X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/530ef4b6c5b943cfa68b779d11cf7de29aa878bf..6746dc89c47ed01b165cc1152533605f97eb8e8d:/ext-all-debug-w-comments.js diff --git a/ext-all-debug-w-comments.js b/ext-all-debug-w-comments.js index 6f89c4e1..c4e2c6b3 100644 --- a/ext-all-debug-w-comments.js +++ b/ext-all-debug-w-comments.js @@ -1,47578 +1,99731 @@ -/*! - * Ext JS Library 3.2.1 - * Copyright(c) 2006-2010 Ext JS, Inc. - * licensing@extjs.com - * http://www.extjs.com/license - */ -/** - * @class Ext.DomHelper - *
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: - *
Insertion methods
- *Commonly used insertion methods: - *
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}';
+This file is part of Ext JS 4
-var tpl = new Ext.DomHelper.createTemplate(html);
-tpl.append('blog-roll', ['link1', 'http://www.jackslocum.com/', "Jack's Site"]);
-tpl.append('blog-roll', ['link2', 'http://www.dustindiaz.com/', "Dustin's Site"]);
- *
- *
- * The same example using named parameters:
-var html = '{text}';
+Copyright (c) 2011 Sencha Inc
-var tpl = new Ext.DomHelper.createTemplate(html);
-tpl.append('blog-roll', {
- id: 'link1',
- url: 'http://www.jackslocum.com/',
- text: "Jack'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}';
+Contact: http://www.sencha.com/contact
-var tpl = new Ext.DomHelper.createTemplate(html);
-tpl.compile();
+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.
-//... 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
- *
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
+/**
+ * @class Ext
* @singleton
*/
-Ext.DomHelper = function(){
- var tempTableEl = null,
- emptyTags = /^(?:br|frame|hr|img|input|link|meta|range|spacer|wbr|area|param|col)$/i,
- tableRe = /^table|tbody|tr|td$/i,
- confRe = /tag|children|cn|html$/i,
- tableElRe = /td|tr|tbody/i,
- cssRe = /([a-z0-9-]+)\s*:\s*([^;\s]+(?:\s*[^;\s]+)*);?/gi,
- endRe = /end/i,
- pub,
- // kill repeat to save bytes
- afterbegin = 'afterbegin',
- afterend = 'afterend',
- beforebegin = 'beforebegin',
- beforeend = 'beforeend',
- ts = 'Represents an HTML fragment template. Templates may be {@link #compile precompiled} - * for greater performance.
- *For example usage {@link #Template see the constructor}.
+ * @author Jacky Nguyen
-var t = new Ext.Template("<div>Hello {0}.</div>");
-t.{@link #append}('some-element', ['foo']);
- *
- * join('')
.
-
-var t = new Ext.Template([
- '<div name="{id}">',
- '<span class="{cls}">{name:trim} {value:ellipsis(10)}</span>',
- '</div>',
-]);
-t.{@link #compile}();
-t.{@link #append}('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});
-
- * join('')
.
- *
-var t = new Ext.Template(
- '<div name="{id}">',
- '<span class="{cls}">{name} {value}</span>',
- '</div>',
- // a configuration object:
- {
- compiled: true, // {@link #compile} immediately
- disableFormats: true // See Notes below.
- }
-);
- *
- * Notes:
- *disableFormats
are not applicable for Ext Core.disableFormats
reduces {@link #apply}
time
- * when no formatting is required.{@link #compile}
).
- * Defaults to false.
- */
- if (me.compiled) {
- me.compile();
- }
-};
-Ext.Template.prototype = {
+ 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 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 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 {Array}
+ */
+ 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;
+ }
+ });
+
+ 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 {Mixed} value The value to convert
+ * @return {Mixed}
+ */
+ 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;
+ }
+ });
+
+ 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
+ * @markdown
+ */
+ deprecate: function(packageName, since, closure, scope) {
+ if (Version.compare(Ext.getVersion(packageName), since) < 1) {
+ closure.call(scope);
+ }
+ }
+ }); // End Versioning
+
+ Ext.setVersion('core', version);
+
+})();
+
+/**
+ * @class Ext.String
+ *
+ * A collection of useful static methods to deal with strings
+ * @singleton
+ */
+
+Ext.String = {
+ 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,
+
/**
- * @cfg {RegExp} re The regular expression used to match template variables.
- * Defaults to:
- * re : /\{([\w-]+)\}/g // for Ext Core
- * re : /\{([\w-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g // for Ext JS
- *
+ * 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
*/
- re : /\{([\w-]+)\}/g,
+ htmlEncode: (function() {
+ var entities = {
+ '&': '&',
+ '>': '>',
+ '<': '<',
+ '"': '"'
+ }, keys = [], p, regex;
+
+ for (p in entities) {
+ keys.push(p);
+ }
+
+ regex = new RegExp('(' + keys.join('|') + ')', 'g');
+
+ return function(value) {
+ return (!value) ? value : String(value).replace(regex, function(match, capture) {
+ return entities[capture];
+ });
+ };
+ })(),
+
/**
- * See {@link #re}
.
- * @type RegExp
- * @property re
+ * Convert certain characters (&, <, >, and ') from their HTML character equivalents.
+ * @param {String} value The string to decode
+ * @return {String} The decoded text
+ * @method
*/
+ htmlDecode: (function() {
+ var entities = {
+ '&': '&',
+ '>': '>',
+ '<': '<',
+ '"': '"'
+ }, keys = [], p, regex;
+
+ for (p in entities) {
+ keys.push(p);
+ }
+
+ regex = new RegExp('(' + keys.join('|') + '|[0-9]{1,5};' + ')', 'g');
+
+ return function(value) {
+ return (!value) ? value : String(value).replace(regex, function(match, capture) {
+ if (capture in entities) {
+ return entities[capture];
+ } else {
+ return String.fromCharCode(parseInt(capture.substr(2), 10));
+ }
+ });
+ };
+ })(),
/**
- * Returns an HTML fragment of this template with the specified values
applied.
- * @param {Object/Array} values
- * The template values. Can be an array if the params are numeric (i.e. {0}
)
- * or an object (i.e. {foo: 'bar'}
).
- * @return {String} The HTML fragment
+ * 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
*/
- applyTemplate : function(values){
- var me = this;
+ urlAppend : function(url, string) {
+ if (!Ext.isEmpty(string)) {
+ return url + (url.indexOf('?') === -1 ? '?' : '&') + string;
+ }
- return me.compiled ?
- me.compiled(values) :
- me.html.replace(me.re, function(m, name){
- return values[name] !== undefined ? values[name] : "";
- });
+ return url;
},
/**
- * Sets the HTML used as the template and optionally compiles it.
- * @param {String} html
- * @param {Boolean} compile (optional) True to compile the template (defaults to undefined)
- * @return {Ext.Template} this
+ * Trims whitespace from either end of a string, leaving spaces within the string intact. Example:
+ * @example
+var s = ' foo bar ';
+alert('-' + s + '-'); //alerts "- foo bar -"
+alert('-' + Ext.String.trim(s) + '-'); //alerts "-foo bar-"
+
+ * @param {String} string The string to escape
+ * @return {String} The trimmed string
*/
- set : function(html, compile){
- var me = this;
- me.html = html;
- me.compiled = null;
- return compile ? me.compile() : me;
+ trim: function(string) {
+ return string.replace(Ext.String.trimRegex, "");
},
/**
- * Compiles the template into an internal function, eliminating the RegEx overhead.
- * @return {Ext.Template} this
+ * Capitalize the given string
+ * @param {String} string
+ * @return {String}
*/
- compile : function(){
- var me = this,
- sep = Ext.isGecko ? "+" : ",";
-
- function fn(m, name){
- name = "values['" + name + "']";
- return "'"+ sep + '(' + name + " == undefined ? '' : " + name + ')' + sep + "'";
- }
-
- eval("this.compiled = function(values){ return " + (Ext.isGecko ? "'" : "['") +
- me.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
- (Ext.isGecko ? "';};" : "'].join('');};"));
- return me;
+ capitalize: function(string) {
+ return string.charAt(0).toUpperCase() + string.substr(1);
},
/**
- * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
- * @param {Mixed} el The context element
- * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
- * @param {Boolean} returnElement (optional) true to return a Ext.Element (defaults to undefined)
- * @return {HTMLElement/Ext.Element} The new node or Element
+ * 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 True to try to find a common word break
+ * @return {String} The converted text
*/
- insertFirst: function(el, values, returnElement){
- return this.doInsert('afterBegin', el, values, returnElement);
+ 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;
},
/**
- * Applies the supplied values to the template and inserts the new node(s) before el.
- * @param {Mixed} el The context element
- * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
- * @param {Boolean} returnElement (optional) true to return a Ext.Element (defaults to undefined)
- * @return {HTMLElement/Ext.Element} The new node or Element
+ * Escapes the passed string for use in a regular expression
+ * @param {String} string
+ * @return {String}
*/
- insertBefore: function(el, values, returnElement){
- return this.doInsert('beforeBegin', el, values, returnElement);
+ escapeRegex: function(string) {
+ return string.replace(Ext.String.escapeRegexRe, "\\$1");
},
/**
- * Applies the supplied values to the template and inserts the new node(s) after el.
- * @param {Mixed} el The context element
- * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
- * @param {Boolean} returnElement (optional) true to return a Ext.Element (defaults to undefined)
- * @return {HTMLElement/Ext.Element} The new node or Element
+ * Escapes the passed string for ' and \
+ * @param {String} string The string to escape
+ * @return {String} The escaped string
*/
- insertAfter : function(el, values, returnElement){
- return this.doInsert('afterEnd', el, values, returnElement);
+ escape: function(string) {
+ return string.replace(Ext.String.escapeRe, "\\$1");
},
/**
- * Applies the supplied values
to the template and appends
- * the new node(s) to the specified el
.
- * For example usage {@link #Template see the constructor}.
- * @param {Mixed} el The context element - * @param {Object/Array} values - * The template values. Can be an array if the params are numeric (i.e.{0}
)
- * or an object (i.e. {foo: 'bar'}
).
- * @param {Boolean} returnElement (optional) true to return an Ext.Element (defaults to undefined)
- * @return {HTMLElement/Ext.Element} The new node or Element
+ * 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
*/
- append : function(el, values, returnElement){
- return this.doInsert('beforeEnd', el, values, returnElement);
+ toggle: function(string, value, other) {
+ return string === value ? other : value;
},
- doInsert : function(where, el, values, returnEl){
- el = Ext.getDom(el);
- var newNode = Ext.DomHelper.insertHtml(where, el, this.applyTemplate(values));
- return returnEl ? Ext.get(newNode, true) : newNode;
+ /**
+ * 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 (defaults to empty 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;
},
/**
- * Applies the supplied values to the template and overwrites the content of el with the new node(s).
- * @param {Mixed} el The context element
- * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
- * @param {Boolean} returnElement (optional) true to return a Ext.Element (defaults to undefined)
- * @return {HTMLElement/Ext.Element} The new node or Element
- */
- overwrite : function(el, values, returnElement){
- el = Ext.getDom(el);
- el.innerHTML = this.applyTemplate(values);
- return returnElement ? Ext.get(el.firstChild, true) : el.firstChild;
+ * 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('<div class="{0}">{1}</div>', cls, text);
+// s now contains the string: '<div class="my-class">Some text</div>'
+
+ * @param {String} string The tokenized string to be formatted
+ * @param {String} value1 The value to replace token {0}
+ * @param {String} value2 Etc...
+ * @return {String} The formatted string
+ */
+ format: function(format) {
+ var args = Ext.Array.toArray(arguments, 1);
+ return format.replace(Ext.String.formatRe, function(m, i) {
+ return args[i];
+ });
}
};
-/**
- * Alias for {@link #applyTemplate}
- * Returns an HTML fragment of this template with the specified values
applied.
- * @param {Object/Array} values
- * The template values. Can be an array if the params are numeric (i.e. {0}
)
- * or an object (i.e. {foo: 'bar'}
).
- * @return {String} The HTML fragment
- * @member Ext.Template
- * @method apply
- */
-Ext.Template.prototype.apply = Ext.Template.prototype.applyTemplate;
/**
- * 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 A configuration object
- * @return {Ext.Template} The created template
- * @static
- */
-Ext.Template.from = function(el, config){
- el = Ext.getDom(el);
- return new Ext.Template(el.value || el.innerHTML, config || '');
-};
-/**
- * @class Ext.Template
+ * @class Ext.Number
+ *
+ * A collection of useful static methods to deal with numbers
+ * @singleton
*/
-Ext.apply(Ext.Template.prototype, {
- /**
- * @cfg {Boolean} disableFormats Specify true to disable format
- * functions in the template. If the template does not contain
- * {@link Ext.util.Format format functions}, setting disableFormats
- * to true will reduce {@link #apply}
time. Defaults to false.
- *
-var t = new Ext.Template(
- '<div name="{id}">',
- '<span class="{cls}">{name} {value}</span>',
- '</div>',
- {
- compiled: true, // {@link #compile} immediately
- disableFormats: true // reduce {@link #apply}
time since no formatting
- }
-);
- *
- * For a list of available format functions, see {@link Ext.util.Format}.
- */
- disableFormats : false,
- /**
- * See {@link #disableFormats}
.
- * @type Boolean
- * @property disableFormats
- */
- /**
- * The regular expression used to match template variables
- * @type RegExp
- * @property
- * @hide repeat doc
- */
- re : /\{([\w-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
- argsRe : /^\s*['"](.*)["']\s*$/,
- compileARe : /\\/g,
- compileBRe : /(\r\n|\n)/g,
- compileCRe : /'/g,
+(function() {
+var isToFixedBroken = (0.9).toFixed() !== '1';
+
+Ext.Number = {
/**
- * 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 (i.e. {0}) or an object (i.e. {foo: 'bar'})
- * @return {String} The HTML fragment
- * @hide repeat doc
+ * 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
*/
- applyTemplate : function(values){
- var me = this,
- useF = me.disableFormats !== true,
- fm = Ext.util.Format,
- tpl = me;
+ constrain: function(number, min, max) {
+ number = parseFloat(number);
- if(me.compiled){
- return me.compiled(values);
+ if (!isNaN(min)) {
+ number = Math.max(number, min);
}
- function fn(m, name, format, args){
- if (format && useF) {
- if (format.substr(0, 5) == "this.") {
- return tpl.call(format.substr(5), values[name], values);
- } else {
- if (args) {
- // quoted values are required for strings in compiled templates,
- // but for non compiled we need to strip them
- // quoted reversed for jsmin
- var re = me.argsRe;
- args = args.split(',');
- for(var i = 0, len = args.length; i < len; i++){
- args[i] = args[i].replace(re, "$1");
- }
- args = [values[name]].concat(args);
- } else {
- args = [values[name]];
- }
- return fm[format].apply(fm, args);
- }
- } else {
- return values[name] !== undefined ? values[name] : "";
- }
+ if (!isNaN(max)) {
+ number = Math.min(number, max);
}
- return me.html.replace(me.re, fn);
+ return number;
},
/**
- * Compiles the template into an internal function, eliminating the RegEx overhead.
- * @return {Ext.Template} this
- * @hide repeat doc
+ * Snaps the passed number between stopping points based upon a passed increment value.
+ * @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.
*/
- compile : function(){
- var me = this,
- fm = Ext.util.Format,
- useF = me.disableFormats !== true,
- sep = Ext.isGecko ? "+" : ",",
- body;
+ snap : function(value, increment, minValue, maxValue) {
+ var newValue = value,
+ m;
- function fn(m, name, format, args){
- if(format && useF){
- args = args ? ',' + args : "";
- if(format.substr(0, 5) != "this."){
- format = "fm." + format + '(';
- }else{
- format = 'this.call("'+ format.substr(5) + '", ';
- args = ", values";
- }
- }else{
- args= ''; format = "(values['" + name + "'] == undefined ? '' : ";
+ if (!(increment && value)) {
+ return value;
+ }
+ m = value % increment;
+ if (m !== 0) {
+ newValue -= m;
+ if (m * 2 >= increment) {
+ newValue += increment;
+ } else if (m * 2 < -increment) {
+ newValue -= increment;
}
- return "'"+ sep + format + "values['" + name + "']" + args + ")"+sep+"'";
}
+ return Ext.Number.constrain(newValue, minValue, maxValue);
+ },
- // branched to use + in gecko and [].join() in others
- if(Ext.isGecko){
- body = "this.compiled = function(values){ return '" +
- me.html.replace(me.compileARe, '\\\\').replace(me.compileBRe, '\\n').replace(me.compileCRe, "\\'").replace(me.re, fn) +
- "';};";
- }else{
- body = ["this.compiled = function(values){ return ['"];
- body.push(me.html.replace(me.compileARe, '\\\\').replace(me.compileBRe, '\\n').replace(me.compileCRe, "\\'").replace(me.re, fn));
- body.push("'].join('');};");
- body = body.join('');
+ /**
+ * 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: function(value, precision) {
+ if (isToFixedBroken) {
+ precision = precision || 0;
+ var pow = Math.pow(10, precision);
+ return (Math.round(value * pow) / pow).toFixed(precision);
}
- eval(body);
- return me;
+
+ return value.toFixed(precision);
},
- // private function used to call members
- call : function(fnName, value, allValues){
- return this[fnName](value, allValues);
+ /**
+ * 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 {Mixed} 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;
}
-});
-Ext.Template.prototype.apply = Ext.Template.prototype.applyTemplate;
-/*
- * This is code is also distributed under MIT license for use
- * with jQuery and prototype JavaScript libraries.
+};
+
+})();
+
+/**
+ * This method is deprecated, please use {@link Ext.Number#from Ext.Number.from} instead
+ *
+ * @deprecated 4.0.0 Replaced by Ext.Number.from
+ * @member Ext
+ * @method num
*/
+Ext.num = function() {
+ return Ext.Number.from.apply(this, arguments);
+};
/**
- * @class Ext.DomQuery
-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, along with some custom selectors and basic XPath.
+ * @author Jacky Nguyen-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. -
-The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.
-Object hash of "pseudo class" filter functions which are used when filtering selections. Each function is passed - * two parameters:
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");
-
+ * 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 {Array/Mixed} value The value to convert to an array if it's not already is an array
+ * @param {Boolean} (Optional) newReference True to clone the given array and return a new reference if necessary,
+ * defaults to false
+ * @return {Array} array
*/
- pseudos : {
- "first-child" : function(c){
- var r = [], ri = -1, n;
- for(var i = 0, ci; ci = n = c[i]; i++){
- while((n = n.previousSibling) && n.nodeType != 1);
- if(!n){
- r[++ri] = ci;
- }
- }
- return r;
- },
+ from: function(value, newReference) {
+ if (value === undefined || value === null) {
+ return [];
+ }
- "last-child" : function(c){
- var r = [], ri = -1, n;
- for(var i = 0, ci; ci = n = c[i]; i++){
- while((n = n.nextSibling) && n.nodeType != 1);
- if(!n){
- r[++ri] = ci;
- }
- }
- return r;
- },
+ if (Ext.isArray(value)) {
+ return (newReference) ? slice.call(value) : value;
+ }
- "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;
- for(var i = 0, n; n = c[i]; i++){
- var pn = n.parentNode;
- if (batch != pn._batch) {
- var j = 0;
- for(var 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;
- }
- }
+ if (value && value.length !== undefined && typeof value !== 'string') {
+ return Ext.toArray(value);
+ }
- return r;
- },
+ return [value];
+ },
- "only-child" : function(c){
- var r = [], ri = -1;;
- for(var i = 0, ci; ci = c[i]; i++){
- if(!prev(ci) && !next(ci)){
- r[++ri] = ci;
- }
+ /**
+ * Removes the specified item from the array if it exists
+ *
+ * @param {Array} array The array
+ * @param {Mixed} 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 {Mixed} 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 intersect = [],
+ arrays = slice.call(arguments),
+ i, j, k, minArray, array, x, y, ln, arraysLn, arrayLn;
+
+ if (!arrays.length) {
+ return intersect;
+ }
+
+ // Find the smallest array
+ for (i = x = 0,ln = arrays.length; i < ln,array = arrays[i]; i++) {
+ if (!minArray || array.length < minArray.length) {
+ minArray = array;
+ x = i;
}
- return r;
- },
+ }
- "empty" : function(c){
- var r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- var cns = ci.childNodes, j = 0, cn, empty = true;
- while(cn = cns[j]){
- ++j;
- if(cn.nodeType == 1 || cn.nodeType == 3){
- empty = false;
+ minArray = ExtArray.unique(minArray);
+ erase(arrays, x, 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.
+ for (i = 0,ln = minArray.length; i < ln,x = minArray[i]; i++) {
+ var count = 0;
+
+ for (j = 0,arraysLn = arrays.length; j < arraysLn,array = arrays[j]; j++) {
+ for (k = 0,arrayLn = array.length; k < arrayLn,y = array[k]; k++) {
+ if (x === y) {
+ count++;
break;
}
}
- if(empty){
- r[++ri] = ci;
- }
}
- return r;
- },
- "contains" : function(c, v){
- var r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- if((ci.textContent||ci.innerText||'').indexOf(v) != -1){
- r[++ri] = ci;
- }
+ if (count === arraysLn) {
+ intersect.push(x);
}
- return r;
- },
+ }
- "nodeValue" : function(c, v){
- var r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- if(ci.firstChild && ci.firstChild.nodeValue == v){
- r[++ri] = ci;
- }
- }
- return r;
- },
+ return intersect;
+ },
- "checked" : function(c){
- var r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- if(ci.checked == true){
- r[++ri] = ci;
+ /**
+ * 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 r;
- },
+ }
- "not" : function(c, ss){
- return Ext.DomQuery.filter(c, ss, true);
- },
+ return clone;
+ },
- "any" : function(c, selectors){
- var ss = selectors.split('|'),
- r = [], ri = -1, s;
- for(var i = 0, ci; ci = c[i]; i++){
- for(var j = 0; s = ss[j]; j++){
- if(Ext.DomQuery.is(ci, s)){
- r[++ri] = ci;
- break;
+ /**
+ * 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.
+ */
+ slice: function(array, begin, end) {
+ 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.
+ * @return {Array} The sorted array.
+ */
+ sort: function(array, sortFn) {
+ if (supportsSort) {
+ if (sortFn) {
+ return array.sort(sortFn);
+ } else {
+ return array.sort();
+ }
+ }
+
+ 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;
}
}
- return r;
- },
-
- "odd" : function(c){
- return this["nth-child"](c, "odd");
- },
+ if (min !== i) {
+ tmp = array[i];
+ array[i] = array[min];
+ array[min] = tmp;
+ }
+ }
- "even" : function(c){
- return this["nth-child"](c, "even");
- },
+ return array;
+ },
- "nth" : function(c, a){
- return c[a-1] || [];
- },
+ /**
+ * Recursively flattens into 1-d Array. Injects Arrays inline.
+ *
+ */
+ flatten: function(array) {
+ var worker = [];
- "first" : function(c){
- return c[0] || [];
- },
+ function rFlatten(a) {
+ var i, ln, v;
- "last" : function(c){
- return c[c.length-1] || [];
- },
+ for (i = 0, ln = a.length; i < ln; i++) {
+ v = a[i];
- "has" : function(c, ss){
- var s = Ext.DomQuery.select,
- r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- if(s(ss, ci).length > 0){
- r[++ri] = ci;
+ if (Ext.isArray(v)) {
+ rFlatten(v);
+ } else {
+ worker.push(v);
}
}
- return r;
- },
- "next" : function(c, ss){
- var is = Ext.DomQuery.is,
- r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- var n = next(ci);
- if(n && is(n, ss)){
- r[++ri] = ci;
+ 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
+ * @return {Mixed} 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;
}
}
- return r;
- },
+ else {
+ if (item < min) {
+ min = item;
+ }
+ }
+ }
- "prev" : function(c, ss){
- var is = Ext.DomQuery.is,
- r = [], ri = -1;
- for(var i = 0, ci; ci = c[i]; i++){
- var n = prev(ci);
- if(n && is(n, ss)){
- r[++ri] = ci;
+ 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
+ * @return {Mixed} 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 r;
}
- }
+
+ 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;
+ },
+
+
+ /**
+ * 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 on which to replace.
+ * @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 An optional 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).
+ * @return {Array} An array containing the removed items.
+ * @method
+ */
+ splice: splice
};
-}();
-/**
- * Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Ext.DomQuery#select}
- * @param {String} path The selector/xpath query
- * @param {Node} root (optional) The start of the query (defaults to document).
- * @return {Array}
- * @member Ext
- * @method query
- */
-Ext.query = Ext.DomQuery.select;
-/**
- * @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. - * @param {Object} scope The default scope (Thethis
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.
- */
-Ext.util.DelayedTask = function(fn, scope, args){
- var me = this,
- id,
- call = function(){
- clearInterval(id);
- id = null;
- fn.apply(scope, args || []);
- };
-
/**
- * Cancels any pending timeout and queues a new one
- * @param {Number} delay 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
+ * @method
+ * @member Ext
+ * @alias Ext.Array#each
*/
- me.delay = function(delay, newFn, newScope, newArgs){
- me.cancel();
- fn = newFn || fn;
- scope = newScope || scope;
- args = newArgs || args;
- id = setInterval(call, delay);
- };
+ Ext.each = ExtArray.each;
/**
- * Cancel the last queued timeout
+ * @method
+ * @member Ext.Array
+ * @alias Ext.Array#merge
*/
- me.cancel = function(){
- if(id){
- clearInterval(id);
- id = null;
- }
- };
-};(function(){
+ ExtArray.union = ExtArray.merge;
-var EXTUTIL = Ext.util,
- EACH = Ext.each,
- TRUE = true,
- FALSE = false;
-/**
- * @class Ext.util.Observable
- * 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.
-Employee = Ext.extend(Ext.util.Observable, {
- constructor: function(config){
- this.name = config.name;
- this.addEvents({
- "fired" : true,
- "quit" : true
- });
+ /**
+ * Old alias to {@link Ext.Array#min}
+ * @deprecated 4.0.0 Use {@link Ext.Array#min} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#min
+ */
+ Ext.min = ExtArray.min;
- // Copy configured listeners into *this* object so that the base class's
- // constructor will add them.
- this.listeners = config.listeners;
+ /**
+ * Old alias to {@link Ext.Array#max}
+ * @deprecated 4.0.0 Use {@link Ext.Array#max} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#max
+ */
+ Ext.max = ExtArray.max;
- // Call our superclass constructor to complete construction process.
- Employee.superclass.constructor.call(this, config)
- }
-});
-
- * 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!");
- }
- }
-});
-
- */
-EXTUTIL.Observable = function(){
- /**
- * @cfg {Object} listeners (optional) 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 ExtJs {@link Ext.Component Components}
- *While some ExtJs 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.DataView DataView}'s
- * {@link Ext.DataView#click click}
event passing the node clicked on. To access DOM
- * events directly from a Component's HTMLElement, listeners must be added to the {@link Ext.Component#getEl Element} after the Component
- * has been rendered. A plugin can simplify this step:
-// Plugin is configured with a listeners config object.
-// The Component is appended to the argument list of all handler functions.
-Ext.DomObserver = Ext.extend(Object, {
- constructor: function(config) {
- this.listeners = config.listeners ? config.listeners : config;
- },
+ /**
+ * Old alias to {@link Ext.Array#sum}
+ * @deprecated 4.0.0 Use {@link Ext.Array#sum} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#sum
+ */
+ Ext.sum = ExtArray.sum;
- // Component passes itself into plugin's init method
- init: function(c) {
- var p, l = this.listeners;
- for (p in l) {
- if (Ext.isFunction(l[p])) {
- l[p] = this.createHandler(l[p], c);
- } else {
- l[p].fn = this.createHandler(l[p].fn, c);
- }
- }
+ /**
+ * Old alias to {@link Ext.Array#mean}
+ * @deprecated 4.0.0 Use {@link Ext.Array#mean} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#mean
+ */
+ Ext.mean = ExtArray.mean;
- // Add the listeners to the Element immediately following the render call
- c.render = c.render.{@link Function#createSequence createSequence}(function() {
- var e = c.getEl();
- if (e) {
- e.on(l);
- }
- });
- },
+ /**
+ * Old alias to {@link Ext.Array#flatten}
+ * @deprecated 4.0.0 Use {@link Ext.Array#flatten} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#flatten
+ */
+ Ext.flatten = ExtArray.flatten;
- createHandler: function(fn, c) {
- return function(e) {
- fn.call(this, e, c);
- };
- }
-});
+ /**
+ * Old alias to {@link Ext.Array#clean}
+ * @deprecated 4.0.0 Use {@link Ext.Array#clean} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#clean
+ */
+ Ext.clean = ExtArray.clean;
-var combo = new Ext.form.ComboBox({
+ /**
+ * Old alias to {@link Ext.Array#unique}
+ * @deprecated 4.0.0 Use {@link Ext.Array#unique} instead
+ * @method
+ * @member Ext
+ * @alias Ext.Array#unique
+ */
+ Ext.unique = ExtArray.unique;
- // Collapse combo when its element is clicked on
- plugins: [ new Ext.DomObserver({
- click: function(evt, comp) {
- comp.collapse();
- }
- })],
- store: myStore,
- typeAhead: true,
- mode: 'local',
- triggerAction: 'all'
-});
- *
+ /**
+ * 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
+ * @alias Ext.Array#pluck
*/
- var me = this, e = me.events;
- if(me.listeners){
- me.on(me.listeners);
- delete me.listeners;
- }
- me.events = e || {};
-};
+ Ext.pluck = ExtArray.pluck;
-EXTUTIL.Observable.prototype = {
- // private
- filterOptRe : /^(?:scope|delay|buffer|single)$/,
+ /**
+ * @method
+ * @member Ext
+ * @alias Ext.Array#toArray
+ */
+ Ext.toArray = function() {
+ return ExtArray.toArray.apply(ExtArray, arguments);
+ };
+})();
+
+/**
+ * @class Ext.Function
+ *
+ * A collection of useful static methods to deal with function callbacks
+ * @singleton
+ */
+Ext.Function = {
/**
- * Fires the specified event with the passed parameters (minus the event name).
- *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. + * 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 */ - fireEvent : function(){ - var a = Array.prototype.slice.call(arguments, 0), - ename = a[0].toLowerCase(), - me = this, - ret = TRUE, - ce = me.events[ename], - cc, - q, - c; - if (me.eventsSuspended === TRUE) { - if (q = me.eventQueue) { - q.push(a); + flexSetter: function(fn) { + return function(a, b) { + var k, i; + + if (a === null) { + return this; } - } - else if(typeof ce == 'object') { - if (ce.bubble){ - if(ce.fire.apply(ce, a.slice(1)) === FALSE) { - return FALSE; + + if (typeof a !== 'string') { + for (k in a) { + if (a.hasOwnProperty(k)) { + fn.call(this, k, a[k]); + } } - c = me.getBubbleTarget && me.getBubbleTarget(); - if(c && c.enableBubble) { - cc = c.events[ename]; - if(!cc || typeof cc != 'object' || !cc.bubble) { - c.enableBubble(ename); + + if (Ext.enumerables) { + for (i = Ext.enumerables.length; i--;) { + k = Ext.enumerables[i]; + if (a.hasOwnProperty(k)) { + fn.call(this, k, a[k]); + } } - return c.fireEvent.apply(c, a); } + } else { + fn.call(this, a, b); } - else { - a.shift(); - ret = ce.fire.apply(ce, a); - } - } - return ret; + + return this; + }; }, /** - * Appends an event handler to this object. - * @param {String} eventName The name of the event to listen for. - * @param {Function} handler The method the event invokes. - * @param {Object} scope (optional) The scope (this
reference) in which the handler function is executed.
- * If omitted, defaults to the object which fired the event.
- * @param {Object} options (optional) An object containing handler configuration.
- * properties. This may contain any of the following properties:this
reference) in which the handler function is executed.
- * If omitted, defaults to the object which fired the event.
- * Combining Options
- * Using the options argument, it is possible to combine different types of listeners:
- *
- * A delayed, one-time listener.
- *
-myDataView.on('click', this.onClick, this, {
-single: true,
-delay: 100
-});
- *
- * 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.
- *
- *
-myGridPanel.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:
- *
-myGridPanel.on({
-'click' : this.onClick,
-'mouseover' : this.onMouseOver,
-'mouseout' : this.onMouseOut,
- scope: 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 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
*/
- addListener : function(eventName, fn, scope, o){
- var me = this,
- e,
- oe,
- isF,
- ce;
- if (typeof eventName == 'object') {
- o = eventName;
- for (e in o){
- oe = o[e];
- if (!me.filterOptRe.test(e)) {
- me.addListener(e, oe.fn || oe, oe.scope || o.scope, oe.fn ? oe : o);
- }
+ bind: function(fn, scope, args, appendArgs) {
+ 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 {
- eventName = eventName.toLowerCase();
- ce = me.events[eventName] || TRUE;
- if (typeof ce == 'boolean') {
- me.events[eventName] = ce = new EXTUTIL.Event(me, eventName);
+ else if (Ext.isNumber(appendArgs)) {
+ callArgs = slice.call(arguments, 0); // copy arguments first
+ Ext.Array.insert(callArgs, appendArgs, args);
}
- ce.addListener(fn, scope, typeof o == 'object' ? o : {});
- }
+
+ return method.apply(scope || window, callArgs);
+ };
},
/**
- * Removes an event handler.
- * @param {String} eventName The type of event the handler was associated with.
- * @param {Function} handler The handler to remove. This must be a reference to the function passed into the {@link #addListener} call.
- * @param {Object} scope (optional) The scope originally specified for the handler.
+ * 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
*/
- removeListener : function(eventName, fn, scope){
- var ce = this.events[eventName.toLowerCase()];
- if (typeof ce == 'object') {
- ce.removeListener(fn, scope);
+ pass: function(fn, args, scope) {
+ if (args) {
+ args = Ext.Array.from(args);
}
+
+ return function() {
+ return fn.apply(scope, args.concat(Ext.Array.toArray(arguments)));
+ };
},
/**
- * Removes all listeners for this object
+ * 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
*/
- purgeListeners : function(){
- var events = this.events,
- evt,
- key;
- for(key in events){
- evt = events[key];
- if(typeof evt == 'object'){
- evt.clearListeners();
- }
- }
+ alias: function(object, methodName) {
+ return function() {
+ return object[methodName].apply(object, arguments);
+ };
},
/**
- * Adds the specified events to the list of events which this Observable may fire.
- * @param {Object|String} o Either an object with event names as properties with a value of true
- * or the first event name string if multiple event names are being passed as separate parameters.
- * @param {string} Optional. Event name if multiple event names are being passed as separate parameters.
- * Usage:
-this.addEvents('storeloaded', 'storecleared');
-
- */
- addEvents : function(o){
- var me = this;
- me.events = me.events || {};
- if (typeof o == 'string') {
- var a = arguments,
- i = a.length;
- while(i--) {
- me.events[a[i]] = me.events[a[i]] || TRUE;
- }
- } else {
- Ext.applyIf(me.events, o);
+ * 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 (optional) The scope (`this` reference) in which the passed function is executed.
+ * **If omitted, defaults to the scope in which the original function is called or the browser window.**
+ * @param {Mixed} returnValue (optional) The value to return if the passed function return false (defaults to null).
+ * @return {Function} The new function
+ */
+ createInterceptor: function(origFn, newFn, scope, returnValue) {
+ var method = origFn;
+ if (!Ext.isFunction(newFn)) {
+ return origFn;
+ }
+ else {
+ return function() {
+ var me = this,
+ args = arguments;
+ newFn.target = me;
+ newFn.method = origFn;
+ return (newFn.apply(scope || me || window, args) !== false) ? origFn.apply(me || window, args) : returnValue || null;
+ };
}
},
/**
- * Checks to see if this object has any listeners for a specified event
- * @param {String} eventName The name of the event to check for
- * @return {Boolean} True if the event is being listened for, else false
- */
- hasListener : function(eventName){
- var e = this.events[eventName.toLowerCase()];
- return typeof e == 'object' && e.listeners.length > 0;
+ * 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;
+ setTimeout(function() {
+ fn.apply(me, arguments);
+ }, delay);
+ };
},
/**
- * Suspend 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;
+ * 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
*/
- suspendEvents : function(queueSuspended){
- this.eventsSuspended = TRUE;
- if(queueSuspended && !this.eventQueue){
- this.eventQueue = [];
+ defer: function(fn, millis, obj, args, appendArgs) {
+ fn = Ext.Function.bind(fn, obj, args, appendArgs);
+ if (millis > 0) {
+ return setTimeout(fn, millis);
}
+ fn();
+ return 0;
},
/**
- * Resume 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.
+ * 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} origFn 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 browser window.
+ * @return {Function} The new function
*/
- resumeEvents : function(){
- var me = this,
- queued = me.eventQueue || [];
- me.eventsSuspended = FALSE;
- delete me.eventQueue;
- EACH(queued, function(e) {
- me.fireEvent.apply(me, e);
- });
+ createSequence: function(origFn, newFn, scope) {
+ if (!Ext.isFunction(newFn)) {
+ return origFn;
+ }
+ else {
+ return function() {
+ var retval = origFn.apply(this || window, arguments);
+ newFn.apply(scope || this || window, arguments);
+ return retval;
+ };
+ }
+ },
+
+ /**
+ * 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) {
+ return function(){
+ var timerId;
+ return function() {
+ var me = this;
+ if (timerId) {
+ clearInterval(timerId);
+ timerId = null;
+ }
+ timerId = setTimeout(function(){
+ fn.apply(scope || me, args || arguments);
+ }, 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 = new Date().getTime();
+ };
+
+ return function() {
+ elapsed = new Date().getTime() - lastCallTime;
+ lastArgs = arguments;
+
+ clearTimeout(timer);
+ if (!lastCallTime || (elapsed >= interval)) {
+ execute();
+ } else {
+ timer = setTimeout(execute, interval - elapsed);
+ }
+ };
}
};
-var OBSERVABLE = EXTUTIL.Observable.prototype;
/**
- * Appends an event handler to this object (shorthand for {@link #addListener}.)
- * @param {String} eventName The type of event to listen for
- * @param {Function} handler The method the event invokes
- * @param {Object} scope (optional) The scope (this
reference) in which the handler function is executed.
- * If omitted, defaults to the object which fired the event.
- * @param {Object} options (optional) An object containing handler configuration.
* @method
+ * @member Ext
+ * @alias Ext.Function#defer
*/
-OBSERVABLE.on = OBSERVABLE.addListener;
+Ext.defer = Ext.Function.alias(Ext.Function, 'defer');
+
/**
- * Removes an event handler (shorthand for {@link #removeListener}.)
- * @param {String} eventName The type of event the handler was associated with.
- * @param {Function} handler The handler to remove. This must be a reference to the function passed into the {@link #addListener} call.
- * @param {Object} scope (optional) The scope originally specified for the handler.
* @method
+ * @member Ext
+ * @alias Ext.Function#pass
*/
-OBSERVABLE.un = OBSERVABLE.removeListener;
+Ext.pass = Ext.Function.alias(Ext.Function, 'pass');
/**
- * Removes all added captures from the Observable.
- * @param {Observable} o The Observable to release
- * @static
+ * @method
+ * @member Ext
+ * @alias Ext.Function#bind
*/
-EXTUTIL.Observable.releaseCapture = function(o){
- o.fireEvent = OBSERVABLE.fireEvent;
-};
+Ext.bind = Ext.Function.alias(Ext.Function, 'bind');
-function createTargeted(h, o, scope){
- return function(){
- if(o.target == arguments[0]){
- h.apply(scope, Array.prototype.slice.call(arguments, 0));
- }
- };
-};
+/**
+ * @author Jacky Nguyen 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.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
+ name = matchedName[0];
+ keys = [];
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
+ if (matchedKeys === null) {
+ object[name] = value;
+ continue;
+ }
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
-});
-
- * @param {String/Array} events The event name to bubble, or an Array of event names.
- */
- enableBubble : function(events){
- var me = this;
- if(!Ext.isEmpty(events)){
- events = Ext.isArray(events) ? events : Array.prototype.slice.call(arguments, 0);
- for(var i = 0, len = events.length; i < len; i++){
- var ename = events[i];
- ename = ename.toLowerCase();
- var ce = me.events[ename] || true;
- if (typeof ce == 'boolean') {
- ce = new Ext.util.Event(me, ename);
- me.events[ename] = ce;
+ 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);
}
- ce.bubble = true;
- }
- }
- }
- };
-}());
+ keys.unshift(name);
-/**
- * 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 {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
- */
-Ext.util.Observable.capture = function(o, fn, scope){
- o.fireEvent = o.fireEvent.createInterceptor(fn, scope);
-};
+ temp = object;
+ for (j = 0, subLn = keys.length; j < subLn; j++) {
+ key = keys[j];
-/**
- * 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.observeClass(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
- */
-Ext.util.Observable.observeClass = function(c, listeners){
- if(c){
- if(!c.fireEvent){
- Ext.apply(c, new Ext.util.Observable());
- Ext.util.Observable.capture(c.prototype, c.fireEvent, c);
- }
- if(typeof listeners == 'object'){
- c.on(listeners);
- }
- return c;
- }
-};
-/**
- * @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
- */
+ 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];
-Ext.EventManager = function(){
- var docReadyEvent,
- docReadyProcId,
- docReadyState = false,
- DETECT_NATIVE = Ext.isGecko || Ext.isWebKit || Ext.isSafari,
- E = Ext.lib.Event,
- D = Ext.lib.Dom,
- DOC = document,
- WINDOW = window,
- DOMCONTENTLOADED = "DOMContentLoaded",
- COMPLETE = 'complete',
- propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/,
- /*
- * This cache is used to hold special js objects, the document and window, that don't have an id. We need to keep
- * a reference to them so we can look them up at a later point.
- */
- specialElCache = [];
+ temp[key] = (Ext.isNumeric(nextKey) || nextKey === '') ? [] : {};
+ }
- function getId(el){
- var id = false,
- i = 0,
- len = specialElCache.length,
- id = false,
- skip = false,
- o;
- if(el){
- if(el.getElementById || el.navigator){
- // look up the id
- for(; i < len; ++i){
- o = specialElCache[i];
- if(o.el === el){
- id = o.id;
- break;
+ temp = temp[key];
+ }
}
}
- if(!id){
- // for browsers that support it, ensure that give the el the same id
- id = Ext.id(el);
- specialElCache.push({
- id: id,
- el: el
- });
- skip = true;
- }
- }else{
- id = Ext.id(el);
- }
- if(!Ext.elCache[id]){
- Ext.Element.addToCache(new Ext.Element(el), id);
- if(skip){
- Ext.elCache[id].skipGC = true;
- }
}
}
- return id;
- };
-
- /// There is some jquery work around stuff here that isn't needed in Ext Core.
- function addListener(el, ename, fn, task, wrap, scope){
- el = Ext.getDom(el);
- var id = getId(el),
- es = Ext.elCache[id].events,
- wfn;
-
- wfn = E.on(el, ename, wrap);
- es[ename] = es[ename] || [];
-
- /* 0 = Original Function,
- 1 = Event Manager Wrapped Function,
- 2 = Scope,
- 3 = Adapter Wrapped Function,
- 4 = Buffered Task
- */
- es[ename].push([fn, wrap, scope, wfn, task]);
- // this is a workaround for jQuery and should somehow be removed from Ext Core in the future
- // without breaking ExtJS.
+ return object;
+ },
- // workaround for jQuery
- if(el.addEventListener && ename == "mousewheel"){
- var args = ["DOMMouseScroll", wrap, false];
- el.addEventListener.apply(el, args);
- Ext.EventManager.addListener(WINDOW, 'unload', function(){
- el.removeEventListener.apply(el, args);
- });
- }
+ /**
+ * Iterate through an object and invoke the given callback function for each iteration. The iteration can be stop
+ * by returning `false` in the callback function. For example:
- // fix stopped mousedowns on the document
- if(el == DOC && ename == "mousedown"){
- Ext.EventManager.stoppedMouseDownEvent.addListener(wrap);
- }
+ var person = {
+ name: 'Jacky'
+ hairColor: 'black'
+ loves: ['food', 'sleeping', 'wife']
};
- function doScrollChk(){
- /* Notes:
- 'doScroll' will NOT work in a IFRAME/FRAMESET.
- The method succeeds but, a DOM query done immediately after -- FAILS.
- */
- if(window != top){
- return false;
- }
-
- try{
- DOC.documentElement.doScroll('left');
- }catch(e){
- return false;
- }
-
- fireDocReady();
- return true;
- }
- /**
- * @return {Boolean} True if the document is in a 'complete' state (or was determined to
- * be true by other means). If false, the state is evaluated again until canceled.
- */
- function checkReadyState(e){
-
- if(Ext.isIE && doScrollChk()){
- return true;
- }
- if(DOC.readyState == COMPLETE){
- fireDocReady();
- return true;
- }
- docReadyState || (docReadyProcId = setTimeout(arguments.callee, 2));
- return false;
- }
+ Ext.Object.each(person, function(key, value, myself) {
+ console.log(key + ":" + value);
- var styles;
- function checkStyleSheets(e){
- styles || (styles = Ext.query('style, link[rel=stylesheet]'));
- if(styles.length == DOC.styleSheets.length){
- fireDocReady();
- return true;
+ if (key === 'hairColor') {
+ return false; // stop the iteration
}
- docReadyState || (docReadyProcId = setTimeout(arguments.callee, 2));
- return false;
- }
+ });
- function OperaDOMContentLoaded(e){
- DOC.removeEventListener(DOMCONTENTLOADED, arguments.callee, false);
- checkStyleSheets();
- }
+ * @param {Object} object The object to iterate
+ * @param {Function} fn The callback function. Passed arguments for each iteration are:
- function fireDocReady(e){
- if(!docReadyState){
- docReadyState = true; //only attempt listener removal once
+- {String} `key`
+- {Mixed} `value`
+- {Object} `object` The object itself
- if(docReadyProcId){
- clearTimeout(docReadyProcId);
- }
- if(DETECT_NATIVE) {
- DOC.removeEventListener(DOMCONTENTLOADED, fireDocReady, false);
- }
- if(Ext.isIE && checkReadyState.bindIE){ //was this was actually set ??
- DOC.detachEvent('onreadystatechange', checkReadyState);
+ * @param {Object} scope (Optional) The execution scope (`this`) of the callback function
+ * @markdown
+ */
+ 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;
+ }
}
- E.un(WINDOW, "load", arguments.callee);
- }
- if(docReadyEvent && !Ext.isReady){
- Ext.isReady = true;
- docReadyEvent.fire();
- docReadyEvent.listeners = [];
}
+ },
- };
+ /**
+ * Merges any number of objects recursively without referencing them or their children.
- function initDocReady(){
- docReadyEvent || (docReadyEvent = new Ext.util.Event());
- if (DETECT_NATIVE) {
- DOC.addEventListener(DOMCONTENTLOADED, fireDocReady, false);
+ var extjs = {
+ companyName: 'Ext JS',
+ products: ['Ext JS', 'Ext GWT', 'Ext Designer'],
+ isSuperCool: true
+ office: {
+ size: 2000,
+ location: 'Palo Alto',
+ isFun: true
}
- /*
- * Handle additional (exceptional) detection strategies here
- */
- if (Ext.isIE){
- //Use readystatechange as a backup AND primary detection mechanism for a FRAME/IFRAME
- //See if page is already loaded
- if(!checkReadyState()){
- checkReadyState.bindIE = true;
- DOC.attachEvent('onreadystatechange', checkReadyState);
- }
-
- }else if(Ext.isOpera ){
- /* Notes:
- Opera needs special treatment needed here because CSS rules are NOT QUITE
- available after DOMContentLoaded is raised.
- */
-
- //See if page is already loaded and all styleSheets are in place
- (DOC.readyState == COMPLETE && checkStyleSheets()) ||
- DOC.addEventListener(DOMCONTENTLOADED, OperaDOMContentLoaded, false);
-
- }else if (Ext.isWebKit){
- //Fallback for older Webkits without DOMCONTENTLOADED support
- checkReadyState();
- }
- // no matter what, make sure it fires on load
- E.on(WINDOW, "load", fireDocReady);
- };
-
- function createTargeted(h, o){
- return function(){
- var args = Ext.toArray(arguments);
- if(o.target == Ext.EventObject.setEvent(args[0]).target){
- h.apply(this, args);
- }
- };
- };
-
- function createBuffered(h, o, task){
- return function(e){
- // create new event object impl so new events don't wipe out properties
- task.delay(o.buffer, h, null, [new Ext.EventObjectImpl(e)]);
- };
- };
-
- function createSingle(h, el, ename, fn, scope){
- return function(e){
- Ext.EventManager.removeListener(el, ename, fn, scope);
- h(e);
- };
};
- function createDelayed(h, o, fn){
- return function(e){
- var task = new Ext.util.DelayedTask(h);
- if(!fn.tasks) {
- fn.tasks = [];
- }
- fn.tasks.push(task);
- task.delay(o.delay || 10, h, null, [new Ext.EventObjectImpl(e)]);
- };
+ var newStuff = {
+ companyName: 'Sencha Inc.',
+ products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],
+ office: {
+ size: 40000,
+ location: 'Redwood City'
+ }
};
- function listen(element, ename, opt, fn, scope){
- var o = (!opt || typeof opt == "boolean") ? {} : opt,
- el = Ext.getDom(element), task;
-
- fn = fn || o.fn;
- scope = scope || o.scope;
+ var sencha = Ext.Object.merge(extjs, newStuff);
- if(!el){
- throw "Error listening for \"" + ename + '\". Element "' + element + '" doesn\'t exist.';
+ // extjs and sencha then equals to
+ {
+ companyName: 'Sencha Inc.',
+ products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],
+ isSuperCool: true
+ office: {
+ size: 30000,
+ location: 'Redwood City'
+ isFun: true
}
- function h(e){
- // prevent errors while unload occurring
- if(!Ext){// !window[xname]){ ==> can't we do this?
- return;
- }
- e = Ext.EventObject.setEvent(e);
- var t;
- if (o.delegate) {
- if(!(t = e.getTarget(o.delegate, el))){
- return;
+ }
+
+ * @param {Object} object,...
+ * @return {Object} merged The object that is created as a result of merging all the objects passed in.
+ * @markdown
+ */
+ merge: function(source, key, value) {
+ if (typeof key === 'string') {
+ if (value && value.constructor === Object) {
+ if (source[key] && source[key].constructor === Object) {
+ ExtObject.merge(source[key], value);
+ }
+ else {
+ source[key] = Ext.clone(value);
}
- } else {
- t = e.target;
- }
- if (o.stopEvent) {
- e.stopEvent();
- }
- if (o.preventDefault) {
- e.preventDefault();
- }
- if (o.stopPropagation) {
- e.stopPropagation();
}
- if (o.normalized) {
- e = e.browserEvent;
+ else {
+ source[key] = value;
}
- fn.call(scope || el, e, t, o);
- };
- if(o.target){
- h = createTargeted(h, o);
- }
- if(o.delay){
- h = createDelayed(h, o, fn);
- }
- if(o.single){
- h = createSingle(h, el, ename, fn, scope);
- }
- if(o.buffer){
- task = new Ext.util.DelayedTask(h);
- h = createBuffered(h, o, task);
+ return source;
}
- addListener(el, ename, fn, task, h, scope);
- return h;
- };
+ var i = 1,
+ ln = arguments.length,
+ object, property;
- var pub = {
- /**
- * 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.
- * @param {String/HTMLElement} 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} handler The handler function the event invokes. This function is passed
- * the following parameters:this
reference) in which the handler function is executed. Defaults to the Element.
- * @param {Object} options (optional) An object containing handler configuration properties.
- * This may contain any of the following properties:this
reference) in which the handler function is executed. Defaults to the Element.See {@link Ext.Element#addListener} for examples of how to use these options.
- */ - addListener : function(element, eventName, fn, scope, options){ - if(typeof eventName == 'object'){ - var o = eventName, e, val; - for(e in o){ - val = o[e]; - if(!propRe.test(e)){ - if(Ext.isFunction(val)){ - // shared options - listen(element, e, o, val, o.scope); - }else{ - // individual options - listen(element, e, val); - } - } + for (; i < ln; i++) { + object = arguments[i]; + + for (property in object) { + if (object.hasOwnProperty(property)) { + ExtObject.merge(source, property, object[property]); } - } else { - listen(element, eventName, options, fn, scope); } - }, - - /** - * 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. - * @param {String/HTMLElement} 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(el, eventName, fn, scope){
- el = Ext.getDom(el);
- var id = getId(el),
- f = el && (Ext.elCache[id].events)[eventName] || [],
- wrap, i, l, k, len, fnc;
+ }
- for (i = 0, len = f.length; i < len; i++) {
+ return source;
+ },
- /* 0 = Original Function,
- 1 = Event Manager Wrapped Function,
- 2 = Scope,
- 3 = Adapter Wrapped Function,
- 4 = Buffered Task
- */
- if (Ext.isArray(fnc = f[i]) && fnc[0] == fn && (!scope || fnc[2] == scope)) {
- if(fnc[4]) {
- fnc[4].cancel();
- }
- k = fn.tasks && fn.tasks.length;
- if(k) {
- while(k--) {
- fn.tasks[k].cancel();
- }
- delete fn.tasks;
- }
- wrap = fnc[1];
- E.un(el, eventName, E.extAdapter ? fnc[3] : wrap);
+ /**
+ * Returns the first matching key corresponding to the given value.
+ * If no matching value is found, null is returned.
- // jQuery workaround that should be removed from Ext Core
- if(wrap && el.addEventListener && eventName == "mousewheel"){
- el.removeEventListener("DOMMouseScroll", wrap, false);
- }
+ var person = {
+ name: 'Jacky',
+ loves: 'food'
+ };
- // fix stopped mousedowns on the document
- if(wrap && el == DOC && eventName == "mousedown"){
- Ext.EventManager.stoppedMouseDownEvent.removeListener(wrap);
- }
+ alert(Ext.Object.getKey(sencha, 'loves')); // alerts 'food'
- f.splice(i, 1);
- if (f.length === 0) {
- delete Ext.elCache[id].events[eventName];
- }
- for (k in Ext.elCache[id].events) {
- return false;
- }
- Ext.elCache[id].events = {};
- return false;
- }
+ * @param {Object} object
+ * @param {Object} value The value to find
+ * @markdown
+ */
+ getKey: function(object, value) {
+ for (var property in object) {
+ if (object.hasOwnProperty(property) && object[property] === value) {
+ return property;
}
- },
-
- /**
- * 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/HTMLElement} el The id or html element from which to remove all event handlers.
- */
- removeAll : function(el){
- el = Ext.getDom(el);
- var id = getId(el),
- ec = Ext.elCache[id] || {},
- es = ec.events || {},
- f, i, len, ename, fn, k, wrap;
-
- for(ename in es){
- if(es.hasOwnProperty(ename)){
- f = es[ename];
- /* 0 = Original Function,
- 1 = Event Manager Wrapped Function,
- 2 = Scope,
- 3 = Adapter Wrapped Function,
- 4 = Buffered Task
- */
- for (i = 0, len = f.length; i < len; i++) {
- fn = f[i];
- if(fn[4]) {
- fn[4].cancel();
- }
- if(fn[0].tasks && (k = fn[0].tasks.length)) {
- while(k--) {
- fn[0].tasks[k].cancel();
- }
- delete fn.tasks;
- }
- wrap = fn[1];
- E.un(el, ename, E.extAdapter ? fn[3] : wrap);
+ }
- // jQuery workaround that should be removed from Ext Core
- if(el.addEventListener && wrap && ename == "mousewheel"){
- el.removeEventListener("DOMMouseScroll", wrap, false);
- }
+ return null;
+ },
- // fix stopped mousedowns on the document
- if(wrap && el == DOC && ename == "mousedown"){
- Ext.EventManager.stoppedMouseDownEvent.removeListener(wrap);
- }
- }
- }
- }
- if (Ext.elCache[id]) {
- Ext.elCache[id].events = {};
- }
- },
+ /**
+ * Gets all values of the given object as an array.
- getListeners : function(el, eventName) {
- el = Ext.getDom(el);
- var id = getId(el),
- ec = Ext.elCache[id] || {},
- es = ec.events || {},
- results = [];
- if (es && es[eventName]) {
- return es[eventName];
- } else {
- return null;
- }
- },
+ var values = Ext.Object.getValues({
+ name: 'Jacky',
+ loves: 'food'
+ }); // ['Jacky', 'food']
- purgeElement : function(el, recurse, eventName) {
- el = Ext.getDom(el);
- var id = getId(el),
- ec = Ext.elCache[id] || {},
- es = ec.events || {},
- i, f, len;
- if (eventName) {
- if (es && es.hasOwnProperty(eventName)) {
- f = es[eventName];
- for (i = 0, len = f.length; i < len; i++) {
- Ext.EventManager.removeListener(el, eventName, f[i][0]);
- }
- }
- } else {
- Ext.EventManager.removeAll(el);
- }
- if (recurse && el && el.childNodes) {
- for (i = 0, len = el.childNodes.length; i < len; i++) {
- Ext.EventManager.purgeElement(el.childNodes[i], recurse, eventName);
- }
- }
- },
+ * @param {Object} object
+ * @return {Array} An array of values from the object
+ * @markdown
+ */
+ getValues: function(object) {
+ var values = [],
+ property;
- _unload : function() {
- var el;
- for (el in Ext.elCache) {
- Ext.EventManager.removeAll(el);
+ for (property in object) {
+ if (object.hasOwnProperty(property)) {
+ values.push(object[property]);
}
- delete Ext.elCache;
- delete Ext.Element._flyweights;
+ }
- // Abort any outstanding Ajax requests
- var c,
- conn,
- tid,
- ajax = Ext.lib.Ajax;
- (typeof ajax.conn == 'object') ? conn = ajax.conn : conn = {};
- for (tid in conn) {
- c = conn[tid];
- if (c) {
- ajax.abort({conn: c, tId: tid});
- }
- }
- },
- /**
- * Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be
- * accessed shorthanded as Ext.onReady().
- * @param {Function} fn The method the event invokes.
- * @param {Object} scope (optional) The scope (this
reference) in which the handler function executes. Defaults to the browser window.
- * @param {boolean} options (optional) Options object as passed to {@link Ext.Element#addListener}. It is recommended that the options
- * {single: true}
be used so that the handler is removed on first invocation.
- */
- onDocumentReady : function(fn, scope, options){
- if(Ext.isReady){ // if it already fired or document.body is present
- docReadyEvent || (docReadyEvent = new Ext.util.Event());
- docReadyEvent.addListener(fn, scope, options);
- docReadyEvent.fire();
- docReadyEvent.listeners = [];
- }else{
- if(!docReadyEvent){
- initDocReady();
- }
- options = options || {};
- options.delay = options.delay || 1;
- docReadyEvent.addListener(fn, scope, options);
- }
- },
+ return values;
+ },
- /**
- * Forces a document ready state transition for the framework. Used when Ext is loaded
- * into a DOM structure AFTER initial page load (Google API or other dynamic load scenario.
- * Any pending 'onDocumentReady' handlers will be fired (if not already handled).
- */
- fireDocReady : fireDocReady
- };
- /**
- * Appends an event handler to an element. Shorthand for {@link #addListener}.
- * @param {String/HTMLElement} 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} handler The handler function the event invokes.
- * @param {Object} scope (optional) (this
reference) in which the handler function executes. Defaults to the Element.
- * @param {Object} options (optional) An object containing standard {@link #addListener} options
- * @member Ext.EventManager
- * @method on
- */
- pub.on = pub.addListener;
/**
- * Removes an event handler from an element. Shorthand for {@link #removeListener}.
- * @param {String/HTMLElement} 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 #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.
- * @member Ext.EventManager
- * @method un
- */
- pub.un = pub.removeListener;
+ * Gets all keys of the given object as an array.
- pub.stoppedMouseDownEvent = new Ext.util.Event();
- return pub;
-}();
-/**
- * Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of {@link Ext.EventManager#onDocumentReady}.
- * @param {Function} fn The method the event invokes.
- * @param {Object} scope (optional) The scope (this
reference) in which the handler function executes. Defaults to the browser window.
- * @param {boolean} options (optional) Options object as passed to {@link Ext.Element#addListener}. It is recommended that the options
- * {single: true}
be used so that the handler is removed on first invocation.
- * @member Ext
- * @method onReady
- */
-Ext.onReady = Ext.EventManager.onDocumentReady;
+ var values = Ext.Object.getKeys({
+ name: 'Jacky',
+ loves: 'food'
+ }); // ['name', 'loves']
+ * @param {Object} object
+ * @return {Array} An array of keys from the object
+ * @method
+ */
+ getKeys: ('keys' in Object.prototype) ? Object.keys : function(object) {
+ var keys = [],
+ property;
-//Initialize doc classes
-(function(){
+ for (property in object) {
+ if (object.hasOwnProperty(property)) {
+ keys.push(property);
+ }
+ }
- var initExtCss = function(){
- // find the body element
- var bd = document.body || document.getElementsByTagName('body')[0];
- if(!bd){ return false; }
- var cls = [' ',
- Ext.isIE ? "ext-ie " + (Ext.isIE6 ? 'ext-ie6' : (Ext.isIE7 ? 'ext-ie7' : 'ext-ie8'))
- : Ext.isGecko ? "ext-gecko " + (Ext.isGecko2 ? 'ext-gecko2' : 'ext-gecko3')
- : Ext.isOpera ? "ext-opera"
- : Ext.isWebKit ? "ext-webkit" : ""];
+ return keys;
+ },
- if(Ext.isSafari){
- cls.push("ext-safari " + (Ext.isSafari2 ? 'ext-safari2' : (Ext.isSafari3 ? 'ext-safari3' : 'ext-safari4')));
- }else if(Ext.isChrome){
- cls.push("ext-chrome");
- }
+ /**
+ * Gets the total number of this object's own properties
- if(Ext.isMac){
- cls.push("ext-mac");
- }
- if(Ext.isLinux){
- cls.push("ext-linux");
- }
+ var size = Ext.Object.getSize({
+ name: 'Jacky',
+ loves: 'food'
+ }); // size equals 2
+
+ * @param {Object} object
+ * @return {Number} size
+ * @markdown
+ */
+ getSize: function(object) {
+ var size = 0,
+ property;
- if(Ext.isStrict || Ext.isBorderBox){ // add to the parent to allow for selectors like ".ext-strict .ext-ie"
- var p = bd.parentNode;
- if(p){
- p.className += Ext.isStrict ? ' ext-strict' : ' ext-border-box';
+ for (property in object) {
+ if (object.hasOwnProperty(property)) {
+ size++;
}
}
- bd.className += cls.join(' ');
- return true;
- }
- if(!initExtCss()){
- Ext.onReady(initExtCss);
+ return size;
}
-})();
+};
/**
- * @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
+ * A convenient alias method for {@link Ext.Object#merge}
+ *
+ * @member Ext
+ * @method merge
*/
-Ext.EventObject = function(){
- var E = Ext.lib.Event,
- // 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
- btnMap = Ext.isIE ? {1:0,4:1,2:2} :
- (Ext.isWebKit ? {1:0,2:1,3:2} : {0:0,1:1,2:2});
-
- Ext.EventObjectImpl = function(e){
- if(e){
- this.setEvent(e.browserEvent || e);
- }
- };
-
- Ext.EventObjectImpl.prototype = {
- /** @private */
- setEvent : function(e){
- var me = this;
- if(e == me || (e && e.browserEvent)){ // already wrapped
- return e;
- }
- me.browserEvent = e;
- if(e){
- // normalize buttons
- me.button = e.button ? btnMap[e.button] : (e.which ? e.which - 1 : -1);
- if(e.type == 'click' && me.button == -1){
- me.button = 0;
- }
- me.type = e.type;
- me.shiftKey = e.shiftKey;
- // mac metaKey behaves like ctrlKey
- me.ctrlKey = e.ctrlKey || e.metaKey || false;
- me.altKey = e.altKey;
- // in getKey these will be normalized for the mac
- me.keyCode = e.keyCode;
- me.charCode = e.charCode;
- // cache the target for the delayed and or buffered events
- me.target = E.getTarget(e);
- // same for XY
- me.xy = E.getXY(e);
- }else{
- me.button = -1;
- me.shiftKey = false;
- me.ctrlKey = false;
- me.altKey = false;
- me.keyCode = 0;
- me.charCode = 0;
- me.target = null;
- me.xy = [0, 0];
- }
- return me;
- },
-
- /**
- * Stop the event (preventDefault and stopPropagation)
- */
- stopEvent : function(){
- var me = this;
- if(me.browserEvent){
- if(me.browserEvent.type == 'mousedown'){
- Ext.EventManager.stoppedMouseDownEvent.fire(me);
- }
- E.stopEvent(me.browserEvent);
- }
- },
+Ext.merge = Ext.Object.merge;
- /**
- * Prevents the browsers default handling of the event.
- */
- preventDefault : function(){
- if(this.browserEvent){
- E.preventDefault(this.browserEvent);
- }
- },
+/**
+ * A convenient alias method for {@link Ext.Object#toQueryString}
+ *
+ * @member Ext
+ * @method urlEncode
+ * @deprecated 4.0.0 Use {@link Ext.Object#toQueryString 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;
+ }
- /**
- * Cancels bubbling of the event.
- */
- stopPropagation : function(){
- var me = this;
- if(me.browserEvent){
- if(me.browserEvent.type == 'mousedown'){
- Ext.EventManager.stoppedMouseDownEvent.fire(me);
- }
- E.stopPropagation(me.browserEvent);
- }
- },
+ return prefix + Ext.Object.toQueryString.apply(Ext.Object, args);
+};
- /**
- * Gets the character code for the event.
- * @return {Number}
- */
- getCharCode : function(){
- return this.charCode || this.keyCode;
- },
+/**
+ * A convenient alias method for {@link Ext.Object#fromQueryString}
+ *
+ * @member Ext
+ * @method urlDecode
+ * @deprecated 4.0.0 Use {@link Ext.Object#fromQueryString Ext.Object.fromQueryString} instead
+ */
+Ext.urlDecode = function() {
+ return Ext.Object.fromQueryString.apply(Ext.Object, arguments);
+};
- /**
- * Returns a normalized keyCode for the event.
- * @return {Number} The key code
- */
- getKey : function(){
- return this.normalizeKey(this.keyCode || this.charCode)
- },
+})();
- // private
- normalizeKey: function(k){
- return Ext.isSafari ? (safariKeys[k] || k) : k;
- },
-
- /**
- * Gets the x coordinate of the event.
- * @return {Number}
- */
- getPageX : function(){
- return this.xy[0];
- },
-
- /**
- * Gets the y coordinate of the event.
- * @return {Number}
- */
- getPageY : function(){
- return this.xy[1];
- },
-
- /**
- * Gets the page coordinates of the event.
- * @return {Array} The xy values like [x, y]
- */
- getXY : function(){
- 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/Mixed} 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){
- return selector ? Ext.fly(this.target).findParent(selector, maxDepth, returnEl) : (returnEl ? Ext.get(this.target) : this.target);
- },
-
- /**
- * Gets the related target.
- * @return {HTMLElement}
- */
- getRelatedTarget : function(){
- return this.browserEvent ? E.getRelatedTarget(this.browserEvent) : null;
- },
-
- /**
- * Normalizes mouse wheel delta across browsers
- * @return {Number} The delta
- */
- getWheelDelta : function(){
- var e = this.browserEvent;
- var delta = 0;
- if(e.wheelDelta){ /* IE/Opera. */
- delta = e.wheelDelta/120;
- }else if(e.detail){ /* Mozilla case. */
- delta = -e.detail/3;
- }
- return delta;
- },
-
- /**
- * 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 {Mixed} el The id, DOM element or Ext.Element to check
- * @param {Boolean} related (optional) true to test if the related target is within el instead of the target
- * @param {Boolean} allowEl {optional} 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 = this[related ? "getRelatedTarget" : "getTarget"]();
- return t && ((allowEl ? (t == Ext.getDom(el)) : false) || Ext.fly(el).contains(t));
- }
- return false;
- }
- };
-
- return new Ext.EventObjectImpl();
-}();
/**
-* @class Ext.EventManager
-*/
-Ext.apply(Ext.EventManager, function(){
- var resizeEvent,
- resizeTask,
- textEvent,
- textSize,
- D = Ext.lib.Dom,
- propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/,
- curWidth = 0,
- curHeight = 0,
- // 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)
- useKeydown = Ext.isWebKit ?
- Ext.num(navigator.userAgent.match(/AppleWebKit\/(\d+)/)[1]) >= 525 :
- !((Ext.isGecko && !Ext.isWindows) || Ext.isOpera);
-
- return {
- // private
- doResizeEvent: function(){
- var h = D.getViewHeight(),
- w = D.getViewWidth();
-
- //whacky problem in IE where the resize event will fire even though the w/h are the same.
- if(curHeight != h || curWidth != w){
- resizeEvent.fire(curWidth = w, curHeight = h);
- }
- },
-
- /**
- * 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){
- if(!resizeEvent){
- resizeEvent = new Ext.util.Event();
- resizeTask = new Ext.util.DelayedTask(this.doResizeEvent);
- Ext.EventManager.on(window, "resize", this.fireWindowResize, this);
- }
- resizeEvent.addListener(fn, scope, options);
- },
-
- // exposed only to allow manual firing
- fireWindowResize : function(){
- if(resizeEvent){
- resizeTask.delay(100);
- }
- },
-
- /**
- * Adds a listener to be notified when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.
- * @param {Function} fn The function the 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}
- */
- onTextResize : function(fn, scope, options){
- if(!textEvent){
- textEvent = new Ext.util.Event();
- var textEl = new Ext.Element(document.createElement('div'));
- textEl.dom.className = 'x-text-resize';
- textEl.dom.innerHTML = 'X';
- textEl.appendTo(document.body);
- textSize = textEl.dom.offsetHeight;
- setInterval(function(){
- if(textEl.dom.offsetHeight != textSize){
- textEvent.fire(textSize, textSize = textEl.dom.offsetHeight);
- }
- }, this.textResizeInterval);
- }
- textEvent.addListener(fn, scope, options);
- },
-
- /**
- * 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){
- if(resizeEvent){
- resizeEvent.removeListener(fn, scope);
- }
- },
-
- // private
- fireResize : function(){
- if(resizeEvent){
- resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
- }
- },
-
- /**
- * The frequency, in milliseconds, to check for text resize events (defaults to 50)
- */
- textResizeInterval : 50,
-
- /**
- * Url used for onDocumentReady with using SSL (defaults to Ext.SSL_SECURE_URL)
- */
- ieDeferSrc : false,
-
- // protected for use inside the framework
- // detects whether we should use keydown or keypress based on the browser.
- useKeydown: useKeydown
- };
-}());
-
-Ext.EventManager.on = Ext.EventManager.addListener;
-
-
-Ext.apply(Ext.EventObjectImpl.prototype, {
- /** 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,
- CONTROL : 17, // legacy
- /** 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,
- PAGEUP : 33, // legacy
- /** Key constant @type Number */
- PAGE_DOWN: 34,
- PAGEDOWN : 34, // legacy
- /** 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,
-
- /** @private */
- 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;
- },
-
- 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
- },
-
- getPoint : function(){
- return new Ext.lib.Point(this.xy[0], this.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);
- }
-});/**
- * @class Ext.Element
- * 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} 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. To - * access the underlying browser event, see {@link Ext.EventObject#browserEvent}. Some older - * browsers may not support the full range of events. Which events are supported is beyond the control of ExtJs.
- * Usage:
-// by id
-var el = Ext.get("my-div");
-
-// by DOM element reference
-var el = Ext.get(myDivElement);
-
- * AnimationsWhen 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);
- *
+ * @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
*
- * 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} animation options specific to Fx effects. The supported - * Element animation configuration options are:
--Option Default Description ---------- -------- --------------------------------------------- -{@link Ext.Fx#duration duration} .35 The duration of the animation in seconds -{@link Ext.Fx#easing easing} easeOut The easing method -{@link Ext.Fx#callback callback} none A function to execute when the anim completes -{@link Ext.Fx#scope scope} this The scope (this) of the callback function + * The date parsing and formatting syntax contains a subset of + * PHP's date() function, and the formats that are + * supported will provide results equivalent to their PHP versions. + * + * The following is a list of all currently supported formats: + *+ * + * Example usage: *+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)\/* + * Example usage (note that you must escape format specifiers with '\\' to render them as character literals): *+ * + * 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. + *-// Element animation options object -var opt = { - {@link Ext.Fx#duration duration}: 1, - {@link Ext.Fx#easing easing}: 'elasticIn', - {@link Ext.Fx#callback callback}: this.foo, - {@link Ext.Fx#scope scope}: this +// 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 +
- *+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" }; -// 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();
-}
- *
- * Also see the {@link #animate} method for another animation technique.
- *Composite (Collections of) Elements
- *For working with collections of Elements, see {@link Ext.CompositeElement}
- * @constructor Create a new Element directly. - * @param {String/HTMLElement} element - * @param {Boolean} forceNew (optional) 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). +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 */ -(function(){ -var DOC = document; - -Ext.Element = function(element, forceNew){ - var dom = typeof element == "string" ? - DOC.getElementById(element) : element, - id; - if(!dom) return null; +/* + * 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. + */ - id = dom.id; +(function() { - if(!forceNew && id && Ext.elCache[id]){ // element object already exists - return Ext.elCache[id].el; - } +// create private copy of Ext'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(/\{(\d+)\}/g, function(m, i) { + return args[i]; + }); +} +Ext.Date = { /** - * The DOM element - * @type HTMLElement + * Returns the current timestamp + * @return {Date} The current timestamp + * @method */ - this.dom = dom; + now: Date.now || function() { + return +new Date(); + }, /** - * The DOM element ID - * @type String + * @private + * Private for now */ - this.id = id || Ext.id(dom); -}; + toString: function(date) { + var pad = Ext.String.leftPad; -var D = Ext.lib.Dom, - DH = Ext.DomHelper, - E = Ext.lib.Event, - A = Ext.lib.Anim, - El = Ext.Element, - EC = Ext.elCache; + 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'); + }, -El.prototype = { /** - * 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 (optional) false to override the default setAttribute to use expandos. - * @return {Ext.Element} this + * Returns the number of milliseconds between two dates + * @param {Date} dateA The first date + * @param {Date} dateB (optional) The second date, defaults to now + * @return {Number} The difference in milliseconds */ - set : function(o, useSet){ - var el = this.dom, - attr, - val, - useSet = (useSet !== false) && !!el.setAttribute; + getElapsed: function(dateA, dateB) { + return Math.abs(dateA - (dateB || new Date())); + }, - for(attr in o){ - if (o.hasOwnProperty(attr)) { - val = o[attr]; - if (attr == 'style') { - DH.applyStyles(el, val); - } else if (attr == 'cls') { - el.className = val; - } else if (useSet) { - el.setAttribute(attr, val); - } else { - el[attr] = val; - } - } + /** + * Global flag which determines if strict date parsing should be used. + * Strict date parsing will not roll-over invalid dates, which is the + * default behaviour of javascript Date objects. + * (see {@link #parse} for more information) + * Defaults to false. + * @static + * @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 this; + + 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 unrecognised characters as literals + }; }, -// 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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. - */ - /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. - */ /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + *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
: Stringstrict
: BooleanTo enable Dates to also be formatted according to that format, a corresponding + * formatting function must be placed into the {@link #formatFunctions} property. + * @property parseFunctions + * @static + * @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 re = new RegExp('\\/Date\\(([-+])?(\\d+)(?:[+-]\\d{4})?\\)\\/'); + var r = (input || '').match(re); + return r? new Date(((r[1] || '') + r[2]) * 1) : null; + } + }, + parseRegexes: [], + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + *
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
: DateTo 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 + * @static + * @type Object */ + formatFunctions: { + "MS": function() { + // UTC milliseconds since Unix epoch (MS-AJAX serialized date format (MRSF)) + return '\\/Date(' + this.getTime() + ')\\/'; + } + }, + + y2kYear : 50, + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + * Date interval constant + * @static + * @type String */ + MILLI : "ms", + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + * Date interval constant + * @static + * @type String */ + SECOND : "s", + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + * Date interval constant + * @static + * @type String */ - /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + MINUTE : "mi", + + /** Date interval constant + * @static + * @type String */ + HOUR : "h", + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + * Date interval constant + * @static + * @type String */ + DAY : "d", + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + * Date interval constant + * @static + * @type String */ + MONTH : "mo", -// 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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + * Date interval constant + * @static + * @type String */ + YEAR : "y", + /** - * @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. - * @param {Object} o The options configuration passed to the {@link #addListener} call. + *
An object hash containing default date values used during date parsing.
+ *The following properties are available:
y
: Numberm
: Numberd
: Numberh
: Numberi
: Numbers
: Numberms
: NumberOverride 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 responsiblity 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
+ * @static
+ * @type Object
*/
+ defaults: {},
+
/**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
+ * An array of textual day names.
+ * Override these values for international dates.
+ * Example:
+ *
+Ext.Date.dayNames = [
+ 'SundayInYourLang',
+ 'MondayInYourLang',
+ ...
+];
+
+ * @type Array
+ * @static
*/
+ dayNames : [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ],
-
-// 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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
+ * An array of textual month names.
+ * Override these values for international dates.
+ * Example:
+ *
+Ext.Date.monthNames = [
+ 'JanInYourLang',
+ 'FebInYourLang',
+ ...
+];
+
+ * @type Array
+ * @static
*/
+ monthNames : [
+ "January",
+ "February",
+ "March",
+ "April",
+ "May",
+ "June",
+ "July",
+ "August",
+ "September",
+ "October",
+ "November",
+ "December"
+ ],
+
/**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
-
-// 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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
-
-// 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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
-
-// 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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
- */
- /**
- * @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.
- * @param {Object} o The options configuration passed to the {@link #addListener} call.
+ * 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 = {
+ 'ShortJanNameInYourLang':0,
+ 'ShortFebNameInYourLang':1,
+ ...
+};
+
+ * @type Object
+ * @static
*/
-
+ monthNumbers : {
+ Jan:0,
+ Feb:1,
+ Mar:2,
+ Apr:3,
+ May:4,
+ Jun:5,
+ Jul:6,
+ Aug:7,
+ Sep:8,
+ Oct:9,
+ Nov:10,
+ Dec:11
+ },
/**
- * The default unit to append to CSS values where a unit isn't provided (defaults to px).
+ * 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 defaults to m/d/Y
, but may be overridden in a locale file.
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:this
reference) in which the handler function is executed.
- * If omitted, defaults to this Element.
- * Combining Options
- * In the following examples, the shorthand form {@link #on} is used rather than the more verbose
- * addListener. The two are equivalent. 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.
-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:
-<div id='elId'>
- <p id='p1'>paragraph one</p>
- <p id='p2' class='clickable'>paragraph two</p>
- <p id='p3'>paragraph three</p>
-</div>
-// 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.Element} this
+ * 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.
+ * @static
+ * @method
*/
- addListener : function(eventName, fn, scope, options){
- Ext.EventManager.on(this.dom, eventName, fn, scope || this, options);
- return this;
- },
+ formatContainsDateInfo : (function(){
+ var stripEscapeRe = /(\\.)/g,
+ dateInfoRe = /([djzmnYycU]|MS)/;
+
+ return function(format){
+ return dateInfoRe.test(format.replace(stripEscapeRe, ''));
+ };
+ })(),
/**
- * Removes an event handler from this element. The shorthand version {@link #un} is equivalent.
- * Note: if a scope was explicitly specified when {@link #addListener adding} the
- * listener, the same scope must be specified here.
+ * 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:
*
-el.removeListener('click', this.handlerFn);
-// or
-el.un('click', this.handlerFn);
+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
- * @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 #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.
- * @return {Ext.Element} this
+ * @type Object
+ * @static
*/
- removeListener : function(eventName, fn, scope){
- Ext.EventManager.removeListener(this.dom, eventName, fn, scope || this);
- return this;
- },
+ formatCodes : {
+ d: "Ext.String.leftPad(this.getDate(), 2, '0')",
+ D: "Ext.Date.getShortDayName(this.getDay())", // get localised 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 localised 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)",
- /**
- * Removes all previous added listeners from this element
- * @return {Ext.Element} this
- */
- removeAllListeners : function(){
- Ext.EventManager.removeAll(this.dom);
- return this;
- },
+ c: function() { // ISO-8601 -- GMT format
+ for (var c = "Y-m-dTH:i:sP", code = [], i = 0, l = c.length; i < l; ++i) {
+ var 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(" + ");
+ },
+ */
- /**
- * Recursively removes all previous added listeners from this element and its children
- * @return {Ext.Element} this
- */
- purgeAllListeners : function() {
- Ext.EventManager.purgeElement(this, true);
- return this;
- },
- /**
- * @private Test if size has a unit, otherwise appends the default
- */
- addUnits : function(size){
- if(size === "" || size == "auto" || size === undefined){
- size = size || '';
- } else if(!isNaN(size) || !unitPattern.test(size)){
- size = size + (this.defaultUnit || 'px');
- }
- return size;
+ U: "Math.round(this.getTime() / 1000)"
},
/**
- * Updates the innerHTML of this Element - * from a specified URL. Note that this is subject to the Same Origin Policy
- *Updating innerHTML of an element will not execute embedded <script> elements. This is a browser restriction.
- * @param {Mixed} options. Either a sring containing the URL from which to load the HTML, or an {@link Ext.Ajax#request} options object specifying - * exactly how to request the HTML. - * @return {Ext.Element} this + * 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. + * @static */ - load : function(url, params, cb){ - Ext.Ajax.request(Ext.apply({ - params: params, - url: url.url || url, - callback: cb, - el: this.dom, - indicatorText: url.indicatorText || '' - }, Ext.isObject(url) ? url : {})); - return this; - }, + isValid : function(y, m, d, h, i, s, ms) { + // setup defaults + h = h || 0; + i = i || 0; + s = s || 0; + ms = ms || 0; - /** - * Tests various css rules/browsers to determine if this element uses a border box - * @return {Boolean} - */ - isBorderBox : function(){ - return noBoxAdjust[(this.dom.tagName || "").toLowerCase()] || Ext.isBorderBox; + // 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(); }, /** - *Removes this element's dom reference. Note that event and cache removal is handled at {@link Ext#removeNode}
- */ - remove : function(){ - var me = this, - dom = me.dom; + * 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();
- if (dom) {
- delete me.dom;
- Ext.removeNode(dom);
- }
- },
+//dt = Thu May 25 2006 (today's month/day in 2006)
+dt = Ext.Date.parse("2006", "Y");
- /**
- * 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 (optional) The scope (this
reference) in which the functions are executed. Defaults to the Element's DOM element.
- * @param {Object} options (optional) Options for the listener. See {@link Ext.util.Observable#addListener the options parameter}.
- * @return {Ext.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;
- },
+//dt = Sun Jan 15 2006 (all date parts specified)
+dt = Ext.Date.parse("2006-01-15", "Y-m-d");
- /**
- * 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
+//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 (optional) True to validate date strings while parsing (i.e. prevents javascript Date "rollover")
+ (defaults to false). Invalid date strings will return null when parsed.
+ * @return {Date} The parsed Date.
+ * @static
*/
- contains : function(el){
- return !el ? false : Ext.lib.Dom.isAncestor(this.dom, el.dom ? el.dom : el);
+ parse : function(input, format, strict) {
+ var p = utilDate.parseFunctions;
+ if (p[format] == null) {
+ utilDate.createParser(format);
+ }
+ return p[format](input, Ext.isDefined(strict) ? strict : utilDate.useStrict);
},
- /**
- * 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
- * @deprecated
- */
- getAttributeNS : function(ns, name){
- return this.getAttribute(name, ns);
+ // Backwards compat
+ parseDate: function(input, format, strict){
+ return utilDate.parse(input, format, strict);
},
- /**
- * Returns the value of an attribute from the element's underlying DOM node.
- * @param {String} name The attribute name
- * @param {String} namespace (optional) The namespace in which to look for the attribute
- * @return {String} The attribute value
- */
- getAttribute : Ext.isIE ? function(name, ns){
- var d = this.dom,
- type = typeof d[ns + ":" + name];
- if(['undefined', 'unknown'].indexOf(type) == -1){
- return d[ns + ":" + name];
+ // 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
}
- return d[name];
- } : function(name, ns){
- var d = this.dom;
- return d.getAttributeNS(ns, name) || d.getAttribute(ns + ":" + name) || d.getAttribute(name) || d[name];
+
+ // note: unknown characters are treated as literals
+ return f || ("'" + Ext.String.escape(character) + "'");
},
- /**
- * Update the innerHTML of this element
- * @param {String} html The new HTML
- * @return {Ext.Element} this
- */
- update : function(html) {
- if (this.dom) {
- this.dom.innerHTML = html;
+ // private
+ createFormat : function(format) {
+ var code = [],
+ special = false,
+ ch = '';
+
+ for (var 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));
+ }
}
- return this;
- }
-};
+ utilDate.formatFunctions[format] = Ext.functionFactory("return " + code.join('+'));
+ },
-var ep = El.prototype;
+ // private
+ createParser : (function() {
+ var code = [
+ "var dt, y, m, d, h, i, s, ms, o, z, zz, u, v,",
+ "def = Ext.Date.defaults,",
+ "results = String(input).match(Ext.Date.parseRegexes[{0}]);", // either null, or an array of matched strings
-El.addMethods = function(o){
- Ext.apply(ep, o);
-};
+ "if(results){",
+ "{1}",
-/**
- * Appends an event handler (shorthand for {@link #addListener}).
- * @param {String} eventName The name of event to handle.
- * @param {Function} fn The handler function the event invokes.
- * @param {Object} scope (optional) The scope (this
reference) in which the handler function is executed.
- * @param {Object} options (optional) An object containing standard {@link #addListener} options
- * @member Ext.Element
- * @method on
- */
-ep.on = ep.addListener;
+ "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 = Ext.Date.clearTime(new Date);",
-/**
- * Removes an event handler from this element (see {@link #removeListener} for additional notes).
- * @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 #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.
- * @return {Ext.Element} this
- * @member Ext.Element
- * @method un
- */
-ep.un = ep.removeListener;
+ // date calculations (note: these calculations create a dependency on Ext.Number.from())
+ "y = Ext.Number.from(y, Ext.Number.from(def.y, dt.getFullYear()));",
+ "m = Ext.Number.from(m, Ext.Number.from(def.m - 1, dt.getMonth()));",
+ "d = Ext.Number.from(d, Ext.Number.from(def.d, dt.getDate()));",
-/**
- * true to automatically adjust width and height settings for box-model issues (default to true)
- */
-ep.autoBoxAdjust = true;
+ // time calculations (note: these calculations create a dependency on Ext.Number.from())
+ "h = Ext.Number.from(h, Ext.Number.from(def.h, dt.getHours()));",
+ "i = Ext.Number.from(i, Ext.Number.from(def.i, dt.getMinutes()));",
+ "s = Ext.Number.from(s, Ext.Number.from(def.s, dt.getSeconds()));",
+ "ms = Ext.Number.from(ms, Ext.Number.from(def.ms, dt.getMilliseconds()));",
-// private
-var unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i,
- docEl;
+ "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
-/**
- * @private
- */
+ // create Date object representing January 1st for the given year
+ // handle years < 100 appropriately
+ "v = Ext.Date.add(new Date(y < 100 ? 100 : y, 0, 1, h, i, s, ms), Ext.Date.YEAR, y < 100 ? y - 100 : 0);",
-/**
- * Retrieves Ext.Element objects.
- * This method does not retrieve {@link Ext.Component Component}s. This method - * retrieves Ext.Element objects which encapsulate DOM elements. To retrieve a Component by - * its ID, use {@link Ext.ComponentMgr#get}.
- *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 {Mixed} el The id of the node, a DOM Node or an existing Element. - * @return {Element} The Element object (or null if no matching element was found) - * @static - * @member Ext.Element - * @method get - */ -El.get = function(el){ - var ex, - elm, - id; - if(!el){ return null; } - if (typeof el == "string") { // element id - if (!(elm = DOC.getElementById(el))) { - return null; - } - if (EC[el] && EC[el].el) { - ex = EC[el].el; - ex.dom = elm; - } else { - ex = El.addToCache(new El(elm)); - } - return ex; - } else if (el.tagName) { // dom element - if(!(id = el.id)){ - id = Ext.id(el); - } - if (EC[id] && EC[id].el) { - ex = EC[id].el; - ex.dom = el; - } else { - ex = El.addToCache(new El(el)); - } - return ex; - } else if (el instanceof El) { - if(el != docEl){ - // refresh dom element in case no longer valid, - // catch case where it hasn't been appended - - // If an el instance is passed, don't pass to getElementById without some kind of id - if (Ext.isIE && (el.id == undefined || el.id == '')) { - el.dom = el.dom; - } else { - el.dom = DOC.getElementById(el.id) || el.dom; - } - } - return el; - } else if(el.isComposite) { - return el; - } else if(Ext.isArray(el)) { - return El.select(el); - } else if(el == DOC) { - // create a bogus element object representing the document object - if(!docEl){ - var f = function(){}; - f.prototype = El.prototype; - docEl = new f(); - docEl.dom = DOC; - } - return docEl; - } - return null; -}; + // then add day of year, checking for Date "rollover" if necessary + "v = !strict? v : (strict === true && (z <= 364 || (Ext.Date.isLeapYear(v) && z <= 365))? Ext.Date.add(v, Ext.Date.DAY, z) : null);", + "}else if(strict === true && !Ext.Date.isValid(y, m + 1, d, h, i, s, ms)){", // check for Date "rollover" + "v = null;", // invalid date, so return null + "}else{", + // plain old Date object + // handle years < 100 properly + "v = Ext.Date.add(new Date(y < 100 ? 100 : y, m, d, h, i, s, ms), Ext.Date.YEAR, y < 100 ? y - 100 : 0);", + "}", + "}", + "}", -El.addToCache = function(el, id){ - id = id || el.id; - EC[id] = { - el: el, - data: {}, - events: {} - }; - return el; -}; + "if(v){", + // favour UTC offset over GMT offset + "if(zz != null){", + // reset to UTC, then add offset + "v = Ext.Date.add(v, Ext.Date.SECOND, -v.getTimezoneOffset() * 60 - zz);", + "}else if(o){", + // reset to GMT, then add offset + "v = Ext.Date.add(v, Ext.Date.MINUTE, -v.getTimezoneOffset() + (sn == '+'? -1 : 1) * (hr * 60 + mn));", + "}", + "}", -// private method for getting and setting element data -El.data = function(el, key, value){ - el = El.get(el); - if (!el) { - return null; - } - var c = EC[el.id].data; - if(arguments.length == 2){ - return c[key]; - }else{ - return (c[key] = value); - } -}; + "return v;" + ].join('\n'); -// 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(El.collectorThreadId); - } else { - var eid, - el, - d, - o; + return function(format) { + var regexNum = utilDate.parseRegexes.length, + currentGroup = 1, + calc = [], + regex = [], + special = false, + ch = ""; - for(eid in EC){ - o = EC[eid]; - if(o.skipGC){ - continue; - } - el = o.el; - d = el.dom; - // ------------------------------------------------------- - // Determining what is garbage: - // ------------------------------------------------------- - // !d - // dom node is null, definitely 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 && !DOC.getElementById(eid))){ - if(Ext.enableListenerCollection){ - Ext.EventManager.removeAll(d); - } - delete EC[eid]; - } - } - // Cleanup IE Object leaks - if (Ext.isIE) { - var t = {}; - for (eid in EC) { - t[eid] = EC[eid]; + for (var i = 0; i < format.length; ++i) { + ch = format.charAt(i); + if (!special && ch == "\\") { + special = true; + } else if (special) { + special = false; + regex.push(Ext.String.escape(ch)); + } else { + var obj = utilDate.formatCodeToRegex(ch, currentGroup); + currentGroup += obj.g; + regex.push(obj.s); + if (obj.g && obj.c) { + calc.push(obj.c); + } + } } - EC = Ext.elCache = t; - } - } -} -El.collectorThreadId = setInterval(garbageCollect, 30000); - -var flyFn = function(){}; -flyFn.prototype = El.prototype; - -// dom is optional -El.Flyweight = function(dom){ - this.dom = dom; -}; - -El.Flyweight.prototype = new flyFn(); -El.Flyweight.prototype.isFlyweight = true; -El._flyweights = {}; - -/** - *Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - - * the dom node can be overwritten by other code. Shorthand of {@link Ext.Element#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} - * will be more appropriate to take advantage of the caching provided by the Ext.Element class.
- * @param {String/HTMLElement} el The dom node or id - * @param {String} named (optional) Allows for creation of named reusable flyweights to prevent conflicts - * (e.g. internally Ext uses "_global") - * @return {Element} The shared Element object (or null if no matching element was found) - * @member Ext.Element - * @method fly - */ -El.fly = function(el, named){ - var ret = null; - named = named || '_global'; - - if (el = Ext.getDom(el)) { - (El._flyweights[named] = El._flyweights[named] || new El.Flyweight()).dom = el; - ret = El._flyweights[named]; - } - return ret; -}; - -/** - * Retrieves Ext.Element objects. - *This method does not retrieve {@link Ext.Component Component}s. This method - * retrieves Ext.Element objects which encapsulate DOM elements. To retrieve a Component by - * its ID, use {@link Ext.ComponentMgr#get}.
- *Uses simple caching to consistently return the same object. Automatically fixes if an - * object was recreated with the same id via AJAX or DOM.
- * Shorthand of {@link Ext.Element#get} - * @param {Mixed} el The id of the node, a DOM Node or an existing Element. - * @return {Element} The Element object (or null if no matching element was found) - * @member Ext - * @method get - */ -Ext.get = El.get; -/** - *Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - - * the dom node can be overwritten by other code. Shorthand of {@link Ext.Element#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} - * will be more appropriate to take advantage of the caching provided by the Ext.Element class.
- * @param {String/HTMLElement} el The dom node or id - * @param {String} named (optional) Allows for creation of named reusable flyweights to prevent conflicts - * (e.g. internally Ext uses "_global") - * @return {Element} The shared Element object (or null if no matching element was found) - * @member Ext - * @method fly - */ -Ext.fly = El.fly; + utilDate.parseRegexes[regexNum] = new RegExp("^" + regex.join('') + "$", 'i'); + utilDate.parseFunctions[format] = Ext.functionFactory("input", "strict", xf(code, regexNum, calc.join(''))); + }; + })(), -// speedy lookup for elements never to box adjust -var noBoxAdjust = Ext.isStrict ? { - select:1 -} : { - input:1, select:1, textarea:1 -}; -if(Ext.isIE || Ext.isGecko){ - noBoxAdjust['button'] = 1; -} + // 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:"(\\d{2})" // day of month with leading zeroes (01 - 31) + }, + j: { + g:1, + c:"d = parseInt(results[{0}], 10);\n", + s:"(\\d{1,2})" // 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:0, + c:null, + s:"(?:\\d{2})" // ISO-8601 week number (with leading zero) + }, + F: function() { + return { + g:1, + c:"m = parseInt(Ext.Date.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:"(\\d{2})" // month number with leading zeros (01 - 12) + }, + n: { + g:1, + c:"m = parseInt(results[{0}], 10) - 1;\n", + s:"(\\d{1,2})" // 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: function() { + return utilDate.formatCodeToRegex("Y"); + }, + 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 > Ext.Date.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)" + }, + 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)" + }, + g: function() { + return utilDate.formatCodeToRegex("G"); + }, + G: { + g:1, + c:"h = parseInt(results[{0}], 10);\n", + s:"(\\d{1,2})" // 24-hr format of an hour without leading zeroes (0 - 23) + }, + h: function() { + return utilDate.formatCodeToRegex("H"); + }, + H: { + g:1, + c:"h = parseInt(results[{0}], 10);\n", + s:"(\\d{2})" // 24-hr format of an hour with leading zeroes (00 - 23) + }, + i: { + g:1, + c:"i = parseInt(results[{0}], 10);\n", + s:"(\\d{2})" // minutes with leading zeros (00 - 59) + }, + s: { + g:1, + c:"s = parseInt(results[{0}], 10);\n", + s:"(\\d{2})" // 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,4}" // timezone abbrev. may be between 1 - 4 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')} + ]; -})(); -/** - * @class Ext.Element - */ -Ext.Element.addMethods({ - /** - * Stops the specified event(s) from bubbling and optionally prevents the default action - * @param {String/Array} eventName an event / array of events to stop from bubbling - * @param {Boolean} preventDefault (optional) true to prevent the default action too - * @return {Ext.Element} this - */ - swallowEvent : function(eventName, preventDefault){ - var me = this; - function fn(e){ - e.stopPropagation(); - if(preventDefault){ - e.preventDefault(); + for (var 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 } - if(Ext.isArray(eventName)){ - Ext.each(eventName, function(e) { - me.on(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} object 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); - }); + //Old Ext.Date prototype methods. + // private + dateFormat: function(date, format) { + return utilDate.format(date, format); }, /** - * Removes worthless text nodes - * @param {Boolean} forceReclean (optional) 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. + * 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 */ - clean : function(forceReclean){ - var me = this, - dom = me.dom, - n = dom.firstChild, - ni = -1; - - if(Ext.Element.data(dom, 'isCleaned') && forceReclean !== true){ - return me; - } - - while(n){ - var nx = n.nextSibling; - if(n.nodeType == 3 && !/\S/.test(n.nodeValue)){ - dom.removeChild(n); - }else{ - n.nodeIndex = ++ni; - } - n = nx; + format: function(date, format) { + if (utilDate.formatFunctions[format] == null) { + utilDate.createFormat(format); } - Ext.Element.data(dom, 'isCleaned', true); - return me; + var result = utilDate.formatFunctions[format].call(date); + return result + ''; }, /** - * Direct access to the Updater {@link Ext.Updater#update} method. The method takes the same object - * parameter as {@link Ext.Updater#update} - * @return {Ext.Element} this + * 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' ...). */ - load : function(){ - var um = this.getUpdater(); - um.update.apply(um, arguments); - return this; + 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,4})(?:[\-+][0-9]{4})?(?: -?\d+)?)$/, "$1$2").replace(/[^A-Z]/g, ""); }, /** - * Gets this element's {@link Ext.Updater Updater} - * @return {Ext.Updater} The Updater - */ - getUpdater : function(){ - return this.updateManager || (this.updateManager = new Ext.Updater(this)); + * Get the offset from GMT of the current date (equivalent to the format specifier 'O'). + * @param {Date} date The date + * @param {Boolean} colon (optional) true to separate the hours and minutes with a colon (defaults to false). + * @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"); }, /** - * Update the innerHTML of this element, optionally searching for and processing scripts - * @param {String} html The new HTML - * @param {Boolean} loadScripts (optional) True to look for and process scripts (defaults to false) - * @param {Function} callback (optional) For async script loading you can be notified when the update completes - * @return {Ext.Element} this + * 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). */ - update : function(html, loadScripts, callback){ - if (!this.dom) { - return this; - } - html = html || ""; + getDayOfYear: function(date) { + var num = 0, + d = Ext.Date.clone(date), + m = date.getMonth(), + i; - if(loadScripts !== true){ - this.dom.innerHTML = html; - if(typeof callback == 'function'){ - callback(); - } - return this; + for (i = 0, d.setDate(1), d.setMonth(0); i < m; d.setMonth(++i)) { + num += utilDate.getDaysInMonth(d); } + return num + date.getDate() - 1; + }, - var id = Ext.id(), - dom = this.dom; + /** + * 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 - html += ''; + 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(); - Ext.lib.Event.onAvailable(id, function(){ - var DOC = document, - hd = DOC.getElementsByTagName("head")[0], - re = /(?: + * + * + * Refer to config options of {@link Ext.Loader} for the list of possible properties. + * + * @param {String/Object} name Name of the value to override, or a config object to override multiple values. + * @param {Object} value (optional) The new value to set, needed if first parameter is String. + * @return {Ext.Loader} this + */ + setConfig: function(name, value) { + if (Ext.isObject(name) && arguments.length === 1) { + Ext.Object.merge(this.config, name); + } + else { + this.config[name] = (Ext.isObject(value)) ? Ext.Object.merge(this.config[name], value) : value; + } -// custom: fade out from the element's current opacity to 25% over 2 seconds -el.fadeOut({ endOpacity: .25, duration: 2}); + return this; + }, -// common config options shown with default values -el.fadeOut({ - endOpacity: 0, //can be any value between 0 and 1 (e.g. .5) - easing: 'easeOut', - duration: .5, - remove: false, - useDisplay: false -}); - - * @param {Object} options (optional) Object literal with any of the Fx config options - * @return {Ext.Element} The Element - */ - fadeOut : function(o){ - o = getObject(o); - var me = this, - dom = me.dom, - style = dom.style, - to = o.endOpacity || 0; - - me.queueFx(o, function(){ - arguments.callee.anim = fly(dom).fxanim({ - opacity : {to : to}}, - o, - NULL, - .5, - EASEOUT, - function(){ - if(to == 0){ - Ext.Element.data(dom, 'visibilityMode') == Ext.Element.DISPLAY || o.useDisplay ? - style.display = "none" : - style.visibility = HIDDEN; - - fly(dom).clearOpacity(); - } - fly(dom).afterFx(o); - }); - }); - return me; - }, + /** + * 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/Mixed} + */ + getConfig: function(name) { + if (name) { + return this.config[name]; + } - /** - * 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);
+ return this.config;
+ },
-// 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: .35
- }
-);
-
- * @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 Fx config options
- * @return {Ext.Element} The Element
- */
- scale : function(w, h, o){
- this.shift(Ext.apply({}, o, {
- width: w,
- height: h
- }));
- return this;
- },
+ /**
+ * 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) {
+ this.config.paths[name] = path;
- /**
- * 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 });
+ return this;
+ }),
-// 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: .35
-});
-
- * @param {Object} options Object literal with any of the Fx config options
- * @return {Ext.Element} The Element
- */
- shift : function(o){
- o = getObject(o);
- var dom = this.dom,
- a = {};
-
- this.queueFx(o, function(){
- for (var prop in o) {
- if (o[prop] != UNDEFINED) {
- a[prop] = {to : o[prop]};
+ /**
+ * 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 = this.config.paths,
+ prefix = this.getPrefix(className);
+
+ if (prefix.length > 0) {
+ if (prefix === className) {
+ return paths[prefix];
}
- }
-
- a.width ? a.width.to = fly(dom).adjustWidth(o.width) : a;
- a.height ? a.height.to = fly(dom).adjustWidth(o.height) : a;
-
- if (a.x || a.y || a.xy) {
- a.points = a.xy ||
- {to : [ a.x ? a.x.to : fly(dom).getX(),
- a.y ? a.y.to : fly(dom).getY()]};
+
+ path = paths[prefix];
+ className = className.substring(prefix.length + 1);
}
- arguments.callee.anim = fly(dom).fxanim(a,
- o,
- MOTION,
- .35,
- EASEOUT,
- function(){
- fly(dom).afterFx(o);
- });
- });
- return this;
- },
+ if (path.length > 0) {
+ path += '/';
+ }
- /**
- * 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();
+ return path.replace(/\/\.\//g, '/') + className.replace(/\./g, "/") + '.js';
+ },
-// custom: slide the element out to the right with a 2-second duration
-el.ghost('r', { duration: 2 });
+ /**
+ * @private
+ * @param {String} className
+ */
+ getPrefix: function(className) {
+ var paths = this.config.paths,
+ prefix, deepestPrefix = '';
-// common config options shown with default values
-el.ghost('b', {
- easing: 'easeOut',
- duration: .5,
- remove: false,
- useDisplay: false
-});
-
- * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to bottom: 'b')
- * @param {Object} options (optional) Object literal with any of the Fx config options
- * @return {Ext.Element} The Element
- */
- ghost : function(anchor, o){
- o = getObject(o);
- var me = this,
- dom = me.dom,
- st = dom.style,
- a = {opacity: {to: 0}, points: {}},
- pt = a.points,
- r,
- w,
- h;
-
- anchor = anchor || "b";
+ if (paths.hasOwnProperty(className)) {
+ return className;
+ }
- me.queueFx(o, function(){
- // restore values after effect
- r = fly(dom).getFxRestore();
- w = fly(dom).getWidth();
- h = fly(dom).getHeight();
-
- function after(){
- o.useDisplay ? fly(dom).setDisplayed(FALSE) : fly(dom).hide();
- fly(dom).clearOpacity();
- fly(dom).setPositioning(r.pos);
- st.width = r.width;
- st.height = r.height;
- fly(dom).afterFx(o);
+ for (prefix in paths) {
+ if (paths.hasOwnProperty(prefix) && prefix + '.' === className.substring(0, prefix.length + 1)) {
+ if (prefix.length > deepestPrefix.length) {
+ deepestPrefix = prefix;
+ }
+ }
}
-
- pt.by = fly(dom).switchStatements(anchor.toLowerCase(), function(v1,v2){ return [v1, v2];}, {
- t : [0, -h],
- l : [-w, 0],
- r : [w, 0],
- b : [0, h],
- tl : [-w, -h],
- bl : [-w, h],
- br : [w, h],
- tr : [w, -h]
- });
-
- arguments.callee.anim = fly(dom).fxanim(a,
- o,
- MOTION,
- .5,
- EASEOUT, after);
- });
- return me;
- },
- /**
- * Ensures that all effects queued after syncFx is called on the element are
- * run concurrently. This is the opposite of {@link #sequenceFx}.
- * @return {Ext.Element} The Element
- */
- syncFx : function(){
- var me = this;
- me.fxDefaults = Ext.apply(me.fxDefaults || {}, {
- block : FALSE,
- concurrent : TRUE,
- stopFx : FALSE
- });
- return me;
- },
+ return deepestPrefix;
+ },
- /**
- * Ensures that all effects queued after sequenceFx is called on the element are
- * run in sequence. This is the opposite of {@link #syncFx}.
- * @return {Ext.Element} The Element
- */
- sequenceFx : function(){
- var me = this;
- me.fxDefaults = Ext.apply(me.fxDefaults || {}, {
- block : FALSE,
- concurrent : FALSE,
- stopFx : FALSE
- });
- return me;
- },
+ /**
+ * 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 = this.queue.length,
+ i, item, j, requires;
- /* @private */
- nextFx : function(){
- var ef = getQueue(this.dom.id)[0];
- if(ef){
- ef.call(this);
- }
- },
+ if (ln === 0) {
+ this.triggerReady();
+ return;
+ }
- /**
- * Returns true if the element has any effects actively running or queued, else returns false.
- * @return {Boolean} True if element has active effects, else false
- */
- hasActiveFx : function(){
- return getQueue(this.dom.id)[0];
- },
+ for (i = 0; i < ln; i++) {
+ item = this.queue[i];
- /**
- * Stops any running effects and clears the element's internal effects queue if it contains
- * any additional effects that haven't started yet.
- * @return {Ext.Element} The Element
- */
- stopFx : function(finish){
- var me = this,
- id = me.dom.id;
- if(me.hasActiveFx()){
- var cur = getQueue(id)[0];
- if(cur && cur.anim){
- if(cur.anim.isAnimated){
- setQueue(id, [cur]); //clear
- cur.anim.stop(finish !== undefined ? finish : TRUE);
- }else{
- setQueue(id, []);
+ 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 > this.numLoadedFiles) {
+ continue;
+ }
+
+ j = 0;
+
+ do {
+ if (Manager.isCreated(requires[j])) {
+ // Take out from the queue
+ Ext.Array.erase(requires, j, 1);
+ }
+ else {
+ j++;
+ }
+ } while (j < requires.length);
+
+ if (item.requires.length === 0) {
+ Ext.Array.erase(this.queue, i, 1);
+ item.callback.call(item.scope);
+ this.refreshQueue();
+ break;
+ }
}
}
- }
- return me;
- },
- /* @private */
- beforeFx : function(o){
- if(this.hasActiveFx() && !o.concurrent){
- if(o.stopFx){
- this.stopFx();
- return TRUE;
- }
- return FALSE;
- }
- return TRUE;
- },
+ return this;
+ },
- /**
- * Returns true if the element is currently blocking so that no other effect can be queued
- * until this effect is finished, else returns false if blocking is not set. This is commonly
- * used to ensure that an effect initiated by a user action runs to completion prior to the
- * same effect being restarted (e.g., firing only one effect even if the user clicks several times).
- * @return {Boolean} True if blocking, else false
- */
- hasFxBlock : function(){
- var q = getQueue(this.dom.id);
- return q && q[0] && q[0].block;
- },
+ /**
+ * Inject a script element to document's head, call onLoad and onError accordingly
+ * @private
+ */
+ injectScriptElement: function(url, onLoad, onError, scope) {
+ var script = document.createElement('script'),
+ me = this,
+ onLoadFn = function() {
+ me.cleanupScriptElement(script);
+ onLoad.call(scope);
+ },
+ onErrorFn = function() {
+ me.cleanupScriptElement(script);
+ onError.call(scope);
+ };
- /* @private */
- queueFx : function(o, fn){
- var me = fly(this.dom);
- if(!me.hasFxBlock()){
- Ext.applyIf(o, me.fxDefaults);
- if(!o.concurrent){
- var run = me.beforeFx(o);
- fn.block = o.block;
- getQueue(me.dom.id).push(fn);
- if(run){
- me.nextFx();
+ script.type = 'text/javascript';
+ script.src = url;
+ script.onload = onLoadFn;
+ script.onerror = onErrorFn;
+ script.onreadystatechange = function() {
+ if (this.readyState === 'loaded' || this.readyState === 'complete') {
+ onLoadFn();
+ }
+ };
+
+ this.documentHead.appendChild(script);
+
+ return script;
+ },
+
+ /**
+ * @private
+ */
+ cleanupScriptElement: function(script) {
+ script.onload = null;
+ script.onreadystatechange = null;
+ script.onerror = null;
+
+ return this;
+ },
+
+ /**
+ * Load a script file, supports both asynchronous and synchronous approaches
+ *
+ * @param {String} url
+ * @param {Function} onLoad
+ * @param {Scope} scope
+ * @param {Boolean} synchronous
+ * @private
+ */
+ loadScriptFile: function(url, onLoad, onError, scope, synchronous) {
+ var me = this,
+ noCacheUrl = url + (this.getConfig('disableCaching') ? ('?' + this.getConfig('disableCachingParam') + '=' + Ext.Date.now()) : ''),
+ fileName = url.split('/').pop(),
+ isCrossOriginRestricted = false,
+ xhr, status, onScriptError;
+
+ scope = scope || this;
+
+ this.isLoading = true;
+
+ if (!synchronous) {
+ onScriptError = function() {
+ onError.call(scope, "Failed loading '" + url + "', please verify that the file exists", synchronous);
+ };
+
+ if (!Ext.isReady && Ext.onDocumentReady) {
+ Ext.onDocumentReady(function() {
+ me.injectScriptElement(noCacheUrl, onLoad, onScriptError, scope);
+ });
+ }
+ else {
+ this.injectScriptElement(noCacheUrl, onLoad, onScriptError, scope);
}
- }else{
- fn.call(me);
}
- }
- return me;
- },
+ else {
+ if (typeof XMLHttpRequest !== 'undefined') {
+ xhr = new XMLHttpRequest();
+ } else {
+ xhr = new ActiveXObject('Microsoft.XMLHTTP');
+ }
- /* @private */
- fxWrap : function(pos, o, vis){
- var dom = this.dom,
- wrap,
- wrapXY;
- if(!o.wrap || !(wrap = Ext.getDom(o.wrap))){
- if(o.fixPosition){
- wrapXY = fly(dom).getXY();
+ try {
+ xhr.open('GET', noCacheUrl, false);
+ xhr.send(null);
+ } catch (e) {
+ isCrossOriginRestricted = true;
+ }
+
+ status = (xhr.status === 1223) ? 204 : xhr.status;
+
+ if (!isCrossOriginRestricted) {
+ isCrossOriginRestricted = (status === 0);
+ }
+
+ if (isCrossOriginRestricted
+ ) {
+ onError.call(this, "Failed loading synchronously via XHR: '" + url + "'; It's likely that the file is either " +
+ "being loaded from a different domain or from the local file system whereby cross origin " +
+ "requests are not allowed due to security reasons. Use asynchronous loading with " +
+ "Ext.require instead.", synchronous);
+ }
+ else if (status >= 200 && status < 300
+ ) {
+ // Firebug friendly, file names are still shown even though they're eval'ed code
+ new Function(xhr.responseText + "\n//@ sourceURL=" + fileName)();
+
+ onLoad.call(scope);
+ }
+ else {
+ onError.call(this, "Failed loading synchronously via XHR: '" + url + "'; please " +
+ "verify that the file exists. " +
+ "XHR status code: " + status, synchronous);
+ }
+
+ // Prevent potential IE memory leak
+ xhr = null;
}
- var div = document.createElement("div");
- div.style.visibility = vis;
- wrap = dom.parentNode.insertBefore(div, dom);
- fly(wrap).setPositioning(pos);
- if(fly(wrap).isStyle(POSITION, "static")){
- fly(wrap).position("relative");
+ },
+
+ /**
+ * 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, e.g.:
+ *
+ * Ext.exclude('Ext.data.*').require('*');
+ *
+ * Ext.exclude('widget.button*').require('widget.*');
+ *
+ * {@link Ext#exclude Ext.exclude} is alias for {@link Ext.Loader#exclude Ext.Loader.exclude} for convenience.
+ *
+ * @param {String/[String]} excludes
+ * @return {Object} object contains `require` method for chaining
+ */
+ exclude: function(excludes) {
+ var me = this;
+
+ return {
+ require: function(expressions, fn, scope) {
+ return me.require(expressions, fn, scope, excludes);
+ },
+
+ syncRequire: function(expressions, fn, scope) {
+ return me.syncRequire(expressions, fn, scope, excludes);
+ }
+ };
+ },
+
+ /**
+ * 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 Ext.syncRequire} is alias for {@link Ext.Loader#syncRequire Ext.Loader.syncRequire} for convenience.
+ *
+ * @param {String/[String]} 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/[String]} excludes (Optional) Classes to be excluded, useful when being used with expressions
+ */
+ syncRequire: function() {
+ this.syncModeEnabled = true;
+ this.require.apply(this, arguments);
+ this.refreshQueue();
+ this.syncModeEnabled = false;
+ },
+
+ /**
+ * 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 Ext.require} is alias for {@link Ext.Loader#require Ext.Loader.require} for convenience.
+ *
+ * @param {String/[String]} 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/[String]} excludes (Optional) Classes to be excluded, useful when being used with expressions
+ */
+ require: function(expressions, fn, scope, excludes) {
+ var filePath, expression, exclude, className, excluded = {},
+ excludedClassNames = [],
+ possibleClassNames = [],
+ possibleClassName, classNames = [],
+ i, j, ln, subLn;
+
+ expressions = Ext.Array.from(expressions);
+ excludes = Ext.Array.from(excludes);
+
+ fn = fn || Ext.emptyFn;
+
+ scope = scope || Ext.global;
+
+ 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;
+ }
+ }
}
- fly(dom).clearPositioning('auto');
- fly(wrap).clip();
- wrap.appendChild(dom);
- if(wrapXY){
- fly(wrap).setXY(wrapXY);
+
+ for (i = 0, ln = expressions.length; i < ln; i++) {
+ expression = expressions[i];
+
+ if (typeof expression === 'string' && expression.length > 0) {
+ possibleClassNames = Manager.getNamesByExpression(expression);
+
+ for (j = 0, subLn = possibleClassNames.length; j < subLn; j++) {
+ possibleClassName = possibleClassNames[j];
+
+ if (!excluded.hasOwnProperty(possibleClassName) && !Manager.isCreated(possibleClassName)) {
+ Ext.Array.include(classNames, possibleClassName);
+ }
+ }
+ }
}
- }
- return wrap;
- },
- /* @private */
- fxUnwrap : function(wrap, pos, o){
- var dom = this.dom;
- fly(dom).clearPositioning();
- fly(dom).setPositioning(pos);
- if(!o.wrap){
- var pn = fly(wrap).dom.parentNode;
- pn.insertBefore(dom, wrap);
- fly(wrap).remove();
- }
- },
+ // If the dynamic dependency feature is not being used, throw an error
+ // if the dependencies are not defined
+ if (!this.config.enabled) {
+ if (classNames.length > 0) {
+ Ext.Error.raise({
+ sourceClass: "Ext.Loader",
+ sourceMethod: "require",
+ msg: "Ext.Loader is not enabled, so dependencies cannot be resolved dynamically. " +
+ "Missing required class" + ((classNames.length > 1) ? "es" : "") + ": " + classNames.join(', ')
+ });
+ }
+ }
- /* @private */
- getFxRestore : function(){
- var st = this.dom.style;
- return {pos: this.getPositioning(), width: st.width, height : st.height};
- },
+ if (classNames.length === 0) {
+ fn.call(scope);
+ return this;
+ }
- /* @private */
- afterFx : function(o){
- var dom = this.dom,
- id = dom.id;
- if(o.afterStyle){
- fly(dom).setStyle(o.afterStyle);
- }
- if(o.afterCls){
- fly(dom).addClass(o.afterCls);
- }
- if(o.remove == TRUE){
- fly(dom).remove();
- }
- if(o.callback){
- o.callback.call(o.scope, fly(dom));
- }
- if(!o.concurrent){
- getQueue(id).shift();
- fly(dom).nextFx();
- }
- },
+ this.queue.push({
+ requires: classNames,
+ callback: fn,
+ scope: scope
+ });
- /* @private */
- fxanim : function(args, opt, animType, defaultDur, defaultEase, cb){
- animType = animType || 'run';
- opt = opt || {};
- var anim = Ext.lib.Anim[animType](
- this.dom,
- args,
- (opt.duration || defaultDur) || .35,
- (opt.easing || defaultEase) || EASEOUT,
- cb,
- this
- );
- opt.anim = anim;
- return anim;
- }
-};
+ classNames = classNames.slice();
-// backwards compat
-Ext.Fx.resize = Ext.Fx.scale;
+ for (i = 0, ln = classNames.length; i < ln; i++) {
+ className = classNames[i];
-//When included, Ext.Fx is automatically applied to Element so that all basic
-//effects are available directly via the Element API
-Ext.Element.addMethods(Ext.Fx);
-})();
-/**
- * @class Ext.CompositeElementLite
- * 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.Element} and - * {@link Ext.Fx}. 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'); + if (!this.isFileLoaded.hasOwnProperty(className)) { + this.isFileLoaded[className] = false; -els.setWidth(100); // all elements become 100 width -els.hide(true); // all elements fade out and hide -// or -els.setWidth(100).hide(true); -
- */ -Ext.CompositeElementLite = function(els, root){ - /** - *The Array of DOM elements which this CompositeElement encapsulates. Read-only.
- *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- * @type Array - * @property elements - */ - this.elements = []; - this.add(els, root); - this.el = new Ext.Element.Flyweight(); -}; + return this; + }, -Ext.CompositeElementLite.prototype = { - isComposite: true, + /** + * @private + * @param {String} className + * @param {String} filePath + */ + onFileLoaded: function(className, filePath) { + this.numLoadedFiles++; - // private - getElement : function(el){ - // Set the shared flyweight dom property to the current element - var e = this.el; - e.dom = el; - e.id = el.id; - return e; - }, + this.isFileLoaded[className] = true; - // private - transformElement : function(el){ - return Ext.getDom(el); - }, + this.numPendingFiles--; + + if (this.numPendingFiles === 0) { + this.refreshQueue(); + } + + + }, + + /** + * @private + */ + onFileLoadError: function(className, filePath, errorMessage, isSynchronous) { + this.numPendingFiles--; + this.hasFileLoadError = true; + + }, + + /** + * @private + */ + addOptionalRequires: function(requires) { + var optionalRequires = this.optionalRequires, + i, ln, require; + + requires = Ext.Array.from(requires); + + for (i = 0, ln = requires.length; i < ln; i++) { + require = requires[i]; + + Ext.Array.include(optionalRequires, require); + } - /** - * Returns the number of elements in this Composite. - * @return Number - */ - getCount : function(){ - return this.elements.length; - }, - /** - * Adds elements to this Composite object. - * @param {Mixed} els Either an Array of DOM elements to add, or another Composite object who's elements should be added. - * @return {CompositeElement} This Composite object. - */ - add : function(els, root){ - var me = this, - elements = me.elements; - if(!els){ return this; - } - if(typeof els == "string"){ - els = Ext.Element.selectorFunction(els, root); - }else if(els.isComposite){ - els = els.elements; - }else if(!Ext.isIterable(els)){ - els = [els]; - } + }, - for(var i = 0, len = els.length; i < len; ++i){ - elements.push(me.transformElement(els[i])); - } - return me; - }, + /** + * @private + */ + triggerReady: function(force) { + var readyListeners = this.readyListeners, + optionalRequires, listener; - invoke : function(fn, args){ - var me = this, - els = me.elements, - len = els.length, - e, - i; + if (this.isLoading || force) { + this.isLoading = false; - for(i = 0; i < len; i++) { - e = els[i]; - if(e){ - Ext.Element.prototype[fn].apply(me.getElement(e), args); + if (this.optionalRequires.length) { + // Clone then empty the array to eliminate potential recursive loop issue + optionalRequires = Ext.Array.clone(this.optionalRequires); + + // Empty the original array + this.optionalRequires.length = 0; + + this.require(optionalRequires, Ext.Function.pass(this.triggerReady, [true], this), this); + return this; + } + + while (readyListeners.length) { + listener = readyListeners.shift(); + listener.fn.call(listener.scope); + + if (this.isLoading) { + return this; + } + } } - } - return me; - }, - /** - * Returns a flyweight Element of the dom element object at the specified index - * @param {Number} index - * @return {Ext.Element} - */ - item : function(index){ - var me = this, - el = me.elements[index], - out = null; - if(el){ - out = me.getElement(el); - } - return out; - }, + return this; + }, - // fixes scope with flyweight - addListener : function(eventName, handler, scope, opt){ - var els = this.elements, - len = els.length, - i, e; + /** + * Adds 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; - for(i = 0; i
-Ext.override(Ext.CompositeElementLite, { - nextAll: function() { - var els = this.elements, i, l = els.length, n, r = [], ri = -1; + filePath = this.getPath(className); -// Loop through all elements in this Composite, accumulating -// an Array of all siblings. - for (i = 0; i < l; i++) { - for (n = els[i].nextSibling; n; n = n.nextSibling) { - r[++ri] = n; + this.classNameToFilePathMap[className] = filePath; + + this.numPendingFiles++; + + this.loadScriptFile( + filePath, + Ext.Function.pass(this.onFileLoaded, [className, filePath], this), + Ext.Function.pass(this.onFileLoadError, [className, filePath]), + this, + this.syncModeEnabled + ); + } } - } -// Add all found siblings to this Composite - return this.add(r); - } -});Calls the passed function for each element in this composite. - * @param {Function} fn The function to call. The function is passed the following parameters: - *
- * @param {Object} scope (optional) The scope (this reference) in which the function is executed. (defaults to the Element) - * @return {CompositeElement} this - */ - each : function(fn, scope){ - var me = this, - els = me.elements, - len = els.length, - i, e; - for(i = 0; i- el : Element
- *The current Element in the iteration. - * This is the flyweight (shared) Ext.Element instance, so if you require a - * a reference to the dom node, use el.dom.- c : Composite
- *This Composite object.- idx : Number
- *The zero-based index in the iteration.- * - * el
: Ext.ElementThe current DOM element.- * - * @return {CompositeElement} this + * @member Ext + * @method syncRequire + * @alias Ext.Loader#syncRequire */ - filter : function(selector){ - var els = [], - me = this, - elements = me.elements, - fn = Ext.isFunction(selector) ? selector - : function(el){ - return el.is(selector); - }; - + Ext.syncRequire = alias(Loader, 'syncRequire'); - me.each(function(el, self, i){ - if(fn(el, i) !== false){ - els[els.length] = me.transformElement(el); - } - }); - me.elements = els; - return me; - }, + /** + * @member Ext + * @method exclude + * @alias Ext.Loader#exclude + */ + Ext.exclude = alias(Loader, 'exclude'); /** - * Find the index of the passed element within the composite collection. - * @param el {Mixed} The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. - * @return Number The index of the passed Ext.Element in the composite collection, or -1 if not found. + * @member Ext + * @method onReady + * @alias Ext.Loader#onReady */ - indexOf : function(el){ - return this.elements.indexOf(this.transformElement(el)); - }, + Ext.onReady = function(fn, scope, options) { + Loader.onReady(fn, scope, true, options); + }; /** - * Replaces the specified element with the passed element. - * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite - * to replace. - * @param {Mixed} replacement The id of an element or the Element itself. - * @param {Boolean} domReplace (Optional) True to remove and replace the element in the document too. - * @return {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); + * @cfg {[String]} requires + * @member Ext.Class + * List of classes that have to be loaded before instanciating 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, continueFn) { + var me = this, + dependencies = [], + className = Manager.getName(cls), + i, j, ln, subLn, value, propertyName, propertyValue; + + /* + Basically 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 { + for (j in propertyValue) { + if (propertyValue.hasOwnProperty(j)) { + value = propertyValue[j]; + + if (typeof value === 'string') { + dependencies.push(value); + } + } + } + } } - this.elements.splice(index, 1, replacement); } - return this; - }, - /** - * Removes all elements. - */ - clear : function(){ - this.elements = []; - } -}; + if (dependencies.length === 0) { +// Loader.historyPush(className); + return; + } -Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addListener; -(function(){ -var fnName, - ElProto = Ext.Element.prototype, - CelProto = Ext.CompositeElementLite.prototype; - -for(fnName in ElProto){ - if(Ext.isFunction(ElProto[fnName])){ - (function(fnName){ - CelProto[fnName] = CelProto[fnName] || function(){ - return this.invoke(fnName, arguments); - }; - }).call(CelProto, fnName); + Loader.require(dependencies, function() { + for (i = 0, ln = dependencyProperties.length; i < ln; i++) { + propertyName = dependencyProperties[i]; - } -} -})(); + if (data.hasOwnProperty(propertyName)) { + propertyValue = data[propertyName]; -if(Ext.DomQuery){ - Ext.Element.selectorFunction = Ext.DomQuery.select; -} + 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]; -/** - * 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/Array} selector The CSS selector or an array of elements - * @param {HTMLElement/String} root (optional) The root element of the query or id of the root - * @return {CompositeElementLite/CompositeElement} - * @member Ext.Element - * @method select - */ -Ext.Element.select = function(selector, root){ - var els; - if(typeof selector == "string"){ - els = Ext.Element.selectorFunction(selector, root); - }else if(selector.length !== undefined){ - els = selector; - }else{ - throw "Invalid selector"; - } - return new Ext.CompositeElementLite(els); -}; -/** - * 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/Array} selector The CSS selector or an array of elements - * @param {HTMLElement/String} root (optional) The root element of the query or id of the root - * @return {CompositeElementLite/CompositeElement} - * @member Ext - * @method select - */ -Ext.select = Ext.Element.select; -/** - * @class Ext.CompositeElementLite - */ -Ext.apply(Ext.CompositeElementLite.prototype, { - addElements : function(els, root){ - if(!els){ - return this; - } - if(typeof els == "string"){ - els = Ext.Element.selectorFunction(els, root); - } - var yels = this.elements; - Ext.each(els, function(e) { - yels.push(Ext.get(e)); - }); - return this; - }, - - /** - * Returns the first Element - * @return {Ext.Element} - */ - first : function(){ - return this.item(0); - }, - - /** - * Returns the last Element - * @return {Ext.Element} - */ - last : function(){ - return this.item(this.getCount()-1); - }, - - /** - * Returns true if this composite contains the passed element - * @param el {Mixed} 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; - }, + if (typeof value === 'string') { + data[propertyName][j] = Manager.get(value); + } + } + } + else { + for (var k in propertyValue) { + if (propertyValue.hasOwnProperty(k)) { + value = propertyValue[k]; - /** - * Removes the specified element(s). - * @param {Mixed} 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 (optional) True to also remove the element from the document - * @return {CompositeElement} this - */ - removeElement : function(keys, removeDom){ - var me = this, - els = this.elements, - el; - Ext.each(keys, function(val){ - if ((el = (els[val] || els[val = me.indexOf(val)]))) { - if(removeDom){ - if(el.dom){ - el.remove(); - }else{ - Ext.removeNode(el); + if (typeof value === 'string') { + data[propertyName][k] = Manager.get(value); + } + } + } } } - els.splice(val, 1); } + + continueFn.call(me, cls, data); }); - return this; - } -}); -/** - * @class Ext.CompositeElement - * @extends Ext.CompositeElementLite - * index
: NumberThe current index within the collection.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.Element} and - * {@link Ext.Fx}. The methods from these classes will be performed on all the elements in this collection.
- *All methods return this and can be chained.
- * Usage: -- */ -Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, { - - constructor : function(els, root){ - this.elements = []; - this.add(els, root); - }, - - // 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); - } + return false; + }, true); - /** - * Adds elements to this composite. - * @param {String/Array} els A string CSS selector, an array of elements or an element - * @return {CompositeElement} this - */ + Class.setDefaultPreprocessorPosition('loader', 'after', 'className'); /** - * Returns the Element object at the specified index - * @param {Number} index - * @return {Ext.Element} + * @cfg {[String]} uses + * @member Ext.Class + * List of classes to load together with this class. These aren't neccessarily loaded before + * this class is instanciated. 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) { + var uses = Ext.Array.from(data.uses), + items = [], + i, ln, item; - /** - * Iterates each-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); -
element
in thiscomposite
- * calling the supplied function using {@link Ext#each}. - * @param {Function} fn The function to be called with each - *element
. If the supplied function returns false, - * iteration stops. This function is called with the following arguments: - *- * @param {Object} scope (optional) The scope (- *
- - *
element
: Ext.ElementThe element at the currentindex
- * in thecomposite
- - *
composite
: ObjectThis composite.- - *
index
: NumberThe current index within thecomposite
reference) in which the specified function is executed. - * Defaults to the element
at the currentindex
- * within the composite. - * @return {CompositeElement} this - */ -}); + for (i = 0, ln = uses.length; i < ln; i++) { + item = uses[i]; -/** - * 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/Array} selector The CSS selector or an array of elements - * @param {Boolean} unique (optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object) - * @param {HTMLElement/String} root (optional) The root element of the query or id of the root - * @return {CompositeElementLite/CompositeElement} - * @member Ext.Element - * @method select - */ -Ext.Element.select = function(selector, unique, root){ - var els; - if(typeof selector == "string"){ - els = Ext.Element.selectorFunction(selector, root); - }else if(selector.length !== undefined){ - els = selector; - }else{ - throw "Invalid selector"; - } + if (typeof item === 'string') { + items.push(item); + } + } - return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els); -}; + Loader.addOptionalRequires(items); + }); + + Manager.setDefaultPostprocessorPosition('uses', 'last'); + +})(Ext.ClassManager, Ext.Class, Ext.Function.flexSetter, Ext.Function.alias); /** - * 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/Array} selector The CSS selector or an array of elements - * @param {Boolean} unique (optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object) - * @param {HTMLElement/String} root (optional) The root element of the query or id of the root - * @return {CompositeElementLite/CompositeElement} - * @member Ext - * @method select - */ -Ext.select = Ext.Element.select;(function(){ - var BEFOREREQUEST = "beforerequest", - REQUESTCOMPLETE = "requestcomplete", - REQUESTEXCEPTION = "requestexception", - UNDEFINED = undefined, - LOAD = 'load', - POST = 'POST', - GET = 'GET', - WINDOW = window; - - /** - * @class Ext.data.Connection - * @extends Ext.util.Observable - *The 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.
- * @constructor - * @param {Object} config a configuration object. - */ - Ext.data.Connection = function(config){ - Ext.apply(this, config); - this.addEvents( - /** - * @event beforerequest - * Fires before a network request is made to retrieve a data object. - * @param {Connection} conn This Connection object. - * @param {Object} options The options config object passed to the {@link #request} method. - */ - BEFOREREQUEST, - /** - * @event requestcomplete - * Fires if the request was successfully completed. - * @param {Connection} conn This Connection object. - * @param {Object} response The XHR object containing the response data. - * See The XMLHttpRequest Object - * for details. - * @param {Object} options The options config object passed to the {@link #request} method. - */ - REQUESTCOMPLETE, - /** - * @event requestexception - * Fires if an error HTTP status was returned from the server. - * See HTTP Status Code Definitions - * for details of HTTP status codes. - * @param {Connection} conn This Connection object. - * @param {Object} response The XHR object containing the response data. - * See The XMLHttpRequest Object - * for details. - * @param {Object} options The options config object passed to the {@link #request} method. - */ - REQUESTEXCEPTION - ); - Ext.data.Connection.superclass.constructor.call(this); - }; + * @class Ext.Error + * @private + * @extends Error - Ext.extend(Ext.data.Connection, Ext.util.Observable, { - /** - * @cfg {String} url (Optional)The default URL to be used for requests to the server. Defaults to undefined.
- *The
- */ - /** - * @cfg {Object} extraParams (Optional) An object containing properties which are used as - * extra parameters to each request made by this object. (defaults to undefined) - */ - /** - * @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added - * to each request made by this object. (defaults to undefined) - */ - /** - * @cfg {String} method (Optional) The default HTTP method to be used for requests. - * (defaults to undefined; if not set, but {@link #request} params are present, POST will be used; - * otherwise, GET will be used.) - */ - /** - * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000) - */ - timeout : 30000, - /** - * @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false) - * @type Boolean - */ - autoAbort:false, +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 eroor 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. - /** - * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true) - * @type Boolean - */ - disableCaching: true, +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. - /** - * @cfg {String} disableCachingParam (Optional) Change the parameter which is sent went disabling caching - * through a cache buster. Defaults to '_dc' - * @type String - */ - disableCachingParam: '_dc', +At its simplest you can simply raise an error as a simple string from within any code: - /** - *url
config may be a function which returns the URL to use for the Ajax request. The scope - * (this
reference) of the function is thescope
option passed to the {@link #request} method.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:- *
- *- url : String/Function (Optional)
- *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 - * {@link #url}.- params : Object/String/Function (Optional)
- *- * 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.- method : String (Optional)
- *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.- callback : Function (Optional)
- *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:- *
- options : Object
- *The parameter to the request call.- success : Boolean
- *True if the request succeeded.- response : Object
- *The XMLHttpRequest object containing the response data. - * See http://www.w3.org/TR/XMLHttpRequest/ for details about - * accessing elements of the response.- success : Function (Optional)
- *The function - * to be called upon success of the request. The callback is passed the following - * parameters:- *
- response : Object
- *The XMLHttpRequest object containing the response data.- options : Object
- *The parameter to the request call.- failure : Function (Optional)
- *The function - * to be called upon failure of the request. The callback is passed the - * following parameters:- *
- response : Object
- *The XMLHttpRequest object containing the response data.- options : Object
- *The parameter to the request call.- scope : Object (Optional)
- *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.- timeout : Number (Optional)
- *The timeout in milliseconds to be used for this request. Defaults to 30 seconds.- form : Element/HTMLElement/String (Optional)
- *The <form> - * Element or the id of the <form> to pull parameters from.- isUpload : Boolean (Optional)
- *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 <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.
- *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.
- *- headers : Object (Optional)
- *Request - * headers to set for the request.- xmlData : Object (Optional)
- *XML document - * to use for the post. Note: This will be used instead of params for the post - * data. Any params will be appended to the URL.- jsonData : Object/String (Optional)
- *JSON - * data to use as the post. Note: This will be used instead of params for the post - * data. Any params will be appended to the URL.- disableCaching : Boolean (Optional)
- *True - * to add a unique cache-buster param to GET requests.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.
- * @return {Number} transactionId The id of the server transaction. This may be used - * to cancel the request. - */ - request : function(o){ - var me = this; - if(me.fireEvent(BEFOREREQUEST, me, o)){ - if (o.el) { - if(!Ext.isEmpty(o.indicatorText)){ - me.indicatorText = ''+o.indicatorText+""; - } - if(me.indicatorText) { - Ext.getDom(o.el).innerHTML = me.indicatorText; - } - o.success = (Ext.isFunction(o.success) ? o.success : function(){}).createInterceptor(function(response) { - Ext.getDom(o.el).innerHTML = response.responseText; - }); - } +#Example usage:# - var p = o.params, - url = o.url || me.url, - method, - cb = {success: me.handleResponse, - failure: me.handleFailure, - scope: me, - argument: {options: o}, - timeout : o.timeout || me.timeout - }, - form, - serForm; + 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. - if (Ext.isFunction(p)) { - p = p.call(o.scope||WINDOW, o); - } +#Example usage:# - p = Ext.urlEncode(me.extraParams, Ext.isObject(p) ? Ext.urlEncode(p) : p); + 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 (Ext.isFunction(url)) { - url = url.call(o.scope || WINDOW, o); - } +If a console is available (that supports the `console.dir` function) you'll see console output like: - if((form = Ext.getDom(o.form))){ - url = url || form.action; - if(o.isUpload || /multipart\/form-data/i.test(form.getAttribute("enctype"))) { - return me.doFormUpload.call(me, o, p, url); - } - serForm = Ext.lib.Ajax.serializeForm(form); - p = p ? (p + '&' + serForm) : serForm; - } + 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" - method = o.method || me.method || ((p || o.xmlData || o.jsonData) ? POST : GET); + uncaught exception: You cannot do that! - if(method === GET && (me.disableCaching && o.disableCaching !== false) || o.disableCaching === true){ - var dcp = o.disableCachingParam || me.disableCachingParam; - url = Ext.urlAppend(url, dcp + '=' + (new Date().getTime())); - } +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. - o.headers = Ext.apply(o.headers || {}, me.defaultHeaders || {}); +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. - if(o.autoAbort === true || me.autoAbort) { - me.abort(); - } +#Example usage:# - if((method == GET || o.xmlData || o.jsonData) && p){ - url = Ext.urlAppend(url, p); - p = ''; - } - return (me.transId = Ext.lib.Ajax.request(method, url, cb, p, o)); - }else{ - return o.callback ? o.callback.apply(o.scope, [o,UNDEFINED,UNDEFINED]) : null; - } - }, + 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 + } + * Create a new Error object + * @param {Object} config The config object + * @markdown + * @author Brian Moeskau+ * @docauthor Brian Moeskau + */ +Ext.Error = Ext.extend(Error, { + statics: { /** - * Determine whether this object has a request outstanding. - * @param {Number} transactionId (Optional) defaults to the last transaction - * @return {Boolean} True if there is an outstanding request. + * @property 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; + + * @markdown + * @static */ - isLoading : function(transId){ - return transId ? Ext.lib.Ajax.isCallInProgress(transId) : !! this.transId; - }, + ignore: false, /** - * Aborts any outstanding request. - * @param {Number} transactionId (Optional) defaults to the last transaction + * @property 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; + + * @markdown + * @static */ - abort : function(transId){ - if(transId || this.isLoading()){ - Ext.lib.Ajax.abort(transId || this.transId); - } - }, + //notify: Ext.isIE6 || Ext.isIE7, - // private - handleResponse : function(response){ - this.transId = false; - var options = response.argument.options; - response.argument = options ? options.argument : null; - this.fireEvent(REQUESTCOMPLETE, this, response, options); - if(options.success){ - options.success.call(options.scope, response, options); + /** +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 + }); } - if(options.callback){ - options.callback.call(options.scope, options, true, response); + } + }); + * @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 + * @markdown + */ + raise: function(err){ + err = err || {}; + if (Ext.isString(err)) { + err = { msg: err }; } - }, - // private - handleFailure : function(response, e){ - this.transId = false; - var options = response.argument.options; - response.argument = options ? options.argument : null; - this.fireEvent(REQUESTEXCEPTION, this, response, options, e); - if(options.failure){ - options.failure.call(options.scope, response, options); + var method = this.raise.caller; + + if (method) { + if (method.$name) { + err.sourceMethod = method.$name; + } + if (method.$owner) { + err.sourceClass = method.$owner.$className; + } } - if(options.callback){ - options.callback.call(options.scope, options, false, response); + + if (Ext.Error.handle(err) !== true) { + var msg = Ext.Error.prototype.toString.call(err); + + Ext.log({ + msg: msg, + level: 'error', + dump: err, + stack: true + }); + + throw new Ext.Error(err); } }, - // private - doFormUpload : function(o, ps, url){ - var id = Ext.id(), - doc = document, - frame = doc.createElement('iframe'), - form = Ext.getDom(o.form), - hiddens = [], - hd, - encoding = 'multipart/form-data', - buf = { - target: form.target, - method: form.method, - encoding: form.encoding, - enctype: form.enctype, - action: form.action - }; + /** +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. - /* - * Originally this behaviour was modified for Opera 10 to apply the secure URL after - * the frame had been added to the document. It seems this has since been corrected in - * Opera so the behaviour has been reverted, the URL will be set before being added. - */ - Ext.fly(frame).set({ - id: id, - name: id, - cls: 'x-hidden', - src: Ext.SSL_SECURE_URL - }); +#Example usage:# - doc.body.appendChild(frame); + 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 + } - // This is required so that IE doesn't pop the response up in a new window. - if(Ext.isIE){ - document.frames[id].name = id; - } + * @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 + * @markdown + */ + handle: function(){ + return Ext.Error.ignore; + } + }, + // This is the standard property that is the name of the constructor. + name: 'Ext.Error', - Ext.fly(form).set({ - target: id, - method: POST, - enctype: encoding, - encoding: encoding, - action: url || buf.action - }); + /** + * @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 }; + } - // add dynamic params - Ext.iterate(Ext.urlDecode(ps, false), function(k, v){ - hd = doc.createElement('input'); - Ext.fly(hd).set({ - type: 'hidden', - value: v, - name: k - }); - form.appendChild(hd); - hiddens.push(hd); - }); + var me = this; - function cb(){ - var me = this, - // bogus response object - r = {responseText : '', - responseXML : null, - argument : o.argument}, - doc, - firstChild; + Ext.apply(me, config); - try{ - doc = frame.contentWindow.document || frame.contentDocument || WINDOW.frames[id].document; - if(doc){ - if(doc.body){ - if(/textarea/i.test((firstChild = doc.body.firstChild || {}).tagName)){ // json response wrapped in textarea - r.responseText = firstChild.value; - }else{ - r.responseText = doc.body.innerHTML; - } - } - //in IE the document may still have a body even if returns XML. - r.responseXML = doc.XMLDocument || doc; - } - } - catch(e) {} + 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. - Ext.EventManager.removeListener(frame, LOAD, cb, me); +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. + * @markdown + * @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.className ? me.className : '', + methodName = me.methodName ? '.' + me.methodName + '(): ' : '', + msg = me.msg || '(No description provided)'; - me.fireEvent(REQUESTCOMPLETE, me, r, o); + return className + methodName + msg; + } +}); - function runCallback(fn, scope, args){ - if(Ext.isFunction(fn)){ - fn.apply(scope, args); - } - } +/* + * 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. + */ - runCallback(o.success, o.scope, [r, o]); - runCallback(o.callback, o.scope, [o, true, r]); - if(!me.debugUploads){ - setTimeout(function(){Ext.removeNode(frame);}, 100); - } - } - Ext.EventManager.on(frame, LOAD, cb, this); - form.submit(); +/* - Ext.fly(form).set(buf); - Ext.each(hiddens, function(h) { - Ext.removeNode(h); - }); - } - }); -})(); +This file is part of Ext JS 4 +Copyright (c) 2011 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. + +*/ /** - * @class Ext.Ajax - * @extends Ext.data.Connection - * The global Ajax request class that provides a simple way to make Ajax requests - * with maximum flexibility.
- *Since Ext.Ajax is a singleton, you can set common properties/events for it once - * and override them at the request function level only if necessary.
- *Common Properties you may want to set are:
- *- *
- {@link #method}
- *- {@link #extraParams}
- *- {@link #url}
- *- * - *-// Default headers to pass in every request -Ext.Ajax.defaultHeaders = { - 'Powered-By': 'Ext' -}; - *
Common Events you may want to set are:
- *- *
- {@link Ext.data.Connection#beforerequest beforerequest}
- *- {@link Ext.data.Connection#requestcomplete requestcomplete}
- *- {@link Ext.data.Connection#requestexception requestexception}
- *- * - *-// Example: show a spinner during all Ajax requests -Ext.Ajax.on('beforerequest', this.showSpinner, this); -Ext.Ajax.on('requestcomplete', this.hideSpinner, this); -Ext.Ajax.on('requestexception', this.hideSpinner, this); - *
An example request:
- *- * + * @class Ext.JSON + * Modified version of Douglas Crockford"s json.js that doesn"t + * mess with the Object prototype + * http://www.json.org/js.html * @singleton */ -Ext.Ajax = new Ext.data.Connection({ +Ext.JSON = new(function() { + var useHasOwn = !! {}.hasOwnProperty, + isNative = function() { + var useNative = null; + + return 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) { + if (!Ext.isDefined(o) || o === null) { + return "null"; + } else if (Ext.isArray(o)) { + return encodeArray(o); + } else if (Ext.isDate(o)) { + return Ext.JSON.encodeDate(o); + } else if (Ext.isString(o)) { + return 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); + } else if (Ext.isObject(o)) { + return encodeObject(o); + } 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); + }) + '"'; + }, + encodeArray = function(o) { + 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(doEncode(o[i]), ','); + } + // Overwrite trailing comma (or empty string) + a[a.length - 1] = ']'; + return a.join(""); + }, + encodeObject = function(o) { + var a = ["{", ""], + // Note empty string in case there are no serializable members. + i; + for (i in o) { + if (!useHasOwn || o.hasOwnProperty(i)) { + a.push(doEncode(i), ":", doEncode(o[i]), ','); + } + } + // Overwrite trailing comma (or empty string) + a[a.length - 1] = '}'; + return a.join(""); + }; + /** - * @cfg {String} url @hide + *-// Basic request -Ext.Ajax.{@link Ext.data.Connection#request request}({ - url: 'foo.php', - success: someFn, - failure: otherFn, - headers: { - 'my-header': 'foo' - }, - params: { foo: 'bar' } -}); - -// Simple ajax form submission -Ext.Ajax.{@link Ext.data.Connection#request request}({ - form: 'some-form', - params: 'foo=bar' -}); - *
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:
+ * @param {Date} d The Date to encode + * @return {String} The string literal to use in a JSON string. */ + this.encodeDate = function(o) { + return '"' + o.getFullYear() + "-" + + pad(o.getMonth() + 1) + "-" + + pad(o.getDate()) + "T" + + pad(o.getHours()) + ":" + + pad(o.getMinutes()) + ":" + + pad(o.getSeconds()) + '"'; + }; + /** - * @cfg {Object} extraParams @hide + * Encodes an Object, Array or other value + * @param {Mixed} o The variable to encode + * @return {String} The JSON string */ + this.encode = function() { + var ec; + return function(o) { + if (!ec) { + // setup encoding function on first access + ec = isNative() ? JSON.stringify : doEncode; + } + return ec(o); + }; + }(); + + /** - * @cfg {Object} defaultHeaders @hide + * 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 (optional) Whether to return null or throw an exception if the JSON is invalid. + * @return {Object} The resulting object */ + this.decode = function() { + var dc; + return function(json, safe) { + if (!dc) { + // setup decoding function on first access + dc = isNative() ? JSON.parse : doDecode; + } + try { + return dc(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} + * @param {Mixed} o The variable to encode + * @return {String} The JSON string + * @member Ext + * @method encode + */ +Ext.encode = Ext.JSON.encode; +/** + * Shorthand for {@link Ext.JSON#decode} + * @param {String} json The JSON string + * @param {Boolean} safe (optional) Whether to return null or throw an exception if the JSON is invalid. + * @return {Object} The resulting object + * @member Ext + * @method decode + */ +Ext.decode = Ext.JSON.decode; + + +/** + * @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 + * @markdown + */ +Ext.apply(Ext, { + userAgent: navigator.userAgent.toLowerCase(), + cache: {}, + idSeed: 1000, + BLANK_IMAGE_URL : 'data:image/gif;base64,R0lGODlhAQABAID/AMDAwAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==', + isStrict: document.compatMode == "CSS1Compat", + windowId: 'ext-window', + documentId: 'ext-document', + /** - * @cfg {String} method (Optional) @hide + * True when the document is fully initialized and ready for action + * @type Boolean */ + isReady: false, + /** - * @cfg {Number} timeout (Optional) @hide + * True to automatically uncache orphaned Ext.core.Elements periodically (defaults to true) + * @type Boolean */ + enableGarbageCollector: true, + /** - * @cfg {Boolean} autoAbort (Optional) @hide + * True to automatically purge event listeners during garbageCollection (defaults to true). + * @type Boolean */ + enableListenerCollection: true, /** - * @cfg {Boolean} disableCaching (Optional) @hide + * Generates unique ids. If the element already has an id, it is unchanged + * @param {Mixed} el (optional) 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) { + if (!me.uniqueGlobalNamespace) { + me.getUniqueGlobalNamespace(); + } + sandboxPrefix = me.uniqueGlobalNamespace + '-'; + } + el.id = sandboxPrefix + (prefix || "ext-gen") + (++Ext.idSeed); + } + return el.id; + }, /** - * @property disableCaching - * True to add a unique cache-buster param to GET requests. (defaults to true) - * @type Boolean + * Returns the current document body as an {@link Ext.core.Element}. + * @return Ext.core.Element The document body */ + getBody: function() { + return Ext.get(document.body || false); + }, + /** - * @property url - * The default URL to be used for requests to the server. (defaults to undefined) - * If the server receives all requests through one URL, setting this once is easier than - * entering it on every request. - * @type String + * Returns the current document head as an {@link Ext.core.Element}. + * @return Ext.core.Element The document head + * @method */ + getHead: function() { + var head; + + return function() { + if (head == undefined) { + head = Ext.get(document.getElementsByTagName("head")[0]); + } + + return head; + }; + }(), + /** - * @property extraParams - * An object containing properties which are used as extra parameters to each request made - * by this object (defaults to undefined). Session information and other data that you need - * to pass with each request are commonly put here. - * @type Object + * Returns the current HTML document object as an {@link Ext.core.Element}. + * @return Ext.core.Element The document */ + getDoc: function() { + return Ext.get(document); + }, + /** - * @property defaultHeaders - * An object containing request headers which are added to each request made by this object - * (defaults to undefined). - * @type Object + * 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. + */ + getCmp: function(id) { + return Ext.ComponentManager.get(id); + }, + + /** + * Returns the current orientation of the mobile device + * @return {String} Either 'portrait' or 'landscape' */ + getOrientation: function() { + return window.innerHeight > window.innerWidth ? 'portrait' : 'landscape'; + }, + /** - * @property method - * The default HTTP method to be used for requests. Note that this is case-sensitive and - * should be all caps (defaults to undefined; if not set but params are present will use - * "POST", otherwise will use "GET".) - * @type String + * 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.core.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 {Mixed} arg1 An {@link Ext.core.Element}, {@link Ext.Component}, or an Array of either of these to destroy + * @param {Mixed} arg2 (optional) + * @param {Mixed} etc... (optional) */ + 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 (Ext.isFunction(arg.destroy)) { + arg.destroy(); + } + else if (arg.dom) { + arg.remove(); + } + } + } + }, + /** - * @property timeout - * The timeout in milliseconds to be used for requests. (defaults to 30000) - * @type Number + * Execute a callback function in a particular scope. If no function is passed the call is ignored. + * + * For example, these lines are equivalent: + * + * Ext.callback(myFunc, this, [arg1, arg2]); + * Ext.isFunction(myFunc) && myFunc.apply(this, [arg1, arg2]); + * + * @param {Function} callback The callback to execute + * @param {Object} scope (optional) The scope to execute in + * @param {Array} args (optional) The arguments to pass to the function + * @param {Number} delay (optional) Pass a number to delay the call by a number of milliseconds. + */ + callback: function(callback, scope, args, delay){ + if(Ext.isFunction(callback)){ + args = args || []; + scope = scope || window; + if (delay) { + Ext.defer(callback, delay, scope, args); + } else { + callback.apply(scope, args); + } + } + }, + + /** + * 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 */ + htmlEncode : function(value) { + return Ext.String.htmlEncode(value); + }, /** - * @property autoAbort - * Whether a new request should abort any pending requests. (defaults to false) - * @type Boolean + * Convert certain characters (&, <, >, and ') from their HTML character equivalents. + * @param {String} value The string to decode + * @return {String} The decoded text */ - autoAbort : false, + htmlDecode : function(value) { + return Ext.String.htmlDecode(value); + }, /** - * Serialize the passed form into a url encoded string - * @param {String/HTMLElement} form - * @return {String} + * 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} s The content to append to the URL. + * @return (String) The resulting URL */ - serializeForm : function(form){ - return Ext.lib.Ajax.serializeForm(form); + urlAppend : function(url, s) { + if (!Ext.isEmpty(s)) { + return url + (url.indexOf('?') === -1 ? '?' : '&') + s; + } + return url; } }); + + +Ext.ns = Ext.namespace; + +// for old browsers +window.undefined = window.undefined; + /** - * @class Ext.Updater - * @extends Ext.util.Observable - * Provides AJAX-style update capabilities for Element objects. Updater can be used to {@link #update} - * an {@link Ext.Element} once, or you can use {@link #startAutoRefresh} to set up an auto-updating - * {@link Ext.Element Element} on a specific interval.+ Ext.JSON.encodeDate = function(d) { + return d.format('"Y-m-d"'); + }; +
- * Usage:
- *- * @constructor - * Create new Updater directly. - * @param {Mixed} el The element to update - * @param {Boolean} forceNew (optional) By default the constructor checks to see if the passed element already - * has an Updater and if it does it returns the same instance. This will skip that check (useful for extending this class). + * @class Ext + * Ext core utilities and functions. + * @singleton */ -Ext.UpdateManager = Ext.Updater = Ext.extend(Ext.util.Observable, -function() { - var BEFOREUPDATE = "beforeupdate", - UPDATE = "update", - FAILURE = "failure"; +(function(){ + var check = function(regex){ + return regex.test(Ext.userAgent); + }, + 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/), + isIE = !isOpera && check(/msie/), + isIE7 = isIE && (check(/msie 7/) || docMode == 7), + isIE8 = isIE && (check(/msie 8/) && docMode != 7 && docMode != 9 || docMode == 8), + isIE9 = isIE && (check(/msie 9/) && docMode != 7 && docMode != 8 || docMode == 9), + isIE6 = isIE && check(/msie 6/), + isGecko = !isWebKit && check(/gecko/), + isGecko3 = isGecko && check(/rv:1\.9/), + isGecko4 = isGecko && check(/rv:2\.0/), + 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, + webKitVersion = isWebKit && (/webkit\/(\d+\.\d+)/.exec(Ext.userAgent)); + + // remove css image flicker + try { + document.execCommand("BackgroundImageCache", false, true); + } catch(e) {} - // private - function processSuccess(response){ - var me = this; - me.transaction = null; - if (response.argument.form && response.argument.reset) { - try { // put in try/catch since some older FF releases had problems with this - response.argument.form.reset(); - } catch(e){} - } - if (me.loadScripts) { - me.renderer.render(me.el, response, me, - updateComplete.createDelegate(me, [response])); - } else { - me.renderer.render(me.el, response, me); - updateComplete.call(me, response); - } - } + Ext.setVersion('extjs', '4.0.2'); + Ext.apply(Ext, { + /** + * 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:""'). + * @type String + */ + SSL_SECURE_URL : Ext.isSecure && isIE ? 'javascript:""' : 'about:blank', - // private - function updateComplete(response, type, success){ - this.fireEvent(type || UPDATE, this.el, response); - if(Ext.isFunction(response.argument.callback)){ - response.argument.callback.call(response.argument.scope, this.el, Ext.isEmpty(success) ? true : false, response, response.argument.options); - } - } + /** + * True if the {@link Ext.fx.Anim} Class is available + * @type Boolean + * @property enableFx + */ - // private - function processFailure(response){ - updateComplete.call(this, response, FAILURE, !!(this.transaction = null)); - } + /** + * True to scope the reset CSS to be just applied to Ext components. Note that this wraps root containers + * with an additional element. Also remember that when you turn on this option, you have to use ext-all-scoped { + * unless you use the bootstrap.js to load your javascript, in which case it will be handled for you. + * @type Boolean + */ + scopeResetCSS : Ext.buildSettings.scopeResetCSS, - return { - constructor: function(el, forceNew){ - var me = this; - el = Ext.get(el); - if(!forceNew && el.updateManager){ - return el.updateManager; + /** + * EXPERIMENTAL - True to cascade listener removal to child elements when an element is removed. + * Currently not optimized for performance. + * @type Boolean + */ + enableNestedListenerRemoval : false, + + /** + * 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. (Defaults to false) + * @type Boolean + */ + USE_NATIVE_JSON : false, + + /** + * Return the dom node for the passed String (id), dom node, or Ext.core.Element. + * Optional 'strict' flag is needed for IE since it can return 'name' and + * 'id' elements by using getElementById. + * Here are some examples: + *- * var el = Ext.get("foo"); // Get Ext.Element object - * var mgr = el.getUpdater(); - * mgr.update({ - url: "http://myserver.com/index.php", - params: { - param1: "foo", - param2: "bar" - } - * }); - * ... - * mgr.formUpdate("myFormId", "http://myserver.com/index.php"); - *
- * // or directly (returns the same Updater instance) - * var mgr = new Ext.Updater("myElementId"); - * mgr.startAutoRefresh(60, "http://myserver.com/index.php"); - * mgr.on("update", myFcnNeedsToKnow); - *
- * // short handed call directly from the element object - * Ext.get("foo").load({ - url: "bar.php", - scripts: true, - params: "param1=foo¶m2=bar", - text: "Loading Foo..." - * }); - *+ * Note: the dom node to be found actually needs to exist (be rendered, etc) + * when this method is called to be successful. + * @param {Mixed} el + * @return HTMLElement + */ + getDom : function(el, strict) { + if (!el || !document) { + return null; } - /** - * The Element object - * @type Ext.Element - */ - me.el = el; - /** - * Cached url to use for refreshes. Overwritten every time update() is called unless "discardUrl" param is set to true. - * @type String - */ - me.defaultUrl = null; + if (el.dom) { + return el.dom; + } else { + if (typeof el == 'string') { + var e = document.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; + } + } + }, - me.addEvents( - /** - * @event beforeupdate - * Fired before an update is made, return false from your handler and the update is cancelled. - * @param {Ext.Element} el - * @param {String/Object/Function} url - * @param {String/Object} params - */ - BEFOREUPDATE, - /** - * @event update - * Fired after successful update is made. - * @param {Ext.Element} el - * @param {Object} oResponseObject The response Object - */ - UPDATE, - /** - * @event failure - * Fired on update failure. - * @param {Ext.Element} el - * @param {Object} oResponseObject The response Object - */ - FAILURE - ); + /** + * Removes a DOM node from the document. + *+// 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.core.Element or a dom node use Ext.getDom +function(el){ + var dom = Ext.getDom(el); + // do something with the dom node +} + *
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 + *
+ * @param {HTMLElement} node The node to remove + * @method + */ + removeNode : isIE6 || isIE7 ? function() { + var d; + return function(n){ + if(n && n.tagName != 'BODY'){ + (Ext.enableNestedListenerRemoval) ? Ext.EventManager.purgeElement(n) : Ext.EventManager.removeAll(n); + d = d || document.createElement('div'); + d.appendChild(n); + d.innerHTML = ''; + delete Ext.cache[n.id]; + } + }; + }() : function(n) { + if (n && n.parentNode && n.tagName != 'BODY') { + (Ext.enableNestedListenerRemoval) ? Ext.EventManager.purgeElement(n) : Ext.EventManager.removeAll(n); + n.parentNode.removeChild(n); + delete Ext.cache[n.id]; + } + }, - Ext.apply(me, Ext.Updater.defaults); - /** - * Blank page URL to use with SSL file uploads (defaults to {@link Ext.Updater.defaults#sslBlankUrl}). - * @property sslBlankUrl - * @type String - */ - /** - * Whether to append unique parameter on get request to disable caching (defaults to {@link Ext.Updater.defaults#disableCaching}). - * @property disableCaching - * @type Boolean - */ - /** - * Text for loading indicator (defaults to {@link Ext.Updater.defaults#indicatorText}). - * @property indicatorText - * @type String - */ - /** - * Whether to show indicatorText when loading (defaults to {@link Ext.Updater.defaults#showLoadIndicator}). - * @property showLoadIndicator - * @type String - */ - /** - * Timeout for requests or form posts in seconds (defaults to {@link Ext.Updater.defaults#timeout}). - * @property timeout - * @type Number - */ - /** - * True to process scripts in the output (defaults to {@link Ext.Updater.defaults#loadScripts}). - * @property loadScripts - * @type Boolean - */ + /** + * True if the detected browser is Opera. + * @type Boolean + */ + isOpera : isOpera, - /** - * Transaction object of the current executing transaction, or null if there is no active transaction. - */ - me.transaction = null; - /** - * Delegate for refresh() prebound to "this", use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments - * @type Function - */ - me.refreshDelegate = me.refresh.createDelegate(me); - /** - * Delegate for update() prebound to "this", use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments - * @type Function - */ - me.updateDelegate = me.update.createDelegate(me); - /** - * Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments - * @type Function - */ - me.formUpdateDelegate = (me.formUpdate || function(){}).createDelegate(me); + /** + * True if the detected browser is Opera 10.5x. + * @type Boolean + */ + isOpera10_5 : isOpera10_5, - /** - * The renderer for this Updater (defaults to {@link Ext.Updater.BasicRenderer}). - */ - me.renderer = me.renderer || me.getDefaultRenderer(); + /** + * True if the detected browser uses WebKit. + * @type Boolean + */ + isWebKit : isWebKit, - Ext.Updater.superclass.constructor.call(me); - }, + /** + * True if the detected browser is Chrome. + * @type Boolean + */ + isChrome : isChrome, /** - * Sets the content renderer for this Updater. See {@link Ext.Updater.BasicRenderer#render} for more details. - * @param {Object} renderer The object implementing the render() method + * True if the detected browser is Safari. + * @type Boolean */ - setRenderer : function(renderer){ - this.renderer = renderer; - }, + isSafari : isSafari, + + /** + * True if the detected browser is Safari 3.x. + * @type Boolean + */ + isSafari3 : isSafari3, /** - * Returns the current content renderer for this Updater. See {@link Ext.Updater.BasicRenderer#render} for more details. - * @return {Object} + * True if the detected browser is Safari 4.x. + * @type Boolean */ - getRenderer : function(){ - return this.renderer; - }, + isSafari4 : isSafari4, /** - * This is an overrideable method which returns a reference to a default - * renderer class if none is specified when creating the Ext.Updater. - * Defaults to {@link Ext.Updater.BasicRenderer} + * True if the detected browser is Safari 2.x. + * @type Boolean */ - getDefaultRenderer: function() { - return new Ext.Updater.BasicRenderer(); - }, + isSafari2 : isSafari2, /** - * Sets the default URL used for updates. - * @param {String/Function} defaultUrl The url or a function to call to get the url + * True if the detected browser is Internet Explorer. + * @type Boolean */ - setDefaultUrl : function(defaultUrl){ - this.defaultUrl = defaultUrl; - }, + isIE : isIE, /** - * Get the Element this Updater is bound to - * @return {Ext.Element} The element + * True if the detected browser is Internet Explorer 6.x. + * @type Boolean */ - getEl : function(){ - return this.el; - }, + isIE6 : isIE6, /** - * Performs an asynchronous request, updating this element with the response. - * If params are specified it uses POST, otherwise it uses GET.true
, then DOM event listeners are also removed from all child nodes. The body node + * will be ignored if passed in.
- * Note: Due to the asynchronous nature of remote server requests, the Element - * will not have been fully updated when the function returns. To post-process the returned - * data, use the callback option, or anupdate
event handler. - * @param {Object} options A config object containing any of the following options:- *
- *- url : String/Function
- *The URL to request or a function which - * returns the URL (defaults to the value of {@link Ext.Ajax#url} if not specified).
- method : String
- *The HTTP method to - * use. Defaults to POST if the
params
argument is present, otherwise GET.- params : String/Object/Function
- *The - * parameters to pass to the server (defaults to none). These may be specified as a url-encoded - * string, or as an object containing properties which represent parameters, - * or as a function, which returns such an object.
- scripts : Boolean
- *If
true
- * any <script> tags embedded in the response text will be extracted - * and executed (defaults to {@link Ext.Updater.defaults#loadScripts}). If this option is specified, - * the callback will be called after the execution of the scripts.- callback : Function
- *A function to - * be called when the response from the server arrives. The following - * parameters are passed:
- *
- *- el : Ext.Element
- *The Element being updated.
- success : Boolean
- *True for success, false for failure.
- response : XMLHttpRequest
- *The XMLHttpRequest which processed the update.
- options : Object
The config object passed to the update call.
- scope : Object
- *The scope in which - * to execute the callback (The callback's
this
reference.) If the - *params
argument is a function, this scope is used for that function also.- discardUrl : Boolean
- *By default, the URL of this request becomes - * the default URL for this Updater object, and will be subsequently used in {@link #refresh} - * calls. To bypass this behavior, pass
discardUrl:true
(defaults to false).- timeout : Number
- *The number of seconds to wait for a response before - * timing out (defaults to {@link Ext.Updater.defaults#timeout}).
- text : String
- *The text to use as the innerHTML of the - * {@link Ext.Updater.defaults#indicatorText} div (defaults to 'Loading...'). To replace the entire div, not - * just the text, override {@link Ext.Updater.defaults#indicatorText} directly.
- nocache : Boolean
Only needed for GET - * requests, this option causes an extra, auto-generated parameter to be appended to the request - * to defeat caching (defaults to {@link Ext.Updater.defaults#disableCaching}).
- * For example: -
+ * True if the detected browser is Internet Explorer 7.x. + * @type Boolean */ - update : function(url, params, callback, discardUrl){ - var me = this, - cfg, - callerScope; - - if(me.fireEvent(BEFOREUPDATE, me.el, url, params) !== false){ - if(Ext.isObject(url)){ // must be config object - cfg = url; - url = cfg.url; - params = params || cfg.params; - callback = callback || cfg.callback; - discardUrl = discardUrl || cfg.discardUrl; - callerScope = cfg.scope; - if(!Ext.isEmpty(cfg.nocache)){me.disableCaching = cfg.nocache;}; - if(!Ext.isEmpty(cfg.text)){me.indicatorText = '- um.update({ - url: "your-url.php", - params: {param1: "foo", param2: "bar"}, // or a URL encoded string - callback: yourFunction, - scope: yourObject, //(optional scope) - discardUrl: true, - nocache: true, - text: "Loading...", - timeout: 60, - scripts: false // Save time by avoiding RegExp execution. - }); -
'+cfg.text+"";}; - if(!Ext.isEmpty(cfg.scripts)){me.loadScripts = cfg.scripts;}; - if(!Ext.isEmpty(cfg.timeout)){me.timeout = cfg.timeout;}; - } - me.showLoading(); - - if(!discardUrl){ - me.defaultUrl = url; - } - if(Ext.isFunction(url)){ - url = url.call(me); - } - - var o = Ext.apply({}, { - url : url, - params: (Ext.isFunction(params) && callerScope) ? params.createDelegate(callerScope) : params, - success: processSuccess, - failure: processFailure, - scope: me, - callback: undefined, - timeout: (me.timeout*1000), - disableCaching: me.disableCaching, - argument: { - "options": cfg, - "url": url, - "form": null, - "callback": callback, - "scope": callerScope || window, - "params": params - } - }, cfg); + isIE7 : isIE7, - me.transaction = Ext.Ajax.request(o); - } + /** + * True if the detected browser is Internet Explorer 8.x. + * @type Boolean + */ + isIE8 : isIE8, + + /** + * True if the detected browser is Internet Explorer 9.x. + * @type Boolean + */ + isIE9 : 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 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 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 WebKit (-1 if the browser does not use WebKit). + * @type Float + */ + webKitVersion: webKitVersion ? parseFloat(webKitVersion[1]) : -1, + + /** + * 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) ? 'http:/' + '/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
+ * @param {Mixed} value The value to test + * @param {Mixed} 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 {Mixed} 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; }, /** - *+ *
- null
+ *- undefined
+ *- an empty array
+ *- a zero length string (Unless the allowBlank parameter is true)
+ *Performs an asynchronous form post, updating this element with the response. If the form has the attribute - * enctype="multipart/form-data", it assumes it's a file upload. - * Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning.
- *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.Be aware that file upload packets, sent with the content type multipart/form-data - * and some server technologies (notably JEE) may require some custom processing in order to - * retrieve parameter names and parameter values from the packet content.
- * @param {String/HTMLElement} form The form Id or form element - * @param {String} url (optional) The url to pass the form to. If omitted the action attribute on the form will be used. - * @param {Boolean} reset (optional) Whether to try to reset the form after the update - * @param {Function} callback (optional) Callback when transaction is complete. The following - * parameters are passed:- *
+ * 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 */ - formUpdate : function(form, url, reset, callback){ - var me = this; - if(me.fireEvent(BEFOREUPDATE, me.el, form, url) !== false){ - if(Ext.isFunction(url)){ - url = url.call(me); - } - form = Ext.getDom(form); - me.transaction = Ext.Ajax.request({ - form: form, - url:url, - success: processSuccess, - failure: processFailure, - scope: me, - timeout: (me.timeout*1000), - argument: { - "url": url, - "form": form, - "callback": callback, - "reset": reset - } + 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. + *- el : Ext.Element
- *The Element being updated.
- success : Boolean
- *True for success, false for failure.
- response : XMLHttpRequest
The XMLHttpRequest which processed the update.
+ * @param {Object} obj The list of behaviors to apply + */ + addBehaviors : function(o){ + if(!Ext.isReady){ + Ext.onReady(function(){ + Ext.addBehaviors(o); }); - me.showLoading.defer(1, me); + } 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; } }, /** - * Set this element to auto refresh. Can be canceled by calling {@link #stopAutoRefresh}. - * @param {Number} interval How often to update (in seconds). - * @param {String/Object/Function} url (optional) The url for this request, a config object in the same format - * supported by {@link #load}, or a function to call to get the url (defaults to the last used url). Note that while - * the url used in a load call can be reused by this method, other load config options will not be reused and must be - * sepcified as part of a config object passed as this paramter if needed. - * @param {String/Object} params (optional) The parameters to pass as either a url encoded string - * "¶m1=1¶m2=2" or as an object {param1: 1, param2: 2} - * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) - * @param {Boolean} refreshNow (optional) Whether to execute the refresh now, or wait the interval + * 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 (optional) true to force a recalculation of the value. + * @return {Object} An object containing the width of a vertical scrollbar and the + * height of a horizontal scrollbar. */ - startAutoRefresh : function(interval, url, params, callback, refreshNow){ - var me = this; - if(refreshNow){ - me.update(url || me.defaultUrl, params, callback, true); + getScrollbarSize: function (force) { + if(!Ext.isReady){ + return 0; } - if(me.autoRefreshProcId){ - clearInterval(me.autoRefreshProcId); + + if(force === true || scrollbarSize === null){ + // BrowserBug: IE9 + // When IE9 positions an element offscreen via offsets, the offsetWidth is + // inaccurately reported. For IE9 only, we render on screen before removing. + var cssClass = Ext.isIE9 ? '' : Ext.baseCSSPrefix + 'hide-offsets', + // Append our div, do our calculation and then remove it + div = Ext.getBody().createChild(' '), + child = div.child('div', true), + w1 = child.offsetWidth; + + div.setStyle('overflow', (Ext.isWebKit || Ext.isGecko) ? 'auto' : 'scroll'); + + var w2 = child.offsetWidth, width = w1 - w2; + div.remove(); + + // We assume width == height for now. TODO: is this always true? + scrollbarSize = { width: width, height: width }; } - me.autoRefreshProcId = setInterval(me.update.createDelegate(me, [url || me.defaultUrl, params, callback, true]), interval * 1000); + + return scrollbarSize; }, /** - * Stop auto refresh on this element. + * 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 (optional) true to force a recalculation of the value. + * @return {Number} The width of a vertical scrollbar. + * @deprecated */ - stopAutoRefresh : function(){ - if(this.autoRefreshProcId){ - clearInterval(this.autoRefreshProcId); - delete this.autoRefreshProcId; - } + getScrollBarWidth: function(force){ + var size = Ext.getScrollbarSize(force); + return size.width + 2; // legacy fudge factor }, /** - * Returns true if the Updater is currently set to auto refresh its content (see {@link #startAutoRefresh}), otherwise false. + * 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 {Array/String} names Either an Array of property names, or a comma-delimited list + * of property names to copy. + * @param {Boolean} usePrototypeKeys (Optional) Defaults to false. Pass true to copy keys off of the prototype as well as the instance. + * @return {Object} The modified object. */ - isAutoRefreshing : function(){ - return !!this.autoRefreshProcId; + copyTo : function(dest, source, names, usePrototypeKeys){ + if(typeof names == 'string'){ + names = names.split(/[,;\s]/); + } + Ext.each(names, function(name){ + if(usePrototypeKeys || source.hasOwnProperty(name)){ + dest[name] = source[name]; + } + }, this); + return dest; }, /** - * Display the element's "loading" state. By default, the element is updated with {@link #indicatorText}. This - * method may be overridden to perform a custom action while this Updater is actively updating its contents. + * 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 {Mixed} arg1 The name of the property to destroy and remove from the object. + * @param {Mixed} etc... More property names to destroy and remove. */ - showLoading : function(){ - if(this.showLoadIndicator){ - this.el.dom.innerHTML = this.indicatorText; + destroyMembers : function(o){ + for (var i = 1, a = arguments, len = a.length; i < len; i++) { + Ext.destroy(o[a[i]]); + delete o[a[i]]; } }, /** - * Aborts the currently executing transaction, if any. + * 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 100). + * + * If additional parameters are passed, they are joined and appended to the message. + * + * This method does nothing in a release build. + * + * @param {String|Object} message 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. + * @markdown */ - abort : function(){ - if(this.transaction){ - Ext.Ajax.abort(this.transaction); - } + log : function (message) { }, /** - * Returns true if an update is in progress, otherwise false. - * @return {Boolean} + * Partitions the set into two sets: a true set and a false set. + * Example: + * Example2: + *+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 {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 */ - isUpdating : function(){ - return this.transaction ? Ext.Ajax.isLoading(this.transaction) : false; + partition : function(arr, truth){ + var ret = [[],[]]; + Ext.each(arr, function(v, i, a) { + ret[ (truth && truth(v, i, a)) || (!truth && v) ? 0 : 1].push(v); + }); + return ret; }, /** - * Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately - * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) + * Invokes a method on each item in an Array. + *+// Example 1: +Ext.partition([true, false, true, true, false]); // [[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 of items to invoke the method on. + * @param {String} methodName The method name to invoke. + * @param {...*} 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 */ - refresh : function(callback){ - if(this.defaultUrl){ - this.update(this.defaultUrl, null, callback, true); - } - } + invoke : function(arr, methodName){ + var ret = [], + args = Array.prototype.slice.call(arguments, 2); + Ext.each(arr, function(v,i) { + if (v && typeof v[methodName] == 'function') { + ret.push(v[methodName].apply(v, args)); + } else { + ret.push(undefined); + } + }); + return ret; + }, + + /** + *+// Example: +Ext.invoke(Ext.query("p"), "getAttribute", "id"); +// [el1.getAttribute("id"), el2.getAttribute("id"), ..., elN.getAttribute("id")] + *
Zips N sets together.
+ *+ * @param {Arrays|NodeLists} 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 = []; -/** - * @class Ext.Updater.defaults - * The defaults collection enables customizing the default properties of Updater - */ -Ext.Updater.defaults = { - /** - * Timeout for requests or form posts in seconds (defaults to 30 seconds). - * @type Number - */ - timeout : 30, - /** - * True to append a unique parameter to GET requests to disable caching (defaults to false). - * @type Boolean - */ - disableCaching : false, - /** - * Whether or not to show {@link #indicatorText} during loading (defaults to true). - * @type Boolean - */ - showLoadIndicator : true, - /** - * Text for loading indicator (defaults to '<div class="loading-indicator">Loading...</div>'). - * @type String - */ - indicatorText : '+// 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"] + *
Loading...', - /** - * True to process scripts by default (defaults to false). - * @type Boolean - */ - loadScripts : false, - /** - * Blank page URL to use with SSL file uploads (defaults to {@link Ext#SSL_SECURE_URL} if set, or "javascript:false"). - * @type String - */ - sslBlankUrl : Ext.SSL_SECURE_URL -}; + for (var i = 0; i < len; i++) { + ret[i] = []; + if(fn){ + ret[i] = fn.apply(fn, Ext.pluck(arrs, i)); + }else{ + for (var 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 {Array} 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; + if (length <= 1) { + return items[0]; + } else { + var head = items.slice(0, length - 1), + tail = items[length - 1]; + + return Ext.util.Format.format("{0} {1} {2}", head.join(", "), connector || 'and', tail); + } + }, + + /** + * By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash, + * you may want to set this to true. + * @type Boolean + */ + useShims: isIE6 + }); +})(); /** - * Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}). - * Usage: - *- * @param {Mixed} el The element to update - * @param {String} url The url - * @param {String/Object} params (optional) Url encoded param string or an object of name/value pairs - * @param {Object} options (optional) A config object with any of the Updater properties you want to set - for - * example: {disableCaching:true, indicatorText: "Loading data..."} - * @static - * @deprecated - * @member Ext.Updater + * 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} config */ -Ext.Updater.updateElement = function(el, url, params, options){ - var um = Ext.get(el).getUpdater(); - Ext.apply(um, options); - um.update(url, params, options ? options.callback : null); +Ext.application = function(config) { + Ext.require('Ext.app.Application'); + + Ext.onReady(function() { + Ext.create('Ext.app.Application', config); + }); }; /** - * @class Ext.Updater.BasicRenderer - *Ext.Updater.updateElement("my-div", "stuff.php");
This class is a base class implementing a simple render method which updates an element using results from an Ajax request.
- *The BasicRenderer updates the element's innerHTML with the responseText. To perform a custom render (i.e. XML or JSON processing), - * create an object with a conforming {@link #render} method and pass it to setRenderer on the Updater.
- */ -Ext.Updater.BasicRenderer = function(){}; + * @class Ext.util.Format -Ext.Updater.BasicRenderer.prototype = { - /** - * This method is called when an Ajax response is received, and an Element needs updating. - * @param {Ext.Element} el The element being rendered - * @param {Object} xhr The XMLHttpRequest object - * @param {Updater} updateManager The calling update manager - * @param {Function} callback A callback that will need to be called if loadScripts is true on the Updater - */ - render : function(el, response, updateManager, callback){ - el.update(response.responseText, updateManager.loadScripts, callback); - } -};/** - * @class Date - * - * The date parsing and formatting syntax contains a subset of - * PHP's date() function, 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 - M$ Microsoft AJAX serialized dates \/Date(1238606590509)\/ (i.e. UTC milliseconds since epoch) or - \/Date(1238606590509+0800)\/ -- * - * Example usage (note that you must escape format specifiers with '\\' to render them as character literals): - *- * - * Here are some standard date/time patterns that you might find helpful. They - * are not part of the source of Date.js, but to use them you can simply copy this - * block of code into any script that is included after Date.js and they will also become - * globally available on the Date object. Feel free to add or remove patterns as needed in your code. - *-// Sample date: -// 'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)' +This class is a centralized place for formatting functions inside the library. It includes +functions to format various different types of data, such as text, dates and numeric values. -var dt = new Date('1/10/2007 03:05:01 PM GMT-0600'); -document.write(dt.format('Y-m-d')); // 2007-01-10 -document.write(dt.format('F j, Y, g:i a')); // January 10, 2007, 3:05 pm -document.write(dt.format('l, \\t\\he jS \\of F Y h:i:s A')); // Wednesday, the 10th of January 2007 03:05:01 PM -
- * - * Example usage: - *-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" -}; -
- *-var dt = new Date(); -document.write(dt.format(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}.
- */ +__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}. -/* - * 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. - */ +__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}' + ]); + + * @markdown + * @singleton + */ (function() { + Ext.ns('Ext.util'); -/** - * Global flag which determines if strict date parsing should be used. - * Strict date parsing will not roll-over invalid dates, which is the - * default behaviour of javascript Date objects. - * (see {@link #parseDate} for more information) - * Defaults to false. - * @static - * @type Boolean -*/ -Date.useStrict = false; + Ext.util.Format = {}; + var UtilFormat = Ext.util.Format, + stripTagsRE = /<\/?[^>]+>/gi, + stripScriptsRe = /(?:)((\n|\r|.)*?)(?:<\/script>)/ig, + nl2brRe = /\r?\n/g, + // A RegExp to remove from a number format string, all characters except digits and '.' + formatCleanRe = /[^\d\.]/g, -// create private copy of Ext's String.format() method -// - to remove unnecessary dependency -// - to resolve namespace conflict with M$-Ajax's implementation -function xf(format) { - var args = Array.prototype.slice.call(arguments, 1); - return format.replace(/\{(\d+)\}/g, function(m, i) { - return args[i]; - }); -} + // 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; + Ext.apply(UtilFormat, { + /** + * @type String + * @property thousandSeparator + * The character that the {@link #number} function uses as a thousand separator.
+ *This defaults to
+ */ + thousandSeparator: ',', -// private -Date.formatCodeToRegex = function(character, currentGroup) { - // Note: currentGroup - position in regex result array (see notes for Date.parseCodes below) - var p = Date.parseCodes[character]; + /** + * @type String + * @property decimalSeparator + *,
, but may be overridden in a locale file.The character that the {@link #number} function uses as a decimal point.
+ *This defaults to
+ */ + decimalSeparator: '.', - if (p) { - p = typeof p == 'function'? p() : p; - Date.parseCodes[character] = p; // reassign function result to prevent repeated execution - } + /** + * @type Number + * @property currencyPrecision + *.
, but may be overridden in a locale file.The number of decimal places that the {@link #currency} function displays.
+ *This defaults to
+ */ + currencyPrecision: 2, - return p ? Ext.applyIf({ - c: p.c ? xf(p.c, currentGroup || "{0}") : p.c - }, p) : { - g:0, - c:null, - s:Ext.escapeRe(character) // treat unrecognised characters as literals - } -}; + /** + * @type String + * @property currencySign + *2
, but may be overridden in a locale file.The currency sign that the {@link #currency} function displays.
+ *This defaults to
+ */ + currencySign: '$', -// private shorthand for Date.formatCodeToRegex since we'll be using it fairly often -var $f = Date.formatCodeToRegex; + /** + * @type Boolean + * @property currencyAtEnd + *$
, but may be overridden in a locale file.This may be set to
+ *true
to make the {@link #currency} function + * append the currency sign to the formatted value.This defaults to
+ */ + currencyAtEnd: false, -Ext.apply(Date, { - /** - *false
, but may be overridden in a locale file.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 #parseDate}.
- *
Example:
- *-Date.parseFunctions['x-date-format'] = myDateParser; -
A parsing function should return a Date object, and is passed the following parameters:
- *- *
- - *
date
: StringThe date string to parse.- - *
strict
: BooleanTrue 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 - * @static - * @type Object - */ - parseFunctions: { - "M$": function(input, strict) { - // note: the timezone offset is ignored since the M$ Ajax server sends - // a UTC milliseconds-since-Unix-epoch value (negative values are allowed) - var re = new RegExp('\\/Date\\(([-+])?(\\d+)(?:[+-]\\d{4})?\\)\\/'); - var r = (input || '').match(re); - return r? new Date(((r[1] || '') + r[2]) * 1) : null; + /** + * Checks a reference and converts it to empty string if it is undefined + * @param {Mixed} value Reference to check + * @return {Mixed} 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 {Mixed} value Reference to check + * @param {String} defaultValue The value to insert of it's undefined (defaults to "") + * @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 + */ + substr : 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 = decimals || UtilFormat.currencyPrecision; + format += 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 + * Date object's parse() method. + * @param {String} format (Optional) 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 {Mixed} 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 {Mixed} 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(size) { + if (size < 1024) { + return size + " bytes"; + } else if (size < 1048576) { + return (Math.round(((size*10) / 1024))/10) + " KB"; + } else { + return (Math.round(((size*10) / 1048576))/10) + " MB"; + } + }, + + /** + * It does simple math for use in a template, for example:
+ * @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; + }, + + /** + *+ * var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}'); + *
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 Ext4
+ *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): + *+ * @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; + } + v = Ext.Number.from(v, NaN); + if (isNaN(v)) { + return ''; + } + var comma = UtilFormat.thousandSeparator, + dec = UtilFormat.decimalSeparator, + i18n = false, + neg = v < 0, + hasComma, + psplit; + + v = Math.abs(v); + + // 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); + i18n = true; + hasComma = formatString.indexOf(comma) != -1; + psplit = formatString.replace(I18NFormatCleanRe, '').split(dec); + } else { + hasComma = formatString.indexOf(',') != -1; + psplit = formatString.replace(formatCleanRe, '').split('.'); + } + + if (1 < psplit.length) { + v = v.toFixed(psplit[1].length); + } else if(2 < psplit.length) { + } else { + v = v.toFixed(0); + } + + var fnum = v.toString(); + + psplit = fnum.split('.'); + + if (hasComma) { + var cnum = psplit[0], + parr = [], + j = cnum.length, + m = Math.floor(j / 3), + n = cnum.length % 3 || 3, + i; + + for (i = 0; i < j; i += n) { + if (i !== 0) { + n = 3; + } + + parr[parr.length] = cnum.substr(i, n); + m -= 1; + } + fnum = parr.join(comma); + if (psplit[1]) { + fnum += dec + psplit[1]; + } + } else { + if (psplit[1]) { + fnum = psplit[0] + dec + psplit[1]; + } + } + + if (neg) { + /* + * Edge case. If we have a very small negative number it will get rounded to 0, + * however the initial check at the top will still report as negative. Replace + * everything but 1-9 and check if the string is empty to determine a 0 value. + */ + neg = fnum.replace(/[^1-9]/g, '') !== ''; + } + + return (neg ? '-' : '') + formatString.replace(/[\d,?\.?]+/, fnum); + }, + + /** + * Returns a number rendering function that can be reused to apply a number format multiple times efficiently + * @param {String} format Any valid number format string for {@link #number} + * @return {Function} The number formatting function + */ + numberRenderer : function(format) { + return function(v) { + return UtilFormat.number(v, format); + }; + }, + + /** + * Selectively do a plural form of a word based on a numeric value. For example, in a template, + * {commentCount:plural("Comment")} would result in "1 Comment" if commentCount was 1 or would be "x Comments" + * if the value is 0 or greater than 1. + * @param {Number} value The value to compare against + * @param {String} singular The singular form of the word + * @param {String} plural (optional) The plural form of the word (defaults to the singular with an "s") + */ + plural : function(v, s, p) { + return v +' ' + (v == 1 ? s : (p ? p : s+'s')); + }, + + /** + * Converts newline characters to the HTML tag <br/> + * @param {String} The string value to format. + * @return {String} The string with embedded <br/> tags in place of newlines. + */ + nl2br : function(v) { + return Ext.isEmpty(v) ? '' : v.replace(nl2brRe, '+ * 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
+ * To allow specification of the formatting string using UK/US grouping characters (,) and decimal (.) for international numbers, add /i to the end. + * For example: 0.000,00/i + *
'); + }, + + /** + * Capitalize the given string. See {@link Ext.String#capitalize}. + * @method + */ + capitalize: Ext.String.capitalize, + + /** + * Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length. + * See {@link Ext.String#ellipsis}. + * @method + */ + ellipsis: Ext.String.ellipsis, + + /** + * Formats to a string. See {@link Ext.String#format} + * @method + */ + format: Ext.String.format, + + /** + * Convert certain characters (&, <, >, and ') from their HTML character equivalents. + * See {@link Ext.String#htmlDecode}. + * @method + */ + htmlDecode: Ext.String.htmlDecode, + + /** + * Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. + * See {@link Ext.String#htmlEncode}. + * @method + */ + htmlEncode: Ext.String.htmlEncode, + + /** + * Adds left padding to a string. See {@link Ext.String#leftPad} + * @method + */ + leftPad: Ext.String.leftPad, + + /** + * Trims any whitespace from either side of a string. See {@link Ext.String#trim}. + * @method + */ + 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) { + if (Ext.isNumber(box)) { + box = box.toString(); + } + 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"); + } + }); +})(); + +/** + * @class Ext.util.TaskRunner + * Provides the ability to execute one or more arbitrary tasks in a multithreaded + * 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 task = { + run: updateClock, + interval: 1000 //1 second +} +var runner = new Ext.util.TaskRunner(); +runner.start(task); + +// equivalent using TaskManager +Ext.TaskManager.start({ + run: updateClock, + interval: 1000 +}); + + *
See the {@link #start} method for details about how to configure a task object.
+ * Also see {@link Ext.util.DelayedTask}. + * + * @constructor + * @param {Number} interval (optional) The minimum precision in milliseconds supported by this TaskRunner instance + * (defaults to 10) + */ +Ext.ns('Ext.util'); + +Ext.util.TaskRunner = function(interval) { + interval = interval || 10; + var tasks = [], + removeQueue = [], + id = 0, + running = false, + + // private + stopThread = function() { + running = false; + clearInterval(id); + id = 0; + }, + + // private + startThread = function() { + if (!running) { + running = true; + id = setInterval(runTasks, interval); + } + }, + + // private + removeTask = function(t) { + removeQueue.push(t); + if (t.onStop) { + t.onStop.apply(t.scope || t); + } + }, + + // private + runTasks = function() { + var rqLen = removeQueue.length, + now = new Date().getTime(), + i; + + if (rqLen > 0) { + for (i = 0; i < rqLen; i++) { + Ext.Array.remove(tasks, removeQueue[i]); + } + removeQueue = []; + if (tasks.length < 1) { + stopThread(); + return; + } + } + i = 0; + var t, + itime, + rt, + len = tasks.length; + for (; i < len; ++i) { + t = tasks[i]; + itime = now - t.taskRunTime; + if (t.interval <= itime) { + rt = t.run.apply(t.scope || t, t.args || [++t.taskRunCount]); + t.taskRunTime = now; + if (rt === false || t.taskRunCount === t.repeat) { + removeTask(t); + return; + } + } + if (t.duration && t.duration <= (now - t.taskStartTime)) { + removeTask(t); + } + } + }; + + /** + * Starts a new task. + * @method start + * @param {Object} taskA config object that supports the following properties:
+ *
+ *- + *
run
: FunctionThe 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 thescope
argument.Return
false
from this function to terminate the task.- + *
interval
: NumberThe frequency in milliseconds with which the task + * should be invoked.- + *
args
: Array(optional) An array of arguments to be passed to the function + * specified byrun
. If not specified, the current invocation count is passed.- + *
scope
: Object(optional) The scope (this reference) in which to execute the + *run
function. Defaults to the task config object.- + *
duration
: Number(optional) The length of time in milliseconds to invoke + * the task before stopping automatically (defaults to indefinite).- + *
repeat
: Number(optional) The number of times to invoke the task before + * stopping automatically (defaults to indefinite).Before each invocation, Ext injects the property
+ * @return {Object} The task + */ + this.start = function(task) { + tasks.push(task); + task.taskStartTime = new Date().getTime(); + task.taskRunTime = 0; + task.taskRunCount = 0; + startThread(); + return task; + }; + + /** + * Stops an existing running task. + * @method stop + * @param {Object} task The task to stop + * @return {Object} The task + */ + this.stop = function(task) { + removeTask(task); + return task; + }; + + /** + * Stops all tasks that are currently running. + * @method stopAll + */ + this.stopAll = function() { + stopThread(); + for (var i = 0, len = tasks.length; i < len; i++) { + if (tasks[i].onStop) { + tasks[i].onStop(); + } + } + tasks = []; + removeQueue = []; + }; +}; + +/** + * @class Ext.TaskManager + * @extends Ext.util.TaskRunner + * 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. + *taskRunCount
into the task object so + * that calculations based on the repeat count can be performed.+ *+// 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.
+ * @singleton + */ +Ext.TaskManager = Ext.create('Ext.util.TaskRunner'); +/** + * @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 + */ +Ext.supports = { + init : function() { + var doc = document, + div = doc.createElement('div'), + tests = this.tests, + ln = tests.length, + i, test; + + div.innerHTML = [ + '', + '', + '', + '', + '', + '', + '' + ].join(''); + + doc.body.appendChild(div); + + for (i = 0; i < ln; i++) { + test = tests[i]; + this[test.identity] = test.fn.call(this, doc, div); + } + + doc.body.removeChild(div); + }, + + /** + * @property CSS3BoxShadow True if document environment supports the CSS3 box-shadow style. + * @type {Boolean} + */ + CSS3BoxShadow: Ext.isDefined(document.documentElement.style.boxShadow), + + /** + * @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), + + 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; + div = Ext.get(div); + for (; i < ln; i++) { + if (div.getStyle(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', + 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', + 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() { + return !!(window.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, + options = [property + webkit, property + w3c, property + moz]; + + div.style.cssText = options.join(';'); + + return ("" + div.style.backgroundImage).indexOf('gradient') !== -1; + } + }, + + /** + * @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() { + return (typeof navigator != 'undefined' && typeof navigator.geolocation != 'undefined') || (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); + } + }, + /** + * @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); + } + }, + { + identity: 'IncludePaddingInWidthCalculation', + fn: function(doc, div){ + var el = Ext.get(div.childNodes[1].firstChild); + return el.getWidth() == 210; + } + }, + { + identity: 'IncludePaddingInHeightCalculation', + fn: function(doc, div){ + var el = Ext.get(div.childNodes[1].firstChild); + return el.getHeight() == 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+ + } + } + ] +}; + + + +/* + +This file is part of Ext JS 4 + +Copyright (c) 2011 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. + +*/ +/** + * @class Ext.core.DomHelper + *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 elementNOTE: 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.core.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.core.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.core.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.core.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:
+ *+ * @singleton + */ +Ext.ns('Ext.core'); +Ext.core.DomHelper = function(){ + var tempTableEl = null, + emptyTags = /^(?:br|frame|hr|img|input|link|meta|range|spacer|wbr|area|param|col)$/i, + tableRe = /^table|tbody|tr|td$/i, + confRe = /tag|children|cn|html$/i, + tableElRe = /td|tr|tbody/i, + endRe = /end/i, + pub, + // kill repeat to save bytes + afterbegin = 'afterbegin', + afterend = 'afterend', + beforebegin = 'beforebegin', + beforeend = 'beforeend', + ts = '+Ext.core.DomHelper.useDom = true; // force it to use DOM; reduces performance + *
', + te = '
', + tbs = ts+'', + tbe = ''+te, + trs = tbs + '', + tre = ' '+tbe; + + // private + function doInsert(el, o, returnElement, pos, sibling, append){ + el = Ext.getDom(el); + var newNode; + if (pub.useDom) { + newNode = createDom(o, null); + if (append) { + el.appendChild(newNode); + } else { + (sibling == 'firstChild' ? el : el.parentNode).insertBefore(newNode, el[sibling] || el); + } + } else { + newNode = Ext.core.DomHelper.insertHtml(pos, el, Ext.core.DomHelper.createHtml(o)); + } + return returnElement ? Ext.get(newNode, true) : newNode; + } + + function createDom(o, parentNode){ + var el, + doc = document, + useSet, + attr, + val, + cn; + + if (Ext.isArray(o)) { // Allow Arrays of siblings to be inserted + el = doc.createDocumentFragment(); // in one shot using a DocumentFragment + for (var i = 0, l = o.length; i < l; i++) { + 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(!confRe.test(attr)){ + val = o[attr]; + if(attr == 'cls'){ + el.className = val; + }else{ + if(useSet){ + el.setAttribute(attr, val); + }else{ + el[attr] = val; + } + } + } + } + Ext.core.DomHelper.applyStyles(el, o.style); + + if ((cn = o.children || o.cn)) { + createDom(cn, el); + } else if (o.html) { + el.innerHTML = o.html; + } + } + if(parentNode){ + parentNode.appendChild(el); + } + return el; + } + + // build as innerHTML where available + function createHtml(o){ + var b = '', + attr, + val, + key, + cn, + i; + + if(typeof o == "string"){ + b = o; + } else if (Ext.isArray(o)) { + for (i=0; i < o.length; i++) { + if(o[i]) { + b += createHtml(o[i]); + } + } + } else { + b += '<' + (o.tag = o.tag || 'div'); + for (attr in o) { + val = o[attr]; + if(!confRe.test(attr)){ + if (typeof val == "object") { + b += ' ' + attr + '="'; + for (key in val) { + b += key + ':' + val[key] + ';'; + } + b += '"'; + }else{ + b += ' ' + ({cls : 'class', htmlFor : 'for'}[attr] || attr) + '="' + val + '"'; + } + } + } + // Now either just close the tag or try to add children and close the tag. + if (emptyTags.test(o.tag)) { + b += '/>'; + } else { + b += '>'; + if ((cn = o.children || o.cn)) { + b += createHtml(cn); + } else if(o.html){ + b += o.html; + } + b += '' + o.tag + '>'; + } + } + return b; + } + + function ieTable(depth, s, h, e){ + tempTableEl.innerHTML = [s, h, e].join(''); + var i = -1, + el = tempTableEl, + ns; + while(++i < depth){ + el = el.firstChild; + } +// If the result is multiple siblings, then encapsulate them into one fragment. + ns = el.nextSibling; + if (ns){ + var df = document.createDocumentFragment(); + while(el){ + ns = el.nextSibling; + df.appendChild(el); + el = ns; + } + el = df; + } + return el; + } + + /** + * @ignore + * Nasty code for IE's broken table implementation + */ + function insertIntoTable(tag, where, el, html) { + var node, + before; + + tempTableEl = tempTableEl || document.createElement('div'); + + if(tag == 'td' && (where == afterbegin || where == beforeend) || + !tableElRe.test(tag) && (where == beforebegin || where == afterend)) { + return null; + } + before = where == beforebegin ? el : + where == afterend ? el.nextSibling : + where == afterbegin ? el.firstChild : null; + + if (where == beforebegin || where == afterend) { + el = el.parentNode; + } + + if (tag == 'td' || (tag == 'tr' && (where == beforeend || where == afterbegin))) { + node = ieTable(4, trs, html, tre); + } else if ((tag == 'tbody' && (where == beforeend || where == afterbegin)) || + (tag == 'tr' && (where == beforebegin || where == afterend))) { + node = ieTable(3, tbs, html, tbe); + } else { + node = ieTable(2, ts, html, te); + } + el.insertBefore(node, before); + return node; + } + + /** + * @ignore + * Fix for IE9 createContextualFragment missing method + */ + function createContextualFragment(html){ + var div = document.createElement("div"), + fragment = document.createDocumentFragment(), + i = 0, + length, childNodes; + + div.innerHTML = html; + childNodes = div.childNodes; + length = childNodes.length; + + for (; i < length; i++) { + fragment.appendChild(childNodes[i].cloneNode(true)); + } + + return fragment; + } + + pub = { + /** + * Returns the markup for the passed Element(s) config. + * @param {Object} o The DOM object spec (and children) + * @return {String} + */ + markup : function(o){ + return createHtml(o); + }, + + /** + * 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) { + el = Ext.fly(el); + if (typeof styles == "function") { + styles = styles.call(); + } + if (typeof styles == "string") { + styles = Ext.core.Element.parseStyles(styles); + } + if (typeof styles == "object") { + 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. + * @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 = {}, + hashVal, + range, + rangeEl, + setStart, + frag, + rs; + + where = where.toLowerCase(); + // add these here because they are used in both branches of the condition. + hash[beforebegin] = ['BeforeBegin', 'previousSibling']; + hash[afterend] = ['AfterEnd', 'nextSibling']; + + // if IE and context element is an HTMLElement + if (el.insertAdjacentHTML) { + if(tableRe.test(el.tagName) && (rs = insertIntoTable(el.tagName.toLowerCase(), where, el, html))){ + return rs; + } + + // add these two to the hash. + hash[afterbegin] = ['AfterBegin', 'firstChild']; + hash[beforeend] = ['BeforeEnd', 'lastChild']; + if ((hashVal = hash[where])) { + 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 (Ext.isTextNode(el)) { + where = where === 'afterbegin' ? 'beforebegin' : where; + where = where === 'beforeend' ? 'afterend' : where; + } + range = Ext.supports.CreateContextualFragment ? el.ownerDocument.createRange() : undefined; + setStart = 'setStart' + (endRe.test(where) ? 'After' : 'Before'); + if (hash[where]) { + if (range) { + range[setStart](el); + frag = range.createContextualFragment(html); + } else { + frag = 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 = createContextualFragment(html); + } + + if(where == afterbegin){ + el.insertBefore(frag, el.firstChild); + }else{ + el.appendChild(frag); + } + } else { + el.innerHTML = html; + } + return el[rangeEl]; + } + } + }, + + /** + * Creates new DOM element(s) and inserts them before el. + * @param {Mixed} el The context element + * @param {Object/String} o The DOM object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Ext.core.Element + * @return {HTMLElement/Ext.core.Element} The new node + */ + insertBefore : function(el, o, returnElement){ + return doInsert(el, o, returnElement, beforebegin); + }, + + /** + * Creates new DOM element(s) and inserts them after el. + * @param {Mixed} el The context element + * @param {Object} o The DOM object spec (and children) + * @param {Boolean} returnElement (optional) true to return a Ext.core.Element + * @return {HTMLElement/Ext.core.Element} The new node + */ + insertAfter : function(el, o, returnElement){ + return doInsert(el, o, returnElement, afterend, 'nextSibling'); + }, + + /** + * Creates new DOM element(s) and inserts them as the first child of el. + * @param {Mixed} el The context element + * @param {Object/String} o The DOM object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Ext.core.Element + * @return {HTMLElement/Ext.core.Element} The new node + */ + insertFirst : function(el, o, returnElement){ + return doInsert(el, o, returnElement, afterbegin, 'firstChild'); + }, + + /** + * Creates new DOM element(s) and appends them to el. + * @param {Mixed} el The context element + * @param {Object/String} o The DOM object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Ext.core.Element + * @return {HTMLElement/Ext.core.Element} The new node + */ + append : function(el, o, returnElement){ + return doInsert(el, o, returnElement, beforeend, '', true); + }, + + /** + * Creates new DOM element(s) and overwrites the contents of el with them. + * @param {Mixed} el The context element + * @param {Object/String} o The DOM object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Ext.core.Element + * @return {HTMLElement/Ext.core.Element} The new node + */ + overwrite : function(el, o, returnElement){ + el = Ext.getDom(el); + el.innerHTML = createHtml(o); + return returnElement ? Ext.get(el.firstChild) : el.firstChild; + }, + + createHtml : createHtml, + + /** + * 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 + * @method + */ + createDom: createDom, + + /** True to force the use of DOM instead of html fragments @type Boolean */ + useDom : false, + + /** + * 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 = Ext.core.DomHelper.createHtml(o); + return Ext.create('Ext.Template', html); + } + }; + return pub; +}(); + +/* + * This is code is also distributed under MIT license for use + * with jQuery and prototype JavaScript libraries. + */ +/** + * @class Ext.DomQuery +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, 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 nth 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 nth 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//\\
+CSS Value Selectors:
++
+ * @singleton + */ +Ext.ns('Ext.core'); + +Ext.core.DomQuery = Ext.DomQuery = function(){ + var cache = {}, + simpleCache = {}, + valueCache = {}, + nonSpace = /\S/, + trimRe = /^\s+|\s+$/g, + tplRe = /\{(\d+)\}/g, + modeRe = /^(\s?[\/>+~]\s?|\s|$)/, + tagTokenRe = /^(#)?([\w-\*]+)/, + nthRe = /(\d*)n\+?(\d*)/, + nthRe2 = /\D/, + // 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; + + // this eval is stop the compressor from + // renaming the variable to something shorter + eval("var batch = 30803;"); + + // Retrieve the child node from a particular + // parent at the specified 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 + function next(n){ + while((n = n.nextSibling) && n.nodeType != 1); + return n; + } + + // retrieve the previous element node + function prev(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 + function byClassName(nodeSet, cls){ + if(!cls){ + return nodeSet; + } + var result = [], ri = -1; + for(var i = 0, ci; 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; + if(!ns){ + return result; + } + tagName = tagName || "*"; + // convert to array + if(typeof ns.getElementsByTagName != "undefined"){ + ns = [ns]; + } + + // no mode specified, grab all elements by tagName + // at any depth + if(!mode){ + for(var i = 0, ni; ni = ns[i]; i++){ + cs = ni.getElementsByTagName(tagName); + for(var j = 0, ci; 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 == ">"){ + var utag = tagName.toUpperCase(); + for(var i = 0, ni, cn; ni = ns[i]; i++){ + cn = ni.childNodes; + for(var j = 0, cj; 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 == "+"){ + var utag = tagName.toUpperCase(); + for(var i = 0, n; 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 == "~"){ + var utag = tagName.toUpperCase(); + for(var i = 0, n; 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){ + if(b.slice){ + return a.concat(b); + } + for(var i = 0, l = b.length; i < l; i++){ + a[a.length] = b[i]; + } + return a; + } + + function byTag(cs, tagName){ + if(cs.tagName || cs == document){ + cs = [cs]; + } + if(!tagName){ + return cs; + } + var result = [], ri = -1; + tagName = tagName.toLowerCase(); + for(var i = 0, ci; ci = cs[i]; i++){ + if(ci.nodeType == 1 && ci.tagName.toLowerCase() == tagName){ + result[++ri] = ci; + } + } + return result; + } + + function byId(cs, id){ + if(cs.tagName || cs == document){ + cs = [cs]; + } + if(!id){ + return cs; + } + var result = [], ri = -1; + for(var i = 0, ci; 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 = Ext.DomQuery.operators[op], + a, + xml, + hasXml; + + for(var i = 0, ci; ci = cs[i]; i++){ + // skip non-element nodes. + if(ci.nodeType != 1){ + continue; + } + // only need to do this for the first node + if(!hasXml){ + xml = Ext.DomQuery.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 = Ext.DomQuery.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){ + return Ext.DomQuery.pseudos[name](cs, value); + } + + function nodupIEXml(cs){ + var d = ++key, + r; + cs[0].setAttribute("_nodup", d); + r = [cs[0]]; + for(var i = 1, len = cs.length; i < len; i++){ + var c = cs[i]; + if(!c.getAttribute("_nodup") != d){ + c.setAttribute("_nodup", d); + r[r.length] = c; + } + } + for(var 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; + if(!len || typeof cs.nodeType != "undefined" || len == 1){ + return cs; + } + if(isIE && typeof cs[0].selectSingleNode != "undefined"){ + return nodupIEXml(cs); + } + var d = ++key; + cs[0]._nodup = d; + for(i = 1; c = cs[i]; i++){ + if(c._nodup != d){ + c._nodup = d; + }else{ + r = []; + for(var 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 = []; + for(var i = 0, len = c1.length; i < len; i++){ + c1[i].setAttribute("_qdiff", d); + } + for(var i = 0, len = c2.length; i < len; i++){ + if(c2[i].getAttribute("_qdiff") != d){ + r[r.length] = c2[i]; + } + } + for(var 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 = []; + if(!len1){ + return c2; + } + if(isIE && typeof c1[0].selectSingleNode != "undefined"){ + return quickDiffIEXml(c1, c2); + } + for(var i = 0; i < len1; i++){ + c1[i]._qdiff = d; + } + for(var 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){ + var d = root.ownerDocument || root; + return d.getElementById(id); + } + ns = getNodes(ns, mode, "*"); + return byId(ns, id); + } + + return { + getStyle : function(el, name){ + return Ext.fly(el).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 (optional) Either "select" (the default) 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"], + mode, + lastPath, + matchers = Ext.DomQuery.matchers, + matchersLn = matchers.length, + modeMatch, + // accept leading mode switch + lmode = path.match(modeRe); + + 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; + var 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))){ + var matched = false; + for(var j = 0; j < matchersLn; j++){ + var t = matchers[j]; + var 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){ + } + } + 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 {Node/String} root (optional) The start of the query (defaults to document). + * @return {Array} 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 || document; + + if(typeof root == "string"){ + root = document.getElementById(root); + } + var paths = path.split(","), + results = []; + + // loop over each selector + for(var i = 0, len = paths.length; i < len; i++){ + var subPath = paths[i].replace(trimRe, ""); + // compile and place in cache + if(!cache[subPath]){ + cache[subPath] = Ext.DomQuery.compile(subPath); + if(!cache[subPath]){ + } + } + var result = cache[subPath](root); + if(result && result != document){ + 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 #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 {Node} root (optional) The start of the query (defaults to document). + * @return {Array} An array of DOM elements (not a NodeList as returned by `querySelectorAll`). + * Empty array when no matches. + * @method + */ + select : document.querySelectorAll ? function(path, root, type) { + root = root || document; + if (!Ext.DomQuery.isXml(root)) { + try { + var cs = root.querySelectorAll(path); + return Ext.Array.toArray(cs); + } + catch (ex) {} + } + return Ext.DomQuery.jsSelect.call(this, path, root, type); + } : function(path, root, type) { + return Ext.DomQuery.jsSelect.call(this, path, root, type); + }, + + /** + * Selects a single element. + * @param {String} selector The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @return {Element} The DOM element which matched the selector. + */ + selectNode : function(path, root){ + return Ext.DomQuery.select(path, root)[0]; + }, + + /** + * Selects the value of a node, optionally replacing null with the defaultValue. + * @param {String} selector The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @param {String} defaultValue + * @return {String} + */ + selectValue : function(path, root, defaultValue){ + path = path.replace(trimRe, ""); + if(!valueCache[path]){ + valueCache[path] = Ext.DomQuery.compile(path, "select"); + } + 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 {Node} root (optional) The start of the query (defaults to document). + * @param {Number} defaultValue + * @return {Number} + */ + selectNumber : function(path, root, defaultValue){ + var v = Ext.DomQuery.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/Array} 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 = document.getElementById(el); + } + var isArray = Ext.isArray(el), + result = Ext.DomQuery.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 {Array} 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 {Array} 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] = Ext.DomQuery.compile(ss, "simple"); + } + 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: '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, > <. + */ + 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"); + + * @markdown + */ + pseudos : { + "first-child" : function(c){ + var r = [], ri = -1, n; + for(var i = 0, ci; 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; + for(var i = 0, ci; 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; + for(var i = 0, n; n = c[i]; i++){ + var pn = n.parentNode; + if (batch != pn._batch) { + var j = 0; + for(var 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;; + for(var i = 0, ci; ci = c[i]; i++){ + if(!prev(ci) && !next(ci)){ + r[++ri] = ci; + } + } + return r; + }, + + "empty" : function(c){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + var cns = ci.childNodes, j = 0, cn, 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; + for(var i = 0, ci; ci = c[i]; i++){ + if((ci.textContent||ci.innerText||'').indexOf(v) != -1){ + r[++ri] = ci; + } + } + return r; + }, + + "nodeValue" : function(c, v){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if(ci.firstChild && ci.firstChild.nodeValue == v){ + r[++ri] = ci; + } + } + return r; + }, + + "checked" : function(c){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if(ci.checked == true){ + r[++ri] = ci; + } + } + return r; + }, + + "not" : function(c, ss){ + return Ext.DomQuery.filter(c, ss, true); + }, + + "any" : function(c, selectors){ + var ss = selectors.split('|'), + r = [], ri = -1, s; + for(var i = 0, ci; ci = c[i]; i++){ + for(var j = 0; s = ss[j]; j++){ + if(Ext.DomQuery.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 = Ext.DomQuery.select, + r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if(s(ss, ci).length > 0){ + r[++ri] = ci; + } + } + return r; + }, + + "next" : function(c, ss){ + var is = Ext.DomQuery.is, + r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + var n = next(ci); + if(n && is(n, ss)){ + r[++ri] = ci; + } + } + return r; + }, + + "prev" : function(c, ss){ + var is = Ext.DomQuery.is, + r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + var n = prev(ci); + if(n && is(n, ss)){ + r[++ri] = ci; + } + } + return r; + } + } + }; +}(); + +/** + * Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Ext.DomQuery#select} + * @param {String} path The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @return {Array} + * @member Ext + * @method query + */ +Ext.query = Ext.DomQuery.select; + +/** + * @class Ext.core.Element + *- 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"
+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. To + * access the underlying browser event, see {@link Ext.EventObject#browserEvent}. Some older + * browsers may not support the full range of events. Which events are supported is beyond the control of ExtJs.
+ * Usage:
++ * Animations+// by id +var el = Ext.get("my-div"); + +// by DOM element reference +var el = Ext.get(myDivElement); +
+ *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} .35 The duration of the animation in seconds +{@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 ++ * + *+ *+// Element animation options object +var opt = { + {@link Ext.fx.Anim#duration duration}: 1, + {@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(); +} + *
Also see the {@link #animate} method for another animation technique.
+ *Composite (Collections of) Elements
+ *For working with collections of Elements, see {@link Ext.CompositeElement}
+ * @constructor Create a new Element directly. + * @param {String/HTMLElement} element + * @param {Boolean} forceNew (optional) 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). + */ + (function() { + var DOC = document, + EC = Ext.cache; + + Ext.Element = Ext.core.Element = function(element, forceNew) { + var dom = typeof element == "string" ? DOC.getElementById(element) : element, + id; + + if (!dom) { + return null; + } + + id = dom.id; + + if (!forceNew && id && EC[id]) { + // element object already exists + return EC[id].el; + } + + /** + * The DOM element + * @type HTMLElement + */ + this.dom = dom; + + /** + * The DOM element ID + * @type String + */ + this.id = id || Ext.id(dom); + }; + + var DH = Ext.core.DomHelper, + El = Ext.core.Element; + + + El.prototype = { + /** + * 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 (optional) false to override the default setAttribute to use expandos. + * @return {Ext.core.Element} this + */ + set: function(o, useSet) { + var el = this.dom, + attr, + val; + useSet = (useSet !== false) && !!el.setAttribute; + + for (attr in o) { + if (o.hasOwnProperty(attr)) { + val = o[attr]; + if (attr == 'style') { + DH.applyStyles(el, val); + } else if (attr == 'cls') { + el.className = val; + } else if (useSet) { + el.setAttribute(attr, val); + } else { + el[attr] = val; + } + } + } + return this; + }, + + // 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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + + // 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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + + + // 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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + + // 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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + + // 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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + + // 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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + /** + * @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. + * @param {Object} o The options configuration passed to the {@link #addListener} call. + */ + + /** + * The default unit to append to CSS values where a unit isn't provided (defaults to px). + * @type String + */ + 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); + }, + + /** + * Tries to focus the element. Any exceptions are caught and ignored. + * @param {Number} defer (optional) Milliseconds to defer the focus + * @return {Ext.core.Element} this + */ + focus: function(defer, + /* private */ + dom) { + var me = this; + dom = dom || me.dom; + try { + if (Number(defer)) { + Ext.defer(me.focus, defer, null, [null, dom]); + } else { + dom.focus(); + } + } catch(e) {} + return me; + }, + + /** + * Tries to blur the element. Any exceptions are caught and ignored. + * @return {Ext.core.Element} this + */ + blur: function() { + try { + this.dom.blur(); + } catch(e) {} + return this; + }, + + /** + * 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; + }, + + /** + * Appends an event handler to this element. The shorthand version {@link #on} is equivalent. + * @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:+ *
+ * @param {Object} scope (optional) The scope (- 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 addListener call.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.core.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
+ * In the following examples, the shorthand form {@link #on} is used rather than the more verbose + * addListener. The two are equivalent. 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:
+ * @return {Ext.core.Element} this + */ + addListener: function(eventName, fn, scope, options) { + Ext.EventManager.on(this.dom, eventName, fn, scope || this, options); + return this; + }, + + /** + * Removes an event handler from this element. The shorthand version {@link #un} is equivalent. + * Note: if a scope was explicitly specified when {@link #addListener adding} the + * listener, the same scope must be specified here. + * Example: + *+// using this markup: +<div id='elId'> + <p id='p1'>paragraph one</p> + <p id='p2' class='clickable'>paragraph two</p> + <p id='p3'>paragraph three</p> +</div> +// 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' + } +); + *
+ * @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 #addListener} call. + * @param {Object} scope If a scope (+el.removeListener('click', this.handlerFn); +// or +el.un('click', this.handlerFn); +
this
reference) was specified when the listener was added, + * then this must refer to the same object. + * @return {Ext.core.Element} this + */ + removeListener: function(eventName, fn, scope) { + Ext.EventManager.un(this.dom, eventName, fn, scope || this); + return this; + }, + + /** + * Removes all previous added listeners from this element + * @return {Ext.core.Element} this + */ + removeAllListeners: function() { + Ext.EventManager.removeAll(this.dom); + return this; + }, + + /** + * Recursively removes all previous added listeners from this element and its children + * @return {Ext.core.Element} this + */ + purgeAllListeners: function() { + Ext.EventManager.purgeElement(this); + return this; + }, + + /** + * @private Test if size has a unit, otherwise appends the passed unit string, or the default for this Element. + * @param size {Mixed} The size to set + * @param units {String} The units to append to a numeric size value + */ + addUnits: function(size, units) { + + // Most common case first: Size is set to a number + if (Ext.isNumber(size)) { + 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 (!unitPattern.test(size)) { + return size || ''; + } + return size; + }, + + /** + * Tests various css rules/browsers to determine if this element uses a border box + * @return {Boolean} + */ + isBorderBox: function() { + return Ext.isBorderBox || noBoxAdjust[(this.dom.tagName || "").toLowerCase()]; + }, + + /** + *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 (dom) { + delete me.dom; + Ext.removeNode(dom); + } + }, + + /** + * 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 (optional) The scope (this
reference) in which the functions are executed. Defaults to the Element's DOM element. + * @param {Object} options (optional) Options for the listener. See {@link Ext.util.Observable#addListener the options parameter}. + * @return {Ext.core.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 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) { + return ! el ? false: Ext.core.Element.isAncestor(this.dom, el.dom ? el.dom: el); + }, + + /** + * 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 + * @deprecated + */ + getAttributeNS: function(ns, name) { + return this.getAttribute(name, ns); + }, + + /** + * Returns the value of an attribute from the element's underlying DOM node. + * @param {String} name The attribute name + * @param {String} namespace (optional) The namespace in which to look for the attribute + * @return {String} The attribute value + * @method + */ + getAttribute: (Ext.isIE && !(Ext.isIE9 && document.documentMode === 9)) ? + 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; + }, + + /** + * Update the innerHTML of this element + * @param {String} html The new HTML + * @return {Ext.core.Element} this + */ + update: function(html) { + if (this.dom) { + this.dom.innerHTML = html; + } + return this; + } + }; + + var ep = El.prototype; + + El.addMethods = function(o) { + Ext.apply(ep, o); + }; + + /** + * Appends an event handler (shorthand for {@link #addListener}). + * @param {String} eventName The name of event to handle. + * @param {Function} fn The handler function the event invokes. + * @param {Object} scope (optional) The scope (this
reference) in which the handler function is executed. + * @param {Object} options (optional) An object containing standard {@link #addListener} options + * @member Ext.core.Element + * @method on + */ + ep.on = ep.addListener; + + /** + * Removes an event handler from this element (see {@link #removeListener} for additional notes). + * @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 #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. + * @return {Ext.core.Element} this + * @member Ext.core.Element + * @method un + */ + ep.un = ep.removeListener; + + /** + * Removes all previous added listeners from this element + * @return {Ext.core.Element} this + * @member Ext.core.Element + * @method clearListeners + */ + ep.clearListeners = ep.removeAllListeners; + + /** + * Removes this element's dom reference. Note that event and cache removal is handled at {@link Ext#removeNode Ext.removeNode}. + * Alias to {@link #remove}. + * @member Ext.core.Element + * @method destroy + */ + ep.destroy = ep.remove; + + /** + * true to automatically adjust width and height settings for box-model issues (default to true) + */ + ep.autoBoxAdjust = true; + + // private + var unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i, + docEl; + + /** + * Retrieves Ext.core.Element objects. + *This method does not retrieve {@link Ext.Component Component}s. This method + * retrieves Ext.core.Element objects which encapsulate DOM elements. To retrieve a Component by + * its ID, use {@link Ext.ComponentManager#get}.
+ *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 {Mixed} el The id of the node, a DOM Node or an existing Element. + * @return {Element} The Element object (or null if no matching element was found) + * @static + * @member Ext.core.Element + * @method get + */ + El.get = function(el) { + var ex, + elm, + id; + if (!el) { + return null; + } + if (typeof el == "string") { + // element id + if (! (elm = DOC.getElementById(el))) { + return null; + } + if (EC[el] && EC[el].el) { + ex = EC[el].el; + ex.dom = elm; + } else { + ex = El.addToCache(new El(elm)); + } + return ex; + } else if (el.tagName) { + // dom element + if (! (id = el.id)) { + id = Ext.id(el); + } + if (EC[id] && EC[id].el) { + ex = EC[id].el; + ex.dom = el; + } else { + ex = El.addToCache(new El(el)); + } + return ex; + } else if (el instanceof El) { + if (el != docEl) { + // refresh dom element in case no longer valid, + // catch case where it hasn't been appended + // If an el instance is passed, don't pass to getElementById without some kind of id + if (Ext.isIE && (el.id == undefined || el.id == '')) { + el.dom = el.dom; + } else { + el.dom = DOC.getElementById(el.id) || el.dom; + } + } + return el; + } else if (el.isComposite) { + return el; + } else if (Ext.isArray(el)) { + return El.select(el); + } else if (el == DOC) { + // create a bogus element object representing the document object + if (!docEl) { + var f = function() {}; + f.prototype = El.prototype; + docEl = new f(); + docEl.dom = DOC; + } + return docEl; + } + return null; + }; + + El.addToCache = function(el, id) { + if (el) { + id = id || el.id; + EC[id] = { + el: el, + data: {}, + events: {} + }; + } + return el; + }; + + // private method for getting and setting element data + El.data = function(el, key, value) { + el = El.get(el); + if (!el) { + return null; + } + var c = EC[el.id].data; + if (arguments.length == 2) { + return c[key]; + } else { + return (c[key] = value); + } + }; + + // 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(El.collectorThreadId); + } else { + var eid, + el, + d, + o; + + for (eid in EC) { + if (!EC.hasOwnProperty(eid)) { + continue; + } + o = EC[eid]; + if (o.skipGarbageCollection) { + continue; + } + el = o.el; + d = el.dom; + // ------------------------------------------------------- + // Determining what is garbage: + // ------------------------------------------------------- + // !d + // dom node is null, definitely 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 && !DOC.getElementById(eid))) { + if (d && Ext.enableListenerCollection) { + Ext.EventManager.removeAll(d); + } + delete EC[eid]; + } + } + // Cleanup IE Object leaks + if (Ext.isIE) { + var t = {}; + for (eid in EC) { + if (!EC.hasOwnProperty(eid)) { + continue; + } + t[eid] = EC[eid]; + } + EC = Ext.cache = t; + } + } + } + El.collectorThreadId = setInterval(garbageCollect, 30000); + + var flyFn = function() {}; + flyFn.prototype = El.prototype; + + // dom is optional + El.Flyweight = function(dom) { + this.dom = dom; + }; + + El.Flyweight.prototype = new flyFn(); + El.Flyweight.prototype.isFlyweight = true; + El._flyweights = {}; + + /** + *Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - + * the dom node can be overwritten by other code. Shorthand of {@link Ext.core.Element#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.core.Element class.
+ * @param {String/HTMLElement} el The dom node or id + * @param {String} named (optional) Allows for creation of named reusable flyweights to prevent conflicts + * (e.g. internally Ext uses "_global") + * @return {Element} The shared Element object (or null if no matching element was found) + * @member Ext.core.Element + * @method fly + */ + El.fly = function(el, named) { + var ret = null; + named = named || '_global'; + el = Ext.getDom(el); + if (el) { + (El._flyweights[named] = El._flyweights[named] || new El.Flyweight()).dom = el; + ret = El._flyweights[named]; + } + return ret; + }; + + /** + * Retrieves Ext.core.Element objects. + *This method does not retrieve {@link Ext.Component Component}s. This method + * retrieves Ext.core.Element objects which encapsulate DOM elements. To retrieve a Component by + * its ID, use {@link Ext.ComponentManager#get}.
+ *Uses simple caching to consistently return the same object. Automatically fixes if an + * object was recreated with the same id via AJAX or DOM.
+ * Shorthand of {@link Ext.core.Element#get} + * @param {Mixed} el The id of the node, a DOM Node or an existing Element. + * @return {Element} The Element object (or null if no matching element was found) + * @member Ext + * @method get + */ + Ext.get = El.get; + + /** + *Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - + * the dom node can be overwritten by other code. Shorthand of {@link Ext.core.Element#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.core.Element class.
+ * @param {String/HTMLElement} el The dom node or id + * @param {String} named (optional) Allows for creation of named reusable flyweights to prevent conflicts + * (e.g. internally Ext uses "_global") + * @return {Element} The shared Element object (or null if no matching element was found) + * @member Ext + * @method fly + */ + Ext.fly = El.fly; + + // speedy lookup for elements never to box adjust + var noBoxAdjust = Ext.isStrict ? { + select: 1 + }: { + input: 1, + select: 1, + textarea: 1 + }; + if (Ext.isIE || Ext.isGecko) { + noBoxAdjust['button'] = 1; + } +})(); + +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods({ + /** + * 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/Mixed} maxDepth (optional) The max depth to search as a number or element (defaults to 50 || document.body) + * @param {Boolean} returnEl (optional) True to return a Ext.core.Element object instead of DOM node + * @return {HTMLElement} The matching DOM node (or null if no match was found) + */ + findParent : function(simpleSelector, maxDepth, returnEl) { + var p = this.dom, + b = document.body, + depth = 0, + stopEl; + + maxDepth = maxDepth || 50; + if (isNaN(maxDepth)) { + stopEl = Ext.getDom(maxDepth); + maxDepth = Number.MAX_VALUE; + } + while (p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl) { + if (Ext.DomQuery.is(p, simpleSelector)) { + return returnEl ? Ext.get(p) : p; + } + depth++; + p = p.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/Mixed} 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.core.Element object instead of DOM node + * @return {HTMLElement} The matching DOM node (or null if no match was found) + */ + findParentNode : function(simpleSelector, maxDepth, returnEl) { + var p = Ext.fly(this.dom.parentNode, '_internal'); + return p ? p.findParent(simpleSelector, maxDepth, 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.core.Element. + * @param {String} selector The simple selector to test + * @param {Number/Mixed} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @return {Ext.core.Element} The matching DOM node (or null if no match was found) + */ + up : function(simpleSelector, maxDepth) { + return this.findParentNode(simpleSelector, maxDepth, true); + }, + + /** + * 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 + * @return {CompositeElement/CompositeElement} The composite element + */ + select : function(selector) { + return Ext.core.Element.select(selector, false, this.dom); + }, + + /** + * Selects child nodes based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @return {Array} 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 (optional) True to return the DOM node instead of Ext.core.Element (defaults to false) + * @return {HTMLElement/Ext.core.Element} The child Ext.core.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 (optional) True to return the DOM node instead of Ext.core.Element (defaults to false) + * @return {HTMLElement/Ext.core.Element} The child Ext.core.Element (or DOM node if returnDom = true) + */ + child : function(selector, returnDom) { + var node, + me = this, + id; + id = Ext.get(me).id; + // Escape . or : + id = id.replace(/[\.:]/g, "\\$0"); + 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 (optional) Find a parent node that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.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 (optional) Find the next sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.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 (optional) Find the previous sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.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 (optional) Find the next sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.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 (optional) Find the previous sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.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; + } +}); + +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods({ + /** + * Appends the passed element(s) to this element + * @param {String/HTMLElement/Array/Element/CompositeElement} el + * @return {Ext.core.Element} this + */ + appendChild : function(el) { + return Ext.get(el).appendTo(this); + }, + + /** + * Appends this element to the passed element + * @param {Mixed} el The new parent element + * @return {Ext.core.Element} this + */ + appendTo : function(el) { + Ext.getDom(el).appendChild(this.dom); + return this; + }, + + /** + * Inserts this element before the passed element in the DOM + * @param {Mixed} el The element before which this element will be inserted + * @return {Ext.core.Element} this + */ + 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 {Mixed} el The element to insert after + * @return {Ext.core.Element} this + */ + 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 {Mixed/Object} el The id or element to insert or a DomHelper config to create and insert + * @return {Ext.core.Element} 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 {Mixed/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 (optional) 'before' or 'after' defaults to before + * @param {Boolean} returnDom (optional) True to return the .;ll;l,raw DOM element instead of Ext.core.Element + * @return {Ext.core.Element} The inserted Element. If an array is passed, the last inserted element is returned. + */ + insertSibling: function(el, where, returnDom){ + var me = this, rt, + isAfter = (where || 'before').toLowerCase() == 'after', + insertEl; + + if(Ext.isArray(el)){ + insertEl = me; + Ext.each(el, function(e) { + rt = Ext.fly(insertEl, '_internal').insertSibling(e, where, returnDom); + if(isAfter){ + insertEl = rt; + } + }); + 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 = Ext.core.DomHelper.append(me.dom.parentNode, el, !returnDom); + } else { + rt = Ext.core.DomHelper[isAfter ? 'insertAfter' : 'insertBefore'](me.dom, el, !returnDom); + } + } + return rt; + }, + + /** + * Replaces the passed element with this element + * @param {Mixed} el The element to replace + * @return {Ext.core.Element} this + */ + replace : function(el) { + el = Ext.get(el); + this.insertBefore(el); + el.remove(); + return this; + }, + + /** + * Replaces this element with the passed element + * @param {Mixed/Object} el The new element or a DomHelper config of an element to create + * @return {Ext.core.Element} this + */ + replaceWith: function(el){ + var me = this; + + if(el.nodeType || el.dom || typeof el == 'string'){ + el = Ext.get(el); + me.dom.parentNode.insertBefore(el, 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.core.Element.addToCache(me.isFlyweight ? new Ext.core.Element(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 (optional) a child element of this element + * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element + * @return {Ext.core.Element} 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[!this.dom.firstChild ? 'insertFirst' : 'append'](this.dom, config, returnDom !== true); + } + }, + + /** + * Creates and wraps this element with another element + * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div + * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Ext.core.Element + * @return {HTMLElement/Element} The newly created wrapper element + */ + wrap : function(config, returnDom) { + var newEl = Ext.core.DomHelper.insertBefore(this.dom, config || {tag: "div"}, !returnDom), + d = newEl.dom || newEl; + + d.appendChild(this.dom); + return 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. + * @param {String} html The HTML fragment + * @param {Boolean} returnEl (optional) True to return an Ext.core.Element (defaults to false) + * @return {HTMLElement/Ext.core.Element} 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; + } +}); + +/** + * @class Ext.core.Element + */ +(function(){ + Ext.core.Element.boxMarkup = ''; + // local style camelizing for speed + var supports = Ext.supports, + view = document.defaultView, + opacityRe = /alpha\(opacity=(.*)\)/i, + trimRe = /^\s+|\s+$/g, + spacesRe = /\s+/, + wordsRe = /\w/g, + adjustDirect2DTableRe = /table-row|table-.*-group/, + INTERNAL = '_internal', + PADDING = 'padding', + MARGIN = 'margin', + BORDER = 'border', + LEFT = '-left', + RIGHT = '-right', + TOP = '-top', + BOTTOM = '-bottom', + WIDTH = '-width', + MATH = Math, + HIDDEN = 'hidden', + ISCLIPPED = 'isClipped', + OVERFLOW = 'overflow', + OVERFLOWX = 'overflow-x', + OVERFLOWY = 'overflow-y', + ORIGINALCLIP = 'originalClip', + // special markup used throughout Ext when box wrapping elements + 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}, + data = Ext.core.Element.data; + + Ext.override(Ext.core.Element, { + + /** + * 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; + }, + + + /** + * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. + * @param {String/Array} className The CSS classes to add separated by space, or an array of classes + * @return {Ext.core.Element} this + */ + addCls : function(className){ + var me = this, + cls = [], + space = ((me.dom.className.replace(trimRe, '') == '') ? "" : " "), + i, len, v; + if (className === undefined) { + return me; + } + // Separate case is for speed + if (Object.prototype.toString.call(className) !== '[object Array]') { + if (typeof className === 'string') { + className = className.replace(trimRe, '').split(spacesRe); + if (className.length === 1) { + className = className[0]; + if (!me.hasCls(className)) { + me.dom.className += space + className; + } + } else { + this.addCls(className); + } + } + } else { + for (i = 0, len = className.length; i < len; i++) { + v = className[i]; + if (typeof v == 'string' && (' ' + me.dom.className + ' ').indexOf(' ' + v + ' ') == -1) { + cls.push(v); + } + } + if (cls.length) { + me.dom.className += space + cls.join(" "); + } + } + return me; + }, + + /** + * Removes one or more CSS classes from the element. + * @param {String/Array} className The CSS classes to remove separated by space, or an array of classes + * @return {Ext.core.Element} this + */ + removeCls : function(className){ + var me = this, + i, idx, len, cls, elClasses; + if (className === undefined) { + return me; + } + if (Object.prototype.toString.call(className) !== '[object Array]') { + className = className.replace(trimRe, '').split(spacesRe); + } + if (me.dom && me.dom.className) { + elClasses = me.dom.className.replace(trimRe, '').split(spacesRe); + for (i = 0, len = className.length; i < len; i++) { + cls = className[i]; + if (typeof cls == 'string') { + cls = cls.replace(trimRe, ''); + idx = Ext.Array.indexOf(elClasses, cls); + if (idx != -1) { + Ext.Array.erase(elClasses, idx, 1); + } + } + } + me.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/Array} className The CSS class to add, or an array of classes + * @return {Ext.core.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) { + Ext.fly(v, '_internal').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.core.Element} this + * @method + */ + toggleCls : Ext.supports.ClassList ? + function(className) { + this.dom.classList.toggle(Ext.String.trim(className)); + return this; + } : + function(className) { + return this.hasCls(className) ? this.removeCls(className) : this.addCls(className); + }, + + /** + * 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 : Ext.supports.ClassList ? + function(className) { + if (!className) { + return false; + } + className = className.split(spacesRe); + var ln = className.length, + i = 0; + for (; i < ln; i++) { + if (className[i] && this.dom.classList.contains(className[i])) { + return true; + } + } + return false; + } : + function(className){ + return className && (' ' + this.dom.className + ' ').indexOf(' ' + className + ' ') != -1; + }, + + /** + * 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.core.Element} this + */ + replaceCls : function(oldClassName, newClassName){ + return this.removeCls(oldClassName).addCls(newClassName); + }, + + isStyle : function(style, val) { + return this.getStyle(style) == val; + }, + + /** + * Normalizes currentStyle and computedStyle. + * @param {String} property The style property whose value is returned. + * @return {String} The current value of the style property for this element. + * @method + */ + getStyle : function(){ + return view && view.getComputedStyle ? + function(prop){ + var el = this.dom, + v, cs, out, display, cleaner; + + if(el == document){ + return null; + } + prop = Ext.core.Element.normalize(prop); + out = (v = el.style[prop]) ? v : + (cs = view.getComputedStyle(el, "")) ? cs[prop] : null; + + // Ignore cases when the margin is correctly reported as 0, the bug only shows + // numbers larger. + if(prop == 'marginRight' && out != '0px' && !supports.RightMargin){ + cleaner = Ext.core.Element.getRightMarginFixCleaner(el); + display = this.getStyle('display'); + el.style.display = 'inline-block'; + out = view.getComputedStyle(el, '').marginRight; + el.style.display = display; + cleaner(); + } + + if(prop == 'backgroundColor' && out == 'rgba(0, 0, 0, 0)' && !supports.TransparentColor){ + out = 'transparent'; + } + return out; + } : + function(prop){ + var el = this.dom, + m, cs; + + if (el == document) { + return null; + } + + if (prop == 'opacity') { + if (el.style.filter.match) { + m = el.style.filter.match(opacityRe); + if(m){ + var fv = parseFloat(m[1]); + if(!isNaN(fv)){ + return fv ? fv / 100 : 0; + } + } + } + return 1; + } + prop = Ext.core.Element.normalize(prop); + return el.style[prop] || ((cs = el.currentStyle) ? cs[prop] : null); + }; + }(), + + /** + * 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 (optional) 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; + + if(!v || (/transparent|inherit/.test(v))) { + return defaultValue; + } + if(/^r/.test(v)){ + Ext.each(v.slice(4, v.length -1).split(','), function(s){ + h = parseInt(s, 10); + color += (h < 16 ? '0' : '') + h.toString(16); + }); + }else{ + v = v.replace('#', ''); + color += v.length == 3 ? v.replace(/^(\w)(\w)(\w)$/, '$1$1$2$2$3$3') : v; + } + return(color.length > 5 ? color.toLowerCase() : defaultValue); + }, + + /** + * 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 (optional) The value to apply to the given property, or null if an object was passed. + * @return {Ext.core.Element} this + */ + setStyle : function(prop, value){ + var me = this, + tmp, style; + + if (!me.dom) { + return me; + } + if (typeof prop === 'string') { + tmp = {}; + tmp[prop] = value; + prop = tmp; + } + for (style in prop) { + if (prop.hasOwnProperty(style)) { + value = Ext.value(prop[style], ''); + if (style == 'opacity') { + me.setOpacity(value); + } + else { + me.dom.style[Ext.core.Element.normalize(style)] = value; + } + } + } + return me; + }, + + /** + * Set the opacity of the element + * @param {Float} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc + * @param {Boolean/Object} animate (optional) a standard Element animation config object or true for + * the default animation ({duration: .35, easing: 'easeIn'}) + * @return {Ext.core.Element} this + */ + setOpacity: function(opacity, animate) { + var me = this, + dom = me.dom, + val, + style; + + if (!me.dom) { + return me; + } + + style = me.dom.style; + + if (!animate || !me.anim) { + if (!Ext.supports.Opacity) { + opacity = opacity < 1 ? 'alpha(opacity=' + opacity * 100 + ')': ''; + val = style.filter.replace(opacityRe, '').replace(trimRe, ''); + + style.zoom = 1; + style.filter = val + (val.length > 0 ? ' ': '') + opacity; + } + else { + style.opacity = opacity; + } + } + else { + if (!Ext.isObject(animate)) { + 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.core.Element} this + */ + clearOpacity : function(){ + var style = this.dom.style; + if(!Ext.supports.Opacity){ + if(!Ext.isEmpty(style.filter)){ + style.filter = style.filter.replace(opacityRe, '').replace(trimRe, ''); + } + }else{ + style.opacity = style['-moz-opacity'] = style['-khtml-opacity'] = ''; + } + return this; + }, + + /** + * @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, + 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 + floating = (parseFloat(me.getStyle(dimension)) || parseFloat(dom.currentStyle.msTransformOrigin.split(' ')[originIndex]) * 2) % 1; + + dom.style['position'] = inlinePosition; + + if (display === 'inline') { + dom.style['display'] = inlineDisplay; + } + + return floating; + }, + + /** + * Returns the offset height of the element + * @param {Boolean} contentHeight (optional) true to get the height minus borders and padding + * @return {Number} The element's height + */ + getHeight: function(contentHeight, preciseHeight) { + var me = this, + dom = me.dom, + hidden = Ext.isIE && me.isStyle('display', 'none'), + height, overflow, style, floating; + + // IE Quirks mode acts more like a max-size measurement unless overflow is hidden during measurement. + // We will put the overflow back to it's original value when we are done measuring. + if (Ext.isIEQuirks) { + style = dom.style; + overflow = style.overflow; + me.setStyle({ overflow: 'hidden'}); + } + + height = dom.offsetHeight; + + height = MATH.max(height, hidden ? 0 : dom.clientHeight) || 0; + + // IE9 Direct2D dimension rounding bug + if (!hidden && 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")); + } + + if (Ext.isIEQuirks) { + me.setStyle({ overflow: overflow}); + } + + if (height < 0) { + height = 0; + } + return height; + }, + + /** + * Returns the offset width of the element + * @param {Boolean} contentWidth (optional) true to get the width minus borders and padding + * @return {Number} The element's width + */ + getWidth: function(contentWidth, preciseWidth) { + var me = this, + dom = me.dom, + hidden = Ext.isIE && me.isStyle('display', 'none'), + rect, width, overflow, style, floating, parentPosition; + + // IE Quirks mode acts more like a max-size measurement unless overflow is hidden during measurement. + // We will put the overflow back to it's original value when we are done measuring. + if (Ext.isIEQuirks) { + style = dom.style; + overflow = style.overflow; + me.setStyle({overflow: 'hidden'}); + } + + // Fix Opera 10.5x width calculation issues + if (Ext.isOpera10_5) { + if (dom.parentNode.currentStyle.position === 'relative') { + parentPosition = dom.parentNode.style.position; + dom.parentNode.style.position = 'static'; + width = dom.offsetWidth; + dom.parentNode.style.position = parentPosition; + } + width = Math.max(width || 0, dom.offsetWidth); + + // 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 + } else if (Ext.supports.BoundingClientRect) { + rect = dom.getBoundingClientRect(); + width = rect.right - rect.left; + width = preciseWidth ? width : Math.ceil(width); + } else { + width = dom.offsetWidth; + } + + width = MATH.max(width, hidden ? 0 : dom.clientWidth) || 0; + + // IE9 Direct2D dimension rounding bug + if (!hidden && Ext.supports.Direct2DBug) { + floating = me.adjustDirect2DDimension('width'); + if (preciseWidth) { + width += floating; + } + else if (floating > 0 && floating < 0.5) { + width++; + } + } + + if (contentWidth) { + width -= (me.getBorderWidth("lr") + me.getPadding("lr")); + } + + if (Ext.isIEQuirks) { + me.setStyle({ overflow: overflow}); + } + + if (width < 0) { + width = 0; + } + return width; + }, + + /** + * Set the width of this Element. + * @param {Mixed} width The new width. This may be one of:+ * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + 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; + }, + + /** + * Set the height of this Element. + *+ *
- 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 {Mixed} height The new height. This may be one of:+// 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 : .5, // animation will have a duration of .5 seconds + // will change the content to "finished" + callback: function(){ this.{@link #update}("finished"); } +}); + *
+ * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + 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; + }, + + /** + * 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 left width + the border right 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 left + the padding right. + * @return {Number} The padding of the sides passed added together + */ + getPadding : function(side){ + return this.addStyles(side, paddings); + }, + + /** + * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove + * @return {Ext.core.Element} this + */ + clip : function(){ + var me = this, + dom = me.dom; + + if(!data(dom, ISCLIPPED)){ + data(dom, ISCLIPPED, true); + data(dom, ORIGINALCLIP, { + o: me.getStyle(OVERFLOW), + x: me.getStyle(OVERFLOWX), + y: me.getStyle(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.core.Element} this + */ + unclip : function(){ + var me = this, + dom = me.dom, + clip; + + if(data(dom, ISCLIPPED)){ + data(dom, ISCLIPPED, false); + clip = data(dom, ORIGINALCLIP); + if(o.o){ + me.setStyle(OVERFLOW, o.o); + } + if(o.x){ + me.setStyle(OVERFLOWX, o.x); + } + if(o.y){ + me.setStyle(OVERFLOWY, o.y); + } + } + return me; + }, + + // private + addStyles : function(sides, styles){ + var totalSize = 0, + sidesArr = sides.match(wordsRe), + i = 0, + len = sidesArr.length, + side, size; + for (; i < len; i++) { + side = sidesArr[i]; + size = side && parseInt(this.getStyle(styles[side]), 10); + if (size) { + totalSize += MATH.abs(size); + } + } + return totalSize; + }, + + 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.core.Element} this + */ + applyStyles : function(style){ + Ext.core.DomHelper.applyStyles(this.dom, style); + return this; + }, + + /** + * Returns an object with properties matching the styles requested. + * For example, el.getStyles('color', 'font-size', 'width') might return + * {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}. + * @param {String} style1 A style name + * @param {String} style2 A style name + * @param {String} etc. + * @return {Object} The style object + */ + getStyles : function(){ + var styles = {}, + len = arguments.length, + i = 0, style; + + for(; i < len; ++i) { + style = arguments[i]; + styles[style] = this.getStyle(style); + } + return styles; + }, + + /** + *+ *
- 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.
+ *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.core.Element.boxMarkup = + '<div class="{0}-tl"><div class="{0}-tr"><div class="{0}-tc"></div></div></div> + <div class="{0}-ml"><div class="{0}-mr"><div class="{0}-mc"></div></div></div> + <div class="{0}-bl"><div class="{0}-br"><div class="{0}-bc"></div></div></div>'; + *
Example usage:
+ *+ * @param {String} class (optional) A base CSS class to apply to the containing wrapper element + * (defaults to 'x-box'). 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.core.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", "+ // 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"); + *
" + Ext.String.format(Ext.core.Element.boxMarkup, cls) + "")); + Ext.DomQuery.selectNode('.' + cls + '-mc', el.dom).appendChild(this.dom); + return el; + }, + + /** + * Set the size of this Element. If animation is true, both width and height will be animated concurrently. + * @param {Mixed} width The new width. This may be one of:+ * @param {Mixed} height The new height. 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 {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} 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; + }, + + /** + * 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 + * @return {Ext.core.Element} this + */ + addClsOnOver : function(className){ + var dom = this.dom; + this.hover( + function(){ + Ext.fly(dom, INTERNAL).addCls(className); + }, + function(){ + Ext.fly(dom, INTERNAL).removeCls(className); + } + ); + return this; + }, + + /** + * Sets up event handlers to add and remove a css class when this element has the focus + * @param {String} className + * @return {Ext.core.Element} this + */ + addClsOnFocus : function(className){ + var me = this, + dom = me.dom; + me.on("focus", function(){ + 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 + * @return {Ext.core.Element} this + */ + addClsOnClick : function(className){ + var dom = this.dom; + this.on("mousedown", function(){ + 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 this; + }, + + /** + *+ *
- 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.
+ *Returns the dimensions of the element available to lay content out in.
+ *
If the element (or any ancestor element) has CSS style
+ * example:display : none
, the dimensions will be zero.+ * + * 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. + */ + + getViewSize : function(){ + var me = this, + dom = me.dom, + isDoc = (dom == Ext.getDoc().dom || dom == Ext.getBody().dom), + style, overflow, ret; + + // If the body, use static methods + if (isDoc) { + ret = { + width : Ext.core.Element.getViewWidth(), + height : Ext.core.Element.getViewHeight() + }; + + // Else use clientHeight/clientWidth + } + else { + // IE 6 & IE Quirks mode acts more like a max-size measurement unless overflow is hidden during measurement. + // We will put the overflow back to it's original value when we are done measuring. + if (Ext.isIE6 || Ext.isIEQuirks) { + style = dom.style; + overflow = style.overflow; + me.setStyle({ overflow: 'hidden'}); + } + ret = { + width : dom.clientWidth, + height : dom.clientHeight + }; + if (Ext.isIE6 || Ext.isIEQuirks) { + me.setStyle({ overflow: overflow }); + } + } + return ret; + }, + + /** + *+ 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. + *
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. + */ + + getStyleSize : function(){ + var me = this, + doc = document, + d = this.dom, + isDoc = (d == doc || d == doc.body), + s = d.style, + w, h; + + // If the body, use static methods + if (isDoc) { + return { + width : Ext.core.Element.getViewWidth(), + height : Ext.core.Element.getViewHeight() + }; + } + // 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)}; + }, + + /** + * Returns the size of the element. + * @param {Boolean} contentSize (optional) true to get the width/size minus borders and padding + * @return {Object} An object containing the element's size {width: (element width), height: (element height)} + */ + getSize : function(contentSize){ + return {width: this.getWidth(contentSize), height: this.getHeight(contentSize)}; + }, + + /** + * Forces the browser to repaint this element + * @return {Ext.core.Element} this + */ + repaint : function(){ + var dom = this.dom; + this.addCls(Ext.baseCSSPrefix + 'repaint'); + setTimeout(function(){ + Ext.fly(dom).removeCls(Ext.baseCSSPrefix + 'repaint'); + }, 1); + return this; + }, + + /** + * Disables text selection for this element (normalized across browsers) + * @return {Ext.core.Element} this + */ + unselectable : function(){ + var me = this; + me.dom.unselectable = "on"; + + me.swallowEvent("selectstart", true); + me.applyStyles("-moz-user-select:none;-khtml-user-select:none;"); + me.addCls(Ext.baseCSSPrefix + 'unselectable'); + + return me; + }, + + /** + * 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 (optional) 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"}, + o = {}, + key; + + if (!side) { + for (key in me.margins){ + o[hash[key]] = parseFloat(me.getStyle(me.margins[key])) || 0; + } + return o; + } else { + return me.addStyles.call(me, side, me.margins); + } + } + }); +})(); +/** + * @class Ext.core.Element + */ +/** + * Visibility mode constant for use with {@link #setVisibilityMode}. Use visibility to hide element + * @static + * @type Number + */ +Ext.core.Element.VISIBILITY = 1; +/** + * Visibility mode constant for use with {@link #setVisibilityMode}. Use display to hide element + * @static + * @type Number + */ +Ext.core.Element.DISPLAY = 2; + +/** + * Visibility mode constant for use with {@link #setVisibilityMode}. Use offsets (x and y positioning offscreen) + * to hide element. + * @static + * @type Number + */ +Ext.core.Element.OFFSETS = 3; + + +Ext.core.Element.ASCLASS = 4; + +/** + * Defaults to 'x-hide-nosize' + * @static + * @type String + */ +Ext.core.Element.visibilityCls = Ext.baseCSSPrefix + 'hide-nosize'; + +Ext.core.Element.addMethods(function(){ + var El = Ext.core.Element, + OPACITY = "opacity", + VISIBILITY = "visibility", + DISPLAY = "display", + HIDDEN = "hidden", + OFFSETS = "offsets", + ASCLASS = "asclass", + NONE = "none", + NOSIZE = 'nosize', + ORIGINALDISPLAY = 'originalDisplay', + VISMODE = 'visibilityMode', + ISVISIBLE = 'isVisible', + data = El.data, + getDisplay = function(dom){ + var d = data(dom, ORIGINALDISPLAY); + if(d === undefined){ + data(dom, ORIGINALDISPLAY, d = ''); + } + return d; + }, + getVisMode = function(dom){ + var m = data(dom, VISMODE); + if(m === undefined){ + data(dom, VISMODE, m = 1); + } + return m; + }; + + return { + /** + * The element's default display mode (defaults to "") + * @type String + */ + originalDisplay : "", + visibilityMode : 1, + + /** + * Sets the element's visibility mode. When setVisible() is called it + * will use this to determine whether to set the visibility or the display property. + * @param {Number} visMode Ext.core.Element.VISIBILITY or Ext.core.Element.DISPLAY + * @return {Ext.core.Element} this + */ + setVisibilityMode : function(visMode){ + data(this.dom, VISMODE, visMode); + return this; + }, + + /** + * Checks whether the element is currently visible using both visibility and display properties. + * @return {Boolean} True if the element is currently visible, else false + */ + isVisible : function() { + var me = this, + dom = me.dom, + visible = data(dom, ISVISIBLE); + + if(typeof visible == 'boolean'){ //return the cached value if registered + return visible; + } + //Determine the current state based on display states + visible = !me.isStyle(VISIBILITY, HIDDEN) && + !me.isStyle(DISPLAY, NONE) && + !((getVisMode(dom) == El.ASCLASS) && me.hasCls(me.visibilityCls || El.visibilityCls)); + + data(dom, ISVISIBLE, visible); + return visible; + }, + + /** + * 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.core.Element} this + */ + setVisible : function(visible, animate){ + var me = this, isDisplay, isVisibility, isOffsets, isNosize, + dom = me.dom, + visMode = getVisMode(dom); + + + // hideMode string override + if (typeof animate == 'string'){ + switch (animate) { + case DISPLAY: + visMode = El.DISPLAY; + break; + case VISIBILITY: + visMode = El.VISIBILITY; + break; + case OFFSETS: + visMode = El.OFFSETS; + break; + case NOSIZE: + case ASCLASS: + visMode = El.ASCLASS; + break; + } + me.setVisibilityMode(visMode); + animate = false; + } + + if (!animate || !me.anim) { + if(visMode == El.ASCLASS ){ + + me[visible?'removeCls':'addCls'](me.visibilityCls || El.visibilityCls); + + } else if (visMode == El.DISPLAY){ + + return me.setDisplayed(visible); + + } else if (visMode == El.OFFSETS){ + + if (!visible){ + // Remember position for restoring, if we are not already hidden by offsets. + if (!me.hideModeStyles) { + me.hideModeStyles = { + position: me.getStyle('position'), + top: me.getStyle('top'), + left: me.getStyle('left') + }; + } + me.applyStyles({position: 'absolute', top: '-10000px', left: '-10000px'}); + } + + // Only "restore" as position if we have actually been hidden using offsets. + // Calling setVisible(true) on a positioned element should not reposition it. + else if (me.hideModeStyles) { + me.applyStyles(me.hideModeStyles || {position: '', top: '', left: ''}); + delete me.hideModeStyles; + } + + }else{ + me.fixDisplay(); + // Show by clearing visibility style. Explicitly setting to "visible" overrides parent visibility setting. + dom.style.visibility = visible ? '' : HIDDEN; + } + }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() { + visible || me.setVisible(false).setOpacity(1); + }, + to: { + opacity: (visible) ? 1 : 0 + } + }, animate)); + } + data(dom, ISVISIBLE, visible); //set logical visibility state + return me; + }, + + + /** + * @private + * Determine if the Element has a relevant height and width available based + * upon current logical visibility state + */ + hasMetrics : function(){ + var dom = this.dom; + return this.isVisible() || (getVisMode(dom) == El.OFFSETS) || (getVisMode(dom) == El.VISIBILITY); + }, + + /** + * Toggles the element's visibility or display, depending on visibility mode. + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Ext.core.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 {Mixed} value Boolean value to display the element using its default display, or a string to set the display directly. + * @return {Ext.core.Element} this + */ + setDisplayed : function(value) { + if(typeof value == "boolean"){ + value = value ? getDisplay(this.dom) : 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(this.dom)); // 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 (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.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 (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.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; + } + }; +}()); +/** + * @class Ext.core.Element + */ +Ext.applyIf(Ext.core.Element.prototype, { + // @private override base Ext.util.Animate mixin for animate for backwards compatibility + animate: function(config) { + var me = this; + if (!me.id) { + me = Ext.get(me.dom); + } + if (Ext.fx.Manager.hasFxBlock(me.id)) { + return me; + } + Ext.fx.Manager.queueFx(Ext.create('Ext.fx.Anim', me.anim(config))); + return this; + }, + + // @private override base Ext.util.Animate mixin for animate for backwards compatibility + 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 = { + target: me, + 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 Fx class overview for valid anchor point options. + * Usage: + *
+ * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to top: 't') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Ext.core.Element} The Element + */ + slideIn: function(anchor, obj, slideOut) { + var me = this, + elStyle = me.dom.style, + beforeAnim, wrapAnim; + + anchor = anchor || "t"; + obj = obj || {}; + + beforeAnim = function() { + var animScope = this, + listeners = obj.listeners, + box, position, restoreSize, wrap, anim; + + if (!slideOut) { + me.fixDisplay(); + } + + box = me.getBox(); + if ((anchor == 't' || anchor == 'b') && box.height == 0) { + box.height = me.dom.scrollHeight; + } + else if ((anchor == 'l' || anchor == 'r') && box.width == 0) { + box.width = me.dom.scrollWidth; + } + + position = me.getPositioning(); + me.setSize(box.width, box.height); + + wrap = me.wrap({ + style: { + visibility: slideOut ? 'visible' : 'hidden' + } + }); + wrap.setPositioning(position); + if (wrap.isStyle('position', 'static')) { + wrap.position('relative'); + } + me.clearPositioning('auto'); + wrap.clip(); + + // 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. + me.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' + } + }; + elStyle.right = '0px'; + 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' + } + }; + 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'; + elStyle.right = '0px'; + break; + case 'bl': + anim = { + from: { + x: box.x + box.width, + width: '0px', + height: '0px' + }, + to: { + x: box.x, + width: box.width + 'px', + height: box.height + 'px' + } + }; + elStyle.right = '0px'; + 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' + } + }; + break; + case 'tr': + anim = { + from: { + y: box.y + box.height, + width: '0px', + height: '0px' + }, + to: { + y: box.y, + width: box.width + 'px', + height: box.height + 'px' + } + }; + elStyle.bottom = '0px'; + break; + } + + wrap.show(); + wrapAnim = Ext.apply({}, obj); + delete wrapAnim.listeners; + wrapAnim = Ext.create('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() { + if (slideOut) { + me.setPositioning(position); + if (obj.useDisplay) { + me.setDisplayed(false); + } else { + me.hide(); + } + } + else { + me.clearPositioning(); + me.setPositioning(position); + } + if (wrap.dom) { + wrap.dom.parentNode.insertBefore(me.dom, wrap.dom); + wrap.remove(); + } + me.setSize(box.width, box.height); + animScope.end(); + }); + // Add configured listeners after + if (listeners) { + wrapAnim.on(listeners); + } + }; + + me.animate({ + duration: obj.duration ? obj.duration * 2 : 1000, + listeners: { + beforeanimate: { + fn: beforeAnim + }, + afteranimate: { + fn: function() { + if (wrapAnim && wrapAnim.running) { + wrapAnim.end(); + } + } + } + } + }); + 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 Fx 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: 2 }); + +// common config options shown with default values +el.slideIn('t', { + easing: 'easeOut', + duration: 500 +}); +
+ * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to top: 't') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Ext.core.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: 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: 2 }); + +// common config options shown with default values +el.slideOut('t', { + easing: 'easeOut', + duration: 500, + remove: false, + useDisplay: false +}); +
+ * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Ext.core.Element} The Element + */ + + puff: function(obj) { + var me = this, + beforeAnim; + obj = Ext.applyIf(obj || {}, { + easing: 'ease-out', + duration: 500, + useDisplay: false + }); + + beforeAnim = function() { + me.clearOpacity(); + me.show(); + + var box = me.getBox(), + fontSize = me.getStyle('fontSize'), + position = me.getPositioning(); + 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() { + if (me.dom) { + if (obj.useDisplay) { + me.setDisplayed(false); + } else { + me.hide(); + } + me.clearOpacity(); + me.setPositioning(position); + me.setStyle({fontSize: fontSize}); + } + }); + }; + + 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.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 Fx config options + * @return {Ext.core.Element} The Element + */ + switchOff: function(obj) { + var me = this, + beforeAnim; + + obj = Ext.applyIf(obj || {}, { + easing: 'ease-in', + duration: 500, + remove: false, + useDisplay: false + }); + + beforeAnim = function() { + var animScope = this, + size = me.getSize(), + xy = me.getXY(), + keyframe, position; + me.clearOpacity(); + me.clip(); + position = me.getPositioning(); + + keyframe = Ext.create('Ext.fx.Animator', { + target: me, + 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() { + if (obj.useDisplay) { + me.setDisplayed(false); + } else { + me.hide(); + } + me.clearOpacity(); + me.setPositioning(position); + me.setSize(size); + animScope.end(); + }); + }; + me.animate({ + duration: (obj.duration * 2), + listeners: { + beforeanimate: { + fn: beforeAnim + } + } + }); + return me; + }, + + /** + * Shows a ripple of exploding, attenuating borders to draw attention to an Element. + * Usage: ++// default +el.switchOff(); + +// all config options shown with default values +el.switchOff({ + easing: 'easeIn', + duration: .3, + remove: false, + useDisplay: false +}); +
+ * @param {String} color (optional) The color of the border. Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9'). + * @param {Number} count (optional) The number of ripples to display (defaults to 1) + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Ext.core.Element} The Element + */ + frame : function(color, count, obj){ + var me = this, + beforeAnim; + + color = color || '#C3DAF9'; + count = count || 1; + obj = obj || {}; + + beforeAnim = function() { + me.show(); + var animScope = this, + box = me.getBox(), + proxy = Ext.getBody().createChild({ + style: { + position : 'absolute', + 'pointer-events': 'none', + 'z-index': 35000, + border : '0px solid ' + color + } + }), + proxyAnim; + proxyAnim = Ext.create('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(); + animScope.end(); + }); + }; + + me.animate({ + duration: (obj.duration * 2) || 2000, + listeners: { + beforeanimate: { + fn: beforeAnim + } + } + }); + 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: a single light blue ripple +el.frame(); + +// custom: 3 red ripples lasting 3 seconds total +el.frame("#ff0000", 3, { duration: 3 }); + +// common config options shown with default values +el.frame("#C3DAF9", 1, { + duration: 1 //duration of each individual ripple. + // Note: Easing is not configurable and will be ignored if included +}); +
+ * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to bottom: 'b') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Ext.core.Element} The Element + */ + ghost: function(anchor, obj) { + var me = this, + beforeAnim; + + anchor = anchor || "b"; + beforeAnim = function() { + var width = me.getWidth(), + height = me.getHeight(), + xy = me.getXY(), + position = me.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 () { + if (me.dom) { + me.hide(); + me.clearOpacity(); + me.setPositioning(position); + } + }); + }; + + me.animate(Ext.applyIf(obj || {}, { + duration: 500, + easing: 'ease-out', + listeners: { + beforeanimate: { + fn: 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: 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: 2 }); + +// common config options shown with default values +el.ghost('b', { + easing: 'easeOut', + duration: 500 +}); +
+ * @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 Fx config options + * @return {Ext.core.Element} The Element + */ + highlight: function(color, o) { + var me = this, + dom = me.dom, + from = {}, + restore, to, attr, lns, event, fn; + + 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]; + me.clearOpacity(); + me.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; + }, + + /** + * @deprecated 4.0 + * Creates a pause before any subsequent queued effects begin. If there are + * no effects queued after the pause it will have no effect. + * Usage: ++// default: highlight background to yellow +el.highlight(); + +// custom: highlight foreground text to blue for 2 seconds +el.highlight("0000ff", { attr: 'color', duration: 2 }); + +// 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 {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 {@link #endOpacity} config option. + * Usage: ++el.pause(1); +
+ * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Ext.Element} The Element + */ + fadeIn: function(o) { + this.animate(Ext.apply({}, o, { + opacity: 1 + })); + return this; + }, + + /** + * Fade an element out (from opaque to transparent). The ending opacity can be specified + * using the {@link #endOpacity} config option. Note that IE may require + * {@link #useDisplay}:true in order to redisplay correctly. + * Usage: ++// default: fade in from opacity 0 to 100% +el.fadeIn(); + +// custom: fade in from opacity 0 to 75% over 2 seconds +el.fadeIn({ endOpacity: .75, duration: 2}); + +// common config options shown with default values +el.fadeIn({ + endOpacity: 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 Fx config options + * @return {Ext.Element} The Element + */ + fadeOut: function(o) { + this.animate(Ext.apply({}, o, { + opacity: 0 + })); + return this; + }, + + /** + * @deprecated 4.0 + * 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: ++// 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({ endOpacity: .25, duration: 2}); + +// common config options shown with default values +el.fadeOut({ + endOpacity: 0, //can be any value between 0 and 1 (e.g. .5) + easing: 'easeOut', + duration: 500, + remove: false, + useDisplay: false +}); +
+ * @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 Fx config options + * @return {Ext.Element} The Element + */ + scale: function(w, h, o) { + this.animate(Ext.apply({}, o, { + width: w, + height: h + })); + return this; + }, + + /** + * @deprecated 4.0 + * 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: ++// 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: .35 + } +); +
+ * @param {Object} options Object literal with any of the Fx config options + * @return {Ext.Element} The Element + */ + shift: function(config) { + this.animate(config); + return this; + } +}); + +/** + * @class Ext.core.Element + */ +Ext.applyIf(Ext.core.Element, { + unitRe: /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i, + camelRe: /(-[a-z])/gi, + opacityRe: /alpha\(opacity=(.*)\)/i, + cssRe: /([a-z0-9-]+)\s*:\s*([^;\s]+(?:\s*[^;\s]+)*);?/gi, + 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'}, + + // Reference the prototype's version of the method. Signatures are identical. + addUnits : Ext.core.Element.prototype.addUnits, + + /** + * 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) { + if (Ext.isObject(box)) { + return { + top: box.top || 0, + right: box.right || 0, + bottom: box.bottom || 0, + left: box.left || 0 + }; + } else { + if (typeof box != 'string') { + box = box.toString(); + } + 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 :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} box The encoded margins + * @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: + *+// 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: .35 +}); +
+ *
+ * @static + * @param {String} prop The property to normalize + * @return {String} The normalized string + */ + normalize : function(prop) { + if (prop == 'float') { + prop = Ext.supports.Float ? 'cssFloat' : 'styleFloat'; + } + return this.propertyCache[prop] || (this.propertyCache[prop] = prop.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} x 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. + *- border-width -> borderWidth
+ *- padding-top -> paddingTop
+ *+ * The sample code below would return an object with 2 properties, one + * for background-color and one for color.
+ *+ * @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; + } +}); + +/** + * @class Ext.CompositeElementLite + *+var css = 'background-color: red;color: blue; '; +console.log(Ext.core.Element.parseStyles(css)); + *
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.core.Element} and + * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection.
+ * Example:+ */ +Ext.CompositeElementLite = function(els, root){ + /** + *+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); +
The Array of DOM elements which this CompositeElement encapsulates. Read-only.
+ *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+ * @type Array + * @property elements + */ + this.elements = []; + this.add(els, root); + this.el = new Ext.core.Element.Flyweight(); +}; + +Ext.CompositeElementLite.prototype = { + isComposite: true, + + // private + getElement : function(el){ + // Set the shared flyweight dom property to the current element + var e = this.el; + e.dom = el; + e.id = el.id; + return e; + }, + + // 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 {Mixed} els Either an Array of DOM elements to add, or another Composite object who's elements should be added. + * @return {CompositeElement} This Composite object. + */ + add : function(els, root){ + var me = this, + elements = me.elements; + if(!els){ + return this; + } + if(typeof els == "string"){ + els = Ext.core.Element.selectorFunction(els, root); + }else if(els.isComposite){ + els = els.elements; + }else if(!Ext.isIterable(els)){ + els = [els]; + } + + for(var i = 0, len = els.length; i < len; ++i){ + elements.push(me.transformElement(els[i])); + } + return me; + }, + + invoke : function(fn, args){ + var me = this, + els = me.elements, + len = els.length, + e, + i; + + for(i = 0; i < len; i++) { + e = els[i]; + if(e){ + Ext.core.Element.prototype[fn].apply(me.getElement(e), args); + } + } + return me; + }, + /** + * Returns a flyweight Element of the dom element object at the specified index + * @param {Number} index + * @return {Ext.core.Element} + */ + item : function(index){ + var me = this, + el = me.elements[index], + out = null; + + if(el){ + out = me.getElement(el); + } + return out; + }, + + // fixes scope with flyweight + addListener : function(eventName, handler, scope, opt){ + var els = this.elements, + len = els.length, + i, e; + + for(i = 0; i
+Ext.override(Ext.CompositeElementLite, { + nextAll: function() { + var els = this.elements, i, l = els.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 = els[i].nextSibling; n; n = n.nextSibling) { + r[++ri] = n; + } + } + +// Add all found siblings to this Composite + return this.add(r); + } +});Calls the passed function for each element in this composite. + * @param {Function} fn The function to call. The function is passed the following parameters: + *
+ * @param {Object} scope (optional) The scope (this reference) in which the function is executed. (defaults to the Element) + * @return {CompositeElement} this + */ + each : function(fn, scope){ + var me = this, + els = me.elements, + len = els.length, + i, e; + + for(i = 0; i- el : Element
+ *The current Element in the iteration. + * This is the flyweight (shared) Ext.core.Element instance, so if you require a + * a reference to the dom node, use el.dom.- c : Composite
+ *This Composite object.- idx : Number
+ *The zero-based index in the iteration.+ * + * el
: Ext.core.ElementThe current DOM element.+ * + * @return {CompositeElement} this + */ + filter : function(selector){ + var els = [], + me = this, + fn = Ext.isFunction(selector) ? selector + : function(el){ + return el.is(selector); + }; + + me.each(function(el, self, i) { + if (fn(el, i) !== false) { + els[els.length] = me.transformElement(el); + } + }); + + me.elements = els; + return me; + }, + + /** + * Find the index of the passed element within the composite collection. + * @param el {Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection. + * @return Number The index of the passed Ext.core.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 {Mixed} el The id of an element, the Element itself, the index of the element in this composite + * to replace. + * @param {Mixed} replacement The id of an element or the Element itself. + * @param {Boolean} domReplace (Optional) True to remove and replace the element in the document too. + * @return {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. + */ + clear : function(){ + this.elements = []; + } +}; + +Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addListener; + +/** + * @private + * Copies all of the functions from Ext.core.Element's prototype onto CompositeElementLite's prototype. + * This is called twice - once immediately below, and once again after additional Ext.core.Element + * are added in Ext JS + */ +Ext.CompositeElementLite.importElementMethods = function() { + var fnName, + ElProto = Ext.core.Element.prototype, + CelProto = Ext.CompositeElementLite.prototype; + + for (fnName in ElProto) { + if (typeof ElProto[fnName] == 'function'){ + (function(fnName) { + CelProto[fnName] = CelProto[fnName] || function() { + return this.invoke(fnName, arguments); + }; + }).call(CelProto, fnName); + + } + } +}; + +Ext.CompositeElementLite.importElementMethods(); + +if(Ext.DomQuery){ + Ext.core.Element.selectorFunction = Ext.DomQuery.select; +} + +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.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/Array} selector The CSS selector or an array of elements + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Ext.core.Element + * @method select + */ +Ext.core.Element.select = function(selector, root){ + var els; + if(typeof selector == "string"){ + els = Ext.core.Element.selectorFunction(selector, root); + }else if(selector.length !== undefined){ + els = selector; + }else{ + } + return new Ext.CompositeElementLite(els); +}; +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.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/Array} selector The CSS selector or an array of elements + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Ext + * @method select + */ +Ext.select = Ext.core.Element.select; + +/** + * @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. + * @param {Object} scope (optional) The default scope (The index
: NumberThe current index within the collection.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. + */ +Ext.util.DelayedTask = function(fn, scope, args) { + var me = this, + id, + call = function() { + clearInterval(id); + id = null; + fn.apply(scope, args || []); + }; + + /** + * Cancels any pending timeout and queues a new one + * @param {Number} delay 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 + */ + this.delay = function(delay, newFn, newScope, newArgs) { + me.cancel(); + fn = newFn || fn; + scope = newScope || scope; + args = newArgs || args; + id = setInterval(call, delay); + }; + + /** + * Cancel the last queued timeout + */ + this.cancel = function(){ + if (id) { + clearInterval(id); + id = null; + } + }; +}; +Ext.require('Ext.util.DelayedTask', function() { + + Ext.util.Event = Ext.extend(Object, (function() { + function createBuffered(handler, listener, o, scope) { + listener.task = new Ext.util.DelayedTask(); + return function() { + listener.task.delay(o.buffer, handler, scope, Ext.Array.toArray(arguments)); + }; + } + + function createDelayed(handler, listener, o, scope) { + return function() { + var task = new Ext.util.DelayedTask(); + if (!listener.tasks) { + listener.tasks = []; + } + listener.tasks.push(task); + task.delay(o.delay || 10, handler, scope, Ext.Array.toArray(arguments)); + }; + } + + function createSingle(handler, listener, o, scope) { + return function() { + listener.ev.removeListener(listener.fn, scope); + return handler.apply(scope, arguments); + }; + } + + return { + isEvent: true, + + constructor: function(observable, name) { + this.name = name; + this.observable = observable; + this.listeners = []; + }, + + addListener: function(fn, scope, options) { + var me = this, + listener; + scope = scope || me.observable; + + + 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); + } + me.listeners.push(listener); + } + }, + + createListener: function(fn, scope, o) { + o = o || {}; + scope = scope || this.observable; + + var listener = { + fn: fn, + scope: scope, + o: o, + ev: this + }, + 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.single) { + handler = createSingle(handler, listener, o, scope); + } + if (o.delay) { + handler = createDelayed(handler, listener, o, scope); + } + if (o.buffer) { + handler = 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; + if (listener.fn == fn && (s == scope || s == 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, + k; + index = me.findListener(fn, scope); + if (index != -1) { + listener = me.listeners[index]; + + 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 + Ext.Array.erase(me.listeners, index, 1); + 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); + } + }, + + fire: function() { + var me = this, + listeners = me.listeners, + count = listeners.length, + i, + args, + listener; + + if (count > 0) { + me.firing = true; + for (i = 0; i < count; i++) { + listener = listeners[i]; + args = arguments.length ? Array.prototype.slice.call(arguments, 0) : []; + if (listener.o) { + args.push(listener.o); + } + if (listener && listener.fireFn.apply(listener.scope || me.observable, args) === false) { + return (me.firing = false); + } + } + } + me.firing = false; + return true; + } + }; + })()); +}); + +/** + * @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 = { + + // --------------------- onReady --------------------- + + /** + * Check if we have bound our global onReady listener + * @private + */ + hasBoundOnReady: false, + + /** + * Check if fireDocReady has been called + * @private + */ + hasFiredReady: false, + + /** + * Timer for the document ready event in old IE versions + * @private + */ + readyTimeout: null, + + /** + * Checks if we have bound an onreadystatechange event + * @private + */ + hasOnReadyStateChange: false, + + /** + * Holds references to any onReady functions + * @private + */ + readyEvent: new Ext.util.Event(), + + /** + * Check the ready state for old IE versions + * @private + * @return {Boolean} True if the document is ready + */ + checkReadyState: function(){ + var me = Ext.EventManager; + + if(window.attachEvent){ + // See here for reference: http://javascript.nwbox.com/IEContentLoaded/ + if (window != top) { + return false; + } + try{ + document.documentElement.doScroll('left'); + }catch(e){ + return false; + } + me.fireDocReady(); + return true; + } + if (document.readyState == 'complete') { + me.fireDocReady(); + return true; + } + me.readyTimeout = setTimeout(arguments.callee, 2); + return false; + }, + + /** + * Binds the appropriate browser event for checking if the DOM has loaded. + * @private + */ + bindReadyEvent: function(){ + var me = Ext.EventManager; + if (me.hasBoundOnReady) { + return; + } + + if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', me.fireDocReady, false); + // fallback, load will ~always~ fire + window.addEventListener('load', me.fireDocReady, false); + } else { + // check if the document is ready, this will also kick off the scroll checking timer + if (!me.checkReadyState()) { + document.attachEvent('onreadystatechange', me.checkReadyState); + me.hasOnReadyStateChange = true; + } + // fallback, onload will ~always~ fire + window.attachEvent('onload', me.fireDocReady, false); + } + me.hasBoundOnReady = true; + }, + + /** + * We know the document is loaded, so trigger any onReady events. + * @private + */ + fireDocReady: function(){ + var me = Ext.EventManager; + + // only unbind these events once + if (!me.hasFiredReady) { + me.hasFiredReady = true; + + if (document.addEventListener) { + document.removeEventListener('DOMContentLoaded', me.fireDocReady, false); + window.removeEventListener('load', me.fireDocReady, false); + } else { + if (me.readyTimeout !== null) { + clearTimeout(me.readyTimeout); + } + if (me.hasOnReadyStateChange) { + document.detachEvent('onreadystatechange', me.checkReadyState); + } + window.detachEvent('onload', me.fireDocReady); + } + Ext.supports.init(); + } + if (!Ext.isReady) { + Ext.isReady = true; + me.onWindowUnload(); + me.readyEvent.fire(); + } + }, + + /** + * Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be + * accessed shorthanded as Ext.onReady(). + * @param {Function} fn The method the event invokes. + * @param {Object} scope (optional) The scope (this
reference) in which the handler function executes. Defaults to the browser window. + * @param {boolean} options (optional) Options object as passed to {@link Ext.core.Element#addListener}. + */ + onDocumentReady: function(fn, scope, options){ + options = options || {}; + var me = Ext.EventManager, + readyEvent = me.readyEvent; + + // force single to be true so our event is only ever fired once. + options.single = true; + + // Document already loaded, let's just fire it + if (Ext.isReady) { + readyEvent.addListener(fn, scope, options); + readyEvent.fire(); + } else { + options.delay = options.delay || 1; + readyEvent.addListener(fn, scope, options); + me.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 {Mixed} element The element to get the id for. + * @return {String} id + */ + getId : function(element) { + var skipGarbageCollection = false, + id; + + element = Ext.getDom(element); + + if (element === document || element === window) { + id = element === document ? Ext.documentId : Ext.windowId; + } + else { + id = Ext.id(element); + } + // skip garbage collection for special elements (window, document, iframes) + if (element && (element.getElementById || element.navigator)) { + skipGarbageCollection = true; + } + + if (!Ext.cache[id]){ + Ext.core.Element.addToCache(new Ext.core.Element(element), id); + if (skipGarbageCollection) { + Ext.cache[id].skipGarbageCollection = true; + } + } + 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 me = this, + propRe = me.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 (Ext.isFunction(value)) { + // 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 === true) { + me.removeListener.apply(this, args); + } else { + me.addListener.apply(me, args); + } + } + } + } + }, + + /** + * 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 (/mouseenter|mouseleave/.test(eventName) && !Ext.supports.MouseEnterLeave) { + if (fn) { + fn = Ext.Function.createInterceptor(fn, this.contains, this); + } + 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){ + var parent = event.browserEvent.currentTarget, + child = this.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.core.Element#addListener} directly on an Element in favor of calling this version. + * @param {String/HTMLElement} 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} handler The handler function the event invokes. This function is passed + * the following parameters:+ *
+ * @param {Object} scope (optional) The scope (- evt : EventObject
+ *The {@link Ext.EventObject EventObject} describing the event.- t : Element
+ *The {@link Ext.core.Element 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 addListener call.this
reference) in which the handler function is executed. Defaults to the 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. Defaults to the Element.- delegate : String
+ *A simple selector to filter the target or look for a descendant of the target- 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- delay : Number
+ *The number of milliseconds to delay the invocation of the handler after te 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.- target : 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.
+ *See {@link Ext.core.Element#addListener} for examples of how to use these options.
+ */ + addListener: function(element, eventName, fn, scope, options){ + // Check if we've been passed a "config style" event. + if (typeof eventName !== 'string') { + this.prepareListenerConfig(element, eventName); + return; + } + + var dom = Ext.getDom(element), + bind, + wrap; + + + // create the wrapper function + options = options || {}; + + bind = this.normalizeEvent(eventName, fn); + wrap = this.createListenerWrap(dom, eventName, bind.fn, scope, options); + + + if (dom.attachEvent) { + dom.attachEvent('on' + bind.eventName, wrap); + } else { + dom.addEventListener(bind.eventName, wrap, options.capture || false); + } + + if (dom == document && eventName == 'mousedown') { + this.stoppedMouseDownEvent.addListener(wrap); + } + + // add all required data into the event cache + this.getEventListenerCache(dom, eventName).push({ + fn: fn, + wrap: wrap, + scope: scope + }); + }, + + /** + * Removes an event handler from an element. The shorthand version {@link #un} is equivalent. Typically + * you will use {@link Ext.core.Element#removeListener} directly on an Element in favor of calling this version. + * @param {String/HTMLElement} 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') { + this.prepareListenerConfig(element, eventName, true); + return; + } + + var dom = Ext.getDom(element), + cache = this.getEventListenerCache(dom, eventName), + bindName = this.normalizeEvent(eventName).eventName, + i = cache.length, j, + listener, wrap, tasks; + + + 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 (dom.detachEvent) { + dom.detachEvent('on' + bindName, wrap); + } else { + dom.removeEventListener(bindName, wrap, false); + } + + if (wrap && dom == document && eventName == 'mousedown') { + this.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.core.Element#removeAllListeners} + * directly on an Element in favor of calling this version. + * @param {String/HTMLElement} el The id or html element from which to remove all event handlers. + */ + removeAll : function(element){ + var dom = Ext.getDom(element), + cache, ev; + if (!dom) { + return; + } + cache = this.getElementEventCache(dom); + + for (ev in cache) { + if (cache.hasOwnProperty(ev)) { + this.removeListener(dom, ev); + } + } + Ext.cache[dom.id].events = {}; + }, + + /** + * Recursively removes all previous added listeners from an element and its children. Typically you will use {@link Ext.core.Element#purgeAllListeners} + * directly on an Element in favor of calling this version. + * @param {String/HTMLElement} 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; + + if(eventName) { + this.removeListener(dom, eventName); + } + else { + this.removeAll(dom); + } + + if(dom && dom.childNodes) { + for(len = element.childNodes.length; i < len; i++) { + this.purgeElement(element.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; + + return function wrap(e, args) { + // Compile the implementation upon first firing + if (!gen) { + f = ['if(!Ext) {return;}']; + + if(options.buffer || options.delay || options.freezeEvent) { + f.push('e = new Ext.EventObjectImpl(e, ' + (options.freezeEvent ? 'true' : 'false' ) + ');'); + } else { + f.push('e = Ext.EventObject.setEvent(e);'); + } + + if (options.delegate) { + f.push('var t = e.getTarget("' + options.delegate + '", this);'); + f.push('if(!t) {return;}'); + } else { + f.push('var t = e.target;'); + } + + 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('fn.call(scope || dom, e, t, options);'); + + if(options.single) { + f.push('Ext.EventManager.removeListener(dom, ename, fn, scope);'); + } + + if(options.delay) { + f.push('}, ' + options.delay + '));'); + } + + if(options.buffer) { + f.push('}, ' + options.buffer + ');'); + } + + gen = Ext.functionFactory('e', 'options', 'fn', 'scope', 'ename', 'dom', 'wrap', 'args', f.join('\n')); + } + + gen.call(dom, e, options, fn, scope, ename, dom, wrap, args); + }; + }, + + /** + * 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) { + if (!element) { + return []; + } + + var eventCache = this.getElementEventCache(element); + return eventCache[eventName] || (eventCache[eventName] = []); + }, + + /** + * Gets the event cache for the object + * @private + * @param {HTMLElement} element The element + * @return {Object} The event cache for the object + */ + getElementEventCache : function(element) { + if (!element) { + return {}; + } + var elementCache = Ext.cache[this.getId(element)]; + return elementCache.events || (elementCache.events = {}); + }, + + // --------------------- utility methods --------------------- + mouseLeaveRe: /(mouseout|mouseleave)/, + mouseEnterRe: /(mouseover|mouseenter)/, + + /** + * Stop the event (preventDefault and stopPropagation) + * @param {Event} The event to stop + */ + stopEvent: function(event) { + this.stopPropagation(event); + this.preventDefault(event); + }, + + /** + * Cancels bubbling of the event. + * @param {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} 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 (this.mouseLeaveRe.test(event.type)) { + target = event.toElement; + } else if (this.mouseEnterRe.test(event.type)) { + target = event.fromElement; + } + } + return this.resolveTextNode(target); + }, + + /** + * Gets the x coordinate from the event + * @param {Object} event The event + * @return {Number} The x coordinate + */ + getPageX: function(event) { + return this.getXY(event)[0]; + }, + + /** + * Gets the y coordinate from the event + * @param {Object} event The event + * @return {Number} The y coordinate + */ + getPageY: function(event) { + return this.getXY(event)[1]; + }, + + /** + * Gets the x & ycoordinate from the event + * @param {Object} event The event + * @return {Array} The x/y coordinate + */ + getPageXY: function(event) { + event = event.browserEvent || event; + var x = event.pageX, + y = event.pageY, + doc = document.documentElement, + body = document.body; + + // pageX/pageY not available (undefined, not null), use clientX/clientY instead + if (!x && x !== 0) { + x = event.clientX + (doc && doc.scrollLeft || body && body.scrollLeft || 0) - (doc && doc.clientLeft || body && body.clientLeft || 0); + y = event.clientY + (doc && doc.scrollTop || body && body.scrollTop || 0) - (doc && doc.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 this.resolveTextNode(event.target || event.srcElement); + }, + + /** + * Resolve any text nodes accounting for browser differences. + * @private + * @param {HTMLElement} node The node + * @return {HTMLElement} The resolved node + */ + // 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. + resolveTextNode: Ext.isGecko ? + function(node) { + if (!node) { + return; + } + // 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; + } + 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.core.Element#addListener} + */ + onWindowResize: function(fn, scope, options){ + var resize = this.resizeEvent; + if(!resize){ + this.resizeEvent = resize = new Ext.util.Event(); + this.on(window, 'resize', this.fireResize, this, {buffer: 100}); + } + resize.addListener(fn, scope, options); + }, + + /** + * Fire the resize event. + * @private + */ + fireResize: function(){ + var me = this, + w = Ext.core.Element.getViewWidth(), + h = Ext.core.Element.getViewHeight(); + + //whacky problem in IE where the resize event will sometimes fire even though the w/h are the same. + if(me.curHeight != h || me.curWidth != w){ + me.curHeight = h; + me.curWidth = w; + me.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){ + if (this.resizeEvent) { + this.resizeEvent.removeListener(fn, scope); + } + }, + + onWindowUnload: function() { + var unload = this.unloadEvent; + if (!unload) { + this.unloadEvent = unload = new Ext.util.Event(); + this.addListener(window, 'unload', this.fireUnload, this); + } + }, + + /** + * Fires the unload event for items bound with onWindowUnload + * @private + */ + fireUnload: function() { + // wrap in a try catch, could have some problems during unload + try { + this.removeUnloadListener(); + // Work around FF3 remembering the last scroll position when refreshing the grid and then losing grid view + if (Ext.isGecko3) { + var gridviews = Ext.ComponentQuery.query('gridview'), + i = 0, + ln = gridviews.length; + for (; i < ln; i++) { + gridviews[i].scrollToTop(); + } + } + // Purge all elements in the cache + var el, + cache = Ext.cache; + for (el in cache) { + if (cache.hasOwnProperty(el)) { + Ext.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(){ + if (this.unloadEvent) { + this.removeListener(window, 'unload', this.fireUnload); + } + }, + + /** + * 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 this.useKeyDown ? 'keydown' : 'keypress'; + } +}; + +/** + * Alias for {@link Ext.Loader#onReady Ext.Loader.onReady} with withDomReady set to true + * @member Ext + * @method onReady + */ +Ext.onReady = function(fn, scope, options) { + Ext.Loader.onReady(fn, scope, true, options); +}; + +/** + * Alias for {@link Ext.EventManager#onDocumentReady Ext.EventManager.onDocumentReady} + * @member Ext + * @method onDocumentReady + */ +Ext.onDocumentReady = Ext.EventManager.onDocumentReady; + +/** + * Alias for {@link Ext.EventManager#addListener Ext.EventManager.addListener} + * @member Ext.EventManager + * @method on + */ +Ext.EventManager.on = Ext.EventManager.addListener; + +/** + * Alias for {@link Ext.EventManager#removeListener Ext.EventManager.removeListener} + * @member Ext.EventManager + * @method un + */ +Ext.EventManager.un = Ext.EventManager.removeListener; + +(function(){ + var initExtCss = function() { + // find the body element + var bd = document.body || document.getElementsByTagName('body')[0], + baseCSSPrefix = Ext.baseCSSPrefix, + cls = [baseCSSPrefix + 'body'], + htmlCls = [], + html; + + if (!bd) { + return false; + } + + html = bd.parentNode; + + //Let's keep this human readable! + if (Ext.isIE) { + cls.push(baseCSSPrefix + 'ie'); + } + if (Ext.isIE6) { + cls.push(baseCSSPrefix + 'ie6'); + } + if (Ext.isIE7) { + cls.push(baseCSSPrefix + 'ie7'); + } + if (Ext.isIE8) { + cls.push(baseCSSPrefix + 'ie8'); + } + if (Ext.isIE9) { + cls.push(baseCSSPrefix + 'ie9'); + } + if (Ext.isGecko) { + cls.push(baseCSSPrefix + 'gecko'); + } + if (Ext.isGecko3) { + cls.push(baseCSSPrefix + 'gecko3'); + } + if (Ext.isGecko4) { + cls.push(baseCSSPrefix + 'gecko4'); + } + if (Ext.isOpera) { + cls.push(baseCSSPrefix + 'opera'); + } + if (Ext.isWebKit) { + cls.push(baseCSSPrefix + 'webkit'); + } + if (Ext.isSafari) { + cls.push(baseCSSPrefix + 'safari'); + } + if (Ext.isSafari2) { + cls.push(baseCSSPrefix + 'safari2'); + } + if (Ext.isSafari3) { + cls.push(baseCSSPrefix + 'safari3'); + } + if (Ext.isSafari4) { + cls.push(baseCSSPrefix + 'safari4'); + } + if (Ext.isChrome) { + cls.push(baseCSSPrefix + 'chrome'); + } + if (Ext.isMac) { + cls.push(baseCSSPrefix + 'mac'); + } + if (Ext.isLinux) { + cls.push(baseCSSPrefix + 'linux'); + } + if (!Ext.supports.CSS3BorderRadius) { + cls.push(baseCSSPrefix + 'nbr'); + } + if (!Ext.supports.CSS3LinearGradient) { + cls.push(baseCSSPrefix + 'nlg'); + } + if (!Ext.scopeResetCSS) { + cls.push(baseCSSPrefix + 'reset'); + } + + // 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; + } + + htmlCls.push(baseCSSPrefix + (Ext.isBorderBox ? 'border-box' : 'strict')); + if (!Ext.isStrict) { + htmlCls.push(baseCSSPrefix + 'quirks'); + if (Ext.isIE && !Ext.isStrict) { + Ext.isIEQuirks = true; + } + } + Ext.fly(html, '_internal').addCls(htmlCls); + } + + Ext.fly(bd, '_internal').addCls(cls); + return true; + }; + + Ext.onReady(initExtCss); +})(); + +/** + * @class Ext.EventObject + +Just as {@link Ext.core.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.core.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', { + uses: ['Ext.util.Point'], + + /** 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 + }, + + 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 {Array} 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/Mixed} 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.core.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/Mixed} 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.core.Element object instead of DOM node + * @return {HTMLElement} + */ + getRelatedTarget : function(selector, maxDepth, returnEl){ + if (selector) { + 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 + 0.5); + + 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:+ * @param {Mixed} el The id, DOM element or Ext.core.Element to check + * @param {Boolean} related (optional) true to test if the related target is within el instead of the target + * @param {Boolean} allowEl {optional} 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).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 Ext.create('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: + *+// 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!'); + } +}); +
HTMLEvents
+ *+ *
+ *- load
+ *- unload
+ *- select
+ *- change
+ *- submit
+ *- reset
+ *- resize
+ *- scroll
+ *MouseEvents
+ *+ *
+ *- click
+ *- dblclick
+ *- mousedown
+ *- mouseup
+ *- mouseover
+ *- mousemove
+ *- mouseout
+ *UIEvents
+ *+ *
+ * @param {Element/HTMLElement} target 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') + + // 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.isIE && 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) + var 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: function (t) { + return t; + } + }; + } + + function cannotInject (target, srcEvent) { + } + + 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(); + +}); + + +/** + * @class Ext.core.Element + */ +(function(){ + var doc = document, + activeElement = null, + isCSS1 = doc.compatMode == "CSS1Compat", + ELEMENT = Ext.core.Element, + fly = function(el){ + if (!_fly) { + _fly = new Ext.core.Element.Flyweight(); + } + _fly.dom = el; + return _fly; + }, _fly; + + // 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; + }; + } + + Ext.apply(ELEMENT, { + 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; + }, + + /** + * 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 () { + return doc.activeElement || activeElement; + }, + + /** + * 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 target {Element} The top-most element being adjusted. + * @private + */ + getRightMarginFixCleaner: function (target) { + var supports = Ext.supports, + hasInputBug = supports.DisplayChangeInputSelectionBug, + hasTextAreaBug = supports.DisplayChangeTextAreaSelectionBug; + + if (hasInputBug || hasTextAreaBug) { + var activeEl = doc.activeElement || activeElement, // save a call + tag = activeEl && activeEl.tagName, + start, + end; + + if ((hasTextAreaBug && tag == 'TEXTAREA') || + (hasInputBug && tag == 'INPUT' && activeEl.type == 'text')) { + if (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 ? ELEMENT.getDocumentWidth() : ELEMENT.getViewportWidth(); + }, + + getViewHeight : function(full) { + return full ? ELEMENT.getDocumentHeight() : ELEMENT.getViewportHeight(); + }, + + getDocumentHeight: function() { + return Math.max(!isCSS1 ? doc.body.scrollHeight : doc.documentElement.scrollHeight, ELEMENT.getViewportHeight()); + }, + + getDocumentWidth: function() { + return Math.max(!isCSS1 ? doc.body.scrollWidth : doc.documentElement.scrollWidth, ELEMENT.getViewportWidth()); + }, + + getViewportHeight: function(){ + return Ext.isIE ? + (Ext.isStrict ? doc.documentElement.clientHeight : doc.body.clientHeight) : + self.innerHeight; + }, + + getViewportWidth : function() { + return (!Ext.isStrict && !Ext.isOpera) ? doc.body.clientWidth : + Ext.isIE ? doc.documentElement.clientWidth : self.innerWidth; + }, + + getY : function(el) { + return ELEMENT.getXY(el)[1]; + }, + + getX : function(el) { + return ELEMENT.getXY(el)[0]; + }, + + getXY : function(el) { + var p, + pe, + b, + bt, + bl, + dbd, + x = 0, + y = 0, + scroll, + hasAbsolute, + bd = (doc.body || doc.documentElement), + ret = [0,0]; + + el = Ext.getDom(el); + + if(el != bd){ + hasAbsolute = fly(el).isStyle("position", "absolute"); + + if (el.getBoundingClientRect) { + b = el.getBoundingClientRect(); + scroll = fly(document).getScroll(); + ret = [Math.round(b.left + scroll.left), Math.round(b.top + scroll.top)]; + } else { + p = el; + + while (p) { + pe = fly(p); + x += p.offsetLeft; + y += p.offsetTop; + + hasAbsolute = hasAbsolute || pe.isStyle("position", "absolute"); + + if (Ext.isGecko) { + y += bt = parseInt(pe.getStyle("borderTopWidth"), 10) || 0; + x += bl = parseInt(pe.getStyle("borderLeftWidth"), 10) || 0; + + if (p != el && !pe.isStyle('overflow','visible')) { + x += bl; + y += bt; + } + } + p = p.offsetParent; + } + + if (Ext.isSafari && hasAbsolute) { + x -= bd.offsetLeft; + y -= bd.offsetTop; + } + + if (Ext.isGecko && !hasAbsolute) { + dbd = fly(bd); + x += parseInt(dbd.getStyle("borderLeftWidth"), 10) || 0; + y += parseInt(dbd.getStyle("borderTopWidth"), 10) || 0; + } + + p = el.parentNode; + while (p && p != bd) { + if (!Ext.isOpera || (p.tagName != 'TR' && !fly(p).isStyle("display", "inline"))) { + x -= p.scrollLeft; + y -= p.scrollTop; + } + p = p.parentNode; + } + ret = [x,y]; + } + } + return ret; + }, + + setXY : function(el, xy) { + (el = Ext.fly(el, '_setXY')).position(); + + var pts = el.translatePoints(xy), + style = el.dom.style, + pos; + + for (pos in pts) { + if (!isNaN(pts[pos])) { + style[pos] = pts[pos] + "px"; + } + } + }, + + setX : function(el, x) { + ELEMENT.setXY(el, [x, false]); + }, + + setY : function(el, y) { + ELEMENT.setXY(el, [false, y]); + }, + + /** + * 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, + name, + data = '', + type, + hasValue; + + Ext.each(fElements, function(element){ + name = element.name; + type = element.type; + + if (!element.disabled && name) { + if (/select-(one|multiple)/i.test(type)) { + Ext.each(element.options, function(opt){ + 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); + } + }); +})(); + +/** + * @class Ext.core.Element + */ + +Ext.core.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 (- focusin
+ *- focusout
+ *- activate
+ *- focus
+ *- blur
+ *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/Array} eventName an event / array of events to stop from bubbling + * @param {Boolean} preventDefault (optional) true to prevent the default action too + * @return {Ext.core.Element} this + */ + swallowEvent : function(eventName, preventDefault) { + var me = this; + function fn(e) { + e.stopPropagation(); + if (preventDefault) { + e.preventDefault(); + } + } + + if (Ext.isArray(eventName)) { + Ext.each(eventName, function(e) { + me.on(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} object 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 (optional) 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, + n = dom.firstChild, + nx, + ni = -1; + + if (Ext.core.Element.data(dom, 'isCleaned') && forceReclean !== true) { + return me; + } + + while (n) { + nx = n.nextSibling; + if (n.nodeType == 3) { + // Remove empty/whitespace text nodes + if (!(/\S/.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 + Ext.fly(n).clean(); + n.nodeIndex = ++ni; + } + n = nx; + } + + Ext.core.Element.data(dom, 'isCleaned', true); + return me; + }, + + /** + * Direct access to the Ext.ElementLoader {@link Ext.ElementLoader#load} method. The method takes the same object + * parameter as {@link Ext.ElementLoader#load} + * @return {Ext.core.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 dom = this.dom, + data = Ext.core.Element.data, + loader = data(dom, 'loader'); + + if (!loader) { + loader = Ext.create('Ext.ElementLoader', { + target: this + }); + data(dom, 'loader', loader); + } + return loader; + }, + + /** + * Update the innerHTML of this element, optionally searching for and processing scripts + * @param {String} html The new HTML + * @param {Boolean} loadScripts (optional) True to look for and process scripts (defaults to false) + * @param {Function} callback (optional) For async script loading you can be notified when the update completes + * @return {Ext.core.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(){ + if (!document.getElementById(id)) { + return false; + } + clearInterval(interval); + var DOC = document, + hd = DOC.getElementsByTagName("head")[0], + re = /(?: + * + * ## Configuration + * + * This component allows several options for configuring how the target Flash movie is embedded. The most + * important is the required {@link #url} which points to the location of the Flash movie to load. Other + * configurations include: + * + * - {@link #backgroundColor} + * - {@link #wmode} + * - {@link #flashVars} + * - {@link #flashParams} + * - {@link #flashAttributes} + * + * ## Example usage: + * + * var win = Ext.widget('window', { + * title: "It's a tiger!", + * layout: 'fit', + * width: 300, + * height: 300, + * x: 20, + * y: 20, + * resizable: true, + * items: { + * xtype: 'flash', + * url: 'tiger.swf' + * } + * }); + * win.show(); + * + * ## Express Install + * + * Adobe provides a tool called [Express Install](http://www.adobe.com/devnet/flashplayer/articles/express_install.html) + * that offers users an easy way to upgrade their Flash player. If you wish to make use of this, you should set + * the static EXPRESS\_INSTALL\_URL property to the location of your Express Install SWF file: + * + * Ext.flash.Component.EXPRESS_INSTALL_URL = 'path/to/local/expressInstall.swf'; + * + * @docauthor Jason Johnston*/ -Ext.data.Response = function(params) { - Ext.apply(this, params); -}; -Ext.data.Response.prototype = { - /** - * @cfg {String} action {@link Ext.data.Api#actions} - */ - action: undefined, - /** - * @cfg {Boolean} success - */ - success : undefined, +Ext.define('Ext.flash.Component', { + extend: 'Ext.Component', + alternateClassName: 'Ext.FlashComponent', + alias: 'widget.flash', + /** - * @cfg {String} message + * @cfg {String} flashVersion + * Indicates the version the flash content was published for. Defaults to '9.0.115'. */ - message : undefined, + flashVersion : '9.0.115', + /** - * @cfg {Array/Object} data + * @cfg {String} backgroundColor + * The background color of the SWF movie. Defaults to '#ffffff'. */ - data: undefined, + backgroundColor: '#ffffff', + /** - * @cfg {Object} raw The raw response returned from server-code + * @cfg {String} wmode + * The wmode of the flash object. This can be used to control layering. Defaults to 'opaque'. + * Set to 'transparent' to ignore the {@link #backgroundColor} and make the background of the Flash + * movie transparent. */ - raw: undefined, + wmode: 'opaque', + /** - * @cfg {Ext.data.Record/Ext.data.Record[]} records related to the Request action + * @cfg {Object} flashVars + * A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined. */ - records: undefined -}; -/** - * @class Ext.data.ScriptTagProxy - * @extends Ext.data.DataProxy - * An implementation of Ext.data.DataProxy that reads a data object from a URL which may be in a domain - * other than the originating domain of the running page.
- *- * Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain - * of the running page, you must use this class, rather than HttpProxy.
- *- * The content passed back from a server resource requested by a ScriptTagProxy must be executable JavaScript - * source code because it is used as the source inside a <script> tag.
- *- * In order for the browser to process the returned data, the server must wrap the data object - * with a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy. - * Below is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy - * depending on whether the callback name was passed: - *
- *
- *-boolean scriptTag = false; -String cb = request.getParameter("callback"); -if (cb != null) { - scriptTag = true; - response.setContentType("text/javascript"); -} else { - response.setContentType("application/x-json"); -} -Writer out = response.getWriter(); -if (scriptTag) { - out.write(cb + "("); -} -out.print(dataBlock.toJsonString()); -if (scriptTag) { - out.write(");"); -} -
Below is a PHP example to do the same thing:
- *-$callback = $_REQUEST['callback']; -// Create the output object. -$output = array('a' => 'Apple', 'b' => 'Banana'); - -//start output -if ($callback) { - header('Content-Type: text/javascript'); - echo $callback . '(' . json_encode($output) . ');'; -} else { - header('Content-Type: application/x-json'); - echo json_encode($output); -} -
Below is the ASP.Net code to do the same thing:
- * - * @constructor - * @param {Object} config A configuration object. - */ -Ext.data.ScriptTagProxy = function(config){ - Ext.apply(this, config); - - Ext.data.ScriptTagProxy.superclass.constructor.call(this, config); - - this.head = document.getElementsByTagName("head")[0]; - - /** - * @event loadexception - * Deprecated in favor of 'exception' event. - * Fires if an exception occurs in the Proxy during data loading. This event can be fired for one of two reasons: - *-String jsonString = "{success: true}"; -String cb = Request.Params.Get("callback"); -String responseString = ""; -if (!String.IsNullOrEmpty(cb)) { - responseString = cb + "(" + jsonString + ")"; -} else { - responseString = jsonString; -} -Response.Write(responseString); -
- * Note that this event is also relayed through {@link Ext.data.Store}, so you can listen for it directly - * on any Store instance. - * @param {Object} this - * @param {Object} options The loading options that were specified (see {@link #load} for details). If the load - * call timed out, this parameter will be null. - * @param {Object} arg The callback's arg object passed to the {@link #load} function - * @param {Error} e The JavaScript Error object caught if the configured Reader could not read the data. - * If the remote request returns success: false, this parameter will be null. + /** + * @cfg {Object} flashParams + * A set of key value pairs to be passed to the flash object as parameters. Possible parameters can be found here: + * http://kb2.adobe.com/cps/127/tn_12701.html Defaults to undefined. */ -}; -Ext.data.ScriptTagProxy.TRANS_ID = 1000; - -Ext.extend(Ext.data.ScriptTagProxy, Ext.data.DataProxy, { /** - * @cfg {String} url The URL from which to request the data object. + * @cfg {Object} flashAttributes + * A set of key value pairs to be passed to the flash object as attributes. Defaults to undefined. */ + /** - * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds. + * @cfg {String} url + * The URL of the SWF file to include. Required. */ - timeout : 30000, + /** - * @cfg {String} callbackParam (Optional) The name of the parameter to pass to the server which tells - * the server the name of the callback function set up by the load call to process the returned data object. - * Defaults to "callback".
- The load call timed out. This means the load callback did not execute within the time limit - * specified by {@link #timeout}. In this case, this event will be raised and the - * fourth parameter (read error) will be null.
- *- The load succeeded but the reader could not read the response. This means the server returned - * data, but the configured Reader threw an error while reading the data. In this case, this event will be - * raised and the caught error will be passed along as the fourth parameter of this event.
The server-side processing must read this parameter value, and generate - * javascript output which calls this named function passing the data object as its only parameter. + * @cfg {String/Number} swfWidth The width of the embedded SWF movie inside the component. Defaults to "100%" + * so that the movie matches the width of the component. */ - callbackParam : "callback", + swfWidth: '100%', + /** - * @cfg {Boolean} nocache (optional) Defaults to true. Disable caching by adding a unique parameter - * name to the request. + * @cfg {String/Number} swfHeight The height of the embedded SWF movie inside the component. Defaults to "100%" + * so that the movie matches the height of the component. */ - nocache : true, - - /** - * HttpProxy implementation of DataProxy#doRequest - * @param {String} action - * @param {Ext.data.Record/Ext.data.Record[]} rs If action is read, rs will be null - * @param {Object} params An object containing properties which are to be used as HTTP parameters - * for the request to the remote server. - * @param {Ext.data.DataReader} reader The Reader object which converts the data - * object into a block of Ext.data.Records. - * @param {Function} callback The function into which to pass the block of Ext.data.Records. - * The function must be passed
- *
- * @param {Object} scope The scope (- The Record block object
- *- The "arg" argument from the load function
- *- A boolean success indicator
- *this
reference) in which the callback function is executed. Defaults to the browser window. - * @param {Object} arg An optional argument which is passed to the callback as its second parameter. + swfHeight: '100%', + + /** + * @cfg {Boolean} expressInstall + * True to prompt the user to install flash if not installed. Note that this uses + * Ext.FlashComponent.EXPRESS_INSTALL_URL, which should be set to the local resource. Defaults to false. */ - doRequest : function(action, rs, params, reader, callback, scope, arg) { - var p = Ext.urlEncode(Ext.apply(params, this.extraParams)); + expressInstall: false, - var url = this.buildUrl(action, rs); - if (!url) { - throw new Ext.data.Api.Error('invalid-url', url); - } - url = Ext.urlAppend(url, p); + /** + * @property swf + * @type {Ext.core.Element} + * A reference to the object or embed element into which the SWF file is loaded. Only + * populated after the component is rendered and the SWF has been successfully embedded. + */ - if(this.nocache){ - url = Ext.urlAppend(url, '_dc=' + (new Date().getTime())); - } - var transId = ++Ext.data.ScriptTagProxy.TRANS_ID; - var trans = { - id : transId, - action: action, - cb : "stcCallback"+transId, - scriptId : "stcScript"+transId, - params : params, - arg : arg, - url : url, - callback : callback, - scope : scope, - reader : reader - }; - window[trans.cb] = this.createCallback(action, rs, trans); - url += String.format("&{0}={1}", this.callbackParam, trans.cb); - if(this.autoAbort !== false){ - this.abort(); - } + // Have to create a placeholder div with the swfId, which SWFObject will replace with the object/embed element. + renderTpl: [''], - trans.timeoutId = this.handleFailure.defer(this.timeout, this, [trans]); + initComponent: function() { - var script = document.createElement("script"); - script.setAttribute("src", url); - script.setAttribute("type", "text/javascript"); - script.setAttribute("id", trans.scriptId); - this.head.appendChild(script); + this.callParent(); + this.addEvents( + /** + * @event success + * Fired when the Flash movie has been successfully embedded + * @param {Ext.flash.Component} this + */ + 'success', - this.trans = trans; + /** + * @event failure + * Fired when the Flash movie embedding fails + * @param {Ext.flash.Component} this + */ + 'failure' + ); }, - // @private createCallback - createCallback : function(action, rs, trans) { - var self = this; - return function(res) { - self.trans = false; - self.destroyTrans(trans, true); - if (action === Ext.data.Api.actions.read) { - self.onRead.call(self, action, trans, res); - } else { - self.onWrite.call(self, action, trans, res, rs); - } - }; - }, - /** - * Callback for read actions - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} trans The request transaction object - * @param {Object} res The server response - * @protected - */ - onRead : function(action, trans, res) { - var result; - try { - result = trans.reader.readRecords(res); - }catch(e){ - // @deprecated: fire loadexception - this.fireEvent("loadexception", this, trans, res, e); + onRender: function() { + var me = this, + params, vars, undef, + swfId = me.getSwfId(); - this.fireEvent('exception', this, 'response', action, trans, res, e); - trans.callback.call(trans.scope||window, null, trans.arg, false); - return; - } - if (result.success === false) { - // @deprecated: fire old loadexception for backwards-compat. - this.fireEvent('loadexception', this, trans, res); + me.renderData.swfId = swfId; - this.fireEvent('exception', this, 'remote', action, trans, res, null); - } else { - this.fireEvent("load", this, res, trans.arg); - } - trans.callback.call(trans.scope||window, result, trans.arg, result.success); + me.callParent(arguments); + + params = Ext.apply({ + allowScriptAccess: 'always', + bgcolor: me.backgroundColor, + wmode: me.wmode + }, me.flashParams); + + vars = Ext.apply({ + allowedDomain: document.location.hostname + }, me.flashVars); + + new swfobject.embedSWF( + me.url, + swfId, + me.swfWidth, + me.swfHeight, + me.flashVersion, + me.expressInstall ? me.statics.EXPRESS_INSTALL_URL : undef, + vars, + params, + me.flashAttributes, + Ext.bind(me.swfCallback, me) + ); }, + /** - * Callback for write actions - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} trans The request transaction object - * @param {Object} res The server response - * @protected + * @private + * The callback method for handling an embedding success or failure by SWFObject + * @param {Object} e The event object passed by SWFObject - see http://code.google.com/p/swfobject/wiki/api */ - onWrite : function(action, trans, response, rs) { - var reader = trans.reader; - try { - // though we already have a response object here in STP, run through readResponse to catch any meta-data exceptions. - var res = reader.readResponse(action, response); - } catch (e) { - this.fireEvent('exception', this, 'response', action, trans, res, e); - trans.callback.call(trans.scope||window, null, res, false); - return; - } - if(!res.success === true){ - this.fireEvent('exception', this, 'remote', action, trans, res, rs); - trans.callback.call(trans.scope||window, null, res, false); - return; + swfCallback: function(e) { + var me = this; + if (e.success) { + me.swf = Ext.get(e.ref); + me.onSuccess(); + me.fireEvent('success', me); + } else { + me.onFailure(); + me.fireEvent('failure', me); } - this.fireEvent("write", this, action, res.data, res, rs, trans.arg ); - trans.callback.call(trans.scope||window, res.data, res, true); - }, - - // private - isLoading : function(){ - return this.trans ? true : false; }, /** - * Abort the current server request. + * Retrieve the id of the SWF object/embed element */ - abort : function(){ - if(this.isLoading()){ - this.destroyTrans(this.trans); - } + getSwfId: function() { + return this.swfId || (this.swfId = "extswf" + this.getAutoId()); }, - // private - destroyTrans : function(trans, isLoaded){ - this.head.removeChild(document.getElementById(trans.scriptId)); - clearTimeout(trans.timeoutId); - if(isLoaded){ - window[trans.cb] = undefined; - try{ - delete window[trans.cb]; - }catch(e){} - }else{ - // if hasn't been loaded, wait for load to remove it to prevent script error - window[trans.cb] = function(){ - window[trans.cb] = undefined; - try{ - delete window[trans.cb]; - }catch(e){} - }; - } + onSuccess: function() { + // swfobject forces visiblity:visible on the swf element, which prevents it + // from getting hidden when an ancestor is given visibility:hidden. + this.swf.setStyle('visibility', 'inherit'); }, - // private - handleFailure : function(trans){ - this.trans = false; - this.destroyTrans(trans, false); - if (trans.action === Ext.data.Api.actions.read) { - // @deprecated firing loadexception - this.fireEvent("loadexception", this, null, trans.arg); - } + onFailure: Ext.emptyFn, - this.fireEvent('exception', this, 'response', trans.action, { - response: null, - options: trans.arg - }); - trans.callback.call(trans.scope||window, null, trans.arg, false); + beforeDestroy: function() { + var me = this, + swf = me.swf; + if (swf) { + swfobject.removeSWF(me.getSwfId()); + Ext.destroy(swf); + delete me.swf; + } + me.callParent(); }, - // inherit docs - destroy: function(){ - this.abort(); - Ext.data.ScriptTagProxy.superclass.destroy.call(this); + statics: { + /** + * Sets the url for installing flash if it doesn't exist. This should be set to a local resource. + * See http://www.adobe.com/devnet/flashplayer/articles/express_install.html for details. + * @static + * @type String + */ + EXPRESS_INSTALL_URL: 'http:/' + '/swfobject.googlecode.com/svn/trunk/swfobject/expressInstall.swf' } -});/** - * @class Ext.data.HttpProxy - * @extends Ext.data.DataProxy - *An implementation of {@link Ext.data.DataProxy} that processes data requests within the same - * domain of the originating page.
- *Note: this class cannot be used to retrieve data from a domain other - * than the domain from which the running page was served. For cross-domain requests, use a - * {@link Ext.data.ScriptTagProxy ScriptTagProxy}.
- *Be aware that to enable the browser to parse an XML document, the server must set - * the Content-Type header in the HTTP response to "text/xml".
- * @constructor - * @param {Object} conn - * An {@link Ext.data.Connection} object, or options parameter to {@link Ext.Ajax#request}. - *Note that if this HttpProxy is being used by a {@link Ext.data.Store Store}, then the - * Store's call to {@link #load} will override any specified callback and params - * options. In this case, use the Store's {@link Ext.data.Store#events events} to modify parameters, - * or react to loading events. The Store's {@link Ext.data.Store#baseParams baseParams} may also be - * used to pass parameters known at instantiation time.
- *If an options parameter is passed, the singleton {@link Ext.Ajax} object will be used to make - * the request.
+}); + +/** + * @class Ext.form.action.Action + * @extends Ext.Base + *The subclasses of this class provide actions to perform upon {@link Ext.form.Basic Form}s.
+ *Instances of this class are only created by a {@link Ext.form.Basic Form} when + * the Form needs to perform an action such as submit or load. The Configuration options + * listed for this class are set through the Form's action methods: {@link Ext.form.Basic#submit submit}, + * {@link Ext.form.Basic#load load} and {@link Ext.form.Basic#doAction doAction}
+ *The instance of Action which performed the action is passed to the success + * and failure callbacks of the Form's action methods ({@link Ext.form.Basic#submit submit}, + * {@link Ext.form.Basic#load load} and {@link Ext.form.Basic#doAction doAction}), + * and to the {@link Ext.form.Basic#actioncomplete actioncomplete} and + * {@link Ext.form.Basic#actionfailed actionfailed} event handlers.
*/ -Ext.data.HttpProxy = function(conn){ - Ext.data.HttpProxy.superclass.constructor.call(this, conn); +Ext.define('Ext.form.action.Action', { + alternateClassName: 'Ext.form.Action', /** - * The Connection object (Or options parameter to {@link Ext.Ajax#request}) which this HttpProxy - * uses to make requests to the server. Properties of this object may be changed dynamically to - * change the way data is requested. - * @property + * @cfg {Ext.form.Basic} form The {@link Ext.form.Basic BasicForm} instance that + * is invoking this Action. Required. */ - this.conn = conn; - // nullify the connection url. The url param has been copied to 'this' above. The connection - // url will be set during each execution of doRequest when buildUrl is called. This makes it easier for users to override the - // connection url during beforeaction events (ie: beforeload, beforewrite, etc). - // Url is always re-defined during doRequest. - this.conn.url = null; + /** + * @cfg {String} url The URL that the Action is to invoke. Will default to the {@link Ext.form.Basic#url url} + * configured on the {@link #form}. + */ - this.useAjax = !conn || !conn.events; + /** + * @cfg {Boolean} reset When set to true, causes the Form to be + * {@link Ext.form.Basic#reset reset} on Action success. If specified, this happens + * before the {@link #success} callback is called and before the Form's + * {@link Ext.form.Basic#actioncomplete actioncomplete} event fires. + */ - // A hash containing active requests, keyed on action [Ext.data.Api.actions.create|read|update|destroy] - var actions = Ext.data.Api.actions; - this.activeRequest = {}; - for (var verb in actions) { - this.activeRequest[actions[verb]] = undefined; - } -}; + /** + * @cfg {String} method The HTTP method to use to access the requested URL. Defaults to the + * {@link Ext.form.Basic#method BasicForm's method}, or 'POST' if not specified. + */ -Ext.extend(Ext.data.HttpProxy, Ext.data.DataProxy, { /** - * Return the {@link Ext.data.Connection} object being used by this Proxy. - * @return {Connection} The Connection object. This object may be used to subscribe to events on - * a finer-grained basis than the DataProxy events. + * @cfg {Object/String} paramsExtra parameter values to pass. These are added to the Form's + * {@link Ext.form.Basic#baseParams} and passed to the specified URL along with the Form's + * input fields.
+ *Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode Ext.Object.toQueryString}.
*/ - getConnection : function() { - return this.useAjax ? Ext.Ajax : this.conn; - }, /** - * Used for overriding the url used for a single request. Designed to be called during a beforeaction event. Calling setUrl - * will override any urls set via the api configuration parameter. Set the optional parameter makePermanent to set the url for - * all subsequent requests. If not set to makePermanent, the next request will use the same url or api configuration defined - * in the initial proxy configuration. - * @param {String} url - * @param {Boolean} makePermanent (Optional) [false] - * - * (e.g.: beforeload, beforesave, etc). + * @cfg {Object} headersExtra headers to be sent in the AJAX request for submit and load actions. See + * {@link Ext.data.Connection#headers}.
*/ - setUrl : function(url, makePermanent) { - this.conn.url = url; - if (makePermanent === true) { - this.url = url; - this.api = null; - Ext.data.Api.prepare(this); - } - }, /** - * HttpProxy implementation of DataProxy#doRequest - * @param {String} action The crud action type (create, read, update, destroy) - * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null - * @param {Object} params An object containing properties which are to be used as HTTP parameters - * for the request to the remote server. - * @param {Ext.data.DataReader} reader The Reader object which converts the data - * object into a block of Ext.data.Records. - * @param {Function} callback - *- * @param {Object} scope The scope (A function to be called after the request. - * The callback is passed the following arguments:
- *
- r : Ext.data.Record[] The block of Ext.data.Records.
- *- options: Options object from the action request
- *- success: Boolean success indicator
this
reference) in which the callback function is executed. Defaults to the browser window. - * @param {Object} arg An optional argument which is passed to the callback as its second parameter. - * @protected + * @cfg {Number} timeout The number of seconds to wait for a server response before + * failing with the {@link #failureType} as {@link Ext.form.action.Action#CONNECT_FAILURE}. If not specified, + * defaults to the configured {@link Ext.form.Basic#timeout timeout} of the + * {@link #form}. */ - doRequest : function(action, rs, params, reader, cb, scope, arg) { - var o = { - method: (this.api[action]) ? this.api[action]['method'] : undefined, - request: { - callback : cb, - scope : scope, - arg : arg - }, - reader: reader, - callback : this.createCallback(action, rs), - scope: this - }; - // If possible, transmit data using jsonData || xmlData on Ext.Ajax.request (An installed DataWriter would have written it there.). - // Use std HTTP params otherwise. - if (params.jsonData) { - o.jsonData = params.jsonData; - } else if (params.xmlData) { - o.xmlData = params.xmlData; - } else { - o.params = params || {}; - } - // Set the connection url. If this.conn.url is not null here, - // the user must have overridden the url during a beforewrite/beforeload event-handler. - // this.conn.url is nullified after each request. - this.conn.url = this.buildUrl(action, rs); + /** + * @cfg {Function} success The function to call when a valid success return packet is received. + * The function is passed the following parameters:+ *
+ */ - if(this.useAjax){ + /** + * @cfg {Function} failure The function to call when a failure packet was received, or when an + * error ocurred in the Ajax communication. + * The function is passed the following parameters:- form : Ext.form.Basic
+ *The form that requested the action- action : Ext.form.action.Action
+ *The Action class. The {@link #result} + * property of this object may be examined to perform custom postprocessing.+ *
+ */ - Ext.applyIf(o, this.conn); + /** + * @cfg {Object} scope The scope in which to call the configured success and failure + * callback functions (the this reference for the callback functions). + */ - // If a currently running request is found for this action, abort it. - if (this.activeRequest[action]) { - //// - // Disabled aborting activeRequest while implementing REST. activeRequest[action] will have to become an array - // TODO ideas anyone? - // - //Ext.Ajax.abort(this.activeRequest[action]); - } - this.activeRequest[action] = Ext.Ajax.request(o); - }else{ - this.conn.request(o); - } - // request is sent, nullify the connection url in preparation for the next request - this.conn.url = null; - }, + /** + * @cfg {String} waitMsg The message to be displayed by a call to {@link Ext.window.MessageBox#wait} + * during the time the action is being processed. + */ /** - * Returns a callback function for a request. Note a special case is made for the - * read action vs all the others. - * @param {String} action [create|update|delete|load] - * @param {Ext.data.Record[]} rs The Store-recordset being acted upon - * @private + * @cfg {String} waitTitle The title to be displayed by a call to {@link Ext.window.MessageBox#wait} + * during the time the action is being processed. */ - createCallback : function(action, rs) { - return function(o, success, response) { - this.activeRequest[action] = undefined; - if (!success) { - if (action === Ext.data.Api.actions.read) { - // @deprecated: fire loadexception for backwards compat. - // TODO remove - this.fireEvent('loadexception', this, o, response); - } - this.fireEvent('exception', this, 'response', action, o, response); - o.request.callback.call(o.request.scope, null, o.request.arg, false); - return; - } - if (action === Ext.data.Api.actions.read) { - this.onRead(action, o, response); - } else { - this.onWrite(action, o, response, rs); - } - }; - }, /** - * Callback for read action - * @param {String} action Action name as per {@link Ext.data.Api.actions#read}. - * @param {Object} o The request transaction object - * @param {Object} res The server response - * @fires loadexception (deprecated) - * @fires exception - * @fires load - * @protected + * @cfg {Boolean} submitEmptyText If set to true, the emptyText value will be sent with the form + * when it is submitted. Defaults to true. */ - onRead : function(action, o, response) { - var result; - try { - result = o.reader.read(response); - }catch(e){ - // @deprecated: fire old loadexception for backwards-compat. - // TODO remove - this.fireEvent('loadexception', this, o, response, e); - - this.fireEvent('exception', this, 'response', action, o, response, e); - o.request.callback.call(o.request.scope, null, o.request.arg, false); - return; - } - if (result.success === false) { - // @deprecated: fire old loadexception for backwards-compat. - // TODO remove - this.fireEvent('loadexception', this, o, response); - // Get DataReader read-back a response-object to pass along to exception event - var res = o.reader.readResponse(action, response); - this.fireEvent('exception', this, 'remote', action, o, res, null); - } - else { - this.fireEvent('load', this, o, o.request.arg); - } - // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance - // the calls to request.callback(...) in each will have to be made identical. - // NOTE reader.readResponse does not currently return Ext.data.Response - o.request.callback.call(o.request.scope, result, o.request.arg, result.success); - }, /** - * Callback for write actions - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} trans The request transaction object - * @param {Object} res The server response - * @fires exception - * @fires write - * @protected + * @property type + * The type of action this Action instance performs. + * Currently only "submit" and "load" are supported. + * @type {String} */ - onWrite : function(action, o, response, rs) { - var reader = o.reader; - var res; - try { - res = reader.readResponse(action, response); - } catch (e) { - this.fireEvent('exception', this, 'response', action, o, response, e); - o.request.callback.call(o.request.scope, null, o.request.arg, false); - return; - } - if (res.success === true) { - this.fireEvent('write', this, action, res.data, res, rs, o.request.arg); - } else { - this.fireEvent('exception', this, 'remote', action, o, res, rs); - } - // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance - // the calls to request.callback(...) in each will have to be made similar. - // NOTE reader.readResponse does not currently return Ext.data.Response - o.request.callback.call(o.request.scope, res.data, res, res.success); - }, - // inherit docs - destroy: function(){ - if(!this.useAjax){ - this.conn.abort(); - }else if(this.activeRequest){ - var actions = Ext.data.Api.actions; - for (var verb in actions) { - if(this.activeRequest[actions[verb]]){ - Ext.Ajax.abort(this.activeRequest[actions[verb]]); + /** + * The type of failure detected will be one of these: {@link Ext.form.action.Action#CLIENT_INVALID}, + * {@link Ext.form.action.Action#SERVER_INVALID}, {@link Ext.form.action.Action#CONNECT_FAILURE}, or + * {@link Ext.form.action.Action#LOAD_FAILURE}. Usage: + *- form : Ext.form.Basic
+ *The form that requested the action- action : Ext.form.action.Action
+ *The Action class. If an Ajax + * error ocurred, the failure type will be in {@link #failureType}. The {@link #result} + * property of this object may be examined to perform custom postprocessing.+ * @property failureType + * @type {String} + */ -Ext.extend(Ext.data.MemoryProxy, Ext.data.DataProxy, { /** - * @event loadexception - * Fires if an exception occurs in the Proxy during data loading. Note that this event is also relayed - * through {@link Ext.data.Store}, so you can listen for it directly on any Store instance. - * @param {Object} this - * @param {Object} arg The callback's arg object passed to the {@link #load} function - * @param {Object} null This parameter does not apply and will always be null for MemoryProxy - * @param {Error} e The JavaScript Error object caught if the configured Reader could not read the data + * The raw XMLHttpRequest object used to perform the action. + * @property response + * @type {Object} */ - /** - * MemoryProxy implementation of DataProxy#doRequest - * @param {String} action - * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null - * @param {Object} params An object containing properties which are to be used as HTTP parameters - * for the request to the remote server. - * @param {Ext.data.DataReader} reader The Reader object which converts the data - * object into a block of Ext.data.Records. - * @param {Function} callback The function into which to pass the block of Ext.data.Records. - * The function must be passed+var fp = new Ext.form.Panel({ +... +buttons: [{ + text: 'Save', + formBind: true, + handler: function(){ + if(fp.getForm().isValid()){ + fp.getForm().submit({ + url: 'form-submit.php', + waitMsg: 'Submitting your data...', + success: function(form, action){ + // server responded with success = true + var result = action.{@link #result}; + }, + failure: function(form, action){ + if (action.{@link #failureType} === {@link Ext.form.action.Action#CONNECT_FAILURE}) { + Ext.Msg.alert('Error', + 'Status:'+action.{@link #response}.status+': '+ + action.{@link #response}.statusText); + } + if (action.failureType === {@link Ext.form.action.Action#SERVER_INVALID}){ + // server responded with success = false + Ext.Msg.alert('Invalid', action.{@link #result}.errormsg); + } } - } + }); } - Ext.data.HttpProxy.superclass.destroy.call(this); } -});/** - * @class Ext.data.MemoryProxy - * @extends Ext.data.DataProxy - * An implementation of Ext.data.DataProxy that simply passes the data specified in its constructor - * to the Reader when its load method is called. - * @constructor - * @param {Object} data The data object which the Reader uses to construct a block of Ext.data.Records. - */ -Ext.data.MemoryProxy = function(data){ - // Must define a dummy api with "read" action to satisfy DataProxy#doRequest and Ext.data.Api#prepare *before* calling super - var api = {}; - api[Ext.data.Api.actions.read] = true; - Ext.data.MemoryProxy.superclass.constructor.call(this, { - api: api - }); - this.data = data; -}; +},{ + text: 'Reset', + handler: function(){ + fp.getForm().reset(); + } +}] + *
- *
- * @param {Object} scope The scope (- The Record block object
- *- The "arg" argument from the load function
- *- A boolean success indicator
- *this
reference) in which the callback function is executed. Defaults to the browser window. - * @param {Object} arg An optional argument which is passed to the callback as its second parameter. + /** + * The decoded response object containing a boolean success property and + * other, action-specific properties. + * @property result + * @type {Object} */ - doRequest : function(action, rs, params, reader, callback, scope, arg) { - // No implementation for CRUD in MemoryProxy. Assumes all actions are 'load' - params = params || {}; - var result; - try { - result = reader.readRecords(this.data); - }catch(e){ - // @deprecated loadexception - this.fireEvent("loadexception", this, null, arg, e); - this.fireEvent('exception', this, 'response', action, arg, null, e); - callback.call(scope, null, arg, false); - return; + /** + * Creates new Action. + * @param {Object} config (optional) Config object. + */ + constructor: function(config) { + if (config) { + Ext.apply(this, config); + } + + // Normalize the params option to an Object + var params = config.params; + if (Ext.isString(params)) { + this.params = Ext.Object.fromQueryString(params); } - callback.call(scope, result, arg, true); - } -});/** - * @class Ext.data.Types - *This is s static class containing the system-supplied data types which may be given to a {@link Ext.data.Field Field}.
- *The properties in this class are used as type indicators in the {@link Ext.data.Field Field} class, so to - * test whether a Field is of a certain type, compare the {@link Ext.data.Field#type type} property against properties - * of this class.
- *Developers may add their own application-specific data types to this class. Definition names must be UPPERCASE. - * each type definition must contain three properties:
- *- *- *
- - *
convert
: FunctionA function to convert raw data values from a data block into the data - * to be stored in the Field. The function is passed the collowing parameters: - *- *
- v : Mixed
- *The data value as read by the Reader, if undefined will use - * the configured {@link Ext.data.Field#defaultValue defaultValue}.- rec : Mixed
- *The data object containing the row as read by the Reader. - * Depending on the Reader type, this could be an Array ({@link Ext.data.ArrayReader ArrayReader}), an object - * ({@link Ext.data.JsonReader JsonReader}), or an XML element ({@link Ext.data.XMLReader XMLReader}).- - *
sortType
: FunctionA function to convert the stored data into comparable form, as defined by {@link Ext.data.SortTypes}.- - *
type
: StringA textual data type name.For example, to create a VELatLong field (See the Microsoft Bing Mapping API) containing the latitude/longitude value of a datapoint on a map from a JsonReader data block - * which contained the properties
- *lat
andlong
, you would define a new data type like this:- *-// Add a new Field data type which stores a VELatLong object in the Record. -Ext.data.Types.VELATLONG = { - convert: function(v, data) { - return new VELatLong(data.lat, data.long); - }, - sortType: function(v) { - return v.Latitude; // When sorting, order by latitude }, - type: 'VELatLong' -}; -
Then, when declaring a Record, use
- * @singleton - */ -Ext.data.Types = new function(){ - var st = Ext.data.SortTypes; - Ext.apply(this, { - /** - * @type Regexp - * @property stripRe - * A regular expression for stripping non-numeric characters from a numeric value. Defaults to /[\$,%]/g. - * This should be overridden for localization. - */ - stripRe: /[\$,%]/g, - - /** - * @type Object. - * @property AUTO - * This data type means that no conversion is applied to the raw data before it is placed into a Record. - */ - AUTO: { - convert: function(v){ return v; }, - sortType: st.none, - type: 'auto' - }, - /** - * @type Object. - * @property STRING - * This data type means that the raw data is converted into a String before it is placed into a Record. - */ - STRING: { - convert: function(v){ return (v === undefined || v === null) ? '' : String(v); }, - sortType: st.asUCString, - type: 'string' - }, + /** + * Invokes this action using the current configuration. + */ + run: Ext.emptyFn, - /** - * @type Object. - * @property INT - * This data type means that the raw data is converted into an integer before it is placed into a Record. - *-var types = Ext.data.Types; // allow shorthand type access -UnitRecord = Ext.data.Record.create([ - { name: 'unitName', mapping: 'UnitName' }, - { name: 'curSpeed', mapping: 'CurSpeed', type: types.INT }, - { name: 'latitude', mapping: 'lat', type: types.FLOAT }, - { name: 'latitude', mapping: 'lat', type: types.FLOAT }, - { name: 'position', type: types.VELATLONG } -]); -
The synonym
- */ - INT: { - convert: function(v){ - return v !== undefined && v !== null && v !== '' ? - parseInt(String(v).replace(Ext.data.Types.stripRe, ''), 10) : 0; - }, - sortType: st.none, - type: 'int' - }, - - /** - * @type Object. - * @property FLOAT - * This data type means that the raw data is converted into a number before it is placed into a Record. - *INTEGER
is equivalent.The synonym
- */ - FLOAT: { - convert: function(v){ - return v !== undefined && v !== null && v !== '' ? - parseFloat(String(v).replace(Ext.data.Types.stripRe, ''), 10) : 0; - }, - sortType: st.none, - type: 'float' - }, - - /** - * @type Object. - * @property BOOL - *NUMBER
is equivalent.This data type means that the raw data is converted into a boolean before it is placed into - * a Record. The string "true" and the number 1 are converted to boolean
- *true
.The synonym
- */ - BOOL: { - convert: function(v){ return v === true || v === 'true' || v == 1; }, - sortType: st.none, - type: 'bool' - }, - - /** - * @type Object. - * @property DATE - * This data type means that the raw data is converted into a Date before it is placed into a Record. - * The date format is specified in the constructor of the {@link Ext.data.Field} to which this type is - * being applied. - */ - DATE: { - convert: function(v){ - var df = this.dateFormat; - if(!v){ - return null; - } - if(Ext.isDate(v)){ - return v; - } - if(df){ - if(df == 'timestamp'){ - return new Date(v*1000); - } - if(df == 'time'){ - return new Date(parseInt(v, 10)); - } - return Date.parseDate(v, df); - } - var parsed = Date.parse(v); - return parsed ? new Date(parsed) : null; - }, - sortType: st.asDate, - type: 'date' - } - }); - - Ext.apply(this, { - /** - * @type Object. - * @property BOOLEAN - *BOOLEAN
is equivalent.This data type means that the raw data is converted into a boolean before it is placed into - * a Record. The string "true" and the number 1 are converted to boolean
- *true
.The synonym
- */ - BOOLEAN: this.BOOL, - /** - * @type Object. - * @property INTEGER - * This data type means that the raw data is converted into an integer before it is placed into a Record. - *BOOL
is equivalent.The synonym
- */ - INTEGER: this.INT, - /** - * @type Object. - * @property NUMBER - * This data type means that the raw data is converted into a number before it is placed into a Record. - *INT
is equivalent.The synonym
- */ - NUMBER: this.FLOAT - }); -};/** - * @class Ext.data.JsonWriter - * @extends Ext.data.DataWriter - * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action. - */ -Ext.data.JsonWriter = Ext.extend(Ext.data.DataWriter, { /** - * @cfg {Boolean} encode true to {@link Ext.util.JSON#encode encode} the - * {@link Ext.data.DataWriter#toHash hashed data}. Defaults to true. When using - * {@link Ext.data.DirectProxy}, set this to false since Ext.Direct.JsonProvider will perform - * its own json-encoding. In addition, if you're using {@link Ext.data.HttpProxy}, setting to false - * will cause HttpProxy to transmit data using the jsonData configuration-params of {@link Ext.Ajax#request} - * instead of params. When using a {@link Ext.data.Store#restful} Store, some serverside frameworks are - * tuned to expect data through the jsonData mechanism. In those cases, one will want to set encode: false, as in - * let the lower-level connection object (eg: Ext.Ajax) do the encoding. + * @private + * @method onSuccess + * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses. + * @param {Object} response */ - encode : true, + /** - * @cfg {Boolean} encodeDelete False to send only the id to the server on delete, true to encode it in an object - * literal, eg:FLOAT
is equivalent.Defaults to false + * @private + * @method handleResponse + * Handles the raw response and builds a result object from it. Must be implemented by subclasses. + * @param {Object} response */ - encodeDelete: false, - - constructor : function(config){ - Ext.data.JsonWriter.superclass.constructor.call(this, config); + + /** + * @private + * Handles a failure response. + * @param {Object} response + */ + onFailure : function(response){ + this.response = response; + this.failureType = Ext.form.action.Action.CONNECT_FAILURE; + this.form.afterAction(this, false); }, /** - * Final action of a write event. Apply the written data-object to params. - * @param {Object} http params-object to write-to. - * @param {Object} baseParams as defined by {@link Ext.data.Store#baseParams}. The baseParms must be encoded by the extending class, eg: {@link Ext.data.JsonWriter}, {@link Ext.data.XmlWriter}. - * @param {Object/Object[]} data Data-object representing compiled Store-recordset. + * @private + * Validates that a response contains either responseText or responseXML and invokes + * {@link #handleResponse} to build the result object. + * @param {Object} response The raw response object. + * @return {Object/Boolean} result The result object as built by handleResponse, or true if + * the response had empty responseText and responseXML. */ - render : function(params, baseParams, data) { - if (this.encode === true) { - // Encode here now. - Ext.apply(params, baseParams); - params[this.meta.root] = Ext.encode(data); - } else { - // defer encoding for some other layer, probably in {@link Ext.Ajax#request}. Place everything into "jsonData" key. - var jdata = Ext.apply({}, baseParams); - jdata[this.meta.root] = data; - params.jsonData = jdata; + processResponse : function(response){ + this.response = response; + if (!response.responseText && !response.responseXML) { + return true; } + return (this.result = this.handleResponse(response)); }, + /** - * Implements abstract Ext.data.DataWriter#createRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Object} + * @private + * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions. + * @return {String} The URL. */ - createRecord : function(rec) { - return this.toHash(rec); + getUrl: function() { + return this.url || this.form.url; }, + /** - * Implements abstract Ext.data.DataWriter#updateRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Object} + * @private + * Determine the HTTP method to be used for the request. + * @return {String} The HTTP method */ - updateRecord : function(rec) { - return this.toHash(rec); + getMethod: function() { + return (this.method || this.form.method || 'POST').toUpperCase(); + }, + /** + * @private + * Get the set of parameters specified in the BasicForm's baseParams and/or the params option. + * Items in params override items of the same name in baseParams. + * @return {Object} the full set of parameters + */ + getParams: function() { + return Ext.apply({}, this.params, this.form.baseParams); }, + /** - * Implements abstract Ext.data.DataWriter#destroyRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Object} + * @private + * Creates a callback object. */ - destroyRecord : function(rec){ - if(this.encodeDelete){ - var data = {}; - data[this.meta.idProperty] = rec.id; - return data; - }else{ - return rec.id; - } + createCallback: function() { + var me = this, + undef, + form = me.form; + return { + success: me.onSuccess, + failure: me.onFailure, + scope: me, + timeout: (this.timeout * 1000) || (form.timeout * 1000), + upload: form.fileUpload ? me.onSuccess : undef + }; + }, + + statics: { + /** + * @property CLIENT_INVALID + * Failure type returned when client side validation of the Form fails + * thus aborting a submit action. Client side validation is performed unless + * {@link Ext.form.action.Submit#clientValidation} is explicitly set to false. + * @type {String} + * @static + */ + CLIENT_INVALID: 'client', + + /** + * @property SERVER_INVALID + *-{id: 1} - *
Failure type returned when server side processing fails and the {@link #result}'s + * success property is set to false.
+ *In the case of a form submission, field-specific error messages may be returned in the + * {@link #result}'s errors property.
+ * @type {String} + * @static + */ + SERVER_INVALID: 'server', + + /** + * @property CONNECT_FAILURE + * Failure type returned when a communication error happens when attempting + * to send a request to the remote server. The {@link #response} may be examined to + * provide further information. + * @type {String} + * @static + */ + CONNECT_FAILURE: 'connect', + + /** + * @property LOAD_FAILURE + * Failure type returned when the response's success + * property is set to false, or no field values are returned in the response's + * data property. + * @type {String} + * @static + */ + LOAD_FAILURE: 'load' + + } -});/** - * @class Ext.data.JsonReader - * @extends Ext.data.DataReader - *Data reader class to create an Array of {@link Ext.data.Record} objects - * from a JSON packet based on mappings in a provided {@link Ext.data.Record} - * constructor.
- *Example code:
- *- *-var myReader = new Ext.data.JsonReader({ - // metadata configuration options: - {@link #idProperty}: 'id' - {@link #root}: 'rows', - {@link #totalProperty}: 'results', - {@link Ext.data.DataReader#messageProperty}: "msg" // The element within the response that provides a user-feedback message (optional) - - // the fields config option will internally create an {@link Ext.data.Record} - // constructor that provides mapping for reading the record data objects - {@link Ext.data.DataReader#fields fields}: [ - // map Record's 'firstname' field to data object's key of same name - {name: 'name'}, - // map Record's 'job' field to data object's 'occupation' key - {name: 'job', mapping: 'occupation'} - ] }); -
This would consume a JSON data object of the form:
+ +/** + * @class Ext.form.action.Submit + * @extends Ext.form.action.Action + *
A class which handles submission of data from {@link Ext.form.Basic Form}s + * and processes the returned response.
+ *Instances of this class are only created by a {@link Ext.form.Basic Form} when + * {@link Ext.form.Basic#submit submit}ting.
+ *Response Packet Criteria
+ *A response packet may contain: + *
+ *
', + '' + ], + /** - * @cfg {String} documentRoot [xrequest] (Optional) The name of the XML document root-node. Note: - * this parameter is required only when sending extra {@link Ext.data.Store#baseParams baseParams} to the server - * during a write-request -- if no baseParams are set, the {@link Ext.data.XmlReader#record} meta-property can - * suffice as the XML document root-node for write-actions involving just a single record. For requests - * involving multiple records and NO baseParams, the {@link Ext.data.XmlWriter#root} property can - * act as the XML document root. + * @property isFieldLabelable + * @type Boolean + * Flag denoting that this object is labelable as a field. Always true. */ - documentRoot: 'xrequest', + isFieldLabelable: true, + /** - * @cfg {Boolean} forceDocumentRoot [false] Set to true to force XML documents having a root-node as defined - * by {@link #documentRoot}, even with no baseParams defined. + * @cfg {String} formItemCls + * A CSS class to be applied to the outermost element to denote that it is participating in the form + * field layout. Defaults to 'x-form-item'. */ - forceDocumentRoot: false, + formItemCls: Ext.baseCSSPrefix + 'form-item', + /** - * @cfg {String} root [records] The name of the containing element which will contain the nodes of an write-action involving multiple records. Each - * xml-record written to the server will be wrapped in an element named after {@link Ext.data.XmlReader#record} property. - * eg: -- + *
success
property : Boolean + *Thesuccess
property is required.errors
property : Object + *+ *The+ *errors
property, + * which is optional, contains error messages for invalid fields.JSON Packets
+ *By default, response packets are assumed to be JSON, so a typical response + * packet may look like this:
+ *{ - results: 2000, // Reader's configured {@link #totalProperty} - rows: [ // Reader's configured {@link #root} - // record data objects: - { {@link #idProperty id}: 1, firstname: 'Bill', occupation: 'Gardener' }, - { {@link #idProperty id}: 2, firstname: 'Ben' , occupation: 'Horticulturalist' }, - ... - ] -} + success: false, + errors: { + clientCode: "Client not found", + portOfLoading: "This field must not be null" + } +}
Other data may be placed into the response for processing by the {@link Ext.form.Basic}'s callback + * or event handler methods. The object decoded from this JSON is available in the + * {@link Ext.form.action.Action#result result} property.
+ *Alternatively, if an {@link #errorReader} is specified as an {@link Ext.data.reader.Xml XmlReader}:
- *+ errorReader: new Ext.data.reader.Xml({ + record : 'field', + success: '@success' + }, [ + 'id', 'msg' + ] + )
Automatic configuration using metaData
- *It is possible to change a JsonReader's metadata at any time by including - * a metaData property in the JSON data object. If the JSON data - * object has a metaData property, a {@link Ext.data.Store Store} - * object using this Reader will reconfigure itself to use the newly provided - * field definition and fire its {@link Ext.data.Store#metachange metachange} - * event. The metachange event handler may interrogate the metaData - * property to perform any configuration required.
- *Note that reconfiguring a Store potentially invalidates objects which may - * refer to Fields or Records which no longer exist.
- *To use this facility you would create the JsonReader like this:
-var myReader = new Ext.data.JsonReader(); + *
then the results may be sent back in XML format:
- *+<?xml version="1.0" encoding="UTF-8"?> +<message success="false"> +<errors> + <field> + <id>clientCode</id> + <msg><![CDATA[Code not found. <br /><i>This is a test validation message from the server </i>]]></msg> + </field> + <field> + <id>portOfLoading</id> + <msg><![CDATA[Port not found. <br /><i>This is a test validation message from the server </i>]]></msg> + </field> +</errors> +</message>
The first data packet from the server would configure the reader by - * containing a metaData property and the data. For - * example, the JSON data object might take the form:
- *-{ - metaData: { - "{@link #idProperty}": "id", - "{@link #root}": "rows", - "{@link #totalProperty}": "results" - "{@link #successProperty}": "success", - "{@link Ext.data.DataReader#fields fields}": [ - {"name": "name"}, - {"name": "job", "mapping": "occupation"} - ], - // used by store to set its sortInfo - "sortInfo":{ - "field": "name", - "direction": "ASC" - }, - // {@link Ext.PagingToolbar paging data} (if applicable) - "start": 0, - "limit": 2, - // custom property - "foo": "bar" - }, - // Reader's configured {@link #successProperty} - "success": true, - // Reader's configured {@link #totalProperty} - "results": 2000, - // Reader's configured {@link #root} - // (this data simulates 2 results {@link Ext.PagingToolbar per page}) - "rows": [ // *Note: this must be an Array - { "id": 1, "name": "Bill", "occupation": "Gardener" }, - { "id": 2, "name": "Ben", "occupation": "Horticulturalist" } - ] -} - *
The metaData property in the JSON data object should contain:
- *- * - * @constructor - * Create a new JsonReader - * @param {Object} meta Metadata configuration options. - * @param {Array/Object} recordType - *- *
- any of the configuration options for this class
- *- a {@link Ext.data.Record#fields fields} property which - * the JsonReader will use as an argument to the - * {@link Ext.data.Record#create data Record create method} in order to - * configure the layout of the Records it will produce.
- *- a {@link Ext.data.Store#sortInfo sortInfo} property - * which the JsonReader will use to set the {@link Ext.data.Store}'s - * {@link Ext.data.Store#sortInfo sortInfo} property
- *- any custom properties needed
- *Either an Array of {@link Ext.data.Field Field} definition objects (which - * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record} - * constructor created from {@link Ext.data.Record#create}.
+ *Other elements may be placed into the response XML for processing by the {@link Ext.form.Basic}'s callback + * or event handler methods. The XML document is available in the {@link #errorReader}'s {@link Ext.data.reader.Xml#xmlData xmlData} property.
*/ -Ext.data.JsonReader = function(meta, recordType){ - meta = meta || {}; - /** - * @cfg {String} idProperty [id] Name of the property within a row object - * that contains a record identifier value. Defaults to id - */ - /** - * @cfg {String} successProperty [success] Name of the property from which to - * retrieve the success attribute. Defaults to success. See - * {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception} - * for additional information. - */ - /** - * @cfg {String} totalProperty [total] Name of the property from which to - * retrieve the total number of records in the dataset. This is only needed - * if the whole dataset is not passed in one go, but is being paged from - * the remote server. Defaults to total. - */ - /** - * @cfg {String} root [undefined] Required. The name of the property - * which contains the Array of row objects. Defaults to undefined. - * An exception will be thrown if the root property is undefined. The data - * packet value for this property should be an empty array to clear the data - * or show no data. - */ - Ext.applyIf(meta, { - idProperty: 'id', - successProperty: 'success', - totalProperty: 'total' - }); +Ext.define('Ext.form.action.Submit', { + extend:'Ext.form.action.Action', + alternateClassName: 'Ext.form.Action.Submit', + alias: 'formaction.submit', + + type: 'submit', - Ext.data.JsonReader.superclass.constructor.call(this, meta, recordType || meta.fields); -}; -Ext.extend(Ext.data.JsonReader, Ext.data.DataReader, { - /** - * This JsonReader's metadata as passed to the constructor, or as passed in - * the last data packet's metaData property. - * @type Mixed - * @property meta - */ /** - * This method is only used by a DataProxy which has retrieved data from a remote server. - * @param {Object} response The XHR object which contains the JSON data in its responseText. - * @return {Object} data A data block which is used by an Ext.data.Store object as - * a cache of Ext.data.Records. + * @cfg {boolean} clientValidation Determines whether a Form's fields are validated + * in a final call to {@link Ext.form.Basic#isValid isValid} prior to submission. + * Pass false in the Form's submit options to prevent this. Defaults to true. */ - read : function(response){ - var json = response.responseText; - var o = Ext.decode(json); - if(!o) { - throw {message: 'JsonReader.read: Json object not found'}; + + // inherit docs + run : function(){ + var form = this.form; + if (this.clientValidation === false || form.isValid()) { + this.doSubmit(); + } else { + // client validation failed + this.failureType = Ext.form.action.Action.CLIENT_INVALID; + form.afterAction(this, false); } - return this.readRecords(o); }, - /* - * TODO: refactor code between JsonReader#readRecords, #readResponse into 1 method. - * there's ugly duplication going on due to maintaining backwards compat. with 2.0. It's time to do this. - */ /** - * Decode a JSON response from server. - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} response The XHR object returned through an Ajax server request. - * @return {Response} A {@link Ext.data.Response Response} object containing the data response, and also status information. - */ - readResponse : function(action, response) { - var o = (response.responseText !== undefined) ? Ext.decode(response.responseText) : response; - if(!o) { - throw new Ext.data.JsonReader.Error('response'); - } + * @private + * Perform the submit of the form data. + */ + doSubmit: function() { + var formEl, + ajaxOptions = Ext.apply(this.createCallback(), { + url: this.getUrl(), + method: this.getMethod(), + headers: this.headers + }); - var root = this.getRoot(o); - if (action === Ext.data.Api.actions.create) { - var def = Ext.isDefined(root); - if (def && Ext.isEmpty(root)) { - throw new Ext.data.JsonReader.Error('root-empty', this.meta.root); - } - else if (!def) { - throw new Ext.data.JsonReader.Error('root-undefined-response', this.meta.root); - } + // For uploads we need to create an actual form that contains the file upload fields, + // and pass that to the ajax call so it can do its iframe-based submit method. + if (this.form.hasUpload()) { + formEl = ajaxOptions.form = this.buildForm(); + ajaxOptions.isUpload = true; + } else { + ajaxOptions.params = this.getParams(); } - // instantiate response object - var res = new Ext.data.Response({ - action: action, - success: this.getSuccess(o), - data: (root) ? this.extractData(root, false) : [], - message: this.getMessage(o), - raw: o - }); + Ext.Ajax.request(ajaxOptions); - // blow up if no successProperty - if (Ext.isEmpty(res.success)) { - throw new Ext.data.JsonReader.Error('successProperty-response', this.meta.successProperty); + if (formEl) { + Ext.removeNode(formEl); } - return res; }, /** - * Create a data block containing Ext.data.Records from a JSON object. - * @param {Object} o An object which contains an Array of row objects in the property specified - * in the config as 'root, and optionally a property, specified in the config as 'totalProperty' - * which contains the total size of the dataset. - * @return {Object} data A data block which is used by an Ext.data.Store object as - * a cache of Ext.data.Records. + * @private + * Build the full set of parameters from the field values plus any additional configured params. */ - readRecords : function(o){ - /** - * After any data loads, the raw JSON data is available for further custom processing. If no data is - * loaded or there is a load exception this property will be undefined. - * @type Object - */ - this.jsonData = o; - if(o.metaData){ - this.onMetaChange(o.metaData); - } - var s = this.meta, Record = this.recordType, - f = Record.prototype.fields, fi = f.items, fl = f.length, v; + getParams: function() { + var nope = false, + configParams = this.callParent(), + fieldParams = this.form.getValues(nope, nope, this.submitEmptyText !== nope); + return Ext.apply({}, fieldParams, configParams); + }, - var root = this.getRoot(o), c = root.length, totalRecords = c, success = true; - if(s.totalProperty){ - v = parseInt(this.getTotal(o), 10); - if(!isNaN(v)){ - totalRecords = v; + /** + * @private + * Build a form element containing fields corresponding to all the parameters to be + * submitted (everything returned by {@link #getParams}. + * NOTE: the form element is automatically added to the DOM, so any code that uses + * it must remove it from the DOM after finishing with it. + * @return HTMLFormElement + */ + buildForm: function() { + var fieldsSpec = [], + formSpec, + formEl, + basicForm = this.form, + params = this.getParams(), + uploadFields = []; + + basicForm.getFields().each(function(field) { + if (field.isFileUpload()) { + uploadFields.push(field); } + }); + + function addField(name, val) { + fieldsSpec.push({ + tag: 'input', + type: 'hidden', + name: name, + value: Ext.String.htmlEncode(val) + }); } - if(s.successProperty){ - v = this.getSuccess(o); - if(v === false || v === 'false'){ - success = false; + + // Add the form field values + Ext.iterate(params, function(key, val) { + if (Ext.isArray(val)) { + Ext.each(val, function(v) { + addField(key, v); + }); + } else { + addField(key, val); } - } + }); - // TODO return Ext.data.Response instance instead. @see #readResponse - return { - success : success, - records : this.extractData(root, true), // <-- true to return [Ext.data.Record] - totalRecords : totalRecords + formSpec = { + tag: 'form', + action: this.getUrl(), + method: this.getMethod(), + target: this.target || '_self', + style: 'display:none', + cn: fieldsSpec }; - }, - // private - buildExtractors : function() { - if(this.ef){ - return; + // Set the proper encoding for file uploads + if (uploadFields.length) { + formSpec.encoding = formSpec.enctype = 'multipart/form-data'; } - var s = this.meta, Record = this.recordType, - f = Record.prototype.fields, fi = f.items, fl = f.length; - if(s.totalProperty) { - this.getTotal = this.createAccessor(s.totalProperty); - } - if(s.successProperty) { - this.getSuccess = this.createAccessor(s.successProperty); - } - if (s.messageProperty) { - this.getMessage = this.createAccessor(s.messageProperty); - } - this.getRoot = s.root ? this.createAccessor(s.root) : function(p){return p;}; - if (s.id || s.idProperty) { - var g = this.createAccessor(s.id || s.idProperty); - this.getId = function(rec) { - var r = g(rec); - return (r === undefined || r === '') ? null : r; - }; - } else { - this.getId = function(){return null;}; - } - var ef = []; - for(var i = 0; i < fl; i++){ - f = fi[i]; - var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name; - ef.push(this.createAccessor(map)); - } - this.ef = ef; + // Create the form + formEl = Ext.core.DomHelper.append(Ext.getBody(), formSpec); + + // Special handling for file upload fields: since browser security measures prevent setting + // their values programatically, and prevent carrying their selected values over when cloning, + // we have to move the actual field instances out of their components and into the form. + Ext.Array.each(uploadFields, function(field) { + if (field.rendered) { // can only have a selected file value after being rendered + formEl.appendChild(field.extractFileInput()); + } + }); + + return formEl; }, + + /** - * @ignore - * TODO This isn't used anywhere?? Don't we want to use this where possible instead of complex #createAccessor? + * @private */ - simpleAccess : function(obj, subsc) { - return obj[subsc]; + onSuccess: function(response) { + var form = this.form, + success = true, + result = this.processResponse(response); + if (result !== true && !result.success) { + if (result.errors) { + form.markInvalid(result.errors); + } + this.failureType = Ext.form.action.Action.SERVER_INVALID; + success = false; + } + form.afterAction(this, success); }, /** - * @ignore + * @private */ - createAccessor : function(){ - var re = /[\[\.]/; - return function(expr) { - if(Ext.isEmpty(expr)){ - return Ext.emptyFn; - } - if(Ext.isFunction(expr)){ - return expr; + handleResponse: function(response) { + var form = this.form, + errorReader = form.errorReader, + rs, errors, i, len, records; + if (errorReader) { + rs = errorReader.read(response); + records = rs.records; + errors = []; + if (records) { + for(i = 0, len = records.length; i < len; i++) { + errors[i] = records[i].data; + } } - var i = String(expr).search(re); - if(i >= 0){ - return new Function('obj', 'return obj' + (i > 0 ? '.' : '') + expr); + if (errors.length < 1) { + errors = null; } - return function(obj){ - return obj[expr]; + return { + success : rs.success, + errors : errors }; - - }; - }(), - - /** - * type-casts a single row of raw-data from server - * @param {Object} data - * @param {Array} items - * @param {Integer} len - * @private - */ - extractValues : function(data, items, len) { - var f, values = {}; - for(var j = 0; j < len; j++){ - f = items[j]; - var v = this.ef[j](data); - values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue, data); } - return values; + return Ext.decode(response.responseText); } }); /** - * @class Ext.data.JsonReader.Error - * Error class for JsonReader - */ -Ext.data.JsonReader.Error = Ext.extend(Ext.Error, { - constructor : function(message, arg) { - this.arg = arg; - Ext.Error.call(this, message); - }, - name : 'Ext.data.JsonReader' -}); -Ext.apply(Ext.data.JsonReader.Error.prototype, { - lang: { - 'response': 'An error occurred while json-decoding your server response', - 'successProperty-response': 'Could not locate your "successProperty" in your server response. Please review your JsonReader config to ensure the config-property "successProperty" matches the property in your server-response. See the JsonReader docs.', - 'root-undefined-config': 'Your JsonReader was configured without a "root" property. Please review your JsonReader config and make sure to define the root property. See the JsonReader docs.', - 'idProperty-undefined' : 'Your JsonReader was configured without an "idProperty" Please review your JsonReader configuration and ensure the "idProperty" is set (e.g.: "id"). See the JsonReader docs.', - 'root-empty': 'Data was expected to be returned by the server in the "root" property of the response. Please review your JsonReader configuration to ensure the "root" property matches that returned in the server-response. See JsonReader docs.' - } -}); -/** - * @class Ext.data.ArrayReader - * @extends Ext.data.JsonReader - *Data reader class to create an Array of {@link Ext.data.Record} objects from an Array. - * Each element of that Array represents a row of data fields. The - * fields are pulled into a Record object using as a subscript, the
- *mapping
property - * of the field definition if it exists, or the field's ordinal position in the definition.Example code:
- *- *-var Employee = Ext.data.Record.create([ - {name: 'name', mapping: 1}, // "mapping" only needed if an "id" field is present which - {name: 'occupation', mapping: 2} // precludes using the ordinal position as the index. -]); -var myReader = new Ext.data.ArrayReader({ - {@link #idIndex}: 0 -}, Employee); -
This would consume an Array like this:
- *- * @constructor - * Create a new ArrayReader - * @param {Object} meta Metadata configuration options. - * @param {Array/Object} recordType - *-[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ] - *
Either an Array of {@link Ext.data.Field Field} definition objects (which - * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record} - * constructor created from {@link Ext.data.Record#create}.
+ * @class Ext.util.ComponentDragger + * @extends Ext.dd.DragTracker + *A subclass of Ext.dd.DragTracker which handles dragging any Component.
+ *This is configured with a Component to be made draggable, and a config object for the + * {@link Ext.dd.DragTracker} class.
+ *A {@link #} delegate may be provided which may be either the element to use as the mousedown target + * or a {@link Ext.DomQuery} selector to activate multiple mousedown targets.
*/ -Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, { +Ext.define('Ext.util.ComponentDragger', { + /** - * @cfg {String} successProperty - * @hide + * @cfg {Boolean} constrain + * Specify astrue
to constrain the Component to within the bounds of the {@link #constrainTo} region. */ + /** - * @cfg {Number} id (optional) The subscript within row Array that provides an ID for the Record. - * Deprecated. Use {@link #idIndex} instead. + * @cfg {String/Element} delegate + * Optional.A {@link Ext.DomQuery DomQuery} selector which identifies child elements within the Component's encapsulating + * Element which are the drag handles. This limits dragging to only begin when the matching elements are mousedowned.
+ *This may also be a specific child element within the Component's encapsulating element to use as the drag handle.
*/ + /** - * @cfg {Number} idIndex (optional) The subscript within row Array that provides an ID for the Record. + * @cfg {Boolean} constrainDelegate + * Specify astrue
to constrain the drag handles within the {@link #constrainTo} region. */ + + extend: 'Ext.dd.DragTracker', + + autoStart: 500, + /** - * Create a data block containing Ext.data.Records from an Array. - * @param {Object} o An Array of row objects which represents the dataset. - * @return {Object} data A data block which is used by an Ext.data.Store object as - * a cache of Ext.data.Records. + * Creates new ComponentDragger. + * @param {object} comp The Component to provide dragging for. + * @param {object} config (optional) Config object */ - readRecords : function(o){ - this.arrayData = o; - var s = this.meta, - sid = s ? Ext.num(s.idIndex, s.id) : null, - recordType = this.recordType, - fields = recordType.prototype.fields, - records = [], - success = true, - v; + constructor: function(comp, config) { + this.comp = comp; + this.initialConstrainTo = config.constrainTo; + this.callParent([ config ]); + }, + + onStart: function(e) { + var me = this, + comp = me.comp; - var root = this.getRoot(o); + // Cache the start [X, Y] array + this.startPosition = comp.getPosition(); - for(var i = 0, len = root.length; i < len; i++) { - var n = root[i], - values = {}, - id = ((sid || sid === 0) && n[sid] !== undefined && n[sid] !== "" ? n[sid] : null); - for(var j = 0, jlen = fields.length; j < jlen; j++) { - var f = fields.items[j], - k = f.mapping !== undefined && f.mapping !== null ? f.mapping : j; - v = n[k] !== undefined ? n[k] : f.defaultValue; - v = f.convert(v, n); - values[f.name] = v; - } - var record = new recordType(values, id); - record.json = n; - records[records.length] = record; + // If client Component has a ghost method to show a lightweight version of itself + // then use that as a drag proxy unless configured to liveDrag. + if (comp.ghost && !comp.liveDrag) { + me.proxy = comp.ghost(); + me.dragTarget = me.proxy.header.el; } - var totalRecords = records.length; - - if(s.totalProperty) { - v = parseInt(this.getTotal(o), 10); - if(!isNaN(v)) { - totalRecords = v; - } + // Set the constrainTo Region before we start dragging. + if (me.constrain || me.constrainDelegate) { + me.constrainTo = me.calculateConstrainRegion(); } - if(s.successProperty){ - v = this.getSuccess(o); - if(v === false || v === 'false'){ - success = false; - } + }, + + calculateConstrainRegion: function() { + var me = this, + comp = me.comp, + c = me.initialConstrainTo, + delegateRegion, + elRegion, + shadowSize = comp.el.shadow ? comp.el.shadow.offset : 0; + + // The configured constrainTo might be a Region or an element + if (!(c instanceof Ext.util.Region)) { + c = Ext.fly(c).getViewRegion(); + } + + // Reduce the constrain region to allow for shadow + if (shadowSize) { + c.adjust(0, -shadowSize, -shadowSize, shadowSize); + } + + // If they only want to constrain the *delegate* to within the constrain region, + // adjust the region to be larger based on the insets of the delegate from the outer + // edges of the Component. + if (!me.constrainDelegate) { + delegateRegion = Ext.fly(me.dragTarget).getRegion(); + elRegion = me.proxy ? me.proxy.el.getRegion() : comp.el.getRegion(); + + c.adjust( + delegateRegion.top - elRegion.top, + delegateRegion.right - elRegion.right, + delegateRegion.bottom - elRegion.bottom, + delegateRegion.left - elRegion.left + ); } + return c; + }, - return { - success : success, - records : records, - totalRecords : totalRecords - }; - } -});/** - * @class Ext.data.ArrayStore - * @extends Ext.data.Store - *Formerly known as "SimpleStore".
- *Small helper class to make creating {@link Ext.data.Store}s from Array data easier. - * An ArrayStore will be automatically configured with a {@link Ext.data.ArrayReader}.
- *A store configuration would be something like:
- *-var store = new Ext.data.ArrayStore({ - // store configs - autoDestroy: true, - storeId: 'myStore', - // reader configs - idIndex: 0, - fields: [ - 'company', - {name: 'price', type: 'float'}, - {name: 'change', type: 'float'}, - {name: 'pctChange', type: 'float'}, - {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'} - ] -}); - *
This store is configured to consume a returned object of the form:
- * An object literal of this form could also be used as the {@link #data} config option. - *-var myData = [ - ['3m Co',71.72,0.02,0.03,'9/1 12:00am'], - ['Alcoa Inc',29.01,0.42,1.47,'9/1 12:00am'], - ['Boeing Co.',75.43,0.53,0.71,'9/1 12:00am'], - ['Hewlett-Packard Co.',36.53,-0.03,-0.08,'9/1 12:00am'], - ['Wal-Mart Stores, Inc.',45.45,0.73,1.63,'9/1 12:00am'] -]; - *
*Note: Although not listed here, this class accepts all of the configuration options of - * {@link Ext.data.ArrayReader ArrayReader}.
- * @constructor - * @param {Object} config - * @xtype arraystore - */ -Ext.data.ArrayStore = Ext.extend(Ext.data.Store, { - /** - * @cfg {Ext.data.DataReader} reader @hide - */ - constructor: function(config){ - Ext.data.ArrayStore.superclass.constructor.call(this, Ext.apply(config, { - reader: new Ext.data.ArrayReader(config) - })); + // Move either the ghost Component or the target Component to its new position on drag + onDrag: function(e) { + var me = this, + comp = (me.proxy && !me.comp.liveDrag) ? me.proxy : me.comp, + offset = me.getOffset(me.constrain || me.constrainDelegate ? 'dragTarget' : null); + + comp.setPosition(me.startPosition[0] + offset[0], me.startPosition[1] + offset[1]); }, - loadData : function(data, append){ - if(this.expandData === true){ - var r = []; - for(var i = 0, len = data.length; i < len; i++){ - r[r.length] = [data[i]]; - } - data = r; + onEnd: function(e) { + if (this.proxy && !this.comp.liveDrag) { + this.comp.unghost(); } - Ext.data.ArrayStore.superclass.loadData.call(this, data, append); } }); -Ext.reg('arraystore', Ext.data.ArrayStore); +/** + * @class Ext.form.Labelable -// backwards compat -Ext.data.SimpleStore = Ext.data.ArrayStore; -Ext.reg('simplestore', Ext.data.SimpleStore);/** - * @class Ext.data.JsonStore - * @extends Ext.data.Store - *Small helper class to make creating {@link Ext.data.Store}s from JSON data easier. - * A JsonStore will be automatically configured with a {@link Ext.data.JsonReader}.
- *A store configuration would be something like:
- *-var store = new Ext.data.JsonStore({ - // store configs - autoDestroy: true, - url: 'get-images.php', - storeId: 'myStore', - // reader configs - root: 'images', - idProperty: 'name', - fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}] -}); - *
This store is configured to consume a returned object of the form:
- * An object literal of this form could also be used as the {@link #data} config option. - *-{ - images: [ - {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)}, - {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)} - ] -} - *
*Note: Although not listed here, this class accepts all of the configuration options of - * {@link Ext.data.JsonReader JsonReader}.
- * @constructor - * @param {Object} config - * @xtype jsonstore +A mixin which allows a component to be configured and decorated with a label and/or error message as is +common for form fields. This is used by e.g. {@link Ext.form.field.Base} and {@link Ext.form.FieldContainer} +to let them be managed by the Field layout. + +**NOTE**: This mixin is mainly for internal library 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.form.field.Base} or {@link Ext.form.FieldContainer}. + +Use of this mixin does not make a component a field in the logical sense, meaning it does not provide any +logic or state related to values or validation; that is handled by the related {@link Ext.form.field.Field} +mixin. These two mixins may be used separately (for example {@link Ext.form.FieldContainer} is Labelable but not a +Field), or in combination (for example {@link Ext.form.field.Base} implements both and has logic for connecting the +two.) + +Component classes which use this mixin should use the Field layout +or a derivation thereof to properly size and position the label and message according to the component config. +They must also call the {@link #initLabelable} method during component initialization to ensure the mixin gets +set up correctly. + + * @markdown + * @docauthor Jason Johnston*/ -Ext.data.JsonStore = Ext.extend(Ext.data.Store, { +Ext.define("Ext.form.Labelable", { + requires: ['Ext.XTemplate'], + + /** + * @cfg {Array/String/Ext.XTemplate} labelableRenderTpl + * The rendering template for the field decorations. Component classes using this mixin should include + * logic to use this as their {@link Ext.AbstractComponent#renderTpl renderTpl}, and implement the + * {@link #getSubTplMarkup} method to generate the field body content. + */ + labelableRenderTpl: [ + ' ', + ' class="{labelCls}"style="{labelStyle}" >', + '{fieldLabel}{labelSeparator} ', + '', + '', + 'id="{baseBodyCls}-{inputId}" role="presentation">{subTplMarkup}', + '', + '', + { + compiled: true, + disableFormats: true + } + ], + /** - * @cfg {Ext.data.DataReader} reader @hide + * @cfg {Ext.XTemplate} activeErrorsTpl + * The template used to format the Array of error messages passed to {@link #setActiveErrors} + * into a single HTML string. By default this renders each message as an item in an unordered list. */ - constructor: function(config){ - Ext.data.JsonStore.superclass.constructor.call(this, Ext.apply(config, { - reader: new Ext.data.JsonReader(config) - })); - } -}); -Ext.reg('jsonstore', Ext.data.JsonStore);/** - * @class Ext.data.XmlWriter - * @extends Ext.data.DataWriter - * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action via XML. - * XmlWriter uses an instance of {@link Ext.XTemplate} for maximum flexibility in defining your own custom XML schema if the default schema is not appropriate for your needs. - * See the {@link #tpl} configuration-property. - */ -Ext.data.XmlWriter = function(params) { - Ext.data.XmlWriter.superclass.constructor.apply(this, arguments); - // compile the XTemplate for rendering XML documents. - this.tpl = (typeof(this.tpl) === 'string') ? new Ext.XTemplate(this.tpl).compile() : this.tpl.compile(); -}; -Ext.extend(Ext.data.XmlWriter, Ext.data.DataWriter, { + activeErrorsTpl: [ + '', + '
>{.} - class="last"
- * However, when multiple records are written in a batch-operation, these records must be wrapped in a containing - * Element. - * eg: -
-<?xml version="1.0" encoding="UTF-8"?> -<user><first>Barney</first></user> -- * Defaults to records. Do not confuse the nature of this property with that of {@link #documentRoot} + * @cfg {String} labelCls + * The CSS class to be applied to the label element. Defaults to 'x-form-item-label'. */ - root: 'records', + labelCls: Ext.baseCSSPrefix + 'form-item-label', + /** - * @cfg {String} xmlVersion [1.0] The version written to header of xml documents. -
-<?xml version="1.0" encoding="UTF-8"?> - <records> - <first>Barney</first></user> - <records><first>Barney</first></user> - </records> -+ * @cfg {String} errorMsgCls + * The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'. */ - xmlVersion : '1.0', + errorMsgCls: Ext.baseCSSPrefix + 'form-error-msg', + /** - * @cfg {String} xmlEncoding [ISO-8859-15] The encoding written to header of xml documents. -
<?xml version="1.0" encoding="ISO-8859-15"?>+ * @cfg {String} baseBodyCls + * The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'. */ - xmlEncoding: 'ISO-8859-15', + baseBodyCls: Ext.baseCSSPrefix + 'form-item-body', + /** - * @cfg {String/Ext.XTemplate} tpl The XML template used to render {@link Ext.data.Api#actions write-actions} to your server. - *
<?xml version="1.0" encoding="ISO-8859-15"?>One can easily provide his/her own custom {@link Ext.XTemplate#constructor template-definition} if the default does not suffice.
- *Defaults to:
-- *
-<?xml version="{version}" encoding="{encoding}"?> - <tpl if="documentRoot"><{documentRoot}> - <tpl for="baseParams"> - <tpl for="."> - <{name}>{value}</{name}> - </tpl> - </tpl> - <tpl if="records.length > 1"><{root}>', - <tpl for="records"> - <{parent.record}> - <tpl for="."> - <{name}>{value}</{name}> - </tpl> - </{parent.record}> - </tpl> - <tpl if="records.length > 1"></{root}></tpl> - <tpl if="documentRoot"></{documentRoot}></tpl> -Templates will be called with the following API
+ * @cfg {String} fieldBodyCls + * An extra CSS class to be applied to the body content element in addition to {@link #fieldBodyCls}. + * Defaults to empty. + */ + fieldBodyCls: '', + + /** + * @cfg {String} clearCls + * The CSS class to be applied to the special clearing div rendered directly after the field + * contents wrapper to provide field clearing (defaults to 'x-clear'). + */ + clearCls: Ext.baseCSSPrefix + 'clear', + + /** + * @cfg {String} invalidCls + * The CSS class to use when marking the component invalid (defaults to 'x-form-invalid') + */ + invalidCls : Ext.baseCSSPrefix + 'form-invalid', + + /** + * @cfg {String} fieldLabel + * The label for the field. It gets appended with the {@link #labelSeparator}, and its position + * and sizing is determined by the {@link #labelAlign}, {@link #labelWidth}, and {@link #labelPad} + * configs. Defaults to undefined. + */ + fieldLabel: undefined, + + /** + * @cfg {String} labelAlign + *Controls the position and alignment of the {@link #fieldLabel}. Valid values are:
*- *
*/ - // Encoding the ? here in case it's being included by some kind of page that will parse it (eg. PHP) - tpl: '- {String} version [1.0] The xml version.
- *- {String} encoding [ISO-8859-15] The xml encoding.
- *- {String/false} documentRoot The XML document root-node name or false if not required. See {@link #documentRoot} and {@link #forceDocumentRoot}.
- *- {String} record The meta-data parameter defined on your {@link Ext.data.XmlReader#record} configuration represents the name of the xml-tag containing each record.
- *- {String} root The meta-data parameter defined by {@link Ext.data.XmlWriter#root} configuration-parameter. Represents the name of the xml root-tag when sending multiple records to the server.
- *- {Array} records The records being sent to the server, ie: the subject of the write-action being performed. The records parameter will be always be an array, even when only a single record is being acted upon. - * Each item within the records array will contain an array of field objects having the following properties: - *
- *- *
- {String} name The field-name of the record as defined by your {@link Ext.data.Record#create Ext.data.Record definition}. The "mapping" property will be used, otherwise it will match the "name" property. Use this parameter to define the XML tag-name of the property.
- *- {Mixed} value The record value of the field enclosed within XML tags specified by name property above.
- *- {Array} baseParams. The baseParams as defined upon {@link Ext.data.Store#baseParams}. Note that the baseParams have been converted into an array of [{name : "foo", value: "bar"}, ...] pairs in the same manner as the records parameter above. See {@link #documentRoot} and {@link #forceDocumentRoot}.
+ *- "left" (the default) - The label is positioned to the left of the field, with its text + * aligned to the left. Its width is determined by the {@link #labelWidth} config.
+ *- "top" - The label is positioned above the field.
+ *- "right" - The label is positioned to the left of the field, with its text aligned + * to the right. Its width is determined by the {@link #labelWidth} config.
*<\u003fxml version="{version}" encoding="{encoding}"\u003f> ', + labelAlign : 'left', + /** + * @cfg {Number} labelWidth + * The width of the {@link #fieldLabel} in pixels. Only applicable if the {@link #labelAlign} is set + * to "left" or "right". Defaults to 100. + */ + labelWidth: 100, /** - * XmlWriter implementation of the final stage of a write action. - * @param {Object} params Transport-proxy's (eg: {@link Ext.Ajax#request}) params-object to write-to. - * @param {Object} baseParams as defined by {@link Ext.data.Store#baseParams}. The baseParms must be encoded by the extending class, eg: {@link Ext.data.JsonWriter}, {@link Ext.data.XmlWriter}. - * @param {Object/Object[]} data Data-object representing the compiled Store-recordset. + * @cfg {Number} labelPad + * The amount of space in pixels between the {@link #fieldLabel} and the input field. Defaults to 5. */ - render : function(params, baseParams, data) { - baseParams = this.toArray(baseParams); - params.xmlData = this.tpl.applyTemplate({ - version: this.xmlVersion, - encoding: this.xmlEncoding, - documentRoot: (baseParams.length > 0 || this.forceDocumentRoot === true) ? this.documentRoot : false, - record: this.meta.record, - root: this.root, - baseParams: baseParams, - records: (Ext.isArray(data[0])) ? data : [data] - }); - }, + labelPad : 5, /** - * createRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Array} Array of name:value pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}. + * @cfg {String} labelSeparator + * Character(s) to be inserted at the end of the {@link #fieldLabel label text}. */ - createRecord : function(rec) { - return this.toArray(this.toHash(rec)); - }, + labelSeparator : ':', /** - * updateRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Array} Array of {name:value} pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}. + * @cfg {String} labelStyle + *<{documentRoot}> <{name}>{value}{name} <{root}> <{parent.record}> <{name}>{value}{name}> {parent.record}>{root}> {documentRoot}> A CSS style specification string to apply directly to this field's label. Defaults to undefined.
*/ - updateRecord : function(rec) { - return this.toArray(this.toHash(rec)); - }, /** - * destroyRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Array} Array containing a attribute-object (name/value pair) representing the {@link Ext.data.DataReader#idProperty idProperty}. + * @cfg {Boolean} hideLabel + *Set to true to completely hide the label element ({@link #fieldLabel} and {@link #labelSeparator}). + * Defaults to false.
+ *Also see {@link #hideEmptyLabel}, which controls whether space will be reserved for an empty fieldLabel.
*/ - destroyRecord : function(rec) { - var data = {}; - data[this.meta.idProperty] = rec.id; - return this.toArray(data); - } -}); -/** - * @class Ext.data.XmlReader - * @extends Ext.data.DataReader - *Data reader class to create an Array of {@link Ext.data.Record} objects from an XML document - * based on mappings in a provided {@link Ext.data.Record} constructor.
- *Note: that in order for the browser to parse a returned XML document, the Content-Type - * header in the HTTP response must be set to "text/xml" or "application/xml".
- *Example code:
- *- *-var Employee = Ext.data.Record.create([ - {name: 'name', mapping: 'name'}, // "mapping" property not needed if it is the same as "name" - {name: 'occupation'} // This field will use "occupation" as the mapping. -]); -var myReader = new Ext.data.XmlReader({ - totalProperty: "results", // The element which contains the total dataset size (optional) - record: "row", // The repeated element which contains row information - idProperty: "id" // The element within the row that provides an ID for the record (optional) - messageProperty: "msg" // The element within the response that provides a user-feedback message (optional) -}, Employee); -
- * This would consume an XML file like this: - *
- * @cfg {String} totalProperty The DomQuery path from which to retrieve the total number of records - * in the dataset. This is only needed if the whole dataset is not passed in one go, but is being - * paged from the remote server. - * @cfg {String} record The DomQuery path to the repeated element which contains record information. - * @cfg {String} record The DomQuery path to the repeated element which contains record information. - * @cfg {String} successProperty The DomQuery path to the success attribute used by forms. - * @cfg {String} idPath The DomQuery path relative from the record element to the element that contains - * a record identifier value. - * @constructor - * Create a new XmlReader. - * @param {Object} meta Metadata configuration options - * @param {Object} recordType Either an Array of field definition objects as passed to - * {@link Ext.data.Record#create}, or a Record constructor object created using {@link Ext.data.Record#create}. - */ -Ext.data.XmlReader = function(meta, recordType){ - meta = meta || {}; + hideLabel: false, - // backwards compat, convert idPath or id / success - Ext.applyIf(meta, { - idProperty: meta.idProperty || meta.idPath || meta.id, - successProperty: meta.successProperty || meta.success - }); + /** + * @cfg {Boolean} hideEmptyLabel + *-<?xml version="1.0" encoding="UTF-8"?> -<dataset> - <results>2</results> - <row> - <id>1</id> - <name>Bill</name> - <occupation>Gardener</occupation> - </row> - <row> - <id>2</id> - <name>Ben</name> - <occupation>Horticulturalist</occupation> - </row> -</dataset> -
When set to true, the label element ({@link #fieldLabel} and {@link #labelSeparator}) will be + * automatically hidden if the {@link #fieldLabel} is empty. Setting this to false will cause the empty + * label element to be rendered and space to be reserved for it; this is useful if you want a field without a label + * to line up with other labeled fields in the same form. Defaults to true.
+ *If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set + * the {@link #hideLabel} config to true.
+ */ + hideEmptyLabel: true, + + /** + * @cfg {Boolean} preventMark + * true to disable displaying any {@link #setActiveError error message} set on this object. + * Defaults to false. + */ + preventMark: false, - Ext.data.XmlReader.superclass.constructor.call(this, meta, recordType || meta.fields); -}; -Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, { /** - * This method is only used by a DataProxy which has retrieved data from a remote server. - * @param {Object} response The XHR object which contains the parsed XML document. The response is expected - * to contain a property called responseXML which refers to an XML document object. - * @return {Object} records A data block which is used by an {@link Ext.data.Store} as - * a cache of Ext.data.Records. + * @cfg {Boolean} autoFitErrors + * Whether to adjust the component's body area to make room for 'side' or 'under' + * {@link #msgTarget error messages}. Defaults to true. */ - read : function(response){ - var doc = response.responseXML; - if(!doc) { - throw {message: "XmlReader.read: XML Document not available"}; - } - return this.readRecords(doc); - }, + autoFitErrors: true, /** - * Create a data block containing Ext.data.Records from an XML document. - * @param {Object} doc A parsed XML document. - * @return {Object} records A data block which is used by an {@link Ext.data.Store} as - * a cache of Ext.data.Records. + * @cfg {String} msgTargetThe location where the error message text should display. + * Must be one of the following values:
+ **/ - readRecords : function(doc){ - /** - * After any data loads/reads, the raw XML Document is available for further custom processing. - * @type XMLDocument - */ - this.xmlData = doc; + msgTarget: 'qtip', - var root = doc.documentElement || doc, - q = Ext.DomQuery, - totalRecords = 0, - success = true; + /** + * @cfg {String} activeError + * If specified, then the component will be displayed with this value as its active error when + * first rendered. Defaults to undefined. Use {@link #setActiveError} or {@link #unsetActiveError} to + * change it after component creation. + */ - if(this.meta.totalProperty){ - totalRecords = this.getTotal(root, 0); - } - if(this.meta.successProperty){ - success = this.getSuccess(root); + + /** + * Performs initialization of this mixin. Component classes using this mixin should call this method + * during their own initialization. + */ + initLabelable: function() { + this.addCls(this.formItemCls); + + this.addEvents( + /** + * @event errorchange + * Fires when the active error message is changed via {@link #setActiveError}. + * @param {Ext.form.Labelable} this + * @param {String} error The active error message + */ + 'errorchange' + ); + }, + + /** + * Returns the label for the field. Defaults to simply returning the {@link #fieldLabel} config. Can be + * overridden to provide + * @return {String} The configured field label, or empty string if not defined + */ + getFieldLabel: function() { + return this.fieldLabel || ''; + }, + + /** + * @protected + * Generates the arguments for the field decorations {@link #labelableRenderTpl rendering template}. + * @return {Object} The template arguments + */ + getLabelableRenderData: function() { + var me = this, + labelAlign = me.labelAlign, + labelPad = me.labelPad, + labelStyle; + + // Calculate label styles up front rather than in the Field layout for speed; this + // is safe because label alignment/width/pad are not expected to change. + if (labelAlign === 'top') { + labelStyle = 'margin-bottom:' + labelPad + 'px;'; + } else { + labelStyle = 'margin-right:' + labelPad + 'px;'; + // Add the width for border-box browsers; will be set by the Field layout for content-box + if (Ext.isBorderBox) { + labelStyle += 'width:' + me.labelWidth + 'px;'; + } } - var records = this.extractData(q.select(this.meta.record, root), true); // <-- true to return Ext.data.Record[] + return Ext.copyTo( + { + inputId: me.getInputId(), + fieldLabel: me.getFieldLabel(), + labelStyle: labelStyle + (me.labelStyle || ''), + subTplMarkup: me.getSubTplMarkup() + }, + me, + 'hideLabel,hideEmptyLabel,labelCls,fieldBodyCls,baseBodyCls,errorMsgCls,clearCls,labelSeparator', + true + ); + }, - // TODO return Ext.data.Response instance. @see #readResponse + /** + * @protected + * Returns the additional {@link Ext.AbstractComponent#renderSelectors} for selecting the field + * decoration elements from the rendered {@link #labelableRenderTpl}. Component classes using this mixin should + * be sure and merge this method's result into the component's {@link Ext.AbstractComponent#renderSelectors} + * before rendering. + */ + getLabelableSelectors: function() { return { - success : success, - records : records, - totalRecords : totalRecords || records.length + /** + * @property labelEl + * @type Ext.core.Element + * The label Element for this component. Only available after the component has been rendered. + */ + labelEl: 'label.' + this.labelCls, + + /** + * @property bodyEl + * @type Ext.core.Element + * The div Element wrapping the component's contents. Only available after the component has been rendered. + */ + bodyEl: '.' + this.baseBodyCls, + + /** + * @property errorEl + * @type Ext.core.Element + * The div Element that will contain the component's error message(s). Note that depending on the + * configured {@link #msgTarget}, this element may be hidden in favor of some other form of + * presentation, but will always be present in the DOM for use by assistive technologies. + */ + errorEl: '.' + this.errorMsgCls }; }, /** - * Decode an XML response from server. - * @param {String} action [{@link Ext.data.Api#actions} create|read|update|destroy] - * @param {Object} response HTTP Response object from browser. - * @return {Ext.data.Response} An instance of {@link Ext.data.Response} + * @protected + * Gets the markup to be inserted into the outer template's bodyEl. Defaults to empty string, should + * be implemented by classes including this mixin as needed. + * @return {String} The markup to be inserted */ - readResponse : function(action, response) { - var q = Ext.DomQuery, - doc = response.responseXML; + getSubTplMarkup: function() { + return ''; + }, - // create general Response instance. - var res = new Ext.data.Response({ - action: action, - success : this.getSuccess(doc), - message: this.getMessage(doc), - data: this.extractData(q.select(this.meta.record, doc) || q.select(this.meta.root, doc), false), - raw: doc - }); + /** + * Get the input id, if any, for this component. This is used as the "for" attribute on the label element. + * Implementing subclasses may also use this as e.g. the id for their own input element. + * @return {String} The input id + */ + getInputId: function() { + return ''; + }, - if (Ext.isEmpty(res.success)) { - throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty); - } + /** + * Gets the active error message for this component, if any. This does not trigger + * validation on its own, it merely returns any message that the component may already hold. + * @return {String} The active error message on the component; if there is no error, an empty string is returned. + */ + getActiveError : function() { + return this.activeError || ''; + }, - // Create actions from a response having status 200 must return pk - if (action === Ext.data.Api.actions.create) { - var def = Ext.isDefined(res.data); - if (def && Ext.isEmpty(res.data)) { - throw new Ext.data.JsonReader.Error('root-empty', this.meta.root); - } - else if (!def) { - throw new Ext.data.JsonReader.Error('root-undefined-response', this.meta.root); - } - } - return res; + /** + * Tells whether the field currently has an active error message. This does not trigger + * validation on its own, it merely looks for any message that the component may already hold. + * @return {Boolean} + */ + hasActiveError: function() { + return !!this.getActiveError(); }, - getSuccess : function() { - return true; + /** + * Sets the active error message to the given string. This replaces the entire error message + * contents with the given string. Also see {@link #setActiveErrors} which accepts an Array of + * messages and formats them according to the {@link #activeErrorsTpl}. + * + * Note that this only updates the error message element's text and attributes, you'll have + * to call doComponentLayout to actually update the field's layout to match. If the field extends + * {@link Ext.form.field.Base} you should call {@link Ext.form.field.Base#markInvalid markInvalid} instead. + * + * @param {String} msg The error message + */ + setActiveError: function(msg) { + this.activeError = msg; + this.activeErrors = [msg]; + this.renderActiveError(); + }, + + /** + * Gets an Array of any active error messages currently applied to the field. This does not trigger + * validation on its own, it merely returns any messages that the component may already hold. + * @return {Array} The active error messages on the component; if there are no errors, an empty Array is returned. + */ + getActiveErrors: function() { + return this.activeErrors || []; + }, + + /** + * Set the active error message to an Array of error messages. The messages are formatted into + * a single message string using the {@link #activeErrorsTpl}. Also see {@link #setActiveError} + * which allows setting the entire error contents with a single string. + * + * Note that this only updates the error message element's text and attributes, you'll have + * to call doComponentLayout to actually update the field's layout to match. If the field extends + * {@link Ext.form.field.Base} you should call {@link Ext.form.field.Base#markInvalid markInvalid} instead. + * + * @param {Array} errors The error messages + */ + setActiveErrors: function(errors) { + this.activeErrors = errors; + this.activeError = this.getTpl('activeErrorsTpl').apply({errors: errors}); + this.renderActiveError(); + }, + + /** + * Clears the active error message(s). + * + * Note that this only clears the error message element's text and attributes, you'll have + * to call doComponentLayout to actually update the field's layout to match. If the field extends + * {@link Ext.form.field.Base} you should call {@link Ext.form.field.Base#clearInvalid clearInvalid} instead. + */ + unsetActiveError: function() { + delete this.activeError; + delete this.activeErrors; + this.renderActiveError(); }, /** - * build response-data extractor functions. * @private - * @ignore + * Updates the rendered DOM to match the current activeError. This only updates the content and + * attributes, you'll have to call doComponentLayout to actually update the display. */ - buildExtractors : function() { - if(this.ef){ - return; - } - var s = this.meta, - Record = this.recordType, - f = Record.prototype.fields, - fi = f.items, - fl = f.length; + renderActiveError: function() { + var me = this, + activeError = me.getActiveError(), + hasError = !!activeError; - if(s.totalProperty) { - this.getTotal = this.createAccessor(s.totalProperty); + if (activeError !== me.lastActiveError) { + me.fireEvent('errorchange', me, activeError); + me.lastActiveError = activeError; } - if(s.successProperty) { - this.getSuccess = this.createAccessor(s.successProperty); - } - if (s.messageProperty) { - this.getMessage = this.createAccessor(s.messageProperty); - } - this.getRoot = function(res) { - return (!Ext.isEmpty(res[this.meta.record])) ? res[this.meta.record] : res[this.meta.root]; - }; - if (s.idPath || s.idProperty) { - var g = this.createAccessor(s.idPath || s.idProperty); - this.getId = function(rec) { - var id = g(rec) || rec.id; - return (id === undefined || id === '') ? null : id; - }; - } else { - this.getId = function(){return null;}; - } - var ef = []; - for(var i = 0; i < fl; i++){ - f = fi[i]; - var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name; - ef.push(this.createAccessor(map)); + + if (me.rendered && !me.isDestroyed && !me.preventMark) { + // Add/remove invalid class + me.el[hasError ? 'addCls' : 'removeCls'](me.invalidCls); + + // Update the aria-invalid attribute + me.getActionEl().dom.setAttribute('aria-invalid', hasError); + + // Update the errorEl with the error message text + me.errorEl.dom.innerHTML = activeError; } - this.ef = ef; }, /** - * Creates a function to return some particular key of data from a response. - * @param {String} key - * @return {Function} - * @private - * @ignore + * Applies a set of default configuration values to this Labelable instance. For each of the + * properties in the given object, check if this component hasOwnProperty that config; if not + * then it's inheriting a default value from its prototype and we should apply the default value. + * @param {Object} defaults The defaults to apply to the object. */ - createAccessor : function(){ - var q = Ext.DomQuery; - return function(key) { - switch(key) { - case this.meta.totalProperty: - return function(root, def){ - return q.selectNumber(key, root, def); - }; - break; - case this.meta.successProperty: - return function(root, def) { - var sv = q.selectValue(key, root, true); - var success = sv !== false && sv !== 'false'; - return success; - }; - break; - default: - return function(root, def) { - return q.selectValue(key, root, def); - }; - break; + setFieldDefaults: function(defaults) { + var me = this; + Ext.iterate(defaults, function(key, val) { + if (!me.hasOwnProperty(key)) { + me[key] = val; } - }; - }(), + }); + }, /** - * extracts values and type-casts a row of data from server, extracted by #extractData - * @param {Hash} data - * @param {Ext.data.Field[]} items - * @param {Number} len - * @private - * @ignore + * @protected Calculate and return the natural width of the bodyEl. Override to provide custom logic. + * Note for implementors: if at all possible this method should be overridden with a custom implementation + * that can avoid anything that would cause the browser to reflow, e.g. querying offsetWidth. */ - extractValues : function(data, items, len) { - var f, values = {}; - for(var j = 0; j < len; j++){ - f = items[j]; - var v = this.ef[j](data); - values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue, data); - } - return values; + getBodyNaturalWidth: function() { + return this.bodyEl.getWidth(); } -});/** - * @class Ext.data.XmlStore - * @extends Ext.data.Store - *+ *
- + *
qtip
Display a quick tip containing the message when the user hovers over the field. This is the default. + *{@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager.init} must have been called for this setting to work.- + *
title
Display the message in a default browser title attribute popup.- + *
under
Add a block div beneath the field containing the error message.- + *
side
Add an error icon to the right of the field, displaying the message in a popup on hover.- + *
none
Don't display any error message. This might be useful if you are implementing custom error display.- + *
[element id]
Add the error message directly to the innerHTML of the specified element.Small helper class to make creating {@link Ext.data.Store}s from XML data easier. - * A XmlStore will be automatically configured with a {@link Ext.data.XmlReader}.
- *A store configuration would be something like:
- *-var store = new Ext.data.XmlStore({ - // store configs - autoDestroy: true, - storeId: 'myStore', - url: 'sheldon.xml', // automatically configures a HttpProxy - // reader configs - record: 'Item', // records will have an "Item" tag - idPath: 'ASIN', - totalRecords: '@TotalResults' - fields: [ - // set up the fields mapping into the xml doc - // The first needs mapping, the others are very basic - {name: 'Author', mapping: 'ItemAttributes > Author'}, - 'Title', 'Manufacturer', 'ProductGroup' - ] + }); - *
This store is configured to consume a returned object of the form:
- * An object literal of this form could also be used as the {@link #data} config option. - *-<?xml version="1.0" encoding="UTF-8"?> -<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15"> - <Items> - <Request> - <IsValid>True</IsValid> - <ItemSearchRequest> - <Author>Sidney Sheldon</Author> - <SearchIndex>Books</SearchIndex> - </ItemSearchRequest> - </Request> - <TotalResults>203</TotalResults> - <TotalPages>21</TotalPages> - <Item> - <ASIN>0446355453</ASIN> - <DetailPageURL> - http://www.amazon.com/ - </DetailPageURL> - <ItemAttributes> - <Author>Sidney Sheldon</Author> - <Manufacturer>Warner Books</Manufacturer> - <ProductGroup>Book</ProductGroup> - <Title>Master of the Game</Title> - </ItemAttributes> - </Item> - </Items> -</ItemSearchResponse> - *
Note: Although not listed here, this class accepts all of the configuration options of - * {@link Ext.data.XmlReader XmlReader}.
- * @constructor - * @param {Object} config - * @xtype xmlstore + +/** + * @class Ext.form.field.Field + +This mixin provides a common interface for the logical behavior and state of form fields, including: + +- Getter and setter methods for field values +- Events and methods for tracking value and validity changes +- Methods for triggering validation + +**NOTE**: When implementing custom fields, it is most likely that you will want to extend the {@link Ext.form.field.Base} +component class rather than using this mixin directly, as BaseField contains additional logic for generating an +actual DOM complete with {@link Ext.form.Labelable label and error message} display and a form input field, +plus methods that bind the Field value getters and setters to the input field's value. + +If you do want to implement this mixin directly and don't want to extend {@link Ext.form.field.Base}, then +you will most likely want to override the following methods with custom implementations: {@link #getValue}, +{@link #setValue}, and {@link #getErrors}. Other methods may be overridden as needed but their base +implementations should be sufficient for common cases. You will also need to make sure that {@link #initField} +is called during the component's initialization. + + * @markdown + * @docauthor Jason Johnston*/ -Ext.data.XmlStore = Ext.extend(Ext.data.Store, { +Ext.define('Ext.form.field.Field', { + + /** + * @property isFormField + * @type {Boolean} + * Flag denoting that this component is a Field. Always true. + */ + isFormField : true, + + /** + * @cfg {Mixed} value A value to initialize this field with (defaults to undefined). + */ + + /** + * @cfg {String} name The name of the field (defaults to undefined). By default this is used as the parameter + * name when including the {@link #getSubmitData field value} in a {@link Ext.form.Basic#submit form submit()}. + * To prevent the field from being included in the form submit, set {@link #submitValue} to false. + */ + + /** + * @cfg {Boolean} disabled True to disable the field (defaults to false). Disabled Fields will not be + * {@link Ext.form.Basic#submit submitted}. + */ + disabled : false, + + /** + * @cfg {Boolean} submitValue Setting this to false will prevent the field from being + * {@link Ext.form.Basic#submit submitted} even when it is not disabled. Defaults to true. + */ + submitValue: true, + + /** + * @cfg {Boolean} validateOnChange + * Specifies whether this field should be validated immediately whenever a change in its value is detected. + * Defaults to true. If the validation results in a change in the field's validity, a + * {@link #validitychange} event will be fired. This allows the field to show feedback about the + * validity of its contents immediately as the user is typing.
+ *When set to false, feedback will not be immediate. However the form will still be validated + * before submitting if the clientValidation option to {@link Ext.form.Basic#doAction} is + * enabled, or if the field or form are validated manually.
+ *See also {@link Ext.form.field.Base#checkChangeEvents}for controlling how changes to the field's value are detected.
+ */ + validateOnChange: true, + + /** + * @private + */ + suspendCheckChange: 0, + + /** + * Initializes this Field mixin on the current instance. Components using this mixin should call + * this method during their own initialization process. + */ + initField: function() { + this.addEvents( + /** + * @event change + * Fires when a user-initiated change is detected in the value of the field. + * @param {Ext.form.field.Field} this + * @param {Mixed} newValue The new value + * @param {Mixed} oldValue The original value + */ + 'change', + /** + * @event validitychange + * Fires when a change in the field's validity is detected. + * @param {Ext.form.field.Field} this + * @param {Boolean} isValid Whether or not the field is now valid + */ + 'validitychange', + /** + * @event dirtychange + * Fires when a change in the field's {@link #isDirty} state is detected. + * @param {Ext.form.field.Field} this + * @param {Boolean} isDirty Whether or not the field is now dirty + */ + 'dirtychange' + ); + + this.initValue(); + }, + + /** + * @protected + * Initializes the field's value based on the initial config. + */ + initValue: function() { + var me = this; + + /** + * @property originalValue + * @type Mixed + * The original value of the field as configured in the {@link #value} configuration, or as loaded by + * the last form load operation if the form's {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} + * setting istrue
. + */ + me.originalValue = me.lastValue = me.value; + + // Set the initial value - prevent validation on initial set + me.suspendCheckChange++; + me.setValue(me.value); + me.suspendCheckChange--; + }, + + /** + * Returns the {@link Ext.form.field.Field#name name} attribute of the field. This is used as the parameter + * name when including the field value in a {@link Ext.form.Basic#submit form submit()}. + * @return {String} name The field {@link Ext.form.field.Field#name name} + */ + getName: function() { + return this.name; + }, + /** - * @cfg {Ext.data.DataReader} reader @hide + * Returns the current data value of the field. The type of value returned is particular to the type of the + * particular field (e.g. a Date object for {@link Ext.form.field.Date}). + * @return {Mixed} value The field value */ - constructor: function(config){ - Ext.data.XmlStore.superclass.constructor.call(this, Ext.apply(config, { - reader: new Ext.data.XmlReader(config) - })); - } -}); -Ext.reg('xmlstore', Ext.data.XmlStore);/** - * @class Ext.data.GroupingStore - * @extends Ext.data.Store - * A specialized store implementation that provides for grouping records by one of the available fields. This - * is usually used in conjunction with an {@link Ext.grid.GroupingView} to provide the data model for - * a grouped GridPanel. - * - * Internally, GroupingStore is simply a normal Store with multi sorting enabled from the start. The grouping field - * and direction are always injected as the first sorter pair. GroupingView picks up on the configured groupField and - * builds grid rows appropriately. - * - * @constructor - * Creates a new GroupingStore. - * @param {Object} config A config object containing the objects needed for the Store to access data, - * and read the data into Records. - * @xtype groupingstore - */ -Ext.data.GroupingStore = Ext.extend(Ext.data.Store, { + getValue: function() { + return this.value; + }, + + /** + * Sets a data value into the field and runs the change detection and validation. + * @param {Mixed} value The value to set + * @return {Ext.form.field.Field} this + */ + setValue: function(value) { + var me = this; + me.value = value; + me.checkChange(); + return me; + }, - //inherit docs - constructor: function(config) { - config = config || {}; + /** + * Returns whether two field {@link #getValue values} are logically equal. Field implementations may override + * this to provide custom comparison logic appropriate for the particular field's data type. + * @param {Mixed} value1 The first value to compare + * @param {Mixed} value2 The second value to compare + * @return {Boolean} True if the values are equal, false if inequal. + */ + isEqual: function(value1, value2) { + return String(value1) === String(value2); + }, - //We do some preprocessing here to massage the grouping + sorting options into a single - //multi sort array. If grouping and sorting options are both presented to the constructor, - //the sorters array consists of the grouping sorter object followed by the sorting sorter object - //see Ext.data.Store's sorting functions for details about how multi sorting works - this.hasMultiSort = true; - this.multiSortInfo = this.multiSortInfo || {sorters: []}; - - var sorters = this.multiSortInfo.sorters, - groupField = config.groupField || this.groupField, - sortInfo = config.sortInfo || this.sortInfo, - groupDir = config.groupDir || this.groupDir; - - //add the grouping sorter object first - if(groupField){ - sorters.push({ - field : groupField, - direction: groupDir - }); + /** + *Returns the parameter(s) that would be included in a standard form submit for this field. Typically this + * will be an object with a single name-value pair, the name being this field's {@link #getName name} and the + * value being its current stringified value. More advanced field implementations may return more than one + * name-value pair.
+ *Note that the values returned from this method are not guaranteed to have been successfully + * {@link #validate validated}.
+ * @return {Object} A mapping of submit parameter names to values; each value should be a string, or an array + * of strings if that particular name has multiple values. It can also return null if there are no + * parameters to be submitted. + */ + getSubmitData: function() { + var me = this, + data = null; + if (!me.disabled && me.submitValue && !me.isFileUpload()) { + data = {}; + data[me.getName()] = '' + me.getValue(); } + return data; + }, - //add the sorting sorter object if it is present - if (sortInfo) { - sorters.push(sortInfo); + /** + *Returns the value(s) that should be saved to the {@link Ext.data.Model} instance for this field, when + * {@link Ext.form.Basic#updateRecord} is called. Typically this will be an object with a single name-value + * pair, the name being this field's {@link #getName name} and the value being its current data value. More + * advanced field implementations may return more than one name-value pair. The returned values will be + * saved to the corresponding field names in the Model.
+ *Note that the values returned from this method are not guaranteed to have been successfully + * {@link #validate validated}.
+ * @return {Object} A mapping of submit parameter names to values; each value should be a string, or an array + * of strings if that particular name has multiple values. It can also return null if there are no + * parameters to be submitted. + */ + getModelData: function() { + var me = this, + data = null; + if (!me.disabled && !me.isFileUpload()) { + data = {}; + data[me.getName()] = me.getValue(); } + return data; + }, - Ext.data.GroupingStore.superclass.constructor.call(this, config); + /** + * Resets the current field value to the originally loaded value and clears any validation messages. + * See {@link Ext.form.Basic}.{@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} + */ + reset : function(){ + var me = this; + + me.setValue(me.originalValue); + me.clearInvalid(); + // delete here so we reset back to the original state + delete me.wasValid; + }, - this.addEvents( - /** - * @event groupchange - * Fired whenever a call to store.groupBy successfully changes the grouping on the store - * @param {Ext.data.GroupingStore} store The grouping store - * @param {String} groupField The field that the store is now grouped by - */ - 'groupchange' - ); + /** + * Resets the field's {@link #originalValue} property so it matches the current {@link #getValue value}. + * This is called by {@link Ext.form.Basic}.{@link Ext.form.Basic#setValues setValues} if the form's + * {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} property is set to true. + */ + resetOriginalValue: function() { + this.originalValue = this.getValue(); + this.checkDirty(); + }, - this.applyGroupField(); + /** + *Checks whether the value of the field has changed since the last time it was checked. If the value + * has changed, it:
+ *+ *
+ */ + checkChange: function() { + if (!this.suspendCheckChange) { + var me = this, + newVal = me.getValue(), + oldVal = me.lastValue; + if (!me.isEqual(newVal, oldVal) && !me.isDestroyed) { + me.lastValue = newVal; + me.fireEvent('change', me, newVal, oldVal); + me.onChange(newVal, oldVal); + } + } }, /** - * @cfg {String} groupField - * The field name by which to sort the store's data (defaults to ''). + * @private + * Called when the field's value changes. Performs validation if the {@link #validateOnChange} + * config is enabled, and invokes the dirty check. */ + onChange: function(newVal, oldVal) { + if (this.validateOnChange) { + this.validate(); + } + this.checkDirty(); + }, + /** - * @cfg {Boolean} remoteGroup - * True if the grouping should apply on the server side, false if it is local only (defaults to false). If the - * grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a - * helper, automatically sending the grouping field name as the 'groupBy' param with each XHR call. + *- Fires the {@link #change change event},
+ *- Performs validation if the {@link #validateOnChange} config is enabled, firing the + * {@link #validationchange validationchange event} if the validity has changed, and
+ *- Checks the {@link #isDirty dirty state} of the field and fires the {@link #dirtychange dirtychange event} + * if it has changed.
+ *Returns true if the value of this Field has been changed from its {@link #originalValue}. + * Will always return false if the field is disabled.
+ *Note that if the owning {@link Ext.form.Basic form} was configured with + * {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} + * then the {@link #originalValue} is updated when the values are loaded by + * {@link Ext.form.Basic}.{@link Ext.form.Basic#setValues setValues}.
+ * @return {Boolean} True if this field has been changed from its original value (and + * is not disabled), false otherwise. */ - remoteGroup : false, + isDirty : function() { + var me = this; + return !me.disabled && !me.isEqual(me.getValue(), me.originalValue); + }, + /** - * @cfg {Boolean} groupOnSort - * True to sort the data on the grouping field when a grouping operation occurs, false to sort based on the - * existing sort info (defaults to false). + * Checks the {@link #isDirty} state of the field and if it has changed since the last time + * it was checked, fires the {@link #dirtychange} event. */ - groupOnSort:false, + checkDirty: function() { + var me = this, + isDirty = me.isDirty(); + if (isDirty !== me.wasDirty) { + me.fireEvent('dirtychange', me, isDirty); + me.onDirtyChange(isDirty); + me.wasDirty = isDirty; + } + }, - groupDir : 'ASC', + /** + * @private Called when the field's dirty state changes. + * @param {Boolean} isDirty + */ + onDirtyChange: Ext.emptyFn, /** - * Clears any existing grouping and refreshes the data using the default sort. + *Runs this field's validators and returns an array of error messages for any validation failures. + * This is called internally during validation and would not usually need to be used manually.
+ *Each subclass should override or augment the return value to provide their own errors.
+ * @param {Mixed} value The value to get errors for (defaults to the current field value) + * @return {Array} All error messages for this field; an empty Array if none. */ - clearGrouping : function(){ - this.groupField = false; + getErrors: function(value) { + return []; + }, - if(this.remoteGroup){ - if(this.baseParams){ - delete this.baseParams.groupBy; - delete this.baseParams.groupDir; - } - var lo = this.lastOptions; - if(lo && lo.params){ - delete lo.params.groupBy; - delete lo.params.groupDir; - } + /** + *Returns whether or not the field value is currently valid by {@link #getErrors validating} the + * field's current value. The {@link #validitychange} event will not be fired; use {@link #validate} + * instead if you want the event to fire. Note: {@link #disabled} fields are always treated as valid.
+ *Implementations are encouraged to ensure that this method does not have side-effects such as + * triggering error message display.
+ * @return {Boolean} True if the value is valid, else false + */ + isValid : function() { + var me = this; + return me.disabled || Ext.isEmpty(me.getErrors()); + }, - this.reload(); - }else{ - this.sort(); - this.fireEvent('datachanged', this); + /** + *Returns whether or not the field value is currently valid by {@link #getErrors validating} the + * field's current value, and fires the {@link #validitychange} event if the field's validity has + * changed since the last validation. Note: {@link #disabled} fields are always treated as valid.
+ *Custom implementations of this method are allowed to have side-effects such as triggering error + * message display. To validate without side-effects, use {@link #isValid}.
+ * @return {Boolean} True if the value is valid, else false + */ + validate : function() { + var me = this, + isValid = me.isValid(); + if (isValid !== me.wasValid) { + me.wasValid = isValid; + me.fireEvent('validitychange', me, isValid); } + return isValid; }, /** - * Groups the data by the specified field. - * @param {String} field The field name by which to sort the store's data - * @param {Boolean} forceRegroup (optional) True to force the group to be refreshed even if the field passed - * in is the same as the current grouping field, false to skip grouping on the same field (defaults to false) + * A utility for grouping a set of modifications which may trigger value changes into a single + * transaction, to prevent excessive firing of {@link #change} events. This is useful for instance + * if the field has sub-fields which are being updated as a group; you don't want the container + * field to check its own changed state for each subfield change. + * @param fn A function containing the transaction code */ - groupBy : function(field, forceRegroup, direction) { - direction = direction ? (String(direction).toUpperCase() == 'DESC' ? 'DESC' : 'ASC') : this.groupDir; + batchChanges: function(fn) { + this.suspendCheckChange++; + fn(); + this.suspendCheckChange--; + this.checkChange(); + }, - if (this.groupField == field && this.groupDir == direction && !forceRegroup) { - return; // already grouped by this field - } + /** + * Returns whether this Field is a file upload field; if it returns true, forms will use + * special techniques for {@link Ext.form.Basic#submit submitting the form} via AJAX. See + * {@link Ext.form.Basic#hasUpload} for details. If this returns true, the {@link #extractFileInput} + * method must also be implemented to return the corresponding file input element. + * @return {Boolean} + */ + isFileUpload: function() { + return false; + }, - //check the contents of the first sorter. If the field matches the CURRENT groupField (before it is set to the new one), - //remove the sorter as it is actually the grouper. The new grouper is added back in by this.sort - sorters = this.multiSortInfo.sorters; - if (sorters.length > 0 && sorters[0].field == this.groupField) { - sorters.shift(); - } + /** + * Only relevant if the instance's {@link #isFileUpload} method returns true. Returns a reference + * to the file input DOM element holding the user's selected file. The input will be appended into + * the submission form and will not be returned, so this method should also create a replacement. + * @return {HTMLInputElement} + */ + extractFileInput: function() { + return null; + }, - this.groupField = field; - this.groupDir = direction; - this.applyGroupField(); + /** + *Associate one or more error messages with this field. Components using this mixin should implement + * this method to update the component's rendering to display the messages.
+ *Note: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to + * return
+ * @param {String/Array} errors The error message(s) for the field. + * @method + */ + markInvalid: Ext.emptyFn, - var fireGroupEvent = function() { - this.fireEvent('groupchange', this, this.getGroupState()); - }; + /** + *false
if the value does pass validation. So simply marking a Field as invalid + * will not prevent submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation} + * option set.Clear any invalid styles/messages for this field. Components using this mixin should implement + * this method to update the components rendering to clear any existing messages.
+ *Note: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to + * return
+ * @method + */ + clearInvalid: Ext.emptyFn - if (this.groupOnSort) { - this.sort(field, direction); - fireGroupEvent.call(this); - return; - } +}); - if (this.remoteGroup) { - this.on('load', fireGroupEvent, this, {single: true}); - this.reload(); - } else { - this.sort(sorters); - fireGroupEvent.call(this); - } - }, +/** + * @class Ext.layout.component.field.Field + * @extends Ext.layout.component.Component + * Layout class for components with {@link Ext.form.Labelable field labeling}, handling the sizing and alignment of + * the form control, label, and error message treatment. + * @private + */ +Ext.define('Ext.layout.component.field.Field', { - //GroupingStore always uses multisorting so we intercept calls to sort here to make sure that our grouping sorter object - //is always injected first. - sort : function(fieldName, dir) { - if (this.remoteSort) { - return Ext.data.GroupingStore.superclass.sort.call(this, fieldName, dir); - } + /* Begin Definitions */ - var sorters = []; + alias: ['layout.field'], - //cater for any existing valid arguments to this.sort, massage them into an array of sorter objects - if (Ext.isArray(arguments[0])) { - sorters = arguments[0]; - } else if (fieldName == undefined) { - //we preserve the existing sortInfo here because this.sort is called after - //clearGrouping and there may be existing sorting - sorters = this.sortInfo ? [this.sortInfo] : []; - } else { - //TODO: this is lifted straight from Ext.data.Store's singleSort function. It should instead be - //refactored into a common method if possible - var field = this.fields.get(fieldName); - if (!field) return false; - - var name = field.name, - sortInfo = this.sortInfo || null, - sortToggle = this.sortToggle ? this.sortToggle[name] : null; - - if (!dir) { - if (sortInfo && sortInfo.field == name) { // toggle sort dir - dir = (this.sortToggle[name] || 'ASC').toggle('ASC', 'DESC'); - } else { - dir = field.sortDir; - } - } + extend: 'Ext.layout.component.Component', - this.sortToggle[name] = dir; - this.sortInfo = {field: name, direction: dir}; + uses: ['Ext.tip.QuickTip', 'Ext.util.TextMetrics'], - sorters = [this.sortInfo]; - } + /* End Definitions */ - //add the grouping sorter object as the first multisort sorter - if (this.groupField) { - sorters.unshift({direction: this.groupDir, field: this.groupField}); - } + type: 'field', - return this.multiSort.call(this, sorters, dir); + beforeLayout: function(width, height) { + var me = this; + return me.callParent(arguments) || (!me.owner.preventMark && me.activeError !== me.owner.getActiveError()); }, - /** - * @private - * Saves the current grouping field and direction to this.baseParams and this.lastOptions.params - * if we're using remote grouping. Does not actually perform any grouping - just stores values - */ - applyGroupField: function(){ - if (this.remoteGroup) { - if(!this.baseParams){ - this.baseParams = {}; + onLayout: function(width, height) { + var me = this, + owner = me.owner, + labelStrategy = me.getLabelStrategy(), + errorStrategy = me.getErrorStrategy(), + isDefined = Ext.isDefined, + isNumber = Ext.isNumber, + lastSize, autoWidth, autoHeight, info, undef; + + lastSize = me.lastComponentSize || {}; + if (!isDefined(width)) { + width = lastSize.width; + if (width < 0) { //first pass lastComponentSize.width is -Infinity + width = undef; + } + } + if (!isDefined(height)) { + height = lastSize.height; + if (height < 0) { //first pass lastComponentSize.height is -Infinity + height = undef; + } + } + autoWidth = !isNumber(width); + autoHeight = !isNumber(height); + + info = { + autoWidth: autoWidth, + autoHeight: autoHeight, + width: autoWidth ? owner.getBodyNaturalWidth() : width, //always give a pixel width + height: height, + setOuterWidth: false, //whether the outer el width should be set to the calculated width + + // insets for the bodyEl from each side of the component layout area + insets: { + top: 0, + right: 0, + bottom: 0, + left: 0 } + }; - Ext.apply(this.baseParams, { - groupBy : this.groupField, - groupDir: this.groupDir - }); + // NOTE the order of calculating insets and setting styles here is very important; we must first + // calculate and set horizontal layout alone, as the horizontal sizing of elements can have an impact + // on the vertical sizes due to wrapping, then calculate and set the vertical layout. - var lo = this.lastOptions; - if (lo && lo.params) { - lo.params.groupDir = this.groupDir; + // perform preparation on the label and error (setting css classes, qtips, etc.) + labelStrategy.prepare(owner, info); + errorStrategy.prepare(owner, info); - //this is deleted because of a bug reported at http://www.extjs.com/forum/showthread.php?t=82907 - delete lo.params.groupBy; - } + // calculate the horizontal insets for the label and error + labelStrategy.adjustHorizInsets(owner, info); + errorStrategy.adjustHorizInsets(owner, info); + + // set horizontal styles for label and error based on the current insets + labelStrategy.layoutHoriz(owner, info); + errorStrategy.layoutHoriz(owner, info); + + // calculate the vertical insets for the label and error + labelStrategy.adjustVertInsets(owner, info); + errorStrategy.adjustVertInsets(owner, info); + + // set vertical styles for label and error based on the current insets + labelStrategy.layoutVert(owner, info); + errorStrategy.layoutVert(owner, info); + + // perform sizing of the elements based on the final dimensions and insets + if (autoWidth && autoHeight) { + // Don't use setTargetSize if auto-sized, so the calculated size is not reused next time + me.setElementSize(owner.el, (info.setOuterWidth ? info.width : undef), info.height); + } else { + me.setTargetSize((!autoWidth || info.setOuterWidth ? info.width : undef), info.height); } + me.sizeBody(info); + + me.activeError = owner.getActiveError(); }, + /** - * @private - * TODO: This function is apparently never invoked anywhere in the framework. It has no documentation - * and should be considered for deletion + * Perform sizing and alignment of the bodyEl (and children) to match the calculated insets. */ - applyGrouping : function(alwaysFireChange){ - if(this.groupField !== false){ - this.groupBy(this.groupField, true, this.groupDir); - return true; - }else{ - if(alwaysFireChange === true){ - this.fireEvent('datachanged', this); - } - return false; - } + sizeBody: function(info) { + var me = this, + owner = me.owner, + insets = info.insets, + totalWidth = info.width, + totalHeight = info.height, + width = Ext.isNumber(totalWidth) ? totalWidth - insets.left - insets.right : totalWidth, + height = Ext.isNumber(totalHeight) ? totalHeight - insets.top - insets.bottom : totalHeight; + + // size the bodyEl + me.setElementSize(owner.bodyEl, width, height); + + // size the bodyEl's inner contents if necessary + me.sizeBodyContents(width, height); }, /** - * @private - * Returns the grouping field that should be used. If groupOnSort is used this will be sortInfo's field, - * otherwise it will be this.groupField - * @return {String} The group field + * Size the contents of the field body, given the full dimensions of the bodyEl. Does nothing by + * default, subclasses can override to handle their specific contents. + * @param {Number} width The bodyEl width + * @param {Number} height The bodyEl height */ - getGroupState : function(){ - return this.groupOnSort && this.groupField !== false ? - (this.sortInfo ? this.sortInfo.field : undefined) : this.groupField; - } -}); -Ext.reg('groupingstore', Ext.data.GroupingStore); -/** - * @class Ext.data.DirectProxy - * @extends Ext.data.DataProxy - */ -Ext.data.DirectProxy = function(config){ - Ext.apply(this, config); - if(typeof this.paramOrder == 'string'){ - this.paramOrder = this.paramOrder.split(/[\s,|]/); - } - Ext.data.DirectProxy.superclass.constructor.call(this, config); -}; + sizeBodyContents: Ext.emptyFn, -Ext.extend(Ext.data.DirectProxy, Ext.data.DataProxy, { - /** - * @cfg {Array/String} paramOrder Defaults to undefined. A list of params to be executed - * server side. Specify the params in the order in which they must be executed on the server-side - * as either (1) an Array of String values, or (2) a String of params delimited by either whitespace, - * comma, or pipe. For example, - * any of the following would be acceptable:true
if the value does not pass validation. So simply clearing a field's errors + * will not necessarily allow submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation} + * option set.- */ - paramOrder: undefined, /** - * @cfg {Boolean} paramsAsHash - * Send parameters as a collection of named arguments (defaults to true). Providing a - * {@link #paramOrder} nullifies this configuration. + * Return the set of strategy functions from the {@link #labelStrategies labelStrategies collection} + * that is appropriate for the field's {@link Ext.form.Labelable#labelAlign labelAlign} config. */ - paramsAsHash: true, + getLabelStrategy: function() { + var me = this, + strategies = me.labelStrategies, + labelAlign = me.owner.labelAlign; + return strategies[labelAlign] || strategies.base; + }, /** - * @cfg {Function} directFn - * Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter - * for Store's which will not implement a full CRUD api. + * Return the set of strategy functions from the {@link #errorStrategies errorStrategies collection} + * that is appropriate for the field's {@link Ext.form.Labelable#msgTarget msgTarget} config. */ - directFn : undefined, + getErrorStrategy: function() { + var me = this, + owner = me.owner, + strategies = me.errorStrategies, + msgTarget = owner.msgTarget; + return !owner.preventMark && Ext.isString(msgTarget) ? + (strategies[msgTarget] || strategies.elementId) : + strategies.none; + }, + + /** - * DirectProxy implementation of {@link Ext.data.DataProxy#doRequest} - * @param {String} action The crud action type (create, read, update, destroy) - * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null - * @param {Object} params An object containing properties which are to be used as HTTP parameters - * for the request to the remote server. - * @param {Ext.data.DataReader} reader The Reader object which converts the data - * object into a block of Ext.data.Records. - * @param {Function} callback - *-paramOrder: ['param1','param2','param3'] -paramOrder: 'param1 param2 param3' -paramOrder: 'param1,param2,param3' -paramOrder: 'param1|param2|param' -
- * @param {Object} scope The scope (A function to be called after the request. - * The callback is passed the following arguments:
- *
- r : Ext.data.Record[] The block of Ext.data.Records.
- *- options: Options object from the action request
- *- success: Boolean success indicator
this
reference) in which the callback function is executed. Defaults to the browser window. - * @param {Object} arg An optional argument which is passed to the callback as its second parameter. - * @protected + * Collection of named strategies for laying out and adjusting labels to accommodate error messages. + * An appropriate one will be chosen based on the owner field's {@link Ext.form.Labelable#labelAlign} config. */ - doRequest : function(action, rs, params, reader, callback, scope, options) { - var args = [], - directFn = this.api[action] || this.directFn; - - switch (action) { - case Ext.data.Api.actions.create: - args.push(params.jsonData); // <-- create(Hash) - break; - case Ext.data.Api.actions.read: - // If the method has no parameters, ignore the paramOrder/paramsAsHash. - if(directFn.directCfg.method.len > 0){ - if(this.paramOrder){ - for(var i = 0, len = this.paramOrder.length; i < len; i++){ - args.push(params[this.paramOrder[i]]); - } - }else if(this.paramsAsHash){ - args.push(params); + labelStrategies: (function() { + var applyIf = Ext.applyIf, + emptyFn = Ext.emptyFn, + base = { + prepare: function(owner, info) { + var cls = owner.labelCls + '-' + owner.labelAlign, + labelEl = owner.labelEl; + if (labelEl && !labelEl.hasCls(cls)) { + labelEl.addCls(cls); + } + }, + adjustHorizInsets: emptyFn, + adjustVertInsets: emptyFn, + layoutHoriz: emptyFn, + layoutVert: emptyFn + }, + left = applyIf({ + prepare: function(owner, info) { + base.prepare(owner, info); + // If auto width, add the label width to the body's natural width. + if (info.autoWidth) { + info.width += (!owner.labelEl ? 0 : owner.labelWidth + owner.labelPad); + } + // Must set outer width to prevent field from wrapping below floated label + info.setOuterWidth = true; + }, + adjustHorizInsets: function(owner, info) { + if (owner.labelEl) { + info.insets.left += owner.labelWidth + owner.labelPad; + } + }, + layoutHoriz: function(owner, info) { + // For content-box browsers we can't rely on Labelable.js#getLabelableRenderData + // setting the width style because it needs to account for the final calculated + // padding/border styles for the label. So we set the width programmatically here to + // normalize content-box sizing, while letting border-box browsers use the original + // width style. + var labelEl = owner.labelEl; + if (labelEl && !owner.isLabelSized && !Ext.isBorderBox) { + labelEl.setWidth(owner.labelWidth); + owner.isLabelSized = true; } } - break; - case Ext.data.Api.actions.update: - args.push(params.jsonData); // <-- update(Hash/Hash[]) - break; - case Ext.data.Api.actions.destroy: - args.push(params.jsonData); // <-- destroy(Int/Int[]) - break; - } + }, base); - var trans = { - params : params || {}, - request: { - callback : callback, - scope : scope, - arg : options - }, - reader: reader - }; - args.push(this.createCallback(action, rs, trans), this); - directFn.apply(window, args); - }, + return { + base: base, - // private - createCallback : function(action, rs, trans) { - var me = this; - return function(result, res) { - if (!res.status) { - // @deprecated fire loadexception - if (action === Ext.data.Api.actions.read) { - me.fireEvent("loadexception", me, trans, res, null); + /** + * Label displayed above the bodyEl + */ + top: applyIf({ + adjustVertInsets: function(owner, info) { + var labelEl = owner.labelEl; + if (labelEl) { + info.insets.top += Ext.util.TextMetrics.measure(labelEl, owner.fieldLabel, info.width).height + + labelEl.getFrameWidth('tb') + owner.labelPad; + } } - me.fireEvent('exception', me, 'remote', action, trans, res, null); - trans.request.callback.call(trans.request.scope, null, trans.request.arg, false); - return; - } - if (action === Ext.data.Api.actions.read) { - me.onRead(action, trans, result, res); - } else { - me.onWrite(action, trans, result, res, rs); - } + }, base), + + /** + * Label displayed to the left of the bodyEl + */ + left: left, + + /** + * Same as left, only difference is text-align in CSS + */ + right: left }; - }, + })(), + + /** - * Callback for read actions - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} trans The request transaction object - * @param {Object} result Data object picked out of the server-response. - * @param {Object} res The server response - * @protected + * Collection of named strategies for laying out and adjusting insets to accommodate error messages. + * An appropriate one will be chosen based on the owner field's {@link Ext.form.Labelable#msgTarget} config. */ - onRead : function(action, trans, result, res) { - var records; - try { - records = trans.reader.readRecords(result); + errorStrategies: (function() { + function setDisplayed(el, displayed) { + var wasDisplayed = el.getStyle('display') !== 'none'; + if (displayed !== wasDisplayed) { + el.setDisplayed(displayed); + } } - catch (ex) { - // @deprecated: Fire old loadexception for backwards-compat. - this.fireEvent("loadexception", this, trans, res, ex); - this.fireEvent('exception', this, 'response', action, trans, res, ex); - trans.request.callback.call(trans.request.scope, null, trans.request.arg, false); - return; + function setStyle(el, name, value) { + if (el.getStyle(name) !== value) { + el.setStyle(name, value); + } } - this.fireEvent("load", this, res, trans.request.arg); - trans.request.callback.call(trans.request.scope, records, trans.request.arg, true); - }, - /** - * Callback for write actions - * @param {String} action [{@link Ext.data.Api#actions create|read|update|destroy}] - * @param {Object} trans The request transaction object - * @param {Object} result Data object picked out of the server-response. - * @param {Object} res The server response - * @param {Ext.data.Record/[Ext.data.Record]} rs The Store resultset associated with the action. - * @protected - */ - onWrite : function(action, trans, result, res, rs) { - var data = trans.reader.extractData(trans.reader.getRoot(result), false); - var success = trans.reader.getSuccess(result); - success = (success !== false); - if (success){ - this.fireEvent("write", this, action, data, res, rs, trans.request.arg); - }else{ - this.fireEvent('exception', this, 'remote', action, trans, result, rs); + + var applyIf = Ext.applyIf, + emptyFn = Ext.emptyFn, + base = { + prepare: function(owner) { + setDisplayed(owner.errorEl, false); + }, + adjustHorizInsets: emptyFn, + adjustVertInsets: emptyFn, + layoutHoriz: emptyFn, + layoutVert: emptyFn + }; + + return { + none: base, + + /** + * Error displayed as icon (with QuickTip on hover) to right of the bodyEl + */ + side: applyIf({ + prepare: function(owner) { + var errorEl = owner.errorEl; + errorEl.addCls(Ext.baseCSSPrefix + 'form-invalid-icon'); + Ext.layout.component.field.Field.initTip(); + errorEl.dom.setAttribute('data-errorqtip', owner.getActiveError() || ''); + setDisplayed(errorEl, owner.hasActiveError()); + }, + adjustHorizInsets: function(owner, info) { + if (owner.autoFitErrors && owner.hasActiveError()) { + info.insets.right += owner.errorEl.getWidth(); + } + }, + layoutHoriz: function(owner, info) { + if (owner.hasActiveError()) { + setStyle(owner.errorEl, 'left', info.width - info.insets.right + 'px'); + } + }, + layoutVert: function(owner, info) { + if (owner.hasActiveError()) { + setStyle(owner.errorEl, 'top', info.insets.top + 'px'); + } + } + }, base), + + /** + * Error message displayed underneath the bodyEl + */ + under: applyIf({ + prepare: function(owner) { + var errorEl = owner.errorEl, + cls = Ext.baseCSSPrefix + 'form-invalid-under'; + if (!errorEl.hasCls(cls)) { + errorEl.addCls(cls); + } + setDisplayed(errorEl, owner.hasActiveError()); + }, + adjustVertInsets: function(owner, info) { + if (owner.autoFitErrors) { + info.insets.bottom += owner.errorEl.getHeight(); + } + }, + layoutHoriz: function(owner, info) { + var errorEl = owner.errorEl, + insets = info.insets; + + setStyle(errorEl, 'width', info.width - insets.right - insets.left + 'px'); + setStyle(errorEl, 'marginLeft', insets.left + 'px'); + } + }, base), + + /** + * Error displayed as QuickTip on hover of the field container + */ + qtip: applyIf({ + prepare: function(owner) { + setDisplayed(owner.errorEl, false); + Ext.layout.component.field.Field.initTip(); + owner.getActionEl().dom.setAttribute('data-errorqtip', owner.getActiveError() || ''); + } + }, base), + + /** + * Error displayed as title tip on hover of the field container + */ + title: applyIf({ + prepare: function(owner) { + setDisplayed(owner.errorEl, false); + owner.el.dom.title = owner.getActiveError() || ''; + } + }, base), + + /** + * Error message displayed as content of an element with a given id elsewhere in the app + */ + elementId: applyIf({ + prepare: function(owner) { + setDisplayed(owner.errorEl, false); + var targetEl = Ext.fly(owner.msgTarget); + if (targetEl) { + targetEl.dom.innerHTML = owner.getActiveError() || ''; + targetEl.setDisplayed(owner.hasActiveError()); + } + } + }, base) + }; + })(), + + statics: { + /** + * Use a custom QuickTip instance separate from the main QuickTips singleton, so that we + * can give it a custom frame style. Responds to errorqtip rather than the qtip property. + */ + initTip: function() { + var tip = this.tip; + if (!tip) { + tip = this.tip = Ext.create('Ext.tip.QuickTip', { + baseCls: Ext.baseCSSPrefix + 'form-invalid-tip', + renderTo: Ext.getBody() + }); + tip.tagConfig = Ext.apply({}, {attribute: 'errorqtip'}, tip.tagConfig); + } + }, + + /** + * Destroy the error tip instance. + */ + destroyTip: function() { + var tip = this.tip; + if (tip) { + tip.destroy(); + delete this.tip; + } } - trans.request.callback.call(trans.request.scope, data, res, success); } + }); + /** - * @class Ext.data.DirectStore - * @extends Ext.data.Store - *Small helper class to create an {@link Ext.data.Store} configured with an - * {@link Ext.data.DirectProxy} and {@link Ext.data.JsonReader} to make interacting - * with an {@link Ext.Direct} Server-side {@link Ext.direct.Provider Provider} easier. - * To create a different proxy/reader combination create a basic {@link Ext.data.Store} - * configured as needed.
- * - **Note: Although they are not listed, this class inherits all of the config options of:
- *- * - * @xtype directstore - * - * @constructor - * @param {Object} config - */ -Ext.data.DirectStore = Ext.extend(Ext.data.Store, { - constructor : function(config){ - // each transaction upon a singe record will generate a distinct Direct transaction since Direct queues them into one Ajax request. - var c = Ext.apply({}, { - batchTransactions: false - }, config); - Ext.data.DirectStore.superclass.constructor.call(this, Ext.apply(c, { - proxy: Ext.isDefined(c.proxy) ? c.proxy : new Ext.data.DirectProxy(Ext.copyTo({}, c, 'paramOrder,paramsAsHash,directFn,api')), - reader: (!Ext.isDefined(c.reader) && c.fields) ? new Ext.data.JsonReader(Ext.copyTo({}, c, 'totalProperty,root,idProperty'), c.fields) : c.reader - })); - } + * @class Ext.form.field.VTypes + *- *
- {@link Ext.data.Store Store}
- *- *- * - *
- {@link Ext.data.JsonReader JsonReader}
- *- * - *- *
- {@link Ext.data.JsonReader#root root}
- *- {@link Ext.data.JsonReader#idProperty idProperty}
- *- {@link Ext.data.JsonReader#totalProperty totalProperty}
- *- {@link Ext.data.DirectProxy DirectProxy}
- *- *- *
- {@link Ext.data.DirectProxy#directFn directFn}
- *- {@link Ext.data.DirectProxy#paramOrder paramOrder}
- *- {@link Ext.data.DirectProxy#paramsAsHash paramsAsHash}
- *This is a singleton object which contains a set of commonly used field validation functions. + * The validations provided are basic and intended to be easily customizable and extended.
+ *To add custom VTypes specify the
+ *{@link Ext.form.field.Text#vtype vtype}
validation + * test function, and optionally specify any corresponding error text to display and any keystroke + * filtering mask to apply. For example:+ * Another example: *+// custom Vtype for vtype:'time' +var timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i; +Ext.apply(Ext.form.field.VTypes, { + // vtype validation function + time: function(val, field) { + return timeTest.test(val); + }, + // vtype Text property: The error text to display when the validation function returns false + timeText: 'Not a valid time. Must be in the format "12:34 PM".', + // vtype Mask property: The keystroke filter mask + timeMask: /[\d\s:amp]/i }); -Ext.reg('directstore', Ext.data.DirectStore); -/** - * @class Ext.Direct - * @extends Ext.util.Observable - *
Overview
- * - *Ext.Direct aims to streamline communication between the client and server - * by providing a single interface that reduces the amount of common code - * typically required to validate data and handle returned data packets - * (reading data, error conditions, etc).
- * - *The Ext.direct namespace includes several classes for a closer integration - * with the server-side. The Ext.data namespace also includes classes for working - * with Ext.data.Stores which are backed by data from an Ext.Direct method.
- * - *Specification
- * - *For additional information consult the - * Ext.Direct Specification.
- * - *Providers
- * - *Ext.Direct uses a provider architecture, where one or more providers are - * used to transport data to and from the server. There are several providers - * that exist in the core at the moment:
- * - *- * - *
- {@link Ext.direct.JsonProvider JsonProvider} for simple JSON operations
- *- {@link Ext.direct.PollingProvider PollingProvider} for repeated requests
- *- {@link Ext.direct.RemotingProvider RemotingProvider} exposes server side - * on the client.
- *A provider does not need to be invoked directly, providers are added via - * {@link Ext.Direct}.{@link Ext.Direct#add add}.
- * - *Router
- * - *Ext.Direct utilizes a "router" on the server to direct requests from the client - * to the appropriate server-side method. Because the Ext.Direct API is completely - * platform-agnostic, you could completely swap out a Java based server solution - * and replace it with one that uses C# without changing the client side JavaScript - * at all.
- * - *Server side events
- * - *Custom events from the server may be handled by the client by adding - * listeners, for example:
+ *+ * @singleton + */ +Ext.define('Ext.form.field.VTypes', (function(){ + // closure these in so they are only created once. + var alpha = /^[a-zA-Z_]+$/, + alphanum = /^[a-zA-Z0-9_]+$/, + email = /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$/, + url = /(((^https?)|(^ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@`~=%!]*)(\.\w{2,})?)*\/?)/i; + + // All these messages and functions are configurable + return { + singleton: true, + alternateClassName: 'Ext.form.VTypes', + + /** + * The function used to validate email addresses. Note that this is a very basic validation -- complete + * validation per the email RFC specifications is very complex and beyond the scope of this class, although + * this function can be overridden if a more comprehensive validation scheme is desired. See the validation + * section of the Wikipedia article on email addresses + * for additional information. This implementation is intended to validate the following emails: + * 'barney@example.de', 'barney.rubble@example.com', 'barney-rubble@example.coop', 'barney+rubble@example.com' + * . + * @param {String} value The email address + * @return {Boolean} true if the RegExp test passed, and false if not. + */ + 'email' : function(v){ + return email.test(v); + }, + /** + * The error text to display when the email validation function returns false. Defaults to: + * 'This field should be an e-mail address in the format "user@example.com"' + * @type String + */ + 'emailText' : 'This field should be an e-mail address in the format "user@example.com"', + /** + * The keystroke filter mask to be applied on email input. See the {@link #email} method for + * information about more complex email validation. Defaults to: + * /[a-z0-9_\.\-@]/i + * @type RegExp + */ + 'emailMask' : /[a-z0-9_\.\-@\+]/i, + + /** + * The function used to validate URLs + * @param {String} value The URL + * @return {Boolean} true if the RegExp test passed, and false if not. + */ + 'url' : function(v){ + return url.test(v); + }, + /** + * The error text to display when the url validation function returns false. Defaults to: + * 'This field should be a URL in the format "http:/'+'/www.example.com"' + * @type String + */ + 'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"', + + /** + * The function used to validate alpha values + * @param {String} value The value + * @return {Boolean} true if the RegExp test passed, and false if not. + */ + 'alpha' : function(v){ + return alpha.test(v); + }, + /** + * The error text to display when the alpha validation function returns false. Defaults to: + * 'This field should only contain letters and _' + * @type String + */ + 'alphaText' : 'This field should only contain letters and _', + /** + * The keystroke filter mask to be applied on alpha input. Defaults to: + * /[a-z_]/i + * @type RegExp + */ + 'alphaMask' : /[a-z_]/i, + + /** + * The function used to validate alphanumeric values + * @param {String} value The value + * @return {Boolean} true if the RegExp test passed, and false if not. + */ + 'alphanum' : function(v){ + return alphanum.test(v); + }, + /** + * The error text to display when the alphanumeric validation function returns false. Defaults to: + * 'This field should only contain letters, numbers and _' + * @type String + */ + 'alphanumText' : 'This field should only contain letters, numbers and _', + /** + * The keystroke filter mask to be applied on alphanumeric input. Defaults to: + * /[a-z0-9_]/i + * @type RegExp + */ + 'alphanumMask' : /[a-z0-9_]/i + }; +})()); + +/** + * @private + * @class Ext.layout.component.field.Text + * @extends Ext.layout.component.field.Field + * Layout class for {@link Ext.form.field.Text} fields. Handles sizing the input field. + */ +Ext.define('Ext.layout.component.field.Text', { + extend: 'Ext.layout.component.field.Field', + alias: 'layout.textfield', + requires: ['Ext.util.TextMetrics'], + + type: 'textfield', + + + /** + * Allow layout to proceed if the {@link Ext.form.field.Text#grow} config is enabled and the value has + * changed since the last layout. + */ + beforeLayout: function(width, height) { + var me = this, + owner = me.owner, + lastValue = this.lastValue, + value = owner.getRawValue(); + this.lastValue = value; + return me.callParent(arguments) || (owner.grow && value !== lastValue); + }, + + + /** + * Size the field body contents given the total dimensions of the bodyEl, taking into account the optional + * {@link Ext.form.field.Text#grow} configurations. + * @param {Number} width The bodyEl width + * @param {Number} height The bodyEl height + */ + sizeBodyContents: function(width, height) { + var size = this.adjustForGrow(width, height); + this.setElementSize(this.owner.inputEl, size[0], size[1]); + }, + + + /** + * Given the target bodyEl dimensions, adjust them if necessary to return the correct final + * size based on the text field's {@link Ext.form.field.Text#grow grow config}. + * @param {Number} width The bodyEl width + * @param {Number} height The bodyEl height + * @return {Array} [inputElWidth, inputElHeight] + */ + adjustForGrow: function(width, height) { + var me = this, + owner = me.owner, + inputEl, value, calcWidth, + result = [width, height]; + + if (owner.grow) { + inputEl = owner.inputEl; + + // Find the width that contains the whole text value + value = (inputEl.dom.value || (owner.hasFocus ? '' : owner.emptyText) || '') + owner.growAppend; + calcWidth = inputEl.getTextWidth(value) + inputEl.getBorderWidth("lr") + inputEl.getPadding("lr"); + + // Constrain + result[0] = Ext.Number.constrain(calcWidth, owner.growMin, + Math.max(owner.growMin, Math.min(owner.growMax, Ext.isNumber(width) ? width : Infinity))); + } + + return result; + } -// add a handler for a 'message' event sent by the server -Ext.Direct.on('message', function(e){ - out.append(String.format('<p><i>{0}</i></p>', e.data)); - out.el.scrollTo('t', 100000, true); }); - * - * @singleton + +/** + * @private + * @class Ext.layout.component.field.TextArea + * @extends Ext.layout.component.field.Field + * Layout class for {@link Ext.form.field.TextArea} fields. Handles sizing the textarea field. */ -Ext.Direct = Ext.extend(Ext.util.Observable, { +Ext.define('Ext.layout.component.field.TextArea', { + extend: 'Ext.layout.component.field.Text', + alias: 'layout.textareafield', + + type: 'textareafield', + + /** - * Each event type implements a getData() method. The default event types are: - *-{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"} +// custom Vtype for vtype:'IPAddress' +Ext.apply(Ext.form.field.VTypes, { + IPAddress: function(v) { + return /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(v); + }, + IPAddressText: 'Must be a numeric IP address', + IPAddressMask: /[\d\.]/i +}); + *
- * @property eventTypes - * @type Object + * Given the target bodyEl dimensions, adjust them if necessary to return the correct final + * size based on the text field's {@link Ext.form.field.Text#grow grow config}. Overrides the + * textfield layout's implementation to handle height rather than width. + * @param {Number} width The bodyEl width + * @param {Number} height The bodyEl height + * @return {Array} [inputElWidth, inputElHeight] */ + adjustForGrow: function(width, height) { + var me = this, + owner = me.owner, + inputEl, value, max, + curWidth, curHeight, calcHeight, + result = [width, height]; + + if (owner.grow) { + inputEl = owner.inputEl; + curWidth = inputEl.getWidth(true); //subtract border/padding to get the available width for the text + curHeight = inputEl.getHeight(); + + // Get and normalize the field value for measurement + value = inputEl.dom.value || ' '; + value += owner.growAppend; + + // Translate newlines to- *
- event : Ext.Direct.Event
- *- exception : Ext.Direct.ExceptionEvent
- *- rpc : Ext.Direct.RemotingEvent
- *
tags + value = value.replace(/\n/g, '
'); + + // Find the height that contains the whole text value + calcHeight = Ext.util.TextMetrics.measure(inputEl, value, curWidth).height + + inputEl.getBorderWidth("tb") + inputEl.getPadding("tb"); + + // Constrain + max = owner.growMax; + if (Ext.isNumber(height)) { + max = Math.min(max, height); + } + result[1] = Ext.Number.constrain(calcHeight, owner.growMin, max); + } + + return result; + } + +}); +/** + * @class Ext.layout.container.Anchor + * @extends Ext.layout.container.Container + * + * This is a layout that enables anchoring of contained elements relative to the container's dimensions. + * If the container is resized, all anchored items are automatically rerendered according to their + * {@link #anchor} rules. + * + * This class is intended to be extended or created via the layout: 'anchor' {@link Ext.layout.container.AbstractContainer#layout} + * config, and should generally not need to be created directly via the new keyword. + * + * AnchorLayout does not have any direct config options (other than inherited ones). By default, + * AnchorLayout will calculate anchor measurements based on the size of the container itself. However, the + * container using the AnchorLayout can supply an anchoring-specific config property of anchorSize. + * If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating + * anchor measurements based on it instead, allowing the container to be sized independently of the anchoring + * logic if necessary. + * + * {@img Ext.layout.container.Anchor/Ext.layout.container.Anchor.png Ext.layout.container.Anchor container layout} + * + * For example: + * Ext.create('Ext.Panel', { + * width: 500, + * height: 400, + * title: "AnchorLayout Panel", + * layout: 'anchor', + * renderTo: Ext.getBody(), + * items: [{ + * xtype: 'panel', + * title: '75% Width and 20% Height', + * anchor: '75% 20%' + * },{ + * xtype: 'panel', + * title: 'Offset -300 Width & -200 Height', + * anchor: '-300 -200' + * },{ + * xtype: 'panel', + * title: 'Mixed Offset and Percent', + * anchor: '-250 20%' + * }] + * }); + */ + +Ext.define('Ext.layout.container.Anchor', { + + /* Begin Definitions */ + + alias: 'layout.anchor', + extend: 'Ext.layout.container.Container', + alternateClassName: 'Ext.layout.AnchorLayout', + + /* End Definitions */ /** - * Four types of possible exceptions which can occur: - *- *
- Ext.Direct.exceptions.TRANSPORT : 'xhr'
- *- Ext.Direct.exceptions.PARSE : 'parse'
- *- Ext.Direct.exceptions.LOGIN : 'login'
- *- Ext.Direct.exceptions.SERVER : 'exception'
+ * @cfg {String} anchor + *This configuation option is to be applied to child items of a container managed by + * this layout (ie. configured with layout:'anchor').
+ * + *This value is what tells the layout how an item should be anchored to the container. items + * added to an AnchorLayout accept an anchoring-specific config property of anchor which is a string + * containing two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%'). + * The following types of anchor values are supported:
- * @property exceptions - * @type Object */ - exceptions: { - TRANSPORT: 'xhr', - PARSE: 'parse', - LOGIN: 'login', - SERVER: 'exception' - }, - // private - constructor: function(){ - this.addEvents( - /** - * @event event - * Fires after an event. - * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred. - * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. - */ - 'event', - /** - * @event exception - * Fires after an event exception. - * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred. - */ - 'exception' - ); - this.transactions = {}; - this.providers = {}; - }, + type: 'anchor', /** - * Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods. - * If the provider is not already connected, it will auto-connect. - *+ * + *
- Percentage : Any value between 1 and 100, expressed as a percentage.
+ * + *+ * The first anchor is the percentage width that the item should take up within the container, and the + * second is the percentage height. For example:+// two values specified +anchor: '100% 50%' // render item complete width of the container and + // 1/2 height of the container +// one value specified +anchor: '100%' // the width value; the height will default to auto + *
- Offsets : Any positive or negative integer value.
+ * + *+ * This is a raw adjustment where the first anchor is the offset from the right edge of the container, + * and the second is the offset from the bottom edge. For example:+// two values specified +anchor: '-50 -100' // render item the complete width of the container + // minus 50 pixels and + // the complete height minus 100 pixels. +// one value specified +anchor: '-50' // anchor value is assumed to be the right offset value + // bottom offset will default to 0 + *
- Sides : Valid values are 'right' (or 'r') and 'bottom' + * (or 'b').
+ * + *+ * Either the container must have a fixed size or an anchorSize config value defined at render time in + * order for these to have any effect.- Mixed :
+ * + * *+ * Anchor values can also be mixed as needed. For example, to render the width offset from the container + * right edge by 50 pixels and 75% of the container's height use: + *+anchor: '-50 75%' + *
- * @param {Object/Array} provider Accepts either an Array of Provider descriptions (an instance - * or config object for a Provider) or any number of Provider descriptions as arguments. Each - * Provider description instructs Ext.Direct how to create client-side stub methods. + * @cfg {String} defaultAnchor + * Default anchor for all child container items applied if no anchor or specific width is set on the child item. Defaults to '100%'. */ - addProvider : function(provider){ - var a = arguments; - if(a.length > 1){ - for(var i = 0, len = a.length; i < len; i++){ - this.addProvider(a[i]); - } + defaultAnchor: '100%', + + parseAnchorRE: /^(r|right|b|bottom)$/i, + + // private + onLayout: function() { + this.callParent(arguments); + + var me = this, + size = me.getLayoutTargetSize(), + owner = me.owner, + target = me.getTarget(), + ownerWidth = size.width, + ownerHeight = size.height, + overflow = target.getStyle('overflow'), + components = me.getVisibleItems(owner), + len = components.length, + boxes = [], + box, newTargetSize, component, anchorSpec, calcWidth, calcHeight, + i, el, cleaner; + + if (ownerWidth < 20 && ownerHeight < 20) { return; } - // if provider has not already been instantiated - if(!provider.events){ - provider = new Ext.Direct.PROVIDERS[provider.type](provider); + // Anchor layout uses natural HTML flow to arrange the child items. + // To ensure that all browsers (I'm looking at you IE!) add the bottom margin of the last child to the + // containing element height, we create a zero-sized element with style clear:both to force a "new line" + if (!me.clearEl) { + me.clearEl = target.createChild({ + cls: Ext.baseCSSPrefix + 'clear', + role: 'presentation' + }); + } + + // Work around WebKit RightMargin bug. We're going to inline-block all the children only ONCE and remove it when we're done + if (!Ext.supports.RightMargin) { + cleaner = Ext.core.Element.getRightMarginFixCleaner(target); + target.addCls(Ext.baseCSSPrefix + 'inline-children'); } - provider.id = provider.id || Ext.id(); - this.providers[provider.id] = provider; - provider.on('data', this.onProviderData, this); - provider.on('exception', this.onProviderException, this); + for (i = 0; i < len; i++) { + component = components[i]; + el = component.el; + anchorSpec = component.anchorSpec; + if (anchorSpec) { + if (anchorSpec.right) { + calcWidth = me.adjustWidthAnchor(anchorSpec.right(ownerWidth) - el.getMargin('lr'), component); + } else { + calcWidth = undefined; + } + if (anchorSpec.bottom) { + calcHeight = me.adjustHeightAnchor(anchorSpec.bottom(ownerHeight) - el.getMargin('tb'), component); + } else { + calcHeight = undefined; + } - if(!provider.isConnected()){ - provider.connect(); + boxes.push({ + component: component, + anchor: true, + width: calcWidth || undefined, + height: calcHeight || undefined + }); + } else { + boxes.push({ + component: component, + anchor: false + }); + } } - return provider; - }, + // Work around WebKit RightMargin bug. We're going to inline-block all the children only ONCE and remove it when we're done + if (!Ext.supports.RightMargin) { + target.removeCls(Ext.baseCSSPrefix + 'inline-children'); + cleaner(); + } - /** - * Retrieve a {@link Ext.direct.Provider provider} by the - * {@link Ext.direct.Provider#id id} specified when the provider is - * {@link #addProvider added}. - * @param {String} id Unique identifier assigned to the provider when calling {@link #addProvider} - */ - getProvider : function(id){ - return this.providers[id]; - }, + for (i = 0; i < len; i++) { + box = boxes[i]; + me.setItemSize(box.component, box.width, box.height); + } - removeProvider : function(id){ - var provider = id.id ? id : this.providers[id]; - provider.un('data', this.onProviderData, this); - provider.un('exception', this.onProviderException, this); - delete this.providers[provider.id]; - return provider; + if (overflow && overflow != 'hidden' && !me.adjustmentPass) { + newTargetSize = me.getLayoutTargetSize(); + if (newTargetSize.width != size.width || newTargetSize.height != size.height) { + me.adjustmentPass = true; + me.onLayout(); + } + } + + delete me.adjustmentPass; }, - addTransaction: function(t){ - this.transactions[t.tid] = t; - return t; + // private + parseAnchor: function(a, start, cstart) { + if (a && a != 'none') { + var ratio; + // standard anchor + if (this.parseAnchorRE.test(a)) { + var diff = cstart - start; + return function(v) { + return v - diff; + }; + } + // percentage + else if (a.indexOf('%') != -1) { + ratio = parseFloat(a.replace('%', '')) * 0.01; + return function(v) { + return Math.floor(v * ratio); + }; + } + // simple offset adjustment + else { + a = parseInt(a, 10); + if (!isNaN(a)) { + return function(v) { + return v + a; + }; + } + } + } + return null; }, - removeTransaction: function(t){ - delete this.transactions[t.tid || t]; - return t; + // private + adjustWidthAnchor: function(value, comp) { + return value; }, - getTransaction: function(tid){ - return this.transactions[tid.tid || tid]; + // private + adjustHeightAnchor: function(value, comp) { + return value; }, - onProviderData : function(provider, e){ - if(Ext.isArray(e)){ - for(var i = 0, len = e.length; i < len; i++){ - this.onProviderData(provider, e[i]); + configureItem: function(item) { + var me = this, + owner = me.owner, + anchor= item.anchor, + anchorsArray, + anchorSpec, + anchorWidth, + anchorHeight; + + if (!item.anchor && item.items && !Ext.isNumber(item.width) && !(Ext.isIE6 && Ext.isStrict)) { + item.anchor = anchor = me.defaultAnchor; + } + + // find the container anchoring size + if (owner.anchorSize) { + if (typeof owner.anchorSize == 'number') { + anchorWidth = owner.anchorSize; + } + else { + anchorWidth = owner.anchorSize.width; + anchorHeight = owner.anchorSize.height; } - return; } - if(e.name && e.name != 'event' && e.name != 'exception'){ - this.fireEvent(e.name, e); - }else if(e.type == 'exception'){ - this.fireEvent('exception', e); + else { + anchorWidth = owner.initialConfig.width; + anchorHeight = owner.initialConfig.height; } - this.fireEvent('event', e, provider); - }, - createEvent : function(response, extraProps){ - return new Ext.Direct.eventTypes[response.type](Ext.apply(response, extraProps)); + if (anchor) { + // cache all anchor values + anchorsArray = anchor.split(' '); + item.anchorSpec = anchorSpec = { + right: me.parseAnchor(anchorsArray[0], item.initialConfig.width, anchorWidth), + bottom: me.parseAnchor(anchorsArray[1], item.initialConfig.height, anchorHeight) + }; + + if (anchorSpec.right) { + item.layoutManagedWidth = 1; + } else { + item.layoutManagedWidth = 2; + } + + if (anchorSpec.bottom) { + item.layoutManagedHeight = 1; + } else { + item.layoutManagedHeight = 2; + } + } else { + item.layoutManagedWidth = 2; + item.layoutManagedHeight = 2; + } + this.callParent(arguments); } -}); -// overwrite impl. with static instance -Ext.Direct = new Ext.Direct(); -Ext.Direct.TID = 1; -Ext.Direct.PROVIDERS = {};/** - * @class Ext.Direct.Transaction - * @extends Object - *-var pollProv = new Ext.direct.PollingProvider({ - url: 'php/poll2.php' -}); - -Ext.Direct.addProvider( - { - "type":"remoting", // create a {@link Ext.direct.RemotingProvider} - "url":"php\/router.php", // url to connect to the Ext.Direct server-side router. - "actions":{ // each property within the actions object represents a Class - "TestAction":[ // array of methods within each server side Class - { - "name":"doEcho", // name of method - "len":1 - },{ - "name":"multiply", - "len":1 - },{ - "name":"doForm", - "formHandler":true, // handle form on server with Ext.Direct.Transaction - "len":1 - }] - }, - "namespace":"myApplication",// namespace to create the Remoting Provider in - },{ - type: 'polling', // create a {@link Ext.direct.PollingProvider} - url: 'php/poll.php' - }, - pollProv // reference to previously created instance -); - *
Supporting Class for Ext.Direct (not intended to be used directly).
- * @constructor - * @param {Object} config - */ -Ext.Direct.Transaction = function(config){ - Ext.apply(this, config); - this.tid = ++Ext.Direct.TID; - this.retryCount = 0; -}; -Ext.Direct.Transaction.prototype = { - send: function(){ - this.provider.queueTransaction(this); +}); +/** + * @class Ext.form.action.Load + * @extends Ext.form.action.Action + *A class which handles loading of data from a server into the Fields of an {@link Ext.form.Basic}.
+ *Instances of this class are only created by a {@link Ext.form.Basic Form} when + * {@link Ext.form.Basic#load load}ing.
+ *Response Packet Criteria
+ *A response packet must contain: + *
+ *+ *
- + *
success
property : Boolean- + *
data
property : ObjectThe+ *data
property contains the values of Fields to load. + * The individual value object for each Field is passed to the Field's + * {@link Ext.form.field.Field#setValue setValue} method.JSON Packets
+ *By default, response packets are assumed to be JSON, so for the following form load call:
+ * a success response packet may look like this:+var myFormPanel = new Ext.form.Panel({ + title: 'Client and routing info', + items: [{ + fieldLabel: 'Client', + name: 'clientName' + }, { + fieldLabel: 'Port of loading', + name: 'portOfLoading' + }, { + fieldLabel: 'Port of discharge', + name: 'portOfDischarge' + }] +}); +myFormPanel.{@link Ext.form.Panel#getForm getForm}().{@link Ext.form.Basic#load load}({ + url: '/getRoutingInfo.php', + params: { + consignmentRef: myConsignmentRef }, + failure: function(form, action) { + Ext.Msg.alert("Load failed", action.result.errorMessage); + } +}); +
+ * while a failure response packet may look like this:+{ + success: true, + data: { + clientName: "Fred. Olsen Lines", + portOfLoading: "FXT", + portOfDischarge: "OSL" + } +}
+ *+{ + success: false, + errorMessage: "Consignment reference not found" +}
Other data may be placed into the response for processing the {@link Ext.form.Basic Form}'s + * callback or event handler methods. The object decoded from this JSON is available in the + * {@link Ext.form.action.Action#result result} property.
+ */ +Ext.define('Ext.form.action.Load', { + extend:'Ext.form.action.Action', + requires: ['Ext.data.Connection'], + alternateClassName: 'Ext.form.Action.Load', + alias: 'formaction.load', - retry: function(){ - this.retryCount++; - this.send(); - }, + type: 'load', - getProvider: function(){ - return this.provider; - } -};Ext.Direct.Event = function(config){ - Ext.apply(this, config); -}; + /** + * @private + */ + run: function() { + Ext.Ajax.request(Ext.apply( + this.createCallback(), + { + method: this.getMethod(), + url: this.getUrl(), + headers: this.headers, + params: this.getParams() + } + )); + }, -Ext.Direct.Event.prototype = { - status: true, - getData: function(){ - return this.data; - } -}; + /** + * @private + */ + onSuccess: function(response){ + var result = this.processResponse(response), + form = this.form; + if (result === true || !result.success || !result.data) { + this.failureType = Ext.form.action.Action.LOAD_FAILURE; + form.afterAction(this, false); + return; + } + form.clearInvalid(); + form.setValues(result.data); + form.afterAction(this, true); + }, -Ext.Direct.RemotingEvent = Ext.extend(Ext.Direct.Event, { - type: 'rpc', - getTransaction: function(){ - return this.transaction || Ext.Direct.getTransaction(this.tid); + /** + * @private + */ + handleResponse: function(response) { + var reader = this.form.reader, + rs, data; + if (reader) { + rs = reader.read(response); + data = rs.records && rs.records[0] ? rs.records[0].data : null; + return { + success : rs.success, + data : data + }; + } + return Ext.decode(response.responseText); } }); -Ext.Direct.ExceptionEvent = Ext.extend(Ext.Direct.RemotingEvent, { - status: false, - type: 'exception' -}); -Ext.Direct.eventTypes = { - 'rpc': Ext.Direct.RemotingEvent, - 'event': Ext.Direct.Event, - 'exception': Ext.Direct.ExceptionEvent -}; /** - * @class Ext.direct.Provider - * @extends Ext.util.Observable - *Ext.direct.Provider is an abstract class meant to be extended.
- * - *For example ExtJs implements the following subclasses:
- *- * @abstract + * @class Ext.window.Window + * @extends Ext.panel.Panel + *-Provider -| -+---{@link Ext.direct.JsonProvider JsonProvider} - | - +---{@link Ext.direct.PollingProvider PollingProvider} - | - +---{@link Ext.direct.RemotingProvider RemotingProvider} - *
A specialized panel intended for use as an application window. Windows are floated, {@link #resizable}, and + * {@link #draggable} by default. Windows can be {@link #maximizable maximized} to fill the viewport, + * restored to their prior size, and can be {@link #minimize}d.
+ *Windows can also be linked to a {@link Ext.ZIndexManager} or managed by the {@link Ext.WindowManager} to provide + * grouping, activation, to front, to back and other application-specific behavior.
+ *By default, Windows will be rendered to document.body. To {@link #constrain} a Window to another element + * specify {@link Ext.Component#renderTo renderTo}.
+ *As with all {@link Ext.container.Container Container}s, it is important to consider how you want the Window + * to size and arrange any child Components. Choose an appropriate {@link #layout} configuration which lays out + * child Components in the required manner.
+ * {@img Ext.window.Window/Ext.window.Window.png Window component} + * Example:*/ -Ext.direct.Provider = Ext.extend(Ext.util.Observable, { +Ext.define('Ext.window.Window', { + extend: 'Ext.panel.Panel', + + alternateClassName: 'Ext.Window', + + requires: ['Ext.util.ComponentDragger', 'Ext.util.Region', 'Ext.EventManager'], + + alias: 'widget.window', + /** - * @cfg {String} id - * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}). - * You should assign an id if you need to be able to access the provider later and you do - * not have an object reference available, for example: - *
+Ext.create('Ext.window.Window', { + title: 'Hello', + height: 200, + width: 400, + layout: 'fit', + items: { // Let's put an empty grid in just to illustrate fit layout + xtype: 'grid', + border: false, + columns: [{header: 'World'}], // One header just for show. There's no data, + store: Ext.create('Ext.data.ArrayStore', {}) // A dummy empty data store + } +}).show(); ++ * @cfg {Number} x + * The X position of the left edge of the window on initial showing. Defaults to centering the Window within + * the width of the Window's container {@link Ext.core.Element Element) (The Element that the Window is rendered to). */ - /** - * @cfg {Number} priority - * Priority of the request. Lower is higher priority, 0 means "duplex" (always on). - * All Providers default to 1 except for PollingProvider which defaults to 3. - */ - priority: 1, - + * @cfg {Number} y + * The Y position of the top edge of the window on initial showing. Defaults to centering the Window within + * the height of the Window's container {@link Ext.core.Element Element) (The Element that the Window is rendered to). + */ /** - * @cfg {String} type - * Required, undefined by default. The type of provider specified - * to {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#addProvider addProvider} to create a - * new Provider. Acceptable values by default are:-Ext.Direct.addProvider( - { - type: 'polling', - url: 'php/poll.php', - id: 'poll-provider' - } -); - -var p = {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#getProvider getProvider}('poll-provider'); -p.disconnect(); - *
- *
- polling : {@link Ext.direct.PollingProvider PollingProvider}
- *- remoting : {@link Ext.direct.RemotingProvider RemotingProvider}
+ * @cfg {Boolean} modal + * True to make the window modal and mask everything behind it when displayed, false to display it without + * restricting access to other UI elements (defaults to false). + */ + /** + * @cfg {String/Element} animateTarget + * Id or element from which the window should animate while opening (defaults to null with no animation). + */ + /** + * @cfg {String/Number/Component} defaultFocus + *Specifies a Component to receive focus when this Window is focused.
+ *This may be one of:
- */ - - // private - constructor : function(config){ - Ext.apply(this, config); - this.addEvents( - /** - * @event connect - * Fires when the Provider connects to the server-side - * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. - */ - 'connect', - /** - * @event disconnect - * Fires when the Provider disconnects from the server-side - * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. - */ - 'disconnect', - /** - * @event data - * Fires when the Provider receives data from the server-side - * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. - * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred. - */ - 'data', - /** - * @event exception - * Fires when the Provider receives an exception from the server-side - */ - 'exception' - ); - Ext.direct.Provider.superclass.constructor.call(this, config); - }, + */ + /** + * @cfg {Function} onEsc + * Allows override of the built-in processing for the escape key. Default action + * is to close the Window (performing whatever action is specified in {@link #closeAction}. + * To prevent the Window closing when the escape key is pressed, specify this as + * Ext.emptyFn (See {@link Ext#emptyFn Ext.emptyFn}). + */ + /** + * @cfg {Boolean} collapsed + * True to render the window collapsed, false to render it expanded (defaults to false). Note that if + * {@link #expandOnShow} is true (the default) it will override the+ *
- The index of a footer Button.
+ *- The id or {@link Ext.AbstractComponent#itemId} of a descendant Component.
+ *- A Component.
*collapsed
config and the window + * will always be expanded when shown. + */ + /** + * @cfg {Boolean} maximized + * True to initially display the window in a maximized state. (Defaults to false). + */ /** - * Returns whether or not the server-side is currently connected. - * Abstract method for subclasses to implement. + * @cfg {String} baseCls + * The base CSS class to apply to this panel's element (defaults to 'x-window'). + */ + baseCls: Ext.baseCSSPrefix + 'window', + + /** + * @cfg {Mixed} resizable + *Specify as
+ *true
to allow user resizing at each edge and corner of the window, false to disable + * resizing (defaults to true).This may also be specified as a config object to
*/ - isConnected: function(){ - return false; - }, + resizable: true, /** - * Abstract methods for subclasses to implement. + * @cfg {Boolean} draggable + *True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note + * that by default the window will be centered in the viewport, so if dragging is disabled the window may need + * to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);).
*/ - connect: Ext.emptyFn, - + draggable: true, + /** - * Abstract methods for subclasses to implement. + * @cfg {Boolean} constrain + * True to constrain the window within its containing element, false to allow it to fall outside of its + * containing element. By default the window will be rendered to document.body. To render and constrain the + * window within another element specify {@link #renderTo}. + * (defaults to false). Optionally the header only can be constrained using {@link #constrainHeader}. */ - disconnect: Ext.emptyFn -}); -/** - * @class Ext.direct.JsonProvider - * @extends Ext.direct.Provider - */ -Ext.direct.JsonProvider = Ext.extend(Ext.direct.Provider, { - parseResponse: function(xhr){ - if(!Ext.isEmpty(xhr.responseText)){ - if(typeof xhr.responseText == 'object'){ - return xhr.responseText; - } - return Ext.decode(xhr.responseText); - } - return null; - }, + constrain: false, - getEvents: function(xhr){ - var data = null; - try{ - data = this.parseResponse(xhr); - }catch(e){ - var event = new Ext.Direct.ExceptionEvent({ - data: e, - xhr: xhr, - code: Ext.Direct.exceptions.PARSE, - message: 'Error parsing json response: \n\n ' + data - }); - return [event]; - } - var events = []; - if(Ext.isArray(data)){ - for(var i = 0, len = data.length; i < len; i++){ - events.push(Ext.Direct.createEvent(data[i])); - } - }else{ - events.push(Ext.Direct.createEvent(data)); - } - return events; - } -});/** - * @class Ext.direct.PollingProvider - * @extends Ext.direct.JsonProvider - * - *
Provides for repetitive polling of the server at distinct {@link #interval intervals}. - * The initial request for data originates from the client, and then is responded to by the - * server.
- * - *All configurations for the PollingProvider should be generated by the server-side - * API portion of the Ext.Direct stack.
- * - *An instance of PollingProvider may be created directly via the new keyword or by simply - * specifying type = 'polling'. For example:
- *- */ -Ext.direct.PollingProvider = Ext.extend(Ext.direct.JsonProvider, { /** - * @cfg {Number} priority - * Priority of the request (defaults to 3). See {@link Ext.direct.Provider#priority}. + * @cfg {Boolean} expandOnShow + * True to always expand the window when it is displayed, false to keep it in its current state (which may be + * {@link #collapsed}) when displayed (defaults to true). */ - // override default priority - priority: 3, - + expandOnShow: true, + + // inherited docs, same default + collapsible: false, + /** - * @cfg {Number} interval - * How often to poll the server-side in milliseconds (defaults to 3000 - every - * 3 seconds). + * @cfg {Boolean} closable + *-var pollA = new Ext.direct.PollingProvider({ - type:'polling', - url: 'php/pollA.php', -}); -Ext.Direct.addProvider(pollA); -pollA.disconnect(); + /** + * @cfg {Boolean} constrainHeader + * True to constrain the window header within its containing element (allowing the window body to fall outside + * of its containing element) or false to allow the header to fall outside its containing element (defaults to + * false). Optionally the entire window can be constrained using {@link #constrain}. + */ + constrainHeader: false, + + /** + * @cfg {Boolean} plain + * True to render the window body with a transparent background so that it will blend into the framing + * elements, false to add a lighter background color to visually highlight the body element and separate it + * more distinctly from the surrounding frame (defaults to false). + */ + plain: false, + + /** + * @cfg {Boolean} minimizable + * True to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button + * and disallow minimizing the window (defaults to false). Note that this button provides no implementation -- + * the behavior of minimizing a window is implementation-specific, so the minimize event must be handled and a + * custom minimize behavior implemented for this option to be useful. + */ + minimizable: false, + + /** + * @cfg {Boolean} maximizable + * True to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button + * and disallow maximizing the window (defaults to false). Note that when a window is maximized, the tool button + * will automatically change to a 'restore' button with the appropriate behavior already built-in that will + * restore the window to its previous size. + */ + maximizable: false, + + // inherit docs + minHeight: 100, + + // inherit docs + minWidth: 200, -Ext.Direct.addProvider( - { - type:'polling', - url: 'php/pollB.php', - id: 'pollB-provider' - } -); -var pollB = Ext.Direct.getProvider('pollB-provider'); - *
True to display the 'close' tool button and allow the user to close the window, false to + * hide the button and disallow closing the window (defaults to
+ *true
).By default, when close is requested by either clicking the close button in the header + * or pressing ESC when the Window has focus, the {@link #close} method will be called. This + * will {@link Ext.Component#destroy destroy} the Window and its content meaning that + * it may not be reused.
+ *To make closing a Window hide the Window so that it may be reused, set + * {@link #closeAction} to 'hide'.
*/ - interval: 3000, + closable: true, /** - * @cfg {Object} baseParams An object containing properties which are to be sent as parameters - * on every polling request + * @cfg {Boolean} hidden + * Render this Window hidden (default istrue
). Iftrue
, the + * {@link #hide} method will be called internally. */ + hidden: true, + + // Inherit docs from Component. Windows render to the body on first show. + autoRender: true, + + // Inherit docs from Component. Windows hide using visibility. + hideMode: 'visibility', + + /** @cfg {Boolean} floating @hide Windows are always floating*/ + floating: true, + + ariaRole: 'alertdialog', - /** - * @cfg {String/Function} url - * The url which the PollingProvider should contact with each request. This can also be - * an imported Ext.Direct method which will accept the baseParams as its only argument. - */ + itemCls: 'x-window-item', + + overlapHeader: true, + + ignoreHeaderBorderManagement: true, // private - constructor : function(config){ - Ext.direct.PollingProvider.superclass.constructor.call(this, config); - this.addEvents( + initComponent: function() { + var me = this; + me.callParent(); + me.addEvents( /** - * @event beforepoll - * Fired immediately before a poll takes place, an event handler can return false - * in order to cancel the poll. - * @param {Ext.direct.PollingProvider} + * @event activate + * Fires after the window has been visually activated via {@link #setActive}. + * @param {Ext.window.Window} this */ - 'beforepoll', /** - * @event poll - * This event has not yet been implemented. - * @param {Ext.direct.PollingProvider} + * @event deactivate + * Fires after the window has been visually deactivated via {@link #setActive}. + * @param {Ext.window.Window} this */ - 'poll' + /** + * @event resize + * Fires after the window has been resized. + * @param {Ext.window.Window} this + * @param {Number} width The window's new width + * @param {Number} height The window's new height + */ + 'resize', + /** + * @event maximize + * Fires after the window has been maximized. + * @param {Ext.window.Window} this + */ + 'maximize', + /** + * @event minimize + * Fires after the window has been minimized. + * @param {Ext.window.Window} this + */ + 'minimize', + /** + * @event restore + * Fires after the window has been restored to its original size after being maximized. + * @param {Ext.window.Window} this + */ + 'restore' ); + + if (me.plain) { + me.addClsWithUI('plain'); + } + + if (me.modal) { + me.ariaRole = 'dialog'; + } }, - // inherited - isConnected: function(){ - return !!this.pollTask; + // State Management + // private + + initStateEvents: function(){ + var events = this.stateEvents; + // push on stateEvents if they don't exist + Ext.each(['maximize', 'restore', 'resize', 'dragend'], function(event){ + if (Ext.Array.indexOf(events, event)) { + events.push(event); + } + }); + this.callParent(); }, - /** - * Connect to the server-side and begin the polling process. To handle each - * response subscribe to the data event. - */ - connect: function(){ - if(this.url && !this.pollTask){ - this.pollTask = Ext.TaskMgr.start({ - run: function(){ - if(this.fireEvent('beforepoll', this) !== false){ - if(typeof this.url == 'function'){ - this.url(this.baseParams); - }else{ - Ext.Ajax.request({ - url: this.url, - callback: this.onData, - scope: this, - params: this.baseParams - }); - } - } - }, - interval: this.interval, - scope: this - }); - this.fireEvent('connect', this); - }else if(!this.url){ - throw 'Error initializing PollingProvider, no url configured.'; + getState: function() { + var me = this, + state = me.callParent() || {}, + maximized = !!me.maximized; + + state.maximized = maximized; + Ext.apply(state, { + size: maximized ? me.restoreSize : me.getSize(), + pos: maximized ? me.restorePos : me.getPosition() + }); + return state; + }, + + applyState: function(state){ + var me = this; + + if (state) { + me.maximized = state.maximized; + if (me.maximized) { + me.hasSavedRestore = true; + me.restoreSize = state.size; + me.restorePos = state.pos; + } else { + Ext.apply(me, { + width: state.size.width, + height: state.size.height, + x: state.pos[0], + y: state.pos[1] + }); + } } }, - /** - * Disconnect from the server-side and stop the polling process. The disconnect - * event will be fired on a successful disconnect. - */ - disconnect: function(){ - if(this.pollTask){ - Ext.TaskMgr.stop(this.pollTask); - delete this.pollTask; - this.fireEvent('disconnect', this); + // private + onMouseDown: function () { + if (this.floating) { + this.toFront(); } }, // private - onData: function(opt, success, xhr){ - if(success){ - var events = this.getEvents(xhr); - for(var i = 0, len = events.length; i < len; i++){ - var e = events[i]; - this.fireEvent('data', this, e); - } - }else{ - var e = new Ext.Direct.ExceptionEvent({ - data: e, - code: Ext.Direct.exceptions.TRANSPORT, - message: 'Unable to connect to the server.', - xhr: xhr + onRender: function(ct, position) { + var me = this; + me.callParent(arguments); + me.focusEl = me.el; + + // Double clicking a header will toggleMaximize + if (me.maximizable) { + me.header.on({ + dblclick: { + fn: me.toggleMaximize, + element: 'el', + scope: me + } }); - this.fireEvent('data', this, e); } - } -}); + }, -Ext.Direct.PROVIDERS['polling'] = Ext.direct.PollingProvider;/** - * @class Ext.direct.RemotingProvider - * @extends Ext.direct.JsonProvider - * - *The {@link Ext.direct.RemotingProvider RemotingProvider} exposes access to - * server side methods on the client (a remote procedure call (RPC) type of - * connection where the client can initiate a procedure on the server).
- * - *This allows for code to be organized in a fashion that is maintainable, - * while providing a clear path between client and server, something that is - * not always apparent when using URLs.
- * - *To accomplish this the server-side needs to describe what classes and methods - * are available on the client-side. This configuration will typically be - * outputted by the server-side Ext.Direct stack when the API description is built.
- */ -Ext.direct.RemotingProvider = Ext.extend(Ext.direct.JsonProvider, { - /** - * @cfg {Object} actions - * Object literal defining the server side actions and methods. For example, if - * the Provider is configured with: - *- *-"actions":{ // each property within the 'actions' object represents a server side Class - "TestAction":[ // array of methods within each server side Class to be - { // stubbed out on client - "name":"doEcho", - "len":1 - },{ - "name":"multiply",// name of method - "len":2 // The number of parameters that will be used to create an - // array of data to send to the server side function. - // Ensure the server sends back a Number, not a String. - },{ - "name":"doForm", - "formHandler":true, // direct the client to use specialized form handling method - "len":1 - }] -} - *
Note that a Store is not required, a server method can be called at any time. - * In the following example a client side handler is used to call the - * server side method "multiply" in the server-side "TestAction" Class:
- *- * In the example above, the server side "multiply" function will be passed two - * arguments (2 and 4). The "multiply" method should return the value 8 which will be - * available as the result in the example above. - */ - - /** - * @cfg {String/Object} namespace - * Namespace for the Remoting Provider (defaults to the browser global scope of window). - * Explicitly specify the namespace Object, or specify a String to have a - * {@link Ext#namespace namespace created} implicitly. - */ - - /** - * @cfg {String} url - * Required. The url to connect to the {@link Ext.Direct} server-side router. - */ - - /** - * @cfg {String} enableUrlEncode - * Specify which param will hold the arguments for the method. - * Defaults to 'data'. - */ - - /** - * @cfg {Number/Boolean} enableBuffer - *-TestAction.multiply( - 2, 4, // pass two arguments to server, so specify len=2 - // callback function after the server is called - // result: the result returned by the server - // e: Ext.Direct.RemotingEvent object - function(result, e){ - var t = e.getTransaction(); - var action = t.action; // server side Class called - var method = t.method; // server side method called - if(e.status){ - var answer = Ext.encode(result); // 8 - - }else{ - var msg = e.message; // failure message + // private + afterRender: function() { + var me = this, + hidden = me.hidden, + keyMap; + + me.hidden = false; + // Component's afterRender sizes and positions the Component + me.callParent(); + me.hidden = hidden; + + // Create the proxy after the size has been applied in Component.afterRender + me.proxy = me.getProxy(); + + // clickToRaise + me.mon(me.el, 'mousedown', me.onMouseDown, me); + + // Initialize + if (me.maximized) { + me.maximized = false; + me.maximize(); } - } -); - *
true or false to enable or disable combining of method - * calls. If a number is specified this is the amount of time in milliseconds - * to wait before sending a batched request (defaults to 10).
- *Calls which are received within the specified timeframe will be - * concatenated together and sent in a single request, optimizing the - * application by reducing the amount of round trips that have to be made - * to the server.
- */ - enableBuffer: 10, - - /** - * @cfg {Number} maxRetries - * Number of times to re-attempt delivery on failure of a call. Defaults to 1. - */ - maxRetries: 1, - + + if (me.closable) { + keyMap = me.getKeyMap(); + keyMap.on(27, me.onEsc, me); + + //if (hidden) { ? would be consistent w/before/afterShow... + keyMap.disable(); + //} + } + + if (!hidden) { + me.syncMonitorWindowResize(); + me.doConstrain(); + } + }, + /** - * @cfg {Number} timeout - * The timeout to use for each request. Defaults to undefined. + * @private + * @override + * Override Component.initDraggable. + * Window uses the header element as the delegate. */ - timeout: undefined, + initDraggable: function() { + var me = this, + ddConfig; - constructor : function(config){ - Ext.direct.RemotingProvider.superclass.constructor.call(this, config); - this.addEvents( - /** - * @event beforecall - * Fires immediately before the client-side sends off the RPC call. - * By returning false from an event handler you can prevent the call from - * executing. - * @param {Ext.direct.RemotingProvider} provider - * @param {Ext.Direct.Transaction} transaction - */ - 'beforecall', - /** - * @event call - * Fires immediately after the request to the server-side is sent. This does - * NOT fire after the response has come back from the call. - * @param {Ext.direct.RemotingProvider} provider - * @param {Ext.Direct.Transaction} transaction - */ - 'call' - ); - this.namespace = (Ext.isString(this.namespace)) ? Ext.ns(this.namespace) : this.namespace || window; - this.transactions = {}; - this.callBuffer = []; - }, + if (!me.header) { + me.updateHeader(true); + } + + /* + * Check the header here again. If for whatever reason it wasn't created in + * updateHeader (preventHeader) then we'll just ignore the rest since the + * header acts as the drag handle. + */ + if (me.header) { + ddConfig = Ext.applyIf({ + el: me.el, + delegate: '#' + me.header.id + }, me.draggable); - // private - initAPI : function(){ - var o = this.actions; - for(var c in o){ - var cls = this.namespace[c] || (this.namespace[c] = {}), - ms = o[c]; - for(var i = 0, len = ms.length; i < len; i++){ - var m = ms[i]; - cls[m.name] = this.createMethod(c, m); + // Add extra configs if Window is specified to be constrained + if (me.constrain || me.constrainHeader) { + ddConfig.constrain = me.constrain; + ddConfig.constrainDelegate = me.constrainHeader; + ddConfig.constrainTo = me.constrainTo || me.container; } + + /** + *If this Window is configured {@link #draggable}, this property will contain + * an instance of {@link Ext.util.ComponentDragger} (A subclass of {@link Ext.dd.DragTracker DragTracker}) + * which handles dragging the Window's DOM Element, and constraining according to the {@link #constrain} + * and {@link #constrainHeader} .
+ *This has implementations of
+ * @type Ext.util.ComponentDragger + * @property dd + */ + me.dd = Ext.create('Ext.util.ComponentDragger', this, ddConfig); + me.relayEvents(me.dd, ['dragstart', 'drag', 'dragend']); } }, - // inherited - isConnected: function(){ - return !!this.connected; + // private + onEsc: function(k, e) { + e.stopEvent(); + this[this.closeAction](); }, - connect: function(){ - if(this.url){ - this.initAPI(); - this.connected = true; - this.fireEvent('connect', this); - }else if(!this.url){ - throw 'Error initializing RemotingProvider, no url configured.'; + // private + beforeDestroy: function() { + var me = this; + if (me.rendered) { + delete this.animateTarget; + me.hide(); + Ext.destroy( + me.keyMap + ); } + me.callParent(); }, - disconnect: function(){ - if(this.connected){ - this.connected = false; - this.fireEvent('disconnect', this); + /** + * @private + * @override + * Contribute class-specific tools to the header. + * Called by Panel's initTools. + */ + addTools: function() { + var me = this; + + // Call Panel's initTools + me.callParent(); + + if (me.minimizable) { + me.addTool({ + type: 'minimize', + handler: Ext.Function.bind(me.minimize, me, []) + }); + } + if (me.maximizable) { + me.addTool({ + type: 'maximize', + handler: Ext.Function.bind(me.maximize, me, []) + }); + me.addTool({ + type: 'restore', + handler: Ext.Function.bind(me.restore, me, []), + hidden: true + }); } }, - onData: function(opt, success, xhr){ - if(success){ - var events = this.getEvents(xhr); - for(var i = 0, len = events.length; i < len; i++){ - var e = events[i], - t = this.getTransaction(e); - this.fireEvent('data', this, e); - if(t){ - this.doCallback(t, e, true); - Ext.Direct.removeTransaction(t); - } - } - }else{ - var ts = [].concat(opt.ts); - for(var i = 0, len = ts.length; i < len; i++){ - var t = this.getTransaction(ts[i]); - if(t && t.retryCount < this.maxRetries){ - t.retry(); - }else{ - var e = new Ext.Direct.ExceptionEvent({ - data: e, - transaction: t, - code: Ext.Direct.exceptions.TRANSPORT, - message: 'Unable to connect to the server.', - xhr: xhr - }); - this.fireEvent('data', this, e); - if(t){ - this.doCallback(t, e, false); - Ext.Direct.removeTransaction(t); - } - } + /** + * Gets the configured default focus item. If a {@link #defaultFocus} is set, it will receive focus, otherwise the + * Container itself will receive focus. + */ + getFocusEl: function() { + var me = this, + f = me.focusEl, + defaultComp = me.defaultButton || me.defaultFocus, + t = typeof db, + el, + ct; + + if (Ext.isDefined(defaultComp)) { + if (Ext.isNumber(defaultComp)) { + f = me.query('button')[defaultComp]; + } else if (Ext.isString(defaultComp)) { + f = me.down('#' + defaultComp); + } else { + f = defaultComp; } } + return f || me.focusEl; }, - getCallData: function(t){ - return { - action: t.action, - method: t.method, - data: t.data, - type: 'rpc', - tid: t.tid - }; + // private + beforeShow: function() { + this.callParent(); + + if (this.expandOnShow) { + this.expand(false); + } }, - doSend : function(data){ - var o = { - url: this.url, - callback: this.onData, - scope: this, - ts: data, - timeout: this.timeout - }, callData; + // private + afterShow: function(animateTarget) { + var me = this, + animating = animateTarget || me.animateTarget; - if(Ext.isArray(data)){ - callData = []; - for(var i = 0, len = data.length; i < len; i++){ - callData.push(this.getCallData(data[i])); - } - }else{ - callData = this.getCallData(data); + + if (animating) { + /* + * If we're animating, constrain the positioning before calling the + * superclass, otherwise we'll be animating to the unconstrained + * window position. + */ + me.doConstrain(); } + // Perform superclass's afterShow tasks + // Which might include animating a proxy from an animTarget + me.callParent(arguments); - if(this.enableUrlEncode){ - var params = {}; - params[Ext.isString(this.enableUrlEncode) ? this.enableUrlEncode : 'data'] = Ext.encode(callData); - o.params = params; - }else{ - o.jsonData = callData; + if (me.maximized) { + me.fitContainer(); } - Ext.Ajax.request(o); - }, - combineAndSend : function(){ - var len = this.callBuffer.length; - if(len > 0){ - this.doSend(len == 1 ? this.callBuffer[0] : this.callBuffer); - this.callBuffer = []; + me.syncMonitorWindowResize(); + if (!animating) { + me.doConstrain(); } - }, - queueTransaction: function(t){ - if(t.form){ - this.processForm(t); - return; - } - this.callBuffer.push(t); - if(this.enableBuffer){ - if(!this.callTask){ - this.callTask = new Ext.util.DelayedTask(this.combineAndSend, this); - } - this.callTask.delay(Ext.isNumber(this.enableBuffer) ? this.enableBuffer : 10); - }else{ - this.combineAndSend(); + if (me.keyMap) { + me.keyMap.enable(); } }, - doCall : function(c, m, args){ - var data = null, hs = args[m.len], scope = args[m.len+1]; + // private + doClose: function() { + var me = this; - if(m.len !== 0){ - data = args.slice(0, m.len); + // immediate close + if (me.hidden) { + me.fireEvent('close', me); + me[me.closeAction](); + } else { + // close after hiding + me.hide(me.animTarget, me.doClose, me); } + }, - var t = new Ext.Direct.Transaction({ - provider: this, - args: args, - action: c, - method: m.name, - data: data, - cb: scope && Ext.isFunction(hs) ? hs.createDelegate(scope) : hs - }); + // private + afterHide: function() { + var me = this; - if(this.fireEvent('beforecall', this, t) !== false){ - Ext.Direct.addTransaction(t); - this.queueTransaction(t); - this.fireEvent('call', this, t); + // No longer subscribe to resizing now that we're hidden + me.syncMonitorWindowResize(); + + // Turn off keyboard handling once window is hidden + if (me.keyMap) { + me.keyMap.disable(); } - }, - doForm : function(c, m, form, callback, scope){ - var t = new Ext.Direct.Transaction({ - provider: this, - action: c, - method: m.name, - args:[form, callback, scope], - cb: scope && Ext.isFunction(callback) ? callback.createDelegate(scope) : callback, - isForm: true - }); + // Perform superclass's afterHide tasks. + me.callParent(arguments); + }, - if(this.fireEvent('beforecall', this, t) !== false){ - Ext.Direct.addTransaction(t); - var isUpload = String(form.getAttribute("enctype")).toLowerCase() == 'multipart/form-data', - params = { - extTID: t.tid, - extAction: c, - extMethod: m.name, - extType: 'rpc', - extUpload: String(isUpload) - }; - - // change made from typeof callback check to callback.params - // to support addl param passing in DirectSubmit EAC 6/2 - Ext.apply(t, { - form: Ext.getDom(form), - isUpload: isUpload, - params: callback && Ext.isObject(callback.params) ? Ext.apply(params, callback.params) : params - }); - this.fireEvent('call', this, t); - this.processForm(t); + // private + onWindowResize: function() { + if (this.maximized) { + this.fitContainer(); } + this.doConstrain(); }, - - processForm: function(t){ - Ext.Ajax.request({ - url: this.url, - params: t.params, - callback: this.onData, - scope: this, - form: t.form, - isUpload: t.isUpload, - ts: t - }); + + /** + * Placeholder method for minimizing the window. By default, this method simply fires the {@link #minimize} event + * since the behavior of minimizing a window is application-specific. To implement custom minimize behavior, + * either the minimize event can be handled or this method can be overridden. + * @return {Ext.window.Window} this + */ + minimize: function() { + this.fireEvent('minimize', this); + return this; }, - createMethod : function(c, m){ - var f; - if(!m.formHandler){ - f = function(){ - this.doCall(c, m, Array.prototype.slice.call(arguments, 0)); - }.createDelegate(this); - }else{ - f = function(form, callback, scope){ - this.doForm(c, m, form, callback, scope); - }.createDelegate(this); + afterCollapse: function() { + var me = this; + + if (me.maximizable) { + me.tools.maximize.hide(); + me.tools.restore.hide(); } - f.directCfg = { - action: c, - method: m - }; - return f; + if (me.resizer) { + me.resizer.disable(); + } + me.callParent(arguments); }, - getTransaction: function(opt){ - return opt && opt.tid ? Ext.Direct.getTransaction(opt.tid) : null; + afterExpand: function() { + var me = this; + + if (me.maximized) { + me.tools.restore.show(); + } else if (me.maximizable) { + me.tools.maximize.show(); + } + if (me.resizer) { + me.resizer.enable(); + } + me.callParent(arguments); }, - doCallback: function(t, e){ - var fn = e.status ? 'success' : 'failure'; - if(t && t.cb){ - var hs = t.cb, - result = Ext.isDefined(e.result) ? e.result : e.data; - if(Ext.isFunction(hs)){ - hs(result, e); - } else{ - Ext.callback(hs[fn], hs.scope, [result, e]); - Ext.callback(hs.callback, hs.scope, [result, e]); + /** + * Fits the window within its current container and automatically replaces + * the {@link #maximizable 'maximize' tool button} with the 'restore' tool button. + * Also see {@link #toggleMaximize}. + * @return {Ext.window.Window} this + */ + maximize: function() { + var me = this; + + if (!me.maximized) { + me.expand(false); + if (!me.hasSavedRestore) { + me.restoreSize = me.getSize(); + me.restorePos = me.getPosition(true); } - } - } -}); -Ext.Direct.PROVIDERS['remoting'] = Ext.direct.RemotingProvider;/** - * @class Ext.Resizable - * @extends Ext.util.Observable - *onBeforeStart
,onDrag
andonEnd
+ * which perform the dragging action. If extra logic is needed at these points, use + * {@link Ext.Function#createInterceptor createInterceptor} or {@link Ext.Function#createSequence createSequence} to + * augment the existing implementations.Applies drag handles to an element to make it resizable. The drag handles are inserted into the element - * and positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap - * the textarea in a div and set 'resizeChild' to true (or to the id of the element), or set wrap:true in your config and - * the element will be wrapped for you automatically.
- *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 -- *Here's an example showing the creation of a typical Resizable:
- *- *-var resizer = new Ext.Resizable('element-id', { - handles: 'all', - minWidth: 200, - minHeight: 100, - maxWidth: 500, - maxHeight: 400, - pinned: true -}); -resizer.on('resize', myHandler); -
To hide a particular handle, set its display to none in CSS, or through script:
- * @constructor - * Create a new resizable component - * @param {Mixed} el The id or element to resize - * @param {Object} config configuration options - */ -Ext.Resizable = Ext.extend(Ext.util.Observable, { + if (me.maximizable) { + me.tools.maximize.hide(); + me.tools.restore.show(); + } + me.maximized = true; + me.el.disableShadow(); - constructor: function(el, config){ - this.el = Ext.get(el); - if(config && config.wrap){ - config.resizeChild = this.el; - this.el = this.el.wrap(typeof config.wrap == 'object' ? config.wrap : {cls:'xresizable-wrap'}); - this.el.id = this.el.dom.id = config.resizeChild.id + '-rzwrap'; - this.el.setStyle('overflow', 'hidden'); - this.el.setPositioning(config.resizeChild.getPositioning()); - config.resizeChild.clearPositioning(); - if(!config.width || !config.height){ - var csize = config.resizeChild.getSize(); - this.el.setSize(csize.width, csize.height); + if (me.dd) { + me.dd.disable(); } - if(config.pinned && !config.adjustments){ - config.adjustments = 'auto'; + if (me.collapseTool) { + me.collapseTool.hide(); } + me.el.addCls(Ext.baseCSSPrefix + 'window-maximized'); + me.container.addCls(Ext.baseCSSPrefix + 'window-maximized-ct'); + + me.syncMonitorWindowResize(); + me.setPosition(0, 0); + me.fitContainer(); + me.fireEvent('maximize', me); } + return me; + }, - /** - * The proxy Element that is resized in place of the real Element during the resize operation. - * This may be queried using {@link Ext.Element#getBox} to provide the new area to resize to. - * Read only. - * @type Ext.Element. - * @property proxy - */ - this.proxy = this.el.createProxy({tag: 'div', cls: 'x-resizable-proxy', id: this.el.id + '-rzproxy'}, Ext.getBody()); - this.proxy.unselectable(); - this.proxy.enableDisplayMode('block'); + /** + * Restores a {@link #maximizable maximized} window back to its original + * size and position prior to being maximized and also replaces + * the 'restore' tool button with the 'maximize' tool button. + * Also see {@link #toggleMaximize}. + * @return {Ext.window.Window} this + */ + restore: function() { + var me = this, + tools = me.tools; - Ext.apply(this, config); + if (me.maximized) { + delete me.hasSavedRestore; + me.removeCls(Ext.baseCSSPrefix + 'window-maximized'); - if(this.pinned){ - this.disableTrackOver = true; - this.el.addClass('x-resizable-pinned'); - } - // if the element isn't positioned, make it relative - var position = this.el.getStyle('position'); - if(position != 'absolute' && position != 'fixed'){ - this.el.setStyle('position', 'relative'); - } - if(!this.handles){ // no handles passed, must be legacy style - this.handles = 's,e,se'; - if(this.multiDirectional){ - this.handles += ',n,w'; + // Toggle tool visibility + if (tools.restore) { + tools.restore.hide(); } - } - if(this.handles == 'all'){ - this.handles = 'n s e w ne nw se sw'; - } - var hs = this.handles.split(/\s*?[,;]\s*?| /); - var ps = Ext.Resizable.positions; - for(var i = 0, len = hs.length; i < len; i++){ - if(hs[i] && ps[hs[i]]){ - var pos = ps[hs[i]]; - this[pos] = new Ext.Resizable.Handle(this, pos, this.disableTrackOver, this.transparent, this.handleCls); + if (tools.maximize) { + tools.maximize.show(); + } + if (me.collapseTool) { + me.collapseTool.show(); } - } - // legacy - this.corner = this.southeast; - if(this.handles.indexOf('n') != -1 || this.handles.indexOf('w') != -1){ - this.updateBox = true; - } + // Restore the position/sizing + me.setPosition(me.restorePos); + me.setSize(me.restoreSize); - this.activeHandle = null; + // Unset old position/sizing + delete me.restorePos; + delete me.restoreSize; - if(this.resizeChild){ - if(typeof this.resizeChild == 'boolean'){ - this.resizeChild = Ext.get(this.el.dom.firstChild, true); - }else{ - this.resizeChild = Ext.get(this.resizeChild, true); - } - } + me.maximized = false; - if(this.adjustments == 'auto'){ - var rc = this.resizeChild; - var hw = this.west, he = this.east, hn = this.north, hs = this.south; - if(rc && (hw || hn)){ - rc.position('relative'); - rc.setLeft(hw ? hw.el.getWidth() : 0); - rc.setTop(hn ? hn.el.getHeight() : 0); - } - this.adjustments = [ - (he ? -he.el.getWidth() : 0) + (hw ? -hw.el.getWidth() : 0), - (hn ? -hn.el.getHeight() : 0) + (hs ? -hs.el.getHeight() : 0) -1 - ]; - } + me.el.enableShadow(true); - if(this.draggable){ - this.dd = this.dynamic ? - this.el.initDD(null) : this.el.initDDProxy(null, {dragElId: this.proxy.id}); - this.dd.setHandleElId(this.resizeChild ? this.resizeChild.id : this.el.id); - if(this.constrainTo){ - this.dd.constrainTo(this.constrainTo); + // Allow users to drag and drop again + if (me.dd) { + me.dd.enable(); } - } - this.addEvents( - /** - * @event beforeresize - * Fired before resize is allowed. Set {@link #enabled} to false to cancel resize. - * @param {Ext.Resizable} this - * @param {Ext.EventObject} e The mousedown event - */ - 'beforeresize', - /** - * @event resize - * Fired after a resize. - * @param {Ext.Resizable} this - * @param {Number} width The new width - * @param {Number} height The new height - * @param {Ext.EventObject} e The mouseup event - */ - 'resize' - ); + me.container.removeCls(Ext.baseCSSPrefix + 'window-maximized-ct'); - if(this.width !== null && this.height !== null){ - this.resizeTo(this.width, this.height); - }else{ - this.updateChildSize(); - } - if(Ext.isIE){ - this.el.dom.style.zoom = 1; + me.syncMonitorWindowResize(); + me.doConstrain(); + me.fireEvent('restore', me); } - Ext.Resizable.superclass.constructor.call(this); + return me; }, /** - * @cfg {Array/String} adjustments String 'auto' or an array [width, height] with values to be added to the - * resize operation's new size (defaults to [0, 0]) - */ - adjustments : [0, 0], - /** - * @cfg {Boolean} animate True to animate the resize (not compatible with dynamic sizing, defaults to false) + * Synchronizes the presence of our listener for window resize events. This method + * should be called whenever this status might change. + * @private */ - animate : false, + syncMonitorWindowResize: function () { + var me = this, + currentlyMonitoring = me._monitoringResize, + // all the states where we should be listening to window resize: + yes = me.monitorResize || me.constrain || me.constrainHeader || me.maximized, + // all the states where we veto this: + veto = me.hidden || me.destroying || me.isDestroyed; + + if (yes && !veto) { + // we should be listening... + if (!currentlyMonitoring) { + // but we aren't, so set it up + Ext.EventManager.onWindowResize(me.onWindowResize, me); + me._monitoringResize = true; + } + } else if (currentlyMonitoring) { + // we should not be listening, but we are, so tear it down + Ext.EventManager.removeResizeListener(me.onWindowResize, me); + me._monitoringResize = false; + } + }, + /** - * @cfg {Mixed} constrainTo Constrain the resize to a particular element + * A shortcut method for toggling between {@link #maximize} and {@link #restore} based on the current maximized + * state of the window. + * @return {Ext.window.Window} this */ + toggleMaximize: function() { + return this[this.maximized ? 'restore': 'maximize'](); + } + /** - * @cfg {Boolean} disableTrackOver True to disable mouse tracking. This is only applied at config time. (defaults to false) - */ - disableTrackOver : false, + * @cfg {Boolean} autoWidth @hide + * Absolute positioned element and therefore cannot support autoWidth. + * A width is a required configuration. + **/ +}); +/** + * @class Ext.form.field.Base + * @extends Ext.Component + +Base class for form fields that provides default event handling, rendering, and other common functionality +needed by all form field types. Utilizes the {@link Ext.form.field.Field} mixin for value handling and validation, +and the {@link Ext.form.Labelable} mixin to provide label and error message display. + +In most cases you will want to use a subclass, such as {@link Ext.form.field.Text} or {@link Ext.form.field.Checkbox}, +rather than creating instances of this class directly. However if you are implementing a custom form field, +using this as the parent class is recommended. + +__Values and Conversions__ + +Because BaseField implements the Field mixin, it has a main value that can be initialized with the +{@link #value} config and manipulated via the {@link #getValue} and {@link #setValue} methods. This main +value can be one of many data types appropriate to the current field, for instance a {@link Ext.form.field.Date Date} +field would use a JavaScript Date object as its value type. However, because the field is rendered as a HTML +input, this value data type can not always be directly used in the rendered field. + +Therefore BaseField introduces the concept of a "raw value". This is the value of the rendered HTML input field, +and is normally a String. The {@link #getRawValue} and {@link #setRawValue} methods can be used to directly +work with the raw value, though it is recommended to use getValue and setValue in most cases. + +Conversion back and forth between the main value and the raw value is handled by the {@link #valueToRaw} and +{@link #rawToValue} methods. If you are implementing a subclass that uses a non-String value data type, you +should override these methods to handle the conversion. + +__Rendering__ + +The content of the field body is defined by the {@link #fieldSubTpl} XTemplate, with its argument data +created by the {@link #getSubTplData} method. Override this template and/or method to create custom +field renderings. +{@img Ext.form.BaseField/Ext.form.BaseField.png Ext.form.BaseField BaseField component} +__Example usage:__ + + // A simple subclass of BaseField that creates a HTML5 search field. Redirects to the + // searchUrl when the Enter key is pressed. + Ext.define('Ext.form.SearchField', { + extend: 'Ext.form.field.Base', + alias: 'widget.searchfield', + + inputType: 'search', + + // Config defining the search URL + searchUrl: 'http://www.google.com/search?q={0}', + + // Add specialkey listener + initComponent: function() { + this.callParent(); + this.on('specialkey', this.checkEnterKey, this); + }, + + // Handle enter key presses, execute the search if the field has a value + checkEnterKey: function(field, e) { + var value = this.getValue(); + if (e.getKey() === e.ENTER && !Ext.isEmpty(value)) { + location.href = Ext.String.format(this.searchUrl, value); + } + } + }); + + Ext.create('Ext.form.Panel', { + title: 'BaseField Example', + bodyPadding: 5, + width: 250, + + // Fields will be arranged vertically, stretched to full width + layout: 'anchor', + defaults: { + anchor: '100%' + }, + items: [{ + xtype: 'searchfield', + fieldLabel: 'Search', + name: 'query' + }] + renderTo: Ext.getBody() + }); + + * + * @markdown + * @docauthor Jason Johnston
- * resizer.east.setDisplayed(false);+ */ +Ext.define('Ext.form.field.Base', { + extend: 'Ext.Component', + mixins: { + labelable: 'Ext.form.Labelable', + field: 'Ext.form.field.Field' + }, + alias: 'widget.field', + alternateClassName: ['Ext.form.Field', 'Ext.form.BaseField'], + requires: ['Ext.util.DelayedTask', 'Ext.XTemplate', 'Ext.layout.component.field.Field'], + + fieldSubTpl: [ + 'name="{name}" ', + ' size="{size}" ', + 'tabIndex="{tabIdx}" ', + 'class="{fieldCls} {typeCls}" autocomplete="off" />', + { + compiled: true, + disableFormats: true + } + ], + /** - * @cfg {Boolean} draggable Convenience to initialize drag drop (defaults to false) + * @cfg {String} name The name of the field (defaults to undefined). This is used as the parameter + * name when including the field value in a {@link Ext.form.Basic#submit form submit()}. If no name is + * configured, it falls back to the {@link #inputId}. To prevent the field from being included in the + * form submit, set {@link #submitValue} to false. */ - draggable: false, + /** - * @cfg {Number} duration Animation duration if animate = true (defaults to 0.35) + * @cfg {String} inputType + *The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text'). + * The extended types supported by HTML5 inputs (url, email, etc.) may also be used, though using them + * will cause older browsers to fall back to 'text'.
+ *The type 'password' must be used to render that field type currently -- there is no separate Ext + * component for that. You can use {@link Ext.form.field.File} which creates a custom-rendered file upload + * field, but if you want a plain unstyled file input you can use a BaseField with inputType:'file'.
*/ - duration : 0.35, + inputType: 'text', + /** - * @cfg {Boolean} dynamic True to resize the element while dragging instead of using a proxy (defaults to false) + * @cfg {Number} tabIndex The tabIndex for this field. Note this only applies to fields that are rendered, + * not those which are built via applyTo (defaults to undefined). */ - dynamic : false, + /** - * @cfg {String} easing Animation easing if animate = true (defaults to 'easingOutStrong') + * @cfg {String} invalidText The error text to use when marking a field invalid and no message is provided + * (defaults to 'The value in this field is invalid') */ - easing : 'easeOutStrong', + invalidText : 'The value in this field is invalid', + /** - * @cfg {Boolean} enabled False to disable resizing (defaults to true) + * @cfg {String} fieldCls The default CSS class for the field input (defaults to 'x-form-field') */ - enabled : true, + fieldCls : Ext.baseCSSPrefix + 'form-field', + /** - * @property enabled Writable. False if resizing is disabled. - * @type Boolean + * @cfg {String} fieldStyle Optional CSS style(s) to be applied to the {@link #inputEl field input element}. + * Should be a valid argument to {@link Ext.core.Element#applyStyles}. Defaults to undefined. See also the + * {@link #setFieldStyle} method for changing the style after initialization. */ + /** - * @cfg {String} handles String consisting of the resize handles to display (defaults to undefined). - * Specify either 'all' or any of 'n s e w ne nw se sw'. + * @cfg {String} focusCls The CSS class to use when the field receives focus (defaults to 'x-form-focus') */ - handles : false, + focusCls : Ext.baseCSSPrefix + 'form-focus', + /** - * @cfg {Boolean} multiDirectional Deprecated. Deprecated style of adding multi-direction resize handles. + * @cfg {String} dirtyCls The CSS class to use when the field value {@link #isDirty is dirty}. */ - multiDirectional : false, + dirtyCls : Ext.baseCSSPrefix + 'form-dirty', + /** - * @cfg {Number} height The height of the element in pixels (defaults to null) + * @cfg {Array} checkChangeEvents + *A list of event names that will be listened for on the field's {@link #inputEl input element}, which + * will cause the field's value to be checked for changes. If a change is detected, the + * {@link #change change event} will be fired, followed by validation if the {@link #validateOnChange} + * option is enabled.
+ *Defaults to ['change', 'propertychange'] in Internet Explorer, and ['change', 'input', + * 'textInput', 'keyup', 'dragdrop'] in other browsers. This catches all the ways that field values + * can be changed in most supported browsers; the only known exceptions at the time of writing are:
+ *+ *
+ *- Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas
+ *- Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text + * fields and textareas
+ *- Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas
+ *If you need to guarantee on-the-fly change notifications including these edge cases, you can call the + * {@link #checkChange} method on a repeating interval, e.g. using {@link Ext.TaskManager}, or if the field is + * within a {@link Ext.form.Panel}, you can use the FormPanel's {@link Ext.form.Panel#pollForChanges} + * configuration to set up such a task automatically.
*/ - height : null, + checkChangeEvents: Ext.isIE && (!document.documentMode || document.documentMode < 9) ? + ['change', 'propertychange'] : + ['change', 'input', 'textInput', 'keyup', 'dragdrop'], + /** - * @cfg {Number} width The width of the element in pixels (defaults to null) + * @cfg {Number} checkChangeBuffer + * Defines a timeout in milliseconds for buffering {@link #checkChangeEvents} that fire in rapid succession. + * Defaults to 50 milliseconds. */ - width : null, + checkChangeBuffer: 50, + + componentLayout: 'field', + /** - * @cfg {Number} heightIncrement The increment to snap the height resize in pixels - * (only applies if{@link #dynamic}==true
). Defaults to 0. + * @cfg {Boolean} readOnly true to mark the field as readOnly in HTML + * (defaults to false). + *Note: this only sets the element's readOnly DOM attribute. + * Setting
*/ - heightIncrement : 0, + readOnly : false, + /** - * @cfg {Number} widthIncrement The increment to snap the width resize in pixels - * (only applies ifreadOnly=true
, for example, will not disable triggering a + * ComboBox or Date; it gives you the option of forcing the user to choose + * via the trigger without typing in the text box. To hide the trigger use + *{@link Ext.form.field.Trigger#hideTrigger hideTrigger}
.{@link #dynamic}==true
). Defaults to 0. + * @cfg {String} readOnlyCls The CSS class applied to the component's main element when it is {@link #readOnly}. */ - widthIncrement : 0, + readOnlyCls: Ext.baseCSSPrefix + 'form-readonly', + /** - * @cfg {Number} minHeight The minimum height for the element (defaults to 5) + * @cfg {String} inputId + * The id that will be given to the generated input DOM element. Defaults to an automatically generated id. + * If you configure this manually, you must make sure it is unique in the document. */ - minHeight : 5, + /** - * @cfg {Number} minWidth The minimum width for the element (defaults to 5) + * @cfg {Boolean} validateOnBlur + * Whether the field should validate when it loses focus (defaults to true). This will cause fields + * to be validated as the user steps through the fields in the form regardless of whether they are making + * changes to those fields along the way. See also {@link #validateOnChange}. */ - minWidth : 5, + validateOnBlur: true, + + // private + hasFocus : false, + + baseCls: Ext.baseCSSPrefix + 'field', + + maskOnDisable: false, + + // private + initComponent : function() { + var me = this; + + me.callParent(); + + me.subTplData = me.subTplData || {}; + + me.addEvents( + /** + * @event focus + * Fires when this field receives input focus. + * @param {Ext.form.field.Base} this + */ + 'focus', + /** + * @event blur + * Fires when this field loses input focus. + * @param {Ext.form.field.Base} this + */ + 'blur', + /** + * @event specialkey + * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. + * To handle other keys see {@link Ext.panel.Panel#keys} or {@link Ext.util.KeyMap}. + * You can check {@link Ext.EventObject#getKey} to determine which key was pressed. + * For example:+ * @param {Ext.form.field.Base} this + * @param {Ext.EventObject} e The event object + */ + 'specialkey' + ); + + // Init mixins + me.initLabelable(); + me.initField(); + + // Default name to inputId + if (!me.name) { + me.name = me.getInputId(); + } + }, + /** - * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000) + * Returns the input id for this field. If none was specified via the {@link #inputId} config, + * then an id will be automatically generated. */ - maxHeight : 10000, + getInputId: function() { + return this.inputId || (this.inputId = Ext.id()); + }, + /** - * @cfg {Number} maxWidth The maximum width for the element (defaults to 10000) + * @protected Creates and returns the data object to be used when rendering the {@link #fieldSubTpl}. + * @return {Object} The template data */ - maxWidth : 10000, + getSubTplData: function() { + var me = this, + type = me.inputType, + inputId = me.getInputId(); + + return Ext.applyIf(me.subTplData, { + id: inputId, + name: me.name || inputId, + type: type, + size: me.size || 20, + cls: me.cls, + fieldCls: me.fieldCls, + tabIdx: me.tabIndex, + typeCls: Ext.baseCSSPrefix + 'form-' + (type === 'password' ? 'text' : type) + }); + }, + /** - * @cfg {Number} minX The minimum x for the element (defaults to 0) + * @protected + * Gets the markup to be inserted into the outer template's bodyEl. For fields this is the + * actual input element. */ - minX: 0, + getSubTplMarkup: function() { + return this.getTpl('fieldSubTpl').apply(this.getSubTplData()); + }, + + initRenderTpl: function() { + var me = this; + if (!me.hasOwnProperty('renderTpl')) { + me.renderTpl = me.getTpl('labelableRenderTpl'); + } + return me.callParent(); + }, + + initRenderData: function() { + return Ext.applyIf(this.callParent(), this.getLabelableRenderData()); + }, + /** - * @cfg {Number} minY The minimum x for the element (defaults to 0) + * Set the {@link #fieldStyle CSS style} of the {@link #inputEl field input element}. + * @param {String/Object/Function} style The style(s) to apply. Should be a valid argument to + * {@link Ext.core.Element#applyStyles}. */ - minY: 0, + setFieldStyle: function(style) { + var me = this, + inputEl = me.inputEl; + if (inputEl) { + inputEl.applyStyles(style); + } + me.fieldStyle = style; + }, + + // private + onRender : function() { + var me = this, + fieldStyle = me.fieldStyle, + renderSelectors = me.renderSelectors; + + Ext.applyIf(renderSelectors, me.getLabelableSelectors()); + + Ext.applyIf(renderSelectors, { + /** + * @property inputEl + * @type Ext.core.Element + * The input Element for this Field. Only available after the field has been rendered. + */ + inputEl: '.' + me.fieldCls + }); + + me.callParent(arguments); + + // Make the stored rawValue get set as the input element's value + me.setRawValue(me.rawValue); + + if (me.readOnly) { + me.setReadOnly(true); + } + if (me.disabled) { + me.disable(); + } + if (fieldStyle) { + me.setFieldStyle(fieldStyle); + } + + me.renderActiveError(); + }, + + initAria: function() { + var me = this; + me.callParent(); + + // Associate the field to the error message element + me.getActionEl().dom.setAttribute('aria-describedby', Ext.id(me.errorEl)); + }, + + getFocusEl: function() { + return this.inputEl; + }, + + isFileUpload: function() { + return this.inputType === 'file'; + }, + + extractFileInput: function() { + var me = this, + fileInput = me.isFileUpload() ? me.inputEl.dom : null, + clone; + if (fileInput) { + clone = fileInput.cloneNode(true); + fileInput.parentNode.replaceChild(clone, fileInput); + me.inputEl = Ext.get(clone); + } + return fileInput; + }, + + // private override to use getSubmitValue() as a convenience + getSubmitData: function() { + var me = this, + data = null, + val; + if (!me.disabled && me.submitValue && !me.isFileUpload()) { + val = me.getSubmitValue(); + if (val !== null) { + data = {}; + data[me.getName()] = val; + } + } + return data; + }, + /** - * @cfg {Boolean} pinned True to ensure that the resize handles are always visible, false to display them only when the - * user mouses over the resizable borders. This is only applied at config time. (defaults to false) + *+var form = new Ext.form.Panel({ + ... + items: [{ + fieldLabel: 'Field 1', + name: 'field1', + allowBlank: false + },{ + fieldLabel: 'Field 2', + name: 'field2', + listeners: { + specialkey: function(field, e){ + // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN, + // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN + if (e.{@link Ext.EventObject#getKey getKey()} == e.ENTER) { + var form = field.up('form').getForm(); + form.submit(); + } + } + } + } + ], + ... +}); + *
Returns the value that would be included in a standard form submit for this field. This will be combined + * with the field's name to form a name=value pair in the {@link #getSubmitData submitted parameters}. + * If an empty string is returned then just the name= will be submitted; if null is returned + * then nothing will be submitted.
+ *Note that the value returned will have been {@link #processRawValue processed} but may or may not have + * been successfully {@link #validate validated}.
+ * @return {String} The value to be submitted, or null. */ - pinned : false, + getSubmitValue: function() { + return this.processRawValue(this.getRawValue()); + }, + /** - * @cfg {Boolean} preserveRatio True to preserve the original ratio between height - * and width during resize (defaults to false) + * Returns the raw value of the field, without performing any normalization, conversion, or validation. + * To get a normalized and converted value see {@link #getValue}. + * @return {String} value The raw String value of the field */ - preserveRatio : false, + getRawValue: function() { + var me = this, + v = (me.inputEl ? me.inputEl.getValue() : Ext.value(me.rawValue, '')); + me.rawValue = v; + return v; + }, + /** - * @cfg {Boolean/String/Element} resizeChild True to resize the first child, or id/element to resize (defaults to false) + * Sets the field's raw value directly, bypassing {@link #valueToRaw value conversion}, change detection, and + * validation. To set the value with these additional inspections see {@link #setValue}. + * @param {Mixed} value The value to set + * @return {Mixed} value The field value that is set */ - resizeChild : false, + setRawValue: function(value) { + var me = this; + value = Ext.value(value, ''); + me.rawValue = value; + + // Some Field subclasses may not render an inputEl + if (me.inputEl) { + me.inputEl.dom.value = value; + } + return value; + }, + /** - * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false) + *Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows + * controlling how value objects passed to {@link #setValue} are shown to the user, including localization. + * For instance, for a {@link Ext.form.field.Date}, this would control how a Date object passed to {@link #setValue} + * would be converted to a String for display in the field.
+ *See {@link #rawToValue} for the opposite conversion.
+ *The base implementation simply does a standard toString conversion, and converts + * {@link Ext#isEmpty empty values} to an empty string.
+ * @param {Mixed} value The mixed-type value to convert to the raw representation. + * @return {Mixed} The converted raw value. */ - transparent: false, + valueToRaw: function(value) { + return '' + Ext.value(value, ''); + }, + /** - * @cfg {Ext.lib.Region} resizeRegion Constrain the resize to a particular region + *Converts a raw input field value into a mixed-type value that is suitable for this particular field type. + * This allows controlling the normalization and conversion of user-entered values into field-type-appropriate + * values, e.g. a Date object for {@link Ext.form.field.Date}, and is invoked by {@link #getValue}.
+ *It is up to individual implementations to decide how to handle raw values that cannot be successfully + * converted to the desired object type.
+ *See {@link #valueToRaw} for the opposite conversion.
+ *The base implementation does no conversion, returning the raw value untouched.
+ * @param {Mixed} rawValue + * @return {Mixed} The converted value. */ + rawToValue: function(rawValue) { + return rawValue; + }, + /** - * @cfg {Boolean} wrap True to wrap an element with a div if needed (required for textareas and images, defaults to false) - * in favor of the handles config option (defaults to false) + * Performs any necessary manipulation of a raw field value to prepare it for {@link #rawToValue conversion} + * and/or {@link #validate validation}, for instance stripping out ignored characters. In the base implementation + * it does nothing; individual subclasses may override this as needed. + * @param {Mixed} value The unprocessed string value + * @return {Mixed} The processed string value */ + processRawValue: function(value) { + return value; + }, + /** - * @cfg {String} handleCls A css class to add to each handle. Defaults to ''. + * Returns the current data value of the field. The type of value returned is particular to the type of the + * particular field (e.g. a Date object for {@link Ext.form.field.Date}), as the result of calling {@link #rawToValue} on + * the field's {@link #processRawValue processed} String value. To return the raw String value, see {@link #getRawValue}. + * @return {Mixed} value The field value */ - + getValue: function() { + var me = this, + val = me.rawToValue(me.processRawValue(me.getRawValue())); + me.value = val; + return val; + }, /** - * Perform a manual resize and fires the 'resize' event. - * @param {Number} width - * @param {Number} height + * Sets a data value into the field and runs the change detection and validation. To set the value directly + * without these inspections see {@link #setRawValue}. + * @param {Mixed} value The value to set + * @return {Ext.form.field.Field} this */ - resizeTo : function(width, height){ - this.el.setSize(width, height); - this.updateChildSize(); - this.fireEvent('resize', this, width, height, null); + setValue: function(value) { + var me = this; + me.setRawValue(me.valueToRaw(value)); + return me.mixins.field.setValue.call(me, value); }, - // private - startSizing : function(e, handle){ - this.fireEvent('beforeresize', this, e); - if(this.enabled){ // 2nd enabled check in case disabled before beforeresize handler - - if(!this.overlay){ - this.overlay = this.el.createProxy({tag: 'div', cls: 'x-resizable-overlay', html: ' '}, Ext.getBody()); - this.overlay.unselectable(); - this.overlay.enableDisplayMode('block'); - this.overlay.on({ - scope: this, - mousemove: this.onMouseMove, - mouseup: this.onMouseUp - }); - } - this.overlay.setStyle('cursor', handle.el.getStyle('cursor')); - - this.resizing = true; - this.startBox = this.el.getBox(); - this.startPoint = e.getXY(); - this.offsets = [(this.startBox.x + this.startBox.width) - this.startPoint[0], - (this.startBox.y + this.startBox.height) - this.startPoint[1]]; - - this.overlay.setSize(Ext.lib.Dom.getViewWidth(true), Ext.lib.Dom.getViewHeight(true)); - this.overlay.show(); - - if(this.constrainTo) { - var ct = Ext.get(this.constrainTo); - this.resizeRegion = ct.getRegion().adjust( - ct.getFrameWidth('t'), - ct.getFrameWidth('l'), - -ct.getFrameWidth('b'), - -ct.getFrameWidth('r') - ); - } - this.proxy.setStyle('visibility', 'hidden'); // workaround display none - this.proxy.show(); - this.proxy.setBox(this.startBox); - if(!this.dynamic){ - this.proxy.setStyle('visibility', 'visible'); - } + //private + onDisable: function() { + var me = this, + inputEl = me.inputEl; + me.callParent(); + if (inputEl) { + inputEl.dom.disabled = true; } }, - // private - onMouseDown : function(handle, e){ - if(this.enabled){ - e.stopEvent(); - this.activeHandle = handle; - this.startSizing(e, handle); + //private + onEnable: function() { + var me = this, + inputEl = me.inputEl; + me.callParent(); + if (inputEl) { + inputEl.dom.disabled = false; } }, - // private - onMouseUp : function(e){ - this.activeHandle = null; - var size = this.resizeElement(); - this.resizing = false; - this.handleOut(); - this.overlay.hide(); - this.proxy.hide(); - this.fireEvent('resize', this, size.width, size.height, e); + /** + * Sets the read only state of this field. + * @param {Boolean} readOnly Whether the field should be read only. + */ + setReadOnly: function(readOnly) { + var me = this, + inputEl = me.inputEl; + if (inputEl) { + inputEl.dom.readOnly = readOnly; + inputEl.dom.setAttribute('aria-readonly', readOnly); + } + me[readOnly ? 'addCls' : 'removeCls'](me.readOnlyCls); + me.readOnly = readOnly; }, // private - updateChildSize : function(){ - if(this.resizeChild){ - var el = this.el; - var child = this.resizeChild; - var adj = this.adjustments; - if(el.dom.offsetWidth){ - var b = el.getSize(true); - child.setSize(b.width+adj[0], b.height+adj[1]); - } - // Second call here for IE - // The first call enables instant resizing and - // the second call corrects scroll bars if they - // exist - if(Ext.isIE){ - setTimeout(function(){ - if(el.dom.offsetWidth){ - var b = el.getSize(true); - child.setSize(b.width+adj[0], b.height+adj[1]); - } - }, 10); - } + fireKey: function(e){ + if(e.isSpecialKey()){ + this.fireEvent('specialkey', this, Ext.create('Ext.EventObjectImpl', e)); } }, // private - snap : function(value, inc, min){ - if(!inc || !value){ - return value; - } - var newValue = value; - var m = value % inc; - if(m > 0){ - if(m > (inc/2)){ - newValue = value + (inc-m); - }else{ - newValue = value - m; - } + initEvents : function(){ + var me = this, + inputEl = me.inputEl, + onChangeTask, + onChangeEvent; + if (inputEl) { + me.mon(inputEl, Ext.EventManager.getKeyEvent(), me.fireKey, me); + me.mon(inputEl, 'focus', me.onFocus, me); + + // standardise buffer across all browsers + OS-es for consistent event order. + // (the 10ms buffer for Editors fixes a weird FF/Win editor issue when changing OS window focus) + me.mon(inputEl, 'blur', me.onBlur, me, me.inEditor ? {buffer:10} : null); + + // listen for immediate value changes + onChangeTask = Ext.create('Ext.util.DelayedTask', me.checkChange, me); + me.onChangeEvent = onChangeEvent = function() { + onChangeTask.delay(me.checkChangeBuffer); + }; + Ext.each(me.checkChangeEvents, function(eventName) { + if (eventName === 'propertychange') { + me.usesPropertychange = true; + } + me.mon(inputEl, eventName, onChangeEvent); + }, me); } - return Math.max(min, newValue); + me.callParent(); }, - /** - *Performs resizing of the associated Element. This method is called internally by this - * class, and should not be called by user code.
- *If a Resizable is being used to resize an Element which encapsulates a more complex UI - * component such as a Panel, this method may be overridden by specifying an implementation - * as a config option to provide appropriate behaviour at the end of the resize operation on - * mouseup, for example resizing the Panel, and relaying the Panel's content.
- *The new area to be resized to is available by examining the state of the {@link #proxy} - * Element. Example: -
- */ - resizeElement : function(){ - var box = this.proxy.getBox(); - if(this.updateBox){ - this.el.setBox(box, false, this.animate, this.duration, null, this.easing); - }else{ - this.el.setSize(box.width, box.height, this.animate, this.duration, null, this.easing); - } - this.updateChildSize(); - if(!this.dynamic){ - this.proxy.hide(); + doComponentLayout: function() { + var me = this, + inputEl = me.inputEl, + usesPropertychange = me.usesPropertychange, + ename = 'propertychange', + onChangeEvent = me.onChangeEvent; + + // In IE if propertychange is one of the checkChangeEvents, we need to remove + // the listener prior to layout and re-add it after, to prevent it from firing + // needlessly for attribute and style changes applied to the inputEl. + if (usesPropertychange) { + me.mun(inputEl, ename, onChangeEvent); } - if(this.draggable && this.constrainTo){ - this.dd.resetConstraints(); - this.dd.constrainTo(this.constrainTo); + me.callParent(arguments); + if (usesPropertychange) { + me.mon(inputEl, ename, onChangeEvent); } - return box; }, // private - constrain : function(v, diff, m, mx){ - if(v - diff < m){ - diff = v - m; - }else if(v - diff > mx){ - diff = v - mx; - } - return diff; - }, + preFocus: Ext.emptyFn, // private - onMouseMove : function(e){ - if(this.enabled && this.activeHandle){ - try{// try catch so if something goes wrong the user doesn't get hung - - if(this.resizeRegion && !this.resizeRegion.contains(e.getPoint())) { - return; - } - - //var curXY = this.startPoint; - var curSize = this.curSize || this.startBox, - x = this.startBox.x, y = this.startBox.y, - ox = x, - oy = y, - w = curSize.width, - h = curSize.height, - ow = w, - oh = h, - mw = this.minWidth, - mh = this.minHeight, - mxw = this.maxWidth, - mxh = this.maxHeight, - wi = this.widthIncrement, - hi = this.heightIncrement, - eventXY = e.getXY(), - diffX = -(this.startPoint[0] - Math.max(this.minX, eventXY[0])), - diffY = -(this.startPoint[1] - Math.max(this.minY, eventXY[1])), - pos = this.activeHandle.position, - tw, - th; - - switch(pos){ - case 'east': - w += diffX; - w = Math.min(Math.max(mw, w), mxw); - break; - case 'south': - h += diffY; - h = Math.min(Math.max(mh, h), mxh); - break; - case 'southeast': - w += diffX; - h += diffY; - w = Math.min(Math.max(mw, w), mxw); - h = Math.min(Math.max(mh, h), mxh); - break; - case 'north': - diffY = this.constrain(h, diffY, mh, mxh); - y += diffY; - h -= diffY; - break; - case 'west': - diffX = this.constrain(w, diffX, mw, mxw); - x += diffX; - w -= diffX; - break; - case 'northeast': - w += diffX; - w = Math.min(Math.max(mw, w), mxw); - diffY = this.constrain(h, diffY, mh, mxh); - y += diffY; - h -= diffY; - break; - case 'northwest': - diffX = this.constrain(w, diffX, mw, mxw); - diffY = this.constrain(h, diffY, mh, mxh); - y += diffY; - h -= diffY; - x += diffX; - w -= diffX; - break; - case 'southwest': - diffX = this.constrain(w, diffX, mw, mxw); - h += diffY; - h = Math.min(Math.max(mh, h), mxh); - x += diffX; - w -= diffX; - break; - } - - var sw = this.snap(w, wi, mw); - var sh = this.snap(h, hi, mh); - if(sw != w || sh != h){ - switch(pos){ - case 'northeast': - y -= sh - h; - break; - case 'north': - y -= sh - h; - break; - case 'southwest': - x -= sw - w; - break; - case 'west': - x -= sw - w; - break; - case 'northwest': - x -= sw - w; - y -= sh - h; - break; - } - w = sw; - h = sh; - } - - if(this.preserveRatio){ - switch(pos){ - case 'southeast': - case 'east': - h = oh * (w/ow); - h = Math.min(Math.max(mh, h), mxh); - w = ow * (h/oh); - break; - case 'south': - w = ow * (h/oh); - w = Math.min(Math.max(mw, w), mxw); - h = oh * (w/ow); - break; - case 'northeast': - w = ow * (h/oh); - w = Math.min(Math.max(mw, w), mxw); - h = oh * (w/ow); - break; - case 'north': - tw = w; - w = ow * (h/oh); - w = Math.min(Math.max(mw, w), mxw); - h = oh * (w/ow); - x += (tw - w) / 2; - break; - case 'southwest': - h = oh * (w/ow); - h = Math.min(Math.max(mh, h), mxh); - tw = w; - w = ow * (h/oh); - x += tw - w; - break; - case 'west': - th = h; - h = oh * (w/ow); - h = Math.min(Math.max(mh, h), mxh); - y += (th - h) / 2; - tw = w; - w = ow * (h/oh); - x += tw - w; - break; - case 'northwest': - tw = w; - th = h; - h = oh * (w/ow); - h = Math.min(Math.max(mh, h), mxh); - w = ow * (h/oh); - y += th - h; - x += tw - w; - break; - - } - } - this.proxy.setBounds(x, y, w, h); - if(this.dynamic){ - this.resizeElement(); - } - }catch(ex){} + onFocus: function() { + var me = this, + focusCls = me.focusCls, + inputEl = me.inputEl; + me.preFocus(); + if (focusCls && inputEl) { + inputEl.addCls(focusCls); + } + if (!me.hasFocus) { + me.hasFocus = true; + me.fireEvent('focus', me); } }, // private - handleOver : function(){ - if(this.enabled){ - this.el.addClass('x-resizable-over'); - } - }, + beforeBlur : Ext.emptyFn, // private - handleOut : function(){ - if(!this.resizing){ - this.el.removeClass('x-resizable-over'); + onBlur : function(){ + var me = this, + focusCls = me.focusCls, + inputEl = me.inputEl; + me.beforeBlur(); + if (focusCls && inputEl) { + inputEl.removeCls(focusCls); + } + if (me.validateOnBlur) { + me.validate(); } + me.hasFocus = false; + me.fireEvent('blur', me); + me.postBlur(); }, + // private + postBlur : Ext.emptyFn, + + /** - * Returns the element this component is bound to. - * @return {Ext.Element} + * @private Called when the field's dirty state changes. Adds/removes the {@link #dirtyCls} on the main element. + * @param {Boolean} isDirty */ - getEl : function(){ - return this.el; + onDirtyChange: function(isDirty) { + this[isDirty ? 'addCls' : 'removeCls'](this.dirtyCls); }, + /** - * Returns the resizeChild element (or null). - * @return {Ext.Element} + * Returns whether or not the field value is currently valid by + * {@link #getErrors validating} the {@link #processRawValue processed raw value} + * of the field. Note: {@link #disabled} fields are always treated as valid. + * @return {Boolean} True if the value is valid, else false */ - getResizeChild : function(){ - return this.resizeChild; + isValid : function() { + var me = this; + return me.disabled || me.validateValue(me.processRawValue(me.getRawValue())); }, + /** - * Destroys this resizable. If the element was wrapped and - * removeEl is not true then the element remains. - * @param {Boolean} removeEl (optional) true to remove the element from the DOM + *-new Ext.Panel({ - title: 'Resize me', - x: 100, - y: 100, - renderTo: Ext.getBody(), - floating: true, - frame: true, - width: 400, - height: 200, - listeners: { - render: function(p) { - new Ext.Resizable(p.getEl(), { - handles: 'all', - pinned: true, - transparent: true, - resizeElement: function() { - var box = this.proxy.getBox(); - p.updateBox(box); - if (p.layout) { - p.doLayout(); - } - return box; - } - }); - } - } -}).show(); -
Uses {@link #getErrors} to build an array of validation errors. If any errors are found, they are passed + * to {@link #markInvalid} and false is returned, otherwise true is returned.
+ *Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2 + * onwards {@link #getErrors} should be overridden instead.
+ * @param {Mixed} value The value to validate + * @return {Boolean} True if all validations passed, false if one or more failed */ - destroy : function(removeEl){ - Ext.destroy(this.dd, this.overlay, this.proxy); - this.overlay = null; - this.proxy = null; - - var ps = Ext.Resizable.positions; - for(var k in ps){ - if(typeof ps[k] != 'function' && this[ps[k]]){ - this[ps[k]].destroy(); + validateValue: function(value) { + var me = this, + errors = me.getErrors(value), + isValid = Ext.isEmpty(errors); + if (!me.preventMark) { + if (isValid) { + me.clearInvalid(); + } else { + me.markInvalid(errors); } } - if(removeEl){ - this.el.update(''); - Ext.destroy(this.el); - this.el = null; - } - this.purgeListeners(); + + return isValid; }, - syncHandleHeight : function(){ - var h = this.el.getHeight(true); - if(this.west){ - this.west.el.setHeight(h); - } - if(this.east){ - this.east.el.setHeight(h); + /** + *Display one or more error messages associated with this field, using {@link #msgTarget} to determine how to + * display the messages and applying {@link #invalidCls} to the field's UI element.
+ *Note: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to + * return
+ * @param {String/Array} errors The validation message(s) to display. + */ + markInvalid : function(errors) { + // Save the message and fire the 'invalid' event + var me = this, + oldMsg = me.getActiveError(); + me.setActiveErrors(Ext.Array.from(errors)); + if (oldMsg !== me.getActiveError()) { + me.doComponentLayout(); } - } -}); - -// private -// hash to map config positions to true positions -Ext.Resizable.positions = { - n: 'north', s: 'south', e: 'east', w: 'west', se: 'southeast', sw: 'southwest', nw: 'northwest', ne: 'northeast' -}; + }, -Ext.Resizable.Handle = Ext.extend(Object, { - constructor : function(rz, pos, disableTrackOver, transparent, cls){ - if(!this.tpl){ - // only initialize the template if resizable is used - var tpl = Ext.DomHelper.createTemplate( - {tag: 'div', cls: 'x-resizable-handle x-resizable-handle-{0}'} - ); - tpl.compile(); - Ext.Resizable.Handle.prototype.tpl = tpl; - } - this.position = pos; - this.rz = rz; - this.el = this.tpl.append(rz.el.dom, [this.position], true); - this.el.unselectable(); - if(transparent){ - this.el.setOpacity(0); - } - if(!Ext.isEmpty(cls)){ - this.el.addClass(cls); - } - this.el.on('mousedown', this.onMouseDown, this); - if(!disableTrackOver){ - this.el.on({ - scope: this, - mouseover: this.onMouseOver, - mouseout: this.onMouseOut - }); + /** + *false
if the value does pass validation. So simply marking a Field as invalid + * will not prevent submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation} + * option set.Clear any invalid styles/messages for this field.
+ *Note: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to + * return
+ */ + clearInvalid : function() { + // Clear the message and fire the 'valid' event + var me = this, + hadError = me.hasActiveError(); + me.unsetActiveError(); + if (hadError) { + me.doComponentLayout(); } }, - // private - afterResize : function(rz){ - // do nothing - }, - // private - onMouseDown : function(e){ - this.rz.onMouseDown(this, e); - }, - // private - onMouseOver : function(e){ - this.rz.handleOver(this, e); - }, - // private - onMouseOut : function(e){ - this.rz.handleOut(this, e); + /** + * @private Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl, + * as that is required for proper styling in IE with nested fields (due to lack of child selector) + */ + renderActiveError: function() { + var me = this, + hasError = me.hasActiveError(); + if (me.inputEl) { + // Add/remove invalid class + me.inputEl[hasError ? 'addCls' : 'removeCls'](me.invalidCls + '-field'); + } + me.mixins.labelable.renderActiveError.call(me); }, - // private - destroy : function(){ - Ext.destroy(this.el); - this.el = null; + + + getActionEl: function() { + return this.inputEl || this.el; } + }); + /** - * @class Ext.Window - * @extends Ext.Panel - *true
if the value does not pass validation. So simply clearing a field's errors + * will not necessarily allow submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation} + * option set.A specialized panel intended for use as an application window. Windows are floated, {@link #resizable}, and - * {@link #draggable} by default. Windows can be {@link #maximizable maximized} to fill the viewport, - * restored to their prior size, and can be {@link #minimize}d.
- *Windows can also be linked to a {@link Ext.WindowGroup} or managed by the {@link Ext.WindowMgr} to provide - * grouping, activation, to front, to back and other application-specific behavior.
- *By default, Windows will be rendered to document.body. To {@link #constrain} a Window to another element - * specify {@link Ext.Component#renderTo renderTo}.
- *Note: By default, the
- * @constructor - * @param {Object} config The config object - * @xtype window + * @class Ext.form.field.Text + * @extends Ext.form.field.Base + +A basic text field. Can be used as a direct replacement for traditional text inputs, +or as the base class for more sophisticated input controls (like {@link Ext.form.field.TextArea} +and {@link Ext.form.field.ComboBox}). Has support for empty-field placeholder values (see {@link #emptyText}). + +#Validation# + +The Text field has a useful set of validations built in: + +- {@link #allowBlank} for making the field required +- {@link #minLength} for requiring a minimum value length +- {@link #maxLength} for setting a maximum value length (with {@link #enforceMaxLength} to add it + as the `maxlength` attribute on the input element) +- {@link #regex} to specify a custom regular expression for validation + +In addition, custom validations may be added: + +- {@link #vtype} specifies a virtual type implementation from {@link Ext.form.field.VTypes} which can contain + custom validation logic +- {@link #validator} allows a custom arbitrary function to be called during validation + +The details around how and when each of these validation options get used are described in the +documentation for {@link #getErrors}. + +By default, the field value is checked for validity immediately while the user is typing in the +field. This can be controlled with the {@link #validateOnChange}, {@link #checkChangeEvents}, and +{@link #checkChangeBugger} configurations. Also see the details on Form Validation in the +{@link Ext.form.Panel} class documentation. + +#Masking and Character Stripping# + +Text fields can be configured with custom regular expressions to be applied to entered values before +validation: see {@link #maskRe} and {@link #stripCharsRe} for details. +{@img Ext.form.Text/Ext.form.Text.png Ext.form.Text component} +#Example usage:# + + Ext.create('Ext.form.Panel', { + title: 'Contact Info', + width: 300, + bodyPadding: 10, + renderTo: Ext.getBody(), + items: [{ + xtype: 'textfield', + name: 'name', + fieldLabel: 'Name', + allowBlank: false // requires a non-empty value + }, { + xtype: 'textfield', + name: 'email', + fieldLabel: 'Email Address', + vtype: 'email' // requires value to be a valid email address format + }] + }); + + * + * @markdown + * @docauthor Jason Johnston{@link #closable close}
header tool destroys the Window resulting in - * destruction of any child Components. This makes the Window object, and all its descendants unusable. To enable - * re-use of a Window, use{@link #closeAction closeAction: 'hide'}
.*/ -Ext.Window = Ext.extend(Ext.Panel, { +Ext.define('Ext.form.field.Text', { + extend:'Ext.form.field.Base', + alias: 'widget.textfield', + requires: ['Ext.form.field.VTypes', 'Ext.layout.component.field.Text'], + alternateClassName: ['Ext.form.TextField', 'Ext.form.Text'], + /** - * @cfg {Number} x - * The X position of the left edge of the window on initial showing. Defaults to centering the Window within - * the width of the Window's container {@link Ext.Element Element) (The Element that the Window is rendered to). + * @cfg {String} vtypeText A custom error message to display in place of the default message provided + * for the {@link #vtype}
currently set for this field (defaults to undefined). + * Note: only applies if{@link #vtype}
is set, else ignored. */ + /** - * @cfg {Number} y - * The Y position of the top edge of the window on initial showing. Defaults to centering the Window within - * the height of the Window's container {@link Ext.Element Element) (The Element that the Window is rendered to). + * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value + * before validation (defaults to undefined). */ + /** - * @cfg {Boolean} modal - * True to make the window modal and mask everything behind it when displayed, false to display it without - * restricting access to other UI elements (defaults to false). + * @cfg {Number} size An initial value for the 'size' attribute on the text input element. This is only + * used if the field has no configured {@link #width} and is not given a width by its container's layout. + * Defaults to 20. */ + size: 20, + /** - * @cfg {String/Element} animateTarget - * Id or element from which the window should animate while opening (defaults to null with no animation). + * @cfg {Boolean} grow true if this field should automatically grow and shrink to its content + * (defaults to false) */ + /** - * @cfg {String} resizeHandles - * A valid {@link Ext.Resizable} handles config string (defaults to 'all'). Only applies when resizable = true. + * @cfg {Number} growMin The minimum width to allow when{@link #grow} = true
(defaults + * to 30) */ + growMin : 30, + /** - * @cfg {Ext.WindowGroup} manager - * A reference to the WindowGroup that should manage this window (defaults to {@link Ext.WindowMgr}). + * @cfg {Number} growMax The maximum width to allow when{@link #grow} = true
(defaults + * to 800) */ + growMax : 800, + /** - * @cfg {String/Number/Component} defaultButton - *Specifies a Component to receive focus when this Window is focussed.
- *This may be one of:
- */ - /** - * @cfg {Function} onEsc - * Allows override of the built-in processing for the escape key. Default action - * is to close the Window (performing whatever action is specified in {@link #closeAction}. - * To prevent the Window closing when the escape key is pressed, specify this as - * Ext.emptyFn (See {@link Ext#emptyFn}). - */ + * @cfg {String} growAppend + * A string that will be appended to the field's current value for the purposes of calculating the target + * field size. Only used when the {@link #grow} config is true. Defaults to a single capital "W" + * (the widest character in common fonts) to leave enough space for the next typed character and avoid the + * field value shifting before the width is adjusted. + */ + growAppend: 'W', + /** - * @cfg {Boolean} collapsed - * True to render the window collapsed, false to render it expanded (defaults to false). Note that if - * {@link #expandOnShow} is true (the default) it will override the collapsed config and the window - * will always be expanded when shown. + * @cfg {String} vtype A validation type name as defined in {@link Ext.form.field.VTypes} (defaults to undefined) */ + /** - * @cfg {Boolean} maximized - * True to initially display the window in a maximized state. (Defaults to false). + * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do + * not match (defaults to undefined) */ /** - * @cfg {String} baseCls - * The base CSS class to apply to this panel's element (defaults to 'x-window'). - */ - baseCls : 'x-window', + * @cfg {Boolean} disableKeyFilter Specify true to disable input keystroke filtering (defaults + * to false) + */ + /** - * @cfg {Boolean} resizable - * True to allow user resizing at each edge and corner of the window, false to disable resizing (defaults to true). + * @cfg {Boolean} allowBlank Specify false to validate that the value's length is > 0 (defaults to + * true) */ - resizable : true, + allowBlank : true, + /** - * @cfg {Boolean} draggable - * True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note - * that by default the window will be centered in the viewport, so if dragging is disabled the window may need - * to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);). + * @cfg {Number} minLength Minimum input field length required (defaults to 0) */ - draggable : true, + minLength : 0, + /** - * @cfg {Boolean} closable - *- *
- The index of a footer Button.
- *- The id of a Component.
- *- A Component.
- *True to display the 'close' tool button and allow the user to close the window, false to - * hide the button and disallow closing the window (defaults to true).
- *By default, when close is requested by either clicking the close button in the header - * or pressing ESC when the Window has focus, the {@link #close} method will be called. This - * will {@link Ext.Component#destroy destroy} the Window and its content meaning that - * it may not be reused.
- *To make closing a Window hide the Window so that it may be reused, set - * {@link #closeAction} to 'hide'. + * @cfg {Number} maxLength Maximum input field length allowed by validation (defaults to Number.MAX_VALUE). + * This behavior is intended to provide instant feedback to the user by improving usability to allow pasting + * and editing or overtyping and back tracking. To restrict the maximum number of characters that can be + * entered into the field use the {@link Ext.form.field.Text#enforceMaxLength enforceMaxLength} option. */ - closable : true, + maxLength : Number.MAX_VALUE, + /** - * @cfg {String} closeAction - *
The action to take when the close header tool is clicked: - *
- *- *
- - *
'{@link #close}'
: Default- * {@link #close remove} the window from the DOM and {@link Ext.Component#destroy destroy} - * it and all descendant Components. The window will not be available to be - * redisplayed via the {@link #show} method. - *- - *
'{@link #hide}'
:- * {@link #hide} the window by setting visibility to hidden and applying negative offsets. - * The window will be available to be redisplayed via the {@link #show} method. - *Note: This setting does not affect the {@link #close} method - * which will always {@link Ext.Component#destroy destroy} the window. To - * programatically hide a window, call {@link #hide}.
+ * @cfg {Boolean} enforceMaxLength True to set the maxLength property on the underlying input field. Defaults to false */ - closeAction : 'close', + /** - * @cfg {Boolean} constrain - * True to constrain the window within its containing element, false to allow it to fall outside of its - * containing element. By default the window will be rendered to document.body. To render and constrain the - * window within another element specify {@link #renderTo}. - * (defaults to false). Optionally the header only can be constrained using {@link #constrainHeader}. + * @cfg {String} minLengthText Error text to display if the {@link #minLength minimum length} + * validation fails (defaults to 'The minimum length for this field is {minLength}') */ - constrain : false, + minLengthText : 'The minimum length for this field is {0}', + /** - * @cfg {Boolean} constrainHeader - * True to constrain the window header within its containing element (allowing the window body to fall outside - * of its containing element) or false to allow the header to fall outside its containing element (defaults to - * false). Optionally the entire window can be constrained using {@link #constrain}. + * @cfg {String} maxLengthText Error text to display if the {@link #maxLength maximum length} + * validation fails (defaults to 'The maximum length for this field is {maxLength}') */ - constrainHeader : false, + maxLengthText : 'The maximum length for this field is {0}', + /** - * @cfg {Boolean} plain - * True to render the window body with a transparent background so that it will blend into the framing - * elements, false to add a lighter background color to visually highlight the body element and separate it - * more distinctly from the surrounding frame (defaults to false). + * @cfg {Boolean} selectOnFocus true to automatically select any existing field text when the field + * receives input focus (defaults to false) */ - plain : false, + /** - * @cfg {Boolean} minimizable - * True to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button - * and disallow minimizing the window (defaults to false). Note that this button provides no implementation -- - * the behavior of minimizing a window is implementation-specific, so the minimize event must be handled and a - * custom minimize behavior implemented for this option to be useful. + * @cfg {String} blankText The error text to display if the {@link #allowBlank} validation + * fails (defaults to 'This field is required') */ - minimizable : false, + blankText : 'This field is required', + /** - * @cfg {Boolean} maximizable - * True to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button - * and disallow maximizing the window (defaults to false). Note that when a window is maximized, the tool button - * will automatically change to a 'restore' button with the appropriate behavior already built-in that will - * restore the window to its previous size. + * @cfg {Function} validator + *A custom validation function to be called during field validation ({@link #getErrors}) + * (defaults to undefined). If specified, this function will be called first, allowing the + * developer to override the default validation process.
+ *This function will be passed the following Parameters:
+ *+ *+ *
- + *
value
: Mixed + *The current field valueThis function is to Return:
+ **/ - maximizable : false, + /** - * @cfg {Number} minHeight - * The minimum height in pixels allowed for this window (defaults to 100). Only applies when resizable = true. + * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation + * (defaults to undefined). If the test fails, the field will be marked invalid using + * {@link #regexText}. */ - minHeight : 100, + /** - * @cfg {Number} minWidth - * The minimum width in pixels allowed for this window (defaults to 200). Only applies when resizable = true. + * @cfg {String} regexText The error text to display if {@link #regex} is used and the + * test fails during validation (defaults to '') */ - minWidth : 200, + regexText : '', + /** - * @cfg {Boolean} expandOnShow - * True to always expand the window when it is displayed, false to keep it in its current state (which may be - * {@link #collapsed}) when displayed (defaults to true). + * @cfg {String} emptyText + *+ *
- + *
true
: Boolean + *true
if the value is valid- + *
msg
: String + *An error message if the value is invalidThe default text to place into an empty field (defaults to undefined).
+ *Note that normally this value will be submitted to the server if this field is enabled; to prevent this + * you can set the {@link Ext.form.action.Action#submitEmptyText submitEmptyText} option of + * {@link Ext.form.Basic#submit} to false.
+ *Also note that if you use {@link #inputType inputType}:'file', {@link #emptyText} is not + * supported and should be avoided.
*/ - expandOnShow : true, - - // inherited docs, same default - collapsible : false, /** - * @cfg {Boolean} initHidden - * True to hide the window until show() is explicitly called (defaults to true). - * @deprecated + * @cfg {String} emptyCls The CSS class to apply to an empty field to style the {@link #emptyText} + * (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed + * depending on the current field value. */ - initHidden : undefined, + emptyCls : Ext.baseCSSPrefix + 'form-empty-field', + + ariaRole: 'textbox', /** - * @cfg {Boolean} hidden - * Render this component hidden (default is true). If true, the - * {@link #hide} method will be called internally. + * @cfg {Boolean} enableKeyEvents true to enable the proxying of key events for the HTML input field (defaults to false) */ - hidden : true, - // The following configs are set to provide the basic functionality of a window. - // Changing them would require additional code to handle correctly and should - // usually only be done in subclasses that can provide custom behavior. Changing them - // may have unexpected or undesirable results. - /** @cfg {String} elements @hide */ - elements : 'header,body', - /** @cfg {Boolean} frame @hide */ - frame : true, - /** @cfg {Boolean} floating @hide */ - floating : true, + componentLayout: 'textfield', - // private initComponent : function(){ - this.initTools(); - Ext.Window.superclass.initComponent.call(this); + this.callParent(); this.addEvents( /** - * @event activate - * Fires after the window has been visually activated via {@link #setActive}. - * @param {Ext.Window} this - */ - /** - * @event deactivate - * Fires after the window has been visually deactivated via {@link #setActive}. - * @param {Ext.Window} this - */ - /** - * @event resize - * Fires after the window has been resized. - * @param {Ext.Window} this - * @param {Number} width The window's new width - * @param {Number} height The window's new height + * @event autosize + * Fires when the {@link #autoSize} function is triggered and the field is + * resized according to the {@link #grow}/{@link #growMin}/{@link #growMax} configs as a result. + * This event provides a hook for the developer to apply additional logic at runtime to resize the + * field if needed. + * @param {Ext.form.field.Text} this This text field + * @param {Number} width The new field width */ - 'resize', + 'autosize', + /** - * @event maximize - * Fires after the window has been maximized. - * @param {Ext.Window} this + * @event keydown + * Keydown input field event. This event only fires if {@link #enableKeyEvents} + * is set to true. + * @param {Ext.form.field.Text} this This text field + * @param {Ext.EventObject} e */ - 'maximize', + 'keydown', /** - * @event minimize - * Fires after the window has been minimized. - * @param {Ext.Window} this + * @event keyup + * Keyup input field event. This event only fires if {@link #enableKeyEvents} + * is set to true. + * @param {Ext.form.field.Text} this This text field + * @param {Ext.EventObject} e */ - 'minimize', + 'keyup', /** - * @event restore - * Fires after the window has been restored to its original size after being maximized. - * @param {Ext.Window} this + * @event keypress + * Keypress input field event. This event only fires if {@link #enableKeyEvents} + * is set to true. + * @param {Ext.form.field.Text} this This text field + * @param {Ext.EventObject} e */ - 'restore' + 'keypress' ); - // for backwards compat, this should be removed at some point - if(Ext.isDefined(this.initHidden)){ - this.hidden = this.initHidden; - } - if(this.hidden === false){ - this.hidden = true; - this.show(); - } - }, - - // private - getState : function(){ - return Ext.apply(Ext.Window.superclass.getState.call(this) || {}, this.getBox(true)); }, // private - onRender : function(ct, position){ - Ext.Window.superclass.onRender.call(this, ct, position); - - if(this.plain){ - this.el.addClass('x-window-plain'); + initEvents : function(){ + var me = this, + el = me.inputEl; + + me.callParent(); + if(me.selectOnFocus || me.emptyText){ + me.mon(el, 'mousedown', me.onMouseDown, me); + } + if(me.maskRe || (me.vtype && me.disableKeyFilter !== true && (me.maskRe = Ext.form.field.VTypes[me.vtype+'Mask']))){ + me.mon(el, 'keypress', me.filterKeys, me); } - // this element allows the Window to be focused for keyboard events - this.focusEl = this.el.createChild({ - tag: 'a', href:'#', cls:'x-dlg-focus', - tabIndex:'-1', html: ' '}); - this.focusEl.swallowEvent('click', true); + if (me.enableKeyEvents) { + me.mon(el, { + scope: me, + keyup: me.onKeyUp, + keydown: me.onKeyDown, + keypress: me.onKeyPress + }); + } + }, - this.proxy = this.el.createProxy('x-window-proxy'); - this.proxy.enableDisplayMode('block'); + /** + * @private override - treat undefined and null values as equal to an empty string value + */ + isEqual: function(value1, value2) { + return String(Ext.value(value1, '')) === String(Ext.value(value2, '')); + }, - if(this.modal){ - this.mask = this.container.createChild({cls:'ext-el-mask'}, this.el.dom); - this.mask.enableDisplayMode('block'); - this.mask.hide(); - this.mon(this.mask, 'click', this.focus, this); - } - if(this.maximizable){ - this.mon(this.header, 'dblclick', this.toggleMaximize, this); + /** + * @private + * If grow=true, invoke the autoSize method when the field's value is changed. + */ + onChange: function() { + this.callParent(); + this.autoSize(); + }, + + afterRender: function(){ + var me = this; + if (me.enforceMaxLength) { + me.inputEl.dom.maxLength = me.maxLength; } + me.applyEmptyText(); + me.autoSize(); + me.callParent(); }, - // private - initEvents : function(){ - Ext.Window.superclass.initEvents.call(this); - if(this.animateTarget){ - this.setAnimateTarget(this.animateTarget); - } - - if(this.resizable){ - this.resizer = new Ext.Resizable(this.el, { - minWidth: this.minWidth, - minHeight:this.minHeight, - handles: this.resizeHandles || 'all', - pinned: true, - resizeElement : this.resizerAction, - handleCls: 'x-window-handle' - }); - this.resizer.window = this; - this.mon(this.resizer, 'beforeresize', this.beforeResize, this); + onMouseDown: function(e){ + var me = this; + if(!me.hasFocus){ + me.mon(me.inputEl, 'mouseup', Ext.emptyFn, me, { single: true, preventDefault: true }); } + }, - if(this.draggable){ - this.header.addClass('x-window-draggable'); + /** + * Performs any necessary manipulation of a raw String value to prepare it for {@link #stringToValue conversion} + * and/or {@link #validate validation}. For text fields this applies the configured {@link #stripCharsRe} to the + * raw value. + * @param {String} value The unprocessed string value + * @return {String} The processed string value + */ + processRawValue: function(value) { + var me = this, + stripRe = me.stripCharsRe, + newValue; + + if (stripRe) { + newValue = value.replace(stripRe, ''); + if (newValue !== value) { + me.setRawValue(newValue); + value = newValue; + } } - this.mon(this.el, 'mousedown', this.toFront, this); - this.manager = this.manager || Ext.WindowMgr; - this.manager.register(this); - if(this.maximized){ - this.maximized = false; - this.maximize(); + return value; + }, + + //private + onDisable: function(){ + this.callParent(); + if (Ext.isIE) { + this.inputEl.dom.unselectable = 'on'; } - if(this.closable){ - var km = this.getKeyMap(); - km.on(27, this.onEsc, this); - km.disable(); + }, + + //private + onEnable: function(){ + this.callParent(); + if (Ext.isIE) { + this.inputEl.dom.unselectable = ''; } }, - initDraggable : function(){ - /** - *If this Window is configured {@link #draggable}, this property will contain - * an instance of {@link Ext.dd.DD} which handles dragging the Window's DOM Element.
- *This has implementations of
- * @type Ext.dd.DD - * @property dd - */ - this.dd = new Ext.Window.DD(this); + onKeyDown: function(e) { + this.fireEvent('keydown', this, e); }, - // private - onEsc : function(k, e){ - e.stopEvent(); - this[this.closeAction](); + onKeyUp: function(e) { + this.fireEvent('keyup', this, e); }, - // private - beforeDestroy : function(){ - if(this.rendered){ - this.hide(); - this.clearAnchor(); - Ext.destroy( - this.focusEl, - this.resizer, - this.dd, - this.proxy, - this.mask - ); - } - Ext.Window.superclass.beforeDestroy.call(this); + onKeyPress: function(e) { + this.fireEvent('keypress', this, e); }, - // private - onDestroy : function(){ - if(this.manager){ - this.manager.unregister(this); + /** + * Resets the current field value to the originally-loaded value and clears any validation messages. + * Also adds {@link #emptyText} and {@link #emptyCls} if the + * original value was blank. + */ + reset : function(){ + this.callParent(); + this.applyEmptyText(); + }, + + applyEmptyText : function(){ + var me = this, + emptyText = me.emptyText, + isEmpty; + + if (me.rendered && emptyText) { + isEmpty = me.getRawValue().length < 1 && !me.hasFocus; + + if (Ext.supports.Placeholder) { + me.inputEl.dom.placeholder = emptyText; + } else if (isEmpty) { + me.setRawValue(emptyText); + } + + //all browsers need this because of a styling issue with chrome + placeholders. + //the text isnt vertically aligned when empty (and using the placeholder) + if (isEmpty) { + me.inputEl.addCls(me.emptyCls); + } + + me.autoSize(); } - Ext.Window.superclass.onDestroy.call(this); }, // private - initTools : function(){ - if(this.minimizable){ - this.addTool({ - id: 'minimize', - handler: this.minimize.createDelegate(this, []) - }); - } - if(this.maximizable){ - this.addTool({ - id: 'maximize', - handler: this.maximize.createDelegate(this, []) - }); - this.addTool({ - id: 'restore', - handler: this.restore.createDelegate(this, []), - hidden:true - }); + preFocus : function(){ + var me = this, + inputEl = me.inputEl, + emptyText = me.emptyText, + isEmpty; + + if (emptyText && !Ext.supports.Placeholder && inputEl.dom.value === emptyText) { + me.setRawValue(''); + isEmpty = true; + inputEl.removeCls(me.emptyCls); + } else if (Ext.supports.Placeholder) { + me.inputEl.removeCls(me.emptyCls); } - if(this.closable){ - this.addTool({ - id: 'close', - handler: this[this.closeAction].createDelegate(this, []) - }); + if (me.selectOnFocus || isEmpty) { + inputEl.dom.select(); } }, - // private - resizerAction : function(){ - var box = this.proxy.getBox(); - this.proxy.hide(); - this.window.handleResize(box); - return box; + onFocus: function() { + var me = this; + me.callParent(arguments); + if (me.emptyText) { + me.autoSize(); + } }, // private - beforeResize : function(){ - this.resizer.minHeight = Math.max(this.minHeight, this.getFrameHeight() + 40); // 40 is a magic minimum content size? - this.resizer.minWidth = Math.max(this.minWidth, this.getFrameWidth() + 40); - this.resizeBox = this.el.getBox(); + postBlur : function(){ + this.applyEmptyText(); }, // private - updateHandles : function(){ - if(Ext.isIE && this.resizer){ - this.resizer.syncHandleHeight(); - this.el.repaint(); + filterKeys : function(e){ + if(e.ctrlKey){ + return; } - }, - - // private - handleResize : function(box){ - var rz = this.resizeBox; - if(rz.x != box.x || rz.y != box.y){ - this.updateBox(box); - }else{ - this.setSize(box); - if (Ext.isIE6 && Ext.isStrict) { - this.doLayout(); - } + var key = e.getKey(), + charCode = String.fromCharCode(e.getCharCode()); + + if(Ext.isGecko && (e.isNavKeyPress() || key === e.BACKSPACE || (key === e.DELETE && e.button === -1))){ + return; + } + + if(!Ext.isGecko && e.isSpecialKey() && !charCode){ + return; + } + if(!this.maskRe.test(charCode)){ + e.stopEvent(); } - this.focus(); - this.updateHandles(); - this.saveState(); }, /** - * Focuses the window. If a defaultButton is set, it will receive focus, otherwise the - * window itself will receive focus. + * Returns the raw String value of the field, without performing any normalization, conversion, or validation. + * Gets the current value of the input element if the field has been rendered, ignoring the value if it is the + * {@link #emptyText}. To get a normalized and converted value see {@link #getValue}. + * @return {String} value The raw String value of the field */ - focus : function(){ - var f = this.focusEl, - db = this.defaultButton, - t = typeof db, - el, - ct; - if(Ext.isDefined(db)){ - if(Ext.isNumber(db) && this.fbar){ - f = this.fbar.items.get(db); - }else if(Ext.isString(db)){ - f = Ext.getCmp(db); - }else{ - f = db; - } - el = f.getEl(); - ct = Ext.getDom(this.container); - if (el && ct) { - if (!Ext.lib.Region.getRegion(ct).contains(Ext.lib.Region.getRegion(el.dom))){ - return; - } - } + getRawValue: function() { + var me = this, + v = me.callParent(); + if (v === me.emptyText) { + v = ''; } - f = f || this.focusEl; - f.focus.defer(10, f); + return v; }, /** - * Sets the target element from which the window should animate while opening. - * @param {String/Element} el The target element or id + * Sets a data value into the field and runs the change detection and validation. Also applies any configured + * {@link #emptyText} for text fields. To set the value directly without these inspections see {@link #setRawValue}. + * @param {Mixed} value The value to set + * @return {Ext.form.field.Text} this */ - setAnimateTarget : function(el){ - el = Ext.get(el); - this.animateTarget = el; - }, - - // private - beforeShow : function(){ - delete this.el.lastXY; - delete this.el.lastLT; - if(this.x === undefined || this.y === undefined){ - var xy = this.el.getAlignToXY(this.container, 'c-c'); - var pos = this.el.translatePoints(xy[0], xy[1]); - this.x = this.x === undefined? pos.left : this.x; - this.y = this.y === undefined? pos.top : this.y; - } - this.el.setLeftTop(this.x, this.y); - - if(this.expandOnShow){ - this.expand(false); + setValue: function(value) { + var me = this, + inputEl = me.inputEl; + + if (inputEl && me.emptyText && !Ext.isEmpty(value)) { + inputEl.removeCls(me.emptyCls); } + + me.callParent(arguments); - if(this.modal){ - Ext.getBody().addClass('x-body-masked'); - this.mask.setSize(Ext.lib.Dom.getViewWidth(true), Ext.lib.Dom.getViewHeight(true)); - this.mask.show(); - } + me.applyEmptyText(); + return me; }, /** - * Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden. - * @param {String/Element} animateTarget (optional) The target element or id from which the window should - * animate while opening (defaults to null with no animation) - * @param {Function} callback (optional) A callback function to call after the window is displayed - * @param {Object} scope (optional) The scope (startDrag
,onDrag
andendDrag
- * which perform the dragging action. If extra logic is needed at these points, use - * {@link Function#createInterceptor createInterceptor} or {@link Function#createSequence createSequence} to - * augment the existing implementations.this
reference) in which the callback is executed. Defaults to this Window. - * @return {Ext.Window} this +Validates a value according to the field's validation rules and returns an array of errors +for any failing validations. Validation rules are processed in the following order: + +1. **Field specific validator** + + A validator offers a way to customize and reuse a validation specification. + If a field is configured with a `{@link #validator}` + function, it will be passed the current field value. The `{@link #validator}` + function is expected to return either: + + - Boolean `true` if the value is valid (validation continues). + - a String to represent the invalid message if invalid (validation halts). + +2. **Basic Validation** + + If the `{@link #validator}` has not halted validation, + basic validation proceeds as follows: + + - `{@link #allowBlank}` : (Invalid message = `{@link #emptyText}`) + + Depending on the configuration of{@link #allowBlank}
, a + blank field will cause validation to halt at this step and return + Boolean true or false accordingly. + + - `{@link #minLength}` : (Invalid message = `{@link #minLengthText}`) + + If the passed value does not satisfy the `{@link #minLength}` + specified, validation halts. + + - `{@link #maxLength}` : (Invalid message = `{@link #maxLengthText}`) + + If the passed value does not satisfy the `{@link #maxLength}` + specified, validation halts. + +3. **Preconfigured Validation Types (VTypes)** + + If none of the prior validation steps halts validation, a field + configured with a `{@link #vtype}` will utilize the + corresponding {@link Ext.form.field.VTypes VTypes} validation function. + If invalid, either the field's `{@link #vtypeText}` or + the VTypes vtype Text property will be used for the invalid message. + Keystrokes on the field will be filtered according to the VTypes + vtype Mask property. + +4. **Field specific regex test** + + If none of the prior validation steps halts validation, a field's + configured{@link #regex}
test will be processed. + The invalid message for this test is configured with `{@link #regexText}` + + * @param {Mixed} value The value to validate. The processed raw value will be used if nothing is passed + * @return {Array} Array of any validation errors + * @markdown */ - show : function(animateTarget, cb, scope){ - if(!this.rendered){ - this.render(Ext.getBody()); - } - if(this.hidden === false){ - this.toFront(); - return this; - } - if(this.fireEvent('beforeshow', this) === false){ - return this; - } - if(cb){ - this.on('show', cb, scope, {single:true}); - } - this.hidden = false; - if(Ext.isDefined(animateTarget)){ - this.setAnimateTarget(animateTarget); - } - this.beforeShow(); - if(this.animateTarget){ - this.animShow(); - }else{ - this.afterShow(); + getErrors: function(value) { + var me = this, + errors = me.callParent(arguments), + validator = me.validator, + emptyText = me.emptyText, + allowBlank = me.allowBlank, + vtype = me.vtype, + vtypes = Ext.form.field.VTypes, + regex = me.regex, + format = Ext.String.format, + msg; + + value = value || me.processRawValue(me.getRawValue()); + + if (Ext.isFunction(validator)) { + msg = validator.call(me, value); + if (msg !== true) { + errors.push(msg); + } } - return this; - }, - // private - afterShow : function(isAnim){ - if (this.isDestroyed){ - return false; - } - this.proxy.hide(); - this.el.setStyle('display', 'block'); - this.el.show(); - if(this.maximized){ - this.fitContainer(); + if (value.length < 1 || value === emptyText) { + if (!allowBlank) { + errors.push(me.blankText); + } + //if value is blank, there cannot be any additional errors + return errors; } - if(Ext.isMac && Ext.isGecko2){ // work around stupid FF 2.0/Mac scroll bar bug - this.cascade(this.setAutoScroll); + + if (value.length < me.minLength) { + errors.push(format(me.minLengthText, me.minLength)); } - if(this.monitorResize || this.modal || this.constrain || this.constrainHeader){ - Ext.EventManager.onWindowResize(this.onWindowResize, this); + if (value.length > me.maxLength) { + errors.push(format(me.maxLengthText, me.maxLength)); } - this.doConstrain(); - this.doLayout(); - if(this.keyMap){ - this.keyMap.enable(); + + if (vtype) { + if(!vtypes[vtype](value, me)){ + errors.push(me.vtypeText || vtypes[vtype +'Text']); + } } - this.toFront(); - this.updateHandles(); - if(isAnim && (Ext.isIE || Ext.isWebKit)){ - var sz = this.getSize(); - this.onResize(sz.width, sz.height); + + if (regex && !regex.test(value)) { + errors.push(me.regexText || me.invalidText); } - this.onShow(); - this.fireEvent('show', this); - }, - // private - animShow : function(){ - this.proxy.show(); - this.proxy.setBox(this.animateTarget.getBox()); - this.proxy.setOpacity(0); - var b = this.getBox(); - this.el.setStyle('display', 'none'); - this.proxy.shift(Ext.apply(b, { - callback: this.afterShow.createDelegate(this, [true], false), - scope: this, - easing: 'easeNone', - duration: 0.25, - opacity: 0.5 - })); + return errors; }, /** - * Hides the window, setting it to invisible and applying negative offsets. - * @param {String/Element} animateTarget (optional) The target element or id to which the window should - * animate while hiding (defaults to null with no animation) - * @param {Function} callback (optional) A callback function to call after the window is hidden - * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to this Window. - * @return {Ext.Window} this + * Selects text in this field + * @param {Number} start (optional) The index where the selection should start (defaults to 0) + * @param {Number} end (optional) The index where the selection should end (defaults to the text length) */ - hide : function(animateTarget, cb, scope){ - if(this.hidden || this.fireEvent('beforehide', this) === false){ - return this; - } - if(cb){ - this.on('hide', cb, scope, {single:true}); - } - this.hidden = true; - if(animateTarget !== undefined){ - this.setAnimateTarget(animateTarget); - } - if(this.modal){ - this.mask.hide(); - Ext.getBody().removeClass('x-body-masked'); + selectText : function(start, end){ + var me = this, + v = me.getRawValue(), + doFocus = true, + el = me.inputEl.dom, + undef, + range; + + if (v.length > 0) { + start = start === undef ? 0 : start; + end = end === undef ? v.length : end; + if (el.setSelectionRange) { + el.setSelectionRange(start, end); + } + else if(el.createTextRange) { + range = el.createTextRange(); + range.moveStart('character', start); + range.moveEnd('character', end - v.length); + range.select(); + } + doFocus = Ext.isGecko || Ext.isOpera; } - if(this.animateTarget){ - this.animHide(); - }else{ - this.el.hide(); - this.afterHide(); + if (doFocus) { + me.focus(); } - return this; }, - // private - afterHide : function(){ - this.proxy.hide(); - if(this.monitorResize || this.modal || this.constrain || this.constrainHeader){ - Ext.EventManager.removeResizeListener(this.onWindowResize, this); - } - if(this.keyMap){ - this.keyMap.disable(); + /** + * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. + * This only takes effect if {@link #grow} = true, and fires the {@link #autosize} event if the + * width changes. + */ + autoSize: function() { + var me = this, + width; + if (me.grow && me.rendered) { + me.doComponentLayout(); + width = me.inputEl.getWidth(); + if (width !== me.lastInputWidth) { + me.fireEvent('autosize', width); + me.lastInputWidth = width; + } } - this.onHide(); - this.fireEvent('hide', this); }, - // private - animHide : function(){ - this.proxy.setOpacity(0.5); - this.proxy.show(); - var tb = this.getBox(false); - this.proxy.setBox(tb); - this.el.hide(); - this.proxy.shift(Ext.apply(this.animateTarget.getBox(), { - callback: this.afterHide, - scope: this, - duration: 0.25, - easing: 'easeNone', - opacity: 0 - })); + initAria: function() { + this.callParent(); + this.getActionEl().dom.setAttribute('aria-required', this.allowBlank === false); }, /** - * Method that is called immediately before theshow
event is fired. - * Defaults toExt.emptyFn
. + * @protected override + * To get the natural width of the inputEl, we do a simple calculation based on the + * 'size' config. We use hard-coded numbers to approximate what browsers do natively, + * to avoid having to read any styles which would hurt performance. + */ + getBodyNaturalWidth: function() { + return Math.round(this.size * 6.5) + 20; + } + +}); + +/** + * @class Ext.form.field.TextArea + * @extends Ext.form.field.Text + +This class creates a multiline text field, which can be used as a direct replacement for traditional +textarea fields. In addition, it supports automatically {@link #grow growing} the height of the textarea to +fit its content. + +All of the configuration options from {@link Ext.form.field.Text} can be used on TextArea. +{@img Ext.form.TextArea/Ext.form.TextArea.png Ext.form.TextArea component} +Example usage: + + Ext.create('Ext.form.FormPanel', { + title : 'Sample TextArea', + width : 400, + bodyPadding: 10, + renderTo : Ext.getBody(), + items: [{ + xtype : 'textareafield', + grow : true, + name : 'message', + fieldLabel: 'Message', + anchor : '100%' + }] + }); + +Some other useful configuration options when using {@link #grow} are {@link #growMin} and {@link #growMax}. These +allow you to set the minimum and maximum grow heights for the textarea. + + * @docauthor Robert Dougan+ */ +Ext.define('Ext.form.field.TextArea', { + extend:'Ext.form.field.Text', + alias: ['widget.textareafield', 'widget.textarea'], + alternateClassName: 'Ext.form.TextArea', + requires: ['Ext.XTemplate', 'Ext.layout.component.field.TextArea'], + + fieldSubTpl: [ + '', + { + compiled: true, + disableFormats: true + } + ], + + /** + * @cfg {Number} growMin The minimum height to allow when {@link Ext.form.field.Text#grow grow}=true + * (defaults to 60) + */ + growMin: 60, + + /** + * @cfg {Number} growMax The maximum height to allow when {@link Ext.form.field.Text#grow grow}=true + * (defaults to 1000) + */ + growMax: 1000, + + /** + * @cfg {String} growAppend + * A string that will be appended to the field's current value for the purposes of calculating the target + * field size. Only used when the {@link #grow} config is true. Defaults to a newline for TextArea + * to ensure there is always a space below the current line. + */ + growAppend: '\n-', + + /** + * @cfg {Number} cols An initial value for the 'cols' attribute on the textarea element. This is only + * used if the component has no configured {@link #width} and is not given a width by its container's + * layout. Defaults to 20. + */ + cols: 20, + + /** + * @cfg {Number} cols An initial value for the 'cols' attribute on the textarea element. This is only + * used if the component has no configured {@link #width} and is not given a width by its container's + * layout. Defaults to 4. + */ + rows: 4, + + /** + * @cfg {Boolean} enterIsSpecial + * True if you want the enter key to be classed as a special key. Special keys are generally navigation + * keys (arrows, space, enter). Setting the config property to true would mean that you could not insert + * returns into the textarea. + * (defaults to false) */ - onShow : Ext.emptyFn, + enterIsSpecial: false, /** - * Method that is called immediately before the hide
event is fired. - * Defaults toExt.emptyFn
. + * @cfg {Boolean} preventScrollbars true to prevent scrollbars from appearing regardless of how much text is + * in the field. This option is only relevant when {@link #grow} is true. Equivalent to setting overflow: hidden, defaults to + * false. */ - onHide : Ext.emptyFn, + preventScrollbars: false, // private - onWindowResize : function(){ - if(this.maximized){ - this.fitContainer(); - } - if(this.modal){ - this.mask.setSize('100%', '100%'); - var force = this.mask.dom.offsetHeight; - this.mask.setSize(Ext.lib.Dom.getViewWidth(true), Ext.lib.Dom.getViewHeight(true)); - } - this.doConstrain(); + componentLayout: 'textareafield', + + // private + onRender: function(ct, position) { + var me = this; + Ext.applyIf(me.subTplData, { + cols: me.cols, + rows: me.rows + }); + + me.callParent(arguments); }, // private - doConstrain : function(){ - if(this.constrain || this.constrainHeader){ - var offsets; - if(this.constrain){ - offsets = { - right:this.el.shadowOffset, - left:this.el.shadowOffset, - bottom:this.el.shadowOffset - }; - }else { - var s = this.getSize(); - offsets = { - right:-(s.width - 100), - bottom:-(s.height - 25) - }; - } + afterRender: function(){ + var me = this; + + me.callParent(arguments); - var xy = this.el.getConstrainToXY(this.container, true, offsets); - if(xy){ - this.setPosition(xy[0], xy[1]); + if (me.grow) { + if (me.preventScrollbars) { + me.inputEl.setStyle('overflow', 'hidden'); } + me.inputEl.setHeight(me.growMin); } }, - // private - used for dragging - ghost : function(cls){ - var ghost = this.createGhost(cls); - var box = this.getBox(true); - ghost.setLeftTop(box.x, box.y); - ghost.setWidth(box.width); - this.el.hide(); - this.activeGhost = ghost; - return ghost; - }, - // private - unghost : function(show, matchPosition){ - if(!this.activeGhost) { - return; + fireKey: function(e) { + if (e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() !== e.ENTER || e.hasModifier()))) { + this.fireEvent('specialkey', this, e); } - if(show !== false){ - this.el.show(); - this.focus.defer(10, this); - if(Ext.isMac && Ext.isGecko2){ // work around stupid FF 2.0/Mac scroll bar bug - this.cascade(this.setAutoScroll); + }, + + /** + * Automatically grows the field to accomodate the height of the text up to the maximum field height allowed. + * This only takes effect if {@link #grow} = true, and fires the {@link #autosize} event if + * the height changes. + */ + autoSize: function() { + var me = this, + height; + + if (me.grow && me.rendered) { + me.doComponentLayout(); + height = me.inputEl.getHeight(); + if (height !== me.lastInputHeight) { + me.fireEvent('autosize', height); + me.lastInputHeight = height; } } - if(matchPosition !== false){ - this.setPosition(this.activeGhost.getLeft(true), this.activeGhost.getTop(true)); - } - this.activeGhost.hide(); - this.activeGhost.remove(); - delete this.activeGhost; + }, + + // private + initAria: function() { + this.callParent(arguments); + this.getActionEl().dom.setAttribute('aria-multiline', true); }, /** - * Placeholder method for minimizing the window. By default, this method simply fires the {@link #minimize} event - * since the behavior of minimizing a window is application-specific. To implement custom minimize behavior, - * either the minimize event can be handled or this method can be overridden. - * @return {Ext.Window} this + * @protected override + * To get the natural width of the textarea element, we do a simple calculation based on the + * 'cols' config. We use hard-coded numbers to approximate what browsers do natively, + * to avoid having to read any styles which would hurt performance. */ - minimize : function(){ - this.fireEvent('minimize', this); - return this; + getBodyNaturalWidth: function() { + return Math.round(this.cols * 6.5) + 20; + } + +}); + + +/** + * @class Ext.window.MessageBox + * @extends Ext.window.Window + +Utility class for generating different styles of message boxes. The singleton instance, `Ext.Msg` can also be used. +Note that a MessageBox is asynchronous. Unlike a regular JavaScript `alert` (which will halt +browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code +that should only run *after* some user feedback from the MessageBox, you must use a callback function +(see the `function` parameter for {@link #show} for more details). + +{@img Ext.window.MessageBox/messagebox1.png alert MessageBox} +{@img Ext.window.MessageBox/messagebox2.png prompt MessageBox} +{@img Ext.window.MessageBox/messagebox3.png show MessageBox} +#Example usage:# + + // Basic alert: + Ext.Msg.alert('Status', 'Changes saved successfully.'); + + // Prompt for user data and process the result using a callback: + Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){ + if (btn == 'ok'){ + // process text value and close... + } + }); + + // Show a dialog using config options: + Ext.Msg.show({ + title:'Save Changes?', + msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?', + buttons: Ext.Msg.YESNOCANCEL, + fn: processResult, + animateTarget: 'elId', + icon: Ext.window.MessageBox.QUESTION + }); + + * @markdown + * @singleton + */ +Ext.define('Ext.window.MessageBox', { + extend: 'Ext.window.Window', + + requires: [ + 'Ext.toolbar.Toolbar', + 'Ext.form.field.Text', + 'Ext.form.field.TextArea', + 'Ext.button.Button', + 'Ext.layout.container.Anchor', + 'Ext.layout.container.HBox', + 'Ext.ProgressBar' + ], + + alternateClassName: 'Ext.MessageBox', + + alias: 'widget.messagebox', + + /** + * Button config that displays a single OK button + * @type Number + */ + OK : 1, + /** + * Button config that displays a single Yes button + * @type Number + */ + YES : 2, + /** + * Button config that displays a single No button + * @type Number + */ + NO : 4, + /** + * Button config that displays a single Cancel button + * @type Number + */ + CANCEL : 8, + /** + * Button config that displays OK and Cancel buttons + * @type Number + */ + OKCANCEL : 9, + /** + * Button config that displays Yes and No buttons + * @type Number + */ + YESNO : 6, + /** + * Button config that displays Yes, No and Cancel buttons + * @type Number + */ + YESNOCANCEL : 14, + /** + * The CSS class that provides the INFO icon image + * @type String + */ + INFO : 'ext-mb-info', + /** + * The CSS class that provides the WARNING icon image + * @type String + */ + WARNING : 'ext-mb-warning', + /** + * The CSS class that provides the QUESTION icon image + * @type String + */ + QUESTION : 'ext-mb-question', + /** + * The CSS class that provides the ERROR icon image + * @type String + */ + ERROR : 'ext-mb-error', + + // hide it by offsets. Windows are hidden on render by default. + hideMode: 'offsets', + closeAction: 'hide', + resizable: false, + title: ' ', + + width: 600, + height: 500, + minWidth: 250, + maxWidth: 600, + minHeight: 110, + maxHeight: 500, + constrain: true, + + cls: Ext.baseCSSPrefix + 'message-box', + + layout: { + type: 'anchor' }, /** - *Closes the Window, removes it from the DOM, {@link Ext.Component#destroy destroy}s - * the Window object and all its descendant Components. The {@link Ext.Panel#beforeclose beforeclose} - * event is fired before the close happens and will cancel the close action if it returns false.
- *
Note: This method is not affected by the {@link #closeAction} setting which - * only affects the action triggered when clicking the {@link #closable 'close' tool in the header}. - * To hide the Window without destroying it, call {@link #hide}.
+ * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) + * @type Number */ - close : function(){ - if(this.fireEvent('beforeclose', this) !== false){ - if(this.hidden){ - this.doClose(); - }else{ - this.hide(null, this.doClose, this); + defaultTextHeight : 75, + /** + * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful + * for setting a different minimum width than text-only dialogs may need (defaults to 250). + * @type Number + */ + minProgressWidth : 250, + /** + * The minimum width in pixels of the message box if it is a prompt dialog. This is useful + * for setting a different minimum width than text-only dialogs may need (defaults to 250). + * @type Number + */ + minPromptWidth: 250, + /** + * An object containing the default button text strings that can be overriden for localized language support. + * Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific + * resource file for handling language support across the framework. + * Customize the default text like so: Ext.window.MessageBox.buttonText.yes = "oui"; //french + * @type Object + */ + buttonText: { + ok: 'OK', + yes: 'Yes', + no: 'No', + cancel: 'Cancel' + }, + + buttonIds: [ + 'ok', 'yes', 'no', 'cancel' + ], + + titleText: { + confirm: 'Confirm', + prompt: 'Prompt', + wait: 'Loading...', + alert: 'Attention' + }, + + iconHeight: 35, + + makeButton: function(btnIdx) { + var btnId = this.buttonIds[btnIdx]; + return Ext.create('Ext.button.Button', { + handler: this.btnCallback, + itemId: btnId, + scope: this, + text: this.buttonText[btnId], + minWidth: 75 + }); + }, + + btnCallback: function(btn) { + var me = this, + value, + field; + + if (me.cfg.prompt || me.cfg.multiline) { + if (me.cfg.multiline) { + field = me.textArea; + } else { + field = me.textField; } + value = field.getValue(); + field.reset(); } + + // Important not to have focus remain in the hidden Window; Interferes with DnD. + btn.blur(); + me.hide(); + me.userCallback(btn.itemId, value, me.cfg); }, - // private - doClose : function(){ - this.fireEvent('close', this); - this.destroy(); + hide: function() { + var me = this; + me.dd.endDrag(); + me.progressBar.reset(); + me.removeCls(me.cfg.cls); + me.callParent(); }, - /** - * Fits the window within its current container and automatically replaces - * the {@link #maximizable 'maximize' tool button} with the 'restore' tool button. - * Also see {@link #toggleMaximize}. - * @return {Ext.Window} this - */ - maximize : function(){ - if(!this.maximized){ - this.expand(false); - this.restoreSize = this.getSize(); - this.restorePos = this.getPosition(true); - if (this.maximizable){ - this.tools.maximize.hide(); - this.tools.restore.show(); + initComponent: function() { + var me = this, + i, button; + + me.title = ' '; + + me.topContainer = Ext.create('Ext.container.Container', { + anchor: '100%', + style: { + padding: '10px', + overflow: 'hidden' + }, + items: [ + me.iconComponent = Ext.create('Ext.Component', { + cls: 'ext-mb-icon', + width: 50, + height: me.iconHeight, + style: { + 'float': 'left' + } + }), + me.promptContainer = Ext.create('Ext.container.Container', { + layout: { + type: 'anchor' + }, + items: [ + me.msg = Ext.create('Ext.Component', { + autoEl: { tag: 'span' }, + cls: 'ext-mb-text' + }), + me.textField = Ext.create('Ext.form.field.Text', { + anchor: '100%', + enableKeyEvents: true, + listeners: { + keydown: me.onPromptKey, + scope: me + } + }), + me.textArea = Ext.create('Ext.form.field.TextArea', { + anchor: '100%', + height: 75 + }) + ] + }) + ] + }); + me.progressBar = Ext.create('Ext.ProgressBar', { + anchor: '-10', + style: 'margin-left:10px' + }); + + me.items = [me.topContainer, me.progressBar]; + + // Create the buttons based upon passed bitwise config + me.msgButtons = []; + for (i = 0; i < 4; i++) { + button = me.makeButton(i); + me.msgButtons[button.itemId] = button; + me.msgButtons.push(button); + } + me.bottomTb = Ext.create('Ext.toolbar.Toolbar', { + ui: 'footer', + dock: 'bottom', + layout: { + pack: 'center' + }, + items: [ + me.msgButtons[0], + me.msgButtons[1], + me.msgButtons[2], + me.msgButtons[3] + ] + }); + me.dockedItems = [me.bottomTb]; + + me.callParent(); + }, + + onPromptKey: function(textField, e) { + var me = this, + blur; + + if (e.keyCode === Ext.EventObject.RETURN || e.keyCode === 10) { + if (me.msgButtons.ok.isVisible()) { + blur = true; + me.msgButtons.ok.handler.call(me, me.msgButtons.ok); + } else if (me.msgButtons.yes.isVisible()) { + me.msgButtons.yes.handler.call(me, me.msgButtons.yes); + blur = true; + } + + if (blur) { + me.textField.blur(); + } + } + }, + + reconfigure: function(cfg) { + var me = this, + buttons = cfg.buttons || 0, + hideToolbar = true, + initialWidth = me.maxWidth, + i; + + cfg = cfg || {}; + me.cfg = cfg; + if (cfg.width) { + initialWidth = cfg.width; + } + + // Default to allowing the Window to take focus. + delete me.defaultFocus; + + // clear any old animateTarget + me.animateTarget = cfg.animateTarget || undefined; + + // Defaults to modal + me.modal = cfg.modal !== false; + + // Show the title + if (cfg.title) { + me.setTitle(cfg.title||' '); + } + + if (!me.rendered) { + me.width = initialWidth; + me.render(Ext.getBody()); + } else { + me.hidden = false; + me.setSize(initialWidth, me.maxHeight); + } + me.setPosition(-10000, -10000); + + // Hide or show the close tool + me.closable = cfg.closable && !cfg.wait; + if (cfg.closable === false) { + me.tools.close.hide(); + } else { + me.tools.close.show(); + } + + // Hide or show the header + if (!cfg.title && !me.closable) { + me.header.hide(); + } else { + me.header.show(); + } + + // Default to dynamic drag: drag the window, not a ghost + me.liveDrag = !cfg.proxyDrag; + + // wrap the user callback + me.userCallback = Ext.Function.bind(cfg.callback ||cfg.fn || Ext.emptyFn, cfg.scope || Ext.global); + + // Hide or show the icon Component + me.setIcon(cfg.icon); + + // Hide or show the message area + if (cfg.msg) { + me.msg.update(cfg.msg); + me.msg.show(); + } else { + me.msg.hide(); + } + + // Hide or show the input field + if (cfg.prompt || cfg.multiline) { + me.multiline = cfg.multiline; + if (cfg.multiline) { + me.textArea.setValue(cfg.value); + me.textArea.setHeight(cfg.defaultTextHeight || me.defaultTextHeight); + me.textArea.show(); + me.textField.hide(); + me.defaultFocus = me.textArea; + } else { + me.textField.setValue(cfg.value); + me.textArea.hide(); + me.textField.show(); + me.defaultFocus = me.textField; } - this.maximized = true; - this.el.disableShadow(); + } else { + me.textArea.hide(); + me.textField.hide(); + } - if(this.dd){ - this.dd.lock(); + // Hide or show the progress bar + if (cfg.progress || cfg.wait) { + me.progressBar.show(); + me.updateProgress(0, cfg.progressText); + if(cfg.wait === true){ + me.progressBar.wait(cfg.waitConfig); } - if(this.collapsible){ - this.tools.toggle.hide(); - } - this.el.addClass('x-window-maximized'); - this.container.addClass('x-window-maximized-ct'); - - this.setPosition(0, 0); - this.fitContainer(); - this.fireEvent('maximize', this); + } else { + me.progressBar.hide(); } - return this; - }, - /** - * Restores a {@link #maximizable maximized} window back to its original - * size and position prior to being maximized and also replaces - * the 'restore' tool button with the 'maximize' tool button. - * Also see {@link #toggleMaximize}. - * @return {Ext.Window} this - */ - restore : function(){ - if(this.maximized){ - var t = this.tools; - this.el.removeClass('x-window-maximized'); - if(t.restore){ - t.restore.hide(); - } - if(t.maximize){ - t.maximize.show(); - } - this.setPosition(this.restorePos[0], this.restorePos[1]); - this.setSize(this.restoreSize.width, this.restoreSize.height); - delete this.restorePos; - delete this.restoreSize; - this.maximized = false; - this.el.enableShadow(true); + // Hide or show buttons depending on flag value sent. + for (i = 0; i < 4; i++) { + if (buttons & Math.pow(2, i)) { - if(this.dd){ - this.dd.unlock(); - } - if(this.collapsible && t.toggle){ - t.toggle.show(); + // Default to focus on the first visible button if focus not already set + if (!me.defaultFocus) { + me.defaultFocus = me.msgButtons[i]; + } + me.msgButtons[i].show(); + hideToolbar = false; + } else { + me.msgButtons[i].hide(); } - this.container.removeClass('x-window-maximized-ct'); - - this.doConstrain(); - this.fireEvent('restore', this); } - return this; - }, - /** - * A shortcut method for toggling between {@link #maximize} and {@link #restore} based on the current maximized - * state of the window. - * @return {Ext.Window} this + // Hide toolbar if no buttons to show + if (hideToolbar) { + me.bottomTb.hide(); + } else { + me.bottomTb.show(); + } + me.hidden = true; + }, + + /** + * Displays a new message box, or reinitializes an existing message box, based on the config options + * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally, + * although those calls are basic shortcuts and do not support all of the config options allowed here. + * @param {Object} config The following config options are supported:+ *
+ * Example usage: + *- animateTarget : String/Element
+ *An id or Element from which the message box should animate as it + * opens and closes (defaults to undefined)- buttons : Number
+ *A bitwise button specifier consisting of the sum of any of the following constants:+ *
Or false to not show any buttons (defaults to false)- Ext.window.MessageBox.OK
+ *- Ext.window.MessageBox.YES
+ *- Ext.window.MessageBox.NO
+ *- Ext.window.MessageBox.CANCEL
+ *- closable : Boolean
+ *False to hide the top-right close button (defaults to true). Note that + * progress and wait dialogs will ignore this property and always hide the close button as they can only + * be closed programmatically.- cls : String
+ *A custom CSS class to apply to the message box's container element- defaultTextHeight : Number
+ *The default height in pixels of the message box's multiline textarea + * if displayed (defaults to 75)- fn : Function
+ *A callback function which is called when the dialog is dismissed either + * by clicking on the configured buttons, or on the dialog close button, or by pressing + * the return button to enter input. + *Progress and wait dialogs will ignore this option since they do not respond to user + * actions and can only be closed programmatically, so any required function should be called + * by the same code after it closes the dialog. Parameters passed:
+ *
- buttonId : String
+ *The ID of the button pressed, one of:+ *
- ok
+ *- yes
+ *- no
+ *- cancel
+ *- text : String
+ *- opt : Object
+ *The config object passed to show.- scope : Object
+ *The scope (this
reference) in which the function will be executed.- icon : String
+ *A CSS class that provides a background image to be used as the body icon for the + * dialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')- iconCls : String
+ *The standard {@link Ext.window.Window#iconCls} to + * add an optional header icon (defaults to '')- maxWidth : Number
+ *The maximum width in pixels of the message box (defaults to 600)- minWidth : Number
+ *The minimum width in pixels of the message box (defaults to 100)- modal : Boolean
+ *False to allow user interaction with the page while the message box is + * displayed (defaults to true)- msg : String
+ *A string that will replace the existing message box body text (defaults to the + * XHTML-compliant non-breaking space character ' ')- multiline : Boolean
+ *+ * True to prompt the user to enter multi-line text (defaults to false)- progress : Boolean
+ *True to display a progress bar (defaults to false)- progressText : String
+ *The text to display inside the progress bar if progress = true (defaults to '')- prompt : Boolean
+ *True to prompt the user to enter single-line text (defaults to false)- proxyDrag : Boolean
+ *True to display a lightweight proxy while dragging (defaults to false)- title : String
+ *The title text- value : String
+ *The string value to set into the active textbox element if displayed- wait : Boolean
+ *True to display a progress bar (defaults to false)- waitConfig : Object
+ *A {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)- width : Number
+ *The width of the dialog in pixels+ * @return {Ext.window.MessageBox} this */ - toggleMaximize : function(){ - return this[this.maximized ? 'restore' : 'maximize'](); + show: function(cfg) { + var me = this; + + me.reconfigure(cfg); + me.addCls(cfg.cls); + if (cfg.animateTarget) { + me.doAutoSize(false); + me.callParent(); + } else { + me.callParent(); + me.doAutoSize(true); + } + return me; }, - // private - fitContainer : function(){ - var vs = this.container.getViewSize(false); - this.setSize(vs.width, vs.height); + afterShow: function(){ + if (this.animateTarget) { + this.center(); + } + this.callParent(arguments); }, - // private - // z-index is managed by the WindowManager and may be overwritten at any time - setZIndex : function(index){ - if(this.modal){ - this.mask.setStyle('z-index', index); + doAutoSize: function(center) { + var me = this, + icon = me.iconComponent, + iconHeight = me.iconHeight; + + if (!Ext.isDefined(me.frameWidth)) { + me.frameWidth = me.el.getWidth() - me.body.getWidth(); } - this.el.setZIndex(++index); - index += 5; - if(this.resizer){ - this.resizer.proxy.setStyle('z-index', ++index); + // reset to the original dimensions + icon.setHeight(iconHeight); + + // Allow per-invocation override of minWidth + me.minWidth = me.cfg.minWidth || Ext.getClass(this).prototype.minWidth; + + // Set best possible size based upon allowing the text to wrap in the maximized Window, and + // then constraining it to within the max with. Then adding up constituent element heights. + me.topContainer.doLayout(); + if (Ext.isIE6 || Ext.isIEQuirks) { + // In IE quirks, the initial full width of the prompt fields will prevent the container element + // from collapsing once sized down, so temporarily force them to a small width. They'll get + // layed out to their final width later when setting the final window size. + me.textField.setCalculatedSize(9); + me.textArea.setCalculatedSize(9); } + var width = me.cfg.width || me.msg.getWidth() + icon.getWidth() + 25, /* topContainer's layout padding */ + height = (me.header.rendered ? me.header.getHeight() : 0) + + Math.max(me.promptContainer.getHeight(), icon.getHeight()) + + me.progressBar.getHeight() + + (me.bottomTb.rendered ? me.bottomTb.getHeight() : 0) + 20 ;/* topContainer's layout padding */ - this.lastZIndex = index; + // Update to the size of the content, this way the text won't wrap under the icon. + icon.setHeight(Math.max(iconHeight, me.msg.getHeight())); + me.setSize(width + me.frameWidth, height + me.frameWidth); + if (center) { + me.center(); + } + return me; }, - /** - * Aligns the window to the specified element - * @param {Mixed} element The element to align to. - * @param {String} position (optional, defaults to "tl-bl?") The position to align to (see {@link Ext.Element#alignTo} for more details). - * @param {Array} offsets (optional) Offset the positioning by [x, y] - * @return {Ext.Window} this - */ - alignTo : function(element, position, offsets){ - var xy = this.el.getAlignToXY(element, position, offsets); - this.setPagePosition(xy[0], xy[1]); - return this; + updateText: function(text) { + this.msg.update(text); + return this.doAutoSize(true); }, /** - * Anchors this window to another element and realigns it when the window is resized or scrolled. - * @param {Mixed} element The element to align to. - * @param {String} position The position to align to (see {@link Ext.Element#alignTo} for more details) - * @param {Array} offsets (optional) Offset the positioning by [x, y] - * @param {Boolean/Number} monitorScroll (optional) true to monitor body scroll and reposition. If this parameter - * is a number, it is used as the buffer delay (defaults to 50ms). - * @return {Ext.Window} this - */ - anchorTo : function(el, alignment, offsets, monitorScroll){ - this.clearAnchor(); - this.anchorTarget = { - el: el, - alignment: alignment, - offsets: offsets - }; - - Ext.EventManager.onWindowResize(this.doAnchor, this); - var tm = typeof monitorScroll; - if(tm != 'undefined'){ - Ext.EventManager.on(window, 'scroll', this.doAnchor, this, - {buffer: tm == 'number' ? monitorScroll : 50}); + * Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default + * styling, and the class passed in is expected to supply the background image url. Pass in empty string ('') + * to clear any existing icon. This method must be called before the MessageBox is shown. + * The following built-in icon classes are supported, but you can also pass in a custom class name: + *+Ext.Msg.show({ +title: 'Address', +msg: 'Please enter your address:', +width: 300, +buttons: Ext.window.MessageBox.OKCANCEL, +multiline: true, +fn: saveAddress, +animateTarget: 'addAddressBtn', +icon: Ext.window.MessageBox.INFO +}); +
+Ext.window.MessageBox.INFO +Ext.window.MessageBox.WARNING +Ext.window.MessageBox.QUESTION +Ext.window.MessageBox.ERROR + *+ * @param {String} icon A CSS classname specifying the icon's background image url, or empty string to clear the icon + * @return {Ext.window.MessageBox} this + */ + setIcon : function(icon) { + var me = this; + me.iconComponent.removeCls(me.iconCls); + if (icon) { + me.iconComponent.show(); + me.iconComponent.addCls(Ext.baseCSSPrefix + 'dlg-icon'); + me.iconComponent.addCls(me.iconCls = icon); + } else { + me.iconComponent.removeCls(Ext.baseCSSPrefix + 'dlg-icon'); + me.iconComponent.hide(); } - return this.doAnchor(); + return me; }, /** - * Performs the anchor, using the saved anchorTarget property. - * @return {Ext.Window} this - * @private + * Updates a progress-style message box's text and progress bar. Only relevant on message boxes + * initiated via {@link Ext.window.MessageBox#progress} or {@link Ext.window.MessageBox#wait}, + * or by calling {@link Ext.window.MessageBox#show} with progress: true. + * @param {Number} value Any number between 0 and 1 (e.g., .5, defaults to 0) + * @param {String} progressText The progress text to display inside the progress bar (defaults to '') + * @param {String} msg The message box's body text is replaced with the specified string (defaults to undefined + * so that any existing body text will not get overwritten by default unless a new value is passed in) + * @return {Ext.window.MessageBox} this */ - doAnchor : function(){ - var o = this.anchorTarget; - this.alignTo(o.el, o.alignment, o.offsets); + updateProgress : function(value, progressText, msg){ + this.progressBar.updateProgress(value, progressText); + if (msg){ + this.updateText(msg); + } return this; }, - /** - * Removes any existing anchor from this window. See {@link #anchorTo}. - * @return {Ext.Window} this - */ - clearAnchor : function(){ - if(this.anchorTarget){ - Ext.EventManager.removeResizeListener(this.doAnchor, this); - Ext.EventManager.un(window, 'scroll', this.doAnchor, this); - delete this.anchorTarget; + onEsc: function() { + if (this.closable !== false) { + this.callParent(arguments); } - return this; }, /** - * Brings this window to the front of any other visible windows - * @param {Boolean} e (optional) Specify false to prevent the window from being focused. - * @return {Ext.Window} this + * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm). + * If a callback function is passed it will be called after the user clicks either button, + * and the id of the button that was clicked will be passed as the only parameter to the callback + * (could also be the top-right close button). + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to the browser wnidow. + * @return {Ext.window.MessageBox} this */ - toFront : function(e){ - if(this.manager.bringToFront(this)){ - if(!e || !e.getTarget().focus){ - this.focus(); - } + confirm: function(cfg, msg, fn, scope) { + if (Ext.isString(cfg)) { + cfg = { + title: cfg, + icon: 'ext-mb-question', + msg: msg, + buttons: this.YESNO, + callback: fn, + scope: scope + }; } - return this; + return this.show(cfg); }, /** - * Makes this the active window by showing its shadow, or deactivates it by hiding its shadow. This method also - * fires the {@link #activate} or {@link #deactivate} event depending on which action occurred. This method is - * called internally by {@link Ext.WindowMgr}. - * @param {Boolean} active True to activate the window, false to deactivate it (defaults to false) + * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt). + * The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user + * clicks either button, and the id of the button that was clicked (could also be the top-right + * close button) and the text that was entered will be passed as the two parameters to the callback. + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to the browser wnidow. + * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight + * property, or the height in pixels to create the textbox (defaults to false / single-line) + * @param {String} value (optional) Default value of the text input element (defaults to '') + * @return {Ext.window.MessageBox} this */ - setActive : function(active){ - if(active){ - if(!this.maximized){ - this.el.enableShadow(true); - } - this.fireEvent('activate', this); - }else{ - this.el.disableShadow(); - this.fireEvent('deactivate', this); + prompt : function(cfg, msg, fn, scope, multiline, value){ + if (Ext.isString(cfg)) { + cfg = { + prompt: true, + title: cfg, + minWidth: this.minPromptWidth, + msg: msg, + buttons: this.OKCANCEL, + callback: fn, + scope: scope, + multiline: multiline, + value: value + }; } + return this.show(cfg); }, /** - * Sends this window to the back of (lower z-index than) any other visible windows - * @return {Ext.Window} this + * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user + * interaction while waiting for a long-running process to complete that does not have defined intervals. + * You are responsible for closing the message box when the process is complete. + * @param {String} msg The message box body text + * @param {String} title (optional) The title bar text + * @param {Object} config (optional) A {@link Ext.ProgressBar#waitConfig} object + * @return {Ext.window.MessageBox} this */ - toBack : function(){ - this.manager.sendToBack(this); - return this; + wait : function(cfg, title, config){ + if (Ext.isString(cfg)) { + cfg = { + title : title, + msg : cfg, + closable: false, + wait: true, + modal: true, + minWidth: this.minProgressWidth, + waitConfig: config + }; + } + return this.show(cfg); }, /** - * Centers this window in the viewport - * @return {Ext.Window} this + * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt). + * If a callback function is passed it will be called after the user clicks the button, and the + * id of the button that was clicked will be passed as the only parameter to the callback + * (could also be the top-right close button). + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to the browser wnidow. + * @return {Ext.window.MessageBox} this */ - center : function(){ - var xy = this.el.getAlignToXY(this.container, 'c-c'); - this.setPagePosition(xy[0], xy[1]); - return this; - } - - /** - * @cfg {Boolean} autoWidth @hide - **/ -}); -Ext.reg('window', Ext.Window); - -// private - custom Window DD implementation -Ext.Window.DD = function(win){ - this.win = win; - Ext.Window.DD.superclass.constructor.call(this, win.el.id, 'WindowDD-'+win.id); - this.setHandleElId(win.header.id); - this.scroll = false; -}; - -Ext.extend(Ext.Window.DD, Ext.dd.DD, { - moveOnly:true, - headerOffsets:[100, 25], - startDrag : function(){ - var w = this.win; - this.proxy = w.ghost(); - if(w.constrain !== false){ - var so = w.el.shadowOffset; - this.constrainTo(w.container, {right: so, left: so, bottom: so}); - }else if(w.constrainHeader !== false){ - var s = this.proxy.getSize(); - this.constrainTo(w.container, {right: -(s.width-this.headerOffsets[0]), bottom: -(s.height-this.headerOffsets[1])}); + alert: function(cfg, msg, fn, scope) { + if (Ext.isString(cfg)) { + cfg = { + title : cfg, + msg : msg, + buttons: this.OK, + fn: fn, + scope : scope, + minWidth: this.minWidth + }; } + return this.show(cfg); }, - b4Drag : Ext.emptyFn, - onDrag : function(e){ - this.alignElWithMouse(this.proxy, e.getPageX(), e.getPageY()); - }, - - endDrag : function(e){ - this.win.unghost(); - this.win.saveState(); + /** + * Displays a message box with a progress bar. This message box has no buttons and is not closeable by + * the user. You are responsible for updating the progress bar as needed via {@link Ext.window.MessageBox#updateProgress} + * and closing the message box when the process is complete. + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {String} progressText (optional) The text to display inside the progress bar (defaults to '') + * @return {Ext.window.MessageBox} this + */ + progress : function(cfg, msg, progressText){ + if (Ext.isString(cfg)) { + cfg = { + title: cfg, + msg: msg, + progressText: progressText + }; + } + return this.show(cfg); } +}, function() { + Ext.MessageBox = Ext.Msg = new this(); }); /** - * @class Ext.WindowGroup - * An object that manages a group of {@link Ext.Window} instances and provides z-order management - * and window activation behavior. - * @constructor + * @class Ext.form.Basic + * @extends Ext.util.Observable + * + * Provides input field management, validation, submission, and form loading services for the collection + * of {@link Ext.form.field.Field Field} instances within a {@link Ext.container.Container}. It is recommended + * that you use a {@link Ext.form.Panel} as the form container, as that has logic to automatically + * hook up an instance of {@link Ext.form.Basic} (plus other conveniences related to field configuration.) + * + * ## Form Actions + * + * The Basic class delegates the handling of form loads and submits to instances of {@link Ext.form.action.Action}. + * See the various Action implementations for specific details of each one's functionality, as well as the + * documentation for {@link #doAction} which details the configuration options that can be specified in + * each action call. + * + * The default submit Action is {@link Ext.form.action.Submit}, which uses an Ajax request to submit the + * form's values to a configured URL. To enable normal browser submission of an Ext form, use the + * {@link #standardSubmit} config option. + * + * Note: File uploads are not performed using normal 'Ajax' techniques; see the description for + * {@link #hasUpload} for details. + * + * ## Example usage: + * + * Ext.create('Ext.form.Panel', { + * title: 'Basic Form', + * renderTo: Ext.getBody(), + * bodyPadding: 5, + * width: 350, + * + * // Any configuration items here will be automatically passed along to + * // the Ext.form.Basic instance when it gets created. + * + * // The form will submit an AJAX request to this URL when submitted + * url: 'save-form.php', + * + * items: [{ + * fieldLabel: 'Field', + * name: 'theField' + * }], + * + * buttons: [{ + * text: 'Submit', + * handler: function() { + * // The getForm() method returns the Ext.form.Basic instance: + * var form = this.up('form').getForm(); + * if (form.isValid()) { + * // Submit the Ajax request and handle the response + * form.submit({ + * success: function(form, action) { + * Ext.Msg.alert('Success', action.result.msg); + * }, + * failure: function(form, action) { + * Ext.Msg.alert('Failed', action.result.msg); + * } + * }); + * } + * } + * }] + * }); + * + * @docauthor Jason Johnston*/ -Ext.WindowGroup = function(){ - var list = {}; - var accessList = []; - var front = null; - - // private - var sortWindows = function(d1, d2){ - return (!d1._lastAccess || d1._lastAccess < d2._lastAccess) ? -1 : 1; - }; - - // private - var orderWindows = function(){ - var a = accessList, len = a.length; - if(len > 0){ - a.sort(sortWindows); - var seed = a[0].manager.zseed; - for(var i = 0; i < len; i++){ - var win = a[i]; - if(win && !win.hidden){ - win.setZIndex(seed + (i*10)); - } - } - } - activateLast(); - }; - - // private - var setActiveWin = function(win){ - if(win != front){ - if(front){ - front.setActive(false); - } - front = win; - if(win){ - win.setActive(true); - } - } - }; - - // private - var activateLast = function(){ - for(var i = accessList.length-1; i >=0; --i) { - if(!accessList[i].hidden){ - setActiveWin(accessList[i]); - return; - } - } - // none to activate - setActiveWin(null); - }; - - return { - /** - * The starting z-index for windows in this WindowGroup (defaults to 9000) - * @type Number The z-index value - */ - zseed : 9000, - - /** - * Registers a {@link Ext.Window Window} with this WindowManager. This should not - * need to be called under normal circumstances. Windows are automatically registered - * with a {@link Ext.Window#manager manager} at construction time.
- *Where this may be useful is moving Windows between two WindowManagers. For example, - * to bring the Ext.MessageBox dialog under the same manager as the Desktop's - * WindowManager in the desktop sample app:
- * @param {Window} win The Window to register. - */ - register : function(win){ - if(win.manager){ - win.manager.unregister(win); - } - win.manager = this; - - list[win.id] = win; - accessList.push(win); - win.on('hide', activateLast); - }, - - /** - *
-var msgWin = Ext.MessageBox.getDialog(); -MyDesktop.getDesktop().getManager().register(msgWin); -Unregisters a {@link Ext.Window Window} from this WindowManager. This should not - * need to be called. Windows are automatically unregistered upon destruction. - * See {@link #register}.
- * @param {Window} win The Window to unregister. - */ - unregister : function(win){ - delete win.manager; - delete list[win.id]; - win.un('hide', activateLast); - accessList.remove(win); - }, - - /** - * Gets a registered window by id. - * @param {String/Object} id The id of the window or a {@link Ext.Window} instance - * @return {Ext.Window} - */ - get : function(id){ - return typeof id == "object" ? id : list[id]; - }, - - /** - * Brings the specified window to the front of any other active windows in this WindowGroup. - * @param {String/Object} win The id of the window or a {@link Ext.Window} instance - * @return {Boolean} True if the dialog was brought to the front, else false - * if it was already in front - */ - bringToFront : function(win){ - win = this.get(win); - if(win != front){ - win._lastAccess = new Date().getTime(); - orderWindows(); - return true; - } - return false; - }, +Ext.define('Ext.form.Basic', { + extend: 'Ext.util.Observable', + alternateClassName: 'Ext.form.BasicForm', + requires: ['Ext.util.MixedCollection', 'Ext.form.action.Load', 'Ext.form.action.Submit', + 'Ext.window.MessageBox', 'Ext.data.Errors', 'Ext.util.DelayedTask'], - /** - * Sends the specified window to the back of other active windows in this WindowGroup. - * @param {String/Object} win The id of the window or a {@link Ext.Window} instance - * @return {Ext.Window} The window - */ - sendToBack : function(win){ - win = this.get(win); - win._lastAccess = -(new Date().getTime()); - orderWindows(); - return win; - }, + /** + * Creates new form. + * @param {Ext.container.Container} owner The component that is the container for the form, usually a {@link Ext.form.Panel} + * @param {Object} config Configuration options. These are normally specified in the config to the + * {@link Ext.form.Panel} constructor, which passes them along to the BasicForm automatically. + */ + constructor: function(owner, config) { + var me = this, + onItemAddOrRemove = me.onItemAddOrRemove; /** - * Hides all windows in this WindowGroup. + * @property owner + * @type Ext.container.Container + * The container component to which this BasicForm is attached. */ - hideAll : function(){ - for(var id in list){ - if(list[id] && typeof list[id] != "function" && list[id].isVisible()){ - list[id].hide(); - } - } - }, + me.owner = owner; - /** - * Gets the currently-active window in this WindowGroup. - * @return {Ext.Window} The active window - */ - getActive : function(){ - return front; - }, + // Listen for addition/removal of fields in the owner container + me.mon(owner, { + add: onItemAddOrRemove, + remove: onItemAddOrRemove, + scope: me + }); - /** - * Returns zero or more windows in this WindowGroup using the custom search function passed to this method. - * The function should accept a single {@link Ext.Window} reference as its only argument and should - * return true if the window matches the search criteria, otherwise it should return false. - * @param {Function} fn The search function - * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the Window being tested. - * that gets passed to the function if not specified) - * @return {Array} An array of zero or more matching windows - */ - getBy : function(fn, scope){ - var r = []; - for(var i = accessList.length-1; i >=0; --i) { - var win = accessList[i]; - if(fn.call(scope||win, win) !== false){ - r.push(win); - } - } - return r; - }, + Ext.apply(me, config); - /** - * Executes the specified function once for every window in this WindowGroup, passing each - * window as the only parameter. Returning false from the function will stop the iteration. - * @param {Function} fn The function to execute for each item - * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the current Window in the iteration. - */ - each : function(fn, scope){ - for(var id in list){ - if(list[id] && typeof list[id] != "function"){ - if(fn.call(scope || list[id], list[id]) === false){ - return; - } - } - } + // Normalize the paramOrder to an Array + if (Ext.isString(me.paramOrder)) { + me.paramOrder = me.paramOrder.split(/[\s,|]/); } - }; -}; + me.checkValidityTask = Ext.create('Ext.util.DelayedTask', me.checkValidity, me); -/** - * @class Ext.WindowMgr - * @extends Ext.WindowGroup - * The default global window group that is available automatically. To have more than one group of windows - * with separate z-order stacks, create additional instances of {@link Ext.WindowGroup} as needed. - * @singleton - */ -Ext.WindowMgr = new Ext.WindowGroup();/** - * @class Ext.MessageBox - *Utility class for generating different styles of message boxes. The alias Ext.Msg can also be used.
- *Note that the MessageBox is asynchronous. Unlike a regular JavaScript
- *alert
(which will halt - * browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code - * that should only run after some user feedback from the MessageBox, you must use a callback function - * (see thefunction
parameter for {@link #show} for more details).Example usage:
- *-// Basic alert: -Ext.Msg.alert('Status', 'Changes saved successfully.'); + me.addEvents( + /** + * @event beforeaction + * Fires before any action is performed. Return false to cancel the action. + * @param {Ext.form.Basic} this + * @param {Ext.form.action.Action} action The {@link Ext.form.action.Action} to be performed + */ + 'beforeaction', + /** + * @event actionfailed + * Fires when an action fails. + * @param {Ext.form.Basic} this + * @param {Ext.form.action.Action} action The {@link Ext.form.action.Action} that failed + */ + 'actionfailed', + /** + * @event actioncomplete + * Fires when an action is completed. + * @param {Ext.form.Basic} this + * @param {Ext.form.action.Action} action The {@link Ext.form.action.Action} that completed + */ + 'actioncomplete', + /** + * @event validitychange + * Fires when the validity of the entire form changes. + * @param {Ext.form.Basic} this + * @param {Boolean} valid true if the form is now valid, false if it is now invalid. + */ + 'validitychange', + /** + * @event dirtychange + * Fires when the dirty state of the entire form changes. + * @param {Ext.form.Basic} this + * @param {Boolean} dirty true if the form is now dirty, false if it is no longer dirty. + */ + 'dirtychange' + ); + me.callParent(); + }, -// Prompt for user data and process the result using a callback: -Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){ - if (btn == 'ok'){ - // process text value and close... - } -}); + /** + * Do any post constructor initialization + * @private + */ + initialize: function(){ + this.initialized = true; + this.onValidityChange(!this.hasInvalidField()); + }, -// Show a dialog using config options: -Ext.Msg.show({ - title:'Save Changes?', - msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?', - buttons: Ext.Msg.YESNOCANCEL, - fn: processResult, - animEl: 'elId', - icon: Ext.MessageBox.QUESTION -}); + /** + * @cfg {String} method + * The request method to use (GET or POST) for form actions if one isn't supplied in the action options. + */ + /** + * @cfg {Ext.data.reader.Reader} reader + * An Ext.data.DataReader (e.g. {@link Ext.data.reader.Xml}) to be used to read + * data when executing 'load' actions. This is optional as there is built-in + * support for processing JSON responses. + */ + /** + * @cfg {Ext.data.reader.Reader} errorReader + *
An Ext.data.DataReader (e.g. {@link Ext.data.reader.Xml}) to be used to + * read field error messages returned from 'submit' actions. This is optional + * as there is built-in support for processing JSON responses.
+ *The Records which provide messages for the invalid Fields must use the + * Field name (or id) as the Record ID, and must contain a field called 'msg' + * which contains the error message.
+ *The errorReader does not have to be a full-blown implementation of a + * Reader. It simply needs to implement a read(xhr) function + * which returns an Array of Records in an object with the following + * structure:
- * @singleton - */ -Ext.MessageBox = function(){ - var dlg, opt, mask, waitTimer, - bodyEl, msgEl, textboxEl, textareaEl, progressBar, pp, iconEl, spacerEl, - buttons, activeTextEl, bwidth, bufferIcon = '', iconCls = '', - buttonNames = ['ok', 'yes', 'no', 'cancel']; - - // private - var handleButton = function(button){ - buttons[button].blur(); - if(dlg.isVisible()){ - dlg.hide(); - handleHide(); - Ext.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value, opt], 1); - } - }; - - // private - var handleHide = function(){ - if(opt && opt.cls){ - dlg.el.removeClass(opt.cls); - } - progressBar.reset(); - }; - - // private - var handleEsc = function(d, k, e){ - if(opt && opt.closable !== false){ - dlg.hide(); - handleHide(); - } - if(e){ - e.stopEvent(); - } - }; - - // private - var updateButtons = function(b){ - var width = 0, - cfg; - if(!b){ - Ext.each(buttonNames, function(name){ - buttons[name].hide(); - }); - return width; - } - dlg.footer.dom.style.display = ''; - Ext.iterate(buttons, function(name, btn){ - cfg = b[name]; - if(cfg){ - btn.show(); - btn.setText(Ext.isString(cfg) ? cfg : Ext.MessageBox.buttonText[name]); - width += btn.getEl().getWidth() + 15; - }else{ - btn.hide(); - } - }); - return width; - }; - - return { - /** - * Returns a reference to the underlying {@link Ext.Window} element - * @return {Ext.Window} The window - */ - getDialog : function(titleText){ - if(!dlg){ - var btns = []; - - buttons = {}; - Ext.each(buttonNames, function(name){ - btns.push(buttons[name] = new Ext.Button({ - text: this.buttonText[name], - handler: handleButton.createCallback(name), - hideMode: 'offsets' - })); - }, this); - dlg = new Ext.Window({ - autoCreate : true, - title:titleText, - resizable:false, - constrain:true, - constrainHeader:true, - minimizable : false, - maximizable : false, - stateful: false, - modal: true, - shim:true, - buttonAlign:"center", - width:400, - height:100, - minHeight: 80, - plain:true, - footer:true, - closable:true, - close : function(){ - if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){ - handleButton("no"); - }else{ - handleButton("cancel"); - } - }, - fbar: new Ext.Toolbar({ - items: btns, - enableOverflow: false - }) - }); - dlg.render(document.body); - dlg.getEl().addClass('x-window-dlg'); - mask = dlg.mask; - bodyEl = dlg.body.createChild({ - html:'+{ + records: recordArray +}
' - }); - iconEl = Ext.get(bodyEl.dom.firstChild); - var contentEl = bodyEl.dom.childNodes[1]; - msgEl = Ext.get(contentEl.firstChild); - textboxEl = Ext.get(contentEl.childNodes[2].firstChild); - textboxEl.enableDisplayMode(); - textboxEl.addKeyListener([10,13], function(){ - if(dlg.isVisible() && opt && opt.buttons){ - if(opt.buttons.ok){ - handleButton("ok"); - }else if(opt.buttons.yes){ - handleButton("yes"); - } - } - }); - textareaEl = Ext.get(contentEl.childNodes[2].childNodes[1]); - textareaEl.enableDisplayMode(); - progressBar = new Ext.ProgressBar({ - renderTo:bodyEl - }); - bodyEl.createChild({cls:'x-clear'}); - } - return dlg; - }, - - /** - * Updates the message box body text - * @param {String} text (optional) Replaces the message box element's innerHTML with the specified string (defaults to - * the XHTML-compliant non-breaking space character ' ') - * @return {Ext.MessageBox} this - */ - updateText : function(text){ - if(!dlg.isVisible() && !opt.width){ - dlg.setSize(this.maxWidth, 100); // resize first so content is never clipped from previous shows - } - msgEl.update(text || ' '); - - var iw = iconCls != '' ? (iconEl.getWidth() + iconEl.getMargins('lr')) : 0, - mw = msgEl.getWidth() + msgEl.getMargins('lr'), - fw = dlg.getFrameWidth('lr'), - bw = dlg.body.getFrameWidth('lr'), - w; - - if (Ext.isIE && iw > 0){ - //3 pixels get subtracted in the icon CSS for an IE margin issue, - //so we have to add it back here for the overall width to be consistent - iw += 3; - } - w = Math.max(Math.min(opt.width || iw+mw+fw+bw, opt.maxWidth || this.maxWidth), - Math.max(opt.minWidth || this.minWidth, bwidth || 0)); - - if(opt.prompt === true){ - activeTextEl.setWidth(w-iw-fw-bw); - } - if(opt.progress === true || opt.wait === true){ - progressBar.setSize(w-iw-fw-bw); - } - if(Ext.isIE && w == bwidth){ - w += 4; //Add offset when the content width is smaller than the buttons. - } - dlg.setSize(w, 'auto').center(); - return this; - }, + */ - /** - * Updates a progress-style message box's text and progress bar. Only relevant on message boxes - * initiated via {@link Ext.MessageBox#progress} or {@link Ext.MessageBox#wait}, - * or by calling {@link Ext.MessageBox#show} with progress: true. - * @param {Number} value Any number between 0 and 1 (e.g., .5, defaults to 0) - * @param {String} progressText The progress text to display inside the progress bar (defaults to '') - * @param {String} msg The message box's body text is replaced with the specified string (defaults to undefined - * so that any existing body text will not get overwritten by default unless a new value is passed in) - * @return {Ext.MessageBox} this - */ - updateProgress : function(value, progressText, msg){ - progressBar.updateProgress(value, progressText); - if(msg){ - this.updateText(msg); - } - return this; - }, + /** + * @cfg {String} url + * The URL to use for form actions if one isn't supplied in the + * {@link #doAction doAction} options. + */ - /** - * Returns true if the message box is currently displayed - * @return {Boolean} True if the message box is visible, else false - */ - isVisible : function(){ - return dlg && dlg.isVisible(); - }, + /** + * @cfg {Object} baseParams + *Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
+ *Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode Ext.Object.toQueryString}.
+ */ - /** - * Hides the message box if it is displayed - * @return {Ext.MessageBox} this - */ - hide : function(){ - var proxy = dlg ? dlg.activeGhost : null; - if(this.isVisible() || proxy){ - dlg.hide(); - handleHide(); - if (proxy){ - // unghost is a private function, but i saw no better solution - // to fix the locking problem when dragging while it closes - dlg.unghost(false, false); - } - } - return this; - }, + /** + * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds). + */ + timeout: 30, - /** - * Displays a new message box, or reinitializes an existing message box, based on the config options - * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally, - * although those calls are basic shortcuts and do not support all of the config options allowed here. - * @param {Object} config The following config options are supported:- *
- * Example usage: - *- animEl : String/Element
- *An id or Element from which the message box should animate as it - * opens and closes (defaults to undefined)- buttons : Object/Boolean
- *A button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo', - * cancel:'Bar'}), or false to not show any buttons (defaults to false)- closable : Boolean
- *False to hide the top-right close button (defaults to true). Note that - * progress and wait dialogs will ignore this property and always hide the close button as they can only - * be closed programmatically.- cls : String
- *A custom CSS class to apply to the message box's container element- defaultTextHeight : Number
- *The default height in pixels of the message box's multiline textarea - * if displayed (defaults to 75)- fn : Function
- *A callback function which is called when the dialog is dismissed either - * by clicking on the configured buttons, or on the dialog close button, or by pressing - * the return button to enter input. - *Progress and wait dialogs will ignore this option since they do not respond to user - * actions and can only be closed programmatically, so any required function should be called - * by the same code after it closes the dialog. Parameters passed:
- *
- buttonId : String
- *The ID of the button pressed, one of:- *
- ok
- *- yes
- *- no
- *- cancel
- *- text : String
- *- opt : Object
- *The config object passed to show.- scope : Object
- *The scope of the callback function- icon : String
- *A CSS class that provides a background image to be used as the body icon for the - * dialog (e.g. Ext.MessageBox.WARNING or 'custom-class') (defaults to '')- iconCls : String
- *The standard {@link Ext.Window#iconCls} to - * add an optional header icon (defaults to '')- maxWidth : Number
- *The maximum width in pixels of the message box (defaults to 600)- minWidth : Number
- *The minimum width in pixels of the message box (defaults to 100)- modal : Boolean
- *False to allow user interaction with the page while the message box is - * displayed (defaults to true)- msg : String
- *A string that will replace the existing message box body text (defaults to the - * XHTML-compliant non-breaking space character ' ')- multiline : Boolean
- *- * True to prompt the user to enter multi-line text (defaults to false)- progress : Boolean
- *True to display a progress bar (defaults to false)- progressText : String
- *The text to display inside the progress bar if progress = true (defaults to '')- prompt : Boolean
- *True to prompt the user to enter single-line text (defaults to false)- proxyDrag : Boolean
- *True to display a lightweight proxy while dragging (defaults to false)- title : String
- *The title text- value : String
- *The string value to set into the active textbox element if displayed- wait : Boolean
- *True to display a progress bar (defaults to false)- waitConfig : Object
- *A {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)- width : Number
- *The width of the dialog in pixels-Ext.Msg.show({ - title: 'Address', - msg: 'Please enter your address:', - width: 300, - buttons: Ext.MessageBox.OKCANCEL, - multiline: true, - fn: saveAddress, - animEl: 'addAddressBtn', - icon: Ext.MessageBox.INFO -}); + /** + * @cfg {Object} api (Optional) If specified, load and submit actions will be handled + * with {@link Ext.form.action.DirectLoad} and {@link Ext.form.action.DirectLoad}. + * Methods which have been imported by {@link Ext.direct.Manager} can be specified here to load and submit + * forms. + * Such as the following:
- * @return {Ext.MessageBox} this - */ - show : function(options){ - if(this.isVisible()){ - this.hide(); - } - opt = options; - var d = this.getDialog(opt.title || " "); - - d.setTitle(opt.title || " "); - var allowClose = (opt.closable !== false && opt.progress !== true && opt.wait !== true); - d.tools.close.setDisplayed(allowClose); - activeTextEl = textboxEl; - opt.prompt = opt.prompt || (opt.multiline ? true : false); - if(opt.prompt){ - if(opt.multiline){ - textboxEl.hide(); - textareaEl.show(); - textareaEl.setHeight(Ext.isNumber(opt.multiline) ? opt.multiline : this.defaultTextHeight); - activeTextEl = textareaEl; - }else{ - textboxEl.show(); - textareaEl.hide(); - } - }else{ - textboxEl.hide(); - textareaEl.hide(); - } - activeTextEl.dom.value = opt.value || ""; - if(opt.prompt){ - d.focusEl = activeTextEl; - }else{ - var bs = opt.buttons; - var db = null; - if(bs && bs.ok){ - db = buttons["ok"]; - }else if(bs && bs.yes){ - db = buttons["yes"]; - } - if (db){ - d.focusEl = db; - } - } - if(opt.iconCls){ - d.setIconClass(opt.iconCls); - } - this.setIcon(Ext.isDefined(opt.icon) ? opt.icon : bufferIcon); - bwidth = updateButtons(opt.buttons); - progressBar.setVisible(opt.progress === true || opt.wait === true); - this.updateProgress(0, opt.progressText); - this.updateText(opt.msg); - if(opt.cls){ - d.el.addClass(opt.cls); - } - d.proxyDrag = opt.proxyDrag === true; - d.modal = opt.modal !== false; - d.mask = opt.modal !== false ? mask : false; - if(!d.isVisible()){ - // force it to the end of the z-index stack so it gets a cursor in FF - document.body.appendChild(dlg.el.dom); - d.setAnimateTarget(opt.animEl); - //workaround for window internally enabling keymap in afterShow - d.on('show', function(){ - if(allowClose === true){ - d.keyMap.enable(); - }else{ - d.keyMap.disable(); - } - }, this, {single:true}); - d.show(opt.animEl); - } - if(opt.wait === true){ - progressBar.wait(opt.waitConfig); - } - return this; - }, - - /** - * Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default - * styling, and the class passed in is expected to supply the background image url. Pass in empty string ('') - * to clear any existing icon. This method must be called before the MessageBox is shown. - * The following built-in icon classes are supported, but you can also pass in a custom class name: - *+api: { + load: App.ss.MyProfile.load, + submit: App.ss.MyProfile.submit +}
-Ext.MessageBox.INFO -Ext.MessageBox.WARNING -Ext.MessageBox.QUESTION -Ext.MessageBox.ERROR - *- * @param {String} icon A CSS classname specifying the icon's background image url, or empty string to clear the icon - * @return {Ext.MessageBox} this - */ - setIcon : function(icon){ - if(!dlg){ - bufferIcon = icon; - return; - } - bufferIcon = undefined; - if(icon && icon != ''){ - iconEl.removeClass('x-hidden'); - iconEl.replaceClass(iconCls, icon); - bodyEl.addClass('x-dlg-icon'); - iconCls = icon; - }else{ - iconEl.replaceClass(iconCls, 'x-hidden'); - bodyEl.removeClass('x-dlg-icon'); - iconCls = ''; - } - return this; - }, + *Load actions can use
+ */ - /** - * Displays a message box with a progress bar. This message box has no buttons and is not closeable by - * the user. You are responsible for updating the progress bar as needed via {@link Ext.MessageBox#updateProgress} - * and closing the message box when the process is complete. - * @param {String} title The title bar text - * @param {String} msg The message box body text - * @param {String} progressText (optional) The text to display inside the progress bar (defaults to '') - * @return {Ext.MessageBox} this - */ - progress : function(title, msg, progressText){ - this.show({ - title : title, - msg : msg, - buttons: false, - progress:true, - closable:false, - minWidth: this.minProgressWidth, - progressText: progressText - }); - return this; - }, + /** + * @cfg {Array/String} paramOrder{@link #paramOrder}
or{@link #paramsAsHash}
+ * to customize how the load method is invoked. + * Submit actions will always use a standard form submit. The formHandler configuration must + * be set on the associated server-side method which has been imported by {@link Ext.direct.Manager}.A list of params to be executed server side. + * Defaults to undefined. Only used for the
+ *{@link #api}
+ *load
configuration.Specify the params in the order in which they must be executed on the + * server-side as either (1) an Array of String values, or (2) a String of params + * delimited by either whitespace, comma, or pipe. For example, + * any of the following would be acceptable:
+ */ - /** - * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user - * interaction while waiting for a long-running process to complete that does not have defined intervals. - * You are responsible for closing the message box when the process is complete. - * @param {String} msg The message box body text - * @param {String} title (optional) The title bar text - * @param {Object} config (optional) A {@link Ext.ProgressBar#waitConfig} object - * @return {Ext.MessageBox} this - */ - wait : function(msg, title, config){ - this.show({ - title : title, - msg : msg, - buttons: false, - closable:false, - wait:true, - modal:true, - minWidth: this.minProgressWidth, - waitConfig: config - }); - return this; - }, + /** + * @cfg {Boolean} paramsAsHash Only used for the+paramOrder: ['param1','param2','param3'] +paramOrder: 'param1 param2 param3' +paramOrder: 'param1,param2,param3' +paramOrder: 'param1|param2|param' +
{@link #api}
+ *load
configuration. If true, parameters will be sent as a + * single hash collection of named arguments (defaults to false). Providing a + * {@link #paramOrder} nullifies this configuration. + */ + paramsAsHash: false, - /** - * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt). - * If a callback function is passed it will be called after the user clicks the button, and the - * id of the button that was clicked will be passed as the only parameter to the callback - * (could also be the top-right close button). - * @param {String} title The title bar text - * @param {String} msg The message box body text - * @param {Function} fn (optional) The callback function invoked after the message box is closed - * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to the browser wnidow. - * @return {Ext.MessageBox} this - */ - alert : function(title, msg, fn, scope){ - this.show({ - title : title, - msg : msg, - buttons: this.OK, - fn: fn, - scope : scope, - minWidth: this.minWidth - }); - return this; - }, + /** + * @cfg {String} waitTitle + * The default title to show for the waiting message box (defaults to 'Please Wait...') + */ + waitTitle: 'Please Wait...', - /** - * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm). - * If a callback function is passed it will be called after the user clicks either button, - * and the id of the button that was clicked will be passed as the only parameter to the callback - * (could also be the top-right close button). - * @param {String} title The title bar text - * @param {String} msg The message box body text - * @param {Function} fn (optional) The callback function invoked after the message box is closed - * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to the browser wnidow. - * @return {Ext.MessageBox} this - */ - confirm : function(title, msg, fn, scope){ - this.show({ - title : title, - msg : msg, - buttons: this.YESNO, - fn: fn, - scope : scope, - icon: this.QUESTION, - minWidth: this.minWidth - }); - return this; - }, + /** + * @cfg {Boolean} trackResetOnLoad If set to true, {@link #reset}() resets to the last loaded + * or {@link #setValues}() data instead of when the form was first created. Defaults to false. + */ + trackResetOnLoad: false, - /** - * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt). - * The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user - * clicks either button, and the id of the button that was clicked (could also be the top-right - * close button) and the text that was entered will be passed as the two parameters to the callback. - * @param {String} title The title bar text - * @param {String} msg The message box body text - * @param {Function} fn (optional) The callback function invoked after the message box is closed - * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to the browser wnidow. - * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight - * property, or the height in pixels to create the textbox (defaults to false / single-line) - * @param {String} value (optional) Default value of the text input element (defaults to '') - * @return {Ext.MessageBox} this - */ - prompt : function(title, msg, fn, scope, multiline, value){ - this.show({ - title : title, - msg : msg, - buttons: this.OKCANCEL, - fn: fn, - minWidth: this.minPromptWidth, - scope : scope, - prompt:true, - multiline: multiline, - value: value - }); - return this; - }, + /** + * @cfg {Boolean} standardSubmit + *If set to true, a standard HTML form submit is used instead + * of a XHR (Ajax) style form submission. Defaults to false. All of + * the field values, plus any additional params configured via {@link #baseParams} + * and/or the
+ */ - /** - * Button config that displays a single OK button - * @type Object - */ - OK : {ok:true}, - /** - * Button config that displays a single Cancel button - * @type Object - */ - CANCEL : {cancel:true}, - /** - * Button config that displays OK and Cancel buttons - * @type Object - */ - OKCANCEL : {ok:true, cancel:true}, - /** - * Button config that displays Yes and No buttons - * @type Object - */ - YESNO : {yes:true, no:true}, - /** - * Button config that displays Yes, No and Cancel buttons - * @type Object - */ - YESNOCANCEL : {yes:true, no:true, cancel:true}, - /** - * The CSS class that provides the INFO icon image - * @type String - */ - INFO : 'ext-mb-info', - /** - * The CSS class that provides the WARNING icon image - * @type String - */ - WARNING : 'ext-mb-warning', - /** - * The CSS class that provides the QUESTION icon image - * @type String - */ - QUESTION : 'ext-mb-question', - /** - * The CSS class that provides the ERROR icon image - * @type String - */ - ERROR : 'ext-mb-error', + /** + * @cfg {Mixed} waitMsgTarget + * By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific + * element by passing it or its id or mask the form itself by passing in true. Defaults to undefined. + */ - /** - * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) - * @type Number - */ - defaultTextHeight : 75, - /** - * The maximum width in pixels of the message box (defaults to 600) - * @type Number - */ - maxWidth : 600, - /** - * The minimum width in pixels of the message box (defaults to 100) - * @type Number - */ - minWidth : 100, - /** - * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful - * for setting a different minimum width than text-only dialogs may need (defaults to 250). - * @type Number - */ - minProgressWidth : 250, - /** - * The minimum width in pixels of the message box if it is a prompt dialog. This is useful - * for setting a different minimum width than text-only dialogs may need (defaults to 250). - * @type Number - */ - minPromptWidth: 250, - /** - * An object containing the default button text strings that can be overriden for localized language support. - * Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific - * resource file for handling language support across the framework. - * Customize the default text like so: Ext.MessageBox.buttonText.yes = "oui"; //french - * @type Object - */ - buttonText : { - ok : "OK", - cancel : "Cancel", - yes : "Yes", - no : "No" - } - }; -}(); -/** - * Shorthand for {@link Ext.MessageBox} - */ -Ext.Msg = Ext.MessageBox;/** - * @class Ext.dd.PanelProxy - * A custom drag proxy implementation specific to {@link Ext.Panel}s. This class is primarily used internally - * for the Panel's drag drop implementation, and should never need to be created directly. - * @constructor - * @param panel The {@link Ext.Panel} to proxy for - * @param config Configuration options - */ -Ext.dd.PanelProxy = function(panel, config){ - this.panel = panel; - this.id = this.panel.id +'-ddproxy'; - Ext.apply(this, config); -}; + // Private + wasDirty: false, + -Ext.dd.PanelProxy.prototype = { /** - * @cfg {Boolean} insertProxy True to insert a placeholder proxy element while dragging the panel, - * false to drag with no proxy (defaults to true). + * Destroys this object. */ - insertProxy : true, - - // private overrides - setStatus : Ext.emptyFn, - reset : Ext.emptyFn, - update : Ext.emptyFn, - stop : Ext.emptyFn, - sync: Ext.emptyFn, + destroy: function() { + this.clearListeners(); + this.checkValidityTask.cancel(); + }, /** - * Gets the proxy's element - * @return {Element} The proxy's element + * @private + * Handle addition or removal of descendant items. Invalidates the cached list of fields + * so that {@link #getFields} will do a fresh query next time it is called. Also adds listeners + * for state change events on added fields, and tracks components with formBind=true. */ - getEl : function(){ - return this.ghost; + onItemAddOrRemove: function(parent, child) { + var me = this, + isAdding = !!child.ownerCt, + isContainer = child.isContainer; + + function handleField(field) { + // Listen for state change events on fields + me[isAdding ? 'mon' : 'mun'](field, { + validitychange: me.checkValidity, + dirtychange: me.checkDirty, + scope: me, + buffer: 100 //batch up sequential calls to avoid excessive full-form validation + }); + // Flush the cached list of fields + delete me._fields; + } + + if (child.isFormField) { + handleField(child); + } + else if (isContainer) { + // Walk down + Ext.Array.forEach(child.query('[isFormField]'), handleField); + } + + // Flush the cached list of formBind components + delete this._boundItems; + + // Check form bind, but only after initial add. Batch it to prevent excessive validation + // calls when many fields are being added at once. + if (me.initialized) { + me.checkValidityTask.delay(10); + } }, /** - * Gets the proxy's ghost element - * @return {Element} The proxy's ghost element + * Return all the {@link Ext.form.field.Field} components in the owner container. + * @return {Ext.util.MixedCollection} Collection of the Field objects */ - getGhost : function(){ - return this.ghost; + getFields: function() { + var fields = this._fields; + if (!fields) { + fields = this._fields = Ext.create('Ext.util.MixedCollection'); + fields.addAll(this.owner.query('[isFormField]')); + } + return fields; + }, + + getBoundItems: function() { + var boundItems = this._boundItems; + if (!boundItems) { + boundItems = this._boundItems = Ext.create('Ext.util.MixedCollection'); + boundItems.addAll(this.owner.query('[formBind]')); + } + return boundItems; }, /** - * Gets the proxy's element - * @return {Element} The proxy's element + * Returns true if the form contains any invalid fields. No fields will be marked as invalid + * as a result of calling this; to trigger marking of fields use {@link #isValid} instead. */ - getProxy : function(){ - return this.proxy; + hasInvalidField: function() { + return !!this.getFields().findBy(function(field) { + var preventMark = field.preventMark, + isValid; + field.preventMark = true; + isValid = field.isValid(); + field.preventMark = preventMark; + return !isValid; + }); }, /** - * Hides the proxy + * Returns true if client-side validation on the form is successful. Any invalid fields will be + * marked as invalid. If you only want to determine overall form validity without marking anything, + * use {@link #hasInvalidField} instead. + * @return Boolean */ - hide : function(){ - if(this.ghost){ - if(this.proxy){ - this.proxy.remove(); - delete this.proxy; - } - this.panel.el.dom.style.display = ''; - this.ghost.remove(); - delete this.ghost; - } + isValid: function() { + var me = this, + invalid; + me.batchLayouts(function() { + invalid = me.getFields().filterBy(function(field) { + return !field.validate(); + }); + }); + return invalid.length < 1; }, /** - * Shows the proxy + * Check whether the validity of the entire form has changed since it was last checked, and + * if so fire the {@link #validitychange validitychange} event. This is automatically invoked + * when an individual field's validity changes. */ - show : function(){ - if(!this.ghost){ - this.ghost = this.panel.createGhost(undefined, undefined, Ext.getBody()); - this.ghost.setXY(this.panel.el.getXY()); - if(this.insertProxy){ - this.proxy = this.panel.el.insertSibling({cls:'x-panel-dd-spacer'}); - this.proxy.setSize(this.panel.getSize()); - } - this.panel.el.dom.style.display = 'none'; + checkValidity: function() { + var me = this, + valid = !me.hasInvalidField(); + if (valid !== me.wasValid) { + me.onValidityChange(valid); + me.fireEvent('validitychange', me, valid); + me.wasValid = valid; } }, - // private - repair : function(xy, callback, scope){ - this.hide(); - if(typeof callback == "function"){ - callback.call(scope || this); + /** + * @private + * Handle changes in the form's validity. If there are any sub components with + * formBind=true then they are enabled/disabled based on the new validity. + * @param {Boolean} valid + */ + onValidityChange: function(valid) { + var boundItems = this.getBoundItems(); + if (boundItems) { + boundItems.each(function(cmp) { + if (cmp.disabled === valid) { + cmp.setDisabled(!valid); + } + }); } }, /** - * Moves the proxy to a different position in the DOM. This is typically called while dragging the Panel - * to keep the proxy sync'd to the Panel's location. - * @param {HTMLElement} parentNode The proxy's parent DOM node - * @param {HTMLElement} before (optional) The sibling node before which the proxy should be inserted (defaults - * to the parent's last child if not specified) + *options
to {@link #submit}, will be included in the + * values submitted in the form.Returns true if any fields in this form have changed from their original values.
+ *Note that if this BasicForm was configured with {@link #trackResetOnLoad} then the + * Fields' original values are updated when the values are loaded by {@link #setValues} + * or {@link #loadRecord}.
+ * @return Boolean */ - moveProxy : function(parentNode, before){ - if(this.proxy){ - parentNode.insertBefore(this.proxy.dom, before); - } - } -}; + isDirty: function() { + return !!this.getFields().findBy(function(f) { + return f.isDirty(); + }); + }, -// private - DD implementation for Panels -Ext.Panel.DD = function(panel, cfg){ - this.panel = panel; - this.dragData = {panel: panel}; - this.proxy = new Ext.dd.PanelProxy(panel, cfg); - Ext.Panel.DD.superclass.constructor.call(this, panel.el, cfg); - var h = panel.header; - if(h){ - this.setHandleElId(h.id); - } - (h ? h : this.panel.body).setStyle('cursor', 'move'); - this.scroll = false; -}; + /** + * Check whether the dirty state of the entire form has changed since it was last checked, and + * if so fire the {@link #dirtychange dirtychange} event. This is automatically invoked + * when an individual field's dirty state changes. + */ + checkDirty: function() { + var dirty = this.isDirty(); + if (dirty !== this.wasDirty) { + this.fireEvent('dirtychange', this, dirty); + this.wasDirty = dirty; + } + }, -Ext.extend(Ext.Panel.DD, Ext.dd.DragSource, { - showFrame: Ext.emptyFn, - startDrag: Ext.emptyFn, - b4StartDrag: function(x, y) { - this.proxy.show(); + /** + *Returns true if the form contains a file upload field. This is used to determine the + * method for submitting the form: File uploads are not performed using normal 'Ajax' techniques, + * that is they are not performed using XMLHttpRequests. Instead a hidden <form> + * element containing all the fields is created temporarily and submitted with 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.
+ * @return Boolean + */ + hasUpload: function() { + return !!this.getFields().findBy(function(f) { + return f.isFileUpload(); + }); }, - b4MouseDown: function(e) { - var x = e.getPageX(); - var y = e.getPageY(); - this.autoOffset(x, y); + + /** + * Performs a predefined action (an implementation of {@link Ext.form.action.Action}) + * to perform application-specific processing. + * @param {String/Ext.form.action.Action} action The name of the predefined action type, + * or instance of {@link Ext.form.action.Action} to perform. + * @param {Object} options (optional) The options to pass to the {@link Ext.form.action.Action} + * that will get created, if the action argument is a String. + *All of the config options listed below are supported by both the + * {@link Ext.form.action.Submit submit} and {@link Ext.form.action.Load load} + * actions unless otherwise noted (custom actions could also accept + * other config options):
+ * + *
+ * + * @return {Ext.form.Basic} this + */ + doAction: function(action, options) { + if (Ext.isString(action)) { + action = Ext.ClassManager.instantiateByAlias('formaction.' + action, Ext.apply({}, options, {form: this})); + } + if (this.fireEvent('beforeaction', this, action) !== false) { + this.beforeAction(action); + Ext.defer(action.run, 100, action); + } + return this; }, - onInitDrag : function(x, y){ - this.onStartDrag(x, y); - return true; + + /** + * Shortcut to {@link #doAction do} a {@link Ext.form.action.Submit submit action}. This will use the + * {@link Ext.form.action.Submit AJAX submit action} by default. If the {@link #standardsubmit} config is + * enabled it will use a standard form element to submit, or if the {@link #api} config is present it will + * use the {@link Ext.form.action.DirectLoad Ext.direct.Direct submit action}. + * @param {Object} options The options to pass to the action (see {@link #doAction} for details).- url : String
+ * + *The url for the action (defaults + * to the form's {@link #url}.)- method : String
+ * + *The form method to use (defaults + * to the form's method, or POST if not defined)- params : String/Object
+ * + *The params to pass + * (defaults to the form's baseParams, or none if not defined)
+ *Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode Ext.Object.toQueryString}.
- headers : Object
+ * + *Request headers to set for the action.- success : Function
+ * + *The callback that will + * be invoked after a successful response (see top of + * {@link Ext.form.action.Submit submit} and {@link Ext.form.action.Load load} + * for a description of what constitutes a successful response). + * The function is passed the following parameters:+ *
- form : The {@link Ext.form.Basic} that requested the action.
+ *- action : The {@link Ext.form.action.Action Action} object which performed the operation. + *
The action object contains these properties of interest:+ *
- {@link Ext.form.action.Action#response response}
+ *- {@link Ext.form.action.Action#result result} : interrogate for custom postprocessing
+ *- {@link Ext.form.action.Action#type type}
+ *- failure : Function
+ * + *The callback that will be invoked after a + * failed transaction attempt. The function is passed the following parameters:+ *
- form : The {@link Ext.form.Basic} that requested the action.
+ *- action : The {@link Ext.form.action.Action Action} object which performed the operation. + *
The action object contains these properties of interest:+ *
- {@link Ext.form.action.Action#failureType failureType}
+ *- {@link Ext.form.action.Action#response response}
+ *- {@link Ext.form.action.Action#result result} : interrogate for custom postprocessing
+ *- {@link Ext.form.action.Action#type type}
+ *- scope : Object
+ * + *The scope in which to call the + * callback functions (The this reference for the callback functions).- clientValidation : Boolean
Submit Action only. + * Determines whether a Form's fields are validated in a final call to + * {@link Ext.form.Basic#isValid isValid} prior to submission. Set to false + * to prevent this. If undefined, pre-submission field validation is performed.
+ *The following code:
+ * would process the following server response for a successful submission:+myFormPanel.getForm().submit({ + clientValidation: true, + url: 'updateConsignment.php', + params: { + newStatus: 'delivered' }, - createFrame : Ext.emptyFn, - getDragEl : function(e){ - return this.proxy.ghost.dom; + success: function(form, action) { + Ext.Msg.alert('Success', action.result.msg); }, - endDrag : function(e){ - this.proxy.hide(); - this.panel.saveState(); + failure: function(form, action) { + switch (action.failureType) { + case Ext.form.action.Action.CLIENT_INVALID: + Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values'); + break; + case Ext.form.action.Action.CONNECT_FAILURE: + Ext.Msg.alert('Failure', 'Ajax communication failed'); + break; + case Ext.form.action.Action.SERVER_INVALID: + Ext.Msg.alert('Failure', action.result.msg); + } + } +}); +
+ * and the following server response for a failed submission:+{ + "success":true, // note this is Boolean, not string + "msg":"Consignment updated" +} +
+ * @return {Ext.form.Basic} this + */ + submit: function(options) { + return this.doAction(this.standardSubmit ? 'standardsubmit' : this.api ? 'directsubmit' : 'submit', options); }, - autoOffset : function(x, y) { - x -= this.startPageX; - y -= this.startPageY; - this.setDelta(x, y); - } -});/** - * @class Ext.state.Provider - * Abstract base class for state provider implementations. This class provides methods - * for encoding and decoding typed variables including dates and defines the - * Provider interface. - */ -Ext.state.Provider = function(){ /** - * @event statechange - * Fires when a state change occurs. - * @param {Provider} this This state provider - * @param {String} key The state key which was changed - * @param {String} value The encoded value for the state + * Shortcut to {@link #doAction do} a {@link Ext.form.action.Load load action}. + * @param {Object} options The options to pass to the action (see {@link #doAction} for details) + * @return {Ext.form.Basic} this */ - this.addEvents("statechange"); - this.state = {}; - Ext.state.Provider.superclass.constructor.call(this); -}; -Ext.extend(Ext.state.Provider, Ext.util.Observable, { + load: function(options) { + return this.doAction(this.api ? 'directload' : 'load', options); + }, + /** - * Returns the current value for a key - * @param {String} name The key name - * @param {Mixed} defaultValue A default value to return if the key's value is not found - * @return {Mixed} The state data + * Persists the values in this form into the passed {@link Ext.data.Model} object in a beginEdit/endEdit block. + * @param {Ext.data.Record} record The record to edit + * @return {Ext.form.Basic} this */ - get : function(name, defaultValue){ - return typeof this.state[name] == "undefined" ? - defaultValue : this.state[name]; + updateRecord: function(record) { + var fields = record.fields, + values = this.getFieldValues(), + name, + obj = {}; + + fields.each(function(f) { + name = f.name; + if (name in values) { + obj[name] = values[name]; + } + }); + + record.beginEdit(); + record.set(obj); + record.endEdit(); + + return this; }, /** - * Clears a value from the state - * @param {String} name The key name + * Loads an {@link Ext.data.Model} into this form by calling {@link #setValues} with the + * {@link Ext.data.Model#data record data}. + * See also {@link #trackResetOnLoad}. + * @param {Ext.data.Model} record The record to load + * @return {Ext.form.Basic} this */ - clear : function(name){ - delete this.state[name]; - this.fireEvent("statechange", this, name, null); + loadRecord: function(record) { + this._record = record; + return this.setValues(record.data); }, - + /** - * Sets the value for a key - * @param {String} name The key name - * @param {Mixed} value The value to set + * Returns the last Ext.data.Model instance that was loaded via {@link #loadRecord} + * @return {Ext.data.Model} The record */ - set : function(name, value){ - this.state[name] = value; - this.fireEvent("statechange", this, name, value); + getRecord: function() { + return this._record; }, /** - * Decodes a string previously encoded with {@link #encodeValue}. - * @param {String} value The value to decode - * @return {Mixed} The decoded value + * @private + * Called before an action is performed via {@link #doAction}. + * @param {Ext.form.action.Action} action The Action instance that was invoked */ - decodeValue : function(cookie){ - var re = /^(a|n|d|b|s|o)\:(.*)$/; - var matches = re.exec(unescape(cookie)); - if(!matches || !matches[1]) return; // non state cookie - var type = matches[1]; - var v = matches[2]; - switch(type){ - case "n": - return parseFloat(v); - case "d": - return new Date(Date.parse(v)); - case "b": - return (v == "1"); - case "a": - var all = []; - if(v != ''){ - Ext.each(v.split('^'), function(val){ - all.push(this.decodeValue(val)); - }, this); - } - return all; - case "o": - var all = {}; - if(v != ''){ - Ext.each(v.split('^'), function(val){ - var kv = val.split('='); - all[kv[0]] = this.decodeValue(kv[1]); - }, this); - } - return all; - default: - return v; + beforeAction: function(action) { + var waitMsg = action.waitMsg, + maskCls = Ext.baseCSSPrefix + 'mask-loading', + waitMsgTarget; + + // Call HtmlEditor's syncValue before actions + this.getFields().each(function(f) { + if (f.isFormField && f.syncValue) { + f.syncValue(); + } + }); + + if (waitMsg) { + waitMsgTarget = this.waitMsgTarget; + if (waitMsgTarget === true) { + this.owner.el.mask(waitMsg, maskCls); + } else if (waitMsgTarget) { + waitMsgTarget = this.waitMsgTarget = Ext.get(waitMsgTarget); + waitMsgTarget.mask(waitMsg, maskCls); + } else { + Ext.MessageBox.wait(waitMsg, action.waitTitle || this.waitTitle); + } } }, /** - * Encodes a value including type information. Decode with {@link #decodeValue}. - * @param {Mixed} value The value to encode - * @return {String} The encoded value - */ - encodeValue : function(v){ - var enc; - if(typeof v == "number"){ - enc = "n:" + v; - }else if(typeof v == "boolean"){ - enc = "b:" + (v ? "1" : "0"); - }else if(Ext.isDate(v)){ - enc = "d:" + v.toGMTString(); - }else if(Ext.isArray(v)){ - var flat = ""; - for(var i = 0, len = v.length; i < len; i++){ - flat += this.encodeValue(v[i]); - if(i != len-1) flat += "^"; - } - enc = "a:" + flat; - }else if(typeof v == "object"){ - var flat = ""; - for(var key in v){ - if(typeof v[key] != "function" && v[key] !== undefined){ - flat += key + "=" + this.encodeValue(v[key]) + "^"; - } - } - enc = "o:" + flat.substring(0, flat.length-1); - }else{ - enc = "s:" + v; + * @private + * Called after an action is performed via {@link #doAction}. + * @param {Ext.form.action.Action} action The Action instance that was invoked + * @param {Boolean} success True if the action completed successfully, false, otherwise. + */ + afterAction: function(action, success) { + if (action.waitMsg) { + var MessageBox = Ext.MessageBox, + waitMsgTarget = this.waitMsgTarget; + if (waitMsgTarget === true) { + this.owner.el.unmask(); + } else if (waitMsgTarget) { + waitMsgTarget.unmask(); + } else { + MessageBox.updateProgress(1); + MessageBox.hide(); + } } - 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: -+{ + "success":false, // note this is Boolean, not string + "msg":"You do not have permission to perform this operation" +} +
- * @singleton - */ -Ext.state.Manager = function(){ - var provider = new Ext.state.Provider(); + if (success) { + if (action.reset) { + this.reset(); + } + Ext.callback(action.success, action.scope || action, [this, action]); + this.fireEvent('actioncomplete', this, action); + } else { + Ext.callback(action.failure, action.scope || action, [this, action]); + this.fireEvent('actionfailed', this, action); + } + }, - return { - /** - * Configures the default state provider for your application - * @param {Provider} stateProvider The state provider to set - */ - setProvider : function(stateProvider){ - provider = stateProvider; - }, - /** - * Returns the current value for a key - * @param {String} name The key name - * @param {Mixed} defaultValue The default value to return if the key lookup does not match - * @return {Mixed} The state data - */ - get : function(key, defaultValue){ - return provider.get(key, defaultValue); - }, + /** + * Find a specific {@link Ext.form.field.Field} in this form by id or name. + * @param {String} id The value to search for (specify either a {@link Ext.Component#id id} or + * {@link Ext.form.field.Field#getName name or hiddenName}). + * @return Ext.form.field.Field The first matching field, or null if none was found. + */ + findField: function(id) { + return this.getFields().findBy(function(f) { + return f.id === id || f.getName() === id; + }); + }, - /** - * Sets the value for a key - * @param {String} name The key name - * @param {Mixed} value The state data - */ - set : function(key, value){ - provider.set(key, value); - }, - /** - * Clears a value from the state - * @param {String} name The key name - */ - clear : function(key){ - provider.clear(key); - }, + /** + * Mark fields in this form invalid in bulk. + * @param {Array/Object} errors Either an array in the form-// in your initialization function -init : function(){ - Ext.state.Manager.setProvider(new Ext.state.CookieProvider()); - var win = new Window(...); - win.restoreState(); -} -
[{id:'fieldId', msg:'The message'}, ...]
, + * an object hash of{id: msg, id2: msg2}
, or a {@link Ext.data.Errors} object. + * @return {Ext.form.Basic} this + */ + markInvalid: function(errors) { + var me = this; - /** - * Gets the currently configured state provider - * @return {Provider} The state provider - */ - getProvider : function(){ - return provider; + function mark(fieldId, msg) { + var field = me.findField(fieldId); + if (field) { + field.markInvalid(msg); + } } - }; -}(); -/** - * @class Ext.state.CookieProvider - * @extends Ext.state.Provider - * The default Provider implementation which saves state via cookies. - *
Usage: -- * @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 'extjs.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.extjs.com') - * @cfg {Boolean} secure True if the site is using SSL (defaults to false) - * @constructor - * Create a new CookieProvider - * @param {Object} config The configuration object - */ -Ext.state.CookieProvider = function(config){ - Ext.state.CookieProvider.superclass.constructor.call(this); - this.path = "/"; - this.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days - this.domain = null; - this.secure = false; - Ext.apply(this, config); - this.state = this.readCookies(); -}; -Ext.extend(Ext.state.CookieProvider, Ext.state.Provider, { - // private - set : function(name, value){ - if(typeof value == "undefined" || value === null){ - this.clear(name); - return; + if (Ext.isArray(errors)) { + Ext.each(errors, function(err) { + mark(err.id, err.msg); + }); + } + else if (errors instanceof Ext.data.Errors) { + errors.each(function(err) { + mark(err.field, err.message); + }); + } + else { + Ext.iterate(errors, mark); } - this.setCookie(name, value); - Ext.state.CookieProvider.superclass.set.call(this, name, value); + return this; }, - // private - clear : function(name){ - this.clearCookie(name); - Ext.state.CookieProvider.superclass.clear.call(this, name); - }, + /** + * Set values for fields in this form in bulk. + * @param {Array/Object} values Either an array in the form:- var cp = new Ext.state.CookieProvider({ - path: "/cgi-bin/", - expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days - domain: "extjs.com" - }); - Ext.state.Manager.setProvider(cp); -
+ * or an object hash of the form:+[{id:'clientName', value:'Fred. Olsen Lines'}, + {id:'portOfLoading', value:'FXT'}, + {id:'portOfDischarge', value:'OSL'} ]
+ * @return {Ext.form.Basic} this + */ + setValues: function(values) { + var me = this; - // private - readCookies : function(){ - var cookies = {}; - var c = document.cookie + ";"; - var re = /\s?(.*?)=(.*?);/g; - var matches; - while((matches = re.exec(c)) != null){ - var name = matches[1]; - var value = matches[2]; - if(name && name.substring(0,3) == "ys-"){ - cookies[name.substr(3)] = this.decodeValue(value); + function setVal(fieldId, val) { + var field = me.findField(fieldId); + if (field) { + field.setValue(val); + if (me.trackResetOnLoad) { + field.resetOriginalValue(); + } } } - return cookies; - }, - // private - setCookie : function(name, value){ - document.cookie = "ys-"+ name + "=" + this.encodeValue(value) + - ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) + - ((this.path == null) ? "" : ("; path=" + this.path)) + - ((this.domain == null) ? "" : ("; domain=" + this.domain)) + - ((this.secure == true) ? "; secure" : ""); + if (Ext.isArray(values)) { + // array of objects + Ext.each(values, function(val) { + setVal(val.id, val.value); + }); + } else { + // object hash + Ext.iterate(values, setVal); + } + return this; }, - // private - clearCookie : function(name){ - document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" + - ((this.path == null) ? "" : ("; path=" + this.path)) + - ((this.domain == null) ? "" : ("; domain=" + this.domain)) + - ((this.secure == true) ? "; secure" : ""); - } -});/** - * @class Ext.DataView - * @extends Ext.BoxComponent - * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate} - * as its internal templating mechanism, and is bound to an {@link Ext.data.Store} - * so that as the data in the store changes the view is automatically updated to reflect the changes. The view also - * provides built-in behavior for many common events that can occur for its contained items including click, doubleclick, - * mouseover, mouseout, etc. as well as a built-in selection model. In order to use these features, an {@link #itemSelector} - * config must be provided for the DataView to determine what nodes it will be working with. - * - *+{ + clientName: 'Fred. Olsen Lines', + portOfLoading: 'FXT', + portOfDischarge: 'OSL' +}
The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.Panel}.
- *- * @constructor - * Create a new DataView - * @param {Object} config The config object - * @xtype dataview - */ -Ext.DataView = Ext.extend(Ext.BoxComponent, { - /** - * @cfg {String/Array} tpl - * The HTML fragment or an array of fragments that will make up the template used by this DataView. This should - * be specified in the same format expected by the constructor of {@link Ext.XTemplate}. - */ - /** - * @cfg {Ext.data.Store} store - * The {@link Ext.data.Store} to bind this DataView to. - */ - /** - * @cfg {String} itemSelector - * This is a required setting. A simple CSS selector (e.g. div.some-class or - * span:first-child) that will be used to determine what nodes this DataView will be - * working with. - */ - /** - * @cfg {Boolean} multiSelect - * True to allow selection of more than one item at a time, false to allow selection of only a single item - * at a time or no selection at all, depending on the value of {@link #singleSelect} (defaults to false). - */ - /** - * @cfg {Boolean} singleSelect - * True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). - * Note that if {@link #multiSelect} = true, this value will be ignored. - */ /** - * @cfg {Boolean} simpleSelect - * True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, - * false to force the user to hold Ctrl or Shift to select more than on item (defaults to false). - */ - /** - * @cfg {String} overClass - * A CSS class to apply to each item in the view on mouseover (defaults to undefined). - */ - /** - * @cfg {String} loadingText - * A string to display during data load operations (defaults to undefined). If specified, this text will be - * displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's - * contents will continue to display normally until the new data is loaded and the contents are replaced. + * Retrieves the fields in the form as a set of key/value pairs, using their + * {@link Ext.form.field.Field#getModelData getModelData()} method to collect the values. + * If multiple fields return values under the same name those values will be combined into an Array. + * This is similar to {@link #getValues} except that this method collects type-specific data values + * (e.g. Date objects for date fields) while getValues returns only String values for submission. + * @param {Boolean} dirtyOnly (optional) If true, only fields that are dirty will be included in the result. + * Defaults to false. + * @return {Object} */ + getFieldValues: function(dirtyOnly) { + return this.getValues(false, dirtyOnly, false, true); + }, + /** - * @cfg {String} selectedClass - * A CSS class to apply to each selected item in the view (defaults to 'x-view-selected'). + * Clears all invalid field messages in this form. + * @return {Ext.form.Basic} this */ - selectedClass : "x-view-selected", + clearInvalid: function() { + var me = this; + me.batchLayouts(function() { + me.getFields().each(function(f) { + f.clearInvalid(); + }); + }); + return me; + }, + /** - * @cfg {String} emptyText - * The text to display in the view when there is no data to display (defaults to ''). + * Resets all fields in this form. + * @return {Ext.form.Basic} this */ - emptyText : "", + reset: function() { + var me = this; + me.batchLayouts(function() { + me.getFields().each(function(f) { + f.reset(); + }); + }); + return me; + }, /** - * @cfg {Boolean} deferEmptyText True to defer emptyText being applied until the store's first load + * Calls {@link Ext#apply Ext.apply} for all fields in this form with the passed object. + * @param {Object} obj The object to be applied + * @return {Ext.form.Basic} this */ - deferEmptyText: true, + applyToFields: function(obj) { + this.getFields().each(function(f) { + Ext.apply(f, obj); + }); + return this; + }, + /** - * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events + * Calls {@link Ext#applyIf Ext.applyIf} for all field in this form with the passed object. + * @param {Object} obj The object to be applied + * @return {Ext.form.Basic} this */ - trackOver: false, - + applyIfToFields: function(obj) { + this.getFields().each(function(f) { + Ext.applyIf(f, obj); + }); + return this; + }, + /** - * @cfg {Boolean} blockRefresh Set this to true to ignore datachanged events on the bound store. This is useful if - * you wish to provide custom transition animations via a plugin (defaults to false) + * @private + * Utility wrapper that suspends layouts of all field parent containers for the duration of a given + * function. Used during full-form validation and resets to prevent huge numbers of layouts. + * @param {Function} fn */ - blockRefresh: false, - - //private - last: false, + batchLayouts: function(fn) { + var me = this, + suspended = new Ext.util.HashMap(); - // private - initComponent : function(){ - Ext.DataView.superclass.initComponent.call(this); - if(Ext.isString(this.tpl) || Ext.isArray(this.tpl)){ - this.tpl = new Ext.XTemplate(this.tpl); - } + // Temporarily suspend layout on each field's immediate owner so we don't get a huge layout cascade + me.getFields().each(function(field) { + var ownerCt = field.ownerCt; + if (!suspended.contains(ownerCt)) { + suspended.add(ownerCt); + ownerCt.oldSuspendLayout = ownerCt.suspendLayout; + ownerCt.suspendLayout = true; + } + }); - this.addEvents( - /** - * @event beforeclick - * Fires before a click is processed. Returns false to cancel the default action. - * @param {Ext.DataView} this - * @param {Number} index The index of the target node - * @param {HTMLElement} node The target node - * @param {Ext.EventObject} e The raw event object - */ - "beforeclick", - /** - * @event click - * Fires when a template node is clicked. - * @param {Ext.DataView} this - * @param {Number} index The index of the target node - * @param {HTMLElement} node The target node - * @param {Ext.EventObject} e The raw event object - */ - "click", - /** - * @event mouseenter - * Fires when the mouse enters a template node. trackOver:true or an overClass must be set to enable this event. - * @param {Ext.DataView} this - * @param {Number} index The index of the target node - * @param {HTMLElement} node The target node - * @param {Ext.EventObject} e The raw event object - */ - "mouseenter", - /** - * @event mouseleave - * Fires when the mouse leaves a template node. trackOver:true or an overClass must be set to enable this event. - * @param {Ext.DataView} this - * @param {Number} index The index of the target node - * @param {HTMLElement} node The target node - * @param {Ext.EventObject} e The raw event object - */ - "mouseleave", - /** - * @event containerclick - * Fires when a click occurs and it is not on a template node. - * @param {Ext.DataView} this - * @param {Ext.EventObject} e The raw event object - */ - "containerclick", - /** - * @event dblclick - * Fires when a template node is double clicked. - * @param {Ext.DataView} this - * @param {Number} index The index of the target node - * @param {HTMLElement} node The target node - * @param {Ext.EventObject} e The raw event object - */ - "dblclick", - /** - * @event contextmenu - * Fires when a template node is right clicked. - * @param {Ext.DataView} this - * @param {Number} index The index of the target node - * @param {HTMLElement} node The target node - * @param {Ext.EventObject} e The raw event object - */ - "contextmenu", - /** - * @event containercontextmenu - * Fires when a right click occurs that is not on a template node. - * @param {Ext.DataView} this - * @param {Ext.EventObject} e The raw event object - */ - "containercontextmenu", - /** - * @event selectionchange - * Fires when the selected nodes change. - * @param {Ext.DataView} this - * @param {Array} selections Array of the selected nodes - */ - "selectionchange", + // Invoke the function + fn(); - /** - * @event beforeselect - * Fires before a selection is made. If any handlers return false, the selection is cancelled. - * @param {Ext.DataView} this - * @param {HTMLElement} node The node to be selected - * @param {Array} selections Array of currently selected nodes - */ - "beforeselect" - ); + // Un-suspend the container layouts + suspended.each(function(id, ct) { + ct.suspendLayout = ct.oldSuspendLayout; + delete ct.oldSuspendLayout; + }); - this.store = Ext.StoreMgr.lookup(this.store); - this.all = new Ext.CompositeElementLite(); - this.selected = new Ext.CompositeElementLite(); - }, + // Trigger a single layout + me.owner.doComponentLayout(); + } +}); - // private - afterRender : function(){ - Ext.DataView.superclass.afterRender.call(this); +/** + * @class Ext.form.FieldAncestor - this.mon(this.getTemplateTarget(), { - "click": this.onClick, - "dblclick": this.onDblClick, - "contextmenu": this.onContextMenu, - scope:this - }); +A mixin for {@link Ext.container.Container} components that are likely to have form fields in their +items subtree. Adds the following capabilities: - if(this.overClass || this.trackOver){ - this.mon(this.getTemplateTarget(), { - "mouseover": this.onMouseOver, - "mouseout": this.onMouseOut, - scope:this - }); - } +- Methods for handling the addition and removal of {@link Ext.form.Labelable} and {@link Ext.form.field.Field} + instances at any depth within the container. +- Events ({@link #fieldvaliditychange} and {@link #fielderrorchange}) for handling changes to the state + of individual fields at the container level. +- Automatic application of {@link #fieldDefaults} config properties to each field added within the + container, to facilitate uniform configuration of all fields. - if(this.store){ - this.bindStore(this.store, true); - } - }, +This mixin is primarily for internal use by {@link Ext.form.Panel} and {@link Ext.form.FieldContainer}, +and should not normally need to be used directly. - /** - * Refreshes the view by reloading the data from the store and re-rendering the template. - */ - refresh : function() { - this.clearSelections(false, true); - var el = this.getTemplateTarget(); - el.update(""); - var records = this.store.getRange(); - if(records.length < 1){ - if(!this.deferEmptyText || this.hasSkippedEmptyText){ - el.update(this.emptyText); - } - this.all.clear(); - }else{ - this.tpl.overwrite(el, this.collectData(records, 0)); - this.all.fill(Ext.query(this.itemSelector, el.dom)); - this.updateIndexes(0); - } - this.hasSkippedEmptyText = true; + * @markdown + * @docauthor Jason Johnston-var store = new Ext.data.JsonStore({ - url: 'get-images.php', - root: 'images', - fields: [ - 'name', 'url', - {name:'size', type: 'float'}, - {name:'lastmod', type:'date', dateFormat:'timestamp'} - ] -}); -store.load(); + /** + * Retrieves the fields in the form as a set of key/value pairs, using their + * {@link Ext.form.field.Field#getSubmitData getSubmitData()} method to collect the values. + * If multiple fields return values under the same name those values will be combined into an Array. + * This is similar to {@link #getFieldValues} except that this method collects only String values for + * submission, while getFieldValues collects type-specific data values (e.g. Date objects for date fields.) + * @param {Boolean} asString (optional) If true, will return the key/value collection as a single + * URL-encoded param string. Defaults to false. + * @param {Boolean} dirtyOnly (optional) If true, only fields that are dirty will be included in the result. + * Defaults to false. + * @param {Boolean} includeEmptyText (optional) If true, the configured emptyText of empty fields will be used. + * Defaults to false. + * @return {String/Object} + */ + getValues: function(asString, dirtyOnly, includeEmptyText, useDataValues) { + var values = {}; -var tpl = new Ext.XTemplate( - '<tpl for=".">', - '<div class="thumb-wrap" id="{name}">', - '<div class="thumb"><img src="{url}" title="{name}"></div>', - '<span class="x-editable">{shortName}</span></div>', - '</tpl>', - '<div class="x-clear"></div>' -); + this.getFields().each(function(field) { + if (!dirtyOnly || field.isDirty()) { + var data = field[useDataValues ? 'getModelData' : 'getSubmitData'](includeEmptyText); + if (Ext.isObject(data)) { + Ext.iterate(data, function(name, val) { + if (includeEmptyText && val === '') { + val = field.emptyText || ''; + } + if (name in values) { + var bucket = values[name], + isArray = Ext.isArray; + if (!isArray(bucket)) { + bucket = values[name] = [bucket]; + } + if (isArray(val)) { + values[name] = bucket.concat(val); + } else { + bucket.push(val); + } + } else { + values[name] = val; + } + }); + } + } + }); -var panel = new Ext.Panel({ - id:'images-view', - frame:true, - width:535, - autoHeight:true, - collapsible:true, - layout:'fit', - title:'Simple DataView', + if (asString) { + values = Ext.Object.toQueryString(values); + } + return values; + }, - items: new Ext.DataView({ - store: store, - tpl: tpl, - autoHeight:true, - multiSelect: true, - overClass:'x-view-over', - itemSelector:'div.thumb-wrap', - emptyText: 'No images to display' - }) -}); -panel.render(document.body); -
+ */ +Ext.define('Ext.form.FieldAncestor', { + + /** + * @cfg {Object} fieldDefaults + * If specified, the properties in this object are used as default config values for each + * {@link Ext.form.Labelable} instance (e.g. {@link Ext.form.field.Base} or {@link Ext.form.FieldContainer}) + * that is added as a descendant of this container. Corresponding values specified in an individual field's + * own configuration, or from the {@link Ext.container.Container#defaults defaults config} of its parent container, + * will take precedence. See the documentation for {@link Ext.form.Labelable} to see what config + * options may be specified in the fieldDefaults.
+ *Example:
+ *+ *new Ext.form.Panel({ + fieldDefaults: { + labelAlign: 'left', + labelWidth: 100 }, + items: [{ + xtype: 'fieldset', + defaults: { + labelAlign: 'top' + }, + items: [{ + name: 'field1' + }, { + name: 'field2' + }] + }, { + xtype: 'fieldset', + items: [{ + name: 'field3', + labelWidth: 150 + }, { + name: 'field4' + }] + }] +});
In this example, field1 and field2 will get labelAlign:'top' (from the fieldset's defaults) + * and labelWidth:100 (from fieldDefaults), field3 and field4 will both get labelAlign:'left' (from + * fieldDefaults and field3 will use the labelWidth:150 from its own config.
+ */ - getTemplateTarget: function(){ - return this.el; - }, /** - * Function which can be overridden to provide custom formatting for each Record that is used by this - * DataView's {@link #tpl template} to render each node. - * @param {Array/Object} data The raw data object that was used to create the Record. - * @param {Number} recordIndex the index number of the Record being prepared for rendering. - * @param {Record} record The Record being prepared for rendering. - * @return {Array/Object} The formatted data in a format expected by the internal {@link #tpl template}'s overwrite() method. - * (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})) + * @protected Initializes the FieldAncestor's state; this must be called from the initComponent method + * of any components importing this mixin. */ - prepareData : function(data){ - return data; + initFieldAncestor: function() { + var me = this, + onSubtreeChange = me.onFieldAncestorSubtreeChange; + + me.addEvents( + /** + * @event fielderrorchange + * Fires when the validity state of any one of the {@link Ext.form.field.Field} instances within this + * container changes. + * @param {Ext.form.FieldAncestor} this + * @param {Ext.form.Labelable} The Field instance whose validity changed + * @param {String} isValid The field's new validity state + */ + 'fieldvaliditychange', + + /** + * @event fielderrorchange + * Fires when the active error message is changed for any one of the {@link Ext.form.Labelable} + * instances within this container. + * @param {Ext.form.FieldAncestor} this + * @param {Ext.form.Labelable} The Labelable instance whose active error was changed + * @param {String} error The active error message + */ + 'fielderrorchange' + ); + + // Catch addition and removal of descendant fields + me.on('add', onSubtreeChange, me); + me.on('remove', onSubtreeChange, me); + + me.initFieldDefaults(); }, /** - *Function which can be overridden which returns the data object passed to this - * DataView's {@link #tpl template} to render the whole DataView.
- *This is usually an Array of data objects, each element of which is processed by an - * {@link Ext.XTemplate XTemplate} which uses '<tpl for=".">' to iterate over its supplied - * data object as an Array. However, named properties may be placed into the data object to - * provide non-repeating data such as headings, totals etc.
- * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView. - * @param {Number} startIndex the index number of the Record being prepared for rendering. - * @return {Array} An Array of data objects to be processed by a repeating XTemplate. May also - * contain named properties. + * @private Initialize the {@link #fieldDefaults} object */ - collectData : function(records, startIndex){ - var r = []; - for(var i = 0, len = records.length; i < len; i++){ - r[r.length] = this.prepareData(records[i].data, startIndex+i, records[i]); + initFieldDefaults: function() { + if (!this.fieldDefaults) { + this.fieldDefaults = {}; } - return r; - }, - - // private - bufferRender : function(records){ - var div = document.createElement('div'); - this.tpl.overwrite(div, this.collectData(records)); - return Ext.query(this.itemSelector, div); }, - // private - onUpdate : function(ds, record){ - var index = this.store.indexOf(record); - if(index > -1){ - var sel = this.isSelected(index); - var original = this.all.elements[index]; - var node = this.bufferRender([record], index)[0]; - - this.all.replaceElement(index, node, true); - if(sel){ - this.selected.replaceElement(original, node); - this.all.item(index).addClass(this.selectedClass); + /** + * @private + * Handle the addition and removal of components in the FieldAncestor component's child tree. + */ + onFieldAncestorSubtreeChange: function(parent, child) { + var me = this, + isAdding = !!child.ownerCt; + + function handleCmp(cmp) { + var isLabelable = cmp.isFieldLabelable, + isField = cmp.isFormField; + if (isLabelable || isField) { + if (isLabelable) { + me['onLabelable' + (isAdding ? 'Added' : 'Removed')](cmp); + } + if (isField) { + me['onField' + (isAdding ? 'Added' : 'Removed')](cmp); + } + } + else if (cmp.isContainer) { + Ext.Array.forEach(cmp.getRefItems(), handleCmp); } - this.updateIndexes(index, index); } + handleCmp(child); }, - // private - onAdd : function(ds, records, index){ - if(this.all.getCount() === 0){ - this.refresh(); - return; - } - var nodes = this.bufferRender(records, index), n, a = this.all.elements; - if(index < this.all.getCount()){ - n = this.all.item(index).insertSibling(nodes, 'before', true); - a.splice.apply(a, [index, 0].concat(nodes)); - }else{ - n = this.all.last().insertSibling(nodes, 'after', true); - a.push.apply(a, nodes); - } - this.updateIndexes(index); - }, + /** + * @protected Called when a {@link Ext.form.Labelable} instance is added to the container's subtree. + * @param {Ext.form.Labelable} labelable The instance that was added + */ + onLabelableAdded: function(labelable) { + var me = this; - // private - onRemove : function(ds, record, index){ - this.deselect(index); - this.all.removeElement(index, true); - this.updateIndexes(index); - if (this.store.getCount() === 0){ - this.refresh(); - } + // buffer slightly to avoid excessive firing while sub-fields are changing en masse + me.mon(labelable, 'errorchange', me.handleFieldErrorChange, me, {buffer: 10}); + + labelable.setFieldDefaults(me.fieldDefaults); }, /** - * Refreshes an individual node's data from the store. - * @param {Number} index The item's data index in the store + * @protected Called when a {@link Ext.form.field.Field} instance is added to the container's subtree. + * @param {Ext.form.field.Field} field The field which was added */ - refreshNode : function(index){ - this.onUpdate(this.store, this.store.getAt(index)); + onFieldAdded: function(field) { + var me = this; + me.mon(field, 'validitychange', me.handleFieldValidityChange, me); }, - // private - updateIndexes : function(startIndex, endIndex){ - var ns = this.all.elements; - startIndex = startIndex || 0; - endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1)); - for(var i = startIndex; i <= endIndex; i++){ - ns[i].viewIndex = i; - } - }, - /** - * Returns the store associated with this DataView. - * @return {Ext.data.Store} The store + * @protected Called when a {@link Ext.form.Labelable} instance is removed from the container's subtree. + * @param {Ext.form.Labelable} labelable The instance that was removed */ - getStore : function(){ - return this.store; + onLabelableRemoved: function(labelable) { + var me = this; + me.mun(labelable, 'errorchange', me.handleFieldErrorChange, me); }, /** - * Changes the data store bound to this view and refreshes it. - * @param {Store} store The store to bind to this view + * @protected Called when a {@link Ext.form.field.Field} instance is removed from the container's subtree. + * @param {Ext.form.field.Field} field The field which was removed */ - bindStore : function(store, initial){ - if(!initial && this.store){ - if(store !== this.store && this.store.autoDestroy){ - this.store.destroy(); - }else{ - this.store.un("beforeload", this.onBeforeLoad, this); - this.store.un("datachanged", this.onDataChanged, this); - this.store.un("add", this.onAdd, this); - this.store.un("remove", this.onRemove, this); - this.store.un("update", this.onUpdate, this); - this.store.un("clear", this.refresh, this); - } - if(!store){ - this.store = null; - } - } - if(store){ - store = Ext.StoreMgr.lookup(store); - store.on({ - scope: this, - beforeload: this.onBeforeLoad, - datachanged: this.onDataChanged, - add: this.onAdd, - remove: this.onRemove, - update: this.onUpdate, - clear: this.refresh - }); - } - this.store = store; - if(store){ - this.refresh(); - } + onFieldRemoved: function(field) { + var me = this; + me.mun(field, 'validitychange', me.handleFieldValidityChange, me); }, - + /** - * @private - * Calls this.refresh if this.blockRefresh is not true + * @private Handle validitychange events on sub-fields; invoke the aggregated event and method */ - onDataChanged: function() { - if (this.blockRefresh !== true) { - this.refresh.apply(this, arguments); - } + handleFieldValidityChange: function(field, isValid) { + var me = this; + me.fireEvent('fieldvaliditychange', me, field, isValid); + me.onFieldValidityChange(); }, /** - * Returns the template node the passed child belongs to, or null if it doesn't belong to one. - * @param {HTMLElement} node - * @return {HTMLElement} The template node + * @private Handle errorchange events on sub-fields; invoke the aggregated event and method */ - findItemFromChild : function(node){ - return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget()); + handleFieldErrorChange: function(labelable, activeError) { + var me = this; + me.fireEvent('fielderrorchange', me, labelable, activeError); + me.onFieldErrorChange(); }, - // private - onClick : function(e){ - var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); - if(item){ - var index = this.indexOf(item); - if(this.onItemClick(item, index, e) !== false){ - this.fireEvent("click", this, index, item, e); - } - }else{ - if(this.fireEvent("containerclick", this, e) !== false){ - this.onContainerClick(e); - } - } - }, + /** + * @protected Fired when the validity of any field within the container changes. + * @param {Ext.form.field.Field} The sub-field whose validity changed + * @param {String} The new validity state + */ + onFieldValidityChange: Ext.emptyFn, - onContainerClick : function(e){ - this.clearSelections(); - }, + /** + * @protected Fired when the error message of any field within the container changes. + * @param {Ext.form.Labelable} The sub-field whose active error changed + * @param {String} The new active error message + */ + onFieldErrorChange: Ext.emptyFn - // private - onContextMenu : function(e){ - var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); - if(item){ - this.fireEvent("contextmenu", this, this.indexOf(item), item, e); - }else{ - this.fireEvent("containercontextmenu", this, e); - } - }, +}); +/** + * @class Ext.layout.container.CheckboxGroup + * @extends Ext.layout.container.Container + *This layout implements the column arrangement for {@link Ext.form.CheckboxGroup} and {@link Ext.form.RadioGroup}. + * It groups the component's sub-items into columns based on the component's + * {@link Ext.form.CheckboxGroup#columns columns} and {@link Ext.form.CheckboxGroup#vertical} config properties.
+ * + */ +Ext.define('Ext.layout.container.CheckboxGroup', { + extend: 'Ext.layout.container.Container', + alias: ['layout.checkboxgroup'], + + + onLayout: function() { + var numCols = this.getColCount(), + shadowCt = this.getShadowCt(), + owner = this.owner, + items = owner.items, + shadowItems = shadowCt.items, + numItems = items.length, + colIndex = 0, + i, numRows; + + // Distribute the items into the appropriate column containers. We add directly to the + // containers' items collection rather than calling container.add(), because we need the + // checkboxes to maintain their original ownerCt. The distribution is done on each layout + // in case items have been added, removed, or reordered. + + shadowItems.each(function(col) { + col.items.clear(); + }); - // private - onDblClick : function(e){ - var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); - if(item){ - this.fireEvent("dblclick", this, this.indexOf(item), item, e); + // If columns="auto", then the number of required columns may change as checkboxes are added/removed + // from the CheckboxGroup; adjust to match. + while (shadowItems.length > numCols) { + shadowCt.remove(shadowItems.last()); } - }, - - // private - onMouseOver : function(e){ - var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); - if(item && item !== this.lastItem){ - this.lastItem = item; - Ext.fly(item).addClass(this.overClass); - this.fireEvent("mouseenter", this, this.indexOf(item), item, e); + while (shadowItems.length < numCols) { + shadowCt.add({ + xtype: 'container', + cls: owner.groupCls, + flex: 1 + }); } - }, - // private - onMouseOut : function(e){ - if(this.lastItem){ - if(!e.within(this.lastItem, true, true)){ - Ext.fly(this.lastItem).removeClass(this.overClass); - this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e); - delete this.lastItem; + if (owner.vertical) { + numRows = Math.ceil(numItems / numCols); + for (i = 0; i < numItems; i++) { + if (i > 0 && i % numRows === 0) { + colIndex++; + } + shadowItems.getAt(colIndex).items.add(items.getAt(i)); + } + } else { + for (i = 0; i < numItems; i++) { + colIndex = i % numCols; + shadowItems.getAt(colIndex).items.add(items.getAt(i)); } } - }, - // private - onItemClick : function(item, index, e){ - if(this.fireEvent("beforeclick", this, index, item, e) === false){ - return false; - } - if(this.multiSelect){ - this.doMultiSelection(item, index, e); - e.preventDefault(); - }else if(this.singleSelect){ - this.doSingleSelection(item, index, e); - e.preventDefault(); + if (!shadowCt.rendered) { + shadowCt.render(this.getRenderTarget()); + } else { + // Ensure all items are rendered in the correct place in the correct column - this won't + // get done by the column containers themselves if their dimensions are not changing. + shadowItems.each(function(col) { + var layout = col.getLayout(); + layout.renderItems(layout.getLayoutItems(), layout.getRenderTarget()); + }); } - return true; - }, - // private - doSingleSelection : function(item, index, e){ - if(e.ctrlKey && this.isSelected(index)){ - this.deselect(index); - }else{ - this.select(index, false); - } + shadowCt.doComponentLayout(); }, - // private - doMultiSelection : function(item, index, e){ - if(e.shiftKey && this.last !== false){ - var last = this.last; - this.selectRange(last, index, e.ctrlKey); - this.last = last; // reset the last - }else{ - if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){ - this.deselect(index); - }else{ - this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect); - } - } - }, + + // We don't want to render any items to the owner directly, that gets handled by each column's own layout + renderItems: Ext.emptyFn, + /** - * Gets the number of selected nodes. - * @return {Number} The node count + * @private + * Creates and returns the shadow hbox container that will be used to arrange the owner's items + * into columns. */ - getSelectionCount : function(){ - return this.selected.getCount(); + getShadowCt: function() { + var me = this, + shadowCt = me.shadowCt, + owner, items, item, columns, columnsIsArray, numCols, i; + + if (!shadowCt) { + // Create the column containers based on the owner's 'columns' config + owner = me.owner; + columns = owner.columns; + columnsIsArray = Ext.isArray(columns); + numCols = me.getColCount(); + items = []; + for(i = 0; i < numCols; i++) { + item = { + xtype: 'container', + cls: owner.groupCls + }; + if (columnsIsArray) { + // Array can contain mixture of whole numbers, used as fixed pixel widths, and fractional + // numbers, used as relative flex values. + if (columns[i] < 1) { + item.flex = columns[i]; + } else { + item.width = columns[i]; + } + } + else { + // All columns the same width + item.flex = 1; + } + items.push(item); + } + + // Create the shadow container; delay rendering until after items are added to the columns + shadowCt = me.shadowCt = Ext.createWidget('container', { + layout: 'hbox', + items: items, + ownerCt: owner + }); + } + + return shadowCt; }, + /** - * Gets the currently selected nodes. - * @return {Array} An array of HTMLElements + * @private Get the number of columns in the checkbox group */ - getSelectedNodes : function(){ - return this.selected.elements; + getColCount: function() { + var owner = this.owner, + colsCfg = owner.columns; + return Ext.isArray(colsCfg) ? colsCfg.length : (Ext.isNumber(colsCfg) ? colsCfg : owner.items.length); + } + +}); + +/** + * @class Ext.form.FieldContainer + * @extends Ext.container.Container + +FieldContainer is a derivation of {@link Ext.container.Container Container} that implements the +{@link Ext.form.Labelable Labelable} mixin. This allows it to be configured so that it is rendered with +a {@link #fieldLabel field label} and optional {@link #msgTarget error message} around its sub-items. +This is useful for arranging a group of fields or other components within a single item in a form, so +that it lines up nicely with other fields. A common use is for grouping a set of related fields under +a single label in a form. + +The container's configured {@link #items} will be layed out within the field body area according to the +configured {@link #layout} type. The default layout is `'autocontainer'`. + +Like regular fields, FieldContainer can inherit its decoration configuration from the +{@link Ext.form.Panel#fieldDefaults fieldDefaults} of an enclosing FormPanel. In addition, +FieldContainer itself can pass {@link #fieldDefaults} to any {@link Ext.form.Labelable fields} +it may itself contain. + +If you are grouping a set of {@link Ext.form.field.Checkbox Checkbox} or {@link Ext.form.field.Radio Radio} +fields in a single labeled container, consider using a {@link Ext.form.CheckboxGroup} +or {@link Ext.form.RadioGroup} instead as they are specialized for handling those types. +{@img Ext.form.FieldContainer/Ext.form.FieldContainer1.png Ext.form.FieldContainer component} +__Example usage:__ + + Ext.create('Ext.form.Panel', { + title: 'FieldContainer Example', + width: 550, + bodyPadding: 10, + + items: [{ + xtype: 'fieldcontainer', + fieldLabel: 'Last Three Jobs', + labelWidth: 100, + + // The body area will contain three text fields, arranged + // horizontally, separated by draggable splitters. + layout: 'hbox', + items: [{ + xtype: 'textfield', + flex: 1 + }, { + xtype: 'splitter' + }, { + xtype: 'textfield', + flex: 1 + }, { + xtype: 'splitter' + }, { + xtype: 'textfield', + flex: 1 + }] + }], + renderTo: Ext.getBody() + }); + +__Usage of {@link #fieldDefaults}:__ +{@img Ext.form.FieldContainer/Ext.form.FieldContainer2.png Ext.form.FieldContainer component} + + Ext.create('Ext.form.Panel', { + title: 'FieldContainer Example', + width: 350, + bodyPadding: 10, + + items: [{ + xtype: 'fieldcontainer', + fieldLabel: 'Your Name', + labelWidth: 75, + defaultType: 'textfield', + + // Arrange fields vertically, stretched to full width + layout: 'anchor', + defaults: { + layout: '100%' + }, + + // These config values will be applied to both sub-fields, except + // for Last Name which will use its own msgTarget. + fieldDefaults: { + msgTarget: 'under', + labelAlign: 'top' + }, + + items: [{ + fieldLabel: 'First Name', + name: 'firstName' + }, { + fieldLabel: 'Last Name', + name: 'lastName', + msgTarget: 'under' + }] + }], + renderTo: Ext.getBody() + }); + + + * @markdown + * @docauthor Jason Johnston+ */ +Ext.define('Ext.form.FieldContainer', { + extend: 'Ext.container.Container', + mixins: { + labelable: 'Ext.form.Labelable', + fieldAncestor: 'Ext.form.FieldAncestor' }, + alias: 'widget.fieldcontainer', + + componentLayout: 'field', /** - * Gets the indexes of the selected nodes. - * @return {Array} An array of numeric indexes + * @cfg {Boolean} combineLabels + * If set to true, and there is no defined {@link #fieldLabel}, the field container will automatically + * generate its label by combining the labels of all the fields it contains. Defaults to false. */ - getSelectedIndexes : function(){ - var indexes = [], s = this.selected.elements; - for(var i = 0, len = s.length; i < len; i++){ - indexes.push(s[i].viewIndex); - } - return indexes; - }, + combineLabels: false, /** - * Gets an array of the selected records - * @return {Array} An array of {@link Ext.data.Record} objects + * @cfg {String} labelConnector + * The string to use when joining the labels of individual sub-fields, when {@link #combineLabels} is + * set to true. Defaults to ', '. */ - getSelectedRecords : function(){ - var r = [], s = this.selected.elements; - for(var i = 0, len = s.length; i < len; i++){ - r[r.length] = this.store.getAt(s[i].viewIndex); - } - return r; - }, + labelConnector: ', ', /** - * Gets an array of the records from an array of nodes - * @param {Array} nodes The nodes to evaluate - * @return {Array} records The {@link Ext.data.Record} objects + * @cfg {Boolean} combineErrors + * If set to true, the field container will automatically combine and display the validation errors from + * all the fields it contains as a single error on the container, according to the configured + * {@link #msgTarget}. Defaults to false. */ - getRecords : function(nodes){ - var r = [], s = nodes; - for(var i = 0, len = s.length; i < len; i++){ - r[r.length] = this.store.getAt(s[i].viewIndex); - } - return r; + combineErrors: false, + + maskOnDisable: false, + + initComponent: function() { + var me = this, + onSubCmpAddOrRemove = me.onSubCmpAddOrRemove; + + // Init mixins + me.initLabelable(); + me.initFieldAncestor(); + + me.callParent(); }, /** - * Gets a record from a node - * @param {HTMLElement} node The node to evaluate - * @return {Record} record The {@link Ext.data.Record} object + * @protected Called when a {@link Ext.form.Labelable} instance is added to the container's subtree. + * @param {Ext.form.Labelable} labelable The instance that was added */ - getRecord : function(node){ - return this.store.getAt(node.viewIndex); + onLabelableAdded: function(labelable) { + var me = this; + me.mixins.fieldAncestor.onLabelableAdded.call(this, labelable); + me.updateLabel(); }, /** - * Clears all selections. - * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event + * @protected Called when a {@link Ext.form.Labelable} instance is removed from the container's subtree. + * @param {Ext.form.Labelable} labelable The instance that was removed */ - clearSelections : function(suppressEvent, skipUpdate){ - if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){ - if(!skipUpdate){ - this.selected.removeClass(this.selectedClass); - } - this.selected.clear(); - this.last = false; - if(!suppressEvent){ - this.fireEvent("selectionchange", this, this.selected.elements); - } - } + onLabelableRemoved: function(labelable) { + var me = this; + me.mixins.fieldAncestor.onLabelableRemoved.call(this, labelable); + me.updateLabel(); }, - /** - * Returns true if the passed node is selected, else false. - * @param {HTMLElement/Number/Ext.data.Record} node The node, node index or record to check - * @return {Boolean} True if selected, else false - */ - isSelected : function(node){ - return this.selected.contains(this.getNode(node)); + onRender: function() { + var me = this, + renderSelectors = me.renderSelectors, + applyIf = Ext.applyIf; + + applyIf(renderSelectors, me.getLabelableSelectors()); + + me.callParent(arguments); }, - /** - * Deselects a node. - * @param {HTMLElement/Number/Record} node The node, node index or record to deselect - */ - deselect : function(node){ - if(this.isSelected(node)){ - node = this.getNode(node); - this.selected.removeElement(node); - if(this.last == node.viewIndex){ - this.last = false; - } - Ext.fly(node).removeClass(this.selectedClass); - this.fireEvent("selectionchange", this, this.selected.elements); + initRenderTpl: function() { + var me = this; + if (!me.hasOwnProperty('renderTpl')) { + me.renderTpl = me.getTpl('labelableRenderTpl'); } + return me.callParent(); }, - /** - * Selects a set of nodes. - * @param {Array/HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node, - * id of a template node, record associated with a node or an array of any of those to select - * @param {Boolean} keepExisting (optional) true to keep existing selections - * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent - */ - select : function(nodeInfo, keepExisting, suppressEvent){ - if(Ext.isArray(nodeInfo)){ - if(!keepExisting){ - this.clearSelections(true); - } - for(var i = 0, len = nodeInfo.length; i < len; i++){ - this.select(nodeInfo[i], true, true); - } - if(!suppressEvent){ - this.fireEvent("selectionchange", this, this.selected.elements); - } - } else{ - var node = this.getNode(nodeInfo); - if(!keepExisting){ - this.clearSelections(true); - } - if(node && !this.isSelected(node)){ - if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){ - Ext.fly(node).addClass(this.selectedClass); - this.selected.add(node); - this.last = node.viewIndex; - if(!suppressEvent){ - this.fireEvent("selectionchange", this, this.selected.elements); - } - } - } - } + initRenderData: function() { + return Ext.applyIf(this.callParent(), this.getLabelableRenderData()); }, /** - * Selects a range of nodes. All nodes between start and end are selected. - * @param {Number} start The index of the first node in the range - * @param {Number} end The index of the last node in the range - * @param {Boolean} keepExisting (optional) True to retain existing selections + * Returns the combined field label if {@link #combineLabels} is set to true and if there is no + * set {@link #fieldLabel}. Otherwise returns the fieldLabel like normal. You can also override + * this method to provide a custom generated label. */ - selectRange : function(start, end, keepExisting){ - if(!keepExisting){ - this.clearSelections(true); + getFieldLabel: function() { + var label = this.fieldLabel || ''; + if (!label && this.combineLabels) { + label = Ext.Array.map(this.query('[isFieldLabelable]'), function(field) { + return field.getFieldLabel(); + }).join(this.labelConnector); } - this.select(this.getNodes(start, end), true); + return label; }, /** - * Gets a template node. - * @param {HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node, - * the id of a template node or the record associated with the node. - * @return {HTMLElement} The node or null if it wasn't found + * @private Updates the content of the labelEl if it is rendered */ - getNode : function(nodeInfo){ - if(Ext.isString(nodeInfo)){ - return document.getElementById(nodeInfo); - }else if(Ext.isNumber(nodeInfo)){ - return this.all.elements[nodeInfo]; - }else if(nodeInfo instanceof Ext.data.Record){ - var idx = this.store.indexOf(nodeInfo); - return this.all.elements[idx]; + updateLabel: function() { + var me = this, + label = me.labelEl; + if (label) { + label.update(me.getFieldLabel()); } - return nodeInfo; }, + /** - * 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 {Array} An array of nodes + * @private Fired when the error message of any field within the container changes, and updates the + * combined error message to match. */ - getNodes : function(start, end){ - var ns = this.all.elements; - start = start || 0; - end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end; - var nodes = [], i; - if(start <= end){ - for(i = start; i <= end && ns[i]; i++){ - nodes.push(ns[i]); + onFieldErrorChange: function(field, activeError) { + if (this.combineErrors) { + var me = this, + oldError = me.getActiveError(), + invalidFields = Ext.Array.filter(me.query('[isFormField]'), function(field) { + return field.hasActiveError(); + }), + newErrors = me.getCombinedErrors(invalidFields); + + if (newErrors) { + me.setActiveErrors(newErrors); + } else { + me.unsetActiveError(); } - } else{ - for(i = start; i >= end && ns[i]; i--){ - nodes.push(ns[i]); + + if (oldError !== me.getActiveError()) { + me.doComponentLayout(); } } - return nodes; }, /** - * Finds the index of the passed node. - * @param {HTMLElement/String/Number/Record} nodeInfo An HTMLElement template node, index of a template node, the id of a template node - * or a record associated with a node. - * @return {Number} The index of the node or -1 + * Takes an Array of invalid {@link Ext.form.field.Field} objects and builds a combined list of error + * messages from them. Defaults to prepending each message by the field name and a colon. This + * can be overridden to provide custom combined error message handling, for instance changing + * the format of each message or sorting the array (it is sorted in order of appearance by default). + * @param {Array} invalidFields An Array of the sub-fields which are currently invalid. + * @return {Array} The combined list of error messages */ - indexOf : function(node){ - node = this.getNode(node); - if(Ext.isNumber(node.viewIndex)){ - return node.viewIndex; - } - return this.all.indexOf(node); - }, - - // private - onBeforeLoad : function(){ - if(this.loadingText){ - this.clearSelections(false, true); - this.getTemplateTarget().update(' '+this.loadingText+''); - this.all.clear(); - } + getCombinedErrors: function(invalidFields) { + var forEach = Ext.Array.forEach, + errors = []; + forEach(invalidFields, function(field) { + forEach(field.getActiveErrors(), function(error) { + var label = field.getFieldLabel(); + errors.push((label ? label + ': ' : '') + error); + }); + }); + return errors; }, - onDestroy : function(){ - this.all.clear(); - this.selected.clear(); - Ext.DataView.superclass.onDestroy.call(this); - this.bindStore(null); + getTargetEl: function() { + return this.bodyEl || this.callParent(); } }); /** - * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore) - * @param {Store} store The store to bind to this view + * A {@link Ext.form.FieldContainer field container} which has a specialized layout for arranging + * {@link Ext.form.field.Checkbox} controls into columns, and provides convenience {@link Ext.form.field.Field} methods + * for {@link #getValue getting}, {@link #setValue setting}, and {@link #validate validating} the group + * of checkboxes as a whole. + * + * # Validation + * + * Individual checkbox fields themselves have no default validation behavior, but + * sometimes you want to require a user to select at least one of a group of checkboxes. CheckboxGroup + * allows this by setting the config `{@link #allowBlank}:false`; when the user does not check at + * least one of the checkboxes, the entire group will be highlighted as invalid and the + * {@link #blankText error message} will be displayed according to the {@link #msgTarget} config. + * + * # Layout + * + * The default layout for CheckboxGroup makes it easy to arrange the checkboxes into + * columns; see the {@link #columns} and {@link #vertical} config documentation for details. You may also + * use a completely different layout by setting the {@link #layout} to one of the other supported layout + * types; for instance you may wish to use a custom arrangement of hbox and vbox containers. In that case + * the checkbox components at any depth will still be managed by the CheckboxGroup's validation. + * + * {@img Ext.form.CheckboxGroup/Ext.form.CheckboxGroup.png Ext.form.CheckboxGroup component} + * + * # Example usage + * + * Ext.create('Ext.form.Panel', { + * title: 'Checkbox Group', + * width: 300, + * height: 125, + * bodyPadding: 10, + * renderTo: Ext.getBody(), + * items:[{ + * xtype: 'checkboxgroup', + * fieldLabel: 'Two Columns', + * // Arrange radio buttons into two columns, distributed vertically + * columns: 2, + * vertical: true, + * items: [ + * {boxLabel: 'Item 1', name: 'rb', inputValue: '1'}, + * {boxLabel: 'Item 2', name: 'rb', inputValue: '2', checked: true}, + * {boxLabel: 'Item 3', name: 'rb', inputValue: '3'}, + * {boxLabel: 'Item 4', name: 'rb', inputValue: '4'}, + * {boxLabel: 'Item 5', name: 'rb', inputValue: '5'}, + * {boxLabel: 'Item 6', name: 'rb', inputValue: '6'} + * ] + * }] + * }); + * */ -Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore; - -Ext.reg('dataview', Ext.DataView); -/** - * @class Ext.list.ListView - * @extends Ext.DataView - *Ext.list.ListView is a fast and light-weight implentation of a - * {@link Ext.grid.GridPanel Grid} like view with the following characteristics:
- *- *- *
- resizable columns
- *- selectable
- *- column widths are initially proportioned by percentage based on the container - * width and number of columns
- *- uses templates to render the data in any required format
- *- no horizontal scrolling
- *- no editing
- *Example usage:
- *- * @constructor - * @param {Object} config - * @xtype listview - */ -Ext.list.ListView = Ext.extend(Ext.DataView, { - /** - * Set this property to true to disable the header click handler disabling sort - * (defaults to false). - * @type Boolean - * @property disableHeaders - */ - /** - * @cfg {Boolean} hideHeaders - * true to hide the {@link #internalTpl header row} (defaults to false so - * the {@link #internalTpl header row} will be shown). - */ - /** - * @cfg {String} itemSelector - * Defaults to 'dl' to work with the preconfigured {@link Ext.DataView#tpl tpl}. - * This setting specifies the CSS selector (e.g. div.some-class or span:first-child) - * that will be used to determine what nodes the ListView will be working with. - */ - itemSelector: 'dl', /** - * @cfg {String} selectedClass The CSS class applied to a selected row (defaults to - * 'x-list-selected'). An example overriding the default styling: --// consume JSON of this form: -{ - "images":[ - { - "name":"dance_fever.jpg", - "size":2067, - "lastmod":1236974993000, - "url":"images\/thumbs\/dance_fever.jpg" - }, - { - "name":"zack_sink.jpg", - "size":2303, - "lastmod":1236974993000, - "url":"images\/thumbs\/zack_sink.jpg" - } - ] -} -var store = new Ext.data.JsonStore({ - url: 'get-images.php', - root: 'images', - fields: [ - 'name', 'url', - {name:'size', type: 'float'}, - {name:'lastmod', type:'date', dateFormat:'timestamp'} - ] -}); -store.load(); - -var listView = new Ext.list.ListView({ - store: store, - multiSelect: true, - emptyText: 'No images to display', - reserveScrollOffset: true, - columns: [{ - header: 'File', - width: .5, - dataIndex: 'name' - },{ - header: 'Last Modified', - width: .35, - dataIndex: 'lastmod', - tpl: '{lastmod:date("m-d h:i a")}' - },{ - header: 'Size', - dataIndex: 'size', - tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize() - align: 'right' - }] -}); - -// put it in a Panel so it looks pretty -var panel = new Ext.Panel({ - id:'images-view', - width:425, - height:250, - collapsible:true, - layout:'fit', - title:'Simple ListView (0 items selected)', - items: listView -}); -panel.render(document.body); +Ext.define('Ext.form.CheckboxGroup', { + extend:'Ext.form.FieldContainer', + mixins: { + field: 'Ext.form.field.Field' + }, + alias: 'widget.checkboxgroup', + requires: ['Ext.layout.container.CheckboxGroup', 'Ext.form.field.Base'], -// little bit of feedback -listView.on('selectionchange', function(view, nodes){ - var l = nodes.length; - var s = l != 1 ? 's' : ''; - panel.setTitle('Simple ListView ('+l+' item'+s+' selected)'); -}); - *
- * @type String + * @cfg {String} name + * @hide */ - selectedClass:'x-list-selected', + /** - * @cfg {String} overClass The CSS class applied when over a row (defaults to - * 'x-list-over'). An example overriding the default styling: -- .x-list-selected {background-color: yellow;} -
- * @type String + * @cfg {Array} items An Array of {@link Ext.form.field.Checkbox Checkbox}es or Checkbox config objects + * to arrange in the group. */ - overClass:'x-list-over', + /** - * @cfg {Boolean} reserveScrollOffset - * By default will defer accounting for the configured {@link #scrollOffset} - * for 10 milliseconds. Specify true to account for the configured - * {@link #scrollOffset} immediately. + * @cfg {String/Number/Array} columns Specifies the number of columns to use when displaying grouped + * checkbox/radio controls using automatic layout. This config can take several types of values: + *- .x-list-over {background-color: orange;} -
*/ + columns : 'auto', + /** - * @cfg {Number} scrollOffset The amount of space to reserve for the scrollbar (defaults to - * undefined). If an explicit value isn't specified, this will be automatically - * calculated. + * @cfg {Boolean} vertical True to distribute contained controls across columns, completely filling each column + * top to bottom before starting on the next column. The number of controls in each column will be automatically + * calculated to keep columns as even as possible. The default value is false, so that controls will be added + * to columns one at a time, completely filling each row left to right before starting on the next row. */ - scrollOffset : undefined, + vertical : false, + /** - * @cfg {Boolean/Object} columnResize - * Specify true or specify a configuration object for {@link Ext.list.ListView.ColumnResizer} - * to enable the columns to be resizable (defaults to true). + * @cfg {Boolean} allowBlank False to validate that at least one item in the group is checked (defaults to true). + * If no items are selected at validation time, {@link #blankText} will be used as the error text. */ - columnResize: true, + allowBlank : true, + /** - * @cfg {Array} columns An array of column configuration objects, for example: - *
- 'auto' :
+ *The controls will be rendered one per column on one row and the width + * of each column will be evenly distributed based on the width of the overall field container. This is the default.
- Number :
+ *If you specific a number (e.g., 3) that number of columns will be + * created and the contained controls will be automatically distributed based on the value of {@link #vertical}.
- Array :
You can also specify an array of column widths, mixing integer + * (fixed width) and float (percentage width) values as needed (e.g., [100, .25, .75]). Any integer values will + * be rendered first, then any float values will be calculated as a percentage of the remaining space. Float + * values do not have to add up to 1 (100%) although if you want the controls to take up the entire field + * container you should do so.
- * Acceptable properties for each column configuration object are: - *-{ - align: 'right', - dataIndex: 'size', - header: 'Size', - tpl: '{size:fileSize}', - width: .35 -} - *
+ * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails (defaults to "You must + * select at least one item in this group") */ + blankText : "You must select at least one item in this group", + + // private + defaultType : 'checkboxfield', + + // private + groupCls : Ext.baseCSSPrefix + 'form-check-group', + /** - * @cfg {Boolean/Object} columnSort - * Specify true or specify a configuration object for {@link Ext.list.ListView.Sorter} - * to enable the columns to be sortable (defaults to true). + * @cfg {String} fieldBodyCls + * An extra CSS class to be applied to the body content element in addition to {@link #baseBodyCls}. + * Defaults to 'x-form-checkboxgroup-body'. */ - columnSort: true, + fieldBodyCls: Ext.baseCSSPrefix + 'form-checkboxgroup-body', + + // private + layout: 'checkboxgroup', + + initComponent: function() { + var me = this; + me.callParent(); + me.initField(); + }, + /** - * @cfg {String/Array} internalTpl - * The template to be used for the header row. See {@link #tpl} for more details. + * @protected + * Initializes the field's value based on the initial config. If the {@link #value} config is specified + * then we use that to set the value; otherwise we initialize the originalValue by querying the values of + * all sub-checkboxes after they have been initialized. */ + initValue: function() { + var me = this, + valueCfg = me.value; + me.originalValue = me.lastValue = valueCfg || me.getValue(); + if (valueCfg) { + me.setValue(valueCfg); + } + }, - /* - * IE has issues when setting percentage based widths to 100%. Default to 99. + /** + * @protected + * When a checkbox is added to the group, monitor it for changes */ - maxWidth: Ext.isIE ? 99 : 100, + onFieldAdded: function(field) { + var me = this; + if (field.isCheckbox) { + me.mon(field, 'change', me.checkChange, me); + } + me.callParent(arguments); + }, - initComponent : function(){ - if(this.columnResize){ - this.colResizer = new Ext.list.ColumnResizer(this.colResizer); - this.colResizer.init(this); - } - if(this.columnSort){ - this.colSorter = new Ext.list.Sorter(this.columnSort); - this.colSorter.init(this); - } - if(!this.internalTpl){ - this.internalTpl = new Ext.XTemplate( - '- *
- align : String
- *Set the CSS text-align property - * of the column. Defaults to 'left'.- dataIndex : String
- *See {@link Ext.grid.Column}. - * {@link Ext.grid.Column#dataIndex dataIndex} for details.- header : String
- *See {@link Ext.grid.Column}. - * {@link Ext.grid.Column#header header} for details.- tpl : String
- *Specify a string to pass as the - * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate} - * will be implicitly created using the dataIndex.- width : Number
- *Percentage of the container width - * this column should be allocated. Columns that have no width specified will be - * allocated with an equal percentage to fill 100% of the container width. To easily take - * advantage of the full container width, leave the width of at least one column undefined. - * Note that if you do not want to take up the full width of the container, the width of - * every column needs to be explicitly defined.', - '', - '', - ' ', - '', - '', - '{header}', - '', - '' - ); + onFieldRemoved: function(field) { + var me = this; + if (field.isCheckbox) { + me.mun(field, 'change', me.checkChange, me); } - if(!this.tpl){ - this.tpl = new Ext.XTemplate( - '', - '', - ' ', - '', - '', - '' - ); - }; + me.callParent(arguments); + }, - var cs = this.columns, - allocatedWidth = 0, - colsWithWidth = 0, - len = cs.length, - columns = []; + // private override - the group value is a complex object, compare using object serialization + isEqual: function(value1, value2) { + var toQueryString = Ext.Object.toQueryString; + return toQueryString(value1) === toQueryString(value2); + }, - for(var i = 0; i < len; i++){ - var c = cs[i]; - if(!c.isColumn) { - c.xtype = c.xtype ? (/^lv/.test(c.xtype) ? c.xtype : 'lv' + c.xtype) : 'lvcolumn'; - c = Ext.create(c); - } - if(c.width) { - allocatedWidth += c.width*100; - colsWithWidth++; - } - columns.push(c); + /** + * Runs CheckboxGroup's validations and returns an array of any errors. The only error by default + * is if allowBlank is set to true and no items are checked. + * @return {Array} Array of all validation errors + */ + getErrors: function() { + var errors = []; + if (!this.allowBlank && Ext.isEmpty(this.getChecked())) { + errors.push(this.blankText); } + return errors; + }, - cs = this.columns = columns; + /** + * @private Returns all checkbox components within the container + */ + getBoxes: function() { + return this.query('[isCheckbox]'); + }, - // auto calculate missing column widths - if(colsWithWidth < len){ - var remaining = len - colsWithWidth; - if(allocatedWidth < this.maxWidth){ - var perCol = ((this.maxWidth-allocatedWidth) / remaining)/100; - for(var j = 0; j < len; j++){ - var c = cs[j]; - if(!c.width){ - c.width = perCol; - } - } - } - } - Ext.list.ListView.superclass.initComponent.call(this); + /** + * @private Convenience function which calls the given function for every checkbox in the group + * @param {Function} fn The function to call + * @param {Object} scope Optional scope object + */ + eachBox: function(fn, scope) { + Ext.Array.forEach(this.getBoxes(), fn, scope || this); }, - onRender : function(){ - this.autoEl = { - cls: 'x-list-wrap' - }; - Ext.list.ListView.superclass.onRender.apply(this, arguments); + /** + * Returns an Array of all checkboxes in the container which are currently checked + * @return {Array} Array of Ext.form.field.Checkbox components + */ + getChecked: function() { + return Ext.Array.filter(this.getBoxes(), function(cb) { + return cb.getValue(); + }); + }, - this.internalTpl.overwrite(this.el, {columns: this.columns}); + // private override + isDirty: function(){ + return Ext.Array.some(this.getBoxes(), function(cb) { + return cb.isDirty(); + }); + }, - this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild); - this.innerHd = Ext.get(this.el.dom.firstChild.firstChild); + // private override + setReadOnly: function(readOnly) { + this.eachBox(function(cb) { + cb.setReadOnly(readOnly); + }); + this.readOnly = readOnly; + }, - if(this.hideHeaders){ - this.el.dom.firstChild.style.display = 'none'; + /** + * Resets the checked state of all {@link Ext.form.field.Checkbox checkboxes} in the group to their + * originally loaded values and clears any validation messages. + * See {@link Ext.form.Basic}.{@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} + */ + reset: function() { + var me = this, + hadError = me.hasActiveError(), + preventMark = me.preventMark; + me.preventMark = true; + me.batchChanges(function() { + me.eachBox(function(cb) { + cb.reset(); + }); + }); + me.preventMark = preventMark; + me.unsetActiveError(); + if (hadError) { + me.doComponentLayout(); } }, - getTemplateTarget : function(){ - return this.innerBody; + // private override + resetOriginalValue: function() { + // Defer resetting of originalValue until after all sub-checkboxes have been reset so we get + // the correct data from getValue() + Ext.defer(function() { + this.callParent(); + }, 1, this); }, + /** - *', - '
', - ' ">', - '{[values.tpl.apply(parent)]}', - '', - '- ', - ' class="{cls}
Function which can be overridden which returns the data object passed to this - * view's {@link #tpl template} to render the whole ListView. The returned object - * shall contain the following properties:
- *- * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView. - * @param {Number} startIndex the index number of the Record being prepared for rendering. - * @return {Object} A data object containing properties to be processed by a repeating - * XTemplate as described above. + *- *
- columns : String
- *See {@link #columns}- rows : String
- *See - * {@link Ext.DataView}.{@link Ext.DataView#collectData collectData}Sets the value(s) of all checkboxes in the group. The expected format is an Object of + * name-value pairs corresponding to the names of the checkboxes in the group. Each pair can + * have either a single or multiple values:
+ *+ *
+ *- A single Boolean or String value will be passed to the
+ *setValue
method of the + * checkbox with that name. See the rules in {@link Ext.form.field.Checkbox#setValue} for accepted values.- An Array of String values will be matched against the {@link Ext.form.field.Checkbox#inputValue inputValue} + * of checkboxes in the group with that name; those checkboxes whose inputValue exists in the array will be + * checked and others will be unchecked.
+ *If a checkbox's name is not in the mapping at all, it will be unchecked.
+ *An example:
+ *+ *var myCheckboxGroup = new Ext.form.CheckboxGroup({ + columns: 3, + items: [{ + name: 'cb1', + boxLabel: 'Single 1' + }, { + name: 'cb2', + boxLabel: 'Single 2' + }, { + name: 'cb3', + boxLabel: 'Single 3' + }, { + name: 'cbGroup', + boxLabel: 'Grouped 1' + inputValue: 'value1' + }, { + name: 'cbGroup', + boxLabel: 'Grouped 2' + inputValue: 'value2' + }, { + name: 'cbGroup', + boxLabel: 'Grouped 3' + inputValue: 'value3' + }] +}); + +myCheckboxGroup.setValue({ + cb1: true, + cb3: false, + cbGroup: ['value1', 'value3'] +});
The above code will cause the checkbox named 'cb1' to be checked, as well as the first and third + * checkboxes named 'cbGroup'. The other three checkboxes will be unchecked.
+ * @param {Object} value The mapping of checkbox names to values. + * @return {Ext.form.CheckboxGroup} this */ - collectData : function(){ - var rs = Ext.list.ListView.superclass.collectData.apply(this, arguments); - return { - columns: this.columns, - rows: rs - } + setValue: function(value) { + var me = this; + me.batchChanges(function() { + me.eachBox(function(cb) { + var name = cb.getName(), + cbValue = false; + if (value && name in value) { + if (Ext.isArray(value[name])) { + cbValue = Ext.Array.contains(value[name], cb.inputValue); + } else { + // single value, let the checkbox's own setValue handle conversion + cbValue = value[name]; + } + } + cb.setValue(cbValue); + }); + }); + return me; }, - verifyInternalSize : function(){ - if(this.lastSize){ - this.onResize(this.lastSize.width, this.lastSize.height); - } - }, - // private - onResize : function(w, h){ - var bd = this.innerBody.dom; - var hd = this.innerHd.dom; - if(!bd){ - return; - } - var bdp = bd.parentNode; - if(Ext.isNumber(w)){ - var sw = w - Ext.num(this.scrollOffset, Ext.getScrollBarWidth()); - if(this.reserveScrollOffset || ((bdp.offsetWidth - bdp.clientWidth) > 10)){ - bd.style.width = sw + 'px'; - hd.style.width = sw + 'px'; - }else{ - bd.style.width = w + 'px'; - hd.style.width = w + 'px'; - setTimeout(function(){ - if((bdp.offsetWidth - bdp.clientWidth) > 10){ - bd.style.width = sw + 'px'; - hd.style.width = sw + 'px'; + /** + *Returns an object containing the values of all checked checkboxes within the group. Each key-value pair + * in the object corresponds to a checkbox {@link Ext.form.field.Checkbox#name name}. If there is only one checked + * checkbox with a particular name, the value of that pair will be the String + * {@link Ext.form.field.Checkbox#inputValue inputValue} of that checkbox. If there are multiple checked checkboxes + * with that name, the value of that pair will be an Array of the selected inputValues.
+ *The object format returned from this method can also be passed directly to the {@link #setValue} method.
+ *NOTE: In Ext 3, this method returned an array of Checkbox components; this was changed to make it more + * consistent with other field components and with the {@link #setValue} argument signature. If you need the old + * behavior in Ext 4+, use the {@link #getChecked} method instead.
+ */ + getValue: function() { + var values = {}; + this.eachBox(function(cb) { + var name = cb.getName(), + inputValue = cb.inputValue, + bucket; + if (cb.getValue()) { + if (name in values) { + bucket = values[name]; + if (!Ext.isArray(bucket)) { + bucket = values[name] = [bucket]; } - }, 10); + bucket.push(inputValue); + } else { + values[name] = inputValue; + } } - } - if(Ext.isNumber(h)){ - bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px'; - } + }); + return values; }, - updateIndexes : function(){ - Ext.list.ListView.superclass.updateIndexes.apply(this, arguments); - this.verifyInternalSize(); + /* + * Don't return any data for submit; the form will get the info from the individual checkboxes themselves. + */ + getSubmitData: function() { + return null; }, - findHeaderIndex : function(hd){ - hd = hd.dom || hd; - var pn = hd.parentNode, cs = pn.parentNode.childNodes; - for(var i = 0, c; c = cs[i]; i++){ - if(c == pn){ - return i; - } - } - return -1; + /* + * Don't return any data for the model; the form will get the info from the individual checkboxes themselves. + */ + getModelData: function() { + return null; }, - setHdWidths : function(){ - var els = this.innerHd.dom.getElementsByTagName('div'); - for(var i = 0, cs = this.columns, len = cs.length; i < len; i++){ - els[i].style.width = (cs[i].width*100) + '%'; + validate: function() { + var me = this, + errors = me.getErrors(), + isValid = Ext.isEmpty(errors), + wasValid = !me.hasActiveError(); + + if (isValid) { + me.unsetActiveError(); + } else { + me.setActiveError(errors); + } + if (isValid !== wasValid) { + me.fireEvent('validitychange', me, isValid); + me.doComponentLayout(); } - } -}); -Ext.reg('listview', Ext.list.ListView); + return isValid; + } -// Backwards compatibility alias -Ext.ListView = Ext.list.ListView;/** - * @class Ext.list.Column - *This class encapsulates column configuration data to be used in the initialization of a - * {@link Ext.list.ListView ListView}.
- *While subclasses are provided to render data in different ways, this class renders a passed - * data field unchanged and is usually used for textual columns.
- */ -Ext.list.Column = Ext.extend(Object, { - /** - * @private - * @cfg {Boolean} isColumn - * Used by ListView constructor method to avoid reprocessing a Column - * ifisColumn
is not set ListView will recreate a new Ext.list.Column - * Defaults to true. - */ - isColumn: true, - - /** - * @cfg {String} align - * Set the CSS text-align property of the column. Defaults to 'left'. - */ - align: 'left', - /** - * @cfg {String} header Optional. The header text to be used as innerHTML - * (html tags are accepted) to display in the ListView. Note: to - * have a clickable header with no text displayed use ' '. - */ - header: '', - - /** - * @cfg {Number} width Optional. Percentage of the container width - * this column should be allocated. Columns that have no width specified will be - * allocated with an equal percentage to fill 100% of the container width. To easily take - * advantage of the full container width, leave the width of at least one column undefined. - * Note that if you do not want to take up the full width of the container, the width of - * every column needs to be explicitly defined. - */ - width: null, +}, function() { - /** - * @cfg {String} cls Optional. This option can be used to add a CSS class to the cell of each - * row for this column. - */ - cls: '', - - /** - * @cfg {String} tpl Optional. Specify a string to pass as the - * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate} - * will be implicitly created using the dataIndex. - */ + this.borrow(Ext.form.field.Base, ['markInvalid', 'clearInvalid']); - /** - * @cfg {String} dataIndexRequired. The name of the field in the - * ListViews's {@link Ext.data.Store}'s {@link Ext.data.Record} definition from - * which to draw the column's value.
- */ - - constructor : function(c){ - if(!c.tpl){ - c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}'); - } - else if(Ext.isString(c.tpl)){ - c.tpl = new Ext.XTemplate(c.tpl); - } - - Ext.apply(this, c); - } }); -Ext.reg('lvcolumn', Ext.list.Column); /** - * @class Ext.list.NumberColumn - * @extends Ext.list.Column - *A Column definition class which renders a numeric data field according to a {@link #format} string. See the - * {@link Ext.list.Column#xtype xtype} config option of {@link Ext.list.Column} for more details.
+ * @private + * Private utility class for managing all {@link Ext.form.field.Checkbox} fields grouped by name. */ -Ext.list.NumberColumn = Ext.extend(Ext.list.Column, { - /** - * @cfg {String} format - * A formatting string as used by {@link Ext.util.Format#number} to format a numeric value for this Column - * (defaults to '0,000.00'). - */ - format: '0,000.00', - - constructor : function(c) { - c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':number("' + (c.format || this.format) + '")}'); - Ext.list.NumberColumn.superclass.constructor.call(this, c); - } -}); +Ext.define('Ext.form.CheckboxManager', { + extend: 'Ext.util.MixedCollection', + singleton: true, -Ext.reg('lvnumbercolumn', Ext.list.NumberColumn); + getByName: function(name) { + return this.filterBy(function(item) { + return item.name == name; + }); + }, -/** - * @class Ext.list.DateColumn - * @extends Ext.list.Column - *A Column definition class which renders a passed date according to the default locale, or a configured - * {@link #format}. See the {@link Ext.list.Column#xtype xtype} config option of {@link Ext.list.Column} - * for more details.
- */ -Ext.list.DateColumn = Ext.extend(Ext.list.Column, { - format: 'm/d/Y', - constructor : function(c) { - c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':date("' + (c.format || this.format) + '")}'); - Ext.list.DateColumn.superclass.constructor.call(this, c); + getWithValue: function(name, value) { + return this.filterBy(function(item) { + return item.name == name && item.inputValue == value; + }); + }, + + getChecked: function(name) { + return this.filterBy(function(item) { + return item.name == name && item.checked; + }); } }); -Ext.reg('lvdatecolumn', Ext.list.DateColumn); /** - * @class Ext.list.BooleanColumn - * @extends Ext.list.Column - *A Column definition class which renders boolean data fields. See the {@link Ext.list.Column#xtype xtype} - * config option of {@link Ext.list.Column} for more details.
+ * @class Ext.form.FieldSet + * @extends Ext.container.Container + * + * A container for grouping sets of fields, rendered as a HTML `fieldset` element. The {@link #title} + * config will be rendered as the fieldset's `legend`. + * + * While FieldSets commonly contain simple groups of fields, they are general {@link Ext.container.Container Containers} + * and may therefore contain any type of components in their {@link #items}, including other nested containers. + * The default {@link #layout} for the FieldSet's items is `'anchor'`, but it can be configured to use any other + * layout type. + * + * FieldSets may also be collapsed if configured to do so; this can be done in two ways: + * + * 1. Set the {@link #collapsible} config to true; this will result in a collapse button being rendered next to + * the {@link #title legend title}, or: + * 2. Set the {@link #checkboxToggle} config to true; this is similar to using {@link #collapsible} but renders + * a {@link Ext.form.field.Checkbox checkbox} in place of the toggle button. The fieldset will be expanded when the + * checkbox is checked and collapsed when it is unchecked. The checkbox will also be included in the + * {@link Ext.form.Basic#submit form submit parameters} using the {@link #checkboxName} as its parameter name. + * + * {@img Ext.form.FieldSet/Ext.form.FieldSet.png Ext.form.FieldSet component} + * + * ## Example usage + * + * Ext.create('Ext.form.Panel', { + * title: 'Simple Form with FieldSets', + * labelWidth: 75, // label settings here cascade unless overridden + * url: 'save-form.php', + * frame: true, + * bodyStyle: 'padding:5px 5px 0', + * width: 550, + * renderTo: Ext.getBody(), + * layout: 'column', // arrange fieldsets side by side + * defaults: { + * bodyPadding: 4 + * }, + * items: [{ + * // Fieldset in Column 1 - collapsible via toggle button + * xtype:'fieldset', + * columnWidth: 0.5, + * title: 'Fieldset 1', + * collapsible: true, + * defaultType: 'textfield', + * defaults: {anchor: '100%'}, + * layout: 'anchor', + * items :[{ + * fieldLabel: 'Field 1', + * name: 'field1' + * }, { + * fieldLabel: 'Field 2', + * name: 'field2' + * }] + * }, { + * // Fieldset in Column 2 - collapsible via checkbox, collapsed by default, contains a panel + * xtype:'fieldset', + * title: 'Show Panel', // title or checkboxToggle creates fieldset header + * columnWidth: 0.5, + * checkboxToggle: true, + * collapsed: true, // fieldset initially collapsed + * layout:'anchor', + * items :[{ + * xtype: 'panel', + * anchor: '100%', + * title: 'Panel inside a fieldset', + * frame: true, + * height: 52 + * }] + * }] + * }); + * + * @docauthor Jason Johnston*/ -Ext.list.BooleanColumn = Ext.extend(Ext.list.Column, { +Ext.define('Ext.form.FieldSet', { + extend: 'Ext.container.Container', + alias: 'widget.fieldset', + uses: ['Ext.form.field.Checkbox', 'Ext.panel.Tool', 'Ext.layout.container.Anchor', 'Ext.layout.component.FieldSet'], + /** - * @cfg {String} trueText - * The string returned by the renderer when the column value is not falsey (defaults to 'true'). + * @cfg {String} title + * A title to be displayed in the fieldset's legend. May contain HTML markup. */ - trueText: 'true', + /** - * @cfg {String} falseText - * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to - * 'false'). + * @cfg {Boolean} checkboxToggle + * Set to true to render a checkbox into the fieldset frame just + * in front of the legend to expand/collapse the fieldset when the checkbox is toggled. (defaults + * to false). This checkbox will be included in form submits using the {@link #checkboxName}. */ - falseText: 'false', + /** - * @cfg {String} undefinedText - * The string returned by the renderer when the column value is undefined (defaults to ' '). + * @cfg {String} checkboxName + * The name to assign to the fieldset's checkbox if {@link #checkboxToggle} = true + * (defaults to '[fieldset id]-checkbox'). */ - undefinedText: ' ', - - constructor : function(c) { - c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':this.format}'); - - var t = this.trueText, f = this.falseText, u = this.undefinedText; - c.tpl.format = function(v){ - if(v === undefined){ - return u; - } - if(!v || v === 'false'){ - return f; - } - return t; - }; - - Ext.list.DateColumn.superclass.constructor.call(this, c); - } -}); -Ext.reg('lvbooleancolumn', Ext.list.BooleanColumn);/** - * @class Ext.list.ColumnResizer - * @extends Ext.util.Observable - * Supporting Class for Ext.list.ListView
- * @constructor - * @param {Object} config - */ -Ext.list.ColumnResizer = Ext.extend(Ext.util.Observable, { /** - * @cfg {Number} minPct The minimum percentage to allot for any column (defaults to .05) + * @cfg {Boolean} collapsible + * Set to true to make the fieldset collapsible and have the expand/collapse toggle button automatically + * rendered into the legend element, false to keep the fieldset statically sized with no collapse + * button (defaults to false). Another option is to configure {@link #checkboxToggle}. + * Use the {@link #collapsed} config to collapse the fieldset by default. */ - minPct: .05, - constructor: function(config){ - Ext.apply(this, config); - Ext.list.ColumnResizer.superclass.constructor.call(this); - }, - init : function(listView){ - this.view = listView; - listView.on('render', this.initEvents, this); - }, + /** + * @cfg {Boolean} collapsed + * Set to true to render the fieldset as collapsed by default. If {@link #checkboxToggle} is specified, + * the checkbox will also be unchecked by default. + */ + collapsed: false, - initEvents : function(view){ - view.mon(view.innerHd, 'mousemove', this.handleHdMove, this); - this.tracker = new Ext.dd.DragTracker({ - onBeforeStart: this.onBeforeStart.createDelegate(this), - onStart: this.onStart.createDelegate(this), - onDrag: this.onDrag.createDelegate(this), - onEnd: this.onEnd.createDelegate(this), - tolerance: 3, - autoStart: 300 - }); - this.tracker.initEl(view.innerHd); - view.on('beforedestroy', this.tracker.destroy, this.tracker); - }, - - handleHdMove : function(e, t){ - var hw = 5, - x = e.getPageX(), - hd = e.getTarget('em', 3, true); - if(hd){ - var r = hd.getRegion(), - ss = hd.dom.style, - pn = hd.dom.parentNode; - - if(x - r.left <= hw && pn != pn.parentNode.firstChild){ - this.activeHd = Ext.get(pn.previousSibling.firstChild); - ss.cursor = Ext.isWebKit ? 'e-resize' : 'col-resize'; - } else if(r.right - x <= hw && pn != pn.parentNode.lastChild.previousSibling){ - this.activeHd = hd; - ss.cursor = Ext.isWebKit ? 'w-resize' : 'col-resize'; - } else{ - delete this.activeHd; - ss.cursor = ''; - } - } - }, + /** + * @property legend + * @type Ext.Component + * The component for the fieldset's legend. Will only be defined if the configuration requires a legend + * to be created, by setting the {@link #title} or {@link #checkboxToggle} options. + */ - onBeforeStart : function(e){ - this.dragHd = this.activeHd; - return !!this.dragHd; - }, + /** + * @cfg {String} baseCls The base CSS class applied to the fieldset (defaults to 'x-fieldset'). + */ + baseCls: Ext.baseCSSPrefix + 'fieldset', - onStart: function(e){ - this.view.disableHeaders = true; - this.proxy = this.view.el.createChild({cls:'x-list-resizer'}); - this.proxy.setHeight(this.view.el.getHeight()); + /** + * @cfg {String} layout The {@link Ext.container.Container#layout} for the fieldset's immediate child items. + * Defaults to 'anchor'. + */ + layout: 'anchor', - var x = this.tracker.getXY()[0], - w = this.view.innerHd.getWidth(); + componentLayout: 'fieldset', - this.hdX = this.dragHd.getX(); - this.hdIndex = this.view.findHeaderIndex(this.dragHd); + // No aria role necessary as fieldset has its own recognized semantics + ariaRole: '', - this.proxy.setX(this.hdX); - this.proxy.setWidth(x-this.hdX); + renderTpl: [''], + + maskOnDisable: false, - this.minWidth = w*this.minPct; - this.maxWidth = w - (this.minWidth*(this.view.columns.length-1-this.hdIndex)); + getElConfig: function(){ + return {tag: 'fieldset', id: this.id}; }, - onDrag: function(e){ - var cursorX = this.tracker.getXY()[0]; - this.proxy.setWidth((cursorX-this.hdX).constrain(this.minWidth, this.maxWidth)); - }, + initComponent: function() { + var me = this, + baseCls = me.baseCls; - onEnd: function(e){ - /* calculate desired width by measuring proxy and then remove it */ - var nw = this.proxy.getWidth(); - this.proxy.remove(); + me.callParent(); - var index = this.hdIndex, - vw = this.view, - cs = vw.columns, - len = cs.length, - w = this.view.innerHd.getWidth(), - minPct = this.minPct * 100, - pct = Math.ceil((nw * vw.maxWidth) / w), - diff = (cs[index].width * 100) - pct, - eachItem = Math.floor(diff / (len-1-index)), - mod = diff - (eachItem * (len-1-index)); - - for(var i = index+1; i < len; i++){ - var cw = (cs[i].width * 100) + eachItem, - ncw = Math.max(minPct, cw); - if(cw != ncw){ - mod += cw - ncw; - } - cs[i].width = ncw / 100; - } - cs[index].width = pct / 100; - cs[index+1].width += (mod / 100); - delete this.dragHd; - vw.setHdWidths(); - vw.refresh(); - setTimeout(function(){ - vw.disableHeaders = false; - }, 100); - } -}); + // Create the Legend component if needed + me.initLegend(); -// Backwards compatibility alias -Ext.ListView.ColumnResizer = Ext.list.ColumnResizer;/** - * @class Ext.list.Sorter - * @extends Ext.util.Observable - *Supporting Class for Ext.list.ListView
- * @constructor - * @param {Object} config - */ -Ext.list.Sorter = Ext.extend(Ext.util.Observable, { - /** - * @cfg {Array} sortClasses - * The CSS classes applied to a header when it is sorted. (defaults to ["sort-asc", "sort-desc"]) - */ - sortClasses : ["sort-asc", "sort-desc"], + // Add body el selector + Ext.applyIf(me.renderSelectors, { + body: '.' + baseCls + '-body' + }); - constructor: function(config){ - Ext.apply(this, config); - Ext.list.Sorter.superclass.constructor.call(this); + if (me.collapsed) { + me.addCls(baseCls + '-collapsed'); + me.collapse(); + } }, - init : function(listView){ - this.view = listView; - listView.on('render', this.initEvents, this); + // private + onRender: function(container, position) { + this.callParent(arguments); + // Make sure the legend is created and rendered + this.initLegend(); }, - initEvents : function(view){ - view.mon(view.innerHd, 'click', this.onHdClick, this); - view.innerHd.setStyle('cursor', 'pointer'); - view.mon(view.store, 'datachanged', this.updateSortState, this); - this.updateSortState.defer(10, this, [view.store]); - }, + /** + * @private + * Initialize and render the legend component if necessary + */ + initLegend: function() { + var me = this, + legendItems, + legend = me.legend; - updateSortState : function(store){ - var state = store.getSortState(); - if(!state){ - return; - } - this.sortState = state; - var cs = this.view.columns, sortColumn = -1; - for(var i = 0, len = cs.length; i < len; i++){ - if(cs[i].dataIndex == state.field){ - sortColumn = i; - break; + // Create the legend component if needed and it hasn't been already + if (!legend && (me.title || me.checkboxToggle || me.collapsible)) { + legendItems = []; + + // Checkbox + if (me.checkboxToggle) { + legendItems.push(me.createCheckboxCmp()); + } + // Toggle button + else if (me.collapsible) { + legendItems.push(me.createToggleCmp()); } - } - if(sortColumn != -1){ - var sortDir = state.direction; - this.updateSortIcon(sortColumn, sortDir); - } - }, - updateSortIcon : function(col, dir){ - var sc = this.sortClasses; - var hds = this.view.innerHd.select('em').removeClass(sc); - hds.item(col).addClass(sc[dir == "DESC" ? 1 : 0]); - }, + // Title + legendItems.push(me.createTitleCmp()); - onHdClick : function(e){ - var hd = e.getTarget('em', 3); - if(hd && !this.view.disableHeaders){ - var index = this.view.findHeaderIndex(hd); - this.view.store.sort(this.view.columns[index].dataIndex); + legend = me.legend = Ext.create('Ext.container.Container', { + baseCls: me.baseCls + '-header', + ariaRole: '', + getElConfig: function(){ + return {tag: 'legend', cls: this.baseCls}; + }, + items: legendItems + }); } - } -}); -// Backwards compatibility alias -Ext.ListView.Sorter = Ext.list.Sorter;/** - * @class Ext.TabPanel - *A basic tab container. TabPanels can be used exactly like a standard {@link Ext.Panel} - * for layout purposes, but also have special support for containing child Components - * ({@link Ext.Container#items items}) that are managed using a - * {@link Ext.layout.CardLayout 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 header/footer elements
- *TabPanels use their {@link Ext.Panel#header header} or {@link Ext.Panel#footer 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#tools tools}.
- *To display a header, embed the TabPanel in a {@link Ext.Panel Panel} which uses - * {@link Ext.Container#layout layout:'fit'}.
- * - *Tab Events
- *There is no actual tab class — each tab is simply a {@link Ext.BoxComponent Component} - * such as a {@link Ext.Panel Panel}. However, when rendered in a TabPanel, each child Component - * can fire additional events that only exist for tabs and are not available from other Components. - * These events are:
- *- *- *
- {@link Ext.Panel#activate activate} : Fires when this Component becomes - * the active tab.
- *- {@link Ext.Panel#deactivate deactivate} : Fires when the Component that - * was the active tab becomes deactivated.
- *- {@link Ext.Panel#beforeclose beforeclose} : Fires when the user clicks on the close tool of a closeable tab. - * May be vetoed by returning
- *false
from a handler.- {@link Ext.Panel#close close} : Fires a closeable tab has been closed by the user.
- *Creating TabPanels from Code
- *TabPanels can be created and rendered completely in code, as in this example:
- *- *-var tabs = new Ext.TabPanel({ - renderTo: Ext.getBody(), - activeTab: 0, - items: [{ - title: 'Tab 1', - html: 'A simple tab' - },{ - title: 'Tab 2', - html: 'Another one' - }] -}); -
Creating TabPanels from Existing Markup
- *TabPanels can also be rendered from pre-existing markup in a couple of ways.
- *- * - * @extends Ext.Panel - * @constructor - * @param {Object} config The configuration options - * @xtype tabpanel - */ -Ext.TabPanel = Ext.extend(Ext.Panel, { /** - * @cfg {Boolean} layoutOnTabChange - * Set to true to force a layout of the active tab when the tab is changed. Defaults to false. - * See {@link Ext.layout.CardLayout}.- * - *
- Pre-Structured Markup
- *- *- * - *A container div with one or more nested tab divs with class 'x-tab' can be rendered entirely - * from existing markup (See the {@link #autoTabs} example).
- *- Un-Structured Markup
- *- *- * - *A TabPanel can also be rendered from markup that is not strictly structured by simply specifying by id - * which elements should be the container and the tabs. Using this method tab content can be pulled from different - * elements within the page by id regardless of page structure. For example:
- *- * Note that the tab divs in this example contain the class 'x-hide-display' so that they can be rendered - * deferred without displaying outside the tabs. You could alternately set {@link #deferredRender} = false - * to render all content tabs on page load. - *-var tabs = new Ext.TabPanel({ - renderTo: 'my-tabs', - activeTab: 0, - items:[ - {contentEl:'tab1', title:'Tab 1'}, - {contentEl:'tab2', title:'Tab 2'} - ] -}); + // Make sure legend is rendered if the fieldset is rendered + if (legend && !legend.rendered && me.rendered) { + me.legend.render(me.el, me.body); //insert before body element + } + }, -// Note that the tabs do not have to be nested within the container (although they can be) -<div id="my-tabs"></div> -<div id="tab1" class="x-hide-display">A simple tab</div> -<div id="tab2" class="x-hide-display">Another one</div> -
{@link Ext.layout.CardLayout#layoutOnCardChange layoutOnCardChange}
. + * @protected + * Creates the legend title component. This is only called internally, but could be overridden in subclasses + * to customize the title component. + * @return Ext.Component */ + createTitleCmp: function() { + var me = this; + me.titleCmp = Ext.create('Ext.Component', { + html: me.title, + cls: me.baseCls + '-header-text' + }); + return me.titleCmp; + + }, + /** - * @cfg {String} tabCls This config option is used on child Components of ths TabPanel. A CSS - * class name applied to the tab strip item representing the child Component, allowing special - * styling to be applied. + * @property checkboxCmp + * @type Ext.form.field.Checkbox + * Refers to the {@link Ext.form.field.Checkbox} component that is added next to the title in the legend. Only + * populated if the fieldset is configured with {@link #checkboxToggle}:true. */ + /** - * @cfg {Boolean} deferredRender - *true by default to defer the rendering of child {@link Ext.Container#items items} - * to the browsers DOM until a tab is activated. false will render all contained - * {@link Ext.Container#items items} as soon as the {@link Ext.layout.CardLayout 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.CardLayout}) as its {@link Ext.layout.CardLayout#deferredRender} - * configuration value.
- *Note: leaving deferredRender as true means that the content - * within an unactivated tab will not be available. For example, this means that if the TabPanel - * is within a {@link Ext.form.FormPanel form}, then until a tab is activated, any Fields within - * unactivated tabs will not be rendered, and will therefore not be submitted and will not be - * available to either {@link Ext.form.BasicForm#getValues getValues} or - * {@link Ext.form.BasicForm#setValues setValues}.
+ * @protected + * Creates the checkbox component. This is only called internally, but could be overridden in subclasses + * to customize the checkbox's configuration or even return an entirely different component type. + * @return Ext.Component */ - deferredRender : true, + createCheckboxCmp: function() { + var me = this, + suffix = '-checkbox'; + + me.checkboxCmp = Ext.create('Ext.form.field.Checkbox', { + name: me.checkboxName || me.id + suffix, + cls: me.baseCls + '-header' + suffix, + checked: !me.collapsed, + listeners: { + change: me.onCheckChange, + scope: me + } + }); + return me.checkboxCmp; + }, + /** - * @cfg {Number} tabWidth The initial width in pixels of each new tab (defaults to 120). + * @property toggleCmp + * @type Ext.panel.Tool + * Refers to the {@link Ext.panel.Tool} component that is added as the collapse/expand button next + * to the title in the legend. Only populated if the fieldset is configured with {@link #collapsible}:true. */ - tabWidth : 120, + /** - * @cfg {Number} minTabWidth The minimum width in pixels for each tab when {@link #resizeTabs} = true (defaults to 30). + * @protected + * Creates the toggle button component. This is only called internally, but could be overridden in + * subclasses to customize the toggle component. + * @return Ext.Component */ - minTabWidth : 30, + createToggleCmp: function() { + var me = this; + me.toggleCmp = Ext.create('Ext.panel.Tool', { + type: 'toggle', + handler: me.toggle, + scope: me + }); + return me.toggleCmp; + }, + /** - * @cfg {Boolean} resizeTabs True to automatically resize each tab so that the tabs will completely fill the - * tab strip (defaults to false). Setting this to true may cause specific widths that might be set per tab to - * be overridden in order to fit them all into view (although {@link #minTabWidth} will always be honored). + * Sets the title of this fieldset + * @param {String} title The new title + * @return {Ext.form.FieldSet} this */ - resizeTabs : false, + setTitle: function(title) { + var me = this; + me.title = title; + me.initLegend(); + me.titleCmp.update(title); + return me; + }, + + getTargetEl : function() { + return this.body || this.frameBody || this.el; + }, + + getContentTarget: function() { + return this.body; + }, + /** - * @cfg {Boolean} enableTabScroll True to enable scrolling to tabs that may be invisible due to overflowing the - * overall TabPanel width. Only available with tabPosition:'top' (defaults to false). + * @private + * Include the legend component in the items for ComponentQuery */ - enableTabScroll : false, + getRefItems: function(deep) { + var refItems = this.callParent(arguments), + legend = this.legend; + + // Prepend legend items to ensure correct order + if (legend) { + refItems.unshift(legend); + if (deep) { + refItems.unshift.apply(refItems, legend.getRefItems(true)); + } + } + return refItems; + }, + /** - * @cfg {Number} scrollIncrement The number of pixels to scroll each time a tab scroll button is pressed - * (defaults to 100, or if {@link #resizeTabs} = true, the calculated tab width). Only - * applies when {@link #enableTabScroll} = true. + * Expands the fieldset. + * @return {Ext.form.FieldSet} this */ - scrollIncrement : 0, + expand : function(){ + return this.setExpanded(true); + }, + /** - * @cfg {Number} scrollRepeatInterval Number of milliseconds between each scroll while a tab scroll button is - * continuously pressed (defaults to 400). + * Collapses the fieldset. + * @return {Ext.form.FieldSet} this */ - scrollRepeatInterval : 400, + collapse : function() { + return this.setExpanded(false); + }, + /** - * @cfg {Float} scrollDuration The number of milliseconds that each scroll animation should last (defaults - * to .35). Only applies when {@link #animScroll} = true. + * @private Collapse or expand the fieldset */ - scrollDuration : 0.35, + setExpanded: function(expanded) { + var me = this, + checkboxCmp = me.checkboxCmp; + + expanded = !!expanded; + + if (checkboxCmp) { + checkboxCmp.setValue(expanded); + } + + if (expanded) { + me.removeCls(me.baseCls + '-collapsed'); + } else { + me.addCls(me.baseCls + '-collapsed'); + } + me.collapsed = !expanded; + if (expanded) { + // ensure subitems will get rendered and layed out when expanding + me.getComponentLayout().childrenChanged = true; + } + me.doComponentLayout(); + return me; + }, + /** - * @cfg {Boolean} animScroll True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults - * to true). Only applies when {@link #enableTabScroll} = true. + * Toggle the fieldset's collapsed state to the opposite of what it is currently */ - animScroll : true, + toggle: function() { + this.setExpanded(!!this.collapsed); + }, + /** - * @cfg {String} tabPosition The position where the tab strip should be rendered (defaults to 'top'). - * The only other supported value is 'bottom'. Note: tab scrolling is only supported for - * tabPosition: 'top'. + * @private Handle changes in the checkbox checked state */ - tabPosition : 'top', - /** - * @cfg {String} baseCls The base CSS class applied to the panel (defaults to 'x-tab-panel'). - */ - baseCls : 'x-tab-panel', - /** - * @cfg {Boolean} autoTabs - *true to query the DOM for any divs with a class of 'x-tab' to be automatically converted - * to tabs and added to this panel (defaults to false). Note that the query will be executed within - * the scope of the container element only (so that multiple tab panels from markup can be supported via this - * method).
- *This method is only possible when the markup is structured correctly as a container with nested divs - * containing the class 'x-tab'. To create TabPanels without these limitations, or to pull tab content - * from other elements on the page, see the example at the top of the class for generating tabs from markup.
- *There are a couple of things to note when using this method:
- *
Example usage: - *- When using the autoTabs config (as opposed to passing individual tab configs in the TabPanel's - * {@link #items} collection), you must use {@link #applyTo} to correctly use the specified id - * as the tab container. The autoTabs method replaces existing content with the TabPanel - * components.
- *- Make sure that you set {@link #deferredRender}: false so that the content elements for each - * tab will be rendered into the TabPanel immediately upon page load, otherwise they will not be transformed - * until each tab is activated and will be visible outside the TabPanel.
- *- */ - autoTabs : false, - /** - * @cfg {String} autoTabSelector The CSS selector used to search for tabs in existing markup when - * {@link #autoTabs} = true (defaults to 'div.x-tab'). This can be any valid selector - * supported by {@link Ext.DomQuery#select}. Note that the query will be executed within the scope of this - * tab panel only (so that multiple tab panels from markup can be supported on a page). - */ - autoTabSelector : 'div.x-tab', - /** - * @cfg {String/Number} activeTab A string id or the numeric index of the tab that should be initially - * activated on render (defaults to undefined). - */ - activeTab : undefined, +/** + * @class Ext.form.Label + * @extends Ext.Component + +Produces a standalone `` element which can be inserted into a form and be associated with a field +in that form using the {@link #forId} property. + +**NOTE:** in most cases it will be more appropriate to use the {@link Ext.form.Labelable#fieldLabel fieldLabel} +and associated config properties ({@link Ext.form.Labelable#labelAlign}, {@link Ext.form.Labelable#labelWidth}, +etc.) in field components themselves, as that allows labels to be uniformly sized throughout the form. +Ext.form.Label should only be used when your layout can not be achieved with the standard +{@link Ext.form.Labelable field layout}. + +You will likely be associating the label with a field component that extends {@link Ext.form.field.Base}, so +you should make sure the {@link #forId} is set to the same value as the {@link Ext.form.field.Base#inputId inputId} +of that field. + +The label's text can be set using either the {@link #text} or {@link #html} configuration properties; the +difference between the two is that the former will automatically escape HTML characters when rendering, while +the latter will not. +{@img Ext.form.Label/Ext.form.Label.png Ext.form.Label component} +#Example usage:# + +This example creates a Label after its associated Text field, an arrangement that cannot currently +be achieved using the standard Field layout's labelAlign. + + Ext.create('Ext.form.Panel', { + title: 'Field with Label', + width: 400, + bodyPadding: 10, + renderTo: Ext.getBody(), + layout: { + type: 'hbox', + align: 'middle' + }, + items: [{ + xtype: 'textfield', + hideLabel: true, + flex: 1 + }, { + xtype: 'label', + forId: 'myFieldId', + text: 'My Awesome Field', + margins: '0 0 0 10' + }] + }); + + * @markdown + * @docauthor Jason Johnston-var tabs = new Ext.TabPanel({ - applyTo: 'my-tabs', - activeTab: 0, - deferredRender: false, - autoTabs: true + onCheckChange: function(cmp, checked) { + this.setExpanded(checked); + }, + + beforeDestroy : function() { + var legend = this.legend; + if (legend) { + legend.destroy(); + } + this.callParent(); + } }); -// This markup will be converted to a TabPanel from the code above -<div id="my-tabs"> - <div class="x-tab" title="Tab 1">A simple tab</div> - <div class="x-tab" title="Tab 2">Another one</div> -</div> -
+ */ +Ext.define('Ext.form.Label', { + extend:'Ext.Component', + alias: 'widget.label', + requires: ['Ext.util.Format'], + /** - * @cfg {Number} tabMargin The number of pixels of space to calculate into the sizing and scrolling of - * tabs. If you change the margin in CSS, you will need to update this value so calculations are correct - * with either {@link #resizeTabs} or scrolling tabs. (defaults to 2) + * @cfg {String} text The plain text to display within the label (defaults to ''). If you need to include HTML + * tags within the label's innerHTML, use the {@link #html} config instead. */ - tabMargin : 2, /** - * @cfg {Boolean} plain true to render the tab strip without a background container image - * (defaults to false). + * @cfg {String} forId The id of the input element to which this label will be bound via the standard HTML 'for' + * attribute. If not specified, the attribute will not be added to the label. In most cases you will be + * associating the label with a {@link Ext.form.field.Base} component, so you should make sure this matches + * the {@link Ext.form.field.Base#inputId inputId} of that field. */ - plain : false, /** - * @cfg {Number} wheelIncrement For scrolling tabs, the number of pixels to increment on mouse wheel - * scrolling (defaults to 20). + * @cfg {String} html An HTML fragment that will be used as the label's innerHTML (defaults to ''). + * Note that if {@link #text} is specified it will take precedence and this value will be ignored. */ - wheelIncrement : 20, + + maskOnDisable: false, + getElConfig: function(){ + var me = this; + return { + tag: 'label', + id: me.id, + htmlFor: me.forId || '', + html: me.text ? Ext.util.Format.htmlEncode(me.text) : (me.html || '') + }; + }, - /* - * This is a protected property used when concatenating tab ids to the TabPanel id for internal uniqueness. - * It does not generally need to be changed, but can be if external code also uses an id scheme that can - * potentially clash with this one. + /** + * Updates the label's innerHTML with the specified string. + * @param {String} text The new label text + * @param {Boolean} encode (optional) False to skip HTML-encoding the text when rendering it + * to the label (defaults to true which encodes the value). This might be useful if you want to include + * tags in the label's innerHTML rather than rendering them as string literals per the default logic. + * @return {Label} this */ - idDelimiter : '__', - - // private - itemCls : 'x-tab-item', - - // private config overrides - elements : 'body', - headerAsText : false, - frame : false, - hideBorders :true, - - // private - initComponent : function(){ - this.frame = false; - Ext.TabPanel.superclass.initComponent.call(this); - this.addEvents( - /** - * @event beforetabchange - * Fires before the active tab changes. Handlers can return false to cancel the tab change. - * @param {TabPanel} this - * @param {Panel} newTab The tab being activated - * @param {Panel} currentTab The current active tab - */ - 'beforetabchange', - /** - * @event tabchange - * Fires after the active tab has changed. - * @param {TabPanel} this - * @param {Panel} tab The new active tab - */ - 'tabchange', - /** - * @event contextmenu - * Relays the contextmenu event from a tab selector element in the tab strip. - * @param {TabPanel} this - * @param {Panel} tab The target tab - * @param {EventObject} e - */ - 'contextmenu' - ); - /** - * @cfg {Object} layoutConfig - * TabPanel implicitly uses {@link Ext.layout.CardLayout} as its layout manager. - * layoutConfig
may be used to configure this layout manager. - *{@link #deferredRender}
and{@link #layoutOnTabChange}
- * configured on the TabPanel will be applied as configs to the layout manager. - */ - this.setLayout(new Ext.layout.CardLayout(Ext.apply({ - layoutOnCardChange: this.layoutOnTabChange, - deferredRender: this.deferredRender - }, this.layoutConfig))); - - if(this.tabPosition == 'top'){ - this.elements += ',header'; - this.stripTarget = 'header'; - }else { - this.elements += ',footer'; - this.stripTarget = 'footer'; + setText : function(text, encode){ + var me = this; + + encode = encode !== false; + if(encode) { + me.text = text; + delete me.html; + } else { + me.html = text; + delete me.text; } - if(!this.stack){ - this.stack = Ext.TabPanel.AccessStack(); + + if(me.rendered){ + me.el.dom.innerHTML = encode !== false ? Ext.util.Format.htmlEncode(text) : text; } - this.initItems(); - }, + return this; + } +}); - // private - onRender : function(ct, position){ - Ext.TabPanel.superclass.onRender.call(this, ct, position); - if(this.plain){ - var pos = this.tabPosition == 'top' ? 'header' : 'footer'; - this[pos].addClass('x-tab-panel-'+pos+'-plain'); - } +/** + * @class Ext.form.Panel + * @extends Ext.panel.Panel - var st = this[this.stripTarget]; +FormPanel provides a standard container for forms. It is essentially a standard {@link Ext.panel.Panel} which +automatically creates a {@link Ext.form.Basic BasicForm} for managing any {@link Ext.form.field.Field} +objects that are added as descendants of the panel. It also includes conveniences for configuring and +working with the BasicForm and the collection of Fields. - this.stripWrap = st.createChild({cls:'x-tab-strip-wrap', cn:{ - tag:'ul', cls:'x-tab-strip x-tab-strip-'+this.tabPosition}}); +__Layout__ - var beforeEl = (this.tabPosition=='bottom' ? this.stripWrap : null); - st.createChild({cls:'x-tab-strip-spacer'}, beforeEl); - this.strip = new Ext.Element(this.stripWrap.dom.firstChild); +By default, FormPanel is configured with `{@link Ext.layout.container.Anchor layout:'anchor'}` for +the layout of its immediate child items. This can be changed to any of the supported container layouts. +The layout of sub-containers is configured in {@link Ext.container.Container#layout the standard way}. - // create an empty span with class x-tab-strip-text to force the height of the header element when there's no tabs. - this.edge = this.strip.createChild({tag:'li', cls:'x-tab-edge', cn: [{tag: 'span', cls: 'x-tab-strip-text', cn: ' '}]}); - this.strip.createChild({cls:'x-clear'}); +__BasicForm__ - this.body.addClass('x-tab-panel-body-'+this.tabPosition); +Although **not listed** as configuration options of FormPanel, the FormPanel class accepts all +of the config options supported by the {@link Ext.form.Basic} class, and will pass them along to +the internal BasicForm when it is created. - /** - * @cfg {Template/XTemplate} itemTpl(Optional) A {@link Ext.Template Template} or - * {@link Ext.XTemplate XTemplate} which may be provided to process the data object returned from - * {@link #getTemplateArgs} to produce a clickable selector element in the tab strip.
- *The main element created should be a <li> element. In order for a click event on - * a selector element to be connected to its item, it must take its id from the TabPanel's - * native {@link #getTemplateArgs}.
- *The child element which contains the title text must be marked by the CSS class - * x-tab-strip-inner.
- *To enable closability, the created element should contain an element marked by the CSS class - * x-tab-strip-close.
- *If a custom itemTpl is supplied, it is the developer's responsibility to create CSS - * style rules to create the desired appearance.
- * Below is an example of how to create customized tab selector items:- */ - if(!this.itemTpl){ - var tt = new Ext.Template( - '-new Ext.TabPanel({ - renderTo: document.body, - minTabWidth: 115, - tabWidth: 135, - enableTabScroll: true, - width: 600, - height: 250, - defaults: {autoScroll:true}, - itemTpl: new Ext.XTemplate( - '<li class="{cls}" id="{id}" style="overflow:hidden">', - '<tpl if="closable">', - '<a class="x-tab-strip-close"></a>', - '</tpl>', - '<a class="x-tab-right" href="#" style="padding-left:6px">', - '<em class="x-tab-left">', - '<span class="x-tab-strip-inner">', - '<img src="{src}" style="float:left;margin:3px 3px 0 0">', - '<span style="margin-left:20px" class="x-tab-strip-text {iconCls}">{text} {extra}</span>', - '</span>', - '</em>', - '</a>', - '</li>' - ), - getTemplateArgs: function(item) { -// Call the native method to collect the base data. Like the ID! - var result = Ext.TabPanel.prototype.getTemplateArgs.call(this, item); - -// Add stuff used in our template - return Ext.apply(result, { - closable: item.closable, - src: item.iconSrc, - extra: item.extraText || '' - }); - }, - items: [{ - title: 'New Tab 1', - iconSrc: '../shared/icons/fam/grid.png', - html: 'Tab Body 1', - closable: true - }, { - title: 'New Tab 2', - iconSrc: '../shared/icons/fam/grid.png', - html: 'Tab Body 2', - extraText: 'Extra stuff in the tab button' - }] -}); -
', - '', - '{text}', - ' ' - ); - tt.disableFormats = true; - tt.compile(); - Ext.TabPanel.prototype.itemTpl = tt; - } +**Note**: If subclassing FormPanel, any configuration options for the BasicForm must be applied to +the `initialConfig` property of the FormPanel. Applying {@link Ext.form.Basic BasicForm} +configuration settings to `this` will *not* affect the BasicForm's configuration. - this.items.each(this.initTab, this); - }, +The following events fired by the BasicForm will be re-fired by the FormPanel and can therefore be +listened for on the FormPanel itself: - // private - afterRender : function(){ - Ext.TabPanel.superclass.afterRender.call(this); - if(this.autoTabs){ - this.readTabs(false); - } - if(this.activeTab !== undefined){ - var item = Ext.isObject(this.activeTab) ? this.activeTab : this.items.get(this.activeTab); - delete this.activeTab; - this.setActiveTab(item); - } - }, +- {@link Ext.form.Basic#beforeaction beforeaction} +- {@link Ext.form.Basic#actionfailed actionfailed} +- {@link Ext.form.Basic#actioncomplete actioncomplete} +- {@link Ext.form.Basic#validitychange validitychange} +- {@link Ext.form.Basic#dirtychange dirtychange} - // private - initEvents : function(){ - Ext.TabPanel.superclass.initEvents.call(this); - this.mon(this.strip, { - scope: this, - mousedown: this.onStripMouseDown, - contextmenu: this.onStripContextMenu - }); - if(this.enableTabScroll){ - this.mon(this.strip, 'mousewheel', this.onWheel, this); - } - }, +__Field Defaults__ - // private - findTargets : function(e){ - var item = null, - itemEl = e.getTarget('li:not(.x-tab-edge)', this.strip); +The {@link #fieldDefaults} config option conveniently allows centralized configuration of default values +for all fields added as descendants of the FormPanel. Any config option recognized by implementations +of {@link Ext.form.Labelable} may be included in this object. See the {@link #fieldDefaults} documentation +for details of how the defaults are applied. - if(itemEl){ - item = this.getComponent(itemEl.id.split(this.idDelimiter)[1]); - if(item.disabled){ - return { - close : null, - item : null, - el : null - }; - } - } - return { - close : e.getTarget('.x-tab-strip-close', this.strip), - item : item, - el : itemEl - }; - }, +__Form Validation__ - // private - onStripMouseDown : function(e){ - if(e.button !== 0){ - return; - } - e.preventDefault(); - var t = this.findTargets(e); - if(t.close){ - if (t.item.fireEvent('beforeclose', t.item) !== false) { - t.item.fireEvent('close', t.item); - this.remove(t.item); - } - return; - } - if(t.item && t.item != this.activeTab){ - this.setActiveTab(t.item); - } - }, +With the default configuration, form fields are validated on-the-fly while the user edits their values. +This can be controlled on a per-field basis (or via the {@link #fieldDefaults} config) with the field +config properties {@link Ext.form.field.Field#validateOnChange} and {@link Ext.form.field.Base#checkChangeEvents}, +and the FormPanel's config properties {@link #pollForChanges} and {@link #pollInterval}. - // private - onStripContextMenu : function(e){ - e.preventDefault(); - var t = this.findTargets(e); - if(t.item){ - this.fireEvent('contextmenu', this, t.item, e); - } - }, +Any component within the FormPanel can be configured with `formBind: true`. This will cause that +component to be automatically disabled when the form is invalid, and enabled when it is valid. This is most +commonly used for Button components to prevent submitting the form in an invalid state, but can be used on +any component type. - /** - * True to scan the markup in this tab panel for {@link #autoTabs} using the - * {@link #autoTabSelector} - * @param {Boolean} removeExisting True to remove existing tabs - */ - readTabs : function(removeExisting){ - if(removeExisting === true){ - this.items.each(function(item){ - this.remove(item); - }, this); - } - var tabs = this.el.query(this.autoTabSelector); - for(var i = 0, len = tabs.length; i < len; i++){ - var tab = tabs[i], - title = tab.getAttribute('title'); - tab.removeAttribute('title'); - this.add({ - title: title, - contentEl: tab - }); - } - }, +For more information on form validation see the following: - // private - initTab : function(item, index){ - var before = this.strip.dom.childNodes[index], - p = this.getTemplateArgs(item), - el = before ? - this.itemTpl.insertBefore(before, p) : - this.itemTpl.append(this.strip, p), - cls = 'x-tab-strip-over', - tabEl = Ext.get(el); - - tabEl.hover(function(){ - if(!item.disabled){ - tabEl.addClass(cls); - } - }, function(){ - tabEl.removeClass(cls); - }); +- {@link Ext.form.field.Field#validateOnChange} +- {@link #pollForChanges} and {@link #pollInterval} +- {@link Ext.form.field.VTypes} +- {@link Ext.form.Basic#doAction BasicForm.doAction clientValidation notes} - if(item.tabTip){ - tabEl.child('span.x-tab-strip-text', true).qtip = item.tabTip; - } - item.tabEl = el; +__Form Submission__ - // Route *keyboard triggered* click events to the tab strip mouse handler. - tabEl.select('a').on('click', function(e){ - if(!e.getPageX()){ - this.onStripMouseDown(e); +By default, Ext Forms are submitted through Ajax, using {@link Ext.form.action.Action}. See the documentation for +{@link Ext.form.Basic} for details. +{@img Ext.form.FormPanel/Ext.form.FormPanel.png Ext.form.FormPanel FormPanel component} +__Example usage:__ + + Ext.create('Ext.form.Panel', { + title: 'Simple Form', + bodyPadding: 5, + width: 350, + + // The form will submit an AJAX request to this URL when submitted + url: 'save-form.php', + + // Fields will be arranged vertically, stretched to full width + layout: 'anchor', + defaults: { + anchor: '100%' + }, + + // The fields + defaultType: 'textfield', + items: [{ + fieldLabel: 'First Name', + name: 'first', + allowBlank: false + },{ + fieldLabel: 'Last Name', + name: 'last', + allowBlank: false + }], + + // Reset and Submit buttons + buttons: [{ + text: 'Reset', + handler: function() { + this.up('form').getForm().reset(); + } + }, { + text: 'Submit', + formBind: true, //only enabled once the form is valid + disabled: true, + handler: function() { + var form = this.up('form').getForm(); + if (form.isValid()) { + form.submit({ + success: function(form, action) { + Ext.Msg.alert('Success', action.result.msg); + }, + failure: function(form, action) { + Ext.Msg.alert('Failed', action.result.msg); + } + }); + } } - }, this, {preventDefault: true}); + }], + renderTo: Ext.getBody() + }); - item.on({ - scope: this, - disable: this.onItemDisabled, - enable: this.onItemEnabled, - titlechange: this.onItemTitleChanged, - iconchange: this.onItemIconChanged, - beforeshow: this.onBeforeShowItem - }); + * + * @markdown + * @docauthor Jason Johnston+ */ +Ext.define('Ext.form.Panel', { + extend:'Ext.panel.Panel', + mixins: { + fieldAncestor: 'Ext.form.FieldAncestor' }, + alias: 'widget.form', + alternateClassName: ['Ext.FormPanel', 'Ext.form.FormPanel'], + requires: ['Ext.form.Basic', 'Ext.util.TaskRunner'], + /** + * @cfg {Boolean} pollForChanges + * If set to true, sets up an interval task (using the {@link #pollInterval}) in which the + * panel's fields are repeatedly checked for changes in their values. This is in addition to the normal detection + * each field does on its own input element, and is not needed in most cases. It does, however, provide a + * means to absolutely guarantee detection of all changes including some edge cases in some browsers which + * do not fire native events. Defaults to false. + */ + /** + * @cfg {Number} pollInterval + * Interval in milliseconds at which the form's fields are checked for value changes. Only used if + * the {@link #pollForChanges} option is set to true. Defaults to 500 milliseconds. + */ /** - * Provides template arguments for rendering a tab selector item in the tab strip.
- *This method returns an object hash containing properties used by the TabPanel's {@link #itemTpl} - * to create a formatted, clickable tab selector element. The properties which must be returned - * are:
- * @param {Ext.BoxComponent} item The {@link Ext.BoxComponent BoxComponent} for which to create a selector element in the tab strip. - * @return {Object} An object hash containing the properties required to render the selector element. + * @cfg {String} layout The {@link Ext.container.Container#layout} for the form panel's immediate child items. + * Defaults to 'anchor'. */ - getTemplateArgs : function(item) { - var cls = item.closable ? 'x-tab-strip-closable' : ''; - if(item.disabled){ - cls += ' x-item-disabled'; - } - if(item.iconCls){ - cls += ' x-tab-with-icon'; - } - if(item.tabCls){ - cls += ' ' + item.tabCls; - } + layout: 'anchor', - return { - id: this.id + this.idDelimiter + item.getItemId(), - text: item.title, - cls: cls, - iconCls: item.iconCls || '' - }; - }, + ariaRole: 'form', - // private - onAdd : function(c){ - Ext.TabPanel.superclass.onAdd.call(this, c); - if(this.rendered){ - var items = this.items; - this.initTab(c, items.indexOf(c)); - this.delegateUpdates(); + initComponent: function() { + var me = this; + + if (me.frame) { + me.border = false; } - }, + + me.initFieldAncestor(); + me.callParent(); - // private - onBeforeAdd : function(item){ - var existing = item.events ? (this.items.containsKey(item.getItemId()) ? item : null) : this.items.get(item); - if(existing){ - this.setActiveTab(item); - return false; - } - Ext.TabPanel.superclass.onBeforeAdd.apply(this, arguments); - var es = item.elements; - item.elements = es ? es.replace(',header', '') : es; - item.border = (item.border === true); - }, + me.relayEvents(me.form, [ + 'beforeaction', + 'actionfailed', + 'actioncomplete', + 'validitychange', + 'dirtychange' + ]); - // private - onRemove : function(c){ - var te = Ext.get(c.tabEl); - // check if the tabEl exists, it won't if the tab isn't rendered - if(te){ - te.select('a').removeAllListeners(); - Ext.destroy(te); - } - Ext.TabPanel.superclass.onRemove.call(this, c); - this.stack.remove(c); - delete c.tabEl; - c.un('disable', this.onItemDisabled, this); - c.un('enable', this.onItemEnabled, this); - c.un('titlechange', this.onItemTitleChanged, this); - c.un('iconchange', this.onItemIconChanged, this); - c.un('beforeshow', this.onBeforeShowItem, this); - if(c == this.activeTab){ - var next = this.stack.next(); - if(next){ - this.setActiveTab(next); - }else if(this.items.getCount() > 0){ - this.setActiveTab(0); - }else{ - this.setActiveTab(null); - } - } - if(!this.destroying){ - this.delegateUpdates(); + // Start polling if configured + if (me.pollForChanges) { + me.startPolling(me.pollInterval || 500); } }, - // private - onBeforeShowItem : function(item){ - if(item != this.activeTab){ - this.setActiveTab(item); - return false; - } + initItems: function() { + // Create the BasicForm + var me = this; + + me.form = me.createForm(); + me.callParent(); + me.form.initialize(); }, - // private - onItemDisabled : function(item){ - var el = this.getTabEl(item); - if(el){ - Ext.fly(el).addClass('x-item-disabled'); - } - this.stack.remove(item); + /** + * @private + */ + createForm: function() { + return Ext.create('Ext.form.Basic', this, Ext.applyIf({listeners: {}}, this.initialConfig)); }, - // private - onItemEnabled : function(item){ - var el = this.getTabEl(item); - if(el){ - Ext.fly(el).removeClass('x-item-disabled'); - } + /** + * Provides access to the {@link Ext.form.Basic Form} which this Panel contains. + * @return {Ext.form.Basic} The {@link Ext.form.Basic Form} which this Panel contains. + */ + getForm: function() { + return this.form; }, - - // private - onItemTitleChanged : function(item){ - var el = this.getTabEl(item); - if(el){ - Ext.fly(el).child('span.x-tab-strip-text', true).innerHTML = item.title; - } + + /** + * Loads an {@link Ext.data.Model} into this form (internally just calls {@link Ext.form.Basic#loadRecord}) + * See also {@link #trackResetOnLoad}. + * @param {Ext.data.Model} record The record to load + * @return {Ext.form.Basic} The Ext.form.Basic attached to this FormPanel + */ + loadRecord: function(record) { + return this.getForm().loadRecord(record); }, - - //private - onItemIconChanged : function(item, iconCls, oldCls){ - var el = this.getTabEl(item); - if(el){ - el = Ext.get(el); - el.child('span.x-tab-strip-text').replaceClass(oldCls, iconCls); - el[Ext.isEmpty(iconCls) ? 'removeClass' : 'addClass']('x-tab-with-icon'); - } + + /** + * Returns the currently loaded Ext.data.Model instance if one was loaded via {@link #loadRecord}. + * @return {Ext.data.Model} The loaded instance + */ + getRecord: function() { + return this.getForm().getRecord(); }, - + /** - * Gets the DOM element for the tab strip item which activates the child panel with the specified - * ID. Access this to change the visual treatment of the item, for example by changing the CSS class name. - * @param {Panel/Number/String} tab The tab component, or the tab's index, or the tabs id or itemId. - * @return {HTMLElement} The DOM node + * Convenience function for fetching the current value of each field in the form. This is the same as calling + * {@link Ext.form.Basic#getValues this.getForm().getValues()} + * @return {Object} The current form field values, keyed by field name */ - getTabEl : function(item){ - var c = this.getComponent(item); - return c ? c.tabEl : null; + getValues: function() { + return this.getForm().getValues(); }, - // private - onResize : function(){ - Ext.TabPanel.superclass.onResize.apply(this, arguments); - this.delegateUpdates(); + beforeDestroy: function() { + this.stopPolling(); + this.form.destroy(); + this.callParent(); }, /** - * Suspends any internal calculations or scrolling while doing a bulk operation. See {@link #endUpdate} + * This is a proxy for the underlying BasicForm's {@link Ext.form.Basic#load} call. + * @param {Object} options The options to pass to the action (see {@link Ext.form.Basic#load} and + * {@link Ext.form.Basic#doAction} for details) */ - beginUpdate : function(){ - this.suspendUpdates = true; + load: function(options) { + this.form.load(options); }, /** - * Resumes calculations and scrolling at the end of a bulk operation. See {@link #beginUpdate} + * This is a proxy for the underlying BasicForm's {@link Ext.form.Basic#submit} call. + * @param {Object} options The options to pass to the action (see {@link Ext.form.Basic#submit} and + * {@link Ext.form.Basic#doAction} for details) */ - endUpdate : function(){ - this.suspendUpdates = false; - this.delegateUpdates(); + submit: function(options) { + this.form.submit(options); }, - /** - * Hides the tab strip item for the passed tab - * @param {Number/String/Panel} item The tab index, id or item + /* + * Inherit docs, not using onDisable because it only gets fired + * when the component is rendered. */ - hideTabStripItem : function(item){ - item = this.getComponent(item); - var el = this.getTabEl(item); - if(el){ - el.style.display = 'none'; - this.delegateUpdates(); - } - this.stack.remove(item); + disable: function(silent) { + this.callParent(arguments); + this.form.getFields().each(function(field) { + field.disable(); + }); }, - /** - * Unhides the tab strip item for the passed tab - * @param {Number/String/Panel} item The tab index, id or item + /* + * Inherit docs, not using onEnable because it only gets fired + * when the component is rendered. */ - unhideTabStripItem : function(item){ - item = this.getComponent(item); - var el = this.getTabEl(item); - if(el){ - el.style.display = ''; - this.delegateUpdates(); - } - }, - - // private - delegateUpdates : function(){ - if(this.suspendUpdates){ - return; - } - if(this.resizeTabs && this.rendered){ - this.autoSizeTabs(); - } - if(this.enableTabScroll && this.rendered){ - this.autoScrollTabs(); - } + enable: function(silent) { + this.callParent(arguments); + this.form.getFields().each(function(field) { + field.enable(); + }); }, - // private - autoSizeTabs : function(){ - var count = this.items.length, - ce = this.tabPosition != 'bottom' ? 'header' : 'footer', - ow = this[ce].dom.offsetWidth, - aw = this[ce].dom.clientWidth; - - if(!this.resizeTabs || count < 1 || !aw){ // !aw for display:none - return; - } - - var each = Math.max(Math.min(Math.floor((aw-4) / count) - this.tabMargin, this.tabWidth), this.minTabWidth); // -4 for float errors in IE - this.lastTabWidth = each; - var lis = this.strip.query('li:not(.x-tab-edge)'); - for(var i = 0, len = lis.length; i < len; i++) { - var li = lis[i], - inner = Ext.fly(li).child('.x-tab-strip-inner', true), - tw = li.offsetWidth, - iw = inner.offsetWidth; - inner.style.width = (each - (tw-iw)) + 'px'; - } + /** + * Start an interval task to continuously poll all the fields in the form for changes in their + * values. This is normally started automatically by setting the {@link #pollForChanges} config. + * @param {Number} interval The interval in milliseconds at which the check should run. + */ + startPolling: function(interval) { + this.stopPolling(); + var task = Ext.create('Ext.util.TaskRunner', interval); + task.start({ + interval: 0, + run: this.checkChange, + scope: this + }); + this.pollTask = task; }, - // private - adjustBodyWidth : function(w){ - if(this.header){ - this.header.setWidth(w); - } - if(this.footer){ - this.footer.setWidth(w); + /** + * Stop a running interval task that was started by {@link #startPolling}. + */ + stopPolling: function() { + var task = this.pollTask; + if (task) { + task.stopAll(); + delete this.pollTask; } - return w; }, /** - * Sets the specified tab as the active tab. This method fires the {@link #beforetabchange} event which - * can return false to cancel the tab change. - * @param {String/Number} item - * The id or tab Panel to activate. This parameter may be any of the following: - *- *
- id : String
- *A unique identifier which links to the item- text : String
- *The text to display- cls : String
- *The CSS class name- iconCls : String
- *A CSS class to provide appearance for an icon.- *- *
- a String : representing the
- *{@link Ext.Component#itemId itemId}
- * or{@link Ext.Component#id id}
of the child component- a Number : representing the position of the child component - * within the
- *{@link Ext.Container#items items}
propertyFor additional information see {@link Ext.util.MixedCollection#get}. + * Forces each field within the form panel to + * {@link Ext.form.field.Field#checkChange check if its value has changed}. */ - setActiveTab : function(item){ - item = this.getComponent(item); - if(this.fireEvent('beforetabchange', this, item, this.activeTab) === false){ - return; - } - if(!this.rendered){ - this.activeTab = item; - return; - } - if(this.activeTab != item){ - if(this.activeTab){ - var oldEl = this.getTabEl(this.activeTab); - if(oldEl){ - Ext.fly(oldEl).removeClass('x-tab-strip-active'); - } - } - this.activeTab = item; - if(item){ - var el = this.getTabEl(item); - Ext.fly(el).addClass('x-tab-strip-active'); - this.stack.add(item); + checkChange: function() { + this.form.getFields().each(function(field) { + field.checkChange(); + }); + } +}); - this.layout.setActiveItem(item); - if(this.scrolling){ - this.scrollToTab(item, this.animScroll); - } - } - this.fireEvent('tabchange', this, item); - } - }, +/** + * A {@link Ext.form.FieldContainer field container} which has a specialized layout for arranging + * {@link Ext.form.field.Radio} controls into columns, and provides convenience {@link Ext.form.field.Field} + * methods for {@link #getValue getting}, {@link #setValue setting}, and {@link #validate validating} the + * group of radio buttons as a whole. + * + * # Validation + * + * Individual radio buttons themselves have no default validation behavior, but + * sometimes you want to require a user to select one of a group of radios. RadioGroup + * allows this by setting the config `{@link #allowBlank}:false`; when the user does not check at + * one of the radio buttons, the entire group will be highlighted as invalid and the + * {@link #blankText error message} will be displayed according to the {@link #msgTarget} config.
+ * + * # Layout + * + * The default layout for RadioGroup makes it easy to arrange the radio buttons into + * columns; see the {@link #columns} and {@link #vertical} config documentation for details. You may also + * use a completely different layout by setting the {@link #layout} to one of the other supported layout + * types; for instance you may wish to use a custom arrangement of hbox and vbox containers. In that case + * the Radio components at any depth will still be managed by the RadioGroup's validation. + * + * {@img Ext.form.RadioGroup/Ext.form.RadioGroup.png Ext.form.RadioGroup component} + * + * # Example usage + * + * Ext.create('Ext.form.Panel', { + * title: 'RadioGroup Example', + * width: 300, + * height: 125, + * bodyPadding: 10, + * renderTo: Ext.getBody(), + * items:[{ + * xtype: 'radiogroup', + * fieldLabel: 'Two Columns', + * // Arrange radio buttons into two columns, distributed vertically + * columns: 2, + * vertical: true, + * items: [ + * {boxLabel: 'Item 1', name: 'rb', inputValue: '1'}, + * {boxLabel: 'Item 2', name: 'rb', inputValue: '2', checked: true}, + * {boxLabel: 'Item 3', name: 'rb', inputValue: '3'}, + * {boxLabel: 'Item 4', name: 'rb', inputValue: '4'}, + * {boxLabel: 'Item 5', name: 'rb', inputValue: '5'}, + * {boxLabel: 'Item 6', name: 'rb', inputValue: '6'} + * ] + * }] + * }); + * + */ +Ext.define('Ext.form.RadioGroup', { + extend: 'Ext.form.CheckboxGroup', + alias: 'widget.radiogroup', /** - * Returns the Component which is the currently active tab. Note that before the TabPanel - * first activates a child Component, this method will return whatever was configured in the - * {@link #activeTab} config option. - * @return {BoxComponent} The currently active child Component if one is active, or the {@link #activeTab} config value. + * @cfg {Array} items An Array of {@link Ext.form.field.Radio Radio}s or Radio config objects + * to arrange in the group. */ - getActiveTab : function(){ - return this.activeTab || null; - }, - /** - * Gets the specified tab by id. - * @param {String} id The tab id - * @return {Panel} The tab + * @cfg {Boolean} allowBlank True to allow every item in the group to be blank (defaults to true). + * If allowBlank = false and no items are selected at validation time, {@link #blankText} will + * be used as the error text. */ - getItem : function(item){ - return this.getComponent(item); - }, - + allowBlank : true, + /** + * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails + * (defaults to 'You must select one item in this group') + */ + blankText : 'You must select one item in this group', + // private - autoScrollTabs : function(){ - this.pos = this.tabPosition=='bottom' ? this.footer : this.header; - var count = this.items.length, - ow = this.pos.dom.offsetWidth, - tw = this.pos.dom.clientWidth, - wrap = this.stripWrap, - wd = wrap.dom, - cw = wd.offsetWidth, - pos = this.getScrollPos(), - l = this.edge.getOffsetsTo(this.stripWrap)[0] + pos; - - if(!this.enableTabScroll || count < 1 || cw < 20){ // 20 to prevent display:none issues - return; - } - if(l <= tw){ - wd.scrollLeft = 0; - wrap.setWidth(tw); - if(this.scrolling){ - this.scrolling = false; - this.pos.removeClass('x-tab-scrolling'); - this.scrollLeft.hide(); - this.scrollRight.hide(); - // See here: http://extjs.com/forum/showthread.php?t=49308&highlight=isSafari - if(Ext.isAir || Ext.isWebKit){ - wd.style.marginLeft = ''; - wd.style.marginRight = ''; - } - } - }else{ - if(!this.scrolling){ - this.pos.addClass('x-tab-scrolling'); - // See here: http://extjs.com/forum/showthread.php?t=49308&highlight=isSafari - if(Ext.isAir || Ext.isWebKit){ - wd.style.marginLeft = '18px'; - wd.style.marginRight = '18px'; - } - } - tw -= wrap.getMargins('lr'); - wrap.setWidth(tw > 20 ? tw : 20); - if(!this.scrolling){ - if(!this.scrollLeft){ - this.createScrollers(); - }else{ - this.scrollLeft.show(); - this.scrollRight.show(); - } - } - this.scrolling = true; - if(pos > (l-tw)){ // ensure it stays within bounds - wd.scrollLeft = l-tw; - }else{ // otherwise, make sure the active tab is still visible - this.scrollToTab(this.activeTab, false); - } - this.updateScrollButtons(); - } - }, - + defaultType : 'radiofield', + // private - createScrollers : function(){ - this.pos.addClass('x-tab-scrolling-' + this.tabPosition); - var h = this.stripWrap.dom.offsetHeight; + groupCls : Ext.baseCSSPrefix + 'form-radio-group', - // left - var sl = this.pos.insertFirst({ - cls:'x-tab-scroller-left' - }); - sl.setHeight(h); - sl.addClassOnOver('x-tab-scroller-left-over'); - this.leftRepeater = new Ext.util.ClickRepeater(sl, { - interval : this.scrollRepeatInterval, - handler: this.onScrollLeft, - scope: this - }); - this.scrollLeft = sl; + getBoxes: function() { + return this.query('[isRadio]'); + } - // right - var sr = this.pos.insertFirst({ - cls:'x-tab-scroller-right' - }); - sr.setHeight(h); - sr.addClassOnOver('x-tab-scroller-right-over'); - this.rightRepeater = new Ext.util.ClickRepeater(sr, { - interval : this.scrollRepeatInterval, - handler: this.onScrollRight, - scope: this +}); + +/** + * @private + * Private utility class for managing all {@link Ext.form.field.Radio} fields grouped by name. + */ +Ext.define('Ext.form.RadioManager', { + extend: 'Ext.util.MixedCollection', + singleton: true, + + getByName: function(name) { + return this.filterBy(function(item) { + return item.name == name; }); - this.scrollRight = sr; }, - // private - getScrollWidth : function(){ - return this.edge.getOffsetsTo(this.stripWrap)[0] + this.getScrollPos(); + getWithValue: function(name, value) { + return this.filterBy(function(item) { + return item.name == name && item.inputValue == value; + }); }, - // private - getScrollPos : function(){ - return parseInt(this.stripWrap.dom.scrollLeft, 10) || 0; - }, + getChecked: function(name) { + return this.findBy(function(item) { + return item.name == name && item.checked; + }); + } +}); - // private - getScrollArea : function(){ - return parseInt(this.stripWrap.dom.clientWidth, 10) || 0; - }, +/** + * @class Ext.form.action.DirectLoad + * @extends Ext.form.action.Load + *Provides {@link Ext.direct.Manager} support for loading form data.
+ *This example illustrates usage of Ext.direct.Direct to load a form through Ext.Direct.
+ *+ * The data packet sent to the server will resemble something like: + *+var myFormPanel = new Ext.form.Panel({ + // configs for FormPanel + title: 'Basic Information', + renderTo: document.body, + width: 300, height: 160, + padding: 10, - // private - getScrollAnim : function(){ - return {duration:this.scrollDuration, callback: this.updateScrollButtons, scope: this}; + // configs apply to child items + defaults: {anchor: '100%'}, + defaultType: 'textfield', + items: [{ + fieldLabel: 'Name', + name: 'name' + },{ + fieldLabel: 'Email', + name: 'email' + },{ + fieldLabel: 'Company', + name: 'company' + }], + + // configs for BasicForm + api: { + // The server-side method to call for load() requests + load: Profile.getBasicInfo, + // The server-side must mark the submit handler as a 'formHandler' + submit: Profile.updateBasicInfo }, + // specify the order for the passed params + paramOrder: ['uid', 'foo'] +}); - // private - getScrollIncrement : function(){ - return this.scrollIncrement || (this.resizeTabs ? this.lastTabWidth+2 : 100); +// load the form +myFormPanel.getForm().load({ + // pass 2 arguments to server side getBasicInfo method (len=2) + params: { + foo: 'bar', + uid: 34 + } +}); + *
+ * The form will process a data packet returned by the server that is similar + * to the following format: + *+[ + { + "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2, + "data":[34,"bar"] // note the order of the params + } +] + *
+ */ +Ext.define('Ext.form.action.DirectLoad', { + extend:'Ext.form.action.Load', + requires: ['Ext.direct.Manager'], + alternateClassName: 'Ext.form.Action.DirectLoad', + alias: 'formaction.directload', + + type: 'directload', + + run: function() { + this.form.api.load.apply(window, this.getArgs()); }, /** - * Scrolls to a particular tab if tab scrolling is enabled - * @param {Panel} item The item to scroll to - * @param {Boolean} animate True to enable animations + * @private + * Build the arguments to be sent to the Direct call. + * @return Array */ + getArgs: function() { + var me = this, + args = [], + form = me.form, + paramOrder = form.paramOrder, + params = me.getParams(), + i, len; - scrollToTab : function(item, animate){ - if(!item){ - return; + // If a paramOrder was specified, add the params into the argument list in that order. + if (paramOrder) { + for (i = 0, len = paramOrder.length; i < len; i++) { + args.push(params[paramOrder[i]]); + } } - var el = this.getTabEl(item), - pos = this.getScrollPos(), - area = this.getScrollArea(), - left = Ext.fly(el).getOffsetsTo(this.stripWrap)[0] + pos, - right = left + el.offsetWidth; - if(left < pos){ - this.scrollTo(left, animate); - }else if(right > (pos + area)){ - this.scrollTo(right - area, animate); + // If paramsAsHash was specified, add all the params as a single object argument. + else if (form.paramsAsHash) { + args.push(params); } + + // Add the callback and scope to the end of the arguments list + args.push(me.onSuccess, me); + + return args; }, - // private - scrollTo : function(pos, animate){ - this.stripWrap.scrollTo('left', pos, animate ? this.getScrollAnim() : false); - if(!animate){ - this.updateScrollButtons(); - } + // Direct actions have already been processed and therefore + // we can directly set the result; Direct Actions do not have + // a this.response property. + processResponse: function(result) { + return (this.result = result); }, - onWheel : function(e){ - var d = e.getWheelDelta()*this.wheelIncrement*-1; - e.stopEvent(); + onSuccess: function(result, trans) { + if (trans.type == Ext.direct.Manager.self.exceptions.SERVER) { + result = {}; + } + this.callParent([result]); + } +}); - var pos = this.getScrollPos(), - newpos = pos + d, - sw = this.getScrollWidth()-this.getScrollArea(); - var s = Math.max(0, Math.min(sw, newpos)); - if(s != pos){ - this.scrollTo(s, false); - } - }, - // private - onScrollRight : function(){ - var sw = this.getScrollWidth()-this.getScrollArea(), - pos = this.getScrollPos(), - s = Math.min(sw, pos + this.getScrollIncrement()); - if(s != pos){ - this.scrollTo(s, this.animScroll); +/** + * @class Ext.form.action.DirectSubmit + * @extends Ext.form.action.Submit + *+[ + { + "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2, + "result":{ + "success":true, + "data":{ + "name":"Fred Flintstone", + "company":"Slate Rock and Gravel", + "email":"fred.flintstone@slaterg.com" + } + } + } +] + *
Provides Ext.direct support for submitting form data.
+ *This example illustrates usage of Ext.direct.Direct to submit a form through Ext.Direct.
+ *+ * The data packet sent to the server will resemble something like: + *+var myFormPanel = new Ext.form.Panel({ + // configs for FormPanel + title: 'Basic Information', + renderTo: document.body, + width: 300, height: 160, + padding: 10, + buttons:[{ + text: 'Submit', + handler: function(){ + myFormPanel.getForm().submit({ + params: { + foo: 'bar', + uid: 34 + } + }); } + }], + + // configs apply to child items + defaults: {anchor: '100%'}, + defaultType: 'textfield', + items: [{ + fieldLabel: 'Name', + name: 'name' + },{ + fieldLabel: 'Email', + name: 'email' + },{ + fieldLabel: 'Company', + name: 'company' + }], + + // configs for BasicForm + api: { + // The server-side method to call for load() requests + load: Profile.getBasicInfo, + // The server-side must mark the submit handler as a 'formHandler' + submit: Profile.updateBasicInfo }, + // specify the order for the passed params + paramOrder: ['uid', 'foo'] +}); + *
+ * The form will process a data packet returned by the server that is similar + * to the following: + *+{ + "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6", + "result":{ + "success":true, + "id":{ + "extAction":"Profile","extMethod":"updateBasicInfo", + "extType":"rpc","extTID":"6","extUpload":"false", + "name":"Aaron Conran","email":"aaron@sencha.com","company":"Sencha Inc." + } + } +} + *
+ * Also see the discussion in {@link Ext.form.action.DirectLoad}. + */ +Ext.define('Ext.form.action.DirectSubmit', { + extend:'Ext.form.action.Submit', + requires: ['Ext.direct.Manager'], + alternateClassName: 'Ext.form.Action.DirectSubmit', + alias: 'formaction.directsubmit', + + type: 'directsubmit', + + doSubmit: function() { + var me = this, + callback = Ext.Function.bind(me.onSuccess, me), + formEl = me.buildForm(); + me.form.api.submit(formEl, callback, me); + Ext.removeNode(formEl); }, - // private - updateScrollButtons : function(){ - var pos = this.getScrollPos(); - this.scrollLeft[pos === 0 ? 'addClass' : 'removeClass']('x-tab-scroller-left-disabled'); - this.scrollRight[pos >= (this.getScrollWidth()-this.getScrollArea()) ? 'addClass' : 'removeClass']('x-tab-scroller-right-disabled'); + // Direct actions have already been processed and therefore + // we can directly set the result; Direct Actions do not have + // a this.response property. + processResponse: function(result) { + return (this.result = result); }, - // private - beforeDestroy : function() { - Ext.destroy(this.leftRepeater, this.rightRepeater); - this.deleteMembers('strip', 'edge', 'scrollLeft', 'scrollRight', 'stripWrap'); - this.activeTab = null; - Ext.TabPanel.superclass.beforeDestroy.apply(this); + onSuccess: function(response, trans) { + if (trans.type === Ext.direct.Manager.self.exceptions.SERVER) { + response = {}; + } + this.callParent([response]); } +}); + +/** + * @class Ext.form.action.StandardSubmit + * @extends Ext.form.action.Submit + *+// sample success packet (batched requests) +[ + { + "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":3, + "result":{ + "success":true + } + } +] - // private - onScrollLeft : function(){ - var pos = this.getScrollPos(), - s = Math.max(0, pos - this.getScrollIncrement()); - if(s != pos){ - this.scrollTo(s, this.animScroll); +// sample failure packet (one request) +{ + "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6", + "result":{ + "errors":{ + "email":"already taken" + }, + "success":false, + "foo":"bar" } +} + *
A class which handles submission of data from {@link Ext.form.Basic Form}s using a standard + * <form> element submit. It does not handle the response from the submit.
+ *If validation of the form fields fails, the Form's {@link Ext.form.Basic#afterAction} method + * will be called. Otherwise, afterAction will not be called.
+ *Instances of this class are only created by a {@link Ext.form.Basic Form} when + * {@link Ext.form.Basic#submit submit}ting, when the form's {@link Ext.form.Basic#standardSubmit} + * config option is true.
+ */ +Ext.define('Ext.form.action.StandardSubmit', { + extend:'Ext.form.action.Submit', + alias: 'formaction.standardsubmit', /** - * @cfg {Boolean} collapsible - * @hide - */ - /** - * @cfg {String} header - * @hide - */ - /** - * @cfg {Boolean} headerAsText - * @hide - */ - /** - * @property header - * @hide - */ - /** - * @cfg title - * @hide - */ - /** - * @cfg {Array} tools - * @hide - */ - /** - * @cfg {Array} toolTemplate - * @hide - */ - /** - * @cfg {Boolean} hideCollapseTool - * @hide - */ - /** - * @cfg {Boolean} titleCollapse - * @hide - */ - /** - * @cfg {Boolean} collapsed - * @hide - */ - /** - * @cfg {String} layout - * @hide + * @cfg {String} target + * Optional target attribute to be used for the form when submitting. If not specified, + * the target will be the current window/frame. */ + /** - * @cfg {Boolean} preventBodyReset - * @hide - */ + * @private + * Perform the form submit. Creates and submits a temporary form element containing an input element for each + * field value returned by {@link Ext.form.Basic#getValues}, plus any configured {@link #params params} or + * {@link Ext.form.Basic#baseParams baseParams}. + */ + doSubmit: function() { + var form = this.buildForm(); + form.submit(); + Ext.removeNode(form); + } + }); -Ext.reg('tabpanel', Ext.TabPanel); /** - * See {@link #setActiveTab}. Sets the specified tab as the active tab. This method fires - * the {@link #beforetabchange} event which can return false to cancel the tab change. - * @param {String/Panel} tab The id or tab Panel to activate - * @method activate - */ -Ext.TabPanel.prototype.activate = Ext.TabPanel.prototype.setActiveTab; - -// private utility class used by TabPanel -Ext.TabPanel.AccessStack = function(){ - var items = []; - return { - add : function(item){ - items.push(item); - if(items.length > 10){ - items.shift(); + * @class Ext.form.field.Checkbox + * @extends Ext.form.field.Base + +Single checkbox field. Can be used as a direct replacement for traditional checkbox fields. Also serves as a +parent class for {@link Ext.form.field.Radio radio buttons}. + +__Labeling:__ In addition to the {@link Ext.form.Labelable standard field labeling options}, checkboxes +may be given an optional {@link #boxLabel} which will be displayed immediately after checkbox. Also see +{@link Ext.form.CheckboxGroup} for a convenient method of grouping related checkboxes. + +__Values:__ +The main value of a checkbox is a boolean, indicating whether or not the checkbox is checked. +The following values will check the checkbox: +* `true` +* `'true'` +* `'1'` +* `'on'` + +Any other value will uncheck the checkbox. + +In addition to the main boolean value, you may also specify a separate {@link #inputValue}. This will be +sent as the parameter value when the form is {@link Ext.form.Basic#submit submitted}. You will want to set +this value if you have multiple checkboxes with the same {@link #name}. If not specified, the value `on` +will be used. +{@img Ext.form.Checkbox/Ext.form.Checkbox.png Ext.form.Checkbox Checkbox component} +__Example usage:__ + + Ext.create('Ext.form.Panel', { + bodyPadding: 10, + width : 300, + title : 'Pizza Order', + items: [ + { + xtype : 'fieldcontainer', + fieldLabel : 'Toppings', + defaultType: 'checkboxfield', + items: [ + { + boxLabel : 'Anchovies', + name : 'topping', + inputValue: '1', + id : 'checkbox1' + }, { + boxLabel : 'Artichoke Hearts', + name : 'topping', + inputValue: '2', + checked : true, + id : 'checkbox2' + }, { + boxLabel : 'Bacon', + name : 'topping', + inputValue: '3', + id : 'checkbox3' + } + ] } - }, - - remove : function(item){ - var s = []; - for(var i = 0, len = items.length; i < len; i++) { - if(items[i] != item){ - s.push(items[i]); + ], + bbar: [ + { + text: 'Select Bacon', + handler: function() { + var checkbox = Ext.getCmp('checkbox3'); + checkbox.setValue(true); + } + }, + '-', + { + text: 'Select All', + handler: function() { + var checkbox1 = Ext.getCmp('checkbox1'), + checkbox2 = Ext.getCmp('checkbox2'), + checkbox3 = Ext.getCmp('checkbox3'); + + checkbox1.setValue(true); + checkbox2.setValue(true); + checkbox3.setValue(true); + } + }, + { + text: 'Deselect All', + handler: function() { + var checkbox1 = Ext.getCmp('checkbox1'), + checkbox2 = Ext.getCmp('checkbox2'), + checkbox3 = Ext.getCmp('checkbox3'); + + checkbox1.setValue(false); + checkbox2.setValue(false); + checkbox3.setValue(false); } } - items = s; - }, + ], + renderTo: Ext.getBody() + }); - next : function(){ - return items.pop(); - } - }; -}; -/** - * @class Ext.Button - * @extends Ext.BoxComponent - * Simple Button class - * @cfg {String} text The button text to be used as innerHTML (html tags are accepted) - * @cfg {String} icon The path to an image to display in the button (the image will be set as the background-image - * CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon') - * @cfg {Function} handler A function called when the button is clicked (can be used instead of click event). - * The handler is passed the following parameters:- * @cfg {Number} minWidth The minimum width for this button (used to give a set of buttons a common width). - * See also {@link Ext.Panel}.{@link Ext.Panel#minButtonWidth minButtonWidth}. - * @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 {Boolean} hidden True to start hidden (defaults to false) - * @cfg {Boolean} disabled True to start disabled (defaults to false) - * @cfg {Boolean} pressed True to start pressed (only if enableToggle = true) - * @cfg {String} toggleGroup The group this toggle button is a member of (only 1 per group can be pressed) - * @cfg {Boolean/Object} repeat True to repeat fire the click event while the mouse is down. This can also be - * a {@link Ext.util.ClickRepeater ClickRepeater} config object (defaults to false). - * @constructor - * Create a new button - * @param {Object} config The config object - * @xtype button + * @docauthor Robert Dougan- *
- - *
b
: ButtonThis Button.- - *
e
: EventObjectThe click event.+ * @markdown */ -Ext.Button = Ext.extend(Ext.BoxComponent, { +Ext.define('Ext.form.field.Checkbox', { + extend: 'Ext.form.field.Base', + alias: ['widget.checkboxfield', 'widget.checkbox'], + alternateClassName: 'Ext.form.Checkbox', + requires: ['Ext.XTemplate', 'Ext.form.CheckboxManager'], + + fieldSubTpl: [ + ' ', + '', + ' ', + // Creates not an actual checkbox, but a button which is given aria role="checkbox" and + // styled with a custom checkbox image. This allows greater control and consistency in + // styling, and using a button allows it to gain focus and handle keyboard nav properly. + 'tabIndex="{tabIdx}" ', + 'class="{fieldCls} {typeCls}" autocomplete="off" hidefocus="true" />', + '', + '', + ' ', + { + disableFormats: true, + compiled: true + } + ], + + isCheckbox: true, + /** - * Read-only. True if this button is hidden - * @type Boolean + * @cfg {String} focusCls The CSS class to use when the checkbox receives focus + * (defaults to 'x-form-cb-focus') */ - hidden : false, + focusCls: Ext.baseCSSPrefix + 'form-cb-focus', + /** - * Read-only. True if this button is disabled - * @type Boolean + * @cfg {String} fieldCls The default CSS class for the checkbox (defaults to 'x-form-field') */ - disabled : false, + /** - * Read-only. True if this button is pressed (only if enableToggle = true) - * @type Boolean + * @cfg {String} fieldBodyCls + * An extra CSS class to be applied to the body content element in addition to {@link #fieldBodyCls}. + * Defaults to 'x-form-cb-wrap. */ - pressed : false, + fieldBodyCls: Ext.baseCSSPrefix + 'form-cb-wrap', /** - * @cfg {Number} tabIndex Set a DOM tabIndex for this button (defaults to undefined) + * @cfg {Boolean} checked true if the checkbox should render initially checked (defaults to false) */ + checked: false, /** - * @cfg {Boolean} allowDepress - * False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when {@link #enableToggle} is true. + * @cfg {String} checkedCls The CSS class added to the component's main element when it is in the checked state. */ + checkedCls: Ext.baseCSSPrefix + 'form-cb-checked', /** - * @cfg {Boolean} enableToggle - * True to enable pressed/not pressed toggling (defaults to false) + * @cfg {String} boxLabel An optional text label that will appear next to the checkbox. Whether it appears before + * or after the checkbox is determined by the {@link #boxLabelAlign} config (defaults to after). */ - enableToggle : false, + /** - * @cfg {Function} toggleHandler - * Function called when a Button with {@link #enableToggle} set to true is clicked. Two arguments are passed:- *
+ * @cfg {String} boxLabelCls The CSS class to be applied to the {@link #boxLabel} element */ + boxLabelCls: Ext.baseCSSPrefix + 'form-cb-label', + /** - * @cfg {Mixed} menu - * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined). + * @cfg {String} boxLabelAlign The position relative to the checkbox where the {@link #boxLabel} should + * appear. Recognized values are 'before' and 'after'. Defaults to 'after'. */ + boxLabelAlign: 'after', + /** - * @cfg {String} menuAlign - * The position to align the menu to (see {@link Ext.Element#alignTo} for more details, defaults to 'tl-bl?'). + * @cfg {String} inputValue The value that should go into the generated input element's value attribute and + * should be used as the parameter value when submitting as part of a form. Defaults to "on". */ - menuAlign : 'tl-bl?', + inputValue: 'on', /** - * @cfg {String} overflowText If used in a {@link Ext.Toolbar Toolbar}, the - * text to be used if this item is shown in the overflow menu. See also - * {@link Ext.Toolbar.Item}.- button : Ext.Button
- *this Button object- state : Boolean
- *The next state of the Button, true means pressed.{@link Ext.Toolbar.Item#overflowText overflowText}
. + * @cfg {String} uncheckedValue If configured, this will be submitted as the checkbox's value during form + * submit if the checkbox is unchecked. By default this is undefined, which results in nothing being + * submitted for the checkbox field when the form is submitted (the default behavior of HTML checkboxes). */ + /** - * @cfg {String} iconCls - * A css class which sets a background image to be used as the icon for this button + * @cfg {Function} handler A function called when the {@link #checked} value changes (can be used instead of + * handling the {@link #change change event}). The handler is passed the following parameters: + **/ + /** - * @cfg {String} type - * submit, reset or button - defaults to 'button' + * @cfg {Object} scope An object to use as the scope ('this' reference) of the {@link #handler} function + * (defaults to this Checkbox). */ - type : 'button', + + // private overrides + checkChangeEvents: [], + inputType: 'checkbox', + ariaRole: 'checkbox', // private - menuClassTarget : 'tr:nth(2)', + onRe: /^on$/i, - /** - * @cfg {String} clickEvent - * The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu). - * Defaults to 'click'. - */ - clickEvent : 'click', + initComponent: function(){ + this.callParent(arguments); + this.getManager().add(this); + }, - /** - * @cfg {Boolean} handleMouseEvents - * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) - */ - handleMouseEvents : true, + initValue: function() { + var me = this, + checked = !!me.checked; - /** - * @cfg {String} tooltipType - * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. - */ - tooltipType : 'qtip', + /** + * The original value of the field as configured in the {@link #checked} configuration, or + * as loaded by the last form load operation if the form's {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} + * setting is+ *
- checkbox : Ext.form.field.Checkbox
+ *The Checkbox being toggled.- checked : Boolean
+ *The new checked state of the checkbox.true
. + * @type Mixed + * @property originalValue + */ + me.originalValue = me.lastValue = checked; - /** - * @cfg {String} buttonSelector - *(Optional) A {@link Ext.DomQuery DomQuery} selector which is used to extract the active, clickable element from the - * DOM structure created.
- *When a custom {@link #template} is used, you must ensure that this selector results in the selection of - * a focussable element.
- *Defaults to 'button:first-child'.
- */ - buttonSelector : 'button:first-child', + // Set the initial checked state + me.setValue(checked); + }, + + // private + onRender : function(ct, position) { + var me = this; + Ext.applyIf(me.renderSelectors, { + /** + * @property boxLabelEl + * @type Ext.core.Element + * A reference to the label element created for the {@link #boxLabel}. Only present if the + * component has been rendered and has a boxLabel configured. + */ + boxLabelEl: 'label.' + me.boxLabelCls + }); + Ext.applyIf(me.subTplData, { + boxLabel: me.boxLabel, + boxLabelCls: me.boxLabelCls, + boxLabelAlign: me.boxLabelAlign + }); + + me.callParent(arguments); + }, + + initEvents: function() { + var me = this; + me.callParent(); + me.mon(me.inputEl, 'click', me.onBoxClick, me); + }, /** - * @cfg {String} scale - *(Optional) The size of the Button. Three values are allowed:
- *- *
- *- 'small'
- *Results in the button element being 16px high.- 'medium'
- *Results in the button element being 24px high.- 'large'
- *Results in the button element being 32px high.Defaults to 'small'.
+ * @private Handle click on the checkbox button */ - scale : 'small', + onBoxClick: function(e) { + var me = this; + if (!me.disabled && !me.readOnly) { + this.setValue(!this.checked); + } + }, /** - * @cfg {Object} scope The scope (this reference) in which the - *{@link #handler}
and{@link #toggleHandler}
is - * executed. Defaults to this Button. + * Returns the checked state of the checkbox. + * @return {Boolean} True if checked, else false */ + getRawValue: function() { + return this.checked; + }, /** - * @cfg {String} iconAlign - *(Optional) The side of the Button box to render the icon. Four values are allowed:
- *- *
- *- 'top'
- *- 'right'
- *- 'bottom'
- *- 'left'
- *Defaults to 'left'.
+ * Returns the checked state of the checkbox. + * @return {Boolean} True if checked, else false */ - iconAlign : 'left', + getValue: function() { + return this.checked; + }, /** - * @cfg {String} arrowAlign - *(Optional) The side of the Button box to render the arrow if the button has an associated {@link #menu}. - * Two values are allowed:
- *- *
- *- 'right'
- *- 'bottom'
- *Defaults to 'right'.
+ * Returns the submit value for the checkbox which can be used when submitting forms. + * @return {Boolean/null} True if checked; otherwise either the {@link #uncheckedValue} or null. */ - arrowAlign : 'right', + getSubmitValue: function() { + var unchecked = this.uncheckedValue, + uncheckedVal = Ext.isDefined(unchecked) ? unchecked : null; + return this.checked ? this.inputValue : uncheckedVal; + }, /** - * @cfg {Ext.Template} template (Optional) - *A {@link Ext.Template Template} used to create the Button's DOM structure.
- * Instances, or subclasses which need a different DOM structure may provide a different - * template layout in conjunction with an implementation of {@link #getTemplateArgs}. - * @type Ext.Template - * @property template + * Sets the checked state of the checkbox. + * @param {Boolean/String} value The following values will check the checkbox: + *true, 'true', '1', or 'on'
, as well as a String that matches the {@link #inputValue}. + * Any other value will uncheck the checkbox. + * @return {Boolean} the new checked state of the checkbox */ + setRawValue: function(value) { + var me = this, + inputEl = me.inputEl, + inputValue = me.inputValue, + checked = (value === true || value === 'true' || value === '1' || + ((Ext.isString(value) && inputValue) ? value == inputValue : me.onRe.test(value))); + + if (inputEl) { + inputEl.dom.setAttribute('aria-checked', checked); + me[checked ? 'addCls' : 'removeCls'](me.checkedCls); + } + + me.checked = me.rawValue = checked; + return checked; + }, + /** - * @cfg {String} cls - * A CSS class string to apply to the button's main element. + * Sets the checked state of the checkbox, and invokes change detection. + * @param {Boolean/String} checked The following values will check the checkbox: + *true, 'true', '1', or 'on'
, as well as a String that matches the {@link #inputValue}. + * Any other value will uncheck the checkbox. + * @return {Ext.form.field.Checkbox} this */ + setValue: function(checked) { + var me = this; + + // If an array of strings is passed, find all checkboxes in the group with the same name as this + // one and check all those whose inputValue is in the array, unchecking all the others. This is to + // facilitate setting values from Ext.form.Basic#setValues, but is not publicly documented as we + // don't want users depending on this behavior. + if (Ext.isArray(checked)) { + me.getManager().getByName(me.name).each(function(cb) { + cb.setValue(Ext.Array.contains(checked, cb.inputValue)); + }); + } else { + me.callParent(arguments); + } + + return me; + }, + + // private + valueToRaw: function(value) { + // No extra conversion for checkboxes + return value; + }, + /** - * @property menu - * @type Menu - * The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option. + * @private + * Called when the checkbox's checked state changes. Invokes the {@link #handler} callback + * function if specified. */ + onChange: function(newVal, oldVal) { + var me = this, + handler = me.handler; + if (handler) { + handler.call(me.scope || me, me, newVal); + } + me.callParent(arguments); + }, + + // inherit docs + getManager: function() { + return Ext.form.CheckboxManager; + }, + + onEnable: function() { + var me = this, + inputEl = me.inputEl; + me.callParent(); + if (inputEl) { + // Can still be disabled if the field is readOnly + inputEl.dom.disabled = me.readOnly; + } + }, + + setReadOnly: function(readOnly) { + var me = this, + inputEl = me.inputEl; + if (inputEl) { + // Set the button to disabled when readonly + inputEl.dom.disabled = readOnly || me.disabled; + } + me.readOnly = readOnly; + }, + /** - * @cfg {Boolean} autoWidth - * By default, if a width is not specified the button will attempt to stretch horizontally to fit its content. - * If the button is being managed by a width sizing layout (hbox, fit, anchor), set this to false to prevent - * the button from doing this automatic sizing. - * Defaults to undefined. + * @protected Calculate and return the natural width of the bodyEl. It's possible that the initial + * rendering will cause the boxLabel to wrap and give us a bad width, so we must prevent wrapping + * while measuring. */ + getBodyNaturalWidth: function() { + var me = this, + bodyEl = me.bodyEl, + ws = 'white-space', + width; + bodyEl.setStyle(ws, 'nowrap'); + width = bodyEl.getWidth(); + bodyEl.setStyle(ws, ''); + return width; + } - initComponent : function(){ - Ext.Button.superclass.initComponent.call(this); +}); + +/** + * @private + * @class Ext.layout.component.field.Trigger + * @extends Ext.layout.component.field.Field + * Layout class for {@link Ext.form.field.Trigger} fields. Adjusts the input field size to accommodate + * the trigger button(s). + * @private + */ + +Ext.define('Ext.layout.component.field.Trigger', { + /* Begin Definitions */ + + alias: ['layout.triggerfield'], + + extend: 'Ext.layout.component.field.Field', + + /* End Definitions */ + + type: 'triggerfield', + + sizeBodyContents: function(width, height) { + var me = this, + owner = me.owner, + inputEl = owner.inputEl, + triggerWrap = owner.triggerWrap, + triggerWidth = owner.getTriggerWidth(); + + // If we or our ancestor is hidden, we can get a triggerWidth calculation + // of 0. We don't want to resize in this case. + if (owner.hideTrigger || owner.readOnly || triggerWidth > 0) { + // Decrease the field's width by the width of the triggers. Both the field and the triggerWrap + // are floated left in CSS so they'll stack up side by side. + me.setElementSize(inputEl, Ext.isNumber(width) ? width - triggerWidth : width); + + // Explicitly set the triggerWrap's width, to prevent wrapping + triggerWrap.setWidth(triggerWidth); + } + } +}); +/** + * @class Ext.view.View + * @extends Ext.view.AbstractView + * + * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate} + * as its internal templating mechanism, and is bound to an {@link Ext.data.Store} + * so that as the data in the store changes the view is automatically updated to reflect the changes. The view also + * provides built-in behavior for many common events that can occur for its contained items including click, doubleclick, + * mouseover, mouseout, etc. as well as a built-in selection model. In order to use these features, an {@link #itemSelector} + * config must be provided for the DataView to determine what nodes it will be working with. + * + * The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.panel.Panel}. + * + * {@img Ext.DataView/Ext.DataView.png Ext.DataView component} + * + * Ext.regModel('Image', { + * Fields: [ + * {name:'src', type:'string'}, + * {name:'caption', type:'string'} + * ] + * }); + * + * Ext.create('Ext.data.Store', { + * id:'imagesStore', + * model: 'Image', + * data: [ + * {src:'http://www.sencha.com/img/20110215-feat-drawing.png', caption:'Drawing & Charts'}, + * {src:'http://www.sencha.com/img/20110215-feat-data.png', caption:'Advanced Data'}, + * {src:'http://www.sencha.com/img/20110215-feat-html5.png', caption:'Overhauled Theme'}, + * {src:'http://www.sencha.com/img/20110215-feat-perf.png', caption:'Performance Tuned'} + * ] + * }); + * + * var imageTpl = new Ext.XTemplate( + * '<tpl for=".">', + * '<div style="thumb-wrap">', + * '<img src="{src}" />', + * '<br/><span>{caption}</span>', + * '</div>', + * '</tpl>' + * ); + * + * Ext.create('Ext.DataView', { + * store: Ext.data.StoreManager.lookup('imagesStore'), + * tpl: imageTpl, + * itemSelector: 'div.thumb-wrap', + * emptyText: 'No images available', + * renderTo: Ext.getBody() + * }); + */ +Ext.define('Ext.view.View', { + extend: 'Ext.view.AbstractView', + alternateClassName: 'Ext.DataView', + alias: 'widget.dataview', + + inheritableStatics: { + EventMap: { + mousedown: 'MouseDown', + mouseup: 'MouseUp', + click: 'Click', + dblclick: 'DblClick', + contextmenu: 'ContextMenu', + mouseover: 'MouseOver', + mouseout: 'MouseOut', + mouseenter: 'MouseEnter', + mouseleave: 'MouseLeave', + keydown: 'KeyDown', + focus: 'Focus' + } + }, + + addCmpEvents: function() { this.addEvents( /** - * @event click - * Fires when this button is clicked - * @param {Button} this - * @param {EventObject} e The click event + * @event beforeitemmousedown + * Fires before the mousedown event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'click', + 'beforeitemmousedown', /** - * @event toggle - * Fires when the 'pressed' state of this button changes (only if enableToggle = true) - * @param {Button} this - * @param {Boolean} pressed + * @event beforeitemmouseup + * Fires before the mouseup event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'toggle', + 'beforeitemmouseup', /** - * @event mouseover - * Fires when the mouse hovers over the button - * @param {Button} this - * @param {Event} e The event object + * @event beforeitemmouseenter + * Fires before the mouseenter event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'mouseover', + 'beforeitemmouseenter', /** - * @event mouseout - * Fires when the mouse exits the button - * @param {Button} this - * @param {Event} e The event object + * @event beforeitemmouseleave + * Fires before the mouseleave event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'mouseout', + 'beforeitemmouseleave', /** - * @event menushow - * If this button has a menu, this event fires when it is shown - * @param {Button} this - * @param {Menu} menu + * @event beforeitemclick + * Fires before the click event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'menushow', + 'beforeitemclick', /** - * @event menuhide - * If this button has a menu, this event fires when it is hidden - * @param {Button} this - * @param {Menu} menu + * @event beforeitemdblclick + * Fires before the dblclick event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'menuhide', + 'beforeitemdblclick', /** - * @event menutriggerover - * If this button has a menu, this event fires when the mouse enters the menu triggering element - * @param {Button} this - * @param {Menu} menu - * @param {EventObject} e + * @event beforeitemcontextmenu + * Fires before the contextmenu event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object */ - 'menutriggerover', + 'beforeitemcontextmenu', /** - * @event menutriggerout - * If this button has a menu, this event fires when the mouse leaves the menu triggering element - * @param {Button} this - * @param {Menu} menu - * @param {EventObject} e + * @event beforeitemkeydown + * Fires before the keydown event on an item is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object. Use {@link Ext.EventObject#getKey getKey()} to retrieve the key that was pressed. */ - 'menutriggerout' + 'beforeitemkeydown', + /** + * @event itemmousedown + * Fires when there is a mouse down on an item + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemmousedown', + /** + * @event itemmouseup + * Fires when there is a mouse up on an item + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemmouseup', + /** + * @event itemmouseenter + * Fires when the mouse enters an item. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemmouseenter', + /** + * @event itemmouseleave + * Fires when the mouse leaves an item. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemmouseleave', + /** + * @event itemclick + * Fires when an item is clicked. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemclick', + /** + * @event itemdblclick + * Fires when an item is double clicked. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemdblclick', + /** + * @event itemcontextmenu + * Fires when an item is right clicked. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object + */ + 'itemcontextmenu', + /** + * @event itemkeydown + * Fires when a key is pressed while an item is currently selected. + * @param {Ext.view.View} this + * @param {Ext.data.Model} record The record that belongs to the item + * @param {HTMLElement} item The item's element + * @param {Number} index The item's index + * @param {Ext.EventObject} e The raw event object. Use {@link Ext.EventObject#getKey getKey()} to retrieve the key that was pressed. + */ + 'itemkeydown', + /** + * @event beforecontainermousedown + * Fires before the mousedown event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainermousedown', + /** + * @event beforecontainermouseup + * Fires before the mouseup event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainermouseup', + /** + * @event beforecontainermouseover + * Fires before the mouseover event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainermouseover', + /** + * @event beforecontainermouseout + * Fires before the mouseout event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainermouseout', + /** + * @event beforecontainerclick + * Fires before the click event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainerclick', + /** + * @event beforecontainerdblclick + * Fires before the dblclick event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainerdblclick', + /** + * @event beforecontainercontextmenu + * Fires before the contextmenu event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'beforecontainercontextmenu', + /** + * @event beforecontainerkeydown + * Fires before the keydown event on the container is processed. Returns false to cancel the default action. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object. Use {@link Ext.EventObject#getKey getKey()} to retrieve the key that was pressed. + */ + 'beforecontainerkeydown', + /** + * @event containermouseup + * Fires when there is a mouse up on the container + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'containermouseup', + /** + * @event containermouseover + * Fires when you move the mouse over the container. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'containermouseover', + /** + * @event containermouseout + * Fires when you move the mouse out of the container. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'containermouseout', + /** + * @event containerclick + * Fires when the container is clicked. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'containerclick', + /** + * @event containerdblclick + * Fires when the container is double clicked. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'containerdblclick', + /** + * @event containercontextmenu + * Fires when the container is right clicked. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object + */ + 'containercontextmenu', + /** + * @event containerkeydown + * Fires when a key is pressed while the container is focused, and no item is currently selected. + * @param {Ext.view.View} this + * @param {Ext.EventObject} e The raw event object. Use {@link Ext.EventObject#getKey getKey()} to retrieve the key that was pressed. + */ + 'containerkeydown', + + /** + * @event selectionchange + * Fires when the selected nodes change. Relayed event from the underlying selection model. + * @param {Ext.view.View} this + * @param {Array} selections Array of the selected nodes + */ + 'selectionchange', + /** + * @event beforeselect + * Fires before a selection is made. If any handlers return false, the selection is cancelled. + * @param {Ext.view.View} this + * @param {HTMLElement} node The node to be selected + * @param {Array} selections Array of currently selected nodes + */ + 'beforeselect' ); - if(this.menu){ - this.menu = Ext.menu.MenuMgr.get(this.menu); - } - if(Ext.isString(this.toggleGroup)){ - this.enableToggle = true; - } }, + // private + afterRender: function(){ + var me = this, + listeners; -/** - *This method returns an Array which provides substitution parameters for the {@link #template Template} used - * to create this Button's DOM structure.
- *Instances or subclasses which use a different Template to create a different DOM structure may need to provide their - * own implementation of this method.
- *The default implementation which provides data for the default {@link #template} returns an Array containing the - * following items:
- * @return {Array} Substitution data for a Template. - */ - getTemplateArgs : function(){ - return [this.type, 'x-btn-' + this.scale + ' x-btn-icon-' + this.scale + '-' + this.iconAlign, this.getMenuClass(), this.cls, this.id]; + me.callParent(); + + listeners = { + scope: me, + /* + * We need to make copies of this since some of the events fired here will end up triggering + * a new event to be called and the shared event object will be mutated. In future we should + * investigate if there are any issues with creating a new event object for each event that + * is fired. + */ + freezeEvent: true, + click: me.handleEvent, + mousedown: me.handleEvent, + mouseup: me.handleEvent, + dblclick: me.handleEvent, + contextmenu: me.handleEvent, + mouseover: me.handleEvent, + mouseout: me.handleEvent, + keydown: me.handleEvent + }; + + me.mon(me.getTargetEl(), listeners); + + if (me.store) { + me.bindStore(me.store, true); + } }, - // private - setButtonClass : function(){ - if(this.useSetClass){ - if(!Ext.isEmpty(this.oldCls)){ - this.el.removeClass([this.oldCls, 'x-btn-pressed']); - } - this.oldCls = (this.iconCls || this.icon) ? (this.text ? 'x-btn-text-icon' : 'x-btn-icon') : 'x-btn-noicon'; - this.el.addClass([this.oldCls, this.pressed ? 'x-btn-pressed' : null]); + handleEvent: function(e) { + if (this.processUIEvent(e) !== false) { + this.processSpecialEvent(e); } }, - // protected - getMenuClass : function(){ - return this.menu ? (this.arrowAlign != 'bottom' ? 'x-btn-arrow' : 'x-btn-arrow-bottom') : ''; + // Private template method + processItemEvent: Ext.emptyFn, + processContainerEvent: Ext.emptyFn, + processSpecialEvent: Ext.emptyFn, + + /* + * Returns true if this mouseover/out event is still over the overItem. + */ + stillOverItem: function (event, overItem) { + var nowOver; + + // There is this weird bug when you hover over the border of a cell it is saying + // the target is the table. + // BrowserBug: IE6 & 7. If me.mouseOverItem has been removed and is no longer + // in the DOM then accessing .offsetParent will throw an "Unspecified error." exception. + // typeof'ng and checking to make sure the offsetParent is an object will NOT throw + // this hard exception. + if (overItem && typeof(overItem.offsetParent) === "object") { + // mouseout : relatedTarget == nowOver, target == wasOver + // mouseover: relatedTarget == wasOver, target == nowOver + nowOver = (event.type == 'mouseout') ? event.getRelatedTarget() : event.getTarget(); + return Ext.fly(overItem).contains(nowOver); + } + + return false; }, - // private - onRender : function(ct, position){ - if(!this.template){ - if(!Ext.Button.buttonTemplate){ - // hideous table template - Ext.Button.buttonTemplate = new Ext.Template( - '- *
- The <button>'s {@link #type}
- *- A CSS class name applied to the Button's main <tbody> element which determines the button's scale and icon alignment.
- *- A CSS class to determine the presence and position of an arrow icon. (
- *'x-btn-arrow'
or'x-btn-arrow-bottom'
or''
)- The {@link #cls} CSS class name applied to the button's wrapping <table> element.
- *- The Component id which is applied to the button's wrapping <table> element.
- *', - '
'); - Ext.Button.buttonTemplate.compile(); + processUIEvent: function(e) { + var me = this, + item = e.getTarget(me.getItemSelector(), me.getTargetEl()), + map = this.statics().EventMap, + index, record, + type = e.type, + overItem = me.mouseOverItem, + newType; + + if (!item) { + if (type == 'mouseover' && me.stillOverItem(e, overItem)) { + item = overItem; + } + + // Try to get the selected item to handle the keydown event, otherwise we'll just fire a container keydown event + if (type == 'keydown') { + record = me.getSelectionModel().getLastSelected(); + if (record) { + item = me.getNode(record); + } } - this.template = Ext.Button.buttonTemplate; } - var btn, targs = this.getTemplateArgs(); + if (item) { + index = me.indexOf(item); + if (!record) { + record = me.getRecord(item); + } - if(position){ - btn = this.template.insertBefore(position, targs, true); - }else{ - btn = this.template.append(ct, targs, true); - } - /** - * An {@link Ext.Element Element} encapsulating the Button's clickable element. By default, - * this references a <button> element. Read only. - * @type Ext.Element - * @property btnEl - */ - this.btnEl = btn.child(this.buttonSelector); - this.mon(this.btnEl, { - scope: this, - focus: this.onFocus, - blur: this.onBlur - }); + if (me.processItemEvent(record, item, index, e) === false) { + return false; + } - this.initButtonEl(btn, this.btnEl); + newType = me.isNewItemEvent(item, e); + if (newType === false) { + return false; + } - Ext.ButtonToggleMgr.register(this); - }, + if ( + (me['onBeforeItem' + map[newType]](record, item, index, e) === false) || + (me.fireEvent('beforeitem' + newType, me, record, item, index, e) === false) || + (me['onItem' + map[newType]](record, item, index, e) === false) + ) { + return false; + } - // private - initButtonEl : function(btn, btnEl){ - this.el = btn; - this.setIcon(this.icon); - this.setText(this.text); - this.setIconClass(this.iconCls); - if(Ext.isDefined(this.tabIndex)){ - btnEl.dom.tabIndex = this.tabIndex; + me.fireEvent('item' + newType, me, record, item, index, e); } - if(this.tooltip){ - this.setTooltip(this.tooltip, true); + else { + if ( + (me.processContainerEvent(e) === false) || + (me['onBeforeContainer' + map[type]](e) === false) || + (me.fireEvent('beforecontainer' + type, me, e) === false) || + (me['onContainer' + map[type]](e) === false) + ) { + return false; + } + + me.fireEvent('container' + type, me, e); } - if(this.handleMouseEvents){ - this.mon(btn, { - scope: this, - mouseover: this.onMouseOver, - mousedown: this.onMouseDown - }); + return true; + }, - // new functionality for monitoring on the document level - //this.mon(btn, 'mouseout', this.onMouseOut, this); - } + isNewItemEvent: function (item, e) { + var me = this, + overItem = me.mouseOverItem, + type = e.type; - if(this.menu){ - this.mon(this.menu, { - scope: this, - show: this.onMenuShow, - hide: this.onMenuHide - }); + switch (type) { + case 'mouseover': + if (item === overItem) { + return false; + } + me.mouseOverItem = item; + return 'mouseenter'; + + case 'mouseout': + // If the currently mouseovered item contains the mouseover target, it's *NOT* a mouseleave + if (me.stillOverItem(e, overItem)) { + return false; + } + me.mouseOverItem = null; + return 'mouseleave'; } + return type; + }, - if(this.repeat){ - var repeater = new Ext.util.ClickRepeater(btn, Ext.isObject(this.repeat) ? this.repeat : {}); - this.mon(repeater, 'click', this.onClick, this); + // private + onItemMouseEnter: function(record, item, index, e) { + if (this.trackOver) { + this.highlightItem(item); } - this.mon(btn, this.clickEvent, this.onClick, this); }, // private - afterRender : function(){ - Ext.Button.superclass.afterRender.call(this); - this.useSetClass = true; - this.setButtonClass(); - this.doc = Ext.getDoc(); - this.doAutoWidth(); + onItemMouseLeave : function(record, item, index, e) { + if (this.trackOver) { + this.clearHighlight(); + } }, + // @private, template methods + onItemMouseDown: Ext.emptyFn, + onItemMouseUp: Ext.emptyFn, + onItemFocus: Ext.emptyFn, + onItemClick: Ext.emptyFn, + onItemDblClick: Ext.emptyFn, + onItemContextMenu: Ext.emptyFn, + onItemKeyDown: Ext.emptyFn, + onBeforeItemMouseDown: Ext.emptyFn, + onBeforeItemMouseUp: Ext.emptyFn, + onBeforeItemFocus: Ext.emptyFn, + onBeforeItemMouseEnter: Ext.emptyFn, + onBeforeItemMouseLeave: Ext.emptyFn, + onBeforeItemClick: Ext.emptyFn, + onBeforeItemDblClick: Ext.emptyFn, + onBeforeItemContextMenu: Ext.emptyFn, + onBeforeItemKeyDown: Ext.emptyFn, + + // @private, template methods + onContainerMouseDown: Ext.emptyFn, + onContainerMouseUp: Ext.emptyFn, + onContainerMouseOver: Ext.emptyFn, + onContainerMouseOut: Ext.emptyFn, + onContainerClick: Ext.emptyFn, + onContainerDblClick: Ext.emptyFn, + onContainerContextMenu: Ext.emptyFn, + onContainerKeyDown: Ext.emptyFn, + onBeforeContainerMouseDown: Ext.emptyFn, + onBeforeContainerMouseUp: Ext.emptyFn, + onBeforeContainerMouseOver: Ext.emptyFn, + onBeforeContainerMouseOut: Ext.emptyFn, + onBeforeContainerClick: Ext.emptyFn, + onBeforeContainerDblClick: Ext.emptyFn, + onBeforeContainerContextMenu: Ext.emptyFn, + onBeforeContainerKeyDown: Ext.emptyFn, + /** - * Sets the CSS class that provides a background image to use as the button's icon. This method also changes - * the value of the {@link iconCls} config internally. - * @param {String} cls The CSS class providing the icon image - * @return {Ext.Button} this + * Highlight a given item in the DataView. This is called by the mouseover handler if {@link #overItemCls} + * and {@link #trackOver} are configured, but can also be called manually by other code, for instance to + * handle stepping through the list via keyboard navigation. + * @param {HTMLElement} item The item to highlight */ - setIconClass : function(cls){ - this.iconCls = cls; - if(this.el){ - this.btnEl.dom.className = ''; - this.btnEl.addClass(['x-btn-text', cls || '']); - this.setButtonClass(); - } - return this; + highlightItem: function(item) { + var me = this; + me.clearHighlight(); + me.highlightedItem = item; + Ext.fly(item).addCls(me.overItemCls); }, /** - * Sets the tooltip for this Button. - * @param {String/Object} tooltip. This may be:', - ' ', - ' ', - ' - * @return {Ext.Button} this - */ - setTooltip : function(tooltip, /* private */ initial){ - if(this.rendered){ - if(!initial){ - this.clearTip(); - } - if(Ext.isObject(tooltip)){ - Ext.QuickTips.register(Ext.apply({ - target: this.btnEl.id - }, tooltip)); - this.tooltip = tooltip; - }else{ - this.btnEl.dom[this.tooltipType] = tooltip; - } - }else{ - this.tooltip = tooltip; + * Un-highlight the currently highlighted item, if any. + */ + clearHighlight: function() { + var me = this, + highlighted = me.highlightedItem; + + if (highlighted) { + Ext.fly(highlighted).removeCls(me.overItemCls); + delete me.highlightedItem; } - return this; }, - // private - clearTip : function(){ - if(Ext.isObject(this.tooltip)){ - Ext.QuickTips.unregister(this.btnEl); + refresh: function() { + var me = this; + me.clearHighlight(); + me.callParent(arguments); + if (!me.isFixedHeight()) { + me.doComponentLayout(); } + } +}); +/** + * Component layout for {@link Ext.view.BoundList}. Handles constraining the height to the configured maxHeight. + * @class Ext.layout.component.BoundList + * @extends Ext.layout.component.Component + * @private + */ +Ext.define('Ext.layout.component.BoundList', { + extend: 'Ext.layout.component.Component', + alias: 'layout.boundlist', + + type: 'component', + + beforeLayout: function() { + return this.callParent(arguments) || this.owner.refreshed > 0; }, - // private - beforeDestroy : function(){ - if(this.rendered){ - this.clearTip(); + onLayout : function(width, height) { + var me = this, + owner = me.owner, + floating = owner.floating, + el = owner.el, + xy = el.getXY(), + isNumber = Ext.isNumber, + minWidth, maxWidth, minHeight, maxHeight, + naturalWidth, naturalHeight, constrainedWidth, constrainedHeight, undef; + + if (floating) { + // Position offscreen so the natural width is not affected by the viewport's right edge + el.setXY([-9999,-9999]); + } + + // Calculate initial layout + me.setTargetSize(width, height); + + // Handle min/maxWidth for auto-width + if (!isNumber(width)) { + minWidth = owner.minWidth; + maxWidth = owner.maxWidth; + if (isNumber(minWidth) || isNumber(maxWidth)) { + naturalWidth = el.getWidth(); + if (naturalWidth < minWidth) { + constrainedWidth = minWidth; + } + else if (naturalWidth > maxWidth) { + constrainedWidth = maxWidth; + } + if (constrainedWidth) { + me.setTargetSize(constrainedWidth); + } + } + } + // Handle min/maxHeight for auto-height + if (!isNumber(height)) { + minHeight = owner.minHeight; + maxHeight = owner.maxHeight; + if (isNumber(minHeight) || isNumber(maxHeight)) { + naturalHeight = el.getHeight(); + if (naturalHeight < minHeight) { + constrainedHeight = minHeight; + } + else if (naturalHeight > maxHeight) { + constrainedHeight = maxHeight; + } + if (constrainedHeight) { + me.setTargetSize(undef, constrainedHeight); + } + } } - if(this.menu && this.destroyMenu !== false) { - Ext.destroy(this.menu); + + if (floating) { + // Restore position + el.setXY(xy); } - Ext.destroy(this.repeater); }, - // private - onDestroy : function(){ - if(this.rendered){ - this.doc.un('mouseover', this.monitorMouseOver, this); - this.doc.un('mouseup', this.onMouseUp, this); - delete this.doc; - delete this.btnEl; - Ext.ButtonToggleMgr.unregister(this); + afterLayout: function() { + var me = this, + toolbar = me.owner.pagingToolbar; + me.callParent(); + if (toolbar) { + toolbar.doComponentLayout(); } - Ext.Button.superclass.onDestroy.call(this); }, - // private - doAutoWidth : function(){ - if(this.autoWidth !== false && this.el && this.text && this.width === undefined){ - this.el.setWidth('auto'); - if(Ext.isIE7 && Ext.isStrict){ - var ib = this.btnEl; - if(ib && ib.getWidth() > 20){ - ib.clip(); - ib.setWidth(Ext.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr')); - } - } - if(this.minWidth){ - if(this.el.getWidth() < this.minWidth){ - this.el.setWidth(this.minWidth); - } + setTargetSize : function(width, height) { + var me = this, + owner = me.owner, + listHeight = null, + toolbar; + + // Size the listEl + if (Ext.isNumber(height)) { + listHeight = height - owner.el.getFrameWidth('tb'); + toolbar = owner.pagingToolbar; + if (toolbar) { + listHeight -= toolbar.getHeight(); } } - }, + me.setElementSize(owner.listEl, null, listHeight); + + me.callParent(arguments); + } +}); + +/** + * @class Ext.toolbar.TextItem + * @extends Ext.toolbar.Item + * + * A simple class that renders text directly into a toolbar. + * + * ## Example usage + * + * {@img Ext.toolbar.TextItem/Ext.toolbar.TextItem.png TextItem component} + * + * Ext.create('Ext.panel.Panel', { + * title: 'Panel with TextItem', + * width: 300, + * height: 200, + * tbar: [ + * {xtype: 'tbtext', text: 'Sample TextItem'} + * ], + * renderTo: Ext.getBody() + * }); + * + * @constructor + * Creates a new TextItem + * @param {Object} text A text string, or a config object containing a text property + */ +Ext.define('Ext.toolbar.TextItem', { + extend: 'Ext.toolbar.Item', + requires: ['Ext.XTemplate'], + alias: 'widget.tbtext', + alternateClassName: 'Ext.Toolbar.TextItem', + /** - * Assigns this Button's click handler - * @param {Function} handler The function to call when the button is clicked - * @param {Object} scope (optional) The scope (- *
- String : A string to be used as innerHTML (html tags are accepted) to show in a tooltip
- *- Object : A configuration object for {@link Ext.QuickTips#register}.
- *this
reference) in which the handler function is executed. - * Defaults to this Button. - * @return {Ext.Button} this + * @cfg {String} text The text to be used as innerHTML (html tags are accepted) */ - setHandler : function(handler, scope){ - this.handler = handler; - this.scope = scope; - return this; + text: '', + + renderTpl: '{text}', + // + baseCls: Ext.baseCSSPrefix + 'toolbar-text', + + onRender : function() { + Ext.apply(this.renderData, { + text: this.text + }); + this.callParent(arguments); }, /** - * Sets this Button's text - * @param {String} text The button text - * @return {Ext.Button} this + * Updates this item's text, setting the text to be used as innerHTML. + * @param {String} t The text to display (html accepted). */ - setText : function(text){ - this.text = text; - if(this.el){ - this.btnEl.update(text || ' '); - this.setButtonClass(); + setText : function(t) { + if (this.rendered) { + this.el.update(t); + this.ownerCt.doLayout(); // In case an empty text item (centered at zero height) receives new text. + } else { + this.text = t; } - this.doAutoWidth(); - return this; - }, + } +}); +/** + * @class Ext.form.field.Trigger + * @extends Ext.form.field.Text + *Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). + * The trigger has no default action, so you must assign a function to implement the trigger click handler by + * overriding {@link #onTriggerClick}. You can create a Trigger field directly, as it renders exactly like a combobox + * for which you can provide a custom implementation. + * {@img Ext.form.field.Trigger/Ext.form.field.Trigger.png Ext.form.field.Trigger component} + * For example:
+ *+ * + *+Ext.define('Ext.ux.CustomTrigger', { + extend: 'Ext.form.field.Trigger', + alias: 'widget.customtrigger', + + // override onTriggerClick + onTriggerClick: function() { + Ext.Msg.alert('Status', 'You clicked my trigger!'); + } +}); + +Ext.create('Ext.form.FormPanel', { + title: 'Form with TriggerField', + bodyPadding: 5, + width: 350, + renderTo: Ext.getBody(), + items:[{ + xtype: 'customtrigger', + fieldLabel: 'Sample Trigger', + emptyText: 'click the trigger', + }] +}); +
However, in general you will most likely want to use Trigger as the base class for a reusable component. + * {@link Ext.form.field.Date} and {@link Ext.form.field.ComboBox} are perfect examples of this.
+ * + * @constructor + * Create a new Trigger field. + * @param {Object} config Configuration options (valid {@Ext.form.field.Text} config options will also be applied + * to the base Text field) + */ +Ext.define('Ext.form.field.Trigger', { + extend:'Ext.form.field.Text', + alias: ['widget.triggerfield', 'widget.trigger'], + requires: ['Ext.core.DomHelper', 'Ext.util.ClickRepeater', 'Ext.layout.component.field.Trigger'], + alternateClassName: ['Ext.form.TriggerField', 'Ext.form.TwinTriggerField', 'Ext.form.Trigger'], + + fieldSubTpl: [ + 'name="{name}" ', + 'size="{size}" ', + 'tabIndex="{tabIdx}" ', + 'class="{fieldCls} {typeCls}" autocomplete="off" />', + '', + '{triggerEl}', + '', + '', + { + compiled: true, + disableFormats: true + } + ], /** - * Sets the background image (inline style) of the button. This method also changes - * the value of the {@link icon} config internally. - * @param {String} icon The path to an image to display in the button - * @return {Ext.Button} this + * @cfg {String} triggerCls + * 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. + * Defaults to undefined. */ - setIcon : function(icon){ - this.icon = icon; - if(this.el){ - this.btnEl.setStyle('background-image', icon ? 'url(' + icon + ')' : ''); - this.setButtonClass(); - } - return this; - }, /** - * Gets the text for this Button - * @return {String} The button text + * @cfg {String} triggerBaseCls + * The base CSS class that is always added to the trigger button. The {@link #triggerCls} will be + * appended in addition to this class. */ - getText : function(){ - return this.text; - }, + triggerBaseCls: Ext.baseCSSPrefix + 'form-trigger', /** - * If a state it passed, it becomes the pressed state otherwise the current state is toggled. - * @param {Boolean} state (optional) Force a particular state - * @param {Boolean} supressEvent (optional) True to stop events being fired when calling this method. - * @return {Ext.Button} this + * @cfg {String} triggerWrapCls + * The CSS class that is added to the div wrapping the trigger button(s). */ - toggle : function(state, suppressEvent){ - state = state === undefined ? !this.pressed : !!state; - if(state != this.pressed){ - if(this.rendered){ - this.el[state ? 'addClass' : 'removeClass']('x-btn-pressed'); - } - this.pressed = state; - if(!suppressEvent){ - this.fireEvent('toggle', this, state); - if(this.toggleHandler){ - this.toggleHandler.call(this.scope || this, this, state); - } - } - } - return this; - }, + triggerWrapCls: Ext.baseCSSPrefix + 'form-trigger-wrap', - // private - onDisable : function(){ - this.onDisableChange(true); - }, + /** + * @cfg {Boolean} hideTrigger true to hide the trigger element and display only the base + * text field (defaults to false) + */ + hideTrigger: false, - // private - onEnable : function(){ - this.onDisableChange(false); - }, + /** + * @cfg {Boolean} editable false to prevent the user from typing text directly into the field; + * the field can only have its value set via an action invoked by the trigger. (defaults to true). + */ + editable: true, - onDisableChange : function(disabled){ - if(this.el){ - if(!Ext.isIE6 || !this.text){ - this.el[disabled ? 'addClass' : 'removeClass'](this.disabledClass); - } - this.el.dom.disabled = disabled; - } - this.disabled = disabled; - }, + /** + * @cfg {Boolean} readOnly true to prevent the user from changing the field, and + * hides the trigger. Supercedes the editable and hideTrigger options if the value is true. + * (defaults to false) + */ + readOnly: false, /** - * Show this button's menu (if it has one) + * @cfg {Boolean} selectOnFocus true to select any existing text in the field immediately on focus. + * Only applies when {@link #editable editable} = true (defaults to false). */ - showMenu : function(){ - if(this.rendered && this.menu){ - if(this.tooltip){ - Ext.QuickTips.getQuickTip().cancelShow(this.btnEl); - } - if(this.menu.isVisible()){ - this.menu.hide(); - } - this.menu.ownerCt = this; - this.menu.show(this.el, this.menuAlign); - } - return this; - }, /** - * Hide this button's menu (if it has one) + * @cfg {Boolean} repeatTriggerClick true to attach a {@link Ext.util.ClickRepeater click repeater} + * to the trigger. Defaults to false. */ - hideMenu : function(){ - if(this.hasVisibleMenu()){ - this.menu.hide(); - } - return this; - }, + repeatTriggerClick: false, + /** - * Returns true if the button has a menu and it is visible - * @return {Boolean} + * @hide + * @method autoSize */ - hasVisibleMenu : function(){ - return this.menu && this.menu.ownerCt == this && this.menu.isVisible(); + autoSize: Ext.emptyFn, + // private + monitorTab: true, + // private + mimicing: false, + // private + triggerIndexRe: /trigger-index-(\d+)/, + + componentLayout: 'triggerfield', + + initComponent: function() { + this.wrapFocusCls = this.triggerWrapCls + '-focus'; + this.callParent(arguments); }, // private - onClick : function(e){ - if(e){ - e.preventDefault(); + onRender: function(ct, position) { + var me = this, + triggerCls, + triggerBaseCls = me.triggerBaseCls, + triggerWrapCls = me.triggerWrapCls, + triggerConfigs = [], + i; + + // triggerCls is a synonym for trigger1Cls, so copy it. + // TODO this triggerCls API design doesn't feel clean, especially where it butts up against the + // single triggerCls config. Should rethink this, perhaps something more structured like a list of + // trigger config objects that hold cls, handler, etc. + if (!me.trigger1Cls) { + me.trigger1Cls = me.triggerCls; } - if(e.button !== 0){ - return; + + // Create as many trigger elements as we have trigger Cls configs, but always at least one + for (i = 0; (triggerCls = me['trigger' + (i + 1) + 'Cls']) || i < 1; i++) { + triggerConfigs.push({ + cls: [Ext.baseCSSPrefix + 'trigger-index-' + i, triggerBaseCls, triggerCls].join(' '), + role: 'button' + }); } - if(!this.disabled){ - if(this.enableToggle && (this.allowDepress !== false || !this.pressed)){ - this.toggle(); - } - if(this.menu && !this.hasVisibleMenu() && !this.ignoreNextClick){ - this.showMenu(); - } - this.fireEvent('click', this, e); - if(this.handler){ - //this.el.removeClass('x-btn-over'); - this.handler.call(this.scope || this, this, e); + triggerConfigs[i - 1].cls += ' ' + triggerBaseCls + '-last'; + + Ext.applyIf(me.renderSelectors, { + /** + * @property triggerWrap + * @type Ext.core.Element + * A reference to the div element wrapping the trigger button(s). Only set after the field has been rendered. + */ + triggerWrap: '.' + triggerWrapCls + }); + Ext.applyIf(me.subTplData, { + triggerWrapCls: triggerWrapCls, + triggerEl: Ext.core.DomHelper.markup(triggerConfigs), + clearCls: me.clearCls + }); + + me.callParent(arguments); + + /** + * @property triggerEl + * @type Ext.CompositeElement + * A composite of all the trigger button elements. Only set after the field has been rendered. + */ + me.triggerEl = Ext.select('.' + triggerBaseCls, true, me.triggerWrap.dom); + + me.doc = Ext.isIE ? Ext.getBody() : Ext.getDoc(); + me.initTrigger(); + }, + + onEnable: function() { + this.callParent(); + this.triggerWrap.unmask(); + }, + + onDisable: function() { + this.callParent(); + this.triggerWrap.mask(); + }, + + afterRender: function() { + this.callParent(); + this.updateEditState(); + }, + + updateEditState: function() { + var me = this, + inputEl = me.inputEl, + triggerWrap = me.triggerWrap, + noeditCls = Ext.baseCSSPrefix + 'trigger-noedit', + displayed, + readOnly; + + if (me.rendered) { + if (me.readOnly) { + inputEl.addCls(noeditCls); + readOnly = true; + displayed = false; + } else { + if (me.editable) { + inputEl.removeCls(noeditCls); + readOnly = false; + } else { + inputEl.addCls(noeditCls); + readOnly = true; + } + displayed = !me.hideTrigger; } + + triggerWrap.setDisplayed(displayed); + inputEl.dom.readOnly = readOnly; + me.doComponentLayout(); } }, - // private - isMenuTriggerOver : function(e, internal){ - return this.menu && !internal; + /** + * Get the total width of the trigger button area. Only useful after the field has been rendered. + * @return {Number} The trigger width + */ + getTriggerWidth: function() { + var me = this, + triggerWrap = me.triggerWrap, + totalTriggerWidth = 0; + if (triggerWrap && !me.hideTrigger && !me.readOnly) { + me.triggerEl.each(function(trigger) { + totalTriggerWidth += trigger.getWidth(); + }); + totalTriggerWidth += me.triggerWrap.getFrameWidth('lr'); + } + return totalTriggerWidth; }, - // private - isMenuTriggerOut : function(e, internal){ - return this.menu && !internal; + setHideTrigger: function(hideTrigger) { + if (hideTrigger != this.hideTrigger) { + this.hideTrigger = hideTrigger; + this.updateEditState(); + } }, - // private - onMouseOver : function(e){ - if(!this.disabled){ - var internal = e.within(this.el, true); - if(!internal){ - this.el.addClass('x-btn-over'); - if(!this.monitoringMouseOver){ - this.doc.on('mouseover', this.monitorMouseOver, this); - this.monitoringMouseOver = true; - } - this.fireEvent('mouseover', this, e); - } - if(this.isMenuTriggerOver(e, internal)){ - this.fireEvent('menutriggerover', this, this.menu, e); - } + /** + * @param {Boolean} editable True to allow the user to directly edit the field text + * Allow or prevent the user from directly editing the field text. If false is passed, + * the user will only be able to modify the field using the trigger. Will also add + * a click event to the text field which will call the trigger. This method + * is the runtime equivalent of setting the 'editable' config option at config time. + */ + setEditable: function(editable) { + if (editable != this.editable) { + this.editable = editable; + this.updateEditState(); } }, - // private - monitorMouseOver : function(e){ - if(e.target != this.el.dom && !e.within(this.el)){ - if(this.monitoringMouseOver){ - this.doc.un('mouseover', this.monitorMouseOver, this); - this.monitoringMouseOver = false; - } - this.onMouseOut(e); + /** + * @param {Boolean} readOnly True to prevent the user changing the field and explicitly + * hide the trigger. + * Setting this to true will superceed settings editable and hideTrigger. + * Setting this to false will defer back to editable and hideTrigger. This method + * is the runtime equivalent of setting the 'readOnly' config option at config time. + */ + setReadOnly: function(readOnly) { + if (readOnly != this.readOnly) { + this.readOnly = readOnly; + this.updateEditState(); } }, // private - onMouseOut : function(e){ - var internal = e.within(this.el) && e.target != this.el.dom; - this.el.removeClass('x-btn-over'); - this.fireEvent('mouseout', this, e); - if(this.isMenuTriggerOut(e, internal)){ - this.fireEvent('menutriggerout', this, this.menu, e); + initTrigger: function() { + var me = this, + triggerWrap = me.triggerWrap, + triggerEl = me.triggerEl; + + if (me.repeatTriggerClick) { + me.triggerRepeater = Ext.create('Ext.util.ClickRepeater', triggerWrap, { + preventDefault: true, + handler: function(cr, e) { + me.onTriggerWrapClick(e); + } + }); + } else { + me.mon(me.triggerWrap, 'click', me.onTriggerWrapClick, me); } - }, - focus : function() { - this.btnEl.focus(); + triggerEl.addClsOnOver(me.triggerBaseCls + '-over'); + triggerEl.each(function(el, c, i) { + el.addClsOnOver(me['trigger' + (i + 1) + 'Cls'] + '-over'); + }); + triggerEl.addClsOnClick(me.triggerBaseCls + '-click'); + triggerEl.each(function(el, c, i) { + el.addClsOnClick(me['trigger' + (i + 1) + 'Cls'] + '-click'); + }); }, - blur : function() { - this.btnEl.blur(); + // private + onDestroy: function() { + var me = this; + Ext.destroyMembers(me, 'triggerRepeater', 'triggerWrap', 'triggerEl'); + delete me.doc; + me.callParent(); }, // private - onFocus : function(e){ - if(!this.disabled){ - this.el.addClass('x-btn-focus'); + onFocus: function() { + var me = this; + this.callParent(); + if (!me.mimicing) { + me.bodyEl.addCls(me.wrapFocusCls); + me.mimicing = true; + me.mon(me.doc, 'mousedown', me.mimicBlur, me, { + delay: 10 + }); + if (me.monitorTab) { + me.on('specialkey', me.checkTab, me); + } } }, + // private - onBlur : function(e){ - this.el.removeClass('x-btn-focus'); + checkTab: function(me, e) { + if (!this.ignoreMonitorTab && e.getKey() == e.TAB) { + this.triggerBlur(); + } }, // private - getClickEl : function(e, isUp){ - return this.el; - }, + onBlur: Ext.emptyFn, // private - onMouseDown : function(e){ - if(!this.disabled && e.button === 0){ - this.getClickEl(e).addClass('x-btn-click'); - this.doc.on('mouseup', this.onMouseUp, this); + mimicBlur: function(e) { + if (!this.isDestroyed && !this.bodyEl.contains(e.target) && this.validateBlur(e)) { + this.triggerBlur(); } }, + // private - onMouseUp : function(e){ - if(e.button === 0){ - this.getClickEl(e, true).removeClass('x-btn-click'); - this.doc.un('mouseup', this.onMouseUp, this); + triggerBlur: function() { + var me = this; + me.mimicing = false; + me.mun(me.doc, 'mousedown', me.mimicBlur, me); + if (me.monitorTab && me.inputEl) { + me.un('specialkey', me.checkTab, me); + } + Ext.form.field.Trigger.superclass.onBlur.call(me); + if (me.bodyEl) { + me.bodyEl.removeCls(me.wrapFocusCls); } }, + + beforeBlur: Ext.emptyFn, + // private - onMenuShow : function(e){ - if(this.menu.ownerCt == this){ - this.menu.ownerCt = this; - this.ignoreNextClick = 0; - this.el.addClass('x-btn-menu-active'); - this.fireEvent('menushow', this, this.menu); - } + // This should be overridden by any subclass that needs to check whether or not the field can be blurred. + validateBlur: function(e) { + return true; }, + // private - onMenuHide : function(e){ - if(this.menu.ownerCt == this){ - this.el.removeClass('x-btn-menu-active'); - this.ignoreNextClick = this.restoreClick.defer(250, this); - this.fireEvent('menuhide', this, this.menu); - delete this.menu.ownerCt; + // process clicks upon triggers. + // determine which trigger index, and dispatch to the appropriate click handler + onTriggerWrapClick: function(e) { + var me = this, + t = e && e.getTarget('.' + Ext.baseCSSPrefix + 'form-trigger', null), + match = t && t.className.match(me.triggerIndexRe), + idx, + triggerClickMethod; + + if (match && !me.readOnly) { + idx = parseInt(match[1], 10); + triggerClickMethod = me['onTrigger' + (idx + 1) + 'Click'] || me.onTriggerClick; + if (triggerClickMethod) { + triggerClickMethod.call(me, e); + } } }, - // private - restoreClick : function(){ - this.ignoreNextClick = 0; - } + /** + * The function that should handle the trigger's click event. This method does nothing by default + * until overridden by an implementing function. See Ext.form.field.ComboBox and Ext.form.field.Date for + * sample implementations. + * @method + * @param {Ext.EventObject} e + */ + onTriggerClick: Ext.emptyFn /** - * @cfg {String} autoEl @hide + * @cfg {Boolean} grow @hide */ /** - * @cfg {String/Object} html @hide + * @cfg {Number} growMin @hide */ /** - * @cfg {String} contentEl @hide + * @cfg {Number} growMax @hide */ +}); + +/** + * @class Ext.form.field.Picker + * @extends Ext.form.field.Trigger + * An abstract class for fields that have a single trigger which opens a "picker" popup below + * the field, e.g. a combobox menu list or a date picker. It provides a base implementation for + * toggling the picker's visibility when the trigger is clicked, as well as keyboard navigation + * and some basic events. Sizing and alignment of the picker can be controlled via the {@link #matchFieldWidth} + * and {@link #pickerAlign}/{@link #pickerOffset} config properties respectively.
+ *You would not normally use this class directly, but instead use it as the parent class for + * a specific picker field implementation. Subclasses must implement the {@link #createPicker} method + * to create a picker component appropriate for the field.
+ * + */ +Ext.define('Ext.form.field.Picker', { + extend: 'Ext.form.field.Trigger', + alias: 'widget.pickerfield', + alternateClassName: 'Ext.form.Picker', + requires: ['Ext.util.KeyNav'], + /** - * @cfg {Mixed} data @hide + * @cfg {Boolean} matchFieldWidth + * Whether the picker dropdown's width should be explicitly set to match the width of the field. + * Defaults to true. */ + matchFieldWidth: true, + /** - * @cfg {Mixed} tpl @hide + * @cfg {String} pickerAlign + * The {@link Ext.core.Element#alignTo alignment position} with which to align the picker. Defaults + * to "tl-bl?" */ + pickerAlign: 'tl-bl?', + /** - * @cfg {String} tplWriteMode @hide + * @cfg {Array} pickerOffset + * An offset [x,y] to use in addition to the {@link #pickerAlign} when positioning the picker. + * Defaults to undefined. */ -}); -Ext.reg('button', Ext.Button); -// Private utility class used by Button -Ext.ButtonToggleMgr = function(){ - var groups = {}; + /** + * @cfg {String} openCls + * A class to be added to the field's {@link #bodyEl} element when the picker is opened. Defaults + * to 'x-pickerfield-open'. + */ + openCls: Ext.baseCSSPrefix + 'pickerfield-open', - function toggleGroup(btn, state){ - if(state){ - var g = groups[btn.toggleGroup]; - for(var i = 0, l = g.length; i < l; i++){ - if(g[i] != btn){ - g[i].toggle(false); - } - } - } - } + /** + * @property isExpanded + * @type Boolean + * True if the picker is currently expanded, false if not. + */ - return { - register : function(btn){ - if(!btn.toggleGroup){ - return; - } - var g = groups[btn.toggleGroup]; - if(!g){ - g = groups[btn.toggleGroup] = []; - } - g.push(btn); - btn.on('toggle', toggleGroup); - }, + /** + * @cfg {Boolean} editable false to prevent the user from typing text directly into the field; + * the field can only have its value set via selecting a value from the picker. In this state, the picker + * can also be opened by clicking directly on the input field itself. + * (defaults to true). + */ + editable: true, - unregister : function(btn){ - if(!btn.toggleGroup){ - return; - } - var g = groups[btn.toggleGroup]; - if(g){ - g.remove(btn); - btn.un('toggle', toggleGroup); - } - }, - /** - * Gets the pressed button in the passed group or null - * @param {String} group - * @return Button - */ - getPressed : function(group){ - var g = groups[group]; - if(g){ - for(var i = 0, len = g.length; i < len; i++){ - if(g[i].pressed === true){ - return g[i]; - } - } - } - return null; - } - }; -}(); -/** - * @class Ext.SplitButton - * @extends Ext.Button - * A split button that provides a built-in dropdown arrow that can fire an event separately from the default - * click event of the button. Typically this would be used to display a dropdown menu that provides additional - * options to the primary button action, but any custom handler can provide the arrowclick implementation. Example usage: - *- * @cfg {Function} arrowHandler A function called when the arrow button is clicked (can be used instead of click event) - * @cfg {String} arrowTooltip The title attribute of the arrow - * @constructor - * Create a new menu button - * @param {Object} config The config object - * @xtype splitbutton - */ -Ext.SplitButton = Ext.extend(Ext.Button, { - // private - arrowSelector : 'em', - split: true, + // Custom events + this.addEvents( + /** + * @event expand + * Fires when the field's picker is expanded. + * @param {Ext.form.field.Picker} field This field instance + */ + 'expand', + /** + * @event collapse + * Fires when the field's picker is collapsed. + * @param {Ext.form.field.Picker} field This field instance + */ + 'collapse', + /** + * @event select + * Fires when a value is selected via the picker. + * @param {Ext.form.field.Picker} field This field instance + * @param {Mixed} value The value that was selected. The exact type of this value is dependent on + * the individual field and picker implementations. + */ + 'select' + ); + }, - // private - initComponent : function(){ - Ext.SplitButton.superclass.initComponent.call(this); - /** - * @event arrowclick - * Fires when this button's arrow is clicked - * @param {MenuButton} this - * @param {EventObject} e The click event - */ - this.addEvents("arrowclick"); + + initEvents: function() { + var me = this; + me.callParent(); + + // Add handlers for keys to expand/collapse the picker + me.keyNav = Ext.create('Ext.util.KeyNav', me.inputEl, { + down: function() { + if (!me.isExpanded) { + // Don't call expand() directly as there may be additional processing involved before + // expanding, e.g. in the case of a ComboBox query. + me.onTriggerClick(); + } + }, + esc: me.collapse, + scope: me, + forceKeyDown: true + }); + + // Non-editable allows opening the picker by clicking the field + if (!me.editable) { + me.mon(me.inputEl, 'click', me.onTriggerClick, me); + } + + // Disable native browser autocomplete + if (Ext.isGecko) { + me.inputEl.dom.setAttribute('autocomplete', 'off'); + } }, - // private - onRender : function(){ - Ext.SplitButton.superclass.onRender.apply(this, arguments); - if(this.arrowTooltip){ - this.el.child(this.arrowSelector).dom[this.tooltipType] = this.arrowTooltip; + + /** + * Expand this field's picker dropdown. + */ + expand: function() { + var me = this, + bodyEl, picker, collapseIf; + + if (me.rendered && !me.isExpanded && !me.isDestroyed) { + bodyEl = me.bodyEl; + picker = me.getPicker(); + collapseIf = me.collapseIf; + + // show the picker and set isExpanded flag + picker.show(); + me.isExpanded = true; + me.alignPicker(); + bodyEl.addCls(me.openCls); + + // monitor clicking and mousewheel + me.mon(Ext.getDoc(), { + mousewheel: collapseIf, + mousedown: collapseIf, + scope: me + }); + Ext.EventManager.onWindowResize(me.alignPicker, me); + me.fireEvent('expand', me); + me.onExpand(); } }, + onExpand: Ext.emptyFn, + /** - * Sets this button's arrow click handler. - * @param {Function} handler The function to call when the arrow is clicked - * @param {Object} scope (optional) Scope for the function passed above + * @protected + * Aligns the picker to the */ - setArrowHandler : function(handler, scope){ - this.arrowHandler = handler; - this.scope = scope; + alignPicker: function() { + var me = this, + picker, isAbove, + aboveSfx = '-above'; + + if (this.isExpanded) { + picker = me.getPicker(); + if (me.matchFieldWidth) { + // Auto the height (it will be constrained by min and max width) unless there are no records to display. + picker.setSize(me.bodyEl.getWidth(), picker.store && picker.store.getCount() ? null : 0); + } + if (picker.isFloating()) { + picker.alignTo(me.inputEl, me.pickerAlign, me.pickerOffset); + + // add the {openCls}-above class if the picker was aligned above + // the field due to hitting the bottom of the viewport + isAbove = picker.el.getY() < me.inputEl.getY(); + me.bodyEl[isAbove ? 'addCls' : 'removeCls'](me.openCls + aboveSfx); + picker.el[isAbove ? 'addCls' : 'removeCls'](picker.baseCls + aboveSfx); + } + } + }, + + /** + * Collapse this field's picker dropdown. + */ + collapse: function() { + if (this.isExpanded && !this.isDestroyed) { + var me = this, + openCls = me.openCls, + picker = me.picker, + doc = Ext.getDoc(), + collapseIf = me.collapseIf, + aboveSfx = '-above'; + + // hide the picker and set isExpanded flag + picker.hide(); + me.isExpanded = false; + + // remove the openCls + me.bodyEl.removeCls([openCls, openCls + aboveSfx]); + picker.el.removeCls(picker.baseCls + aboveSfx); + + // remove event listeners + doc.un('mousewheel', collapseIf, me); + doc.un('mousedown', collapseIf, me); + Ext.EventManager.removeResizeListener(me.alignPicker, me); + me.fireEvent('collapse', me); + me.onCollapse(); + } }, - getMenuClass : function(){ - return 'x-btn-split' + (this.arrowAlign == 'bottom' ? '-bottom' : ''); + onCollapse: Ext.emptyFn, + + + /** + * @private + * Runs on mousewheel and mousedown of doc to check to see if we should collapse the picker + */ + collapseIf: function(e) { + var me = this; + if (!me.isDestroyed && !e.within(me.bodyEl, false, true) && !e.within(me.picker.el, false, true)) { + me.collapse(); + } }, - isClickOnArrow : function(e){ - if (this.arrowAlign != 'bottom') { - var visBtn = this.el.child('em.x-btn-split'); - var right = visBtn.getRegion().right - visBtn.getPadding('r'); - return e.getPageX() > right; - } else { - return e.getPageY() > this.btnEl.getRegion().bottom; - } + /** + * Return a reference to the picker component for this field, creating it if necessary by + * calling {@link #createPicker}. + * @return {Ext.Component} The picker component + */ + getPicker: function() { + var me = this; + return me.picker || (me.picker = me.createPicker()); }, - // private - onClick : function(e, t){ - e.preventDefault(); - if(!this.disabled){ - if(this.isClickOnArrow(e)){ - if(this.menu && !this.menu.isVisible() && !this.ignoreNextClick){ - this.showMenu(); - } - this.fireEvent("arrowclick", this, e); - if(this.arrowHandler){ - this.arrowHandler.call(this.scope || this, this, e); - } - }else{ - if(this.enableToggle){ - this.toggle(); - } - this.fireEvent("click", this, e); - if(this.handler){ - this.handler.call(this.scope || this, this, e); - } + /** + * Create and return the component to be used as this field's picker. Must be implemented + * by subclasses of Picker. + * @return {Ext.Component} The picker component + */ + createPicker: Ext.emptyFn, + + /** + * Handles the trigger click; by default toggles between expanding and collapsing the + * picker component. + */ + onTriggerClick: function() { + var me = this; + if (!me.readOnly && !me.disabled) { + if (me.isExpanded) { + me.collapse(); + } else { + me.expand(); } + me.inputEl.focus(); } }, - // private - isMenuTriggerOver : function(e){ - return this.menu && e.target.tagName == this.arrowSelector; + mimicBlur: function(e) { + var me = this, + picker = me.picker; + // ignore mousedown events within the picker element + if (!picker || !e.within(picker.el, false, true)) { + me.callParent(arguments); + } }, - // private - isMenuTriggerOut : function(e, internal){ - return this.menu && e.target.tagName != this.arrowSelector; + onDestroy : function(){ + var me = this; + Ext.EventManager.removeResizeListener(me.alignPicker, me); + Ext.destroy(me.picker, me.keyNav); + me.callParent(); } -}); -Ext.reg('splitbutton', Ext.SplitButton);/** - * @class Ext.CycleButton - * @extends Ext.SplitButton - * A specialized SplitButton that contains a menu of {@link Ext.menu.CheckItem} elements. The button automatically - * cycles through each menu item on click, raising the button's {@link #change} event (or calling the button's - * {@link #changeHandler} function, if supplied) for the active menu item. Clicking on the arrow section of the - * button displays the dropdown menu just like a normal SplitButton. Example usage: - *-// display a dropdown menu: -new Ext.SplitButton({ - renderTo: 'button-ct', // the container id - text: 'Options', - handler: optionsHandler, // handle a click on the button itself - menu: new Ext.menu.Menu({ - items: [ - // these items will render as dropdown menu items when the arrow is clicked: - {text: 'Item 1', handler: item1Handler}, - {text: 'Item 2', handler: item2Handler} - ] - }) -}); + initComponent: function() { + this.callParent(); -// Instead of showing a menu, you provide any type of custom -// functionality you want when the dropdown arrow is clicked: -new Ext.SplitButton({ - renderTo: 'button-ct', - text: 'Options', - handler: optionsHandler, - arrowHandler: myCustomHandler -}); -
- * @constructor - * Create a new split button - * @param {Object} config The config object - * @xtype cycle + + +/** + * @class Ext.form.field.Spinner + * @extends Ext.form.field.Trigger + *-var btn = new Ext.CycleButton({ - showText: true, - prependText: 'View as ', - items: [{ - text:'text only', - iconCls:'view-text', - checked:true - },{ - text:'HTML', - iconCls:'view-html' - }], - changeHandler:function(btn, item){ - Ext.Msg.alert('Change View', item.text); - } }); -
A field with a pair of up/down spinner buttons. This class is not normally instantiated directly, + * instead it is subclassed and the {@link #onSpinUp} and {@link #onSpinDown} methods are implemented + * to handle when the buttons are clicked. A good example of this is the {@link Ext.form.field.Number} field + * which uses the spinner to increment and decrement the field's value by its {@link Ext.form.field.Number#step step} + * config value.
+ * {@img Ext.form.field.Spinner/Ext.form.field.Spinner.png Ext.form.field.Spinner field} + * For example: + Ext.define('Ext.ux.CustomSpinner', { + extend: 'Ext.form.field.Spinner', + alias: 'widget.customspinner', + + // override onSpinUp (using step isn't neccessary) + onSpinUp: function() { + var me = this; + if (!me.readOnly) { + var val = me.step; // set the default value to the step value + if(me.getValue() !== '') { + val = parseInt(me.getValue().slice(0, -5)); // gets rid of " Pack" + } + me.setValue((val + me.step) + ' Pack'); + } + }, + + // override onSpinDown + onSpinDown: function() { + var me = this; + if (!me.readOnly) { + if(me.getValue() !== '') { + val = parseInt(me.getValue().slice(0, -5)); // gets rid of " Pack" + } + me.setValue((val - me.step) + ' Pack'); + } + } + }); + + Ext.create('Ext.form.FormPanel', { + title: 'Form with SpinnerField', + bodyPadding: 5, + width: 350, + renderTo: Ext.getBody(), + items:[{ + xtype: 'customspinner', + fieldLabel: 'How Much Beer?', + step: 6 + }] + }); + *By default, pressing the up and down arrow keys will also trigger the onSpinUp and onSpinDown methods; + * to prevent this, set {@link #keyNavEnabled} = false.
+ * */ -Ext.CycleButton = Ext.extend(Ext.SplitButton, { +Ext.define('Ext.form.field.Spinner', { + extend: 'Ext.form.field.Trigger', + alias: 'widget.spinnerfield', + alternateClassName: 'Ext.form.Spinner', + requires: ['Ext.util.KeyNav'], + + trigger1Cls: Ext.baseCSSPrefix + 'form-spinner-up', + trigger2Cls: Ext.baseCSSPrefix + 'form-spinner-down', + /** - * @cfg {Array} items An array of {@link Ext.menu.CheckItem} config objects to be used when creating the - * button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'}) + * @cfg {Boolean} spinUpEnabled + * Specifies whether the up spinner button is enabled. Defaults to true. To change this + * after the component is created, use the {@link #setSpinUpEnabled} method. + */ + spinUpEnabled: true, + + /** + * @cfg {Boolean} spinDownEnabled + * Specifies whether the down spinner button is enabled. Defaults to true. To change this + * after the component is created, use the {@link #setSpinDownEnabled} method. */ + spinDownEnabled: true, + /** - * @cfg {Boolean} showText True to display the active item's text as the button text (defaults to false) + * @cfg {Boolean} keyNavEnabled + * Specifies whether the up and down arrow keys should trigger spinning up and down. + * Defaults to true. */ + keyNavEnabled: true, + /** - * @cfg {String} prependText A static string to prepend before the active item's text when displayed as the - * button's text (only applies when showText = true, defaults to '') + * @cfg {Boolean} mouseWheelEnabled + * Specifies whether the mouse wheel should trigger spinning up and down while the field has + * focus. Defaults to true. */ + mouseWheelEnabled: true, + /** - * @cfg {Function} changeHandler A callback function that will be invoked each time the active menu - * item in the button's menu has changed. If this callback is not supplied, the SplitButton will instead - * fire the {@link #change} event on active item change. The changeHandler function will be called with the - * following argument list: (SplitButton this, Ext.menu.CheckItem item) + * @cfg {Boolean} repeatTriggerClick Whether a {@link Ext.util.ClickRepeater click repeater} should be + * attached to the spinner buttons. Defaults to true. */ + repeatTriggerClick: true, + /** - * @cfg {String} forceIcon A css class which sets an image to be used as the static icon for this button. This - * icon will always be displayed regardless of which item is selected in the dropdown list. This overrides the - * default behavior of changing the button's icon to match the selected item's icon on change. + * This method is called when the spinner up button is clicked, or when the up arrow key is pressed + * if {@link #keyNavEnabled} is true. Must be implemented by subclasses. */ + onSpinUp: Ext.emptyFn, + /** - * @property menu - * @type Menu - * The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices. + * This method is called when the spinner down button is clicked, or when the down arrow key is pressed + * if {@link #keyNavEnabled} is true. Must be implemented by subclasses. */ + onSpinDown: Ext.emptyFn, - // private - getItemText : function(item){ - if(item && this.showText === true){ - var text = ''; - if(this.prependText){ - text += this.prependText; - } - text += item.text; - return text; - } - return undefined; + initComponent: function() { + this.callParent(); + + this.addEvents( + /** + * @event spin + * Fires when the spinner is made to spin up or down. + * @param {Ext.form.field.Spinner} this + * @param {String} direction Either 'up' if spinning up, or 'down' if spinning down. + */ + 'spin', + + /** + * @event spinup + * Fires when the spinner is made to spin up. + * @param {Ext.form.field.Spinner} this + */ + 'spinup', + + /** + * @event spindown + * Fires when the spinner is made to spin down. + * @param {Ext.form.field.Spinner} this + */ + 'spindown' + ); }, /** - * Sets the button's active menu item. - * @param {Ext.menu.CheckItem} item The item to activate - * @param {Boolean} suppressEvent True to prevent the button's change event from firing (defaults to false) + * @private override */ - setActiveItem : function(item, suppressEvent){ - if(!Ext.isObject(item)){ - item = this.menu.getComponent(item); + onRender: function() { + var me = this, + triggers; + + me.callParent(arguments); + triggers = me.triggerEl; + + /** + * @property spinUpEl + * @type Ext.core.Element + * The spinner up button element + */ + me.spinUpEl = triggers.item(0); + /** + * @property spinDownEl + * @type Ext.core.Element + * The spinner down button element + */ + me.spinDownEl = triggers.item(1); + + // Set initial enabled/disabled states + me.setSpinUpEnabled(me.spinUpEnabled); + me.setSpinDownEnabled(me.spinDownEnabled); + + // Init up/down arrow keys + if (me.keyNavEnabled) { + me.spinnerKeyNav = Ext.create('Ext.util.KeyNav', me.inputEl, { + scope: me, + up: me.spinUp, + down: me.spinDown + }); } - if(item){ - if(!this.rendered){ - this.text = this.getItemText(item); - this.iconCls = item.iconCls; - }else{ - var t = this.getItemText(item); - if(t){ - this.setText(t); - } - this.setIconClass(item.iconCls); - } - this.activeItem = item; - if(!item.checked){ - item.setChecked(true, false); - } - if(this.forceIcon){ - this.setIconClass(this.forceIcon); - } - if(!suppressEvent){ - this.fireEvent('change', this, item); - } + + // Init mouse wheel + if (me.mouseWheelEnabled) { + me.mon(me.bodyEl, 'mousewheel', me.onMouseWheel, me); } }, /** - * Gets the currently active menu item. - * @return {Ext.menu.CheckItem} The active item + * @private override + * Since the triggers are stacked, only measure the width of one of them. */ - getActiveItem : function(){ - return this.activeItem; + getTriggerWidth: function() { + return this.hideTrigger || this.readOnly ? 0 : this.spinUpEl.getWidth() + this.triggerWrap.getFrameWidth('lr'); }, - // private - initComponent : function(){ - this.addEvents( - /** - * @event change - * Fires after the button's active menu item has changed. Note that if a {@link #changeHandler} function - * is set on this CycleButton, it will be called instead on active item change and this change event will - * not be fired. - * @param {Ext.CycleButton} this - * @param {Ext.menu.CheckItem} item The menu item that was selected - */ - "change" - ); + /** + * @private Handles the spinner up button clicks. + */ + onTrigger1Click: function() { + this.spinUp(); + }, + + /** + * @private Handles the spinner down button clicks. + */ + onTrigger2Click: function() { + this.spinDown(); + }, - if(this.changeHandler){ - this.on('change', this.changeHandler, this.scope||this); - delete this.changeHandler; + /** + * Triggers the spinner to step up; fires the {@link #spin} and {@link #spinup} events and calls the + * {@link #onSpinUp} method. Does nothing if the field is {@link #disabled} or if {@link #spinUpEnabled} + * is false. + */ + spinUp: function() { + var me = this; + if (me.spinUpEnabled && !me.disabled) { + me.fireEvent('spin', me, 'up'); + me.fireEvent('spinup', me); + me.onSpinUp(); } + }, - this.itemCount = this.items.length; + /** + * Triggers the spinner to step down; fires the {@link #spin} and {@link #spindown} events and calls the + * {@link #onSpinDown} method. Does nothing if the field is {@link #disabled} or if {@link #spinDownEnabled} + * is false. + */ + spinDown: function() { + var me = this; + if (me.spinDownEnabled && !me.disabled) { + me.fireEvent('spin', me, 'down'); + me.fireEvent('spindown', me); + me.onSpinDown(); + } + }, - this.menu = {cls:'x-cycle-menu', items:[]}; - var checked = 0; - Ext.each(this.items, function(item, i){ - Ext.apply(item, { - group: item.group || this.id, - itemIndex: i, - checkHandler: this.checkHandler, - scope: this, - checked: item.checked || false - }); - this.menu.items.push(item); - if(item.checked){ - checked = i; - } - }, this); - Ext.CycleButton.superclass.initComponent.call(this); - this.on('click', this.toggleSelected, this); - this.setActiveItem(checked, true); + /** + * Sets whether the spinner up button is enabled. + * @param {Boolean} enabled true to enable the button, false to disable it. + */ + setSpinUpEnabled: function(enabled) { + var me = this, + wasEnabled = me.spinUpEnabled; + me.spinUpEnabled = enabled; + if (wasEnabled !== enabled && me.rendered) { + me.spinUpEl[enabled ? 'removeCls' : 'addCls'](me.trigger1Cls + '-disabled'); + } }, - // private - checkHandler : function(item, pressed){ - if(pressed){ - this.setActiveItem(item); + /** + * Sets whether the spinner down button is enabled. + * @param {Boolean} enabled true to enable the button, false to disable it. + */ + setSpinDownEnabled: function(enabled) { + var me = this, + wasEnabled = me.spinDownEnabled; + me.spinDownEnabled = enabled; + if (wasEnabled !== enabled && me.rendered) { + me.spinDownEl[enabled ? 'removeCls' : 'addCls'](me.trigger2Cls + '-disabled'); } }, /** - * This is normally called internally on button click, but can be called externally to advance the button's - * active item programmatically to the next one in the menu. If the current item is the last one in the menu - * the active item will be set to the first item in the menu. + * @private + * Handles mousewheel events on the field */ - toggleSelected : function(){ - var m = this.menu; - m.render(); - // layout if we haven't before so the items are active - if(!m.hasLayout){ - m.doLayout(); - } - - var nextIdx, checkItem; - for (var i = 1; i < this.itemCount; i++) { - nextIdx = (this.activeItem.itemIndex + i) % this.itemCount; - // check the potential item - checkItem = m.items.itemAt(nextIdx); - // if its not disabled then check it. - if (!checkItem.disabled) { - checkItem.setChecked(true); - break; + onMouseWheel: function(e) { + var me = this, + delta; + if (me.hasFocus) { + delta = e.getWheelDelta(); + if (delta > 0) { + me.spinUp(); + } + else if (delta < 0) { + me.spinDown(); } + e.stopEvent(); } - } -}); -Ext.reg('cycle', Ext.CycleButton);/** - * @class Ext.Toolbar - * @extends Ext.Container - *Basic Toolbar class. Although the {@link Ext.Container#defaultType defaultType} for Toolbar - * is {@link Ext.Button button}, Toolbar elements (child items for the Toolbar container) may - * be virtually any type of Component. Toolbar elements can be created explicitly via their constructors, - * or implicitly via their xtypes, and can be {@link #add}ed dynamically.
- *Some items have shortcut strings for creation:
- *-Shortcut xtype Class Description -'->' 'tbfill' {@link Ext.Toolbar.Fill} begin using the right-justified button container -'-' 'tbseparator' {@link Ext.Toolbar.Separator} add a vertical separator bar between toolbar items -' ' 'tbspacer' {@link Ext.Toolbar.Spacer} add horiztonal space between elements - *- * - * Example usage of various elements: - *- * Example adding a ComboBox within a menu of a button: - *-var tb = new Ext.Toolbar({ - renderTo: document.body, - width: 600, - height: 100, - items: [ - { - // xtype: 'button', // default for Toolbars, same as 'tbbutton' - text: 'Button' - }, - { - xtype: 'splitbutton', // same as 'tbsplitbutton' - text: 'Split Button' - }, - // begin using the right-justified button container - '->', // same as {xtype: 'tbfill'}, // Ext.Toolbar.Fill - { - xtype: 'textfield', - name: 'field1', - emptyText: 'enter search term' - }, - // add a vertical separator bar between toolbar items - '-', // same as {xtype: 'tbseparator'} to create Ext.Toolbar.Separator - 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.Toolbar.TextItem - {xtype: 'tbspacer'},// same as ' ' to create Ext.Toolbar.Spacer - 'text 2', - {xtype: 'tbspacer', width: 50}, // add a 50px space - 'text 3' - ] -}); - *
- * @constructor - * Creates a new Toolbar - * @param {Object/Array} config A config object or an array of buttons to {@link #add} - * @xtype toolbar - */ -Ext.Toolbar = function(config){ - if(Ext.isArray(config)){ - config = {items: config, layout: 'toolbar'}; - } else { - config = Ext.apply({ - layout: 'toolbar' - }, config); - if(config.buttons) { - config.items = config.buttons; - } - } - Ext.Toolbar.superclass.constructor.call(this, config); -}; -(function(){ +#Removing UI Enhancements# +{@img Ext.form.Number/Ext.form.Number2.png Ext.form.Number component} + Ext.create('Ext.form.Panel', { + title: 'Personal Info', + width: 300, + bodyPadding: 10, + renderTo: Ext.getBody(), + items: [{ + xtype: 'numberfield', + anchor: '100%', + name: 'age', + fieldLabel: 'Age', + minValue: 0, //prevents negative numbers + + // Remove spinner buttons, and arrow key and mouse wheel listeners + hideTrigger: true, + keyNavEnabled: false, + mouseWheelEnabled: false + }] + }); -var T = Ext.Toolbar; +#Using Step# + Ext.create('Ext.form.Panel', { + renderTo: Ext.getBody(), + title: 'Step', + width: 300, + bodyPadding: 10, + items: [{ + xtype: 'numberfield', + anchor: '100%', + name: 'evens', + fieldLabel: 'Even Numbers', -Ext.extend(T, Ext.Container, { + // Set step so it skips every other number + step: 2, + value: 0, - defaultType: 'button', + // Add change handler to force user-entered numbers to evens + listeners: { + change: function(field, value) { + value = parseInt(value, 10); + field.setValue(value + value % 2); + } + } + }] + }); - /** - * @cfg {String/Object} layout - * This class assigns a default layout (-// ComboBox creation -var combo = new Ext.form.ComboBox({ - store: new Ext.data.ArrayStore({ - autoDestroy: true, - fields: ['initials', 'fullname'], - data : [ - ['FF', 'Fred Flintstone'], - ['BR', 'Barney Rubble'] - ] - }), - displayField: 'fullname', - typeAhead: true, - mode: 'local', - forceSelection: true, - triggerAction: 'all', - emptyText: 'Select a name...', - selectOnFocus: true, - width: 135, - getListParent: function() { - return this.el.up('.x-menu'); }, - iconCls: 'no-icon' //use iconCls if placing within menu to shift to right side of menu -}); -// put ComboBox in a Menu -var menu = new Ext.menu.Menu({ - id: 'mainMenu', - items: [ - combo // A Field in a Menu - ] -}); + onDestroy: function() { + Ext.destroyMembers(this, 'spinnerKeyNav', 'spinUpEl', 'spinDownEl'); + this.callParent(); + } -// add a Button with the menu -tb.add({ - text:'Button w/ Menu', - menu: menu // assign menu by instance +}); +/** + * @class Ext.form.field.Number + * @extends Ext.form.field.Spinner + +A numeric text field that provides automatic keystroke filtering to disallow non-numeric characters, +and numeric validation to limit the value to a range of valid numbers. The range of acceptable number +values can be controlled by setting the {@link #minValue} and {@link #maxValue} configs, and fractional +decimals can be disallowed by setting {@link #allowDecimals} to `false`. + +By default, the number field is also rendered with a set of up/down spinner buttons and has +up/down arrow key and mouse wheel event listeners attached for incrementing/decrementing the value by the +{@link #step} value. To hide the spinner buttons set `{@link #hideTrigger hideTrigger}:true`; to disable the arrow key +and mouse wheel handlers set `{@link #keyNavEnabled keyNavEnabled}:false` and +`{@link #mouseWheelEnabled mouseWheelEnabled}:false`. See the example below. + +#Example usage:# +{@img Ext.form.Number/Ext.form.Number1.png Ext.form.Number component} + Ext.create('Ext.form.Panel', { + title: 'On The Wall', + width: 300, + bodyPadding: 10, + renderTo: Ext.getBody(), + items: [{ + xtype: 'numberfield', + anchor: '100%', + name: 'bottles', + fieldLabel: 'Bottles of Beer', + value: 99, + maxValue: 99, + minValue: 0 + }], + buttons: [{ + text: 'Take one down, pass it around', + handler: function() { + this.up('form').down('[name=bottles]').spinDown(); + } + }] }); -tb.doLayout(); - *
layout:'toolbar'
). - * Developers may override this configuration option if another layout - * is required (the constructor must be passed a configuration object in this - * case instead of an array). - * See {@link Ext.Container#layout} for additional information. - */ - enableOverflow : false, + * + * @markdown + * @docauthor Jason Johnston+ */ +Ext.define('Ext.form.field.Number', { + extend:'Ext.form.field.Spinner', + alias: 'widget.numberfield', + alternateClassName: ['Ext.form.NumberField', 'Ext.form.Number'], /** - * @cfg {Boolean} enableOverflow - * Defaults to false. Configure true
to make the toolbar provide a button - * which activates a dropdown Menu to show items which overflow the Toolbar's width. + * @cfg {RegExp} stripCharsRe @hide */ /** - * @cfg {String} buttonAlign - *
The default position at which to align child items. Defaults to
- *"left"
May be specified as
- *"center"
to cause items added before a Fill (A"->"
) item - * to be centered in the Toolbar. Items added after a Fill are still right-aligned.Specify as
+ * @cfg {RegExp} maskRe @hide */ - trackMenus : true, - internalDefaults: {removeMode: 'container', hideParent: true}, - toolbarCls: 'x-toolbar', - - initComponent : function(){ - T.superclass.initComponent.call(this); - - /** - * @event overflowchange - * Fires after the overflow state has changed. - * @param {Object} c The Container - * @param {Boolean} lastOverflow overflow state - */ - this.addEvents('overflowchange'); - }, - - // private - onRender : function(ct, position){ - if(!this.el){ - if(!this.autoCreate){ - this.autoCreate = { - cls: this.toolbarCls + ' x-small-editor' - }; - } - this.el = ct.createChild(Ext.apply({ id: this.id },this.autoCreate), position); - Ext.Toolbar.superclass.onRender.apply(this, arguments); - } - }, - /** - *"right"
to right align all child items.Adds element(s) to the toolbar -- this function takes a variable number of - * arguments of mixed type and adds them to the toolbar.
- *Note: See the notes within {@link Ext.Container#add}.
- * @param {Mixed} arg1 The following types of arguments are all valid:
- *- *
- * @param {Mixed} arg2 - * @param {Mixed} etc. - * @method add + * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true) */ + allowDecimals : true, - // private - lookupComponent : function(c){ - if(Ext.isString(c)){ - if(c == '-'){ - c = new T.Separator(); - }else if(c == ' '){ - c = new T.Spacer(); - }else if(c == '->'){ - c = new T.Fill(); - }else{ - c = new T.TextItem(c); - } - this.applyDefaults(c); - }else{ - if(c.isFormField || c.render){ // some kind of form field, some kind of Toolbar.Item - c = this.createComponent(c); - }else if(c.tag){ // DomHelper spec - c = new T.Item({autoEl: c}); - }else if(c.tagName){ // element - c = new T.Item({el:c}); - }else if(Ext.isObject(c)){ // must be button config? - c = c.xtype ? this.createComponent(c) : this.constructButton(c); - } - } - return c; - }, - - // private - applyDefaults : function(c){ - if(!Ext.isString(c)){ - c = Ext.Toolbar.superclass.applyDefaults.call(this, c); - var d = this.internalDefaults; - if(c.events){ - Ext.applyIf(c.initialConfig, d); - Ext.apply(c, d); - }else{ - Ext.applyIf(c, d); - } - } - return c; - }, + /** + * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.') + */ + decimalSeparator : '.', /** - * Adds a separator - *- {@link Ext.Button} config: A valid button config object (equivalent to {@link #addButton})
- *- HtmlElement: Any standard HTML element (equivalent to {@link #addElement})
- *- Field: Any form field (equivalent to {@link #addField})
- *- Item: Any subclass of {@link Ext.Toolbar.Item} (equivalent to {@link #addItem})
- *- String: Any generic string (gets wrapped in a {@link Ext.Toolbar.TextItem}, equivalent to {@link #addText}). - * Note that there are a few special strings that are treated differently as explained next.
- *- '-': Creates a separator element (equivalent to {@link #addSeparator})
- *- ' ': Creates a spacer element (equivalent to {@link #addSpacer})
- *- '->': Creates a fill element (equivalent to {@link #addFill})
- *Note: See the notes within {@link Ext.Container#add}.
- * @return {Ext.Toolbar.Item} The separator {@link Ext.Toolbar.Item item} + * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2) */ - addSeparator : function(){ - return this.add(new T.Separator()); - }, + decimalPrecision : 2, /** - * Adds a spacer element - *Note: See the notes within {@link Ext.Container#add}.
- * @return {Ext.Toolbar.Spacer} The spacer item + * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY). Will be used by + * the field's validation logic, and for + * {@link Ext.form.field.Spinner#setSpinUpEnabled enabling/disabling the down spinner button}. */ - addSpacer : function(){ - return this.add(new T.Spacer()); - }, + minValue: Number.NEGATIVE_INFINITY, /** - * Forces subsequent additions into the float:right toolbar - *Note: See the notes within {@link Ext.Container#add}.
+ * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE). Will be used by + * the field's validation logic, and for + * {@link Ext.form.field.Spinner#setSpinUpEnabled enabling/disabling the up spinner button}. */ - addFill : function(){ - this.add(new T.Fill()); - }, + maxValue: Number.MAX_VALUE, /** - * Adds any standard HTML element to the toolbar - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Mixed} el The element or id of the element to add - * @return {Ext.Toolbar.Item} The element's item + * @cfg {Number} step Specifies a numeric interval by which the field's value will be incremented or + * decremented when the user invokes the spinner. Defaults to 1. */ - addElement : function(el){ - return this.addItem(new T.Item({el:el})); - }, + step: 1, /** - * Adds any Toolbar.Item or subclass - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Ext.Toolbar.Item} item - * @return {Ext.Toolbar.Item} The item + * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to 'The minimum + * value for this field is {minValue}') */ - addItem : function(item){ - return this.add.apply(this, arguments); - }, + minText : 'The minimum value for this field is {0}', /** - * Adds a button (or buttons). See {@link Ext.Button} for more info on the config. - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Object/Array} config A button config or array of configs - * @return {Ext.Button/Array} + * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to 'The maximum + * value for this field is {maxValue}') */ - addButton : function(config){ - if(Ext.isArray(config)){ - var buttons = []; - for(var i = 0, len = config.length; i < len; i++) { - buttons.push(this.addButton(config[i])); - } - return buttons; - } - return this.add(this.constructButton(config)); - }, + maxText : 'The maximum value for this field is {0}', /** - * Adds text to the toolbar - *Note: See the notes within {@link Ext.Container#add}.
- * @param {String} text The text to add - * @return {Ext.Toolbar.Item} The element's item + * @cfg {String} nanText Error text to display if the value is not a valid number. For example, this can happen + * if a valid character like '.' or '-' is left in the field with no number (defaults to '{value} is not a valid number') */ - addText : function(text){ - return this.addItem(new T.TextItem(text)); - }, + nanText : '{0} is not a valid number', /** - * Adds a new element to the toolbar from the passed {@link Ext.DomHelper} config - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Object} config - * @return {Ext.Toolbar.Item} The element's item + * @cfg {String} negativeText Error text to display if the value is negative and {@link #minValue} is set to + * 0. This is used instead of the {@link #minText} in that circumstance only. */ - addDom : function(config){ - return this.add(new T.Item({autoEl: config})); - }, + negativeText : 'The value cannot be negative', /** - * Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have - * been rendered yet. For a field that has already been rendered, use {@link #addElement}. - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Ext.form.Field} field - * @return {Ext.Toolbar.Item} + * @cfg {String} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789'). */ - addField : function(field){ - return this.add(field); - }, + baseChars : '0123456789', /** - * Inserts any {@link Ext.Toolbar.Item}/{@link Ext.Button} at the specified index. - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Number} index The index where the item is to be inserted - * @param {Object/Ext.Toolbar.Item/Ext.Button/Array} item The button, or button config object to be - * inserted, or an array of buttons/configs. - * @return {Ext.Button/Item} + * @cfg {Boolean} autoStripChars True to automatically strip not allowed characters from the field. Defaults to false */ - insertButton : function(index, item){ - if(Ext.isArray(item)){ - var buttons = []; - for(var i = 0, len = item.length; i < len; i++) { - buttons.push(this.insertButton(index + i, item[i])); + autoStripChars: false, + + initComponent: function() { + var me = this, + allowed; + + me.callParent(); + + me.setMinValue(me.minValue); + me.setMaxValue(me.maxValue); + + // Build regexes for masking and stripping based on the configured options + if (me.disableKeyFilter !== true) { + allowed = me.baseChars + ''; + if (me.allowDecimals) { + allowed += me.decimalSeparator; + } + if (me.minValue < 0) { + allowed += '-'; + } + allowed = Ext.String.escapeRegex(allowed); + me.maskRe = new RegExp('[' + allowed + ']'); + if (me.autoStripChars) { + me.stripCharsRe = new RegExp('[^' + allowed + ']', 'gi'); } - return buttons; } - return Ext.Toolbar.superclass.insert.call(this, index, item); }, - // private - trackMenu : function(item, remove){ - if(this.trackMenus && item.menu){ - var method = remove ? 'mun' : 'mon'; - this[method](item, 'menutriggerover', this.onButtonTriggerOver, this); - this[method](item, 'menushow', this.onButtonMenuShow, this); - this[method](item, 'menuhide', this.onButtonMenuHide, this); + /** + * Runs all of Number'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 validations run test that the value is a number, and that it is within the + * configured min and max values. + * @param {Mixed} value The value to get errors for (defaults to the current field value) + * @return {Array} All validation errors for this field + */ + getErrors: function(value) { + var me = this, + errors = me.callParent(arguments), + format = Ext.String.format, + num; + + value = Ext.isDefined(value) ? value : this.processRawValue(this.getRawValue()); + + if (value.length < 1) { // if it's blank and textfield didn't flag it then it's valid + return errors; } - }, - // private - constructButton : function(item){ - var b = item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType); - return b; - }, + value = String(value).replace(me.decimalSeparator, '.'); - // private - onAdd : function(c){ - Ext.Toolbar.superclass.onAdd.call(this); - this.trackMenu(c); - if(this.disabled){ - c.disable(); + if(isNaN(value)){ + errors.push(format(me.nanText, value)); + } + + num = me.parseValue(value); + + if (me.minValue === 0 && num < 0) { + errors.push(this.negativeText); + } + else if (num < me.minValue) { + errors.push(format(me.minText, me.minValue)); } - }, - // private - onRemove : function(c){ - Ext.Toolbar.superclass.onRemove.call(this); - this.trackMenu(c, true); - }, + if (num > me.maxValue) { + errors.push(format(me.maxText, me.maxValue)); + } - // private - onDisable : function(){ - this.items.each(function(item){ - if(item.disable){ - item.disable(); - } - }); - }, - // private - onEnable : function(){ - this.items.each(function(item){ - if(item.enable){ - item.enable(); - } - }); + return errors; }, - // private - onButtonTriggerOver : function(btn){ - if(this.activeMenuBtn && this.activeMenuBtn != btn){ - this.activeMenuBtn.hideMenu(); - btn.showMenu(); - this.activeMenuBtn = btn; + rawToValue: function(rawValue) { + var value = this.fixPrecision(this.parseValue(rawValue)); + if (value === null) { + value = rawValue || null; } + return value; }, - // private - onButtonMenuShow : function(btn){ - this.activeMenuBtn = btn; + valueToRaw: function(value) { + var me = this, + decimalSeparator = me.decimalSeparator; + value = me.parseValue(value); + value = me.fixPrecision(value); + value = Ext.isNumber(value) ? value : parseFloat(String(value).replace(decimalSeparator, '.')); + value = isNaN(value) ? '' : String(value).replace('.', decimalSeparator); + return value; }, - // private - onButtonMenuHide : function(btn){ - delete this.activeMenuBtn; - } -}); -Ext.reg('toolbar', Ext.Toolbar); + onChange: function() { + var me = this, + value = me.getValue(), + valueIsNull = value === null; -/** - * @class Ext.Toolbar.Item - * @extends Ext.BoxComponent - * The base class that other non-interacting Toolbar Item classes should extend in order to - * get some basic common toolbar item functionality. - * @constructor - * Creates a new Item - * @param {HTMLElement} el - * @xtype tbitem - */ -T.Item = Ext.extend(Ext.BoxComponent, { - hideParent: true, // Hiding a Toolbar.Item hides its containing TD - enable:Ext.emptyFn, - disable:Ext.emptyFn, - focus:Ext.emptyFn - /** - * @cfg {String} overflowText Text to be used for the menu if the item is overflowed. - */ -}); -Ext.reg('tbitem', T.Item); + me.callParent(arguments); -/** - * @class Ext.Toolbar.Separator - * @extends Ext.Toolbar.Item - * A simple class that adds a vertical separator bar between toolbar items - * (css class:'xtb-sep'). Example usage: - *- * @constructor - * Creates a new Separator - * @xtype tbseparator - */ -T.Separator = Ext.extend(T.Item, { - onRender : function(ct, position){ - this.el = ct.createChild({tag:'span', cls:'xtb-sep'}, position); - } -}); -Ext.reg('tbseparator', T.Separator); + // Update the spinner buttons + me.setSpinUpEnabled(valueIsNull || value < me.maxValue); + me.setSpinDownEnabled(valueIsNull || value > me.minValue); + }, -/** - * @class Ext.Toolbar.Spacer - * @extends Ext.Toolbar.Item - * A simple element that adds extra horizontal space between items in a toolbar. - * By default a 2px wide space is added via css specification:-new Ext.Panel({ - tbar : [ - 'Item 1', - {xtype: 'tbseparator'}, // or '-' - 'Item 2' - ] -}); -
- *-.x-toolbar .xtb-spacer { - width:2px; -} - *
Example usage:
- *- * @constructor - * Creates a new Spacer - * @xtype tbspacer - */ -T.Spacer = Ext.extend(T.Item, { /** - * @cfg {Number} width - * The width of the spacer in pixels (defaults to 2px via css style .x-toolbar .xtb-spacer). + * Replaces any existing {@link #minValue} with the new value. + * @param {Number} value The minimum value */ + setMinValue : function(value) { + this.minValue = Ext.Number.from(value, Number.NEGATIVE_INFINITY); + }, - onRender : function(ct, position){ - this.el = ct.createChild({tag:'div', cls:'xtb-spacer', style: this.width?'width:'+this.width+'px':''}, position); - } -}); -Ext.reg('tbspacer', T.Spacer); - -/** - * @class Ext.Toolbar.Fill - * @extends Ext.Toolbar.Spacer - * A non-rendering placeholder item which instructs the Toolbar's Layout to begin using - * the right-justified button container. - *-new Ext.Panel({ - 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' - ] -}); -
- * @constructor - * Creates a new Fill - * @xtype tbfill - */ -T.Fill = Ext.extend(T.Item, { - // private - render : Ext.emptyFn, - isFill : true -}); -Ext.reg('tbfill', T.Fill); - -/** - * @class Ext.Toolbar.TextItem - * @extends Ext.Toolbar.Item - * A simple class that renders text directly into a toolbar - * (with css class:'xtb-text'). Example usage: - *-new Ext.Panel({ - tbar : [ - 'Item 1', - {xtype: 'tbfill'}, // or '->' - 'Item 2' - ] -}); -
- * @constructor - * Creates a new TextItem - * @param {String/Object} text A text string, or a config object containing a text property - * @xtype tbtext - */ -T.TextItem = Ext.extend(T.Item, { /** - * @cfg {String} text The text to be used as innerHTML (html tags are accepted) + * Replaces any existing {@link #maxValue} with the new value. + * @param {Number} value The maximum value */ - - constructor: function(config){ - T.TextItem.superclass.constructor.call(this, Ext.isString(config) ? {text: config} : config); + setMaxValue: function(value) { + this.maxValue = Ext.Number.from(value, Number.MAX_VALUE); }, // private - onRender : function(ct, position) { - this.autoEl = {cls: 'xtb-text', html: this.text || ''}; - T.TextItem.superclass.onRender.call(this, ct, position); + parseValue : function(value) { + value = parseFloat(String(value).replace(this.decimalSeparator, '.')); + return isNaN(value) ? null : value; }, /** - * Updates this item's text, setting the text to be used as innerHTML. - * @param {String} t The text to display (html accepted). + * @private + * */ - setText : function(t) { - if(this.rendered){ - this.el.update(t); - }else{ - this.text = t; + fixPrecision : function(value) { + var me = this, + nan = isNaN(value), + precision = me.decimalPrecision; + + if (nan || !value) { + return nan ? '' : value; + } else if (!me.allowDecimals || precision <= 0) { + precision = 0; } - } -}); -Ext.reg('tbtext', T.TextItem); -// backwards compat -T.Button = Ext.extend(Ext.Button, {}); -T.SplitButton = Ext.extend(Ext.SplitButton, {}); -Ext.reg('tbbutton', T.Button); -Ext.reg('tbsplit', T.SplitButton); + return parseFloat(Ext.Number.toFixed(parseFloat(value), precision)); + }, -})(); -/** - * @class Ext.ButtonGroup - * @extends Ext.Panel - * Container for a group of buttons. Example usage: - *-new Ext.Panel({ - tbar : [ - {xtype: 'tbtext', text: 'Item 1'} // or simply 'Item 1' - ] -}); -
- * @constructor - * Create a new ButtonGroup. - * @param {Object} config The config object - * @xtype buttongroup - */ -Ext.ButtonGroup = Ext.extend(Ext.Panel, { - /** - * @cfg {Number} columns The columns configuration property passed to the - * {@link #layout configured layout manager}. See {@link Ext.layout.TableLayout#columns}. - */ - /** - * @cfg {String} baseCls Defaults to 'x-btn-group'. See {@link Ext.Panel#baseCls}. - */ - baseCls: 'x-btn-group', - /** - * @cfg {String} layout Defaults to 'table'. See {@link Ext.Container#layout}. - */ - layout:'table', - defaultType: 'button', - /** - * @cfg {Boolean} frame Defaults to true. See {@link Ext.Panel#frame}. - */ - frame: true, - internalDefaults: {removeMode: 'container', hideParent: true}, + beforeBlur : function() { + var me = this, + v = me.parseValue(me.getRawValue()); - initComponent : function(){ - this.layoutConfig = this.layoutConfig || {}; - Ext.applyIf(this.layoutConfig, { - columns : this.columns - }); - if(!this.title){ - this.addClass('x-btn-group-notitle'); + if (!Ext.isEmpty(v)) { + me.setValue(v); } - this.on('afterlayout', this.onAfterLayout, this); - Ext.ButtonGroup.superclass.initComponent.call(this); }, - applyDefaults : function(c){ - c = Ext.ButtonGroup.superclass.applyDefaults.call(this, c); - var d = this.internalDefaults; - if(c.events){ - Ext.applyIf(c.initialConfig, d); - Ext.apply(c, d); - }else{ - Ext.applyIf(c, d); + onSpinUp: function() { + var me = this; + if (!me.readOnly) { + me.setValue(Ext.Number.constrain(me.getValue() + me.step, me.minValue, me.maxValue)); } - return c; }, - onAfterLayout : function(){ - var bodyWidth = this.body.getFrameWidth('lr') + this.body.dom.firstChild.offsetWidth; - this.body.setWidth(bodyWidth); - this.el.setWidth(bodyWidth + this.getFrameWidth()); + onSpinDown: function() { + var me = this; + if (!me.readOnly) { + me.setValue(Ext.Number.constrain(me.getValue() - me.step, me.minValue, me.maxValue)); + } } - /** - * @cfg {Array} tools @hide - */ }); -Ext.reg('buttongroup', Ext.ButtonGroup); /** - * @class Ext.PagingToolbar - * @extends Ext.Toolbar + * @class Ext.toolbar.Paging + * @extends Ext.toolbar.Toolbar *-var p = new Ext.Panel({ - title: 'Panel with Button Group', - width: 300, - height:200, - renderTo: document.body, - html: 'whatever', - tbar: [{ - xtype: 'buttongroup', - {@link #columns}: 3, - title: 'Clipboard', - items: [{ - text: 'Paste', - scale: 'large', - rowspan: 3, iconCls: 'add', - iconAlign: 'top', - cls: 'x-btn-as-arrow' - },{ - xtype:'splitbutton', - text: 'Menu Button', - scale: 'large', - rowspan: 3, - iconCls: 'add', - iconAlign: 'top', - arrowAlign:'bottom', - menu: [{text: 'Menu Item 1'}] - },{ - xtype:'splitbutton', text: 'Cut', iconCls: 'add16', menu: [{text: 'Cut Menu Item'}] - },{ - text: 'Copy', iconCls: 'add16' - },{ - text: 'Format', iconCls: 'add16' - }] - }] -}); - *
As the amount of records increases, the time required for the browser to render * them increases. Paging is used to reduce the amount of data exchanged with the client. * Note: if there are more records/rows than can be viewed in the available screen area, vertical * scrollbars will be added.
*Paging is typically handled on the server side (see exception below). The client sends * parameters to the server side, which the server needs to interpret and then respond with the - * approprate data.
- *Ext.PagingToolbar is a specialized toolbar that is bound to a {@link Ext.data.Store} + * appropriate data.
+ *Ext.toolbar.Paging is a specialized toolbar that is bound to a {@link Ext.data.Store} * and provides automatic paging control. This Component {@link Ext.data.Store#load load}s blocks * of data into the {@link #store} by passing {@link Ext.data.Store#paramNames paramNames} used for * paging criteria.
+ * + * {@img Ext.toolbar.Paging/Ext.toolbar.Paging.png Ext.toolbar.Paging component} + * *PagingToolbar is typically used as one of the Grid's toolbars:
** *-Ext.QuickTips.init(); // to display button quicktips - -var myStore = new Ext.data.Store({ - reader: new Ext.data.JsonReader({ - {@link Ext.data.JsonReader#totalProperty totalProperty}: 'results', - ... - }), - ... -}); - -var myPageSize = 25; // server script should only send back 25 items at a time - -var grid = new Ext.grid.GridPanel({ - ... - store: myStore, - bbar: new Ext.PagingToolbar({ - {@link #store}: myStore, // grid and PagingToolbar using same store - {@link #displayInfo}: true, - {@link #pageSize}: myPageSize, - {@link #prependButtons}: true, - items: [ - 'text 1' - ] - }) -}); + * var itemsPerPage = 2; // set the number of items you want per page + * + * var store = Ext.create('Ext.data.Store', { + * id:'simpsonsStore', + * autoLoad: false, + * fields:['name', 'email', 'phone'], + * pageSize: itemsPerPage, // items per page + * proxy: { + * type: 'ajax', + * url: 'pagingstore.js', // url that will load data with respect to start and limit params + * reader: { + * type: 'json', + * root: 'items', + * totalProperty: 'total' + * } + * } + * }); + * + * // specify segment of data you want to load using params + * store.load({ + * params:{ + * start:0, + * limit: itemsPerPage + * } + * }); + * + * Ext.create('Ext.grid.Panel', { + * title: 'Simpsons', + * store: store, + * columns: [ + * {header: 'Name', dataIndex: 'name'}, + * {header: 'Email', dataIndex: 'email', flex:1}, + * {header: 'Phone', dataIndex: 'phone'} + * ], + * width: 400, + * height: 125, + * dockedItems: [{ + * xtype: 'pagingtoolbar', + * store: store, // same store GridPanel is using + * dock: 'bottom', + * displayInfo: true + * }], + * renderTo: Ext.getBody() + * }); *
To use paging, pass the paging requirements to the server when the store is first loaded.
@@ -47591,7 +99744,7 @@ store.load({ *If using {@link Ext.data.Store#autoLoad store's autoLoad} configuration:
*@@ -47612,18 +99765,15 @@ var myStore = new Ext.data.Store({ *var myStore = new Ext.data.Store({ - {@link Ext.data.Store#autoLoad autoLoad}: {params:{start: 0, limit: 25}}, + {@link Ext.data.Store#autoLoad autoLoad}: {start: 0, limit: 25}, ... }); *
Paging with Local Data
*Paging can also be accomplished with local data using extensions:
*- * @constructor Create a new PagingToolbar - * @param {Object} config The config object - * @xtype paging */ -(function() { - -var T = Ext.Toolbar; - -Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { +Ext.define('Ext.toolbar.Paging', { + extend: 'Ext.toolbar.Toolbar', + alias: 'widget.pagingtoolbar', + alternateClassName: 'Ext.PagingToolbar', + requires: ['Ext.toolbar.TextItem', 'Ext.form.field.Number'], /** * @cfg {Ext.data.Store} store * The {@link Ext.data.Store} the paging toolbar should use as its data source (required). @@ -47632,16 +99782,13 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { * @cfg {Boolean} displayInfo * true to display the displayMsg (defaults to false) */ - /** - * @cfg {Number} pageSize - * The number of records to display per page (defaults to 20) - */ - pageSize : 20, + displayInfo: false, /** * @cfg {Boolean} prependButtons * true to insert any configured items before the paging buttons. * Defaults to false. */ + prependButtons: false, /** * @cfg {String} displayMsg * The paging status message to display (defaults to 'Displaying {0} - {1} of {2}'). @@ -47698,109 +99845,122 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { * Note: quick tips must be initialized for the quicktip to show. */ refreshText : 'Refresh', - - /** - *- *
- Ext.ux.data.PagingStore
+ *- Ext.ux.data.PagingStore
*- Paging Memory Proxy (examples/ux/PagingMemoryProxy.js)
*Deprecated.
- *paramNames
should be set in the data store - * (see {@link Ext.data.Store#paramNames}).Object mapping of parameter names used for load calls, initially set to:
- *{start: 'start', limit: 'limit'}- * @type Object - * @property paramNames - * @deprecated - */ - /** - * The number of records to display per page. See also {@link #cursor}. - * @type Number - * @property pageSize + * @cfg {Number} inputItemWidth + * The width in pixels of the input field used to display and change the current page number (defaults to 30). */ - + inputItemWidth : 30, + /** - * Indicator for the record position. This property might be used to get the active page - * number for example:- * @type Number - * @property cursor + * Gets the standard paging items in the toolbar + * @private */ - - initComponent : function(){ - var pagingItems = [this.first = new T.Button({ - tooltip: this.firstText, - overflowText: this.firstText, - iconCls: 'x-tbar-page-first', + getPagingItems: function() { + var me = this; + + return [{ + itemId: 'first', + tooltip: me.firstText, + overflowText: me.firstText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-first', disabled: true, - handler: this.moveFirst, - scope: this - }), this.prev = new T.Button({ - tooltip: this.prevText, - overflowText: this.prevText, - iconCls: 'x-tbar-page-prev', + handler: me.moveFirst, + scope: me + },{ + itemId: 'prev', + tooltip: me.prevText, + overflowText: me.prevText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-prev', disabled: true, - handler: this.movePrevious, - scope: this - }), '-', this.beforePageText, - this.inputItem = new Ext.form.NumberField({ - cls: 'x-tbar-page-number', + handler: me.movePrevious, + scope: me + }, + '-', + me.beforePageText, + { + xtype: 'numberfield', + itemId: 'inputItem', + name: 'inputItem', + cls: Ext.baseCSSPrefix + 'tbar-page-number', allowDecimals: false, - allowNegative: false, + minValue: 1, + hideTrigger: true, enableKeyEvents: true, selectOnFocus: true, submitValue: false, + width: me.inputItemWidth, + margins: '-1 2 3 2', listeners: { - scope: this, - keydown: this.onPagingKeyDown, - blur: this.onPagingBlur - } - }), this.afterTextItem = new T.TextItem({ - text: String.format(this.afterPageText, 1) - }), '-', this.next = new T.Button({ - tooltip: this.nextText, - overflowText: this.nextText, - iconCls: 'x-tbar-page-next', + scope: me, + keydown: me.onPagingKeyDown, + blur: me.onPagingBlur + } + },{ + xtype: 'tbtext', + itemId: 'afterTextItem', + text: Ext.String.format(me.afterPageText, 1) + }, + '-', + { + itemId: 'next', + tooltip: me.nextText, + overflowText: me.nextText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-next', disabled: true, - handler: this.moveNext, - scope: this - }), this.last = new T.Button({ - tooltip: this.lastText, - overflowText: this.lastText, - iconCls: 'x-tbar-page-last', + handler: me.moveNext, + scope: me + },{ + itemId: 'last', + tooltip: me.lastText, + overflowText: me.lastText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-last', disabled: true, - handler: this.moveLast, - scope: this - }), '-', this.refresh = new T.Button({ - tooltip: this.refreshText, - overflowText: this.refreshText, - iconCls: 'x-tbar-loading', - handler: this.doRefresh, - scope: this - })]; - + handler: me.moveLast, + scope: me + }, + '-', + { + itemId: 'refresh', + tooltip: me.refreshText, + overflowText: me.refreshText, + iconCls: Ext.baseCSSPrefix + 'tbar-loading', + handler: me.doRefresh, + scope: me + }]; + }, - var userItems = this.items || this.buttons || []; - if (this.prependButtons) { - this.items = userItems.concat(pagingItems); - }else{ - this.items = pagingItems.concat(userItems); + initComponent : function(){ + var me = this, + pagingItems = me.getPagingItems(), + userItems = me.items || me.buttons || []; + + if (me.prependButtons) { + me.items = userItems.concat(pagingItems); + } else { + me.items = pagingItems.concat(userItems); } - delete this.buttons; - if(this.displayInfo){ - this.items.push('->'); - this.items.push(this.displayItem = new T.TextItem({})); + delete me.buttons; + + if (me.displayInfo) { + me.items.push('->'); + me.items.push({xtype: 'tbtext', itemId: 'displayItem'}); } - Ext.PagingToolbar.superclass.initComponent.call(this); - this.addEvents( + + me.callParent(); + + me.addEvents( /** * @event change * Fires after the active page has been changed. - * @param {Ext.PagingToolbar} this + * @param {Ext.toolbar.Paging} this * @param {Object} pageData An object that has these properties:- * // t is reference to the paging toolbar instance - * var activePage = Math.ceil((t.cursor + t.pageSize) / t.pageSize); - *
*
- - *
total
: NumberThe total number of records in the dataset as * returned by the server- - *
activePage
: NumberThe current page numberpages
: NumberThe total number of pages (calculated from + *- + *
currentPage
: NumberThe current page number- + *
pageCount
: NumberThe total number of pages (calculated from * the total number of records in the dataset as returned by the server and the current {@link #pageSize})- + *
toRecord
: NumberThe starting record index for the current page- * */ 'change', @@ -47808,146 +99968,149 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { * @event beforechange * Fires just before the active page is changed. * Return false to prevent the active page from being changed. - * @param {Ext.PagingToolbar} this - * @param {Object} params An object hash of the parameters which the PagingToolbar will send when - * loading the required page. This will contain:
fromRecord
: NumberThe ending record index for the current page- *
- *- - *
start
: NumberThe starting row number for the next page of records to - * be retrieved from the server- - *
limit
: NumberThe number of records to be retrieved from the server(note: the names of the start and limit properties are determined - * by the store's {@link Ext.data.Store#paramNames paramNames} property.)
- *Parameters may be added as required in the event handler.
+ * @param {Ext.toolbar.Paging} this + * @param {Number} page The page number that will be loaded on change */ 'beforechange' ); - this.on('afterlayout', this.onFirstLayout, this, {single: true}); - this.cursor = 0; - this.bindStore(this.store, true); - }, + me.on('afterlayout', me.onLoad, me, {single: true}); - // private - onFirstLayout : function(){ - if(this.dsLoaded){ - this.onLoad.apply(this, this.dsLoaded); - } + me.bindStore(me.store, true); }, - // private updateInfo : function(){ - if(this.displayItem){ - var count = this.store.getCount(); - var msg = count == 0 ? - this.emptyMsg : - String.format( - this.displayMsg, - this.cursor+1, this.cursor+count, this.store.getTotalCount() + var me = this, + displayItem = me.child('#displayItem'), + store = me.store, + pageData = me.getPageData(), + count, msg; + + if (displayItem) { + count = store.getCount(); + if (count === 0) { + msg = me.emptyMsg; + } else { + msg = Ext.String.format( + me.displayMsg, + pageData.fromRecord, + pageData.toRecord, + pageData.total ); - this.displayItem.setText(msg); + } + displayItem.setText(msg); + me.doComponentLayout(); } }, // private - onLoad : function(store, r, o){ - if(!this.rendered){ - this.dsLoaded = [store, r, o]; + onLoad : function(){ + var me = this, + pageData, + currPage, + pageCount, + afterText; + + if (!me.rendered) { return; } - var p = this.getParams(); - this.cursor = (o.params && o.params[p.start]) ? o.params[p.start] : 0; - var d = this.getPageData(), ap = d.activePage, ps = d.pages; - this.afterTextItem.setText(String.format(this.afterPageText, d.pages)); - this.inputItem.setValue(ap); - this.first.setDisabled(ap == 1); - this.prev.setDisabled(ap == 1); - this.next.setDisabled(ap == ps); - this.last.setDisabled(ap == ps); - this.refresh.enable(); - this.updateInfo(); - this.fireEvent('change', this, d); + pageData = me.getPageData(); + currPage = pageData.currentPage; + pageCount = pageData.pageCount; + afterText = Ext.String.format(me.afterPageText, isNaN(pageCount) ? 1 : pageCount); + + me.child('#afterTextItem').setText(afterText); + me.child('#inputItem').setValue(currPage); + me.child('#first').setDisabled(currPage === 1); + me.child('#prev').setDisabled(currPage === 1); + me.child('#next').setDisabled(currPage === pageCount); + me.child('#last').setDisabled(currPage === pageCount); + me.child('#refresh').enable(); + me.updateInfo(); + me.fireEvent('change', me, pageData); }, // private getPageData : function(){ - var total = this.store.getTotalCount(); + var store = this.store, + totalCount = store.getTotalCount(); + return { - total : total, - activePage : Math.ceil((this.cursor+this.pageSize)/this.pageSize), - pages : total < this.pageSize ? 1 : Math.ceil(total/this.pageSize) + total : totalCount, + currentPage : store.currentPage, + pageCount: Math.ceil(totalCount / store.pageSize), + fromRecord: ((store.currentPage - 1) * store.pageSize) + 1, + toRecord: Math.min(store.currentPage * store.pageSize, totalCount) + }; }, - /** - * Change the active page - * @param {Integer} page The page to display - */ - changePage : function(page){ - this.doLoad(((page-1) * this.pageSize).constrain(0, this.store.getTotalCount())); - }, - // private onLoadError : function(){ - if(!this.rendered){ + if (!this.rendered) { return; } - this.refresh.enable(); + this.child('#refresh').enable(); }, // private - readPage : function(d){ - var v = this.inputItem.getValue(), pageNum; - if (!v || isNaN(pageNum = parseInt(v, 10))) { - this.inputItem.setValue(d.activePage); + readPageFromInput : function(pageData){ + var v = this.child('#inputItem').getValue(), + pageNum = parseInt(v, 10); + + if (!v || isNaN(pageNum)) { + this.child('#inputItem').setValue(pageData.currentPage); return false; } return pageNum; }, onPagingFocus : function(){ - this.inputItem.select(); + this.child('#inputItem').select(); }, //private onPagingBlur : function(e){ - this.inputItem.setValue(this.getPageData().activePage); + var curPage = this.getPageData().currentPage; + this.child('#inputItem').setValue(curPage); }, // private onPagingKeyDown : function(field, e){ - var k = e.getKey(), d = this.getPageData(), pageNum; + var me = this, + k = e.getKey(), + pageData = me.getPageData(), + increment = e.shiftKey ? 10 : 1, + pageNum; + if (k == e.RETURN) { e.stopEvent(); - pageNum = this.readPage(d); - if(pageNum !== false){ - pageNum = Math.min(Math.max(1, pageNum), d.pages) - 1; - this.doLoad(pageNum * this.pageSize); + pageNum = me.readPageFromInput(pageData); + if (pageNum !== false) { + pageNum = Math.min(Math.max(1, pageNum), pageData.pageCount); + if(me.fireEvent('beforechange', me, pageNum) !== false){ + me.store.loadPage(pageNum); + } } - }else if (k == e.HOME || k == e.END){ + } else if (k == e.HOME || k == e.END) { e.stopEvent(); - pageNum = k == e.HOME ? 1 : d.pages; + pageNum = k == e.HOME ? 1 : pageData.pageCount; field.setValue(pageNum); - }else if (k == e.UP || k == e.PAGEUP || k == e.DOWN || k == e.PAGEDOWN){ + } else if (k == e.UP || k == e.PAGEUP || k == e.DOWN || k == e.PAGEDOWN) { e.stopEvent(); - if((pageNum = this.readPage(d))){ - var increment = e.shiftKey ? 10 : 1; - if(k == e.DOWN || k == e.PAGEDOWN){ + pageNum = me.readPageFromInput(pageData); + if (pageNum) { + if (k == e.DOWN || k == e.PAGEDOWN) { increment *= -1; } pageNum += increment; - if(pageNum >= 1 & pageNum <= d.pages){ + if (pageNum >= 1 && pageNum <= pageData.pages) { field.setValue(pageNum); } } } }, - // private - getParams : function(){ - //retain backwards compat, allow params on the toolbar itself, if they exist. - return this.paramNames || this.store.paramNames; - }, - // private beforeLoad : function(){ if(this.rendered && this.refresh){ @@ -47957,11 +100120,8 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { // private doLoad : function(start){ - var o = {}, pn = this.getParams(); - o[pn.start] = start; - o[pn.limit] = this.pageSize; if(this.fireEvent('beforechange', this, o) !== false){ - this.store.load({params:o}); + this.store.load(); } }, @@ -47969,38 +100129,62 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { * Move to the first page, has the same effect as clicking the 'first' button. */ moveFirst : function(){ - this.doLoad(0); + if (this.fireEvent('beforechange', this, 1) !== false){ + this.store.loadPage(1); + } }, /** * Move to the previous page, has the same effect as clicking the 'previous' button. */ movePrevious : function(){ - this.doLoad(Math.max(0, this.cursor-this.pageSize)); + var me = this, + prev = me.store.currentPage - 1; + + if (prev > 0) { + if (me.fireEvent('beforechange', me, prev) !== false) { + me.store.previousPage(); + } + } }, /** * Move to the next page, has the same effect as clicking the 'next' button. */ moveNext : function(){ - this.doLoad(this.cursor+this.pageSize); + var me = this, + total = me.getPageData().pageCount, + next = me.store.currentPage + 1; + + if (next <= total) { + if (me.fireEvent('beforechange', me, next) !== false) { + me.store.nextPage(); + } + } }, /** * Move to the last page, has the same effect as clicking the 'last' button. */ moveLast : function(){ - var total = this.store.getTotalCount(), - extra = total % this.pageSize; - - this.doLoad(extra ? (total - extra) : total - this.pageSize); + var me = this, + last = me.getPageData().pageCount; + + if (me.fireEvent('beforechange', me, last) !== false) { + me.store.loadPage(last); + } }, /** * Refresh the current page, has the same effect as clicking the 'refresh' button. */ doRefresh : function(){ - this.doLoad(this.cursor); + var me = this, + current = me.store.currentPage; + + if (me.fireEvent('beforechange', me, current) !== false) { + me.store.loadPage(current); + } }, /** @@ -48009,33 +100193,30 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { * @param {Boolean} initial (Optional) true to not remove listeners */ bindStore : function(store, initial){ - var doLoad; - if(!initial && this.store){ - if(store !== this.store && this.store.autoDestroy){ - this.store.destroy(); + var me = this; + + if (!initial && me.store) { + if(store !== me.store && me.store.autoDestroy){ + me.store.destroy(); }else{ - this.store.un('beforeload', this.beforeLoad, this); - this.store.un('load', this.onLoad, this); - this.store.un('exception', this.onLoadError, this); + me.store.un('beforeload', me.beforeLoad, me); + me.store.un('load', me.onLoad, me); + me.store.un('exception', me.onLoadError, me); } if(!store){ - this.store = null; + me.store = null; } } - if(store){ - store = Ext.StoreMgr.lookup(store); + if (store) { + store = Ext.data.StoreManager.lookup(store); store.on({ - scope: this, - beforeload: this.beforeLoad, - load: this.onLoad, - exception: this.onLoadError + scope: me, + beforeload: me.beforeLoad, + load: me.onLoad, + exception: me.onLoadError }); - doLoad = true; - } - this.store = store; - if(doLoad){ - this.onLoad(store, null, {}); } + me.store = store; }, /** @@ -48057,25645 +100238,28563 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, { // private onDestroy : function(){ this.bindStore(null); - Ext.PagingToolbar.superclass.onDestroy.call(this); + this.callParent(); } }); -})(); -Ext.reg('paging', Ext.PagingToolbar);/** - * @class Ext.History - * @extends Ext.util.Observable - * 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. - * @singleton +/** + * @class Ext.view.BoundList + * @extends Ext.view.View + * An internal used DataView for ComboBox, MultiSelect and ItemSelector. */ -Ext.History = (function () { - var iframe, hiddenField; - var ready = false; - var currentToken; +Ext.define('Ext.view.BoundList', { + extend: 'Ext.view.View', + alias: 'widget.boundlist', + alternateClassName: 'Ext.BoundList', + requires: ['Ext.layout.component.BoundList', 'Ext.toolbar.Paging'], - function getHash() { - var href = top.location.href, i = href.indexOf("#"); - return i >= 0 ? href.substr(i + 1) : null; - } + /** + * @cfg {Number} pageSize If greater than 0, a {@link Ext.toolbar.Paging} is displayed at the + * bottom of the list and store queries will execute with page start and + * {@link Ext.toolbar.Paging#pageSize limit} parameters. + */ + pageSize: 0, - function doSave() { - hiddenField.value = currentToken; - } + /** + * @property pagingToolbar + * @type {Ext.toolbar.Paging} + * A reference to the PagingToolbar instance in this view. Only populated if {@link #pageSize} is greater + * than zero and the BoundList has been rendered. + */ - function handleStateChange(token) { - currentToken = token; - Ext.History.fireEvent('change', token); - } + // private overrides + autoScroll: true, + baseCls: Ext.baseCSSPrefix + 'boundlist', + listItemCls: '', + shadow: false, + trackOver: true, + refreshed: 0, - function updateIFrame (token) { - var html = ['',Ext.util.Format.htmlEncode(token),''].join(''); - try { - var doc = iframe.contentWindow.document; - doc.open(); - doc.write(html); - doc.close(); - return true; - } catch (e) { - return false; - } - } + ariaRole: 'listbox', - function checkIFrame() { - if (!iframe.contentWindow || !iframe.contentWindow.document) { - setTimeout(checkIFrame, 10); - return; + componentLayout: 'boundlist', + + renderTpl: [''], + + initComponent: function() { + var me = this, + baseCls = me.baseCls, + itemCls = baseCls + '-item'; + me.itemCls = itemCls; + me.selectedItemCls = baseCls + '-selected'; + me.overItemCls = baseCls + '-item-over'; + me.itemSelector = "." + itemCls; + + if (me.floating) { + me.addCls(baseCls + '-floating'); + } + + if (!me.tpl) { + // should be setting aria-posinset based on entire set of data + // not filtered set + me.tpl = Ext.create('Ext.XTemplate', + '' + ); + } else if (Ext.isString(me.tpl)) { + me.tpl = Ext.create('Ext.XTemplate', me.tpl); } - var doc = iframe.contentWindow.document; - var elem = doc.getElementById("state"); - var token = elem ? elem.innerText : null; + if (me.pageSize) { + me.pagingToolbar = me.createPagingToolbar(); + } - var hash = getHash(); + me.callParent(); - setInterval(function () { + Ext.applyIf(me.renderSelectors, { + listEl: '.list-ct' + }); + }, - doc = iframe.contentWindow.document; - elem = doc.getElementById("state"); + createPagingToolbar: function() { + return Ext.widget('pagingtoolbar', { + pageSize: this.pageSize, + store: this.store, + border: false + }); + }, - var newtoken = elem ? elem.innerText : null; + onRender: function() { + var me = this, + toolbar = me.pagingToolbar; + me.callParent(arguments); + if (toolbar) { + toolbar.render(me.el); + } + }, - var newHash = getHash(); + bindStore : function(store, initial) { + var me = this, + toolbar = me.pagingToolbar; + me.callParent(arguments); + if (toolbar) { + toolbar.bindStore(store, initial); + } + }, - if (newtoken !== token) { - token = newtoken; - handleStateChange(token); - top.location.hash = token; - hash = token; - doSave(); - } else if (newHash !== hash) { - hash = newHash; - updateIFrame(newHash); - } + getTargetEl: function() { + return this.listEl || this.el; + }, - }, 50); + getInnerTpl: function(displayField) { + return '{' + displayField + '}'; + }, - ready = true; + refresh: function() { + var me = this; + me.callParent(); + if (me.isVisible()) { + me.refreshed++; + me.doComponentLayout(); + me.refreshed--; + } + }, - Ext.History.fireEvent('ready', Ext.History); - } + initAria: function() { + this.callParent(); - function startUp() { - currentToken = hiddenField.value ? hiddenField.value : getHash(); + var selModel = this.getSelectionModel(), + mode = selModel.getSelectionMode(), + actionEl = this.getActionEl(); - if (Ext.isIE) { - checkIFrame(); - } else { - var hash = getHash(); - setInterval(function () { - var newHash = getHash(); - if (newHash !== hash) { - hash = newHash; - handleStateChange(hash); - doSave(); - } - }, 50); - ready = true; - Ext.History.fireEvent('ready', Ext.History); + // TODO: subscribe to mode changes or allow the selModel to manipulate this attribute. + if (mode !== 'SINGLE') { + actionEl.dom.setAttribute('aria-multiselectable', true); } + }, + + onDestroy: function() { + Ext.destroyMembers(this, 'pagingToolbar', 'listEl'); + this.callParent(); } +}); - return { - /** - * The id of the hidden field required for storing the current history token. - * @type String - * @property - */ - fieldId: 'x-history-field', - /** - * The id of the iframe required by IE to manage the history stack. - * @type String - * @property - */ - iframeId: 'x-history-frame', +/** + * @class Ext.view.BoundListKeyNav + * @extends Ext.util.KeyNav + * A specialized {@link Ext.util.KeyNav} implementation for navigating a {@link Ext.view.BoundList} using + * the keyboard. The up, down, pageup, pagedown, home, and end keys move the active highlight + * through the list. The enter key invokes the selection model's select action using the highlighted item. + */ +Ext.define('Ext.view.BoundListKeyNav', { + extend: 'Ext.util.KeyNav', + requires: 'Ext.view.BoundList', + + /** + * @cfg {Ext.view.BoundList} boundList + * @required + * The {@link Ext.view.BoundList} instance for which key navigation will be managed. This is required. + */ - events:{}, + constructor: function(el, config) { + var me = this; + me.boundList = config.boundList; + me.callParent([el, Ext.apply({}, config, me.defaultHandlers)]); + }, - /** - * Initialize the global History instance. - * @param {Boolean} onReady (optional) A callback function that will be called once the history - * component is fully initialized. - * @param {Object} scope (optional) The scope (
', + ' - ' + me.getInnerTpl(me.displayField) + '
', + 'this
reference) in which the callback is executed. Defaults to the browser window. - */ - init: function (onReady, scope) { - if(ready) { - Ext.callback(onReady, scope, [this]); - return; - } - if(!Ext.isReady){ - Ext.onReady(function(){ - Ext.History.init(onReady, scope); - }); - return; - } - hiddenField = Ext.getDom(Ext.History.fieldId); - if (Ext.isIE) { - iframe = Ext.getDom(Ext.History.iframeId); - } - this.addEvents( - /** - * @event ready - * Fires when the Ext.History singleton has been initialized and is ready for use. - * @param {Ext.History} The Ext.History singleton. - */ - 'ready', - /** - * @event change - * Fires when navigation back or forwards within the local page's history occurs. - * @param {String} token An identifier associated with the page state at that point in its history. - */ - 'change' - ); - if(onReady){ - this.on('ready', onReady, scope, {single:true}); - } - startUp(); + defaultHandlers: { + up: function() { + var me = this, + boundList = me.boundList, + allItems = boundList.all, + oldItem = boundList.highlightedItem, + oldItemIdx = oldItem ? boundList.indexOf(oldItem) : -1, + newItemIdx = oldItemIdx > 0 ? oldItemIdx - 1 : allItems.getCount() - 1; //wraps around + me.highlightAt(newItemIdx); }, - /** - * 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 specifc history - * state of that component. Example usage: - *- * @param {String} token The value that defines a particular application-specific history state - * @param {Boolean} preventDuplicates 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 (defaults to true). - */ - add: function (token, preventDup) { - if(preventDup !== false){ - if(this.getToken() == token){ - return true; - } - } - if (Ext.isIE) { - return updateIFrame(token); - } else { - top.location.hash = token; - return true; - } + down: function() { + var me = this, + boundList = me.boundList, + allItems = boundList.all, + oldItem = boundList.highlightedItem, + oldItemIdx = oldItem ? boundList.indexOf(oldItem) : -1, + newItemIdx = oldItemIdx < allItems.getCount() - 1 ? oldItemIdx + 1 : 0; //wraps around + me.highlightAt(newItemIdx); }, - /** - * Programmatically steps back one step in browser history (equivalent to the user pressing the Back button). - */ - back: function(){ - history.go(-1); + pageup: function() { + //TODO }, - /** - * Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button). - */ - forward: function(){ - history.go(1); + pagedown: function() { + //TODO }, - /** - * Retrieves the currently-active history token. - * @return {String} The token - */ - getToken: function() { - return ready ? currentToken : getHash(); + home: function() { + this.highlightAt(0); + }, + + end: function() { + var me = this; + me.highlightAt(me.boundList.all.getCount() - 1); + }, + + enter: function(e) { + this.selectHighlighted(e); } - }; -})(); -Ext.apply(Ext.History, new Ext.util.Observable());/** - * @class Ext.Tip - * @extends Ext.Panel - * @xtype tip - * This is the base class for {@link Ext.QuickTip} and {@link Ext.Tooltip} that provides the basic layout and - * positioning that all tip-based classes require. This class can be used directly for simple, statically-positioned - * tips that are displayed programmatically, or it can be extended to provide custom tip implementations. - * @constructor - * Create a new Tip - * @param {Object} config The configuration options - */ -Ext.Tip = Ext.extend(Ext.Panel, { + }, + /** - * @cfg {Boolean} closable True to render a close tool button into the tooltip header (defaults to false). + * Highlights the item at the given index. + * @param {Number} index */ + highlightAt: function(index) { + var boundList = this.boundList, + item = boundList.all.item(index); + if (item) { + item = item.dom; + boundList.highlightItem(item); + boundList.getTargetEl().scrollChildIntoView(item, false); + } + }, + /** - * @cfg {Number} width - * Width in pixels of the tip (defaults to auto). Width will be ignored if it exceeds the bounds of - * {@link #minWidth} or {@link #maxWidth}. The maximum supported value is 500. + * Triggers selection of the currently highlighted item according to the behavior of + * the configured SelectionModel. */ + selectHighlighted: function(e) { + var me = this, + boundList = me.boundList, + highlighted = boundList.highlightedItem, + selModel = boundList.getSelectionModel(); + if (highlighted) { + selModel.selectWithEvent(boundList.getRecord(highlighted), e); + } + } + +}); +/** + * @class Ext.form.field.ComboBox + * @extends Ext.form.field.Picker + * + * A combobox control with support for autocomplete, remote loading, and many other features. + * + * A ComboBox is like a combination of a traditional HTML text `` field and a `-// Handle tab changes on a TabPanel -tabPanel.on('tabchange', function(tabPanel, tab){ - Ext.History.add(tabPanel.id + ':' + tab.id); -}); -