X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/b37ceabb82336ee82757cd32efe353cfab8ec267..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/ext-all-debug-w-comments.js diff --git a/ext-all-debug-w-comments.js b/ext-all-debug-w-comments.js index bd9c2bc3..ee1252e1 100644 --- a/ext-all-debug-w-comments.js +++ b/ext-all-debug-w-comments.js @@ -1,47681 +1,97675 @@ -/*! - * Ext JS Library 3.2.2 - * Copyright(c) 2006-2010 Ext JS, Inc. - * licensing@extjs.com - * http://www.extjs.com/license - */ +/* +Ext JS - JavaScript Library +Copyright (c) 2006-2011, Sencha Inc. +All rights reserved. +licensing@sencha.com +*/ /** - * @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}';
-
-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}';
-
-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}';
-
-var tpl = new Ext.DomHelper.createTemplate(html);
-tpl.compile();
-
-//... use template like normal
- *
- *
- * Performance Boost
- *DomHelper will transparently create HTML fragments when it can. Using HTML fragments instead - * of DOM can significantly boost performance.
- *Element creation specification parameters may also be strings. If {@link #useDom} is false, - * then the string is used as innerHTML. If {@link #useDom} is true, a string specification - * results in the creation of a text node. Usage:
- *
-Ext.DomHelper.useDom = true; // force it to use DOM; reduces performance
- *
+ * @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}.
- * - * @constructor - * An instance of this class may be created by passing to the constructor either - * a single argument, or multiple arguments: - *
-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.
+ * Old alias to {@link Ext#typeOf}
+ * @deprecated 4.0.0 Use {@link Ext#typeOf} instead
*/
- if (me.compiled) {
- me.compile();
- }
-};
-Ext.Template.prototype = {
+ Ext.type = Ext.typeOf;
+
+})();
+
+/**
+ * @author Jacky Nguyen
+ * 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
*/
- 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
*/
+ 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 ? "+" : ",";
+ capitalize: function(string) {
+ return string.charAt(0).toUpperCase() + string.substr(1);
+ },
- function fn(m, name){
- name = "values['" + name + "']";
- return "'"+ sep + '(' + name + " == undefined ? '' : " + name + ')' + sep + "'";
+ /**
+ * 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
+ */
+ 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) + "...";
}
-
- 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;
+ return value;
},
/**
- * 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
+ * Escapes the passed string for use in a regular expression
+ * @param {String} string
+ * @return {String}
*/
- insertFirst: function(el, values, returnElement){
- return this.doInsert('afterBegin', 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) 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 ' and \
+ * @param {String} string The string to escape
+ * @return {String} The escaped string
*/
- insertBefore: function(el, values, returnElement){
- return this.doInsert('beforeBegin', el, values, returnElement);
+ escape: function(string) {
+ return string.replace(Ext.String.escapeRe, "\\$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
+ * 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
*/
- insertAfter : function(el, values, returnElement){
- return this.doInsert('afterEnd', el, values, returnElement);
+ toggle: function(string, value, other) {
+ return string === value ? other : value;
},
/**
- * 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
+ * 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;
+ },
+
+ /**
+ * 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];
+ });
+ }
+};
+
+/**
+ * @class Ext.Number
+ *
+ * A collection of useful static methods to deal with numbers
+ * @singleton
+ */
+
+(function() {
+
+var isToFixedBroken = (0.9).toFixed() !== '1';
+
+Ext.Number = {
+ /**
+ * Checks whether or not the current 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
*/
- append : function(el, values, returnElement){
- return this.doInsert('beforeEnd', el, values, returnElement);
+ constrain: function(number, min, max) {
+ number = parseFloat(number);
+
+ if (!isNaN(min)) {
+ number = Math.max(number, min);
+ }
+ if (!isNaN(max)) {
+ number = Math.min(number, max);
+ }
+ return number;
},
- 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;
+ /**
+ * 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);
+ }
+
+ return value.toFixed(precision);
},
/**
- * 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
+ * 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
*/
- overwrite : function(el, values, returnElement){
- el = Ext.getDom(el);
- el.innerHTML = this.applyTemplate(values);
- return returnElement ? Ext.get(el.firstChild, true) : el.firstChild;
+ from: function(value, defaultValue) {
+ if (isFinite(value)) {
+ value = parseFloat(value);
+ }
+
+ return !isNaN(value) ? value : defaultValue;
}
};
-/**
- * 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
+ * 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.Template.from = function(el, config){
- el = Ext.getDom(el);
- return new Ext.Template(el.value || el.innerHTML, config || '');
+Ext.num = function() {
+ return Ext.Number.from.apply(this, arguments);
};
/**
- * @class Ext.Template
+ * @author Jacky Nguyen 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
+(function() {
+
+ var arrayPrototype = Array.prototype,
+ slice = arrayPrototype.slice,
+ supportsForEach = 'forEach' in arrayPrototype,
+ supportsMap = 'map' in arrayPrototype,
+ supportsIndexOf = 'indexOf' in arrayPrototype,
+ supportsEvery = 'every' in arrayPrototype,
+ supportsSome = 'some' in arrayPrototype,
+ supportsFilter = 'filter' in arrayPrototype,
+ supportsSort = function() {
+ var a = [1,2,3,4,5].sort(function(){ return 0; });
+ return a[0] === 1 && a[1] === 2 && a[2] === 3 && a[3] === 4 && a[4] === 5;
+ }(),
+ supportsSliceOnNodeList = true,
+ ExtArray;
+ try {
+ // IE 6 - 8 will throw an error when using Array.prototype.slice on NodeList
+ if (typeof document !== 'undefined') {
+ slice.call(document.getElementsByTagName('body'));
+ }
+ } catch (e) {
+ supportsSliceOnNodeList = false;
}
-);
- *
- * 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,
+ ExtArray = Ext.Array = {
+ /*
+ * Iterates an array or an iterable value and invoke the given callback function for each item.
- /**
- * 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
- */
- applyTemplate : function(values){
- var me = this,
- useF = me.disableFormats !== true,
- fm = Ext.util.Format,
- tpl = me;
+ var countries = ['Vietnam', 'Singapore', 'United States', 'Russia'];
- if(me.compiled){
- return me.compiled(values);
+ Ext.Array.each(countries, function(name, index, countriesItSelf) {
+ console.log(name);
+ });
+
+ var sum = function() {
+ var sum = 0;
+
+ Ext.Array.each(arguments, function(value) {
+ sum += value;
+ });
+
+ return sum;
+ };
+
+ sum(1, 2, 3); // returns 6
+
+ * The iteration can be stopped by returning false in the function callback.
+
+ Ext.Array.each(countries, function(name, index, countriesItSelf) {
+ if (name === 'Singapore') {
+ return false; // break here
}
- 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]];
+ });
+
+ * @param {Array/NodeList/Mixed} iterable The value to be iterated. If this
+ * argument is not iterable, the callback function is called once.
+ * @param {Function} fn The callback function. If it returns false, the iteration stops and this method returns
+ * the current `index`. Arguments passed to this callback function are:
+
+- `item`: {Mixed} The item at the current `index` in the passed `array`
+- `index`: {Number} The current `index` within the `array`
+- `allItems`: {Array/NodeList/Mixed} The `array` passed as the first argument to `Ext.Array.each`
+
+ * @param {Object} scope (Optional) The scope (`this` reference) in which the specified function is executed.
+ * @param {Boolean} reverse (Optional) Reverse the iteration order (loop from the end to the beginning)
+ * Defaults false
+ * @return {Boolean} See description for the `fn` parameter.
+ * @markdown
+ */
+ each: function(array, fn, scope, reverse) {
+ array = ExtArray.from(array);
+
+ var i,
+ ln = array.length;
+
+ if (reverse !== true) {
+ for (i = 0; i < ln; i++) {
+ if (fn.call(scope || array[i], array[i], i, array) === false) {
+ return i;
+ }
+ }
+ }
+ else {
+ for (i = ln - 1; i > -1; i--) {
+ if (fn.call(scope || array[i], array[i], i, array) === false) {
+ return i;
}
- return fm[format].apply(fm, args);
}
- } else {
- return values[name] !== undefined ? values[name] : "";
}
- }
- return me.html.replace(me.re, fn);
- },
- /**
- * Compiles the template into an internal function, eliminating the RegEx overhead.
- * @return {Ext.Template} this
- * @hide repeat doc
- */
- compile : function(){
- var me = this,
- fm = Ext.util.Format,
- useF = me.disableFormats !== true,
- sep = Ext.isGecko ? "+" : ",",
- body;
+ return true;
+ },
- 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 ? '' : ";
+ /**
+ * Iterates an array and invoke the given callback function for each item. Note that this will simply
+ * delegate to the native Array.prototype.forEach method if supported.
+ * It doesn't support stopping the iteration by returning false in the callback function like
+ * {@link Ext.Array#each}. However, performance could be much better in modern browsers comparing with
+ * {@link Ext.Array#each}
+ *
+ * @param {Array} array The array to iterate
+ * @param {Function} fn The function callback, to be invoked these arguments:
+ *
+- `item`: {Mixed} The item at the current `index` in the passed `array`
+- `index`: {Number} The current `index` within the `array`
+- `allItems`: {Array} The `array` itself which was passed as the first argument
+
+ * @param {Object} scope (Optional) The execution scope (`this`) in which the specified function is executed.
+ * @markdown
+ */
+ forEach: function(array, fn, scope) {
+ if (supportsForEach) {
+ return array.forEach(fn, scope);
}
- return "'"+ sep + format + "values['" + name + "']" + args + ")"+sep+"'";
- }
- // 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('');
- }
- eval(body);
- return me;
- },
+ var i = 0,
+ ln = array.length;
- // private function used to call members
- call : function(fnName, value, allValues){
- return this[fnName](value, allValues);
- }
-});
-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.
- */
-/**
- * @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.
+ for (; i < ln; i++) { + fn.call(scope, array[i], i, array); + } + }, --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");
-
+ * Merge multiple arrays into one with unique items that exist in all of the arrays.
+ *
+ * @param {Array} array,...
+ * @return {Array} intersect
*/
- 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;
- },
+ intersect: function() {
+ var intersect = [],
+ arrays = slice.call(arguments),
+ i, j, k, minArray, array, x, y, ln, arraysLn, arrayLn;
- "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 (!arrays.length) {
+ return intersect;
+ }
- "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;
- }
+ // 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;
- },
+ minArray = Ext.Array.unique(minArray);
+ arrays.splice(x, 1);
- "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;
- },
+ // 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;
- "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;
+ 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} array A
+ * @param {Array} array B
+ * @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]) {
+ clone.splice(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;
+ /**
+ * 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.
+ * @param {Array} array The array to flatten
+ * @return {Array} The new, flattened array.
+ */
+ 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;
- },
-
- "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;
+ else {
+ if (item < min) {
+ min = item;
}
}
- 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.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
- */
- me.delay = function(delay, newFn, newScope, newArgs){
- me.cancel();
- fn = newFn || fn;
- scope = newScope || scope;
- args = newArgs || args;
- id = setInterval(call, delay);
- };
+ return min;
+ },
- /**
- * Cancel the last queued timeout
- */
- me.cancel = function(){
- if(id){
- clearInterval(id);
- id = null;
- }
- };
-};(function(){
+ /**
+ * 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;
-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
- });
+ for (i = 0, ln = array.length; i < ln; i++) {
+ item = array[i];
- // Copy configured listeners into *this* object so that the base class's
- // constructor will add them.
- this.listeners = config.listeners;
+ if (comparisonFn) {
+ if (comparisonFn(max, item) === -1) {
+ max = item;
+ }
+ }
+ else {
+ if (item > max) {
+ max = item;
+ }
+ }
+ }
- // 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;
- },
+ return max;
+ },
- // 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);
- }
- }
+ /**
+ * 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;
+ },
- // 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);
- }
- });
- },
+ /**
+ * 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;
- createHandler: function(fn, c) {
- return function(e) {
- fn.call(this, e, c);
- };
- }
-});
+ for (i = 0,ln = array.length; i < ln; i++) {
+ item = array[i];
-var combo = new Ext.form.ComboBox({
+ sum += item;
+ }
- // Collapse combo when its element is clicked on
- plugins: [ new Ext.DomObserver({
- click: function(evt, comp) {
- comp.collapse();
+ return sum;
}
- })],
- store: myStore,
- typeAhead: true,
- mode: 'local',
- triggerAction: 'all'
-});
- *
+
+ };
+
+ /**
+ * Convenient alias to {@link Ext.Array#each}
+ * @member Ext
+ * @method each
*/
- var me = this, e = me.events;
- if(me.listeners){
- me.on(me.listeners);
- delete me.listeners;
- }
- me.events = e || {};
-};
+ Ext.each = Ext.Array.each;
-EXTUTIL.Observable.prototype = {
- // private
- filterOptRe : /^(?:scope|delay|buffer|single)$/,
+ /**
+ * Alias to {@link Ext.Array#merge}.
+ * @member Ext.Array
+ * @method union
+ */
+ Ext.Array.union = Ext.Array.merge;
/**
- * 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. + * Old alias to {@link Ext.Array#min} + * @deprecated 4.0.0 Use {@link Ext.Array#min} instead + * @member Ext + * @method min */ - 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); - } - } - else if(typeof ce == 'object') { - if (ce.bubble){ - if(ce.fire.apply(ce, a.slice(1)) === FALSE) { - return FALSE; - } - c = me.getBubbleTarget && me.getBubbleTarget(); - if(c && c.enableBubble) { - cc = c.events[ename]; - if(!cc || typeof cc != 'object' || !cc.bubble) { - c.enableBubble(ename); - } - return c.fireEvent.apply(c, a); - } - } - else { - a.shift(); - ret = ce.fire.apply(ce, a); - } - } - return ret; - }, + Ext.min = Ext.Array.min; /** - * 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
-});
+ * Old alias to {@link Ext.Array#max}
+ * @deprecated 4.0.0 Use {@link Ext.Array#max} instead
+ * @member Ext
+ * @method max
*/
- addListener : function(eventName, fn, scope, o){
- var me = this,
- e,
- oe,
- 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);
- }
- }
- } else {
- eventName = eventName.toLowerCase();
- ce = me.events[eventName] || TRUE;
- if (typeof ce == 'boolean') {
- me.events[eventName] = ce = new EXTUTIL.Event(me, eventName);
- }
- ce.addListener(fn, scope, typeof o == 'object' ? o : {});
- }
- },
+ Ext.max = Ext.Array.max;
/**
- * 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.
+ * Old alias to {@link Ext.Array#sum}
+ * @deprecated 4.0.0 Use {@link Ext.Array#sum} instead
+ * @member Ext
+ * @method sum
*/
- removeListener : function(eventName, fn, scope){
- var ce = this.events[eventName.toLowerCase()];
- if (typeof ce == 'object') {
- ce.removeListener(fn, scope);
- }
- },
+ Ext.sum = Ext.Array.sum;
/**
- * Removes all listeners for this object
+ * Old alias to {@link Ext.Array#mean}
+ * @deprecated 4.0.0 Use {@link Ext.Array#mean} instead
+ * @member Ext
+ * @method mean
*/
- purgeListeners : function(){
- var events = this.events,
- evt,
- key;
- for(key in events){
- evt = events[key];
- if(typeof evt == 'object'){
- evt.clearListeners();
- }
- }
- },
+ Ext.mean = Ext.Array.mean;
/**
- * 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');
-
+ * Old alias to {@link Ext.Array#flatten}
+ * @deprecated 4.0.0 Use {@link Ext.Array#flatten} instead
+ * @member Ext
+ * @method flatten
*/
- 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);
- }
- },
+ Ext.flatten = Ext.Array.flatten;
/**
- * 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
+ * Old alias to {@link Ext.Array#clean Ext.Array.clean}
+ * @deprecated 4.0.0 Use {@link Ext.Array.clean} instead
+ * @member Ext
+ * @method clean
*/
- hasListener : function(eventName){
- var e = this.events[eventName.toLowerCase()];
- return typeof e == 'object' && e.listeners.length > 0;
- },
+ Ext.clean = Ext.Array.clean;
/**
- * 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;
+ * Old alias to {@link Ext.Array#unique Ext.Array.unique}
+ * @deprecated 4.0.0 Use {@link Ext.Array.unique} instead
+ * @member Ext
+ * @method unique
*/
- suspendEvents : function(queueSuspended){
- this.eventsSuspended = TRUE;
- if(queueSuspended && !this.eventQueue){
- this.eventQueue = [];
- }
- },
+ Ext.unique = Ext.Array.unique;
/**
- * 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.
+ * Old alias to {@link Ext.Array#pluck Ext.Array.pluck}
+ * @deprecated 4.0.0 Use {@link Ext.Array#pluck Ext.Array.pluck} instead
+ * @member Ext
+ * @method pluck
*/
- resumeEvents : function(){
- var me = this,
- queued = me.eventQueue || [];
- me.eventsSuspended = FALSE;
- delete me.eventQueue;
- EACH(queued, function(e) {
- me.fireEvent.apply(me, e);
- });
+ Ext.pluck = Ext.Array.pluck;
+
+ /**
+ * Convenient alias to {@link Ext.Array#toArray Ext.Array.toArray}
+ * @param {Iterable} the iterable object to be turned into a true Array.
+ * @member Ext
+ * @method toArray
+ * @return {Array} array
+ */
+ Ext.toArray = function() {
+ return ExtArray.toArray.apply(ExtArray, arguments);
}
-};
+})();
-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
- */
-OBSERVABLE.on = OBSERVABLE.addListener;
-/**
- * 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
+ * @class Ext.Function
+ *
+ * A collection of useful static methods to deal with function callbacks
+ * @singleton
*/
-OBSERVABLE.un = OBSERVABLE.removeListener;
-/**
- * Removes all added captures from the Observable.
- * @param {Observable} o The Observable to release
- * @static
- */
-EXTUTIL.Observable.releaseCapture = function(o){
- o.fireEvent = OBSERVABLE.fireEvent;
-};
-
-function createTargeted(h, o, scope){
- return function(){
- if(o.target == arguments[0]){
- h.apply(scope, Array.prototype.slice.call(arguments, 0));
- }
- };
-};
+Ext.Function = {
-function createBuffered(h, o, l, scope){
- l.task = new EXTUTIL.DelayedTask();
- return function(){
- l.task.delay(o.buffer, h, scope, Array.prototype.slice.call(arguments, 0));
- };
-};
-
-function createSingle(h, e, fn, scope){
- return function(){
- e.removeListener(fn, scope);
- return h.apply(scope, arguments);
- };
-};
+ /**
+ * 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
+var setValue = Ext.Function.flexSetter(function(name, value) {
+ this[name] = value;
+});
-function createDelayed(h, o, l, scope){
- return function(){
- var task = new EXTUTIL.DelayedTask();
- if(!l.tasks) {
- l.tasks = [];
- }
- l.tasks.push(task);
- task.delay(o.delay || 10, h, scope, Array.prototype.slice.call(arguments, 0));
- };
-};
+// Afterwards
+// Setting a single name - value
+setValue('name1', 'value1');
-EXTUTIL.Event = function(obj, name){
- this.name = name;
- this.obj = obj;
- this.listeners = [];
-};
+// Settings multiple name - value pairs
+setValue({
+ name1: 'value1',
+ name2: 'value2',
+ name3: 'value3'
+});
+ *
+ * @param {Function} setter
+ * @returns {Function} flexSetter
+ */
+ flexSetter: function(fn) {
+ return function(a, b) {
+ var k, i;
-EXTUTIL.Event.prototype = {
- addListener : function(fn, scope, options){
- var me = this,
- l;
- scope = scope || me.obj;
- if(!me.isListening(fn, scope)){
- l = 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);
+ if (a === null) {
+ return this;
}
- me.listeners.push(l);
- }
- },
-
- createListener: function(fn, scope, o){
- o = o || {};
- scope = scope || this.obj;
- var l = {
- fn: fn,
- scope: scope,
- options: o
- }, h = fn;
- if(o.target){
- h = createTargeted(h, o, scope);
- }
- if(o.delay){
- h = createDelayed(h, o, l, scope);
- }
- if(o.single){
- h = createSingle(h, this, fn, scope);
- }
- if(o.buffer){
- h = createBuffered(h, o, l, scope);
- }
- l.fireFn = h;
- return l;
- },
- findListener : function(fn, scope){
- var list = this.listeners,
- i = list.length,
- l;
+ if (typeof a !== 'string') {
+ for (k in a) {
+ if (a.hasOwnProperty(k)) {
+ fn.call(this, k, a[k]);
+ }
+ }
- scope = scope || this.obj;
- while(i--){
- l = list[i];
- if(l){
- if(l.fn == fn && l.scope == scope){
- return i;
+ if (Ext.enumerables) {
+ for (i = Ext.enumerables.length; i--;) {
+ k = Ext.enumerables[i];
+ if (a.hasOwnProperty(k)) {
+ fn.call(this, k, a[k]);
+ }
+ }
}
+ } else {
+ fn.call(this, a, b);
}
- }
- return -1;
- },
- isListening : function(fn, scope){
- return this.findListener(fn, scope) != -1;
+ return this;
+ };
},
- removeListener : function(fn, scope){
- var index,
- l,
- k,
- me = this,
- ret = FALSE;
- if((index = me.findListener(fn, scope)) != -1){
- if (me.firing) {
- me.listeners = me.listeners.slice(0);
- }
- l = me.listeners[index];
- if(l.task) {
- l.task.cancel();
- delete l.task;
+ /**
+ * 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)
+ *
+ * @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
+ */
+ bind: function(fn, scope, args, appendArgs) {
+ var method = fn,
+ applyArgs;
+
+ return function() {
+ var callArgs = args || arguments;
+
+ if (appendArgs === true) {
+ callArgs = Array.prototype.slice.call(arguments, 0);
+ callArgs = callArgs.concat(args);
}
- k = l.tasks && l.tasks.length;
- if(k) {
- while(k--) {
- l.tasks[k].cancel();
- }
- delete l.tasks;
+ else if (Ext.isNumber(appendArgs)) {
+ callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
+ applyArgs = [appendArgs, 0].concat(args); // create method call params
+ Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
}
- me.listeners.splice(index, 1);
- ret = TRUE;
- }
- return ret;
- },
- // Iterate to stop any buffered/delayed events
- clearListeners : function(){
- var me = this,
- l = me.listeners,
- i = l.length;
- while(i--) {
- me.removeListener(l[i].fn, l[i].scope);
- }
+ return method.apply(scope || window, callArgs);
+ };
},
- fire : function(){
- var me = this,
- listeners = me.listeners,
- len = listeners.length,
- i = 0,
- l;
+ /**
+ * 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(' '));
+ };
- if(len > 0){
- me.firing = TRUE;
- var args = Array.prototype.slice.call(arguments, 0);
- for (; i < len; i++) {
- l = listeners[i];
- if(l && l.fireFn.apply(l.scope || me.obj || window, args) === FALSE) {
- return (me.firing = FALSE);
- }
- }
+ var callback = Ext.Function.pass(originalFunction, ['Hello', 'World']);
+
+ callback(); // alerts 'Hello World'
+ callback('by Me'); // alerts 'Hello World by Me'
+
+ * @param {Function} fn The original function
+ * @param {Array} args The arguments to pass to new callback
+ * @param {Object} scope (optional) The scope (this
reference) in which the function is executed.
+ * @return {Function} The new callback function
+ */
+ pass: function(fn, args, scope) {
+ if (args) {
+ args = Ext.Array.from(args);
}
- me.firing = FALSE;
- return TRUE;
- }
-};
-})();
-/**
- * @class Ext.util.Observable
- */
-Ext.apply(Ext.util.Observable.prototype, function(){
- // this is considered experimental (along with beforeMethod, afterMethod, removeMethodListener?)
- // allows for easier interceptor and sequences, including cancelling and overwriting the return value of the call
- // private
- function getMethodEvent(method){
- var e = (this.methodEvents = this.methodEvents ||
- {})[method], returnValue, v, cancel, obj = this;
-
- if (!e) {
- this.methodEvents[method] = e = {};
- e.originalFn = this[method];
- e.methodName = method;
- e.before = [];
- e.after = [];
-
- var makeCall = function(fn, scope, args){
- if((v = fn.apply(scope || obj, args)) !== undefined){
- if (typeof v == 'object') {
- if(v.returnValue !== undefined){
- returnValue = v.returnValue;
- }else{
- returnValue = v;
- }
- cancel = !!v.cancel;
- }
- else
- if (v === false) {
- cancel = true;
- }
- else {
- returnValue = v;
- }
- }
- };
+ return function() {
+ return fn.apply(scope, args.concat(Ext.Array.toArray(arguments)));
+ };
+ },
- this[method] = function(){
- var args = Array.prototype.slice.call(arguments, 0),
- b;
- returnValue = v = undefined;
- cancel = false;
-
- for(var i = 0, len = e.before.length; i < len; i++){
- b = e.before[i];
- makeCall(b.fn, b.scope, args);
- if (cancel) {
- return returnValue;
- }
- }
+ /**
+ * Create an alias to the provided method property with name methodName
of object
.
+ * Note that the execution scope will still be bound to the provided object
itself.
+ *
+ * @param {Object/Function} object
+ * @param {String} methodName
+ * @return {Function} aliasFn
+ */
+ alias: function(object, methodName) {
+ return function() {
+ return object[methodName].apply(object, arguments);
+ };
+ },
- if((v = e.originalFn.apply(obj, args)) !== undefined){
- returnValue = v;
- }
+ /**
+ * 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);
+}
- for(var i = 0, len = e.after.length; i < len; i++){
- b = e.after[i];
- makeCall(b.fn, b.scope, args);
- if (cancel) {
- return returnValue;
- }
- }
- return returnValue;
+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;
};
}
- return e;
- }
+ },
- return {
- // these are considered experimental
- // allows for easier interceptor and sequences, including cancelling and overwriting the return value of the call
- // adds an 'interceptor' called before the original method
- beforeMethod : function(method, fn, scope){
- getMethodEvent.call(this, method).before.push({
- fn: fn,
- scope: scope
- });
- },
+ /**
+ * 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);
+ };
+ },
- // adds a 'sequence' called after the original method
- afterMethod : function(method, fn, scope){
- getMethodEvent.call(this, method).after.push({
- fn: fn,
- scope: scope
- });
- },
+ /**
+ * Calls this function after the number of millseconds specified, optionally in a specific scope. Example usage:
+ *
+var sayHi = function(name){
+ alert('Hi, ' + name);
+}
- removeMethodListener: function(method, fn, scope){
- var e = this.getMethodEvent(method);
- for(var i = 0, len = e.before.length; i < len; i++){
- if(e.before[i].fn == fn && e.before[i].scope == scope){
- e.before.splice(i, 1);
- return;
- }
- }
- for(var i = 0, len = e.after.length; i < len; i++){
- if(e.after[i].fn == fn && e.after[i].scope == scope){
- e.after.splice(i, 1);
- return;
- }
- }
- },
+// executes immediately:
+sayHi('Fred');
- /**
- * Relays selected events from the specified Observable as if the events were fired by this.
- * @param {Object} o The Observable whose events this object is to relay.
- * @param {Array} events Array of event names to relay.
- */
- relayEvents : function(o, events){
- var me = this;
- function createHandler(ename){
- return function(){
- return me.fireEvent.apply(me, [ename].concat(Array.prototype.slice.call(arguments, 0)));
- };
- }
- for(var i = 0, len = events.length; i < len; i++){
- var ename = events[i];
- me.events[ename] = me.events[ename] || true;
- o.on(ename, createHandler(ename), me);
- }
- },
+// executes after 2 seconds:
+Ext.Function.defer(sayHi, 2000, this, ['Fred']);
- /**
- * 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');
- }),
+// this syntax is sometimes useful for deferring
+// execution of an anonymous function:
+Ext.Function.defer(function(){
+ alert('Anonymous');
+}, 100);
+
+ * @param {Function} fn The function to defer.
+ * @param {Number} millis The number of milliseconds for the setTimeout call (if less than or equal to 0 the function is executed immediately)
+ * @param {Object} scope (optional) The scope (this
reference) in which the function is executed.
+ * If omitted, defaults to the browser window.
+ * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)
+ * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding,
+ * if a number the args are inserted at the specified position
+ * @return {Number} The timeout id that can be used with clearTimeout
+ */
+ defer: function(fn, millis, obj, args, appendArgs) {
+ fn = Ext.Function.bind(fn, obj, args, appendArgs);
+ if (millis > 0) {
+ return setTimeout(fn, millis);
+ }
+ fn();
+ return 0;
+ },
- // 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;
- }
+ /**
+ * 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);
});
-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');
+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
+ */
+ createSequence: function(origFn, newFn, scope) {
+ if (!Ext.isFunction(newFn)) {
+ return origFn;
}
- }
-});
-
- * @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;
- }
- ce.bubble = true;
- }
- }
+ 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 fn {Function} The function to execute at a regular time interval. + * @param interval {Number} The interval in milliseconds on which the passed function is executed. + * @param 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);
+ }
+ };
+ }
+};
/**
- * 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
+ * Shorthand for {@link Ext.Function#defer}
+ * @member Ext
+ * @method defer
*/
-Ext.util.Observable.capture = function(o, fn, scope){
- o.fireEvent = o.fireEvent.createInterceptor(fn, scope);
-};
+Ext.defer = Ext.Function.alias(Ext.Function, 'defer');
+/**
+ * Shorthand for {@link Ext.Function#pass}
+ * @member Ext
+ * @method pass
+ */
+Ext.pass = Ext.Function.alias(Ext.Function, 'pass');
/**
- * 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
+ * Shorthand for {@link Ext.Function#bind}
+ * @member Ext
+ * @method bind
*/
-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;
- }
-};
+Ext.bind = Ext.Function.alias(Ext.Function, 'bind');
+
/**
- * @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.
+ * @author Jacky Nguyen 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); + * @param {String} queryString The query string to decode + * @param {Boolean} recursive (Optional) Whether or not to recursively decode the string. This format is supported by + * PHP / Ruby on Rails servers and similar. Defaults to false + * @return {Object} + */ + fromQueryString: function(queryString, recursive) { + var parts = queryString.replace(/^\?/, '').split('&'), + object = {}, + temp, components, name, value, i, ln, + part, j, subLn, matchedKeys, matchedName, + keys, key, nextKey; + + for (i = 0, ln = parts.length; i < ln; i++) { + part = parts[i]; + + if (part.length > 0) { + components = part.split('='); + name = decodeURIComponent(components[0]); + value = (components[1] !== undefined) ? decodeURIComponent(components[1]) : ''; + + if (!recursive) { + if (object.hasOwnProperty(name)) { + if (!Ext.isArray(object[name])) { + object[name] = [object[name]]; } + + object[name].push(value); + } + else { + object[name] = value; } } - } else { - 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;
+ else {
+ matchedKeys = name.match(/(\[):?([^\]]*)\]/g);
+ matchedName = name.match(/^([^\[]+)/);
+
+ if (!matchedName) {
+ Ext.Error.raise({
+ sourceClass: "Ext.Object",
+ sourceMethod: "fromQueryString",
+ queryString: queryString,
+ recursive: recursive,
+ msg: 'Malformed query string given, failed parsing name from "' + part + '"'
+ });
+ }
- for (i = 0, len = f.length; i < len; i++) {
+ name = matchedName[0];
+ keys = [];
- /* 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;
+ if (matchedKeys === null) {
+ object[name] = value;
+ continue;
}
- wrap = fnc[1];
- E.un(el, eventName, E.extAdapter ? fnc[3] : wrap);
- // jQuery workaround that should be removed from Ext Core
- if(wrap && el.addEventListener && eventName == "mousewheel"){
- el.removeEventListener("DOMMouseScroll", wrap, false);
+ 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);
}
- // fix stopped mousedowns on the document
- if(wrap && el == DOC && eventName == "mousedown"){
- Ext.EventManager.stoppedMouseDownEvent.removeListener(wrap);
- }
+ keys.unshift(name);
- 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;
- }
- }
- },
+ temp = object;
- /**
- * 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();
+ for (j = 0, subLn = keys.length; j < subLn; j++) {
+ key = keys[j];
+
+ if (j === subLn - 1) {
+ if (Ext.isArray(temp) && key === '') {
+ temp.push(value);
+ }
+ else {
+ temp[key] = value;
}
- delete fn.tasks;
}
- wrap = fn[1];
- E.un(el, ename, E.extAdapter ? fn[3] : wrap);
+ else {
+ if (temp[key] === undefined || typeof temp[key] === 'string') {
+ nextKey = keys[j+1];
- // jQuery workaround that should be removed from Ext Core
- if(el.addEventListener && wrap && ename == "mousewheel"){
- el.removeEventListener("DOMMouseScroll", wrap, false);
- }
+ temp[key] = (Ext.isNumeric(nextKey) || nextKey === '') ? [] : {};
+ }
- // fix stopped mousedowns on the document
- if(wrap && el == DOC && ename == "mousedown"){
- Ext.EventManager.stoppedMouseDownEvent.removeListener(wrap);
+ temp = temp[key];
}
}
}
}
- if (Ext.elCache[id]) {
- Ext.elCache[id].events = {};
- }
- },
+ }
- 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;
- }
- },
+ return object;
+ },
- 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);
+ /**
+ * 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:
+
+ var person = {
+ name: 'Jacky'
+ hairColor: 'black'
+ loves: ['food', 'sleeping', 'wife']
+ };
+
+ Ext.Object.each(person, function(key, value, myself) {
+ console.log(key + ":" + value);
+
+ if (key === 'hairColor') {
+ return false; // stop the iteration
+ }
+ });
+
+ * @param {Object} object The object to iterate
+ * @param {Function} fn The callback function. Passed arguments for each iteration are:
+
+- {String} `key`
+- {Mixed} `value`
+- {Object} `object` The object itself
+
+ * @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;
}
}
- },
+ }
+ },
- _unload : function() {
- var el;
- for (el in Ext.elCache) {
- Ext.EventManager.removeAll(el);
- }
- delete Ext.elCache;
- delete Ext.Element._flyweights;
+ /**
+ * Merges any number of objects recursively without referencing them or their children.
- // 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});
+ var extjs = {
+ companyName: 'Ext JS',
+ products: ['Ext JS', 'Ext GWT', 'Ext Designer'],
+ isSuperCool: true
+ office: {
+ size: 2000,
+ location: 'Palo Alto',
+ isFun: true
+ }
+ };
+
+ var newStuff = {
+ companyName: 'Sencha Inc.',
+ products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],
+ office: {
+ size: 40000,
+ location: 'Redwood City'
+ }
+ };
+
+ var sencha = Ext.Object.merge(extjs, newStuff);
+
+ // extjs and sencha then equals to
+ {
+ companyName: 'Sencha Inc.',
+ products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],
+ isSuperCool: true
+ office: {
+ size: 30000,
+ location: 'Redwood City'
+ isFun: true
+ }
+ }
+
+ * @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);
}
}
- },
- /**
- * 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();
+ else {
+ source[key] = value;
+ }
+
+ return source;
+ }
+
+ var i = 1,
+ ln = arguments.length,
+ object, property;
+
+ for (; i < ln; i++) {
+ object = arguments[i];
+
+ for (property in object) {
+ if (object.hasOwnProperty(property)) {
+ ExtObject.merge(source, property, object[property]);
}
- options = options || {};
- options.delay = options.delay || 1;
- docReadyEvent.addListener(fn, scope, options);
}
- },
+ }
- /**
- * 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
+ return source;
+ },
+
+ /**
+ * Returns the first matching key corresponding to the given value.
+ * If no matching value is found, null is returned.
+
+ var person = {
+ name: 'Jacky',
+ loves: 'food'
};
- /**
- * 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
+
+ alert(Ext.Object.getKey(sencha, 'loves')); // alerts 'food'
+
+ * @param {Object} object
+ * @param {Object} value The value to find
+ * @markdown
*/
- pub.on = pub.addListener;
+ getKey: function(object, value) {
+ for (var property in object) {
+ if (object.hasOwnProperty(property) && object[property] === value) {
+ return property;
+ }
+ }
+
+ return null;
+ },
+
/**
- * 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
+ * Gets all values of the given object as an array.
+
+ var values = Ext.Object.getValues({
+ name: 'Jacky',
+ loves: 'food'
+ }); // ['Jacky', 'food']
+
+ * @param {Object} object
+ * @return {Array} An array of values from the object
+ * @markdown
*/
- pub.un = pub.removeListener;
+ getValues: function(object) {
+ var values = [],
+ property;
- 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;
+ for (property in object) {
+ if (object.hasOwnProperty(property)) {
+ values.push(object[property]);
+ }
+ }
+ return values;
+ },
-//Initialize doc classes
-(function(){
+ /**
+ * Gets all keys of the given object as an array.
- 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" : ""];
+ var values = Ext.Object.getKeys({
+ name: 'Jacky',
+ loves: 'food'
+ }); // ['name', 'loves']
- 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");
- }
+ * @param {Object} object
+ * @return {Array} An array of keys from the object
+ */
+ getKeys: ('keys' in Object.prototype) ? Object.keys : function(object) {
+ var keys = [],
+ property;
- if(Ext.isMac){
- cls.push("ext-mac");
- }
- if(Ext.isLinux){
- cls.push("ext-linux");
+ for (property in object) {
+ if (object.hasOwnProperty(property)) {
+ keys.push(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';
+ return keys;
+ },
+
+ /**
+ * Gets the total number of this object's own properties
+
+ var size = Ext.Object.getSize({
+ name: 'Jacky',
+ loves: 'food'
+ }); // size equals 2
+
+ * @param {Object} object
+ * @return {Number} size
+ * @markdown
+ */
+ getSize: function(object) {
+ var size = 0,
+ property;
+
+ 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,
- 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
- btnMap = Ext.isIE ? {1:0,4:1,2:2} :
- (Ext.isWebKit ? {1:0,2:1,3:2} : {0:0,1:1,2:2});
+Ext.merge = Ext.Object.merge;
- Ext.EventObjectImpl = function(e){
- if(e){
- this.setEvent(e.browserEvent || e);
- }
- };
+/**
+ * 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;
+ }
- 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(clickRe.test(e.type) && 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);
- }
- },
-
- /**
- * Prevents the browsers default handling of the event.
- */
- preventDefault : function(){
- if(this.browserEvent){
- E.preventDefault(this.browserEvent);
- }
- },
-
- /**
- * 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);
- }
- },
-
- /**
- * 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)
- },
-
- // 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 prefix + Ext.Object.toQueryString.apply(Ext.Object, args);
+};
- 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");
+ * 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);
+};
-// 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 */ - 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 DH = Ext.DomHelper, - 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. + *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 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 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 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. + * Date interval constant + * @static + * @type String */ + MILLI : "ms", + /** - * @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 */ + SECOND : "s", + /** - * @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 */ - /** - * @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. + MINUTE : "mi", + + /** Date interval constant + * @static + * @type String */ + HOUR : "h", + /** - * @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. + * Date interval constant + * @static + * @type String */ + DAY : "d", + /** - * @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 */ + MONTH : "mo", + /** - * @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 */ + YEAR : "y", -// 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. + *
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 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 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"
+ ],
+
/**
- * @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.
+ * 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"
+ ],
-// 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 #dateRenderer} and {@link #date} functions use. + * see {@link #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
*/
- 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];
- }
- return d[name];
- } : function(name, ns){
- var d = this.dom;
- return d.getAttributeNS(ns, name) || d.getAttribute(ns + ":" + name) || d.getAttribute(name) || d[name];
- },
+ // private
+ getFormatCode : function(character) {
+ var f = utilDate.formatCodes[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;
+ if (f) {
+ f = typeof f == 'function'? f() : f;
+ utilDate.formatCodes[character] = f; // reassign function result to prevent repeated execution
}
- return this;
- }
-};
-var ep = El.prototype;
+ // note: unknown characters are treated as literals
+ return f || ("'" + Ext.String.escape(character) + "'");
+ },
-El.addMethods = function(o){
- Ext.apply(ep, o);
-};
+ // private
+ createFormat : function(format) {
+ var code = [],
+ special = false,
+ ch = '';
-/**
- * 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;
-
-/**
- * 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;
-
-/**
- * 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;
-
-/**
- * @private
- */
-
-/**
- * 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; + 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 { - el.dom = DOC.getElementById(el.id) || el.dom; + code.push(utilDate.getFormatCode(ch)); } } - 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; -}; + utilDate.formatFunctions[format] = Ext.functionFactory("return " + code.join('+')); + }, -El.addToCache = function(el, id){ - id = id || el.id; - EC[id] = { - el: el, - data: {}, - events: {} - }; - return el; -}; + // 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 -// 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); - } -}; + "if(results){", + "{1}", -// 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; + "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);", - 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]; - } - EC = Ext.elCache = t; - } - } -} -El.collectorThreadId = setInterval(garbageCollect, 30000); + // 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()));", -var flyFn = function(){}; -flyFn.prototype = El.prototype; + // 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()));", -// dom is optional -El.Flyweight = function(dom){ - this.dom = dom; -}; + "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 -El.Flyweight.prototype = new flyFn(); -El.Flyweight.prototype.isFlyweight = true; -El._flyweights = {}; + // 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);", -/** - *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'; + // 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);", + "}", + "}", + "}", - if (el = Ext.getDom(el)) { - (El._flyweights[named] = El._flyweights[named] || new El.Flyweight()).dom = el; - ret = El._flyweights[named]; - } - return ret; -}; + "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));", + "}", + "}", -/** - * 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; + "return v;" + ].join('\n'); -/** - *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; + return function(format) { + var regexNum = utilDate.parseRegexes.length, + currentGroup = 1, + calc = [], + regex = [], + special = false, + ch = ""; -// 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; -} + 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); + } + } + } -})(); -/** - * @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(); + utilDate.parseRegexes[regexNum] = new RegExp("^" + regex.join('') + "$", 'i'); + utilDate.parseFunctions[format] = Ext.functionFactory("input", "strict", xf(code, regexNum, calc.join(''))); + }; + })(), + + // private + parseCodes : { + /* + * Notes: + * g = {Number} calculation group (0 or 1. only group 1 contributes to date calculations.) + * c = {String} calculation method (required for group 1. null for group 0. {0} = currentGroup - position in regex result array) + * s = {String} regex pattern. all matches are stored in results[], and are accessible by the calculation mapped to 'c' + */ + d: { + g:1, + c:"d = parseInt(results[{0}], 10);\n", + s:"(\\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')} + ]; + + 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 + */ + 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 {@link Ext.Loader#configs} for the list of possible properties + * + * @param {Object} config The config object to override the default values in {@link Ext.Loader#config} + * @return {Ext.Loader} this + * @markdown + */ + 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; + } + + return this; + }, - Ext.Updater.superclass.constructor.call(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]; + } + + return this.config; }, /** - * 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 + * 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 + * @markdown + */ + setPath: flexSetter(function(name, path) { + this.config.paths[name] = path; + + return this; + }), + + /** + * 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 + * @markdown */ - setRenderer : function(renderer){ - this.renderer = renderer; + getPath: function(className) { + var path = '', + paths = this.config.paths, + prefix = this.getPrefix(className); + + if (prefix.length > 0) { + if (prefix === className) { + return paths[prefix]; + } + + path = paths[prefix]; + className = className.substring(prefix.length + 1); + } + + if (path.length > 0) { + path += '/'; + } + + return path.replace(/\/\.\//g, '/') + className.replace(/\./g, "/") + '.js'; }, /** - * Returns the current content renderer for this Updater. See {@link Ext.Updater.BasicRenderer#render} for more details. - * @return {Object} + * @private + * @param {String} className */ - getRenderer : function(){ - return this.renderer; + getPrefix: function(className) { + var paths = this.config.paths, + prefix, deepestPrefix = ''; + + if (paths.hasOwnProperty(className)) { + return className; + } + + for (prefix in paths) { + if (paths.hasOwnProperty(prefix) && prefix + '.' === className.substring(0, prefix.length + 1)) { + if (prefix.length > deepestPrefix.length) { + deepestPrefix = prefix; + } + } + } + + return deepestPrefix; }, /** - * 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} + * 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 */ - getDefaultRenderer: function() { - return new Ext.Updater.BasicRenderer(); + refreshQueue: function() { + var ln = this.queue.length, + i, item, j, requires; + + if (ln === 0) { + this.triggerReady(); + return; + } + + for (i = 0; i < ln; i++) { + item = this.queue[i]; + + if (item) { + requires = item.requires; + + // Don't bother checking when the number of files loaded + // is still less than the array length + if (requires.length > this.numLoadedFiles) { + continue; + } + + j = 0; + + do { + if (Manager.isCreated(requires[j])) { + // Take out from the queue + requires.splice(j, 1); + } + else { + j++; + } + } while (j < requires.length); + + if (item.requires.length === 0) { + this.queue.splice(i, 1); + item.callback.call(item.scope); + this.refreshQueue(); + break; + } + } + } + + return this; }, /** - * Sets the default URL used for updates. - * @param {String/Function} defaultUrl The url or a function to call to get the url + * Inject a script element to document's head, call onLoad and onError accordingly + * @private */ - setDefaultUrl : function(defaultUrl){ - this.defaultUrl = defaultUrl; + 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); + }; + + 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; }, /** - * Get the Element this Updater is bound to - * @return {Ext.Element} The element + * @private */ - getEl : function(){ - return this.el; + cleanupScriptElement: function(script) { + script.onload = null; + script.onreadystatechange = null; + script.onerror = null; + + return this; }, /** - * Performs an asynchronous request, updating this element with the response. - * If params are specified it uses POST, otherwise it uses GET.update
event handler.
- * @param {Object} options A config object containing any of the following options:The URL to request or a function which - * returns the URL (defaults to the value of {@link Ext.Ajax#url} if not specified).
The HTTP method to
- * use. Defaults to POST if the params
argument is present, otherwise GET.
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.
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.
A function to - * be called when the response from the server arrives. The following - * parameters are passed:
The Element being updated.
True for success, false for failure.
The XMLHttpRequest which processed the update.
The config object passed to the update call.
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.
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).
The number of seconds to wait for a response before - * timing out (defaults to {@link Ext.Updater.defaults#timeout}).
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.
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: -
- 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.
- });
-
+ * Load a script file, supports both asynchronous and synchronous approaches
+ *
+ * @param {String} url
+ * @param {Function} onLoad
+ * @param {Scope} scope
+ * @param {Boolean} synchronous
+ * @private
*/
- update : function(url, params, callback, discardUrl){
+ loadScriptFile: function(url, onLoad, onError, scope, synchronous) {
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 = '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:The Element being updated.
True for success, false for failure.
The XMLHttpRequest which processed the update.
this
) of the callback function
+ * @param {Boolean} withDomReady Whether or not to wait for document dom ready as well
*/
- isUpdating : function(){
- return this.transaction ? Ext.Ajax.isLoading(this.transaction) : false;
+ onReady: function(fn, scope, withDomReady, options) {
+ var oldFn;
+
+ if (withDomReady !== false && Ext.onDocumentReady) {
+ oldFn = fn;
+
+ fn = function() {
+ Ext.onDocumentReady(oldFn, scope, options);
+ };
+ }
+
+ if (!this.isLoading) {
+ fn.call(scope);
+ }
+ else {
+ this.readyListeners.push({
+ fn: fn,
+ scope: scope
+ });
+ }
},
/**
- * 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)
+ * @private
+ * @param {String} className
*/
- refresh : function(callback){
- if(this.defaultUrl){
- this.update(this.defaultUrl, null, callback, true);
+ historyPush: function(className) {
+ if (className && this.isFileLoaded.hasOwnProperty(className)) {
+ Ext.Array.include(this.history, className);
}
+
+ return this;
}
- }
-}());
+ };
-/**
- * @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
+ * Convenient alias of {@link Ext.Loader#require}. Please see the introduction documentation of
+ * {@link Ext.Loader} for examples.
+ * @member Ext
+ * @method require
*/
- disableCaching : false,
+ Ext.require = alias(Loader, 'require');
+
/**
- * Whether or not to show {@link #indicatorText} during loading (defaults to true).
- * @type Boolean
+ * Synchronous version of {@link Ext#require}, convenient alias of {@link Ext.Loader#syncRequire}.
+ *
+ * @member Ext
+ * @method syncRequire
*/
- showLoadIndicator : true,
+ Ext.syncRequire = alias(Loader, 'syncRequire');
+
/**
- * Text for loading indicator (defaults to '<div class="loading-indicator">Loading...</div>').
- * @type String
- */
- indicatorText : 'Ext.Updater.updateElement("my-div", "stuff.php");
- * @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
- */
-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);
-};
+ /*
+ 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;
+ }
+ }
+ */
-/**
- * @class Ext.Updater.BasicRenderer
- * 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(){}; + for (i = 0, ln = dependencyProperties.length; i < ln; i++) { + propertyName = dependencyProperties[i]; -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): - *
-// Sample date:
-// 'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)'
+ if (data.hasOwnProperty(propertyName)) {
+ propertyValue = data[propertyName];
-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
-
- *
- * 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.
- *
-Date.patterns = {
- ISO8601Long:"Y-m-d H:i:s",
- ISO8601Short:"Y-m-d",
- ShortDate: "n/j/Y",
- LongDate: "l, F d, Y",
- FullDateTime: "l, F d, Y g:i:s A",
- MonthDay: "F d",
- ShortTime: "g:i A",
- LongTime: "g:i:s A",
- SortableDateTime: "Y-m-d\\TH:i:s",
- UniversalSortableDateTime: "Y-m-d H:i:sO",
- YearMonth: "F, Y"
-};
-
- *
- * Example usage:
- *
-var dt = new Date();
-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}.
- */ + if (typeof propertyValue === 'string') { + dependencies.push(propertyValue); + } + else if (propertyValue instanceof Array) { + for (j = 0, subLn = propertyValue.length; j < subLn; j++) { + value = propertyValue[j]; -/* - * 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. - */ + if (typeof value === 'string') { + dependencies.push(value); + } + } + } + else { + for (j in propertyValue) { + if (propertyValue.hasOwnProperty(j)) { + value = propertyValue[j]; -(function() { + if (typeof value === 'string') { + dependencies.push(value); + } + } + } + } + } + } + + if (dependencies.length === 0) { +// Loader.historyPush(className); + return; + } + + var deadlockPath = [], + requiresMap = Loader.requiresMap, + detectDeadlock; + + /* + Automatically detect deadlocks before-hand, + will throw an error with detailed path for ease of debugging. Examples of deadlock cases: + + - A extends B, then B extends A + - A requires B, B requires C, then C requires A + + The detectDeadlock function will recursively transverse till the leaf, hence it can detect deadlocks + no matter how deep the path is. + */ + + if (className) { + requiresMap[className] = dependencies; + + detectDeadlock = function(cls) { + deadlockPath.push(cls); + + if (requiresMap[cls]) { + if (Ext.Array.contains(requiresMap[cls], className)) { + Ext.Error.raise({ + sourceClass: "Ext.Loader", + msg: "Deadlock detected while loading dependencies! '" + className + "' and '" + + deadlockPath[1] + "' " + "mutually require each other. Path: " + + deadlockPath.join(' -> ') + " -> " + deadlockPath[0] + }); + } + + for (i = 0, ln = requiresMap[cls].length; i < ln; i++) { + detectDeadlock(requiresMap[cls][i]); + } + } + }; + + detectDeadlock(className); + } + + + Loader.require(dependencies, function() { + for (i = 0, ln = dependencyProperties.length; i < ln; i++) { + propertyName = dependencyProperties[i]; + + if (data.hasOwnProperty(propertyName)) { + propertyValue = data[propertyName]; + + if (typeof propertyValue === 'string') { + data[propertyName] = Manager.get(propertyValue); + } + else if (propertyValue instanceof Array) { + for (j = 0, subLn = propertyValue.length; j < subLn; j++) { + value = propertyValue[j]; + + if (typeof value === 'string') { + data[propertyName][j] = Manager.get(value); + } + } + } + else { + for (var k in propertyValue) { + if (propertyValue.hasOwnProperty(k)) { + value = propertyValue[k]; + + if (typeof value === 'string') { + data[propertyName][k] = Manager.get(value); + } + } + } + } + } + } + + continueFn.call(me, cls, data); + }); + + return false; + }, true); + + Class.setDefaultPreprocessorPosition('loader', 'after', 'className'); + + Manager.registerPostprocessor('uses', function(name, cls, data) { + var uses = Ext.Array.from(data.uses), + items = [], + i, ln, item; + + for (i = 0, ln = uses.length; i < ln; i++) { + item = uses[i]; + + if (typeof item === 'string') { + items.push(item); + } + } + + Loader.addOptionalRequires(items); + }); + + Manager.setDefaultPostprocessorPosition('uses', 'last'); + +})(Ext.ClassManager, Ext.Class, Ext.Function.flexSetter, Ext.Function.alias); /** - * 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; + * @class Ext.Error + * @private + * @extends Error +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. -// 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]; +Ext.Error also offers a global error {@link #handle handling} method that can be overridden in order to +handle application-wide errors in a single spot. You can optionally {@link #ignore} errors altogether, +although in a real application it's usually a better idea to override the handling function and perform +logging or some other method of reporting the errors in a way that is meaningful to the application. + +At its simplest you can simply raise an error as a simple string from within any code: + +#Example usage:# + + Ext.Error.raise('Something bad happened!'); + +If raised from plain JavaScript code, the error will be logged to the console (if available) and the message +displayed. In most cases however you'll be raising errors from within a class, and it may often be useful to add +additional metadata about the error being raised. The {@link #raise} method can also take a config object. +In this form the `msg` attribute becomes the error description, and any other data added to the config gets +added to the error object and, if the console is available, logged to the console for inspection. + +#Example usage:# + + Ext.define('Ext.Foo', { + doSomething: function(option){ + if (someCondition === false) { + Ext.Error.raise({ + msg: 'You cannot do that!', + option: option, // whatever was passed into the method + 'error code': 100 // other arbitrary info + }); + } + } }); -} +If a console is available (that supports the `console.dir` function) you'll see console output like: -// private -Date.formatCodeToRegex = function(character, currentGroup) { - // Note: currentGroup - position in regex result array (see notes for Date.parseCodes below) - var p = Date.parseCodes[character]; + An error was raised with the following data: + option: Object { foo: "bar"} + foo: "bar" + error code: 100 + msg: "You cannot do that!" + sourceClass: "Ext.Foo" + sourceMethod: "doSomething" + + uncaught exception: You cannot do that! + +As you can see, the error will report exactly where it was raised and will include as much information as the +raising code can usefully provide. + +If you want to handle all application errors globally you can simply override the static {@link handle} method +and provide whatever handling logic you need. If the method returns true then the error is considered handled +and will not be thrown to the browser. If anything but true is returned then the error will be thrown normally. + +#Example usage:# - if (p) { - p = typeof p == 'function'? p() : p; - Date.parseCodes[character] = p; // reassign function result to prevent repeated execution + 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 } - 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 + * Create a new Error object + * @param {Object} config The config object + * @markdown + * @author Brian MoeskauAn 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
: 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 + * @constructor + * @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. */ - 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; + constructor: function(config){ + if (Ext.isString(config)) { + config = { msg: config }; } + Ext.apply(this, config); }, - parseRegexes: [], /** - *
An object hash in which each property is a date formatting function. The property name is the - * format string which corresponds to the produced formatted date string.
- *This object is automatically populated with date formatting functions as - * date formats are requested for Ext standard formatting strings.
- *Custom formatting functions may be inserted into this object, keyed by a name which from then on - * may be used as a format string to {@link #format}. Example:
-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 +Provides a custom string representation of the error object. This is an override of the base JavaScript +`Object.toString` method, which is useful so that when logged to the browser console, an error object will +be displayed with a useful message instead of `[object Object]`, the default `toString` result. + +The default implementation will include the error message along with the raising class and method, if available, +but this can be overridden with a custom implementation either at the prototype level (for all errors) or on +a particular error instance, if you want to provide a custom description that will show up in the console. + * @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. */ - formatFunctions: { - "M$": function() { - // UTC milliseconds since Unix epoch (M$-AJAX serialized date format (MRSF)) - return '\\/Date(' + this.getTime() + ')\\/'; - } - }, + toString: function(){ + var me = this, + className = me.className ? me.className : '', + methodName = me.methodName ? '.' + me.methodName + '(): ' : '', + msg = me.msg || '(No description provided)'; - y2kYear : 50, + return className + methodName + msg; + } +}); + + +/* +Ext JS - JavaScript Library +Copyright (c) 2006-2011, Sencha Inc. +All rights reserved. +licensing@sencha.com +*/ +/** + * @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.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(""); + }; /** - * Date interval constant - * @static - * @type String + *
Encodes a Date. This returns the actual string which is inserted into the JSON string as the literal expression. + * The returned value includes enclosing double quotation marks.
+ *The default return format is "yyyy-mm-ddThh:mm:ss".
+ *To override this:
+ Ext.JSON.encodeDate = function(d) {
+ return d.format('"Y-m-d"');
+ };
+
+ * @param {Date} d The Date to encode
+ * @return {String} The string literal to use in a JSON string.
*/
- MILLI : "ms",
+ this.encodeDate = function(o) {
+ return '"' + o.getFullYear() + "-"
+ + pad(o.getMonth() + 1) + "-"
+ + pad(o.getDate()) + "T"
+ + pad(o.getHours()) + ":"
+ + pad(o.getMinutes()) + ":"
+ + pad(o.getSeconds()) + '"';
+ };
/**
- * Date interval constant
- * @static
- * @type String
+ * Encodes an Object, Array or other value
+ * @param {Mixed} o The variable to encode
+ * @return {String} The JSON string
*/
- SECOND : "s",
+ this.encode = function() {
+ var ec;
+ return function(o) {
+ if (!ec) {
+ // setup encoding function on first access
+ ec = isNative() ? JSON.stringify : doEncode;
+ }
+ return ec(o);
+ };
+ }();
+
/**
- * Date interval constant
- * @static
- * @type String
+ * 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
*/
- MINUTE : "mi",
+ 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 and invalid JSON String: " + json
+ });
+ }
+ };
+ }();
- /** Date interval constant
- * @static
- * @type String
- */
- HOUR : "h",
+})();
+/**
+ * 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',
/**
- * Date interval constant
- * @static
- * @type String
+ * True when the document is fully initialized and ready for action
+ * @type Boolean
*/
- DAY : "d",
+ isReady: false,
/**
- * Date interval constant
- * @static
- * @type String
+ * True to automatically uncache orphaned Ext.core.Elements periodically (defaults to true)
+ * @type Boolean
*/
- MONTH : "mo",
+ enableGarbageCollector: true,
/**
- * Date interval constant
- * @static
- * @type String
+ * True to automatically purge event listeners during garbageCollection (defaults to true).
+ * @type Boolean
*/
- YEAR : "y",
+ enableListenerCollection: true,
/**
- * 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 #parseDate} 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
-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.
-Date.parseDate('2009-02', 'Y-m'); // returns a Date object representing February 1st 2009
-
- * @property defaults
- * @static
- * @type Object
+ * 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.
*/
- defaults: {},
+ id: function(el, prefix) {
+ el = Ext.getDom(el, true) || {};
+ if (el === document) {
+ el.id = this.documentId;
+ }
+ else if (el === window) {
+ el.id = this.windowId;
+ }
+ if (!el.id) {
+ el.id = (prefix || "ext-gen") + (++Ext.idSeed);
+ }
+ return el.id;
+ },
/**
- * An array of textual day names.
- * Override these values for international dates.
- * Example:
- *
-Date.dayNames = [
- 'SundayInYourLang',
- 'MondayInYourLang',
- ...
-];
-
- * @type Array
- * @static
+ * Returns the current document body as an {@link Ext.core.Element}.
+ * @return Ext.core.Element The document body
*/
- dayNames : [
- "Sunday",
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday",
- "Saturday"
- ],
+ getBody: function() {
+ return Ext.get(document.body || false);
+ },
/**
- * An array of textual month names.
- * Override these values for international dates.
- * Example:
- *
-Date.monthNames = [
- 'JanInYourLang',
- 'FebInYourLang',
- ...
-];
-
- * @type Array
- * @static
+ * Returns the current document head as an {@link Ext.core.Element}.
+ * @return Ext.core.Element The document head
*/
- monthNames : [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
- ],
+ getHead: function() {
+ var head;
+
+ return function() {
+ if (head == undefined) {
+ head = Ext.get(document.getElementsByTagName("head")[0]);
+ }
+
+ return head;
+ };
+ }(),
/**
- * 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:
- *
-Date.monthNumbers = {
- 'ShortJanNameInYourLang':0,
- 'ShortFebNameInYourLang':1,
- ...
-};
-
- * @type Object
- * @static
+ * Returns the current HTML document object as an {@link Ext.core.Element}.
+ * @return Ext.core.Element The document
*/
- 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
+ getDoc: function() {
+ return Ext.get(document);
},
/**
- * Get the short month name for the given month number.
- * Override this function for international dates.
- * @param {Number} month A zero-based javascript month number.
- * @return {String} The short month name.
- * @static
- */
- getShortMonthName : function(month) {
- return Date.monthNames[month].substring(0, 3);
+ * 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);
},
/**
- * Get the short day name for the given day number.
- * Override this function for international dates.
- * @param {Number} day A zero-based javascript day number.
- * @return {String} The short day name.
- * @static
+ * Returns the current orientation of the mobile device
+ * @return {String} Either 'portrait' or 'landscape'
*/
- getShortDayName : function(day) {
- return Date.dayNames[day].substring(0, 3);
+ getOrientation: function() {
+ return window.innerHeight > window.innerWidth ? 'portrait' : 'landscape';
},
/**
- * Get the zero-based javascript month number for the given short/full month name.
- * Override this function for international dates.
- * @param {String} name The short/full month name.
- * @return {Number} The zero-based javascript month number.
- * @static
+ * 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)
*/
- getMonthNumber : function(name) {
- // handle camel casing for english month names (since the keys for the Date.monthNumbers hash are case sensitive)
- return Date.monthNumbers[name.substring(0, 1).toUpperCase() + name.substring(1, 3).toLowerCase()];
+ 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();
+ }
+ }
+ }
},
/**
- * 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: Date.format() treats characters as literals if an appropriate mapping cannot be found.
- * Example:
- *
-Date.formatCodes.x = "String.leftPad(this.getDate(), 2, '0')";
-(new Date()).format("X"); // returns the current day of the month
-
- * @type Object
- * @static
+ * Execute a callback function in a particular scope. If no function is passed the call is ignored.
+ * @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.
*/
- formatCodes : {
- d: "String.leftPad(this.getDate(), 2, '0')",
- D: "Date.getShortDayName(this.getDay())", // get localised short day name
- j: "this.getDate()",
- l: "Date.dayNames[this.getDay()]",
- N: "(this.getDay() ? this.getDay() : 7)",
- S: "this.getSuffix()",
- w: "this.getDay()",
- z: "this.getDayOfYear()",
- W: "String.leftPad(this.getWeekOfYear(), 2, '0')",
- F: "Date.monthNames[this.getMonth()]",
- m: "String.leftPad(this.getMonth() + 1, 2, '0')",
- M: "Date.getShortMonthName(this.getMonth())", // get localised short month name
- n: "(this.getMonth() + 1)",
- t: "this.getDaysInMonth()",
- L: "(this.isLeapYear() ? 1 : 0)",
- o: "(this.getFullYear() + (this.getWeekOfYear() == 1 && this.getMonth() > 0 ? +1 : (this.getWeekOfYear() >= 52 && this.getMonth() < 11 ? -1 : 0)))",
- Y: "this.getFullYear()",
- 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: "String.leftPad((this.getHours() % 12) ? this.getHours() % 12 : 12, 2, '0')",
- H: "String.leftPad(this.getHours(), 2, '0')",
- i: "String.leftPad(this.getMinutes(), 2, '0')",
- s: "String.leftPad(this.getSeconds(), 2, '0')",
- u: "String.leftPad(this.getMilliseconds(), 3, '0')",
- O: "this.getGMTOffset()",
- P: "this.getGMTOffset(true)",
- T: "this.getTimezone()",
- Z: "(this.getTimezoneOffset() * -60)",
-
- 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'" : Date.getFormatCode(e)); // treat T as a character literal
+ 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);
}
- return code.join(" + ");
- },
- /*
- c: function() { // ISO-8601 -- UTC format
- return [
- "this.getUTCFullYear()", "'-'",
- "String.leftPad(this.getUTCMonth() + 1, 2, '0')", "'-'",
- "String.leftPad(this.getUTCDate(), 2, '0')",
- "'T'",
- "String.leftPad(this.getUTCHours(), 2, '0')", "':'",
- "String.leftPad(this.getUTCMinutes(), 2, '0')", "':'",
- "String.leftPad(this.getUTCSeconds(), 2, '0')",
- "'Z'"
- ].join(" + ");
- },
- */
-
- U: "Math.round(this.getTime() / 1000)"
+ }
},
/**
- * Checks if the passed Date parameters will cause a javascript Date "rollover".
- * @param {Number} year 4-digit year
- * @param {Number} month 1-based month-of-year
- * @param {Number} day Day of month
- * @param {Number} hour (optional) Hour
- * @param {Number} minute (optional) Minute
- * @param {Number} second (optional) Second
- * @param {Number} millisecond (optional) Millisecond
- * @return {Boolean} true if the passed parameters do not cause a Date "rollover", false otherwise.
- * @static
+ * 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
*/
- isValid : function(y, m, d, h, i, s, ms) {
- // setup defaults
- h = h || 0;
- i = i || 0;
- s = s || 0;
- ms = ms || 0;
-
- var dt = new Date(y, m - 1, d, h, i, s, ms);
+ htmlEncode : function(value) {
+ return Ext.String.htmlEncode(value);
+ },
- return y == dt.getFullYear() &&
- m == dt.getMonth() + 1 &&
- d == dt.getDate() &&
- h == dt.getHours() &&
- i == dt.getMinutes() &&
- s == dt.getSeconds() &&
- ms == dt.getMilliseconds();
+ /**
+ * Convert certain characters (&, <, >, and ') from their HTML character equivalents.
+ * @param {String} value The string to decode
+ * @return {String} The decoded text
+ */
+ htmlDecode : function(value) {
+ return Ext.String.htmlDecode(value);
},
/**
- * 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();
+ * 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
+ */
+ urlAppend : function(url, s) {
+ if (!Ext.isEmpty(s)) {
+ return url + (url.indexOf('?') === -1 ? '?' : '&') + s;
+ }
+ return url;
+ }
+});
-//dt = Thu May 25 2006 (today's month/day in 2006)
-dt = Date.parseDate("2006", "Y");
-//dt = Sun Jan 15 2006 (all date parts specified)
-dt = Date.parseDate("2006-01-15", "Y-m-d");
+Ext.ns = Ext.namespace;
-//dt = Sun Jan 15 2006 15:20:01
-dt = Date.parseDate("2006-01-15 3:20:01 PM", "Y-m-d g:i:s A");
+// for old browsers
+window.undefined = window.undefined;
+/**
+ * @class Ext
+ * Ext core utilities and functions.
+ * @singleton
+ */
+(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/),
+ scrollWidth = null;
+
+ // remove css image flicker
+ try {
+ document.execCommand("BackgroundImageCache", false, true);
+ } catch(e) {}
-// attempt to parse Sun Feb 29 2006 03:20:01 in strict mode
-dt = Date.parseDate("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
- */
- parseDate : function(input, format, strict) {
- var p = Date.parseFunctions;
- if (p[format] == null) {
- Date.createParser(format);
- }
- return p[format](input, Ext.isDefined(strict) ? strict : Date.useStrict);
- },
+ Ext.setVersion('extjs', '4.0.0');
+ 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
- getFormatCode : function(character) {
- var f = Date.formatCodes[character];
+ /**
+ * True if the {@link Ext.fx.Anim} Class is available
+ * @type Boolean
+ * @property enableFx
+ */
- if (f) {
- f = typeof f == 'function'? f() : f;
- Date.formatCodes[character] = f; // reassign function result to prevent repeated execution
- }
+ /**
+ * 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,
- // note: unknown characters are treated as literals
- return f || ("'" + String.escape(character) + "'");
- },
+ /**
+ * EXPERIMENTAL - True to cascade listener removal to child elements when an element is removed.
+ * Currently not optimized for performance.
+ * @type Boolean
+ */
+ enableNestedListenerRemoval : false,
- // private
- createFormat : function(format) {
- var code = [],
- special = false,
- ch = '';
+ /**
+ * 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,
- for (var i = 0; i < format.length; ++i) {
- ch = format.charAt(i);
- if (!special && ch == "\\") {
- special = true;
- } else if (special) {
- special = false;
- code.push("'" + String.escape(ch) + "'");
+ /**
+ * 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:
+ *
+// 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
+}
+ *
+ * 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;
+ }
+ if (el.dom) {
+ return el.dom;
} else {
- code.push(Date.getFormatCode(ch))
+ 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;
+ }
}
- }
- Date.formatFunctions[format] = new Function("return " + code.join('+'));
- },
+ },
- // private
- createParser : function() {
- var code = [
- "var dt, y, m, d, h, i, s, ms, o, z, zz, u, v,",
- "def = Date.defaults,",
- "results = String(input).match(Date.parseRegexes[{0}]);", // either null, or an array of matched strings
+ /**
+ * Removes a DOM node from the document.
+ * Removes this element from the document, removes all DOM event listeners, and deletes the cache reference.
+ * All DOM event listeners are removed from this element. If {@link Ext#enableNestedListenerRemoval Ext.enableNestedListenerRemoval} is
+ * true
, then DOM event listeners are also removed from all child nodes. The body node
+ * will be ignored if passed in.
Utility method for returning a default value if the passed value is empty.
+ *The value is deemed to be empty if it is
+Ext.addBehaviors({
+ // add a listener for click on all anchors in element with id foo
+ '#foo a@click' : function(e, t){
+ // do something
+ },
+
+ // add the same listener to multiple selectors (separated by comma BEFORE the @)
+ '#foo a, #bar span.some-class@mouseover' : function(){
+ // do something
+ }
+});
+ *
+ * @param {Object} obj The list of behaviors to apply
+ */
+ addBehaviors : function(o){
+ if(!Ext.isReady){
+ Ext.onReady(function(){
+ Ext.addBehaviors(o);
+ });
+ } else {
+ var cache = {}, // simple cache for applying multiple behaviors to same selector does query multiple times
+ parts,
+ b,
+ s;
+ for (b in o) {
+ if ((parts = b.split('@'))[1]) { // for Object prototype breakers
+ s = parts[0];
+ if(!cache[s]){
+ cache[s] = Ext.select(s);
+ }
+ cache[s].on(parts[1], o[b]);
+ }
+ }
+ cache = null;
}
},
- N: {
- g:0,
- c:null,
- s:"[1-7]" // ISO-8601 day number (1 (monday) - 7 (sunday))
+
+ /**
+ * Utility method for getting the width of the browser scrollbar. 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 {Number} The width of the scrollbar.
+ */
+ getScrollBarWidth: function(force){
+ if(!Ext.isReady){
+ return 0;
+ }
+
+ if(force === true || scrollWidth === 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
+ var div = Ext.getBody().createChild(' '),
+ child = div.child('div', true);
+ var w1 = child.offsetWidth;
+ div.setStyle('overflow', (Ext.isWebKit || Ext.isGecko) ? 'auto' : 'scroll');
+ var w2 = child.offsetWidth;
+ div.remove();
+ // Need to add 2 to ensure we leave enough space
+ scrollWidth = w1 - w2 + 2;
+ }
+ return scrollWidth;
},
- S: {
- g:0,
- c:null,
- s:"(?:st|nd|rd|th)"
+
+ /**
+ * 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.
+ */
+ 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;
},
- w: {
- g:0,
- c:null,
- s:"[0-6]" // javascript day number (0 (sunday) - 6 (saturday))
+
+ /**
+ * 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.
+ */
+ destroyMembers : function(o, arg1, arg2, etc){
+ for (var i = 1, a = arguments, len = a.length; i < len; i++) {
+ Ext.destroy(o[a[i]]);
+ delete o[a[i]];
+ }
},
- z: {
- g:1,
- c:"z = parseInt(results[{0}], 10);\n",
- s:"(\\d{1,3})" // day of the year (0 - 364 (365 in leap years))
+
+ /**
+ * Partitions the set into two sets: a true set and a false set.
+ * Example:
+ * Example2:
+ *
+// 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 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} [true
+// Example:
+Ext.invoke(Ext.query("p"), "getAttribute", "id");
+// [el1.getAttribute("id"), el2.getAttribute("id"), ..., elN.getAttribute("id")]
+ *
+ * @param {Array|NodeList} arr The Array of items to invoke the method on.
+ * @param {String} methodName The method name to invoke.
+ * @param {...*} args Arguments to send into the method invocation.
+ * @return {Array} The results of invoking the method on each item in the array.
+ * @deprecated 4.0.0 Will be removed in the next major version
+ */
+ invoke : function(arr, methodName){
+ var ret = [],
+ args = Array.prototype.slice.call(arguments, 2);
+ 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;
},
- F: function() {
- return {
- g:1,
- c:"m = parseInt(Date.getMonthNumber(results[{0}]), 10);\n", // get localised month number
- s:"(" + Date.monthNames.join("|") + ")"
+
+ /**
+ * Zips N sets together.
+ *
+// Example 1:
+Ext.zip([1,2,3],[4,5,6]); // [[1,4],[2,5],[3,6]]
+// Example 2:
+Ext.zip(
+ [ "+", "-", "+"],
+ [ 12, 10, 22],
+ [ 43, 15, 96],
+ function(a, b, c){
+ return "$" + a + "" + b + "." + c
+ }
+); // ["$+12.43", "$-10.15", "$+22.96"]
+ *
+ * @param {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 = [];
+
+ 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;
},
- M: function() {
- for (var a = [], i = 0; i < 12; a.push(Date.getShortMonthName(i)), ++i); // get localised short month names
- return Ext.applyIf({
- s:"(" + a.join("|") + ")"
- }, $f("F"));
+
+ /**
+ * 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);
+ }
},
- m: {
- g:1,
- c:"m = parseInt(results[{0}], 10) - 1;\n",
- s:"(\\d{2})" // month number with leading zeros (01 - 12)
+
+ /**
+ * 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
+ });
+})();
+
+/**
+ * TBD
+ * @type Function
+ * @param {Object} config
+ */
+Ext.application = function(config) {
+ Ext.require('Ext.app.Application');
+
+ Ext.onReady(function() {
+ Ext.create('Ext.app.Application', config);
+ });
+};
+
+/**
+ * @class Ext.util.Format
+
+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.
+
+__Localization__
+This class contains several options for localization. These can be set once the library has loaded,
+all calls to the functions from that point will use the locale settings that were specified.
+Options include:
+- thousandSeparator
+- decimalSeparator
+- currenyPrecision
+- currencySign
+- currencyAtEnd
+This class also uses the default date format defined here: {@link Ext.date#defaultFormat}.
+
+__Using with renderers__
+There are two helper functions that return a new function that can be used in conjunction with
+grid renderers:
+
+ columns: [{
+ dataIndex: 'date',
+ renderer: Ext.util.Format.dateRenderer('Y-m-d')
+ }, {
+ dataIndex: 'time',
+ renderer: Ext.util.Format.numberRenderer('0.000')
+ }]
+
+Functions that only take a single argument can also be passed directly:
+ columns: [{
+ dataIndex: 'cost',
+ renderer: Ext.util.Format.usMoney
+ }, {
+ dataIndex: 'productCode',
+ renderer: Ext.util.Format.uppercase
+ }]
+
+__Using with XTemplates__
+XTemplates can also directly use Ext.util.Format functions:
+
+ new Ext.XTemplate([
+ 'Date: {startDate:date("Y-m-d")}',
+ 'Cost: {cost:usMoney}'
+ ]);
+
+ * @markdown
+ * @singleton
+ */
+(function() {
+ Ext.ns('Ext.util');
+
+ Ext.util.Format = {};
+ var UtilFormat = Ext.util.Format,
+ stripTagsRE = /<\/?[^>]+>/gi,
+ stripScriptsRe = /(?:The character that the {@link #number} function uses as a thousand separator.
+ *This defaults to ,
, but may be overridden in a locale file.
The character that the {@link #number} function uses as a decimal point.
+ *This defaults to .
, but may be overridden in a locale file.
The number of decimal places that the {@link #currency} function displays.
+ *This defaults to 2
, but may be overridden in a locale file.
The currency sign that the {@link #currency} function displays.
+ *This defaults to $
, 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 false
, but may be overridden in a locale file.
+ * var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');
+ *
+ * @return {Function} A function that operates on the passed value.
+ */
+ 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;
},
- 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 + String.leftPad(hr, 2, '0') + String.leftPad(mn, 2, '0')) : null;\n" // -12hrs <= GMT offset <= 14hrs
- ].join("\n"),
- s: "([+\-]\\d{4})" // GMT offset in hrs and mins
+
+ /**
+ * 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.
+// 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, -Ext.apply(Date.prototype, { // private - dateFormat : function(format) { - if (Date.formatFunctions[format] == null) { - Date.createFormat(format); - } - return Date.formatFunctions[format].call(this); + stopThread = function() { + running = false; + clearInterval(id); + id = 0; }, - /** - * 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. - * @return {String} The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...). - */ - getTimezone : function() { - // 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 this.toString().replace(/^.* (?:\((.*)\)|([A-Z]{1,4})(?:[\-+][0-9]{4})?(?: -?\d+)?)$/, "$1$2").replace(/[^A-Z]/g, ""); + // private + startThread = function() { + if (!running) { + running = true; + id = setInterval(runTasks, interval); + } }, - /** - * Get the offset from GMT of the current date (equivalent to the format specifier 'O'). - * @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(colon) { - return (this.getTimezoneOffset() > 0 ? "-" : "+") - + String.leftPad(Math.floor(Math.abs(this.getTimezoneOffset()) / 60), 2, "0") - + (colon ? ":" : "") - + String.leftPad(Math.abs(this.getTimezoneOffset() % 60), 2, "0"); + // private + removeTask = function(t) { + removeQueue.push(t); + if (t.onStop) { + t.onStop.apply(t.scope || t); + } }, - /** - * Get the numeric day number of the year, adjusted for leap year. - * @return {Number} 0 to 364 (365 in leap years). - */ - getDayOfYear: function() { - var num = 0, - d = this.clone(), - m = this.getMonth(), + // private + runTasks = function() { + var rqLen = removeQueue.length, + now = new Date().getTime(), i; - for (i = 0, d.setDate(1), d.setMonth(0); i < m; d.setMonth(++i)) { - num += d.getDaysInMonth(); + if (rqLen > 0) { + for (i = 0; i < rqLen; i++) { + Ext.Array.remove(tasks, removeQueue[i]); + } + removeQueue = []; + if (tasks.length < 1) { + stopThread(); + return; + } } - return num + this.getDate() - 1; - }, + 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); + } + } + }; /** - * Get the numeric ISO-8601 week number of the year. - * (equivalent to the format specifier 'W', but without a leading zero). - * @return {Number} 1 to 53 + * 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 the scope
argument.
Return false
from this function to terminate the task.
interval
: Numberargs
: Arrayrun
. If not specified, the current invocation count is passed.scope
: Objectrun
function. Defaults to the task config object.duration
: Numberrepeat
: NumberBefore each invocation, Ext injects the property 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; + }, + /** - * Checks if the current date falls within a leap year. - * @return {Boolean} True if the current date falls within a leap year, false otherwise. + * @property iPhone True when the browser is running on a iPhone + * @type {Boolean} */ - isLeapYear : function() { - var year = this.getFullYear(); - return !!((year & 3) == 0 && (year % 100 || (year % 400 == 0 && year))); + platforms: [{ + property: 'platform', + regex: /iPhone/i, + identity: 'iPhone' }, - + /** - * Get the first day of the current month, adjusted for leap year. The returned value - * is the numeric day index within the week (0-6) which can be used in conjunction with - * the {@link #monthNames} array to retrieve the textual day name. - * Example: - *
-var dt = new Date('1/10/2007');
-document.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'
-
- * @return {Number} The day number (0-6).
+ * @property iPod True when the browser is running on a iPod
+ * @type {Boolean}
*/
- getFirstDayOfMonth : function() {
- var day = (this.getDay() - (this.getDate() - 1)) % 7;
- return (day < 0) ? (day + 7) : day;
+ {
+ property: 'platform',
+ regex: /iPod/i,
+ identity: 'iPod'
},
-
+
/**
- * Get the last day of the current month, adjusted for leap year. The returned value
- * is the numeric day index within the week (0-6) which can be used in conjunction with
- * the {@link #monthNames} array to retrieve the textual day name.
- * Example:
- *
-var dt = new Date('1/10/2007');
-document.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'
-
- * @return {Number} The day number (0-6).
+ * @property iPad True when the browser is running on a iPad
+ * @type {Boolean}
*/
- getLastDayOfMonth : function() {
- return this.getLastDateOfMonth().getDay();
+ {
+ property: 'userAgent',
+ regex: /iPad/i,
+ identity: 'iPad'
},
-
-
+
/**
- * Get the date of the first day of the month in which this date resides.
- * @return {Date}
+ * @property Blackberry True when the browser is running on a Blackberry
+ * @type {Boolean}
*/
- getFirstDateOfMonth : function() {
- return new Date(this.getFullYear(), this.getMonth(), 1);
+ {
+ property: 'userAgent',
+ regex: /Blackberry/i,
+ identity: 'Blackberry'
},
-
+
/**
- * Get the date of the last day of the month in which this date resides.
- * @return {Date}
+ * @property Android True when the browser is running on an Android device
+ * @type {Boolean}
*/
- getLastDateOfMonth : function() {
- return new Date(this.getFullYear(), this.getMonth(), this.getDaysInMonth());
+ {
+ property: 'userAgent',
+ regex: /Android/i,
+ identity: 'Android'
},
-
+
/**
- * Get the number of days in the current month, adjusted for leap year.
- * @return {Number} The number of days in the month.
+ * @property Mac True when the browser is running on a Mac
+ * @type {Boolean}
*/
- getDaysInMonth: function() {
- var daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
+ {
+ 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();
- return function() { // return a closure for efficiency
- var m = this.getMonth();
+/**
+ * @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 = [
+ '
-//wrong way:
-var orig = new Date('10/1/2006');
-var copy = orig;
-copy.setDate(5);
-document.write(orig); //returns 'Thu Oct 05 2006'!
-
-//correct way:
-var orig = new Date('10/1/2006');
-var copy = orig.clone();
-copy.setDate(5);
-document.write(orig); //returns 'Thu Oct 01 2006'
-
- * @return {Date} The new Date instance.
+ * @property CSS3BoxShadow True if document environment supports the CSS3 box-shadow style.
+ * @type {Boolean}
*/
- clone : function() {
- return new Date(this.getTime());
- },
+ CSS3BoxShadow: Ext.isDefined(document.documentElement.style.boxShadow),
/**
- * Checks if the current date is affected by Daylight Saving Time (DST).
- * @return {Boolean} True if the current date is affected by DST.
+ * @property ClassList True if document environment supports the HTML5 classList API.
+ * @type {Boolean}
*/
- isDST : function() {
- // adapted from http://extjs.com/forum/showthread.php?p=247172#post247172
- // courtesy of @geoffrey.mcgill
- return new Date(this.getFullYear(), 0, 1).getTimezoneOffset() != this.getTimezoneOffset();
- },
+ ClassList: !!document.documentElement.classList,
/**
- * Attempts to clear all time information from this Date by setting the time to midnight of the same day,
- * automatically adjusting for Daylight Saving Time (DST) where applicable.
- * (note: DST timezone information for the browser's host operating system is assumed to be up-to-date)
- * @param {Boolean} clone true to create a clone of this date, clear the time and return it (defaults to false).
- * @return {Date} this or the clone.
+ * @property OrientationChange True if the device supports orientation change
+ * @type {Boolean}
*/
- clearTime : function(clone) {
- if (clone) {
- return this.clone().clearTime();
- }
-
- // get current date before clearing time
- var d = this.getDate();
-
- // clear time
- this.setHours(0);
- this.setMinutes(0);
- this.setSeconds(0);
- this.setMilliseconds(0);
-
- if (this.getDate() != d) { // account for DST (i.e. day of month changed when setting hour = 0)
- // note: DST adjustments are assumed to occur in multiples of 1 hour (this is almost always the case)
- // refer to http://www.timeanddate.com/time/aboutdst.html for the (rare) exceptions to this rule
-
- // increment hour until cloned date == current date
- for (var hr = 1, c = this.add(Date.HOUR, hr); c.getDate() != d; hr++, c = this.add(Date.HOUR, hr));
-
- this.setDate(d);
- this.setHours(c.getHours());
- }
-
- return this;
- },
-
+ OrientationChange: ((typeof window.orientation != 'undefined') && ('onorientationchange' in window)),
+
/**
- * Provides a convenient method for performing basic date arithmetic. This method
- * does not modify the Date instance being called - it creates and returns
- * a new Date instance containing the resulting date value.
- *
- * Examples:
- *
-// Basic usage:
-var dt = new Date('10/29/2006').add(Date.DAY, 5);
-document.write(dt); //returns 'Fri Nov 03 2006 00:00:00'
-
-// Negative values will be subtracted:
-var dt2 = new Date('10/1/2006').add(Date.DAY, -5);
-document.write(dt2); //returns 'Tue Sep 26 2006 00:00:00'
-
-// You can even chain several calls together in one line:
-var dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);
-document.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'
-
- *
- * @param {String} interval A valid date interval enum value.
- * @param {Number} value The amount to add to the current date.
- * @return {Date} The new Date instance.
+ * @property DeviceMotion True if the device supports device motion (acceleration and rotation rate)
+ * @type {Boolean}
*/
- add : function(interval, value) {
- var d = this.clone();
- if (!interval || value === 0) return d;
-
- switch(interval.toLowerCase()) {
- case Date.MILLI:
- d.setMilliseconds(this.getMilliseconds() + value);
- break;
- case Date.SECOND:
- d.setSeconds(this.getSeconds() + value);
- break;
- case Date.MINUTE:
- d.setMinutes(this.getMinutes() + value);
- break;
- case Date.HOUR:
- d.setHours(this.getHours() + value);
- break;
- case Date.DAY:
- d.setDate(this.getDate() + value);
- break;
- case Date.MONTH:
- var day = this.getDate();
- if (day > 28) {
- day = Math.min(day, this.getFirstDateOfMonth().add('mo', value).getLastDateOfMonth().getDate());
- }
- d.setDate(day);
- d.setMonth(this.getMonth() + value);
- break;
- case Date.YEAR:
- d.setFullYear(this.getFullYear() + value);
- break;
- }
- return d;
- },
-
+ DeviceMotion: ('ondevicemotion' in window),
+
/**
- * Checks if this date falls on or between the given start and end dates.
- * @param {Date} start Start date
- * @param {Date} end End date
- * @return {Boolean} true if this date falls on or between the given start and end dates.
+ * @property Touch True if the device supports touch
+ * @type {Boolean}
*/
- between : function(start, end) {
- var t = this.getTime();
- return start.getTime() <= t && t <= end.getTime();
- }
-});
-
-
-/**
- * Formats a date given the supplied format string.
- * @param {String} format The format string.
- * @return {String} The formatted date.
- * @method format
- */
-Date.prototype.format = Date.prototype.dateFormat;
-
+ // 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),
-// private
-if (Ext.isSafari && (navigator.userAgent.match(/WebKit\/(\d+)/)[1] || NaN) < 420) {
- Ext.apply(Date.prototype, {
- _xMonth : Date.prototype.setMonth,
- _xDate : Date.prototype.setDate,
-
- // Bug in Safari 1.3, 2.0 (WebKit build < 420)
- // Date.setMonth does not work consistently if iMonth is not 0-11
- setMonth : function(num) {
- if (num <= -1) {
- var n = Math.ceil(-num),
- back_year = Math.ceil(n / 12),
- month = (n % 12) ? 12 - n % 12 : 0;
-
- this.setFullYear(this.getFullYear() - back_year);
-
- return this._xMonth(month);
- } else {
- return this._xMonth(num);
+ 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, view) {
+ view = doc.defaultView;
+ return !(view && view.getComputedStyle(div.firstChild.firstChild, null).marginRight != '0px');
+ }
+ },
+
+ /**
+ * @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');
}
},
- // Bug in setDate() method (resolved in WebKit build 419.3, so to be safe we target Webkit builds < 420)
- // The parameter for Date.setDate() is converted to a signed byte integer in Safari
- // http://brianary.blogspot.com/2006/03/safari-date-bug.html
- setDate : function(d) {
- // use setTime() to workaround setDate() bug
- // subtract current day of month in milliseconds, then add desired day of month in milliseconds
- return this.setTime(this.getTime() - (this.getDate() - d) * 864e5);
- }
- });
-}
-
-
-
-/* Some basic Date tests... (requires Firebug)
-
-Date.parseDate('', 'c'); // call Date.parseDate() once to force computation of regex string so we can console.log() it
-console.log('Insane Regex for "c" format: %o', Date.parseCodes.c.s); // view the insane regex for the "c" format specifier
-
-// standard tests
-console.group('Standard Date.parseDate() Tests');
- console.log('Date.parseDate("2009-01-05T11:38:56", "c") = %o', Date.parseDate("2009-01-05T11:38:56", "c")); // assumes browser's timezone setting
- console.log('Date.parseDate("2009-02-04T12:37:55.001000", "c") = %o', Date.parseDate("2009-02-04T12:37:55.001000", "c")); // assumes browser's timezone setting
- console.log('Date.parseDate("2009-03-03T13:36:54,101000Z", "c") = %o', Date.parseDate("2009-03-03T13:36:54,101000Z", "c")); // UTC
- console.log('Date.parseDate("2009-04-02T14:35:53.901000-0530", "c") = %o', Date.parseDate("2009-04-02T14:35:53.901000-0530", "c")); // GMT-0530
- console.log('Date.parseDate("2009-05-01T15:34:52,9876000+08:00", "c") = %o', Date.parseDate("2009-05-01T15:34:52,987600+08:00", "c")); // GMT+08:00
-console.groupEnd();
-
-// ISO-8601 format as specified in http://www.w3.org/TR/NOTE-datetime
-// -- accepts ALL 6 levels of date-time granularity
-console.group('ISO-8601 Granularity Test (see http://www.w3.org/TR/NOTE-datetime)');
- console.log('Date.parseDate("1997", "c") = %o', Date.parseDate("1997", "c")); // YYYY (e.g. 1997)
- console.log('Date.parseDate("1997-07", "c") = %o', Date.parseDate("1997-07", "c")); // YYYY-MM (e.g. 1997-07)
- console.log('Date.parseDate("1997-07-16", "c") = %o', Date.parseDate("1997-07-16", "c")); // YYYY-MM-DD (e.g. 1997-07-16)
- console.log('Date.parseDate("1997-07-16T19:20+01:00", "c") = %o', Date.parseDate("1997-07-16T19:20+01:00", "c")); // YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00)
- console.log('Date.parseDate("1997-07-16T19:20:30+01:00", "c") = %o', Date.parseDate("1997-07-16T19:20:30+01:00", "c")); // YYYY-MM-DDThh:mm:ssTZD (e.g. 1997-07-16T19:20:30+01:00)
- console.log('Date.parseDate("1997-07-16T19:20:30.45+01:00", "c") = %o', Date.parseDate("1997-07-16T19:20:30.45+01:00", "c")); // YYYY-MM-DDThh:mm:ss.sTZD (e.g. 1997-07-16T19:20:30.45+01:00)
- console.log('Date.parseDate("1997-07-16 19:20:30.45+01:00", "c") = %o', Date.parseDate("1997-07-16 19:20:30.45+01:00", "c")); // YYYY-MM-DD hh:mm:ss.sTZD (e.g. 1997-07-16T19:20:30.45+01:00)
- console.log('Date.parseDate("1997-13-16T19:20:30.45+01:00", "c", true)= %o', Date.parseDate("1997-13-16T19:20:30.45+01:00", "c", true)); // strict date parsing with invalid month value
-console.groupEnd();
+ /**
+ * @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'));
+ }
+ },
-//*/
-/**
- * @class Ext.util.MixedCollection
- * @extends Ext.util.Observable
- * A Collection class that maintains both numeric indexes and keys and exposes events.
- * @constructor
- * @param {Boolean} allowFunctions Specify true if the {@link #addAll}
- * function should add function references to the collection. Defaults to
- * false.
- * @param {Function} keyFn A function that can accept an item of the type(s) stored in this MixedCollection
- * and return the key value for that item. This is used when available to look up the key on items that
- * were passed without an explicit key parameter to a MixedCollection method. Passing this parameter is
- * equivalent to providing an implementation for the {@link #getKey} method.
- */
-Ext.util.MixedCollection = function(allowFunctions, keyFn){
- this.items = [];
- this.map = {};
- this.keys = [];
- this.length = 0;
- this.addEvents(
+ /**
+ * @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;
+ }
+ },
+
/**
- * @event clear
- * Fires when the collection is cleared.
+ * @property CSS3BorderRadius True if the device supports CSS3 border radius
+ * @type {Boolean}
*/
- 'clear',
+ {
+ 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;
+ }
+ },
+
/**
- * @event add
- * Fires when an item is added to the collection.
- * @param {Number} index The index at which the item was added.
- * @param {Object} o The item added.
- * @param {String} key The key associated with the added item.
+ * @property GeoLocation True if the device supports GeoLocation
+ * @type {Boolean}
*/
- 'add',
+ {
+ identity: 'GeoLocation',
+ fn: function() {
+ return (typeof navigator != 'undefined' && typeof navigator.geolocation != 'undefined') || (typeof google != 'undefined' && typeof google.gears != 'undefined');
+ }
+ },
/**
- * @event replace
- * Fires when an item is replaced in the collection.
- * @param {String} key he key associated with the new added.
- * @param {Object} old The item being replaced.
- * @param {Object} new The new item.
+ * @property MouseEnterLeave True if the browser supports mouseenter and mouseleave events
+ * @type {Boolean}
*/
- 'replace',
+ {
+ identity: 'MouseEnterLeave',
+ fn: function(doc, div){
+ return ('onmouseenter' in div && 'onmouseleave' in div);
+ }
+ },
/**
- * @event remove
- * Fires when an item is removed from the collection.
- * @param {Object} o The item being removed.
- * @param {String} key (optional) The key associated with the removed item.
+ * @property MouseWheel True if the browser supports the mousewheel event
+ * @type {Boolean}
*/
- 'remove',
- 'sort'
- );
- this.allowFunctions = allowFunctions === true;
- if(keyFn){
- this.getKey = keyFn;
- }
- Ext.util.MixedCollection.superclass.constructor.call(this);
+ {
+ 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;
+ }
+ }
+
+ ]
};
-Ext.extend(Ext.util.MixedCollection, Ext.util.Observable, {
- /**
- * @cfg {Boolean} allowFunctions Specify true if the {@link #addAll}
- * function should add function references to the collection. Defaults to
- * false.
- */
- allowFunctions : false,
- /**
- * Adds an item to the collection. Fires the {@link #add} event when complete.
- * @param {String} key The key to associate with the item, or the new item.
- *If a {@link #getKey} implementation was specified for this MixedCollection, - * or if the key of the stored items is in a property called id, - * the MixedCollection will be able to derive the key for the new item. - * In this case just pass the new item in this parameter.
- * @param {Object} o The item to add. - * @return {Object} The item added. - */ - add : function(key, o){ - if(arguments.length == 1){ - o = arguments[0]; - key = this.getKey(o); - } - if(typeof key != 'undefined' && key !== null){ - var old = this.map[key]; - if(typeof old != 'undefined'){ - return this.replace(key, o); - } - this.map[key] = o; - } - this.length++; - this.items.push(o); - this.keys.push(key); - this.fireEvent('add', this.length-1, o, key); - return o; - }, +/* +Ext JS - JavaScript Library +Copyright (c) 2006-2011, Sencha Inc. +All rights reserved. +licensing@sencha.com +*/ +/** + * @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: + *
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.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}'});
- /**
- * MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation
- * simply returns item.id
but you can provide your own implementation
- * to return a different value as in the following examples:
-// normal way
-var mc = new Ext.util.MixedCollection();
-mc.add(someEl.dom.id, someEl);
-mc.add(otherEl.dom.id, otherEl);
-//and so on
+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}';
-// using getKey
-var mc = new Ext.util.MixedCollection();
-mc.getKey = function(el){
- return el.dom.id;
-};
-mc.add(someEl);
-mc.add(otherEl);
+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}';
-// or via the constructor
-var mc = new Ext.util.MixedCollection(false, function(el){
- return el.dom.id;
+var tpl = new Ext.core.DomHelper.createTemplate(html);
+tpl.append('blog-roll', {
+ id: 'link1',
+ url: 'http://www.edspencer.net/',
+ text: "Ed's Site"
});
-mc.add(someEl);
-mc.add(otherEl);
- *
- * @param {Object} item The item for which to find the key.
- * @return {Object} The key for the passed item.
- */
- getKey : function(o){
- return o.id;
- },
+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}';
- /**
- * Replaces an item in the collection. Fires the {@link #replace} event when complete.
- * @param {String} key The key associated with the item to replace, or the replacement item.
- * If you supplied a {@link #getKey} implementation for this MixedCollection, or if the key
- * of your stored items is in a property called id, then the MixedCollection
- * will be able to derive the key of the replacement item. If you want to replace an item
- * with one having the same key value, then just pass the replacement item in this parameter.
- * @param o {Object} o (optional) If the first parameter passed was a key, the item to associate
- * with that key.
- * @return {Object} The new item.
- */
- replace : function(key, o){
- if(arguments.length == 1){
- o = arguments[0];
- key = this.getKey(o);
- }
- var old = this.map[key];
- if(typeof key == 'undefined' || key === null || typeof old == 'undefined'){
- return this.add(key, o);
- }
- var index = this.indexOfKey(key);
- this.items[index] = o;
- this.map[key] = o;
- this.fireEvent('replace', key, old, o);
- return o;
- },
+var tpl = new Ext.core.DomHelper.createTemplate(html);
+tpl.compile();
- /**
- * Adds all elements of an Array or an Object to the collection.
- * @param {Object/Array} objs An Object containing properties which will be added
- * to the collection, or an Array of values, each of which are added to the collection.
- * Functions references will be added to the collection if {@link #allowFunctions}
- * has been set to true.
- */
- addAll : function(objs){
- if(arguments.length > 1 || Ext.isArray(objs)){
- var args = arguments.length > 1 ? arguments : objs;
- for(var i = 0, len = args.length; i < len; i++){
- this.add(args[i]);
- }
- }else{
- for(var key in objs){
- if(this.allowFunctions || typeof objs[key] != 'function'){
- this.add(key, objs[key]);
- }
+//... 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.core.DomHelper.useDom = true; // force it to use DOM; reduces performance
+ *
+ * @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 = 'The collection item
The item's index
The total number of items in the collection
this
reference) in which the function is executed. Defaults to the current item in the iteration.
- */
- each : function(fn, scope){
- var items = [].concat(this.items); // each safe for removal
- for(var i = 0, len = items.length; i < len; i++){
- if(fn.call(scope || items[i], items[i], i, len) === false){
- break;
+ 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);
}
- }
- },
-
- /**
- * Executes the specified function once for every key in the collection, passing each
- * key, and its associated item as the first two parameters.
- * @param {Function} fn The function to execute for each item.
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the browser window.
- */
- eachKey : function(fn, scope){
- for(var i = 0, len = this.keys.length; i < len; i++){
- fn.call(scope || window, this.keys[i], this.items[i], i, len);
- }
- },
-
- /**
- * Returns the first item in the collection which elicits a true return value from the
- * passed selection function.
- * @param {Function} fn The selection function to execute for each item.
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the browser window.
- * @return {Object} The first item in the collection which returned true from the selection function.
- */
- find : function(fn, scope){
- for(var i = 0, len = this.items.length; i < len; i++){
- if(fn.call(scope || window, this.items[i], this.keys[i])){
- return this.items[i];
+ } 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;
+ }
+ }
+ }
}
- }
- return null;
- },
+ Ext.core.DomHelper.applyStyles(el, o.style);
- /**
- * Inserts an item at the specified index in the collection. Fires the {@link #add} event when complete.
- * @param {Number} index The index to insert the item at.
- * @param {String} key The key to associate with the new item, or the item itself.
- * @param {Object} o (optional) If the second parameter was a key, the new item.
- * @return {Object} The item inserted.
- */
- insert : function(index, key, o){
- if(arguments.length == 2){
- o = arguments[1];
- key = this.getKey(o);
- }
- if(this.containsKey(key)){
- this.suspendEvents();
- this.removeKey(key);
- this.resumeEvents();
- }
- if(index >= this.length){
- return this.add(key, o);
+ if ((cn = o.children || o.cn)) {
+ createDom(cn, el);
+ } else if (o.html) {
+ el.innerHTML = o.html;
+ }
}
- this.length++;
- this.items.splice(index, 0, o);
- if(typeof key != 'undefined' && key !== null){
- this.map[key] = o;
+ if(parentNode){
+ parentNode.appendChild(el);
}
- this.keys.splice(index, 0, key);
- this.fireEvent('add', index, o, key);
- return o;
- },
+ return el;
+ }
- /**
- * Remove an item from the collection.
- * @param {Object} o The item to remove.
- * @return {Object} The item removed or false if no item was removed.
- */
- remove : function(o){
- return this.removeAt(this.indexOf(o));
- },
+ // build as innerHTML where available
+ function createHtml(o){
+ var b = '',
+ attr,
+ val,
+ key,
+ cn,
+ i;
- /**
- * Remove an item from a specified index in the collection. Fires the {@link #remove} event when complete.
- * @param {Number} index The index within the collection of the item to remove.
- * @return {Object} The item removed or false if no item was removed.
- */
- removeAt : function(index){
- if(index < this.length && index >= 0){
- this.length--;
- var o = this.items[index];
- this.items.splice(index, 1);
- var key = this.keys[index];
- if(typeof key != 'undefined'){
- delete this.map[key];
- }
- this.keys.splice(index, 1);
- this.fireEvent('remove', o, key);
- return o;
+ 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 false;
- },
-
- /**
- * Removed an item associated with the passed key fom the collection.
- * @param {String} key The key of the item to remove.
- * @return {Object} The item removed or false if no item was removed.
- */
- removeKey : function(key){
- return this.removeAt(this.indexOfKey(key));
- },
-
- /**
- * Returns the number of items in the collection.
- * @return {Number} the number of items in the collection.
- */
- getCount : function(){
- return this.length;
- },
-
- /**
- * Returns index within the collection of the passed Object.
- * @param {Object} o The item to find the index of.
- * @return {Number} index of the item. Returns -1 if not found.
- */
- indexOf : function(o){
- return this.items.indexOf(o);
- },
-
- /**
- * Returns index within the collection of the passed key.
- * @param {String} key The key to find the index of.
- * @return {Number} index of the key.
- */
- indexOfKey : function(key){
- return this.keys.indexOf(key);
- },
-
- /**
- * Returns the item associated with the passed key OR index.
- * Key has priority over index. This is the equivalent
- * of calling {@link #key} first, then if nothing matched calling {@link #itemAt}.
- * @param {String/Number} key The key or index of the item.
- * @return {Object} If the item is found, returns the item. If the item was not found, returns undefined.
- * If an item was found, but is a Class, returns null.
- */
- item : function(key){
- var mk = this.map[key],
- item = mk !== undefined ? mk : (typeof key == 'number') ? this.items[key] : undefined;
- return typeof item != 'function' || this.allowFunctions ? item : null; // for prototype!
- },
-
- /**
- * Returns the item at the specified index.
- * @param {Number} index The index of the item.
- * @return {Object} The item at the specified index.
- */
- itemAt : function(index){
- return this.items[index];
- },
-
- /**
- * Returns the item associated with the passed key.
- * @param {String/Number} key The key of the item.
- * @return {Object} The item associated with the passed key.
- */
- key : function(key){
- return this.map[key];
- },
-
- /**
- * Returns true if the collection contains the passed Object as an item.
- * @param {Object} o The Object to look for in the collection.
- * @return {Boolean} True if the collection contains the Object as an item.
- */
- contains : function(o){
- return this.indexOf(o) != -1;
- },
-
- /**
- * Returns true if the collection contains the passed Object as a key.
- * @param {String} key The key to look for in the collection.
- * @return {Boolean} True if the collection contains the Object as a key.
- */
- containsKey : function(key){
- return typeof this.map[key] != 'undefined';
- },
-
- /**
- * Removes all items from the collection. Fires the {@link #clear} event when complete.
- */
- clear : function(){
- this.length = 0;
- this.items = [];
- this.keys = [];
- this.map = {};
- this.fireEvent('clear');
- },
-
- /**
- * Returns the first item in the collection.
- * @return {Object} the first item in the collection..
- */
- first : function(){
- return this.items[0];
- },
-
- /**
- * Returns the last item in the collection.
- * @return {Object} the last item in the collection..
- */
- last : function(){
- return this.items[this.length-1];
- },
-
- /**
- * @private
- * Performs the actual sorting based on a direction and a sorting function. Internally,
- * this creates a temporary array of all items in the MixedCollection, sorts it and then writes
- * the sorted array data back into this.items and this.keys
- * @param {String} property Property to sort by ('key', 'value', or 'index')
- * @param {String} dir (optional) Direction to sort 'ASC' or 'DESC'. Defaults to 'ASC'.
- * @param {Function} fn (optional) Comparison function that defines the sort order.
- * Defaults to sorting by numeric value.
- */
- _sort : function(property, dir, fn){
- var i, len,
- dsc = String(dir).toUpperCase() == 'DESC' ? -1 : 1,
-
- //this is a temporary array used to apply the sorting function
- c = [],
- keys = this.keys,
- items = this.items;
-
- //default to a simple sorter function if one is not provided
- fn = fn || function(a, b) {
- return a - b;
- };
+ return b;
+ }
- //copy all the items into a temporary array, which we will sort
- for(i = 0, len = items.length; i < len; i++){
- c[c.length] = {
- key : keys[i],
- value: items[i],
- index: i
- };
+ function ieTable(depth, s, h, e){
+ tempTableEl.innerHTML = [s, h, e].join('');
+ var i = -1,
+ el = tempTableEl,
+ ns;
+ while(++i < depth){
+ el = el.firstChild;
}
-
- //sort the temporary array
- c.sort(function(a, b){
- var v = fn(a[property], b[property]) * dsc;
- if(v === 0){
- v = (a.index < b.index ? -1 : 1);
+// 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;
}
- return v;
- });
-
- //copy the temporary array back into the main this.items and this.keys objects
- for(i = 0, len = c.length; i < len; i++){
- items[i] = c[i].value;
- keys[i] = c[i].key;
+ el = df;
}
-
- this.fireEvent('sort', this);
- },
-
- /**
- * Sorts this collection by item value with the passed comparison function.
- * @param {String} direction (optional) 'ASC' or 'DESC'. Defaults to 'ASC'.
- * @param {Function} fn (optional) Comparison function that defines the sort order.
- * Defaults to sorting by numeric value.
- */
- sort : function(dir, fn){
- this._sort('value', dir, fn);
- },
+ return el;
+ }
/**
- * Reorders each of the items based on a mapping from old index to new index. Internally this
- * just translates into a sort. The 'sort' event is fired whenever reordering has occured.
- * @param {Object} mapping Mapping from old item index to new item index
+ * @ignore
+ * Nasty code for IE's broken table implementation
*/
- reorder: function(mapping) {
- this.suspendEvents();
-
- var items = this.items,
- index = 0,
- length = items.length,
- order = [],
- remaining = [],
- oldIndex;
+ function insertIntoTable(tag, where, el, html) {
+ var node,
+ before;
- //object of {oldPosition: newPosition} reversed to {newPosition: oldPosition}
- for (oldIndex in mapping) {
- order[mapping[oldIndex]] = items[oldIndex];
- }
+ tempTableEl = tempTableEl || document.createElement('div');
- for (index = 0; index < length; index++) {
- if (mapping[index] == undefined) {
- remaining.push(items[index]);
- }
+ 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;
- for (index = 0; index < length; index++) {
- if (order[index] == undefined) {
- order[index] = remaining.shift();
- }
+ if (where == beforebegin || where == afterend) {
+ el = el.parentNode;
}
- this.clear();
- this.addAll(order);
-
- this.resumeEvents();
- this.fireEvent('sort', this);
- },
-
- /**
- * Sorts this collection by keys.
- * @param {String} direction (optional) 'ASC' or 'DESC'. Defaults to 'ASC'.
- * @param {Function} fn (optional) Comparison function that defines the sort order.
- * Defaults to sorting by case insensitive string.
- */
- keySort : function(dir, fn){
- this._sort('key', dir, fn || function(a, b){
- var v1 = String(a).toUpperCase(), v2 = String(b).toUpperCase();
- return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0);
- });
- },
-
- /**
- * Returns a range of items in this collection
- * @param {Number} startIndex (optional) The starting index. Defaults to 0.
- * @param {Number} endIndex (optional) The ending index. Defaults to the last item.
- * @return {Array} An array of items
- */
- getRange : function(start, end){
- var items = this.items;
- if(items.length < 1){
- return [];
- }
- start = start || 0;
- end = Math.min(typeof end == 'undefined' ? this.length-1 : end, this.length-1);
- var i, r = [];
- if(start <= end){
- for(i = start; i <= end; i++) {
- r[r.length] = items[i];
- }
- }else{
- for(i = start; i >= end; i--) {
- r[r.length] = items[i];
- }
+ 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);
}
- return r;
- },
-
+ el.insertBefore(node, before);
+ return node;
+ }
+
/**
- * Filter the objects in this collection by a specific property.
- * Returns a new collection that has been filtered.
- * @param {String} property A property on your objects
- * @param {String/RegExp} value Either string that the property values
- * should start with or a RegExp to test against the property
- * @param {Boolean} anyMatch (optional) True to match any part of the string, not just the beginning
- * @param {Boolean} caseSensitive (optional) True for case sensitive comparison (defaults to False).
- * @return {MixedCollection} The new filtered collection
- */
- filter : function(property, value, anyMatch, caseSensitive){
- if(Ext.isEmpty(value, false)){
- return this.clone();
- }
- value = this.createValueMatcher(value, anyMatch, caseSensitive);
- return this.filterBy(function(o){
- return o && value.test(o[property]);
- });
- },
+ * @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;
- /**
- * Filter by a function. Returns a new collection that has been filtered.
- * The passed function will be called with each object in the collection.
- * If the function returns true, the value is included otherwise it is filtered.
- * @param {Function} fn The function to be called, it will receive the args o (the object), k (the key)
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to this MixedCollection.
- * @return {MixedCollection} The new filtered collection
- */
- filterBy : function(fn, scope){
- var r = new Ext.util.MixedCollection();
- r.getKey = this.getKey;
- var k = this.keys, it = this.items;
- for(var i = 0, len = it.length; i < len; i++){
- if(fn.call(scope||this, it[i], k[i])){
- r.add(k[i], it[i]);
- }
+ for (; i < length; i++) {
+ fragment.appendChild(childNodes[i].cloneNode(true));
}
- return r;
- },
- /**
- * Finds the index of the first matching object in this collection by a specific property/value.
- * @param {String} property The name of a property on your objects.
- * @param {String/RegExp} value A string that the property values
- * should start with or a RegExp to test against the property.
- * @param {Number} start (optional) The index to start searching at (defaults to 0).
- * @param {Boolean} anyMatch (optional) True to match any part of the string, not just the beginning.
- * @param {Boolean} caseSensitive (optional) True for case sensitive comparison.
- * @return {Number} The matched index or -1
- */
- findIndex : function(property, value, start, anyMatch, caseSensitive){
- if(Ext.isEmpty(value, false)){
- return -1;
- }
- value = this.createValueMatcher(value, anyMatch, caseSensitive);
- return this.findIndexBy(function(o){
- return o && value.test(o[property]);
- }, null, start);
- },
+ 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);
+ },
- /**
- * Find the index of the first matching object in this collection by a function.
- * If the function returns true it is considered a match.
- * @param {Function} fn The function to be called, it will receive the args o (the object), k (the key).
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to this MixedCollection.
- * @param {Number} start (optional) The index to start searching at (defaults to 0).
- * @return {Number} The matched index or -1
- */
- findIndexBy : function(fn, scope, start){
- var k = this.keys, it = this.items;
- for(var i = (start||0), len = it.length; i < len; i++){
- if(fn.call(scope||this, it[i], k[i])){
- return i;
+ /**
+ * 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);
+ }
}
- }
- return -1;
- },
+ },
- /**
- * Returns a regular expression based on the given value and matching options. This is used internally for finding and filtering,
- * and by Ext.data.Store#filter
- * @private
- * @param {String} value The value to create the regex for. This is escaped using Ext.escapeRe
- * @param {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false
- * @param {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.
- * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
- */
- createValueMatcher : function(value, anyMatch, caseSensitive, exactMatch) {
- if (!value.exec) { // not a regex
- var er = Ext.escapeRe;
- value = String(value);
+ /**
+ * 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;
- if (anyMatch === true) {
- value = er(value);
+ 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 {
- value = '^' + er(value);
- if (exactMatch === true) {
- value += '$';
+ // we cannot insert anything inside a textnode so...
+ if (Ext.isTextNode(el)) {
+ where = where === 'afterbegin' ? 'beforebegin' : where;
+ where = where === 'beforeend' ? 'afterend' : where;
}
- }
- value = new RegExp(value, caseSensitive ? '' : 'i');
- }
- return value;
- },
-
- /**
- * Creates a shallow copy of this collection
- * @return {MixedCollection}
- */
- clone : function(){
- var r = new Ext.util.MixedCollection();
- var k = this.keys, it = this.items;
- for(var i = 0, len = it.length; i < len; i++){
- r.add(k[i], it[i]);
- }
- r.getKey = this.getKey;
- return r;
- }
-});
-/**
- * This method calls {@link #item item()}.
- * Returns the item associated with the passed key OR index. Key has priority
- * over index. This is the equivalent of calling {@link #key} first, then if
- * nothing matched calling {@link #itemAt}.
- * @param {String/Number} key The key or index of the item.
- * @return {Object} If the item is found, returns the item. If the item was
- * not found, returns undefined. If an item was found, but is a Class,
- * returns null.
- */
-Ext.util.MixedCollection.prototype.get = Ext.util.MixedCollection.prototype.item;
-/**
- * @class Ext.util.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.util.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.util.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 {
- var a = ["{"], b, i, v;
- for (i in o) {
- // don't encode DOM objects
- if(!o.getElementsByTagName){
- if(!useHasOwn || o.hasOwnProperty(i)) {
- v = o[i];
- switch (typeof v) {
- case "undefined":
- case "function":
- case "unknown":
- break;
- default:
- if(b){
- a.push(',');
- }
- a.push(doEncode(i), ":",
- v === null ? "null" : doEncode(v));
- b = true;
- }
- }
- }
- }
- a.push("}");
- return a.join("");
- }
- },
- m = {
- "\b": '\\b',
- "\t": '\\t',
- "\n": '\\n',
- "\f": '\\f',
- "\r": '\\r',
- '"' : '\\"',
- "\\": '\\\\'
- },
- encodeString = function(s){
- if (/["\\\x00-\x1f]/.test(s)) {
- return '"' + s.replace(/([\x00-\x1f\\"])/g, function(a, b) {
- var c = m[b];
- if(c){
- return c;
- }
- c = b.charCodeAt();
- return "\\u00" +
- Math.floor(c / 16).toString(16) +
- (c % 16).toString(16);
- }) + '"';
- }
- return '"' + s + '"';
- },
- encodeArray = function(o){
- var a = ["["], b, i, l = o.length, v;
- for (i = 0; i < l; i += 1) {
- v = o[i];
- switch (typeof v) {
- case "undefined":
- case "function":
- case "unknown":
- break;
- default:
- if (b) {
- a.push(',');
- }
- a.push(v === null ? "null" : Ext.util.JSON.encode(v));
- b = true;
+ 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);
}
- }
- a.push("]");
- return a.join("");
- };
-
- /**
- * Encodes a Date. This returns the actual string which is inserted into the JSON string as the literal expression. - * The returned value includes enclosing double quotation marks.
- *The default return format is "yyyy-mm-ddThh:mm:ss".
- *To override this:
-Ext.util.JSON.encodeDate = function(d) {
- return d.format('"Y-m-d"');
-};
-
- * @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()) + '"';
- };
-
- /**
- * 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);
- };
- }();
-
-
- /**
- * 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
- * @return {Object} The resulting object
- */
- this.decode = function() {
- var dc;
- return function(json) {
- if (!dc) {
- // setup decoding function on first access
- dc = isNative() ? JSON.parse : doDecode;
- }
- return dc(json);
- };
- }();
-
-})();
-/**
- * Shorthand for {@link Ext.util.JSON#encode}
- * @param {Mixed} o The variable to encode
- * @return {String} The JSON string
- * @member Ext
- * @method encode
- */
-Ext.encode = Ext.util.JSON.encode;
-/**
- * Shorthand for {@link Ext.util.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.util.JSON.decode;
-/**
- * @class Ext.util.Format
- * Reusable data formatting functions
- * @singleton
- */
-Ext.util.Format = function(){
- var trimRe = /^\s+|\s+$/g,
- stripTagsRE = /<\/?[^>]+>/gi,
- stripScriptsRe = /(?:+DomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.
- /** - * Converts the first character only of a string to upper case - * @param {String} value The text to convert - * @return {String} The converted text - */ - capitalize : function(value){ - return !value ? value : value.charAt(0).toUpperCase() + value.substr(1).toLowerCase(); - }, ++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.
+
- * var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');
- *
- * @return {Function} A function that operates on the passed value.
- */
- math : function(){
- var fns = {};
- return function(v, a){
- if(!fns[a]){
- fns[a] = new Function('v', 'return v ' + a + ';');
- }
- return fns[a](v);
- }
- }(),
+ // retrieve the previous element node
+ function prev(n){
+ while((n = n.previousSibling) && n.nodeType != 1);
+ return n;
+ }
- /**
- * 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;
+ // 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;
}
- return result;
- },
+ n = nextNode;
+ }
+ return this;
+ }
- /**
- * Formats the number according to the format string.
- * 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:
+// 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);
+ *
+ *
+ * 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: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.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:
+ *
+el.removeListener('click', this.handlerFn);
+// or
+el.un('click', this.handlerFn);
+
+ * @param {String} eventName The name of the event from which to remove the handler.
+ * @param {Function} fn The handler function to remove. This must be a reference to the function passed into the {@link #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
+ */
+ 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)) {
+ if (Ext.isDefined(Ext.global.console)) {
+ Ext.global.console.warn("Warning, size detected as NaN on Element.addUnits.");
+ }
+ 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
+ */
+ 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 = '
+// 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 {Mixed} height The new height. This may be one of: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:
+ *
+ // Basic box wrap
+ Ext.get("foo").boxWrap();
+
+ // You can also add a custom class and use CSS inheritance rules to customize the box look.
+ // 'x-box-blue' is a built-in alternative -- look at the related CSS definitions as an example
+ // for how to create a custom box wrap style.
+ Ext.get("foo").boxWrap().addCls("x-box-blue");
+ *
+ * @param {String} class (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", "{width: widthValue, height: heightValue}
.Returns the dimensions of the element available to lay content out in.
+ *
If the element (or any ancestor element) has CSS style display : none
, the dimensions will be zero.
+ var vpSize = Ext.getBody().getViewSize();
+
+ // all Windows created afterwards will have a default value of 90% height and 95% width
+ Ext.Window.override({
+ width: vpSize.width * 0.9,
+ height: vpSize.height * 0.95
+ });
+ // To handle window resizing you would have to hook onto onWindowResize.
+ *
+ *
+ * getViewSize utilizes clientHeight/clientWidth which excludes sizing of scrollbars.
+ * To obtain the size including scrollbars, use getStyleSize
+ *
+ * Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc.
+ */
+
+ 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;
+ },
+
+ /**
+ * 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: + *
+// 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
+ */
+ 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 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 {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
+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
+ */
+
+ 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.switchOff();
+
+// all config options shown with default values
+el.switchOff({
+ easing: 'easeIn',
+ duration: .3,
+ remove: false,
+ useDisplay: false
+});
+
+ * @param {Object} options (optional) Object literal with any of the 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: 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} 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: 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} 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: 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 {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:
+
+el.pause(1);
+
+ * @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:
+
+// 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
+ */
+ 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 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 {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:
+
+// 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 {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:
+
+// 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
+});
+
+ * @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:
+ * + * The sample code below would return an object with 2 properties, one + * for background-color and one for color.
+ *
+var css = 'background-color: red;color: blue; ';
+console.log(Ext.core.Element.parseStyles(css));
+ *
+ * @static
+ * @param {String} styles A CSS string
+ * @return {Object} styles
+ */
+ parseStyles: function(styles){
+ var out = {},
+ cssRe = this.cssRe,
+ matches;
+
+ if (styles) {
+ // Since we're using the g flag on the regex, we need to set the lastIndex.
+ // This automatically happens on some implementations, but not others, see:
+ // http://stackoverflow.com/questions/2645273/javascript-regular-expression-literal-persists-between-function-calls
+ // http://blog.stevenlevithan.com/archives/fixing-javascript-regexp
+ cssRe.lastIndex = 0;
+ while ((matches = cssRe.exec(styles))) {
+ out[matches[1]] = matches[2];
+ }
+ }
+ return out;
+ }
+});
+
+/**
+ * @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.core.Element} and + * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection.
+ * Example:
+var els = Ext.select("#some-el div.some-class");
+// or select directly from an existing element
+var el = Ext.get('some-el');
+el.select('div.some-class');
+
+els.setWidth(100); // all elements become 100 width
+els.hide(true); // all elements fade out and hide
+// or
+els.setWidth(100).hide(true);
+
+ */
+Ext.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
+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);
+ }
+});
+ * @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; iel
: Ext.core.Elementindex
: Numberthis
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 (!fn) {
+ Ext.Error.raise({
+ sourceClass: Ext.getClassName(this.observable),
+ sourceMethod: "addListener",
+ msg: "The specified callback function is undefined"
+ });
+ }
+
+ if (!me.isListening(fn, scope)) {
+ listener = me.createListener(fn, scope, options);
+ if (me.firing) {
+ // if we are currently firing this event, don't disturb the listener loop
+ me.listeners = me.listeners.slice(0);
+ }
+ 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
+ me.listeners.splice(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: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.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 (Ext.isObject(eventName)) { + this.prepareListenerConfig(element, eventName); + return; + } + + var dom = Ext.getDom(element), + bind, + wrap; + + if (!dom){ + Ext.Error.raise({ + sourceClass: 'Ext.EventManager', + sourceMethod: 'addListener', + targetElement: element, + eventName: eventName, + msg: 'Error adding "' + eventName + '\" listener for nonexistent element "' + element + '"' + }); + } + if (!fn) { + Ext.Error.raise({ + sourceClass: 'Ext.EventManager', + sourceMethod: 'addListener', + targetElement: element, + eventName: eventName, + msg: 'Error adding "' + eventName + '\" listener. The handler function is undefined.' + }); + } + + // create the wrapper function + options = options || {}; + + bind = 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 (Ext.isObject(eventName)) {
+ 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
+ cache.splice(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} o The options
+ */
+ createListenerWrap : function(dom, ename, fn, scope, options) {
+ options = !Ext.isObject(options) ? {} : options;
+
+ var f = ['if(!Ext) {return;}'],
+ gen;
+
+ 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'));
+
+ return function wrap(e, args) {
+ 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) {
+ 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) {
+ 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 = [],
+ 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,
+
+ /**
+ * 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;
+ },
+
+ /**
+ * Normalizes mouse wheel delta across browsers
+ * @return {Number} The delta
+ */
+ getWheelDelta : function(){
+ var event = this.browserEvent,
+ delta = 0;
+
+ if (event.wheelDelta) { /* IE/Opera. */
+ delta = event.wheelDelta / 120;
+ } else if (event.detail){ /* Mozilla case. */
+ delta = -event.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.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:
+ * HTMLEvents
+ *MouseEvents
+ *UIEvents
+ *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';
+ *
+ * @constructor
+ * Creates a new Ext.flash.Component instance.
+ * @param {Object} config The component configuration.
+ *
+ * @xtype flash
+ * @docauthor Jason Johnston dataIndex
property in column definition objects passed to {@link Ext.grid.ColumnModel}.
- * Note: In the simplest case, if no properties other than name
are required, a field
- * definition may consist of just a String for the field name.
{@link Ext.data.Field#convert convert}
- * has not been specified. This may be specified as a string value. Possible values are
- * This may also be specified by referencing a member of the {@link Ext.data.Types} class.
- *Developers may create their own application-specific data types by defining new members of the - * {@link Ext.data.Types} class.
+ * @cfg {String} flashVersion + * Indicates the version the flash content was published for. Defaults to '9.0.115'. */ - /** - * @cfg {Function} convert - * (Optional) A function which converts the value provided by the Reader into an object that will be stored - * in the Record. It is passed the following parameters:{@link Ext.data.Field#defaultValue defaultValue}
.
-// example of convert function
-function fullName(v, record){
- return record.name.last + ', ' + record.name.first;
-}
-
-function location(v, record){
- return !record.city ? '' : (record.city + ', ' + record.state);
-}
-
-var Dude = Ext.data.Record.create([
- {name: 'fullname', convert: fullName},
- {name: 'firstname', mapping: 'name.first'},
- {name: 'lastname', mapping: 'name.last'},
- {name: 'city', defaultValue: 'homeless'},
- 'state',
- {name: 'location', convert: location}
-]);
-
-// create the data store
-var store = new Ext.data.Store({
- reader: new Ext.data.JsonReader(
- {
- idProperty: 'key',
- root: 'daRoot',
- totalProperty: 'total'
- },
- Dude // recordType
- )
-});
+ flashVersion : '9.0.115',
-var myData = [
- { key: 1,
- name: { first: 'Fat', last: 'Albert' }
- // notice no city, state provided in data object
- },
- { key: 2,
- name: { first: 'Barney', last: 'Rubble' },
- city: 'Bedrock', state: 'Stoneridge'
- },
- { key: 3,
- name: { first: 'Cliff', last: 'Claven' },
- city: 'Boston', state: 'MA'
- }
-];
- *
- */
- /**
- * @cfg {String} dateFormat
- * (Optional) Used when converting received data into a Date when the {@link #type} is specified as "date"
.
A format string for the {@link Date#parseDate Date.parseDate} function, or "timestamp" if the - * value provided by the Reader is a UNIX timestamp, or "time" if the value provided by the Reader is a - * javascript millisecond timestamp. See {@link Date}
- */ - dateFormat: null, - /** - * @cfg {Mixed} defaultValue - * (Optional) The default value used when a Record is being created by a {@link Ext.data.Reader Reader} - * when the item referenced by the{@link Ext.data.Field#mapping mapping}
does not exist in the data
- * object (i.e. undefined). (defaults to "")
- */
- defaultValue: "",
/**
- * @cfg {String/Number} mapping
- * (Optional) A path expression for use by the {@link Ext.data.DataReader} implementation - * that is creating the {@link Ext.data.Record Record} to extract the Field value from the data object. - * If the path expression is the same as the field name, the mapping may be omitted.
- *The form of the mapping expression depends on the Reader being used.
- *If a more complex value extraction strategy is required, then configure the Field with a {@link #convert} - * function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to - * return the desired data.
+ * @cfg {String} backgroundColor + * The background color of the SWF movie. Defaults to '#ffffff'. */ - mapping: null, - /** - * @cfg {Function} sortType - * (Optional) A function which converts a Field's value to a comparable value in order to ensure - * correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom - * sort example:
-// current sort after sort we want
-// +-+------+ +-+------+
-// |1|First | |1|First |
-// |2|Last | |3|Second|
-// |3|Second| |2|Last |
-// +-+------+ +-+------+
+ backgroundColor: '#ffffff',
-sortType: function(value) {
- switch (value.toLowerCase()) // native toLowerCase():
- {
- case 'first': return 1;
- case 'second': return 2;
- default: return 3;
- }
-}
- *
- */
- sortType : null,
- /**
- * @cfg {String} sortDir
- * (Optional) Initial direction to sort ("ASC"
or "DESC"
). Defaults to
- * "ASC"
.
- */
- sortDir : "ASC",
- /**
- * @cfg {Boolean} allowBlank
- * (Optional) Used for validating a {@link Ext.data.Record record}, defaults to true
.
- * An empty value here will cause {@link Ext.data.Record}.{@link Ext.data.Record#isValid isValid}
- * to evaluate to false
.
- */
- allowBlank : true
-});
-/**
- * @class Ext.data.DataReader
- * Abstract base class for reading structured data from a data source and converting
- * it into an object containing {@link Ext.data.Record} objects and metadata for use
- * by an {@link Ext.data.Store}. This class is intended to be extended and should not
- * be created directly. For existing implementations, see {@link Ext.data.ArrayReader},
- * {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader}.
- * @constructor Create a new DataReader
- * @param {Object} meta Metadata configuration options (implementation-specific).
- * @param {Array/Object} recordType
- * 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 using {@link Ext.data.Record#create}.
- */ -Ext.data.DataReader = function(meta, recordType){ - /** - * This DataReader's configured metadata as passed to the constructor. - * @type Mixed - * @property meta - */ - this.meta = meta; /** - * @cfg {Array/Object} fields - *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}.
+ * @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. */ - this.recordType = Ext.isArray(recordType) ? - Ext.data.Record.create(recordType) : recordType; - - // if recordType defined make sure extraction functions are defined - if (this.recordType){ - this.buildExtractors(); - } -}; + wmode: 'opaque', -Ext.data.DataReader.prototype = { - /** - * @cfg {String} messageProperty [undefined] Optional name of a property within a server-response that represents a user-feedback message. - */ /** - * Abstract method created in extension's buildExtractors impl. + * @cfg {Object} flashVars + * A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined. */ - getTotal: Ext.emptyFn, + /** - * Abstract method created in extension's buildExtractors impl. + * @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. */ - getRoot: Ext.emptyFn, + /** - * Abstract method created in extension's buildExtractors impl. + * @cfg {Object} flashAttributes + * A set of key value pairs to be passed to the flash object as attributes. Defaults to undefined. */ - getMessage: Ext.emptyFn, + /** - * Abstract method created in extension's buildExtractors impl. + * @cfg {String} url + * The URL of the SWF file to include. Required. */ - getSuccess: Ext.emptyFn, + /** - * Abstract method created in extension's buildExtractors impl. + * @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. */ - getId: Ext.emptyFn, + swfWidth: '100%', + /** - * Abstract method, overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader} + * @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. */ - buildExtractors : Ext.emptyFn, + swfHeight: '100%', + /** - * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader} + * @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. */ - extractValues : Ext.emptyFn, + expressInstall: false, /** - * Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server. - * You must return at least the database pk using the idProperty defined in your DataReader configuration. The incoming - * data from server will be merged with the data in the local record. - * In addition, you must return record-data from the server in the same order received. - * Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed. - * @param {Record/Record[]} record The phantom record to be realized. - * @param {Object/Object[]} data The new record data to apply. Must include the primary-key from database defined in idProperty field. + * @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. */ - realize: function(rs, data){ - if (Ext.isArray(rs)) { - for (var i = rs.length - 1; i >= 0; i--) { - // recurse - if (Ext.isArray(data)) { - this.realize(rs.splice(i,1).shift(), data.splice(i,1).shift()); - } - else { - // weird...rs is an array but data isn't?? recurse but just send in the whole invalid data object. - // the else clause below will detect !this.isData and throw exception. - this.realize(rs.splice(i,1).shift(), data); - } - } - } - else { - // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on. - if (Ext.isArray(data) && data.length == 1) { - data = data.shift(); - } - if (!this.isData(data)) { - // TODO: Let exception-handler choose to commit or not rather than blindly rs.commit() here. - //rs.commit(); - throw new Ext.data.DataReader.Error('realize', rs); - } - rs.phantom = false; // <-- That's what it's all about - rs._phid = rs.id; // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords - rs.id = this.getId(data); - rs.data = data; - rs.commit(); - } - }, + // Have to create a placeholder div with the swfId, which SWFObject will replace with the object/embed element. + renderTpl: [''], - /** - * Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save. - * If returning data from multiple-records after a batch-update, you must return record-data from the server in - * the same order received. Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be - * suppressed as the record receives fresh new data-hash - * @param {Record/Record[]} rs - * @param {Object/Object[]} data - */ - update : function(rs, data) { - if (Ext.isArray(rs)) { - for (var i=rs.length-1; i >= 0; i--) { - if (Ext.isArray(data)) { - this.update(rs.splice(i,1).shift(), data.splice(i,1).shift()); - } - else { - // weird...rs is an array but data isn't?? recurse but just send in the whole data object. - // the else clause below will detect !this.isData and throw exception. - this.update(rs.splice(i,1).shift(), data); - } - } + initComponent: function() { + if (!('swfobject' in window)) { + Ext.Error.raise('The SWFObject library is not loaded. Ext.flash.Component requires SWFObject version 2.2 or later: http://code.google.com/p/swfobject/'); } - else { - // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on. - if (Ext.isArray(data) && data.length == 1) { - data = data.shift(); - } - if (this.isData(data)) { - rs.data = Ext.apply(rs.data, data); - } - rs.commit(); + if (!this.url) { + Ext.Error.raise('The "url" config is required for Ext.flash.Component'); } + + this.callParent(); + this.addEvents( + /** + * @event success + * Fired when the Flash movie has been successfully embedded + * @param {Ext.flash.Component} this + */ + 'success', + + /** + * @event failure + * Fired when the Flash movie embedding fails + * @param {Ext.flash.Component} this + */ + 'failure' + ); }, - /** - * returns extracted, type-cast rows of data. Iterates to call #extractValues for each row - * @param {Object[]/Object} data-root from server response - * @param {Boolean} returnRecords [false] Set true to return instances of Ext.data.Record - * @private - */ - extractData : function(root, returnRecords) { - // A bit ugly this, too bad the Record's raw data couldn't be saved in a common property named "raw" or something. - var rawName = (this instanceof Ext.data.JsonReader) ? 'json' : 'node'; + onRender: function() { + var me = this, + params, vars, undef, + swfId = me.getSwfId(); - var rs = []; + me.renderData.swfId = swfId; - // Had to add Check for XmlReader, #isData returns true if root is an Xml-object. Want to check in order to re-factor - // #extractData into DataReader base, since the implementations are almost identical for JsonReader, XmlReader - if (this.isData(root) && !(this instanceof Ext.data.XmlReader)) { - root = [root]; - } - var f = this.recordType.prototype.fields, - fi = f.items, - fl = f.length, - rs = []; - if (returnRecords === true) { - var Record = this.recordType; - for (var i = 0; i < root.length; i++) { - var n = root[i]; - var record = new Record(this.extractValues(n, fi, fl), this.getId(n)); - record[rawName] = n; // <-- There's implementation of ugly bit, setting the raw record-data. - rs.push(record); - } - } - else { - for (var i = 0; i < root.length; i++) { - var data = this.extractValues(root[i], fi, fl); - data[this.meta.idProperty] = this.getId(root[i]); - rs.push(data); - } - } - return rs; + 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) + ); }, /** - * Returns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key - * corresponding to idProperty defined in your DataReader config containing non-empty pk. - * @param {Object} data - * @return {Boolean} + * @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 */ - isData : function(data) { - return (data && Ext.isObject(data) && !Ext.isEmpty(this.getId(data))) ? true : false; - }, - - // private function a store will createSequence upon - onMetaChange : function(meta){ - delete this.ef; - this.meta = meta; - this.recordType = Ext.data.Record.create(meta.fields); - this.buildExtractors(); - } -}; - -/** - * @class Ext.data.DataReader.Error - * @extends Ext.Error - * General error class for Ext.data.DataReader - */ -Ext.data.DataReader.Error = Ext.extend(Ext.Error, { - constructor : function(message, arg) { - this.arg = arg; - Ext.Error.call(this, message); - }, - name: 'Ext.data.DataReader' -}); -Ext.apply(Ext.data.DataReader.Error.prototype, { - lang : { - 'update': "#update received invalid data from server. Please see docs for DataReader#update and review your DataReader configuration.", - 'realize': "#realize was called with invalid remote-data. Please see the docs for DataReader#realize and review your DataReader configuration.", - 'invalid-response': "#readResponse received an invalid response from the server." - } -}); -/** - * @class Ext.data.DataWriter - *Ext.data.DataWriter facilitates create, update, and destroy actions between - * an Ext.data.Store and a server-side framework. A Writer enabled Store will - * automatically manage the Ajax requests to perform CRUD actions on a Store.
- *Ext.data.DataWriter is an abstract base class which is intended to be extended - * and should not be created directly. For existing implementations, see - * {@link Ext.data.JsonWriter}.
- *Creating a writer is simple:
- *
-var writer = new Ext.data.JsonWriter({
- encode: false // <--- false causes data to be printed to jsonData config-property of Ext.Ajax#reqeust
-});
- *
- * * Same old JsonReader as Ext-2.x:
- *
-var reader = new Ext.data.JsonReader({idProperty: 'id'}, [{name: 'first'}, {name: 'last'}, {name: 'email'}]);
- *
- *
- * The proxy for a writer enabled store can be configured with a simple url
:
-// Create a standard HttpProxy instance.
-var proxy = new Ext.data.HttpProxy({
- url: 'app.php/users' // <--- Supports "provides"-type urls, such as '/users.json', '/products.xml' (Hello Rails/Merb)
-});
- *
- * For finer grained control, the proxy may also be configured with an API
:
-// Maximum flexibility with the API-configuration
-var proxy = new Ext.data.HttpProxy({
- api: {
- read : 'app.php/users/read',
- create : 'app.php/users/create',
- update : 'app.php/users/update',
- destroy : { // <--- Supports object-syntax as well
- url: 'app.php/users/destroy',
- method: "DELETE"
+ 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);
}
- }
-});
- *
- * Pulling it all together into a Writer-enabled Store:
- *
-var store = new Ext.data.Store({
- proxy: proxy,
- reader: reader,
- writer: writer,
- autoLoad: true,
- autoSave: true // -- Cell-level updates.
-});
- *
- * Initiating write-actions automatically, using the existing Ext2.0 Store/Record API:
- *
-var rec = store.getAt(0);
-rec.set('email', 'foo@bar.com'); // <--- Immediately initiates an UPDATE action through configured proxy.
+ },
-store.remove(rec); // <---- Immediately initiates a DESTROY action through configured proxy.
- *
- * For record/batch updates, use the Store-configuration {@link Ext.data.Store#autoSave autoSave:false}
- *
-var store = new Ext.data.Store({
- proxy: proxy,
- reader: reader,
- writer: writer,
- autoLoad: true,
- autoSave: false // -- disable cell-updates
-});
+ /**
+ * Retrieve the id of the SWF object/embed element
+ */
+ getSwfId: function() {
+ return this.swfId || (this.swfId = "extswf" + this.getAutoId());
+ },
-var urec = store.getAt(0);
-urec.set('email', 'foo@bar.com');
+ 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');
+ },
-var drec = store.getAt(1);
-store.remove(drec);
+ onFailure: Ext.emptyFn,
-// Push the button!
-store.save();
- *
- * @constructor Create a new DataWriter
- * @param {Object} meta Metadata configuration options (implementation-specific)
- * @param {Object} recordType Either an Array of field definition objects as specified
- * in {@link Ext.data.Record#create}, or an {@link Ext.data.Record} object created
- * using {@link Ext.data.Record#create}.
+ beforeDestroy: function() {
+ var me = this,
+ swf = me.swf;
+ if (swf) {
+ swfobject.removeSWF(me.getSwfId());
+ Ext.destroy(swf);
+ delete me.swf;
+ }
+ me.callParent();
+ },
+
+ 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.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.
+ * @constructor + * @param {Object} config The configuration for this instance. */ -Ext.data.DataWriter = function(config){ - Ext.apply(this, config); -}; -Ext.data.DataWriter.prototype = { +Ext.define('Ext.form.action.Action', { + alternateClassName: 'Ext.form.Action', /** - * @cfg {Boolean} writeAllFields - * false by default. Set true to have DataWriter return ALL fields of a modified - * record -- not just those that changed. - * false to have DataWriter only request modified fields from a record. + * @cfg {Ext.form.Basic} form The {@link Ext.form.Basic BasicForm} instance that + * is invoking this Action. Required. */ - writeAllFields : false, + /** - * @cfg {Boolean} listful - * false by default. Set true to have the DataWriter always write HTTP params as a list, - * even when acting upon a single record. + * @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}. */ - listful : false, // <-- listful is actually not used internally here in DataWriter. @see Ext.data.Store#execute. /** - * Compiles a Store recordset into a data-format defined by an extension such as {@link Ext.data.JsonWriter} or {@link Ext.data.XmlWriter} in preparation for a {@link Ext.data.Api#actions server-write action}. The first two params are similar similar in nature to {@link Ext#apply}, - * Where the first parameter is the receiver of paramaters and the second, baseParams, the source. - * @param {Object} params The request-params receiver. - * @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 {String} action [{@link Ext.data.Api#actions create|update|destroy}] - * @param {Record/Record[]} rs The recordset to write, the subject(s) of the write action. + * @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. */ - apply : function(params, baseParams, action, rs) { - var data = [], - renderer = action + 'Record'; - // TODO implement @cfg listful here - if (Ext.isArray(rs)) { - Ext.each(rs, function(rec){ - data.push(this[renderer](rec)); - }, this); - } - else if (rs instanceof Ext.data.Record) { - data = this[renderer](rs); - } - this.render(params, baseParams, data); - }, /** - * abstract method meant to be overridden by all DataWriter extensions. It's the extension's job to apply the "data" to the "params". - * The data-object provided to render is populated with data according to the meta-info defined in the user's DataReader config, - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Record[]} rs Store recordset - * @param {Object} params Http params to be sent to server. - * @param {Object} data object populated according to DataReader meta-data. + * @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. */ - render : Ext.emptyFn, /** - * @cfg {Function} updateRecord Abstract method that should be implemented in all subclasses - * (e.g.: {@link Ext.data.JsonWriter#updateRecord JsonWriter.updateRecord} + * @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}.
*/ - updateRecord : Ext.emptyFn, /** - * @cfg {Function} createRecord Abstract method that should be implemented in all subclasses - * (e.g.: {@link Ext.data.JsonWriter#createRecord JsonWriter.createRecord}) + * @cfg {Object} headersExtra headers to be sent in the AJAX request for submit and load actions. See + * {@link Ext.data.Connection#headers}.
*/ - createRecord : Ext.emptyFn, /** - * @cfg {Function} destroyRecord Abstract method that should be implemented in all subclasses - * (e.g.: {@link Ext.data.JsonWriter#destroyRecord JsonWriter.destroyRecord}) + * @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}. */ - destroyRecord : Ext.emptyFn, /** - * Converts a Record to a hash, taking into account the state of the Ext.data.Record along with configuration properties - * related to its rendering, such as {@link #writeAllFields}, {@link Ext.data.Record#phantom phantom}, {@link Ext.data.Record#getChanges getChanges} and - * {@link Ext.data.DataReader#idProperty idProperty} - * @param {Ext.data.Record} rec The Record from which to create a hash. - * @param {Object} config NOT YET IMPLEMENTED. Will implement an exlude/only configuration for fine-control over which fields do/don't get rendered. - * @return {Object} - * @protected - * TODO Implement excludes/only configuration with 2nd param? + * @cfg {Function} success The function to call when a valid success return packet is received. + * The function is passed the following parameters:<tpl for="."><{name}>{value}</{name}</tpl>
- * eg, non-phantom:
-{id: 1, first: 'foo', last: 'bar'} --> [{name: 'id', value: 1}, {name: 'first', value: 'foo'}, {name: 'last', value: 'bar'}]
- * {@link Ext.data.Record#phantom Phantom} records will have had their idProperty omitted in {@link #toHash} if determined to be auto-generated.
- * Non AUTOINCREMENT pks should have been protected.
- * @param {Hash} data Hashed by Ext.data.DataWriter#toHash
- * @return {[Object]} Array of attribute-objects.
- * @protected
+ * @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:Abstract base class for implementations which provide retrieval of unformatted data objects. - * This class is intended to be extended and should not be created directly. For existing implementations, - * see {@link Ext.data.DirectProxy}, {@link Ext.data.HttpProxy}, {@link Ext.data.ScriptTagProxy} and - * {@link Ext.data.MemoryProxy}.
- *DataProxy implementations are usually used in conjunction with an implementation of {@link Ext.data.DataReader} - * (of the appropriate type which knows how to parse the data object) to provide a block of - * {@link Ext.data.Records} to an {@link Ext.data.Store}.
- *The parameter to a DataProxy constructor may be an {@link Ext.data.Connection} or can also be the - * config object to an {@link Ext.data.Connection}.
- *Custom implementations must implement either the doRequest
method (preferred) or the
- * load
method (deprecated). See
- * {@link Ext.data.HttpProxy}.{@link Ext.data.HttpProxy#doRequest doRequest} or
- * {@link Ext.data.HttpProxy}.{@link Ext.data.HttpProxy#load load} for additional details.
Example 1
- *
-proxy: new Ext.data.ScriptTagProxy({
- {@link Ext.data.Connection#url url}: 'http://extjs.com/forum/topics-remote.php'
-}),
- *
- * Example 2
- *
-proxy : new Ext.data.HttpProxy({
- {@link Ext.data.Connection#method method}: 'GET',
- {@link Ext.data.HttpProxy#prettyUrls prettyUrls}: false,
- {@link Ext.data.Connection#url url}: 'local/default.php', // see options parameter for {@link Ext.Ajax#request}
- {@link #api}: {
- // all actions except the following will use above url
- create : 'local/new.php',
- update : 'local/update.php'
- }
-}),
- *
- * And new in Ext version 3, attach centralized event-listeners upon the DataProxy class itself! This is a great place - * to implement a messaging system to centralize your application's user-feedback and error-handling.
- *
-// Listen to all "beforewrite" event fired by all proxies.
-Ext.data.DataProxy.on('beforewrite', function(proxy, action) {
- console.log('beforewrite: ', action);
-});
-
-// Listen to "write" event fired by all proxies
-Ext.data.DataProxy.on('write', function(proxy, action, data, res, rs) {
- console.info('write: ', action);
-});
-// Listen to "exception" event fired by all proxies
-Ext.data.DataProxy.on('exception', function(proxy, type, action) {
- console.error(type + action + ' exception);
-});
- *
- * Note: These three events are all fired with the signature of the corresponding DataProxy instance event {@link #beforewrite beforewrite}, {@link #write write} and {@link #exception exception}.
- */
-Ext.data.DataProxy = function(conn){
- // make sure we have a config object here to support ux proxies.
- // All proxies should now send config into superclass constructor.
- conn = conn || {};
+ /**
+ * @cfg {Object} scope The scope in which to call the configured success and failure
+ * callback functions (the this reference for the callback functions).
+ */
- // This line caused a bug when people use custom Connection object having its own request method.
- // http://extjs.com/forum/showthread.php?t=67194. Have to set DataProxy config
- //Ext.applyIf(this, conn);
+ /**
+ * @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.
+ */
- this.api = conn.api;
- this.url = conn.url;
- this.restful = conn.restful;
- this.listeners = conn.listeners;
+ /**
+ * @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.
+ */
- // deprecated
- this.prettyUrls = conn.prettyUrls;
+ /**
+ * @cfg {Boolean} submitEmptyText If set to true, the emptyText value will be sent with the form
+ * when it is submitted. Defaults to true.
+ */
/**
- * @cfg {Object} api
- * Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".
- * Defaults to:
-api: {
- read : undefined,
- create : undefined,
- update : undefined,
- destroy : undefined
-}
- *
- * The url is built based upon the action being executed [load|create|save|destroy] - * using the commensurate {@link #api} property, or if undefined default to the - * configured {@link Ext.data.Store}.{@link Ext.data.Store#url url}.
For example:
- *
-api: {
- load : '/controller/load',
- create : '/controller/new', // Server MUST return idProperty of new record
- save : '/controller/update',
- destroy : '/controller/destroy_action'
-}
+ * @property type
+ * The type of action this Action instance performs.
+ * Currently only "submit" and "load" are supported.
+ * @type {String}
+ */
-// Alternatively, one can use the object-form to specify each API-action
-api: {
- load: {url: 'read.php', method: 'GET'},
- create: 'create.php',
- destroy: 'destroy.php',
- save: 'update.php'
-}
- *
- * If the specific URL for a given CRUD action is undefined, the CRUD action request - * will be directed to the configured {@link Ext.data.Connection#url url}.
- *Note: To modify the URL for an action dynamically the appropriate API - * property should be modified before the action is requested using the corresponding before - * action event. For example to modify the URL associated with the load action: + /** + * 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: *
-// modify the url for the action
-myStore.on({
- beforeload: {
- fn: function (store, options) {
- // use {@link Ext.data.HttpProxy#setUrl setUrl} to change the URL for *just* this request.
- store.proxy.setUrl('changed1.php');
-
- // set optional second parameter to true to make this URL change
- // permanent, applying this URL for all subsequent requests.
- store.proxy.setUrl('changed1.php', true);
-
- // Altering the proxy API should be done using the public
- // method {@link Ext.data.DataProxy#setApi setApi}.
- store.proxy.setApi('read', 'changed2.php');
-
- // Or set the entire API with a config-object.
- // When using the config-object option, you must redefine the entire
- // API -- not just a specific action of it.
- store.proxy.setApi({
- read : 'changed_read.php',
- create : 'changed_create.php',
- update : 'changed_update.php',
- destroy : 'changed_destroy.php'
+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);
+ }
+ }
});
}
}
-});
+},{
+ text: 'Reset',
+ handler: function(){
+ fp.getForm().reset();
+ }
+}]
*
- *
+ * @property failureType
+ * @type {String}
*/
- this.addEvents(
- /**
- * @event exception
- * Fires if an exception occurs in the Proxy during a remote request. This event is relayed - * through a corresponding {@link Ext.data.Store}.{@link Ext.data.Store#exception exception}, - * so any Store instance may observe this event.
- *In addition to being fired through the DataProxy instance that raised the event, this event is also fired - * through the Ext.data.DataProxy class to allow for centralized processing of exception events from all - * DataProxies by attaching a listener to the Ext.data.Proxy class itself.
- *This event can be fired for one of two reasons:
- *This event fires with two different contexts based upon the 2nd - * parameter type [remote|response]. The first four parameters - * are identical between the two contexts -- only the final two parameters - * differ.
- * @param {DataProxy} this The proxy that sent the request - * @param {String} type - *The value of this parameter will be either 'response' or 'remote'.
- *An invalid response from the server was returned: either 404, - * 500 or the response meta-data does not match that defined in the DataReader - * (e.g.: root, idProperty, successProperty).
- *A valid response was returned from the server having - * successProperty === false. This response might contain an error-message - * sent from the server. For example, the user may have failed - * authentication/authorization or a database validation error occurred.
- *The value of this parameter depends on the value of the type
parameter:
The raw browser response object (e.g.: XMLHttpRequest)
- *The decoded response object sent from the server.
- *The type and value of this parameter depends on the value of the type
parameter:
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.
- *This parameter will only exist if the action was a write action - * (Ext.data.Api.actions.create|update|destroy).
- *This event is deprecated. The signature of the loadexception event - * varies depending on the proxy, use the catch-all {@link #exception} event instead. - * This event will fire in addition to the {@link #exception} event.
- * @param {misc} misc See {@link #exception}. - * @deprecated - */ - 'loadexception', - /** - * @event beforewrite - *Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy
- *In addition to being fired through the DataProxy instance that raised the event, this event is also fired - * through the Ext.data.DataProxy class to allow for centralized processing of beforewrite events from all - * DataProxies by attaching a listener to the Ext.data.Proxy class itself.
- * @param {DataProxy} this The proxy for the request - * @param {String} action [Ext.data.Api.actions.create|update|destroy] - * @param {Record/Record[]} rs The Record(s) to create|update|destroy. - * @param {Object} params The requestparams
object. Edit params
to add parameters to the request.
- */
- 'beforewrite',
- /**
- * @event write
- * Fires before the request-callback is called
- *In addition to being fired through the DataProxy instance that raised the event, this event is also fired - * through the Ext.data.DataProxy class to allow for centralized processing of write events from all - * DataProxies by attaching a listener to the Ext.data.Proxy class itself.
- * @param {DataProxy} this The proxy that sent the request - * @param {String} action [Ext.data.Api.actions.create|upate|destroy] - * @param {Object} data The data object extracted from the server-response - * @param {Object} response The decoded response from server - * @param {Record/Record[]} rs The Record(s) from Store - * @param {Object} options The callback's options property as passed to the {@link #request} function - */ - 'write' - ); - Ext.data.DataProxy.superclass.constructor.call(this); - - // Prepare the proxy api. Ensures all API-actions are defined with the Object-form. - try { - Ext.data.Api.prepare(this); - } catch (e) { - if (e instanceof Ext.data.Api.Error) { - e.toConsole(); - } - } - // relay each proxy's events onto Ext.data.DataProxy class for centralized Proxy-listening - Ext.data.DataProxy.relayEvents(this, ['beforewrite', 'write', 'exception']); -}; - -Ext.extend(Ext.data.DataProxy, Ext.util.Observable, { /** - * @cfg {Boolean} restful - *Defaults to false. Set to true to operate in a RESTful manner.
- * Note: this parameter will automatically be set to true if the
- * {@link Ext.data.Store} it is plugged into is set to restful: true
. If the
- * Store is RESTful, there is no need to set this option on the proxy.
RESTful implementations enable the serverside framework to automatically route - * actions sent to one url based upon the HTTP method, for example: - *
-store: new Ext.data.Store({
- restful: true,
- proxy: new Ext.data.HttpProxy({url:'/users'}); // all requests sent to /users
- ...
-)}
- *
- * If there is no {@link #api}
specified in the configuration of the proxy,
- * all requests will be marshalled to a single RESTful url (/users) so the serverside
- * framework can inspect the HTTP Method and act accordingly:
- * -Method url action -POST /users create -GET /users read -PUT /users/23 update -DESTROY /users/23 delete - *- *
If set to true, a {@link Ext.data.Record#phantom non-phantom} record's - * {@link Ext.data.Record#id id} will be appended to the url. Some MVC (e.g., Ruby on Rails, - * Merb and Django) support segment based urls where the segments in the URL follow the - * Model-View-Controller approach:
- * someSite.com/controller/action/id
- *
- * Where the segments in the url are typically:Refer to {@link Ext.data.DataProxy#api}
for additional information.
Redefines the Proxy's API or a single action of an API. Can be called with two method signatures.
- *If called with an object as the only parameter, the object should redefine the entire API, e.g.:
-proxy.setApi({
- read : '/users/read',
- create : '/users/create',
- update : '/users/update',
- destroy : '/users/destroy'
-});
-
- * If called with two parameters, the first parameter should be a string specifying the API action to - * redefine and the second parameter should be the URL (or function if using DirectProxy) to call for that action, e.g.:
-proxy.setApi(Ext.data.Api.actions.read, '/users/new_load_url');
-
- * @param {String/Object} api An API specification object, or the name of an action.
- * @param {String/Function} url The URL (or function if using DirectProxy) to call for the action.
+ * The decoded response object containing a boolean success property and
+ * other, action-specific properties.
+ * @property result
+ * @type {Object}
*/
- setApi : function() {
- if (arguments.length == 1) {
- var valid = Ext.data.Api.isValid(arguments[0]);
- if (valid === true) {
- this.api = arguments[0];
- }
- else {
- throw new Ext.data.Api.Error('invalid', valid);
- }
+
+
+
+ constructor: function(config) {
+ if (config) {
+ Ext.apply(this, config);
}
- else if (arguments.length == 2) {
- if (!Ext.data.Api.isAction(arguments[0])) {
- throw new Ext.data.Api.Error('invalid', arguments[0]);
- }
- this.api[arguments[0]] = arguments[1];
+
+ // Normalize the params option to an Object
+ var params = config.params;
+ if (Ext.isString(params)) {
+ this.params = Ext.Object.fromQueryString(params);
}
- Ext.data.Api.prepare(this);
},
/**
- * Returns true if the specified action is defined as a unique action in the api-config.
- * request. If all API-actions are routed to unique urls, the xaction parameter is unecessary. However, if no api is defined
- * and all Proxy actions are routed to DataProxy#url, the server-side will require the xaction parameter to perform a switch to
- * the corresponding code for CRUD action.
- * @param {String [Ext.data.Api.CREATE|READ|UPDATE|DESTROY]} action
- * @return {Boolean}
+ * Invokes this action using the current configuration.
*/
- isApiAction : function(action) {
- return (this.api[action]) ? true : false;
- },
+ run: Ext.emptyFn,
/**
- * All proxy actions are executed through this method. Automatically fires the "before" + action event
- * @param {String} action Name of the action
- * @param {Ext.data.Record/Ext.data.Record[]/null} rs Will be null when action is 'load'
- * @param {Object} params
- * @param {Ext.data.DataReader} reader
- * @param {Function} callback
- * @param {Object} scope The scope (this
reference) in which the callback function is executed. Defaults to the Proxy object.
- * @param {Object} options Any options specified for the action (e.g. see {@link Ext.data.Store#load}.
+ * @private
+ * @method onSuccess
+ * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses.
+ * @param {Object} response
*/
- request : function(action, rs, params, reader, callback, scope, options) {
- if (!this.api[action] && !this.load) {
- throw new Ext.data.DataProxy.Error('action-undefined', action);
- }
- params = params || {};
- if ((action === Ext.data.Api.actions.read) ? this.fireEvent("beforeload", this, params) : this.fireEvent("beforewrite", this, action, rs, params) !== false) {
- this.doRequest.apply(this, arguments);
- }
- else {
- callback.call(scope || this, null, options, false);
- }
- },
-
/**
- * Deprecated load method using old method signature. See {@doRequest} for preferred method.
- * @deprecated
- * @param {Object} params
- * @param {Object} reader
- * @param {Object} callback
- * @param {Object} scope
- * @param {Object} arg
+ * @private
+ * @method handleResponse
+ * Handles the raw response and builds a result object from it. Must be implemented by subclasses.
+ * @param {Object} response
*/
- load : null,
/**
- * @cfg {Function} doRequest Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers.
- * (e.g.: {@link Ext.data.HttpProxy#doRequest HttpProxy.doRequest},
- * {@link Ext.data.DirectProxy#doRequest DirectProxy.doRequest}).
+ * @private
+ * Handles a failure response.
+ * @param {Object} response
*/
- doRequest : function(action, rs, params, reader, callback, scope, options) {
- // default implementation of doRequest for backwards compatibility with 2.0 proxies.
- // If we're executing here, the action is probably "load".
- // Call with the pre-3.0 method signature.
- this.load(params, reader, callback, scope, options);
+ onFailure : function(response){
+ this.response = response;
+ this.failureType = Ext.form.action.Action.CONNECT_FAILURE;
+ this.form.afterAction(this, false);
},
/**
- * @cfg {Function} onRead Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. Callback for read {@link Ext.data.Api#actions 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
- */
- onRead : Ext.emptyFn,
- /**
- * @cfg {Function} onWrite Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. Callback for create, update and destroy {@link Ext.data.Api#actions 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
- */
- onWrite : Ext.emptyFn,
- /**
- * buildUrl
- * Sets the appropriate url based upon the action being executed. If restful is true, and only a single record is being acted upon,
- * url will be built Rails-style, as in "/controller/action/32". restful will aply iff the supplied record is an
- * instance of Ext.data.Record rather than an Array of them.
- * @param {String} action The api action being executed [read|create|update|destroy]
- * @param {Ext.data.Record/Ext.data.Record[]} record The record or Array of Records being acted upon.
- * @return {String} url
* @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.
*/
- buildUrl : function(action, record) {
- record = record || null;
-
- // conn.url gets nullified after each request. If it's NOT null here, that means the user must have intervened with a call
- // to DataProxy#setUrl or DataProxy#setApi and changed it before the request was executed. If that's the case, use conn.url,
- // otherwise, build the url from the api or this.url.
- var url = (this.conn && this.conn.url) ? this.conn.url : (this.api[action]) ? this.api[action].url : this.url;
- if (!url) {
- throw new Ext.data.Api.Error('invalid-url', action);
- }
-
- // look for urls having "provides" suffix used in some MVC frameworks like Rails/Merb and others. The provides suffice informs
- // the server what data-format the client is dealing with and returns data in the same format (eg: application/json, application/xml, etc)
- // e.g.: /users.json, /users.xml, etc.
- // with restful routes, we need urls like:
- // PUT /users/1.json
- // DELETE /users/1.json
- var provides = null;
- var m = url.match(/(.*)(\.json|\.xml|\.html)$/);
- if (m) {
- provides = m[2]; // eg ".json"
- url = m[1]; // eg: "/users"
- }
- // prettyUrls is deprectated in favor of restful-config
- if ((this.restful === true || this.prettyUrls === true) && record instanceof Ext.data.Record && !record.phantom) {
- url += '/' + record.id;
+ processResponse : function(response){
+ this.response = response;
+ if (!response.responseText && !response.responseXML) {
+ return true;
}
- return (provides === null) ? url : url + provides;
+ return (this.result = this.handleResponse(response));
},
/**
- * Destroys the proxy by purging any event listeners and cancelling any active requests.
+ * @private
+ * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions.
+ * @return {String} The URL.
*/
- destroy: function(){
- this.purgeListeners();
- }
-});
-
-// Apply the Observable prototype to the DataProxy class so that proxy instances can relay their
-// events to the class. Allows for centralized listening of all proxy instances upon the DataProxy class.
-Ext.apply(Ext.data.DataProxy, Ext.util.Observable.prototype);
-Ext.util.Observable.call(Ext.data.DataProxy);
-
-/**
- * @class Ext.data.DataProxy.Error
- * @extends Ext.Error
- * DataProxy Error extension.
- * constructor
- * @param {String} message Message describing the error.
- * @param {Record/Record[]} arg
- */
-Ext.data.DataProxy.Error = Ext.extend(Ext.Error, {
- constructor : function(message, arg) {
- this.arg = arg;
- Ext.Error.call(this, message);
+ getUrl: function() {
+ return this.url || this.form.url;
},
- name: 'Ext.data.DataProxy'
-});
-Ext.apply(Ext.data.DataProxy.Error.prototype, {
- lang: {
- 'action-undefined': "DataProxy attempted to execute an API-action but found an undefined url / function. Please review your Proxy url/api-configuration.",
- 'api-invalid': 'Recieved an invalid API-configuration. Please ensure your proxy API-configuration contains only the actions from Ext.data.Api.actions.'
- }
-});
-
-/**
- * @class Ext.data.Request
- * A simple Request class used internally to the data package to provide more generalized remote-requests
- * to a DataProxy.
- * TODO Not yet implemented. Implement in Ext.data.Store#execute
- */
-Ext.data.Request = function(params) {
- Ext.apply(this, params);
-};
-Ext.data.Request.prototype = {
- /**
- * @cfg {String} action
- */
- action : undefined,
- /**
- * @cfg {Ext.data.Record[]/Ext.data.Record} rs The Store recordset associated with the request.
- */
- rs : undefined,
- /**
- * @cfg {Object} params HTTP request params
- */
- params: undefined,
- /**
- * @cfg {Function} callback The function to call when request is complete
- */
- callback : Ext.emptyFn,
- /**
- * @cfg {Object} scope The scope of the callback funtion
- */
- scope : undefined,
- /**
- * @cfg {Ext.data.DataReader} reader The DataReader instance which will parse the received response
- */
- reader : undefined
-};
-/**
- * @class Ext.data.Response
- * A generic response class to normalize response-handling internally to the framework.
- */
-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,
- /**
- * @cfg {String} message
- */
- message : undefined,
/**
- * @cfg {Array/Object} data
+ * @private
+ * Determine the HTTP method to be used for the request.
+ * @return {String} The HTTP method
*/
- data: undefined,
+ getMethod: function() {
+ return (this.method || this.form.method || 'POST').toUpperCase();
+ },
+
/**
- * @cfg {Object} raw The raw response returned from server-code
+ * @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
*/
- raw: undefined,
+ getParams: function() {
+ return Ext.apply({}, this.params, this.form.baseParams);
+ },
+
/**
- * @cfg {Ext.data.Record/Ext.data.Record[]} records related to the Request action
+ * @private
+ * Creates a callback object.
*/
- 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'];
+ 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
+ };
+ },
-// Create the output object.
-$output = array('a' => 'Apple', 'b' => 'Banana');
+ 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',
-//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);
-}
+ /**
+ * @property SERVER_INVALID
+ * 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.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:
+ *
+ * success
property : Boolean
+ * The success
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:
+{
+ 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'
+ ]
+ )
- * Below is the ASP.Net code to do the same thing:
-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);
+ * 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>
- *
- * @constructor
- * @param {Object} config A configuration object.
+ * 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.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:
- * - 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.
- * 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.
- */
-};
+Ext.define('Ext.form.action.Submit', {
+ extend:'Ext.form.action.Action',
+ alternateClassName: 'Ext.form.Action.Submit',
+ alias: 'formaction.submit',
-Ext.data.ScriptTagProxy.TRANS_ID = 1000;
+ type: 'submit',
-Ext.extend(Ext.data.ScriptTagProxy, Ext.data.DataProxy, {
/**
- * @cfg {String} url The URL from which to request the data object.
+ * @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.
*/
+
+ // 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);
+ }
+ },
+
/**
- * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.
- */
- timeout : 30000,
+ * @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
+ });
+
+ // 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();
+ }
+
+ Ext.Ajax.request(ajaxOptions);
+
+ if (formEl) {
+ Ext.removeNode(formEl);
+ }
+ },
+
/**
- * @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 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.
+ * @private
+ * Build the full set of parameters from the field values plus any additional configured params.
*/
- callbackParam : "callback",
+ getParams: function() {
+ var nope = false,
+ configParams = this.callParent(),
+ fieldParams = this.form.getValues(nope, nope, this.submitEmptyText !== nope);
+ return Ext.apply({}, fieldParams, configParams);
+ },
+
/**
- * @cfg {Boolean} nocache (optional) Defaults to true. Disable caching by adding a unique parameter
- * name to the request.
- */
- 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
- * - The Record block object
- * - The "arg" argument from the load function
- * - A boolean success indicator
- *
- * @param {Object} scope The scope (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.
- */
- doRequest : function(action, rs, params, reader, callback, scope, arg) {
- var p = Ext.urlEncode(Ext.apply(params, this.extraParams));
+ * @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);
+ }
+ });
- var url = this.buildUrl(action, rs);
- if (!url) {
- throw new Ext.data.Api.Error('invalid-url', url);
+ function addField(name, val) {
+ fieldsSpec.push({
+ tag: 'input',
+ type: 'hidden',
+ name: name,
+ value: val
+ });
}
- url = Ext.urlAppend(url, p);
- 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
+ // 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);
+ }
+ });
+
+ formSpec = {
+ tag: 'form',
+ action: this.getUrl(),
+ method: this.getMethod(),
+ target: this.target || '_self',
+ style: 'display:none',
+ cn: fieldsSpec
};
- window[trans.cb] = this.createCallback(action, rs, trans);
- url += String.format("&{0}={1}", this.callbackParam, trans.cb);
- if(this.autoAbort !== false){
- this.abort();
+
+ // Set the proper encoding for file uploads
+ if (uploadFields.length) {
+ formSpec.encoding = formSpec.enctype = 'multipart/form-data';
}
- trans.timeoutId = this.handleFailure.defer(this.timeout, this, [trans]);
+ // Create the form
+ formEl = Ext.core.DomHelper.append(Ext.getBody(), formSpec);
- var script = document.createElement("script");
- script.setAttribute("src", url);
- script.setAttribute("type", "text/javascript");
- script.setAttribute("id", trans.scriptId);
- this.head.appendChild(script);
+ // 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());
+ }
+ });
- this.trans = trans;
+ return formEl;
},
- // @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);
+
+
+ /**
+ * @private
+ */
+ 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);
},
+
/**
- * 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
+ * @private
*/
- 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);
-
- this.fireEvent('exception', this, 'response', action, trans, res, e);
- trans.callback.call(trans.scope||window, null, trans.arg, false);
- return;
+ 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;
+ }
+ }
+ if (errors.length < 1) {
+ errors = null;
+ }
+ return {
+ success : rs.success,
+ errors : errors
+ };
}
- if (result.success === false) {
- // @deprecated: fire old loadexception for backwards-compat.
- this.fireEvent('loadexception', this, trans, res);
+ return Ext.decode(response.responseText);
+ }
+});
+
+/**
+ * @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.
+ * @constructor Create a new ComponentTracker
+ * @param {object} comp The Component to provide dragging for.
+ * @param {object} config The config object
+ */
+Ext.define('Ext.util.ComponentDragger', {
- 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);
- },
/**
- * 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
+ * @cfg {Boolean} constrain
+ * Specify as true
to constrain the Component to within the bounds of the {@link #constrainTo} region.
*/
- 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;
- }
- 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;
- },
+ /**
+ * @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.
+ */
/**
- * Abort the current server request.
+ * @cfg {Boolean} constrainDelegate
+ * Specify as true
to constrain the drag handles within the {@link constrainTo} region.
*/
- abort : function(){
- if(this.isLoading()){
- this.destroyTrans(this.trans);
- }
+
+ extend: 'Ext.dd.DragTracker',
+
+ autoStart: 500,
+
+ constructor: function(comp, config) {
+ this.comp = comp;
+ this.initialConstrainTo = config.constrainTo;
+ this.callParent([ config ]);
},
- // 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){}
- };
+ onStart: function(e) {
+ var me = this,
+ comp = me.comp;
+
+ // Cache the start [X, Y] array
+ this.startPosition = comp.getPosition();
+
+ // 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;
+ }
+
+ // Set the constrainTo Region before we start dragging.
+ if (me.constrain || me.constrainDelegate) {
+ me.constrainTo = me.calculateConstrainRegion();
}
},
- // 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);
+ 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;
+ },
- this.fireEvent('exception', this, 'response', trans.action, {
- response: null,
- options: trans.arg
- });
- trans.callback.call(trans.scope||window, null, trans.arg, false);
+ // 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.apply(comp, [me.startPosition[0] + offset[0], me.startPosition[1] + offset[1]]);
},
- // inherit docs
- destroy: function(){
- this.abort();
- Ext.data.ScriptTagProxy.superclass.destroy.call(this);
+ onEnd: function(e) {
+ if (this.proxy && !this.comp.liveDrag) {
+ this.comp.unghost();
+ }
}
-});/**
- * @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.
- */
-Ext.data.HttpProxy = function(conn){
- Ext.data.HttpProxy.superclass.constructor.call(this, conn);
+});
+/**
+ * @class Ext.form.Labelable
- /**
- * 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
- */
- this.conn = conn;
+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.
- // 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;
+**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}.
- this.useAjax = !conn || !conn.events;
+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.)
- // 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;
- }
-};
+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.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
+ }
+ ],
-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 {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.
*/
- getConnection : function() {
- return this.useAjax ? Ext.Ajax : this.conn;
- },
+ activeErrorsTpl: [
+ '',
+ '- class="last"
>{.}
',
+ ''
+ ],
/**
- * 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).
+ * @property isFieldLabelable
+ * @type Boolean
+ * Flag denoting that this object is labelable as a field. Always true.
*/
- setUrl : function(url, makePermanent) {
- this.conn.url = url;
- if (makePermanent === true) {
- this.url = url;
- this.api = null;
- Ext.data.Api.prepare(this);
- }
- },
+ isFieldLabelable: true,
/**
- * 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
- * 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
- * @param {Object} scope The scope (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 {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'.
*/
- 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
- };
+ formItemCls: Ext.baseCSSPrefix + 'form-item',
- // 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);
-
- if(this.useAjax){
-
- Ext.applyIf(o, this.conn);
+ /**
+ * @cfg {String} labelCls
+ * The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.
+ */
+ labelCls: Ext.baseCSSPrefix + 'form-item-label',
- // 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} errorMsgCls
+ * The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.
+ */
+ errorMsgCls: Ext.baseCSSPrefix + 'form-error-msg',
/**
- * 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} baseBodyCls
+ * The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.
*/
- 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);
- }
- };
- },
+ baseBodyCls: Ext.baseCSSPrefix + 'form-item-body',
/**
- * 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 {String} fieldBodyCls
+ * An extra CSS class to be applied to the body content element in addition to {@link #fieldBodyCls}.
+ * Defaults to empty.
*/
- 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);
+ fieldBodyCls: '',
- // 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
+ * @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').
*/
- 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);
- },
+ clearCls: Ext.baseCSSPrefix + 'clear',
- // 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]]);
- }
- }
- }
- 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;
-};
+ /**
+ * @cfg {String} invalidCls
+ * The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')
+ */
+ invalidCls : Ext.baseCSSPrefix + 'form-invalid',
-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
+ * @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,
- /**
- * 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
- * - The Record block object
- * - The "arg" argument from the load function
- * - A boolean success indicator
+ /**
+ * @cfg {String} labelAlign
+ * Controls the position and alignment of the {@link #fieldLabel}. Valid values are:
+ *
+ * - "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.
*
- * @param {Object} scope The scope (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.
*/
- 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;
- }
- 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 : MixedThe data value as read by the Reader, if undefined will use
- * the configured {@link Ext.data.Field#defaultValue defaultValue}.
- * - rec : MixedThe 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
: Function A function to convert the stored data into comparable form, as defined by {@link Ext.data.SortTypes}.
- * type
: String A 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
and long
, 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
-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 }
-]);
-
- * @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'
- },
+ labelAlign : 'left',
- /**
- * @type Object.
- * @property INT
- * This data type means that the raw data is converted into an integer before it is placed into a Record.
- * The synonym INTEGER
is equivalent.
- */
- 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.
- * The synonym NUMBER
is equivalent.
- */
- 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
- * 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
is equivalent.
- */
- 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
- * 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
is equivalent.
- */
- 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.
- * The synonym INT
is equivalent.
- */
- 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.
- * The synonym FLOAT
is equivalent.
- */
- 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 JSON encode} the
- * {@link Ext.data.DataWriter#toHash hashed data} into a standard HTTP parameter named after this
- * Reader's meta.root
property which, by default is imported from the associated Reader. Defaults to true.
- * If set to false
, the hashed data is {@link Ext.util.JSON#encode JSON encoded}, along with
- * the associated {@link Ext.data.Store}'s {@link Ext.data.Store#baseParams baseParams}, into the POST body.
- * 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.
- */
- 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:
-{id: 1}
- *
Defaults to false
- */
- encodeDelete: false,
-
- constructor : function(config){
- Ext.data.JsonWriter.superclass.constructor.call(this, config);
- },
+ /**
+ * @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,
/**
- * This method should not need to be called by application code, however it may be useful on occasion to
- * override it, or augment it with an {@link Function#createInterceptor interceptor} or {@link Function#createSequence sequence}.
- * The provided implementation encodes the serialized data representing the Store's modified Records into the Ajax request's
- * params
according to the {@link #encode}
setting.
- * @param {Object} Ajax request params object to write into.
- * @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 serialized modified records from the Store. May be either a single object,
- * or an Array of objects - user implementations must handle both cases.
+ * @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) {
- 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;
- }
- },
+ labelPad : 5,
+
/**
- * Implements abstract Ext.data.DataWriter#createRecord
- * @protected
- * @param {Ext.data.Record} rec
- * @return {Object}
+ * @cfg {String} labelSeparator
+ * Character(s) to be inserted at the end of the {@link #fieldLabel label text}.
*/
- createRecord : function(rec) {
- return this.toHash(rec);
- },
+ labelSeparator : ':',
+
/**
- * Implements abstract Ext.data.DataWriter#updateRecord
- * @protected
- * @param {Ext.data.Record} rec
- * @return {Object}
+ * @cfg {String} labelStyle
+ * A CSS style specification string to apply directly to this field's label. Defaults to undefined.
*/
- updateRecord : function(rec) {
- return this.toHash(rec);
- },
/**
- * Implements abstract Ext.data.DataWriter#destroyRecord
- * @protected
- * @param {Ext.data.Record} rec
- * @return {Object}
+ * @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){
- if(this.encodeDelete){
- var data = {};
- data[this.meta.idProperty] = rec.id;
- return data;
- }else{
- return rec.id;
- }
- }
-});/**
- * @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:
-{
- 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' },
- ...
- ]
-}
-
- * 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();
-
- * 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:
- *
- * - 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
- *
- *
- * @constructor
- * Create a new JsonReader
- * @param {Object} meta Metadata configuration options.
- * @param {Array/Object} recordType
- * 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}.
- */
-Ext.data.JsonReader = function(meta, recordType){
- meta = meta || {};
+ hideLabel: false,
+
/**
- * @cfg {String} idProperty [id] Name of the property within a row object
- * that contains a record identifier value. Defaults to id
+ * @cfg {Boolean} hideEmptyLabel
+ * 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 {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 {Boolean} preventMark
+ * true to disable displaying any {@link #setActiveError error message} set on this object.
+ * Defaults to false.
*/
+ preventMark: false,
+
/**
- * @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 {Boolean} autoFitErrors
+ * Whether to adjust the component's body area to make room for 'side' or 'under'
+ * {@link #msgTarget error messages}. Defaults to true.
*/
+ autoFitErrors: true,
+
/**
- * @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.
+ * @cfg {String} msgTarget The location where the error message text should display.
+ * Must be one of the following values:
+ *
+ * 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.
+ *
*/
- Ext.applyIf(meta, {
- idProperty: 'id',
- successProperty: 'success',
- totalProperty: 'total'
- });
+ msgTarget: 'qtip',
- 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
+ * @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.
*/
+
+
/**
- * 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.
+ * Performs initialization of this mixin. Component classes using this mixin should call this method
+ * during their own initialization.
*/
- read : function(response){
- var json = response.responseText;
- var o = Ext.decode(json);
- if(!o) {
- throw {message: 'JsonReader.read: Json object not found'};
- }
- return this.readRecords(o);
+ 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'
+ );
},
- /*
- * 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.
+ * 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
*/
- readResponse : function(action, response) {
- var o = (response.responseText !== undefined) ? Ext.decode(response.responseText) : response;
- if(!o) {
- throw new Ext.data.JsonReader.Error('response');
- }
+ getFieldLabel: function() {
+ return this.fieldLabel || '';
+ },
- 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);
+ /**
+ * @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;';
}
}
- // 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
- });
-
- // blow up if no successProperty
- if (Ext.isEmpty(res.success)) {
- throw new Ext.data.JsonReader.Error('successProperty-response', this.meta.successProperty);
- }
- return res;
+ 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
+ );
},
/**
- * 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.
+ * @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.
*/
- 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;
+ getLabelableSelectors: function() {
+ return {
+ /**
+ * @property labelEl
+ * @type Ext.core.Element
+ * The label Element for this component. Only available after the component has been rendered.
+ */
+ labelEl: 'label.' + this.labelCls,
- 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;
- }
- }
- if(s.successProperty){
- v = this.getSuccess(o);
- if(v === false || v === 'false'){
- success = false;
- }
- }
+ /**
+ * @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,
- // 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
+ /**
+ * @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
};
},
- // private
- buildExtractors : function() {
- if(this.ef){
- return;
- }
- 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;
+ /**
+ * @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
+ */
+ getSubTplMarkup: function() {
+ return '';
},
/**
- * @ignore
- * TODO This isn't used anywhere?? Don't we want to use this where possible instead of complex #createAccessor?
+ * 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
*/
- simpleAccess : function(obj, subsc) {
- return obj[subsc];
+ getInputId: function() {
+ return '';
},
/**
- * @ignore
+ * 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.
*/
- createAccessor : function(){
- var re = /[\[\.]/;
- return function(expr) {
- if(Ext.isEmpty(expr)){
- return Ext.emptyFn;
- }
- if(Ext.isFunction(expr)){
- return expr;
- }
- var i = String(expr).search(re);
- if(i >= 0){
- return new Function('obj', 'return obj' + (i > 0 ? '.' : '') + expr);
- }
- return function(obj){
- return obj[expr];
- };
-
- };
- }(),
+ getActiveError : function() {
+ return this.activeError || '';
+ },
/**
- * type-casts a single row of raw-data from server
- * @param {Object} data
- * @param {Array} items
- * @param {Integer} len
- * @private
+ * 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}
*/
- 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;
- }
-});
+ hasActiveError: function() {
+ return !!this.getActiveError();
+ },
-/**
- * @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:
- *
-[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]
- *
- * @constructor
- * Create a new ArrayReader
- * @param {Object} meta Metadata configuration options.
- * @param {Array/Object} recordType
- * 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}.
- */
-Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, {
/**
- * @cfg {String} successProperty
- * @hide
+ * 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}.
+ * @param {String} msg The error message
*/
+ setActiveError: function(msg) {
+ this.activeError = msg;
+ this.activeErrors = [msg];
+ this.renderActiveError();
+ },
+
/**
- * @cfg {Number} id (optional) The subscript within row Array that provides an ID for the Record.
- * Deprecated. Use {@link #idIndex} instead.
+ * 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 || [];
+ },
+
/**
- * @cfg {Number} idIndex (optional) The subscript within row Array that provides an ID for the Record.
+ * 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.
+ * @param {Array} errors The error messages
*/
+ setActiveErrors: function(errors) {
+ this.activeErrors = errors;
+ this.activeError = this.getTpl('activeErrorsTpl').apply({errors: errors});
+ this.renderActiveError();
+ },
+
/**
- * 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.
+ * Clears the active error.
*/
- 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;
+ unsetActiveError: function() {
+ delete this.activeError;
+ delete this.activeErrors;
+ this.renderActiveError();
+ },
- var root = this.getRoot(o);
+ /**
+ * @private
+ * 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.
+ */
+ renderActiveError: function() {
+ var me = this,
+ activeError = me.getActiveError(),
+ hasError = !!activeError;
- 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 (activeError !== me.lastActiveError) {
+ me.fireEvent('errorchange', me, activeError);
+ me.lastActiveError = activeError;
}
- var totalRecords = records.length;
+ if (me.rendered && !me.isDestroyed && !me.preventMark) {
+ // Add/remove invalid class
+ me.el[hasError ? 'addCls' : 'removeCls'](me.invalidCls);
- if(s.totalProperty) {
- v = parseInt(this.getTotal(o), 10);
- if(!isNaN(v)) {
- totalRecords = v;
- }
- }
- if(s.successProperty){
- v = this.getSuccess(o);
- if(v === false || v === 'false'){
- success = false;
- }
+ // 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;
}
+ },
- 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:
-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']
-];
- *
- * An object literal of this form could also be used as the {@link #data} config option.
- * *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
+ * 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.
*/
- constructor: function(config){
- Ext.data.ArrayStore.superclass.constructor.call(this, Ext.apply(config, {
- reader: new Ext.data.ArrayReader(config)
- }));
- },
-
- 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]];
+ setFieldDefaults: function(defaults) {
+ var me = this;
+ Ext.iterate(defaults, function(key, val) {
+ if (!me.hasOwnProperty(key)) {
+ me[key] = val;
}
- data = r;
- }
- Ext.data.ArrayStore.superclass.loadData.call(this, data, append);
- }
-});
-Ext.reg('arraystore', Ext.data.ArrayStore);
-
-// 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:
-{
- 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)}
- ]
-}
- *
- * An object literal of this form could also be used as the {@link #data} config option.
- * *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
- */
-Ext.data.JsonStore = Ext.extend(Ext.data.Store, {
+ });
+ },
+
/**
- * @cfg {Ext.data.DataReader} reader @hide
+ * @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.
*/
- constructor: function(config){
- Ext.data.JsonStore.superclass.constructor.call(this, Ext.apply(config, {
- reader: new Ext.data.JsonReader(config)
- }));
+ getBodyNaturalWidth: function() {
+ return this.bodyEl.getWidth();
}
+
});
-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.
+
+/**
+ * @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.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, {
+Ext.define('Ext.form.field.Field', {
+
/**
- * @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 isFormField
+ * @type {Boolean}
+ * Flag denoting that this component is a Field. Always true.
*/
- documentRoot: 'xrequest',
+ isFormField : 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 {Mixed} value A value to initialize this field with (defaults to undefined).
*/
- forceDocumentRoot: false,
+
/**
- * @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:
-
-<?xml version="1.0" encoding="UTF-8"?>
-<user><first>Barney</first></user>
-
- * 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"?>
- <records>
- <first>Barney</first></user>
- <records><first>Barney</first></user>
- </records>
-
- * Defaults to records. Do not confuse the nature of this property with that of {@link #documentRoot}
+ * @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.
*/
- root: 'records',
+
/**
- * @cfg {String} xmlVersion [1.0] The version written to header of xml documents.
-<?xml version="1.0" encoding="ISO-8859-15"?>
+ * @cfg {Boolean} disabled True to disable the field (defaults to false). Disabled Fields will not be
+ * {@link Ext.form.Basic#submit submitted}.
*/
- xmlVersion : '1.0',
+ disabled : false,
+
/**
- * @cfg {String} xmlEncoding [ISO-8859-15] The encoding written to header of xml documents.
-<?xml version="1.0" encoding="ISO-8859-15"?>
+ * @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.
*/
- xmlEncoding: 'ISO-8859-15',
+ submitValue: true,
+
/**
- * @cfg {String/Ext.XTemplate} tpl The XML template used to render {@link Ext.data.Api#actions write-actions} to your server.
- * 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
- *
- * - {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}.
- *
+ * @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.
*/
- // Encoding the ? here in case it's being included by some kind of page that will parse it (eg. PHP)
- tpl: '<\u003fxml version="{version}" encoding="{encoding}"\u003f><{documentRoot}><{name}>{value}{name}> <{root}> <{parent.record}><{name}>{value}{name}> {parent.record}> {root}> {documentRoot}> ',
+ validateOnChange: true,
+ /**
+ * @private
+ */
+ suspendCheckChange: 0,
/**
- * 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.
+ * Initializes this Field mixin on the current instance. Components using this mixin should call
+ * this method during their own initialization process.
*/
- 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]
- });
+ 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();
},
/**
- * 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}.
+ * Initializes the field's value based on the initial config.
*/
- createRecord : function(rec) {
- return this.toArray(this.toHash(rec));
+ 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 is true
.
+ */
+ me.originalValue = me.lastValue = me.value;
+
+ // Set the initial value - prevent validation on initial set
+ me.suspendCheckChange++;
+ me.setValue(me.value);
+ me.suspendCheckChange--;
},
/**
- * 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}.
+ * 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}
*/
- updateRecord : function(rec) {
- return this.toArray(this.toHash(rec));
+ getName: function() {
+ return this.name;
+ },
+ /**
+ * 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
+ */
+ getValue: function() {
+ return this.value;
},
+
/**
- * 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}.
+ * 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
*/
- 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:
- *
-<?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>
-
- * @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 || {};
+ setValue: function(value) {
+ var me = this;
+ me.value = value;
+ me.checkChange();
+ return me;
+ },
- // backwards compat, convert idPath or id / success
- Ext.applyIf(meta, {
- idProperty: meta.idProperty || meta.idPath || meta.id,
- successProperty: meta.successProperty || meta.success
- });
+ /**
+ * 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);
+ },
- 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.
+ * 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.
*/
- read : function(response){
- var doc = response.responseXML;
- if(!doc) {
- throw {message: "XmlReader.read: XML Document not available"};
+ getSubmitData: function() {
+ var me = this,
+ data = null;
+ if (!me.disabled && me.submitValue && !me.isFileUpload()) {
+ data = {};
+ data[me.getName()] = '' + me.getValue();
}
- return this.readRecords(doc);
+ return data;
},
/**
- * 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.
+ * 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.
*/
- readRecords : function(doc){
- /**
- * After any data loads/reads, the raw XML Document is available for further custom processing.
- * @type XMLDocument
- */
- this.xmlData = doc;
+ getModelData: function() {
+ var me = this,
+ data = null;
+ if (!me.disabled && !me.isFileUpload()) {
+ data = {};
+ data[me.getName()] = me.getValue();
+ }
+ return data;
+ },
+
+ /**
+ * 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;
+ },
- var root = doc.documentElement || doc,
- q = Ext.DomQuery,
- totalRecords = 0,
- success = true;
+ /**
+ * 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();
+ },
- if(this.meta.totalProperty){
- totalRecords = this.getTotal(root, 0);
+ /**
+ * Checks whether the value of the field has changed since the last time it was checked. If the value
+ * has changed, it:
+ *
+ * - 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.
+ *
+ */
+ 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);
+ }
}
- if(this.meta.successProperty){
- success = this.getSuccess(root);
+ },
+
+ /**
+ * @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();
+ },
- var records = this.extractData(q.select(this.meta.record, root), true); // <-- true to return Ext.data.Record[]
+ /**
+ * 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.
+ */
+ isDirty : function() {
+ var me = this;
+ return !me.disabled && !me.isEqual(me.getValue(), me.originalValue);
+ },
- // TODO return Ext.data.Response instance. @see #readResponse
- return {
- success : success,
- records : records,
- totalRecords : totalRecords || records.length
- };
+ /**
+ * 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.
+ */
+ checkDirty: function() {
+ var me = this,
+ isDirty = me.isDirty();
+ if (isDirty !== me.wasDirty) {
+ me.fireEvent('dirtychange', me, isDirty);
+ me.onDirtyChange(isDirty);
+ me.wasDirty = isDirty;
+ }
},
/**
- * 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}
+ * @private Called when the field's dirty state changes.
+ * @param {Boolean} isDirty
*/
- readResponse : function(action, response) {
- var q = Ext.DomQuery,
- doc = response.responseXML,
- root = doc.documentElement || doc;
+ onDirtyChange: Ext.emptyFn,
- // create general Response instance.
- var res = new Ext.data.Response({
- action: action,
- success : this.getSuccess(root),
- message: this.getMessage(root),
- data: this.extractData(q.select(this.meta.record, root) || q.select(this.meta.root, root), false),
- raw: doc
- });
+ /**
+ * 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.
+ */
+ getErrors: function(value) {
+ return [];
+ },
- if (Ext.isEmpty(res.success)) {
- throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty);
- }
+ /**
+ * 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());
+ },
- // 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);
- }
+ /**
+ * 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 res;
+ return isValid;
},
- getSuccess : function() {
- return true;
+ /**
+ * 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
+ */
+ batchChanges: function(fn) {
+ this.suspendCheckChange++;
+ fn();
+ this.suspendCheckChange--;
+ this.checkChange();
},
/**
- * build response-data extractor functions.
- * @private
- * @ignore
+ * 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}
*/
- buildExtractors : function() {
- if(this.ef){
- return;
- }
- var s = this.meta,
- Record = this.recordType,
- f = Record.prototype.fields,
- fi = f.items,
- fl = f.length;
+ isFileUpload: function() {
+ return false;
+ },
- 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 = function(res) {
- return (!Ext.isEmpty(res[this.meta.record])) ? res[this.meta.record] : res[this.meta.root];
+ /**
+ * 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;
+ },
+
+ /**
+ * 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 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.
+ * @param {String/Array} errors The error message(s) for the field.
+ */
+ markInvalid: Ext.emptyFn,
+
+ /**
+ * 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 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.
+ */
+ clearInvalid: Ext.emptyFn
+
+});
+
+/**
+ * @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', {
+
+ /* Begin Definitions */
+
+ alias: ['layout.field'],
+
+ extend: 'Ext.layout.component.Component',
+
+ uses: ['Ext.tip.QuickTip', 'Ext.util.TextMetrics'],
+
+ /* End Definitions */
+
+ type: 'field',
+
+ beforeLayout: function(width, height) {
+ var me = this;
+ return me.callParent(arguments) || (!me.owner.preventMark && me.activeError !== me.owner.getActiveError());
+ },
+
+ 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,
+
+ // insets for the bodyEl from each side of the component layout area
+ insets: {
+ top: 0,
+ right: 0,
+ bottom: 0,
+ left: 0
+ }
};
- 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;
- };
+
+ // 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.
+
+ // perform preparation on the label and error (setting css classes, qtips, etc.)
+ labelStrategy.prepare(owner, info);
+ errorStrategy.prepare(owner, info);
+
+ // 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.width, info.height);
} 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));
+ me.setTargetSize(info.width, info.height);
}
- this.ef = ef;
+ me.sizeBody(info);
+
+ me.activeError = owner.getActiveError();
},
+
/**
- * Creates a function to return some particular key of data from a response.
- * @param {String} key
- * @return {Function}
- * @private
- * @ignore
+ * Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.
*/
- 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;
- }
+ 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);
+ },
+
+ /**
+ * 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
+ */
+ sizeBodyContents: Ext.emptyFn,
+
+
+ /**
+ * Return the set of strategy functions from the {@link #labelStrategies labelStrategies collection}
+ * that is appropriate for the field's {@link Ext.form.field.Field#labelAlign labelAlign} config.
+ */
+ getLabelStrategy: function() {
+ var me = this,
+ strategies = me.labelStrategies,
+ labelAlign = me.owner.labelAlign;
+ return strategies[labelAlign] || strategies.base;
+ },
+
+ /**
+ * Return the set of strategy functions from the {@link #errorStrategies errorStrategies collection}
+ * that is appropriate for the field's {@link Ext.form.field.Field#msgTarget msgTarget} config.
+ */
+ 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;
+ },
+
+
+
+ /**
+ * 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.field.Field#labelAlign} config.
+ */
+ 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);
+ }
+ },
+ 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;
+ }
+ }
+ }, base);
+
+
+ return {
+ base: base,
+
+ /**
+ * 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;
+ }
+ }
+ }, base),
+
+ /**
+ * Label displayed to the left of the bodyEl
+ */
+ left: left,
+
+ /**
+ * Same as left, only difference is text-align in CSS
+ */
+ right: left
};
- }(),
+ })(),
+
+
/**
- * 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
+ * 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.field.Field#msgTarget} config.
*/
- 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);
+ errorStrategies: (function() {
+ function setDisplayed(el, displayed) {
+ var wasDisplayed = el.getStyle('display') !== 'none';
+ if (displayed !== wasDisplayed) {
+ el.setDisplayed(displayed);
+ }
+ }
+
+ function setStyle(el, name, value) {
+ if (el.getStyle(name) !== value) {
+ el.setStyle(name, value);
+ }
+ }
+
+ 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;
+ }
}
- return values;
}
-});/**
- * @class Ext.data.XmlStore
- * @extends Ext.data.Store
- * 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'
- ]
+
+});
+
+/**
+ * @class Ext.form.field.VTypes
+ * 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:
+ *
+// 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
});
- *
- * This store is configured to consume a returned object of the form:
-<?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>
*
- * An object literal of this form could also be used as the {@link #data} config option.
- * 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
+ * Another example:
+ *
+// 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
+});
+ *
+ * @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.data.XmlStore = Ext.extend(Ext.data.Store, {
+Ext.define('Ext.layout.component.field.Text', {
+ extend: 'Ext.layout.component.field.Field',
+ alias: 'layout.textfield',
+ requires: ['Ext.util.TextMetrics'],
+
+ type: 'textfield',
+
+
/**
- * @cfg {Ext.data.DataReader} reader @hide
+ * Allow layout to proceed if the {@link Ext.form.field.Text#grow} config is enabled and the value has
+ * changed since the last layout.
*/
- 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, {
+ 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);
+ },
- //inherit docs
- constructor: function(config) {
- config = config || {};
- //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
- });
- }
+ /**
+ * 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]);
+ },
+
- //add the sorting sorter object if it is present
- if (sortInfo) {
- sorters.push(sortInfo);
+ /**
+ * 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)));
}
- Ext.data.GroupingStore.superclass.constructor.call(this, config);
+ return result;
+ }
+
+});
- 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'
- );
+/**
+ * @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.define('Ext.layout.component.field.TextArea', {
+ extend: 'Ext.layout.component.field.Text',
+ alias: 'layout.textareafield',
+
+ type: 'textareafield',
- this.applyGroupField();
- },
/**
- * @cfg {String} groupField
- * The field name by which to sort the store's data (defaults to '').
- */
- /**
- * @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.
- */
- remoteGroup : false,
- /**
- * @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).
+ * 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]
*/
- groupOnSort:false,
+ adjustForGrow: function(width, height) {
+ var me = this,
+ owner = me.owner,
+ inputEl, value, max,
+ curWidth, curHeight, calcHeight,
+ result = [width, height];
- groupDir : 'ASC',
+ if (owner.grow) {
+ inputEl = owner.inputEl;
+ curWidth = inputEl.getWidth(true); //subtract border/padding to get the available width for the text
+ curHeight = inputEl.getHeight();
- /**
- * Clears any existing grouping and refreshes the data using the default sort.
- */
- clearGrouping : function(){
- this.groupField = false;
+ // Get and normalize the field value for measurement
+ value = inputEl.dom.value || ' ';
+ value += owner.growAppend;
- 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;
- }
+ // Translate newlines to
tags
+ value = value.replace(/\n/g, '
');
- this.reload();
- }else{
- this.sort();
- this.fireEvent('datachanged', this);
+ // 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 */
/**
- * 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)
+ * @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:
+ *
+ * - 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%'
+ *
+ *
+ *
+ *
*/
- groupBy : function(field, forceRegroup, direction) {
- direction = direction ? (String(direction).toUpperCase() == 'DESC' ? 'DESC' : 'ASC') : this.groupDir;
- if (this.groupField == field && this.groupDir == direction && !forceRegroup) {
- return; // already grouped by this field
- }
+ type: 'anchor',
- //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
- var sorters = this.multiSortInfo.sorters;
- if (sorters.length > 0 && sorters[0].field == this.groupField) {
- sorters.shift();
- }
+ /**
+ * @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%'.
+ *
+ */
+ defaultAnchor: '100%',
- this.groupField = field;
- this.groupDir = direction;
- this.applyGroupField();
+ parseAnchorRE: /^(r|right|b|bottom)$/i,
- var fireGroupEvent = function() {
- this.fireEvent('groupchange', this, this.getGroupState());
- };
+ // private
+ onLayout: function() {
+ this.callParent(arguments);
- if (this.groupOnSort) {
- this.sort(field, direction);
- fireGroupEvent.call(this);
+ 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, anchorWidth, anchorHeight, component, anchorSpec, calcWidth, calcHeight,
+ anchorsArray, anchor, i, el;
+
+ if (ownerWidth < 20 && ownerHeight < 20) {
return;
}
- if (this.remoteGroup) {
- this.on('load', fireGroupEvent, this, {single: true});
- this.reload();
- } else {
- this.sort(sorters);
- fireGroupEvent.call(this);
+ // 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'
+ });
}
- },
- //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);
+ // 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;
+ }
+ }
+ else {
+ anchorWidth = owner.initialConfig.width;
+ anchorHeight = owner.initialConfig.height;
}
- var sorters = [];
+ // 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.addCls(Ext.baseCSSPrefix + 'inline-children');
+ }
- //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;
+ for (i = 0; i < len; i++) {
+ component = components[i];
+ el = component.el;
+ anchor = component.anchor;
+
+ if (!component.anchor && component.items && !Ext.isNumber(component.width) && !(Ext.isIE6 && Ext.isStrict)) {
+ component.anchor = anchor = me.defaultAnchor;
+ }
+
+ if (anchor) {
+ anchorSpec = component.anchorSpec;
+ // cache all anchor values
+ if (!anchorSpec) {
+ anchorsArray = anchor.split(' ');
+ component.anchorSpec = anchorSpec = {
+ right: me.parseAnchor(anchorsArray[0], component.initialConfig.width, anchorWidth),
+ bottom: me.parseAnchor(anchorsArray[1], component.initialConfig.height, anchorHeight)
+ };
}
+ calcWidth = anchorSpec.right ? me.adjustWidthAnchor(anchorSpec.right(ownerWidth) - el.getMargin('lr'), component) : undefined;
+ calcHeight = anchorSpec.bottom ? me.adjustHeightAnchor(anchorSpec.bottom(ownerHeight) - el.getMargin('tb'), component) : undefined;
+
+ boxes.push({
+ component: component,
+ anchor: true,
+ width: calcWidth || undefined,
+ height: calcHeight || undefined
+ });
+ } else {
+ boxes.push({
+ component: component,
+ anchor: false
+ });
}
+ }
- this.sortToggle[name] = dir;
- this.sortInfo = {field: name, direction: dir};
+ // 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');
+ }
- sorters = [this.sortInfo];
+ for (i = 0; i < len; i++) {
+ box = boxes[i];
+ me.setItemSize(box.component, box.width, box.height);
}
- //add the grouping sorter object as the first multisort sorter
- if (this.groupField) {
- sorters.unshift({direction: this.groupDir, field: this.groupField});
+ if (overflow && overflow != 'hidden' && !me.adjustmentPass) {
+ newTargetSize = me.getLayoutTargetSize();
+ if (newTargetSize.width != size.width || newTargetSize.height != size.height) {
+ me.adjustmentPass = true;
+ me.onLayout();
+ }
}
- return this.multiSort.call(this, sorters, dir);
+ delete me.adjustmentPass;
},
- /**
- * @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 = {};
+ // 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;
+ },
- Ext.apply(this.baseParams, {
- groupBy : this.groupField,
- groupDir: this.groupDir
- });
+ // private
+ adjustWidthAnchor: function(value, comp) {
+ return value;
+ },
- var lo = this.lastOptions;
- if (lo && lo.params) {
- lo.params.groupDir = this.groupDir;
+ // private
+ adjustHeightAnchor: function(value, comp) {
+ return value;
+ }
- //this is deleted because of a bug reported at http://www.extjs.com/forum/showthread.php?t=82907
- delete lo.params.groupBy;
- }
- }
+});
+/**
+ * @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 : Object
+ * The 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:
+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);
+ }
+});
+
+ * a success response packet may look like this:
+{
+ success: true,
+ data: {
+ clientName: "Fred. Olsen Lines",
+ portOfLoading: "FXT",
+ portOfDischarge: "OSL"
+ }
+}
+ * while a failure response packet may look like this:
+{
+ 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',
+
+ type: 'load',
/**
* @private
- * TODO: This function is apparently never invoked anywhere in the framework. It has no documentation
- * and should be considered for deletion
*/
- applyGrouping : function(alwaysFireChange){
- if(this.groupField !== false){
- this.groupBy(this.groupField, true, this.groupDir);
- return true;
- }else{
- if(alwaysFireChange === true){
- this.fireEvent('datachanged', this);
+ run: function() {
+ Ext.Ajax.request(Ext.apply(
+ this.createCallback(),
+ {
+ method: this.getMethod(),
+ url: this.getUrl(),
+ headers: this.headers,
+ params: this.getParams()
}
- return false;
+ ));
+ },
+
+ /**
+ * @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);
},
/**
* @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
*/
- getGroupState : function(){
- return this.groupOnSort && this.groupField !== false ?
- (this.sortInfo ? this.sortInfo.field : undefined) : this.groupField;
+ 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.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,|]/);
+ * @class Ext.window.Window
+ * @extends Ext.panel.Panel
+ * 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.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
}
- Ext.data.DirectProxy.superclass.constructor.call(this, config);
-};
+}).show();
+
+ * @constructor
+ * @param {Object} config The config object
+ * @xtype window
+ */
+Ext.define('Ext.window.Window', {
+ extend: 'Ext.panel.Panel',
+
+ alternateClassName: 'Ext.Window',
+
+ requires: ['Ext.util.ComponentDragger', 'Ext.util.Region', 'Ext.EventManager'],
+
+ alias: 'widget.window',
-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:
-paramOrder: ['param1','param2','param3']
-paramOrder: 'param1 param2 param3'
-paramOrder: 'param1,param2,param3'
-paramOrder: 'param1|param2|param'
-
+ * @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).
*/
- paramOrder: undefined,
-
/**
- * @cfg {Boolean} paramsAsHash
- * Send parameters as a collection of named arguments (defaults to true). Providing a
- * {@link #paramOrder} nullifies this configuration.
+ * @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 {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:
+ * - The index of a footer Button.
+ * - The id or {@link Ext.AbstractComponent#itemId} of a descendant Component.
+ * - A Component.
+ *
+ */
+ /**
+ * @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 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).
*/
- paramsAsHash: true,
/**
- * @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.
+ * @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
*/
- directFn : undefined,
+ resizable: true,
/**
- * 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
- * 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
- * @param {Object} scope The scope (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 {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);).
*/
- doRequest : function(action, rs, params, reader, callback, scope, options) {
- var args = [],
- directFn = this.api[action] || this.directFn;
+ draggable: true,
- 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);
- }
- }
- 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;
- }
+ /**
+ * @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}.
+ */
+ constrain: false,
- var trans = {
- params : params || {},
- request: {
- callback : callback,
- scope : scope,
- arg : options
- },
- reader: reader
- };
+ /**
+ * @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,
- args.push(this.createCallback(action, rs, trans), this);
- directFn.apply(window, args);
- },
+ /**
+ * @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,
- // 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);
- }
- 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);
- }
- };
- },
+ /**
+ * @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,
/**
- * 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
+ * @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.
*/
- onRead : function(action, trans, result, res) {
- var records;
- try {
- records = trans.reader.readRecords(result);
- }
- catch (ex) {
- // @deprecated: Fire old loadexception for backwards-compat.
- this.fireEvent("loadexception", this, trans, res, ex);
+ maximizable: false,
+
+ // inherit docs
+ minHeight: 100,
+
+ // inherit docs
+ minWidth: 200,
- this.fireEvent('exception', this, 'response', action, trans, res, ex);
- trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);
- return;
- }
- 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
+ * @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).
*/
- 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);
- }
- 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:
- *
- * - {@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}
- *
- *
- *
- * @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
- }));
- }
-});
-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:
- *
-{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
+ expandOnShow: true,
+
+ // inherited docs, same default
+ collapsible: false,
-// 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
- */
-Ext.Direct = Ext.extend(Ext.util.Observable, {
/**
- * Each event type implements a getData() method. The default event types are:
- *
- * - event : Ext.Direct.Event
- * - exception : Ext.Direct.ExceptionEvent
- * - rpc : Ext.Direct.RemotingEvent
- *
- * @property eventTypes
- * @type Object
+ * @cfg {Boolean} closable
+ * 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'.
*/
+ closable: true,
/**
- * 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'
- *
- * @property exceptions
- * @type Object
+ * @cfg {Boolean} hidden
+ * Render this Window hidden (default is true
). If true
, the
+ * {@link #hide} method will be called internally.
*/
- exceptions: {
- TRANSPORT: 'xhr',
- PARSE: 'parse',
- LOGIN: 'login',
- SERVER: 'exception'
- },
+ 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',
+
+ itemCls: 'x-window-item',
+
+ overlapHeader: true,
+
+ ignoreHeaderBorderManagement: true,
// private
- constructor: function(){
- this.addEvents(
+ initComponent: function() {
+ var me = this;
+ me.callParent();
+ me.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 activate
+ * Fires after the window has been visually activated via {@link #setActive}.
+ * @param {Ext.window.Window} this
*/
- 'event',
/**
- * @event exception
- * Fires after an event exception.
- * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
+ * @event deactivate
+ * Fires after the window has been visually deactivated via {@link #setActive}.
+ * @param {Ext.window.Window} this
*/
- 'exception'
+ /**
+ * @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'
);
- this.transactions = {};
- this.providers = {};
+
+ if (me.plain) {
+ me.addClsWithUI('plain');
+ }
+
+ if (me.modal) {
+ me.ariaRole = 'dialog';
+ }
},
- /**
- * 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.
- *
-var pollProv = new Ext.direct.PollingProvider({
- url: 'php/poll2.php'
-});
+ // State Management
+ // private
-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'
+ 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();
},
- pollProv // reference to previously created instance
-);
- *
- * @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.
- */
- addProvider : function(provider){
- var a = arguments;
- if(a.length > 1){
- for(var i = 0, len = a.length; i < len; i++){
- this.addProvider(a[i]);
+
+ 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]
+ });
}
- return;
}
+ },
- // if provider has not already been instantiated
- if(!provider.events){
- provider = new Ext.Direct.PROVIDERS[provider.type](provider);
+ // private
+ onMouseDown: function () {
+ if (this.floating) {
+ this.toFront();
+ }
+ },
+
+ // private
+ 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
+ }
+ });
}
- provider.id = provider.id || Ext.id();
- this.providers[provider.id] = provider;
+ },
+
+ // private
+ afterRender: function() {
+ var me = this,
+ hidden = me.hidden,
+ keyMap;
- provider.on('data', this.onProviderData, this);
- provider.on('exception', this.onProviderException, this);
+ 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();
- if(!provider.isConnected()){
- provider.connect();
+ // clickToRaise
+ me.mon(me.el, 'mousedown', me.onMouseDown, me);
+
+ // Initialize
+ if (me.maximized) {
+ me.maximized = false;
+ me.maximize();
}
- return provider;
+ if (me.closable) {
+ keyMap = me.getKeyMap();
+ keyMap.on(27, me.onEsc, me);
+ keyMap.disable();
+ }
},
/**
- * 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}
+ * @private
+ * @override
+ * Override Component.initDraggable.
+ * Window uses the header element as the delegate.
*/
- getProvider : function(id){
- return this.providers[id];
- },
+ initDraggable: function() {
+ var me = this,
+ ddConfig;
- 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 (!me.header) {
+ me.updateHeader(true);
+ }
+
+ ddConfig = Ext.applyIf({
+ el: me.el,
+ delegate: '#' + me.header.id
+ }, me.draggable);
+
+ // 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 onBeforeStart
, onDrag
and onEnd
+ * 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.
+ * @type Ext.util.ComponentDragger
+ * @property dd
+ */
+ me.dd = Ext.create('Ext.util.ComponentDragger', this, ddConfig);
+ me.relayEvents(me.dd, ['dragstart', 'drag', 'dragend']);
},
- addTransaction: function(t){
- this.transactions[t.tid] = t;
- return t;
+ // private
+ onEsc: function(k, e) {
+ e.stopEvent();
+ this[this.closeAction]();
},
- removeTransaction: function(t){
- delete this.transactions[t.tid || t];
- return t;
+ // private
+ beforeDestroy: function() {
+ var me = this;
+ if (me.rendered) {
+ delete this.animateTarget;
+ me.hide();
+ Ext.destroy(
+ me.keyMap
+ );
+ }
+ me.callParent();
},
- getTransaction: function(tid){
- return this.transactions[tid.tid || tid];
+ /**
+ * @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
+ });
+ }
},
- onProviderData : function(provider, e){
- if(Ext.isArray(e)){
- for(var i = 0, len = e.length; i < len; i++){
- this.onProviderData(provider, e[i]);
+ /**
+ * 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;
- }
- if(e.name && e.name != 'event' && e.name != 'exception'){
- this.fireEvent(e.name, e);
- }else if(e.type == 'exception'){
- this.fireEvent('exception', e);
}
- this.fireEvent('event', e, provider);
+ return f || me.focusEl;
},
- createEvent : function(response, extraProps){
- return new Ext.Direct.eventTypes[response.type](Ext.apply(response, extraProps));
- }
-});
-// overwrite impl. with static instance
-Ext.Direct = new Ext.Direct();
+ // private
+ beforeShow: function() {
+ this.callParent();
-Ext.Direct.TID = 1;
-Ext.Direct.PROVIDERS = {};/**
- * @class Ext.Direct.Transaction
- * @extends Object
- * 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);
+ if (this.expandOnShow) {
+ this.expand(false);
+ }
},
- retry: function(){
- this.retryCount++;
- this.send();
+ // private
+ afterShow: function(animateTarget) {
+ var me = this,
+ size;
+
+ // Perform superclass's afterShow tasks
+ // Which might include animating a proxy from an animTarget
+ me.callParent(arguments);
+
+ if (me.maximized) {
+ me.fitContainer();
+ }
+
+ if (me.monitorResize || me.constrain || me.constrainHeader) {
+ Ext.EventManager.onWindowResize(me.onWindowResize, me);
+ }
+ me.doConstrain();
+ if (me.keyMap) {
+ me.keyMap.enable();
+ }
},
- getProvider: function(){
- return this.provider;
- }
-};Ext.Direct.Event = function(config){
- Ext.apply(this, config);
-};
+ // private
+ doClose: function() {
+ var me = this;
-Ext.Direct.Event.prototype = {
- status: true,
- getData: function(){
- return this.data;
- }
-};
+ // immediate close
+ if (me.hidden) {
+ me.fireEvent('close', me);
+ me[me.closeAction]();
+ } else {
+ // close after hiding
+ me.hide(me.animTarget, me.doClose, me);
+ }
+ },
-Ext.Direct.RemotingEvent = Ext.extend(Ext.Direct.Event, {
- type: 'rpc',
- getTransaction: function(){
- return this.transaction || Ext.Direct.getTransaction(this.tid);
- }
-});
+ // private
+ afterHide: function() {
+ var me = this;
-Ext.Direct.ExceptionEvent = Ext.extend(Ext.Direct.RemotingEvent, {
- status: false,
- type: 'exception'
-});
+ // No longer subscribe to resizing now that we're hidden
+ if (me.monitorResize || me.constrain || me.constrainHeader) {
+ Ext.EventManager.removeResizeListener(me.onWindowResize, me);
+ }
-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:
- *
-Provider
-|
-+---{@link Ext.direct.JsonProvider JsonProvider}
- |
- +---{@link Ext.direct.PollingProvider PollingProvider}
- |
- +---{@link Ext.direct.RemotingProvider RemotingProvider}
- *
- * @abstract
- */
-Ext.direct.Provider = Ext.extend(Ext.util.Observable, {
- /**
- * @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.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();
- *
- */
-
- /**
- * @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,
+ // Turn off keyboard handling once window is hidden
+ if (me.keyMap) {
+ me.keyMap.disable();
+ }
+
+ // Perform superclass's afterHide tasks.
+ me.callParent(arguments);
+ },
- /**
- * @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:
- * - polling : {@link Ext.direct.PollingProvider PollingProvider}
- * - remoting : {@link Ext.direct.RemotingProvider RemotingProvider}
- *
- */
-
// 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);
+ onWindowResize: function() {
+ if (this.maximized) {
+ this.fitContainer();
+ }
+ this.doConstrain();
},
/**
- * Returns whether or not the server-side is currently connected.
- * Abstract method for subclasses to implement.
+ * 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
*/
- isConnected: function(){
- return false;
+ minimize: function() {
+ this.fireEvent('minimize', this);
+ return this;
},
- /**
- * Abstract methods for subclasses to implement.
- */
- connect: Ext.emptyFn,
-
- /**
- * Abstract methods for subclasses to implement.
- */
- 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);
+ afterCollapse: function() {
+ var me = this;
+
+ if (me.maximizable) {
+ me.tools.maximize.hide();
+ me.tools.restore.hide();
}
- return null;
+ if (me.resizer) {
+ me.resizer.disable();
+ }
+ me.callParent(arguments);
},
- 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];
+ afterExpand: function() {
+ var me = this;
+
+ if (me.maximized) {
+ me.tools.restore.show();
+ } else if (me.maximizable) {
+ me.tools.maximize.show();
}
- 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));
+ if (me.resizer) {
+ me.resizer.enable();
}
- 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:
- *
-var pollA = new Ext.direct.PollingProvider({
- type:'polling',
- url: 'php/pollA.php',
-});
-Ext.Direct.addProvider(pollA);
-pollA.disconnect();
+ me.callParent(arguments);
+ },
-Ext.Direct.addProvider(
- {
- type:'polling',
- url: 'php/pollB.php',
- id: 'pollB-provider'
- }
-);
-var pollB = Ext.Direct.getProvider('pollB-provider');
- *
- */
-Ext.direct.PollingProvider = Ext.extend(Ext.direct.JsonProvider, {
- /**
- * @cfg {Number} priority
- * Priority of the request (defaults to 3). See {@link Ext.direct.Provider#priority}.
- */
- // override default priority
- priority: 3,
-
/**
- * @cfg {Number} interval
- * How often to poll the server-side in milliseconds (defaults to 3000 - every
- * 3 seconds).
+ * 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
*/
- interval: 3000,
+ maximize: function() {
+ var me = this;
- /**
- * @cfg {Object} baseParams An object containing properties which are to be sent as parameters
- * on every polling request
- */
-
- /**
- * @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.
- */
+ if (!me.maximized) {
+ me.expand(false);
+ if (!me.hasSavedRestore) {
+ me.restoreSize = me.getSize();
+ me.restorePos = me.getPosition(true);
+ }
+ if (me.maximizable) {
+ me.tools.maximize.hide();
+ me.tools.restore.show();
+ }
+ me.maximized = true;
+ me.el.disableShadow();
- // private
- constructor : function(config){
- Ext.direct.PollingProvider.superclass.constructor.call(this, config);
- this.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}
- */
- 'beforepoll',
- /**
- * @event poll
- * This event has not yet been implemented.
- * @param {Ext.direct.PollingProvider}
- */
- 'poll'
- );
- },
+ if (me.dd) {
+ me.dd.disable();
+ }
+ if (me.collapseTool) {
+ me.collapseTool.hide();
+ }
+ me.el.addCls(Ext.baseCSSPrefix + 'window-maximized');
+ me.container.addCls(Ext.baseCSSPrefix + 'window-maximized-ct');
- // inherited
- isConnected: function(){
- return !!this.pollTask;
+ me.setPosition(0, 0);
+ me.fitContainer();
+ me.fireEvent('maximize', me);
+ }
+ return me;
},
/**
- * Connect to the server-side and begin the polling process. To handle each
- * response subscribe to the data event.
+ * 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
*/
- 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.';
+ restore: function() {
+ var me = this,
+ tools = me.tools;
+
+ if (me.maximized) {
+ delete me.hasSavedRestore;
+ me.removeCls(Ext.baseCSSPrefix + 'window-maximized');
+
+ // Toggle tool visibility
+ if (tools.restore) {
+ tools.restore.hide();
+ }
+ if (tools.maximize) {
+ tools.maximize.show();
+ }
+ if (me.collapseTool) {
+ me.collapseTool.show();
+ }
+
+ // Restore the position/sizing
+ me.setPosition(me.restorePos);
+ me.setSize(me.restoreSize);
+
+ // Unset old position/sizing
+ delete me.restorePos;
+ delete me.restoreSize;
+
+ me.maximized = false;
+
+ me.el.enableShadow(true);
+
+ // Allow users to drag and drop again
+ if (me.dd) {
+ me.dd.enable();
+ }
+
+ me.container.removeCls(Ext.baseCSSPrefix + 'window-maximized-ct');
+
+ me.doConstrain();
+ me.fireEvent('restore', me);
}
+ return me;
},
/**
- * Disconnect from the server-side and stop the polling process. The disconnect
- * event will be fired on a successful disconnect.
+ * 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
*/
- disconnect: function(){
- if(this.pollTask){
- Ext.TaskMgr.stop(this.pollTask);
- delete this.pollTask;
- this.fireEvent('disconnect', this);
- }
- },
-
- // 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
- });
- this.fireEvent('data', this, e);
- }
+ toggleMaximize: function() {
+ return this[this.maximized ? 'restore': 'maximize']();
}
-});
-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:
- *
-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
+ * @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',
- }else{
- var msg = e.message; // failure message
+ 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()
+ });
+
+ * @constructor
+ * Creates a new Field
+ * @param {Object} config Configuration options
+ *
+ * @xtype field
+ * @markdown
+ * @docauthor Jason Johnston
+ */
+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
}
- }
-);
- *
- * 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} 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.
*/
-
+
/**
- * @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} 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'.
*/
-
+ inputType: 'text',
+
/**
- * @cfg {String} url
- * Required. The url to connect to the {@link Ext.Direct} server-side router.
+ * @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).
*/
-
+
/**
- * @cfg {String} enableUrlEncode
- * Specify which param will hold the arguments for the method.
- * Defaults to 'data'.
+ * @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')
*/
-
+ invalidText : 'The value in this field is invalid',
+
/**
- * @cfg {Number/Boolean} enableBuffer
- * 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.
+ * @cfg {String} fieldCls The default CSS class for the field input (defaults to 'x-form-field')
*/
- enableBuffer: 10,
-
+ fieldCls : Ext.baseCSSPrefix + 'form-field',
+
/**
- * @cfg {Number} maxRetries
- * Number of times to re-attempt delivery on failure of a call. Defaults to 1.
+ * @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.
*/
- maxRetries: 1,
-
+
/**
- * @cfg {Number} timeout
- * The timeout to use for each request. Defaults to undefined.
+ * @cfg {String} focusCls The CSS class to use when the field receives focus (defaults to 'x-form-focus')
*/
- timeout: undefined,
+ focusCls : Ext.baseCSSPrefix + 'form-focus',
- 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
- * @param {Object} meta The meta data
- */
- '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
- * @param {Object} meta The meta data
- */
- 'call'
- );
- this.namespace = (Ext.isString(this.namespace)) ? Ext.ns(this.namespace) : this.namespace || window;
- this.transactions = {};
- this.callBuffer = [];
- },
+ /**
+ * @cfg {String} dirtyCls The CSS class to use when the field value {@link #isDirty is dirty}.
+ */
+ dirtyCls : Ext.baseCSSPrefix + 'form-dirty',
+
+ /**
+ * @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.
+ */
+ checkChangeEvents: Ext.isIE && (!document.documentMode || document.documentMode < 9) ?
+ ['change', 'propertychange'] :
+ ['change', 'input', 'textInput', 'keyup', 'dragdrop'],
+
+ /**
+ * @cfg {Number} checkChangeBuffer
+ * Defines a timeout in milliseconds for buffering {@link #checkChangeEvents} that fire in rapid succession.
+ * Defaults to 50 milliseconds.
+ */
+ checkChangeBuffer: 50,
+
+ componentLayout: 'field',
+
+ /**
+ * @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 readOnly=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}
.
+ */
+ readOnly : false,
+
+ /**
+ * @cfg {String} readOnlyCls The CSS class applied to the component's main element when it is {@link #readOnly}.
+ */
+ readOnlyCls: Ext.baseCSSPrefix + 'form-readonly',
+
+ /**
+ * @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.
+ */
+
+ /**
+ * @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}.
+ */
+ validateOnBlur: true,
// 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);
- }
- }
- },
+ hasFocus : false,
+
+ baseCls: Ext.baseCSSPrefix + 'field',
+
+ maskOnDisable: false,
- // inherited
- isConnected: function(){
- return !!this.connected;
- },
+ // private
+ initComponent : function() {
+ var me = this;
- 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.';
- }
- },
+ me.callParent();
- disconnect: function(){
- if(this.connected){
- this.connected = false;
- this.fireEvent('disconnect', this);
- }
- },
+ me.subTplData = me.subTplData || {};
- 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);
+ 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:
+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();
}
}
}
}
+ ],
+ ...
+});
+ *
+ * @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();
+ }
},
- getCallData: function(t){
- return {
- action: t.action,
- method: t.method,
- data: t.data,
- type: 'rpc',
- tid: t.tid
- };
+ /**
+ * Returns the input id for this field. If none was specified via the {@link #inputId} config,
+ * then an id will be automatically generated.
+ */
+ getInputId: function() {
+ return this.inputId || (this.inputId = Ext.id());
},
- doSend : function(data){
- var o = {
- url: this.url,
- callback: this.onData,
- scope: this,
- ts: data,
- timeout: this.timeout
- }, callData;
+ /**
+ * @protected Creates and returns the data object to be used when rendering the {@link #fieldSubTpl}.
+ * @return {Object} The template data
+ */
+ 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)
+ });
+ },
- 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);
- }
+ /**
+ * @protected
+ * Gets the markup to be inserted into the outer template's bodyEl. For fields this is the
+ * actual input element.
+ */
+ getSubTplMarkup: function() {
+ return this.getTpl('fieldSubTpl').apply(this.getSubTplData());
+ },
- if(this.enableUrlEncode){
- var params = {};
- params[Ext.isString(this.enableUrlEncode) ? this.enableUrlEncode : 'data'] = Ext.encode(callData);
- o.params = params;
- }else{
- o.jsonData = callData;
+ initRenderTpl: function() {
+ var me = this;
+ if (!me.hasOwnProperty('renderTpl')) {
+ me.renderTpl = me.getTpl('labelableRenderTpl');
}
- Ext.Ajax.request(o);
+ return me.callParent();
},
- combineAndSend : function(){
- var len = this.callBuffer.length;
- if(len > 0){
- this.doSend(len == 1 ? this.callBuffer[0] : this.callBuffer);
- this.callBuffer = [];
- }
+ initRenderData: function() {
+ return Ext.applyIf(this.callParent(), this.getLabelableRenderData());
},
- 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();
+ /**
+ * 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}.
+ */
+ setFieldStyle: function(style) {
+ var me = this,
+ inputEl = me.inputEl;
+ if (inputEl) {
+ inputEl.applyStyles(style);
}
+ me.fieldStyle = style;
},
- doCall : function(c, m, args){
- var data = null, hs = args[m.len], scope = args[m.len+1];
+ // private
+ onRender : function() {
+ var me = this,
+ fieldStyle = me.fieldStyle,
+ renderSelectors = me.renderSelectors;
- if(m.len !== 0){
- data = args.slice(0, m.len);
- }
+ Ext.applyIf(renderSelectors, me.getLabelableSelectors());
- 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
+ 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
});
- if(this.fireEvent('beforecall', this, t, m) !== false){
- Ext.Direct.addTransaction(t);
- this.queueTransaction(t);
- this.fireEvent('call', this, t, m);
- }
- },
+ me.callParent(arguments);
- 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
- });
+ // Make the stored rawValue get set as the input element's value
+ me.setRawValue(me.rawValue);
- if(this.fireEvent('beforecall', this, t, m) !== 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, m);
- this.processForm(t);
+ if (me.readOnly) {
+ me.setReadOnly(true);
+ }
+ if (me.disabled) {
+ me.disable();
}
+ if (fieldStyle) {
+ me.setFieldStyle(fieldStyle);
+ }
+
+ me.renderActiveError();
},
-
- 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
- });
+
+ 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));
},
- 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);
- }
- f.directCfg = {
- action: c,
- method: m
- };
- return f;
+ getFocusEl: function() {
+ return this.inputEl;
},
- getTransaction: function(opt){
- return opt && opt.tid ? Ext.Direct.getTransaction(opt.tid) : null;
+ isFileUpload: function() {
+ return this.inputType === 'file';
},
- 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]);
- }
+ 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);
}
- }
-});
-Ext.Direct.PROVIDERS['remoting'] = Ext.direct.RemotingProvider;/**
- * @class Ext.Resizable
- * @extends Ext.util.Observable
- * 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:
- * resizer.east.setDisplayed(false);
- * @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, {
+ return fileInput;
+ },
- 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(config.pinned && !config.adjustments){
- config.adjustments = 'auto';
+ // 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;
+ },
- /**
- * 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');
+ /**
+ * 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.
+ */
+ getSubmitValue: function() {
+ return this.processRawValue(this.getRawValue());
+ },
- Ext.apply(this, config);
+ /**
+ * 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
+ */
+ getRawValue: function() {
+ var me = this,
+ v = (me.inputEl ? me.inputEl.getValue() : Ext.value(me.rawValue, ''));
+ me.rawValue = v;
+ return v;
+ },
+
+ /**
+ * 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
+ */
+ setRawValue: function(value) {
+ var me = this;
+ value = Ext.value(value, '');
+ me.rawValue = value;
- if(this.pinned){
- this.disableTrackOver = true;
- this.el.addClass('x-resizable-pinned');
+ // Some Field subclasses may not render an inputEl
+ if (me.inputEl) {
+ me.inputEl.dom.value = value;
}
- // 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');
+ return value;
+ },
+
+ /**
+ * 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.
+ */
+ valueToRaw: function(value) {
+ return '' + Ext.value(value, '');
+ },
+
+ /**
+ * 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;
+ },
+
+ /**
+ * 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;
+ },
+
+ /**
+ * 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;
+ },
+
+ /**
+ * 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
+ */
+ setValue: function(value) {
+ var me = this;
+ me.setRawValue(me.valueToRaw(value));
+ return me.mixins.field.setValue.call(me, value);
+ },
+
+
+ //private
+ onDisable: function() {
+ var me = this,
+ inputEl = me.inputEl;
+ me.callParent();
+ if (inputEl) {
+ inputEl.dom.disabled = true;
}
- if(!this.handles){ // no handles passed, must be legacy style
- this.handles = 's,e,se';
- if(this.multiDirectional){
- this.handles += ',n,w';
- }
+ },
+
+ //private
+ onEnable: function() {
+ var me = this,
+ inputEl = me.inputEl;
+ me.callParent();
+ if (inputEl) {
+ inputEl.dom.disabled = false;
}
- if(this.handles == 'all'){
- this.handles = 'n s e w ne nw se sw';
+ },
+
+ /**
+ * 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);
}
- 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);
- }
+ me[readOnly ? 'addCls' : 'removeCls'](me.readOnlyCls);
+ me.readOnly = readOnly;
+ },
+
+ // private
+ fireKey: function(e){
+ if(e.isSpecialKey()){
+ this.fireEvent('specialkey', this, Ext.create('Ext.EventObjectImpl', e));
}
- // legacy
- this.corner = this.southeast;
+ },
- if(this.handles.indexOf('n') != -1 || this.handles.indexOf('w') != -1){
- this.updateBox = true;
+ // private
+ 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);
}
+ me.callParent();
+ },
- this.activeHandle = null;
+ doComponentLayout: function() {
+ var me = this,
+ inputEl = me.inputEl,
+ usesPropertychange = me.usesPropertychange,
+ ename = 'propertychange',
+ onChangeEvent = me.onChangeEvent;
- 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);
- }
+ // 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.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.callParent(arguments);
+ if (usesPropertychange) {
+ me.mon(inputEl, ename, onChangeEvent);
}
+ },
- 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);
- }
+ // private
+ preFocus: Ext.emptyFn,
+
+ // private
+ 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);
+ }
+ },
- 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'
- );
+ // private
+ beforeBlur : Ext.emptyFn,
- if(this.width !== null && this.height !== null){
- this.resizeTo(this.width, this.height);
- }else{
- this.updateChildSize();
+ // private
+ onBlur : function(){
+ var me = this,
+ focusCls = me.focusCls,
+ inputEl = me.inputEl;
+ me.beforeBlur();
+ if (focusCls && inputEl) {
+ inputEl.removeCls(focusCls);
}
- if(Ext.isIE){
- this.el.dom.style.zoom = 1;
+ if (me.validateOnBlur) {
+ me.validate();
}
- Ext.Resizable.superclass.constructor.call(this);
+ me.hasFocus = false;
+ me.fireEvent('blur', me);
+ me.postBlur();
},
+ // private
+ postBlur : Ext.emptyFn,
+
+
/**
- * @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])
+ * @private Called when the field's dirty state changes. Adds/removes the {@link #dirtyCls} on the main element.
+ * @param {Boolean} isDirty
*/
- adjustments : [0, 0],
+ onDirtyChange: function(isDirty) {
+ this[isDirty ? 'addCls' : 'removeCls'](this.dirtyCls);
+ },
+
+
/**
- * @cfg {Boolean} animate True to animate the resize (not compatible with dynamic sizing, defaults to false)
+ * 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
*/
- animate : false,
+ isValid : function() {
+ var me = this;
+ return me.disabled || me.validateValue(me.processRawValue(me.getRawValue()));
+ },
+
+
/**
- * @cfg {Mixed} constrainTo Constrain the resize to a particular element
+ * 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
*/
+ 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);
+ }
+ }
+
+ return isValid;
+ },
+
/**
- * @cfg {Boolean} disableTrackOver True to disable mouse tracking. This is only applied at config time. (defaults to false)
+ * 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 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.
+ * @param {String/Array} errors The validation message(s) to display.
*/
- disableTrackOver : false,
+ 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();
+ }
+ },
+
/**
- * @cfg {Boolean} draggable Convenience to initialize drag drop (defaults to false)
+ * 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 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.
*/
- draggable: false,
+ clearInvalid : function() {
+ // Clear the message and fire the 'valid' event
+ var me = this,
+ hadError = me.hasActiveError();
+ me.unsetActiveError();
+ if (hadError) {
+ me.doComponentLayout();
+ }
+ },
+
/**
- * @cfg {Number} duration Animation duration if animate = true (defaults to 0.35)
+ * @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)
*/
- duration : 0.35,
+ 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);
+ },
+
+
+ getActionEl: function() {
+ return this.inputEl || this.el;
+ }
+
+});
+
+/**
+ * @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
+ }]
+ });
+
+ * @constructor Creates a new TextField
+ * @param {Object} config Configuration options
+ *
+ * @xtype textfield
+ * @markdown
+ * @docauthor Jason Johnston
+ */
+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 {Boolean} dynamic True to resize the element while dragging instead of using a proxy (defaults to false)
+ * @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.
*/
- dynamic : false,
+
/**
- * @cfg {String} easing Animation easing if animate = true (defaults to 'easingOutStrong')
+ * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value
+ * before validation (defaults to undefined).
*/
- easing : 'easeOutStrong',
+
/**
- * @cfg {Boolean} enabled False to disable resizing (defaults to true)
+ * @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.
*/
- enabled : true,
+ size: 20,
+
/**
- * @property enabled Writable. False if resizing is disabled.
- * @type Boolean
+ * @cfg {Boolean} grow true if this field should automatically grow and shrink to its content
+ * (defaults to false)
*/
+
/**
- * @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 {Number} growMin The minimum width to allow when {@link #grow} = true
(defaults
+ * to 30)
*/
- handles : false,
+ growMin : 30,
+
/**
- * @cfg {Boolean} multiDirectional Deprecated. Deprecated style of adding multi-direction resize handles.
+ * @cfg {Number} growMax The maximum width to allow when {@link #grow} = true
(defaults
+ * to 800)
*/
- multiDirectional : false,
+ growMax : 800,
+
/**
- * @cfg {Number} height The height of the element in pixels (defaults to null)
+ * @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.
*/
- height : null,
+ growAppend: 'W',
+
/**
- * @cfg {Number} width The width of the element in pixels (defaults to null)
+ * @cfg {String} vtype A validation type name as defined in {@link Ext.form.field.VTypes} (defaults to undefined)
*/
- width : null,
+
/**
- * @cfg {Number} heightIncrement The increment to snap the height resize in pixels
- * (only applies if {@link #dynamic}==true
). Defaults to 0.
+ * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do
+ * not match (defaults to undefined)
*/
- heightIncrement : 0,
+
/**
- * @cfg {Number} widthIncrement The increment to snap the width resize in pixels
- * (only applies if {@link #dynamic}==true
). Defaults to 0.
+ * @cfg {Boolean} disableKeyFilter Specify true to disable input keystroke filtering (defaults
+ * to false)
*/
- widthIncrement : 0,
+
/**
- * @cfg {Number} minHeight The minimum height for the element (defaults to 5)
+ * @cfg {Boolean} allowBlank Specify false to validate that the value's length is > 0 (defaults to
+ * true)
*/
- minHeight : 5,
+ allowBlank : true,
+
/**
- * @cfg {Number} minWidth The minimum width for the element (defaults to 5)
+ * @cfg {Number} minLength Minimum input field length required (defaults to 0)
*/
- minWidth : 5,
+ minLength : 0,
+
/**
- * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000)
+ * @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.
*/
- maxHeight : 10000,
+ maxLength : Number.MAX_VALUE,
+
/**
- * @cfg {Number} maxWidth The maximum width for the element (defaults to 10000)
+ * @cfg {Boolean} enforceMaxLength True to set the maxLength property on the underlying input field. Defaults to false
*/
- maxWidth : 10000,
+
/**
- * @cfg {Number} minX The minimum x for the element (defaults to 0)
+ * @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}')
*/
- minX: 0,
+ minLengthText : 'The minimum length for this field is {0}',
+
/**
- * @cfg {Number} minY The minimum x for the element (defaults to 0)
+ * @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}')
*/
- minY: 0,
+ maxLengthText : 'The maximum length for this field is {0}',
+
/**
- * @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)
+ * @cfg {Boolean} selectOnFocus true to automatically select any existing field text when the field
+ * receives input focus (defaults to false)
*/
- pinned : false,
+
/**
- * @cfg {Boolean} preserveRatio True to preserve the original ratio between height
- * and width during resize (defaults to false)
+ * @cfg {String} blankText The error text to display if the {@link #allowBlank} validation
+ * fails (defaults to 'This field is required')
*/
- preserveRatio : false,
+ blankText : 'This field is required',
+
/**
- * @cfg {Boolean/String/Element} resizeChild True to resize the first child, or id/element to resize (defaults to false)
+ * @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 value
+ *
+ *
This function is to Return:
+ *
+ * true
: Boolean
+ * true
if the value is valid
+ * msg
: String
+ * An error message if the value is invalid
+ *
*/
- resizeChild : false,
+
/**
- * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false)
+ * @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}.
*/
- transparent: false,
+
/**
- * @cfg {Ext.lib.Region} resizeRegion Constrain the resize to a particular region
+ * @cfg {String} regexText The error text to display if {@link #regex} is used and the
+ * test fails during validation (defaults to '')
*/
+ regexText : '',
+
/**
- * @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)
+ * @cfg {String} emptyText
+ * The 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.
*/
+
/**
- * @cfg {String} handleCls A css class to add to each handle. Defaults to ''.
+ * @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.
*/
+ emptyCls : Ext.baseCSSPrefix + 'form-empty-field',
+ ariaRole: 'textbox',
/**
- * Perform a manual resize and fires the 'resize' event.
- * @param {Number} width
- * @param {Number} height
+ * @cfg {Boolean} enableKeyEvents true to enable the proxying of key events for the HTML input field (defaults to false)
*/
- resizeTo : function(width, height){
- this.el.setSize(width, height);
- this.updateChildSize();
- this.fireEvent('resize', this, width, height, null);
- },
-
- // 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();
+ componentLayout: 'textfield',
- 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')
- );
- }
+ initComponent : function(){
+ this.callParent();
+ this.addEvents(
+ /**
+ * @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
+ */
+ 'autosize',
- this.proxy.setStyle('visibility', 'hidden'); // workaround display none
- this.proxy.show();
- this.proxy.setBox(this.startBox);
- if(!this.dynamic){
- this.proxy.setStyle('visibility', 'visible');
- }
- }
+ /**
+ * @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
+ */
+ 'keydown',
+ /**
+ * @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
+ */
+ 'keyup',
+ /**
+ * @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
+ */
+ 'keypress'
+ );
},
// private
- onMouseDown : function(handle, e){
- if(this.enabled){
- e.stopEvent();
- this.activeHandle = handle;
- this.startSizing(e, handle);
+ 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);
+ }
+
+ if (me.enableKeyEvents) {
+ me.mon(el, {
+ scope: me,
+ keyup: me.onKeyUp,
+ keydown: me.onKeyDown,
+ keypress: me.onKeyPress
+ });
}
},
- // 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);
+ /**
+ * @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, ''));
},
- // 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);
- }
+ /**
+ * @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
- 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;
- }
+ onMouseDown: function(e){
+ var me = this;
+ if(!me.hasFocus){
+ me.mon(me.inputEl, 'mouseup', Ext.emptyFn, me, { single: true, preventDefault: true });
}
- return Math.max(min, newValue);
},
/**
- * 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:
-
-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();
-
+ * 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
*/
- 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();
+ processRawValue: function(value) {
+ var me = this,
+ stripRe = me.stripCharsRe,
+ newValue;
+
+ if (stripRe) {
+ newValue = value.replace(stripRe, '');
+ if (newValue !== value) {
+ me.setRawValue(newValue);
+ value = newValue;
+ }
}
- if(this.draggable && this.constrainTo){
- this.dd.resetConstraints();
- this.dd.constrainTo(this.constrainTo);
+ return value;
+ },
+
+ //private
+ onDisable: function(){
+ this.callParent();
+ if (Ext.isIE) {
+ this.inputEl.dom.unselectable = 'on';
}
- return box;
},
- // private
- constrain : function(v, diff, m, mx){
- if(v - diff < m){
- diff = v - m;
- }else if(v - diff > mx){
- diff = v - mx;
+ //private
+ onEnable: function(){
+ this.callParent();
+ if (Ext.isIE) {
+ this.inputEl.dom.unselectable = '';
}
- return diff;
},
- // private
- onMouseMove : function(e){
- if(this.enabled && this.activeHandle){
- try{// try catch so if something goes wrong the user doesn't get hung
+ onKeyDown: function(e) {
+ this.fireEvent('keydown', this, e);
+ },
- if(this.resizeRegion && !this.resizeRegion.contains(e.getPoint())) {
- return;
- }
+ onKeyUp: function(e) {
+ this.fireEvent('keyup', this, e);
+ },
- //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;
- }
+ onKeyPress: function(e) {
+ this.fireEvent('keypress', this, e);
+ },
- 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;
+ /**
+ * 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);
}
- this.proxy.setBounds(x, y, w, h);
- if(this.dynamic){
- this.resizeElement();
+
+ //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);
}
- }catch(ex){}
+
+ me.autoSize();
}
},
// private
- handleOver : function(){
- if(this.enabled){
- this.el.addClass('x-resizable-over');
+ 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 (me.selectOnFocus || isEmpty) {
+ inputEl.dom.select();
+ }
+ },
+
+ onFocus: function() {
+ var me = this;
+ me.callParent(arguments);
+ if (me.emptyText) {
+ me.autoSize();
}
},
// private
- handleOut : function(){
- if(!this.resizing){
- this.el.removeClass('x-resizable-over');
+ postBlur : function(){
+ this.applyEmptyText();
+ },
+
+ // private
+ filterKeys : function(e){
+ if(e.ctrlKey){
+ return;
+ }
+ 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();
}
},
/**
- * Returns the element this component is bound to.
- * @return {Ext.Element}
+ * 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
*/
- getEl : function(){
- return this.el;
+ getRawValue: function() {
+ var me = this,
+ v = me.callParent();
+ if (v === me.emptyText) {
+ v = '';
+ }
+ return v;
},
/**
- * Returns the resizeChild element (or null).
- * @return {Ext.Element}
+ * 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
*/
- getResizeChild : function(){
- return this.resizeChild;
+ setValue: function(value) {
+ var me = this,
+ inputEl = me.inputEl;
+
+ if (inputEl && me.emptyText && !Ext.isEmpty(value)) {
+ inputEl.removeCls(me.emptyCls);
+ }
+
+ me.callParent(arguments);
+
+ me.applyEmptyText();
+ return me;
},
/**
- * 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
- */
- destroy : function(removeEl){
- Ext.destroy(this.dd, this.overlay, this.proxy);
- this.overlay = null;
- this.proxy = null;
+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:
- var ps = Ext.Resizable.positions;
- for(var k in ps){
- if(typeof ps[k] != 'function' && this[ps[k]]){
- this[ps[k]].destroy();
+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
+ */
+ 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);
}
}
- if(removeEl){
- this.el.update('');
- Ext.destroy(this.el);
- this.el = null;
- }
- this.purgeListeners();
- },
- syncHandleHeight : function(){
- var h = this.el.getHeight(true);
- if(this.west){
- this.west.el.setHeight(h);
+ 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(this.east){
- this.east.el.setHeight(h);
+
+ if (value.length < me.minLength) {
+ errors.push(format(me.minLengthText, me.minLength));
}
- }
-});
-// 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'
-};
+ if (value.length > me.maxLength) {
+ errors.push(format(me.maxLengthText, me.maxLength));
+ }
-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;
+ if (vtype) {
+ if(!vtypes[vtype](value, me)){
+ errors.push(me.vtypeText || vtypes[vtype +'Text']);
+ }
}
- 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 (regex && !regex.test(value)) {
+ errors.push(me.regexText || me.invalidText);
}
- if(!Ext.isEmpty(cls)){
- this.el.addClass(cls);
+
+ return errors;
+ },
+
+ /**
+ * 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)
+ */
+ 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;
}
- this.el.on('mousedown', this.onMouseDown, this);
- if(!disableTrackOver){
- this.el.on({
- scope: this,
- mouseover: this.onMouseOver,
- mouseout: this.onMouseOut
- });
+ if (doFocus) {
+ me.focus();
}
},
- // private
- afterResize : function(rz){
- // do nothing
- },
- // private
- onMouseDown : function(e){
- this.rz.onMouseDown(this, e);
- },
- // private
- onMouseOver : function(e){
- this.rz.handleOver(this, e);
+ /**
+ * 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;
+ }
+ }
},
- // private
- onMouseOut : function(e){
- this.rz.handleOut(this, e);
+
+ initAria: function() {
+ this.callParent();
+ this.getActionEl().dom.setAttribute('aria-required', this.allowBlank === false);
},
- // private
- destroy : function(){
- Ext.destroy(this.el);
- this.el = null;
+
+ /**
+ * @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.Window
- * @extends Ext.Panel
- * 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 {@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'}
.
+ * @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.
+
* @constructor
- * @param {Object} config The config object
- * @xtype window
+ * Creates a new TextArea
+ * @param {Object} config Configuration options
+ * @xtype textareafield
+ * @docauthor Robert Dougan
*/
-Ext.Window = Ext.extend(Ext.Panel, {
+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} 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 {Number} growMin The minimum height to allow when {@link Ext.form.field.Text#grow grow}=true
+ * (defaults to 60)
*/
+ growMin: 60,
+
/**
- * @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 {Number} growMax The maximum height to allow when {@link Ext.form.field.Text#grow grow}=true
+ * (defaults to 1000)
*/
+ growMax: 1000,
+
/**
- * @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} 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 {String/Element} animateTarget
- * Id or element from which the window should animate while opening (defaults to null with no animation).
+ * @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 {String} resizeHandles
- * A valid {@link Ext.Resizable} handles config string (defaults to 'all'). Only applies when resizable = true.
+ * @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 {Ext.WindowGroup} manager
- * A reference to the WindowGroup that should manage this window (defaults to {@link Ext.WindowMgr}).
+ * @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)
*/
+ enterIsSpecial: false,
+
/**
- * @cfg {String/Number/Component} defaultButton
- * Specifies a Component to receive focus when this Window is focussed.
- * This may be one of:
- * - The index of a footer Button.
- * - The id of a Component.
- * - A Component.
- *
- */
- /**
- * @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 {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 {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.
*/
+ preventScrollbars: false,
+
+ // private
+ componentLayout: 'textareafield',
+
+ // private
+ onRender: function(ct, position) {
+ var me = this;
+ Ext.applyIf(me.subTplData, {
+ cols: me.cols,
+ rows: me.rows
+ });
+
+ me.callParent(arguments);
+ },
+
+ // private
+ afterRender: function(){
+ var me = this;
+
+ me.callParent(arguments);
+
+ if (me.grow) {
+ if (me.preventScrollbars) {
+ me.inputEl.setStyle('overflow', 'hidden');
+ }
+ me.inputEl.setHeight(me.growMin);
+ }
+ },
+
+ // private
+ fireKey: function(e) {
+ if (e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() !== e.ENTER || e.hasModifier()))) {
+ this.fireEvent('specialkey', this, e);
+ }
+ },
+
/**
- * @cfg {Boolean} maximized
- * True to initially display the window in a maximized state. (Defaults to false).
+ * 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;
+ }
+ }
+ },
+
+ // private
+ initAria: function() {
+ this.callParent(arguments);
+ this.getActionEl().dom.setAttribute('aria-multiline', true);
+ },
/**
- * @cfg {String} baseCls
- * The base CSS class to apply to this panel's element (defaults to 'x-window').
- */
- baseCls : 'x-window',
- /**
- * @cfg {Boolean} resizable
- * True to allow user resizing at each edge and corner of the window, false to disable resizing (defaults to true).
+ * @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.
*/
- resizable : true,
+ 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
+ * @xtype messagebox
+ */
+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',
+
/**
- * @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);).
+ * Button config that displays a single OK button
+ * @type Number
*/
- draggable : true,
+ OK : 1,
/**
- * @cfg {Boolean} closable
- * 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'.
+ * Button config that displays a single Yes button
+ * @type Number
*/
- closable : true,
+ YES : 2,
/**
- * @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}.
+ * Button config that displays a single No button
+ * @type Number
*/
- closeAction : 'close',
+ NO : 4,
/**
- * @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}.
+ * Button config that displays a single Cancel button
+ * @type Number
*/
- constrain : false,
+ CANCEL : 8,
/**
- * @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}.
+ * Button config that displays OK and Cancel buttons
+ * @type Number
*/
- constrainHeader : false,
+ OKCANCEL : 9,
/**
- * @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).
+ * Button config that displays Yes and No buttons
+ * @type Number
*/
- plain : false,
+ YESNO : 6,
/**
- * @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.
+ * Button config that displays Yes, No and Cancel buttons
+ * @type Number
*/
- minimizable : false,
+ YESNOCANCEL : 14,
/**
- * @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.
+ * The CSS class that provides the INFO icon image
+ * @type String
*/
- maximizable : false,
+ INFO : 'ext-mb-info',
/**
- * @cfg {Number} minHeight
- * The minimum height in pixels allowed for this window (defaults to 100). Only applies when resizable = true.
+ * The CSS class that provides the WARNING icon image
+ * @type String
*/
- minHeight : 100,
+ WARNING : 'ext-mb-warning',
/**
- * @cfg {Number} minWidth
- * The minimum width in pixels allowed for this window (defaults to 200). Only applies when resizable = true.
+ * The CSS class that provides the QUESTION icon image
+ * @type String
*/
- minWidth : 200,
+ QUESTION : 'ext-mb-question',
/**
- * @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).
+ * The CSS class that provides the ERROR icon image
+ * @type String
*/
- expandOnShow : true,
+ ERROR : 'ext-mb-error',
- // inherited docs, same default
- collapsible : false,
+ // 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'
+ },
/**
- * @cfg {Boolean} initHidden
- * True to hide the window until show() is explicitly called (defaults to true).
- * @deprecated
+ * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
+ * @type Number
*/
- initHidden : undefined,
-
+ defaultTextHeight : 75,
/**
- * @cfg {Boolean} hidden
- * Render this component hidden (default is true). If true, the
- * {@link #hide} method will be called internally.
+ * 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
*/
- 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,
+ 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'
+ },
- // private
- initComponent : function(){
- this.initTools();
- Ext.Window.superclass.initComponent.call(this);
- 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
- */
- 'resize',
- /**
- * @event maximize
- * Fires after the window has been maximized.
- * @param {Ext.Window} this
- */
- 'maximize',
- /**
- * @event minimize
- * Fires after the window has been minimized.
- * @param {Ext.Window} this
- */
- 'minimize',
- /**
- * @event restore
- * Fires after the window has been restored to its original size after being maximized.
- * @param {Ext.Window} this
- */
- 'restore'
- );
- // 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();
- }
+ buttonIds: [
+ 'ok', 'yes', 'no', 'cancel'
+ ],
+
+ titleText: {
+ confirm: 'Confirm',
+ prompt: 'Prompt',
+ wait: 'Loading...',
+ alert: 'Attention'
},
+
+ iconHeight: 35,
- // private
- getState : function(){
- return Ext.apply(Ext.Window.superclass.getState.call(this) || {}, this.getBox(true));
+ 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
+ });
},
- // private
- onRender : function(ct, position){
- Ext.Window.superclass.onRender.call(this, ct, position);
+ btnCallback: function(btn) {
+ var me = this,
+ value,
+ field;
- if(this.plain){
- this.el.addClass('x-window-plain');
+ if (me.cfg.prompt || me.cfg.multiline) {
+ if (me.cfg.multiline) {
+ field = me.textArea;
+ } else {
+ field = me.textField;
+ }
+ value = field.getValue();
+ field.reset();
}
- // 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);
+ // Important not to have focus remain in the hidden Window; Interferes with DnD.
+ btn.blur();
+ me.hide();
+ me.userCallback(btn.itemId, value, me.cfg);
+ },
+
+ hide: function() {
+ var me = this;
+ me.dd.endDrag();
+ me.progressBar.reset();
+ me.removeCls(me.cfg.cls);
+ me.callParent();
+ },
- this.proxy = this.el.createProxy('x-window-proxy');
- this.proxy.enableDisplayMode('block');
+ initComponent: function() {
+ var me = this,
+ i, button;
- 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);
+ 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);
}
- if(this.maximizable){
- this.mon(this.header, 'dblclick', this.toggleMaximize, this);
+ 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();
+ }
}
},
- // 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);
+ 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;
}
- if(this.draggable){
- this.header.addClass('x-window-draggable');
+ // 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||' ');
}
- 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();
+
+ if (!me.rendered) {
+ me.width = initialWidth;
+ me.render(Ext.getBody());
+ } else {
+ me.setSize(initialWidth, me.maxHeight);
}
- if(this.closable){
- var km = this.getKeyMap();
- km.on(27, this.onEsc, this);
- km.disable();
+ 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();
}
- },
- 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 startDrag
, onDrag
and endDrag
- * 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.
- * @type Ext.dd.DD
- * @property dd
- */
- this.dd = new Ext.Window.DD(this);
- },
+ // Hide or show the header
+ if (!cfg.title && !me.closable) {
+ me.header.hide();
+ } else {
+ me.header.show();
+ }
- // private
- onEsc : function(k, e){
- e.stopEvent();
- this[this.closeAction]();
- },
+ // Default to dynamic drag: drag the window, not a ghost
+ me.liveDrag = !cfg.proxyDrag;
- // private
- beforeDestroy : function(){
- if(this.rendered){
- this.hide();
- this.clearAnchor();
- Ext.destroy(
- this.focusEl,
- this.resizer,
- this.dd,
- this.proxy,
- this.mask
- );
+ // 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;
+ }
+ } else {
+ me.textArea.hide();
+ me.textField.hide();
}
- Ext.Window.superclass.beforeDestroy.call(this);
- },
- // private
- onDestroy : function(){
- if(this.manager){
- this.manager.unregister(this);
+ // 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);
+ }
+ } else {
+ me.progressBar.hide();
}
- Ext.Window.superclass.onDestroy.call(this);
- },
- // private
- initTools : function(){
- if(this.minimizable){
- this.addTool({
- id: 'minimize',
- handler: this.minimize.createDelegate(this, [])
- });
+ // Hide or show buttons depending on flag value sent.
+ for (i = 0; i < 4; i++) {
+ if (buttons & Math.pow(2, i)) {
+
+ // 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();
+ }
}
- if(this.maximizable){
- this.addTool({
- id: 'maximize',
- handler: this.maximize.createDelegate(this, [])
- });
- this.addTool({
- id: 'restore',
- handler: this.restore.createDelegate(this, []),
- hidden:true
- });
+
+ // 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:
+ * - animateTarget : String/ElementAn id or Element from which the message box should animate as it
+ * opens and closes (defaults to undefined)
+ * - buttons : NumberA bitwise button specifier consisting of the sum of any of the following constants:
+ * - Ext.window.MessageBox.OK
+ * - Ext.window.MessageBox.YES
+ * - Ext.window.MessageBox.NO
+ * - Ext.window.MessageBox.CANCEL
+ *
Or false to not show any buttons (defaults to false)
+ * - closable : BooleanFalse 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 : StringA custom CSS class to apply to the message box's container element
+ * - defaultTextHeight : NumberThe default height in pixels of the message box's multiline textarea
+ * if displayed (defaults to 75)
+ * - fn : FunctionA 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 : StringThe ID of the button pressed, one of:
+ * - ok
+ * - yes
+ * - no
+ * - cancel
+ *
+ * - text : String
+ * - opt : ObjectThe config object passed to show.
+ *
+ * - scope : ObjectThe scope (
this
reference) in which the function will be executed.
+ * - icon : StringA 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 : StringThe standard {@link Ext.window.Window#iconCls} to
+ * add an optional header icon (defaults to '')
+ * - maxWidth : NumberThe maximum width in pixels of the message box (defaults to 600)
+ * - minWidth : NumberThe minimum width in pixels of the message box (defaults to 100)
+ * - modal : BooleanFalse to allow user interaction with the page while the message box is
+ * displayed (defaults to true)
+ * - msg : StringA 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 : BooleanTrue to display a progress bar (defaults to false)
+ * - progressText : StringThe text to display inside the progress bar if progress = true (defaults to '')
+ * - prompt : BooleanTrue to prompt the user to enter single-line text (defaults to false)
+ * - proxyDrag : BooleanTrue to display a lightweight proxy while dragging (defaults to false)
+ * - title : StringThe title text
+ * - value : StringThe string value to set into the active textbox element if displayed
+ * - wait : BooleanTrue to display a progress bar (defaults to false)
+ * - waitConfig : ObjectA {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)
+ * - width : NumberThe width of the dialog in pixels
+ *
+ * Example usage:
+ *
+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
+});
+
+ * @return {Ext.window.MessageBox} this
+ */
+ 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);
}
- if(this.closable){
- this.addTool({
- id: 'close',
- handler: this[this.closeAction].createDelegate(this, [])
- });
+ return me;
+ },
+
+ afterShow: function(){
+ if (this.animateTarget) {
+ this.center();
+ }
+ this.callParent(arguments);
+ },
+
+ 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();
+ }
+
+ // 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 */
+
+ // 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;
},
- // private
- resizerAction : function(){
- var box = this.proxy.getBox();
- this.proxy.hide();
- this.window.handleResize(box);
- return box;
+ updateText: function(text) {
+ this.msg.update(text);
+ return this.doAutoSize(true);
},
- // 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();
+ /**
+ * 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.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 me;
},
- // private
- updateHandles : function(){
- if(Ext.isIE && this.resizer){
- this.resizer.syncHandleHeight();
- this.el.repaint();
+ /**
+ * 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
+ */
+ updateProgress : function(value, progressText, msg){
+ this.progressBar.updateProgress(value, progressText);
+ if (msg){
+ this.updateText(msg);
}
+ return this;
},
- // 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();
- }
+ onEsc: function() {
+ if (this.closable !== false) {
+ this.callParent(arguments);
}
- 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.
+ * 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
*/
- 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;
- }
- }
+ 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
+ };
}
- f = f || this.focusEl;
- f.focus.defer(10, f);
+ return this.show(cfg);
},
/**
- * Sets the target element from which the window should animate while opening.
- * @param {String/Element} el The target element or id
+ * 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
*/
- 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);
+ 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);
+ },
- 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();
+ /**
+ * 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
+ */
+ 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);
},
/**
- * 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 (this
reference) in which the callback is executed. Defaults to this Window.
- * @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
*/
- 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();
+ 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;
+ return this.show(cfg);
},
- // 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(Ext.isMac && Ext.isGecko2){ // work around stupid FF 2.0/Mac scroll bar bug
- this.cascade(this.setAutoScroll);
+ /**
+ * 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.form.Basic
+ * @extends Ext.util.Observable
- if(this.monitorResize || this.modal || this.constrain || this.constrainHeader){
- Ext.EventManager.onWindowResize(this.onWindowResize, this);
- }
- this.doConstrain();
- this.doLayout();
- if(this.keyMap){
- this.keyMap.enable();
- }
- this.toFront();
- this.updateHandles();
- if(isAnim && (Ext.isIE || Ext.isWebKit)){
- var sz = this.getSize();
- this.onResize(sz.width, sz.height);
+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);
+ }
+ });
+ }
+ }
+ }]
+ });
+
+ * @constructor
+ * @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.
+ *
+ * @markdown
+ * @docauthor Jason Johnston
+ */
+
+
+
+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'],
+
+ constructor: function(owner, config) {
+ var me = this,
+ onItemAddOrRemove = me.onItemAddOrRemove;
+
+ /**
+ * @property owner
+ * @type Ext.container.Container
+ * The container component to which this BasicForm is attached.
+ */
+ me.owner = owner;
+
+ // Listen for addition/removal of fields in the owner container
+ me.mon(owner, {
+ add: onItemAddOrRemove,
+ remove: onItemAddOrRemove,
+ scope: me
+ });
+
+ Ext.apply(me, config);
+
+ // Normalize the paramOrder to an Array
+ if (Ext.isString(me.paramOrder)) {
+ me.paramOrder = me.paramOrder.split(/[\s,|]/);
}
- this.onShow();
- this.fireEvent('show', this);
+
+ 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();
},
- // 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
- }));
+ /**
+ * Do any post constructor initialization
+ * @private
+ */
+ initialize: function(){
+ this.initialized = true;
+ this.onValidityChange(!this.hasInvalidField());
},
/**
- * 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
+ * @cfg {String} method
+ * The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
*/
- hide : function(animateTarget, cb, scope){
- if(this.hidden || this.fireEvent('beforehide', this) === false){
- return this;
- }
- if(cb){
- this.on('hide', cb, scope, {single:true});
+ /**
+ * @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:
+{
+ records: recordArray
+}
+
+ */
+
+ /**
+ * @cfg {String} url
+ * The URL to use for form actions if one isn't supplied in the
+ * {@link #doAction doAction} options.
+ */
+
+ /**
+ * @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}.
+ */
+
+ /**
+ * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
+ */
+ timeout: 30,
+
+ /**
+ * @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:
+api: {
+ load: App.ss.MyProfile.load,
+ submit: App.ss.MyProfile.submit
+}
+
+ * Load actions can use {@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}.
+ */
+
+ /**
+ * @cfg {Array/String} paramOrder 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:
+paramOrder: ['param1','param2','param3']
+paramOrder: 'param1 param2 param3'
+paramOrder: 'param1,param2,param3'
+paramOrder: 'param1|param2|param'
+
+ */
+
+ /**
+ * @cfg {Boolean} paramsAsHash Only used for the {@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,
+
+ /**
+ * @cfg {String} waitTitle
+ * The default title to show for the waiting message box (defaults to 'Please Wait...')
+ */
+ waitTitle: 'Please Wait...',
+
+ /**
+ * @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,
+
+ /**
+ * @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 options
to {@link #submit}, will be included in the
+ * values submitted in the form.
+ */
+
+ /**
+ * @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.
+ */
+
+
+ // Private
+ wasDirty: false,
+
+
+ /**
+ * Destroys this object.
+ */
+ destroy: function() {
+ this.clearListeners();
+ },
+
+ /**
+ * @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.
+ */
+ 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;
}
- this.hidden = true;
- if(animateTarget !== undefined){
- this.setAnimateTarget(animateTarget);
+
+ if (child.isFormField) {
+ handleField(child);
}
- if(this.modal){
- this.mask.hide();
- Ext.getBody().removeClass('x-body-masked');
+ else if (isContainer) {
+ // Walk down
+ Ext.Array.forEach(child.query('[isFormField]'), handleField);
}
- if(this.animateTarget){
- this.animHide();
- }else{
- this.el.hide();
- this.afterHide();
+
+ // Flush the cached list of formBind components
+ delete this._boundItems;
+
+ // Check form bind, but only after initial add
+ if (me.initialized) {
+ me.onValidityChange(!me.hasInvalidField());
}
- 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();
+ /**
+ * Return all the {@link Ext.form.field.Field} components in the owner container.
+ * @return {Ext.util.MixedCollection} Collection of the Field objects
+ */
+ getFields: function() {
+ var fields = this._fields;
+ if (!fields) {
+ fields = this._fields = Ext.create('Ext.util.MixedCollection');
+ fields.addAll(this.owner.query('[isFormField]'));
}
- this.onHide();
- this.fireEvent('hide', this);
+ return fields;
},
- // 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
- }));
+ getBoundItems: function() {
+ var boundItems = this._boundItems;
+ if (!boundItems) {
+ boundItems = this._boundItems = Ext.create('Ext.util.MixedCollection');
+ boundItems.addAll(this.owner.query('[formBind]'));
+ }
+ return boundItems;
},
/**
- * Method that is called immediately before the show
event is fired.
- * Defaults to Ext.emptyFn
.
+ * 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.
*/
- onShow : Ext.emptyFn,
+ hasInvalidField: function() {
+ return !!this.getFields().findBy(function(field) {
+ var preventMark = field.preventMark,
+ isValid;
+ field.preventMark = true;
+ isValid = field.isValid();
+ field.preventMark = preventMark;
+ return !isValid;
+ });
+ },
/**
- * Method that is called immediately before the hide
event is fired.
- * Defaults to Ext.emptyFn
.
+ * 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
*/
- onHide : Ext.emptyFn,
+ isValid: function() {
+ var me = this,
+ invalid;
+ me.batchLayouts(function() {
+ invalid = me.getFields().filterBy(function(field) {
+ return !field.validate();
+ });
+ });
+ return invalid.length < 1;
+ },
- // private
- onWindowResize : function(){
- if(this.maximized){
- this.fitContainer();
+ /**
+ * 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.
+ */
+ checkValidity: function() {
+ var me = this,
+ valid = !me.hasInvalidField();
+ if (valid !== me.wasValid) {
+ me.onValidityChange(valid);
+ me.fireEvent('validitychange', me, valid);
+ me.wasValid = valid;
}
- 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));
+ },
+
+ /**
+ * @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);
+ }
+ });
}
- this.doConstrain();
},
- // 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)
- };
- }
+ /**
+ * 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
+ */
+ isDirty: function() {
+ return !!this.getFields().findBy(function(f) {
+ return f.isDirty();
+ });
+ },
- var xy = this.el.getConstrainToXY(this.container, true, offsets);
- if(xy){
- this.setPosition(xy[0], xy[1]);
- }
+ /**
+ * 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;
}
},
- // 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;
+ /**
+ * 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();
+ });
},
- // private
- unghost : function(show, matchPosition){
- if(!this.activeGhost) {
- return;
- }
- 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);
- }
+ /**
+ * 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):
+ *
+ * - url : StringThe url for the action (defaults
+ * to the form's {@link #url}.)
+ *
+ * - method : StringThe 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 : ObjectRequest headers to set for the action.
+ *
+ * - success : FunctionThe 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 : FunctionThe 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 : ObjectThe scope in which to call the
+ * callback functions (The this reference for the callback functions).
+ *
+ * - clientValidation : BooleanSubmit 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.
+ *
+ * @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(matchPosition !== false){
- this.setPosition(this.activeGhost.getLeft(true), this.activeGhost.getTop(true));
+ if (this.fireEvent('beforeaction', this, action) !== false) {
+ this.beforeAction(action);
+ Ext.defer(action.run, 100, action);
}
- this.activeGhost.hide();
- this.activeGhost.remove();
- delete this.activeGhost;
+ return this;
+ },
+
+ /**
+ * 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).
+ * The following code:
+myFormPanel.getForm().submit({
+ clientValidation: true,
+ url: 'updateConsignment.php',
+ params: {
+ newStatus: 'delivered'
+ },
+ success: function(form, action) {
+ Ext.Msg.alert('Success', action.result.msg);
+ },
+ 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);
+ }
+ }
+});
+
+ * would process the following server response for a successful submission:
+{
+ "success":true, // note this is Boolean, not string
+ "msg":"Consignment updated"
+}
+
+ * and the following server response for a failed submission:
+{
+ "success":false, // note this is Boolean, not string
+ "msg":"You do not have permission to perform this operation"
+}
+
+ * @return {Ext.form.Basic} this
+ */
+ submit: function(options) {
+ return this.doAction(this.standardSubmit ? 'standardsubmit' : this.api ? 'directsubmit' : 'submit', options);
},
/**
- * 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
+ * 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
*/
- minimize : function(){
- this.fireEvent('minimize', this);
- return this;
+ load: function(options) {
+ return this.doAction(this.api ? 'directload' : 'load', options);
},
/**
- * 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}.
+ * 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
*/
- close : function(){
- if(this.fireEvent('beforeclose', this) !== false){
- if(this.hidden){
- this.doClose();
- }else{
- this.hide(null, this.doClose, this);
+ 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;
},
- // private
- doClose : function(){
- this.fireEvent('close', this);
- this.destroy();
+ /**
+ * 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
+ */
+ loadRecord: function(record) {
+ this._record = record;
+ return this.setValues(record.data);
+ },
+
+ /**
+ * Returns the last Ext.data.Model instance that was loaded via {@link #loadRecord}
+ * @return {Ext.data.Model} The record
+ */
+ getRecord: function() {
+ return this._record;
},
/**
- * 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
+ * @private
+ * Called before an action is performed via {@link #doAction}.
+ * @param {Ext.form.action.Action} action The Action instance that was invoked
*/
- 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();
- }
- this.maximized = true;
- this.el.disableShadow();
+ beforeAction: function(action) {
+ var waitMsg = action.waitMsg,
+ maskCls = Ext.baseCSSPrefix + 'mask-loading',
+ waitMsgTarget;
- if(this.dd){
- this.dd.lock();
- }
- if(this.collapsible){
- this.tools.toggle.hide();
+ // Call HtmlEditor's syncValue before actions
+ this.getFields().each(function(f) {
+ if (f.isFormField && f.syncValue) {
+ f.syncValue();
}
- this.el.addClass('x-window-maximized');
- this.container.addClass('x-window-maximized-ct');
+ });
- this.setPosition(0, 0);
- this.fitContainer();
- this.fireEvent('maximize', this);
+ 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);
+ }
}
- 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);
-
- if(this.dd){
- this.dd.unlock();
+ * @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();
}
- if(this.collapsible && t.toggle){
- t.toggle.show();
+ }
+ if (success) {
+ if (action.reset) {
+ this.reset();
}
- this.container.removeClass('x-window-maximized-ct');
-
- this.doConstrain();
- this.fireEvent('restore', this);
+ 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 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
+ * 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.
*/
- toggleMaximize : function(){
- return this[this.maximized ? 'restore' : 'maximize']();
+ findField: function(id) {
+ return this.getFields().findBy(function(f) {
+ return f.id === id || f.getName() === id;
+ });
},
- // private
- fitContainer : function(){
- var vs = this.container.getViewSize(false);
- this.setSize(vs.width, vs.height);
- },
- // 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);
- }
- this.el.setZIndex(++index);
- index += 5;
+ /**
+ * Mark fields in this form invalid in bulk.
+ * @param {Array/Object} errors Either an array in the form [{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;
- if(this.resizer){
- this.resizer.proxy.setStyle('z-index', ++index);
+ function mark(fieldId, msg) {
+ var field = me.findField(fieldId);
+ if (field) {
+ field.markInvalid(msg);
+ }
}
- this.lastZIndex = index;
+ 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);
+ }
+ return this;
},
/**
- * 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
+ * Set values for fields in this form in bulk.
+ * @param {Array/Object} values Either an array in the form:
+[{id:'clientName', value:'Fred. Olsen Lines'},
+ {id:'portOfLoading', value:'FXT'},
+ {id:'portOfDischarge', value:'OSL'} ]
+ * or an object hash of the form:
+{
+ clientName: 'Fred. Olsen Lines',
+ portOfLoading: 'FXT',
+ portOfDischarge: 'OSL'
+}
+ * @return {Ext.form.Basic} this
*/
- alignTo : function(element, position, offsets){
- var xy = this.el.getAlignToXY(element, position, offsets);
- this.setPagePosition(xy[0], xy[1]);
- return this;
- },
+ setValues: function(values) {
+ var me = this;
- /**
- * 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
- };
+ function setVal(fieldId, val) {
+ var field = me.findField(fieldId);
+ if (field) {
+ field.setValue(val);
+ if (me.trackResetOnLoad) {
+ field.resetOriginalValue();
+ }
+ }
+ }
- 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});
+ 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.doAnchor();
+ return this;
},
/**
- * Performs the anchor, using the saved anchorTarget property.
- * @return {Ext.Window} this
- * @private
+ * 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}
*/
- doAnchor : function(){
- var o = this.anchorTarget;
- this.alignTo(o.el, o.alignment, o.offsets);
- return this;
+ getValues: function(asString, dirtyOnly, includeEmptyText, useDataValues) {
+ var values = {};
+
+ 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;
+ }
+ });
+ }
+ }
+ });
+
+ if (asString) {
+ values = Ext.Object.toQueryString(values);
+ }
+ return values;
},
/**
- * Removes any existing anchor from this window. See {@link #anchorTo}.
- * @return {Ext.Window} this
+ * 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}
*/
- clearAnchor : function(){
- if(this.anchorTarget){
- Ext.EventManager.removeResizeListener(this.doAnchor, this);
- Ext.EventManager.un(window, 'scroll', this.doAnchor, this);
- delete this.anchorTarget;
- }
- return this;
+ getFieldValues: function(dirtyOnly) {
+ return this.getValues(false, dirtyOnly, false, true);
},
/**
- * 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
+ * Clears all invalid field messages in this form.
+ * @return {Ext.form.Basic} this
*/
- toFront : function(e){
- if(this.manager.bringToFront(this)){
- if(!e || !e.getTarget().focus){
- this.focus();
- }
- }
- return this;
+ clearInvalid: function() {
+ var me = this;
+ me.batchLayouts(function() {
+ me.getFields().each(function(f) {
+ f.clearInvalid();
+ });
+ });
+ return me;
},
/**
- * 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)
+ * Resets all fields in this form.
+ * @return {Ext.form.Basic} 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);
- }
+ reset: function() {
+ var me = this;
+ me.batchLayouts(function() {
+ me.getFields().each(function(f) {
+ f.reset();
+ });
+ });
+ return me;
},
/**
- * Sends this window to the back of (lower z-index than) any other visible windows
- * @return {Ext.Window} this
+ * 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
*/
- toBack : function(){
- this.manager.sendToBack(this);
+ applyToFields: function(obj) {
+ this.getFields().each(function(f) {
+ Ext.apply(f, obj);
+ });
return this;
},
/**
- * Centers this window in the viewport
- * @return {Ext.Window} this
+ * 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
*/
- center : function(){
- var xy = this.el.getAlignToXY(this.container, 'c-c');
- this.setPagePosition(xy[0], xy[1]);
+ applyIfToFields: function(obj) {
+ this.getFields().each(function(f) {
+ Ext.applyIf(f, obj);
+ });
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])});
- }
- },
- b4Drag : Ext.emptyFn,
-
- onDrag : function(e){
- this.alignElWithMouse(this.proxy, e.getPageX(), e.getPageY());
},
- endDrag : function(e){
- this.win.unghost();
- this.win.saveState();
- }
-});
-/**
- * @class Ext.WindowGroup
- * An object that manages a group of {@link Ext.Window} instances and provides z-order management
- * and window activation behavior.
- * @constructor
- */
-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:
-var msgWin = Ext.MessageBox.getDialog();
-MyDesktop.getDesktop().getManager().register(msgWin);
-
- * @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);
- },
-
- /**
- * 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;
- },
-
- /**
- * 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;
- },
-
- /**
- * Hides all windows in this WindowGroup.
- */
- hideAll : function(){
- for(var id in list){
- if(list[id] && typeof list[id] != "function" && list[id].isVisible()){
- list[id].hide();
- }
- }
- },
-
- /**
- * Gets the currently-active window in this WindowGroup.
- * @return {Ext.Window} The active window
- */
- getActive : function(){
- return front;
- },
-
- /**
- * 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;
- },
-
- /**
- * 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;
- }
- }
- }
- }
- };
-};
-
-
-/**
- * @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 the function
parameter for {@link #show} for more details).
- * 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,
- animEl: 'elId',
- icon: Ext.MessageBox.QUESTION
-});
-
- * @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
+ * 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
+ */
+ batchLayouts: function(fn) {
+ var me = this,
+ suspended = new Ext.util.HashMap();
- // 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();
+ // 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;
}
});
- 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:'
'
- });
- 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;
- },
- /**
- * 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();
- },
+ // Invoke the function
+ fn();
- /**
- * 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;
- },
+ // Un-suspend the container layouts
+ suspended.each(function(id, ct) {
+ ct.suspendLayout = ct.oldSuspendLayout;
+ delete ct.oldSuspendLayout;
+ });
- /**
- * 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:
- * - animEl : String/ElementAn id or Element from which the message box should animate as it
- * opens and closes (defaults to undefined)
- * - buttons : Object/BooleanA button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo',
- * cancel:'Bar'}), or false to not show any buttons (defaults to false)
- * - closable : BooleanFalse 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 : StringA custom CSS class to apply to the message box's container element
- * - defaultTextHeight : NumberThe default height in pixels of the message box's multiline textarea
- * if displayed (defaults to 75)
- * - fn : FunctionA 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 : StringThe ID of the button pressed, one of:
- * - ok
- * - yes
- * - no
- * - cancel
- *
- * - text : String
- * - opt : ObjectThe config object passed to show.
- *
- * - scope : ObjectThe scope of the callback function
- * - icon : StringA 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 : StringThe standard {@link Ext.Window#iconCls} to
- * add an optional header icon (defaults to '')
- * - maxWidth : NumberThe maximum width in pixels of the message box (defaults to 600)
- * - minWidth : NumberThe minimum width in pixels of the message box (defaults to 100)
- * - modal : BooleanFalse to allow user interaction with the page while the message box is
- * displayed (defaults to true)
- * - msg : StringA 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 : BooleanTrue to display a progress bar (defaults to false)
- * - progressText : StringThe text to display inside the progress bar if progress = true (defaults to '')
- * - prompt : BooleanTrue to prompt the user to enter single-line text (defaults to false)
- * - proxyDrag : BooleanTrue to display a lightweight proxy while dragging (defaults to false)
- * - title : StringThe title text
- * - value : StringThe string value to set into the active textbox element if displayed
- * - wait : BooleanTrue to display a progress bar (defaults to false)
- * - waitConfig : ObjectA {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)
- * - width : NumberThe width of the dialog in pixels
- *
- * Example usage:
- *
-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
+ // Trigger a single layout
+ me.owner.doComponentLayout();
+ }
});
-
- * @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(Ext.isDefined(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:
- *
-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;
- },
-
- /**
- * 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;
- },
-
- /**
- * 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;
- },
-
- /**
- * 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;
- },
- /**
- * 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;
- },
+/**
+ * @class Ext.form.FieldAncestor
- /**
- * 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;
- },
+A mixin for {@link Ext.container.Container} components that are likely to have form fields in their
+items subtree. Adds the following capabilities:
- /**
- * 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',
+- 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.
- /**
- * 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"
- }
- };
-}();
+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.
-/**
- * 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
+ * @markdown
+ * @docauthor Jason Johnston
*/
-Ext.dd.PanelProxy = function(panel, config){
- this.panel = panel;
- this.id = this.panel.id +'-ddproxy';
- Ext.apply(this, config);
-};
-
-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).
+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.
*/
- insertProxy : true,
- // private overrides
- setStatus : Ext.emptyFn,
- reset : Ext.emptyFn,
- update : Ext.emptyFn,
- stop : Ext.emptyFn,
- sync: Ext.emptyFn,
/**
- * Gets the proxy's element
- * @return {Element} The proxy's element
+ * @protected Initializes the FieldAncestor's state; this must be called from the initComponent method
+ * of any components importing this mixin.
*/
- getEl : function(){
- return this.ghost;
- },
+ initFieldAncestor: function() {
+ var me = this,
+ onSubtreeChange = me.onFieldAncestorSubtreeChange;
- /**
- * Gets the proxy's ghost element
- * @return {Element} The proxy's ghost element
- */
- getGhost : function(){
- return this.ghost;
- },
+ 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',
- /**
- * Gets the proxy's element
- * @return {Element} The proxy's element
- */
- getProxy : function(){
- return this.proxy;
+ /**
+ * @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();
},
/**
- * Hides the proxy
+ * @private Initialize the {@link #fieldDefaults} object
*/
- 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;
+ initFieldDefaults: function() {
+ if (!this.fieldDefaults) {
+ this.fieldDefaults = {};
}
},
/**
- * Shows the proxy
+ * @private
+ * Handle the addition and removal of components in the FieldAncestor component's child tree.
*/
- 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());
+ 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.panel.el.dom.style.display = 'none';
- }
- },
-
- // private
- repair : function(xy, callback, scope){
- this.hide();
- if(typeof callback == "function"){
- callback.call(scope || this);
}
+ handleCmp(child);
},
/**
- * 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)
+ * @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
*/
- moveProxy : function(parentNode, before){
- if(this.proxy){
- parentNode.insertBefore(this.proxy.dom, before);
- }
- }
-};
+ onLabelableAdded: function(labelable) {
+ var me = this;
-// 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;
-};
+ // buffer slightly to avoid excessive firing while sub-fields are changing en masse
+ me.mon(labelable, 'errorchange', me.handleFieldErrorChange, me, {buffer: 10});
-Ext.extend(Ext.Panel.DD, Ext.dd.DragSource, {
- showFrame: Ext.emptyFn,
- startDrag: Ext.emptyFn,
- b4StartDrag: function(x, y) {
- this.proxy.show();
- },
- b4MouseDown: function(e) {
- var x = e.getPageX();
- var y = e.getPageY();
- this.autoOffset(x, y);
- },
- onInitDrag : function(x, y){
- this.onStartDrag(x, y);
- return true;
- },
- createFrame : Ext.emptyFn,
- getDragEl : function(e){
- return this.proxy.ghost.dom;
- },
- endDrag : function(e){
- this.proxy.hide();
- this.panel.saveState();
+ labelable.setFieldDefaults(me.fieldDefaults);
},
- 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 = Ext.extend(Ext.util.Observable, {
-
- constructor : 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
- */
- this.addEvents("statechange");
- this.state = {};
- Ext.state.Provider.superclass.constructor.call(this);
+ /**
+ * @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
+ */
+ onFieldAdded: function(field) {
+ var me = this;
+ me.mon(field, 'validitychange', me.handleFieldValidityChange, me);
},
-
+
/**
- * 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
+ * @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
*/
- get : function(name, defaultValue){
- return typeof this.state[name] == "undefined" ?
- defaultValue : this.state[name];
+ onLabelableRemoved: function(labelable) {
+ var me = this;
+ me.mun(labelable, 'errorchange', me.handleFieldErrorChange, me);
},
/**
- * Clears a value from the state
- * @param {String} name The key name
+ * @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
*/
- clear : function(name){
- delete this.state[name];
- this.fireEvent("statechange", this, name, null);
+ onFieldRemoved: function(field) {
+ var me = this;
+ me.mun(field, 'validitychange', me.handleFieldValidityChange, me);
},
/**
- * Sets the value for a key
- * @param {String} name The key name
- * @param {Mixed} value The value to set
+ * @private Handle validitychange events on sub-fields; invoke the aggregated event and method
*/
- set : function(name, value){
- this.state[name] = value;
- this.fireEvent("statechange", this, name, value);
+ handleFieldValidityChange: function(field, isValid) {
+ var me = this;
+ me.fireEvent('fieldvaliditychange', me, field, isValid);
+ me.onFieldValidityChange();
},
/**
- * Decodes a string previously encoded with {@link #encodeValue}.
- * @param {String} value The value to decode
- * @return {Mixed} The decoded value
+ * @private Handle errorchange events on sub-fields; invoke the aggregated event and method
*/
- decodeValue : function(cookie){
- /**
- * a -> Array
- * n -> Number
- * d -> Date
- * b -> Boolean
- * s -> String
- * o -> Object
- * -> Empty (null)
- */
- var re = /^(a|n|d|b|s|o|e)\:(.*)$/,
- matches = re.exec(unescape(cookie)),
- all,
- type,
- v,
- kv;
- if(!matches || !matches[1]){
- return; // non state cookie
- }
- type = matches[1];
- v = matches[2];
- switch(type){
- case 'e':
- return null;
- case 'n':
- return parseFloat(v);
- case 'd':
- return new Date(Date.parse(v));
- case 'b':
- return (v == '1');
- case 'a':
- all = [];
- if(v != ''){
- Ext.each(v.split('^'), function(val){
- all.push(this.decodeValue(val));
- }, this);
- }
- return all;
- case 'o':
- all = {};
- if(v != ''){
- Ext.each(v.split('^'), function(val){
- kv = val.split('=');
- all[kv[0]] = this.decodeValue(kv[1]);
- }, this);
- }
- return all;
- default:
- return v;
- }
+ handleFieldErrorChange: function(labelable, activeError) {
+ var me = this;
+ me.fireEvent('fielderrorchange', me, labelable, activeError);
+ me.onFieldErrorChange();
},
/**
- * Encodes a value including type information. Decode with {@link #decodeValue}.
- * @param {Mixed} value The value to encode
- * @return {String} The encoded value
+ * @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
*/
- encodeValue : function(v){
- var enc,
- flat = '',
- i = 0,
- len,
- key;
- if(v == null){
- return 'e:1';
- }else 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)){
- for(len = v.length; i < len; i++){
- flat += this.encodeValue(v[i]);
- if(i != len - 1){
- flat += '^';
- }
- }
- enc = 'a:' + flat;
- }else if(typeof v == 'object'){
- for(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;
- }
- return escape(enc);
- }
+ onFieldValidityChange: Ext.emptyFn,
+
+ /**
+ * @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
+
});
/**
- * @class Ext.state.Manager
- * This is the global state manager. By default all components that are "state aware" check this class
- * for state information if you don't pass them a custom state provider. In order for this class
- * to be useful, it must be initialized with a provider when your application initializes. Example usage:
-
-// in your initialization function
-init : function(){
- Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
- var win = new Window(...);
- win.restoreState();
-}
-
- * @singleton
+ * @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.state.Manager = function(){
- var provider = new Ext.state.Provider();
-
- 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);
- },
-
- /**
- * 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);
- },
+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();
+ });
- /**
- * Clears a value from the state
- * @param {String} name The key name
- */
- clear : function(key){
- provider.clear(key);
- },
+ // 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());
+ }
+ while (shadowItems.length < numCols) {
+ shadowCt.add({
+ xtype: 'container',
+ cls: owner.groupCls,
+ flex: 1
+ });
+ }
- /**
- * Gets the currently configured state provider
- * @return {Provider} The state provider
- */
- getProvider : function(){
- return provider;
+ 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));
+ }
}
- };
-}();
-/**
- * @class Ext.state.CookieProvider
- * @extends Ext.state.Provider
- * The default Provider implementation which saves state via cookies.
- *
Usage:
-
- 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);
-
- * @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 = Ext.extend(Ext.state.Provider, {
-
- constructor : 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();
- },
-
- // private
- set : function(name, value){
- if(typeof value == "undefined" || value === null){
- this.clear(name);
- return;
+
+ 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());
+ });
}
- this.setCookie(name, value);
- Ext.state.CookieProvider.superclass.set.call(this, name, value);
- },
- // private
- clear : function(name){
- this.clearCookie(name);
- Ext.state.CookieProvider.superclass.clear.call(this, name);
+ shadowCt.doComponentLayout();
},
- // private
- readCookies : function(){
- var cookies = {},
- c = document.cookie + ";",
- re = /\s?(.*?)=(.*?);/g,
- matches,
- name,
- value;
- while((matches = re.exec(c)) != null){
- name = matches[1];
- value = matches[2];
- if(name && name.substring(0,3) == "ys-"){
- cookies[name.substr(3)] = this.decodeValue(value);
+
+ // We don't want to render any items to the owner directly, that gets handled by each column's own layout
+ renderItems: Ext.emptyFn,
+
+
+ /**
+ * @private
+ * Creates and returns the shadow hbox container that will be used to arrange the owner's items
+ * into columns.
+ */
+ 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 cookies;
+
+ return shadowCt;
},
- // 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" : "");
- },
- // 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" : "");
+ /**
+ * @private Get the number of columns in the checkbox group
+ */
+ getColCount: function() {
+ var owner = this.owner,
+ colsCfg = owner.columns;
+ return Ext.isArray(colsCfg) ? colsCfg.length : (Ext.isNumber(colsCfg) ? colsCfg : owner.items.length);
}
-});/**
- * @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.
- *
- * The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.Panel}.
- *
-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 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>'
-);
+/**
+ * @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()
+ });
-var panel = new Ext.Panel({
- id:'images-view',
- frame:true,
- width:535,
- autoHeight:true,
- collapsible:true,
- layout:'fit',
- title:'Simple DataView',
- 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);
-
* @constructor
- * Create a new DataView
- * @param {Object} config The config object
- * @xtype dataview
+ * Creates a new Ext.form.FieldContainer instance.
+ * @param {Object} config The component configuration.
+ *
+ * @xtype fieldcontainer
+ * @markdown
+ * @docauthor Jason Johnston
*/
-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.
- */
- /**
- * @cfg {String} selectedClass
- * A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').
- */
- selectedClass : "x-view-selected",
+Ext.define('Ext.form.FieldContainer', {
+ extend: 'Ext.container.Container',
+ mixins: {
+ labelable: 'Ext.form.Labelable',
+ fieldAncestor: 'Ext.form.FieldAncestor'
+ },
+ alias: 'widget.fieldcontainer',
+
+ componentLayout: 'field',
+
/**
- * @cfg {String} emptyText
- * The text to display in the view when there is no data to display (defaults to '').
+ * @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.
*/
- emptyText : "",
+ combineLabels: false,
/**
- * @cfg {Boolean} deferEmptyText True to defer emptyText being applied until the store's first load
+ * @cfg {String} labelConnector
+ * The string to use when joining the labels of individual sub-fields, when {@link #combineLabels} is
+ * set to true. Defaults to ', '.
*/
- deferEmptyText: true,
+ labelConnector: ', ',
+
/**
- * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
+ * @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.
*/
- trackOver: false,
+ combineErrors: false,
- /**
- * @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)
- */
- blockRefresh: false,
-
- //private
- last: false,
+ maskOnDisable: false,
- // 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);
- }
+ initComponent: function() {
+ var me = this,
+ onSubCmpAddOrRemove = me.onSubCmpAddOrRemove;
- 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",
+ // Init mixins
+ me.initLabelable();
+ me.initFieldAncestor();
- /**
- * @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"
- );
+ me.callParent();
+ },
- this.store = Ext.StoreMgr.lookup(this.store);
- this.all = new Ext.CompositeElementLite();
- this.selected = new Ext.CompositeElementLite();
+ /**
+ * @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;
+ me.mixins.fieldAncestor.onLabelableAdded.call(this, labelable);
+ me.updateLabel();
},
- // private
- afterRender : function(){
- Ext.DataView.superclass.afterRender.call(this);
+ /**
+ * @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
+ */
+ onLabelableRemoved: function(labelable) {
+ var me = this;
+ me.mixins.fieldAncestor.onLabelableRemoved.call(this, labelable);
+ me.updateLabel();
+ },
- this.mon(this.getTemplateTarget(), {
- "click": this.onClick,
- "dblclick": this.onDblClick,
- "contextmenu": this.onContextMenu,
- scope:this
- });
+ onRender: function() {
+ var me = this,
+ renderSelectors = me.renderSelectors,
+ applyIf = Ext.applyIf;
- if(this.overClass || this.trackOver){
- this.mon(this.getTemplateTarget(), {
- "mouseover": this.onMouseOver,
- "mouseout": this.onMouseOut,
- scope:this
- });
- }
+ applyIf(renderSelectors, me.getLabelableSelectors());
- if(this.store){
- this.bindStore(this.store, true);
- }
+ me.callParent(arguments);
},
- /**
- * 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);
+ initRenderTpl: function() {
+ var me = this;
+ if (!me.hasOwnProperty('renderTpl')) {
+ me.renderTpl = me.getTpl('labelableRenderTpl');
}
- this.hasSkippedEmptyText = true;
+ return me.callParent();
},
- getTemplateTarget: function(){
- return this.el;
+ initRenderData: function() {
+ return Ext.applyIf(this.callParent(), this.getLabelableRenderData());
},
/**
- * 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'}))
+ * 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.
*/
- prepareData : function(data){
- return data;
+ 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);
+ }
+ return label;
},
/**
- * 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 Updates the content of the labelEl if it is rendered
*/
- 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]);
+ updateLabel: function() {
+ var me = this,
+ label = me.labelEl;
+ if (label) {
+ label.update(me.getFieldLabel());
}
- 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];
+ /**
+ * @private Fired when the error message of any field within the container changes, and updates the
+ * combined error message to match.
+ */
+ 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);
- this.all.replaceElement(index, node, true);
- if(sel){
- this.selected.replaceElement(original, node);
- this.all.item(index).addClass(this.selectedClass);
+ if (newErrors) {
+ me.setActiveErrors(newErrors);
+ } else {
+ me.unsetActiveError();
+ }
+
+ if (oldError !== me.getActiveError()) {
+ me.doComponentLayout();
}
- this.updateIndexes(index, index);
}
},
- // 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);
+ /**
+ * 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
+ */
+ 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;
},
- // private
- onRemove : function(ds, record, index){
- this.deselect(index);
- this.all.removeElement(index, true);
- this.updateIndexes(index);
- if (this.store.getCount() === 0){
- this.refresh();
- }
+ getTargetEl: function() {
+ return this.bodyEl || this.callParent();
+ }
+});
+
+/**
+ * @class Ext.form.CheckboxGroup
+ * @extends Ext.form.FieldContainer
+ * 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.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'}
+ ]
+ }]
+ });
+ *
+ * @constructor
+ * Creates a new CheckboxGroup
+ * @param {Object} config Configuration options
+ * @xtype checkboxgroup
+ */
+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'],
/**
- * Refreshes an individual node's data from the store.
- * @param {Number} index The item's data index in the store
+ * @cfg {String} name
+ * @hide
*/
- refreshNode : function(index){
- this.onUpdate(this.store, this.store.getAt(index));
- },
- // 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
+ * @cfg {Array} items An Array of {@link Ext.form.field.Checkbox Checkbox}es or Checkbox config objects
+ * to arrange in the group.
+ */
+
+ /**
+ * @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:
+ * - '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.
*/
- getStore : function(){
- return this.store;
- },
+ columns : 'auto',
/**
- * Changes the data store bound to this view and refreshes it.
- * @param {Store} store The store to bind to this view
+ * @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.
*/
- 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();
- }
- },
-
+ vertical : false,
+
/**
- * @private
- * Calls this.refresh if this.blockRefresh is not 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.
*/
- onDataChanged: function() {
- if (this.blockRefresh !== true) {
- this.refresh.apply(this, arguments);
- }
- },
+ allowBlank : true,
/**
- * 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
+ * @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")
*/
- findItemFromChild : function(node){
- return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget());
- },
+ blankText : "You must select at least one item in this group",
// 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);
- }
- }
- },
-
- onContainerClick : function(e){
- this.clearSelections();
- },
+ defaultType : 'checkboxfield',
// 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);
- }
- },
+ groupCls : Ext.baseCSSPrefix + 'form-check-group',
- // private
- onDblClick : function(e){
- var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
- if(item){
- this.fireEvent("dblclick", this, this.indexOf(item), item, e);
- }
- },
+ /**
+ * @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'.
+ */
+ fieldBodyCls: Ext.baseCSSPrefix + 'form-checkboxgroup-body',
// 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);
- }
+ layout: 'checkboxgroup',
+
+ initComponent: function() {
+ var me = this;
+ me.callParent();
+ me.initField();
},
- // 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;
- }
+ /**
+ * @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);
}
},
- // 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();
+ /**
+ * @protected
+ * When a checkbox is added to the group, monitor it for changes
+ */
+ onFieldAdded: function(field) {
+ var me = this;
+ if (field.isCheckbox) {
+ me.mon(field, 'change', me.checkChange, me);
}
- return true;
+ me.callParent(arguments);
},
- // private
- doSingleSelection : function(item, index, e){
- if(e.ctrlKey && this.isSelected(index)){
- this.deselect(index);
- }else{
- this.select(index, false);
+ onFieldRemoved: function(field) {
+ var me = this;
+ if (field.isCheckbox) {
+ me.mun(field, 'change', me.checkChange, me);
}
+ me.callParent(arguments);
},
- // 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);
- }
- }
+ // 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);
},
/**
- * Gets the number of selected nodes.
- * @return {Number} The node count
+ * 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
*/
- getSelectionCount : function(){
- return this.selected.getCount();
+ getErrors: function() {
+ var errors = [];
+ if (!this.allowBlank && Ext.isEmpty(this.getChecked())) {
+ errors.push(this.blankText);
+ }
+ return errors;
},
/**
- * Gets the currently selected nodes.
- * @return {Array} An array of HTMLElements
+ * @private Returns all checkbox components within the container
*/
- getSelectedNodes : function(){
- return this.selected.elements;
+ getBoxes: function() {
+ return this.query('[isCheckbox]');
},
/**
- * Gets the indexes of the selected nodes.
- * @return {Array} An array of numeric indexes
+ * @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
*/
- 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;
+ eachBox: function(fn, scope) {
+ Ext.Array.forEach(this.getBoxes(), fn, scope || this);
},
/**
- * Gets an array of the selected records
- * @return {Array} An array of {@link Ext.data.Record} objects
+ * Returns an Array of all checkboxes in the container which are currently checked
+ * @return {Array} Array of Ext.form.field.Checkbox components
*/
- 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;
+ getChecked: function() {
+ return Ext.Array.filter(this.getBoxes(), function(cb) {
+ return cb.getValue();
+ });
},
- /**
- * 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
- */
- 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;
+ // private override
+ isDirty: function(){
+ return Ext.Array.some(this.getBoxes(), function(cb) {
+ return cb.isDirty();
+ });
},
- /**
- * Gets a record from a node
- * @param {HTMLElement} node The node to evaluate
- * @return {Record} record The {@link Ext.data.Record} object
- */
- getRecord : function(node){
- return this.store.getAt(node.viewIndex);
+ // private override
+ setReadOnly: function(readOnly) {
+ this.eachBox(function(cb) {
+ cb.setReadOnly(readOnly);
+ });
+ this.readOnly = readOnly;
},
/**
- * Clears all selections.
- * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event
+ * 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}
*/
- 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);
- }
+ 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();
}
},
- /**
- * 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));
+ // 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);
},
+
/**
- * Deselects a node.
- * @param {HTMLElement/Number/Record} node The node, node index or record to deselect
+ * 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
*/
- 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);
- }
+ 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;
},
+
/**
- * 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
+ * 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.
*/
- 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);
+ 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];
}
+ bucket.push(inputValue);
+ } else {
+ values[name] = inputValue;
}
}
- }
+ });
+ return values;
},
- /**
- * 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
+ /*
+ * Don't return any data for submit; the form will get the info from the individual checkboxes themselves.
*/
- selectRange : function(start, end, keepExisting){
- if(!keepExisting){
- this.clearSelections(true);
- }
- this.select(this.getNodes(start, end), true);
+ getSubmitData: function() {
+ return null;
},
- /**
- * 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
+ /*
+ * Don't return any data for the model; the form will get the info from the individual checkboxes themselves.
*/
- 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];
- }
- return nodeInfo;
+ getModelData: function() {
+ return null;
},
- /**
- * 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
- */
- 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]);
- }
- } else{
- for(i = start; i >= end && ns[i]; i--){
- nodes.push(ns[i]);
- }
- }
- return nodes;
- },
+ validate: function() {
+ var me = this,
+ errors = me.getErrors(),
+ isValid = Ext.isEmpty(errors),
+ wasValid = !me.hasActiveError();
- /**
- * 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
- */
- indexOf : function(node){
- node = this.getNode(node);
- if(Ext.isNumber(node.viewIndex)){
- return node.viewIndex;
+ if (isValid) {
+ me.unsetActiveError();
+ } else {
+ me.setActiveError(errors);
}
- return this.all.indexOf(node);
- },
-
- // private
- onBeforeLoad : function(){
- if(this.loadingText){
- this.clearSelections(false, true);
- this.getTemplateTarget().update(''+this.loadingText+'');
- this.all.clear();
+ if (isValid !== wasValid) {
+ me.fireEvent('validitychange', me, isValid);
+ me.doComponentLayout();
}
- },
- onDestroy : function(){
- this.all.clear();
- this.selected.clear();
- Ext.DataView.superclass.onDestroy.call(this);
- this.bindStore(null);
+ return isValid;
}
+
+}, function() {
+
+ this.borrow(Ext.form.field.Base, ['markInvalid', 'clearInvalid']);
+
});
+
/**
- * 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
+ * @private
+ * Private utility class for managing all {@link Ext.form.field.Checkbox} fields grouped by name.
*/
-Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
+Ext.define('Ext.form.CheckboxManager', {
+ extend: 'Ext.util.MixedCollection',
+ singleton: true,
-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:
- *
-// 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();
+ getByName: function(name) {
+ return this.filterBy(function(item) {
+ return item.name == name;
+ });
+ },
-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'
- }]
-});
+ getWithValue: function(name, value) {
+ return this.filterBy(function(item) {
+ return item.name == name && item.inputValue == value;
+ });
+ },
-// 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
+ getChecked: function(name) {
+ return this.filterBy(function(item) {
+ return item.name == name && item.checked;
+ });
+ }
});
-panel.render(document.body);
-// 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)');
-});
- *
+/**
+ * @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
+ * }]
+ * }]
+ * });
+ *
* @constructor
- * @param {Object} config
- * @xtype listview
+ * Create a new FieldSet
+ * @param {Object} config Configuration options
+ * @xtype fieldset
+ * @docauthor Jason Johnston
*/
-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:
-
- .x-list-selected {background-color: yellow;}
-
- * @type String
- */
- selectedClass:'x-list-selected',
+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} overClass The CSS class applied when over a row (defaults to
- * 'x-list-over'). An example overriding the default styling:
-
- .x-list-over {background-color: orange;}
-
- * @type String
+ * @cfg {String} title
+ * A title to be displayed in the fieldset's legend. May contain HTML markup.
*/
- 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 {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}.
*/
+
/**
- * @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 {String} checkboxName
+ * The name to assign to the fieldset's checkbox if {@link #checkboxToggle} = true
+ * (defaults to '[fieldset id]-checkbox').
*/
- scrollOffset : undefined,
+
/**
- * @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} 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.
*/
- columnResize: true,
+
/**
- * @cfg {Array} columns An array of column configuration objects, for example:
- *
-{
- align: 'right',
- dataIndex: 'size',
- header: 'Size',
- tpl: '{size:fileSize}',
- width: .35
-}
- *
- * Acceptable properties for each column configuration object are:
- *
- * - align : StringSet the CSS text-align property
- * of the column. Defaults to 'left'.
- * - dataIndex : StringSee {@link Ext.grid.Column}.
- * {@link Ext.grid.Column#dataIndex dataIndex} for details.
- * - header : StringSee {@link Ext.grid.Column}.
- * {@link Ext.grid.Column#header header} for details.
- * - tpl : StringSpecify 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 : NumberPercentage 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.
- *
+ * @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,
+
/**
- * @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).
+ * @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.
*/
- columnSort: true,
+
/**
- * @cfg {String/Array} internalTpl
- * The template to be used for the header row. See {@link #tpl} for more details.
+ * @cfg {String} baseCls The base CSS class applied to the fieldset (defaults to 'x-fieldset').
*/
+ baseCls: Ext.baseCSSPrefix + 'fieldset',
- /*
- * IE has issues when setting percentage based widths to 100%. Default to 99.
+ /**
+ * @cfg {String} layout The {@link Ext.container.Container#layout} for the fieldset's immediate child items.
+ * Defaults to 'anchor'.
*/
- maxColumnWidth: Ext.isIE ? 99 : 100,
-
- 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(
- '',
- '',
- '',
- '{header}',
- '',
- ' ',
- '',
- '',
- '',
- ''
- );
- }
- if(!this.tpl){
- this.tpl = new Ext.XTemplate(
- '',
- '',
- '',
- '- ',
- ' class="{cls}
">',
- '{[values.tpl.apply(parent)]}',
- '',
- '
',
- '',
- '',
- ''
- );
- };
+ layout: 'anchor',
- var cs = this.columns,
- allocatedWidth = 0,
- colsWithWidth = 0,
- len = cs.length,
- columns = [];
+ componentLayout: 'fieldset',
- 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);
- }
+ // No aria role necessary as fieldset has its own recognized semantics
+ ariaRole: '',
- cs = this.columns = columns;
+ renderTpl: [''],
+
+ maskOnDisable: false,
- // auto calculate missing column widths
- if(colsWithWidth < len){
- var remaining = len - colsWithWidth;
- if(allocatedWidth < this.maxColumnWidth){
- var perCol = ((this.maxColumnWidth-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);
+ getElConfig: function(){
+ return {tag: 'fieldset', id: this.id};
},
- onRender : function(){
- this.autoEl = {
- cls: 'x-list-wrap'
- };
- Ext.list.ListView.superclass.onRender.apply(this, arguments);
+ initComponent: function() {
+ var me = this,
+ baseCls = me.baseCls;
+
+ me.callParent();
- this.internalTpl.overwrite(this.el, {columns: this.columns});
+ // Create the Legend component if needed
+ me.initLegend();
- this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild);
- this.innerHd = Ext.get(this.el.dom.firstChild.firstChild);
+ // Add body el selector
+ Ext.applyIf(me.renderSelectors, {
+ body: '.' + baseCls + '-body'
+ });
- if(this.hideHeaders){
- this.el.dom.firstChild.style.display = 'none';
+ if (me.collapsed) {
+ me.addCls(baseCls + '-collapsed');
+ me.collapse();
}
},
- getTemplateTarget : function(){
- return this.innerBody;
+ // private
+ onRender: function(container, position) {
+ this.callParent(arguments);
+ // Make sure the legend is created and rendered
+ this.initLegend();
},
/**
- * 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:
- *
- * - columns : StringSee {@link #columns}
- * - rows : StringSee
- * {@link Ext.DataView}.{@link Ext.DataView#collectData collectData}
- *
- * @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.
+ * @private
+ * Initialize and render the legend component if necessary
*/
- collectData : function(){
- var rs = Ext.list.ListView.superclass.collectData.apply(this, arguments);
- return {
- columns: this.columns,
- rows: rs
- }
- },
+ initLegend: function() {
+ var me = this,
+ legendItems,
+ legend = me.legend;
- verifyInternalSize : function(){
- if(this.lastSize){
- this.onResize(this.lastSize.width, this.lastSize.height);
- }
- },
+ // Create the legend component if needed and it hasn't been already
+ if (!legend && (me.title || me.checkboxToggle || me.collapsible)) {
+ legendItems = [];
- // 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';
- }
- }, 10);
+ // Checkbox
+ if (me.checkboxToggle) {
+ legendItems.push(me.createCheckboxCmp());
}
+ // Toggle button
+ else if (me.collapsible) {
+ legendItems.push(me.createToggleCmp());
+ }
+
+ // Title
+ legendItems.push(me.createTitleCmp());
+
+ legend = me.legend = Ext.create('Ext.container.Container', {
+ baseCls: me.baseCls + '-header',
+ ariaRole: '',
+ getElConfig: function(){
+ return {tag: 'legend', cls: this.baseCls};
+ },
+ items: legendItems
+ });
}
- if(Ext.isNumber(h)){
- bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px';
+
+ // 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
}
},
- updateIndexes : function(){
- Ext.list.ListView.superclass.updateIndexes.apply(this, arguments);
- this.verifyInternalSize();
+ /**
+ * @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;
+
},
- 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;
+ /**
+ * @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.
+ */
+
+ /**
+ * @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
+ */
+ 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 -1;
+ });
+ return me.checkboxCmp;
},
- 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) + '%';
- }
- }
-});
-
-Ext.reg('listview', Ext.list.ListView);
+ /**
+ * @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.
+ */
-// 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
- * if isColumn
is not set ListView will recreate a new Ext.list.Column
- * Defaults to true.
+ * @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
*/
- isColumn: true,
+ createToggleCmp: function() {
+ var me = this;
+ me.toggleCmp = Ext.create('Ext.panel.Tool', {
+ type: 'toggle',
+ handler: me.toggle,
+ scope: me
+ });
+ return me.toggleCmp;
+ },
/**
- * @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: '',
+ * Sets the title of this fieldset
+ * @param {String} title The new title
+ * @return {Ext.form.FieldSet} this
+ */
+ 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 {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,
+ * @private
+ * Include the legend component in the items for ComponentQuery
+ */
+ 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 {String} cls Optional. This option can be used to add a CSS class to the cell of each
- * row for this column.
+ * Expands the fieldset.
+ * @return {Ext.form.FieldSet} this
*/
- cls: '',
+ expand : function(){
+ return this.setExpanded(true);
+ },
/**
- * @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.
+ * Collapses the fieldset.
+ * @return {Ext.form.FieldSet} this
*/
+ collapse : function() {
+ return this.setExpanded(false);
+ },
/**
- * @cfg {String} dataIndex Required. 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.
+ * @private Collapse or expand the fieldset
*/
-
- 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);
+ setExpanded: function(expanded) {
+ var me = this,
+ checkboxCmp = me.checkboxCmp,
+ toggleCmp = me.toggleCmp;
+
+ expanded = !!expanded;
+
+ if (checkboxCmp) {
+ checkboxCmp.setValue(expanded);
}
- Ext.apply(this, c);
- }
-});
-
-Ext.reg('lvcolumn', Ext.list.Column);
+ if (expanded) {
+ me.removeCls(me.baseCls + '-collapsed');
+ } else {
+ me.addCls(me.baseCls + '-collapsed');
+ }
+ me.collapsed = !expanded;
+ me.doComponentLayout();
+ return me;
+ },
-/**
- * @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.
- */
-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);
- }
-});
+ * Toggle the fieldset's collapsed state to the opposite of what it is currently
+ */
+ toggle: function() {
+ this.setExpanded(!!this.collapsed);
+ },
-Ext.reg('lvnumbercolumn', Ext.list.NumberColumn);
+ /**
+ * @private Handle changes in the checkbox checked state
+ */
+ onCheckChange: function(cmp, checked) {
+ this.setExpanded(checked);
+ },
-/**
- * @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);
+ beforeDestroy : function() {
+ var legend = this.legend;
+ if (legend) {
+ legend.destroy();
+ }
+ this.callParent();
}
});
-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.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'
+ }]
+ });
+
+ * @constructor
+ * Creates a new Label component.
+ * @param {Ext.core.Element/String/Object} config The configuration options.
+ *
+ * @xtype label
+ * @markdown
+ * @docauthor Jason Johnston
*/
-Ext.list.BooleanColumn = Ext.extend(Ext.list.Column, {
+Ext.define('Ext.form.Label', {
+ extend:'Ext.Component',
+ alias: 'widget.label',
+ requires: ['Ext.util.Format'],
+
/**
- * @cfg {String} trueText
- * The string returned by the renderer when the column value is not falsey (defaults to 'true').
+ * @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.
*/
- trueText: 'true',
/**
- * @cfg {String} falseText
- * The string returned by the renderer when the column value is falsey (but not undefined) (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.
*/
- falseText: 'false',
/**
- * @cfg {String} undefinedText
- * The string returned by the renderer when the column value is undefined (defaults to ' ').
+ * @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.
*/
- 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;
+ 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 || '')
};
+ },
+
+ /**
+ * 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
+ */
+ setText : function(text, encode){
+ var me = this;
- Ext.list.DateColumn.superclass.constructor.call(this, c);
+ encode = encode !== false;
+ if(encode) {
+ me.text = text;
+ delete me.html;
+ } else {
+ me.html = text;
+ delete me.text;
+ }
+
+ if(me.rendered){
+ me.el.dom.innerHTML = encode !== false ? Ext.util.Format.htmlEncode(text) : text;
+ }
+ return this;
}
});
-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)
- */
- 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);
- },
+/**
+ * @class Ext.form.Panel
+ * @extends Ext.panel.Panel
+
+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.
+
+__Layout__
+
+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}.
+
+__BasicForm__
+
+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.
+
+**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.
+
+The following events fired by the BasicForm will be re-fired by the FormPanel and can therefore be
+listened for on the FormPanel itself:
+
+- {@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}
- 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 = '';
- }
- }
- },
+__Field Defaults__
- onBeforeStart : function(e){
- this.dragHd = this.activeHd;
- return !!this.dragHd;
- },
+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.
- onStart: function(e){
- this.view.disableHeaders = true;
- this.proxy = this.view.el.createChild({cls:'x-list-resizer'});
- this.proxy.setHeight(this.view.el.getHeight());
+__Form Validation__
- var x = this.tracker.getXY()[0],
- w = this.view.innerHd.getWidth();
+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}.
- this.hdX = this.dragHd.getX();
- this.hdIndex = this.view.findHeaderIndex(this.dragHd);
+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.
- this.proxy.setX(this.hdX);
- this.proxy.setWidth(x-this.hdX);
+For more information on form validation see the following:
- this.minWidth = w*this.minPct;
- this.maxWidth = w - (this.minWidth*(this.view.columns.length-1-this.hdIndex));
- },
+- {@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}
- onDrag: function(e){
- var cursorX = this.tracker.getXY()[0];
- this.proxy.setWidth((cursorX-this.hdX).constrain(this.minWidth, this.maxWidth));
- },
+__Form Submission__
- onEnd: function(e){
- /* calculate desired width by measuring proxy and then remove it */
- var nw = this.proxy.getWidth();
- this.proxy.remove();
+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:__
- 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.maxColumnWidth) / 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);
- }
-});
+ 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);
+ }
+ });
+ }
+ }
+ }],
+ renderTo: Ext.getBody()
+ });
-// 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
+ * @param {Object} config Configuration options
+ * @xtype form
+ *
+ * @markdown
+ * @docauthor Jason Johnston
*/
-Ext.list.Sorter = Ext.extend(Ext.util.Observable, {
+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 {Array} sortClasses
- * The CSS classes applied to a header when it is sorted. (defaults to ["sort-asc", "sort-desc"])
+ * @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.
*/
- sortClasses : ["sort-asc", "sort-desc"],
- constructor: function(config){
- Ext.apply(this, config);
- Ext.list.Sorter.superclass.constructor.call(this);
- },
+ /**
+ * @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.
+ */
- init : function(listView){
- this.view = listView;
- listView.on('render', this.initEvents, this);
- },
+ /**
+ * @cfg {String} layout The {@link Ext.container.Container#layout} for the form panel's immediate child items.
+ * Defaults to 'anchor'.
+ */
+ layout: 'anchor',
- 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]);
- },
+ ariaRole: 'form',
- 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;
- }
- }
- if(sortColumn != -1){
- var sortDir = state.direction;
- this.updateSortIcon(sortColumn, sortDir);
+ initComponent: function() {
+ var me = this;
+
+ if (me.frame) {
+ me.border = false;
}
- },
+
+ me.initFieldAncestor();
+ me.callParent();
- 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]);
- },
+ me.relayEvents(me.form, [
+ 'beforeaction',
+ 'actionfailed',
+ 'actioncomplete',
+ 'validitychange',
+ 'dirtychange'
+ ]);
- 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);
+ // Start polling if configured
+ if (me.pollForChanges) {
+ me.startPolling(me.pollInterval || 500);
}
- }
-});
+ },
-// 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.
- *
- *
- * - 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:
- *
-var tabs = new Ext.TabPanel({
- renderTo: 'my-tabs',
- activeTab: 0,
- items:[
- {contentEl:'tab1', title:'Tab 1'},
- {contentEl:'tab2', title:'Tab 2'}
- ]
-});
+ initItems: function() {
+ // Create the BasicForm
+ var me = this;
+
+ me.form = me.createForm();
+ me.callParent();
+ me.form.initialize();
+ },
-// 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>
-
- * 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.
- *
- *
- *
- *
- * @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}.{@link Ext.layout.CardLayout#layoutOnCardChange layoutOnCardChange}
.
+ * @private
*/
+ createForm: function() {
+ return Ext.create('Ext.form.Basic', this, Ext.applyIf({listeners: {}}, this.initialConfig));
+ },
+
/**
- * @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.
+ * 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;
+ },
+
/**
- * @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}.
+ * 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
*/
- deferredRender : true,
+ loadRecord: function(record) {
+ return this.getForm().loadRecord(record);
+ },
+
/**
- * @cfg {Number} tabWidth The initial width in pixels of each new tab (defaults to 120).
+ * Returns the currently loaded Ext.data.Model instance if one was loaded via {@link #loadRecord}.
+ * @return {Ext.data.Model} The loaded instance
*/
- tabWidth : 120,
+ getRecord: function() {
+ return this.getForm().getRecord();
+ },
+
/**
- * @cfg {Number} minTabWidth The minimum width in pixels for each tab when {@link #resizeTabs} = true (defaults to 30).
+ * 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
*/
- minTabWidth : 30,
+ getValues: function() {
+ return this.getForm().getValues();
+ },
+
+ beforeDestroy: function() {
+ this.stopPolling();
+ this.form.destroy();
+ this.callParent();
+ },
+
/**
- * @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).
+ * 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)
*/
- resizeTabs : false,
+ load: function(options) {
+ this.form.load(options);
+ },
+
/**
- * @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).
+ * 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)
*/
- enableTabScroll : false,
- /**
- * @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.
+ submit: function(options) {
+ this.form.submit(options);
+ },
+
+ /*
+ * Inherit docs, not using onDisable because it only gets fired
+ * when the component is rendered.
*/
- scrollIncrement : 0,
- /**
- * @cfg {Number} scrollRepeatInterval Number of milliseconds between each scroll while a tab scroll button is
- * continuously pressed (defaults to 400).
+ disable: function(silent) {
+ this.callParent(arguments);
+ this.form.getFields().each(function(field) {
+ field.disable();
+ });
+ },
+
+ /*
+ * Inherit docs, not using onEnable because it only gets fired
+ * when the component is rendered.
*/
- scrollRepeatInterval : 400,
+ enable: function(silent) {
+ this.callParent(arguments);
+ this.form.getFields().each(function(field) {
+ field.enable();
+ });
+ },
+
/**
- * @cfg {Float} scrollDuration The number of milliseconds that each scroll animation should last (defaults
- * to .35). Only applies when {@link #animScroll} = true.
+ * 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.
*/
- scrollDuration : 0.35,
+ 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;
+ },
+
/**
- * @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.
+ * Stop a running interval task that was started by {@link #startPolling}.
*/
- animScroll : true,
+ stopPolling: function() {
+ var task = this.pollTask;
+ if (task) {
+ task.stopAll();
+ delete this.pollTask;
+ }
+ },
+
/**
- * @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'.
+ * Forces each field within the form panel to
+ * {@link Ext.form.field.Field#checkChange check if its value has changed}.
*/
- 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:
- * - 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.
- *
Example usage:
- *
-var tabs = new Ext.TabPanel({
- applyTo: 'my-tabs',
- activeTab: 0,
- deferredRender: false,
- autoTabs: true
+ checkChange: function() {
+ this.form.getFields().each(function(field) {
+ field.checkChange();
+ });
+ }
});
-// 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>
-
- */
- 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.RadioGroup
+ * @extends Ext.form.CheckboxGroup
+ * 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.
+ * Example usage:
+ *
+var myRadioGroup = new Ext.form.RadioGroup({
+ id: 'myGroup',
+ xtype: 'radiogroup',
+ fieldLabel: 'Single Column',
+ // Arrange radio buttons into three columns, distributed vertically
+ columns: 3,
+ 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'}
+ ]
+});
+ *
+ * @constructor
+ * Creates a new RadioGroup
+ * @param {Object} config Configuration options
+ * @xtype radiogroup
+ */
+Ext.define('Ext.form.RadioGroup', {
+ extend: 'Ext.form.CheckboxGroup',
+ alias: 'widget.radiogroup',
+
/**
- * @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 {Array} items An Array of {@link Ext.form.field.Radio Radio}s or Radio config objects
+ * to arrange in the group.
*/
- tabMargin : 2,
/**
- * @cfg {Boolean} plain true to render the tab strip without a background container image
- * (defaults to false).
+ * @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.
*/
- plain : false,
+ allowBlank : true,
/**
- * @cfg {Number} wheelIncrement For scrolling tabs, the number of pixels to increment on mouse wheel
- * scrolling (defaults to 20).
- */
- wheelIncrement : 20,
-
- /*
- * 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.
+ * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails
+ * (defaults to 'You must select one item in this group')
*/
- idDelimiter : '__',
-
- // private
- itemCls : 'x-tab-item',
-
- // private config overrides
- elements : 'body',
- headerAsText : false,
- frame : false,
- hideBorders :true,
-
+ blankText : 'You must select one item in this group',
+
// 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';
- }
- if(!this.stack){
- this.stack = Ext.TabPanel.AccessStack();
- }
- this.initItems();
- },
-
+ defaultType : 'radiofield',
+
// 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');
- }
+ groupCls : Ext.baseCSSPrefix + 'form-radio-group',
- var st = this[this.stripTarget];
-
- this.stripWrap = st.createChild({cls:'x-tab-strip-wrap', cn:{
- tag:'ul', cls:'x-tab-strip x-tab-strip-'+this.tabPosition}});
-
- 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);
+ getBoxes: function() {
+ return this.query('[isRadio]');
+ }
- // 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'});
+});
- this.body.addClass('x-tab-panel-body-'+this.tabPosition);
+/**
+ * @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,
- /**
- * @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:
-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 || ''
+ getByName: function(name) {
+ return this.filterBy(function(item) {
+ return item.name == name;
});
},
- 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'
- }]
-});
-
- */
- if(!this.itemTpl){
- var tt = new Ext.Template(
- '',
- '',
- '{text}',
- ' '
- );
- tt.disableFormats = true;
- tt.compile();
- Ext.TabPanel.prototype.itemTpl = tt;
- }
-
- this.items.each(this.initTab, this);
- },
- // 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);
- }
+ getWithValue: function(name, value) {
+ return this.filterBy(function(item) {
+ return item.name == name && item.inputValue == value;
+ });
},
- // private
- initEvents : function(){
- Ext.TabPanel.superclass.initEvents.call(this);
- this.mon(this.strip, {
- scope: this,
- mousedown: this.onStripMouseDown,
- contextmenu: this.onStripContextMenu
+ getChecked: function(name) {
+ return this.findBy(function(item) {
+ return item.name == name && item.checked;
});
- if(this.enableTabScroll){
- this.mon(this.strip, 'mousewheel', this.onWheel, this);
- }
- },
+ }
+});
- // private
- findTargets : function(e){
- var item = null,
- itemEl = e.getTarget('li:not(.x-tab-edge)', this.strip);
+/**
+ * @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.
+ *
+var myFormPanel = new Ext.form.Panel({
+ // configs for FormPanel
+ title: 'Basic Information',
+ renderTo: document.body,
+ width: 300, height: 160,
+ padding: 10,
- 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
- };
+ // 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
- 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);
+// load the form
+myFormPanel.getForm().load({
+ // pass 2 arguments to server side getBasicInfo method (len=2)
+ params: {
+ foo: 'bar',
+ uid: 34
+ }
+});
+ *
+ * The data packet sent to the server will resemble something like:
+ *
+[
+ {
+ "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
+ "data":[34,"bar"] // note the order of the params
+ }
+]
+ *
+ * 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,
+ "result":{
+ "success":true,
+ "data":{
+ "name":"Fred Flintstone",
+ "company":"Slate Rock and Gravel",
+ "email":"fred.flintstone@slaterg.com"
}
- return;
}
- if(t.item && t.item != this.activeTab){
- this.setActiveTab(t.item);
- }
- },
+ }
+]
+ *
+ */
+Ext.define('Ext.form.action.DirectLoad', {
+ extend:'Ext.form.action.Load',
+ requires: ['Ext.direct.Manager'],
+ alternateClassName: 'Ext.form.Action.DirectLoad',
+ alias: 'formaction.directload',
- // private
- onStripContextMenu : function(e){
- e.preventDefault();
- var t = this.findTargets(e);
- if(t.item){
- this.fireEvent('contextmenu', this, t.item, e);
- }
+ type: 'directload',
+
+ run: function() {
+ this.form.api.load.apply(window, this.getArgs());
},
/**
- * True to scan the markup in this tab panel for {@link #autoTabs} using the
- * {@link #autoTabSelector}
- * @param {Boolean} removeExisting True to remove existing tabs
+ * @private
+ * Build the arguments to be sent to the Direct call.
+ * @return Array
*/
- readTabs : function(removeExisting){
- if(removeExisting === true){
- this.items.each(function(item){
- this.remove(item);
- }, this);
+ getArgs: function() {
+ var me = this,
+ args = [],
+ form = me.form,
+ paramOrder = form.paramOrder,
+ params = me.getParams(),
+ i, len;
+
+ // 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 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
- });
+ // 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
- 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);
- });
+ // 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);
+ },
- if(item.tabTip){
- tabEl.child('span.x-tab-strip-text', true).qtip = item.tabTip;
+ onSuccess: function(result, trans) {
+ if (trans.type == Ext.direct.Manager.self.exceptions.SERVER) {
+ result = {};
}
- item.tabEl = el;
+ this.callParent([result]);
+ }
+});
- // Route *keyboard triggered* click events to the tab strip mouse handler.
- tabEl.select('a').on('click', function(e){
- if(!e.getPageX()){
- this.onStripMouseDown(e);
- }
- }, this, {preventDefault: true});
- item.on({
- scope: this,
- disable: this.onItemDisabled,
- enable: this.onItemEnabled,
- titlechange: this.onItemTitleChanged,
- iconchange: this.onItemIconChanged,
- beforeshow: this.onBeforeShowItem
- });
- },
+/**
+ * @class Ext.form.action.DirectSubmit
+ * @extends Ext.form.action.Submit
+ * Provides Ext.direct support for submitting form data.
+ * This example illustrates usage of Ext.direct.Direct to submit a form through Ext.Direct.
+ *
+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'
+ }],
- /**
- * 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:
- * - id : StringA unique identifier which links to the item
- * - text : StringThe text to display
- * - cls : StringThe CSS class name
- * - iconCls : StringA CSS class to provide appearance for an icon.
- *
- * @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.
- */
- getTemplateArgs : function(item) {
- var cls = item.closable ? 'x-tab-strip-closable' : '';
- if(item.disabled){
- cls += ' x-item-disabled';
+ // 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 data packet sent to the server will resemble something like:
+ *
+{
+ "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."
}
- if(item.iconCls){
- cls += ' x-tab-with-icon';
+ }
+}
+ *
+ * The form will process a data packet returned by the server that is similar
+ * to the following:
+ *
+// sample success packet (batched requests)
+[
+ {
+ "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":3,
+ "result":{
+ "success":true
}
- if(item.tabCls){
- cls += ' ' + item.tabCls;
+ }
+]
+
+// sample failure packet (one request)
+{
+ "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6",
+ "result":{
+ "errors":{
+ "email":"already taken"
+ },
+ "success":false,
+ "foo":"bar"
}
+}
+ *
+ * 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',
- return {
- id: this.id + this.idDelimiter + item.getItemId(),
- text: item.title,
- cls: cls,
- iconCls: item.iconCls || ''
- };
- },
+ type: 'directsubmit',
- // 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();
- }
+ 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
- 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);
+ // 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
- 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();
+ onSuccess: function(response, trans) {
+ if (trans.type === Ext.direct.Manager.self.exceptions.SERVER) {
+ response = {};
}
- },
+ this.callParent([response]);
+ }
+});
- // private
- onBeforeShowItem : function(item){
- if(item != this.activeTab){
- this.setActiveTab(item);
- return false;
- }
- },
+/**
+ * @class Ext.form.action.StandardSubmit
+ * @extends Ext.form.action.Submit
+ * 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',
- // private
- onItemDisabled : function(item){
- var el = this.getTabEl(item);
- if(el){
- Ext.fly(el).addClass('x-item-disabled');
- }
- this.stack.remove(item);
- },
+ /**
+ * @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.
+ */
- // private
- onItemEnabled : function(item){
- var el = this.getTabEl(item);
- if(el){
- Ext.fly(el).removeClass('x-item-disabled');
- }
- },
+ /**
+ * @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);
+ }
+
+});
+
+/**
+ * @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'
+ }
+ ]
+ }
+ ],
+ 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);
+ }
+ }
+ ],
+ renderTo: Ext.getBody()
+ });
- // private
- onItemTitleChanged : function(item){
- var el = this.getTabEl(item);
- if(el){
- Ext.fly(el).child('span.x-tab-strip-text', true).innerHTML = item.title;
+ * @constructor
+ * Creates a new Checkbox
+ * @param {Object} config Configuration options
+ * @xtype checkboxfield
+ * @docauthor Robert Dougan
+ * @markdown
+ */
+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
}
- },
+ ],
- //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');
- }
- },
+ isCheckbox: true,
/**
- * 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
+ * @cfg {String} focusCls The CSS class to use when the checkbox receives focus
+ * (defaults to 'x-form-cb-focus')
*/
- getTabEl : function(item){
- var c = this.getComponent(item);
- return c ? c.tabEl : null;
- },
-
- // private
- onResize : function(){
- Ext.TabPanel.superclass.onResize.apply(this, arguments);
- this.delegateUpdates();
- },
+ focusCls: Ext.baseCSSPrefix + 'form-cb-focus',
/**
- * Suspends any internal calculations or scrolling while doing a bulk operation. See {@link #endUpdate}
+ * @cfg {String} fieldCls The default CSS class for the checkbox (defaults to 'x-form-field')
*/
- beginUpdate : function(){
- this.suspendUpdates = true;
- },
/**
- * Resumes calculations and scrolling at the end of a bulk operation. See {@link #beginUpdate}
+ * @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.
*/
- endUpdate : function(){
- this.suspendUpdates = false;
- this.delegateUpdates();
- },
+ fieldBodyCls: Ext.baseCSSPrefix + 'form-cb-wrap',
/**
- * Hides the tab strip item for the passed tab
- * @param {Number/String/Panel} item The tab index, id or item
+ * @cfg {Boolean} checked true if the checkbox should render initially checked (defaults to false)
*/
- hideTabStripItem : function(item){
- item = this.getComponent(item);
- var el = this.getTabEl(item);
- if(el){
- el.style.display = 'none';
- this.delegateUpdates();
- }
- this.stack.remove(item);
- },
+ checked: false,
/**
- * Unhides the tab strip item for the passed tab
- * @param {Number/String/Panel} item The tab index, id or item
+ * @cfg {String} checkedCls The CSS class added to the component's main element when it is in the checked state.
*/
- 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();
- }
- },
-
- // private
- autoSizeTabs : function(){
- var count = this.items.length,
- ce = this.tabPosition != 'bottom' ? 'header' : 'footer',
- ow = this[ce].dom.offsetWidth,
- aw = this[ce].dom.clientWidth;
+ checkedCls: Ext.baseCSSPrefix + 'form-cb-checked',
- if(!this.resizeTabs || count < 1 || !aw){ // !aw for display:none
- return;
- }
+ /**
+ * @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).
+ */
- 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';
- }
- },
+ /**
+ * @cfg {String} boxLabelCls The CSS class to be applied to the {@link #boxLabel} element
+ */
+ boxLabelCls: Ext.baseCSSPrefix + 'form-cb-label',
- // private
- adjustBodyWidth : function(w){
- if(this.header){
- this.header.setWidth(w);
- }
- if(this.footer){
- this.footer.setWidth(w);
- }
- return w;
- },
+ /**
+ * @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',
/**
- * 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:
- *
- * - 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}
property
- *
- * For additional information see {@link Ext.util.MixedCollection#get}.
+ * @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".
*/
- 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);
+ inputValue: 'on',
- this.layout.setActiveItem(item);
- if(this.scrolling){
- this.scrollToTab(item, this.animScroll);
- }
- }
- this.fireEvent('tabchange', this, item);
- }
- },
+ /**
+ * @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).
+ */
/**
- * 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 {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:
+ *
+ * - checkbox : Ext.form.field.CheckboxThe Checkbox being toggled.
+ * - checked : BooleanThe new checked state of the checkbox.
+ *
*/
- getActiveTab : function(){
- return this.activeTab || null;
- },
/**
- * Gets the specified tab by id.
- * @param {String} id The tab id
- * @return {Panel} The tab
+ * @cfg {Object} scope An object to use as the scope ('this' reference) of the {@link #handler} function
+ * (defaults to this Checkbox).
*/
- getItem : function(item){
- return this.getComponent(item);
- },
- // 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 || cw < 20){ // 20 to prevent display:none issues
- return;
- }
- if(count == 0 || l <= tw){
- // ensure the width is set if there's no tabs
- 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();
- }
- },
+ // private overrides
+ checkChangeEvents: [],
+ inputType: 'checkbox',
+ ariaRole: 'checkbox',
// private
- createScrollers : function(){
- this.pos.addClass('x-tab-scrolling-' + this.tabPosition);
- var h = this.stripWrap.dom.offsetHeight;
+ onRe: /^on$/i,
- // 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;
-
- // 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
- });
- this.scrollRight = sr;
+ initComponent: function(){
+ this.callParent(arguments);
+ this.getManager().add(this);
},
- // private
- getScrollWidth : function(){
- return this.edge.getOffsetsTo(this.stripWrap)[0] + this.getScrollPos();
- },
+ initValue: function() {
+ var me = this,
+ checked = !!me.checked;
- // private
- getScrollPos : function(){
- return parseInt(this.stripWrap.dom.scrollLeft, 10) || 0;
- },
+ /**
+ * 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 true
.
+ * @type Mixed
+ * @property originalValue
+ */
+ me.originalValue = me.lastValue = checked;
- // private
- getScrollArea : function(){
- return parseInt(this.stripWrap.dom.clientWidth, 10) || 0;
+ // Set the initial checked state
+ me.setValue(checked);
},
// private
- getScrollAnim : function(){
- return {duration:this.scrollDuration, callback: this.updateScrollButtons, scope: this};
+ 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);
},
- // private
- getScrollIncrement : function(){
- return this.scrollIncrement || (this.resizeTabs ? this.lastTabWidth+2 : 100);
+ initEvents: function() {
+ var me = this;
+ me.callParent();
+ me.mon(me.inputEl, 'click', me.onBoxClick, me);
},
/**
- * 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 Handle click on the checkbox button
*/
-
- scrollToTab : function(item, animate){
- if(!item){
- return;
- }
- 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);
- }
- },
-
- // private
- scrollTo : function(pos, animate){
- this.stripWrap.scrollTo('left', pos, animate ? this.getScrollAnim() : false);
- if(!animate){
- this.updateScrollButtons();
+ onBoxClick: function(e) {
+ var me = this;
+ if (!me.disabled && !me.readOnly) {
+ this.setValue(!this.checked);
}
},
- onWheel : function(e){
- var d = e.getWheelDelta()*this.wheelIncrement*-1;
- e.stopEvent();
-
- 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);
- }
+ /**
+ * Returns the checked state of the checkbox.
+ * @return {Boolean} True if checked, else false
+ */
+ getRawValue: function() {
+ return this.checked;
},
- // 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);
- }
+ /**
+ * Returns the checked state of the checkbox.
+ * @return {Boolean} True if checked, else false
+ */
+ getValue: function() {
+ return this.checked;
},
- // private
- onScrollLeft : function(){
- var pos = this.getScrollPos(),
- s = Math.max(0, pos - this.getScrollIncrement());
- if(s != pos){
- this.scrollTo(s, this.animScroll);
- }
+ /**
+ * 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.
+ */
+ getSubmitValue: function() {
+ return this.checked ? this.inputValue : (this.uncheckedValue || null);
},
- // 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');
+ getModelData: function() {
+ return this.getSubmitData();
},
- // 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);
- }
-
- /**
- * @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 {Boolean} preventBodyReset
- * @hide
+ * 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
*/
-});
-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();
- }
- },
-
- remove : function(item){
- var s = [];
- for(var i = 0, len = items.length; i < len; i++) {
- if(items[i] != item){
- s.push(items[i]);
- }
- }
- items = s;
- },
+ 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)));
- next : function(){
- return items.pop();
+ if (inputEl) {
+ inputEl.dom.setAttribute('aria-checked', checked);
+ me[checked ? 'addCls' : 'removeCls'](me.checkedCls);
}
- };
-};
-/**
- * @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:
- * b
: ButtonThis Button.
- * e
: EventObjectThe click event.
- *
- * @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
- */
-Ext.Button = Ext.extend(Ext.BoxComponent, {
- /**
- * Read-only. True if this button is hidden
- * @type Boolean
- */
- hidden : false,
- /**
- * Read-only. True if this button is disabled
- * @type Boolean
- */
- disabled : false,
- /**
- * Read-only. True if this button is pressed (only if enableToggle = true)
- * @type Boolean
- */
- pressed : false,
- /**
- * @cfg {Number} tabIndex Set a DOM tabIndex for this button (defaults to undefined)
- */
+ me.checked = me.rawValue = checked;
+ return checked;
+ },
/**
- * @cfg {Boolean} allowDepress
- * False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when {@link #enableToggle} is true.
+ * 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;
- /**
- * @cfg {Boolean} enableToggle
- * True to enable pressed/not pressed toggling (defaults to false)
- */
- enableToggle : false,
- /**
- * @cfg {Function} toggleHandler
- * Function called when a Button with {@link #enableToggle} set to true is clicked. Two arguments are passed:
- * - button : Ext.Buttonthis Button object
- * - state : BooleanThe next state of the Button, true means pressed.
- *
- */
- /**
- * @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} menuAlign
- * The position to align the menu to (see {@link Ext.Element#alignTo} for more details, defaults to 'tl-bl?').
- */
- menuAlign : 'tl-bl?',
+ // 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);
+ }
- /**
- * @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}.{@link Ext.Toolbar.Item#overflowText overflowText}
.
- */
- /**
- * @cfg {String} iconCls
- * A css class which sets a background image to be used as the icon for this button
- */
- /**
- * @cfg {String} type
- * submit, reset or button - defaults to 'button'
- */
- type : 'button',
+ return me;
+ },
// private
- menuClassTarget : 'tr:nth(2)',
+ valueToRaw: function(value) {
+ // No extra conversion for checkboxes
+ return value;
+ },
/**
- * @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'.
+ * @private
+ * Called when the checkbox's checked state changes. Invokes the {@link #handler} callback
+ * function if specified.
*/
- clickEvent : 'click',
+ onChange: function(newVal, oldVal) {
+ var me = this,
+ handler = me.handler;
+ if (handler) {
+ handler.call(me.scope || me, me, newVal);
+ }
+ me.callParent(arguments);
+ },
- /**
- * @cfg {Boolean} handleMouseEvents
- * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
- */
- handleMouseEvents : true,
+ // inherit docs
+ getManager: function() {
+ return Ext.form.CheckboxManager;
+ },
- /**
- * @cfg {String} tooltipType
- * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
- */
- tooltipType : 'qtip',
+ 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;
+ }
+ },
- /**
- * @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',
+ 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 {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'.
+ * @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.
*/
- scale : 'small',
+ getBodyNaturalWidth: function() {
+ var me = this,
+ bodyEl = me.bodyEl,
+ ws = 'white-space',
+ width;
+ bodyEl.setStyle(ws, 'nowrap');
+ width = bodyEl.getWidth();
+ bodyEl.setStyle(ws, '');
+ return width;
+ }
- /**
- * @cfg {Object} scope The scope (this reference) in which the
- * {@link #handler}
and {@link #toggleHandler}
is
- * executed. Defaults to this Button.
- */
+});
- /**
- * @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'.
- */
- iconAlign : 'left',
+/**
+ * @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
+ */
- /**
- * @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'.
- */
- arrowAlign : 'right',
+Ext.define('Ext.layout.component.field.Trigger', {
- /**
- * @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
- */
- /**
- * @cfg {String} cls
- * A CSS class string to apply to the button's main element.
- */
- /**
- * @property menu
- * @type Menu
- * The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option.
- */
- /**
- * @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.
- */
+ /* Begin Definitions */
- initComponent : function(){
- Ext.Button.superclass.initComponent.call(this);
+ 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(
+ '',
+ '',
+ '',
+ '
{caption}',
+ '',
+ ' '
+ );
+
+ Ext.create('Ext.DataView', {
+ store: Ext.data.StoreManager.lookup('imagesStore'),
+ tpl: imageTpl,
+ itemSelector: 'div.thumb-wrap',
+ emptyText: 'No images available',
+ renderTo: Ext.getBody()
+ });
+ *
+ * @xtype dataview
+ */
+Ext.define('Ext.view.View', {
+ extend: 'Ext.view.AbstractView',
+ alternateClassName: 'Ext.view.View',
+ 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'
+ }
+ },
+
+ 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
+ */
+ 'beforeitemcontextmenu',
+ /**
+ * @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.
+ */
+ '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.
*/
- 'menutriggerover',
+ 'containerkeydown',
+
/**
- * @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 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
*/
- 'menutriggerout'
+ '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;
- }
- },
-
-/**
- * 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:
- * - 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.
- *
- * @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];
},
-
// 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]);
+ afterRender: function(){
+ var me = this,
+ listeners;
+
+ me.callParent();
+
+ listeners = {
+ scope: me,
+ 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);
}
},
-
- // protected
- getMenuClass : function(){
- return this.menu ? (this.arrowAlign != 'bottom' ? 'x-btn-arrow' : 'x-btn-arrow-bottom') : '';
+
+ handleEvent: function(e) {
+ if (this.processUIEvent(e) !== false) {
+ this.processSpecialEvent(e);
+ }
},
-
- // private
- onRender : function(ct, position){
- if(!this.template){
- if(!Ext.Button.buttonTemplate){
- // hideous table template
- Ext.Button.buttonTemplate = new Ext.Template(
- '',
- ' ',
- ' ',
- ' ',
- '
');
- Ext.Button.buttonTemplate.compile();
+
+ // Private template method
+ processItemEvent: Ext.emptyFn,
+ processContainerEvent: Ext.emptyFn,
+ processSpecialEvent: Ext.emptyFn,
+
+ processUIEvent: function(e, type) {
+ type = type || e.type;
+ var me = this,
+ item = e.getTarget(me.getItemSelector(), me.getTargetEl()),
+ map = this.statics().EventMap,
+ index, record;
+
+ if (!item) {
+ // 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 (type == 'mouseover' && me.mouseOverItem && typeof me.mouseOverItem.offsetParent === "object" && Ext.fly(me.mouseOverItem).getRegion().contains(e.getPoint())) {
+ item = me.mouseOverItem;
+ }
+
+ // 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(position){
- btn = this.template.insertBefore(position, targs, true);
- }else{
- btn = this.template.append(ct, targs, true);
+
+ if (item) {
+ index = me.indexOf(item);
+ if (!record) {
+ record = me.getRecord(item);
+ }
+
+ if (me.processItemEvent(type, record, item, index, e) === false) {
+ return false;
+ }
+
+ type = me.isNewItemEvent(type, item, e);
+ if (type === false) {
+ return false;
+ }
+
+ if (
+ (me['onBeforeItem' + map[type]](record, item, index, e) === false) ||
+ (me.fireEvent('beforeitem' + type, me, record, item, index, e) === false) ||
+ (me['onItem' + map[type]](record, item, index, e) === false)
+ ) {
+ return false;
+ }
+
+ me.fireEvent('item' + type, me, record, item, index, e);
+ }
+ else {
+ if (
+ (me.processContainerEvent(type, 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);
}
- /**
- * 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
- });
-
- this.initButtonEl(btn, this.btnEl);
-
- Ext.ButtonToggleMgr.register(this);
+
+ return true;
},
-
- // 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;
- }
- if(this.tooltip){
- this.setTooltip(this.tooltip, true);
- }
-
- if(this.handleMouseEvents){
- this.mon(btn, {
- scope: this,
- mouseover: this.onMouseOver,
- mousedown: this.onMouseDown
- });
-
- // new functionality for monitoring on the document level
- //this.mon(btn, 'mouseout', this.onMouseOut, this);
- }
-
- if(this.menu){
- this.mon(this.menu, {
- scope: this,
- show: this.onMenuShow,
- hide: this.onMenuHide
- });
+
+ isNewItemEvent: function(type, item, e) {
+ var me = this,
+ overItem = me.mouseOverItem,
+ contains,
+ isItem;
+
+ switch (type) {
+ case 'mouseover':
+ if (item === overItem) {
+ return false;
+ }
+ me.mouseOverItem = item;
+ return 'mouseenter';
+ break;
+
+ case 'mouseout':
+ /*
+ * Need an extra check here to see if it's the parent element. See the
+ * comment re: the browser bug at the start of processUIEvent
+ */
+ if (overItem && typeof overItem.offsetParent === "object") {
+ contains = Ext.fly(me.mouseOverItem).getRegion().contains(e.getPoint());
+ isItem = Ext.fly(e.getTarget()).hasCls(me.itemSelector);
+ if (contains && isItem) {
+ return false;
+ }
+ }
+ me.mouseOverItem = null;
+ return 'mouseleave';
+ break;
}
-
- if(this.repeat){
- var repeater = new Ext.util.ClickRepeater(btn, Ext.isObject(this.repeat) ? this.repeat : {});
- this.mon(repeater, 'click', this.onRepeatClick, this);
- }else{
- this.mon(btn, this.clickEvent, this.onClick, this);
+ return type;
+ },
+
+ // private
+ onItemMouseEnter: function(record, item, index, e) {
+ if (this.trackOver) {
+ this.highlightItem(item);
}
},
// 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,
+ onItemClick: Ext.emptyFn,
+ onItemDblClick: Ext.emptyFn,
+ onItemContextMenu: Ext.emptyFn,
+ onItemKeyDown: Ext.emptyFn,
+ onBeforeItemMouseDown: Ext.emptyFn,
+ onBeforeItemMouseUp: 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:
- * - 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}.
- *
- * @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() {
+ this.clearHighlight();
+ this.callParent(arguments);
+ }
+});
+/**
+ * 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.btnEl, 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
+ * @xtype tbtext
+ */
+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 (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)
+ * @xtype triggerfield
+ */
+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
- onRepeatClick : function(repeat, e){
- this.onClick(e);
+ 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();
- }
- if(e.button !== 0){
- return;
+ 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(!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);
- }
+
+ // Create as many trigger elements as we have triggerCls 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'
+ });
}
- },
+ triggerConfigs[i - 1].cls += ' ' + triggerBaseCls + '-last';
- // private
- isMenuTriggerOver : function(e, internal){
- return this.menu && !internal;
+ 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();
},
- // private
- isMenuTriggerOut : function(e, internal){
- return this.menu && !internal;
+ onEnable: function() {
+ this.callParent();
+ this.triggerWrap.unmask();
+ },
+
+ onDisable: function() {
+ this.callParent();
+ this.triggerWrap.mask();
+ },
+
+ afterRender: function() {
+ this.callParent();
+ 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;
+ 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;
}
- this.fireEvent('mouseover', this, e);
- }
- if(this.isMenuTriggerOver(e, internal)){
- this.fireEvent('menutriggerover', this, this.menu, e);
+ displayed = !me.hideTrigger;
}
+
+ triggerWrap.setDisplayed(displayed);
+ inputEl.dom.readOnly = readOnly;
+ me.doComponentLayout();
}
},
- // 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);
+ /**
+ * 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
- 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);
+ setHideTrigger: function(hideTrigger) {
+ if (hideTrigger != this.hideTrigger) {
+ this.hideTrigger = hideTrigger;
+ this.updateEditState();
}
},
- focus : function() {
- this.btnEl.focus();
+ /**
+ * @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();
+ }
},
- blur : function() {
- this.btnEl.blur();
+ /**
+ * @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
- onFocus : function(e){
- if(!this.disabled){
- this.el.addClass('x-btn-focus');
+ 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);
}
+
+ 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');
+ });
},
+
// private
- onBlur : function(e){
- this.el.removeClass('x-btn-focus');
+ onDestroy: function() {
+ var me = this;
+ Ext.destroyMembers(me, 'triggerRepeater', 'triggerWrap', 'triggerEl');
+ delete me.doc;
+ me.callParent();
},
// private
- getClickEl : function(e, isUp){
- return this.el;
+ 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
- onMouseDown : function(e){
- if(!this.disabled && e.button === 0){
- this.getClickEl(e).addClass('x-btn-click');
- this.doc.on('mouseup', this.onMouseUp, this);
+ checkTab: function(me, e) {
+ if (!this.ignoreMonitorTab && e.getKey() == e.TAB) {
+ this.triggerBlur();
}
},
+
+ // private
+ onBlur: Ext.emptyFn,
+
// private
- onMouseUp : function(e){
- if(e.button === 0){
- this.getClickEl(e, true).removeClass('x-btn-click');
- this.doc.un('mouseup', this.onMouseUp, this);
+ mimicBlur: function(e) {
+ if (!this.isDestroyed && !this.bodyEl.contains(e.target) && this.validateBlur(e)) {
+ this.triggerBlur();
}
},
+
// 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);
+ 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
- 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;
- }
+ // 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
- restoreClick : function(){
- this.ignoreNextClick = 0;
- }
+ // 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);
+ }
+ }
+ },
+
+ /**
+ * 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.
+ *
+ * @xtype pickerfield
+ * @constructor
+ * Create a new picker field
+ * @param {Object} config
+ */
+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:
- *
-// 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
-});
-
- * @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');
+ }
+ },
+
+
+ /**
+ * 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
+ });
+
+ me.fireEvent('expand', me);
+ me.onExpand();
+ }
+ },
+
+ onExpand: Ext.emptyFn,
+
+ /**
+ * @protected
+ * Aligns the picker to the
+ */
+ 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);
+ }
+ }
},
- // private
- onRender : function(){
- Ext.SplitButton.superclass.onRender.apply(this, arguments);
- if(this.arrowTooltip){
- this.el.child(this.arrowSelector).dom[this.tooltipType] = this.arrowTooltip;
+ /**
+ * 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);
+
+ me.fireEvent('collapse', me);
+ me.onCollapse();
}
},
+ onCollapse: 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
+ * @private
+ * Runs on mousewheel and mousedown of doc to check to see if we should collapse the picker
*/
- setArrowHandler : function(handler, scope){
- this.arrowHandler = handler;
- this.scope = scope;
+ collapseIf: function(e) {
+ var me = this;
+ if (!me.isDestroyed && !e.within(me.bodyEl, false, true) && !e.within(me.picker.el, false, true)) {
+ me.collapse();
+ }
},
- getMenuClass : function(){
- return 'x-btn-split' + (this.arrowAlign == 'bottom' ? '-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());
},
- 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;
- }
- },
+ /**
+ * 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,
- // 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);
- }
+ /**
+ * 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.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:
- *
-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);
- }
});
-
+
+
+/**
+ * @class Ext.form.field.Spinner
+ * @extends Ext.form.field.Trigger
+ * 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.
+ *
* @constructor
- * Create a new split button
- * @param {Object} config The config object
- * @xtype cycle
+ * Creates a new Spinner field
+ * @param {Object} config Configuration options
+ * @xtype spinnerfield
*/
-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} showText True to display the active item's text as the button text (defaults to false)
+ * @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 {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} keyNavEnabled
+ * Specifies whether the up and down arrow keys should trigger spinning up and down.
+ * Defaults to true.
*/
+ keyNavEnabled: 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} mouseWheelEnabled
+ * Specifies whether the mouse wheel should trigger spinning up and down while the field has
+ * focus. Defaults to true.
*/
+ mouseWheelEnabled: 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.
+ * @cfg {Boolean} repeatTriggerClick Whether a {@link Ext.util.ClickRepeater click repeater} should be
+ * attached to the spinner buttons. Defaults to true.
*/
+ repeatTriggerClick: true,
+
/**
- * @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 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,
- // private
- getItemText : function(item){
- if(item && this.showText === true){
- var text = '';
- if(this.prependText){
- text += this.prependText;
- }
- text += item.text;
- return text;
- }
- return undefined;
+ /**
+ * 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,
+
+ 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:
- *
-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'
- ]
-});
- *
- * Example adding a ComboBox within a menu of a button:
- *
-// 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();
- *
- * @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 (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,
+ * @constructor
+ * Creates a new Number field
+ * @param {Object} config Configuration options
+ *
+ * @xtype numberfield
+ * @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 "right"
to right align all child items.
+ * @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);
- }
- },
-
/**
- * 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:
- *
- * - {@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})
- *
- * @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;
- },
+ /**
+ * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.')
+ */
+ decimalSeparator : '.',
- // 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 {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2)
+ */
+ decimalPrecision : 2,
/**
- * Adds a separator
- *
Note: See the notes within {@link Ext.Container#add}.
- * @return {Ext.Toolbar.Item} The separator {@link Ext.Toolbar.Item 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}.
*/
- addSeparator : function(){
- return this.add(new T.Separator());
- },
+ minValue: Number.NEGATIVE_INFINITY,
/**
- * Adds a spacer element
- *
Note: See the notes within {@link Ext.Container#add}.
- * @return {Ext.Toolbar.Spacer} The spacer item
+ * @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}.
*/
- addSpacer : function(){
- return this.add(new T.Spacer());
- },
+ maxValue: Number.MAX_VALUE,
/**
- * Forces subsequent additions into the float:right toolbar
- *
Note: See the notes within {@link Ext.Container#add}.
+ * @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.
*/
- addFill : function(){
- this.add(new T.Fill());
- },
+ step: 1,
/**
- * 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 {String} minText Error text to display if the minimum value validation fails (defaults to 'The minimum
+ * value for this field is {minValue}')
*/
- addElement : function(el){
- return this.addItem(new T.Item({el:el}));
- },
+ minText : 'The minimum value for this field is {0}',
/**
- * 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} maxText Error text to display if the maximum value validation fails (defaults to 'The maximum
+ * value for this field is {maxValue}')
*/
- addItem : function(item){
- return this.add.apply(this, arguments);
- },
+ maxText : 'The maximum 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} 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')
*/
- 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));
- },
+ nanText : '{0} is not a valid number',
/**
- * 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} 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.
*/
- addText : function(text){
- return this.addItem(new T.TextItem(text));
- },
+ negativeText : 'The value cannot be negative',
/**
- * 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} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789').
*/
- addDom : function(config){
- return this.add(new T.Item({autoEl: config}));
- },
+ baseChars : '0123456789',
/**
- * 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 {Boolean} autoStripChars True to automatically strip not allowed characters from the field. Defaults to false
*/
- addField : function(field){
- return this.add(field);
+ autoStripChars: false,
+
+ initComponent: function() {
+ var me = this,
+ allowed;
+
+ this.callParent();
+
+ me.setMinValue(me.minValue);
+ me.setMaxValue(me.maxValue);
+
+ // Build regexes for masking and stripping based on the configured options
+ 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');
+ }
},
/**
- * 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}
+ * 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
*/
- 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]));
- }
- return buttons;
+ 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;
}
- 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);
+ value = String(value).replace(me.decimalSeparator, '.');
+
+ if(isNaN(value)){
+ errors.push(format(me.nanText, value));
}
- },
- // private
- constructButton : function(item){
- var b = item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType);
- return b;
- },
+ num = me.parseValue(value);
- // private
- onAdd : function(c){
- Ext.Toolbar.superclass.onAdd.call(this);
- this.trackMenu(c);
- if(this.disabled){
- c.disable();
+ 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) {
+ return this.fixPrecision(this.parseValue(rawValue)) || rawValue || null;
},
- // 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:
- *
-new Ext.Panel({
- tbar : [
- 'Item 1',
- {xtype: 'tbseparator'}, // or '-'
- 'Item 2'
- ]
-});
-
- * @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:
-.x-toolbar .xtb-spacer {
- width:2px;
-}
- *
- * Example usage:
- *
-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 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: 'tbfill'}, // or '->'
- 'Item 2'
- ]
-});
-
- * @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 : [
- {xtype: 'tbtext', text: 'Item 1'} // or simply 'Item 1'
- ]
-});
-
- * @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).
- */
- setText : function(t) {
- if(this.rendered){
- this.el.update(t);
- }else{
- this.text = t;
- }
- }
-});
-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);
-
-})();
-/**
- * @class Ext.ButtonGroup
- * @extends Ext.Panel
- * Container for a group of buttons. Example usage:
- *
-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'
- }]
- }]
-});
- *
- * @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}.
+ * @private
+ *
*/
- frame: true,
- internalDefaults: {removeMode: 'container', hideParent: true},
+ fixPrecision : function(value) {
+ var me = this,
+ nan = isNaN(value),
+ precision = me.decimalPrecision;
- initComponent : function(){
- this.layoutConfig = this.layoutConfig || {};
- Ext.applyIf(this.layoutConfig, {
- columns : this.columns
- });
- if(!this.title){
- this.addClass('x-btn-group-notitle');
+ if (nan || !value) {
+ return nan ? '' : value;
+ } else if (!me.allowDecimals || precision <= 0) {
+ precision = 0;
}
- this.on('afterlayout', this.onAfterLayout, this);
- Ext.ButtonGroup.superclass.initComponent.call(this);
+
+ return parseFloat(Ext.Number.toFixed(parseFloat(value), precision));
},
- 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);
+ beforeBlur : function() {
+ var me = this,
+ v = me.parseValue(me.getRawValue());
+
+ if (!Ext.isEmpty(v)) {
+ me.setValue(v);
}
- 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());
+ onSpinUp: function() {
+ var me = this;
+ if (!me.readOnly) {
+ me.setValue(Ext.Number.constrain(me.getValue() + me.step, me.minValue, me.maxValue));
+ }
+ },
+
+ 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
* 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.
@@ -47694,7 +97688,7 @@ store.load({
* If using {@link Ext.data.Store#autoLoad store's autoLoad} configuration:
*
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},
...
});
*
@@ -47715,18 +97709,18 @@ var myStore = new Ext.data.Store({
* Paging with Local Data
* Paging can also be accomplished with local data using extensions:
*
- * - Ext.ux.data.PagingStore
+ * - Ext.ux.data.PagingStore
* - Paging Memory Proxy (examples/ux/PagingMemoryProxy.js)
*
* @constructor Create a new PagingToolbar
* @param {Object} config The config object
- * @xtype paging
+ * @xtype pagingtoolbar
*/
-(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).
@@ -47735,16 +97729,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}').
@@ -47801,109 +97792,122 @@ Ext.PagingToolbar = Ext.extend(Ext.Toolbar, {
* Note: quick tips must be initialized for the quicktip to show.
*/
refreshText : 'Refresh',
-
- /**
- * 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:
- * // t is reference to the paging toolbar instance
- * var activePage = Math.ceil((t.cursor + t.pageSize) / t.pageSize);
- *
- * @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:
* total
: Number The total number of records in the dataset as
* returned by the server
- * activePage
: Number The current page number
- * pages
: Number The total number of pages (calculated from
+ * currentPage
: Number The current page number
+ * pageCount
: Number The 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
: Number The starting record index for the current page
+ * fromRecord
: Number The ending record index for the current page
*
*/
'change',
@@ -47911,146 +97915,150 @@ 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:
- * start
: Number The starting row number for the next page of records to
- * be retrieved from the server
- * limit
: Number The 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),
+ //pageCount : store.getPageCount(),
+ 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 k = e.getKey(),
+ pageData = this.getPageData(),
+ increment = e.shiftKey ? 10 : 1,
+ pageNum,
+ me = this;
+
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.total);
+ 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){
@@ -48060,11 +98068,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();
}
},
@@ -48072,38 +98077,56 @@ 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);
+ var me = this;
+ if(me.fireEvent('beforechange', me, 1) !== false){
+ me.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(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;
+ if(me.fireEvent('beforechange', me, me.store.currentPage + 1) !== 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 = this.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);
+ }
},
/**
@@ -48112,33 +98135,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;
},
/**
@@ -48160,25690 +98180,27924 @@ 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;
-
- function getHash() {
- var href = top.location.href, i = href.indexOf("#");
- return i >= 0 ? href.substr(i + 1) : null;
- }
+Ext.define('Ext.view.BoundList', {
+ extend: 'Ext.view.View',
+ alias: 'widget.boundlist',
+ alternateClassName: 'Ext.BoundList',
+ requires: ['Ext.layout.component.BoundList', 'Ext.toolbar.Paging'],
- function doSave() {
- hiddenField.value = currentToken;
- }
+ /**
+ * @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 handleStateChange(token) {
- currentToken = token;
- Ext.History.fireEvent('change', token);
- }
+ /**
+ * @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 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;
- }
- }
+ // private overrides
+ autoScroll: true,
+ baseCls: Ext.baseCSSPrefix + 'boundlist',
+ listItemCls: '',
+ shadow: false,
+ trackOver: true,
+ refreshed: 0,
- function checkIFrame() {
- if (!iframe.contentWindow || !iframe.contentWindow.document) {
- setTimeout(checkIFrame, 10);
- return;
- }
+ ariaRole: 'listbox',
- var doc = iframe.contentWindow.document;
- var elem = doc.getElementById("state");
- var token = elem ? elem.innerText : null;
+ componentLayout: 'boundlist',
- var hash = getHash();
+ renderTpl: [''],
- setInterval(function () {
+ 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');
+ }
+
+ // should be setting aria-posinset based on entire set of data
+ // not filtered set
+ me.tpl = Ext.create('Ext.XTemplate',
+ '',
+ '- ' + me.getInnerTpl(me.displayField) + '
',
+ '
'
+ );
- doc = iframe.contentWindow.document;
- elem = doc.getElementById("state");
+ if (me.pageSize) {
+ me.pagingToolbar = me.createPagingToolbar();
+ }
- var newtoken = elem ? elem.innerText : null;
+ me.callParent();
- var newHash = getHash();
+ Ext.applyIf(me.renderSelectors, {
+ listEl: '.list-ct'
+ });
+ },
- if (newtoken !== token) {
- token = newtoken;
- handleStateChange(token);
- top.location.hash = token;
- hash = token;
- doSave();
- } else if (newHash !== hash) {
- hash = newHash;
- updateIFrame(newHash);
- }
+ createPagingToolbar: function() {
+ return Ext.widget('pagingtoolbar', {
+ pageSize: this.pageSize,
+ store: this.store,
+ border: false
+ });
+ },
- }, 50);
+ onRender: function() {
+ var me = this,
+ toolbar = me.pagingToolbar;
+ me.callParent(arguments);
+ if (toolbar) {
+ toolbar.render(me.el);
+ }
+ },
- ready = true;
+ bindStore : function(store, initial) {
+ var me = this,
+ toolbar = me.pagingToolbar;
+ me.callParent(arguments);
+ if (toolbar) {
+ toolbar.bindStore(store, initial);
+ }
+ },
- Ext.History.fireEvent('ready', Ext.History);
- }
+ getTargetEl: function() {
+ return this.listEl || this.el;
+ },
- function startUp() {
- currentToken = hiddenField.value ? hiddenField.value : getHash();
+ getInnerTpl: function(displayField) {
+ return '{' + displayField + '}';
+ },
- 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);
+ refresh: function() {
+ var me = this;
+ me.callParent();
+ if (me.isVisible()) {
+ me.refreshed++;
+ me.doComponentLayout();
+ me.refreshed--;
}
+ },
+
+ initAria: function() {
+ this.callParent();
+
+ var selModel = this.getSelectionModel(),
+ mode = selModel.getSelectionMode(),
+ actionEl = this.getActionEl();
+
+ // 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',
- events:{},
+ /**
+ * @cfg {Ext.view.BoundList} boundList
+ * @required
+ * The {@link Ext.view.BoundList} instance for which key navigation will be managed. This is required.
+ */
- /**
- * 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 (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();
- },
+ constructor: function(el, config) {
+ var me = this;
+ me.boundList = config.boundList;
+ me.callParent([el, Ext.apply({}, config, me.defaultHandlers)]);
+ },
- /**
- * 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:
- *
-// Handle tab changes on a TabPanel
-tabPanel.on('tabchange', function(tabPanel, tab){
- Ext.History.add(tabPanel.id + ':' + tab.id);
-});
-
- * @param {String} token The value that defines a particular application-specific history state
- * @param {Boolean} preventDuplicates 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;
- }
+ 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);
},
- /**
- * Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).
- */
- back: function(){
- history.go(-1);
+ 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 forward one step in browser history (equivalent to the user pressing the Forward button).
- */
- forward: function(){
- history.go(1);
+ pageup: function() {
+ //TODO
},
- /**
- * Retrieves the currently-active history token.
- * @return {String} The token
- */
- getToken: function() {
- return ready ? currentToken : getHash();
- }
- };
-})();
-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).
- */
- /**
- * @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.
- */
- /**
- * @cfg {Number} minWidth The minimum width of the tip in pixels (defaults to 40).
- */
- minWidth : 40,
- /**
- * @cfg {Number} maxWidth The maximum width of the tip in pixels (defaults to 300). The maximum supported value is 500.
- */
- maxWidth : 300,
- /**
- * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop"
- * for bottom-right shadow (defaults to "sides").
- */
- shadow : "sides",
- /**
- * @cfg {String} defaultAlign Experimental. The default {@link Ext.Element#alignTo} anchor position value
- * for this tip relative to its element of origin (defaults to "tl-bl?").
- */
- defaultAlign : "tl-bl?",
- autoRender: true,
- quickShowInterval : 250,
-
- // private panel overrides
- frame:true,
- hidden:true,
- baseCls: 'x-tip',
- floating:{shadow:true,shim:true,useDisplay:true,constrain:false},
- autoHeight:true,
+ pagedown: function() {
+ //TODO
+ },
- closeAction: 'hide',
+ home: function() {
+ this.highlightAt(0);
+ },
- // private
- initComponent : function(){
- Ext.Tip.superclass.initComponent.call(this);
- if(this.closable && !this.title){
- this.elements += ',header';
- }
- },
+ end: function() {
+ var me = this;
+ me.highlightAt(me.boundList.all.getCount() - 1);
+ },
- // private
- afterRender : function(){
- Ext.Tip.superclass.afterRender.call(this);
- if(this.closable){
- this.addTool({
- id: 'close',
- handler: this[this.closeAction],
- scope: this
- });
+ enter: function(e) {
+ this.selectHighlighted(e);
}
},
/**
- * Shows this tip at the specified XY position. Example usage:
- *
-// Show the tip at x:50 and y:100
-tip.showAt([50,100]);
-
- * @param {Array} xy An array containing the x and y coordinates
+ * Highlights the item at the given index.
+ * @param {Number} index
*/
- showAt : function(xy){
- Ext.Tip.superclass.show.call(this);
- if(this.measureWidth !== false && (!this.initialConfig || typeof this.initialConfig.width != 'number')){
- this.doAutoWidth();
- }
- if(this.constrainPosition){
- xy = this.el.adjustForConstraints(xy);
- }
- this.setPagePosition(xy[0], xy[1]);
- },
-
- // protected
- doAutoWidth : function(adjust){
- adjust = adjust || 0;
- var bw = this.body.getTextWidth();
- if(this.title){
- bw = Math.max(bw, this.header.child('span').getTextWidth(this.title));
- }
- bw += this.getFrameWidth() + (this.closable ? 20 : 0) + this.body.getPadding("lr") + adjust;
- this.setWidth(bw.constrain(this.minWidth, this.maxWidth));
-
- // IE7 repaint bug on initial show
- if(Ext.isIE7 && !this.repainted){
- this.el.repaint();
- this.repainted = true;
+ 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);
}
},
/**
- * Experimental. Shows this tip at a position relative to another element using a standard {@link Ext.Element#alignTo}
- * anchor position value. Example usage:
- *
-// Show the tip at the default position ('tl-br?')
-tip.showBy('my-el');
-
-// Show the tip's top-left corner anchored to the element's top-right corner
-tip.showBy('my-el', 'tl-tr');
-
- * @param {Mixed} el An HTMLElement, Ext.Element or string id of the target element to align to
- * @param {String} position (optional) A valid {@link Ext.Element#alignTo} anchor position (defaults to 'tl-br?' or
- * {@link #defaultAlign} if specified).
+ * Triggers selection of the currently highlighted item according to the behavior of
+ * the configured SelectionModel.
*/
- showBy : function(el, pos){
- if(!this.rendered){
- this.render(Ext.getBody());
+ selectHighlighted: function(e) {
+ var me = this,
+ boundList = me.boundList,
+ highlighted = boundList.highlightedItem,
+ selModel = boundList.getSelectionModel();
+ if (highlighted) {
+ selModel.selectWithEvent(boundList.getRecord(highlighted), e);
}
- this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign));
- },
-
- initDraggable : function(){
- this.dd = new Ext.Tip.DD(this, typeof this.draggable == 'boolean' ? null : this.draggable);
- this.header.addClass('x-tip-draggable');
}
-});
-
-Ext.reg('tip', Ext.Tip);
-
-// private - custom Tip DD implementation
-Ext.Tip.DD = function(tip, config){
- Ext.apply(this, config);
- this.tip = tip;
- Ext.Tip.DD.superclass.constructor.call(this, tip.el.id, 'WindowDD-'+tip.id);
- this.setHandleElId(tip.header.id);
- this.scroll = false;
-};
-Ext.extend(Ext.Tip.DD, Ext.dd.DD, {
- moveOnly:true,
- scroll:false,
- headerOffsets:[100, 25],
- startDrag : function(){
- this.tip.el.disableShadow();
- },
- endDrag : function(e){
- this.tip.el.enableShadow(true);
- }
-});/**
- * @class Ext.ToolTip
- * @extends Ext.Tip
- * A standard tooltip implementation for providing additional information when hovering over a target element.
- * @xtype tooltip
+});
+/**
+ * @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 `<input>` field and a `<select>`
+ * field; the user is able to type freely into the field, and/or pick values from a dropdown selection
+ * list. The user can input any value by default, even if it does not appear in the selection list;
+ * to prevent free-form values and restrict them to items in the list, set {@link #forceSelection} to `true`.
+ *
+ * The selection list's options are populated from any {@link Ext.data.Store}, including remote
+ * stores. The data items in the store are mapped to each option's displayed text and backing value via
+ * the {@link #valueField} and {@link #displayField} configurations, respectively.
+ *
+ * If your store is not remote, i.e. it depends only on local data and is loaded up front, you should be
+ * sure to set the {@link #queryMode} to `'local'`, as this will improve responsiveness for the user.
+ *
+ * {@img Ext.form.ComboBox/Ext.form.ComboBox.png Ext.form.ComboBox component}
+ *
+ * ## Example usage:
+ *
+ * // The data store containing the list of states
+ * var states = Ext.create('Ext.data.Store', {
+ * fields: ['abbr', 'name'],
+ * data : [
+ * {"abbr":"AL", "name":"Alabama"},
+ * {"abbr":"AK", "name":"Alaska"},
+ * {"abbr":"AZ", "name":"Arizona"}
+ * //...
+ * ]
+ * });
+ *
+ * // Create the combo box, attached to the states data store
+ * Ext.create('Ext.form.ComboBox', {
+ * fieldLabel: 'Choose State',
+ * store: states,
+ * queryMode: 'local',
+ * displayField: 'name',
+ * valueField: 'abbr',
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * ## Events
+ *
+ * To do something when something in ComboBox is selected, configure the select event:
+ *
+ * var cb = Ext.create('Ext.form.ComboBox', {
+ * // all of your config options
+ * listeners:{
+ * scope: yourScope,
+ * 'select': yourFunction
+ * }
+ * });
+ *
+ * // Alternatively, you can assign events after the object is created:
+ * var cb = new Ext.form.field.ComboBox(yourOptions);
+ * cb.on('select', yourFunction, yourScope);
+ *
+ * ## Multiple Selection
+ *
+ * ComboBox also allows selection of multiple items from the list; to enable multi-selection set the
+ * {@link #multiSelect} config to `true`.
+ *
* @constructor
- * Create a new Tooltip
- * @param {Object} config The configuration options
+ * Create a new ComboBox.
+ * @param {Object} config Configuration options
+ * @xtype combo
+ * @docauthor Jason Johnston
*/
-Ext.ToolTip = Ext.extend(Ext.Tip, {
- /**
- * When a Tooltip is configured with the {@link #delegate}
- * option to cause selected child elements of the {@link #target}
- * Element to each trigger a seperate show event, this property is set to
- * the DOM element which triggered the show.
- * @type DOMElement
- * @property triggerElement
- */
+Ext.define('Ext.form.field.ComboBox', {
+ extend:'Ext.form.field.Picker',
+ requires: ['Ext.util.DelayedTask', 'Ext.EventObject', 'Ext.view.BoundList', 'Ext.view.BoundListKeyNav', 'Ext.data.StoreManager'],
+ alternateClassName: 'Ext.form.ComboBox',
+ alias: ['widget.combobox', 'widget.combo'],
+
/**
- * @cfg {Mixed} target The target HTMLElement, Ext.Element or id to monitor
- * for mouseover events to trigger showing this ToolTip.
+ * @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 'x-form-arrow-trigger' for ComboBox.
*/
+ triggerCls: Ext.baseCSSPrefix + 'form-arrow-trigger',
+
/**
- * @cfg {Boolean} autoHide True to automatically hide the tooltip after the
- * mouse exits the target element or after the {@link #dismissDelay}
- * has expired if set (defaults to true). If {@link closable} = true
- * a close tool button will be rendered into the tooltip header.
+ * @cfg {Ext.data.Store/Array} store The data source to which this combo is bound (defaults to undefined).
+ * Acceptable values for this property are:
+ *
+ * - any {@link Ext.data.Store Store} subclass
+ * - an Array : Arrays will be converted to a {@link Ext.data.Store} internally,
+ * automatically generating {@link Ext.data.Field#name field names} to work with all data components.
+ *
+ * - 1-dimensional array : (e.g., ['Foo','Bar'])
+ * A 1-dimensional array will automatically be expanded (each array item will be used for both the combo
+ * {@link #valueField} and {@link #displayField})
+ * - 2-dimensional array : (e.g., [['f','Foo'],['b','Bar']])
+ * For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo
+ * {@link #valueField}, while the value at index 1 is assumed to be the combo {@link #displayField}.
+ *
+ * See also {@link #queryMode}.
*/
+
/**
- * @cfg {Number} showDelay Delay in milliseconds before the tooltip displays
- * after the mouse enters the target element (defaults to 500)
+ * @cfg {Boolean} multiSelect
+ * If set to true, allows the combo field to hold more than one value at a time, and allows selecting
+ * multiple items from the dropdown list. The combo's text field will show all selected values separated by
+ * the {@link #delimiter}. (Defaults to false.)
*/
- showDelay : 500,
+ multiSelect: false,
+
/**
- * @cfg {Number} hideDelay Delay in milliseconds after the mouse exits the
- * target element but before the tooltip actually hides (defaults to 200).
- * Set to 0 for the tooltip to hide immediately.
+ * @cfg {String} delimiter
+ * The character(s) used to separate the {@link #displayField display values} of multiple selected items
+ * when {@link #multiSelect} = true. Defaults to ', '.
*/
- hideDelay : 200,
+ delimiter: ', ',
+
/**
- * @cfg {Number} dismissDelay Delay in milliseconds before the tooltip
- * automatically hides (defaults to 5000). To disable automatic hiding, set
- * dismissDelay = 0.
+ * @cfg {String} displayField The underlying {@link Ext.data.Field#name data field name} to bind to this
+ * ComboBox (defaults to 'text').
+ * See also {@link #valueField}.
*/
- dismissDelay : 5000,
+ displayField: 'text',
+
/**
- * @cfg {Array} mouseOffset An XY offset from the mouse position where the
- * tooltip should be shown (defaults to [15,18]).
+ * @cfg {String} valueField
+ * @required
+ * The underlying {@link Ext.data.Field#name data value name} to bind to this ComboBox (defaults to match
+ * the value of the {@link #displayField} config).
+ * Note: use of a valueField requires the user to make a selection in order for a value to be
+ * mapped. See also {@link #displayField}.
*/
+
/**
- * @cfg {Boolean} trackMouse True to have the tooltip follow the mouse as it
- * moves over the target element (defaults to false).
+ * @cfg {String} triggerAction The action to execute when the trigger is clicked.
+ *
+ * - 'all' : Default
+ *
{@link #doQuery run the query} specified by the {@link #allQuery} config option
+ * - 'query' :
+ *
{@link #doQuery run the query} using the {@link Ext.form.field.Base#getRawValue raw value}.
+ *
+ * See also {@link #queryParam}
.
*/
- trackMouse : false,
+ triggerAction: 'all',
+
/**
- * @cfg {Boolean} anchorToTarget True to anchor the tooltip to the target
- * element, false to anchor it relative to the mouse coordinates (defaults
- * to true). When anchorToTarget
is true, use
- * {@link #defaultAlign}
to control tooltip alignment to the
- * target element. When anchorToTarget
is false, use
- * {@link #anchorPosition}
instead to control alignment.
+ * @cfg {String} allQuery The text query to send to the server to return all records for the list
+ * with no filtering (defaults to '')
*/
- anchorToTarget : true,
+ allQuery: '',
+
/**
- * @cfg {Number} anchorOffset A numeric pixel value used to offset the
- * default position of the anchor arrow (defaults to 0). When the anchor
- * position is on the top or bottom of the tooltip, anchorOffset
- * will be used as a horizontal offset. Likewise, when the anchor position
- * is on the left or right side, anchorOffset
will be used as
- * a vertical offset.
+ * @cfg {String} queryParam Name of the query ({@link Ext.data.Store#baseParam baseParam} name for the store)
+ * as it will be passed on the querystring (defaults to 'query')
*/
- anchorOffset : 0,
+ queryParam: 'query',
+
/**
- * @cfg {String} delegate Optional. A {@link Ext.DomQuery DomQuery}
- * selector which allows selection of individual elements within the
- * {@link #target}
element to trigger showing and hiding the
- * ToolTip as the mouse moves within the target.
- * When specified, the child element of the target which caused a show
- * event is placed into the {@link #triggerElement}
property
- * before the ToolTip is shown.
- * This may be useful when a Component has regular, repeating elements
- * in it, each of which need a Tooltip which contains information specific
- * to that element. For example:
-var myGrid = new Ext.grid.gridPanel(gridConfig);
-myGrid.on('render', function(grid) {
- var store = grid.getStore(); // Capture the Store.
- var view = grid.getView(); // Capture the GridView.
- myGrid.tip = new Ext.ToolTip({
- target: view.mainBody, // The overall target element.
- delegate: '.x-grid3-row', // Each grid row causes its own seperate show and hide.
- trackMouse: true, // Moving within the row should not hide the tip.
- renderTo: document.body, // Render immediately so that tip.body can be
- // referenced prior to the first show.
- listeners: { // Change content dynamically depending on which element
- // triggered the show.
- beforeshow: function updateTipBody(tip) {
- var rowIndex = view.findRowIndex(tip.triggerElement);
- tip.body.dom.innerHTML = 'Over Record ID ' + store.getAt(rowIndex).id;
- }
- }
- });
+ * @cfg {String} queryMode
+ * The mode for queries. Acceptable values are:
+ *
+ * - 'remote' : Default
+ *
Automatically loads the {@link #store} the first time the trigger
+ * is clicked. If you do not want the store to be automatically loaded the first time the trigger is
+ * clicked, set to 'local' and manually load the store. To force a requery of the store
+ * every time the trigger is clicked see {@link #lastQuery}.
+ * - 'local' :
+ *
ComboBox loads local data
+ *
+var combo = new Ext.form.field.ComboBox({
+ renderTo: document.body,
+ queryMode: 'local',
+ store: new Ext.data.ArrayStore({
+ id: 0,
+ fields: [
+ 'myId', // numeric value is the key
+ 'displayText'
+ ],
+ data: [[1, 'item1'], [2, 'item2']] // data is local
+ }),
+ valueField: 'myId',
+ displayField: 'displayText',
+ triggerAction: 'all'
});
- *
+ *
+ *
*/
+ queryMode: 'remote',
- // private
- targetCounter : 0,
-
- constrainPosition : false,
-
- // private
- initComponent : function(){
- Ext.ToolTip.superclass.initComponent.call(this);
- this.lastActive = new Date();
- this.initTarget(this.target);
- this.origAnchor = this.anchor;
- },
-
- // private
- onRender : function(ct, position){
- Ext.ToolTip.superclass.onRender.call(this, ct, position);
- this.anchorCls = 'x-tip-anchor-' + this.getAnchorPosition();
- this.anchorEl = this.el.createChild({
- cls: 'x-tip-anchor ' + this.anchorCls
- });
- },
-
- // private
- afterRender : function(){
- Ext.ToolTip.superclass.afterRender.call(this);
- this.anchorEl.setStyle('z-index', this.el.getZIndex() + 1).setVisibilityMode(Ext.Element.DISPLAY);
- },
+ queryCaching: true,
/**
- * Binds this ToolTip to the specified element. The tooltip will be displayed when the mouse moves over the element.
- * @param {Mixed} t The Element, HtmlElement, or ID of an element to bind to
+ * @cfg {Number} pageSize If greater than 0, a {@link Ext.toolbar.Paging} is displayed in the
+ * footer of the dropdown list and the {@link #doQuery filter queries} will execute with page start and
+ * {@link Ext.toolbar.Paging#pageSize limit} parameters. Only applies when {@link #queryMode} = 'remote'
+ * (defaults to 0).
*/
- initTarget : function(target){
- var t;
- if((t = Ext.get(target))){
- if(this.target){
- var tg = Ext.get(this.target);
- this.mun(tg, 'mouseover', this.onTargetOver, this);
- this.mun(tg, 'mouseout', this.onTargetOut, this);
- this.mun(tg, 'mousemove', this.onMouseMove, this);
- }
- this.mon(t, {
- mouseover: this.onTargetOver,
- mouseout: this.onTargetOut,
- mousemove: this.onMouseMove,
- scope: this
- });
- this.target = t;
- }
- if(this.anchor){
- this.anchorTarget = this.target;
- }
- },
-
- // private
- onMouseMove : function(e){
- var t = this.delegate ? e.getTarget(this.delegate) : this.triggerElement = true;
- if (t) {
- this.targetXY = e.getXY();
- if (t === this.triggerElement) {
- if(!this.hidden && this.trackMouse){
- this.setPagePosition(this.getTargetXY());
- }
- } else {
- this.hide();
- this.lastActive = new Date(0);
- this.onTargetOver(e);
- }
- } else if (!this.closable && this.isVisible()) {
- this.hide();
- }
- },
-
- // private
- getTargetXY : function(){
- if(this.delegate){
- this.anchorTarget = this.triggerElement;
- }
- if(this.anchor){
- this.targetCounter++;
- var offsets = this.getOffsets(),
- xy = (this.anchorToTarget && !this.trackMouse) ? this.el.getAlignToXY(this.anchorTarget, this.getAnchorAlign()) : this.targetXY,
- dw = Ext.lib.Dom.getViewWidth() - 5,
- dh = Ext.lib.Dom.getViewHeight() - 5,
- de = document.documentElement,
- bd = document.body,
- scrollX = (de.scrollLeft || bd.scrollLeft || 0) + 5,
- scrollY = (de.scrollTop || bd.scrollTop || 0) + 5,
- axy = [xy[0] + offsets[0], xy[1] + offsets[1]],
- sz = this.getSize();
-
- this.anchorEl.removeClass(this.anchorCls);
-
- if(this.targetCounter < 2){
- if(axy[0] < scrollX){
- if(this.anchorToTarget){
- this.defaultAlign = 'l-r';
- if(this.mouseOffset){this.mouseOffset[0] *= -1;}
- }
- this.anchor = 'left';
- return this.getTargetXY();
- }
- if(axy[0]+sz.width > dw){
- if(this.anchorToTarget){
- this.defaultAlign = 'r-l';
- if(this.mouseOffset){this.mouseOffset[0] *= -1;}
- }
- this.anchor = 'right';
- return this.getTargetXY();
- }
- if(axy[1] < scrollY){
- if(this.anchorToTarget){
- this.defaultAlign = 't-b';
- if(this.mouseOffset){this.mouseOffset[1] *= -1;}
- }
- this.anchor = 'top';
- return this.getTargetXY();
- }
- if(axy[1]+sz.height > dh){
- if(this.anchorToTarget){
- this.defaultAlign = 'b-t';
- if(this.mouseOffset){this.mouseOffset[1] *= -1;}
- }
- this.anchor = 'bottom';
- return this.getTargetXY();
- }
- }
-
- this.anchorCls = 'x-tip-anchor-'+this.getAnchorPosition();
- this.anchorEl.addClass(this.anchorCls);
- this.targetCounter = 0;
- return axy;
- }else{
- var mouseOffset = this.getMouseOffset();
- return [this.targetXY[0]+mouseOffset[0], this.targetXY[1]+mouseOffset[1]];
- }
- },
-
- getMouseOffset : function(){
- var offset = this.anchor ? [0,0] : [15,18];
- if(this.mouseOffset){
- offset[0] += this.mouseOffset[0];
- offset[1] += this.mouseOffset[1];
- }
- return offset;
- },
+ pageSize: 0,
- // private
- getAnchorPosition : function(){
- if(this.anchor){
- this.tipAnchor = this.anchor.charAt(0);
- }else{
- var m = this.defaultAlign.match(/^([a-z]+)-([a-z]+)(\?)?$/);
- if(!m){
- throw 'AnchorTip.defaultAlign is invalid';
- }
- this.tipAnchor = m[1].charAt(0);
- }
+ /**
+ * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and
+ * sending the query to filter the dropdown list (defaults to 500 if {@link #queryMode} = 'remote'
+ * or 10 if {@link #queryMode} = 'local')
+ */
- switch(this.tipAnchor){
- case 't': return 'top';
- case 'b': return 'bottom';
- case 'r': return 'right';
- }
- return 'left';
- },
+ /**
+ * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and
+ * {@link #typeAhead} activate (defaults to 4 if {@link #queryMode} = 'remote' or 0 if
+ * {@link #queryMode} = 'local', does not apply if {@link Ext.form.field.Trigger#editable editable} = false).
+ */
- // private
- getAnchorAlign : function(){
- switch(this.anchor){
- case 'top' : return 'tl-bl';
- case 'left' : return 'tl-tr';
- case 'right': return 'tr-tl';
- default : return 'bl-tl';
- }
- },
+ /**
+ * @cfg {Boolean} autoSelect true to select the first result gathered by the data store (defaults
+ * to true). A false value would require a manual selection from the dropdown list to set the components value
+ * unless the value of ({@link #typeAhead}) were true.
+ */
+ autoSelect: true,
- // private
- getOffsets : function(){
- var offsets,
- ap = this.getAnchorPosition().charAt(0);
- if(this.anchorToTarget && !this.trackMouse){
- switch(ap){
- case 't':
- offsets = [0, 9];
- break;
- case 'b':
- offsets = [0, -13];
- break;
- case 'r':
- offsets = [-13, 0];
- break;
- default:
- offsets = [9, 0];
- break;
- }
- }else{
- switch(ap){
- case 't':
- offsets = [-15-this.anchorOffset, 30];
- break;
- case 'b':
- offsets = [-19-this.anchorOffset, -13-this.el.dom.offsetHeight];
- break;
- case 'r':
- offsets = [-15-this.el.dom.offsetWidth, -13-this.anchorOffset];
- break;
- default:
- offsets = [25, -13-this.anchorOffset];
- break;
- }
- }
- var mouseOffset = this.getMouseOffset();
- offsets[0] += mouseOffset[0];
- offsets[1] += mouseOffset[1];
+ /**
+ * @cfg {Boolean} typeAhead true to populate and autoselect the remainder of the text being
+ * typed after a configurable delay ({@link #typeAheadDelay}) if it matches a known value (defaults
+ * to false)
+ */
+ typeAhead: false,
- return offsets;
- },
+ /**
+ * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
+ * if {@link #typeAhead} = true (defaults to 250)
+ */
+ typeAheadDelay: 250,
- // private
- onTargetOver : function(e){
- if(this.disabled || e.within(this.target.dom, true)){
- return;
- }
- var t = e.getTarget(this.delegate);
- if (t) {
- this.triggerElement = t;
- this.clearTimer('hide');
- this.targetXY = e.getXY();
- this.delayShow();
- }
- },
+ /**
+ * @cfg {Boolean} selectOnTab
+ * Whether the Tab key should select the currently highlighted item. Defaults to true.
+ */
+ selectOnTab: true,
- // private
- delayShow : function(){
- if(this.hidden && !this.showTimer){
- if(this.lastActive.getElapsed() < this.quickShowInterval){
- this.show();
- }else{
- this.showTimer = this.show.defer(this.showDelay, this);
- }
- }else if(!this.hidden && this.autoHide !== false){
- this.show();
- }
- },
+ /**
+ * @cfg {Boolean} forceSelection true to restrict the selected value to one of the values in the list,
+ * false to allow the user to set arbitrary text into the field (defaults to false)
+ */
+ forceSelection: false,
- // private
- onTargetOut : function(e){
- if(this.disabled || e.within(this.target.dom, true)){
- return;
- }
- this.clearTimer('show');
- if(this.autoHide !== false){
- this.delayHide();
- }
- },
+ /**
+ * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
+ * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this
+ * default text is used, it means there is no value set and no validation will occur on this field.
+ */
- // private
- delayHide : function(){
- if(!this.hidden && !this.hideTimer){
- this.hideTimer = this.hide.defer(this.hideDelay, this);
+ /**
+ * The value of the match string used to filter the store. Delete this property to force a requery.
+ * Example use:
+ *
+var combo = new Ext.form.field.ComboBox({
+ ...
+ queryMode: 'remote',
+ listeners: {
+ // delete the previous query in the beforequery event or set
+ // combo.lastQuery = null (this will reload the store the next time it expands)
+ beforequery: function(qe){
+ delete qe.combo.lastQuery;
}
- },
+ }
+});
+ *
+ * To make sure the filter in the store is not cleared the first time the ComboBox trigger is used
+ * configure the combo with lastQuery=''. Example use:
+ *
+var combo = new Ext.form.field.ComboBox({
+ ...
+ queryMode: 'local',
+ triggerAction: 'all',
+ lastQuery: ''
+});
+ *
+ * @property lastQuery
+ * @type String
+ */
/**
- * Hides this tooltip if visible.
+ * @cfg {Object} defaultListConfig
+ * Set of options that will be used as defaults for the user-configured {@link #listConfig} object.
*/
- hide: function(){
- this.clearTimer('dismiss');
- this.lastActive = new Date();
- if(this.anchorEl){
- this.anchorEl.hide();
- }
- Ext.ToolTip.superclass.hide.call(this);
- delete this.triggerElement;
+ defaultListConfig: {
+ emptyText: '',
+ loadingText: 'Loading...',
+ loadingHeight: 70,
+ minWidth: 70,
+ maxHeight: 300,
+ shadow: 'sides'
},
/**
- * Shows this tooltip at the current event target XY position.
+ * @cfg {Mixed} transform
+ * The id, DOM node or {@link Ext.core.Element} of an existing HTML <select> element to
+ * convert into a ComboBox. The target select's options will be used to build the options in the ComboBox
+ * dropdown; a configured {@link #store} will take precedence over this.
*/
- show : function(){
- if(this.anchor){
- // pre-show it off screen so that the el will have dimensions
- // for positioning calcs when getting xy next
- this.showAt([-1000,-1000]);
- this.origConstrainPosition = this.constrainPosition;
- this.constrainPosition = false;
- this.anchor = this.origAnchor;
- }
- this.showAt(this.getTargetXY());
-
- if(this.anchor){
- this.syncAnchor();
- this.anchorEl.show();
- this.constrainPosition = this.origConstrainPosition;
- }else{
- this.anchorEl.hide();
- }
- },
- // inherit docs
- showAt : function(xy){
- this.lastActive = new Date();
- this.clearTimers();
- Ext.ToolTip.superclass.showAt.call(this, xy);
- if(this.dismissDelay && this.autoHide !== false){
- this.dismissTimer = this.hide.defer(this.dismissDelay, this);
+ /**
+ * @cfg {Object} listConfig
+ * An optional set of configuration properties that will be passed to the {@link Ext.view.BoundList}'s
+ * constructor. Any configuration that is valid for BoundList can be included. Some of the more useful
+ * ones are:
+ *
+ * - {@link Ext.view.BoundList#cls} - defaults to empty
+ * - {@link Ext.view.BoundList#emptyText} - defaults to empty string
+ * - {@link Ext.view.BoundList#getInnerTpl} - defaults to the template defined in BoundList
+ * - {@link Ext.view.BoundList#itemSelector} - defaults to the value defined in BoundList
+ * - {@link Ext.view.BoundList#loadingText} - defaults to 'Loading...'
+ * - {@link Ext.view.BoundList#minWidth} - defaults to 70
+ * - {@link Ext.view.BoundList#maxWidth} - defaults to undefined
+ * - {@link Ext.view.BoundList#maxHeight} - defaults to 300
+ * - {@link Ext.view.BoundList#resizable} - defaults to false
+ * - {@link Ext.view.BoundList#shadow} - defaults to 'sides'
+ * - {@link Ext.view.BoundList#width} - defaults to undefined (automatically set to the width
+ * of the ComboBox field if {@link #matchFieldWidth} is true)
+ *
+ */
+
+ //private
+ ignoreSelection: 0,
+
+ initComponent: function() {
+ var me = this,
+ isDefined = Ext.isDefined,
+ store = me.store,
+ transform = me.transform,
+ transformSelect, isLocalMode;
+
+ if (!store && !transform) {
+ Ext.Error.raise('Either a valid store, or a HTML select to transform, must be configured on the combo.');
}
- if(this.anchor && !this.anchorEl.isVisible()){
- this.syncAnchor();
- this.anchorEl.show();
- }else{
- this.anchorEl.hide();
+ if (me.typeAhead && me.multiSelect) {
+ Ext.Error.raise('typeAhead and multiSelect are mutually exclusive options -- please remove one of them.');
}
- },
-
- // private
- syncAnchor : function(){
- var anchorPos, targetPos, offset;
- switch(this.tipAnchor.charAt(0)){
- case 't':
- anchorPos = 'b';
- targetPos = 'tl';
- offset = [20+this.anchorOffset, 2];
- break;
- case 'r':
- anchorPos = 'l';
- targetPos = 'tr';
- offset = [-2, 11+this.anchorOffset];
- break;
- case 'b':
- anchorPos = 't';
- targetPos = 'bl';
- offset = [20+this.anchorOffset, -2];
- break;
- default:
- anchorPos = 'r';
- targetPos = 'tl';
- offset = [2, 11+this.anchorOffset];
- break;
+ if (me.typeAhead && !me.editable) {
+ Ext.Error.raise('If typeAhead is enabled the combo must be editable: true -- please change one of those settings.');
}
- this.anchorEl.alignTo(this.el, anchorPos+'-'+targetPos, offset);
- },
-
- // private
- setPagePosition : function(x, y){
- Ext.ToolTip.superclass.setPagePosition.call(this, x, y);
- if(this.anchor){
- this.syncAnchor();
+ if (me.selectOnFocus && !me.editable) {
+ Ext.Error.raise('If selectOnFocus is enabled the combo must be editable: true -- please change one of those settings.');
}
- },
-
- // private
- clearTimer : function(name){
- name = name + 'Timer';
- clearTimeout(this[name]);
- delete this[name];
- },
- // private
- clearTimers : function(){
- this.clearTimer('show');
- this.clearTimer('dismiss');
- this.clearTimer('hide');
- },
+ this.addEvents(
+ // TODO need beforeselect?
- // private
- onShow : function(){
- Ext.ToolTip.superclass.onShow.call(this);
- Ext.getDoc().on('mousedown', this.onDocMouseDown, this);
- },
+ /**
+ * @event beforequery
+ * Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
+ * cancel property to true.
+ * @param {Object} queryEvent An object that has these properties:
+ * combo
: Ext.form.field.ComboBox This combo box
+ * query
: String The query string
+ * forceAll
: Boolean True to force "all" query
+ * cancel
: Boolean Set to true to cancel the query
+ *
+ */
+ 'beforequery',
- // private
- onHide : function(){
- Ext.ToolTip.superclass.onHide.call(this);
- Ext.getDoc().un('mousedown', this.onDocMouseDown, this);
- },
+ /*
+ * @event select
+ * Fires when at least one list item is selected.
+ * @param {Ext.form.field.ComboBox} combo This combo box
+ * @param {Array} records The selected records
+ */
+ 'select'
+ );
- // private
- onDocMouseDown : function(e){
- if(this.autoHide !== true && !this.closable && !e.within(this.el.dom)){
- this.disable();
- this.doEnable.defer(100, this);
+ // Build store from 'transform' HTML select element's options
+ if (!store && transform) {
+ transformSelect = Ext.getDom(transform);
+ if (transformSelect) {
+ store = Ext.Array.map(Ext.Array.from(transformSelect.options), function(option) {
+ return [option.value, option.text];
+ });
+ if (!me.name) {
+ me.name = transformSelect.name;
+ }
+ if (!('value' in me)) {
+ me.value = transformSelect.value;
+ }
+ }
}
- },
-
- // private
- doEnable : function(){
- if(!this.isDestroyed){
- this.enable();
+
+ me.bindStore(store, true);
+ store = me.store;
+ if (store.autoCreated) {
+ me.queryMode = 'local';
+ me.valueField = me.displayField = 'field1';
+ if (!store.expanded) {
+ me.displayField = 'field2';
+ }
}
- },
- // private
- onDisable : function(){
- this.clearTimers();
- this.hide();
- },
- // private
- adjustPosition : function(x, y){
- if(this.contstrainPosition){
- var ay = this.targetXY[1], h = this.getSize().height;
- if(y <= ay && (y+h) >= ay){
- y = ay-h-5;
- }
+ if (!isDefined(me.valueField)) {
+ me.valueField = me.displayField;
}
- return {x : x, y: y};
- },
-
- beforeDestroy : function(){
- this.clearTimers();
- Ext.destroy(this.anchorEl);
- delete this.anchorEl;
- delete this.target;
- delete this.anchorTarget;
- delete this.triggerElement;
- Ext.ToolTip.superclass.beforeDestroy.call(this);
- },
- // private
- onDestroy : function(){
- Ext.getDoc().un('mousedown', this.onDocMouseDown, this);
- Ext.ToolTip.superclass.onDestroy.call(this);
- }
-});
+ isLocalMode = me.queryMode === 'local';
+ if (!isDefined(me.queryDelay)) {
+ me.queryDelay = isLocalMode ? 10 : 500;
+ }
+ if (!isDefined(me.minChars)) {
+ me.minChars = isLocalMode ? 0 : 4;
+ }
-Ext.reg('tooltip', Ext.ToolTip);/**
- * @class Ext.QuickTip
- * @extends Ext.ToolTip
- * @xtype quicktip
- * A specialized tooltip class for tooltips that can be specified in markup and automatically managed by the global
- * {@link Ext.QuickTips} instance. See the QuickTips class header for additional usage details and examples.
- * @constructor
- * Create a new Tip
- * @param {Object} config The configuration options
- */
-Ext.QuickTip = Ext.extend(Ext.ToolTip, {
- /**
- * @cfg {Mixed} target The target HTMLElement, Ext.Element or id to associate with this quicktip (defaults to the document).
- */
- /**
- * @cfg {Boolean} interceptTitles True to automatically use the element's DOM title value if available (defaults to false).
- */
- interceptTitles : false,
+ if (!me.displayTpl) {
+ me.displayTpl = Ext.create('Ext.XTemplate',
+ '' +
+ '{[typeof values === "string" ? values : values.' + me.displayField + ']}' +
+ '' + me.delimiter + ' ' +
+ ' '
+ );
+ } else if (Ext.isString(me.displayTpl)) {
+ me.displayTpl = Ext.create('Ext.XTemplate', me.displayTpl);
+ }
- // private
- tagConfig : {
- namespace : "ext",
- attribute : "qtip",
- width : "qwidth",
- target : "target",
- title : "qtitle",
- hide : "hide",
- cls : "qclass",
- align : "qalign",
- anchor : "anchor"
- },
+ me.callParent();
- // private
- initComponent : function(){
- this.target = this.target || Ext.getDoc();
- this.targets = this.targets || {};
- Ext.QuickTip.superclass.initComponent.call(this);
- },
+ me.doQueryTask = Ext.create('Ext.util.DelayedTask', me.doRawQuery, me);
- /**
- * Configures a new quick tip instance and assigns it to a target element. The following config values are
- * supported (for example usage, see the {@link Ext.QuickTips} class header):
- *
- * - autoHide
- * - cls
- * - dismissDelay (overrides the singleton value)
- * - target (required)
- * - text (required)
- * - title
- * - width
- * @param {Object} config The config object
- */
- register : function(config){
- var cs = Ext.isArray(config) ? config : arguments;
- for(var i = 0, len = cs.length; i < len; i++){
- var c = cs[i];
- var target = c.target;
- if(target){
- if(Ext.isArray(target)){
- for(var j = 0, jlen = target.length; j < jlen; j++){
- this.targets[Ext.id(target[j])] = c;
- }
- } else{
- this.targets[Ext.id(target)] = c;
- }
- }
+ // store has already been loaded, setValue
+ if (me.store.getCount() > 0) {
+ me.setValue(me.value);
}
- },
- /**
- * Removes this quick tip from its element and destroys it.
- * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed.
- */
- unregister : function(el){
- delete this.targets[Ext.id(el)];
- },
-
- /**
- * Hides a visible tip or cancels an impending show for a particular element.
- * @param {String/HTMLElement/Element} el The element that is the target of the tip.
- */
- cancelShow: function(el){
- var at = this.activeTarget;
- el = Ext.get(el).dom;
- if(this.isVisible()){
- if(at && at.el == el){
- this.hide();
- }
- }else if(at && at.el == el){
- this.clearTimer('show');
+ // render in place of 'transform' select
+ if (transformSelect) {
+ me.render(transformSelect.parentNode, transformSelect);
+ Ext.removeNode(transformSelect);
+ delete me.renderTo;
}
},
-
- getTipCfg: function(e) {
- var t = e.getTarget(),
- ttp,
- cfg;
- if(this.interceptTitles && t.title && Ext.isString(t.title)){
- ttp = t.title;
- t.qtip = ttp;
- t.removeAttribute("title");
- e.preventDefault();
- }else{
- cfg = this.tagConfig;
- ttp = t.qtip || Ext.fly(t).getAttribute(cfg.attribute, cfg.namespace);
+
+ beforeBlur: function() {
+ var me = this;
+ me.doQueryTask.cancel();
+ if (me.forceSelection) {
+ me.assertValue();
+ } else {
+ me.collapse();
}
- return ttp;
},
// private
- onTargetOver : function(e){
- if(this.disabled){
- return;
- }
- this.targetXY = e.getXY();
- var t = e.getTarget();
- if(!t || t.nodeType !== 1 || t == document || t == document.body){
- return;
- }
- if(this.activeTarget && ((t == this.activeTarget.el) || Ext.fly(this.activeTarget.el).contains(t))){
- this.clearTimer('hide');
- this.show();
- return;
- }
- if(t && this.targets[t.id]){
- this.activeTarget = this.targets[t.id];
- this.activeTarget.el = t;
- this.anchor = this.activeTarget.anchor;
- if(this.anchor){
- this.anchorTarget = t;
+ assertValue: function() {
+ var me = this,
+ value = me.getRawValue(),
+ rec;
+
+ if (me.multiSelect) {
+ // For multiselect, check that the current displayed value matches the current
+ // selection, if it does not then revert to the most recent selection.
+ if (value !== me.getDisplayValue()) {
+ me.setValue(me.lastSelection);
}
- this.delayShow();
- return;
- }
- var ttp, et = Ext.fly(t), cfg = this.tagConfig, ns = cfg.namespace;
- if(ttp = this.getTipCfg(e)){
- var autoHide = et.getAttribute(cfg.hide, ns);
- this.activeTarget = {
- el: t,
- text: ttp,
- width: et.getAttribute(cfg.width, ns),
- autoHide: autoHide != "user" && autoHide !== 'false',
- title: et.getAttribute(cfg.title, ns),
- cls: et.getAttribute(cfg.cls, ns),
- align: et.getAttribute(cfg.align, ns)
-
- };
- this.anchor = et.getAttribute(cfg.anchor, ns);
- if(this.anchor){
- this.anchorTarget = t;
+ } else {
+ // For single-select, match the displayed value to a record and select it,
+ // if it does not match a record then revert to the most recent selection.
+ rec = me.findRecordByDisplay(value);
+ if (rec) {
+ me.select(rec);
+ } else {
+ me.setValue(me.lastSelection);
}
- this.delayShow();
}
+ me.collapse();
},
- // private
- onTargetOut : function(e){
+ onTypeAhead: function() {
+ var me = this,
+ displayField = me.displayField,
+ record = me.store.findRecord(displayField, me.getRawValue()),
+ boundList = me.getPicker(),
+ newValue, len, selStart;
- // If moving within the current target, and it does not have a new tip, ignore the mouseout
- if (this.activeTarget && e.within(this.activeTarget.el) && !this.getTipCfg(e)) {
- return;
- }
+ if (record) {
+ newValue = record.get(displayField);
+ len = newValue.length;
+ selStart = me.getRawValue().length;
- this.clearTimer('show');
- if(this.autoHide !== false){
- this.delayHide();
- }
- },
+ boundList.highlightItem(boundList.getNode(record));
- // inherit docs
- showAt : function(xy){
- var t = this.activeTarget;
- if(t){
- if(!this.rendered){
- this.render(Ext.getBody());
- this.activeTarget = t;
- }
- if(t.width){
- this.setWidth(t.width);
- this.body.setWidth(this.adjustBodyWidth(t.width - this.getFrameWidth()));
- this.measureWidth = false;
- } else{
- this.measureWidth = true;
- }
- this.setTitle(t.title || '');
- this.body.update(t.text);
- this.autoHide = t.autoHide;
- this.dismissDelay = t.dismissDelay || this.dismissDelay;
- if(this.lastCls){
- this.el.removeClass(this.lastCls);
- delete this.lastCls;
- }
- if(t.cls){
- this.el.addClass(t.cls);
- this.lastCls = t.cls;
- }
- if(this.anchor){
- this.constrainPosition = false;
- }else if(t.align){ // TODO: this doesn't seem to work consistently
- xy = this.el.getAlignToXY(t.el, t.align);
- this.constrainPosition = false;
- }else{
- this.constrainPosition = true;
+ if (selStart !== 0 && selStart !== len) {
+ me.setRawValue(newValue);
+ me.selectText(selStart, newValue.length);
}
}
- Ext.QuickTip.superclass.showAt.call(this, xy);
},
- // inherit docs
- hide: function(){
- delete this.activeTarget;
- Ext.QuickTip.superclass.hide.call(this);
- }
-});
-Ext.reg('quicktip', Ext.QuickTip);/**
- * @class Ext.QuickTips
- * Provides attractive and customizable tooltips for any element. The QuickTips
- * singleton is used to configure and manage tooltips globally for multiple elements
- * in a generic manner. To create individual tooltips with maximum customizability,
- * you should consider either {@link Ext.Tip} or {@link Ext.ToolTip}.
- * Quicktips can be configured via tag attributes directly in markup, or by
- * registering quick tips programmatically via the {@link #register} method.
- * The singleton's instance of {@link Ext.QuickTip} is available via
- * {@link #getQuickTip}, and supports all the methods, and all the all the
- * configuration properties of Ext.QuickTip. These settings will apply to all
- * tooltips shown by the singleton.
- * Below is the summary of the configuration properties which can be used.
- * For detailed descriptions see {@link #getQuickTip}
- * QuickTips singleton configs (all are optional)
- * - dismissDelay
- * - hideDelay
- * - maxWidth
- * - minWidth
- * - showDelay
- * - trackMouse
- * Target element configs (optional unless otherwise noted)
- * - autoHide
- * - cls
- * - dismissDelay (overrides singleton value)
- * - target (required)
- * - text (required)
- * - title
- * - width
- * Here is an example showing how some of these config options could be used:
- *
-// Init the singleton. Any tag-based quick tips will start working.
-Ext.QuickTips.init();
+ // invoked when a different store is bound to this combo
+ // than the original
+ resetToDefault: function() {
-// Apply a set of config properties to the singleton
-Ext.apply(Ext.QuickTips.getQuickTip(), {
- maxWidth: 200,
- minWidth: 100,
- showDelay: 50,
- trackMouse: true
-});
+ },
-// Manually register a quick tip for a specific element
-Ext.QuickTips.register({
- target: 'my-div',
- title: 'My Tooltip',
- text: 'This tooltip was added in code',
- width: 100,
- dismissDelay: 20
-});
-
- * To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with
- * the ext: namespace. The HTML element itself is automatically set as the quick tip target. Here is the summary
- * of supported attributes (optional unless otherwise noted):
- * - hide: Specifying "user" is equivalent to setting autoHide = false. Any other value will be the
- * same as autoHide = true.
- * - qclass: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).
- * - qtip (required): The quick tip text (equivalent to the 'text' target element config).
- * - qtitle: The quick tip title (equivalent to the 'title' target element config).
- * - qwidth: The quick tip width (equivalent to the 'width' target element config).
- * Here is an example of configuring an HTML element to display a tooltip from markup:
- *
-// Add a quick tip to an HTML button
-<input type="button" value="OK" ext:qtitle="OK Button" ext:qwidth="100"
- ext:qtip="This is a quick tip from markup!"></input>
-
- * @singleton
- */
-Ext.QuickTips = function(){
- var tip, locks = [];
- return {
- /**
- * Initialize the global QuickTips instance and prepare any quick tips.
- * @param {Boolean} autoRender True to render the QuickTips container immediately to preload images. (Defaults to true)
- */
- init : function(autoRender){
- if(!tip){
- if(!Ext.isReady){
- Ext.onReady(function(){
- Ext.QuickTips.init(autoRender);
- });
- return;
- }
- tip = new Ext.QuickTip({elements:'header,body'});
- if(autoRender !== false){
- tip.render(Ext.getBody());
- }
- }
- },
+ bindStore: function(store, initial) {
+ var me = this,
+ oldStore = me.store;
- /**
- * Enable quick tips globally.
- */
- enable : function(){
- if(tip){
- locks.pop();
- if(locks.length < 1){
- tip.enable();
+ // this code directly accesses this.picker, bc invoking getPicker
+ // would create it when we may be preping to destroy it
+ if (oldStore && !initial) {
+ if (oldStore !== store && oldStore.autoDestroy) {
+ oldStore.destroy();
+ } else {
+ oldStore.un({
+ scope: me,
+ load: me.onLoad,
+ exception: me.collapse
+ });
+ }
+ if (!store) {
+ me.store = null;
+ if (me.picker) {
+ me.picker.bindStore(null);
}
}
- },
-
- /**
- * Disable quick tips globally.
- */
- disable : function(){
- if(tip){
- tip.disable();
+ }
+ if (store) {
+ if (!initial) {
+ me.resetToDefault();
}
- locks.push(1);
- },
-
- /**
- * Returns true if quick tips are enabled, else false.
- * @return {Boolean}
- */
- isEnabled : function(){
- return tip !== undefined && !tip.disabled;
- },
- /**
- * Gets the global QuickTips instance.
- */
- getQuickTip : function(){
- return tip;
- },
+ me.store = Ext.data.StoreManager.lookup(store);
+ me.store.on({
+ scope: me,
+ load: me.onLoad,
+ exception: me.collapse
+ });
- /**
- * Configures a new quick tip instance and assigns it to a target element. See
- * {@link Ext.QuickTip#register} for details.
- * @param {Object} config The config object
- */
- register : function(){
- tip.register.apply(tip, arguments);
- },
+ if (me.picker) {
+ me.picker.bindStore(store);
+ }
+ }
+ },
- /**
- * Removes any registered quick tip from the target element and destroys it.
- * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed.
- */
- unregister : function(){
- tip.unregister.apply(tip, arguments);
- },
+ onLoad: function() {
+ var me = this,
+ value = me.value;
- /**
- * Alias of {@link #register}.
- * @param {Object} config The config object
- */
- tips :function(){
- tip.register.apply(tip, arguments);
+ me.syncSelection();
+ if (me.picker && !me.picker.getSelectionModel().hasSelection()) {
+ me.doAutoSelect();
}
- }
-}();/**
- * @class Ext.slider.Tip
- * @extends Ext.Tip
- * Simple plugin for using an Ext.Tip with a slider to show the slider value. Example usage:
-
-new Ext.Slider({
- width: 214,
- minValue: 0,
- maxValue: 100,
- plugins: new Ext.slider.Tip()
-});
-
- * Optionally provide your own tip text by overriding getText:
-
- new Ext.Slider({
- width: 214,
- minValue: 0,
- maxValue: 100,
- plugins: new Ext.slider.Tip({
- getText: function(thumb){
- return String.format('{0}% complete', thumb.value);
- }
- })
- });
-
- */
-Ext.slider.Tip = Ext.extend(Ext.Tip, {
- minWidth: 10,
- offsets : [0, -10],
-
- init: function(slider) {
- slider.on({
- scope : this,
- dragstart: this.onSlide,
- drag : this.onSlide,
- dragend : this.hide,
- destroy : this.destroy
- });
},
-
+
/**
* @private
- * Called whenever a dragstart or drag event is received on the associated Thumb.
- * Aligns the Tip with the Thumb's new position.
- * @param {Ext.slider.MultiSlider} slider The slider
- * @param {Ext.EventObject} e The Event object
- * @param {Ext.slider.Thumb} thumb The thumb that the Tip is attached to
+ * Execute the query with the raw contents within the textfield.
*/
- onSlide : function(slider, e, thumb) {
- this.show();
- this.body.update(this.getText(thumb));
- this.doAutoWidth();
- this.el.alignTo(thumb.el, 'b-t?', this.offsets);
+ doRawQuery: function() {
+ this.doQuery(this.getRawValue());
},
/**
- * Used to create the text that appears in the Tip's body. By default this just returns
- * the value of the Slider Thumb that the Tip is attached to. Override to customize.
- * @param {Ext.slider.Thumb} thumb The Thumb that the Tip is attached to
- * @return {String} The text to display in the tip
- */
- getText : function(thumb) {
- return String(thumb.value);
- }
-});
-
-//backwards compatibility - SliderTip used to be a ux before 3.2
-Ext.ux.SliderTip = Ext.slider.Tip;/**
- * @class Ext.tree.TreePanel
- * @extends Ext.Panel
- * The TreePanel provides tree-structured UI representation of tree-structured data.
- * {@link Ext.tree.TreeNode TreeNode}s added to the TreePanel may each contain metadata
- * used by your application in their {@link Ext.tree.TreeNode#attributes attributes} property.
- * A TreePanel must have a {@link #root} node before it is rendered. This may either be
- * specified using the {@link #root} config option, or using the {@link #setRootNode} method.
- *
An example of tree rendered to an existing div:
-var tree = new Ext.tree.TreePanel({
- renderTo: 'tree-div',
- useArrows: true,
- autoScroll: true,
- animate: true,
- enableDD: true,
- containerScroll: true,
- border: false,
- // auto create TreeLoader
- dataUrl: 'get-nodes.php',
-
- root: {
- nodeType: 'async',
- text: 'Ext JS',
- draggable: false,
- id: 'source'
- }
-});
-
-tree.getRootNode().expand();
- *
- * The example above would work with a data packet similar to this:
-[{
- "text": "adapter",
- "id": "source\/adapter",
- "cls": "folder"
-}, {
- "text": "dd",
- "id": "source\/dd",
- "cls": "folder"
-}, {
- "text": "debug.js",
- "id": "source\/debug.js",
- "leaf": true,
- "cls": "file"
-}]
- *
- * An example of tree within a Viewport:
-new Ext.Viewport({
- layout: 'border',
- items: [{
- region: 'west',
- collapsible: true,
- title: 'Navigation',
- xtype: 'treepanel',
- width: 200,
- autoScroll: true,
- split: true,
- loader: new Ext.tree.TreeLoader(),
- root: new Ext.tree.AsyncTreeNode({
- expanded: true,
- children: [{
- text: 'Menu Option 1',
- leaf: true
- }, {
- text: 'Menu Option 2',
- leaf: true
- }, {
- text: 'Menu Option 3',
- leaf: true
- }]
- }),
- rootVisible: false,
- listeners: {
- click: function(n) {
- Ext.Msg.alert('Navigation Tree Click', 'You clicked: "' + n.attributes.text + '"');
- }
- }
- }, {
- region: 'center',
- xtype: 'tabpanel',
- // remaining code not shown ...
- }]
-});
-
- *
- * @cfg {Ext.tree.TreeNode} root The root node for the tree.
- * @cfg {Boolean} rootVisible false to hide the root node (defaults to true)
- * @cfg {Boolean} lines false to disable tree lines (defaults to true)
- * @cfg {Boolean} enableDD true to enable drag and drop
- * @cfg {Boolean} enableDrag true to enable just drag
- * @cfg {Boolean} enableDrop true to enable just drop
- * @cfg {Object} dragConfig Custom config to pass to the {@link Ext.tree.TreeDragZone} instance
- * @cfg {Object} dropConfig Custom config to pass to the {@link Ext.tree.TreeDropZone} instance
- * @cfg {String} ddGroup The DD group this TreePanel belongs to
- * @cfg {Boolean} ddAppendOnly true if the tree should only allow append drops (use for trees which are sorted)
- * @cfg {Boolean} ddScroll true to enable body scrolling
- * @cfg {Boolean} containerScroll true to register this container with ScrollManager
- * @cfg {Boolean} hlDrop false to disable node highlight on drop (defaults to the value of {@link Ext#enableFx})
- * @cfg {String} hlColor The color of the node highlight (defaults to 'C3DAF9')
- * @cfg {Boolean} animate true to enable animated expand/collapse (defaults to the value of {@link Ext#enableFx})
- * @cfg {Boolean} singleExpand true if only 1 node per branch may be expanded
- * @cfg {Object} selModel A tree selection model to use with this TreePanel (defaults to an {@link Ext.tree.DefaultSelectionModel})
- * @cfg {Boolean} trackMouseOver false to disable mouse over highlighting
- * @cfg {Ext.tree.TreeLoader} loader A {@link Ext.tree.TreeLoader} for use with this TreePanel
- * @cfg {String} pathSeparator The token used to separate sub-paths in path strings (defaults to '/')
- * @cfg {Boolean} useArrows true to use Vista-style arrows in the tree (defaults to false)
- * @cfg {String} requestMethod The HTTP request method for loading data (defaults to the value of {@link Ext.Ajax#method}).
- *
- * @constructor
- * @param {Object} config
- * @xtype treepanel
- */
-Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
- rootVisible : true,
- animate : Ext.enableFx,
- lines : true,
- enableDD : false,
- hlDrop : Ext.enableFx,
- pathSeparator : '/',
-
- /**
- * @cfg {Array} bubbleEvents
- * An array of events that, when fired, should be bubbled to any parent container.
- * See {@link Ext.util.Observable#enableBubble}.
- * Defaults to [].
+ * Executes a query to filter the dropdown list. Fires the {@link #beforequery} event prior to performing the
+ * query allowing the query action to be canceled if needed.
+ * @param {String} queryString The SQL query to execute
+ * @param {Boolean} forceAll true to force the query to execute even if there are currently fewer
+ * characters in the field than the minimum specified by the {@link #minChars} config option. It
+ * also clears any filter previously saved in the current store (defaults to false)
+ * @return {Boolean} true if the query was permitted to run, false if it was cancelled by a {@link #beforequery} handler.
*/
- bubbleEvents : [],
-
- initComponent : function(){
- Ext.tree.TreePanel.superclass.initComponent.call(this);
-
- if(!this.eventModel){
- this.eventModel = new Ext.tree.TreeEventModel(this);
- }
-
- // initialize the loader
- var l = this.loader;
- if(!l){
- l = new Ext.tree.TreeLoader({
- dataUrl: this.dataUrl,
- requestMethod: this.requestMethod
- });
- }else if(Ext.isObject(l) && !l.load){
- l = new Ext.tree.TreeLoader(l);
- }
- this.loader = l;
+ doQuery: function(queryString, forceAll) {
+ queryString = queryString || '';
- this.nodeHash = {};
+ // store in object and pass by reference in 'beforequery'
+ // so that client code can modify values.
+ var me = this,
+ qe = {
+ query: queryString,
+ forceAll: forceAll,
+ combo: me,
+ cancel: false
+ },
+ store = me.store,
+ isLocalMode = me.queryMode === 'local';
- /**
- * The root node of this tree.
- * @type Ext.tree.TreeNode
- * @property root
- */
- if(this.root){
- var r = this.root;
- delete this.root;
- this.setRootNode(r);
+ if (me.fireEvent('beforequery', qe) === false || qe.cancel) {
+ return false;
}
+ // get back out possibly modified values
+ queryString = qe.query;
+ forceAll = qe.forceAll;
- this.addEvents(
+ // query permitted to run
+ if (forceAll || (queryString.length >= me.minChars)) {
+ // expand before starting query so LoadMask can position itself correctly
+ me.expand();
+
+ // make sure they aren't querying the same thing
+ if (!me.queryCaching || me.lastQuery !== queryString) {
+ me.lastQuery = queryString;
+ store.clearFilter(!forceAll);
+ if (isLocalMode) {
+ if (!forceAll) {
+ store.filter(me.displayField, queryString);
+ }
+ } else {
+ store.load({
+ params: me.getParams(queryString)
+ });
+ }
+ }
- /**
- * @event append
- * Fires when a new child node is appended to a node in this tree.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The newly appended node
- * @param {Number} index The index of the newly appended node
- */
- 'append',
- /**
- * @event remove
- * Fires when a child node is removed from a node in this tree.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node removed
- */
- 'remove',
- /**
- * @event movenode
- * Fires when a node is moved to a new location in the tree
- * @param {Tree} tree The owner tree
- * @param {Node} node The node moved
- * @param {Node} oldParent The old parent of this node
- * @param {Node} newParent The new parent of this node
- * @param {Number} index The index it was moved to
- */
- 'movenode',
- /**
- * @event insert
- * Fires when a new child node is inserted in a node in this tree.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node inserted
- * @param {Node} refNode The child node the node was inserted before
- */
- 'insert',
- /**
- * @event beforeappend
- * Fires before a new child is appended to a node in this tree, return false to cancel the append.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node to be appended
- */
- 'beforeappend',
- /**
- * @event beforeremove
- * Fires before a child is removed from a node in this tree, return false to cancel the remove.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node to be removed
- */
- 'beforeremove',
- /**
- * @event beforemovenode
- * Fires before a node is moved to a new location in the tree. Return false to cancel the move.
- * @param {Tree} tree The owner tree
- * @param {Node} node The node being moved
- * @param {Node} oldParent The parent of the node
- * @param {Node} newParent The new parent the node is moving to
- * @param {Number} index The index it is being moved to
- */
- 'beforemovenode',
- /**
- * @event beforeinsert
- * Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node to be inserted
- * @param {Node} refNode The child node the node is being inserted before
- */
- 'beforeinsert',
+ // Clear current selection if it does not match the current value in the field
+ if (me.getRawValue() !== me.getDisplayValue()) {
+ me.ignoreSelection++;
+ me.picker.getSelectionModel().deselectAll();
+ me.ignoreSelection--;
+ }
- /**
- * @event beforeload
- * Fires before a node is loaded, return false to cancel
- * @param {Node} node The node being loaded
- */
- 'beforeload',
- /**
- * @event load
- * Fires when a node is loaded
- * @param {Node} node The node that was loaded
- */
- 'load',
- /**
- * @event textchange
- * Fires when the text for a node is changed
- * @param {Node} node The node
- * @param {String} text The new text
- * @param {String} oldText The old text
- */
- 'textchange',
- /**
- * @event beforeexpandnode
- * Fires before a node is expanded, return false to cancel.
- * @param {Node} node The node
- * @param {Boolean} deep
- * @param {Boolean} anim
- */
- 'beforeexpandnode',
- /**
- * @event beforecollapsenode
- * Fires before a node is collapsed, return false to cancel.
- * @param {Node} node The node
- * @param {Boolean} deep
- * @param {Boolean} anim
- */
- 'beforecollapsenode',
- /**
- * @event expandnode
- * Fires when a node is expanded
- * @param {Node} node The node
- */
- 'expandnode',
- /**
- * @event disabledchange
- * Fires when the disabled status of a node changes
- * @param {Node} node The node
- * @param {Boolean} disabled
- */
- 'disabledchange',
- /**
- * @event collapsenode
- * Fires when a node is collapsed
- * @param {Node} node The node
- */
- 'collapsenode',
- /**
- * @event beforeclick
- * Fires before click processing on a node. Return false to cancel the default action.
- * @param {Node} node The node
- * @param {Ext.EventObject} e The event object
- */
- 'beforeclick',
- /**
- * @event click
- * Fires when a node is clicked
- * @param {Node} node The node
- * @param {Ext.EventObject} e The event object
- */
- 'click',
- /**
- * @event containerclick
- * Fires when the tree container is clicked
- * @param {Tree} this
- * @param {Ext.EventObject} e The event object
- */
- 'containerclick',
- /**
- * @event checkchange
- * Fires when a node with a checkbox's checked property changes
- * @param {Node} this This node
- * @param {Boolean} checked
- */
- 'checkchange',
- /**
- * @event beforedblclick
- * Fires before double click processing on a node. Return false to cancel the default action.
- * @param {Node} node The node
- * @param {Ext.EventObject} e The event object
- */
- 'beforedblclick',
- /**
- * @event dblclick
- * Fires when a node is double clicked
- * @param {Node} node The node
- * @param {Ext.EventObject} e The event object
- */
- 'dblclick',
- /**
- * @event containerdblclick
- * Fires when the tree container is double clicked
- * @param {Tree} this
- * @param {Ext.EventObject} e The event object
- */
- 'containerdblclick',
- /**
- * @event contextmenu
- * Fires when a node is right clicked. To display a context menu in response to this
- * event, first create a Menu object (see {@link Ext.menu.Menu} for details), then add
- * a handler for this event:
-new Ext.tree.TreePanel({
- title: 'My TreePanel',
- root: new Ext.tree.AsyncTreeNode({
- text: 'The Root',
- children: [
- { text: 'Child node 1', leaf: true },
- { text: 'Child node 2', leaf: true }
- ]
- }),
- contextMenu: new Ext.menu.Menu({
- items: [{
- id: 'delete-node',
- text: 'Delete Node'
- }],
- listeners: {
- itemclick: function(item) {
- switch (item.id) {
- case 'delete-node':
- var n = item.parentMenu.contextNode;
- if (n.parentNode) {
- n.remove();
- }
- break;
- }
+ if (isLocalMode) {
+ me.doAutoSelect();
+ }
+ if (me.typeAhead) {
+ me.doTypeAhead();
}
}
- }),
- listeners: {
- contextmenu: function(node, e) {
-// Register the context node with the menu so that a Menu Item's handler function can access
-// it via its {@link Ext.menu.BaseItem#parentMenu parentMenu} property.
- node.select();
- var c = node.getOwnerTree().contextMenu;
- c.contextNode = node;
- c.showAt(e.getXY());
- }
- }
-});
-
- * @param {Node} node The node
- * @param {Ext.EventObject} e The event object
- */
- 'contextmenu',
- /**
- * @event containercontextmenu
- * Fires when the tree container is right clicked
- * @param {Tree} this
- * @param {Ext.EventObject} e The event object
- */
- 'containercontextmenu',
- /**
- * @event beforechildrenrendered
- * Fires right before the child nodes for a node are rendered
- * @param {Node} node The node
- */
- 'beforechildrenrendered',
- /**
- * @event startdrag
- * Fires when a node starts being dragged
- * @param {Ext.tree.TreePanel} this
- * @param {Ext.tree.TreeNode} node
- * @param {event} e The raw browser event
- */
- 'startdrag',
- /**
- * @event enddrag
- * Fires when a drag operation is complete
- * @param {Ext.tree.TreePanel} this
- * @param {Ext.tree.TreeNode} node
- * @param {event} e The raw browser event
- */
- 'enddrag',
- /**
- * @event dragdrop
- * Fires when a dragged node is dropped on a valid DD target
- * @param {Ext.tree.TreePanel} this
- * @param {Ext.tree.TreeNode} node
- * @param {DD} dd The dd it was dropped on
- * @param {event} e The raw browser event
- */
- 'dragdrop',
- /**
- * @event beforenodedrop
- * Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
- * passed to handlers has the following properties:
- *
- * - tree - The TreePanel
- * - target - The node being targeted for the drop
- * - data - The drag data from the drag source
- * - point - The point of the drop - append, above or below
- * - source - The drag source
- * - rawEvent - Raw mouse event
- * - dropNode - Drop node(s) provided by the source OR you can supply node(s)
- * to be inserted by setting them on this object.
- * - cancel - Set this to true to cancel the drop.
- * - dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true
- * will prevent the animated 'repair' from appearing.
- *
- * @param {Object} dropEvent
- */
- 'beforenodedrop',
- /**
- * @event nodedrop
- * Fires after a DD object is dropped on a node in this tree. The dropEvent
- * passed to handlers has the following properties:
- *
- * - tree - The TreePanel
- * - target - The node being targeted for the drop
- * - data - The drag data from the drag source
- * - point - The point of the drop - append, above or below
- * - source - The drag source
- * - rawEvent - Raw mouse event
- * - dropNode - Dropped node(s).
- *
- * @param {Object} dropEvent
- */
- 'nodedrop',
- /**
- * @event nodedragover
- * Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
- * passed to handlers has the following properties:
- *
- * - tree - The TreePanel
- * - target - The node being targeted for the drop
- * - data - The drag data from the drag source
- * - point - The point of the drop - append, above or below
- * - source - The drag source
- * - rawEvent - Raw mouse event
- * - dropNode - Drop node(s) provided by the source.
- * - cancel - Set this to true to signal drop not allowed.
- *
- * @param {Object} dragOverEvent
- */
- 'nodedragover'
- );
- if(this.singleExpand){
- this.on('beforeexpandnode', this.restrictExpand, this);
- }
+ return true;
},
// private
- proxyNodeEvent : function(ename, a1, a2, a3, a4, a5, a6){
- if(ename == 'collapse' || ename == 'expand' || ename == 'beforecollapse' || ename == 'beforeexpand' || ename == 'move' || ename == 'beforemove'){
- ename = ename+'node';
+ getParams: function(queryString) {
+ var p = {},
+ pageSize = this.pageSize;
+ p[this.queryParam] = queryString;
+ if (pageSize) {
+ p.start = 0;
+ p.limit = pageSize;
}
- // args inline for performance while bubbling events
- return this.fireEvent(ename, a1, a2, a3, a4, a5, a6);
+ return p;
},
-
/**
- * Returns this root node for this tree
- * @return {Node}
+ * @private
+ * If the autoSelect config is true, and the picker is open, highlights the first item.
*/
- getRootNode : function(){
- return this.root;
+ doAutoSelect: function() {
+ var me = this,
+ picker = me.picker,
+ lastSelected, itemNode;
+ if (picker && me.autoSelect && me.store.getCount() > 0) {
+ // Highlight the last selected item and scroll it into view
+ lastSelected = picker.getSelectionModel().lastSelected;
+ itemNode = picker.getNode(lastSelected || 0);
+ if (itemNode) {
+ picker.highlightItem(itemNode);
+ picker.listEl.scrollChildIntoView(itemNode, false);
+ }
+ }
},
- /**
- * Sets the root node for this tree. If the TreePanel has already rendered a root node, the
- * previous root node (and all of its descendants) are destroyed before the new root node is rendered.
- * @param {Node} node
- * @return {Node}
- */
- setRootNode : function(node){
- this.destroyRoot();
- if(!node.render){ // attributes passed
- node = this.loader.createNode(node);
- }
- this.root = node;
- node.ownerTree = this;
- node.isRoot = true;
- this.registerNode(node);
- if(!this.rootVisible){
- var uiP = node.attributes.uiProvider;
- node.ui = uiP ? new uiP(node) : new Ext.tree.RootTreeNodeUI(node);
+ doTypeAhead: function() {
+ if (!this.typeAheadTask) {
+ this.typeAheadTask = Ext.create('Ext.util.DelayedTask', this.onTypeAhead, this);
}
- if(this.innerCt){
- this.clearInnerCt();
- this.renderRoot();
+ if (this.lastKey != Ext.EventObject.BACKSPACE && this.lastKey != Ext.EventObject.DELETE) {
+ this.typeAheadTask.delay(this.typeAheadDelay);
}
- return node;
- },
-
- clearInnerCt : function(){
- this.innerCt.update('');
},
-
- // private
- renderRoot : function(){
- this.root.render();
- if(!this.rootVisible){
- this.root.renderChildren();
+
+ onTriggerClick: function() {
+ var me = this;
+ if (!me.readOnly && !me.disabled) {
+ if (me.isExpanded) {
+ me.collapse();
+ } else {
+ me.onFocus({});
+ if (me.triggerAction === 'all') {
+ me.doQuery(me.allQuery, true);
+ } else {
+ me.doQuery(me.getRawValue());
+ }
+ }
+ me.inputEl.focus();
}
},
- /**
- * Gets a node in this tree by its id
- * @param {String} id
- * @return {Node}
- */
- getNodeById : function(id){
- return this.nodeHash[id];
- },
- // private
- registerNode : function(node){
- this.nodeHash[node.id] = node;
+ // store the last key and doQuery if relevant
+ onKeyUp: function(e, t) {
+ var me = this,
+ key = e.getKey();
+
+ if (!me.readOnly && !me.disabled && me.editable) {
+ me.lastKey = key;
+ // we put this in a task so that we can cancel it if a user is
+ // in and out before the queryDelay elapses
+
+ // perform query w/ any normal key or backspace or delete
+ if (!e.isSpecialKey() || key == e.BACKSPACE || key == e.DELETE) {
+ me.doQueryTask.delay(me.queryDelay);
+ }
+ }
},
- // private
- unregisterNode : function(node){
- delete this.nodeHash[node.id];
+ initEvents: function() {
+ var me = this;
+ me.callParent();
+
+ // setup keyboard handling
+ me.mon(me.inputEl, 'keyup', me.onKeyUp, me);
},
- // private
- toString : function(){
- return '[Tree'+(this.id?' '+this.id:'')+']';
+ createPicker: function() {
+ var me = this,
+ picker,
+ menuCls = Ext.baseCSSPrefix + 'menu',
+ opts = Ext.apply({
+ selModel: {
+ mode: me.multiSelect ? 'SIMPLE' : 'SINGLE'
+ },
+ floating: true,
+ hidden: true,
+ ownerCt: me.ownerCt,
+ cls: me.el.up('.' + menuCls) ? menuCls : '',
+ store: me.store,
+ displayField: me.displayField,
+ focusOnToFront: false,
+ pageSize: me.pageSize
+ }, me.listConfig, me.defaultListConfig);
+
+ picker = me.picker = Ext.create('Ext.view.BoundList', opts);
+
+ me.mon(picker, {
+ itemclick: me.onItemClick,
+ refresh: me.onListRefresh,
+ scope: me
+ });
+
+ me.mon(picker.getSelectionModel(), {
+ selectionChange: me.onListSelectionChange,
+ scope: me
+ });
+
+ return picker;
},
- // private
- restrictExpand : function(node){
- var p = node.parentNode;
- if(p){
- if(p.expandedChild && p.expandedChild.parentNode == p){
- p.expandedChild.collapse();
+ onListRefresh: function() {
+ this.alignPicker();
+ this.syncSelection();
+ },
+
+ onItemClick: function(picker, record){
+ /*
+ * If we're doing single selection, the selection change events won't fire when
+ * clicking on the selected element. Detect it here.
+ */
+ var me = this,
+ lastSelection = me.lastSelection,
+ valueField = me.valueField,
+ selected;
+
+ if (!me.multiSelect && lastSelection) {
+ selected = lastSelection[0];
+ if (record.get(valueField) === selected.get(valueField)) {
+ me.collapse();
}
- p.expandedChild = node;
- }
+ }
},
- /**
- * Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id')
- * @param {String} attribute (optional) Defaults to null (return the actual nodes)
- * @param {TreeNode} startNode (optional) The node to start from, defaults to the root
- * @return {Array}
- */
- getChecked : function(a, startNode){
- startNode = startNode || this.root;
- var r = [];
- var f = function(){
- if(this.attributes.checked){
- r.push(!a ? this : (a == 'id' ? this.id : this.attributes[a]));
+ onListSelectionChange: function(list, selectedRecords) {
+ var me = this;
+ // Only react to selection if it is not called from setValue, and if our list is
+ // expanded (ignores changes to the selection model triggered elsewhere)
+ if (!me.ignoreSelection && me.isExpanded) {
+ if (!me.multiSelect) {
+ Ext.defer(me.collapse, 1, me);
}
- };
- startNode.cascade(f);
- return r;
+ me.setValue(selectedRecords, false);
+ if (selectedRecords.length > 0) {
+ me.fireEvent('select', me, selectedRecords);
+ }
+ me.inputEl.focus();
+ }
},
/**
- * Returns the default {@link Ext.tree.TreeLoader} for this TreePanel.
- * @return {Ext.tree.TreeLoader} The TreeLoader for this TreePanel.
+ * @private
+ * Enables the key nav for the BoundList when it is expanded.
*/
- getLoader : function(){
- return this.loader;
+ onExpand: function() {
+ var me = this,
+ keyNav = me.listKeyNav,
+ selectOnTab = me.selectOnTab,
+ picker = me.getPicker();
+
+ // Handle BoundList navigation from the input field. Insert a tab listener specially to enable selectOnTab.
+ if (keyNav) {
+ keyNav.enable();
+ } else {
+ keyNav = me.listKeyNav = Ext.create('Ext.view.BoundListKeyNav', this.inputEl, {
+ boundList: picker,
+ forceKeyDown: true,
+ tab: function(e) {
+ if (selectOnTab) {
+ this.selectHighlighted(e);
+ me.triggerBlur();
+ }
+ // Tab key event is allowed to propagate to field
+ return true;
+ }
+ });
+ }
+
+ // While list is expanded, stop tab monitoring from Ext.form.field.Trigger so it doesn't short-circuit selectOnTab
+ if (selectOnTab) {
+ me.ignoreMonitorTab = true;
+ }
+
+ Ext.defer(keyNav.enable, 1, keyNav); //wait a bit so it doesn't react to the down arrow opening the picker
+ me.inputEl.focus();
},
/**
- * Expand all nodes
+ * @private
+ * Disables the key nav for the BoundList when it is collapsed.
*/
- expandAll : function(){
- this.root.expand(true);
+ onCollapse: function() {
+ var me = this,
+ keyNav = me.listKeyNav;
+ if (keyNav) {
+ keyNav.disable();
+ me.ignoreMonitorTab = false;
+ }
},
/**
- * Collapse all nodes
+ * Selects an item by a {@link Ext.data.Model Model}, or by a key value.
+ * @param r
*/
- collapseAll : function(){
- this.root.collapse(true);
+ select: function(r) {
+ this.setValue(r, true);
},
/**
- * Returns the selection model used by this TreePanel.
- * @return {TreeSelectionModel} The selection model used by this TreePanel
+ * Find the record by searching for a specific field/value combination
+ * Returns an Ext.data.Record or false
+ * @private
*/
- getSelectionModel : function(){
- if(!this.selModel){
- this.selModel = new Ext.tree.DefaultSelectionModel();
- }
- return this.selModel;
+ findRecord: function(field, value) {
+ var ds = this.store,
+ idx = ds.findExact(field, value);
+ return idx !== -1 ? ds.getAt(idx) : false;
+ },
+ findRecordByValue: function(value) {
+ return this.findRecord(this.valueField, value);
+ },
+ findRecordByDisplay: function(value) {
+ return this.findRecord(this.displayField, value);
},
/**
- * Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Ext.data.Node#getPath}
- * @param {String} path
- * @param {String} attr (optional) The attribute used in the path (see {@link Ext.data.Node#getPath} for more info)
- * @param {Function} callback (optional) The callback to call when the expand is complete. The callback will be called with
- * (bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.
+ * Sets the specified value(s) into the field. For each value, if a record is found in the {@link #store} that
+ * matches based on the {@link #valueField}, then that record's {@link #displayField} will be displayed in the
+ * field. If no match is found, and the {@link #valueNotFoundText} config option is defined, then that will be
+ * displayed as the default field text. Otherwise a blank value will be shown, although the value will still be set.
+ * @param {String|Array} value The value(s) to be set. Can be either a single String or {@link Ext.data.Model},
+ * or an Array of Strings or Models.
+ * @return {Ext.form.field.Field} this
*/
- expandPath : function(path, attr, callback){
- if(Ext.isEmpty(path)){
- if(callback){
- callback(false, undefined);
- }
- return;
+ setValue: function(value, doSelect) {
+ var me = this,
+ valueNotFoundText = me.valueNotFoundText,
+ inputEl = me.inputEl,
+ i, len, record,
+ models = [],
+ displayTplData = [],
+ processedValue = [];
+
+ if (me.store.loading) {
+ // Called while the Store is loading. Ensure it is processed by the onLoad method.
+ me.value = value;
+ return me;
}
- attr = attr || 'id';
- var keys = path.split(this.pathSeparator);
- var curNode = this.root;
- if(curNode.attributes[attr] != keys[1]){ // invalid root
- if(callback){
- callback(false, null);
+
+ // This method processes multi-values, so ensure value is an array.
+ value = Ext.Array.from(value);
+
+ // Loop through values
+ for (i = 0, len = value.length; i < len; i++) {
+ record = value[i];
+ if (!record || !record.isModel) {
+ record = me.findRecordByValue(record);
}
- return;
- }
- var index = 1;
- var f = function(){
- if(++index == keys.length){
- if(callback){
- callback(true, curNode);
- }
- return;
+ // record found, select it.
+ if (record) {
+ models.push(record);
+ displayTplData.push(record.data);
+ processedValue.push(record.get(me.valueField));
}
- var c = curNode.findChild(attr, keys[index]);
- if(!c){
- if(callback){
- callback(false, curNode);
+ // record was not found, this could happen because
+ // store is not loaded or they set a value not in the store
+ else {
+ // if valueNotFoundText is defined, display it, otherwise display nothing for this value
+ if (Ext.isDefined(valueNotFoundText)) {
+ displayTplData.push(valueNotFoundText);
}
- return;
+ processedValue.push(value[i]);
}
- curNode = c;
- c.expand(false, false, f);
- };
- curNode.expand(false, false, f);
- },
+ }
- /**
- * Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Ext.data.Node#getPath}
- * @param {String} path
- * @param {String} attr (optional) The attribute used in the path (see {@link Ext.data.Node#getPath} for more info)
- * @param {Function} callback (optional) The callback to call when the selection is complete. The callback will be called with
- * (bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.
- */
- selectPath : function(path, attr, callback){
- if(Ext.isEmpty(path)){
- if(callback){
- callback(false, undefined);
- }
- return;
+ // Set the value of this field. If we are multiselecting, then that is an array.
+ me.value = me.multiSelect ? processedValue : processedValue[0];
+ if (!Ext.isDefined(me.value)) {
+ me.value = null;
}
- attr = attr || 'id';
- var keys = path.split(this.pathSeparator),
- v = keys.pop();
- if(keys.length > 1){
- var f = function(success, node){
- if(success && node){
- var n = node.findChild(attr, v);
- if(n){
- n.select();
- if(callback){
- callback(true, n);
- }
- }else if(callback){
- callback(false, n);
- }
- }else{
- if(callback){
- callback(false, n);
- }
- }
- };
- this.expandPath(keys.join(this.pathSeparator), attr, f);
- }else{
- this.root.select();
- if(callback){
- callback(true, this.root);
- }
+ me.displayTplData = displayTplData; //store for getDisplayValue method
+ me.lastSelection = me.valueModels = models;
+
+ if (inputEl && me.emptyText && !Ext.isEmpty(value)) {
+ inputEl.removeCls(me.emptyCls);
}
+
+ // Calculate raw value from the collection of Model data
+ me.setRawValue(me.getDisplayValue());
+ me.checkChange();
+
+ if (doSelect !== false) {
+ me.syncSelection();
+ }
+ me.applyEmptyText();
+
+ return me;
},
/**
- * Returns the underlying Element for this tree
- * @return {Ext.Element} The Element
+ * @private Generate the string value to be displayed in the text field for the currently stored value
*/
- getTreeEl : function(){
- return this.body;
+ getDisplayValue: function() {
+ return this.displayTpl.apply(this.displayTplData);
},
- // private
- onRender : function(ct, position){
- Ext.tree.TreePanel.superclass.onRender.call(this, ct, position);
- this.el.addClass('x-tree');
- this.innerCt = this.body.createChild({tag:'ul',
- cls:'x-tree-root-ct ' +
- (this.useArrows ? 'x-tree-arrows' : this.lines ? 'x-tree-lines' : 'x-tree-no-lines')});
- },
+ getValue: function() {
+ // If the user has not changed the raw field value since a value was selected from the list,
+ // then return the structured value from the selection. If the raw field value is different
+ // than what would be displayed due to selection, return that raw value.
+ var me = this,
+ picker = me.picker,
+ rawValue = me.getRawValue(), //current value of text field
+ value = me.value; //stored value from last selection or setValue() call
- // private
- initEvents : function(){
- Ext.tree.TreePanel.superclass.initEvents.call(this);
+ if (me.getDisplayValue() !== rawValue) {
+ value = rawValue;
+ me.value = me.displayTplData = me.valueModels = null;
+ if (picker) {
+ me.ignoreSelection++;
+ picker.getSelectionModel().deselectAll();
+ me.ignoreSelection--;
+ }
+ }
- if(this.containerScroll){
- Ext.dd.ScrollManager.register(this.body);
- }
- if((this.enableDD || this.enableDrop) && !this.dropZone){
- /**
- * The dropZone used by this tree if drop is enabled (see {@link #enableDD} or {@link #enableDrop})
- * @property dropZone
- * @type Ext.tree.TreeDropZone
- */
- this.dropZone = new Ext.tree.TreeDropZone(this, this.dropConfig || {
- ddGroup: this.ddGroup || 'TreeDD', appendOnly: this.ddAppendOnly === true
- });
- }
- if((this.enableDD || this.enableDrag) && !this.dragZone){
- /**
- * The dragZone used by this tree if drag is enabled (see {@link #enableDD} or {@link #enableDrag})
- * @property dragZone
- * @type Ext.tree.TreeDragZone
- */
- this.dragZone = new Ext.tree.TreeDragZone(this, this.dragConfig || {
- ddGroup: this.ddGroup || 'TreeDD',
- scroll: this.ddScroll
- });
- }
- this.getSelectionModel().init(this);
+ return value;
},
- // private
- afterRender : function(){
- Ext.tree.TreePanel.superclass.afterRender.call(this);
- this.renderRoot();
+ getSubmitValue: function() {
+ return this.getValue();
},
- beforeDestroy : function(){
- if(this.rendered){
- Ext.dd.ScrollManager.unregister(this.body);
- Ext.destroy(this.dropZone, this.dragZone);
+ isEqual: function(v1, v2) {
+ var fromArray = Ext.Array.from,
+ i, len;
+
+ v1 = fromArray(v1);
+ v2 = fromArray(v2);
+ len = v1.length;
+
+ if (len !== v2.length) {
+ return false;
+ }
+
+ for(i = 0; i < len; i++) {
+ if (v2[i] !== v1[i]) {
+ return false;
+ }
}
- this.destroyRoot();
- Ext.destroy(this.loader);
- this.nodeHash = this.root = this.loader = null;
- Ext.tree.TreePanel.superclass.beforeDestroy.call(this);
+
+ return true;
},
-
+
/**
- * Destroy the root node. Not included by itself because we need to pass the silent parameter.
- * @private
+ * Clears any value currently set in the ComboBox.
+ */
+ clearValue: function() {
+ this.setValue([]);
+ },
+
+ /**
+ * @private Synchronizes the selection in the picker to match the current value of the combobox.
*/
- destroyRoot : function(){
- if(this.root && this.root.destroy){
- this.root.destroy(true);
+ syncSelection: function() {
+ var me = this,
+ ExtArray = Ext.Array,
+ picker = me.picker,
+ selection, selModel;
+ if (picker) {
+ // From the value, find the Models that are in the store's current data
+ selection = [];
+ ExtArray.forEach(me.valueModels || [], function(value) {
+ if (value && value.isModel && me.store.indexOf(value) >= 0) {
+ selection.push(value);
+ }
+ });
+
+ // Update the selection to match
+ me.ignoreSelection++;
+ selModel = picker.getSelectionModel();
+ selModel.deselectAll();
+ if (selection.length) {
+ selModel.select(selection);
+ }
+ me.ignoreSelection--;
}
}
+});
+
+/**
+ * @private
+ * @class Ext.picker.Month
+ * @extends Ext.Component
+ * A month picker component. This class is used by the {@link Ext.picker.Date DatePicker} class
+ * to allow browsing and selection of year/months combinations.
+ * @constructor
+ * Create a new MonthPicker
+ * @param {Object} config The config object
+ * @xtype monthpicker
+ * @private
+ */
+Ext.define('Ext.picker.Month', {
+ extend: 'Ext.Component',
+ requires: ['Ext.XTemplate', 'Ext.util.ClickRepeater', 'Ext.Date', 'Ext.button.Button'],
+ alias: 'widget.monthpicker',
+ alternateClassName: 'Ext.MonthPicker',
+
+ renderTpl: [
+ '',
+ '',
+ '',
+ '',
+ ' '
+ ],
/**
- * @cfg {String/Number} activeItem
- * @hide
+ * @cfg {String} okText The text to display on the ok button. Defaults to 'OK'
*/
+ okText: 'OK',
+
/**
- * @cfg {Boolean} autoDestroy
- * @hide
+ * @cfg {String} cancelText The text to display on the cancel button. Defaults to 'Cancel'
*/
+ cancelText: 'Cancel',
+
/**
- * @cfg {Object/String/Function} autoLoad
- * @hide
+ * @cfg {String} baseCls The base CSS class to apply to the picker element. Defaults to 'x-monthpicker'
*/
+ baseCls: Ext.baseCSSPrefix + 'monthpicker',
+
/**
- * @cfg {Boolean} autoWidth
- * @hide
+ * @cfg {Boolean} showButtons True to show ok and cancel buttons below the picker. Defaults to true.
*/
+ showButtons: true,
+
/**
- * @cfg {Boolean/Number} bufferResize
- * @hide
+ * @cfg {String} selectedCls The class to be added to selected items in the picker. Defaults to
+ * 'x-monthpicker-selected'
*/
+
/**
- * @cfg {String} defaultType
- * @hide
+ * @cfg {Date/Array} value The default value to set. See {#setValue setValue}
*/
+
+ width: 175,
+
+ height: 195,
+
+
+ // private
+ totalYears: 10,
+ yearOffset: 5, // 10 years in total, 2 per row
+ monthOffset: 6, // 12 months, 2 per row
+
+ // private, inherit docs
+ initComponent: function(){
+ var me = this;
+
+ me.selectedCls = me.baseCls + '-selected';
+ me.addEvents(
+ /**
+ * @event cancelclick
+ * Fires when the cancel button is pressed.
+ * @param {Ext.picker.Month} this
+ */
+ 'cancelclick',
+
+ /**
+ * @event monthclick
+ * Fires when a month is clicked.
+ * @param {Ext.picker.Month} this
+ * @param {Array} value The current value
+ */
+ 'monthclick',
+
+ /**
+ * @event monthdblclick
+ * Fires when a month is clicked.
+ * @param {Ext.picker.Month} this
+ * @param {Array} value The current value
+ */
+ 'monthdblclick',
+
+ /**
+ * @event okclick
+ * Fires when the ok button is pressed.
+ * @param {Ext.picker.Month} this
+ * @param {Array} value The current value
+ */
+ 'okclick',
+
+ /**
+ * @event select
+ * Fires when a month/year is selected.
+ * @param {Ext.picker.Month} this
+ * @param {Array} value The current value
+ */
+ 'select',
+
+ /**
+ * @event yearclick
+ * Fires when a year is clicked.
+ * @param {Ext.picker.Month} this
+ * @param {Array} value The current value
+ */
+ 'yearclick',
+
+ /**
+ * @event yeardblclick
+ * Fires when a year is clicked.
+ * @param {Ext.picker.Month} this
+ * @param {Array} value The current value
+ */
+ 'yeardblclick'
+ );
+
+ me.setValue(me.value);
+ me.activeYear = me.getYear(new Date().getFullYear() - 4, -4);
+ this.callParent();
+ },
+
+ // private, inherit docs
+ onRender: function(ct, position){
+ var me = this,
+ i = 0,
+ months = [],
+ shortName = Ext.Date.getShortMonthName,
+ monthLen = me.monthOffset;
+
+ for (; i < monthLen; ++i) {
+ months.push(shortName(i), shortName(i + monthLen));
+ }
+
+ Ext.apply(me.renderData, {
+ months: months,
+ years: me.getYears(),
+ showButtons: me.showButtons
+ });
+
+ Ext.apply(me.renderSelectors, {
+ bodyEl: '.' + me.baseCls + '-body',
+ prevEl: '.' + me.baseCls + '-yearnav-prev',
+ nextEl: '.' + me.baseCls + '-yearnav-next',
+ buttonsEl: '.' + me.baseCls + '-buttons'
+ });
+ this.callParent([ct, position]);
+ },
+
+ // private, inherit docs
+ afterRender: function(){
+ var me = this,
+ body = me.bodyEl,
+ buttonsEl = me.buttonsEl;
+
+ me.callParent();
+
+ me.mon(body, 'click', me.onBodyClick, me);
+ me.mon(body, 'dblclick', me.onBodyClick, me);
+
+ // keep a reference to the year/month elements since we'll be re-using them
+ me.years = body.select('.' + me.baseCls + '-year a');
+ me.months = body.select('.' + me.baseCls + '-month a');
+
+ if (me.showButtons) {
+ me.okBtn = Ext.create('Ext.button.Button', {
+ text: me.okText,
+ renderTo: buttonsEl,
+ handler: me.onOkClick,
+ scope: me
+ });
+ me.cancelBtn = Ext.create('Ext.button.Button', {
+ text: me.cancelText,
+ renderTo: buttonsEl,
+ handler: me.onCancelClick,
+ scope: me
+ });
+ }
+
+ me.backRepeater = Ext.create('Ext.util.ClickRepeater', me.prevEl, {
+ handler: Ext.Function.bind(me.adjustYear, me, [-me.totalYears])
+ });
+
+ me.prevEl.addClsOnOver(me.baseCls + '-yearnav-prev-over');
+ me.nextRepeater = Ext.create('Ext.util.ClickRepeater', me.nextEl, {
+ handler: Ext.Function.bind(me.adjustYear, me, [me.totalYears])
+ });
+ me.nextEl.addClsOnOver(me.baseCls + '-yearnav-next-over');
+ me.updateBody();
+ },
+
/**
- * @cfg {Object} defaults
- * @hide
+ * Set the value for the picker.
+ * @param {Date/Array} value The value to set. It can be a Date object, where the month/year will be extracted, or
+ * it can be an array, with the month as the first index and the year as the second.
+ * @return {Ext.picker.Month} this
*/
+ setValue: function(value){
+ var me = this,
+ active = me.activeYear,
+ offset = me.monthOffset,
+ year,
+ index;
+
+ if (!value) {
+ me.value = [null, null];
+ } else if (Ext.isDate(value)) {
+ me.value = [value.getMonth(), value.getFullYear()];
+ } else {
+ me.value = [value[0], value[1]];
+ }
+
+ if (me.rendered) {
+ year = me.value[1];
+ if (year !== null) {
+ if ((year < active || year > active + me.yearOffset)) {
+ me.activeYear = year - me.yearOffset + 1;
+ }
+ }
+ me.updateBody();
+ }
+
+ return me;
+ },
+
/**
- * @cfg {Boolean} hideBorders
- * @hide
+ * Gets the selected value. It is returned as an array [month, year]. It may
+ * be a partial value, for example [null, 2010]. The month is returned as
+ * 0 based.
+ * @return {Array} The selected value
*/
+ getValue: function(){
+ return this.value;
+ },
+
/**
- * @cfg {Mixed} items
- * @hide
+ * Checks whether the picker has a selection
+ * @return {Boolean} Returns true if both a month and year have been selected
*/
+ hasSelection: function(){
+ var value = this.value;
+ return value[0] !== null && value[1] !== null;
+ },
+
/**
- * @cfg {String} layout
- * @hide
+ * Get an array of years to be pushed in the template. It is not in strict
+ * numerical order because we want to show them in columns.
+ * @private
+ * @return {Array} An array of years
*/
+ getYears: function(){
+ var me = this,
+ offset = me.yearOffset,
+ start = me.activeYear, // put the "active" year on the left
+ end = start + offset,
+ i = start,
+ years = [];
+
+ for (; i < end; ++i) {
+ years.push(i, i + offset);
+ }
+
+ return years;
+ },
+
/**
- * @cfg {Object} layoutConfig
- * @hide
+ * Update the years in the body based on any change
+ * @private
*/
+ updateBody: function(){
+ var me = this,
+ years = me.years,
+ months = me.months,
+ yearNumbers = me.getYears(),
+ cls = me.selectedCls,
+ value = me.getYear(null),
+ month = me.value[0],
+ monthOffset = me.monthOffset,
+ year;
+
+ if (me.rendered) {
+ years.removeCls(cls);
+ months.removeCls(cls);
+ years.each(function(el, all, index){
+ year = yearNumbers[index];
+ el.dom.innerHTML = year;
+ if (year == value) {
+ el.dom.className = cls;
+ }
+ });
+ if (month !== null) {
+ if (month < monthOffset) {
+ month = month * 2;
+ } else {
+ month = (month - monthOffset) * 2 + 1;
+ }
+ months.item(month).addCls(cls);
+ }
+ }
+ },
+
/**
- * @cfg {Boolean} monitorResize
- * @hide
+ * Gets the current year value, or the default.
+ * @private
+ * @param {Number} defaultValue The default value to use if the year is not defined.
+ * @param {Number} offset A number to offset the value by
+ * @return {Number} The year value
*/
+ getYear: function(defaultValue, offset) {
+ var year = this.value[1];
+ offset = offset || 0;
+ return year === null ? defaultValue : year + offset;
+ },
+
/**
- * @property items
- * @hide
+ * React to clicks on the body
+ * @private
*/
+ onBodyClick: function(e, t) {
+ var me = this,
+ isDouble = e.type == 'dblclick';
+
+ if (e.getTarget('.' + me.baseCls + '-month')) {
+ e.stopEvent();
+ me.onMonthClick(t, isDouble);
+ } else if (e.getTarget('.' + me.baseCls + '-year')) {
+ e.stopEvent();
+ me.onYearClick(t, isDouble);
+ }
+ },
+
/**
- * @method cascade
- * @hide
+ * Modify the year display by passing an offset.
+ * @param {Number} offset The offset to move by. If not specified, it defaults to 10.
*/
+ adjustYear: function(offset){
+ if (typeof offset != 'number') {
+ offset = this.totalYears;
+ }
+ this.activeYear += offset;
+ this.updateBody();
+ },
+
/**
- * @method doLayout
- * @hide
+ * React to the ok button being pressed
+ * @private
*/
+ onOkClick: function(){
+ this.fireEvent('okclick', this, this.value);
+ },
+
/**
- * @method find
- * @hide
+ * React to the cancel button being pressed
+ * @private
*/
+ onCancelClick: function(){
+ this.fireEvent('cancelclick', this);
+ },
+
/**
- * @method findBy
- * @hide
+ * React to a month being clicked
+ * @private
+ * @param {HTMLElement} target The element that was clicked
+ * @param {Boolean} isDouble True if the event was a doubleclick
*/
+ onMonthClick: function(target, isDouble){
+ var me = this;
+ me.value[0] = me.resolveOffset(me.months.indexOf(target), me.monthOffset);
+ me.updateBody();
+ me.fireEvent('month' + (isDouble ? 'dbl' : '') + 'click', me, me.value);
+ me.fireEvent('select', me, me.value);
+ },
+
/**
- * @method findById
- * @hide
+ * React to a year being clicked
+ * @private
+ * @param {HTMLElement} target The element that was clicked
+ * @param {Boolean} isDouble True if the event was a doubleclick
*/
+ onYearClick: function(target, isDouble){
+ var me = this;
+ me.value[1] = me.activeYear + me.resolveOffset(me.years.indexOf(target), me.yearOffset);
+ me.updateBody();
+ me.fireEvent('year' + (isDouble ? 'dbl' : '') + 'click', me, me.value);
+ me.fireEvent('select', me, me.value);
+
+ },
+
/**
- * @method findByType
- * @hide
+ * Returns an offsetted number based on the position in the collection. Since our collections aren't
+ * numerically ordered, this function helps to normalize those differences.
+ * @private
+ * @param {Object} index
+ * @param {Object} offset
+ * @return {Number} The correctly offsetted number
*/
+ resolveOffset: function(index, offset){
+ if (index % 2 === 0) {
+ return (index / 2);
+ } else {
+ return offset + Math.floor(index / 2);
+ }
+ },
+
+ // private, inherit docs
+ beforeDestroy: function(){
+ var me = this;
+ me.years = me.months = null;
+ Ext.destroyMembers('backRepeater', 'nextRepeater', 'okBtn', 'cancelBtn');
+ this.callParent();
+ }
+});
+
+/**
+ * @class Ext.picker.Date
+ * @extends Ext.Component
+ * A date picker. This class is used by the {@link Ext.form.field.Date} field to allow browsing and
+ * selection of valid dates in a popup next to the field, but may also be used with other components.
+ * Typically you will need to implement a handler function to be notified when the user chooses a color from the
+ * picker; you can register the handler using the {@link #select} event, or by implementing the {@link #handler}
+ * method.
+ * By default the user will be allowed to pick any date; this can be changed by using the {@link #minDate},
+ * {@link #maxDate}, {@link #disabledDays}, {@link #disabledDatesRE}, and/or {@link #disabledDates} configs.
+ * All the string values documented below may be overridden by including an Ext locale file in your page.
+ * Example usage:
+ * new Ext.panel.Panel({
+ title: 'Choose a future date:',
+ width: 200,
+ bodyPadding: 10,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'datepicker',
+ minDate: new Date(),
+ handler: function(picker, date) {
+ // do something with the selected date
+ }
+ }]
+});
+ * {@img Ext.picker.Date/Ext.picker.Date.png Ext.picker.Date component}
+ *
+ * @constructor
+ * Create a new DatePicker
+ * @param {Object} config The config object
+ *
+ * @xtype datepicker
+ */
+Ext.define('Ext.picker.Date', {
+ extend: 'Ext.Component',
+ requires: [
+ 'Ext.XTemplate',
+ 'Ext.button.Button',
+ 'Ext.button.Split',
+ 'Ext.util.ClickRepeater',
+ 'Ext.util.KeyNav',
+ 'Ext.EventObject',
+ 'Ext.fx.Manager',
+ 'Ext.picker.Month'
+ ],
+ alias: 'widget.datepicker',
+ alternateClassName: 'Ext.DatePicker',
+
+ renderTpl: [
+ '',
+ '',
+ '',
+ '',
+ '',
+ '{.:this.firstInitial} ',
+ ' ',
+ ' ',
+ '',
+ '',
+ '{#:this.isEndOfWeek}',
+ '',
+ '',
+ '',
+ '',
+ ' ',
+ ' ',
+ ' ',
+ '
',
+ '',
+ '',
+ ' ',
+ '',
+ {
+ firstInitial: function(value) {
+ return value.substr(0,1);
+ },
+ isEndOfWeek: function(value) {
+ // convert from 1 based index to 0 based
+ // by decrementing value once.
+ value--;
+ var end = value % 7 === 0 && value !== 0;
+ return end ? '' : '';
+ },
+ longDay: function(value){
+ return Ext.Date.format(value, this.longDayFormat);
+ }
+ }
+ ],
+
+ ariaTitle: 'Date Picker',
/**
- * @method getComponent
- * @hide
+ * @cfg {String} todayText
+ * The text to display on the button that selects the current date (defaults to 'Today'
)
*/
+ todayText : 'Today',
/**
- * @method getLayout
- * @hide
+ * @cfg {Function} handler
+ * Optional. A function that will handle the select event of this picker.
+ * The handler is passed the following parameters:
+ * picker
: Ext.picker.Date This Date picker.
+ * date
: Date The selected date.
+ *
*/
/**
- * @method getUpdater
- * @hide
+ * @cfg {Object} scope
+ * The scope (this
reference) in which the {@link #handler}
+ * function will be called. Defaults to this DatePicker instance.
*/
/**
- * @method insert
- * @hide
+ * @cfg {String} todayTip
+ * A string used to format the message for displaying in a tooltip over the button that
+ * selects the current date. Defaults to '{0} (Spacebar)'
where
+ * the {0}
token is replaced by today's date.
*/
+ todayTip : '{0} (Spacebar)',
/**
- * @method load
- * @hide
+ * @cfg {String} minText
+ * The error text to display if the minDate validation fails (defaults to 'This date is before the minimum date'
)
*/
+ minText : 'This date is before the minimum date',
/**
- * @method remove
- * @hide
+ * @cfg {String} maxText
+ * The error text to display if the maxDate validation fails (defaults to 'This date is after the maximum date'
)
*/
+ maxText : 'This date is after the maximum date',
/**
- * @event add
- * @hide
+ * @cfg {String} format
+ * The default date format string which can be overriden for localization support. The format must be
+ * valid according to {@link Ext.Date#parse} (defaults to {@link Ext.Date#defaultFormat}).
*/
/**
- * @method removeAll
- * @hide
+ * @cfg {String} disabledDaysText
+ * The tooltip to display when the date falls on a disabled day (defaults to 'Disabled'
)
*/
+ disabledDaysText : 'Disabled',
/**
- * @event afterLayout
- * @hide
+ * @cfg {String} disabledDatesText
+ * The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled'
)
*/
+ disabledDatesText : 'Disabled',
/**
- * @event beforeadd
- * @hide
+ * @cfg {Array} monthNames
+ * An array of textual month names which can be overriden for localization support (defaults to Ext.Date.monthNames)
*/
/**
- * @event beforeremove
- * @hide
+ * @cfg {Array} dayNames
+ * An array of textual day names which can be overriden for localization support (defaults to Ext.Date.dayNames)
*/
/**
- * @event remove
- * @hide
+ * @cfg {String} nextText
+ * The next month navigation button tooltip (defaults to 'Next Month (Control+Right)'
)
*/
-
-
-
+ nextText : 'Next Month (Control+Right)',
/**
- * @cfg {String} allowDomMove @hide
+ * @cfg {String} prevText
+ * The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)'
)
*/
+ prevText : 'Previous Month (Control+Left)',
/**
- * @cfg {String} autoEl @hide
+ * @cfg {String} monthYearText
+ * The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)'
)
*/
+ monthYearText : 'Choose a month (Control+Up/Down to move years)',
/**
- * @cfg {String} applyTo @hide
+ * @cfg {Number} startDay
+ * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)
*/
+ startDay : 0,
/**
- * @cfg {String} contentEl @hide
+ * @cfg {Boolean} showToday
+ * False to hide the footer area containing the Today button and disable the keyboard handler for spacebar
+ * that selects the current date (defaults to true
).
*/
+ showToday : true,
/**
- * @cfg {Mixed} data @hide
+ * @cfg {Date} minDate
+ * Minimum allowable date (JavaScript date object, defaults to null)
*/
/**
- * @cfg {Mixed} tpl @hide
+ * @cfg {Date} maxDate
+ * Maximum allowable date (JavaScript date object, defaults to null)
*/
/**
- * @cfg {String} tplWriteMode @hide
+ * @cfg {Array} disabledDays
+ * An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).
*/
/**
- * @cfg {String} disabledClass @hide
+ * @cfg {RegExp} disabledDatesRE
+ * JavaScript regular expression used to disable a pattern of dates (defaults to null). The {@link #disabledDates}
+ * config will generate this regex internally, but if you specify disabledDatesRE it will take precedence over the
+ * disabledDates value.
*/
/**
- * @cfg {String} elements @hide
+ * @cfg {Array} disabledDates
+ * An array of 'dates' to disable, as strings. These strings will be used to build a dynamic regular
+ * expression so they are very powerful. Some examples:
+ *
+ * - ['03/08/2003', '09/16/2003'] would disable those exact dates
+ * - ['03/08', '09/16'] would disable those days for every year
+ * - ['^03/08'] would only match the beginning (useful if you are using short years)
+ * - ['03/../2006'] would disable every day in March 2006
+ * - ['^03'] would disable every day in every March
+ *
+ * Note that the format of the dates included in the array should exactly match the {@link #format} config.
+ * In order to support regular expressions, if you are using a date format that has '.' in it, you will have to
+ * escape the dot when restricting dates. For example: ['03\\.08\\.03'].
*/
+
/**
- * @cfg {String} html @hide
+ * @cfg {Boolean} disableAnim True to disable animations when showing the month picker. Defaults to false.
*/
+ disableAnim: true,
+
/**
- * @cfg {Boolean} preventBodyReset
- * @hide
+ * @cfg {String} baseCls
+ * The base CSS class to apply to this components element (defaults to 'x-datepicker').
*/
+ baseCls: Ext.baseCSSPrefix + 'datepicker',
+
/**
- * @property disabled
- * @hide
+ * @cfg {String} selectedCls
+ * The class to apply to the selected cell. Defaults to 'x-datepicker-selected'
*/
+
/**
- * @method applyToMarkup
- * @hide
+ * @cfg {String} disabledCellCls
+ * The class to apply to disabled cells. Defaults to 'x-datepicker-disabled'
*/
+
/**
- * @method enable
- * @hide
+ * @cfg {String} longDayFormat
+ * The format for displaying a date in a longer format. Defaults to 'F d, Y'
*/
+ longDayFormat: 'F d, Y',
+
/**
- * @method disable
- * @hide
+ * @cfg {Object} keyNavConfig Specifies optional custom key event handlers for the {@link Ext.util.KeyNav}
+ * attached to this date picker. Must conform to the config format recognized by the {@link Ext.util.KeyNav}
+ * constructor. Handlers specified in this object will replace default handlers of the same name.
*/
+
/**
- * @method setDisabled
- * @hide
+ * @cfg {Boolean} focusOnShow
+ * True to automatically focus the picker on show. Defaults to false.
*/
-});
+ focusOnShow: false,
-Ext.tree.TreePanel.nodeTypes = {};
+ // private
+ // Set by other components to stop the picker focus being updated when the value changes.
+ focusOnSelect: true,
-Ext.reg('treepanel', Ext.tree.TreePanel);Ext.tree.TreeEventModel = function(tree){
- this.tree = tree;
- this.tree.on('render', this.initEvents, this);
-};
+ width: 178,
-Ext.tree.TreeEventModel.prototype = {
- initEvents : function(){
- var t = this.tree;
+ // default value used to initialise each date in the DatePicker
+ // (note: 12 noon was chosen because it steers well clear of all DST timezone changes)
+ initHour: 12, // 24-hour format
- if(t.trackMouseOver !== false){
- t.mon(t.innerCt, {
- scope: this,
- mouseover: this.delegateOver,
- mouseout: this.delegateOut
- });
- }
- t.mon(t.getTreeEl(), {
- scope: this,
- click: this.delegateClick,
- dblclick: this.delegateDblClick,
- contextmenu: this.delegateContextMenu
- });
- },
+ numDays: 42,
- getNode : function(e){
- var t;
- if(t = e.getTarget('.x-tree-node-el', 10)){
- var id = Ext.fly(t, '_treeEvents').getAttribute('tree-node-id', 'ext');
- if(id){
- return this.tree.getNodeById(id);
- }
- }
- return null;
- },
+ // private, inherit docs
+ initComponent : function() {
+ var me = this,
+ clearTime = Ext.Date.clearTime;
- getNodeTarget : function(e){
- var t = e.getTarget('.x-tree-node-icon', 1);
- if(!t){
- t = e.getTarget('.x-tree-node-el', 6);
- }
- return t;
- },
+ me.selectedCls = me.baseCls + '-selected';
+ me.disabledCellCls = me.baseCls + '-disabled';
+ me.prevCls = me.baseCls + '-prevday';
+ me.activeCls = me.baseCls + '-active';
+ me.nextCls = me.baseCls + '-prevday';
+ me.todayCls = me.baseCls + '-today';
+ me.dayNames = me.dayNames.slice(me.startDay).concat(me.dayNames.slice(0, me.startDay));
+ this.callParent();
- delegateOut : function(e, t){
- if(!this.beforeEvent(e)){
- return;
- }
- if(e.getTarget('.x-tree-ec-icon', 1)){
- var n = this.getNode(e);
- this.onIconOut(e, n);
- if(n == this.lastEcOver){
- delete this.lastEcOver;
- }
- }
- if((t = this.getNodeTarget(e)) && !e.within(t, true)){
- this.onNodeOut(e, this.getNode(e));
- }
- },
+ me.value = me.value ?
+ clearTime(me.value, true) : clearTime(new Date());
- delegateOver : function(e, t){
- if(!this.beforeEvent(e)){
- return;
- }
- if(Ext.isGecko && !this.trackingDoc){ // prevent hanging in FF
- Ext.getBody().on('mouseover', this.trackExit, this);
- this.trackingDoc = true;
- }
- if(this.lastEcOver){ // prevent hung highlight
- this.onIconOut(e, this.lastEcOver);
- delete this.lastEcOver;
- }
- if(e.getTarget('.x-tree-ec-icon', 1)){
- this.lastEcOver = this.getNode(e);
- this.onIconOver(e, this.lastEcOver);
- }
- if(t = this.getNodeTarget(e)){
- this.onNodeOver(e, this.getNode(e));
- }
+ me.addEvents(
+ /**
+ * @event select
+ * Fires when a date is selected
+ * @param {DatePicker} this DatePicker
+ * @param {Date} date The selected date
+ */
+ 'select'
+ );
+
+ me.initDisabledDays();
},
- trackExit : function(e){
- if(this.lastOverNode){
- if(this.lastOverNode.ui && !e.within(this.lastOverNode.ui.getEl())){
- this.onNodeOut(e, this.lastOverNode);
- }
- delete this.lastOverNode;
- Ext.getBody().un('mouseover', this.trackExit, this);
- this.trackingDoc = false;
- }
+ // private, inherit docs
+ onRender : function(container, position){
+ /*
+ * days array for looping through 6 full weeks (6 weeks * 7 days)
+ * Note that we explicitly force the size here so the template creates
+ * all the appropriate cells.
+ */
+
+ var me = this,
+ days = new Array(me.numDays),
+ today = Ext.Date.format(new Date(), me.format);
+
+ Ext.applyIf(me, {
+ renderData: {},
+ renderSelectors: {}
+ });
+
+ Ext.apply(me.renderData, {
+ dayNames: me.dayNames,
+ ariaTitle: me.ariaTitle,
+ value: me.value,
+ showToday: me.showToday,
+ prevText: me.prevText,
+ nextText: me.nextText,
+ days: days
+ });
+ me.getTpl('renderTpl').longDayFormat = me.longDayFormat;
+
+ Ext.apply(me.renderSelectors, {
+ eventEl: 'table.' + me.baseCls + '-inner',
+ prevEl: '.' + me.baseCls + '-prev a',
+ nextEl: '.' + me.baseCls + '-next a',
+ middleBtnEl: '.' + me.baseCls + '-month',
+ footerEl: '.' + me.baseCls + '-footer'
+ });
+
+ this.callParent(arguments);
+ me.el.unselectable();
+
+ me.cells = me.eventEl.select('tbody td');
+ me.textNodes = me.eventEl.query('tbody td span');
+ me.monthBtn = Ext.create('Ext.button.Split', {
+ text: '',
+ tooltip: me.monthYearText,
+ renderTo: me.middleBtnEl
+ });
+ //~ me.middleBtnEl.down('button').addCls(Ext.baseCSSPrefix + 'btn-arrow');
+
+
+ me.todayBtn = Ext.create('Ext.button.Button', {
+ renderTo: me.footerEl,
+ text: Ext.String.format(me.todayText, today),
+ tooltip: Ext.String.format(me.todayTip, today),
+ handler: me.selectToday,
+ scope: me
+ });
},
- delegateClick : function(e, t){
- if(this.beforeEvent(e)){
- if(e.getTarget('input[type=checkbox]', 1)){
- this.onCheckboxClick(e, this.getNode(e));
- }else if(e.getTarget('.x-tree-ec-icon', 1)){
- this.onIconClick(e, this.getNode(e));
- }else if(this.getNodeTarget(e)){
- this.onNodeClick(e, this.getNode(e));
+ // private, inherit docs
+ initEvents: function(){
+ var me = this,
+ eDate = Ext.Date,
+ day = eDate.DAY;
+
+ this.callParent();
+
+ me.prevRepeater = Ext.create('Ext.util.ClickRepeater', me.prevEl, {
+ handler: me.showPrevMonth,
+ scope: me,
+ preventDefault: true,
+ stopDefault: true
+ });
+
+ me.nextRepeater = Ext.create('Ext.util.ClickRepeater', me.nextEl, {
+ handler: me.showNextMonth,
+ scope: me,
+ preventDefault:true,
+ stopDefault:true
+ });
+
+ me.keyNav = Ext.create('Ext.util.KeyNav', me.eventEl, Ext.apply({
+ scope: me,
+ 'left' : function(e){
+ if(e.ctrlKey){
+ me.showPrevMonth();
+ }else{
+ me.update(eDate.add(me.activeDate, day, -1));
+ }
+ },
+
+ 'right' : function(e){
+ if(e.ctrlKey){
+ me.showNextMonth();
+ }else{
+ me.update(eDate.add(me.activeDate, day, 1));
+ }
+ },
+
+ 'up' : function(e){
+ if(e.ctrlKey){
+ me.showNextYear();
+ }else{
+ me.update(eDate.add(me.activeDate, day, -7));
+ }
+ },
+
+ 'down' : function(e){
+ if(e.ctrlKey){
+ me.showPrevYear();
+ }else{
+ me.update(eDate.add(me.activeDate, day, 7));
+ }
+ },
+ 'pageUp' : me.showNextMonth,
+ 'pageDown' : me.showPrevMonth,
+ 'enter' : function(e){
+ e.stopPropagation();
+ return true;
}
- }else{
- this.checkContainerEvent(e, 'click');
+ }, me.keyNavConfig));
+
+ if(me.showToday){
+ me.todayKeyListener = me.eventEl.addKeyListener(Ext.EventObject.SPACE, me.selectToday, me);
}
+ me.mon(me.eventEl, 'mousewheel', me.handleMouseWheel, me);
+ me.mon(me.eventEl, 'click', me.handleDateClick, me, {delegate: 'a.' + me.baseCls + '-date'});
+ me.mon(me.monthBtn, 'click', me.showMonthPicker, me);
+ me.mon(me.monthBtn, 'arrowclick', me.showMonthPicker, me);
+ me.update(me.value);
},
- delegateDblClick : function(e, t){
- if(this.beforeEvent(e)){
- if(this.getNodeTarget(e)){
- this.onNodeDblClick(e, this.getNode(e));
- }
- }else{
- this.checkContainerEvent(e, 'dblclick');
+ /**
+ * Setup the disabled dates regex based on config options
+ * @private
+ */
+ initDisabledDays : function(){
+ var me = this,
+ dd = me.disabledDates,
+ re = '(?:',
+ len;
+
+ if(!me.disabledDatesRE && dd){
+ len = dd.length - 1;
+
+ Ext.each(dd, function(d, i){
+ re += Ext.isDate(d) ? '^' + Ext.String.escapeRegex(Ext.Date.dateFormat(d, me.format)) + '$' : dd[i];
+ if(i != len){
+ re += '|';
+ }
+ }, me);
+ me.disabledDatesRE = new RegExp(re + ')');
}
},
- delegateContextMenu : function(e, t){
- if(this.beforeEvent(e)){
- if(this.getNodeTarget(e)){
- this.onNodeContextMenu(e, this.getNode(e));
- }
+ /**
+ * Replaces any existing disabled dates with new values and refreshes the DatePicker.
+ * @param {Array/RegExp} disabledDates An array of date strings (see the {@link #disabledDates} config
+ * for details on supported values), or a JavaScript regular expression used to disable a pattern of dates.
+ * @return {Ext.picker.Date} this
+ */
+ setDisabledDates : function(dd){
+ var me = this;
+
+ if(Ext.isArray(dd)){
+ me.disabledDates = dd;
+ me.disabledDatesRE = null;
}else{
- this.checkContainerEvent(e, 'contextmenu');
+ me.disabledDatesRE = dd;
}
- },
-
- checkContainerEvent: function(e, type){
- if(this.disabled){
- e.stopEvent();
- return false;
- }
- this.onContainerEvent(e, type);
+ me.initDisabledDays();
+ me.update(me.value, true);
+ return me;
},
- onContainerEvent: function(e, type){
- this.tree.fireEvent('container' + type, this.tree, e);
+ /**
+ * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker.
+ * @param {Array} disabledDays An array of disabled day indexes. See the {@link #disabledDays} config
+ * for details on supported values.
+ * @return {Ext.picker.Date} this
+ */
+ setDisabledDays : function(dd){
+ this.disabledDays = dd;
+ return this.update(this.value, true);
},
- onNodeClick : function(e, node){
- node.ui.onClick(e);
+ /**
+ * Replaces any existing {@link #minDate} with the new value and refreshes the DatePicker.
+ * @param {Date} value The minimum date that can be selected
+ * @return {Ext.picker.Date} this
+ */
+ setMinDate : function(dt){
+ this.minDate = dt;
+ return this.update(this.value, true);
},
- onNodeOver : function(e, node){
- this.lastOverNode = node;
- node.ui.onOver(e);
+ /**
+ * Replaces any existing {@link #maxDate} with the new value and refreshes the DatePicker.
+ * @param {Date} value The maximum date that can be selected
+ * @return {Ext.picker.Date} this
+ */
+ setMaxDate : function(dt){
+ this.maxDate = dt;
+ return this.update(this.value, true);
},
- onNodeOut : function(e, node){
- node.ui.onOut(e);
+ /**
+ * Sets the value of the date field
+ * @param {Date} value The date to set
+ * @return {Ext.picker.Date} this
+ */
+ setValue : function(value){
+ this.value = Ext.Date.clearTime(value, true);
+ return this.update(this.value);
},
- onIconOver : function(e, node){
- node.ui.addClass('x-tree-ec-over');
+ /**
+ * Gets the current selected value of the date field
+ * @return {Date} The selected date
+ */
+ getValue : function(){
+ return this.value;
},
- onIconOut : function(e, node){
- node.ui.removeClass('x-tree-ec-over');
+ // private
+ focus : function(){
+ this.update(this.activeDate);
},
- onIconClick : function(e, node){
- node.ui.ecClick(e);
- },
+ // private, inherit docs
+ onEnable: function(){
+ this.callParent();
+ this.setDisabledStatus(false);
+ this.update(this.activeDate);
- onCheckboxClick : function(e, node){
- node.ui.onCheckChange(e);
},
- onNodeDblClick : function(e, node){
- node.ui.onDblClick(e);
+ // private, inherit docs
+ onDisable : function(){
+ this.callParent();
+ this.setDisabledStatus(true);
},
- onNodeContextMenu : function(e, node){
- node.ui.onContextMenu(e);
- },
+ /**
+ * Set the disabled state of various internal components
+ * @private
+ * @param {Boolean} disabled
+ */
+ setDisabledStatus : function(disabled){
+ var me = this;
- beforeEvent : function(e){
- var node = this.getNode(e);
- if(this.disabled || !node || !node.ui){
- e.stopEvent();
- return false;
+ me.keyNav.setDisabled(disabled);
+ me.prevRepeater.setDisabled(disabled);
+ me.nextRepeater.setDisabled(disabled);
+ if (me.showToday) {
+ me.todayKeyListener.setDisabled(disabled);
+ me.todayBtn.setDisabled(disabled);
}
- return true;
},
- disable: function(){
- this.disabled = true;
+ /**
+ * Get the current active date.
+ * @private
+ * @return {Date} The active date
+ */
+ getActive: function(){
+ return this.activeDate || me.value;
},
- enable: function(){
- this.disabled = false;
- }
-};/**
- * @class Ext.tree.DefaultSelectionModel
- * @extends Ext.util.Observable
- * The default single selection for a TreePanel.
- */
-Ext.tree.DefaultSelectionModel = Ext.extend(Ext.util.Observable, {
-
- constructor : function(config){
- this.selNode = null;
-
- this.addEvents(
- /**
- * @event selectionchange
- * Fires when the selected node changes
- * @param {DefaultSelectionModel} this
- * @param {TreeNode} node the new selection
- */
- 'selectionchange',
-
- /**
- * @event beforeselect
- * Fires before the selected node changes, return false to cancel the change
- * @param {DefaultSelectionModel} this
- * @param {TreeNode} node the new selection
- * @param {TreeNode} node the old selection
- */
- 'beforeselect'
- );
+ /**
+ * Run any animation required to hide/show the month picker.
+ * @private
+ * @param {Boolean} isHide True if it's a hide operation
+ */
+ runAnimation: function(isHide){
+ var options = {
+ target: this.monthPicker,
+ duration: 200
+ };
- Ext.apply(this, config);
- Ext.tree.DefaultSelectionModel.superclass.constructor.call(this);
- },
-
- init : function(tree){
- this.tree = tree;
- tree.mon(tree.getTreeEl(), 'keydown', this.onKeyDown, this);
- tree.on('click', this.onNodeClick, this);
- },
-
- onNodeClick : function(node, e){
- this.select(node);
+ Ext.fx.Manager.run();
+ if (isHide) {
+ //TODO: slideout
+ } else {
+ //TODO: slidein
+ }
+ Ext.create('Ext.fx.Anim', options);
},
-
+
/**
- * Select a node.
- * @param {TreeNode} node The node to select
- * @return {TreeNode} The selected node
+ * Hides the month picker, if it's visible.
+ * @return {Ext.picker.Date} this
*/
- select : function(node, /* private*/ selectNextNode){
- // If node is hidden, select the next node in whatever direction was being moved in.
- if (!Ext.fly(node.ui.wrap).isVisible() && selectNextNode) {
- return selectNextNode.call(this, node);
- }
- var last = this.selNode;
- if(node == last){
- node.ui.onSelectedChange(true);
- }else if(this.fireEvent('beforeselect', this, node, last) !== false){
- if(last && last.ui){
- last.ui.onSelectedChange(false);
+ hideMonthPicker : function(){
+ var me = this,
+ picker = me.monthPicker;
+
+ if (picker) {
+ if (me.disableAnim) {
+ picker.hide();
+ } else {
+ this.runAnimation(true);
}
- this.selNode = node;
- node.ui.onSelectedChange(true);
- this.fireEvent('selectionchange', this, node, last);
}
- return node;
+ return me;
},
-
+
/**
- * Deselect a node.
- * @param {TreeNode} node The node to unselect
- * @param {Boolean} silent True to stop the selectionchange event from firing.
+ * Show the month picker
+ * @return {Ext.picker.Date} this
*/
- unselect : function(node, silent){
- if(this.selNode == node){
- this.clearSelections(silent);
- }
+ showMonthPicker : function(){
+
+ var me = this,
+ picker,
+ size,
+ top,
+ left;
+
+
+ if (me.rendered && !me.disabled) {
+ size = me.getSize();
+ picker = me.createMonthPicker();
+ picker.show();
+ picker.setSize(size);
+ picker.setValue(me.getActive());
+
+ if (me.disableAnim) {
+ picker.setPosition(-1, -1);
+ } else {
+ me.runAnimation(false);
+ }
+ }
+ return me;
},
-
+
/**
- * Clear all selections
- * @param {Boolean} silent True to stop the selectionchange event from firing.
+ * Create the month picker instance
+ * @private
+ * @return {Ext.picker.Month} picker
*/
- clearSelections : function(silent){
- var n = this.selNode;
- if(n){
- n.ui.onSelectedChange(false);
- this.selNode = null;
- if(silent !== true){
- this.fireEvent('selectionchange', this, null);
- }
+ createMonthPicker: function(){
+ var me = this,
+ picker = me.monthPicker;
+
+ if (!picker) {
+ me.monthPicker = picker = Ext.create('Ext.picker.Month', {
+ renderTo: me.el,
+ floating: true,
+ shadow: false,
+ listeners: {
+ scope: me,
+ cancelclick: me.onCancelClick,
+ okclick: me.onOkClick,
+ yeardblclick: me.onOkClick,
+ monthdblclick: me.onOkClick
+ }
+ });
+
+ me.on('beforehide', me.hideMonthPicker, me);
}
- return n;
+ return picker;
},
-
+
/**
- * Get the selected node
- * @return {TreeNode} The selected node
+ * Respond to an ok click on the month picker
+ * @private
*/
- getSelectedNode : function(){
- return this.selNode;
+ onOkClick: function(picker, value){
+ var me = this,
+ month = value[0],
+ year = value[1],
+ date = new Date(year, month, me.getActive().getDate());
+
+ if (date.getMonth() !== month) {
+ // 'fix' the JS rolling date conversion if needed
+ date = new Date(year, month, 1).getLastDateOfMonth();
+ }
+ me.update(date);
+ me.hideMonthPicker();
},
-
+
/**
- * Returns true if the node is selected
- * @param {TreeNode} node The node to check
- * @return {Boolean}
+ * Respond to a cancel click on the month picker
+ * @private
*/
- isSelected : function(node){
- return this.selNode == node;
+ onCancelClick: function(){
+ this.hideMonthPicker();
},
/**
- * Selects the node above the selected node in the tree, intelligently walking the nodes
- * @return TreeNode The new selection
+ * Show the previous month.
+ * @return {Ext.picker.Date} this
*/
- selectPrevious : function(/* private */ s){
- if(!(s = s || this.selNode || this.lastSelNode)){
- return null;
- }
- // Here we pass in the current function to select to indicate the direction we're moving
- var ps = s.previousSibling;
- if(ps){
- if(!ps.isExpanded() || ps.childNodes.length < 1){
- return this.select(ps, this.selectPrevious);
- } else{
- var lc = ps.lastChild;
- while(lc && lc.isExpanded() && Ext.fly(lc.ui.wrap).isVisible() && lc.childNodes.length > 0){
- lc = lc.lastChild;
- }
- return this.select(lc, this.selectPrevious);
- }
- } else if(s.parentNode && (this.tree.rootVisible || !s.parentNode.isRoot)){
- return this.select(s.parentNode, this.selectPrevious);
- }
- return null;
+ showPrevMonth : function(e){
+ return this.update(Ext.Date.add(this.activeDate, Ext.Date.MONTH, -1));
},
/**
- * Selects the node above the selected node in the tree, intelligently walking the nodes
- * @return TreeNode The new selection
+ * Show the next month.
+ * @return {Ext.picker.Date} this
*/
- selectNext : function(/* private */ s){
- if(!(s = s || this.selNode || this.lastSelNode)){
- return null;
- }
- // Here we pass in the current function to select to indicate the direction we're moving
- if(s.firstChild && s.isExpanded() && Ext.fly(s.ui.wrap).isVisible()){
- return this.select(s.firstChild, this.selectNext);
- }else if(s.nextSibling){
- return this.select(s.nextSibling, this.selectNext);
- }else if(s.parentNode){
- var newS = null;
- s.parentNode.bubble(function(){
- if(this.nextSibling){
- newS = this.getOwnerTree().selModel.select(this.nextSibling, this.selectNext);
- return false;
- }
- });
- return newS;
- }
- return null;
+ showNextMonth : function(e){
+ return this.update(Ext.Date.add(this.activeDate, Ext.Date.MONTH, 1));
},
- onKeyDown : function(e){
- var s = this.selNode || this.lastSelNode;
- // undesirable, but required
- var sm = this;
- if(!s){
- return;
- }
- var k = e.getKey();
- switch(k){
- case e.DOWN:
- e.stopEvent();
- this.selectNext();
- break;
- case e.UP:
- e.stopEvent();
- this.selectPrevious();
- break;
- case e.RIGHT:
- e.preventDefault();
- if(s.hasChildNodes()){
- if(!s.isExpanded()){
- s.expand();
- }else if(s.firstChild){
- this.select(s.firstChild, e);
- }
- }
- break;
- case e.LEFT:
- e.preventDefault();
- if(s.hasChildNodes() && s.isExpanded()){
- s.collapse();
- }else if(s.parentNode && (this.tree.rootVisible || s.parentNode != this.tree.getRootNode())){
- this.select(s.parentNode, e);
- }
- break;
- };
- }
-});
-
-/**
- * @class Ext.tree.MultiSelectionModel
- * @extends Ext.util.Observable
- * Multi selection for a TreePanel.
- */
-Ext.tree.MultiSelectionModel = Ext.extend(Ext.util.Observable, {
-
- constructor : function(config){
- this.selNodes = [];
- this.selMap = {};
- this.addEvents(
- /**
- * @event selectionchange
- * Fires when the selected nodes change
- * @param {MultiSelectionModel} this
- * @param {Array} nodes Array of the selected nodes
- */
- 'selectionchange'
- );
- Ext.apply(this, config);
- Ext.tree.MultiSelectionModel.superclass.constructor.call(this);
- },
-
- init : function(tree){
- this.tree = tree;
- tree.mon(tree.getTreeEl(), 'keydown', this.onKeyDown, this);
- tree.on('click', this.onNodeClick, this);
- },
-
- onNodeClick : function(node, e){
- if(e.ctrlKey && this.isSelected(node)){
- this.unselect(node);
- }else{
- this.select(node, e, e.ctrlKey);
- }
- },
-
/**
- * Select a node.
- * @param {TreeNode} node The node to select
- * @param {EventObject} e (optional) An event associated with the selection
- * @param {Boolean} keepExisting True to retain existing selections
- * @return {TreeNode} The selected node
+ * Show the previous year.
+ * @return {Ext.picker.Date} this
*/
- select : function(node, e, keepExisting){
- if(keepExisting !== true){
- this.clearSelections(true);
- }
- if(this.isSelected(node)){
- this.lastSelNode = node;
- return node;
- }
- this.selNodes.push(node);
- this.selMap[node.id] = node;
- this.lastSelNode = node;
- node.ui.onSelectedChange(true);
- this.fireEvent('selectionchange', this, this.selNodes);
- return node;
+ showPrevYear : function(){
+ this.update(Ext.Date.add(this.activeDate, Ext.Date.YEAR, -1));
},
-
+
/**
- * Deselect a node.
- * @param {TreeNode} node The node to unselect
+ * Show the next year.
+ * @return {Ext.picker.Date} this
*/
- unselect : function(node){
- if(this.selMap[node.id]){
- node.ui.onSelectedChange(false);
- var sn = this.selNodes;
- var index = sn.indexOf(node);
- if(index != -1){
- this.selNodes.splice(index, 1);
- }
- delete this.selMap[node.id];
- this.fireEvent('selectionchange', this, this.selNodes);
- }
+ showNextYear : function(){
+ this.update(Ext.Date.add(this.activeDate, Ext.Date.YEAR, 1));
},
-
+
/**
- * Clear all selections
+ * Respond to the mouse wheel event
+ * @private
+ * @param {Ext.EventObject} e
*/
- clearSelections : function(suppressEvent){
- var sn = this.selNodes;
- if(sn.length > 0){
- for(var i = 0, len = sn.length; i < len; i++){
- sn[i].ui.onSelectedChange(false);
- }
- this.selNodes = [];
- this.selMap = {};
- if(suppressEvent !== true){
- this.fireEvent('selectionchange', this, this.selNodes);
+ handleMouseWheel : function(e){
+ e.stopEvent();
+ if(!this.disabled){
+ var delta = e.getWheelDelta();
+ if(delta > 0){
+ this.showPrevMonth();
+ } else if(delta < 0){
+ this.showNextMonth();
}
}
},
-
+
/**
- * Returns true if the node is selected
- * @param {TreeNode} node The node to check
- * @return {Boolean}
+ * Respond to a date being clicked in the picker
+ * @private
+ * @param {Ext.EventObject} e
+ * @param {HTMLElement} t
*/
- isSelected : function(node){
- return this.selMap[node.id] ? true : false;
+ handleDateClick : function(e, t){
+ var me = this,
+ handler = me.handler;
+
+ e.stopEvent();
+ if(!me.disabled && t.dateValue && !Ext.fly(t.parentNode).hasCls(me.disabledCellCls)){
+ me.cancelFocus = me.focusOnSelect === false;
+ me.setValue(new Date(t.dateValue));
+ delete me.cancelFocus;
+ me.fireEvent('select', me, me.value);
+ if (handler) {
+ handler.call(me.scope || me, me, me.value);
+ }
+ // event handling is turned off on hide
+ // when we are using the picker in a field
+ // therefore onSelect comes AFTER the select
+ // event.
+ me.onSelect();
+ }
},
-
+
/**
- * Returns an array of the selected nodes
- * @return {Array}
+ * Perform any post-select actions
+ * @private
*/
- getSelectedNodes : function(){
- return this.selNodes.concat([]);
+ onSelect: function() {
+ if (this.hideOnSelect) {
+ this.hide();
+ }
},
- onKeyDown : Ext.tree.DefaultSelectionModel.prototype.onKeyDown,
-
- selectNext : Ext.tree.DefaultSelectionModel.prototype.selectNext,
-
- selectPrevious : Ext.tree.DefaultSelectionModel.prototype.selectPrevious
-});/**
- * @class Ext.data.Tree
- * @extends Ext.util.Observable
- * Represents a tree data structure and bubbles all the events for its nodes. The nodes
- * in the tree have most standard DOM functionality.
- * @constructor
- * @param {Node} root (optional) The root node
- */
-Ext.data.Tree = function(root){
- this.nodeHash = {};
- /**
- * The root node for this tree
- * @type Node
- */
- this.root = null;
- if(root){
- this.setRootNode(root);
- }
- this.addEvents(
- /**
- * @event append
- * Fires when a new child node is appended to a node in this tree.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The newly appended node
- * @param {Number} index The index of the newly appended node
- */
- "append",
- /**
- * @event remove
- * Fires when a child node is removed from a node in this tree.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node removed
- */
- "remove",
- /**
- * @event move
- * Fires when a node is moved to a new location in the tree
- * @param {Tree} tree The owner tree
- * @param {Node} node The node moved
- * @param {Node} oldParent The old parent of this node
- * @param {Node} newParent The new parent of this node
- * @param {Number} index The index it was moved to
- */
- "move",
- /**
- * @event insert
- * Fires when a new child node is inserted in a node in this tree.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node inserted
- * @param {Node} refNode The child node the node was inserted before
- */
- "insert",
- /**
- * @event beforeappend
- * Fires before a new child is appended to a node in this tree, return false to cancel the append.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node to be appended
- */
- "beforeappend",
- /**
- * @event beforeremove
- * Fires before a child is removed from a node in this tree, return false to cancel the remove.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node to be removed
- */
- "beforeremove",
- /**
- * @event beforemove
- * Fires before a node is moved to a new location in the tree. Return false to cancel the move.
- * @param {Tree} tree The owner tree
- * @param {Node} node The node being moved
- * @param {Node} oldParent The parent of the node
- * @param {Node} newParent The new parent the node is moving to
- * @param {Number} index The index it is being moved to
- */
- "beforemove",
- /**
- * @event beforeinsert
- * Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
- * @param {Tree} tree The owner tree
- * @param {Node} parent The parent node
- * @param {Node} node The child node to be inserted
- * @param {Node} refNode The child node the node is being inserted before
- */
- "beforeinsert"
- );
-
- Ext.data.Tree.superclass.constructor.call(this);
-};
-
-Ext.extend(Ext.data.Tree, Ext.util.Observable, {
/**
- * @cfg {String} pathSeparator
- * The token used to separate paths in node ids (defaults to '/').
+ * Sets the current value to today.
+ * @return {Ext.picker.Date} this
*/
- pathSeparator: "/",
+ selectToday : function(){
+ var me = this,
+ btn = me.todayBtn,
+ handler = me.handler;
- // private
- proxyNodeEvent : function(){
- return this.fireEvent.apply(this, arguments);
+ if(btn && !btn.disabled){
+ me.setValue(Ext.Date.clearTime(new Date()));
+ me.fireEvent('select', me, me.value);
+ if (handler) {
+ handler.call(me.scope || me, me, me.value);
+ }
+ me.onSelect();
+ }
+ return me;
},
/**
- * Returns the root node for this tree.
- * @return {Node}
+ * Update the selected cell
+ * @private
+ * @param {Date} date The new date
+ * @param {Date} active The active date
*/
- getRootNode : function(){
- return this.root;
+ selectedUpdate: function(date, active){
+ var me = this,
+ t = date.getTime(),
+ cells = me.cells,
+ cls = me.selectedCls;
+
+ cells.removeCls(cls);
+ cells.each(function(c){
+ if (c.dom.firstChild.dateValue == t) {
+ me.el.dom.setAttribute('aria-activedescendent', c.dom.id);
+ c.addCls(cls);
+ if(me.isVisible() && !me.cancelFocus){
+ Ext.fly(c.dom.firstChild).focus(50);
+ }
+ return false;
+ }
+ }, this);
},
/**
- * Sets the root node for this tree.
- * @param {Node} node
- * @return {Node}
+ * Update the contents of the picker for a new month
+ * @private
+ * @param {Date} date The new date
+ * @param {Date} active The active date
*/
- setRootNode : function(node){
- this.root = node;
- node.ownerTree = this;
- node.isRoot = true;
- this.registerNode(node);
- return node;
+ fullUpdate: function(date, active){
+ var me = this,
+ cells = me.cells.elements,
+ textNodes = me.textNodes,
+ disabledCls = me.disabledCellCls,
+ eDate = Ext.Date,
+ i = 0,
+ extraDays = 0,
+ visible = me.isVisible(),
+ sel = +eDate.clearTime(date, true),
+ today = +eDate.clearTime(new Date()),
+ min = me.minDate ? eDate.clearTime(me.minDate, true) : Number.NEGATIVE_INFINITY,
+ max = me.maxDate ? eDate.clearTime(me.maxDate, true) : Number.POSITIVE_INFINITY,
+ ddMatch = me.disabledDatesRE,
+ ddText = me.disabledDatesText,
+ ddays = me.disabledDays ? me.disabledDays.join('') : false,
+ ddaysText = me.disabledDaysText,
+ format = me.format,
+ days = eDate.getDaysInMonth(date),
+ firstOfMonth = eDate.getFirstDateOfMonth(date),
+ startingPos = firstOfMonth.getDay() - me.startDay,
+ previousMonth = eDate.add(date, eDate.MONTH, -1),
+ longDayFormat = me.longDayFormat,
+ prevStart,
+ current,
+ disableToday,
+ tempDate,
+ setCellClass,
+ html,
+ cls,
+ formatValue,
+ value;
+
+ if (startingPos < 0) {
+ startingPos += 7;
+ }
+
+ days += startingPos;
+ prevStart = eDate.getDaysInMonth(previousMonth) - startingPos;
+ current = new Date(previousMonth.getFullYear(), previousMonth.getMonth(), prevStart, me.initHour);
+
+ if (me.showToday) {
+ tempDate = eDate.clearTime(new Date());
+ disableToday = (tempDate < min || tempDate > max ||
+ (ddMatch && format && ddMatch.test(eDate.dateFormat(tempDate, format))) ||
+ (ddays && ddays.indexOf(tempDate.getDay()) != -1));
+
+ if (!me.disabled) {
+ me.todayBtn.setDisabled(disableToday);
+ me.todayKeyListener.setDisabled(disableToday);
+ }
+ }
+
+ setCellClass = function(cell){
+ value = +eDate.clearTime(current, true);
+ cell.title = eDate.format(current, longDayFormat);
+ // store dateValue number as an expando
+ cell.firstChild.dateValue = value;
+ if(value == today){
+ cell.className += ' ' + me.todayCls;
+ cell.title = me.todayText;
+ }
+ if(value == sel){
+ cell.className += ' ' + me.selectedCls;
+ me.el.dom.setAttribute('aria-activedescendant', cell.id);
+ if (visible && me.floating) {
+ Ext.fly(cell.firstChild).focus(50);
+ }
+ }
+ // disabling
+ if(value < min) {
+ cell.className = disabledCls;
+ cell.title = me.minText;
+ return;
+ }
+ if(value > max) {
+ cell.className = disabledCls;
+ cell.title = me.maxText;
+ return;
+ }
+ if(ddays){
+ if(ddays.indexOf(current.getDay()) != -1){
+ cell.title = ddaysText;
+ cell.className = disabledCls;
+ }
+ }
+ if(ddMatch && format){
+ formatValue = eDate.dateFormat(current, format);
+ if(ddMatch.test(formatValue)){
+ cell.title = ddText.replace('%0', formatValue);
+ cell.className = disabledCls;
+ }
+ }
+ };
+
+ for(; i < me.numDays; ++i) {
+ if (i < startingPos) {
+ html = (++prevStart);
+ cls = me.prevCls;
+ } else if (i >= days) {
+ html = (++extraDays);
+ cls = me.nextCls;
+ } else {
+ html = i - startingPos + 1;
+ cls = me.activeCls;
+ }
+ textNodes[i].innerHTML = html;
+ cells[i].className = cls;
+ current.setDate(current.getDate() + 1);
+ setCellClass(cells[i]);
+ }
+
+ me.monthBtn.setText(me.monthNames[date.getMonth()] + ' ' + date.getFullYear());
},
/**
- * Gets a node in this tree by its id.
- * @param {String} id
- * @return {Node}
+ * Update the contents of the picker
+ * @private
+ * @param {Date} date The new date
+ * @param {Boolean} forceRefresh True to force a full refresh
*/
- getNodeById : function(id){
- return this.nodeHash[id];
- },
+ update : function(date, forceRefresh){
+ var me = this,
+ active = me.activeDate;
- // private
- registerNode : function(node){
- this.nodeHash[node.id] = node;
+ if (me.rendered) {
+ me.activeDate = date;
+ if(!forceRefresh && active && me.el && active.getMonth() == date.getMonth() && active.getFullYear() == date.getFullYear()){
+ me.selectedUpdate(date, active);
+ } else {
+ me.fullUpdate(date, active);
+ }
+ }
+ return me;
},
- // private
- unregisterNode : function(node){
- delete this.nodeHash[node.id];
+ // private, inherit docs
+ beforeDestroy : function() {
+ var me = this;
+
+ if (me.rendered) {
+ Ext.destroy(
+ me.todayKeyListener,
+ me.keyNav,
+ me.monthPicker,
+ me.monthBtn,
+ me.nextRepeater,
+ me.prevRepeater,
+ me.todayBtn
+ );
+ delete me.textNodes;
+ delete me.cells.elements;
+ }
},
- toString : function(){
- return "[Tree"+(this.id?" "+this.id:"")+"]";
+ // private, inherit docs
+ onShow: function() {
+ this.callParent(arguments);
+ if (this.focusOnShow) {
+ this.focus();
+ }
}
+},
+
+// After dependencies have loaded:
+function() {
+ var proto = this.prototype;
+
+ proto.monthNames = Ext.Date.monthNames;
+
+ proto.dayNames = Ext.Date.dayNames;
+
+ proto.format = Ext.Date.defaultFormat;
});
/**
- * @class Ext.data.Node
- * @extends Ext.util.Observable
- * @cfg {Boolean} leaf true if this node is a leaf and does not have children
- * @cfg {String} id The id for this node. If one is not specified, one is generated.
+ * @class Ext.form.field.Date
+ * @extends Ext.form.field.Picker
+
+Provides a date input field with a {@link Ext.picker.Date date picker} dropdown and automatic date
+validation.
+
+This field recognizes and uses the JavaScript Date object as its main {@link #value} type. In addition,
+it recognizes string values which are parsed according to the {@link #format} and/or {@link #altFormats}
+configs. These may be reconfigured to use date formats appropriate for the user's locale.
+
+The field may be limited to a certain range of dates by using the {@link #minValue}, {@link #maxValue},
+{@link #disabledDays}, and {@link #disabledDates} config parameters. These configurations will be used both
+in the field's validation, and in the date picker dropdown by preventing invalid dates from being selected.
+{@img Ext.form.Date/Ext.form.Date.png Ext.form.Date component}
+#Example usage:#
+
+ Ext.create('Ext.form.Panel', {
+ width: 300,
+ bodyPadding: 10,
+ title: 'Dates',
+ items: [{
+ xtype: 'datefield',
+ anchor: '100%',
+ fieldLabel: 'From',
+ name: 'from_date',
+ maxValue: new Date() // limited to the current date or prior
+ }, {
+ xtype: 'datefield',
+ anchor: '100%',
+ fieldLabel: 'To',
+ name: 'to_date',
+ value: new Date() // defaults to today
+ }],
+ renderTo: Ext.getBody()
+ });
+
+#Date Formats Examples#
+
+This example shows a couple of different date format parsing scenarios. Both use custom date format
+configurations; the first one matches the configured `format` while the second matches the `altFormats`.
+
+ Ext.create('Ext.form.Panel', {
+ renderTo: Ext.getBody(),
+ width: 300,
+ bodyPadding: 10,
+ title: 'Dates',
+ items: [{
+ xtype: 'datefield',
+ anchor: '100%',
+ fieldLabel: 'Date',
+ name: 'date',
+ // The value matches the format; will be parsed and displayed using that format.
+ format: 'm d Y',
+ value: '2 4 1978'
+ }, {
+ xtype: 'datefield',
+ anchor: '100%',
+ fieldLabel: 'Date',
+ name: 'date',
+ // The value does not match the format, but does match an altFormat; will be parsed
+ // using the altFormat and displayed using the format.
+ format: 'm d Y',
+ altFormats: 'm,d,Y|m.d.Y',
+ value: '2.4.1978'
+ }]
+ });
+
* @constructor
- * @param {Object} attributes The attributes/config for the node
+ * Create a new Date field
+ * @param {Object} config
+ *
+ * @xtype datefield
+ * @markdown
+ * @docauthor Jason Johnston
*/
-Ext.data.Node = function(attributes){
+Ext.define('Ext.form.field.Date', {
+ extend:'Ext.form.field.Picker',
+ alias: 'widget.datefield',
+ requires: ['Ext.picker.Date'],
+ alternateClassName: ['Ext.form.DateField', 'Ext.form.Date'],
+
+ /**
+ * @cfg {String} format
+ * The default date format string which can be overriden for localization support. The format must be
+ * valid according to {@link Ext.Date#parse} (defaults to 'm/d/Y').
+ */
+ format : "m/d/Y",
+ /**
+ * @cfg {String} altFormats
+ * Multiple date formats separated by "|" to try when parsing a user input value and it
+ * does not match the defined format (defaults to
+ * 'm/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d|n-j|n/j').
+ */
+ altFormats : "m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d|n-j|n/j",
+ /**
+ * @cfg {String} disabledDaysText
+ * The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')
+ */
+ disabledDaysText : "Disabled",
+ /**
+ * @cfg {String} disabledDatesText
+ * The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')
+ */
+ disabledDatesText : "Disabled",
+ /**
+ * @cfg {String} minText
+ * The error text to display when the date in the cell is before {@link #minValue} (defaults to
+ * 'The date in this field must be after {minValue}').
+ */
+ minText : "The date in this field must be equal to or after {0}",
+ /**
+ * @cfg {String} maxText
+ * The error text to display when the date in the cell is after {@link #maxValue} (defaults to
+ * 'The date in this field must be before {maxValue}').
+ */
+ maxText : "The date in this field must be equal to or before {0}",
/**
- * The attributes supplied for the node. You can use this property to access any custom attributes you supplied.
- * @type {Object}
+ * @cfg {String} invalidText
+ * The error text to display when the date in the field is invalid (defaults to
+ * '{value} is not a valid date - it must be in the format {format}').
*/
- this.attributes = attributes || {};
- this.leaf = this.attributes.leaf;
+ invalidText : "{0} is not a valid date - it must be in the format {1}",
/**
- * The node id. @type String
+ * @cfg {String} triggerCls
+ * An additional CSS class used to style the trigger button. The trigger will always get the
+ * class 'x-form-trigger' and triggerCls will be appended if specified
+ * (defaults to 'x-form-date-trigger' which displays a calendar icon).
*/
- this.id = this.attributes.id;
- if(!this.id){
- this.id = Ext.id(null, "xnode-");
- this.attributes.id = this.id;
- }
+ triggerCls : Ext.baseCSSPrefix + 'form-date-trigger',
/**
- * All child nodes of this node. @type Array
+ * @cfg {Boolean} showToday
+ * false to hide the footer area of the Date picker containing the Today button and disable
+ * the keyboard handler for spacebar that selects the current date (defaults to true).
*/
- this.childNodes = [];
- if(!this.childNodes.indexOf){ // indexOf is a must
- this.childNodes.indexOf = function(o){
- for(var i = 0, len = this.length; i < len; i++){
- if(this[i] == o){
- return i;
- }
- }
- return -1;
- };
- }
+ showToday : true,
/**
- * The parent node for this node. @type Node
+ * @cfg {Date/String} minValue
+ * The minimum allowed date. Can be either a Javascript date object or a string date in a
+ * valid format (defaults to undefined).
*/
- this.parentNode = null;
/**
- * The first direct child node of this node, or null if this node has no child nodes. @type Node
+ * @cfg {Date/String} maxValue
+ * The maximum allowed date. Can be either a Javascript date object or a string date in a
+ * valid format (defaults to undefined).
*/
- this.firstChild = null;
/**
- * The last direct child node of this node, or null if this node has no child nodes. @type Node
+ * @cfg {Array} disabledDays
+ * An array of days to disable, 0 based (defaults to undefined). Some examples:
+// disable Sunday and Saturday:
+disabledDays: [0, 6]
+// disable weekdays:
+disabledDays: [1,2,3,4,5]
+ *
*/
- this.lastChild = null;
/**
- * The node immediately preceding this node in the tree, or null if there is no sibling node. @type Node
+ * @cfg {Array} disabledDates
+ * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
+ * expression so they are very powerful. Some examples:
+// disable these exact dates:
+disabledDates: ["03/08/2003", "09/16/2003"]
+// disable these days for every year:
+disabledDates: ["03/08", "09/16"]
+// only match the beginning (useful if you are using short years):
+disabledDates: ["^03/08"]
+// disable every day in March 2006:
+disabledDates: ["03/../2006"]
+// disable every day in every March:
+disabledDates: ["^03"]
+ *
+ * Note that the format of the dates included in the array should exactly match the {@link #format} config.
+ * In order to support regular expressions, if you are using a {@link #format date format} that has "." in
+ * it, you will have to escape the dot when restricting dates. For example: ["03\\.08\\.03"].
*/
- this.previousSibling = null;
+
/**
- * The node immediately following this node in the tree, or null if there is no sibling node. @type Node
+ * @cfg {String} submitFormat The date format string which will be submitted to the server.
+ * The format must be valid according to {@link Ext.Date#parse} (defaults to {@link #format}).
*/
- this.nextSibling = null;
- this.addEvents({
- /**
- * @event append
- * Fires when a new child node is appended
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} node The newly appended node
- * @param {Number} index The index of the newly appended node
- */
- "append" : true,
- /**
- * @event remove
- * Fires when a child node is removed
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} node The removed node
- */
- "remove" : true,
- /**
- * @event move
- * Fires when this node is moved to a new location in the tree
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} oldParent The old parent of this node
- * @param {Node} newParent The new parent of this node
- * @param {Number} index The index it was moved to
- */
- "move" : true,
- /**
- * @event insert
- * Fires when a new child node is inserted.
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} node The child node inserted
- * @param {Node} refNode The child node the node was inserted before
- */
- "insert" : true,
- /**
- * @event beforeappend
- * Fires before a new child is appended, return false to cancel the append.
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} node The child node to be appended
- */
- "beforeappend" : true,
- /**
- * @event beforeremove
- * Fires before a child is removed, return false to cancel the remove.
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} node The child node to be removed
- */
- "beforeremove" : true,
- /**
- * @event beforemove
- * Fires before this node is moved to a new location in the tree. Return false to cancel the move.
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} oldParent The parent of this node
- * @param {Node} newParent The new parent this node is moving to
- * @param {Number} index The index it is being moved to
- */
- "beforemove" : true,
- /**
- * @event beforeinsert
- * Fires before a new child is inserted, return false to cancel the insert.
- * @param {Tree} tree The owner tree
- * @param {Node} this This node
- * @param {Node} node The child node to be inserted
- * @param {Node} refNode The child node the node is being inserted before
- */
- "beforeinsert" : true
- });
- this.listeners = this.attributes.listeners;
- Ext.data.Node.superclass.constructor.call(this);
-};
+ // in the absence of a time value, a default value of 12 noon will be used
+ // (note: 12 noon was chosen because it steers well clear of all DST timezone changes)
+ initTime: '12', // 24 hour format
-Ext.extend(Ext.data.Node, Ext.util.Observable, {
- // private
- fireEvent : function(evtName){
- // first do standard event for this node
- if(Ext.data.Node.superclass.fireEvent.apply(this, arguments) === false){
- return false;
- }
- // then bubble it up to the tree if the event wasn't cancelled
- var ot = this.getOwnerTree();
- if(ot){
- if(ot.proxyNodeEvent.apply(ot, arguments) === false){
- return false;
- }
- }
- return true;
- },
+ initTimeFormat: 'H',
+ matchFieldWidth: false,
/**
- * Returns true if this node is a leaf
- * @return {Boolean}
+ * @cfg {Number} startDay
+ * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)
*/
- isLeaf : function(){
- return this.leaf === true;
- },
+ startDay: 0,
+
+ initComponent : function(){
+ var me = this,
+ isString = Ext.isString,
+ min, max;
- // private
- setFirstChild : function(node){
- this.firstChild = node;
+ min = me.minValue;
+ max = me.maxValue;
+ if(isString(min)){
+ me.minValue = me.parseDate(min);
+ }
+ if(isString(max)){
+ me.maxValue = me.parseDate(max);
+ }
+ me.disabledDatesRE = null;
+ me.initDisabledDays();
+
+ me.callParent();
},
- //private
- setLastChild : function(node){
- this.lastChild = node;
+ initValue: function() {
+ var me = this,
+ value = me.value;
+
+ // If a String value was supplied, try to convert it to a proper Date
+ if (Ext.isString(value)) {
+ me.value = me.rawToValue(value);
+ }
+
+ me.callParent();
},
+ // private
+ initDisabledDays : function(){
+ if(this.disabledDates){
+ var dd = this.disabledDates,
+ len = dd.length - 1,
+ re = "(?:";
- /**
- * Returns true if this node is the last child of its parent
- * @return {Boolean}
- */
- isLast : function(){
- return (!this.parentNode ? true : this.parentNode.lastChild == this);
+ Ext.each(dd, function(d, i){
+ re += Ext.isDate(d) ? '^' + Ext.String.escapeRegex(d.dateFormat(this.format)) + '$' : dd[i];
+ if (i !== len) {
+ re += '|';
+ }
+ }, this);
+ this.disabledDatesRE = new RegExp(re + ')');
+ }
},
/**
- * Returns true if this node is the first child of its parent
- * @return {Boolean}
+ * Replaces any existing disabled dates with new values and refreshes the Date picker.
+ * @param {Array} disabledDates An array of date strings (see the {@link #disabledDates} config
+ * for details on supported values) used to disable a pattern of dates.
*/
- isFirst : function(){
- return (!this.parentNode ? true : this.parentNode.firstChild == this);
+ setDisabledDates : function(dd){
+ var me = this,
+ picker = me.picker;
+
+ me.disabledDates = dd;
+ me.initDisabledDays();
+ if (picker) {
+ picker.setDisabledDates(me.disabledDatesRE);
+ }
},
/**
- * Returns true if this node has one or more child nodes, else false.
- * @return {Boolean}
+ * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the Date picker.
+ * @param {Array} disabledDays An array of disabled day indexes. See the {@link #disabledDays}
+ * config for details on supported values.
*/
- hasChildNodes : function(){
- return !this.isLeaf() && this.childNodes.length > 0;
+ setDisabledDays : function(dd){
+ var picker = this.picker;
+
+ this.disabledDays = dd;
+ if (picker) {
+ picker.setDisabledDays(dd);
+ }
},
/**
- * Returns true if this node has one or more child nodes, or if the expandable
- * node attribute is explicitly specified as true (see {@link #attributes}), otherwise returns false.
- * @return {Boolean}
+ * Replaces any existing {@link #minValue} with the new value and refreshes the Date picker.
+ * @param {Date} value The minimum date that can be selected
*/
- isExpandable : function(){
- return this.attributes.expandable || this.hasChildNodes();
+ setMinValue : function(dt){
+ var me = this,
+ picker = me.picker,
+ minValue = (Ext.isString(dt) ? me.parseDate(dt) : dt);
+
+ me.minValue = minValue;
+ if (picker) {
+ picker.minText = Ext.String.format(me.minText, me.formatDate(me.minValue));
+ picker.setMinDate(minValue);
+ }
},
/**
- * Insert node(s) as the last child node of this node.
- * @param {Node/Array} node The node or Array of nodes to append
- * @return {Node} The appended node if single append, or null if an array was passed
+ * Replaces any existing {@link #maxValue} with the new value and refreshes the Date picker.
+ * @param {Date} value The maximum date that can be selected
*/
- appendChild : function(node){
- var multi = false;
- if(Ext.isArray(node)){
- multi = node;
- }else if(arguments.length > 1){
- multi = arguments;
- }
- // if passed an array or multiple args do them one by one
- if(multi){
- for(var i = 0, len = multi.length; i < len; i++) {
- this.appendChild(multi[i]);
- }
- }else{
- if(this.fireEvent("beforeappend", this.ownerTree, this, node) === false){
- return false;
- }
- var index = this.childNodes.length;
- var oldParent = node.parentNode;
- // it's a move, make sure we move it cleanly
- if(oldParent){
- if(node.fireEvent("beforemove", node.getOwnerTree(), node, oldParent, this, index) === false){
- return false;
- }
- oldParent.removeChild(node);
- }
- index = this.childNodes.length;
- if(index === 0){
- this.setFirstChild(node);
- }
- this.childNodes.push(node);
- node.parentNode = this;
- var ps = this.childNodes[index-1];
- if(ps){
- node.previousSibling = ps;
- ps.nextSibling = node;
- }else{
- node.previousSibling = null;
- }
- node.nextSibling = null;
- this.setLastChild(node);
- node.setOwnerTree(this.getOwnerTree());
- this.fireEvent("append", this.ownerTree, this, node, index);
- if(oldParent){
- node.fireEvent("move", this.ownerTree, node, oldParent, this, index);
- }
- return node;
+ setMaxValue : function(dt){
+ var me = this,
+ picker = me.picker,
+ maxValue = (Ext.isString(dt) ? me.parseDate(dt) : dt);
+
+ me.maxValue = maxValue;
+ if (picker) {
+ picker.maxText = Ext.String.format(me.maxText, me.formatDate(me.maxValue));
+ picker.setMaxDate(maxValue);
}
},
/**
- * Removes a child node from this node.
- * @param {Node} node The node to remove
- * @param {Boolean} destroy true to destroy the node upon removal. Defaults to false.
- * @return {Node} The removed node
+ * Runs all of Date's validations and returns an array of any errors. Note that this first
+ * runs Text's validations, so the returned array is an amalgamation of all field errors.
+ * The additional validation checks are testing that the date format is valid, that the chosen
+ * date is within the min and max date constraints set, that the date chosen is not in the disabledDates
+ * regex and that the day chosed is not one of the disabledDays.
+ * @param {Mixed} value The value to get errors for (defaults to the current field value)
+ * @return {Array} All validation errors for this field
*/
- removeChild : function(node, destroy){
- var index = this.childNodes.indexOf(node);
- if(index == -1){
- return false;
- }
- if(this.fireEvent("beforeremove", this.ownerTree, this, node) === false){
- return false;
- }
-
- // remove it from childNodes collection
- this.childNodes.splice(index, 1);
+ getErrors: function(value) {
+ var me = this,
+ format = Ext.String.format,
+ clearTime = Ext.Date.clearTime,
+ errors = me.callParent(arguments),
+ disabledDays = me.disabledDays,
+ disabledDatesRE = me.disabledDatesRE,
+ minValue = me.minValue,
+ maxValue = me.maxValue,
+ len = disabledDays ? disabledDays.length : 0,
+ i = 0,
+ svalue,
+ fvalue,
+ day,
+ time;
- // update siblings
- if(node.previousSibling){
- node.previousSibling.nextSibling = node.nextSibling;
- }
- if(node.nextSibling){
- node.nextSibling.previousSibling = node.previousSibling;
- }
+ value = me.formatDate(value || me.processRawValue(me.getRawValue()));
- // update child refs
- if(this.firstChild == node){
- this.setFirstChild(node.nextSibling);
- }
- if(this.lastChild == node){
- this.setLastChild(node.previousSibling);
+ if (value === null || value.length < 1) { // if it's blank and textfield didn't flag it then it's valid
+ return errors;
}
- this.fireEvent("remove", this.ownerTree, this, node);
- if(destroy){
- node.destroy(true);
- }else{
- node.clear();
+ svalue = value;
+ value = me.parseDate(value);
+ if (!value) {
+ errors.push(format(me.invalidText, svalue, me.format));
+ return errors;
}
- return node;
- },
- // private
- clear : function(destroy){
- // clear any references from the node
- this.setOwnerTree(null, destroy);
- this.parentNode = this.previousSibling = this.nextSibling = null;
- if(destroy){
- this.firstChild = this.lastChild = null;
+ time = value.getTime();
+ if (minValue && time < clearTime(minValue).getTime()) {
+ errors.push(format(me.minText, me.formatDate(minValue)));
}
- },
- /**
- * Destroys the node.
- */
- destroy : function(/* private */ silent){
- /*
- * Silent is to be used in a number of cases
- * 1) When setRootNode is called.
- * 2) When destroy on the tree is called
- * 3) For destroying child nodes on a node
- */
- if(silent === true){
- this.purgeListeners();
- this.clear(true);
- Ext.each(this.childNodes, function(n){
- n.destroy(true);
- });
- this.childNodes = null;
- }else{
- this.remove(true);
+ if (maxValue && time > clearTime(maxValue).getTime()) {
+ errors.push(format(me.maxText, me.formatDate(maxValue)));
}
- },
- /**
- * Inserts the first node before the second node in this nodes childNodes collection.
- * @param {Node} node The node to insert
- * @param {Node} refNode The node to insert before (if null the node is appended)
- * @return {Node} The inserted node
- */
- insertBefore : function(node, refNode){
- if(!refNode){ // like standard Dom, refNode can be null for append
- return this.appendChild(node);
- }
- // nothing to do
- if(node == refNode){
- return false;
- }
+ if (disabledDays) {
+ day = value.getDay();
- if(this.fireEvent("beforeinsert", this.ownerTree, this, node, refNode) === false){
- return false;
+ for(; i < len; i++) {
+ if (day === disabledDays[i]) {
+ errors.push(me.disabledDaysText);
+ break;
+ }
+ }
}
- var index = this.childNodes.indexOf(refNode);
- var oldParent = node.parentNode;
- var refIndex = index;
- // when moving internally, indexes will change after remove
- if(oldParent == this && this.childNodes.indexOf(node) < index){
- refIndex--;
+ fvalue = me.formatDate(value);
+ if (disabledDatesRE && disabledDatesRE.test(fvalue)) {
+ errors.push(format(me.disabledDatesText, fvalue));
}
- // it's a move, make sure we move it cleanly
- if(oldParent){
- if(node.fireEvent("beforemove", node.getOwnerTree(), node, oldParent, this, index, refNode) === false){
- return false;
- }
- oldParent.removeChild(node);
- }
- if(refIndex === 0){
- this.setFirstChild(node);
- }
- this.childNodes.splice(refIndex, 0, node);
- node.parentNode = this;
- var ps = this.childNodes[refIndex-1];
- if(ps){
- node.previousSibling = ps;
- ps.nextSibling = node;
- }else{
- node.previousSibling = null;
- }
- node.nextSibling = refNode;
- refNode.previousSibling = node;
- node.setOwnerTree(this.getOwnerTree());
- this.fireEvent("insert", this.ownerTree, this, node, refNode);
- if(oldParent){
- node.fireEvent("move", this.ownerTree, node, oldParent, this, refIndex, refNode);
- }
- return node;
+ return errors;
},
- /**
- * Removes this node from its parent
- * @param {Boolean} destroy true to destroy the node upon removal. Defaults to false.
- * @return {Node} this
- */
- remove : function(destroy){
- if (this.parentNode) {
- this.parentNode.removeChild(this, destroy);
- }
- return this;
+ rawToValue: function(rawValue) {
+ return this.parseDate(rawValue) || rawValue || null;
},
- /**
- * Removes all child nodes from this node.
- * @param {Boolean} destroy true to destroy the node upon removal. Defaults to false.
- * @return {Node} this
- */
- removeAll : function(destroy){
- var cn = this.childNodes,
- n;
- while((n = cn[0])){
- this.removeChild(n, destroy);
- }
- return this;
+ valueToRaw: function(value) {
+ return this.formatDate(this.parseDate(value));
},
/**
- * Returns the child node at the specified index.
- * @param {Number} index
- * @return {Node}
- */
- item : function(index){
- return this.childNodes[index];
- },
+ * Sets the value of the date field. You can pass a date object or any string that can be
+ * parsed into a valid date, using {@link #format} as the date format, according
+ * to the same rules as {@link Ext.Date#parse} (the default format used is "m/d/Y").
+ *
Usage:
+ *
+//All of these calls set the same date value (May 4, 2006)
- /**
- * Replaces one child node in this node with another.
- * @param {Node} newChild The replacement node
- * @param {Node} oldChild The node to replace
- * @return {Node} The replaced node
- */
- replaceChild : function(newChild, oldChild){
- var s = oldChild ? oldChild.nextSibling : null;
- this.removeChild(oldChild);
- this.insertBefore(newChild, s);
- return oldChild;
- },
+//Pass a date object:
+var dt = new Date('5/4/2006');
+dateField.setValue(dt);
- /**
- * Returns the index of a child node
- * @param {Node} node
- * @return {Number} The index of the node or -1 if it was not found
+//Pass a date string (default format):
+dateField.setValue('05/04/2006');
+
+//Pass a date string (custom format):
+dateField.format = 'Y-m-d';
+dateField.setValue('2006-05-04');
+
+ * @param {String/Date} date The date or valid date string
+ * @return {Ext.form.field.Date} this
+ * @method setValue
*/
- indexOf : function(child){
- return this.childNodes.indexOf(child);
- },
/**
- * Returns the tree this node is in.
- * @return {Tree}
+ * Attempts to parse a given string value using a given {@link Ext.Date#parse date format}.
+ * @param {String} value The value to attempt to parse
+ * @param {String} format A valid date format (see {@link Ext.Date#parse})
+ * @return {Date} The parsed Date object, or null if the value could not be successfully parsed.
*/
- getOwnerTree : function(){
- // if it doesn't have one, look for one
- if(!this.ownerTree){
- var p = this;
- while(p){
- if(p.ownerTree){
- this.ownerTree = p.ownerTree;
- break;
- }
- p = p.parentNode;
+ safeParse : function(value, format) {
+ var me = this,
+ utilDate = Ext.Date,
+ parsedDate,
+ result = null;
+
+ if (utilDate.formatContainsHourInfo(format)) {
+ // if parse format contains hour information, no DST adjustment is necessary
+ result = utilDate.parse(value, format);
+ } else {
+ // set time to 12 noon, then clear the time
+ parsedDate = utilDate.parse(value + ' ' + me.initTime, format + ' ' + me.initTimeFormat);
+ if (parsedDate) {
+ result = utilDate.clearTime(parsedDate);
}
}
- return this.ownerTree;
+ return result;
+ },
+
+ // @private
+ getSubmitValue: function() {
+ var me = this,
+ format = me.submitFormat || me.format,
+ value = me.getValue();
+
+ return value ? Ext.Date.format(value, format) : null;
},
/**
- * Returns depth of this node (the root node has a depth of 0)
- * @return {Number}
+ * @private
*/
- getDepth : function(){
- var depth = 0;
- var p = this;
- while(p.parentNode){
- ++depth;
- p = p.parentNode;
+ parseDate : function(value) {
+ if(!value || Ext.isDate(value)){
+ return value;
}
- return depth;
- },
- // private
- setOwnerTree : function(tree, destroy){
- // if it is a move, we need to update everyone
- if(tree != this.ownerTree){
- if(this.ownerTree){
- this.ownerTree.unregisterNode(this);
- }
- this.ownerTree = tree;
- // If we're destroying, we don't need to recurse since it will be called on each child node
- if(destroy !== true){
- Ext.each(this.childNodes, function(n){
- n.setOwnerTree(tree);
- });
- }
- if(tree){
- tree.registerNode(this);
- }
- }
- },
+ var me = this,
+ val = me.safeParse(value, me.format),
+ altFormats = me.altFormats,
+ altFormatsArray = me.altFormatsArray,
+ i = 0,
+ len;
- /**
- * Changes the id of this node.
- * @param {String} id The new id for the node.
- */
- setId: function(id){
- if(id !== this.id){
- var t = this.ownerTree;
- if(t){
- t.unregisterNode(this);
- }
- this.id = this.attributes.id = id;
- if(t){
- t.registerNode(this);
+ if (!val && altFormats) {
+ altFormatsArray = altFormatsArray || altFormats.split('|');
+ len = altFormatsArray.length;
+ for (; i < len && !val; ++i) {
+ val = me.safeParse(value, altFormatsArray[i]);
}
- this.onIdChange(id);
}
+ return val;
},
// private
- onIdChange: Ext.emptyFn,
-
- /**
- * Returns the path for this node. The path can be used to expand or select this node programmatically.
- * @param {String} attr (optional) The attr to use for the path (defaults to the node's id)
- * @return {String} The path
- */
- getPath : function(attr){
- attr = attr || "id";
- var p = this.parentNode;
- var b = [this.attributes[attr]];
- while(p){
- b.unshift(p.attributes[attr]);
- p = p.parentNode;
- }
- var sep = this.getOwnerTree().pathSeparator;
- return sep + b.join(sep);
+ formatDate : function(date){
+ return Ext.isDate(date) ? Ext.Date.dateFormat(date, this.format) : date;
},
- /**
- * Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function
- * will be the args provided or the current node. If the function returns false at any point,
- * the bubble is stopped.
- * @param {Function} fn The function to call
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the current Node.
- * @param {Array} args (optional) The args to call the function with (default to passing the current Node)
- */
- bubble : function(fn, scope, args){
- var p = this;
- while(p){
- if(fn.apply(scope || p, args || [p]) === false){
- break;
+ createPicker: function() {
+ var me = this,
+ format = Ext.String.format;
+
+ return Ext.create('Ext.picker.Date', {
+ ownerCt: this.ownerCt,
+ renderTo: document.body,
+ floating: true,
+ hidden: true,
+ focusOnShow: true,
+ minDate: me.minValue,
+ maxDate: me.maxValue,
+ disabledDatesRE: me.disabledDatesRE,
+ disabledDatesText: me.disabledDatesText,
+ disabledDays: me.disabledDays,
+ disabledDaysText: me.disabledDaysText,
+ format: me.format,
+ showToday: me.showToday,
+ startDay: me.startDay,
+ minText: format(me.minText, me.formatDate(me.minValue)),
+ maxText: format(me.maxText, me.formatDate(me.maxValue)),
+ listeners: {
+ scope: me,
+ select: me.onSelect
+ },
+ keyNavConfig: {
+ esc: function() {
+ me.collapse();
+ }
}
- p = p.parentNode;
- }
+ });
},
- /**
- * Cascades down the tree from this node, calling the specified function with each node. The arguments to the function
- * will be the args provided or the current node. If the function returns false at any point,
- * the cascade is stopped on that branch.
- * @param {Function} fn The function to call
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the current Node.
- * @param {Array} args (optional) The args to call the function with (default to passing the current Node)
- */
- cascade : function(fn, scope, args){
- if(fn.apply(scope || this, args || [this]) !== false){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++) {
- cs[i].cascade(fn, scope, args);
- }
- }
+ onSelect: function(m, d) {
+ this.setValue(d);
+ this.fireEvent('select', this, d);
+ this.collapse();
},
/**
- * Interates the child nodes of this node, calling the specified function with each node. The arguments to the function
- * will be the args provided or the current node. If the function returns false at any point,
- * the iteration stops.
- * @param {Function} fn The function to call
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the current Node in the iteration.
- * @param {Array} args (optional) The args to call the function with (default to passing the current Node)
+ * @private
+ * Sets the Date picker's value to match the current field value when expanding.
*/
- eachChild : function(fn, scope, args){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++) {
- if(fn.apply(scope || this, args || [cs[i]]) === false){
- break;
- }
- }
+ onExpand: function() {
+ var me = this,
+ value = me.getValue();
+ me.picker.setValue(value instanceof Date ? value : new Date());
},
/**
- * Finds the first child that has the attribute with the specified value.
- * @param {String} attribute The attribute name
- * @param {Mixed} value The value to search for
- * @param {Boolean} deep (Optional) True to search through nodes deeper than the immediate children
- * @return {Node} The found child or null if none was found
+ * @private
+ * Focuses the field when collapsing the Date picker.
*/
- findChild : function(attribute, value, deep){
- return this.findChildBy(function(){
- return this.attributes[attribute] == value;
- }, null, deep);
+ onCollapse: function() {
+ this.focus(false, 60);
},
- /**
- * Finds the first child by a custom function. The child matches if the function passed returns true
.
- * @param {Function} fn A function which must return true
if the passed Node is the required Node.
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the Node being tested.
- * @param {Boolean} deep (Optional) True to search through nodes deeper than the immediate children
- * @return {Node} The found child or null if none was found
- */
- findChildBy : function(fn, scope, deep){
- var cs = this.childNodes,
- len = cs.length,
- i = 0,
- n,
- res;
- for(; i < len; i++){
- n = cs[i];
- if(fn.call(scope || n, n) === true){
- return n;
- }else if (deep){
- res = n.findChildBy(fn, scope, deep);
- if(res != null){
- return res;
- }
- }
-
+ // private
+ beforeBlur : function(){
+ var v = this.parseDate(this.getRawValue());
+ if(v){
+ this.setValue(v);
}
- return null;
- },
+ }
/**
- * Sorts this nodes children using the supplied sort function.
- * @param {Function} fn A function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.
- * @param {Object} scope (optional)The scope (this
reference) in which the function is executed. Defaults to the browser window.
+ * @cfg {Boolean} grow @hide
*/
- sort : function(fn, scope){
- var cs = this.childNodes;
- var len = cs.length;
- if(len > 0){
- var sortFn = scope ? function(){fn.apply(scope, arguments);} : fn;
- cs.sort(sortFn);
- for(var i = 0; i < len; i++){
- var n = cs[i];
- n.previousSibling = cs[i-1];
- n.nextSibling = cs[i+1];
- if(i === 0){
- this.setFirstChild(n);
- }
- if(i == len-1){
- this.setLastChild(n);
- }
- }
- }
- },
-
/**
- * Returns true if this node is an ancestor (at any point) of the passed node.
- * @param {Node} node
- * @return {Boolean}
+ * @cfg {Number} growMin @hide
*/
- contains : function(node){
- return node.isAncestor(this);
- },
-
/**
- * Returns true if the passed node is an ancestor (at any point) of this node.
- * @param {Node} node
- * @return {Boolean}
+ * @cfg {Number} growMax @hide
*/
- isAncestor : function(node){
- var p = this.parentNode;
- while(p){
- if(p == node){
- return true;
- }
- p = p.parentNode;
- }
- return false;
- },
+ /**
+ * @hide
+ * @method autoSize
+ */
+});
+
+/**
+ * @class Ext.form.field.Display
+ * @extends Ext.form.field.Base
+ * A display-only text field which is not validated and not submitted. This is useful for when you want
+ * to display a value from a form's {@link Ext.form.Basic#load loaded data} but do not want to allow the
+ * user to edit or submit that value. The value can be optionally {@link #htmlEncode HTML encoded} if it contains
+ * HTML markup that you do not want to be rendered.
+ * If you have more complex content, or need to include components within the displayed content, also
+ * consider using a {@link Ext.form.FieldContainer} instead.
+ * {@img Ext.form.Display/Ext.form.Display.png Ext.form.Display component}
+ * Example:
+ *
+ Ext.create('Ext.form.Panel', {
+ width: 175,
+ height: 120,
+ bodyPadding: 10,
+ title: 'Final Score',
+ items: [{
+ xtype: 'displayfield',
+ fieldLabel: 'Home',
+ name: 'home_score',
+ value: '10'
+ }, {
+ xtype: 'displayfield',
+ fieldLabel: 'Visitor',
+ name: 'visitor_score',
+ value: '11'
+ }],
+ buttons: [{
+ text: 'Update',
+ }],
+ renderTo: Ext.getBody()
+ });
+
- toString : function(){
- return "[Node"+(this.id?" "+this.id:"")+"]";
- }
-});/**
- * @class Ext.tree.TreeNode
- * @extends Ext.data.Node
- * @cfg {String} text The text for this node
- * @cfg {Boolean} expanded true to start the node expanded
- * @cfg {Boolean} allowDrag False to make this node undraggable if {@link #draggable} = true (defaults to true)
- * @cfg {Boolean} allowDrop False if this node cannot have child nodes dropped on it (defaults to true)
- * @cfg {Boolean} disabled true to start the node disabled
- * @cfg {String} icon The path to an icon for the node. The preferred way to do this
- * is to use the cls or iconCls attributes and add the icon via a CSS background image.
- * @cfg {String} cls A css class to be added to the node
- * @cfg {String} iconCls A css class to be added to the nodes icon element for applying css background images
- * @cfg {String} href URL of the link used for the node (defaults to #)
- * @cfg {String} hrefTarget target frame for the link
- * @cfg {Boolean} hidden True to render hidden. (Defaults to false).
- * @cfg {String} qtip An Ext QuickTip for the node
- * @cfg {Boolean} expandable If set to true, the node will always show a plus/minus icon, even when empty
- * @cfg {String} qtipCfg An Ext QuickTip config for the node (used instead of qtip)
- * @cfg {Boolean} singleClickExpand True for single click expand on this node
- * @cfg {Function} uiProvider A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)
- * @cfg {Boolean} checked True to render a checked checkbox for this node, false to render an unchecked checkbox
- * (defaults to undefined with no checkbox rendered)
- * @cfg {Boolean} draggable True to make this node draggable (defaults to false)
- * @cfg {Boolean} isTarget False to not allow this node to act as a drop target (defaults to true)
- * @cfg {Boolean} allowChildren False to not allow this node to have child nodes (defaults to true)
- * @cfg {Boolean} editable False to not allow this node to be edited by an {@link Ext.tree.TreeEditor} (defaults to true)
* @constructor
- * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node
+ * Creates a new DisplayField.
+ * @param {Object} config Configuration options
+ *
+ * @xtype displayfield
*/
-Ext.tree.TreeNode = function(attributes){
- attributes = attributes || {};
- if(Ext.isString(attributes)){
- attributes = {text: attributes};
- }
- this.childrenRendered = false;
- this.rendered = false;
- Ext.tree.TreeNode.superclass.constructor.call(this, attributes);
- this.expanded = attributes.expanded === true;
- this.isTarget = attributes.isTarget !== false;
- this.draggable = attributes.draggable !== false && attributes.allowDrag !== false;
- this.allowChildren = attributes.allowChildren !== false && attributes.allowDrop !== false;
+Ext.define('Ext.form.field.Display', {
+ extend:'Ext.form.field.Base',
+ alias: 'widget.displayfield',
+ requires: ['Ext.util.Format', 'Ext.XTemplate'],
+ alternateClassName: ['Ext.form.DisplayField', 'Ext.form.Display'],
+ fieldSubTpl: [
+ '',
+ {
+ compiled: true,
+ disableFormats: true
+ }
+ ],
/**
- * Read-only. The text for this node. To change it use {@link #setText}
.
- * @type String
- */
- this.text = attributes.text;
- /**
- * True if this node is disabled.
- * @type Boolean
+ * @cfg {String} fieldCls The default CSS class for the field (defaults to "x-form-display-field")
*/
- this.disabled = attributes.disabled === true;
+ fieldCls: Ext.baseCSSPrefix + 'form-display-field',
+
/**
- * True if this node is hidden.
- * @type Boolean
+ * @cfg {Boolean} htmlEncode false to skip HTML-encoding the text when rendering it (defaults to
+ * false). This might be useful if you want to include tags in the field's innerHTML rather than
+ * rendering them as string literals per the default logic.
*/
- this.hidden = attributes.hidden === true;
+ htmlEncode: false,
- this.addEvents(
- /**
- * @event textchange
- * Fires when the text for this node is changed
- * @param {Node} this This node
- * @param {String} text The new text
- * @param {String} oldText The old text
- */
- 'textchange',
- /**
- * @event beforeexpand
- * Fires before this node is expanded, return false to cancel.
- * @param {Node} this This node
- * @param {Boolean} deep
- * @param {Boolean} anim
- */
- 'beforeexpand',
- /**
- * @event beforecollapse
- * Fires before this node is collapsed, return false to cancel.
- * @param {Node} this This node
- * @param {Boolean} deep
- * @param {Boolean} anim
- */
- 'beforecollapse',
- /**
- * @event expand
- * Fires when this node is expanded
- * @param {Node} this This node
- */
- 'expand',
- /**
- * @event disabledchange
- * Fires when the disabled status of this node changes
- * @param {Node} this This node
- * @param {Boolean} disabled
- */
- 'disabledchange',
- /**
- * @event collapse
- * Fires when this node is collapsed
- * @param {Node} this This node
- */
- 'collapse',
- /**
- * @event beforeclick
- * Fires before click processing. Return false to cancel the default action.
- * @param {Node} this This node
- * @param {Ext.EventObject} e The event object
- */
- 'beforeclick',
- /**
- * @event click
- * Fires when this node is clicked
- * @param {Node} this This node
- * @param {Ext.EventObject} e The event object
- */
- 'click',
- /**
- * @event checkchange
- * Fires when a node with a checkbox's checked property changes
- * @param {Node} this This node
- * @param {Boolean} checked
- */
- 'checkchange',
- /**
- * @event beforedblclick
- * Fires before double click processing. Return false to cancel the default action.
- * @param {Node} this This node
- * @param {Ext.EventObject} e The event object
- */
- 'beforedblclick',
- /**
- * @event dblclick
- * Fires when this node is double clicked
- * @param {Node} this This node
- * @param {Ext.EventObject} e The event object
- */
- 'dblclick',
- /**
- * @event contextmenu
- * Fires when this node is right clicked
- * @param {Node} this This node
- * @param {Ext.EventObject} e The event object
- */
- 'contextmenu',
- /**
- * @event beforechildrenrendered
- * Fires right before the child nodes for this node are rendered
- * @param {Node} this This node
- */
- 'beforechildrenrendered'
- );
+ validateOnChange: false,
- var uiClass = this.attributes.uiProvider || this.defaultUI || Ext.tree.TreeNodeUI;
+ initEvents: Ext.emptyFn,
- /**
- * Read-only. The UI for this node
- * @type TreeNodeUI
- */
- this.ui = new uiClass(this);
-};
-Ext.extend(Ext.tree.TreeNode, Ext.data.Node, {
- preventHScroll : true,
- /**
- * Returns true if this node is expanded
- * @return {Boolean}
- */
- isExpanded : function(){
- return this.expanded;
- },
+ submitValue: false,
-/**
- * Returns the UI object for this node.
- * @return {TreeNodeUI} The object which is providing the user interface for this tree
- * node. Unless otherwise specified in the {@link #uiProvider}, this will be an instance
- * of {@link Ext.tree.TreeNodeUI}
- */
- getUI : function(){
- return this.ui;
+ isValid: function() {
+ return true;
},
- getLoader : function(){
- var owner;
- return this.loader || ((owner = this.getOwnerTree()) && owner.loader ? owner.loader : (this.loader = new Ext.tree.TreeLoader()));
+ validate: function() {
+ return true;
},
- // private override
- setFirstChild : function(node){
- var of = this.firstChild;
- Ext.tree.TreeNode.superclass.setFirstChild.call(this, node);
- if(this.childrenRendered && of && node != of){
- of.renderIndent(true, true);
- }
- if(this.rendered){
- this.renderIndent(true, true);
- }
+ getRawValue: function() {
+ return this.rawValue;
},
- // private override
- setLastChild : function(node){
- var ol = this.lastChild;
- Ext.tree.TreeNode.superclass.setLastChild.call(this, node);
- if(this.childrenRendered && ol && node != ol){
- ol.renderIndent(true, true);
- }
- if(this.rendered){
- this.renderIndent(true, true);
+ setRawValue: function(value) {
+ var me = this;
+ value = Ext.value(value, '');
+ me.rawValue = value;
+ if (me.rendered) {
+ me.inputEl.dom.innerHTML = me.htmlEncode ? Ext.util.Format.htmlEncode(value) : value;
}
+ return value;
},
- // these methods are overridden to provide lazy rendering support
- // private override
- appendChild : function(n){
- if(!n.render && !Ext.isArray(n)){
- n = this.getLoader().createNode(n);
- }
- var node = Ext.tree.TreeNode.superclass.appendChild.call(this, n);
- if(node && this.childrenRendered){
- node.render();
- }
- this.ui.updateExpandIcon();
- return node;
- },
+ // private
+ getContentTarget: function() {
+ return this.inputEl;
+ }
- // private override
- removeChild : function(node, destroy){
- this.ownerTree.getSelectionModel().unselect(node);
- Ext.tree.TreeNode.superclass.removeChild.apply(this, arguments);
- // only update the ui if we're not destroying
- if(!destroy){
- // if it's been rendered remove dom node
- if(node.ui.rendered){
- node.ui.remove();
- }
- if(this.childNodes.length < 1){
- this.collapse(false, false);
- }else{
- this.ui.updateExpandIcon();
- }
- if(!this.firstChild && !this.isHiddenRoot()){
- this.childrenRendered = false;
+ /**
+ * @cfg {String} inputType
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} disabled
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} readOnly
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} validateOnChange
+ * @hide
+ */
+ /**
+ * @cfg {Number} checkChangeEvents
+ * @hide
+ */
+ /**
+ * @cfg {Number} checkChangeBuffer
+ * @hide
+ */
+});
+
+/**
+ * @class Ext.form.field.File
+ * @extends Ext.form.field.Text
+
+A file upload field which has custom styling and allows control over the button text and other
+features of {@link Ext.form.field.Text text fields} like {@link Ext.form.field.Text#emptyText empty text}.
+It uses a hidden file input element behind the scenes to allow user selection of a file and to
+perform the actual upload during {@link Ext.form.Basic#submit form submit}.
+
+Because there is no secure cross-browser way to programmatically set the value of a file input,
+the standard Field `setValue` method is not implemented. The `{@link #getValue}` method will return
+a value that is browser-dependent; some have just the file name, some have a full path, some use
+a fake path.
+{@img Ext.form.File/Ext.form.File.png Ext.form.File component}
+#Example Usage:#
+
+ Ext.create('Ext.form.Panel', {
+ title: 'Upload a Photo',
+ width: 400,
+ bodyPadding: 10,
+ frame: true,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'filefield',
+ name: 'photo',
+ fieldLabel: 'Photo',
+ labelWidth: 50,
+ msgTarget: 'side',
+ allowBlank: false,
+ anchor: '100%',
+ buttonText: 'Select Photo...'
+ }],
+
+ buttons: [{
+ text: 'Upload',
+ handler: function() {
+ var form = this.up('form').getForm();
+ if(form.isValid()){
+ form.submit({
+ url: 'photo-upload.php',
+ waitMsg: 'Uploading your photo...',
+ success: function(fp, o) {
+ Ext.Msg.alert('Success', 'Your photo "' + o.result.file + '" has been uploaded.');
+ }
+ });
+ }
}
- }
- return node;
- },
+ }]
+ });
- // private override
- insertBefore : function(node, refNode){
- if(!node.render){
- node = this.getLoader().createNode(node);
- }
- var newNode = Ext.tree.TreeNode.superclass.insertBefore.call(this, node, refNode);
- if(newNode && refNode && this.childrenRendered){
- node.render();
- }
- this.ui.updateExpandIcon();
- return newNode;
- },
+ * @constructor
+ * Create a new File field
+ * @param {Object} config Configuration options
+ * @xtype filefield
+ * @markdown
+ * @docauthor Jason Johnston
+ */
+Ext.define("Ext.form.field.File", {
+ extend: 'Ext.form.field.Text',
+ alias: ['widget.filefield', 'widget.fileuploadfield'],
+ alternateClassName: ['Ext.form.FileUploadField', 'Ext.ux.form.FileUploadField', 'Ext.form.File'],
+ uses: ['Ext.button.Button', 'Ext.layout.component.field.File'],
/**
- * Sets the text for this node
- * @param {String} text
+ * @cfg {String} buttonText The button text to display on the upload button (defaults to
+ * 'Browse...'). Note that if you supply a value for {@link #buttonConfig}, the buttonConfig.text
+ * value will be used instead if available.
*/
- setText : function(text){
- var oldText = this.text;
- this.text = this.attributes.text = text;
- if(this.rendered){ // event without subscribing
- this.ui.onTextChange(this, text, oldText);
- }
- this.fireEvent('textchange', this, text, oldText);
- },
+ buttonText: 'Browse...',
/**
- * Triggers selection of this node
+ * @cfg {Boolean} buttonOnly True to display the file upload field as a button with no visible
+ * text field (defaults to false). If true, all inherited Text members will still be available.
*/
- select : function(){
- var t = this.getOwnerTree();
- if(t){
- t.getSelectionModel().select(this);
- }
- },
+ buttonOnly: false,
/**
- * Triggers deselection of this node
- * @param {Boolean} silent (optional) True to stop selection change events from firing.
+ * @cfg {Number} buttonMargin The number of pixels of space reserved between the button and the text field
+ * (defaults to 3). Note that this only applies if {@link #buttonOnly} = false.
*/
- unselect : function(silent){
- var t = this.getOwnerTree();
- if(t){
- t.getSelectionModel().unselect(this, silent);
- }
- },
+ buttonMargin: 3,
/**
- * Returns true if this node is selected
- * @return {Boolean}
+ * @cfg {Object} buttonConfig A standard {@link Ext.button.Button} config object.
*/
- isSelected : function(){
- var t = this.getOwnerTree();
- return t ? t.getSelectionModel().isSelected(this) : false;
- },
/**
- * Expand this node.
- * @param {Boolean} deep (optional) True to expand all children as well
- * @param {Boolean} anim (optional) false to cancel the default animation
- * @param {Function} callback (optional) A callback to be called when
- * expanding this node completes (does not wait for deep expand to complete).
- * Called with 1 parameter, this node.
- * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to this TreeNode.
+ * @event change
+ * Fires when the underlying file input field's value has changed from the user
+ * selecting a new file from the system file selection dialog.
+ * @param {Ext.ux.form.FileUploadField} this
+ * @param {String} value The file value returned by the underlying file input field
*/
- expand : function(deep, anim, callback, scope){
- if(!this.expanded){
- if(this.fireEvent('beforeexpand', this, deep, anim) === false){
- return;
- }
- if(!this.childrenRendered){
- this.renderChildren();
- }
- this.expanded = true;
- if(!this.isHiddenRoot() && (this.getOwnerTree().animate && anim !== false) || anim){
- this.ui.animExpand(function(){
- this.fireEvent('expand', this);
- this.runCallback(callback, scope || this, [this]);
- if(deep === true){
- this.expandChildNodes(true);
- }
- }.createDelegate(this));
- return;
- }else{
- this.ui.expand();
- this.fireEvent('expand', this);
- this.runCallback(callback, scope || this, [this]);
- }
- }else{
- this.runCallback(callback, scope || this, [this]);
- }
- if(deep === true){
- this.expandChildNodes(true);
- }
- },
- runCallback : function(cb, scope, args){
- if(Ext.isFunction(cb)){
- cb.apply(scope, args);
- }
- },
+ /**
+ * @property fileInputEl
+ * @type {Ext.core.Element}
+ * A reference to the invisible file input element created for this upload field. Only
+ * populated after this component is rendered.
+ */
- isHiddenRoot : function(){
- return this.isRoot && !this.getOwnerTree().rootVisible;
- },
+ /**
+ * @property button
+ * @type {Ext.button.Button}
+ * A reference to the trigger Button component created for this upload field. Only
+ * populated after this component is rendered.
+ */
/**
- * Collapse this node.
- * @param {Boolean} deep (optional) True to collapse all children as well
- * @param {Boolean} anim (optional) false to cancel the default animation
- * @param {Function} callback (optional) A callback to be called when
- * expanding this node completes (does not wait for deep expand to complete).
- * Called with 1 parameter, this node.
- * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to this TreeNode.
+ * @cfg {String} fieldBodyCls
+ * An extra CSS class to be applied to the body content element in addition to {@link #fieldBodyCls}.
+ * Defaults to 'x-form-file-wrap' for file upload field.
*/
- collapse : function(deep, anim, callback, scope){
- if(this.expanded && !this.isHiddenRoot()){
- if(this.fireEvent('beforecollapse', this, deep, anim) === false){
- return;
- }
- this.expanded = false;
- if((this.getOwnerTree().animate && anim !== false) || anim){
- this.ui.animCollapse(function(){
- this.fireEvent('collapse', this);
- this.runCallback(callback, scope || this, [this]);
- if(deep === true){
- this.collapseChildNodes(true);
- }
- }.createDelegate(this));
- return;
- }else{
- this.ui.collapse();
- this.fireEvent('collapse', this);
- this.runCallback(callback, scope || this, [this]);
- }
- }else if(!this.expanded){
- this.runCallback(callback, scope || this, [this]);
- }
- if(deep === true){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++) {
- cs[i].collapse(true, false);
- }
- }
- },
+ fieldBodyCls: Ext.baseCSSPrefix + 'form-file-wrap',
+
// private
- delayedExpand : function(delay){
- if(!this.expandProcId){
- this.expandProcId = this.expand.defer(delay, this);
- }
- },
+ readOnly: true,
+ componentLayout: 'filefield',
// private
- cancelExpand : function(){
- if(this.expandProcId){
- clearTimeout(this.expandProcId);
- }
- this.expandProcId = false;
- },
+ onRender: function() {
+ var me = this,
+ inputEl;
- /**
- * Toggles expanded/collapsed state of the node
- */
- toggle : function(){
- if(this.expanded){
- this.collapse();
- }else{
- this.expand();
+ me.callParent(arguments);
+
+ me.createButton();
+ me.createFileInput();
+
+ // we don't create the file/button til after onRender, the initial disable() is
+ // called in the onRender of the component.
+ if (me.disabled) {
+ me.disableItems();
}
- },
- /**
- * Ensures all parent nodes are expanded, and if necessary, scrolls
- * the node into view.
- * @param {Function} callback (optional) A function to call when the node has been made visible.
- * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to this TreeNode.
- */
- ensureVisible : function(callback, scope){
- var tree = this.getOwnerTree();
- tree.expandPath(this.parentNode ? this.parentNode.getPath() : this.getPath(), false, function(){
- var node = tree.getNodeById(this.id); // Somehow if we don't do this, we lose changes that happened to node in the meantime
- tree.getTreeEl().scrollChildIntoView(node.ui.anchor);
- this.runCallback(callback, scope || this, [this]);
- }.createDelegate(this));
+ inputEl = me.inputEl;
+ inputEl.dom.removeAttribute('name'); //name goes on the fileInput, not the text input
+ if (me.buttonOnly) {
+ inputEl.setDisplayed(false);
+ }
},
/**
- * Expand all child nodes
- * @param {Boolean} deep (optional) true if the child nodes should also expand their child nodes
+ * @private
+ * Creates the custom trigger Button component. The fileInput will be inserted into this.
*/
- expandChildNodes : function(deep){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++) {
- cs[i].expand(deep);
- }
+ createButton: function() {
+ var me = this;
+ me.button = Ext.widget('button', Ext.apply({
+ renderTo: me.bodyEl,
+ text: me.buttonText,
+ cls: Ext.baseCSSPrefix + 'form-file-btn',
+ preventDefault: false,
+ ownerCt: me,
+ style: me.buttonOnly ? '' : 'margin-left:' + me.buttonMargin + 'px'
+ }, me.buttonConfig));
},
/**
- * Collapse all child nodes
- * @param {Boolean} deep (optional) true if the child nodes should also collapse their child nodes
+ * @private
+ * Creates the file input element. It is inserted into the trigger button component, made
+ * invisible, and floated on top of the button's other content so that it will receive the
+ * button's clicks.
*/
- collapseChildNodes : function(deep){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++) {
- cs[i].collapse(deep);
- }
+ createFileInput : function() {
+ var me = this;
+ me.fileInputEl = me.button.el.createChild({
+ name: me.getName(),
+ cls: Ext.baseCSSPrefix + 'form-file-input',
+ tag: 'input',
+ type: 'file',
+ size: 1
+ }).on('change', me.onFileChange, me);
},
/**
- * Disables this node
+ * @private Event handler fired when the user selects a file.
*/
- disable : function(){
- this.disabled = true;
- this.unselect();
- if(this.rendered && this.ui.onDisableChange){ // event without subscribing
- this.ui.onDisableChange(this, true);
- }
- this.fireEvent('disabledchange', this, true);
+ onFileChange: function() {
+ this.lastValue = null; // force change event to get fired even if the user selects a file with the same name
+ Ext.form.field.File.superclass.setValue.call(this, this.fileInputEl.dom.value);
},
/**
- * Enables this node
+ * Overridden to do nothing
+ * @hide
*/
- enable : function(){
- this.disabled = false;
- if(this.rendered && this.ui.onDisableChange){ // event without subscribing
- this.ui.onDisableChange(this, false);
- }
- this.fireEvent('disabledchange', this, false);
- },
+ setValue: Ext.emptyFn,
- // private
- renderChildren : function(suppressEvent){
- if(suppressEvent !== false){
- this.fireEvent('beforechildrenrendered', this);
- }
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++){
- cs[i].render(true);
- }
- this.childrenRendered = true;
+ reset : function(){
+ this.fileInputEl.remove();
+ this.createFileInput();
+ this.callParent();
},
- // private
- sort : function(fn, scope){
- Ext.tree.TreeNode.superclass.sort.apply(this, arguments);
- if(this.childrenRendered){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++){
- cs[i].render(true);
- }
- }
+ onDisable: function(){
+ this.callParent();
+ this.disableItems();
},
-
- // private
- render : function(bulkRender){
- this.ui.render(bulkRender);
- if(!this.rendered){
- // make sure it is registered
- this.getOwnerTree().registerNode(this);
- this.rendered = true;
- if(this.expanded){
- this.expanded = false;
- this.expand(false, false);
- }
- }
+
+ disableItems: function(){
+ var file = this.fileInputEl,
+ button = this.button;
+
+ if (file) {
+ file.dom.disabled = true;
+ }
+ if (button) {
+ button.disable();
+ }
},
- // private
- renderIndent : function(deep, refresh){
- if(refresh){
- this.ui.childIndent = null;
- }
- this.ui.renderIndent();
- if(deep === true && this.childrenRendered){
- var cs = this.childNodes;
- for(var i = 0, len = cs.length; i < len; i++){
- cs[i].renderIndent(true, refresh);
- }
- }
+ onEnable: function(){
+ var me = this;
+ me.callParent();
+ me.fileInputEl.dom.disabled = false;
+ me.button.enable();
},
- beginUpdate : function(){
- this.childrenRendered = false;
+ isFileUpload: function() {
+ return true;
},
- endUpdate : function(){
- if(this.expanded && this.rendered){
- this.renderChildren();
- }
+ extractFileInput: function() {
+ var fileInput = this.fileInputEl.dom;
+ this.reset();
+ return fileInput;
},
- //inherit docs
- destroy : function(silent){
- if(silent === true){
- this.unselect(true);
+ onDestroy: function(){
+ Ext.destroyMembers(this, 'fileInputEl', 'button');
+ this.callParent();
+ }
+
+
+});
+
+/**
+ * @class Ext.form.field.Hidden
+ * @extends Ext.form.field.Base
+ * A basic hidden field for storing hidden values in forms that need to be passed in the form submit.
+ * This creates an actual input element with type="submit" in the DOM. While its label is
+ * {@link #hideLabel not rendered} by default, it is still a real component and may be sized according to
+ * its owner container's layout.
+ * Because of this, in most cases it is more convenient and less problematic to simply
+ * {@link Ext.form.action.Action#params pass hidden parameters} directly when
+ * {@link Ext.form.Basic#submit submitting the form}.
+ * Example:
+ * new Ext.form.Panel({
+ title: 'My Form',
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Text Field',
+ name: 'text_field',
+ value: 'value from text field'
+ }, {
+ xtype: 'hiddenfield',
+ name: 'hidden_field_1',
+ value: 'value from hidden field'
+ }],
+
+ buttons: [{
+ text: 'Submit',
+ handler: function() {
+ this.up('form').getForm().submit({
+ params: {
+ hidden_field_2: 'value from submit call'
+ }
+ });
}
- Ext.tree.TreeNode.superclass.destroy.call(this, silent);
- Ext.destroy(this.ui, this.loader);
- this.ui = this.loader = null;
- },
+ }]
+});
+ * Submitting the above form will result in three values sent to the server:
+ * text_field=value+from+text+field&hidden_field_1=value+from+hidden+field&
hidden_field_2=value+from+submit+call
+ *
+ * @constructor
+ * Create a new Hidden field.
+ * @param {Object} config Configuration options
+ *
+ * @xtype hiddenfield
+ */
+Ext.define('Ext.form.field.Hidden', {
+ extend:'Ext.form.field.Base',
+ alias: ['widget.hiddenfield', 'widget.hidden'],
+ alternateClassName: 'Ext.form.Hidden',
// private
- onIdChange : function(id){
- this.ui.onIdChange(id);
- }
+ inputType : 'hidden',
+ hideLabel: true,
+
+ initComponent: function(){
+ this.formItemCls += '-hidden';
+ this.callParent();
+ },
+
+ // These are all private overrides
+ initEvents: Ext.emptyFn,
+ setSize : Ext.emptyFn,
+ setWidth : Ext.emptyFn,
+ setHeight : Ext.emptyFn,
+ setPosition : Ext.emptyFn,
+ setPagePosition : Ext.emptyFn,
+ markInvalid : Ext.emptyFn,
+ clearInvalid : Ext.emptyFn
+});
+
+/**
+ * @class Ext.picker.Color
+ * @extends Ext.Component
+ * ColorPicker provides a simple color palette for choosing colors. The picker can be rendered to any container.
+ * The available default to a standard 40-color palette; this can be customized with the {@link #colors} config.
+ * Typically you will need to implement a handler function to be notified when the user chooses a color from the
+ * picker; you can register the handler using the {@link #select} event, or by implementing the {@link #handler}
+ * method.
+ * Here's an example of typical usage:
+ * var cp = new Ext.picker.Color({
+ value: '993300', // initial selected color
+ renderTo: 'my-div'
});
-Ext.tree.TreePanel.nodeTypes.node = Ext.tree.TreeNode;/**
- * @class Ext.tree.AsyncTreeNode
- * @extends Ext.tree.TreeNode
- * @cfg {TreeLoader} loader A TreeLoader to be used by this node (defaults to the loader defined on the tree)
+cp.on('select', function(picker, selColor){
+ // do something with selColor
+});
+
+ * {@img Ext.picker.Color/Ext.picker.Color.png Ext.picker.Color component}
+ *
* @constructor
- * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node
+ * Create a new ColorPicker
+ * @param {Object} config The config object
+ *
+ * @xtype colorpicker
*/
- Ext.tree.AsyncTreeNode = function(config){
- this.loaded = config && config.loaded === true;
- this.loading = false;
- Ext.tree.AsyncTreeNode.superclass.constructor.apply(this, arguments);
- /**
- * @event beforeload
- * Fires before this node is loaded, return false to cancel
- * @param {Node} this This node
- */
- this.addEvents('beforeload', 'load');
- /**
- * @event load
- * Fires when this node is loaded
- * @param {Node} this This node
- */
+Ext.define('Ext.picker.Color', {
+ extend: 'Ext.Component',
+ requires: 'Ext.XTemplate',
+ alias: 'widget.colorpicker',
+ alternateClassName: 'Ext.ColorPalette',
+
/**
- * The loader used by this node (defaults to using the tree's defined loader)
- * @type TreeLoader
- * @property loader
+ * @cfg {String} componentCls
+ * The CSS class to apply to the containing element (defaults to 'x-color-picker')
*/
-};
-Ext.extend(Ext.tree.AsyncTreeNode, Ext.tree.TreeNode, {
- expand : function(deep, anim, callback, scope){
- if(this.loading){ // if an async load is already running, waiting til it's done
- var timer;
- var f = function(){
- if(!this.loading){ // done loading
- clearInterval(timer);
- this.expand(deep, anim, callback, scope);
- }
- }.createDelegate(this);
- timer = setInterval(f, 200);
- return;
- }
- if(!this.loaded){
- if(this.fireEvent("beforeload", this) === false){
- return;
- }
- this.loading = true;
- this.ui.beforeLoad(this);
- var loader = this.loader || this.attributes.loader || this.getOwnerTree().getLoader();
- if(loader){
- loader.load(this, this.loadComplete.createDelegate(this, [deep, anim, callback, scope]), this);
- return;
- }
- }
- Ext.tree.AsyncTreeNode.superclass.expand.call(this, deep, anim, callback, scope);
- },
+ componentCls : Ext.baseCSSPrefix + 'color-picker',
/**
- * Returns true if this node is currently loading
- * @return {Boolean}
+ * @cfg {String} selectedCls
+ * The CSS class to apply to the selected element
*/
- isLoading : function(){
- return this.loading;
- },
-
- loadComplete : function(deep, anim, callback, scope){
- this.loading = false;
- this.loaded = true;
- this.ui.afterLoad(this);
- this.fireEvent("load", this);
- this.expand(deep, anim, callback, scope);
- },
+ selectedCls: Ext.baseCSSPrefix + 'color-picker-selected',
/**
- * Returns true if this node has been loaded
- * @return {Boolean}
+ * @cfg {String} value
+ * The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that
+ * the hex codes are case-sensitive.
*/
- isLoaded : function(){
- return this.loaded;
- },
+ value : null,
- hasChildNodes : function(){
- if(!this.isLeaf() && !this.loaded){
- return true;
- }else{
- return Ext.tree.AsyncTreeNode.superclass.hasChildNodes.call(this);
- }
- },
+ /**
+ * @cfg {String} clickEvent
+ * The DOM event that will cause a color to be selected. This can be any valid event name (dblclick, contextmenu).
+ * Defaults to 'click'.
+ */
+ clickEvent :'click',
/**
- * Trigger a reload for this node
- * @param {Function} callback
- * @param {Object} scope (optional) The scope (this
reference) in which the callback is executed. Defaults to this Node.
+ * @cfg {Boolean} allowReselect If set to true then reselecting a color that is already selected fires the {@link #select} event
*/
- reload : function(callback, scope){
- this.collapse(false, false);
- while(this.firstChild){
- this.removeChild(this.firstChild).destroy();
- }
- this.childrenRendered = false;
- this.loaded = false;
- if(this.isHiddenRoot()){
- this.expanded = false;
- }
- this.expand(false, false, callback, scope);
- }
-});
+ allowReselect : false,
-Ext.tree.TreePanel.nodeTypes.async = Ext.tree.AsyncTreeNode;/**
- * @class Ext.tree.TreeNodeUI
- * This class provides the default UI implementation for Ext TreeNodes.
- * The TreeNode UI implementation is separate from the
- * tree implementation, and allows customizing of the appearance of
- * tree nodes.
- *
- * If you are customizing the Tree's user interface, you
- * may need to extend this class, but you should never need to instantiate this class.
- *
- * This class provides access to the user interface components of an Ext TreeNode, through
- * {@link Ext.tree.TreeNode#getUI}
- */
-Ext.tree.TreeNodeUI = function(node){
- this.node = node;
- this.rendered = false;
- this.animating = false;
- this.wasLeaf = true;
- this.ecc = 'x-tree-ec-icon x-tree-elbow';
- this.emptyIcon = Ext.BLANK_IMAGE_URL;
-};
+ /**
+ *
An array of 6-digit color hex code strings (without the # symbol). This array can contain any number
+ * of colors, and each hex code should be unique. The width of the picker is controlled via CSS by adjusting
+ * the width property of the 'x-color-picker' class (or assigning a custom class), so you can balance the number
+ * of colors with the width setting until the box is symmetrical.
+ * You can override individual colors if needed:
+ *
+var cp = new Ext.picker.Color();
+cp.colors[0] = 'FF0000'; // change the first box to red
+
+
+Or you can provide a custom array of your own for complete control:
+
+var cp = new Ext.picker.Color();
+cp.colors = ['000000', '993300', '333300'];
+
+ * @type Array
+ */
+ colors : [
+ '000000', '993300', '333300', '003300', '003366', '000080', '333399', '333333',
+ '800000', 'FF6600', '808000', '008000', '008080', '0000FF', '666699', '808080',
+ 'FF0000', 'FF9900', '99CC00', '339966', '33CCCC', '3366FF', '800080', '969696',
+ 'FF00FF', 'FFCC00', 'FFFF00', '00FF00', '00FFFF', '00CCFF', '993366', 'C0C0C0',
+ 'FF99CC', 'FFCC99', 'FFFF99', 'CCFFCC', 'CCFFFF', '99CCFF', 'CC99FF', 'FFFFFF'
+ ],
-Ext.tree.TreeNodeUI.prototype = {
+ /**
+ * @cfg {Function} handler
+ * Optional. A function that will handle the select event of this picker.
+ * The handler is passed the following parameters:
+ * picker
: ColorPickerThe {@link #picker Ext.picker.Color}.
+ * color
: StringThe 6-digit color hex code (without the # symbol).
+ *
+ */
+ /**
+ * @cfg {Object} scope
+ * The scope (this reference) in which the {@link #handler}
+ * function will be called. Defaults to this ColorPicker instance.
+ */
+
+ colorRe: /(?:^|\s)color-(.{6})(?:\s|$)/,
+
+ constructor: function() {
+ this.renderTpl = Ext.create('Ext.XTemplate', ' ');
+ this.callParent(arguments);
+ },
+
// private
- removeChild : function(node){
- if(this.rendered){
- this.ctNode.removeChild(node.ui.getEl());
+ initComponent : function(){
+ var me = this;
+
+ this.callParent(arguments);
+ me.addEvents(
+ /**
+ * @event select
+ * Fires when a color is selected
+ * @param {Ext.picker.Color} this
+ * @param {String} color The 6-digit color hex code (without the # symbol)
+ */
+ 'select'
+ );
+
+ if (me.handler) {
+ me.on('select', me.handler, me.scope, true);
}
},
- // private
- beforeLoad : function(){
- this.addClass("x-tree-node-loading");
- },
// private
- afterLoad : function(){
- this.removeClass("x-tree-node-loading");
- },
+ onRender : function(container, position){
+ var me = this,
+ clickEvent = me.clickEvent;
+
+ Ext.apply(me.renderData, {
+ itemCls: me.itemCls,
+ colors: me.colors
+ });
+ this.callParent(arguments);
- // private
- onTextChange : function(node, text, oldText){
- if(this.rendered){
- this.textNode.innerHTML = text;
+ me.mon(me.el, clickEvent, me.handleClick, me, {delegate: 'a'});
+ // always stop following the anchors
+ if(clickEvent != 'click'){
+ me.mon(me.el, 'click', Ext.emptyFn, me, {delegate: 'a', stopEvent: true});
}
},
// private
- onDisableChange : function(node, state){
- this.disabled = state;
- if (this.checkbox) {
- this.checkbox.disabled = state;
- }
- if(state){
- this.addClass("x-tree-node-disabled");
- }else{
- this.removeClass("x-tree-node-disabled");
+ afterRender : function(){
+ var me = this,
+ value;
+
+ this.callParent(arguments);
+ if (me.value) {
+ value = me.value;
+ me.value = null;
+ me.select(value, true);
}
},
// private
- onSelectedChange : function(state){
- if(state){
- this.focus();
- this.addClass("x-tree-selected");
- }else{
- //this.blur();
- this.removeClass("x-tree-selected");
+ handleClick : function(event, target){
+ var me = this,
+ color;
+
+ event.stopEvent();
+ if (!me.disabled) {
+ color = target.className.match(me.colorRe)[1];
+ me.select(color.toUpperCase());
}
},
- // private
- onMove : function(tree, node, oldParent, newParent, index, refNode){
- this.childIndent = null;
- if(this.rendered){
- var targetNode = newParent.ui.getContainer();
- if(!targetNode){//target not rendered
- this.holder = document.createElement("div");
- this.holder.appendChild(this.wrap);
- return;
- }
- var insertBefore = refNode ? refNode.ui.getEl() : null;
- if(insertBefore){
- targetNode.insertBefore(this.wrap, insertBefore);
- }else{
- targetNode.appendChild(this.wrap);
- }
- this.node.renderIndent(true, oldParent != newParent);
+ /**
+ * Selects the specified color in the picker (fires the {@link #select} event)
+ * @param {String} color A valid 6-digit color hex code (# will be stripped if included)
+ * @param {Boolean} suppressEvent (optional) True to stop the select event from firing. Defaults to false.
+ */
+ select : function(color, suppressEvent){
+
+ var me = this,
+ selectedCls = me.selectedCls,
+ value = me.value,
+ el;
+
+ color = color.replace('#', '');
+ if (!me.rendered) {
+ me.value = color;
+ return;
}
- },
+
+
+ if (color != value || me.allowReselect) {
+ el = me.el;
-/**
- * Adds one or more CSS classes to the node's UI element.
- * Duplicate classes are automatically filtered out.
- * @param {String/Array} className The CSS class to add, or an array of classes
- */
- addClass : function(cls){
- if(this.elNode){
- Ext.fly(this.elNode).addClass(cls);
+ if (me.value) {
+ el.down('a.color-' + value).removeCls(selectedCls);
+ }
+ el.down('a.color-' + color).addCls(selectedCls);
+ me.value = color;
+ if (suppressEvent !== true) {
+ me.fireEvent('select', me, color);
+ }
}
},
+
+ /**
+ * Get the currently selected color value.
+ * @return {String} value The selected value. Null if nothing is selected.
+ */
+ getValue: function(){
+ return this.value || null;
+ }
+});
/**
- * Removes one or more CSS classes from the node's UI element.
- * @param {String/Array} className The CSS class to remove, or an array of classes
+ * @private
+ * @class Ext.layout.component.field.HtmlEditor
+ * @extends Ext.layout.component.field.Field
+ * Layout class for {@link Ext.form.field.HtmlEditor} fields. Sizes the toolbar, textarea, and iframe elements.
+ * @private
*/
- removeClass : function(cls){
- if(this.elNode){
- Ext.fly(this.elNode).removeClass(cls);
- }
- },
-
- // private
- remove : function(){
- if(this.rendered){
- this.holder = document.createElement("div");
- this.holder.appendChild(this.wrap);
- }
- },
- // private
- fireEvent : function(){
- return this.node.fireEvent.apply(this.node, arguments);
- },
+Ext.define('Ext.layout.component.field.HtmlEditor', {
+ extend: 'Ext.layout.component.field.Field',
+ alias: ['layout.htmleditor'],
- // private
- initEvents : function(){
- this.node.on("move", this.onMove, this);
+ type: 'htmleditor',
- if(this.node.disabled){
- this.onDisableChange(this.node, true);
- }
- if(this.node.hidden){
- this.hide();
- }
- var ot = this.node.getOwnerTree();
- var dd = ot.enableDD || ot.enableDrag || ot.enableDrop;
- if(dd && (!this.node.isRoot || ot.rootVisible)){
- Ext.dd.Registry.register(this.elNode, {
- node: this.node,
- handles: this.getDDHandles(),
- isHandle: false
- });
+ sizeBodyContents: function(width, height) {
+ var me = this,
+ owner = me.owner,
+ bodyEl = owner.bodyEl,
+ toolbar = owner.getToolbar(),
+ textarea = owner.textareaEl,
+ iframe = owner.iframeEl,
+ editorHeight;
+
+ if (Ext.isNumber(width)) {
+ width -= bodyEl.getFrameWidth('lr');
+ }
+ toolbar.setWidth(width);
+ textarea.setWidth(width);
+ iframe.setWidth(width);
+
+ // If fixed height, subtract toolbar height from the input area height
+ if (Ext.isNumber(height)) {
+ editorHeight = height - toolbar.getHeight() - bodyEl.getFrameWidth('tb');
+ textarea.setHeight(editorHeight);
+ iframe.setHeight(editorHeight);
}
- },
-
- // private
- getDDHandles : function(){
- return [this.iconNode, this.textNode, this.elNode];
- },
-
+ }
+});
/**
- * Hides this node.
+ * @class Ext.form.field.HtmlEditor
+ * @extends Ext.Component
+ *
+ * Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be
+ * automatically hidden when needed. These are noted in the config options where appropriate.
+ *
+ * The editor's toolbar buttons have tooltips defined in the {@link #buttonTips} property, but they are not
+ * enabled by default unless the global {@link Ext.tip.QuickTipManager} singleton is {@link Ext.tip.QuickTipManager#init initialized}.
+ *
+ * An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within
+ * any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.
+ *
+ * {@img Ext.form.HtmlEditor/Ext.form.HtmlEditor1.png Ext.form.HtmlEditor component}
+ *
+ * ## Example usage
+ *
+ * {@img Ext.form.HtmlEditor/Ext.form.HtmlEditor2.png Ext.form.HtmlEditor component}
+ *
+ * // Simple example rendered with default options:
+ * Ext.tip.QuickTips.init(); // enable tooltips
+ * Ext.create('Ext.form.HtmlEditor', {
+ * width: 580,
+ * height: 250,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * {@img Ext.form.HtmlEditor/Ext.form.HtmlEditor2.png Ext.form.HtmlEditor component}
+ *
+ * // Passed via xtype into a container and with custom options:
+ * Ext.tip.QuickTips.init(); // enable tooltips
+ * new Ext.panel.Panel({
+ * title: 'HTML Editor',
+ * renderTo: Ext.getBody(),
+ * width: 550,
+ * height: 250,
+ * frame: true,
+ * layout: 'fit',
+ * items: {
+ * xtype: 'htmleditor',
+ * enableColors: false,
+ * enableAlignments: false
+ * }
+ * });
+ *
+ * @constructor
+ * Create a new HtmlEditor
+ * @param {Object} config
+ * @xtype htmleditor
*/
- hide : function(){
- this.node.hidden = true;
- if(this.wrap){
- this.wrap.style.display = "none";
- }
- },
+Ext.define('Ext.form.field.HtmlEditor', {
+ extend:'Ext.Component',
+ mixins: {
+ labelable: 'Ext.form.Labelable',
+ field: 'Ext.form.field.Field'
+ },
+ alias: 'widget.htmleditor',
+ alternateClassName: 'Ext.form.HtmlEditor',
+ requires: [
+ 'Ext.tip.QuickTipManager',
+ 'Ext.picker.Color',
+ 'Ext.toolbar.Item',
+ 'Ext.toolbar.Toolbar',
+ 'Ext.util.Format',
+ 'Ext.layout.component.field.HtmlEditor'
+ ],
-/**
- * Shows this node.
- */
- show : function(){
- this.node.hidden = false;
- if(this.wrap){
- this.wrap.style.display = "";
+ fieldSubTpl: [
+ '',
+ '',
+ '',
+ {
+ compiled: true,
+ disableFormats: true
}
- },
+ ],
- // private
- onContextMenu : function(e){
- if (this.node.hasListener("contextmenu") || this.node.getOwnerTree().hasListener("contextmenu")) {
- e.preventDefault();
- this.focus();
- this.fireEvent("contextmenu", this.node, e);
- }
- },
+ /**
+ * @cfg {Boolean} enableFormat Enable the bold, italic and underline buttons (defaults to true)
+ */
+ enableFormat : true,
+ /**
+ * @cfg {Boolean} enableFontSize Enable the increase/decrease font size buttons (defaults to true)
+ */
+ enableFontSize : true,
+ /**
+ * @cfg {Boolean} enableColors Enable the fore/highlight color buttons (defaults to true)
+ */
+ enableColors : true,
+ /**
+ * @cfg {Boolean} enableAlignments Enable the left, center, right alignment buttons (defaults to true)
+ */
+ enableAlignments : true,
+ /**
+ * @cfg {Boolean} enableLists Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
+ */
+ enableLists : true,
+ /**
+ * @cfg {Boolean} enableSourceEdit Enable the switch to source edit button. Not available in Safari. (defaults to true)
+ */
+ enableSourceEdit : true,
+ /**
+ * @cfg {Boolean} enableLinks Enable the create link button. Not available in Safari. (defaults to true)
+ */
+ enableLinks : true,
+ /**
+ * @cfg {Boolean} enableFont Enable font selection. Not available in Safari. (defaults to true)
+ */
+ enableFont : true,
+ /**
+ * @cfg {String} createLinkText The default text for the create link prompt
+ */
+ createLinkText : 'Please enter the URL for the link:',
+ /**
+ * @cfg {String} defaultLinkValue The default value for the create link prompt (defaults to http:/ /)
+ */
+ defaultLinkValue : 'http:/'+'/',
+ /**
+ * @cfg {Array} fontFamilies An array of available font families
+ */
+ fontFamilies : [
+ 'Arial',
+ 'Courier New',
+ 'Tahoma',
+ 'Times New Roman',
+ 'Verdana'
+ ],
+ defaultFont: 'tahoma',
+ /**
+ * @cfg {String} defaultValue A default value to be put into the editor to resolve focus issues (defaults to (Non-breaking space) in Opera and IE6, (Zero-width space) in all other browsers).
+ */
+ defaultValue: (Ext.isOpera || Ext.isIE6) ? ' ' : '',
- // private
- onClick : function(e){
- if(this.dropping){
- e.stopEvent();
- return;
- }
- if(this.fireEvent("beforeclick", this.node, e) !== false){
- var a = e.getTarget('a');
- if(!this.disabled && this.node.attributes.href && a){
- this.fireEvent("click", this.node, e);
- return;
- }else if(a && e.ctrlKey){
- e.stopEvent();
- }
- e.preventDefault();
- if(this.disabled){
- return;
- }
+ fieldBodyCls: Ext.baseCSSPrefix + 'html-editor-wrap',
- if(this.node.attributes.singleClickExpand && !this.animating && this.node.isExpandable()){
- this.node.toggle();
- }
+ componentLayout: 'htmleditor',
- this.fireEvent("click", this.node, e);
- }else{
- e.stopEvent();
- }
- },
+ // private properties
+ initialized : false,
+ activated : false,
+ sourceEditMode : false,
+ iframePad:3,
+ hideMode:'offsets',
+ maskOnDisable: true,
+
// private
- onDblClick : function(e){
- e.preventDefault();
- if(this.disabled){
- return;
- }
- if(this.fireEvent("beforedblclick", this.node, e) !== false){
- if(this.checkbox){
- this.toggleCheck();
- }
- if(!this.animating && this.node.isExpandable()){
- this.node.toggle();
- }
- this.fireEvent("dblclick", this.node, e);
- }
- },
+ initComponent : function(){
+ var me = this;
- onOver : function(e){
- this.addClass('x-tree-node-over');
- },
+ me.addEvents(
+ /**
+ * @event initialize
+ * Fires when the editor is fully initialized (including the iframe)
+ * @param {Ext.form.field.HtmlEditor} this
+ */
+ 'initialize',
+ /**
+ * @event activate
+ * Fires when the editor is first receives the focus. Any insertion must wait
+ * until after this event.
+ * @param {Ext.form.field.HtmlEditor} this
+ */
+ 'activate',
+ /**
+ * @event beforesync
+ * Fires before the textarea is updated with content from the editor iframe. Return false
+ * to cancel the sync.
+ * @param {Ext.form.field.HtmlEditor} this
+ * @param {String} html
+ */
+ 'beforesync',
+ /**
+ * @event beforepush
+ * Fires before the iframe editor is updated with content from the textarea. Return false
+ * to cancel the push.
+ * @param {Ext.form.field.HtmlEditor} this
+ * @param {String} html
+ */
+ 'beforepush',
+ /**
+ * @event sync
+ * Fires when the textarea is updated with content from the editor iframe.
+ * @param {Ext.form.field.HtmlEditor} this
+ * @param {String} html
+ */
+ 'sync',
+ /**
+ * @event push
+ * Fires when the iframe editor is updated with content from the textarea.
+ * @param {Ext.form.field.HtmlEditor} this
+ * @param {String} html
+ */
+ 'push',
+ /**
+ * @event editmodechange
+ * Fires when the editor switches edit modes
+ * @param {Ext.form.field.HtmlEditor} this
+ * @param {Boolean} sourceEdit True if source edit, false if standard editing.
+ */
+ 'editmodechange'
+ );
- onOut : function(e){
- this.removeClass('x-tree-node-over');
- },
+ me.callParent(arguments);
- // private
- onCheckChange : function(){
- var checked = this.checkbox.checked;
- // fix for IE6
- this.checkbox.defaultChecked = checked;
- this.node.attributes.checked = checked;
- this.fireEvent('checkchange', this.node, checked);
+ // Init mixins
+ me.initLabelable();
+ me.initField();
},
- // private
- ecClick : function(e){
- if(!this.animating && this.node.isExpandable()){
- this.node.toggle();
+ /*
+ * Protected method that will not generally be called directly. It
+ * is called when the editor creates its toolbar. Override this method if you need to
+ * add custom toolbar buttons.
+ * @param {Ext.form.field.HtmlEditor} editor
+ */
+ createToolbar : function(editor){
+ var me = this,
+ items = [],
+ tipsEnabled = Ext.tip.QuickTipManager && Ext.tip.QuickTipManager.isEnabled(),
+ baseCSSPrefix = Ext.baseCSSPrefix,
+ fontSelectItem, toolbar, undef;
+
+ function btn(id, toggle, handler){
+ return {
+ itemId : id,
+ cls : baseCSSPrefix + 'btn-icon',
+ iconCls: baseCSSPrefix + 'edit-'+id,
+ enableToggle:toggle !== false,
+ scope: editor,
+ handler:handler||editor.relayBtnCmd,
+ clickEvent:'mousedown',
+ tooltip: tipsEnabled ? editor.buttonTips[id] || undef : undef,
+ overflowText: editor.buttonTips[id].title || undef,
+ tabIndex:-1
+ };
}
- },
- // private
- startDrop : function(){
- this.dropping = true;
- },
- // delayed drop so the click event doesn't get fired on a drop
- endDrop : function(){
- setTimeout(function(){
- this.dropping = false;
- }.createDelegate(this), 50);
- },
+ if (me.enableFont && !Ext.isSafari2) {
+ fontSelectItem = Ext.widget('component', {
+ renderTpl: [
+ ''
+ ],
+ renderData: {
+ cls: baseCSSPrefix + 'font-select',
+ fonts: me.fontFamilies,
+ defaultFont: me.defaultFont
+ },
+ renderSelectors: {
+ selectEl: 'select'
+ },
+ onDisable: function() {
+ var selectEl = this.selectEl;
+ if (selectEl) {
+ selectEl.dom.disabled = true;
+ }
+ Ext.Component.superclass.onDisable.apply(this, arguments);
+ },
+ onEnable: function() {
+ var selectEl = this.selectEl;
+ if (selectEl) {
+ selectEl.dom.disabled = false;
+ }
+ Ext.Component.superclass.onEnable.apply(this, arguments);
+ }
+ });
- // private
- expand : function(){
- this.updateExpandIcon();
- this.ctNode.style.display = "";
- },
+ items.push(
+ fontSelectItem,
+ '-'
+ );
+ }
- // private
- focus : function(){
- if(!this.node.preventHScroll){
- try{this.anchor.focus();
- }catch(e){}
- }else{
- try{
- var noscroll = this.node.getOwnerTree().getTreeEl().dom;
- var l = noscroll.scrollLeft;
- this.anchor.focus();
- noscroll.scrollLeft = l;
- }catch(e){}
+ if (me.enableFormat) {
+ items.push(
+ btn('bold'),
+ btn('italic'),
+ btn('underline')
+ );
}
- },
-/**
- * Sets the checked status of the tree node to the passed value, or, if no value was passed,
- * toggles the checked status. If the node was rendered with no checkbox, this has no effect.
- * @param {Boolean} value (optional) The new checked status.
- */
- toggleCheck : function(value){
- var cb = this.checkbox;
- if(cb){
- cb.checked = (value === undefined ? !cb.checked : value);
- this.onCheckChange();
+ if (me.enableFontSize) {
+ items.push(
+ '-',
+ btn('increasefontsize', false, me.adjustFont),
+ btn('decreasefontsize', false, me.adjustFont)
+ );
}
- },
- // private
- blur : function(){
- try{
- this.anchor.blur();
- }catch(e){}
- },
+ if (me.enableColors) {
+ items.push(
+ '-', {
+ itemId: 'forecolor',
+ cls: baseCSSPrefix + 'btn-icon',
+ iconCls: baseCSSPrefix + 'edit-forecolor',
+ overflowText: editor.buttonTips.forecolor.title,
+ tooltip: tipsEnabled ? editor.buttonTips.forecolor || undef : undef,
+ tabIndex:-1,
+ menu : Ext.widget('menu', {
+ plain: true,
+ items: [{
+ xtype: 'colorpicker',
+ allowReselect: true,
+ focus: Ext.emptyFn,
+ value: '000000',
+ plain: true,
+ clickEvent: 'mousedown',
+ handler: function(cp, color) {
+ me.execCmd('forecolor', Ext.isWebKit || Ext.isIE ? '#'+color : color);
+ me.deferFocus();
+ this.up('menu').hide();
+ }
+ }]
+ })
+ }, {
+ itemId: 'backcolor',
+ cls: baseCSSPrefix + 'btn-icon',
+ iconCls: baseCSSPrefix + 'edit-backcolor',
+ overflowText: editor.buttonTips.backcolor.title,
+ tooltip: tipsEnabled ? editor.buttonTips.backcolor || undef : undef,
+ tabIndex:-1,
+ menu : Ext.widget('menu', {
+ plain: true,
+ items: [{
+ xtype: 'colorpicker',
+ focus: Ext.emptyFn,
+ value: 'FFFFFF',
+ plain: true,
+ allowReselect: true,
+ clickEvent: 'mousedown',
+ handler: function(cp, color) {
+ if (Ext.isGecko) {
+ me.execCmd('useCSS', false);
+ me.execCmd('hilitecolor', color);
+ me.execCmd('useCSS', true);
+ me.deferFocus();
+ } else {
+ me.execCmd(Ext.isOpera ? 'hilitecolor' : 'backcolor', Ext.isWebKit || Ext.isIE ? '#'+color : color);
+ me.deferFocus();
+ }
+ this.up('menu').hide();
+ }
+ }]
+ })
+ }
+ );
+ }
- // private
- animExpand : function(callback){
- var ct = Ext.get(this.ctNode);
- ct.stopFx();
- if(!this.node.isExpandable()){
- this.updateExpandIcon();
- this.ctNode.style.display = "";
- Ext.callback(callback);
- return;
+ if (me.enableAlignments) {
+ items.push(
+ '-',
+ btn('justifyleft'),
+ btn('justifycenter'),
+ btn('justifyright')
+ );
+ }
+
+ if (!Ext.isSafari2) {
+ if (me.enableLinks) {
+ items.push(
+ '-',
+ btn('createlink', false, me.createLink)
+ );
+ }
+
+ if (me.enableLists) {
+ items.push(
+ '-',
+ btn('insertorderedlist'),
+ btn('insertunorderedlist')
+ );
+ }
+ if (me.enableSourceEdit) {
+ items.push(
+ '-',
+ btn('sourceedit', true, function(btn){
+ me.toggleSourceEdit(!me.sourceEditMode);
+ })
+ );
+ }
}
- this.animating = true;
- this.updateExpandIcon();
- ct.slideIn('t', {
- callback : function(){
- this.animating = false;
- Ext.callback(callback);
- },
- scope: this,
- duration: this.node.ownerTree.duration || .25
+ // build the toolbar
+ toolbar = Ext.widget('toolbar', {
+ renderTo: me.toolbarWrap,
+ enableOverflow: true,
+ items: items
});
- },
- // private
- highlight : function(){
- var tree = this.node.getOwnerTree();
- Ext.fly(this.wrap).highlight(
- tree.hlColor || "C3DAF9",
- {endColor: tree.hlBaseColor}
- );
- },
+ if (fontSelectItem) {
+ me.fontSelect = fontSelectItem.selectEl;
- // private
- collapse : function(){
- this.updateExpandIcon();
- this.ctNode.style.display = "none";
- },
+ me.mon(me.fontSelect, 'change', function(){
+ me.relayCmd('fontname', me.fontSelect.dom.value);
+ me.deferFocus();
+ });
+ }
- // private
- animCollapse : function(callback){
- var ct = Ext.get(this.ctNode);
- ct.enableDisplayMode('block');
- ct.stopFx();
-
- this.animating = true;
- this.updateExpandIcon();
-
- ct.slideOut('t', {
- callback : function(){
- this.animating = false;
- Ext.callback(callback);
- },
- scope: this,
- duration: this.node.ownerTree.duration || .25
+ // stop form submits
+ me.mon(toolbar.el, 'click', function(e){
+ e.preventDefault();
});
- },
-
- // private
- getContainer : function(){
- return this.ctNode;
- },
-
-/**
- * Returns the element which encapsulates this node.
- * @return {HtmlElement} The DOM element. The default implementation uses a <li>
.
- */
- getEl : function(){
- return this.wrap;
- },
- // private
- appendDDGhost : function(ghostNode){
- ghostNode.appendChild(this.elNode.cloneNode(true));
+ me.toolbar = toolbar;
},
- // private
- getDDRepairXY : function(){
- return Ext.lib.Dom.getXY(this.iconNode);
+ onDisable: function() {
+ this.bodyEl.mask();
+ this.callParent(arguments);
},
- // private
- onRender : function(){
- this.render();
+ onEnable: function() {
+ this.bodyEl.unmask();
+ this.callParent(arguments);
},
- // private
- render : function(bulkRender){
- var n = this.node, a = n.attributes;
- var targetNode = n.parentNode ?
- n.parentNode.ui.getContainer() : n.ownerTree.innerCt.dom;
+ /**
+ * Sets the read only state of this field.
+ * @param {Boolean} readOnly Whether the field should be read only.
+ */
+ setReadOnly: function(readOnly) {
+ var me = this,
+ textareaEl = me.textareaEl,
+ iframeEl = me.iframeEl,
+ body;
- if(!this.rendered){
- this.rendered = true;
+ me.readOnly = readOnly;
- this.renderElements(n, a, targetNode, bulkRender);
+ if (textareaEl) {
+ textareaEl.dom.readOnly = readOnly;
+ }
- if(a.qtip){
- if(this.textNode.setAttributeNS){
- this.textNode.setAttributeNS("ext", "qtip", a.qtip);
- if(a.qtipTitle){
- this.textNode.setAttributeNS("ext", "qtitle", a.qtipTitle);
- }
- }else{
- this.textNode.setAttribute("ext:qtip", a.qtip);
- if(a.qtipTitle){
- this.textNode.setAttribute("ext:qtitle", a.qtipTitle);
- }
- }
- }else if(a.qtipCfg){
- a.qtipCfg.target = Ext.id(this.textNode);
- Ext.QuickTips.register(a.qtipCfg);
- }
- this.initEvents();
- if(!this.node.expanded){
- this.updateExpandIcon(true);
+ if (me.initialized) {
+ body = me.getEditorBody();
+ if (Ext.isIE) {
+ // Hide the iframe while setting contentEditable so it doesn't grab focus
+ iframeEl.setDisplayed(false);
+ body.contentEditable = !readOnly;
+ iframeEl.setDisplayed(true);
+ } else {
+ me.setDesignMode(!readOnly);
}
- }else{
- if(bulkRender === true) {
- targetNode.appendChild(this.wrap);
+ if (body) {
+ body.style.cursor = readOnly ? 'default' : 'text';
}
+ me.disableItems(readOnly);
}
},
- // private
- renderElements : function(n, a, targetNode, bulkRender){
- // add some indent caching, this helps performance when rendering a large tree
- this.indentMarkup = n.parentNode ? n.parentNode.ui.getChildIndent() : '';
-
- var cb = Ext.isBoolean(a.checked),
- nel,
- href = a.href ? a.href : Ext.isGecko ? "" : "#",
- buf = ['- ',
- '',this.indentMarkup,"",
- '',
- '',
- cb ? ('' : '/>')) : '',
- '',n.text,"",
- ' ',
- "
"].join('');
-
- if(bulkRender !== true && n.nextSibling && (nel = n.nextSibling.ui.getEl())){
- this.wrap = Ext.DomHelper.insertHtml("beforeBegin", nel, buf);
- }else{
- this.wrap = Ext.DomHelper.insertHtml("beforeEnd", targetNode, buf);
- }
-
- this.elNode = this.wrap.childNodes[0];
- this.ctNode = this.wrap.childNodes[1];
- var cs = this.elNode.childNodes;
- this.indentNode = cs[0];
- this.ecNode = cs[1];
- this.iconNode = cs[2];
- var index = 3;
- if(cb){
- this.checkbox = cs[3];
- // fix for IE6
- this.checkbox.defaultChecked = this.checkbox.checked;
- index++;
- }
- this.anchor = cs[index];
- this.textNode = cs[index].firstChild;
- },
-
-/**
- * Returns the <a> element that provides focus for the node's UI.
- * @return {HtmlElement} The DOM anchor element.
- */
- getAnchor : function(){
- return this.anchor;
- },
-
-/**
- * Returns the text node.
- * @return {HtmlNode} The DOM text node.
- */
- getTextEl : function(){
- return this.textNode;
- },
-
-/**
- * Returns the icon <img> element.
- * @return {HtmlElement} The DOM image element.
- */
- getIconEl : function(){
- return this.iconNode;
- },
-
-/**
- * Returns the checked status of the node. If the node was rendered with no
- * checkbox, it returns false.
- * @return {Boolean} The checked flag.
- */
- isChecked : function(){
- return this.checkbox ? this.checkbox.checked : false;
+ /**
+ * Protected method that will not generally be called directly. It
+ * is called when the editor initializes the iframe with HTML contents. Override this method if you
+ * want to change the initialization markup of the iframe (e.g. to add stylesheets).
+ *
+ * Note: IE8-Standards has unwanted scroller behavior, so the default meta tag forces IE7 compatibility.
+ * Also note that forcing IE7 mode works when the page is loaded normally, but if you are using IE's Web
+ * Developer Tools to manually set the document mode, that will take precedence and override what this
+ * code sets by default. This can be confusing when developing, but is not a user-facing issue.
+ */
+ getDocMarkup: function() {
+ var me = this,
+ h = me.iframeEl.getHeight() - me.iframePad * 2;
+ return Ext.String.format('', me.iframePad, h);
},
// private
- updateExpandIcon : function(){
- if(this.rendered){
- var n = this.node,
- c1,
- c2,
- cls = n.isLast() ? "x-tree-elbow-end" : "x-tree-elbow",
- hasChild = n.hasChildNodes();
- if(hasChild || n.attributes.expandable){
- if(n.expanded){
- cls += "-minus";
- c1 = "x-tree-node-collapsed";
- c2 = "x-tree-node-expanded";
- }else{
- cls += "-plus";
- c1 = "x-tree-node-expanded";
- c2 = "x-tree-node-collapsed";
- }
- if(this.wasLeaf){
- this.removeClass("x-tree-node-leaf");
- this.wasLeaf = false;
- }
- if(this.c1 != c1 || this.c2 != c2){
- Ext.fly(this.elNode).replaceClass(c1, c2);
- this.c1 = c1; this.c2 = c2;
- }
- }else{
- if(!this.wasLeaf){
- Ext.fly(this.elNode).replaceClass("x-tree-node-expanded", "x-tree-node-collapsed");
- delete this.c1;
- delete this.c2;
- this.wasLeaf = true;
- }
- }
- var ecc = "x-tree-ec-icon "+cls;
- if(this.ecc != ecc){
- this.ecNode.className = ecc;
- this.ecc = ecc;
- }
- }
+ getEditorBody: function() {
+ var doc = this.getDoc();
+ return doc.body || doc.documentElement;
},
// private
- onIdChange: function(id){
- if(this.rendered){
- this.elNode.setAttribute('ext:tree-node-id', id);
- }
+ getDoc: function() {
+ return (!Ext.isIE && this.iframeEl.dom.contentDocument) || this.getWin().document;
},
// private
- getChildIndent : function(){
- if(!this.childIndent){
- var buf = [],
- p = this.node;
- while(p){
- if(!p.isRoot || (p.isRoot && p.ownerTree.rootVisible)){
- if(!p.isLast()) {
- buf.unshift('');
- } else {
- buf.unshift('');
- }
- }
- p = p.parentNode;
- }
- this.childIndent = buf.join("");
- }
- return this.childIndent;
+ getWin: function() {
+ return Ext.isIE ? this.iframeEl.dom.contentWindow : window.frames[this.iframeEl.dom.name];
},
// private
- renderIndent : function(){
- if(this.rendered){
- var indent = "",
- p = this.node.parentNode;
- if(p){
- indent = p.ui.getChildIndent();
- }
- if(this.indentMarkup != indent){ // don't rerender if not required
- this.indentNode.innerHTML = indent;
- this.indentMarkup = indent;
- }
- this.updateExpandIcon();
- }
- },
-
- destroy : function(){
- if(this.elNode){
- Ext.dd.Registry.unregister(this.elNode.id);
- }
+ onRender: function() {
+ var me = this,
+ renderSelectors = me.renderSelectors;
- Ext.each(['textnode', 'anchor', 'checkbox', 'indentNode', 'ecNode', 'iconNode', 'elNode', 'ctNode', 'wrap', 'holder'], function(el){
- if(this[el]){
- Ext.fly(this[el]).remove();
- delete this[el];
- }
- }, this);
- delete this.node;
- }
-};
+ Ext.applyIf(renderSelectors, me.getLabelableSelectors());
-/**
- * @class Ext.tree.RootTreeNodeUI
- * This class provides the default UI implementation for root Ext TreeNodes.
- * The RootTreeNode UI implementation allows customizing the appearance of the root tree node.
- *
- * If you are customizing the Tree's user interface, you
- * may need to extend this class, but you should never need to instantiate this class.
- */
-Ext.tree.RootTreeNodeUI = Ext.extend(Ext.tree.TreeNodeUI, {
- // private
- render : function(){
- if(!this.rendered){
- var targetNode = this.node.ownerTree.innerCt.dom;
- this.node.expanded = true;
- targetNode.innerHTML = '
';
- this.wrap = this.ctNode = targetNode.firstChild;
- }
- },
- collapse : Ext.emptyFn,
- expand : Ext.emptyFn
-});/**
- * @class Ext.tree.TreeLoader
- * @extends Ext.util.Observable
- * A TreeLoader provides for lazy loading of an {@link Ext.tree.TreeNode}'s child
- * nodes from a specified URL. The response must be a JavaScript Array definition
- * whose elements are node definition objects. e.g.:
- *
- [{
- id: 1,
- text: 'A leaf Node',
- leaf: true
- },{
- id: 2,
- text: 'A folder Node',
- children: [{
- id: 3,
- text: 'A child Node',
- leaf: true
- }]
- }]
-
- *
- * A server request is sent, and child nodes are loaded only when a node is expanded.
- * The loading node's id is passed to the server under the parameter name "node" to
- * enable the server to produce the correct child nodes.
- *
- * To pass extra parameters, an event handler may be attached to the "beforeload"
- * event, and the parameters specified in the TreeLoader's baseParams property:
- *
- myTreeLoader.on("beforeload", function(treeLoader, node) {
- this.baseParams.category = node.attributes.category;
- }, this);
-
- * This would pass an HTTP parameter called "category" to the server containing
- * the value of the Node's "category" attribute.
- * @constructor
- * Creates a new Treeloader.
- * @param {Object} config A config object containing config properties.
- */
-Ext.tree.TreeLoader = function(config){
- this.baseParams = {};
- Ext.apply(this, config);
+ Ext.applyIf(renderSelectors, {
+ toolbarWrap: 'div.' + Ext.baseCSSPrefix + 'html-editor-tb',
+ iframeEl: 'iframe',
+ textareaEl: 'textarea'
+ });
- this.addEvents(
- /**
- * @event beforeload
- * Fires before a network request is made to retrieve the Json text which specifies a node's children.
- * @param {Object} This TreeLoader object.
- * @param {Object} node The {@link Ext.tree.TreeNode} object being loaded.
- * @param {Object} callback The callback function specified in the {@link #load} call.
- */
- "beforeload",
- /**
- * @event load
- * Fires when the node has been successfuly loaded.
- * @param {Object} This TreeLoader object.
- * @param {Object} node The {@link Ext.tree.TreeNode} object being loaded.
- * @param {Object} response The response object containing the data from the server.
- */
- "load",
- /**
- * @event loadexception
- * Fires if the network request failed.
- * @param {Object} This TreeLoader object.
- * @param {Object} node The {@link Ext.tree.TreeNode} object being loaded.
- * @param {Object} response The response object containing the data from the server.
- */
- "loadexception"
- );
- Ext.tree.TreeLoader.superclass.constructor.call(this);
- if(Ext.isString(this.paramOrder)){
- this.paramOrder = this.paramOrder.split(/[\s,|]/);
- }
-};
+ me.callParent(arguments);
-Ext.extend(Ext.tree.TreeLoader, Ext.util.Observable, {
- /**
- * @cfg {String} dataUrl The URL from which to request a Json string which
- * specifies an array of node definition objects representing the child nodes
- * to be loaded.
- */
- /**
- * @cfg {String} requestMethod The HTTP request method for loading data (defaults to the value of {@link Ext.Ajax#method}).
- */
- /**
- * @cfg {String} url Equivalent to {@link #dataUrl}.
- */
- /**
- * @cfg {Boolean} preloadChildren If set to true, the loader recursively loads "children" attributes when doing the first load on nodes.
- */
- /**
- * @cfg {Object} baseParams (optional) An object containing properties which
- * specify HTTP parameters to be passed to each request for child nodes.
- */
- /**
- * @cfg {Object} baseAttrs (optional) An object containing attributes to be added to all nodes
- * created by this loader. If the attributes sent by the server have an attribute in this object,
- * they take priority.
- */
- /**
- * @cfg {Object} uiProviders (optional) An object containing properties which
- * specify custom {@link Ext.tree.TreeNodeUI} implementations. If the optional
- * uiProvider attribute of a returned child node is a string rather
- * than a reference to a TreeNodeUI implementation, then that string value
- * is used as a property name in the uiProviders object.
- */
- uiProviders : {},
+ me.textareaEl.dom.value = me.value || '';
- /**
- * @cfg {Boolean} clearOnLoad (optional) Default to true. Remove previously existing
- * child nodes before loading.
- */
- clearOnLoad : true,
+ // Start polling for when the iframe document is ready to be manipulated
+ me.monitorTask = Ext.TaskManager.start({
+ run: me.checkDesignMode,
+ scope: me,
+ interval:100
+ });
- /**
- * @cfg {Array/String} paramOrder Defaults to undefined. Only used when using directFn.
- * Specifies the params in the order in which they must be passed to the server-side Direct method
- * 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:
-nodeParameter: 'node',
-paramOrder: ['param1','param2','param3']
-paramOrder: 'node param1 param2 param3'
-paramOrder: 'param1,node,param2,param3'
-paramOrder: 'param1|param2|param|node'
-
- */
- paramOrder: undefined,
+ me.createToolbar(me);
+ me.disableItems(true);
+ },
- /**
- * @cfg {Boolean} paramsAsHash Only used when using directFn.
- * Send parameters as a collection of named arguments (defaults to false). Providing a
- * {@link #paramOrder} nullifies this configuration.
- */
- paramsAsHash: false,
+ initRenderTpl: function() {
+ var me = this;
+ if (!me.hasOwnProperty('renderTpl')) {
+ me.renderTpl = me.getTpl('labelableRenderTpl');
+ }
+ return me.callParent();
+ },
- /**
- * @cfg {String} nodeParameter The name of the parameter sent to the server which contains
- * the identifier of the node. Defaults to 'node'.
- */
- nodeParameter: 'node',
+ initRenderData: function() {
+ return Ext.applyIf(this.callParent(), this.getLabelableRenderData());
+ },
- /**
- * @cfg {Function} directFn
- * Function to call when executing a request.
- */
- directFn : undefined,
+ getSubTplData: function() {
+ var cssPrefix = Ext.baseCSSPrefix;
+ return {
+ toolbarWrapCls: cssPrefix + 'html-editor-tb',
+ textareaCls: cssPrefix + 'hidden',
+ iframeName: Ext.id(),
+ iframeSrc: Ext.SSL_SECURE_URL,
+ size: 'height:100px;'
+ };
+ },
- /**
- * Load an {@link Ext.tree.TreeNode} from the URL specified in the constructor.
- * This is called automatically when a node is expanded, but may be used to reload
- * a node (or append new children if the {@link #clearOnLoad} option is false.)
- * @param {Ext.tree.TreeNode} node
- * @param {Function} callback Function to call after the node has been loaded. The
- * function is passed the TreeNode which was requested to be loaded.
- * @param {Object} scope The scope (this
reference) in which the callback is executed.
- * defaults to the loaded TreeNode.
- */
- load : function(node, callback, scope){
- if(this.clearOnLoad){
- while(node.firstChild){
- node.removeChild(node.firstChild);
- }
- }
- if(this.doPreload(node)){ // preloaded json children
- this.runCallback(callback, scope || node, [node]);
- }else if(this.directFn || this.dataUrl || this.url){
- this.requestData(node, callback, scope || node);
- }
+ getSubTplMarkup: function() {
+ return this.getTpl('fieldSubTpl').apply(this.getSubTplData());
},
- doPreload : function(node){
- if(node.attributes.children){
- if(node.childNodes.length < 1){ // preloaded?
- var cs = node.attributes.children;
- node.beginUpdate();
- for(var i = 0, len = cs.length; i < len; i++){
- var cn = node.appendChild(this.createNode(cs[i]));
- if(this.preloadChildren){
- this.doPreload(cn);
- }
- }
- node.endUpdate();
- }
- return true;
- }
- return false;
+ getBodyNaturalWidth: function() {
+ return 565;
},
- getParams: function(node){
- var bp = Ext.apply({}, this.baseParams),
- np = this.nodeParameter,
- po = this.paramOrder;
+ initFrameDoc: function() {
+ var me = this,
+ doc, task;
- np && (bp[ np ] = node.id);
+ Ext.TaskManager.stop(me.monitorTask);
- if(this.directFn){
- var buf = [node.id];
- if(po){
- // reset 'buf' if the nodeParameter was included in paramOrder
- if(np && po.indexOf(np) > -1){
- buf = [];
- }
+ doc = me.getDoc();
+ me.win = me.getWin();
- for(var i = 0, len = po.length; i < len; i++){
- buf.push(bp[ po[i] ]);
+ doc.open();
+ doc.write(me.getDocMarkup());
+ doc.close();
+
+ task = { // must defer to wait for browser to be ready
+ run: function() {
+ var doc = me.getDoc();
+ if (doc.body || doc.readyState === 'complete') {
+ Ext.TaskManager.stop(task);
+ me.setDesignMode(true);
+ Ext.defer(me.initEditor, 10, me);
}
- }else if(this.paramsAsHash){
- buf = [bp];
- }
- return buf;
- }else{
- return bp;
- }
+ },
+ interval : 10,
+ duration:10000,
+ scope: me
+ };
+ Ext.TaskManager.start(task);
},
- requestData : function(node, callback, scope){
- if(this.fireEvent("beforeload", this, node, callback) !== false){
- if(this.directFn){
- var args = this.getParams(node);
- args.push(this.processDirectResponse.createDelegate(this, [{callback: callback, node: node, scope: scope}], true));
- this.directFn.apply(window, args);
- }else{
- this.transId = Ext.Ajax.request({
- method:this.requestMethod,
- url: this.dataUrl||this.url,
- success: this.handleResponse,
- failure: this.handleFailure,
- scope: this,
- argument: {callback: callback, node: node, scope: scope},
- params: this.getParams(node)
- });
- }
- }else{
- // if the load is cancelled, make sure we notify
- // the node that we are done
- this.runCallback(callback, scope || node, []);
+ checkDesignMode: function() {
+ var me = this,
+ doc = me.getDoc();
+ if (doc && (!doc.editorInitialized || me.getDesignMode() !== 'on')) {
+ me.initFrameDoc();
}
},
- processDirectResponse: function(result, response, args){
- if(response.status){
- this.handleResponse({
- responseData: Ext.isArray(result) ? result : null,
- responseText: result,
- argument: args
- });
- }else{
- this.handleFailure({
- argument: args
- });
+ /* private
+ * set current design mode. To enable, mode can be true or 'on', off otherwise
+ */
+ setDesignMode: function(mode) {
+ var me = this,
+ doc = me.getDoc();
+ if (doc) {
+ if (me.readOnly) {
+ mode = false;
+ }
+ doc.designMode = (/on|true/i).test(String(mode).toLowerCase()) ?'on':'off';
}
},
// private
- runCallback: function(cb, scope, args){
- if(Ext.isFunction(cb)){
- cb.apply(scope, args);
- }
- },
-
- isLoading : function(){
- return !!this.transId;
+ getDesignMode: function() {
+ var doc = this.getDoc();
+ return !doc ? '' : String(doc.designMode).toLowerCase();
},
- abort : function(){
- if(this.isLoading()){
- Ext.Ajax.abort(this.transId);
- }
+ disableItems: function(disabled) {
+ this.getToolbar().items.each(function(item){
+ if(item.getItemId() !== 'sourceedit'){
+ item.setDisabled(disabled);
+ }
+ });
},
/**
- * Override this function for custom TreeNode node implementation, or to
- * modify the attributes at creation time.
- * Example:
-new Ext.tree.TreePanel({
- ...
- loader: new Ext.tree.TreeLoader({
- url: 'dataUrl',
- createNode: function(attr) {
-// Allow consolidation consignments to have
-// consignments dropped into them.
- if (attr.isConsolidation) {
- attr.iconCls = 'x-consol',
- attr.allowDrop = true;
- }
- return Ext.tree.TreeLoader.prototype.createNode.call(this, attr);
- }
- }),
- ...
-});
-
- * @param attr {Object} The attributes from which to create the new node.
- */
- createNode : function(attr){
- // apply baseAttrs, nice idea Corey!
- if(this.baseAttrs){
- Ext.applyIf(attr, this.baseAttrs);
- }
- if(this.applyLoader !== false && !attr.loader){
- attr.loader = this;
+ * Toggles the editor between standard and source edit mode.
+ * @param {Boolean} sourceEditMode (optional) True for source edit, false for standard
+ */
+ toggleSourceEdit: function(sourceEditMode) {
+ var me = this,
+ iframe = me.iframeEl,
+ textarea = me.textareaEl,
+ hiddenCls = Ext.baseCSSPrefix + 'hidden',
+ btn = me.getToolbar().getComponent('sourceedit');
+
+ if (!Ext.isBoolean(sourceEditMode)) {
+ sourceEditMode = !me.sourceEditMode;
}
- if(Ext.isString(attr.uiProvider)){
- attr.uiProvider = this.uiProviders[attr.uiProvider] || eval(attr.uiProvider);
+ me.sourceEditMode = sourceEditMode;
+
+ if (btn.pressed !== sourceEditMode) {
+ btn.toggle(sourceEditMode);
}
- if(attr.nodeType){
- return new Ext.tree.TreePanel.nodeTypes[attr.nodeType](attr);
- }else{
- return attr.leaf ?
- new Ext.tree.TreeNode(attr) :
- new Ext.tree.AsyncTreeNode(attr);
+ if (sourceEditMode) {
+ me.disableItems(true);
+ me.syncValue();
+ iframe.addCls(hiddenCls);
+ textarea.removeCls(hiddenCls);
+ textarea.dom.removeAttribute('tabIndex');
+ textarea.focus();
}
- },
-
- processResponse : function(response, node, callback, scope){
- var json = response.responseText;
- try {
- var o = response.responseData || Ext.decode(json);
- node.beginUpdate();
- for(var i = 0, len = o.length; i < len; i++){
- var n = this.createNode(o[i]);
- if(n){
- node.appendChild(n);
- }
+ else {
+ if (me.initialized) {
+ me.disableItems(me.readOnly);
}
- node.endUpdate();
- this.runCallback(callback, scope || node, [node]);
- }catch(e){
- this.handleFailure(response);
+ me.pushValue();
+ iframe.removeCls(hiddenCls);
+ textarea.addCls(hiddenCls);
+ textarea.dom.setAttribute('tabIndex', -1);
+ me.deferFocus();
}
+ me.fireEvent('editmodechange', me, sourceEditMode);
+ me.doComponentLayout();
},
- handleResponse : function(response){
- this.transId = false;
- var a = response.argument;
- this.processResponse(response, a.node, a.callback, a.scope);
- this.fireEvent("load", this, a.node, response);
- },
-
- handleFailure : function(response){
- this.transId = false;
- var a = response.argument;
- this.fireEvent("loadexception", this, a.node, response);
- this.runCallback(a.callback, a.scope || a.node, [a.node]);
+ // private used internally
+ createLink : function() {
+ var url = prompt(this.createLinkText, this.defaultLinkValue);
+ if (url && url !== 'http:/'+'/') {
+ this.relayCmd('createlink', url);
+ }
},
- destroy : function(){
- this.abort();
- this.purgeListeners();
- }
-});/**
- * @class Ext.tree.TreeFilter
- * Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes
- * @param {TreePanel} tree
- * @param {Object} config (optional)
- */
-Ext.tree.TreeFilter = function(tree, config){
- this.tree = tree;
- this.filtered = {};
- Ext.apply(this, config);
-};
-
-Ext.tree.TreeFilter.prototype = {
- clearBlank:false,
- reverse:false,
- autoClear:false,
- remove:false,
+ clearInvalid: Ext.emptyFn,
- /**
- * Filter the data by a specific attribute.
- * @param {String/RegExp} value Either string that the attribute value
- * should start with or a RegExp to test against the attribute
- * @param {String} attr (optional) The attribute passed in your node's attributes collection. Defaults to "text".
- * @param {TreeNode} startNode (optional) The node to start the filter at.
- */
- filter : function(value, attr, startNode){
- attr = attr || "text";
- var f;
- if(typeof value == "string"){
- var vlen = value.length;
- // auto clear empty filter
- if(vlen == 0 && this.clearBlank){
- this.clear();
- return;
- }
- value = value.toLowerCase();
- f = function(n){
- return n.attributes[attr].substr(0, vlen).toLowerCase() == value;
- };
- }else if(value.exec){ // regex?
- f = function(n){
- return value.test(n.attributes[attr]);
- };
- }else{
- throw 'Illegal filter type, must be string or regex';
+ // docs inherit from Field
+ setValue: function(value) {
+ var me = this,
+ textarea = me.textareaEl;
+ me.mixins.field.setValue.call(me, value);
+ if (value === null || value === undefined) {
+ value = '';
}
- this.filterBy(f, null, startNode);
- },
+ if (textarea) {
+ textarea.dom.value = value;
+ }
+ me.pushValue();
+ return this;
+ },
/**
- * Filter by a function. The passed function will be called with each
- * node in the tree (or from the startNode). If the function returns true, the node is kept
- * otherwise it is filtered. If a node is filtered, its children are also filtered.
- * @param {Function} fn The filter function
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to the current Node.
+ * Protected method that will not generally be called directly. If you need/want
+ * custom HTML cleanup, this is the method you should override.
+ * @param {String} html The HTML to be cleaned
+ * @return {String} The cleaned HTML
*/
- filterBy : function(fn, scope, startNode){
- startNode = startNode || this.tree.root;
- if(this.autoClear){
- this.clear();
+ cleanHtml: function(html) {
+ html = String(html);
+ if (Ext.isWebKit) { // strip safari nonsense
+ html = html.replace(/\sclass="(?:Apple-style-span|khtml-block-placeholder)"/gi, '');
}
- var af = this.filtered, rv = this.reverse;
- var f = function(n){
- if(n == startNode){
- return true;
- }
- if(af[n.id]){
- return false;
- }
- var m = fn.call(scope || n, n);
- if(!m || rv){
- af[n.id] = n;
- n.ui.hide();
- return false;
- }
- return true;
- };
- startNode.cascade(f);
- if(this.remove){
- for(var id in af){
- if(typeof id != "function"){
- var n = af[id];
- if(n && n.parentNode){
- n.parentNode.removeChild(n);
- }
- }
- }
+
+ /*
+ * Neat little hack. Strips out all the non-digit characters from the default
+ * value and compares it to the character code of the first character in the string
+ * because it can cause encoding issues when posted to the server.
+ */
+ if (html.charCodeAt(0) === this.defaultValue.replace(/\D/g, '')) {
+ html = html.substring(1);
}
+ return html;
},
/**
- * Clears the current filter. Note: with the "remove" option
- * set a filter cannot be cleared.
+ * @protected method that will not generally be called directly. Syncs the contents
+ * of the editor iframe with the textarea.
*/
- clear : function(){
- var t = this.tree;
- var af = this.filtered;
- for(var id in af){
- if(typeof id != "function"){
- var n = af[id];
- if(n){
- n.ui.show();
+ syncValue : function(){
+ var me = this,
+ body, html, bodyStyle, match;
+ if (me.initialized) {
+ body = me.getEditorBody();
+ html = body.innerHTML;
+ if (Ext.isWebKit) {
+ bodyStyle = body.getAttribute('style'); // Safari puts text-align styles on the body element!
+ match = bodyStyle.match(/text-align:(.*?);/i);
+ if (match && match[1]) {
+ html = '' + html + '';
}
}
- }
- this.filtered = {};
- }
-};
-/**
- * @class Ext.tree.TreeSorter
- * Provides sorting of nodes in a {@link Ext.tree.TreePanel}. The TreeSorter automatically monitors events on the
- * associated TreePanel that might affect the tree's sort order (beforechildrenrendered, append, insert and textchange).
- * Example usage:
- *
-new Ext.tree.TreeSorter(myTree, {
- folderSort: true,
- dir: "desc",
- sortType: function(node) {
- // sort by a custom, typed attribute:
- return parseInt(node.id, 10);
- }
-});
-
- * @constructor
- * @param {TreePanel} tree
- * @param {Object} config
- */
-Ext.tree.TreeSorter = function(tree, config){
- /**
- * @cfg {Boolean} folderSort True to sort leaf nodes under non-leaf nodes (defaults to false)
- */
- /**
- * @cfg {String} property The named attribute on the node to sort by (defaults to "text"). Note that this
- * property is only used if no {@link #sortType} function is specified, otherwise it is ignored.
- */
- /**
- * @cfg {String} dir The direction to sort ("asc" or "desc," case-insensitive, defaults to "asc")
- */
- /**
- * @cfg {String} leafAttr The attribute used to determine leaf nodes when {@link #folderSort} = true (defaults to "leaf")
- */
- /**
- * @cfg {Boolean} caseSensitive true for case-sensitive sort (defaults to false)
- */
- /**
- * @cfg {Function} sortType A custom "casting" function used to convert node values before sorting. The function
- * will be called with a single parameter (the {@link Ext.tree.TreeNode} being evaluated) and is expected to return
- * the node's sort value cast to the specific data type required for sorting. This could be used, for example, when
- * a node's text (or other attribute) should be sorted as a date or numeric value. See the class description for
- * example usage. Note that if a sortType is specified, any {@link #property} config will be ignored.
- */
-
- Ext.apply(this, config);
- tree.on("beforechildrenrendered", this.doSort, this);
- tree.on("append", this.updateSort, this);
- tree.on("insert", this.updateSort, this);
- tree.on("textchange", this.updateSortParent, this);
-
- var dsc = this.dir && this.dir.toLowerCase() == "desc";
- var p = this.property || "text";
- var sortType = this.sortType;
- var fs = this.folderSort;
- var cs = this.caseSensitive === true;
- var leafAttr = this.leafAttr || 'leaf';
-
- this.sortFn = function(n1, n2){
- if(fs){
- if(n1.attributes[leafAttr] && !n2.attributes[leafAttr]){
- return 1;
- }
- if(!n1.attributes[leafAttr] && n2.attributes[leafAttr]){
- return -1;
+ html = me.cleanHtml(html);
+ if (me.fireEvent('beforesync', me, html) !== false) {
+ me.textareaEl.dom.value = html;
+ me.fireEvent('sync', me, html);
}
}
- var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : n1.attributes[p].toUpperCase());
- var v2 = sortType ? sortType(n2) : (cs ? n2.attributes[p] : n2.attributes[p].toUpperCase());
- if(v1 < v2){
- return dsc ? +1 : -1;
- }else if(v1 > v2){
- return dsc ? -1 : +1;
- }else{
- return 0;
- }
- };
-};
-
-Ext.tree.TreeSorter.prototype = {
- doSort : function(node){
- node.sort(this.sortFn);
},
- compareNodes : function(n1, n2){
- return (n1.text.toUpperCase() > n2.text.toUpperCase() ? 1 : -1);
- },
-
- updateSort : function(tree, node){
- if(node.childrenRendered){
- this.doSort.defer(1, this, [node]);
+ //docs inherit from Field
+ getValue : function() {
+ var me = this,
+ value;
+ if (!me.sourceEditMode) {
+ me.syncValue();
}
+ value = me.rendered ? me.textareaEl.dom.value : me.value;
+ me.value = value;
+ return value;
},
- updateSortParent : function(node){
- var p = node.parentNode;
- if(p && p.childrenRendered){
- this.doSort.defer(1, this, [p]);
- }
- }
-};/**
- * @class Ext.tree.TreeDropZone
- * @extends Ext.dd.DropZone
- * @constructor
- * @param {String/HTMLElement/Element} tree The {@link Ext.tree.TreePanel} for which to enable dropping
- * @param {Object} config
- */
-if(Ext.dd.DropZone){
-
-Ext.tree.TreeDropZone = function(tree, config){
- /**
- * @cfg {Boolean} allowParentInsert
- * Allow inserting a dragged node between an expanded parent node and its first child that will become a
- * sibling of the parent when dropped (defaults to false)
- */
- this.allowParentInsert = config.allowParentInsert || false;
- /**
- * @cfg {String} allowContainerDrop
- * True if drops on the tree container (outside of a specific tree node) are allowed (defaults to false)
- */
- this.allowContainerDrop = config.allowContainerDrop || false;
- /**
- * @cfg {String} appendOnly
- * True if the tree should only allow append drops (use for trees which are sorted, defaults to false)
- */
- this.appendOnly = config.appendOnly || false;
-
- Ext.tree.TreeDropZone.superclass.constructor.call(this, tree.getTreeEl(), config);
- /**
- * The TreePanel for this drop zone
- * @type Ext.tree.TreePanel
- * @property
- */
- this.tree = tree;
- /**
- * Arbitrary data that can be associated with this tree and will be included in the event object that gets
- * passed to any nodedragover event handler (defaults to {})
- * @type Ext.tree.TreePanel
- * @property
- */
- this.dragOverData = {};
- // private
- this.lastInsertClass = "x-tree-no-status";
-};
-
-Ext.extend(Ext.tree.TreeDropZone, Ext.dd.DropZone, {
- /**
- * @cfg {String} ddGroup
- * A named drag drop group to which this object belongs. If a group is specified, then this object will only
- * interact with other drag drop objects in the same group (defaults to 'TreeDD').
- */
- ddGroup : "TreeDD",
-
/**
- * @cfg {String} expandDelay
- * The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node
- * over the target (defaults to 1000)
+ * @protected method that will not generally be called directly. Pushes the value of the textarea
+ * into the iframe editor.
*/
- expandDelay : 1000,
-
- // private
- expandNode : function(node){
- if(node.hasChildNodes() && !node.isExpanded()){
- node.expand(false, null, this.triggerCacheRefresh.createDelegate(this));
- }
- },
-
- // private
- queueExpand : function(node){
- this.expandProcId = this.expandNode.defer(this.expandDelay, this, [node]);
- },
-
- // private
- cancelExpand : function(){
- if(this.expandProcId){
- clearTimeout(this.expandProcId);
- this.expandProcId = false;
+ pushValue: function() {
+ var me = this,
+ v;
+ if(me.initialized){
+ v = me.textareaEl.dom.value || '';
+ if (!me.activated && v.length < 1) {
+ v = me.defaultValue;
+ }
+ if (me.fireEvent('beforepush', me, v) !== false) {
+ me.getEditorBody().innerHTML = v;
+ if (Ext.isGecko) {
+ // Gecko hack, see: https://bugzilla.mozilla.org/show_bug.cgi?id=232791#c8
+ me.setDesignMode(false); //toggle off first
+ me.setDesignMode(true);
+ }
+ me.fireEvent('push', me, v);
+ }
}
},
// private
- isValidDropPoint : function(n, pt, dd, e, data){
- if(!n || !data){ return false; }
- var targetNode = n.node;
- var dropNode = data.node;
- // default drop rules
- if(!(targetNode && targetNode.isTarget && pt)){
- return false;
- }
- if(pt == "append" && targetNode.allowChildren === false){
- return false;
- }
- if((pt == "above" || pt == "below") && (targetNode.parentNode && targetNode.parentNode.allowChildren === false)){
- return false;
- }
- if(dropNode && (targetNode == dropNode || dropNode.contains(targetNode))){
- return false;
- }
- // reuse the object
- var overEvent = this.dragOverData;
- overEvent.tree = this.tree;
- overEvent.target = targetNode;
- overEvent.data = data;
- overEvent.point = pt;
- overEvent.source = dd;
- overEvent.rawEvent = e;
- overEvent.dropNode = dropNode;
- overEvent.cancel = false;
- var result = this.tree.fireEvent("nodedragover", overEvent);
- return overEvent.cancel === false && result !== false;
+ deferFocus : function(){
+ this.focus(false, true);
},
- // private
- getDropPoint : function(e, n, dd){
- var tn = n.node;
- if(tn.isRoot){
- return tn.allowChildren !== false ? "append" : false; // always append for root
- }
- var dragEl = n.ddel;
- var t = Ext.lib.Dom.getY(dragEl), b = t + dragEl.offsetHeight;
- var y = Ext.lib.Event.getPageY(e);
- var noAppend = tn.allowChildren === false || tn.isLeaf();
- if(this.appendOnly || tn.parentNode.allowChildren === false){
- return noAppend ? false : "append";
- }
- var noBelow = false;
- if(!this.allowParentInsert){
- noBelow = tn.hasChildNodes() && tn.isExpanded();
- }
- var q = (b - t) / (noAppend ? 2 : 3);
- if(y >= t && y < (t + q)){
- return "above";
- }else if(!noBelow && (noAppend || y >= b-q && y <= b)){
- return "below";
- }else{
- return "append";
- }
+ getFocusEl: function() {
+ var me = this,
+ win = me.win;
+ return win && !me.sourceEditMode ? win : me.textareaEl;
},
// private
- onNodeEnter : function(n, dd, e, data){
- this.cancelExpand();
- },
-
- onContainerOver : function(dd, e, data) {
- if (this.allowContainerDrop && this.isValidDropPoint({ ddel: this.tree.getRootNode().ui.elNode, node: this.tree.getRootNode() }, "append", dd, e, data)) {
- return this.dropAllowed;
- }
- return this.dropNotAllowed;
- },
+ initEditor : function(){
+ //Destroying the component during/before initEditor can cause issues.
+ try {
+ var me = this,
+ dbody = me.getEditorBody(),
+ ss = me.textareaEl.getStyles('font-size', 'font-family', 'background-image', 'background-repeat', 'background-color', 'color'),
+ doc,
+ fn;
- // private
- onNodeOver : function(n, dd, e, data){
- var pt = this.getDropPoint(e, n, dd);
- var node = n.node;
-
- // auto node expand check
- if(!this.expandProcId && pt == "append" && node.hasChildNodes() && !n.node.isExpanded()){
- this.queueExpand(node);
- }else if(pt != "append"){
- this.cancelExpand();
- }
-
- // set the insert point style on the target node
- var returnCls = this.dropNotAllowed;
- if(this.isValidDropPoint(n, pt, dd, e, data)){
- if(pt){
- var el = n.ddel;
- var cls;
- if(pt == "above"){
- returnCls = n.node.isFirst() ? "x-tree-drop-ok-above" : "x-tree-drop-ok-between";
- cls = "x-tree-drag-insert-above";
- }else if(pt == "below"){
- returnCls = n.node.isLast() ? "x-tree-drop-ok-below" : "x-tree-drop-ok-between";
- cls = "x-tree-drag-insert-below";
- }else{
- returnCls = "x-tree-drop-ok-append";
- cls = "x-tree-drag-append";
- }
- if(this.lastInsertClass != cls){
- Ext.fly(el).replaceClass(this.lastInsertClass, cls);
- this.lastInsertClass = cls;
- }
- }
- }
- return returnCls;
- },
+ ss['background-attachment'] = 'fixed'; // w3c
+ dbody.bgProperties = 'fixed'; // ie
- // private
- onNodeOut : function(n, dd, e, data){
- this.cancelExpand();
- this.removeDropIndicators(n);
- },
+ Ext.core.DomHelper.applyStyles(dbody, ss);
- // private
- onNodeDrop : function(n, dd, e, data){
- var point = this.getDropPoint(e, n, dd);
- var targetNode = n.node;
- targetNode.ui.startDrop();
- if(!this.isValidDropPoint(n, point, dd, e, data)){
- targetNode.ui.endDrop();
- return false;
- }
- // first try to find the drop node
- var dropNode = data.node || (dd.getTreeNode ? dd.getTreeNode(data, targetNode, point, e) : null);
- return this.processDrop(targetNode, data, point, dd, e, dropNode);
- },
-
- onContainerDrop : function(dd, e, data){
- if (this.allowContainerDrop && this.isValidDropPoint({ ddel: this.tree.getRootNode().ui.elNode, node: this.tree.getRootNode() }, "append", dd, e, data)) {
- var targetNode = this.tree.getRootNode();
- targetNode.ui.startDrop();
- var dropNode = data.node || (dd.getTreeNode ? dd.getTreeNode(data, targetNode, 'append', e) : null);
- return this.processDrop(targetNode, data, 'append', dd, e, dropNode);
- }
- return false;
- },
-
- // private
- processDrop: function(target, data, point, dd, e, dropNode){
- var dropEvent = {
- tree : this.tree,
- target: target,
- data: data,
- point: point,
- source: dd,
- rawEvent: e,
- dropNode: dropNode,
- cancel: !dropNode,
- dropStatus: false
- };
- var retval = this.tree.fireEvent("beforenodedrop", dropEvent);
- if(retval === false || dropEvent.cancel === true || !dropEvent.dropNode){
- target.ui.endDrop();
- return dropEvent.dropStatus;
- }
-
- target = dropEvent.target;
- if(point == 'append' && !target.isExpanded()){
- target.expand(false, null, function(){
- this.completeDrop(dropEvent);
- }.createDelegate(this));
- }else{
- this.completeDrop(dropEvent);
- }
- return true;
- },
+ doc = me.getDoc();
- // private
- completeDrop : function(de){
- var ns = de.dropNode, p = de.point, t = de.target;
- if(!Ext.isArray(ns)){
- ns = [ns];
- }
- var n;
- for(var i = 0, len = ns.length; i < len; i++){
- n = ns[i];
- if(p == "above"){
- t.parentNode.insertBefore(n, t);
- }else if(p == "below"){
- t.parentNode.insertBefore(n, t.nextSibling);
- }else{
- t.appendChild(n);
+ if (doc) {
+ try {
+ Ext.EventManager.removeAll(doc);
+ } catch(e) {}
}
- }
- n.ui.focus();
- if(Ext.enableFx && this.tree.hlDrop){
- n.ui.highlight();
- }
- t.ui.endDrop();
- this.tree.fireEvent("nodedrop", de);
- },
-
- // private
- afterNodeMoved : function(dd, data, e, targetNode, dropNode){
- if(Ext.enableFx && this.tree.hlDrop){
- dropNode.ui.focus();
- dropNode.ui.highlight();
- }
- this.tree.fireEvent("nodedrop", this.tree, targetNode, data, dd, e);
- },
-
- // private
- getTree : function(){
- return this.tree;
- },
-
- // private
- removeDropIndicators : function(n){
- if(n && n.ddel){
- var el = n.ddel;
- Ext.fly(el).removeClass([
- "x-tree-drag-insert-above",
- "x-tree-drag-insert-below",
- "x-tree-drag-append"]);
- this.lastInsertClass = "_noclass";
- }
- },
-
- // private
- beforeDragDrop : function(target, e, id){
- this.cancelExpand();
- return true;
- },
- // private
- afterRepair : function(data){
- if(data && Ext.enableFx){
- data.node.ui.highlight();
- }
- this.hideProxy();
- }
-});
+ /*
+ * We need to use createDelegate here, because when using buffer, the delayed task is added
+ * as a property to the function. When the listener is removed, the task is deleted from the function.
+ * Since onEditorEvent is shared on the prototype, if we have multiple html editors, the first time one of the editors
+ * is destroyed, it causes the fn to be deleted from the prototype, which causes errors. Essentially, we're just anonymizing the function.
+ */
+ fn = Ext.Function.bind(me.onEditorEvent, me);
+ Ext.EventManager.on(doc, {
+ mousedown: fn,
+ dblclick: fn,
+ click: fn,
+ keyup: fn,
+ buffer:100
+ });
-}/**
- * @class Ext.tree.TreeDragZone
- * @extends Ext.dd.DragZone
- * @constructor
- * @param {String/HTMLElement/Element} tree The {@link Ext.tree.TreePanel} for which to enable dragging
- * @param {Object} config
- */
-if(Ext.dd.DragZone){
-Ext.tree.TreeDragZone = function(tree, config){
- Ext.tree.TreeDragZone.superclass.constructor.call(this, tree.innerCt, config);
- /**
- * The TreePanel for this drag zone
- * @type Ext.tree.TreePanel
- * @property
- */
- this.tree = tree;
-};
+ // These events need to be relayed from the inner document (where they stop
+ // bubbling) up to the outer document. This has to be done at the DOM level so
+ // the event reaches listeners on elements like the document body. The effected
+ // mechanisms that depend on this bubbling behavior are listed to the right
+ // of the event.
+ fn = me.onRelayedEvent;
+ Ext.EventManager.on(doc, {
+ mousedown: fn, // menu dismisal (MenuManager) and Window onMouseDown (toFront)
+ mousemove: fn, // window resize drag detection
+ mouseup: fn, // window resize termination
+ click: fn, // not sure, but just to be safe
+ dblclick: fn, // not sure again
+ scope: me
+ });
-Ext.extend(Ext.tree.TreeDragZone, Ext.dd.DragZone, {
- /**
- * @cfg {String} ddGroup
- * A named drag drop group to which this object belongs. If a group is specified, then this object will only
- * interact with other drag drop objects in the same group (defaults to 'TreeDD').
- */
- ddGroup : "TreeDD",
+ if (Ext.isGecko) {
+ Ext.EventManager.on(doc, 'keypress', me.applyCommand, me);
+ }
+ if (me.fixKeys) {
+ Ext.EventManager.on(doc, 'keydown', me.fixKeys, me);
+ }
- // private
- onBeforeDrag : function(data, e){
- var n = data.node;
- return n && n.draggable && !n.disabled;
+ // We need to be sure we remove all our events from the iframe on unload or we're going to LEAK!
+ Ext.EventManager.on(window, 'unload', me.beforeDestroy, me);
+ doc.editorInitialized = true;
+
+ me.initialized = true;
+ me.pushValue();
+ me.setReadOnly(me.readOnly);
+ me.fireEvent('initialize', me);
+ } catch(ex) {
+ // ignore (why?)
+ }
},
// private
- onInitDrag : function(e){
- var data = this.dragData;
- this.tree.getSelectionModel().select(data.node);
- this.tree.eventModel.disable();
- this.proxy.update("");
- data.node.ui.appendDDGhost(this.proxy.ghost.dom);
- this.tree.fireEvent("startdrag", this.tree, data.node, e);
+ beforeDestroy : function(){
+ var me = this,
+ monitorTask = me.monitorTask,
+ doc, prop;
+
+ if (monitorTask) {
+ Ext.TaskManager.stop(monitorTask);
+ }
+ if (me.rendered) {
+ try {
+ doc = me.getDoc();
+ if (doc) {
+ Ext.EventManager.removeAll(doc);
+ for (prop in doc) {
+ if (doc.hasOwnProperty(prop)) {
+ delete doc[prop];
+ }
+ }
+ }
+ } catch(e) {
+ // ignore (why?)
+ }
+ Ext.destroyMembers('tb', 'toolbarWrap', 'iframeEl', 'textareaEl');
+ }
+ me.callParent();
},
// private
- getRepairXY : function(e, data){
- return data.node.ui.getDDRepairXY();
+ onRelayedEvent: function (event) {
+ // relay event from the iframe's document to the document that owns the iframe...
+
+ var iframeEl = this.iframeEl,
+ iframeXY = iframeEl.getXY(),
+ eventXY = event.getXY();
+
+ // the event from the inner document has XY relative to that document's origin,
+ // so adjust it to use the origin of the iframe in the outer document:
+ event.xy = [iframeXY[0] + eventXY[0], iframeXY[1] + eventXY[1]];
+
+ event.injectEvent(iframeEl); // blame the iframe for the event...
+
+ event.xy = eventXY; // restore the original XY (just for safety)
},
// private
- onEndDrag : function(data, e){
- this.tree.eventModel.enable.defer(100, this.tree.eventModel);
- this.tree.fireEvent("enddrag", this.tree, data.node, e);
+ onFirstFocus : function(){
+ var me = this,
+ selection, range;
+ me.activated = true;
+ me.disableItems(me.readOnly);
+ if (Ext.isGecko) { // prevent silly gecko errors
+ me.win.focus();
+ selection = me.win.getSelection();
+ if (!selection.focusNode || selection.focusNode.nodeType !== 3) {
+ range = selection.getRangeAt(0);
+ range.selectNodeContents(me.getEditorBody());
+ range.collapse(true);
+ me.deferFocus();
+ }
+ try {
+ me.execCmd('useCSS', true);
+ me.execCmd('styleWithCSS', false);
+ } catch(e) {
+ // ignore (why?)
+ }
+ }
+ me.fireEvent('activate', me);
},
// private
- onValidDrop : function(dd, e, id){
- this.tree.fireEvent("dragdrop", this.tree, this.dragData.node, dd, e);
- this.hideProxy();
+ adjustFont: function(btn) {
+ var adjust = btn.getItemId() === 'increasefontsize' ? 1 : -1,
+ size = this.getDoc().queryCommandValue('FontSize') || '2',
+ isPxSize = Ext.isString(size) && size.indexOf('px') !== -1,
+ isSafari;
+ size = parseInt(size, 10);
+ if (isPxSize) {
+ // Safari 3 values
+ // 1 = 10px, 2 = 13px, 3 = 16px, 4 = 18px, 5 = 24px, 6 = 32px
+ if (size <= 10) {
+ size = 1 + adjust;
+ }
+ else if (size <= 13) {
+ size = 2 + adjust;
+ }
+ else if (size <= 16) {
+ size = 3 + adjust;
+ }
+ else if (size <= 18) {
+ size = 4 + adjust;
+ }
+ else if (size <= 24) {
+ size = 5 + adjust;
+ }
+ else {
+ size = 6 + adjust;
+ }
+ size = Ext.Number.constrain(size, 1, 6);
+ } else {
+ isSafari = Ext.isSafari;
+ if (isSafari) { // safari
+ adjust *= 2;
+ }
+ size = Math.max(1, size + adjust) + (isSafari ? 'px' : 0);
+ }
+ this.execCmd('FontSize', size);
},
// private
- beforeInvalidDrop : function(e, id){
- // this scrolls the original position back into view
- var sm = this.tree.getSelectionModel();
- sm.clearSelections();
- sm.select(this.dragData.node);
+ onEditorEvent: function(e) {
+ this.updateToolbar();
},
-
- // private
- afterRepair : function(){
- if (Ext.enableFx && this.tree.hlDrop) {
- Ext.Element.fly(this.dragData.ddel).highlight(this.hlColor || "c3daf9");
- }
- this.dragging = false;
- }
-});
-}/**
- * @class Ext.tree.TreeEditor
- * @extends Ext.Editor
- * Provides editor functionality for inline tree node editing. Any valid {@link Ext.form.Field} subclass can be used
- * as the editor field.
- * @constructor
- * @param {TreePanel} tree
- * @param {Object} fieldConfig (optional) Either a prebuilt {@link Ext.form.Field} instance or a Field config object
- * that will be applied to the default field instance (defaults to a {@link Ext.form.TextField}).
- * @param {Object} config (optional) A TreeEditor config object
- */
-Ext.tree.TreeEditor = function(tree, fc, config){
- fc = fc || {};
- var field = fc.events ? fc : new Ext.form.TextField(fc);
-
- Ext.tree.TreeEditor.superclass.constructor.call(this, field, config);
- this.tree = tree;
-
- if(!tree.rendered){
- tree.on('render', this.initEditor, this);
- }else{
- this.initEditor(tree);
- }
-};
-
-Ext.extend(Ext.tree.TreeEditor, Ext.Editor, {
- /**
- * @cfg {String} alignment
- * The position to align to (see {@link Ext.Element#alignTo} for more details, defaults to "l-l").
- */
- alignment: "l-l",
- // inherit
- autoSize: false,
- /**
- * @cfg {Boolean} hideEl
- * True to hide the bound element while the editor is displayed (defaults to false)
- */
- hideEl : false,
- /**
- * @cfg {String} cls
- * CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")
- */
- cls: "x-small-editor x-tree-editor",
/**
- * @cfg {Boolean} shim
- * True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)
- */
- shim:false,
- // inherit
- shadow:"frame",
- /**
- * @cfg {Number} maxWidth
- * The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed
- * the containing tree element's size, it will be automatically limited for you to the container width, taking
- * scroll and client offsets into account prior to each edit.
- */
- maxWidth: 250,
- /**
- * @cfg {Number} editDelay The number of milliseconds between clicks to register a double-click that will trigger
- * editing on the current node (defaults to 350). If two clicks occur on the same node within this time span,
- * the editor for the node will display, otherwise it will be processed as a regular click.
+ * Protected method that will not generally be called directly. It triggers
+ * a toolbar update by reading the markup state of the current selection in the editor.
*/
- editDelay : 350,
+ updateToolbar: function() {
+ var me = this,
+ btns, doc, name, fontSelect;
- initEditor : function(tree){
- tree.on({
- scope : this,
- beforeclick: this.beforeNodeClick,
- dblclick : this.onNodeDblClick
- });
-
- this.on({
- scope : this,
- complete : this.updateNode,
- beforestartedit: this.fitToTree,
- specialkey : this.onSpecialKey
- });
-
- this.on('startedit', this.bindScroll, this, {delay:10});
- },
+ if (me.readOnly) {
+ return;
+ }
- // private
- fitToTree : function(ed, el){
- var td = this.tree.getTreeEl().dom, nd = el.dom;
- if(td.scrollLeft > nd.offsetLeft){ // ensure the node left point is visible
- td.scrollLeft = nd.offsetLeft;
- }
- var w = Math.min(
- this.maxWidth,
- (td.clientWidth > 20 ? td.clientWidth : td.offsetWidth) - Math.max(0, nd.offsetLeft-td.scrollLeft) - /*cushion*/5);
- this.setSize(w, '');
- },
-
- /**
- * Edit the text of the passed {@link Ext.tree.TreeNode TreeNode}.
- * @param node {Ext.tree.TreeNode} The TreeNode to edit. The TreeNode must be {@link Ext.tree.TreeNode#editable editable}.
- */
- triggerEdit : function(node, defer){
- this.completeEdit();
- if(node.attributes.editable !== false){
- /**
- * The {@link Ext.tree.TreeNode TreeNode} this editor is bound to. Read-only.
- * @type Ext.tree.TreeNode
- * @property editNode
- */
- this.editNode = node;
- if(this.tree.autoScroll){
- Ext.fly(node.ui.getEl()).scrollIntoView(this.tree.body);
- }
- var value = node.text || '';
- if (!Ext.isGecko && Ext.isEmpty(node.text)){
- node.setText(' ');
- }
- this.autoEditTimer = this.startEdit.defer(this.editDelay, this, [node.ui.textNode, value]);
- return false;
+ if (!me.activated) {
+ me.onFirstFocus();
+ return;
}
- },
- // private
- bindScroll : function(){
- this.tree.getTreeEl().on('scroll', this.cancelEdit, this);
- },
+ btns = me.getToolbar().items.map;
+ doc = me.getDoc();
- // private
- beforeNodeClick : function(node, e){
- clearTimeout(this.autoEditTimer);
- if(this.tree.getSelectionModel().isSelected(node)){
- e.stopEvent();
- return this.triggerEdit(node);
+ if (me.enableFont && !Ext.isSafari2) {
+ name = (doc.queryCommandValue('FontName') || me.defaultFont).toLowerCase();
+ fontSelect = me.fontSelect.dom;
+ if (name !== fontSelect.value) {
+ fontSelect.value = name;
+ }
}
- },
- onNodeDblClick : function(node, e){
- clearTimeout(this.autoEditTimer);
+ function updateButtons() {
+ Ext.Array.forEach(Ext.Array.toArray(arguments), function(name) {
+ btns[name].toggle(doc.queryCommandState(name));
+ });
+ }
+ if(me.enableFormat){
+ updateButtons('bold', 'italic', 'underline');
+ }
+ if(me.enableAlignments){
+ updateButtons('justifyleft', 'justifycenter', 'justifyright');
+ }
+ if(!Ext.isSafari2 && me.enableLists){
+ updateButtons('insertorderedlist', 'insertunorderedlist');
+ }
+
+ Ext.menu.Manager.hideAll();
+
+ me.syncValue();
},
// private
- updateNode : function(ed, value){
- this.tree.getTreeEl().un('scroll', this.cancelEdit, this);
- this.editNode.setText(value);
+ relayBtnCmd: function(btn) {
+ this.relayCmd(btn.getItemId());
},
- // private
- onHide : function(){
- Ext.tree.TreeEditor.superclass.onHide.call(this);
- if(this.editNode){
- this.editNode.ui.focus.defer(50, this.editNode.ui);
- }
+ /**
+ * Executes a Midas editor command on the editor document and performs necessary focus and
+ * toolbar updates. This should only be called after the editor is initialized.
+ * @param {String} cmd The Midas command
+ * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null)
+ */
+ relayCmd: function(cmd, value) {
+ Ext.defer(function() {
+ var me = this;
+ me.focus();
+ me.execCmd(cmd, value);
+ me.updateToolbar();
+ }, 10, this);
},
- // private
- onSpecialKey : function(field, e){
- var k = e.getKey();
- if(k == e.ESC){
- e.stopEvent();
- this.cancelEdit();
- }else if(k == e.ENTER && !e.hasModifier()){
- e.stopEvent();
- this.completeEdit();
- }
+ /**
+ * Executes a Midas editor command directly on the editor document.
+ * For visual commands, you should use {@link #relayCmd} instead.
+ * This should only be called after the editor is initialized.
+ * @param {String} cmd The Midas command
+ * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null)
+ */
+ execCmd : function(cmd, value){
+ var me = this,
+ doc = me.getDoc(),
+ undef;
+ doc.execCommand(cmd, false, value === undef ? null : value);
+ me.syncValue();
},
-
- onDestroy : function(){
- clearTimeout(this.autoEditTimer);
- Ext.tree.TreeEditor.superclass.onDestroy.call(this);
- var tree = this.tree;
- tree.un('beforeclick', this.beforeNodeClick, this);
- tree.un('dblclick', this.onNodeDblClick, this);
- }
-});/*! SWFObject v2.2
- is released under the MIT License
-*/
-var swfobject = function() {
-
- var UNDEF = "undefined",
- OBJECT = "object",
- SHOCKWAVE_FLASH = "Shockwave Flash",
- SHOCKWAVE_FLASH_AX = "ShockwaveFlash.ShockwaveFlash",
- FLASH_MIME_TYPE = "application/x-shockwave-flash",
- EXPRESS_INSTALL_ID = "SWFObjectExprInst",
- ON_READY_STATE_CHANGE = "onreadystatechange",
-
- win = window,
- doc = document,
- nav = navigator,
-
- plugin = false,
- domLoadFnArr = [main],
- regObjArr = [],
- objIdArr = [],
- listenersArr = [],
- storedAltContent,
- storedAltContentId,
- storedCallbackFn,
- storedCallbackObj,
- isDomLoaded = false,
- isExpressInstallActive = false,
- dynamicStylesheet,
- dynamicStylesheetMedia,
- autoHideShow = true,
-
- /* Centralized function for browser feature detection
- - User agent string detection is only used when no good alternative is possible
- - Is executed directly for optimal performance
- */
- ua = function() {
- var w3cdom = typeof doc.getElementById != UNDEF && typeof doc.getElementsByTagName != UNDEF && typeof doc.createElement != UNDEF,
- u = nav.userAgent.toLowerCase(),
- p = nav.platform.toLowerCase(),
- windows = p ? /win/.test(p) : /win/.test(u),
- mac = p ? /mac/.test(p) : /mac/.test(u),
- webkit = /webkit/.test(u) ? parseFloat(u.replace(/^.*webkit\/(\d+(\.\d+)?).*$/, "$1")) : false, // returns either the webkit version or false if not webkit
- ie = !+"\v1", // feature detection based on Andrea Giammarchi's solution: http://webreflection.blogspot.com/2009/01/32-bytes-to-know-if-your-browser-is-ie.html
- playerVersion = [0,0,0],
- d = null;
- if (typeof nav.plugins != UNDEF && typeof nav.plugins[SHOCKWAVE_FLASH] == OBJECT) {
- d = nav.plugins[SHOCKWAVE_FLASH].description;
- if (d && !(typeof nav.mimeTypes != UNDEF && nav.mimeTypes[FLASH_MIME_TYPE] && !nav.mimeTypes[FLASH_MIME_TYPE].enabledPlugin)) { // navigator.mimeTypes["application/x-shockwave-flash"].enabledPlugin indicates whether plug-ins are enabled or disabled in Safari 3+
- plugin = true;
- ie = false; // cascaded feature detection for Internet Explorer
- d = d.replace(/^.*\s+(\S+\s+\S+$)/, "$1");
- playerVersion[0] = parseInt(d.replace(/^(.*)\..*$/, "$1"), 10);
- playerVersion[1] = parseInt(d.replace(/^.*\.(.*)\s.*$/, "$1"), 10);
- playerVersion[2] = /[a-zA-Z]/.test(d) ? parseInt(d.replace(/^.*[a-zA-Z]+(.*)$/, "$1"), 10) : 0;
- }
- }
- else if (typeof win.ActiveXObject != UNDEF) {
- try {
- var a = new ActiveXObject(SHOCKWAVE_FLASH_AX);
- if (a) { // a will return null when ActiveX is disabled
- d = a.GetVariable("$version");
- if (d) {
- ie = true; // cascaded feature detection for Internet Explorer
- d = d.split(" ")[1].split(",");
- playerVersion = [parseInt(d[0], 10), parseInt(d[1], 10), parseInt(d[2], 10)];
- }
+ // private
+ applyCommand : function(e){
+ if (e.ctrlKey) {
+ var me = this,
+ c = e.getCharCode(), cmd;
+ if (c > 0) {
+ c = String.fromCharCode(c);
+ switch (c) {
+ case 'b':
+ cmd = 'bold';
+ break;
+ case 'i':
+ cmd = 'italic';
+ break;
+ case 'u':
+ cmd = 'underline';
+ break;
}
- }
- catch(e) {}
- }
- return { w3:w3cdom, pv:playerVersion, wk:webkit, ie:ie, win:windows, mac:mac };
- }(),
-
- /* Cross-browser onDomLoad
- - Will fire an event as soon as the DOM of a web page is loaded
- - Internet Explorer workaround based on Diego Perini's solution: http://javascript.nwbox.com/IEContentLoaded/
- - Regular onload serves as fallback
- */
- onDomLoad = function() {
- if (!ua.w3) { return; }
- if ((typeof doc.readyState != UNDEF && doc.readyState == "complete") || (typeof doc.readyState == UNDEF && (doc.getElementsByTagName("body")[0] || doc.body))) { // function is fired after onload, e.g. when script is inserted dynamically
- callDomLoadFunctions();
- }
- if (!isDomLoaded) {
- if (typeof doc.addEventListener != UNDEF) {
- doc.addEventListener("DOMContentLoaded", callDomLoadFunctions, false);
- }
- if (ua.ie && ua.win) {
- doc.attachEvent(ON_READY_STATE_CHANGE, function() {
- if (doc.readyState == "complete") {
- doc.detachEvent(ON_READY_STATE_CHANGE, arguments.callee);
- callDomLoadFunctions();
- }
- });
- if (win == top) { // if not inside an iframe
- (function(){
- if (isDomLoaded) { return; }
- try {
- doc.documentElement.doScroll("left");
- }
- catch(e) {
- setTimeout(arguments.callee, 0);
- return;
- }
- callDomLoadFunctions();
- })();
+ if (cmd) {
+ me.win.focus();
+ me.execCmd(cmd);
+ me.deferFocus();
+ e.preventDefault();
}
}
- if (ua.wk) {
- (function(){
- if (isDomLoaded) { return; }
- if (!/loaded|complete/.test(doc.readyState)) {
- setTimeout(arguments.callee, 0);
- return;
- }
- callDomLoadFunctions();
- })();
- }
- addLoadEvent(callDomLoadFunctions);
- }
- }();
-
- function callDomLoadFunctions() {
- if (isDomLoaded) { return; }
- try { // test if we can really add/remove elements to/from the DOM; we don't want to fire it too early
- var t = doc.getElementsByTagName("body")[0].appendChild(createElement("span"));
- t.parentNode.removeChild(t);
- }
- catch (e) { return; }
- isDomLoaded = true;
- var dl = domLoadFnArr.length;
- for (var i = 0; i < dl; i++) {
- domLoadFnArr[i]();
- }
- }
-
- function addDomLoadEvent(fn) {
- if (isDomLoaded) {
- fn();
- }
- else {
- domLoadFnArr[domLoadFnArr.length] = fn; // Array.push() is only available in IE5.5+
}
- }
-
- /* Cross-browser onload
- - Based on James Edwards' solution: http://brothercake.com/site/resources/scripts/onload/
- - Will fire an event as soon as a web page including all of its assets are loaded
+ },
+
+ /**
+ * Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
+ * to insert text.
+ * @param {String} text
*/
- function addLoadEvent(fn) {
- if (typeof win.addEventListener != UNDEF) {
- win.addEventListener("load", fn, false);
- }
- else if (typeof doc.addEventListener != UNDEF) {
- doc.addEventListener("load", fn, false);
- }
- else if (typeof win.attachEvent != UNDEF) {
- addListener(win, "onload", fn);
- }
- else if (typeof win.onload == "function") {
- var fnOld = win.onload;
- win.onload = function() {
- fnOld();
- fn();
- };
- }
- else {
- win.onload = fn;
- }
- }
-
- /* Main function
- - Will preferably execute onDomLoad, otherwise onload (as a fallback)
- */
- function main() {
- if (plugin) {
- testPlayerVersion();
- }
- else {
- matchVersions();
- }
- }
-
- /* Detect the Flash Player version for non-Internet Explorer browsers
- - Detecting the plug-in version via the object element is more precise than using the plugins collection item's description:
- a. Both release and build numbers can be detected
- b. Avoid wrong descriptions by corrupt installers provided by Adobe
- c. Avoid wrong descriptions by multiple Flash Player entries in the plugin Array, caused by incorrect browser imports
- - Disadvantage of this method is that it depends on the availability of the DOM, while the plugins collection is immediately available
- */
- function testPlayerVersion() {
- var b = doc.getElementsByTagName("body")[0];
- var o = createElement(OBJECT);
- o.setAttribute("type", FLASH_MIME_TYPE);
- var t = b.appendChild(o);
- if (t) {
- var counter = 0;
- (function(){
- if (typeof t.GetVariable != UNDEF) {
- var d = t.GetVariable("$version");
- if (d) {
- d = d.split(" ")[1].split(",");
- ua.pv = [parseInt(d[0], 10), parseInt(d[1], 10), parseInt(d[2], 10)];
- }
- }
- else if (counter < 10) {
- counter++;
- setTimeout(arguments.callee, 10);
- return;
+ insertAtCursor : function(text){
+ var me = this,
+ range;
+
+ if (me.activated) {
+ me.win.focus();
+ if (Ext.isIE) {
+ range = me.getDoc().selection.createRange();
+ if (range) {
+ range.pasteHTML(text);
+ me.syncValue();
+ me.deferFocus();
}
- b.removeChild(o);
- t = null;
- matchVersions();
- })();
- }
- else {
- matchVersions();
+ }else{
+ me.execCmd('InsertHTML', text);
+ me.deferFocus();
+ }
}
- }
-
- /* Perform Flash Player and SWF version matching; static publishing only
- */
- function matchVersions() {
- var rl = regObjArr.length;
- if (rl > 0) {
- for (var i = 0; i < rl; i++) { // for each registered object element
- var id = regObjArr[i].id;
- var cb = regObjArr[i].callbackFn;
- var cbObj = {success:false, id:id};
- if (ua.pv[0] > 0) {
- var obj = getElementById(id);
- if (obj) {
- if (hasPlayerVersion(regObjArr[i].swfVersion) && !(ua.wk && ua.wk < 312)) { // Flash Player version >= published SWF version: Houston, we have a match!
- setVisibility(id, true);
- if (cb) {
- cbObj.success = true;
- cbObj.ref = getObjectById(id);
- cb(cbObj);
- }
- }
- else if (regObjArr[i].expressInstall && canExpressInstall()) { // show the Adobe Express Install dialog if set by the web page author and if supported
- var att = {};
- att.data = regObjArr[i].expressInstall;
- att.width = obj.getAttribute("width") || "0";
- att.height = obj.getAttribute("height") || "0";
- if (obj.getAttribute("class")) { att.styleclass = obj.getAttribute("class"); }
- if (obj.getAttribute("align")) { att.align = obj.getAttribute("align"); }
- // parse HTML object param element's name-value pairs
- var par = {};
- var p = obj.getElementsByTagName("param");
- var pl = p.length;
- for (var j = 0; j < pl; j++) {
- if (p[j].getAttribute("name").toLowerCase() != "movie") {
- par[p[j].getAttribute("name")] = p[j].getAttribute("value");
- }
- }
- showExpressInstall(att, par, id, cb);
- }
- else { // Flash Player and SWF version mismatch or an older Webkit engine that ignores the HTML object element's nested param elements: display alternative content instead of SWF
- displayAltContent(obj);
- if (cb) { cb(cbObj); }
- }
+ },
+
+ // private
+ fixKeys: function() { // load time branching for fastest keydown performance
+ if (Ext.isIE) {
+ return function(e){
+ var me = this,
+ k = e.getKey(),
+ doc = me.getDoc(),
+ range, target;
+ if (k === e.TAB) {
+ e.stopEvent();
+ range = doc.selection.createRange();
+ if(range){
+ range.collapse(true);
+ range.pasteHTML(' ');
+ me.deferFocus();
}
}
- else { // if no Flash Player is installed or the fp version cannot be detected we let the HTML object element do its job (either show a SWF or alternative content)
- setVisibility(id, true);
- if (cb) {
- var o = getObjectById(id); // test whether there is an HTML object element or not
- if (o && typeof o.SetVariable != UNDEF) {
- cbObj.success = true;
- cbObj.ref = o;
+ else if (k === e.ENTER) {
+ range = doc.selection.createRange();
+ if (range) {
+ target = range.parentElement();
+ if(!target || target.tagName.toLowerCase() !== 'li'){
+ e.stopEvent();
+ range.pasteHTML('
');
+ range.collapse(false);
+ range.select();
}
- cb(cbObj);
- }
- }
- }
- }
- }
-
- function getObjectById(objectIdStr) {
- var r = null;
- var o = getElementById(objectIdStr);
- if (o && o.nodeName == "OBJECT") {
- if (typeof o.SetVariable != UNDEF) {
- r = o;
- }
- else {
- var n = o.getElementsByTagName(OBJECT)[0];
- if (n) {
- r = n;
- }
- }
- }
- return r;
- }
-
- /* Requirements for Adobe Express Install
- - only one instance can be active at a time
- - fp 6.0.65 or higher
- - Win/Mac OS only
- - no Webkit engines older than version 312
- */
- function canExpressInstall() {
- return !isExpressInstallActive && hasPlayerVersion("6.0.65") && (ua.win || ua.mac) && !(ua.wk && ua.wk < 312);
- }
-
- /* Show the Adobe Express Install dialog
- - Reference: http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=6a253b75
- */
- function showExpressInstall(att, par, replaceElemIdStr, callbackFn) {
- isExpressInstallActive = true;
- storedCallbackFn = callbackFn || null;
- storedCallbackObj = {success:false, id:replaceElemIdStr};
- var obj = getElementById(replaceElemIdStr);
- if (obj) {
- if (obj.nodeName == "OBJECT") { // static publishing
- storedAltContent = abstractAltContent(obj);
- storedAltContentId = null;
- }
- else { // dynamic publishing
- storedAltContent = obj;
- storedAltContentId = replaceElemIdStr;
- }
- att.id = EXPRESS_INSTALL_ID;
- if (typeof att.width == UNDEF || (!/%$/.test(att.width) && parseInt(att.width, 10) < 310)) { att.width = "310"; }
- if (typeof att.height == UNDEF || (!/%$/.test(att.height) && parseInt(att.height, 10) < 137)) { att.height = "137"; }
- doc.title = doc.title.slice(0, 47) + " - Flash Player Installation";
- var pt = ua.ie && ua.win ? "ActiveX" : "PlugIn",
- fv = "MMredirectURL=" + win.location.toString().replace(/&/g,"%26") + "&MMplayerType=" + pt + "&MMdoctitle=" + doc.title;
- if (typeof par.flashvars != UNDEF) {
- par.flashvars += "&" + fv;
- }
- else {
- par.flashvars = fv;
- }
- // IE only: when a SWF is loading (AND: not available in cache) wait for the readyState of the object element to become 4 before removing it,
- // because you cannot properly cancel a loading SWF file without breaking browser load references, also obj.onreadystatechange doesn't work
- if (ua.ie && ua.win && obj.readyState != 4) {
- var newObj = createElement("div");
- replaceElemIdStr += "SWFObjectNew";
- newObj.setAttribute("id", replaceElemIdStr);
- obj.parentNode.insertBefore(newObj, obj); // insert placeholder div that will be replaced by the object element that loads expressinstall.swf
- obj.style.display = "none";
- (function(){
- if (obj.readyState == 4) {
- obj.parentNode.removeChild(obj);
}
- else {
- setTimeout(arguments.callee, 10);
- }
- })();
- }
- createSWF(att, par, replaceElemIdStr);
- }
- }
-
- /* Functions to abstract and display alternative content
- */
- function displayAltContent(obj) {
- if (ua.ie && ua.win && obj.readyState != 4) {
- // IE only: when a SWF is loading (AND: not available in cache) wait for the readyState of the object element to become 4 before removing it,
- // because you cannot properly cancel a loading SWF file without breaking browser load references, also obj.onreadystatechange doesn't work
- var el = createElement("div");
- obj.parentNode.insertBefore(el, obj); // insert placeholder div that will be replaced by the alternative content
- el.parentNode.replaceChild(abstractAltContent(obj), el);
- obj.style.display = "none";
- (function(){
- if (obj.readyState == 4) {
- obj.parentNode.removeChild(obj);
- }
- else {
- setTimeout(arguments.callee, 10);
}
- })();
- }
- else {
- obj.parentNode.replaceChild(abstractAltContent(obj), obj);
+ };
}
- }
- function abstractAltContent(obj) {
- var ac = createElement("div");
- if (ua.win && ua.ie) {
- ac.innerHTML = obj.innerHTML;
- }
- else {
- var nestedObj = obj.getElementsByTagName(OBJECT)[0];
- if (nestedObj) {
- var c = nestedObj.childNodes;
- if (c) {
- var cl = c.length;
- for (var i = 0; i < cl; i++) {
- if (!(c[i].nodeType == 1 && c[i].nodeName == "PARAM") && !(c[i].nodeType == 8)) {
- ac.appendChild(c[i].cloneNode(true));
- }
- }
+ if (Ext.isOpera) {
+ return function(e){
+ var me = this;
+ if (e.getKey() === e.TAB) {
+ e.stopEvent();
+ me.win.focus();
+ me.execCmd('InsertHTML',' ');
+ me.deferFocus();
}
- }
+ };
}
- return ac;
- }
-
- /* Cross-browser dynamic SWF creation
- */
- function createSWF(attObj, parObj, id) {
- var r, el = getElementById(id);
- if (ua.wk && ua.wk < 312) { return r; }
- if (el) {
- if (typeof attObj.id == UNDEF) { // if no 'id' is defined for the object element, it will inherit the 'id' from the alternative content
- attObj.id = id;
- }
- if (ua.ie && ua.win) { // Internet Explorer + the HTML object element + W3C DOM methods do not combine: fall back to outerHTML
- var att = "";
- for (var i in attObj) {
- if (attObj[i] != Object.prototype[i]) { // filter out prototype additions from other potential libraries
- if (i.toLowerCase() == "data") {
- parObj.movie = attObj[i];
- }
- else if (i.toLowerCase() == "styleclass") { // 'class' is an ECMA4 reserved keyword
- att += ' class="' + attObj[i] + '"';
- }
- else if (i.toLowerCase() != "classid") {
- att += ' ' + i + '="' + attObj[i] + '"';
- }
- }
- }
- var par = "";
- for (var j in parObj) {
- if (parObj[j] != Object.prototype[j]) { // filter out prototype additions from other potential libraries
- par += '';
- }
- }
- el.outerHTML = '';
- objIdArr[objIdArr.length] = attObj.id; // stored to fix object 'leaks' on unload (dynamic publishing only)
- r = getElementById(attObj.id);
- }
- else { // well-behaving browsers
- var o = createElement(OBJECT);
- o.setAttribute("type", FLASH_MIME_TYPE);
- for (var m in attObj) {
- if (attObj[m] != Object.prototype[m]) { // filter out prototype additions from other potential libraries
- if (m.toLowerCase() == "styleclass") { // 'class' is an ECMA4 reserved keyword
- o.setAttribute("class", attObj[m]);
- }
- else if (m.toLowerCase() != "classid") { // filter out IE specific attribute
- o.setAttribute(m, attObj[m]);
- }
- }
- }
- for (var n in parObj) {
- if (parObj[n] != Object.prototype[n] && n.toLowerCase() != "movie") { // filter out prototype additions from other potential libraries and IE specific param element
- createObjParam(o, n, parObj[n]);
- }
+
+ if (Ext.isWebKit) {
+ return function(e){
+ var me = this,
+ k = e.getKey();
+ if (k === e.TAB) {
+ e.stopEvent();
+ me.execCmd('InsertText','\t');
+ me.deferFocus();
}
- el.parentNode.replaceChild(o, el);
- r = o;
- }
- }
- return r;
- }
-
- function createObjParam(el, pName, pValue) {
- var p = createElement("param");
- p.setAttribute("name", pName);
- p.setAttribute("value", pValue);
- el.appendChild(p);
- }
-
- /* Cross-browser SWF removal
- - Especially needed to safely and completely remove a SWF in Internet Explorer
- */
- function removeSWF(id) {
- var obj = getElementById(id);
- if (obj && obj.nodeName == "OBJECT") {
- if (ua.ie && ua.win) {
- obj.style.display = "none";
- (function(){
- if (obj.readyState == 4) {
- removeObjectInIE(id);
- }
- else {
- setTimeout(arguments.callee, 10);
- }
- })();
- }
- else {
- obj.parentNode.removeChild(obj);
- }
- }
- }
-
- function removeObjectInIE(id) {
- var obj = getElementById(id);
- if (obj) {
- for (var i in obj) {
- if (typeof obj[i] == "function") {
- obj[i] = null;
+ else if (k === e.ENTER) {
+ e.stopEvent();
+ me.execCmd('InsertHtml','
');
+ me.deferFocus();
}
- }
- obj.parentNode.removeChild(obj);
- }
- }
-
- /* Functions to optimize JavaScript compression
- */
- function getElementById(id) {
- var el = null;
- try {
- el = doc.getElementById(id);
- }
- catch (e) {}
- return el;
- }
-
- function createElement(el) {
- return doc.createElement(el);
- }
-
- /* Updated attachEvent function for Internet Explorer
- - Stores attachEvent information in an Array, so on unload the detachEvent functions can be called to avoid memory leaks
- */
- function addListener(target, eventType, fn) {
- target.attachEvent(eventType, fn);
- listenersArr[listenersArr.length] = [target, eventType, fn];
- }
-
- /* Flash Player and SWF content version matching
- */
- function hasPlayerVersion(rv) {
- var pv = ua.pv, v = rv.split(".");
- v[0] = parseInt(v[0], 10);
- v[1] = parseInt(v[1], 10) || 0; // supports short notation, e.g. "9" instead of "9.0.0"
- v[2] = parseInt(v[2], 10) || 0;
- return (pv[0] > v[0] || (pv[0] == v[0] && pv[1] > v[1]) || (pv[0] == v[0] && pv[1] == v[1] && pv[2] >= v[2])) ? true : false;
- }
-
- /* Cross-browser dynamic CSS creation
- - Based on Bobby van der Sluis' solution: http://www.bobbyvandersluis.com/articles/dynamicCSS.php
- */
- function createCSS(sel, decl, media, newStyle) {
- if (ua.ie && ua.mac) { return; }
- var h = doc.getElementsByTagName("head")[0];
- if (!h) { return; } // to also support badly authored HTML pages that lack a head element
- var m = (media && typeof media == "string") ? media : "screen";
- if (newStyle) {
- dynamicStylesheet = null;
- dynamicStylesheetMedia = null;
- }
- if (!dynamicStylesheet || dynamicStylesheetMedia != m) {
- // create dynamic stylesheet + get a global reference to it
- var s = createElement("style");
- s.setAttribute("type", "text/css");
- s.setAttribute("media", m);
- dynamicStylesheet = h.appendChild(s);
- if (ua.ie && ua.win && typeof doc.styleSheets != UNDEF && doc.styleSheets.length > 0) {
- dynamicStylesheet = doc.styleSheets[doc.styleSheets.length - 1];
- }
- dynamicStylesheetMedia = m;
- }
- // add style rule
- if (ua.ie && ua.win) {
- if (dynamicStylesheet && typeof dynamicStylesheet.addRule == OBJECT) {
- dynamicStylesheet.addRule(sel, decl);
- }
- }
- else {
- if (dynamicStylesheet && typeof doc.createTextNode != UNDEF) {
- dynamicStylesheet.appendChild(doc.createTextNode(sel + " {" + decl + "}"));
- }
- }
- }
-
- function setVisibility(id, isVisible) {
- if (!autoHideShow) { return; }
- var v = isVisible ? "visible" : "hidden";
- if (isDomLoaded && getElementById(id)) {
- getElementById(id).style.visibility = v;
- }
- else {
- createCSS("#" + id, "visibility:" + v);
+ };
}
- }
- /* Filter to avoid XSS attacks
- */
- function urlEncodeIfNecessary(s) {
- var regex = /[\\\"<>\.;]/;
- var hasBadChars = regex.exec(s) != null;
- return hasBadChars && typeof encodeURIComponent != UNDEF ? encodeURIComponent(s) : s;
- }
-
- /* Release memory to avoid memory leaks caused by closures, fix hanging audio/video threads and force open sockets/NetConnections to disconnect (Internet Explorer only)
- */
- var cleanup = function() {
- if (ua.ie && ua.win) {
- window.attachEvent("onunload", function() {
- // remove listeners to avoid memory leaks
- var ll = listenersArr.length;
- for (var i = 0; i < ll; i++) {
- listenersArr[i][0].detachEvent(listenersArr[i][1], listenersArr[i][2]);
- }
- // cleanup dynamically embedded objects to fix audio/video threads and force open sockets and NetConnections to disconnect
- var il = objIdArr.length;
- for (var j = 0; j < il; j++) {
- removeSWF(objIdArr[j]);
- }
- // cleanup library's main closures to avoid memory leaks
- for (var k in ua) {
- ua[k] = null;
- }
- ua = null;
- for (var l in swfobject) {
- swfobject[l] = null;
- }
- swfobject = null;
- });
- }
- }();
-
- return {
- /* Public API
- - Reference: http://code.google.com/p/swfobject/wiki/documentation
- */
- registerObject: function(objectIdStr, swfVersionStr, xiSwfUrlStr, callbackFn) {
- if (ua.w3 && objectIdStr && swfVersionStr) {
- var regObj = {};
- regObj.id = objectIdStr;
- regObj.swfVersion = swfVersionStr;
- regObj.expressInstall = xiSwfUrlStr;
- regObj.callbackFn = callbackFn;
- regObjArr[regObjArr.length] = regObj;
- setVisibility(objectIdStr, false);
- }
- else if (callbackFn) {
- callbackFn({success:false, id:objectIdStr});
- }
+ return null; // not needed, so null
+ }(),
+
+ /**
+ * Returns the editor's toolbar. This is only available after the editor has been rendered.
+ * @return {Ext.toolbar.Toolbar}
+ */
+ getToolbar : function(){
+ return this.toolbar;
+ },
+
+ /**
+ * Object collection of toolbar tooltips for the buttons in the editor. The key
+ * is the command id associated with that button and the value is a valid QuickTips object.
+ * For example:
+
+{
+ bold : {
+ title: 'Bold (Ctrl+B)',
+ text: 'Make the selected text bold.',
+ cls: 'x-html-editor-tip'
+ },
+ italic : {
+ title: 'Italic (Ctrl+I)',
+ text: 'Make the selected text italic.',
+ cls: 'x-html-editor-tip'
+ },
+ ...
+
+ * @type Object
+ */
+ buttonTips : {
+ bold : {
+ title: 'Bold (Ctrl+B)',
+ text: 'Make the selected text bold.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- getObjectById: function(objectIdStr) {
- if (ua.w3) {
- return getObjectById(objectIdStr);
- }
+ italic : {
+ title: 'Italic (Ctrl+I)',
+ text: 'Make the selected text italic.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- embedSWF: function(swfUrlStr, replaceElemIdStr, widthStr, heightStr, swfVersionStr, xiSwfUrlStr, flashvarsObj, parObj, attObj, callbackFn) {
- var callbackObj = {success:false, id:replaceElemIdStr};
- if (ua.w3 && !(ua.wk && ua.wk < 312) && swfUrlStr && replaceElemIdStr && widthStr && heightStr && swfVersionStr) {
- setVisibility(replaceElemIdStr, false);
- addDomLoadEvent(function() {
- widthStr += ""; // auto-convert to string
- heightStr += "";
- var att = {};
- if (attObj && typeof attObj === OBJECT) {
- for (var i in attObj) { // copy object to avoid the use of references, because web authors often reuse attObj for multiple SWFs
- att[i] = attObj[i];
- }
- }
- att.data = swfUrlStr;
- att.width = widthStr;
- att.height = heightStr;
- var par = {};
- if (parObj && typeof parObj === OBJECT) {
- for (var j in parObj) { // copy object to avoid the use of references, because web authors often reuse parObj for multiple SWFs
- par[j] = parObj[j];
- }
- }
- if (flashvarsObj && typeof flashvarsObj === OBJECT) {
- for (var k in flashvarsObj) { // copy object to avoid the use of references, because web authors often reuse flashvarsObj for multiple SWFs
- if (typeof par.flashvars != UNDEF) {
- par.flashvars += "&" + k + "=" + flashvarsObj[k];
- }
- else {
- par.flashvars = k + "=" + flashvarsObj[k];
- }
- }
- }
- if (hasPlayerVersion(swfVersionStr)) { // create SWF
- var obj = createSWF(att, par, replaceElemIdStr);
- if (att.id == replaceElemIdStr) {
- setVisibility(replaceElemIdStr, true);
- }
- callbackObj.success = true;
- callbackObj.ref = obj;
- }
- else if (xiSwfUrlStr && canExpressInstall()) { // show Adobe Express Install
- att.data = xiSwfUrlStr;
- showExpressInstall(att, par, replaceElemIdStr, callbackFn);
- return;
- }
- else { // show alternative content
- setVisibility(replaceElemIdStr, true);
- }
- if (callbackFn) { callbackFn(callbackObj); }
- });
- }
- else if (callbackFn) { callbackFn(callbackObj); }
+ underline : {
+ title: 'Underline (Ctrl+U)',
+ text: 'Underline the selected text.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- switchOffAutoHideShow: function() {
- autoHideShow = false;
+ increasefontsize : {
+ title: 'Grow Text',
+ text: 'Increase the font size.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- ua: ua,
-
- getFlashPlayerVersion: function() {
- return { major:ua.pv[0], minor:ua.pv[1], release:ua.pv[2] };
+ decreasefontsize : {
+ title: 'Shrink Text',
+ text: 'Decrease the font size.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- hasFlashPlayerVersion: hasPlayerVersion,
-
- createSWF: function(attObj, parObj, replaceElemIdStr) {
- if (ua.w3) {
- return createSWF(attObj, parObj, replaceElemIdStr);
- }
- else {
- return undefined;
- }
+ backcolor : {
+ title: 'Text Highlight Color',
+ text: 'Change the background color of the selected text.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- showExpressInstall: function(att, par, replaceElemIdStr, callbackFn) {
- if (ua.w3 && canExpressInstall()) {
- showExpressInstall(att, par, replaceElemIdStr, callbackFn);
- }
+ forecolor : {
+ title: 'Font Color',
+ text: 'Change the color of the selected text.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- removeSWF: function(objElemIdStr) {
- if (ua.w3) {
- removeSWF(objElemIdStr);
- }
+ justifyleft : {
+ title: 'Align Text Left',
+ text: 'Align text to the left.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
},
-
- createCSS: function(selStr, declStr, mediaStr, newStyleBoolean) {
- if (ua.w3) {
- createCSS(selStr, declStr, mediaStr, newStyleBoolean);
+ justifycenter : {
+ title: 'Center Text',
+ text: 'Center text in the editor.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
+ },
+ justifyright : {
+ title: 'Align Text Right',
+ text: 'Align text to the right.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
+ },
+ insertunorderedlist : {
+ title: 'Bullet List',
+ text: 'Start a bulleted list.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
+ },
+ insertorderedlist : {
+ title: 'Numbered List',
+ text: 'Start a numbered list.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
+ },
+ createlink : {
+ title: 'Hyperlink',
+ text: 'Make the selected text a hyperlink.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
+ },
+ sourceedit : {
+ title: 'Source Edit',
+ text: 'Switch to source editing mode.',
+ cls: Ext.baseCSSPrefix + 'html-editor-tip'
+ }
+ }
+
+ // hide stuff that is not compatible
+ /**
+ * @event blur
+ * @hide
+ */
+ /**
+ * @event change
+ * @hide
+ */
+ /**
+ * @event focus
+ * @hide
+ */
+ /**
+ * @event specialkey
+ * @hide
+ */
+ /**
+ * @cfg {String} fieldCls @hide
+ */
+ /**
+ * @cfg {String} focusCls @hide
+ */
+ /**
+ * @cfg {String} autoCreate @hide
+ */
+ /**
+ * @cfg {String} inputType @hide
+ */
+ /**
+ * @cfg {String} invalidCls @hide
+ */
+ /**
+ * @cfg {String} invalidText @hide
+ */
+ /**
+ * @cfg {String} msgFx @hide
+ */
+ /**
+ * @cfg {Boolean} allowDomMove @hide
+ */
+ /**
+ * @cfg {String} applyTo @hide
+ */
+ /**
+ * @cfg {String} readOnly @hide
+ */
+ /**
+ * @cfg {String} tabIndex @hide
+ */
+ /**
+ * @method validate
+ * @hide
+ */
+});
+
+/**
+ * @class Ext.form.field.Radio
+ * @extends Ext.form.field.Checkbox
+
+Single radio field. Similar to checkbox, but automatically handles making sure only one radio is checked
+at a time within a group of radios with the same name.
+
+__Labeling:__
+In addition to the {@link Ext.form.Labelable standard field labeling options}, radio buttons
+may be given an optional {@link #boxLabel} which will be displayed immediately to the right of the input. Also
+see {@link Ext.form.RadioGroup} for a convenient method of grouping related radio buttons.
+
+__Values:__
+The main value of a Radio field is a boolean, indicating whether or not the radio is checked.
+
+The following values will check the radio:
+* `true`
+* `'true'`
+* `'1'`
+* `'on'`
+
+Any other value will uncheck it.
+
+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 radio buttons with the same {@link #name}, as is almost always the case.
+{@img Ext.form.Radio/Ext.form.Radio.png Ext.form.Radio component}
+__Example usage:__
+
+ Ext.create('Ext.form.Panel', {
+ title : 'Order Form',
+ width : 300,
+ bodyPadding: 10,
+ renderTo : Ext.getBody(),
+ items: [
+ {
+ xtype : 'fieldcontainer',
+ fieldLabel : 'Size',
+ defaultType: 'radiofield',
+ defaults: {
+ flex: 1
+ },
+ layout: 'hbox',
+ items: [
+ {
+ boxLabel : 'M',
+ name : 'size',
+ inputValue: 'm',
+ id : 'radio1'
+ }, {
+ boxLabel : 'L',
+ name : 'size',
+ inputValue: 'l',
+ id : 'radio2'
+ }, {
+ boxLabel : 'XL',
+ name : 'size',
+ inputValue: 'xl',
+ id : 'radio3'
+ }
+ ]
+ },
+ {
+ xtype : 'fieldcontainer',
+ fieldLabel : 'Color',
+ defaultType: 'radiofield',
+ defaults: {
+ flex: 1
+ },
+ layout: 'hbox',
+ items: [
+ {
+ boxLabel : 'Blue',
+ name : 'color',
+ inputValue: 'blue',
+ id : 'radio4'
+ }, {
+ boxLabel : 'Grey',
+ name : 'color',
+ inputValue: 'grey',
+ id : 'radio5'
+ }, {
+ boxLabel : 'Black',
+ name : 'color',
+ inputValue: 'black',
+ id : 'radio6'
+ }
+ ]
}
- },
-
- addDomLoadEvent: addDomLoadEvent,
-
- addLoadEvent: addLoadEvent,
-
- getQueryParamValue: function(param) {
- var q = doc.location.search || doc.location.hash;
- if (q) {
- if (/\?/.test(q)) { q = q.split("?")[1]; } // strip question mark
- if (param == null) {
- return urlEncodeIfNecessary(q);
- }
- var pairs = q.split("&");
- for (var i = 0; i < pairs.length; i++) {
- if (pairs[i].substring(0, pairs[i].indexOf("=")) == param) {
- return urlEncodeIfNecessary(pairs[i].substring((pairs[i].indexOf("=") + 1)));
+ ],
+ bbar: [
+ {
+ text: 'Smaller Size',
+ handler: function() {
+ var radio1 = Ext.getCmp('radio1'),
+ radio2 = Ext.getCmp('radio2'),
+ radio3 = Ext.getCmp('radio3');
+
+ //if L is selected, change to M
+ if (radio2.getValue()) {
+ radio1.setValue(true);
+ return;
+ }
+
+ //if XL is selected, change to L
+ if (radio3.getValue()) {
+ radio2.setValue(true);
+ return;
}
+
+ //if nothing is set, set size to S
+ radio1.setValue(true);
}
- }
- return "";
- },
-
- // For internal usage only
- expressInstallCallback: function() {
- if (isExpressInstallActive) {
- var obj = getElementById(EXPRESS_INSTALL_ID);
- if (obj && storedAltContent) {
- obj.parentNode.replaceChild(storedAltContent, obj);
- if (storedAltContentId) {
- setVisibility(storedAltContentId, true);
- if (ua.ie && ua.win) { storedAltContent.style.display = "block"; }
+ },
+ {
+ text: 'Larger Size',
+ handler: function() {
+ var radio1 = Ext.getCmp('radio1'),
+ radio2 = Ext.getCmp('radio2'),
+ radio3 = Ext.getCmp('radio3');
+
+ //if M is selected, change to L
+ if (radio1.getValue()) {
+ radio2.setValue(true);
+ return;
}
- if (storedCallbackFn) { storedCallbackFn(storedCallbackObj); }
+
+ //if L is selected, change to XL
+ if (radio2.getValue()) {
+ radio3.setValue(true);
+ return;
+ }
+
+ //if nothing is set, set size to XL
+ radio3.setValue(true);
}
- isExpressInstallActive = false;
- }
- }
- };
-}();
-/**
- * @class Ext.FlashComponent
- * @extends Ext.BoxComponent
+ },
+ '-',
+ {
+ text: 'Select color',
+ menu: {
+ indent: false,
+ items: [
+ {
+ text: 'Blue',
+ handler: function() {
+ var radio = Ext.getCmp('radio4');
+ radio.setValue(true);
+ }
+ },
+ {
+ text: 'Grey',
+ handler: function() {
+ var radio = Ext.getCmp('radio5');
+ radio.setValue(true);
+ }
+ },
+ {
+ text: 'Black',
+ handler: function() {
+ var radio = Ext.getCmp('radio6');
+ radio.setValue(true);
+ }
+ }
+ ]
+ }
+ }
+ ]
+ });
+
+
* @constructor
- * @xtype flash
+ * Creates a new Radio
+ * @param {Object} config Configuration options
+ * @xtype radio
+ * @docauthor Robert Dougan
+ * @markdown
*/
-Ext.FlashComponent = Ext.extend(Ext.BoxComponent, {
- /**
- * @cfg {String} flashVersion
- * Indicates the version the flash content was published for. Defaults to '9.0.115'.
- */
- flashVersion : '9.0.115',
+Ext.define('Ext.form.field.Radio', {
+ extend:'Ext.form.field.Checkbox',
+ alias: ['widget.radiofield', 'widget.radio'],
+ alternateClassName: 'Ext.form.Radio',
+ requires: ['Ext.form.RadioManager'],
- /**
- * @cfg {String} backgroundColor
- * The background color of the chart. Defaults to '#ffffff'.
- */
- backgroundColor: '#ffffff',
+ isRadio: true,
/**
- * @cfg {String} wmode
- * The wmode of the flash object. This can be used to control layering. Defaults to 'opaque'.
+ * @cfg {String} uncheckedValue @hide
*/
- wmode: 'opaque',
- /**
- * @cfg {Object} flashVars
- * A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined.
- */
- flashVars: undefined,
+ // private
+ inputType: 'radio',
+ ariaRole: 'radio',
/**
- * @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.
+ * If this radio is part of a group, it will return the selected value
+ * @return {String}
*/
- flashParams: undefined,
+ getGroupValue: function() {
+ var selected = this.getManager().getChecked(this.name);
+ return selected ? selected.inputValue : null;
+ },
/**
- * @cfg {String} url
- * The URL of the chart to include. Defaults to undefined.
+ * @private Handle click on the radio button
*/
- url: undefined,
- swfId : undefined,
- swfWidth: '100%',
- swfHeight: '100%',
+ onBoxClick: function(e) {
+ var me = this;
+ if (!me.disabled && !me.readOnly) {
+ this.setValue(true);
+ }
+ },
/**
- * @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.
+ * Sets either the checked/unchecked status of this Radio, or, if a string value
+ * is passed, checks a sibling Radio of the same name whose value is the value specified.
+ * @param value {String/Boolean} Checked value, or the value of the sibling radio button to check.
+ * @return {Ext.form.field.Radio} this
*/
- expressInstall: false,
-
- initComponent : function(){
- Ext.FlashComponent.superclass.initComponent.call(this);
-
- this.addEvents(
- /**
- * @event initialize
- *
- * @param {Chart} this
- */
- 'initialize'
- );
- },
-
- onRender : function(){
- Ext.FlashComponent.superclass.onRender.apply(this, arguments);
-
- var params = Ext.apply({
- allowScriptAccess: 'always',
- bgcolor: this.backgroundColor,
- wmode: this.wmode
- }, this.flashParams), vars = Ext.apply({
- allowedDomain: document.location.hostname,
- YUISwfId: this.getId(),
- YUIBridgeCallback: 'Ext.FlashEventProxy.onEvent'
- }, this.flashVars);
-
- new swfobject.embedSWF(this.url, this.id, this.swfWidth, this.swfHeight, this.flashVersion,
- this.expressInstall ? Ext.FlashComponent.EXPRESS_INSTALL_URL : undefined, vars, params);
+ setValue: function(v) {
+ var me = this,
+ active;
- this.swf = Ext.getDom(this.id);
- this.el = Ext.get(this.swf);
+ if (Ext.isBoolean(v)) {
+ me.callParent(arguments);
+ } else {
+ active = me.getManager().getWithValue(me.name, v).getAt(0);
+ if (active) {
+ active.setValue(true);
+ }
+ }
+ return me;
},
- getSwfId : function(){
- return this.swfId || (this.swfId = "extswf" + (++Ext.Component.AUTO_ID));
+ /**
+ * Returns the submit value for the checkbox which can be used when submitting forms.
+ * @return {Boolean/null} True if checked, null if not.
+ */
+ getSubmitValue: function() {
+ return this.checked ? this.inputValue : null;
},
- getId : function(){
- return this.id || (this.id = "extflashcmp" + (++Ext.Component.AUTO_ID));
- },
+ // inherit docs
+ onChange: function(newVal, oldVal) {
+ var me = this;
+ me.callParent(arguments);
- onFlashEvent : function(e){
- switch(e.type){
- case "swfReady":
- this.initSwf();
- return;
- case "log":
- return;
+ if (newVal) {
+ this.getManager().getByName(me.name).each(function(item){
+ if (item !== me) {
+ item.setValue(false);
+ }
+ }, me);
}
- e.component = this;
- this.fireEvent(e.type.toLowerCase().replace(/event$/, ''), e);
- },
-
- initSwf : function(){
- this.onSwfReady(!!this.isInitialized);
- this.isInitialized = true;
- this.fireEvent('initialize', this);
},
+ // inherit docs
beforeDestroy: function(){
- if(this.rendered){
- swfobject.removeSWF(this.swf.id);
- }
- Ext.FlashComponent.superclass.beforeDestroy.call(this);
+ this.callParent();
+ this.getManager().removeAtKey(this.id);
},
- onSwfReady : Ext.emptyFn
+ // inherit docs
+ getManager: function() {
+ return Ext.form.RadioManager;
+ }
});
/**
- * Sets the url for installing flash if it doesn't exist. This should be set to a local resource.
- * @static
- * @type String
- */
-Ext.FlashComponent.EXPRESS_INSTALL_URL = 'http:/' + '/swfobject.googlecode.com/svn/trunk/swfobject/expressInstall.swf';
-
-Ext.reg('flash', Ext.FlashComponent);/**
- * @class Ext.FlashProxy
- * @singleton
- */
-Ext.FlashEventProxy = {
- onEvent : function(id, e){
- var fp = Ext.getCmp(id);
- if(fp){
- fp.onFlashEvent(e);
- }else{
- arguments.callee.defer(10, this, [id, e]);
- }
- }
-};/**
- * @class Ext.chart.Chart
- * @extends Ext.FlashComponent
- * The Ext.chart package provides the capability to visualize data with flash based charting.
- * Each chart binds directly to an Ext.data.Store enabling automatic updates of the chart.
- * To change the look and feel of a chart, see the {@link #chartStyle} and {@link #extraStyle} config options.
+ * @class Ext.picker.Time
+ * @extends Ext.view.BoundList
+ * A time picker which provides a list of times from which to choose. This is used by the
+ * {@link Ext.form.field.Time} class to allow browsing and selection of valid times, but could also be used
+ * with other components.
+ * By default, all times starting at midnight and incrementing every 15 minutes will be presented.
+ * This list of available times can be controlled using the {@link #minValue}, {@link #maxValue}, and
+ * {@link #increment} configuration properties. The format of the times presented in the list can be
+ * customized with the {@link #format} config.
+ * To handle when the user selects a time from the list, you can subscribe to the {@link #selectionchange}
+ * event.
+ *
+ * {@img Ext.picker.Time/Ext.picker.Time.png Ext.picker.Time component}
+ *
+ * ## Code
+ new Ext.create('Ext.picker.Time', {
+ width: 60,
+ minValue: Ext.Date.parse('04:30:00 AM', 'h:i:s A'),
+ maxValue: Ext.Date.parse('08:00:00 AM', 'h:i:s A'),
+ renderTo: Ext.getBody()
+ });
+ *
* @constructor
- * @xtype chart
+ * Create a new TimePicker
+ * @param {Object} config The config object
+ *
+ * @xtype timepicker
*/
+Ext.define('Ext.picker.Time', {
+ extend: 'Ext.view.BoundList',
+ alias: 'widget.timepicker',
+ requires: ['Ext.data.Store', 'Ext.Date'],
- Ext.chart.Chart = Ext.extend(Ext.FlashComponent, {
- refreshBuffer: 100,
+ /**
+ * @cfg {Date} minValue
+ * The minimum time to be shown in the list of times. This must be a Date object (only the time fields
+ * will be used); no parsing of String values will be done. Defaults to undefined.
+ */
/**
- * @cfg {String} backgroundColor
- * @hide
+ * @cfg {Date} maxValue
+ * The maximum time to be shown in the list of times. This must be a Date object (only the time fields
+ * will be used); no parsing of String values will be done. Defaults to undefined.
*/
/**
- * @cfg {Object} chartStyle
- * Sets styles for this chart. This contains default styling, so modifying this property will override
- * the built in styles of the chart. Use {@link #extraStyle} to add customizations to the default styling.
+ * @cfg {Number} increment
+ * The number of minutes between each time value in the list (defaults to 15).
*/
- chartStyle: {
- padding: 10,
- animationEnabled: true,
- font: {
- name: 'Tahoma',
- color: 0x444444,
- size: 11
- },
- dataTip: {
- padding: 5,
- border: {
- color: 0x99bbe8,
- size:1
- },
- background: {
- color: 0xDAE7F6,
- alpha: .9
- },
- font: {
- name: 'Tahoma',
- color: 0x15428B,
- size: 10,
- bold: true
- }
- }
- },
+ increment: 15,
/**
- * @cfg {String} url
- * The url to load the chart from. This defaults to Ext.chart.Chart.CHART_URL, which should
- * be modified to point to the local charts resource.
- */
-
- /**
- * @cfg {Object} extraStyle
- * Contains extra styles that will be added or overwritten to the default chartStyle. Defaults to null.
- * For a detailed list of the options available, visit the YUI Charts site
- * at http://developer.yahoo.com/yui/charts/#basicstyles
- * Some of the options availabe:
- *
- * - padding - The space around the edge of the chart's contents. Padding does not increase the size of the chart.
- * - animationEnabled - A Boolean value that specifies whether marker animations are enabled or not. Enabled by default.
- * - font - An Object defining the font style to be used in the chart. Defaults to { name: 'Tahoma', color: 0x444444, size: 11 }
- *
- * - name - font name
- * - color - font color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
- * - size - font size in points (numeric portion only, ie: 11)
- * - bold - boolean
- * - italic - boolean
- * - underline - boolean
- *
- *
- * - border - An object defining the border style around the chart. The chart itself will decrease in dimensions to accomodate the border.
- *
- * - color - border color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
- * - size - border size in pixels (numeric portion only, ie: 1)
- *
- *
- * - background - An object defining the background style of the chart.
- *
- * - color - border color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
- * - image - an image URL. May be relative to the current document or absolute.
- *
- *
- * - legend - An object defining the legend style
- *
- * - display - location of the legend. Possible values are "none", "left", "right", "top", and "bottom".
- * - spacing - an image URL. May be relative to the current document or absolute.
- * - padding, border, background, font - same options as described above.
- *
- * - dataTip - An object defining the style of the data tip (tooltip).
- *
- * - padding, border, background, font - same options as described above.
- *
- * - xAxis and yAxis - An object defining the style of the style of either axis.
- *
- * - color - same option as described above.
- * - size - same option as described above.
- * - showLabels - boolean
- * - labelRotation - a value in degrees from -90 through 90. Default is zero.
- *
- * - majorGridLines and minorGridLines - An object defining the style of the style of the grid lines.
- *
- * - color, size - same options as described above.
- *
- * - zeroGridLine - An object defining the style of the style of the zero grid line.
- *
- * - color, size - same options as described above.
- *
- * - majorTicks and minorTicks - An object defining the style of the style of ticks in the chart.
- *
- * - color, size - same options as described above.
- * - length - the length of each tick in pixels extending from the axis.
- * - display - how the ticks are drawn. Possible values are "none", "inside", "outside", and "cross".
- *
- *
+ * @cfg {String} format
+ * The default time format string which can be overriden for localization support. The format must be
+ * valid according to {@link Ext.Date#parse} (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
+ * format try 'H:i' instead.
*/
- extraStyle: null,
+ format : "g:i A",
/**
- * @cfg {Object} seriesStyles
- * Contains styles to apply to the series after a refresh. Defaults to null.
+ * @hide
+ * The field in the implicitly-generated Model objects that gets displayed in the list. This is
+ * an internal field name only and is not useful to change via config.
*/
- seriesStyles: null,
+ displayField: 'disp',
/**
- * @cfg {Boolean} disableCaching
- * True to add a "cache buster" to the end of the chart url. Defaults to true for Opera and IE.
+ * @private
+ * Year, month, and day that all times will be normalized into internally.
*/
- disableCaching: Ext.isIE || Ext.isOpera,
- disableCacheParam: '_dc',
+ initDate: [2008,1,1],
- initComponent : function(){
- Ext.chart.Chart.superclass.initComponent.call(this);
- if(!this.url){
- this.url = Ext.chart.Chart.CHART_URL;
- }
- if(this.disableCaching){
- this.url = Ext.urlAppend(this.url, String.format('{0}={1}', this.disableCacheParam, new Date().getTime()));
- }
- this.addEvents(
- 'itemmouseover',
- 'itemmouseout',
- 'itemclick',
- 'itemdoubleclick',
- 'itemdragstart',
- 'itemdrag',
- 'itemdragend',
- /**
- * @event beforerefresh
- * Fires before a refresh to the chart data is called. If the beforerefresh handler returns
- * false the {@link #refresh} action will be cancelled.
- * @param {Chart} this
- */
- 'beforerefresh',
- /**
- * @event refresh
- * Fires after the chart data has been refreshed.
- * @param {Chart} this
- */
- 'refresh'
- );
- this.store = Ext.StoreMgr.lookup(this.store);
- },
+ componentCls: Ext.baseCSSPrefix + 'timepicker',
/**
- * Sets a single style value on the Chart instance.
- *
- * @param name {String} Name of the Chart style value to change.
- * @param value {Object} New value to pass to the Chart style.
+ * @hide
*/
- setStyle: function(name, value){
- this.swf.setStyle(name, Ext.encode(value));
- },
+ loadingText: '',
+
+ initComponent: function() {
+ var me = this,
+ dateUtil = Ext.Date,
+ clearTime = dateUtil.clearTime,
+ initDate = me.initDate.join('/');
+
+ // Set up absolute min and max for the entire day
+ me.absMin = clearTime(new Date(initDate));
+ me.absMax = dateUtil.add(clearTime(new Date(initDate)), 'mi', (24 * 60) - 1);
+
+ me.store = me.createStore();
+ me.updateList();
+
+ this.callParent();
+ },
/**
- * Resets all styles on the Chart instance.
- *
- * @param styles {Object} Initializer for all Chart styles.
+ * Set the {@link #minValue} and update the list of available times. This must be a Date
+ * object (only the time fields will be used); no parsing of String values will be done.
+ * @param {Date} value
*/
- setStyles: function(styles){
- this.swf.setStyles(Ext.encode(styles));
+ setMinValue: function(value) {
+ this.minValue = value;
+ this.updateList();
},
/**
- * Sets the styles on all series in the Chart.
- *
- * @param styles {Array} Initializer for all Chart series styles.
+ * Set the {@link #maxValue} and update the list of available times. This must be a Date
+ * object (only the time fields will be used); no parsing of String values will be done.
+ * @param {Date} value
*/
- setSeriesStyles: function(styles){
- this.seriesStyles = styles;
- var s = [];
- Ext.each(styles, function(style){
- s.push(Ext.encode(style));
- });
- this.swf.setSeriesStyles(s);
+ setMaxValue: function(value) {
+ this.maxValue = value;
+ this.updateList();
},
- setCategoryNames : function(names){
- this.swf.setCategoryNames(names);
+ /**
+ * @private
+ * Sets the year/month/day of the given Date object to the {@link #initDate}, so that only
+ * the time fields are significant. This makes values suitable for time comparison.
+ * @param {Date} date
+ */
+ normalizeDate: function(date) {
+ var initDate = this.initDate;
+ date.setFullYear(initDate[0], initDate[1] - 1, initDate[2]);
+ return date;
},
- setLegendRenderer : function(fn, scope){
- var chart = this;
- scope = scope || chart;
- chart.removeFnProxy(chart.legendFnName);
- chart.legendFnName = chart.createFnProxy(function(name){
- return fn.call(scope, name);
- });
- chart.swf.setLegendLabelFunction(chart.legendFnName);
- },
+ /**
+ * Update the list of available times in the list to be constrained within the
+ * {@link #minValue} and {@link #maxValue}.
+ */
+ updateList: function() {
+ var me = this,
+ min = me.normalizeDate(me.minValue || me.absMin),
+ max = me.normalizeDate(me.maxValue || me.absMax);
- setTipRenderer : function(fn, scope){
- var chart = this;
- scope = scope || chart;
- chart.removeFnProxy(chart.tipFnName);
- chart.tipFnName = chart.createFnProxy(function(item, index, series){
- var record = chart.store.getAt(index);
- return fn.call(scope, chart, record, index, series);
+ me.store.filterBy(function(record) {
+ var date = record.get('date');
+ return date >= min && date <= max;
});
- chart.swf.setDataTipFunction(chart.tipFnName);
- },
-
- setSeries : function(series){
- this.series = series;
- this.refresh();
},
/**
- * Changes the data store bound to this chart and refreshes it.
- * @param {Store} store The store to bind to this chart
+ * @private
+ * Creates the internal {@link Ext.data.Store} that contains the available times. The store
+ * is loaded with all possible times, and it is later filtered to hide those times outside
+ * the minValue/maxValue.
*/
- bindStore : function(store, initial){
- if(!initial && this.store){
- if(store !== this.store && this.store.autoDestroy){
- this.store.destroy();
- }else{
- this.store.un("datachanged", this.refresh, this);
- this.store.un("add", this.delayRefresh, this);
- this.store.un("remove", this.delayRefresh, this);
- this.store.un("update", this.delayRefresh, this);
- this.store.un("clear", this.refresh, this);
- }
- }
- if(store){
- store = Ext.StoreMgr.lookup(store);
- store.on({
- scope: this,
- datachanged: this.refresh,
- add: this.delayRefresh,
- remove: this.delayRefresh,
- update: this.delayRefresh,
- clear: this.refresh
+ createStore: function() {
+ var me = this,
+ utilDate = Ext.Date,
+ times = [],
+ min = me.absMin,
+ max = me.absMax;
+
+ while(min <= max){
+ times.push({
+ disp: utilDate.dateFormat(min, me.format),
+ date: min
});
+ min = utilDate.add(min, 'mi', me.increment);
}
- this.store = store;
- if(store && !initial){
- this.refresh();
- }
- },
- onSwfReady : function(isReset){
- Ext.chart.Chart.superclass.onSwfReady.call(this, isReset);
- var ref;
- this.swf.setType(this.type);
+ return Ext.create('Ext.data.Store', {
+ fields: ['disp', 'date'],
+ data: times
+ });
+ }
- if(this.chartStyle){
- this.setStyles(Ext.apply({}, this.extraStyle, this.chartStyle));
- }
+});
- if(this.categoryNames){
- this.setCategoryNames(this.categoryNames);
- }
+/**
+ * @class Ext.form.field.Time
+ * @extends Ext.form.field.Picker
+ * Provides a time input field with a time dropdown and automatic time validation.
+ * This field recognizes and uses JavaScript Date objects as its main {@link #value} type (only the time
+ * portion of the date is used; the month/day/year are ignored). In addition, it recognizes string values which
+ * are parsed according to the {@link #format} and/or {@link #altFormats} configs. These may be reconfigured
+ * to use time formats appropriate for the user's locale.
+ * The field may be limited to a certain range of times by using the {@link #minValue} and {@link #maxValue}
+ * configs, and the interval between time options in the dropdown can be changed with the {@link #increment} config.
+ * {@img Ext.form.Time/Ext.form.Time.png Ext.form.Time component}
+ * Example usage:
+ *
+ Ext.create('Ext.form.Panel', {
+ title: 'Time Card',
+ width: 300,
+ bodyPadding: 10,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'timefield',
+ name: 'in',
+ fieldLabel: 'Time In',
+ minValue: '6:00 AM',
+ maxValue: '8:00 PM',
+ increment: 30,
+ anchor: '100%'
+ }, {
+ xtype: 'timefield',
+ name: 'out',
+ fieldLabel: 'Time Out',
+ minValue: '6:00 AM',
+ maxValue: '8:00 PM',
+ increment: 30,
+ anchor: '100%'
+ }]
+ });
+
+ * @constructor
+ * Create a new Time field
+ * @param {Object} config
+ * @xtype timefield
+ */
+Ext.define('Ext.form.field.Time', {
+ extend:'Ext.form.field.Picker',
+ alias: 'widget.timefield',
+ requires: ['Ext.form.field.Date', 'Ext.picker.Time', 'Ext.view.BoundListKeyNav', 'Ext.Date'],
+ alternateClassName: ['Ext.form.TimeField', 'Ext.form.Time'],
- if(this.tipRenderer){
- ref = this.getFunctionRef(this.tipRenderer);
- this.setTipRenderer(ref.fn, ref.scope);
- }
- if(this.legendRenderer){
- ref = this.getFunctionRef(this.legendRenderer);
- this.setLegendRenderer(ref.fn, ref.scope);
- }
- if(!isReset){
- this.bindStore(this.store, true);
- }
- this.refresh.defer(10, 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 'x-form-time-trigger' for the Time field trigger.
+ */
+ triggerCls: Ext.baseCSSPrefix + 'form-time-trigger',
- delayRefresh : function(){
- if(!this.refreshTask){
- this.refreshTask = new Ext.util.DelayedTask(this.refresh, this);
- }
- this.refreshTask.delay(this.refreshBuffer);
- },
+ /**
+ * @cfg {Date/String} minValue
+ * The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
+ * time in a valid format -- see {@link #format} and {@link #altFormats} (defaults to undefined).
+ */
- refresh : function(){
- if(this.fireEvent('beforerefresh', this) !== false){
- var styleChanged = false;
- // convert the store data into something YUI charts can understand
- var data = [], rs = this.store.data.items;
- for(var j = 0, len = rs.length; j < len; j++){
- data[j] = rs[j].data;
- }
- //make a copy of the series definitions so that we aren't
- //editing them directly.
- var dataProvider = [];
- var seriesCount = 0;
- var currentSeries = null;
- var i = 0;
- if(this.series){
- seriesCount = this.series.length;
- for(i = 0; i < seriesCount; i++){
- currentSeries = this.series[i];
- var clonedSeries = {};
- for(var prop in currentSeries){
- if(prop == "style" && currentSeries.style !== null){
- clonedSeries.style = Ext.encode(currentSeries.style);
- styleChanged = true;
- //we don't want to modify the styles again next time
- //so null out the style property.
- // this causes issues
- // currentSeries.style = null;
- } else{
- clonedSeries[prop] = currentSeries[prop];
- }
- }
- dataProvider.push(clonedSeries);
- }
- }
+ /**
+ * @cfg {Date/String} maxValue
+ * The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
+ * time in a valid format -- see {@link #format} and {@link #altFormats} (defaults to undefined).
+ */
- if(seriesCount > 0){
- for(i = 0; i < seriesCount; i++){
- currentSeries = dataProvider[i];
- if(!currentSeries.type){
- currentSeries.type = this.type;
- }
- currentSeries.dataProvider = data;
- }
- } else{
- dataProvider.push({type: this.type, dataProvider: data});
- }
- this.swf.setDataProvider(dataProvider);
- if(this.seriesStyles){
- this.setSeriesStyles(this.seriesStyles);
- }
- this.fireEvent('refresh', this);
- }
- },
+ /**
+ * @cfg {String} minText
+ * The error text to display when the entered time is before {@link #minValue} (defaults to
+ * 'The time in this field must be equal to or after {0}').
+ */
+ minText : "The time in this field must be equal to or after {0}",
- // private
- createFnProxy : function(fn){
- var fnName = 'extFnProxy' + (++Ext.chart.Chart.PROXY_FN_ID);
- Ext.chart.Chart.proxyFunction[fnName] = fn;
- return 'Ext.chart.Chart.proxyFunction.' + fnName;
- },
+ /**
+ * @cfg {String} maxText
+ * The error text to display when the entered time is after {@link #maxValue} (defaults to
+ * 'The time in this field must be equal to or before {0}').
+ */
+ maxText : "The time in this field must be equal to or before {0}",
- // private
- removeFnProxy : function(fn){
- if(!Ext.isEmpty(fn)){
- fn = fn.replace('Ext.chart.Chart.proxyFunction.', '');
- delete Ext.chart.Chart.proxyFunction[fn];
- }
- },
+ /**
+ * @cfg {String} invalidText
+ * The error text to display when the time in the field is invalid (defaults to
+ * '{value} is not a valid time').
+ */
+ invalidText : "{0} is not a valid time",
- // private
- getFunctionRef : function(val){
- if(Ext.isFunction(val)){
- return {
- fn: val,
- scope: this
- };
- }else{
- return {
- fn: val.fn,
- scope: val.scope || this
- }
- }
- },
+ /**
+ * @cfg {String} format
+ * The default time format string which can be overriden for localization support. The format must be
+ * valid according to {@link Ext.Date#parse} (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
+ * format try 'H:i' instead.
+ */
+ format : "g:i A",
- // private
- onDestroy: function(){
- if (this.refreshTask && this.refreshTask.cancel){
- this.refreshTask.cancel();
- }
- Ext.chart.Chart.superclass.onDestroy.call(this);
- this.bindStore(null);
- this.removeFnProxy(this.tipFnName);
- this.removeFnProxy(this.legendFnName);
- }
-});
-Ext.reg('chart', Ext.chart.Chart);
-Ext.chart.Chart.PROXY_FN_ID = 0;
-Ext.chart.Chart.proxyFunction = {};
+ /**
+ * @cfg {String} submitFormat The date format string which will be submitted to the server.
+ * The format must be valid according to {@link Ext.Date#parse} (defaults to {@link #format}).
+ */
-/**
- * Sets the url to load the chart from. This should be set to a local resource.
- * @static
- * @type String
- */
-Ext.chart.Chart.CHART_URL = 'http:/' + '/yui.yahooapis.com/2.8.0/build/charts/assets/charts.swf';
+ /**
+ * @cfg {String} altFormats
+ * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
+ * format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A').
+ */
+ altFormats : "g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A",
-/**
- * @class Ext.chart.PieChart
- * @extends Ext.chart.Chart
- * @constructor
- * @xtype piechart
- */
-Ext.chart.PieChart = Ext.extend(Ext.chart.Chart, {
- type: 'pie',
+ /**
+ * @cfg {Number} increment
+ * The number of minutes between each time value in the list (defaults to 15).
+ */
+ increment: 15,
- onSwfReady : function(isReset){
- Ext.chart.PieChart.superclass.onSwfReady.call(this, isReset);
+ /**
+ * @cfg {Number} pickerMaxHeight
+ * The maximum height of the {@link Ext.picker.Time} dropdown. Defaults to 300.
+ */
+ pickerMaxHeight: 300,
- this.setDataField(this.dataField);
- this.setCategoryField(this.categoryField);
- },
+ /**
+ * @cfg {Boolean} selectOnTab
+ * Whether the Tab key should select the currently highlighted item. Defaults to true.
+ */
+ selectOnTab: true,
- setDataField : function(field){
- this.dataField = field;
- this.swf.setDataField(field);
- },
+ /**
+ * @private
+ * This is the date to use when generating time values in the absence of either minValue
+ * or maxValue. Using the current date causes DST issues on DST boundary dates, so this is an
+ * arbitrary "safe" date that can be any date aside from DST boundary dates.
+ */
+ initDate: '1/1/2008',
+ initDateFormat: 'j/n/Y',
- setCategoryField : function(field){
- this.categoryField = field;
- this.swf.setCategoryField(field);
- }
-});
-Ext.reg('piechart', Ext.chart.PieChart);
-/**
- * @class Ext.chart.CartesianChart
- * @extends Ext.chart.Chart
- * @constructor
- * @xtype cartesianchart
- */
-Ext.chart.CartesianChart = Ext.extend(Ext.chart.Chart, {
- onSwfReady : function(isReset){
- Ext.chart.CartesianChart.superclass.onSwfReady.call(this, isReset);
- this.labelFn = [];
- if(this.xField){
- this.setXField(this.xField);
- }
- if(this.yField){
- this.setYField(this.yField);
- }
- if(this.xAxis){
- this.setXAxis(this.xAxis);
- }
- if(this.xAxes){
- this.setXAxes(this.xAxes);
- }
- if(this.yAxis){
- this.setYAxis(this.yAxis);
- }
- if(this.yAxes){
- this.setYAxes(this.yAxes);
+ initComponent: function() {
+ var me = this,
+ min = me.minValue,
+ max = me.maxValue;
+ if (min) {
+ me.setMinValue(min);
}
- if(Ext.isDefined(this.constrainViewport)){
- this.swf.setConstrainViewport(this.constrainViewport);
+ if (max) {
+ me.setMaxValue(max);
}
+ this.callParent();
},
- setXField : function(value){
- this.xField = value;
- this.swf.setHorizontalField(value);
- },
+ initValue: function() {
+ var me = this,
+ value = me.value;
- setYField : function(value){
- this.yField = value;
- this.swf.setVerticalField(value);
- },
+ // If a String value was supplied, try to convert it to a proper Date object
+ if (Ext.isString(value)) {
+ me.value = me.rawToValue(value);
+ }
- setXAxis : function(value){
- this.xAxis = this.createAxis('xAxis', value);
- this.swf.setHorizontalAxis(this.xAxis);
+ me.callParent();
},
- setXAxes : function(value){
- var axis;
- for(var i = 0; i < value.length; i++) {
- axis = this.createAxis('xAxis' + i, value[i]);
- this.swf.setHorizontalAxis(axis);
+ /**
+ * Replaces any existing {@link #minValue} with the new time and refreshes the picker's range.
+ * @param {Date/String} value The minimum time that can be selected
+ */
+ setMinValue: function(value) {
+ var me = this,
+ picker = me.picker;
+ me.setLimit(value, true);
+ if (picker) {
+ picker.setMinValue(me.minValue);
}
},
- setYAxis : function(value){
- this.yAxis = this.createAxis('yAxis', value);
- this.swf.setVerticalAxis(this.yAxis);
- },
-
- setYAxes : function(value){
- var axis;
- for(var i = 0; i < value.length; i++) {
- axis = this.createAxis('yAxis' + i, value[i]);
- this.swf.setVerticalAxis(axis);
+ /**
+ * Replaces any existing {@link #maxValue} with the new time and refreshes the picker's range.
+ * @param {Date/String} value The maximum time that can be selected
+ */
+ setMaxValue: function(value) {
+ var me = this,
+ picker = me.picker;
+ me.setLimit(value, false);
+ if (picker) {
+ picker.setMaxValue(me.maxValue);
}
},
- createAxis : function(axis, value){
- var o = Ext.apply({}, value),
- ref,
- old;
-
- if(this[axis]){
- old = this[axis].labelFunction;
- this.removeFnProxy(old);
- this.labelFn.remove(old);
+ /**
+ * @private
+ * Updates either the min or max value. Converts the user's value into a Date object whose
+ * year/month/day is set to the {@link #initDate} so that only the time fields are significant.
+ */
+ setLimit: function(value, isMin) {
+ var me = this,
+ d, val;
+ if (Ext.isString(value)) {
+ d = me.parseDate(value);
}
- if(o.labelRenderer){
- ref = this.getFunctionRef(o.labelRenderer);
- o.labelFunction = this.createFnProxy(function(v){
- return ref.fn.call(ref.scope, v);
- });
- delete o.labelRenderer;
- this.labelFn.push(o.labelFunction);
+ else if (Ext.isDate(value)) {
+ d = value;
}
- if(axis.indexOf('xAxis') > -1 && o.position == 'left'){
- o.position = 'bottom';
+ if (d) {
+ val = Ext.Date.clearTime(new Date(me.initDate));
+ val.setHours(d.getHours(), d.getMinutes(), d.getSeconds(), d.getMilliseconds());
+ me[isMin ? 'minValue' : 'maxValue'] = val;
}
- return o;
},
- onDestroy : function(){
- Ext.chart.CartesianChart.superclass.onDestroy.call(this);
- Ext.each(this.labelFn, function(fn){
- this.removeFnProxy(fn);
- }, this);
- }
-});
-Ext.reg('cartesianchart', Ext.chart.CartesianChart);
-
-/**
- * @class Ext.chart.LineChart
- * @extends Ext.chart.CartesianChart
- * @constructor
- * @xtype linechart
- */
-Ext.chart.LineChart = Ext.extend(Ext.chart.CartesianChart, {
- type: 'line'
-});
-Ext.reg('linechart', Ext.chart.LineChart);
-
-/**
- * @class Ext.chart.ColumnChart
- * @extends Ext.chart.CartesianChart
- * @constructor
- * @xtype columnchart
- */
-Ext.chart.ColumnChart = Ext.extend(Ext.chart.CartesianChart, {
- type: 'column'
-});
-Ext.reg('columnchart', Ext.chart.ColumnChart);
-
-/**
- * @class Ext.chart.StackedColumnChart
- * @extends Ext.chart.CartesianChart
- * @constructor
- * @xtype stackedcolumnchart
- */
-Ext.chart.StackedColumnChart = Ext.extend(Ext.chart.CartesianChart, {
- type: 'stackcolumn'
-});
-Ext.reg('stackedcolumnchart', Ext.chart.StackedColumnChart);
-
-/**
- * @class Ext.chart.BarChart
- * @extends Ext.chart.CartesianChart
- * @constructor
- * @xtype barchart
- */
-Ext.chart.BarChart = Ext.extend(Ext.chart.CartesianChart, {
- type: 'bar'
-});
-Ext.reg('barchart', Ext.chart.BarChart);
-
-/**
- * @class Ext.chart.StackedBarChart
- * @extends Ext.chart.CartesianChart
- * @constructor
- * @xtype stackedbarchart
- */
-Ext.chart.StackedBarChart = Ext.extend(Ext.chart.CartesianChart, {
- type: 'stackbar'
-});
-Ext.reg('stackedbarchart', Ext.chart.StackedBarChart);
-
-
+ rawToValue: function(rawValue) {
+ return this.parseDate(rawValue) || rawValue || null;
+ },
-/**
- * @class Ext.chart.Axis
- * Defines a CartesianChart's vertical or horizontal axis.
- * @constructor
- */
-Ext.chart.Axis = function(config){
- Ext.apply(this, config);
-};
+ valueToRaw: function(value) {
+ return this.formatDate(this.parseDate(value));
+ },
-Ext.chart.Axis.prototype =
-{
/**
- * The type of axis.
- *
- * @property type
- * @type String
+ * Runs all of Time's validations and returns an array of any errors. Note that this first
+ * runs Text's validations, so the returned array is an amalgamation of all field errors.
+ * The additional validation checks are testing that the time format is valid, that the chosen
+ * time is within the {@link #minValue} and {@link #maxValue} constraints set.
+ * @param {Mixed} value The value to get errors for (defaults to the current field value)
+ * @return {Array} All validation errors for this field
*/
- type: null,
+ getErrors: function(value) {
+ var me = this,
+ format = Ext.String.format,
+ errors = me.callParent(arguments),
+ minValue = me.minValue,
+ maxValue = me.maxValue,
+ date;
- /**
- * The direction in which the axis is drawn. May be "horizontal" or "vertical".
- *
- * @property orientation
- * @type String
- */
- orientation: "horizontal",
+ value = me.formatDate(value || me.processRawValue(me.getRawValue()));
- /**
- * If true, the items on the axis will be drawn in opposite direction.
- *
- * @property reverse
- * @type Boolean
- */
- reverse: false,
+ if (value === null || value.length < 1) { // if it's blank and textfield didn't flag it then it's valid
+ return errors;
+ }
- /**
- * A string reference to the globally-accessible function that may be called to
- * determine each of the label values for this axis.
- *
- * @property labelFunction
- * @type String
- */
- labelFunction: null,
+ date = me.parseDate(value);
+ if (!date) {
+ errors.push(format(me.invalidText, value, me.format));
+ return errors;
+ }
- /**
- * If true, labels that overlap previously drawn labels on the axis will be hidden.
- *
- * @property hideOverlappingLabels
- * @type Boolean
- */
- hideOverlappingLabels: true,
+ if (minValue && date < minValue) {
+ errors.push(format(me.minText, me.formatDate(minValue)));
+ }
- /**
- * The space, in pixels, between labels on an axis.
- *
- * @property labelSpacing
- * @type Number
- */
- labelSpacing: 2
-};
+ if (maxValue && date > maxValue) {
+ errors.push(format(me.maxText, me.formatDate(maxValue)));
+ }
-/**
- * @class Ext.chart.NumericAxis
- * @extends Ext.chart.Axis
- * A type of axis whose units are measured in numeric values.
- * @constructor
- */
-Ext.chart.NumericAxis = Ext.extend(Ext.chart.Axis, {
- type: "numeric",
+ return errors;
+ },
- /**
- * The minimum value drawn by the axis. If not set explicitly, the axis
- * minimum will be calculated automatically.
- *
- * @property minimum
- * @type Number
- */
- minimum: NaN,
+ formatDate: function() {
+ return Ext.form.field.Date.prototype.formatDate.apply(this, arguments);
+ },
/**
- * The maximum value drawn by the axis. If not set explicitly, the axis
- * maximum will be calculated automatically.
- *
- * @property maximum
- * @type Number
+ * @private
+ * Parses an input value into a valid Date object.
+ * @param {String/Date} value
*/
- maximum: NaN,
+ parseDate: function(value) {
+ if (!value || Ext.isDate(value)) {
+ return value;
+ }
- /**
- * The spacing between major intervals on this axis.
- *
- * @property majorUnit
- * @type Number
- */
- majorUnit: NaN,
+ var me = this,
+ val = me.safeParse(value, me.format),
+ altFormats = me.altFormats,
+ altFormatsArray = me.altFormatsArray,
+ i = 0,
+ len;
- /**
- * The spacing between minor intervals on this axis.
- *
- * @property minorUnit
- * @type Number
- */
- minorUnit: NaN,
+ if (!val && altFormats) {
+ altFormatsArray = altFormatsArray || altFormats.split('|');
+ len = altFormatsArray.length;
+ for (; i < len && !val; ++i) {
+ val = me.safeParse(value, altFormatsArray[i]);
+ }
+ }
+ return val;
+ },
- /**
- * If true, the labels, ticks, gridlines, and other objects will snap to the
- * nearest major or minor unit. If false, their position will be based on
- * the minimum value.
- *
- * @property snapToUnits
- * @type Boolean
- */
- snapToUnits: true,
+ safeParse: function(value, format){
+ var me = this,
+ utilDate = Ext.Date,
+ parsedDate,
+ result = null;
- /**
- * If true, and the bounds are calculated automatically, either the minimum
- * or maximum will be set to zero.
- *
- * @property alwaysShowZero
- * @type Boolean
- */
- alwaysShowZero: true,
+ if (utilDate.formatContainsDateInfo(format)) {
+ // assume we've been given a full date
+ result = utilDate.parse(value, format);
+ } else {
+ // Use our initial safe date
+ parsedDate = utilDate.parse(me.initDate + ' ' + value, me.initDateFormat + ' ' + format);
+ if (parsedDate) {
+ result = parsedDate;
+ }
+ }
+ return result;
+ },
- /**
- * The scaling algorithm to use on this axis. May be "linear" or
- * "logarithmic".
- *
- * @property scale
- * @type String
- */
- scale: "linear",
+ // @private
+ getSubmitValue: function() {
+ var me = this,
+ format = me.submitFormat || me.format,
+ value = me.getValue();
- /**
- * Indicates whether to round the major unit.
- *
- * @property roundMajorUnit
- * @type Boolean
- */
- roundMajorUnit: true,
+ return value ? Ext.Date.format(value, format) : null;
+ },
/**
- * Indicates whether to factor in the size of the labels when calculating a
- * major unit.
- *
- * @property calculateByLabelSize
- * @type Boolean
+ * @private
+ * Creates the {@link Ext.picker.Time}
*/
- calculateByLabelSize: true,
+ createPicker: function() {
+ var me = this,
+ picker = Ext.create('Ext.picker.Time', {
+ selModel: {
+ mode: 'SINGLE'
+ },
+ floating: true,
+ hidden: true,
+ minValue: me.minValue,
+ maxValue: me.maxValue,
+ increment: me.increment,
+ format: me.format,
+ ownerCt: this.ownerCt,
+ renderTo: document.body,
+ maxHeight: me.pickerMaxHeight,
+ focusOnToFront: false
+ });
+
+ me.mon(picker.getSelectionModel(), {
+ selectionchange: me.onListSelect,
+ scope: me
+ });
+
+ return picker;
+ },
/**
- * Indicates the position of the axis relative to the chart
- *
- * @property position
- * @type String
+ * @private
+ * Enables the key nav for the Time picker when it is expanded.
+ * TODO this is largely the same logic as ComboBox, should factor out.
*/
- position: 'left',
+ onExpand: function() {
+ var me = this,
+ keyNav = me.pickerKeyNav,
+ selectOnTab = me.selectOnTab,
+ picker = me.getPicker(),
+ lastSelected = picker.getSelectionModel().lastSelected,
+ itemNode;
+
+ if (!keyNav) {
+ keyNav = me.pickerKeyNav = Ext.create('Ext.view.BoundListKeyNav', this.inputEl, {
+ boundList: picker,
+ forceKeyDown: true,
+ tab: function(e) {
+ if (selectOnTab) {
+ this.selectHighlighted(e);
+ me.triggerBlur();
+ }
+ // Tab key event is allowed to propagate to field
+ return true;
+ }
+ });
+ // stop tab monitoring from Ext.form.field.Trigger so it doesn't short-circuit selectOnTab
+ if (selectOnTab) {
+ me.ignoreMonitorTab = true;
+ }
+ }
+ Ext.defer(keyNav.enable, 1, keyNav); //wait a bit so it doesn't react to the down arrow opening the picker
+
+ // Highlight the last selected item and scroll it into view
+ if (lastSelected) {
+ itemNode = picker.getNode(lastSelected);
+ if (itemNode) {
+ picker.highlightItem(itemNode);
+ picker.el.scrollChildIntoView(itemNode, false);
+ }
+ }
+ },
/**
- * Indicates whether to extend maximum beyond data's maximum to the nearest
- * majorUnit.
- *
- * @property adjustMaximumByMajorUnit
- * @type Boolean
+ * @private
+ * Disables the key nav for the Time picker when it is collapsed.
*/
- adjustMaximumByMajorUnit: true,
+ onCollapse: function() {
+ var me = this,
+ keyNav = me.pickerKeyNav;
+ if (keyNav) {
+ keyNav.disable();
+ me.ignoreMonitorTab = false;
+ }
+ },
/**
- * Indicates whether to extend the minimum beyond data's minimum to the
- * nearest majorUnit.
- *
- * @property adjustMinimumByMajorUnit
- * @type Boolean
+ * @private
+ * Handles a time being selected from the Time picker.
*/
- adjustMinimumByMajorUnit: true
-
+ onListSelect: function(list, recordArray) {
+ var me = this,
+ record = recordArray[0],
+ val = record ? record.get('date') : null;
+ me.setValue(val);
+ me.fireEvent('select', me, val);
+ me.picker.clearHighlight();
+ me.collapse();
+ me.inputEl.focus();
+ }
});
+
/**
- * @class Ext.chart.TimeAxis
- * @extends Ext.chart.Axis
- * A type of axis whose units are measured in time-based values.
- * @constructor
+ * @class Ext.grid.CellEditor
+ * @extends Ext.Editor
+ * Internal utility class that provides default configuration for cell editing.
+ * @ignore
*/
-Ext.chart.TimeAxis = Ext.extend(Ext.chart.Axis, {
- type: "time",
-
+Ext.define('Ext.grid.CellEditor', {
+ extend: 'Ext.Editor',
+ constructor: function(config) {
+ if (config.field) {
+ config.field.monitorTab = false;
+ }
+ config.autoSize = {
+ width: 'boundEl'
+ };
+ this.callParent(arguments);
+ },
+
/**
- * The minimum value drawn by the axis. If not set explicitly, the axis
- * minimum will be calculated automatically.
- *
- * @property minimum
- * @type Date
+ * @private
+ * Hide the grid cell when editor is shown.
*/
- minimum: null,
-
+ onShow: function() {
+ var first = this.boundEl.first();
+ if (first) {
+ first.hide();
+ }
+ this.callParent(arguments);
+ },
+
/**
- * The maximum value drawn by the axis. If not set explicitly, the axis
- * maximum will be calculated automatically.
- *
- * @property maximum
- * @type Number
+ * @private
+ * Show grid cell when editor is hidden.
*/
- maximum: null,
-
+ onHide: function() {
+ var first = this.boundEl.first();
+ if (first) {
+ first.show();
+ }
+ this.callParent(arguments);
+ },
+
/**
- * The spacing between major intervals on this axis.
- *
- * @property majorUnit
- * @type Number
+ * @private
+ * Fix checkbox blur when it is clicked.
*/
- majorUnit: NaN,
-
+ afterRender: function() {
+ this.callParent(arguments);
+ var field = this.field;
+ if (field.isXType('checkboxfield')) {
+ field.mon(field.inputEl, 'mousedown', this.onCheckBoxMouseDown, this);
+ field.mon(field.inputEl, 'click', this.onCheckBoxClick, this);
+ }
+ },
+
/**
- * The time unit used by the majorUnit.
- *
- * @property majorTimeUnit
- * @type String
+ * @private
+ * Because when checkbox is clicked it loses focus completeEdit is bypassed.
*/
- majorTimeUnit: null,
-
+ onCheckBoxMouseDown: function() {
+ this.completeEdit = Ext.emptyFn;
+ },
+
/**
- * The spacing between minor intervals on this axis.
- *
- * @property majorUnit
- * @type Number
+ * @private
+ * Restore checkbox focus and completeEdit method.
*/
- minorUnit: NaN,
+ onCheckBoxClick: function() {
+ delete this.completeEdit;
+ this.field.focus(false, 10);
+ },
+
+ alignment: "tl-tl",
+ hideEl : false,
+ cls: Ext.baseCSSPrefix + "small-editor " + Ext.baseCSSPrefix + "grid-editor",
+ shim: false,
+ shadow: false
+});
+/**
+ * @class Ext.grid.ColumnLayout
+ * @extends Ext.layout.container.HBox
+ * @private
+ *
+ * This class is used only by the grid's HeaderContainer docked child.
+ *
+ * This class adds the ability to shrink the vertical size of the inner container element back if a grouped
+ * column header has all its child columns dragged out, and the whole HeaderContainer needs to shrink back down.
+ *
+ * It also enforces the grid's HeaderContainer's forceFit config by, after every calaculateChildBoxes call, converting
+ * all pixel widths into flex values, so that propertions are maintained upon width change of the grid.
+ *
+ * Also, after every layout, after all headers have attained their 'stretchmax' height, it goes through and calls
+ * setPadding
on the columns so that they lay out correctly. TODO: implement a ColumnHeader component
+ * layout which takes responsibility for this, and will run upon resize.
+ */
+Ext.define('Ext.grid.ColumnLayout', {
+ extend: 'Ext.layout.container.HBox',
+ alias: 'layout.gridcolumn',
+ type : 'column',
- /**
- * The time unit used by the minorUnit.
- *
- * @property majorTimeUnit
- * @type String
- */
- minorTimeUnit: null,
+ // Height-stretched innerCt must be able to revert back to unstretched height
+ clearInnerCtOnLayout: false,
- /**
- * If true, the labels, ticks, gridlines, and other objects will snap to the
- * nearest major or minor unit. If false, their position will be based on
- * the minimum value.
- *
- * @property snapToUnits
- * @type Boolean
- */
- snapToUnits: true,
+ constructor: function() {
+ var me = this;
+ me.callParent(arguments);
+ if (!Ext.isDefined(me.availableSpaceOffset)) {
+ me.availableSpaceOffset = (Ext.getScrollBarWidth() - 2);
+ }
+ },
- /**
- * Series that are stackable will only stack when this value is set to true.
- *
- * @property stackingEnabled
- * @type Boolean
- */
- stackingEnabled: false,
+ beforeLayout: function() {
+ var me = this,
+ i = 0,
+ items = me.getLayoutItems(),
+ len = items.length,
+ item, returnValue;
- /**
- * Indicates whether to factor in the size of the labels when calculating a
- * major unit.
- *
- * @property calculateByLabelSize
- * @type Boolean
- */
- calculateByLabelSize: true
+ returnValue = me.callParent(arguments);
-});
+ // Size to a sane minimum height before possibly being stretched to accommodate grouped headers
+ me.innerCt.setHeight(23);
-/**
- * @class Ext.chart.CategoryAxis
- * @extends Ext.chart.Axis
- * A type of axis that displays items in categories.
- * @constructor
- */
-Ext.chart.CategoryAxis = Ext.extend(Ext.chart.Axis, {
- type: "category",
+ // Unstretch child items before the layout which stretches them.
+ if (me.align == 'stretchmax') {
+ for (; i < len; i++) {
+ item = items[i];
+ item.el.setStyle({
+ height: 'auto'
+ });
+ item.titleContainer.setStyle({
+ height: 'auto',
+ paddingTop: '0'
+ });
+ if (item.componentLayout && item.componentLayout.lastComponentSize) {
+ item.componentLayout.lastComponentSize.height = item.el.dom.offsetHeight;
+ }
+ }
+ }
+ return returnValue;
+ },
- /**
- * A list of category names to display along this axis.
- *
- * @property categoryNames
- * @type Array
- */
- categoryNames: null,
+ // Override to enforce the forceFit config.
+ calculateChildBoxes: function(visibleItems, targetSize) {
+ var me = this,
+ calculations = me.callParent(arguments),
+ boxes = calculations.boxes,
+ metaData = calculations.meta,
+ len = boxes.length, i = 0, box, item;
- /**
- * Indicates whether or not to calculate the number of categories (ticks and
- * labels) when there is not enough room to display all labels on the axis.
- * If set to true, the axis will determine the number of categories to plot.
- * If not, all categories will be plotted.
- *
- * @property calculateCategoryCount
- * @type Boolean
- */
- calculateCategoryCount: false
+ if (targetSize.width && !me.isColumn) {
+ // If configured forceFit then all columns will be flexed
+ if (me.owner.forceFit) {
-});
+ for (; i < len; i++) {
+ box = boxes[i];
+ item = box.component;
-/**
- * @class Ext.chart.Series
- * Series class for the charts widget.
- * @constructor
- */
-Ext.chart.Series = function(config) { Ext.apply(this, config); };
+ // Set a sane minWidth for the Box layout to be able to squeeze flexed Headers down to.
+ item.minWidth = Ext.grid.plugin.HeaderResizer.prototype.minColWidth;
-Ext.chart.Series.prototype =
-{
- /**
- * The type of series.
- *
- * @property type
- * @type String
- */
- type: null,
+ // For forceFit, just use allocated width as the flex value, and the proportions
+ // will end up the same whatever HeaderContainer width they are being forced into.
+ item.flex = box.width;
+ }
- /**
- * The human-readable name of the series.
- *
- * @property displayName
- * @type String
- */
- displayName: null
-};
+ // Recalculate based upon all columns now being flexed instead of sized.
+ calculations = me.callParent(arguments);
+ }
+ else if (metaData.tooNarrow) {
+ targetSize.width = metaData.desiredSize;
+ }
+ }
-/**
- * @class Ext.chart.CartesianSeries
- * @extends Ext.chart.Series
- * CartesianSeries class for the charts widget.
- * @constructor
- */
-Ext.chart.CartesianSeries = Ext.extend(Ext.chart.Series, {
- /**
- * The field used to access the x-axis value from the items from the data
- * source.
- *
- * @property xField
- * @type String
- */
- xField: null,
+ return calculations;
+ },
- /**
- * The field used to access the y-axis value from the items from the data
- * source.
- *
- * @property yField
- * @type String
- */
- yField: null,
+ afterLayout: function() {
+ var me = this,
+ i = 0,
+ items = me.getLayoutItems(),
+ len = items.length;
- /**
- * False to not show this series in the legend. Defaults to true.
- *
- * @property showInLegend
- * @type Boolean
- */
- showInLegend: true,
+ me.callParent(arguments);
- /**
- * Indicates which axis the series will bind to
- *
- * @property axis
- * @type String
- */
- axis: 'primary'
-});
+ // Set up padding in items
+ if (me.align == 'stretchmax') {
+ for (; i < len; i++) {
+ items[i].setPadding();
+ }
+ }
+ },
-/**
- * @class Ext.chart.ColumnSeries
- * @extends Ext.chart.CartesianSeries
- * ColumnSeries class for the charts widget.
- * @constructor
- */
-Ext.chart.ColumnSeries = Ext.extend(Ext.chart.CartesianSeries, {
- type: "column"
-});
+ // FIX: when flexing we actually don't have enough space as we would
+ // typically because of the scrollOffset on the GridView, must reserve this
+ updateInnerCtSize: function(tSize, calcs) {
+ var me = this,
+ extra = 0;
+
+ // Columns must not account for scroll offset
+ if (!me.isColumn && calcs.meta.tooNarrow) {
+ if (
+ Ext.isWebKit ||
+ Ext.isGecko ||
+ (Ext.isIEQuirks && (Ext.isIE6 || Ext.isIE7 || Ext.isIE8))
+ ) {
+ extra = 1;
+ // IE6-8 not quirks
+ } else if (Ext.isIE6 || Ext.isIE7 || Ext.isIE8) {
+ extra = 2;
+ }
+
+ // this is the 1px accounted for in the Scroller when subtracting 1px.
+ extra++;
+ tSize.width = calcs.meta.desiredSize + (me.reserveOffset ? me.availableSpaceOffset : 0) + extra;
+ }
+ return me.callParent(arguments);
+ },
-/**
- * @class Ext.chart.LineSeries
- * @extends Ext.chart.CartesianSeries
- * LineSeries class for the charts widget.
- * @constructor
- */
-Ext.chart.LineSeries = Ext.extend(Ext.chart.CartesianSeries, {
- type: "line"
+ doOwnerCtLayouts: function() {
+ var ownerCt = this.owner.ownerCt;
+ if (!ownerCt.componentLayout.layoutBusy) {
+ ownerCt.doComponentLayout();
+ }
+ }
});
-
/**
- * @class Ext.chart.BarSeries
- * @extends Ext.chart.CartesianSeries
- * BarSeries class for the charts widget.
- * @constructor
+ * @class Ext.grid.LockingView
+ * This class is used internally to provide a single interface when using
+ * a locking grid. Internally, the locking grid creates 2 separate grids,
+ * so this class is used to map calls appropriately.
+ * @ignore
*/
-Ext.chart.BarSeries = Ext.extend(Ext.chart.CartesianSeries, {
- type: "bar"
+Ext.define('Ext.grid.LockingView', {
+
+ mixins: {
+ observable: 'Ext.util.Observable'
+ },
+
+ eventRelayRe: /^(beforeitem|beforecontainer|item|container|cell)/,
+
+ constructor: function(config){
+ var me = this,
+ eventNames = [],
+ eventRe = me.eventRelayRe,
+ locked = config.locked.getView(),
+ normal = config.normal.getView(),
+ events,
+ event;
+
+ Ext.apply(me, {
+ lockedView: locked,
+ normalView: normal,
+ lockedGrid: config.locked,
+ normalGrid: config.normal,
+ panel: config.panel
+ });
+ me.mixins.observable.constructor.call(me, config);
+
+ // relay events
+ events = locked.events;
+ for (event in events) {
+ if (events.hasOwnProperty(event) && eventRe.test(event)) {
+ eventNames.push(event);
+ }
+ }
+ me.relayEvents(locked, eventNames);
+ me.relayEvents(normal, eventNames);
+
+ normal.on({
+ scope: me,
+ itemmouseleave: me.onItemMouseLeave,
+ itemmouseenter: me.onItemMouseEnter
+ });
+
+ locked.on({
+ scope: me,
+ itemmouseleave: me.onItemMouseLeave,
+ itemmouseenter: me.onItemMouseEnter
+ });
+ },
+
+ getGridColumns: function() {
+ var cols = this.lockedGrid.headerCt.getGridColumns();
+ return cols.concat(this.normalGrid.headerCt.getGridColumns());
+ },
+
+ onItemMouseEnter: function(view, record){
+ var me = this,
+ locked = me.lockedView,
+ other = me.normalView,
+ item;
+
+ if (view.trackOver) {
+ if (view !== locked) {
+ other = locked;
+ }
+ item = other.getNode(record);
+ other.highlightItem(item);
+ }
+ },
+
+ onItemMouseLeave: function(view, record){
+ var me = this,
+ locked = me.lockedView,
+ other = me.normalView;
+
+ if (view.trackOver) {
+ if (view !== locked) {
+ other = locked;
+ }
+ other.clearHighlight();
+ }
+ },
+
+ relayFn: function(name, args){
+ args = args || [];
+
+ var view = this.lockedView;
+ view[name].apply(view, args || []);
+ view = this.normalView;
+ view[name].apply(view, args || []);
+ },
+
+ getSelectionModel: function(){
+ return this.panel.getSelectionModel();
+ },
+
+ getStore: function(){
+ return this.panel.store;
+ },
+
+ getNode: function(nodeInfo){
+ // default to the normal view
+ return this.normalView.getNode(nodeInfo);
+ },
+
+ getCell: function(record, column){
+ var view = this.lockedView,
+ row;
+
+
+ if (view.getHeaderAtIndex(column) === -1) {
+ view = this.normalView;
+ }
+
+ row = view.getNode(record);
+ return Ext.fly(row).down(column.getCellSelector());
+ },
+
+ getRecord: function(node){
+ var result = this.lockedView.getRecord(node);
+ if (!node) {
+ result = this.normalView.getRecord(node);
+ }
+ return result;
+ },
+
+ refreshNode: function(){
+ this.relayFn('refreshNode', arguments);
+ },
+
+ refresh: function(){
+ this.relayFn('refresh', arguments);
+ },
+
+ bindStore: function(){
+ this.relayFn('bindStore', arguments);
+ },
+
+ addRowCls: function(){
+ this.relayFn('addRowCls', arguments);
+ },
+
+ removeRowCls: function(){
+ this.relayFn('removeRowCls', arguments);
+ }
+
});
-
-
/**
- * @class Ext.chart.PieSeries
- * @extends Ext.chart.Series
- * PieSeries class for the charts widget.
- * @constructor
- */
-Ext.chart.PieSeries = Ext.extend(Ext.chart.Series, {
- type: "pie",
- dataField: null,
- categoryField: null
-});/**
- * @class Ext.menu.Menu
- * @extends Ext.Container
- * A menu object. This is the container to which you may add menu items. Menu can also serve as a base class
- * when you want a specialized menu based off of another component (like {@link Ext.menu.DateMenu} for example).
- * Menus may contain either {@link Ext.menu.Item menu items}, or general {@link Ext.Component Component}s.
- * To make a contained general {@link Ext.Component Component} line up with other {@link Ext.menu.Item menu items}
- * specify iconCls: 'no-icon'. This reserves a space for an icon, and indents the Component in line
- * with the other menu items. See {@link Ext.form.ComboBox}.{@link Ext.form.ComboBox#getListParent getListParent}
- * for an example.
- * By default, Menus are absolutely positioned, floating Components. By configuring a Menu with
- * {@link #floating}:false, a Menu may be used as child of a Container.
+ * @class Ext.grid.Lockable
+ * @private
*
- * @xtype menu
+ * Lockable is a private mixin which injects lockable behavior into any
+ * TablePanel subclass such as GridPanel or TreePanel. TablePanel will
+ * automatically inject the Ext.grid.Lockable mixin in when one of the
+ * these conditions are met:
+ * - The TablePanel has the lockable configuration set to true
+ * - One of the columns in the TablePanel has locked set to true/false
+ *
+ * Each TablePanel subclass *must* register an alias. It should have an array
+ * of configurations to copy to the 2 separate tablepanel's that will be generated
+ * to note what configurations should be copied. These are named normalCfgCopy and
+ * lockedCfgCopy respectively.
+ *
+ * Columns which are locked must specify a fixed width. They do *NOT* support a
+ * flex width.
+ *
+ * Configurations which are specified in this class will be available on any grid or
+ * tree which is using the lockable functionality.
*/
-Ext.menu.Menu = Ext.extend(Ext.Container, {
- /**
- * @cfg {Object} defaults
- * A config object that will be applied to all items added to this container either via the {@link #items}
- * config or via the {@link #add} method. The defaults config can contain any number of
- * name/value property pairs to be added to each item, and should be valid for the types of items
- * being added to the menu.
- */
- /**
- * @cfg {Mixed} items
- * An array of items to be added to this menu. Menus may contain either {@link Ext.menu.Item menu items},
- * or general {@link Ext.Component Component}s.
- */
- /**
- * @cfg {Number} minWidth The minimum width of the menu in pixels (defaults to 120)
- */
- minWidth : 120,
- /**
- * @cfg {Boolean/String} shadow True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
- * for bottom-right shadow (defaults to 'sides')
- */
- shadow : 'sides',
- /**
- * @cfg {String} subMenuAlign The {@link Ext.Element#alignTo} anchor position value to use for submenus of
- * this menu (defaults to 'tl-tr?')
- */
- subMenuAlign : 'tl-tr?',
- /**
- * @cfg {String} defaultAlign The default {@link Ext.Element#alignTo} anchor position value for this menu
- * relative to its element of origin (defaults to 'tl-bl?')
- */
- defaultAlign : 'tl-bl?',
- /**
- * @cfg {Boolean} allowOtherMenus True to allow multiple menus to be displayed at the same time (defaults to false)
- */
- allowOtherMenus : false,
- /**
- * @cfg {Boolean} ignoreParentClicks True to ignore clicks on any item in this menu that is a parent item (displays
- * a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false).
- */
- ignoreParentClicks : false,
- /**
- * @cfg {Boolean} enableScrolling True to allow the menu container to have scroller controls if the menu is too long (defaults to true).
- */
- enableScrolling : true,
- /**
- * @cfg {Number} maxHeight The maximum height of the menu. Only applies when enableScrolling is set to True (defaults to null).
- */
- maxHeight : null,
- /**
- * @cfg {Number} scrollIncrement The amount to scroll the menu. Only applies when enableScrolling is set to True (defaults to 24).
- */
- scrollIncrement : 24,
- /**
- * @cfg {Boolean} showSeparator True to show the icon separator. (defaults to true).
- */
- showSeparator : true,
- /**
- * @cfg {Array} defaultOffsets An array specifying the [x, y] offset in pixels by which to
- * change the default Menu popup position after aligning according to the {@link #defaultAlign}
- * configuration. Defaults to [0, 0].
- */
- defaultOffsets : [0, 0],
-
+Ext.define('Ext.grid.Lockable', {
+
+ requires: ['Ext.grid.LockingView'],
+
/**
- * @cfg {Boolean} plain
- * True to remove the incised line down the left side of the menu. Defaults to false.
+ * @cfg {Boolean} syncRowHeight Synchronize rowHeight between the normal and
+ * locked grid view. This is turned on by default. If your grid is guaranteed
+ * to have rows of all the same height, you should set this to false to
+ * optimize performance.
*/
- plain : false,
-
+ syncRowHeight: true,
+
/**
- * @cfg {Boolean} floating
- * By default, a Menu configured as floating:true
- * will be rendered as an {@link Ext.Layer} (an absolutely positioned,
- * floating Component with zindex=15000).
- * If configured as floating:false
, the Menu may be
- * used as child item of another Container instead of a free-floating
- * {@link Ext.Layer Layer}.
+ * @cfg {String} subGridXType The xtype of the subgrid to specify. If this is
+ * not specified lockable will determine the subgrid xtype to create by the
+ * following rule. Use the superclasses xtype if the superclass is NOT
+ * tablepanel, otherwise use the xtype itself.
*/
- floating : true,
-
-
+
/**
- * @cfg {Number} zIndex
- * zIndex to use when the menu is floating.
+ * @cfg {Object} lockedViewConfig A view configuration to be applied to the
+ * locked side of the grid. Any conflicting configurations between lockedViewConfig
+ * and viewConfig will be overwritten by the lockedViewConfig.
*/
- zIndex: 15000,
-
- // private
- hidden : true,
/**
- * @cfg {String/Object} layout
- * This class assigns a default layout (layout:'menu'
).
- * Developers may override this configuration option if another layout is required.
- * See {@link Ext.Container#layout} for additional information.
+ * @cfg {Object} normalViewConfig A view configuration to be applied to the
+ * normal/unlocked side of the grid. Any conflicting configurations between normalViewConfig
+ * and viewConfig will be overwritten by the normalViewConfig.
*/
- layout : 'menu',
- hideMode : 'offsets', // Important for laying out Components
- scrollerHeight : 8,
- autoLayout : true, // Provided for backwards compat
- defaultType : 'menuitem',
- bufferResize : false,
+
+ // private variable to track whether or not the spacer is hidden/visible
+ spacerHidden: true,
+
+ // i8n text
+ unlockText: 'Unlock',
+ lockText: 'Lock',
+
+ determineXTypeToCreate: function() {
+ var me = this,
+ typeToCreate;
- initComponent : function(){
- if(Ext.isArray(this.initialConfig)){
- Ext.apply(this, {items:this.initialConfig});
- }
- this.addEvents(
- /**
- * @event click
- * Fires when this menu is clicked (or when the enter key is pressed while it is active)
- * @param {Ext.menu.Menu} this
- * @param {Ext.menu.Item} menuItem The menu item that was clicked
- * @param {Ext.EventObject} e
- */
- 'click',
- /**
- * @event mouseover
- * Fires when the mouse is hovering over this menu
- * @param {Ext.menu.Menu} this
- * @param {Ext.EventObject} e
- * @param {Ext.menu.Item} menuItem The menu item that was clicked
- */
- 'mouseover',
- /**
- * @event mouseout
- * Fires when the mouse exits this menu
- * @param {Ext.menu.Menu} this
- * @param {Ext.EventObject} e
- * @param {Ext.menu.Item} menuItem The menu item that was clicked
- */
- 'mouseout',
- /**
- * @event itemclick
- * Fires when a menu item contained in this menu is clicked
- * @param {Ext.menu.BaseItem} baseItem The BaseItem that was clicked
- * @param {Ext.EventObject} e
- */
- 'itemclick'
- );
- Ext.menu.MenuMgr.register(this);
- if(this.floating){
- Ext.EventManager.onWindowResize(this.hide, this);
- }else{
- if(this.initialConfig.hidden !== false){
- this.hidden = false;
+ if (me.subGridXType) {
+ typeToCreate = me.subGridXType;
+ } else {
+ var xtypes = this.getXTypes().split('/'),
+ xtypesLn = xtypes.length,
+ xtype = xtypes[xtypesLn - 1],
+ superxtype = xtypes[xtypesLn - 2];
+
+ if (superxtype !== 'tablepanel') {
+ typeToCreate = superxtype;
+ } else {
+ typeToCreate = xtype;
}
- this.internalDefaults = {hideOnClick: false};
- }
- Ext.menu.Menu.superclass.initComponent.call(this);
- if(this.autoLayout){
- var fn = this.doLayout.createDelegate(this, []);
- this.on({
- add: fn,
- remove: fn
- });
}
+
+ return typeToCreate;
},
+
+ // injectLockable will be invoked before initComponent's parent class implementation
+ // is called, so throughout this method this. are configurations
+ injectLockable: function() {
+ // ensure lockable is set to true in the TablePanel
+ this.lockable = true;
+ // Instruct the TablePanel it already has a view and not to create one.
+ // We are going to aggregate 2 copies of whatever TablePanel we are using
+ this.hasView = true;
- //private
- getLayoutTarget : function() {
- return this.ul;
- },
+ var me = this,
+ // xtype of this class, 'treepanel' or 'gridpanel'
+ // (Note: this makes it a requirement that any subclass that wants to use lockable functionality needs to register an
+ // alias.)
+ xtype = me.determineXTypeToCreate(),
+ // share the selection model
+ selModel = me.getSelectionModel(),
+ lockedGrid = {
+ xtype: xtype,
+ // Lockable does NOT support animations for Tree
+ enableAnimations: false,
+ scroll: false,
+ scrollerOwner: false,
+ selModel: selModel,
+ border: false,
+ cls: Ext.baseCSSPrefix + 'grid-inner-locked'
+ },
+ normalGrid = {
+ xtype: xtype,
+ enableAnimations: false,
+ scrollerOwner: false,
+ selModel: selModel,
+ border: false
+ },
+ i = 0,
+ columns,
+ lockedHeaderCt,
+ normalHeaderCt;
+
+ me.addCls(Ext.baseCSSPrefix + 'grid-locked');
+
+ // copy appropriate configurations to the respective
+ // aggregated tablepanel instances and then delete them
+ // from the master tablepanel.
+ Ext.copyTo(normalGrid, me, me.normalCfgCopy);
+ Ext.copyTo(lockedGrid, me, me.lockedCfgCopy);
+ for (; i < me.normalCfgCopy.length; i++) {
+ delete me[me.normalCfgCopy[i]];
+ }
+ for (i = 0; i < me.lockedCfgCopy.length; i++) {
+ delete me[me.lockedCfgCopy[i]];
+ }
+
+ me.lockedHeights = [];
+ me.normalHeights = [];
+
+ columns = me.processColumns(me.columns);
- // private
- onRender : function(ct, position){
- if(!ct){
- ct = Ext.getBody();
- }
-
- var dh = {
- id: this.getId(),
- cls: 'x-menu ' + ((this.floating) ? 'x-menu-floating x-layer ' : '') + (this.cls || '') + (this.plain ? ' x-menu-plain' : '') + (this.showSeparator ? '' : ' x-menu-nosep'),
- style: this.style,
- cn: [
- {tag: 'a', cls: 'x-menu-focus', href: '#', onclick: 'return false;', tabIndex: '-1'},
- {tag: 'ul', cls: 'x-menu-list'}
- ]
- };
- if(this.floating){
- this.el = new Ext.Layer({
- shadow: this.shadow,
- dh: dh,
- constrain: false,
- parentEl: ct,
- zindex: this.zIndex
+ lockedGrid.width = columns.lockedWidth;
+ lockedGrid.columns = columns.locked;
+ normalGrid.columns = columns.normal;
+
+ me.store = Ext.StoreManager.lookup(me.store);
+ lockedGrid.store = me.store;
+ normalGrid.store = me.store;
+
+ // normal grid should flex the rest of the width
+ normalGrid.flex = 1;
+ lockedGrid.viewConfig = me.lockedViewConfig || {};
+ lockedGrid.viewConfig.loadingUseMsg = false;
+ normalGrid.viewConfig = me.normalViewConfig || {};
+
+ Ext.applyIf(lockedGrid.viewConfig, me.viewConfig);
+ Ext.applyIf(normalGrid.viewConfig, me.viewConfig);
+
+ me.normalGrid = Ext.ComponentManager.create(normalGrid);
+ me.lockedGrid = Ext.ComponentManager.create(lockedGrid);
+
+ me.view = Ext.create('Ext.grid.LockingView', {
+ locked: me.lockedGrid,
+ normal: me.normalGrid,
+ panel: me
+ });
+
+ if (me.syncRowHeight) {
+ me.lockedGrid.getView().on({
+ refresh: me.onLockedGridAfterRefresh,
+ itemupdate: me.onLockedGridAfterUpdate,
+ scope: me
+ });
+
+ me.normalGrid.getView().on({
+ refresh: me.onNormalGridAfterRefresh,
+ itemupdate: me.onNormalGridAfterUpdate,
+ scope: me
});
- }else{
- this.el = ct.createChild(dh);
}
- Ext.menu.Menu.superclass.onRender.call(this, ct, position);
+
+ lockedHeaderCt = me.lockedGrid.headerCt;
+ normalHeaderCt = me.normalGrid.headerCt;
+
+ lockedHeaderCt.lockedCt = true;
+ lockedHeaderCt.lockableInjected = true;
+ normalHeaderCt.lockableInjected = true;
+
+ lockedHeaderCt.on({
+ columnshow: me.onLockedHeaderShow,
+ columnhide: me.onLockedHeaderHide,
+ columnmove: me.onLockedHeaderMove,
+ sortchange: me.onLockedHeaderSortChange,
+ columnresize: me.onLockedHeaderResize,
+ scope: me
+ });
+
+ normalHeaderCt.on({
+ columnmove: me.onNormalHeaderMove,
+ sortchange: me.onNormalHeaderSortChange,
+ scope: me
+ });
+
+ me.normalGrid.on({
+ scrollershow: me.onScrollerShow,
+ scrollerhide: me.onScrollerHide,
+ scope: me
+ });
+
+ me.lockedGrid.on('afterlayout', me.onLockedGridAfterLayout, me, {single: true});
+
+ me.modifyHeaderCt();
+ me.items = [me.lockedGrid, me.normalGrid];
- if(!this.keyNav){
- this.keyNav = new Ext.menu.MenuNav(this);
+ me.layout = {
+ type: 'hbox',
+ align: 'stretch'
+ };
+ },
+
+ processColumns: function(columns){
+ // split apart normal and lockedWidths
+ var i = 0,
+ len = columns.length,
+ lockedWidth = 0,
+ lockedHeaders = [],
+ normalHeaders = [],
+ column;
+
+ for (; i < len; ++i) {
+ column = columns[i];
+ // mark the column as processed so that the locked attribute does not
+ // trigger trying to aggregate the columns again.
+ column.processed = true;
+ if (column.locked) {
+ if (column.flex) {
+ Ext.Error.raise("Columns which are locked do NOT support a flex width. You must set a width on the " + columns[i].text + "column.");
+ }
+ lockedWidth += column.width;
+ lockedHeaders.push(column);
+ } else {
+ normalHeaders.push(column);
+ }
}
- // generic focus element
- this.focusEl = this.el.child('a.x-menu-focus');
- this.ul = this.el.child('ul.x-menu-list');
- this.mon(this.ul, {
- scope: this,
- click: this.onClick,
- mouseover: this.onMouseOver,
- mouseout: this.onMouseOut
+ return {
+ lockedWidth: lockedWidth,
+ locked: lockedHeaders,
+ normal: normalHeaders
+ };
+ },
+
+ // create a new spacer after the table is refreshed
+ onLockedGridAfterLayout: function() {
+ var me = this,
+ lockedView = me.lockedGrid.getView();
+ lockedView.on({
+ refresh: me.createSpacer,
+ beforerefresh: me.destroySpacer,
+ scope: me
});
- if(this.enableScrolling){
- this.mon(this.el, {
- scope: this,
- delegate: '.x-menu-scroller',
- click: this.onScroll,
- mouseover: this.deactivateActive
- });
+ },
+
+ // trigger a pseudo refresh on the normal side
+ onLockedHeaderMove: function() {
+ if (this.syncRowHeight) {
+ this.onNormalGridAfterRefresh();
}
},
-
- // private
- findTargetItem : function(e){
- var t = e.getTarget('.x-menu-list-item', this.ul, true);
- if(t && t.menuItemId){
- return this.items.get(t.menuItemId);
+
+ // trigger a pseudo refresh on the locked side
+ onNormalHeaderMove: function() {
+ if (this.syncRowHeight) {
+ this.onLockedGridAfterRefresh();
}
},
-
- // private
- onClick : function(e){
- var t = this.findTargetItem(e);
- if(t){
- if(t.isFormField){
- this.setActiveItem(t);
- }else if(t instanceof Ext.menu.BaseItem){
- if(t.menu && this.ignoreParentClicks){
- t.expandMenu();
- e.preventDefault();
- }else if(t.onClick){
- t.onClick(e);
- this.fireEvent('click', this, t, e);
+
+ // create a spacer in lockedsection and store a reference
+ // TODO: Should destroy before refreshing content
+ createSpacer: function() {
+ var me = this,
+ // This affects scrolling all the way to the bottom of a locked grid
+ // additional test, sort a column and make sure it synchronizes
+ w = Ext.getScrollBarWidth() + (Ext.isIE ? 2 : 0),
+ view = me.lockedGrid.getView(),
+ el = view.el;
+
+ me.spacerEl = Ext.core.DomHelper.append(el, {
+ cls: me.spacerHidden ? (Ext.baseCSSPrefix + 'hidden') : '',
+ style: 'height: ' + w + 'px;'
+ }, true);
+ },
+
+ destroySpacer: function() {
+ var me = this;
+ if (me.spacerEl) {
+ me.spacerEl.destroy();
+ delete me.spacerEl;
+ }
+ },
+
+ // cache the heights of all locked rows and sync rowheights
+ onLockedGridAfterRefresh: function() {
+ var me = this,
+ view = me.lockedGrid.getView(),
+ el = view.el,
+ rowEls = el.query(view.getItemSelector()),
+ ln = rowEls.length,
+ i = 0;
+
+ // reset heights each time.
+ me.lockedHeights = [];
+
+ for (; i < ln; i++) {
+ me.lockedHeights[i] = rowEls[i].clientHeight;
+ }
+ me.syncRowHeights();
+ },
+
+ // cache the heights of all normal rows and sync rowheights
+ onNormalGridAfterRefresh: function() {
+ var me = this,
+ view = me.normalGrid.getView(),
+ el = view.el,
+ rowEls = el.query(view.getItemSelector()),
+ ln = rowEls.length,
+ i = 0;
+
+ // reset heights each time.
+ me.normalHeights = [];
+
+ for (; i < ln; i++) {
+ me.normalHeights[i] = rowEls[i].clientHeight;
+ }
+ me.syncRowHeights();
+ },
+
+ // rows can get bigger/smaller
+ onLockedGridAfterUpdate: function(record, index, node) {
+ this.lockedHeights[index] = node.clientHeight;
+ this.syncRowHeights();
+ },
+
+ // rows can get bigger/smaller
+ onNormalGridAfterUpdate: function(record, index, node) {
+ this.normalHeights[index] = node.clientHeight;
+ this.syncRowHeights();
+ },
+
+ // match the rowheights to the biggest rowheight on either
+ // side
+ syncRowHeights: function() {
+ var me = this,
+ lockedHeights = me.lockedHeights,
+ normalHeights = me.normalHeights,
+ calcHeights = [],
+ ln = lockedHeights.length,
+ i = 0,
+ lockedView, normalView,
+ lockedRowEls, normalRowEls,
+ vertScroller = me.getVerticalScroller(),
+ scrollTop;
+
+ // ensure there are an equal num of locked and normal
+ // rows before synchronization
+ if (lockedHeights.length && normalHeights.length) {
+ lockedView = me.lockedGrid.getView();
+ normalView = me.normalGrid.getView();
+ lockedRowEls = lockedView.el.query(lockedView.getItemSelector());
+ normalRowEls = normalView.el.query(normalView.getItemSelector());
+
+ // loop thru all of the heights and sync to the other side
+ for (; i < ln; i++) {
+ // ensure both are numbers
+ if (!isNaN(lockedHeights[i]) && !isNaN(normalHeights[i])) {
+ if (lockedHeights[i] > normalHeights[i]) {
+ Ext.fly(normalRowEls[i]).setHeight(lockedHeights[i]);
+ } else if (lockedHeights[i] < normalHeights[i]) {
+ Ext.fly(lockedRowEls[i]).setHeight(normalHeights[i]);
+ }
}
}
+
+ // invalidate the scroller and sync the scrollers
+ me.normalGrid.invalidateScroller();
+
+ // synchronize the view with the scroller, if we have a virtualScrollTop
+ // then the user is using a PagingScroller
+ if (vertScroller && vertScroller.setViewScrollTop) {
+ vertScroller.setViewScrollTop(me.virtualScrollTop);
+ } else {
+ // We don't use setScrollTop here because if the scrollTop is
+ // set to the exact same value some browsers won't fire the scroll
+ // event. Instead, we directly set the scrollTop.
+ scrollTop = normalView.el.dom.scrollTop;
+ normalView.el.dom.scrollTop = scrollTop;
+ lockedView.el.dom.scrollTop = scrollTop;
+ }
+
+ // reset the heights
+ me.lockedHeights = [];
+ me.normalHeights = [];
+ }
+ },
+
+ // track when scroller is shown
+ onScrollerShow: function(scroller, direction) {
+ if (direction === 'horizontal') {
+ this.spacerHidden = false;
+ this.spacerEl.removeCls(Ext.baseCSSPrefix + 'hidden');
+ }
+ },
+
+ // track when scroller is hidden
+ onScrollerHide: function(scroller, direction) {
+ if (direction === 'horizontal') {
+ this.spacerHidden = true;
+ this.spacerEl.addCls(Ext.baseCSSPrefix + 'hidden');
}
},
- // private
- setActiveItem : function(item, autoExpand){
- if(item != this.activeItem){
- this.deactivateActive();
- if((this.activeItem = item).isFormField){
- item.focus();
- }else{
- item.activate(autoExpand);
- }
- }else if(autoExpand){
- item.expandMenu();
+
+ // inject Lock and Unlock text
+ modifyHeaderCt: function() {
+ var me = this;
+ me.lockedGrid.headerCt.getMenuItems = me.getMenuItems(true);
+ me.normalGrid.headerCt.getMenuItems = me.getMenuItems(false);
+ },
+
+ onUnlockMenuClick: function() {
+ this.unlock();
+ },
+
+ onLockMenuClick: function() {
+ this.lock();
+ },
+
+ getMenuItems: function(locked) {
+ var me = this,
+ unlockText = me.unlockText,
+ lockText = me.lockText,
+ // TODO: Refactor to use Ext.baseCSSPrefix
+ unlockCls = 'xg-hmenu-unlock',
+ lockCls = 'xg-hmenu-lock',
+ unlockHandler = Ext.Function.bind(me.onUnlockMenuClick, me),
+ lockHandler = Ext.Function.bind(me.onLockMenuClick, me);
+
+ // runs in the scope of headerCt
+ return function() {
+ var o = Ext.grid.header.Container.prototype.getMenuItems.call(this);
+ o.push('-',{
+ cls: unlockCls,
+ text: unlockText,
+ handler: unlockHandler,
+ disabled: !locked
+ });
+ o.push({
+ cls: lockCls,
+ text: lockText,
+ handler: lockHandler,
+ disabled: locked
+ });
+ return o;
+ };
+ },
+
+ // going from unlocked section to locked
+ /**
+ * Locks the activeHeader as determined by which menu is open OR a header
+ * as specified.
+ * @param {Ext.grid.column.Column} header (Optional) Header to unlock from the locked section. Defaults to the header which has the menu open currently.
+ * @param {Number} toIdx (Optional) The index to move the unlocked header to. Defaults to appending as the last item.
+ * @private
+ */
+ lock: function(activeHd, toIdx) {
+ var me = this,
+ normalGrid = me.normalGrid,
+ lockedGrid = me.lockedGrid,
+ normalHCt = normalGrid.headerCt,
+ lockedHCt = lockedGrid.headerCt;
+
+ activeHd = activeHd || normalHCt.getMenu().activeHeader;
+
+ // if column was previously flexed, get/set current width
+ // and remove the flex
+ if (activeHd.flex) {
+ activeHd.width = activeHd.getWidth();
+ delete activeHd.flex;
+ }
+
+ normalHCt.remove(activeHd, false);
+ lockedHCt.suspendLayout = true;
+ if (Ext.isDefined(toIdx)) {
+ lockedHCt.insert(toIdx, activeHd);
+ } else {
+ lockedHCt.add(activeHd);
}
+ lockedHCt.suspendLayout = false;
+ me.syncLockedSection();
+ },
+
+ syncLockedSection: function() {
+ var me = this;
+ me.syncLockedWidth();
+ me.lockedGrid.getView().refresh();
+ me.normalGrid.getView().refresh();
+ },
+
+ // adjust the locked section to the width of its respective
+ // headerCt
+ syncLockedWidth: function() {
+ var me = this,
+ width = me.lockedGrid.headerCt.getFullWidth(true);
+ me.lockedGrid.setWidth(width);
+ },
+
+ onLockedHeaderResize: function() {
+ this.syncLockedWidth();
+ },
+
+ onLockedHeaderHide: function() {
+ this.syncLockedWidth();
},
-
- deactivateActive : function(){
- var a = this.activeItem;
- if(a){
- if(a.isFormField){
- //Fields cannot deactivate, but Combos must collapse
- if(a.collapse){
- a.collapse();
- }
- }else{
- a.deactivate();
- }
- delete this.activeItem;
+
+ onLockedHeaderShow: function() {
+ this.syncLockedWidth();
+ },
+
+ onLockedHeaderSortChange: function(headerCt, header, sortState) {
+ if (sortState) {
+ // no real header, and silence the event so we dont get into an
+ // infinite loop
+ this.normalGrid.headerCt.clearOtherSortStates(null, true);
}
},
-
- // private
- tryActivate : function(start, step){
- var items = this.items;
- for(var i = start, len = items.length; i >= 0 && i < len; i+= step){
- var item = items.get(i);
- if(!item.disabled && (item.canActivate || item.isFormField)){
- this.setActiveItem(item, false);
- return item;
- }
+
+ onNormalHeaderSortChange: function(headerCt, header, sortState) {
+ if (sortState) {
+ // no real header, and silence the event so we dont get into an
+ // infinite loop
+ this.lockedGrid.headerCt.clearOtherSortStates(null, true);
}
- return false;
},
+
+ // going from locked section to unlocked
+ /**
+ * Unlocks the activeHeader as determined by which menu is open OR a header
+ * as specified.
+ * @param {Ext.grid.column.Column} header (Optional) Header to unlock from the locked section. Defaults to the header which has the menu open currently.
+ * @param {Number} toIdx (Optional) The index to move the unlocked header to. Defaults to 0.
+ * @private
+ */
+ unlock: function(activeHd, toIdx) {
+ var me = this,
+ normalGrid = me.normalGrid,
+ lockedGrid = me.lockedGrid,
+ normalHCt = normalGrid.headerCt,
+ lockedHCt = lockedGrid.headerCt;
- // private
- onMouseOver : function(e){
- var t = this.findTargetItem(e);
- if(t){
- if(t.canActivate && !t.disabled){
- this.setActiveItem(t, true);
- }
+ if (!Ext.isDefined(toIdx)) {
+ toIdx = 0;
}
- this.over = true;
- this.fireEvent('mouseover', this, e, t);
+ activeHd = activeHd || lockedHCt.getMenu().activeHeader;
+
+ lockedHCt.remove(activeHd, false);
+ me.syncLockedWidth();
+ me.lockedGrid.getView().refresh();
+ normalHCt.insert(toIdx, activeHd);
+ me.normalGrid.getView().refresh();
},
+
+ // we want to totally override the reconfigure behaviour here, since we're creating 2 sub-grids
+ reconfigureLockable: function(store, columns) {
+ var me = this,
+ lockedGrid = me.lockedGrid,
+ normalGrid = me.normalGrid;
+
+ if (columns) {
+ lockedGrid.headerCt.removeAll();
+ normalGrid.headerCt.removeAll();
+
+ columns = me.processColumns(columns);
+ lockedGrid.setWidth(columns.lockedWidth);
+ lockedGrid.headerCt.add(columns.locked);
+ normalGrid.headerCt.add(columns.normal);
+ }
+
+ if (store) {
+ store = Ext.data.StoreManager.lookup(store);
+ me.store = store;
+ lockedGrid.bindStore(store);
+ normalGrid.bindStore(store);
+ } else {
+ lockedGrid.getView().refresh();
+ normalGrid.getView().refresh();
+ }
+ }
+});
- // private
- onMouseOut : function(e){
- var t = this.findTargetItem(e);
- if(t){
- if(t == this.activeItem && t.shouldDeactivate && t.shouldDeactivate(e)){
- this.activeItem.deactivate();
- delete this.activeItem;
+/**
+ * @class Ext.grid.Scroller
+ * @extends Ext.Component
+ *
+ * Docked in an Ext.grid.Panel, controls virtualized scrolling and synchronization
+ * across different sections.
+ *
+ * @private
+ */
+Ext.define('Ext.grid.Scroller', {
+ extend: 'Ext.Component',
+ alias: 'widget.gridscroller',
+ weight: 110,
+ cls: Ext.baseCSSPrefix + 'scroller',
+ focusable: false,
+
+ renderTpl: ['
'],
+
+ initComponent: function() {
+ var me = this,
+ dock = me.dock,
+ cls = Ext.baseCSSPrefix + 'scroller-vertical',
+ sizeProp = 'width',
+ // Subtracting 2px would give us a perfect fit of the scroller
+ // however, some browsers wont allow us to scroll content thats not
+ // visible, therefore we use 1px.
+ // Note: This 1px offset matches code in Ext.grid.ColumnLayout when
+ // reserving room for the scrollbar
+ scrollbarWidth = Ext.getScrollBarWidth() + (Ext.isIE ? 1 : -1);
+
+ me.offsets = {bottom: 0};
+
+ if (dock === 'top' || dock === 'bottom') {
+ cls = Ext.baseCSSPrefix + 'scroller-horizontal';
+ sizeProp = 'height';
+ }
+ me[sizeProp] = scrollbarWidth;
+
+ me.cls += (' ' + cls);
+
+ Ext.applyIf(me.renderSelectors, {
+ stretchEl: '.' + Ext.baseCSSPrefix + 'stretcher'
+ });
+ me.callParent();
+ },
+
+
+ afterRender: function() {
+ var me = this;
+ me.callParent();
+ me.ownerCt.on('afterlayout', me.onOwnerAfterLayout, me);
+ me.mon(me.el, 'scroll', me.onElScroll, me);
+ Ext.cache[me.el.id].skipGarbageCollection = true;
+ },
+
+ getSizeCalculation: function() {
+ var owner = this.getPanel(),
+ dock = this.dock,
+ elDom = this.el.dom,
+ width = 1,
+ height = 1,
+ view, tbl;
+
+ if (dock === 'top' || dock === 'bottom') {
+ // TODO: Must gravitate to a single region..
+ // Horizontal scrolling only scrolls virtualized region
+ var items = owner.query('tableview'),
+ center = items[1] || items[0];
+
+ if (!center) {
+ return false;
+ }
+ // center is not guaranteed to have content, such as when there
+ // are zero rows in the grid/tree. We read the width from the
+ // headerCt instead.
+ width = center.headerCt.getFullWidth();
+
+ if (Ext.isIEQuirks) {
+ width--;
+ }
+ // Account for the 1px removed in Scroller.
+ width--;
+ } else {
+ view = owner.down('tableview:not([lockableInjected])');
+ if (!view) {
+ return false;
}
+ tbl = view.el;
+ if (!tbl) {
+ return false;
+ }
+
+ // needs to also account for header and scroller (if still in picture)
+ // should calculate from headerCt.
+ height = tbl.dom.scrollHeight;
}
- this.over = false;
- this.fireEvent('mouseout', this, e, t);
- },
-
- // private
- onScroll : function(e, t){
- if(e){
- e.stopEvent();
+ if (isNaN(width)) {
+ width = 1;
}
- var ul = this.ul.dom, top = Ext.fly(t).is('.x-menu-scroller-top');
- ul.scrollTop += this.scrollIncrement * (top ? -1 : 1);
- if(top ? ul.scrollTop <= 0 : ul.scrollTop + this.activeMax >= ul.scrollHeight){
- this.onScrollerOut(null, t);
+ if (isNaN(height)) {
+ height = 1;
}
+ return {
+ width: width,
+ height: height
+ };
},
-
- // private
- onScrollerIn : function(e, t){
- var ul = this.ul.dom, top = Ext.fly(t).is('.x-menu-scroller-top');
- if(top ? ul.scrollTop > 0 : ul.scrollTop + this.activeMax < ul.scrollHeight){
- Ext.fly(t).addClass(['x-menu-item-active', 'x-menu-scroller-active']);
+
+ invalidate: function(firstPass) {
+ if (!this.stretchEl || !this.ownerCt) {
+ return;
+ }
+ var size = this.getSizeCalculation(),
+ elDom = this.el.dom;
+ if (size) {
+ this.stretchEl.setSize(size);
+
+ // BrowserBug: IE7
+ // This makes the scroller enabled, when initially rendering.
+ elDom.scrollTop = elDom.scrollTop;
}
},
- // private
- onScrollerOut : function(e, t){
- Ext.fly(t).removeClass(['x-menu-item-active', 'x-menu-scroller-active']);
+ onOwnerAfterLayout: function(owner, layout) {
+ this.invalidate();
},
/**
- * If {@link #floating}=true
, shows this menu relative to
- * another element using {@link #showat}, otherwise uses {@link Ext.Component#show}.
- * @param {Mixed} element The element to align to
- * @param {String} position (optional) The {@link Ext.Element#alignTo} anchor position to use in aligning to
- * the element (defaults to this.defaultAlign)
- * @param {Ext.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
+ * Sets the scrollTop and constrains the value between 0 and max.
+ * @param {Number} scrollTop
+ * @return {Number} The resulting scrollTop value after being constrained
*/
- show : function(el, pos, parentMenu){
- if(this.floating){
- this.parentMenu = parentMenu;
- if(!this.el){
- this.render();
- this.doLayout(false, true);
- }
- this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign, this.defaultOffsets), parentMenu);
- }else{
- Ext.menu.Menu.superclass.show.call(this);
+ setScrollTop: function(scrollTop) {
+ if (this.el) {
+ var elDom = this.el.dom;
+ return elDom.scrollTop = Ext.Number.constrain(scrollTop, 0, elDom.scrollHeight - elDom.clientHeight);
}
},
/**
- * Displays this menu at a specific xy position and fires the 'show' event if a
- * handler for the 'beforeshow' event does not return false cancelling the operation.
- * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)
- * @param {Ext.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
+ * Sets the scrollLeft and constrains the value between 0 and max.
+ * @param {Number} scrollLeft
+ * @return {Number} The resulting scrollLeft value after being constrained
*/
- showAt : function(xy, parentMenu){
- if(this.fireEvent('beforeshow', this) !== false){
- this.parentMenu = parentMenu;
- if(!this.el){
- this.render();
- }
- if(this.enableScrolling){
- // set the position so we can figure out the constrain value.
- this.el.setXY(xy);
- //constrain the value, keep the y coordinate the same
- xy[1] = this.constrainScroll(xy[1]);
- xy = [this.el.adjustForConstraints(xy)[0], xy[1]];
- }else{
- //constrain to the viewport.
- xy = this.el.adjustForConstraints(xy);
- }
- this.el.setXY(xy);
- this.el.show();
- Ext.menu.Menu.superclass.onShow.call(this);
- if(Ext.isIE){
- // internal event, used so we don't couple the layout to the menu
- this.fireEvent('autosize', this);
- if(!Ext.isIE8){
- this.el.repaint();
- }
- }
- this.hidden = false;
- this.focus();
- this.fireEvent('show', this);
+ setScrollLeft: function(scrollLeft) {
+ if (this.el) {
+ var elDom = this.el.dom;
+ return elDom.scrollLeft = Ext.Number.constrain(scrollLeft, 0, elDom.scrollWidth - elDom.clientWidth);
}
},
- constrainScroll : function(y){
- var max, full = this.ul.setHeight('auto').getHeight(),
- returnY = y, normalY, parentEl, scrollTop, viewHeight;
- if(this.floating){
- parentEl = Ext.fly(this.el.dom.parentNode);
- scrollTop = parentEl.getScroll().top;
- viewHeight = parentEl.getViewSize().height;
- //Normalize y by the scroll position for the parent element. Need to move it into the coordinate space
- //of the view.
- normalY = y - scrollTop;
- max = this.maxHeight ? this.maxHeight : viewHeight - normalY;
- if(full > viewHeight) {
- max = viewHeight;
- //Set returnY equal to (0,0) in view space by reducing y by the value of normalY
- returnY = y - normalY;
- } else if(max < full) {
- returnY = y - (full - max);
- max = full;
- }
- }else{
- max = this.getHeight();
- }
- // Always respect maxHeight
- if (this.maxHeight){
- max = Math.min(this.maxHeight, max);
- }
- if(full > max && max > 0){
- this.activeMax = max - this.scrollerHeight * 2 - this.el.getFrameWidth('tb') - Ext.num(this.el.shadowOffset, 0);
- this.ul.setHeight(this.activeMax);
- this.createScrollers();
- this.el.select('.x-menu-scroller').setDisplayed('');
- }else{
- this.ul.setHeight(full);
- this.el.select('.x-menu-scroller').setDisplayed('none');
+ /**
+ * Scroll by deltaY
+ * @param {Number} delta
+ * @return {Number} The resulting scrollTop value
+ */
+ scrollByDeltaY: function(delta) {
+ if (this.el) {
+ var elDom = this.el.dom;
+ return this.setScrollTop(elDom.scrollTop + delta);
}
- this.ul.dom.scrollTop = 0;
- return returnY;
},
- createScrollers : function(){
- if(!this.scroller){
- this.scroller = {
- pos: 0,
- top: this.el.insertFirst({
- tag: 'div',
- cls: 'x-menu-scroller x-menu-scroller-top',
- html: ' '
- }),
- bottom: this.el.createChild({
- tag: 'div',
- cls: 'x-menu-scroller x-menu-scroller-bottom',
- html: ' '
- })
- };
- this.scroller.top.hover(this.onScrollerIn, this.onScrollerOut, this);
- this.scroller.topRepeater = new Ext.util.ClickRepeater(this.scroller.top, {
- listeners: {
- click: this.onScroll.createDelegate(this, [null, this.scroller.top], false)
- }
- });
- this.scroller.bottom.hover(this.onScrollerIn, this.onScrollerOut, this);
- this.scroller.bottomRepeater = new Ext.util.ClickRepeater(this.scroller.bottom, {
- listeners: {
- click: this.onScroll.createDelegate(this, [null, this.scroller.bottom], false)
- }
- });
+ /**
+ * Scroll by deltaX
+ * @param {Number} delta
+ * @return {Number} The resulting scrollLeft value
+ */
+ scrollByDeltaX: function(delta) {
+ if (this.el) {
+ var elDom = this.el.dom;
+ return this.setScrollLeft(elDom.scrollLeft + delta);
}
},
-
- onLayout : function(){
- if(this.isVisible()){
- if(this.enableScrolling){
- this.constrainScroll(this.el.getTop());
- }
- if(this.floating){
- this.el.sync();
- }
- }
+
+
+ /**
+ * Scroll to the top.
+ */
+ scrollToTop : function(){
+ this.setScrollTop(0);
},
-
- focus : function(){
- if(!this.hidden){
- this.doFocus.defer(50, this);
- }
+
+ // synchronize the scroller with the bound gridviews
+ onElScroll: function(event, target) {
+ this.fireEvent('bodyscroll', event, target);
},
- doFocus : function(){
- if(!this.hidden){
- this.focusEl.focus();
+ getPanel: function() {
+ var me = this;
+ if (!me.panel) {
+ me.panel = this.up('[scrollerOwner]');
}
- },
+ return me.panel;
+ }
+});
+
+/**
+ * @class Ext.grid.PagingScroller
+ * @extends Ext.grid.Scroller
+ *
+ * @private
+ */
+Ext.define('Ext.grid.PagingScroller', {
+ extend: 'Ext.grid.Scroller',
+ alias: 'widget.paginggridscroller',
+ //renderTpl: null,
+ //tpl: [
+ // '',
+ // '',
+ // ' '
+ //],
+ /**
+ * @cfg {Number} percentageFromEdge This is a number above 0 and less than 1 which specifies
+ * at what percentage to begin fetching the next page. For example if the pageSize is 100
+ * and the percentageFromEdge is the default of 0.35, the paging scroller will prefetch pages
+ * when scrolling up between records 0 and 34 and when scrolling down between records 65 and 99.
+ */
+ percentageFromEdge: 0.35,
+
/**
- * Hides this menu and optionally all parent menus
- * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false)
+ * @cfg {Number} scrollToLoadBuffer This is the time in milliseconds to buffer load requests
+ * when scrolling the PagingScrollbar.
*/
- hide : function(deep){
- if (!this.isDestroyed) {
- this.deepHide = deep;
- Ext.menu.Menu.superclass.hide.call(this);
- delete this.deepHide;
- }
+ scrollToLoadBuffer: 200,
+
+ activePrefetch: true,
+
+ chunkSize: 50,
+ snapIncrement: 25,
+
+ syncScroll: true,
+
+ initComponent: function() {
+ var me = this,
+ ds = me.store;
+
+ ds.on('guaranteedrange', this.onGuaranteedRange, this);
+ this.callParent(arguments);
},
+
+
+ onGuaranteedRange: function(range, start, end) {
+ var me = this,
+ ds = me.store,
+ rs;
+ // this should never happen
+ if (range.length && me.visibleStart < range[0].index) {
+ return;
+ }
+
+ ds.loadRecords(range);
- // private
- onHide : function(){
- Ext.menu.Menu.superclass.onHide.call(this);
- this.deactivateActive();
- if(this.el && this.floating){
- this.el.hide();
- }
- var pm = this.parentMenu;
- if(this.deepHide === true && pm){
- if(pm.floating){
- pm.hide(true);
- }else{
- pm.deactivateActive();
+ if (!me.firstLoad) {
+ if (me.rendered) {
+ me.invalidate();
+ } else {
+ me.on('afterrender', this.invalidate, this, {single: true});
}
+ me.firstLoad = true;
+ } else {
+ // adjust to visible
+ me.syncTo();
}
},
+
+ syncTo: function() {
+ var me = this,
+ pnl = me.getPanel(),
+ store = pnl.store,
+ scrollerElDom = this.el.dom,
+ rowOffset = me.visibleStart - store.guaranteedStart,
+ scrollBy = rowOffset * me.rowHeight,
+ scrollHeight = scrollerElDom.scrollHeight,
+ clientHeight = scrollerElDom.clientHeight,
+ scrollTop = scrollerElDom.scrollTop,
+ useMaximum;
+
+ // BrowserBug: clientHeight reports 0 in IE9 StrictMode
+ // Instead we are using offsetHeight and hardcoding borders
+ if (Ext.isIE9 && Ext.isStrict) {
+ clientHeight = scrollerElDom.offsetHeight + 2;
+ }
- // private
- lookupComponent : function(c){
- if(Ext.isString(c)){
- c = (c == 'separator' || c == '-') ? new Ext.menu.Separator() : new Ext.menu.TextItem(c);
- this.applyDefaults(c);
- }else{
- if(Ext.isObject(c)){
- c = this.getMenuItem(c);
- }else if(c.tagName || c.el){ // element. Wrap it.
- c = new Ext.BoxComponent({
- el: c
- });
- }
- }
- return c;
+ // This should always be zero or greater than zero but staying
+ // safe and less than 0 we'll scroll to the bottom.
+ useMaximum = (scrollHeight - clientHeight - scrollTop <= 0);
+ this.setViewScrollTop(scrollBy, useMaximum);
},
-
- applyDefaults : function(c){
- if(!Ext.isString(c)){
- c = Ext.menu.Menu.superclass.applyDefaults.call(this, c);
- var d = this.internalDefaults;
- if(d){
- if(c.events){
- Ext.applyIf(c.initialConfig, d);
- Ext.apply(c, d);
- }else{
- Ext.applyIf(c, d);
+
+ getPageData : function(){
+ var panel = this.getPanel(),
+ store = panel.store,
+ totalCount = store.getTotalCount();
+
+ return {
+ 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)
+ };
+ },
+
+ onElScroll: function(e, t) {
+ var me = this,
+ panel = me.getPanel(),
+ store = panel.store,
+ pageSize = store.pageSize,
+ guaranteedStart = store.guaranteedStart,
+ guaranteedEnd = store.guaranteedEnd,
+ totalCount = store.getTotalCount(),
+ numFromEdge = Math.ceil(me.percentageFromEdge * store.pageSize),
+ position = t.scrollTop,
+ visibleStart = Math.floor(position / me.rowHeight),
+ view = panel.down('tableview'),
+ viewEl = view.el,
+ visibleHeight = viewEl.getHeight(),
+ visibleAhead = Math.ceil(visibleHeight / me.rowHeight),
+ visibleEnd = visibleStart + visibleAhead,
+ prevPage = Math.floor(visibleStart / store.pageSize),
+ nextPage = Math.floor(visibleEnd / store.pageSize) + 2,
+ lastPage = Math.ceil(totalCount / store.pageSize),
+ //requestStart = visibleStart,
+ requestStart = Math.floor(visibleStart / me.snapIncrement) * me.snapIncrement,
+ requestEnd = requestStart + pageSize - 1,
+ activePrefetch = me.activePrefetch;
+
+ me.visibleStart = visibleStart;
+ me.visibleEnd = visibleEnd;
+
+
+ me.syncScroll = true;
+ if (totalCount >= pageSize) {
+ // end of request was past what the total is, grab from the end back a pageSize
+ if (requestEnd > totalCount - 1) {
+ this.cancelLoad();
+ if (store.rangeSatisfied(totalCount - pageSize, totalCount - 1)) {
+ me.syncScroll = true;
+ }
+ store.guaranteeRange(totalCount - pageSize, totalCount - 1);
+ // Out of range, need to reset the current data set
+ } else if (visibleStart < guaranteedStart || visibleEnd > guaranteedEnd) {
+ if (store.rangeSatisfied(requestStart, requestEnd)) {
+ this.cancelLoad();
+ store.guaranteeRange(requestStart, requestEnd);
+ } else {
+ store.mask();
+ me.attemptLoad(requestStart, requestEnd);
}
+ // dont sync the scroll view immediately, sync after the range has been guaranteed
+ me.syncScroll = false;
+ } else if (activePrefetch && visibleStart < (guaranteedStart + numFromEdge) && prevPage > 0) {
+ me.syncScroll = true;
+ store.prefetchPage(prevPage);
+ } else if (activePrefetch && visibleEnd > (guaranteedEnd - numFromEdge) && nextPage < lastPage) {
+ me.syncScroll = true;
+ store.prefetchPage(nextPage);
}
}
- return c;
+
+
+ if (me.syncScroll) {
+ me.syncTo();
+ }
},
+
+ getSizeCalculation: function() {
+ // Use the direct ownerCt here rather than the scrollerOwner
+ // because we are calculating widths/heights.
+ var owner = this.ownerCt,
+ view = owner.getView(),
+ store = this.store,
+ dock = this.dock,
+ elDom = this.el.dom,
+ width = 1,
+ height = 1;
+
+ if (!this.rowHeight) {
+ this.rowHeight = view.el.down(view.getItemSelector()).getHeight(false, true);
+ }
- // private
- getMenuItem : function(config){
- if(!config.isXType){
- if(!config.xtype && Ext.isBoolean(config.checked)){
- return new Ext.menu.CheckItem(config)
- }
- return Ext.create(config, this.defaultType);
+ height = store.getTotalCount() * this.rowHeight;
+
+ if (isNaN(width)) {
+ width = 1;
+ }
+ if (isNaN(height)) {
+ height = 1;
+ }
+ return {
+ width: width,
+ height: height
+ };
+ },
+
+ attemptLoad: function(start, end) {
+ var me = this;
+ if (!me.loadTask) {
+ me.loadTask = Ext.create('Ext.util.DelayedTask', me.doAttemptLoad, me, []);
+ }
+ me.loadTask.delay(me.scrollToLoadBuffer, me.doAttemptLoad, me, [start, end]);
+ },
+
+ cancelLoad: function() {
+ if (this.loadTask) {
+ this.loadTask.cancel();
}
- return config;
},
+
+ doAttemptLoad: function(start, end) {
+ var store = this.getPanel().store;
+ store.guaranteeRange(start, end);
+ },
+
+ setViewScrollTop: function(scrollTop, useMax) {
+ var owner = this.getPanel(),
+ items = owner.query('tableview'),
+ i = 0,
+ len = items.length,
+ center,
+ centerEl,
+ calcScrollTop,
+ maxScrollTop,
+ scrollerElDom = this.el.dom;
+
+ owner.virtualScrollTop = scrollTop;
+
+ center = items[1] || items[0];
+ centerEl = center.el.dom;
+
+ maxScrollTop = ((owner.store.pageSize * this.rowHeight) - centerEl.clientHeight);
+ calcScrollTop = (scrollTop % ((owner.store.pageSize * this.rowHeight) + 1));
+ if (useMax) {
+ calcScrollTop = maxScrollTop;
+ }
+ if (calcScrollTop > maxScrollTop) {
+ //Ext.Error.raise("Calculated scrollTop was larger than maxScrollTop");
+ return;
+ // calcScrollTop = maxScrollTop;
+ }
+ for (; i < len; i++) {
+ items[i].el.dom.scrollTop = calcScrollTop;
+ }
+ }
+});
+
+
+/**
+ * @class Ext.panel.Table
+ * @extends Ext.panel.Panel
+ * @xtype tablepanel
+ * @private
+ * @author Nicolas Ferrero
+ * TablePanel is a private class and the basis of both TreePanel and GridPanel.
+ *
+ * TablePanel aggregates:
+ *
+ * - a Selection Model
+ * - a View
+ * - a Store
+ * - Scrollers
+ * - Ext.grid.header.Container
+ *
+ */
+Ext.define('Ext.panel.Table', {
+ extend: 'Ext.panel.Panel',
+
+ alias: 'widget.tablepanel',
+
+ uses: [
+ 'Ext.selection.RowModel',
+ 'Ext.grid.Scroller',
+ 'Ext.grid.header.Container',
+ 'Ext.grid.Lockable'
+ ],
+ cls: Ext.baseCSSPrefix + 'grid',
+ extraBodyCls: Ext.baseCSSPrefix + 'grid-body',
+
+ layout: 'fit',
/**
- * Adds a separator bar to the menu
- * @return {Ext.menu.Item} The menu item that was added
+ * Boolean to indicate that a view has been injected into the panel.
+ * @property hasView
*/
- addSeparator : function(){
- return this.add(new Ext.menu.Separator());
- },
+ hasView: false,
+
+ // each panel should dictate what viewType and selType to use
+ viewType: null,
+ selType: 'rowmodel',
/**
- * Adds an {@link Ext.Element} object to the menu
- * @param {Mixed} el The element or DOM node to add, or its id
- * @return {Ext.menu.Item} The menu item that was added
+ * @cfg {Number} scrollDelta
+ * Number of pixels to scroll when scrolling with mousewheel.
+ * Defaults to 40.
*/
- addElement : function(el){
- return this.add(new Ext.menu.BaseItem({
- el: el
- }));
- },
+ scrollDelta: 40,
/**
- * Adds an existing object based on {@link Ext.menu.BaseItem} to the menu
- * @param {Ext.menu.Item} item The menu item to add
- * @return {Ext.menu.Item} The menu item that was added
+ * @cfg {String/Boolean} scroll
+ * Valid values are 'both', 'horizontal' or 'vertical'. true implies 'both'. false implies 'none'.
+ * Defaults to true.
*/
- addItem : function(item){
- return this.add(item);
- },
+ scroll: true,
/**
- * Creates a new {@link Ext.menu.Item} based an the supplied config object and adds it to the menu
- * @param {Object} config A MenuItem config object
- * @return {Ext.menu.Item} The menu item that was added
+ * @cfg {Array} columns
+ * An array of {@link Ext.grid.column.Column column} definition objects which define all columns that appear in this grid. Each
+ * column definition provides the header text for the column, and a definition of where the data for that column comes from.
*/
- addMenuItem : function(config){
- return this.add(this.getMenuItem(config));
- },
/**
- * Creates a new {@link Ext.menu.TextItem} with the supplied text and adds it to the menu
- * @param {String} text The text to display in the menu item
- * @return {Ext.menu.Item} The menu item that was added
+ * @cfg {Boolean} forceFit
+ * Specify as true
to force the columns to fit into the available width. Headers are first sized according to configuration, whether that be
+ * a specific width, or flex. Then they are all proportionally changed in width so that the entire content width is used..
*/
- addText : function(text){
- return this.add(new Ext.menu.TextItem(text));
- },
-
- //private
- onDestroy : function(){
- Ext.EventManager.removeResizeListener(this.hide, this);
- var pm = this.parentMenu;
- if(pm && pm.activeChild == this){
- delete pm.activeChild;
- }
- delete this.parentMenu;
- Ext.menu.Menu.superclass.onDestroy.call(this);
- Ext.menu.MenuMgr.unregister(this);
- if(this.keyNav) {
- this.keyNav.disable();
- }
- var s = this.scroller;
- if(s){
- Ext.destroy(s.topRepeater, s.bottomRepeater, s.top, s.bottom);
- }
- Ext.destroy(
- this.el,
- this.focusEl,
- this.ul
- );
- }
-});
-
-Ext.reg('menu', Ext.menu.Menu);
-// MenuNav is a private utility class used internally by the Menu
-Ext.menu.MenuNav = Ext.extend(Ext.KeyNav, function(){
- function up(e, m){
- if(!m.tryActivate(m.items.indexOf(m.activeItem)-1, -1)){
- m.tryActivate(m.items.length-1, -1);
- }
- }
- function down(e, m){
- if(!m.tryActivate(m.items.indexOf(m.activeItem)+1, 1)){
- m.tryActivate(0, 1);
- }
- }
- return {
- constructor : function(menu){
- Ext.menu.MenuNav.superclass.constructor.call(this, menu.el);
- this.scope = this.menu = menu;
- },
+ /**
+ * @cfg {Boolean} hideHeaders
+ * Specify as true
to hide the headers.
+ */
- doRelay : function(e, h){
- var k = e.getKey();
-// Keystrokes within a form Field (e.g.: down in a Combo) do not navigate. Allow only TAB
- if (this.menu.activeItem && this.menu.activeItem.isFormField && k != e.TAB) {
- return false;
- }
- if(!this.menu.activeItem && e.isNavKeyPress() && k != e.SPACE && k != e.RETURN){
- this.menu.tryActivate(0, 1);
- return false;
- }
- return h.call(this.scope || this, e, this.menu);
- },
+ /**
+ * @cfg {Boolean} sortableColumns
+ * Defaults to true. Set to false to disable column sorting via clicking the
+ * header and via the Sorting menu items.
+ */
+ sortableColumns: true,
- tab: function(e, m) {
- e.stopEvent();
- if (e.shiftKey) {
- up(e, m);
- } else {
- down(e, m);
- }
- },
+ verticalScrollDock: 'right',
+ verticalScrollerType: 'gridscroller',
- up : up,
+ horizontalScrollerPresentCls: Ext.baseCSSPrefix + 'horizontal-scroller-present',
+ verticalScrollerPresentCls: Ext.baseCSSPrefix + 'vertical-scroller-present',
- down : down,
+ // private property used to determine where to go down to find views
+ // this is here to support locking.
+ scrollerOwner: true,
- right : function(e, m){
- if(m.activeItem){
- m.activeItem.expandMenu(true);
- }
- },
+ invalidateScrollerOnRefresh: true,
+
+ enableColumnMove: true,
+ enableColumnResize: true,
- left : function(e, m){
- m.hide();
- if(m.parentMenu && m.parentMenu.activeItem){
- m.parentMenu.activeItem.activate();
- }
- },
- enter : function(e, m){
- if(m.activeItem){
- e.stopPropagation();
- m.activeItem.onClick(e);
- m.fireEvent('click', this, m.activeItem);
- return true;
- }
+ initComponent: function() {
+ if (!this.viewType) {
+ Ext.Error.raise("You must specify a viewType config.");
+ }
+ if (!this.store) {
+ Ext.Error.raise("You must specify a store config");
+ }
+ if (this.headers) {
+ Ext.Error.raise("The headers config is not supported. Please specify columns instead.");
}
- };
-}());
-/**
- * @class Ext.menu.MenuMgr
- * Provides a common registry of all menu items on a page so that they can be easily accessed by id.
- * @singleton
- */
-Ext.menu.MenuMgr = function(){
- var menus, active, groups = {}, attached = false, lastShow = new Date();
-
- // private - called when first menu is created
- function init(){
- menus = {};
- active = new Ext.util.MixedCollection();
- Ext.getDoc().addKeyListener(27, function(){
- if(active.length > 0){
- hideAll();
- }
- });
- }
-
- // private
- function hideAll(){
- if(active && active.length > 0){
- var c = active.clone();
- c.each(function(m){
- m.hide();
- });
- return true;
- }
- return false;
- }
- // private
- function onHide(m){
- active.remove(m);
- if(active.length < 1){
- Ext.getDoc().un("mousedown", onMouseDown);
- attached = false;
- }
- }
+ var me = this,
+ scroll = me.scroll,
+ vertical = false,
+ horizontal = false,
+ headerCtCfg = me.columns || me.colModel,
+ i = 0,
+ view,
+ border = me.border;
- // private
- function onShow(m){
- var last = active.last();
- lastShow = new Date();
- active.add(m);
- if(!attached){
- Ext.getDoc().on("mousedown", onMouseDown);
- attached = true;
- }
- if(m.parentMenu){
- m.getEl().setZIndex(parseInt(m.parentMenu.getEl().getStyle("z-index"), 10) + 3);
- m.parentMenu.activeChild = m;
- }else if(last && !last.isDestroyed && last.isVisible()){
- m.getEl().setZIndex(parseInt(last.getEl().getStyle("z-index"), 10) + 3);
- }
- }
+ // Set our determinScrollbars method to reference a buffered call to determinScrollbars which fires on a 30ms buffer.
+ me.determineScrollbars = Ext.Function.createBuffered(me.determineScrollbars, 30);
+ me.injectView = Ext.Function.createBuffered(me.injectView, 30);
- // private
- function onBeforeHide(m){
- if(m.activeChild){
- m.activeChild.hide();
- }
- if(m.autoHideTimer){
- clearTimeout(m.autoHideTimer);
- delete m.autoHideTimer;
- }
- }
+ if (me.hideHeaders) {
+ border = false;
+ }
- // private
- function onBeforeShow(m){
- var pm = m.parentMenu;
- if(!pm && !m.allowOtherMenus){
- hideAll();
- }else if(pm && pm.activeChild){
- pm.activeChild.hide();
- }
- }
+ // The columns/colModel config may be either a fully instantiated HeaderContainer, or an array of Column definitions, or a config object of a HeaderContainer
+ // Either way, we extract a columns property referencing an array of Column definitions.
+ if (headerCtCfg instanceof Ext.grid.header.Container) {
+ me.headerCt = headerCtCfg;
+ me.headerCt.border = border;
+ me.columns = me.headerCt.items.items;
+ } else {
+ if (Ext.isArray(headerCtCfg)) {
+ headerCtCfg = {
+ items: headerCtCfg,
+ border: border
+ };
+ }
+ Ext.apply(headerCtCfg, {
+ forceFit: me.forceFit,
+ sortable: me.sortableColumns,
+ enableColumnMove: me.enableColumnMove,
+ enableColumnResize: me.enableColumnResize,
+ border: border
+ });
+ me.columns = headerCtCfg.items;
- // private
- function onMouseDown(e){
- if(lastShow.getElapsed() > 50 && active.length > 0 && !e.getTarget(".x-menu")){
- hideAll();
- }
- }
+ // If any of the Column objects contain a locked property, and are not processed, this is a lockable TablePanel, a
+ // special view will be injected by the Ext.grid.Lockable mixin, so no processing of .
+ if (Ext.ComponentQuery.query('{locked !== undefined}{processed != true}', me.columns).length) {
+ me.self.mixin('lockable', Ext.grid.Lockable);
+ me.injectLockable();
+ }
+ }
- // private
- function onBeforeCheck(mi, state){
- if(state){
- var g = groups[mi.group];
- for(var i = 0, l = g.length; i < l; i++){
- if(g[i] != mi){
- g[i].setChecked(false);
- }
- }
- }
- }
+ me.store = Ext.data.StoreManager.lookup(me.store);
+ me.addEvents(
+ /**
+ * @event scrollerhide
+ * Fires when a scroller is hidden
+ * @param {Ext.grid.Scroller} scroller
+ * @param {String} orientation Orientation, can be 'vertical' or 'horizontal'
+ */
+ 'scrollerhide',
+ /**
+ * @event scrollershow
+ * Fires when a scroller is shown
+ * @param {Ext.grid.Scroller} scroller
+ * @param {String} orientation Orientation, can be 'vertical' or 'horizontal'
+ */
+ 'scrollershow'
+ );
- return {
+ me.bodyCls = me.bodyCls || '';
+ me.bodyCls += (' ' + me.extraBodyCls);
- /**
- * Hides all menus that are currently visible
- * @return {Boolean} success True if any active menus were hidden.
- */
- hideAll : function(){
- return hideAll();
- },
+ // autoScroll is not a valid configuration
+ delete me.autoScroll;
- // private
- register : function(menu){
- if(!menus){
- init();
- }
- menus[menu.id] = menu;
- menu.on({
- beforehide: onBeforeHide,
- hide: onHide,
- beforeshow: onBeforeShow,
- show: onShow
- });
- },
+ // If this TablePanel is lockable (Either configured lockable, or any of the defined columns has a 'locked' property)
+ // than a special lockable view containing 2 side-by-side grids will have been injected so we do not need to set up any UI.
+ if (!me.hasView) {
- /**
- * Returns a {@link Ext.menu.Menu} object
- * @param {String/Object} menu The string menu id, an existing menu object reference, or a Menu config that will
- * be used to generate and return a new Menu instance.
- * @return {Ext.menu.Menu} The specified menu, or null if none are found
- */
- get : function(menu){
- if(typeof menu == "string"){ // menu id
- if(!menus){ // not initialized, no menus to return
- return null;
- }
- return menus[menu];
- }else if(menu.events){ // menu instance
- return menu;
- }else if(typeof menu.length == 'number'){ // array of menu items?
- return new Ext.menu.Menu({items:menu});
- }else{ // otherwise, must be a config
- return Ext.create(menu, 'menu');
- }
- },
+ // If we were not configured with a ready-made headerCt (either by direct config with a headerCt property, or by passing
+ // a HeaderContainer instance as the 'columns' property, then go ahead and create one from the config object created above.
+ if (!me.headerCt) {
+ me.headerCt = Ext.create('Ext.grid.header.Container', headerCtCfg);
+ }
- // private
- unregister : function(menu){
- delete menus[menu.id];
- menu.un("beforehide", onBeforeHide);
- menu.un("hide", onHide);
- menu.un("beforeshow", onBeforeShow);
- menu.un("show", onShow);
- },
+ // Extract the array of Column objects
+ me.columns = me.headerCt.items.items;
- // private
- registerCheckable : function(menuItem){
- var g = menuItem.group;
- if(g){
- if(!groups[g]){
- groups[g] = [];
- }
- groups[g].push(menuItem);
- menuItem.on("beforecheckchange", onBeforeCheck);
- }
- },
+ if (me.hideHeaders) {
+ me.headerCt.height = 0;
+ me.headerCt.border = false;
+ me.headerCt.addCls(Ext.baseCSSPrefix + 'grid-header-ct-hidden');
+ me.addCls(Ext.baseCSSPrefix + 'grid-header-hidden');
+ // IE Quirks Mode fix
+ // If hidden configuration option was used, several layout calculations will be bypassed.
+ if (Ext.isIEQuirks) {
+ me.headerCt.style = {
+ display: 'none'
+ };
+ }
+ }
- // private
- unregisterCheckable : function(menuItem){
- var g = menuItem.group;
- if(g){
- groups[g].remove(menuItem);
- menuItem.un("beforecheckchange", onBeforeCheck);
- }
- },
+ // turn both on.
+ if (scroll === true || scroll === 'both') {
+ vertical = horizontal = true;
+ } else if (scroll === 'horizontal') {
+ horizontal = true;
+ } else if (scroll === 'vertical') {
+ vertical = true;
+ // All other values become 'none' or false.
+ } else {
+ me.headerCt.availableSpaceOffset = 0;
+ }
- getCheckedItem : function(groupId){
- var g = groups[groupId];
- if(g){
- for(var i = 0, l = g.length; i < l; i++){
- if(g[i].checked){
- return g[i];
- }
- }
- }
- return null;
- },
+ if (vertical) {
+ me.verticalScroller = me.verticalScroller || {};
+ Ext.applyIf(me.verticalScroller, {
+ dock: me.verticalScrollDock,
+ xtype: me.verticalScrollerType,
+ store: me.store
+ });
+ me.verticalScroller = Ext.ComponentManager.create(me.verticalScroller);
+ me.mon(me.verticalScroller, {
+ bodyscroll: me.onVerticalScroll,
+ scope: me
+ });
+ }
- setCheckedItem : function(groupId, itemId){
- var g = groups[groupId];
- if(g){
- for(var i = 0, l = g.length; i < l; i++){
- if(g[i].id == itemId){
- g[i].setChecked(true);
- }
- }
- }
- return null;
- }
- };
-}();
-/**
- * @class Ext.menu.BaseItem
- * @extends Ext.Component
- * The base class for all items that render into menus. BaseItem provides default rendering, activated state
- * management and base configuration options shared by all menu components.
- * @constructor
- * Creates a new BaseItem
- * @param {Object} config Configuration options
- * @xtype menubaseitem
- */
-Ext.menu.BaseItem = Ext.extend(Ext.Component, {
- /**
- * @property parentMenu
- * @type Ext.menu.Menu
- * The parent Menu of this Item.
- */
- /**
- * @cfg {Function} handler
- * A function that will handle the click event of this menu item (optional).
- * The handler is passed the following parameters:
- * b
: ItemThis menu Item.
- * e
: EventObjectThe click event.
- *
- */
- /**
- * @cfg {Object} scope
- * The scope (this reference) in which the handler function will be called.
- */
- /**
- * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to false)
- */
- canActivate : false,
- /**
- * @cfg {String} activeClass The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")
- */
- activeClass : "x-menu-item-active",
- /**
- * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to true)
- */
- hideOnClick : true,
- /**
- * @cfg {Number} clickHideDelay Length of time in milliseconds to wait before hiding after a click (defaults to 1)
- */
- clickHideDelay : 1,
+ if (horizontal) {
+ me.horizontalScroller = Ext.ComponentManager.create({
+ xtype: 'gridscroller',
+ section: me,
+ dock: 'bottom',
+ store: me.store
+ });
+ me.mon(me.horizontalScroller, {
+ bodyscroll: me.onHorizontalScroll,
+ scope: me
+ });
+ }
- // private
- ctype : "Ext.menu.BaseItem",
+ me.headerCt.on('columnresize', me.onHeaderResize, me);
+ me.relayEvents(me.headerCt, ['columnresize', 'columnmove', 'columnhide', 'columnshow', 'sortchange']);
+ me.features = me.features || [];
+ me.dockedItems = me.dockedItems || [];
+ me.dockedItems.unshift(me.headerCt);
+ me.viewConfig = me.viewConfig || {};
+ me.viewConfig.invalidateScrollerOnRefresh = me.invalidateScrollerOnRefresh;
- // private
- actionMode : "container",
+ // AbstractDataView will look up a Store configured as an object
+ // getView converts viewConfig into a View instance
+ view = me.getView();
- initComponent : function(){
- Ext.menu.BaseItem.superclass.initComponent.call(this);
- this.addEvents(
- /**
- * @event click
- * Fires when this item is clicked
- * @param {Ext.menu.BaseItem} this
- * @param {Ext.EventObject} e
- */
- 'click',
- /**
- * @event activate
- * Fires when this item is activated
- * @param {Ext.menu.BaseItem} this
- */
- 'activate',
- /**
- * @event deactivate
- * Fires when this item is deactivated
- * @param {Ext.menu.BaseItem} this
- */
- 'deactivate'
- );
- if(this.handler){
- this.on("click", this.handler, this.scope);
- }
+ if (view) {
+ me.mon(view.store, {
+ load: me.onStoreLoad,
+ scope: me
+ });
+ me.mon(view, {
+ refresh: {
+ fn: this.onViewRefresh,
+ scope: me,
+ buffer: 50
+ },
+ itemupdate: me.onViewItemUpdate,
+ scope: me
+ });
+ this.relayEvents(view, [
+ /**
+ * @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
+ */
+ 'beforeitemmousedown',
+ /**
+ * @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
+ */
+ 'beforeitemmouseup',
+ /**
+ * @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
+ */
+ 'beforeitemmouseenter',
+ /**
+ * @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
+ */
+ 'beforeitemmouseleave',
+ /**
+ * @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
+ */
+ 'beforeitemclick',
+ /**
+ * @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
+ */
+ 'beforeitemdblclick',
+ /**
+ * @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
+ */
+ 'beforeitemcontextmenu',
+ /**
+ * @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 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 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 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'
+ ]);
+ }
+ }
+ me.callParent(arguments);
+ },
+
+ // state management
+ initStateEvents: function(){
+ var events = this.stateEvents;
+ // push on stateEvents if they don't exist
+ Ext.each(['columnresize', 'columnmove', 'columnhide', 'columnshow', 'sortchange'], function(event){
+ if (Ext.Array.indexOf(events, event)) {
+ events.push(event);
+ }
+ });
+ this.callParent();
},
- // private
- onRender : function(container, position){
- Ext.menu.BaseItem.superclass.onRender.apply(this, arguments);
- if(this.ownerCt && this.ownerCt instanceof Ext.menu.Menu){
- this.parentMenu = this.ownerCt;
- }else{
- this.container.addClass('x-menu-list-item');
- this.mon(this.el, {
- scope: this,
- click: this.onClick,
- mouseenter: this.activate,
- mouseleave: this.deactivate
+ getState: function(){
+ var state = {
+ columns: []
+ },
+ sorter = this.store.sorters.first();
+
+ this.headerCt.items.each(function(header){
+ state.columns.push({
+ id: header.headerId,
+ width: header.flex ? undefined : header.width,
+ hidden: header.hidden,
+ sortable: header.sortable
});
- }
- },
-
- /**
- * Sets the function that will handle click events for this item (equivalent to passing in the {@link #handler}
- * config property). If an existing handler is already registered, it will be unregistered for you.
- * @param {Function} handler The function that should be called on click
- * @param {Object} scope The scope (this
reference) in which the handler function is executed. Defaults to this menu item.
- */
- setHandler : function(handler, scope){
- if(this.handler){
- this.un("click", this.handler, this.scope);
- }
- this.on("click", this.handler = handler, this.scope = scope);
- },
+ });
- // private
- onClick : function(e){
- if(!this.disabled && this.fireEvent("click", this, e) !== false
- && (this.parentMenu && this.parentMenu.fireEvent("itemclick", this, e) !== false)){
- this.handleClick(e);
- }else{
- e.stopEvent();
+ if (sorter) {
+ state.sort = {
+ property: sorter.property,
+ direction: sorter.direction
+ };
}
+ return state;
},
- // private
- activate : function(){
- if(this.disabled){
- return false;
+ applyState: function(state) {
+ var headers = state.columns,
+ length = headers ? headers.length : 0,
+ headerCt = this.headerCt,
+ items = headerCt.items,
+ sorter = state.sort,
+ store = this.store,
+ i = 0,
+ index,
+ headerState,
+ header;
+
+ for (; i < length; ++i) {
+ headerState = headers[i];
+ header = headerCt.down('gridcolumn[headerId=' + headerState.id + ']');
+ index = items.indexOf(header);
+ if (i !== index) {
+ headerCt.moveHeader(index, i);
+ }
+ header.sortable = headerState.sortable;
+ if (Ext.isDefined(headerState.width)) {
+ delete header.flex;
+ if (header.rendered) {
+ header.setWidth(headerState.width);
+ } else {
+ header.minWidth = header.width = headerState.width;
+ }
+ }
+ header.hidden = headerState.hidden;
}
- var li = this.container;
- li.addClass(this.activeClass);
- this.region = li.getRegion().adjust(2, 2, -2, -2);
- this.fireEvent("activate", this);
- return true;
- },
-
- // private
- deactivate : function(){
- this.container.removeClass(this.activeClass);
- this.fireEvent("deactivate", this);
- },
-
- // private
- shouldDeactivate : function(e){
- return !this.region || !this.region.contains(e.getPoint());
- },
- // private
- handleClick : function(e){
- var pm = this.parentMenu;
- if(this.hideOnClick){
- if(pm.floating){
- pm.hide.defer(this.clickHideDelay, pm, [true]);
- }else{
- pm.deactivateActive();
+ if (sorter) {
+ if (store.remoteSort) {
+ store.sorters.add(Ext.create('Ext.util.Sorter', {
+ property: sorter.property,
+ direction: sorter.direction
+ }));
+ }
+ else {
+ store.sort(sorter.property, sorter.direction);
}
}
},
- // private. Do nothing
- expandMenu : Ext.emptyFn,
-
- // private. Do nothing
- hideMenu : Ext.emptyFn
-});
-Ext.reg('menubaseitem', Ext.menu.BaseItem);/**
- * @class Ext.menu.TextItem
- * @extends Ext.menu.BaseItem
- * Adds a static text string to a menu, usually used as either a heading or group separator.
- * @constructor
- * Creates a new TextItem
- * @param {Object/String} config If config is a string, it is used as the text to display, otherwise it
- * is applied as a config object (and should contain a text property).
- * @xtype menutextitem
- */
-Ext.menu.TextItem = Ext.extend(Ext.menu.BaseItem, {
- /**
- * @cfg {String} text The text to display for this item (defaults to '')
- */
/**
- * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false)
+ * Returns the store associated with this Panel.
+ * @return {Ext.data.Store} The store
*/
- hideOnClick : false,
+ getStore: function(){
+ return this.store;
+ },
+
/**
- * @cfg {String} itemCls The default CSS class to use for text items (defaults to "x-menu-text")
+ * Gets the view for this panel.
+ * @return {Ext.view.Table}
*/
- itemCls : "x-menu-text",
-
- constructor : function(config){
- if(typeof config == 'string'){
- config = {text: config}
+ getView: function() {
+ var me = this,
+ sm;
+
+ if (!me.view) {
+ sm = me.getSelectionModel();
+ me.view = me.createComponent(Ext.apply({}, me.viewConfig, {
+ xtype: me.viewType,
+ store: me.store,
+ headerCt: me.headerCt,
+ selModel: sm,
+ features: me.features,
+ panel: me
+ }));
+ me.mon(me.view, {
+ uievent: me.processEvent,
+ scope: me
+ });
+ sm.view = me.view;
+ me.headerCt.view = me.view;
+ me.relayEvents(me.view, ['cellclick', 'celldblclick']);
}
- Ext.menu.TextItem.superclass.constructor.call(this, config);
+ return me.view;
},
- // private
- onRender : function(){
- var s = document.createElement("span");
- s.className = this.itemCls;
- s.innerHTML = this.text;
- this.el = s;
- Ext.menu.TextItem.superclass.onRender.apply(this, arguments);
- }
-});
-Ext.reg('menutextitem', Ext.menu.TextItem);/**
- * @class Ext.menu.Separator
- * @extends Ext.menu.BaseItem
- * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
- * add one of these by using "-" in you call to add() or in your items config rather than creating one directly.
- * @constructor
- * @param {Object} config Configuration options
- * @xtype menuseparator
- */
-Ext.menu.Separator = Ext.extend(Ext.menu.BaseItem, {
- /**
- * @cfg {String} itemCls The default CSS class to use for separators (defaults to "x-menu-sep")
- */
- itemCls : "x-menu-sep",
/**
- * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false)
+ * @private
+ * @override
+ * autoScroll is never valid for all classes which extend TablePanel.
*/
- hideOnClick : false,
+ setAutoScroll: Ext.emptyFn,
+
+ // This method hijacks Ext.view.Table's el scroll method.
+ // This enables us to keep the virtualized scrollbars in sync
+ // with the view. It currently does NOT support animation.
+ elScroll: function(direction, distance, animate) {
+ var me = this,
+ scroller;
+
+ if (direction === "up" || direction === "left") {
+ distance = -distance;
+ }
+
+ if (direction === "down" || direction === "up") {
+ scroller = me.getVerticalScroller();
+ scroller.scrollByDeltaY(distance);
+ } else {
+ scroller = me.getHorizontalScroller();
+ scroller.scrollByDeltaX(distance);
+ }
+ },
+
+ afterLayout: function() {
+ this.callParent(arguments);
+ this.injectView();
+ },
- /**
- * @cfg {String} activeClass
- * @hide
- */
- activeClass: '',
- // private
- onRender : function(li){
- var s = document.createElement("span");
- s.className = this.itemCls;
- s.innerHTML = " ";
- this.el = s;
- li.addClass("x-menu-sep-li");
- Ext.menu.Separator.superclass.onRender.apply(this, arguments);
- }
-});
-Ext.reg('menuseparator', Ext.menu.Separator);/**
- * @class Ext.menu.Item
- * @extends Ext.menu.BaseItem
- * A base class for all menu items that require menu-related functionality (like sub-menus) and are not static
- * display items. Item extends the base functionality of {@link Ext.menu.BaseItem} by adding menu-specific
- * activation and click handling.
- * @constructor
- * Creates a new Item
- * @param {Object} config Configuration options
- * @xtype menuitem
- */
-Ext.menu.Item = Ext.extend(Ext.menu.BaseItem, {
- /**
- * @property menu
- * @type Ext.menu.Menu
- * The submenu associated with this Item if one was configured.
- */
- /**
- * @cfg {Mixed} menu (optional) Either an instance of {@link Ext.menu.Menu} or the config object for an
- * {@link Ext.menu.Menu} which acts as the submenu when this item is activated.
- */
/**
- * @cfg {String} icon The path to an icon to display in this item (defaults to Ext.BLANK_IMAGE_URL). If
- * icon is specified {@link #iconCls} should not be.
- */
- /**
- * @cfg {String} iconCls A CSS class that specifies a background image that will be used as the icon for
- * this item (defaults to ''). If iconCls is specified {@link #icon} should not be.
- */
- /**
- * @cfg {String} text The text to display in this item (defaults to '').
- */
- /**
- * @cfg {String} href The href attribute to use for the underlying anchor link (defaults to '#').
- */
- /**
- * @cfg {String} hrefTarget The target attribute to use for the underlying anchor link (defaults to '').
- */
- /**
- * @cfg {String} itemCls The default CSS class to use for menu items (defaults to 'x-menu-item')
- */
- itemCls : 'x-menu-item',
+ * @private
+ * Called after this Component has achieved its correct initial size, after all layouts have done their thing.
+ * This is so we can add the View only after the initial size is known. This method is buffered 30ms.
+ */
+ injectView: function() {
+ if (!this.hasView && !this.collapsed) {
+ var me = this,
+ view = me.getView();
+
+ me.hasView = true;
+ me.add(view);
+
+ // hijack the view el's scroll method
+ view.el.scroll = Ext.Function.bind(me.elScroll, me);
+ // We use to listen to document.body wheel events, but that's a
+ // little much. We scope just to the view now.
+ me.mon(view.el, {
+ mousewheel: me.onMouseWheel,
+ scope: me
+ });
+ }
+ },
+
+ afterExpand: function() {
+ this.callParent(arguments);
+ if (!this.hasView) {
+ this.injectView();
+ }
+ },
+
/**
- * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to true)
- */
- canActivate : true,
+ * @private
+ * Process UI events from the view. Propagate them to whatever internal Components need to process them
+ * @param {String} type Event type, eg 'click'
+ * @param {TableView} view TableView Component
+ * @param {HtmlElement} cell Cell HtmlElement the event took place within
+ * @param {Number} recordIndex Index of the associated Store Model (-1 if none)
+ * @param {Number} cellIndex Cell index within the row
+ * @param {EventObject} e Original event
+ */
+ processEvent: function(type, view, cell, recordIndex, cellIndex, e) {
+ var me = this,
+ header;
+
+ if (cellIndex !== -1) {
+ header = me.headerCt.getGridColumns()[cellIndex];
+ return header.processEvent.apply(header, arguments);
+ }
+ },
+
/**
- * @cfg {Number} showDelay Length of time in milliseconds to wait before showing this item (defaults to 200)
+ * Request a recalculation of scrollbars and put them in if they are needed.
*/
- showDelay: 200,
- // doc'd in BaseItem
- hideDelay: 200,
+ determineScrollbars: function() {
+ var me = this,
+ viewElDom,
+ centerScrollWidth,
+ centerClientWidth,
+ scrollHeight,
+ clientHeight;
+
+ if (!me.collapsed && me.view && me.view.el) {
+ viewElDom = me.view.el.dom;
+ //centerScrollWidth = viewElDom.scrollWidth;
+ centerScrollWidth = me.headerCt.getFullWidth();
+ /**
+ * clientWidth often returns 0 in IE resulting in an
+ * infinity result, here we use offsetWidth bc there are
+ * no possible scrollbars and we don't care about margins
+ */
+ centerClientWidth = viewElDom.offsetWidth;
+ if (me.verticalScroller && me.verticalScroller.el) {
+ scrollHeight = me.verticalScroller.getSizeCalculation().height;
+ } else {
+ scrollHeight = viewElDom.scrollHeight;
+ }
- // private
- ctype: 'Ext.menu.Item',
+ clientHeight = viewElDom.clientHeight;
- initComponent : function(){
- Ext.menu.Item.superclass.initComponent.call(this);
- if(this.menu){
- this.menu = Ext.menu.MenuMgr.get(this.menu);
- this.menu.ownerCt = this;
+ if (!me.collapsed && scrollHeight > clientHeight) {
+ me.showVerticalScroller();
+ } else {
+ me.hideVerticalScroller();
+ }
+
+ if (!me.collapsed && centerScrollWidth > (centerClientWidth + Ext.getScrollBarWidth() - 2)) {
+ me.showHorizontalScroller();
+ } else {
+ me.hideHorizontalScroller();
+ }
}
},
- // private
- onRender : function(container, position){
- if (!this.itemTpl) {
- this.itemTpl = Ext.menu.Item.prototype.itemTpl = new Ext.XTemplate(
- '',
- ' target="{hrefTarget}"',
- '',
- '>',
- '',
- ''
- );
+ onHeaderResize: function() {
+ if (this.view && this.view.rendered) {
+ this.determineScrollbars();
+ this.invalidateScroller();
}
- var a = this.getTemplateArgs();
- this.el = position ? this.itemTpl.insertBefore(position, a, true) : this.itemTpl.append(container, a, true);
- this.iconEl = this.el.child('img.x-menu-item-icon');
- this.textEl = this.el.child('.x-menu-item-text');
- if(!this.href) { // if no link defined, prevent the default anchor event
- this.mon(this.el, 'click', Ext.emptyFn, null, { preventDefault: true });
- }
- Ext.menu.Item.superclass.onRender.call(this, container, position);
},
- getTemplateArgs: function() {
- return {
- id: this.id,
- cls: this.itemCls + (this.menu ? ' x-menu-item-arrow' : '') + (this.cls ? ' ' + this.cls : ''),
- href: this.href || '#',
- hrefTarget: this.hrefTarget,
- icon: this.icon || Ext.BLANK_IMAGE_URL,
- iconCls: this.iconCls || '',
- text: this.itemText||this.text||' '
- };
+ /**
+ * Hide the verticalScroller and remove the horizontalScrollerPresentCls.
+ */
+ hideHorizontalScroller: function() {
+ var me = this;
+
+ if (me.horizontalScroller && me.horizontalScroller.ownerCt === me) {
+ me.verticalScroller.offsets.bottom = 0;
+ me.removeDocked(me.horizontalScroller, false);
+ me.removeCls(me.horizontalScrollerPresentCls);
+ me.fireEvent('scrollerhide', me.horizontalScroller, 'horizontal');
+ }
+
},
/**
- * Sets the text to display in this menu item
- * @param {String} text The text to display
+ * Show the horizontalScroller and add the horizontalScrollerPresentCls.
*/
- setText : function(text){
- this.text = text||' ';
- if(this.rendered){
- this.textEl.update(this.text);
- this.parentMenu.layout.doAutoSize();
+ showHorizontalScroller: function() {
+ var me = this;
+
+ if (me.verticalScroller) {
+ me.verticalScroller.offsets.bottom = Ext.getScrollBarWidth() - 2;
+ }
+ if (me.horizontalScroller && me.horizontalScroller.ownerCt !== me) {
+ me.addDocked(me.horizontalScroller);
+ me.addCls(me.horizontalScrollerPresentCls);
+ me.fireEvent('scrollershow', me.horizontalScroller, 'horizontal');
}
},
/**
- * Sets the CSS class to apply to the item's icon element
- * @param {String} cls The CSS class to apply
+ * Hide the verticalScroller and remove the verticalScrollerPresentCls.
*/
- setIconClass : function(cls){
- var oldCls = this.iconCls;
- this.iconCls = cls;
- if(this.rendered){
- this.iconEl.replaceClass(oldCls, this.iconCls);
+ hideVerticalScroller: function() {
+ var me = this,
+ headerCt = me.headerCt;
+
+ // only trigger a layout when reserveOffset is changing
+ if (headerCt && headerCt.layout.reserveOffset) {
+ headerCt.layout.reserveOffset = false;
+ headerCt.doLayout();
+ }
+ if (me.verticalScroller && me.verticalScroller.ownerCt === me) {
+ me.removeDocked(me.verticalScroller, false);
+ me.removeCls(me.verticalScrollerPresentCls);
+ me.fireEvent('scrollerhide', me.verticalScroller, 'vertical');
}
},
- //private
- beforeDestroy: function(){
- if (this.menu){
- delete this.menu.ownerCt;
- this.menu.destroy();
+ /**
+ * Show the verticalScroller and add the verticalScrollerPresentCls.
+ */
+ showVerticalScroller: function() {
+ var me = this,
+ headerCt = me.headerCt;
+
+ // only trigger a layout when reserveOffset is changing
+ if (headerCt && !headerCt.layout.reserveOffset) {
+ headerCt.layout.reserveOffset = true;
+ headerCt.doLayout();
+ }
+ if (me.verticalScroller && me.verticalScroller.ownerCt !== me) {
+ me.addDocked(me.verticalScroller);
+ me.addCls(me.verticalScrollerPresentCls);
+ me.fireEvent('scrollershow', me.verticalScroller, 'vertical');
}
- Ext.menu.Item.superclass.beforeDestroy.call(this);
},
- // private
- handleClick : function(e){
- if(!this.href){ // if no link defined, stop the event automatically
- e.stopEvent();
+ /**
+ * Invalides scrollers that are present and forces a recalculation.
+ * (Not related to showing/hiding the scrollers)
+ */
+ invalidateScroller: function() {
+ var me = this,
+ vScroll = me.verticalScroller,
+ hScroll = me.horizontalScroller;
+
+ if (vScroll) {
+ vScroll.invalidate();
+ }
+ if (hScroll) {
+ hScroll.invalidate();
}
- Ext.menu.Item.superclass.handleClick.apply(this, arguments);
},
- // private
- activate : function(autoExpand){
- if(Ext.menu.Item.superclass.activate.apply(this, arguments)){
- this.focus();
- if(autoExpand){
- this.expandMenu();
- }
- }
- return true;
+ // refresh the view when a header moves
+ onHeaderMove: function(headerCt, header, fromIdx, toIdx) {
+ this.view.refresh();
},
- // private
- shouldDeactivate : function(e){
- if(Ext.menu.Item.superclass.shouldDeactivate.call(this, e)){
- if(this.menu && this.menu.isVisible()){
- return !this.menu.getEl().getRegion().contains(e.getPoint());
- }
- return true;
- }
- return false;
+ // Section onHeaderHide is invoked after view.
+ onHeaderHide: function(headerCt, header) {
+ this.invalidateScroller();
},
- // private
- deactivate : function(){
- Ext.menu.Item.superclass.deactivate.apply(this, arguments);
- this.hideMenu();
+ onHeaderShow: function(headerCt, header) {
+ this.invalidateScroller();
},
- // private
- expandMenu : function(autoActivate){
- if(!this.disabled && this.menu){
- clearTimeout(this.hideTimer);
- delete this.hideTimer;
- if(!this.menu.isVisible() && !this.showTimer){
- this.showTimer = this.deferExpand.defer(this.showDelay, this, [autoActivate]);
- }else if (this.menu.isVisible() && autoActivate){
- this.menu.tryActivate(0, 1);
+ getVerticalScroller: function() {
+ return this.getScrollerOwner().down('gridscroller[dock=' + this.verticalScrollDock + ']');
+ },
+
+ getHorizontalScroller: function() {
+ return this.getScrollerOwner().down('gridscroller[dock=bottom]');
+ },
+
+ onMouseWheel: function(e) {
+ var me = this,
+ browserEvent = e.browserEvent,
+ vertScroller = me.getVerticalScroller(),
+ horizScroller = me.getHorizontalScroller(),
+ scrollDelta = me.scrollDelta,
+ deltaY, deltaX,
+ vertScrollerEl, horizScrollerEl,
+ origScrollLeft, origScrollTop,
+ newScrollLeft, newScrollTop;
+
+ // Track original scroll values, so we can see if we've
+ // reached the end of our scroll height/width.
+ if (horizScroller) {
+ horizScrollerEl = horizScroller.el;
+ if (horizScrollerEl) {
+ origScrollLeft = horizScrollerEl.dom.scrollLeft;
+ }
+ }
+ if (vertScroller) {
+ vertScrollerEl = vertScroller.el;
+ if (vertScrollerEl) {
+ origScrollTop = vertScrollerEl.dom.scrollTop;
+ }
+ }
+
+ // Webkit Horizontal Axis
+ if (browserEvent.wheelDeltaX || browserEvent.wheelDeltaY) {
+ deltaX = -browserEvent.wheelDeltaX / 120 * scrollDelta / 3;
+ deltaY = -browserEvent.wheelDeltaY / 120 * scrollDelta / 3;
+ if (horizScroller) {
+ newScrollLeft = horizScroller.scrollByDeltaX(deltaX);
+ }
+ if (vertScroller) {
+ newScrollTop = vertScroller.scrollByDeltaY(deltaY);
+ }
+ } else {
+ // Gecko Horizontal Axis
+ if (browserEvent.axis && browserEvent.axis === 1) {
+ if (horizScroller) {
+ deltaX = -(scrollDelta * e.getWheelDelta()) / 3;
+ newScrollLeft = horizScroller.scrollByDeltaX(deltaX);
+ }
+ } else {
+ if (vertScroller) {
+
+ deltaY = -(scrollDelta * e.getWheelDelta() / 3);
+ newScrollTop = vertScroller.scrollByDeltaY(deltaY);
+ }
}
}
+
+ // If after given our delta, the scroller has not progressed, then we're
+ // at the end of our scroll range and shouldn't stop the browser event.
+ if ((deltaX !== 0 && newScrollLeft !== origScrollLeft) ||
+ (deltaY !== 0 && newScrollTop !== origScrollTop)) {
+ e.stopEvent();
+ }
},
- // private
- deferExpand : function(autoActivate){
- delete this.showTimer;
- this.menu.show(this.container, this.parentMenu.subMenuAlign || 'tl-tr?', this.parentMenu);
- if(autoActivate){
- this.menu.tryActivate(0, 1);
+ /**
+ * @private
+ * Determine and invalidate scrollers on view refresh
+ */
+ onViewRefresh: function() {
+ if (Ext.isIE) {
+ this.syncCellHeight();
+ }
+ this.determineScrollbars();
+ if (this.invalidateScrollerOnRefresh) {
+ this.invalidateScroller();
}
},
- // private
- hideMenu : function(){
- clearTimeout(this.showTimer);
- delete this.showTimer;
- if(!this.hideTimer && this.menu && this.menu.isVisible()){
- this.hideTimer = this.deferHide.defer(this.hideDelay, this);
+ onViewItemUpdate: function(record, index, tr) {
+ if (Ext.isIE) {
+ this.syncCellHeight([tr]);
}
},
- // private
- deferHide : function(){
- delete this.hideTimer;
- if(this.menu.over){
- this.parentMenu.setActiveItem(this, false);
- }else{
- this.menu.hide();
+ // BrowserBug: IE will not stretch the td to fit the height of the entire
+ // tr, so manually sync cellheights on refresh and when an item has been
+ // updated.
+ syncCellHeight: function(trs) {
+ var me = this,
+ i = 0,
+ tds,
+ j, tdsLn,
+ tr, td,
+ trsLn,
+ rowHeights = [],
+ cellHeights,
+ cellClsSelector = ('.' + Ext.baseCSSPrefix + 'grid-cell');
+
+ trs = trs || me.view.getNodes();
+
+ trsLn = trs.length;
+ // Reading loop
+ for (; i < trsLn; i++) {
+ tr = trs[i];
+ tds = Ext.fly(tr).query(cellClsSelector);
+ tdsLn = tds.length;
+ cellHeights = [];
+ for (j = 0; j < tdsLn; j++) {
+ td = tds[j];
+ cellHeights.push(td.clientHeight);
+ }
+ rowHeights.push(Ext.Array.max(cellHeights));
+ }
+
+ // Setting loop
+ for (i = 0; i < trsLn; i++) {
+ tr = trs[i];
+ tdsLn = tr.childNodes.length;
+ for (j = 0; j < tdsLn; j++) {
+ td = Ext.fly(tr.childNodes[j]);
+ if (rowHeights[i]) {
+ if (td.is(cellClsSelector)) {
+ td.setHeight(rowHeights[i]);
+ } else {
+ td.down(cellClsSelector).setHeight(rowHeights[i]);
+ }
+ }
+
+ }
}
- }
-});
-Ext.reg('menuitem', Ext.menu.Item);/**
- * @class Ext.menu.CheckItem
- * @extends Ext.menu.Item
- * Adds a menu item that contains a checkbox by default, but can also be part of a radio group.
- * @constructor
- * Creates a new CheckItem
- * @param {Object} config Configuration options
- * @xtype menucheckitem
- */
-Ext.menu.CheckItem = Ext.extend(Ext.menu.Item, {
- /**
- * @cfg {String} group
- * All check items with the same group name will automatically be grouped into a single-select
- * radio button group (defaults to '')
- */
- /**
- * @cfg {String} itemCls The default CSS class to use for check items (defaults to "x-menu-item x-menu-check-item")
- */
- itemCls : "x-menu-item x-menu-check-item",
- /**
- * @cfg {String} groupClass The default CSS class to use for radio group check items (defaults to "x-menu-group-item")
- */
- groupClass : "x-menu-group-item",
+ },
/**
- * @cfg {Boolean} checked True to initialize this checkbox as checked (defaults to false). Note that
- * if this checkbox is part of a radio group (group = true) only the last item in the group that is
- * initialized with checked = true will be rendered as checked.
+ * Sets the scrollTop of the TablePanel.
+ * @param {Number} deltaY
*/
- checked: false,
+ setScrollTop: function(top) {
+ var me = this,
+ rootCmp = me.getScrollerOwner(),
+ verticalScroller = me.getVerticalScroller();
- // private
- ctype: "Ext.menu.CheckItem",
-
- initComponent : function(){
- Ext.menu.CheckItem.superclass.initComponent.call(this);
- this.addEvents(
- /**
- * @event beforecheckchange
- * Fires before the checked value is set, providing an opportunity to cancel if needed
- * @param {Ext.menu.CheckItem} this
- * @param {Boolean} checked The new checked value that will be set
- */
- "beforecheckchange" ,
- /**
- * @event checkchange
- * Fires after the checked value has been set
- * @param {Ext.menu.CheckItem} this
- * @param {Boolean} checked The checked value that was set
- */
- "checkchange"
- );
- /**
- * A function that handles the checkchange event. The function is undefined by default, but if an implementation
- * is provided, it will be called automatically when the checkchange event fires.
- * @param {Ext.menu.CheckItem} this
- * @param {Boolean} checked The checked value that was set
- * @method checkHandler
- */
- if(this.checkHandler){
- this.on('checkchange', this.checkHandler, this.scope);
- }
- Ext.menu.MenuMgr.registerCheckable(this);
- },
-
- // private
- onRender : function(c){
- Ext.menu.CheckItem.superclass.onRender.apply(this, arguments);
- if(this.group){
- this.el.addClass(this.groupClass);
- }
- if(this.checked){
- this.checked = false;
- this.setChecked(true, true);
+ rootCmp.virtualScrollTop = top;
+ if (verticalScroller) {
+ verticalScroller.setScrollTop(top);
}
+
},
- // private
- destroy : function(){
- Ext.menu.MenuMgr.unregisterCheckable(this);
- Ext.menu.CheckItem.superclass.destroy.apply(this, arguments);
+ getScrollerOwner: function() {
+ var rootCmp = this;
+ if (!this.scrollerOwner) {
+ rootCmp = this.up('[scrollerOwner]');
+ }
+ return rootCmp;
},
/**
- * Set the checked state of this item
- * @param {Boolean} checked The new checked value
- * @param {Boolean} suppressEvent (optional) True to prevent the checkchange event from firing (defaults to false)
+ * Scrolls the TablePanel by deltaY
+ * @param {Number} deltaY
*/
- setChecked : function(state, suppressEvent){
- var suppress = suppressEvent === true;
- if(this.checked != state && (suppress || this.fireEvent("beforecheckchange", this, state) !== false)){
- if(this.container){
- this.container[state ? "addClass" : "removeClass"]("x-menu-item-checked");
- }
- this.checked = state;
- if(!suppress){
- this.fireEvent("checkchange", this, state);
- }
+ scrollByDeltaY: function(deltaY) {
+ var rootCmp = this.getScrollerOwner(),
+ scrollerRight;
+ scrollerRight = rootCmp.down('gridscroller[dock=' + this.verticalScrollDock + ']');
+ if (scrollerRight) {
+ scrollerRight.scrollByDeltaY(deltaY);
}
},
- // private
- handleClick : function(e){
- if(!this.disabled && !(this.checked && this.group)){// disable unselect on radio item
- this.setChecked(!this.checked);
- }
- Ext.menu.CheckItem.superclass.handleClick.apply(this, arguments);
- }
-});
-Ext.reg('menucheckitem', Ext.menu.CheckItem);/**
- * @class Ext.menu.DateMenu
- * @extends Ext.menu.Menu
- * ',
- 'A menu containing an {@link Ext.DatePicker} Component.
- * Notes:
- * - Although not listed here, the constructor for this class
- * accepts all of the configuration options of {@link Ext.DatePicker}.
- * - If subclassing DateMenu, any configuration options for the DatePicker must be
- * applied to the initialConfig property of the DateMenu.
- * Applying {@link Ext.DatePicker DatePicker} configuration settings to
- * this will not affect the DatePicker's configuration.
- *
- * @xtype datemenu
- */
- Ext.menu.DateMenu = Ext.extend(Ext.menu.Menu, {
- /**
- * @cfg {Boolean} enableScrolling
- * @hide
- */
- enableScrolling : false,
- /**
- * @cfg {Function} handler
- * Optional. A function that will handle the select event of this menu.
- * The handler is passed the following parameters:
- * picker
: DatePickerThe Ext.DatePicker.
- * date
: DateThe selected date.
- *
- */
+
/**
- * @cfg {Object} scope
- * The scope (this reference) in which the {@link #handler}
- * function will be called. Defaults to this DateMenu instance.
- */
- /**
- * @cfg {Boolean} hideOnClick
- * False to continue showing the menu after a date is selected, defaults to true.
- */
- hideOnClick : true,
-
- /**
- * @cfg {String} pickerId
- * An id to assign to the underlying date picker. Defaults to null.
- */
- pickerId : null,
-
- /**
- * @cfg {Number} maxHeight
- * @hide
- */
- /**
- * @cfg {Number} scrollIncrement
- * @hide
+ * Scrolls the TablePanel by deltaX
+ * @param {Number} deltaY
*/
+ scrollByDeltaX: function(deltaX) {
+ this.horizontalScroller.scrollByDeltaX(deltaX);
+ },
+
/**
- * The {@link Ext.DatePicker} instance for this DateMenu
- * @property picker
- * @type DatePicker
+ * Get left hand side marker for header resizing.
+ * @private
*/
- cls : 'x-date-menu',
-
+ getLhsMarker: function() {
+ var me = this;
+
+ if (!me.lhsMarker) {
+ me.lhsMarker = Ext.core.DomHelper.append(me.el, {
+ cls: Ext.baseCSSPrefix + 'grid-resize-marker'
+ }, true);
+ }
+ return me.lhsMarker;
+ },
+
/**
- * @event click
- * @hide
+ * Get right hand side marker for header resizing.
+ * @private
*/
-
+ getRhsMarker: function() {
+ var me = this;
+
+ if (!me.rhsMarker) {
+ me.rhsMarker = Ext.core.DomHelper.append(me.el, {
+ cls: Ext.baseCSSPrefix + 'grid-resize-marker'
+ }, true);
+ }
+ return me.rhsMarker;
+ },
+
/**
- * @event itemclick
- * @hide
+ * Returns the selection model being used and creates it via the configuration
+ * if it has not been created already.
+ * @return {Ext.selection.Model} selModel
*/
+ getSelectionModel: function(){
+ if (!this.selModel) {
+ this.selModel = {};
+ }
- initComponent : function(){
- this.on('beforeshow', this.onBeforeShow, this);
- if(this.strict = (Ext.isIE7 && Ext.isStrict)){
- this.on('show', this.onShow, this, {single: true, delay: 20});
+ var mode = 'SINGLE',
+ type;
+ if (this.simpleSelect) {
+ mode = 'SIMPLE';
+ } else if (this.multiSelect) {
+ mode = 'MULTI';
}
- Ext.apply(this, {
- plain: true,
- showSeparator: false,
- items: this.picker = new Ext.DatePicker(Ext.applyIf({
- internalRender: this.strict || !Ext.isIE,
- ctCls: 'x-menu-date-item',
- id: this.pickerId
- }, this.initialConfig))
+
+ Ext.applyIf(this.selModel, {
+ allowDeselect: this.allowDeselect,
+ mode: mode
});
- this.picker.purgeListeners();
- Ext.menu.DateMenu.superclass.initComponent.call(this);
- /**
- * @event select
- * Fires when a date is selected from the {@link #picker Ext.DatePicker}
- * @param {DatePicker} picker The {@link #picker Ext.DatePicker}
- * @param {Date} date The selected date
- */
- this.relayEvents(this.picker, ['select']);
- this.on('show', this.picker.focus, this.picker);
- this.on('select', this.menuHide, this);
- if(this.handler){
- this.on('select', this.handler, this.scope || this);
+
+ if (!this.selModel.events) {
+ type = this.selModel.selType || this.selType;
+ this.selModel = Ext.create('selection.' + type, this.selModel);
+ }
+
+ if (!this.selModel.hasRelaySetup) {
+ this.relayEvents(this.selModel, ['selectionchange', 'select', 'deselect']);
+ this.selModel.hasRelaySetup = true;
}
+
+ // lock the selection model if user
+ // has disabled selection
+ if (this.disableSelection) {
+ this.selModel.locked = true;
+ }
+ return this.selModel;
},
- menuHide : function() {
- if(this.hideOnClick){
- this.hide(true);
+ onVerticalScroll: function(event, target) {
+ var owner = this.getScrollerOwner(),
+ items = owner.query('tableview'),
+ i = 0,
+ len = items.length;
+
+ for (; i < len; i++) {
+ items[i].el.dom.scrollTop = target.scrollTop;
}
},
- onBeforeShow : function(){
- if(this.picker){
- this.picker.hideMonthPicker(true);
+ onHorizontalScroll: function(event, target) {
+ var owner = this.getScrollerOwner(),
+ items = owner.query('tableview'),
+ i = 0,
+ len = items.length,
+ center,
+ centerEl,
+ centerScrollWidth,
+ centerClientWidth,
+ width;
+
+ center = items[1] || items[0];
+ centerEl = center.el.dom;
+ centerScrollWidth = centerEl.scrollWidth;
+ centerClientWidth = centerEl.offsetWidth;
+ width = this.horizontalScroller.getWidth();
+
+ centerEl.scrollLeft = target.scrollLeft;
+ this.headerCt.el.dom.scrollLeft = target.scrollLeft;
+ },
+
+ // template method meant to be overriden
+ onStoreLoad: Ext.emptyFn,
+
+ getEditorParent: function() {
+ return this.body;
+ },
+
+ bindStore: function(store) {
+ var me = this;
+ me.store = store;
+ me.getView().bindStore(store);
+ },
+
+ reconfigure: function(store, columns) {
+ var me = this;
+
+ if (me.lockable) {
+ me.reconfigureLockable(store, columns);
+ return;
+ }
+
+ if (columns) {
+ me.headerCt.removeAll();
+ me.headerCt.add(columns);
+ }
+ if (store) {
+ store = Ext.StoreManager.lookup(store);
+ me.bindStore(store);
+ } else {
+ me.getView().refresh();
}
},
- onShow : function(){
- var el = this.picker.getEl();
- el.setWidth(el.getWidth()); //nasty hack for IE7 strict mode
+ afterComponentLayout: function() {
+ this.callParent(arguments);
+ this.determineScrollbars();
+ this.invalidateScroller();
}
- });
- Ext.reg('datemenu', Ext.menu.DateMenu);
- /**
- * @class Ext.menu.ColorMenu
- * @extends Ext.menu.Menu
- * A menu containing a {@link Ext.ColorPalette} Component.
- * Notes:
- * - Although not listed here, the constructor for this class
- * accepts all of the configuration options of {@link Ext.ColorPalette}.
- * - If subclassing ColorMenu, any configuration options for the ColorPalette must be
- * applied to the initialConfig property of the ColorMenu.
- * Applying {@link Ext.ColorPalette ColorPalette} configuration settings to
- * this will not affect the ColorPalette's configuration.
- *
*
- * @xtype colormenu
+});
+/**
+ * @class Ext.view.Table
+ * @extends Ext.view.View
+
+This class encapsulates the user interface for a tabular data set.
+It acts as a centralized manager for controlling the various interface
+elements of the view. This includes handling events, such as row and cell
+level based DOM events. It also reacts to events from the underlying {@link Ext.selection.Model}
+to provide visual feedback to the user.
+
+This class does not provide ways to manipulate the underlying data of the configured
+{@link Ext.data.Store}.
+
+This is the base class for both {@link Ext.grid.View} and {@link Ext.tree.View} and is not
+to be used directly.
+
+ * @markdown
+ * @abstract
+ * @xtype tableview
+ * @author Nicolas Ferrero
*/
- Ext.menu.ColorMenu = Ext.extend(Ext.menu.Menu, {
- /**
- * @cfg {Boolean} enableScrolling
- * @hide
- */
- enableScrolling : false,
- /**
- * @cfg {Function} handler
- * Optional. A function that will handle the select event of this menu.
- * The handler is passed the following parameters:
- * palette
: ColorPaletteThe {@link #palette Ext.ColorPalette}.
- * color
: StringThe 6-digit color hex code (without the # symbol).
- *
- */
+Ext.define('Ext.view.Table', {
+ extend: 'Ext.view.View',
+ alias: 'widget.tableview',
+ uses: [
+ 'Ext.view.TableChunker',
+ 'Ext.util.DelayedTask',
+ 'Ext.util.MixedCollection'
+ ],
+
+ cls: Ext.baseCSSPrefix + 'grid-view',
+
+ // row
+ itemSelector: '.' + Ext.baseCSSPrefix + 'grid-row',
+ // cell
+ cellSelector: '.' + Ext.baseCSSPrefix + 'grid-cell',
+
+ selectedItemCls: Ext.baseCSSPrefix + 'grid-row-selected',
+ selectedCellCls: Ext.baseCSSPrefix + 'grid-cell-selected',
+ focusedItemCls: Ext.baseCSSPrefix + 'grid-row-focused',
+ overItemCls: Ext.baseCSSPrefix + 'grid-row-over',
+ altRowCls: Ext.baseCSSPrefix + 'grid-row-alt',
+ rowClsRe: /(?:^|\s*)grid-row-(first|last|alt)(?:\s+|$)/g,
+ cellRe: new RegExp('x-grid-cell-([^\\s]+) ', ''),
+
+ // cfg docs inherited
+ trackOver: true,
+
/**
- * @cfg {Object} scope
- * The scope (this reference) in which the {@link #handler}
- * function will be called. Defaults to this ColorMenu instance.
- */
-
- /**
- * @cfg {Boolean} hideOnClick
- * False to continue showing the menu after a color is selected, defaults to true.
- */
- hideOnClick : true,
-
- cls : 'x-color-menu',
-
- /**
- * @cfg {String} paletteId
- * An id to assign to the underlying color palette. Defaults to null.
+ * Override this function to apply custom CSS classes to rows during rendering. You can also supply custom
+ * parameters to the row template for the current row to customize how it is rendered using the rowParams
+ * parameter. This function should return the CSS class name (or empty string '' for none) that will be added
+ * to the row's wrapping div. To apply multiple class names, simply return them space-delimited within the string
+ * (e.g., 'my-class another-class'). Example usage:
+
+viewConfig: {
+ forceFit: true,
+ showPreview: true, // custom property
+ enableRowBody: true, // required to create a second, full-width row to show expanded Record data
+ getRowClass: function(record, rowIndex, rp, ds){ // rp = rowParams
+ if(this.showPreview){
+ rp.body = '<p>'+record.data.excerpt+'</p>';
+ return 'x-grid3-row-expanded';
+ }
+ return 'x-grid3-row-collapsed';
+ }
+},
+
+ * @param {Model} model The {@link Ext.data.Model} corresponding to the current row.
+ * @param {Number} index The row index.
+ * @param {Object} rowParams (DEPRECATED) A config object that is passed to the row template during rendering that allows
+ * customization of various aspects of a grid row.
+ * If {@link #enableRowBody} is configured true, then the following properties may be set
+ * by this function, and will be used to render a full-width expansion row below each grid row:
+ *
+ * body
: String An HTML fragment to be used as the expansion row's body content (defaults to '').
+ * bodyStyle
: String A CSS style specification that will be applied to the expansion row's <tr> element. (defaults to '').
+ *
+ * The following property will be passed in, and may be appended to:
+ *
+ * tstyle
: String A CSS style specification that willl be applied to the <table> element which encapsulates
+ * both the standard grid row, and any expansion row.
+ *
+ * @param {Store} store The {@link Ext.data.Store} this grid is bound to
+ * @method getRowClass
+ * @return {String} a CSS class name to add to the row.
*/
- paletteId : null,
+ getRowClass: null,
+
+ initComponent: function() {
+ this.scrollState = {};
+ this.selModel.view = this;
+ this.headerCt.view = this;
+ this.initFeatures();
+ this.setNewTemplate();
+ this.callParent();
+ this.mon(this.store, {
+ load: this.onStoreLoad,
+ scope: this
+ });
+
+ // this.addEvents(
+ // /**
+ // * @event rowfocus
+ // * @param {Ext.data.Record} record
+ // * @param {HTMLElement} row
+ // * @param {Number} rowIdx
+ // */
+ // 'rowfocus'
+ // );
+ },
+
+ // scroll to top of the grid when store loads
+ onStoreLoad: function(){
+ if (this.invalidateScrollerOnRefresh) {
+ if (Ext.isGecko) {
+ if (!this.scrollToTopTask) {
+ this.scrollToTopTask = Ext.create('Ext.util.DelayedTask', this.scrollToTop, this);
+ }
+ this.scrollToTopTask.delay(1);
+ } else {
+ this.scrollToTop();
+ }
+ }
+ },
+
+ // scroll the view to the top
+ scrollToTop: Ext.emptyFn,
- /**
- * @cfg {Number} maxHeight
- * @hide
- */
- /**
- * @cfg {Number} scrollIncrement
- * @hide
- */
/**
- * @property palette
- * @type ColorPalette
- * The {@link Ext.ColorPalette} instance for this ColorMenu
+ * Get the columns used for generating a template via TableChunker.
+ * See {@link Ext.grid.header.Container#getGridColumns}.
+ * @private
*/
-
+ getGridColumns: function() {
+ return this.headerCt.getGridColumns();
+ },
/**
- * @event click
- * @hide
+ * Get a leaf level header by index regardless of what the nesting
+ * structure is.
+ * @private
+ * @param {Number} index The index
*/
+ getHeaderAtIndex: function(index) {
+ return this.headerCt.getHeaderAtIndex(index);
+ },
/**
- * @event itemclick
- * @hide
+ * Get the cell (td) for a particular record and column.
+ * @param {Ext.data.Model} record
+ * @param {Ext.grid.column.Colunm} column
+ * @private
*/
-
- initComponent : function(){
- Ext.apply(this, {
- plain: true,
- showSeparator: false,
- items: this.palette = new Ext.ColorPalette(Ext.applyIf({
- id: this.paletteId
- }, this.initialConfig))
- });
- this.palette.purgeListeners();
- Ext.menu.ColorMenu.superclass.initComponent.call(this);
- /**
- * @event select
- * Fires when a color is selected from the {@link #palette Ext.ColorPalette}
- * @param {Ext.ColorPalette} palette The {@link #palette Ext.ColorPalette}
- * @param {String} color The 6-digit color hex code (without the # symbol)
- */
- this.relayEvents(this.palette, ['select']);
- this.on('select', this.menuHide, this);
- if(this.handler){
- this.on('select', this.handler, this.scope || this);
- }
+ getCell: function(record, column) {
+ var row = this.getNode(record);
+ return Ext.fly(row).down(column.getCellSelector());
},
- menuHide : function(){
- if(this.hideOnClick){
- this.hide(true);
- }
- }
-});
-Ext.reg('colormenu', Ext.menu.ColorMenu);
-/**
- * @class Ext.form.Field
- * @extends Ext.BoxComponent
- * Base class for form fields that provides default event handling, sizing, value handling and other functionality.
- * @constructor
- * Creates a new Field
- * @param {Object} config Configuration options
- * @xtype field
- */
-Ext.form.Field = Ext.extend(Ext.BoxComponent, {
- /**
- * The label Element associated with this Field. Only available after this Field has been rendered by a
- * {@link form Ext.layout.FormLayout} layout manager.
- * @type Ext.Element
- * @property label
- */
- /**
- * @cfg {String} inputType The type attribute for input fields -- e.g. radio, text, password, file (defaults
- * to 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are
- * no separate Ext components for those. Note that if you use inputType:'file', {@link #emptyText}
- * is not supported and should be avoided.
- */
- /**
- * @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).
- */
/**
- * @cfg {Mixed} value A value to initialize this field with (defaults to undefined).
- */
- /**
- * @cfg {String} name The field's HTML name attribute (defaults to '').
- * Note: this property must be set if this field is to be automatically included with
- * {@link Ext.form.BasicForm#submit form submit()}.
- */
- /**
- * @cfg {String} cls A custom CSS class to apply to the field's underlying element (defaults to '').
+ * Get a reference to a feature
+ * @param {String} id The id of the feature
+ * @return {Ext.grid.feature.Feature} The feature. Undefined if not found
*/
+ getFeature: function(id) {
+ var features = this.featuresMC;
+ if (features) {
+ return features.get(id);
+ }
+ },
/**
- * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to 'x-form-invalid')
- */
- invalidClass : 'x-form-invalid',
- /**
- * @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')
- */
- invalidText : 'The value in this field is invalid',
- /**
- * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to 'x-form-focus')
- */
- focusClass : 'x-form-focus',
- /**
- * @cfg {Boolean} preventMark
- * true to disable {@link #markInvalid marking the field invalid}.
- * Defaults to false.
- */
- /**
- * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
- automatic validation (defaults to 'keyup').
- */
- validationEvent : 'keyup',
- /**
- * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
- */
- validateOnBlur : true,
- /**
- * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation
- * is initiated (defaults to 250)
- */
- validationDelay : 250,
- /**
- * @cfg {String/Object} autoCreate A {@link Ext.DomHelper DomHelper} element spec, or true for a default
- * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
- * See {@link Ext.Component#autoEl autoEl} for details. Defaults to:
- * {tag: 'input', type: 'text', size: '20', autocomplete: 'off'}
- */
- defaultAutoCreate : {tag: 'input', type: 'text', size: '20', autocomplete: 'off'},
- /**
- * @cfg {String} fieldClass The default CSS class for the field (defaults to 'x-form-field')
- */
- fieldClass : 'x-form-field',
- /**
- * @cfg {String} msgTarget The location where the message text set through {@link #markInvalid} should display.
- * Must be one of the following values:
- *
- * qtip
Display a quick tip containing the message when the user hovers over the field. This is the default.
- * {@link Ext.QuickTips#init Ext.QuickTips.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.
- * [element id]
Add the error message directly to the innerHTML of the specified element.
- *
- */
- msgTarget : 'qtip',
- /**
- * @cfg {String} msgFx Experimental The effect used when displaying a validation message under the field
- * (defaults to 'normal').
- */
- msgFx : 'normal',
- /**
- * @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 readOnly=true
, for example, will not disable triggering a
- * ComboBox or DateField; 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.TriggerField#hideTrigger hideTrigger}
.
- */
- readOnly : false,
- /**
- * @cfg {Boolean} disabled True to disable the field (defaults to false).
- * Be aware that conformant with the HTML specification,
- * disabled Fields will not be {@link Ext.form.BasicForm#submit submitted}.
- */
- disabled : false,
- /**
- * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
- * Defaults to true.
+ * Initializes each feature and bind it to this view.
+ * @private
*/
- submitValue: true,
-
- // private
- isFormField : true,
-
- // private
- msgDisplay: '',
-
- // private
- hasFocus : false,
+ initFeatures: function() {
+ this.features = this.features || [];
+ var features = this.features,
+ ln = features.length,
+ i = 0;
- // private
- initComponent : function(){
- Ext.form.Field.superclass.initComponent.call(this);
- this.addEvents(
- /**
- * @event focus
- * Fires when this field receives input focus.
- * @param {Ext.form.Field} this
- */
- 'focus',
- /**
- * @event blur
- * Fires when this field loses input focus.
- * @param {Ext.form.Field} 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#keys} or {@link Ext.KeyMap}.
- * You can check {@link Ext.EventObject#getKey} to determine which key was pressed.
- * For example:
-var form = new Ext.form.FormPanel({
- ...
- 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.ownerCt.getForm();
- form.submit();
- }
- }
+ this.featuresMC = Ext.create('Ext.util.MixedCollection');
+ for (; i < ln; i++) {
+ // ensure feature hasnt already been instantiated
+ if (!features[i].isFeature) {
+ features[i] = Ext.create('feature.'+features[i].ftype, features[i]);
}
+ // inject a reference to view
+ features[i].view = this;
+ this.featuresMC.add(features[i]);
}
- ],
- ...
-});
- *
- * @param {Ext.form.Field} this
- * @param {Ext.EventObject} e The event object
- */
- 'specialkey',
- /**
- * @event change
- * Fires just before the field blurs if the field value has changed.
- * @param {Ext.form.Field} this
- * @param {Mixed} newValue The new value
- * @param {Mixed} oldValue The original value
- */
- 'change',
- /**
- * @event invalid
- * Fires after the field has been marked as invalid.
- * @param {Ext.form.Field} this
- * @param {String} msg The validation message
- */
- 'invalid',
- /**
- * @event valid
- * Fires after the field has been validated with no errors.
- * @param {Ext.form.Field} this
- */
- 'valid'
- );
},
/**
- * Returns the {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
- * attribute of the field if available.
- * @return {String} name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
+ * Gives features an injection point to attach events to the markup that
+ * has been created for this view.
+ * @private
*/
- getName : function(){
- return this.rendered && this.el.dom.name ? this.el.dom.name : this.name || this.id || '';
+ attachEventsForFeatures: function() {
+ var features = this.features,
+ ln = features.length,
+ i = 0;
+
+ for (; i < ln; i++) {
+ if (features[i].isFeature) {
+ features[i].attachEvents();
+ }
+ }
},
- // private
- onRender : function(ct, position){
- if(!this.el){
- var cfg = this.getAutoCreate();
+ afterRender: function() {
+ this.callParent();
+ this.mon(this.el, {
+ scroll: this.fireBodyScroll,
+ scope: this
+ });
+ this.attachEventsForFeatures();
+ },
- if(!cfg.name){
- cfg.name = this.name || this.id;
- }
- if(this.inputType){
- cfg.type = this.inputType;
+ fireBodyScroll: function(e, t) {
+ this.fireEvent('bodyscroll', e, t);
+ },
+
+ // TODO: Refactor headerCt dependency here to colModel
+ /**
+ * Uses the headerCt to transform data from dataIndex keys in a record to
+ * headerId keys in each header and then run them through each feature to
+ * get additional data for variables they have injected into the view template.
+ * @private
+ */
+ prepareData: function(data, idx, record) {
+ var orig = this.headerCt.prepareData(data, idx, record, this),
+ features = this.features,
+ ln = features.length,
+ i = 0,
+ node, feature;
+
+ for (; i < ln; i++) {
+ feature = features[i];
+ if (feature.isFeature) {
+ Ext.apply(orig, feature.getAdditionalData(data, idx, record, orig, this));
}
- this.autoEl = cfg;
- }
- Ext.form.Field.superclass.onRender.call(this, ct, position);
- if(this.submitValue === false){
- this.el.dom.removeAttribute('name');
}
- var type = this.el.dom.type;
- if(type){
- if(type == 'password'){
- type = 'text';
+
+ return orig;
+ },
+
+ // TODO: Refactor headerCt dependency here to colModel
+ collectData: function(records, startIndex) {
+ var preppedRecords = this.callParent(arguments),
+ headerCt = this.headerCt,
+ fullWidth = headerCt.getFullWidth(),
+ features = this.features,
+ ln = features.length,
+ o = {
+ rows: preppedRecords,
+ fullWidth: fullWidth
+ },
+ i = 0,
+ feature,
+ j = 0,
+ jln,
+ rowParams;
+
+ jln = preppedRecords.length;
+ // process row classes, rowParams has been deprecated and has been moved
+ // to the individual features that implement the behavior.
+ if (this.getRowClass) {
+ for (; j < jln; j++) {
+ rowParams = {};
+ preppedRecords[j]['rowCls'] = this.getRowClass(records[j], j, rowParams, this.store);
+ if (rowParams.alt) {
+ Ext.Error.raise("The getRowClass alt property is no longer supported.");
+ }
+ if (rowParams.tstyle) {
+ Ext.Error.raise("The getRowClass tstyle property is no longer supported.");
+ }
+ if (rowParams.cells) {
+ Ext.Error.raise("The getRowClass cells property is no longer supported.");
+ }
+ if (rowParams.body) {
+ Ext.Error.raise("The getRowClass body property is no longer supported. Use the getAdditionalData method of the rowbody feature.");
+ }
+ if (rowParams.bodyStyle) {
+ Ext.Error.raise("The getRowClass bodyStyle property is no longer supported.");
+ }
+ if (rowParams.cols) {
+ Ext.Error.raise("The getRowClass cols property is no longer supported.");
+ }
}
- this.el.addClass('x-form-'+type);
}
- if(this.readOnly){
- this.setReadOnly(true);
- }
- if(this.tabIndex !== undefined){
- this.el.dom.setAttribute('tabIndex', this.tabIndex);
+ // currently only one feature may implement collectData. This is to modify
+ // what's returned to the view before its rendered
+ for (; i < ln; i++) {
+ feature = features[i];
+ if (feature.isFeature && feature.collectData && !feature.disabled) {
+ o = feature.collectData(records, preppedRecords, startIndex, fullWidth, o);
+ break;
+ }
}
-
- this.el.addClass([this.fieldClass, this.cls]);
+ return o;
},
- // private
- getItemCt : function(){
- return this.itemCt;
+ // TODO: Refactor header resizing to column resizing
+ /**
+ * When a header is resized, setWidth on the individual columns resizer class,
+ * the top level table, save/restore scroll state, generate a new template and
+ * restore focus to the grid view's element so that keyboard navigation
+ * continues to work.
+ * @private
+ */
+ onHeaderResize: function(header, w, suppressFocus) {
+ var el = this.el;
+ if (el) {
+ this.saveScrollState();
+ // Grab the col and set the width, css
+ // class is generated in TableChunker.
+ // Select composites because there may be several chunks.
+ el.select('.' + Ext.baseCSSPrefix + 'grid-col-resizer-'+header.id).setWidth(w);
+ el.select('.' + Ext.baseCSSPrefix + 'grid-table-resizer').setWidth(this.headerCt.getFullWidth());
+ this.restoreScrollState();
+ this.setNewTemplate();
+ if (!suppressFocus) {
+ this.el.focus();
+ }
+ }
},
- // private
- initValue : function(){
- if(this.value !== undefined){
- this.setValue(this.value);
- }else if(!Ext.isEmpty(this.el.dom.value) && this.el.dom.value != this.emptyText){
- this.setValue(this.el.dom.value);
+ /**
+ * When a header is shown restore its oldWidth if it was previously hidden.
+ * @private
+ */
+ onHeaderShow: function(headerCt, header, suppressFocus) {
+ // restore headers that were dynamically hidden
+ if (header.oldWidth) {
+ this.onHeaderResize(header, header.oldWidth, suppressFocus);
+ delete header.oldWidth;
+ // flexed headers will have a calculated size set
+ // this additional check has to do with the fact that
+ // defaults: {width: 100} will fight with a flex value
+ } else if (header.width && !header.flex) {
+ this.onHeaderResize(header, header.width, suppressFocus);
}
- /**
- * 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.BasicForm#trackResetOnLoad trackResetOnLoad}
- * setting is true
.
- * @type mixed
- * @property originalValue
- */
- this.originalValue = this.getValue();
+ this.setNewTemplate();
},
/**
- * Returns true if the value of this Field has been changed from its original value.
- * Will return false if the field is disabled or has not been rendered yet.
- * Note that if the owning {@link Ext.form.BasicForm form} was configured with
- * {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
- * then the original value is updated when the values are loaded by
- * {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#setValues setValues}.
- * @return {Boolean} True if this field has been changed from its original value (and
- * is not disabled), false otherwise.
+ * When the header hides treat it as a resize to 0.
+ * @private
*/
- isDirty : function() {
- if(this.disabled || !this.rendered) {
- return false;
- }
- return String(this.getValue()) !== String(this.originalValue);
+ onHeaderHide: function(headerCt, header, suppressFocus) {
+ this.onHeaderResize(header, 0, suppressFocus);
},
/**
- * Sets the read only state of this field.
- * @param {Boolean} readOnly Whether the field should be read only.
+ * Set a new template based on the current columns displayed in the
+ * grid.
+ * @private
*/
- setReadOnly : function(readOnly){
- if(this.rendered){
- this.el.dom.readOnly = readOnly;
- }
- this.readOnly = readOnly;
+ setNewTemplate: function() {
+ var columns = this.headerCt.getColumnsForTpl(true);
+ this.tpl = this.getTableChunker().getTableTpl({
+ columns: columns,
+ features: this.features
+ });
},
- // private
- afterRender : function(){
- Ext.form.Field.superclass.afterRender.call(this);
- this.initEvents();
- this.initValue();
+ /**
+ * Get the configured chunker or default of Ext.view.TableChunker
+ */
+ getTableChunker: function() {
+ return this.chunker || Ext.view.TableChunker;
},
- // private
- fireKey : function(e){
- if(e.isSpecialKey()){
- this.fireEvent('specialkey', this, e);
+ /**
+ * Add a CSS Class to a specific row.
+ * @param {HTMLElement/String/Number/Ext.data.Model} rowInfo An HTMLElement, index or instance of a model representing this row
+ * @param {String} cls
+ */
+ addRowCls: function(rowInfo, cls) {
+ var row = this.getNode(rowInfo);
+ if (row) {
+ Ext.fly(row).addCls(cls);
}
},
/**
- * Resets the current field value to the originally loaded value and clears any validation messages.
- * See {@link Ext.form.BasicForm}.{@link Ext.form.BasicForm#trackResetOnLoad trackResetOnLoad}
+ * Remove a CSS Class from a specific row.
+ * @param {HTMLElement/String/Number/Ext.data.Model} rowInfo An HTMLElement, index or instance of a model representing this row
+ * @param {String} cls
*/
- reset : function(){
- this.setValue(this.originalValue);
- this.clearInvalid();
+ removeRowCls: function(rowInfo, cls) {
+ var row = this.getNode(rowInfo);
+ if (row) {
+ Ext.fly(row).removeCls(cls);
+ }
},
- // private
- initEvents : function(){
- this.mon(this.el, Ext.EventManager.useKeydown ? 'keydown' : 'keypress', this.fireKey, this);
- this.mon(this.el, 'focus', this.onFocus, this);
-
- // 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)
- this.mon(this.el, 'blur', this.onBlur, this, this.inEditor ? {buffer:10} : null);
+ // GridSelectionModel invokes onRowSelect as selection changes
+ onRowSelect : function(rowIdx) {
+ this.addRowCls(rowIdx, this.selectedItemCls);
},
- // private
- preFocus: Ext.emptyFn,
-
- // private
- onFocus : function(){
- this.preFocus();
- if(this.focusClass){
- this.el.addClass(this.focusClass);
- }
- if(!this.hasFocus){
- this.hasFocus = true;
- /**
- * The value that the Field had at the time it was last focused. This is the value that is passed
- * to the {@link #change} event which is fired if the value has been changed when the Field is blurred.
- * This will be undefined until the Field has been visited. Compare {@link #originalValue}.
- * @type mixed
- * @property startValue
- */
- this.startValue = this.getValue();
- this.fireEvent('focus', this);
- }
+ // GridSelectionModel invokes onRowDeselect as selection changes
+ onRowDeselect : function(rowIdx) {
+ this.removeRowCls(rowIdx, this.selectedItemCls);
+ this.removeRowCls(rowIdx, this.focusedItemCls);
},
-
- // private
- beforeBlur : Ext.emptyFn,
-
- // private
- onBlur : function(){
- this.beforeBlur();
- if(this.focusClass){
- this.el.removeClass(this.focusClass);
+
+ onCellSelect: function(position) {
+ var cell = this.getCellByPosition(position);
+ if (cell) {
+ cell.addCls(this.selectedCellCls);
}
- this.hasFocus = false;
- if(this.validationEvent !== false && (this.validateOnBlur || this.validationEvent == 'blur')){
- this.validate();
+ },
+
+ onCellDeselect: function(position) {
+ var cell = this.getCellByPosition(position);
+ if (cell) {
+ cell.removeCls(this.selectedCellCls);
}
- var v = this.getValue();
- if(String(v) !== String(this.startValue)){
- this.fireEvent('change', this, v, this.startValue);
+
+ },
+
+ onCellFocus: function(position) {
+ //var cell = this.getCellByPosition(position);
+ this.focusCell(position);
+ },
+
+ getCellByPosition: function(position) {
+ var row = position.row,
+ column = position.column,
+ store = this.store,
+ node = this.getNode(row),
+ header = this.headerCt.getHeaderAtIndex(column),
+ cellSelector,
+ cell = false;
+
+ if (header) {
+ cellSelector = header.getCellSelector();
+ cell = Ext.fly(node).down(cellSelector);
}
- this.fireEvent('blur', this);
- this.postBlur();
+ return cell;
},
- // private
- postBlur : Ext.emptyFn,
+ // GridSelectionModel invokes onRowFocus to 'highlight'
+ // the last row focused
+ onRowFocus: function(rowIdx, highlight, supressFocus) {
+ var row = this.getNode(rowIdx);
- /**
- * Returns whether or not the field value is currently valid by
- * {@link #validateValue validating} the {@link #processValue processed value}
- * of the field. Note: {@link #disabled} fields are ignored.
- * @param {Boolean} preventMark True to disable marking the field invalid
- * @return {Boolean} True if the value is valid, else false
- */
- isValid : function(preventMark){
- if(this.disabled){
- return true;
+ if (highlight) {
+ this.addRowCls(rowIdx, this.focusedItemCls);
+ if (!supressFocus) {
+ this.focusRow(rowIdx);
+ }
+ //this.el.dom.setAttribute('aria-activedescendant', row.id);
+ } else {
+ this.removeRowCls(rowIdx, this.focusedItemCls);
}
- var restore = this.preventMark;
- this.preventMark = preventMark === true;
- var v = this.validateValue(this.processValue(this.getRawValue()));
- this.preventMark = restore;
- return v;
},
/**
- * Validates the field value
- * @return {Boolean} True if the value is valid, else false
+ * Focus a particular row and bring it into view. Will fire the rowfocus event.
+ * @cfg {Mixed} An HTMLElement template node, index of a template node, the
+ * id of a template node or the record associated with the node.
*/
- validate : function(){
- if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
- this.clearInvalid();
- return true;
+ focusRow: function(rowIdx) {
+ var row = this.getNode(rowIdx),
+ el = this.el,
+ adjustment = 0,
+ panel = this.ownerCt,
+ rowRegion,
+ elRegion,
+ record;
+
+ if (row && this.el) {
+ elRegion = el.getRegion();
+ rowRegion = Ext.fly(row).getRegion();
+ // row is above
+ if (rowRegion.top < elRegion.top) {
+ adjustment = rowRegion.top - elRegion.top;
+ // row is below
+ } else if (rowRegion.bottom > elRegion.bottom) {
+ adjustment = rowRegion.bottom - elRegion.bottom;
+ }
+ record = this.getRecord(row);
+ rowIdx = this.store.indexOf(record);
+
+ if (adjustment) {
+ // scroll the grid itself, so that all gridview's update.
+ panel.scrollByDeltaY(adjustment);
+ }
+ this.fireEvent('rowfocus', record, row, rowIdx);
+ }
+ },
+
+ focusCell: function(position) {
+ var cell = this.getCellByPosition(position),
+ el = this.el,
+ adjustmentY = 0,
+ adjustmentX = 0,
+ elRegion = el.getRegion(),
+ panel = this.ownerCt,
+ cellRegion,
+ record;
+
+ if (cell) {
+ cellRegion = cell.getRegion();
+ // cell is above
+ if (cellRegion.top < elRegion.top) {
+ adjustmentY = cellRegion.top - elRegion.top;
+ // cell is below
+ } else if (cellRegion.bottom > elRegion.bottom) {
+ adjustmentY = cellRegion.bottom - elRegion.bottom;
+ }
+
+ // cell is left
+ if (cellRegion.left < elRegion.left) {
+ adjustmentX = cellRegion.left - elRegion.left;
+ // cell is right
+ } else if (cellRegion.right > elRegion.right) {
+ adjustmentX = cellRegion.right - elRegion.right;
+ }
+
+ if (adjustmentY) {
+ // scroll the grid itself, so that all gridview's update.
+ panel.scrollByDeltaY(adjustmentY);
+ }
+ if (adjustmentX) {
+ panel.scrollByDeltaX(adjustmentX);
+ }
+ el.focus();
+ this.fireEvent('cellfocus', record, cell, position);
}
- return false;
},
/**
- * This method should only be overridden if necessary to prepare raw values
- * for validation (see {@link #validate} and {@link #isValid}). This method
- * is expected to return the processed value for the field which will
- * be used for validation (see validateValue method).
- * @param {Mixed} value
+ * Scroll by delta. This affects this individual view ONLY and does not
+ * synchronize across views or scrollers.
+ * @param {Number} delta
+ * @param {String} dir (optional) Valid values are scrollTop and scrollLeft. Defaults to scrollTop.
+ * @private
*/
- processValue : function(value){
- return value;
+ scrollByDelta: function(delta, dir) {
+ dir = dir || 'scrollTop';
+ var elDom = this.el.dom;
+ elDom[dir] = (elDom[dir] += delta);
},
- /**
- * Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
- * with the first 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 getErrors should be
- * overridden instead.
- * @param {Mixed} The current value of the field
- * @return {Boolean} True if all validations passed, false if one or more failed
- */
- validateValue : function(value) {
- //currently, we only show 1 error at a time for a field, so just use the first one
- var error = this.getErrors(value)[0];
+ onUpdate: function(ds, index) {
+ this.callParent(arguments);
+ },
- if (error == undefined) {
- return true;
- } else {
- this.markInvalid(error);
- return false;
- }
- },
-
/**
- * 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
- * @return {Array} All error messages for this field
+ * Save the scrollState in a private variable.
+ * Must be used in conjunction with restoreScrollState
*/
- getErrors: function() {
- return [];
+ saveScrollState: function() {
+ var dom = this.el.dom,
+ state = this.scrollState;
+
+ state.left = dom.scrollLeft;
+ state.top = dom.scrollTop;
},
/**
- * Gets the active error message for this field.
- * @return {String} Returns the active error message on the field, if there is no error, an empty string is returned.
+ * Restore the scrollState.
+ * Must be used in conjunction with saveScrollState
+ * @private
*/
- getActiveError : function(){
- return this.activeError || '';
+ restoreScrollState: function() {
+ var dom = this.el.dom,
+ state = this.scrollState,
+ headerEl = this.headerCt.el.dom;
+
+ headerEl.scrollLeft = dom.scrollLeft = state.left;
+ dom.scrollTop = state.top;
},
/**
- * Display an error message associated with this field, using {@link #msgTarget} to determine how to
- * display the message and applying {@link #invalidClass} to the field's UI element.
- * Note: this method does not cause the Field's {@link #validate} method to return 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.
- * {@link #isValid invalid}.
- * @param {String} msg (optional) The validation message (defaults to {@link #invalidText})
+ * Refresh the grid view.
+ * Saves and restores the scroll state, generates a new template, stripes rows
+ * and invalidates the scrollers.
+ * @param {Boolean} firstPass This is a private flag for internal use only.
*/
- markInvalid : function(msg){
- //don't set the error icon if we're not rendered or marking is prevented
- if (this.rendered && !this.preventMark) {
- msg = msg || this.invalidText;
+ refresh: function(firstPass) {
+ var me = this,
+ table;
- var mt = this.getMessageHandler();
- if(mt){
- mt.mark(this, msg);
- }else if(this.msgTarget){
- this.el.addClass(this.invalidClass);
- var t = Ext.getDom(this.msgTarget);
- if(t){
- t.innerHTML = msg;
- t.style.display = this.msgDisplay;
- }
+ //this.saveScrollState();
+ me.setNewTemplate();
+
+ // The table.unselectable() call below adds a selectstart listener to the table element.
+ // Before we clear the whole dataview in the callParent, we remove all the listeners from the
+ // table. This prevents a big memory leak on IE6 and IE7.
+ if (me.rendered) {
+ table = me.el.child('table');
+ if (table) {
+ table.removeAllListeners();
}
}
- this.setActiveError(msg);
+ me.callParent(arguments);
+
+ //this.restoreScrollState();
+ if (me.rendered) {
+ // Make the table view unselectable
+ table = me.el.child('table');
+ if (table) {
+ table.unselectable();
+ }
+
+ if (!firstPass) {
+ // give focus back to gridview
+ me.el.focus();
+ }
+ }
},
-
- /**
- * Clear any invalid styles/messages for this field
- */
- clearInvalid : function(){
- //don't remove the error icon if we're not rendered or marking is prevented
- if (this.rendered && !this.preventMark) {
- this.el.removeClass(this.invalidClass);
- var mt = this.getMessageHandler();
- if(mt){
- mt.clear(this);
- }else if(this.msgTarget){
- this.el.removeClass(this.invalidClass);
- var t = Ext.getDom(this.msgTarget);
- if(t){
- t.innerHTML = '';
- t.style.display = 'none';
+
+ processItemEvent: function(type, record, row, rowIndex, e) {
+ var me = this,
+ cell = e.getTarget(me.cellSelector, row),
+ cellIndex = cell ? cell.cellIndex : -1,
+ map = me.statics().EventMap,
+ selModel = me.getSelectionModel(),
+ result;
+
+ if (type == 'keydown' && !cell && selModel.getCurrentPosition) {
+ // CellModel, otherwise we can't tell which cell to invoke
+ cell = me.getCellByPosition(selModel.getCurrentPosition());
+ if (cell) {
+ cell = cell.dom;
+ cellIndex = cell.cellIndex;
+ }
+ }
+
+ result = me.fireEvent('uievent', type, me, cell, rowIndex, cellIndex, e);
+
+ if (result === false || me.callParent(arguments) === false) {
+ return false;
+ }
+
+ // Don't handle cellmouseenter and cellmouseleave events for now
+ if (type == 'mouseover' || type == 'mouseout') {
+ return true;
+ }
+
+ return !(
+ // We are adding cell and feature events
+ (me['onBeforeCell' + map[type]](cell, cellIndex, record, row, rowIndex, e) === false) ||
+ (me.fireEvent('beforecell' + type, me, cell, cellIndex, record, row, rowIndex, e) === false) ||
+ (me['onCell' + map[type]](cell, cellIndex, record, row, rowIndex, e) === false) ||
+ (me.fireEvent('cell' + type, me, cell, cellIndex, record, row, rowIndex, e) === false)
+ );
+ },
+
+ processSpecialEvent: function(e) {
+ var me = this,
+ map = this.statics().EventMap,
+ features = this.features,
+ ln = features.length,
+ type = e.type,
+ i, feature, prefix, featureTarget,
+ beforeArgs, args,
+ panel = me.ownerCt;
+
+ this.callParent(arguments);
+
+ if (type == 'mouseover' || type == 'mouseout') {
+ return;
+ }
+
+ for (i = 0; i < ln; i++) {
+ feature = features[i];
+ if (feature.hasFeatureEvent) {
+ featureTarget = e.getTarget(feature.eventSelector, me.getTargetEl());
+ if (featureTarget) {
+ prefix = feature.eventPrefix;
+ // allows features to implement getFireEventArgs to change the
+ // fireEvent signature
+ beforeArgs = feature.getFireEventArgs('before' + prefix + type, me, featureTarget);
+ args = feature.getFireEventArgs(prefix + type, me, featureTarget);
+
+ if (
+ // before view event
+ (me.fireEvent.apply(me, beforeArgs) === false) ||
+ // panel grid event
+ (panel.fireEvent.apply(panel, beforeArgs) === false) ||
+ // view event
+ (me.fireEvent.apply(me, args) === false) ||
+ // panel event
+ (panel.fireEvent.apply(panel, args) === false)
+ ) {
+ return false;
+ }
}
}
}
-
- this.unsetActiveError();
+ return true;
},
+ onCellMouseDown: Ext.emptyFn,
+ onCellMouseUp: Ext.emptyFn,
+ onCellClick: Ext.emptyFn,
+ onCellDblClick: Ext.emptyFn,
+ onCellContextMenu: Ext.emptyFn,
+ onCellKeyDown: Ext.emptyFn,
+ onBeforeCellMouseDown: Ext.emptyFn,
+ onBeforeCellMouseUp: Ext.emptyFn,
+ onBeforeCellClick: Ext.emptyFn,
+ onBeforeCellDblClick: Ext.emptyFn,
+ onBeforeCellContextMenu: Ext.emptyFn,
+ onBeforeCellKeyDown: Ext.emptyFn,
+
/**
- * Sets the current activeError to the given string. Fires the 'invalid' event.
- * This does not set up the error icon, only sets the message and fires the event. To show the error icon,
- * use markInvalid instead, which calls this method internally
- * @param {String} msg The error message
- * @param {Boolean} suppressEvent True to suppress the 'invalid' event from being fired
+ * Expand a particular header to fit the max content width.
+ * This will ONLY expand, not contract.
+ * @private
*/
- setActiveError: function(msg, suppressEvent) {
- this.activeError = msg;
- if (suppressEvent !== true) this.fireEvent('invalid', this, msg);
+ expandToFit: function(header) {
+ var maxWidth = this.getMaxContentWidth(header);
+ delete header.flex;
+ header.setWidth(maxWidth);
},
-
+
/**
- * Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
- * usually need to be called manually
- * @param {Boolean} suppressEvent True to suppress the 'invalid' event from being fired
+ * Get the max contentWidth of the header's text and all cells
+ * in the grid under this header.
+ * @private
*/
- unsetActiveError: function(suppressEvent) {
- delete this.activeError;
- if (suppressEvent !== true) this.fireEvent('valid', this);
- },
+ getMaxContentWidth: function(header) {
+ var cellSelector = header.getCellInnerSelector(),
+ cells = this.el.query(cellSelector),
+ i = 0,
+ ln = cells.length,
+ maxWidth = header.el.dom.scrollWidth,
+ scrollWidth;
- // private
- getMessageHandler : function(){
- return Ext.form.MessageTargets[this.msgTarget];
+ for (; i < ln; i++) {
+ scrollWidth = cells[i].scrollWidth;
+ if (scrollWidth > maxWidth) {
+ maxWidth = scrollWidth;
+ }
+ }
+ return maxWidth;
},
- // private
- getErrorCt : function(){
- return this.el.findParent('.x-form-element', 5, true) || // use form element wrap if available
- this.el.findParent('.x-form-field-wrap', 5, true); // else direct field wrap
- },
+ getPositionByEvent: function(e) {
+ var cellNode = e.getTarget(this.cellSelector),
+ rowNode = e.getTarget(this.itemSelector),
+ record = this.getRecord(rowNode),
+ header = this.getHeaderByCell(cellNode);
- // Alignment for 'under' target
- alignErrorEl : function(){
- this.errorEl.setWidth(this.getErrorCt().getWidth(true) - 20);
+ return this.getPosition(record, header);
},
- // Alignment for 'side' target
- alignErrorIcon : function(){
- this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]);
+ getHeaderByCell: function(cell) {
+ if (cell) {
+ var m = cell.className.match(this.cellRe);
+ if (m && m[1]) {
+ return Ext.getCmp(m[1]);
+ }
+ }
+ return false;
},
/**
- * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.
- * @return {Mixed} value The field value
+ * @param {Object} position The current row and column: an object containing the following properties:
+ * - row The row index
+ * - columnThe column index
+ *
+ * @param {String} direction 'up', 'down', 'right' and 'left'
+ * @param {Ext.EventObject} e event
+ * @param {Boolean} preventWrap Set to true to prevent wrap around to the next or previous row.
+ * @param {Function} verifierFn A function to verify the validity of the calculated position. When using this function, you must return true to allow the newPosition to be returned.
+ * @param {Scope} scope Scope to run the verifierFn in
+ * @returns {Object} newPosition An object containing the following properties:
+ * - row The row index
+ * - columnThe column index
+ *
+ * @private
*/
- getRawValue : function(){
- var v = this.rendered ? this.el.getValue() : Ext.value(this.value, '');
- if(v === this.emptyText){
- v = '';
+ walkCells: function(pos, direction, e, preventWrap, verifierFn, scope) {
+ var row = pos.row,
+ column = pos.column,
+ rowCount = this.store.getCount(),
+ firstCol = this.getFirstVisibleColumnIndex(),
+ lastCol = this.getLastVisibleColumnIndex(),
+ newPos = {row: row, column: column},
+ activeHeader = this.headerCt.getHeaderAtIndex(column);
+
+ // no active header or its currently hidden
+ if (!activeHeader || activeHeader.hidden) {
+ return false;
}
- return v;
- },
- /**
- * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.
- * @return {Mixed} value The field value
- */
- getValue : function(){
- if(!this.rendered) {
- return this.value;
+ e = e || {};
+ direction = direction.toLowerCase();
+ switch (direction) {
+ case 'right':
+ // has the potential to wrap if its last
+ if (column === lastCol) {
+ // if bottom row and last column, deny right
+ if (preventWrap || row === rowCount - 1) {
+ return false;
+ }
+ if (!e.ctrlKey) {
+ // otherwise wrap to nextRow and firstCol
+ newPos.row = row + 1;
+ newPos.column = firstCol;
+ }
+ // go right
+ } else {
+ if (!e.ctrlKey) {
+ newPos.column = column + this.getRightGap(activeHeader);
+ } else {
+ newPos.column = lastCol;
+ }
+ }
+ break;
+
+ case 'left':
+ // has the potential to wrap
+ if (column === firstCol) {
+ // if top row and first column, deny left
+ if (preventWrap || row === 0) {
+ return false;
+ }
+ if (!e.ctrlKey) {
+ // otherwise wrap to prevRow and lastCol
+ newPos.row = row - 1;
+ newPos.column = lastCol;
+ }
+ // go left
+ } else {
+ if (!e.ctrlKey) {
+ newPos.column = column + this.getLeftGap(activeHeader);
+ } else {
+ newPos.column = firstCol;
+ }
+ }
+ break;
+
+ case 'up':
+ // if top row, deny up
+ if (row === 0) {
+ return false;
+ // go up
+ } else {
+ if (!e.ctrlKey) {
+ newPos.row = row - 1;
+ } else {
+ newPos.row = 0;
+ }
+ }
+ break;
+
+ case 'down':
+ // if bottom row, deny down
+ if (row === rowCount - 1) {
+ return false;
+ // go down
+ } else {
+ if (!e.ctrlKey) {
+ newPos.row = row + 1;
+ } else {
+ newPos.row = rowCount - 1;
+ }
+ }
+ break;
}
- var v = this.el.getValue();
- if(v === this.emptyText || v === undefined){
- v = '';
+
+ if (verifierFn && verifierFn.call(scope || window, newPos) !== true) {
+ return false;
+ } else {
+ return newPos;
}
- return v;
},
+ getFirstVisibleColumnIndex: function() {
+ var headerCt = this.getHeaderCt(),
+ allColumns = headerCt.getGridColumns(),
+ visHeaders = Ext.ComponentQuery.query(':not([hidden])', allColumns),
+ firstHeader = visHeaders[0];
- /**
- * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.
- * @param {Mixed} value The value to set
- * @return {Mixed} value The field value that is set
- */
- setRawValue : function(v){
- return this.rendered ? (this.el.dom.value = (Ext.isEmpty(v) ? '' : v)) : '';
+ return headerCt.getHeaderIndex(firstHeader);
},
- /**
- * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.
- * @param {Mixed} value The value to set
- * @return {Ext.form.Field} this
- */
- setValue : function(v){
- this.value = v;
- if(this.rendered){
- this.el.dom.value = (Ext.isEmpty(v) ? '' : v);
- this.validate();
- }
- return this;
+ getLastVisibleColumnIndex: function() {
+ var headerCt = this.getHeaderCt(),
+ allColumns = headerCt.getGridColumns(),
+ visHeaders = Ext.ComponentQuery.query(':not([hidden])', allColumns),
+ lastHeader = visHeaders[visHeaders.length - 1];
+
+ return headerCt.getHeaderIndex(lastHeader);
},
- // private, does not work for all fields
- append : function(v){
- this.setValue([this.getValue(), v].join(''));
- }
+ getHeaderCt: function() {
+ return this.headerCt;
+ },
- /**
- * @cfg {Boolean} autoWidth @hide
- */
- /**
- * @cfg {Boolean} autoHeight @hide
- */
+ getPosition: function(record, header) {
+ var me = this,
+ store = me.store,
+ gridCols = me.headerCt.getGridColumns();
+
+ return {
+ row: store.indexOf(record),
+ column: Ext.Array.indexOf(gridCols, header)
+ };
+ },
/**
- * @cfg {String} autoEl @hide
+ * Determines the 'gap' between the closest adjacent header to the right
+ * that is not hidden.
+ * @private
*/
-});
+ getRightGap: function(activeHeader) {
+ var headerCt = this.getHeaderCt(),
+ headers = headerCt.getGridColumns(),
+ activeHeaderIdx = Ext.Array.indexOf(headers, activeHeader),
+ i = activeHeaderIdx + 1,
+ nextIdx;
-
-Ext.form.MessageTargets = {
- 'qtip' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- field.el.dom.qtip = msg;
- field.el.dom.qclass = 'x-form-invalid-tip';
- if(Ext.QuickTips){ // fix for floating editors interacting with DND
- Ext.QuickTips.enable();
+ for (; i <= headers.length; i++) {
+ if (!headers[i].hidden) {
+ nextIdx = i;
+ break;
}
- },
- clear: function(field){
- field.el.removeClass(field.invalidClass);
- field.el.dom.qtip = '';
- }
- },
- 'title' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- field.el.dom.title = msg;
- },
- clear: function(field){
- field.el.dom.title = '';
}
+
+ return nextIdx - activeHeaderIdx;
},
- 'under' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- if(!field.errorEl){
- var elp = field.getErrorCt();
- if(!elp){ // field has no container el
- field.el.dom.title = msg;
- return;
- }
- field.errorEl = elp.createChild({cls:'x-form-invalid-msg'});
- field.on('resize', field.alignErrorEl, field);
- field.on('destroy', function(){
- Ext.destroy(this.errorEl);
- }, field);
- }
- field.alignErrorEl();
- field.errorEl.update(msg);
- Ext.form.Field.msgFx[field.msgFx].show(field.errorEl, field);
- },
- clear: function(field){
- field.el.removeClass(field.invalidClass);
- if(field.errorEl){
- Ext.form.Field.msgFx[field.msgFx].hide(field.errorEl, field);
- }else{
- field.el.dom.title = '';
+
+ beforeDestroy: function() {
+ if (this.rendered) {
+ table = this.el.child('table');
+ if (table) {
+ table.removeAllListeners();
}
}
+ this.callParent(arguments);
},
- 'side' : {
- mark: function(field, msg){
- field.el.addClass(field.invalidClass);
- if(!field.errorIcon){
- var elp = field.getErrorCt();
- // field has no container el
- if(!elp){
- field.el.dom.title = msg;
- return;
- }
- field.errorIcon = elp.createChild({cls:'x-form-invalid-icon'});
- if (field.ownerCt) {
- field.ownerCt.on('afterlayout', field.alignErrorIcon, field);
- field.ownerCt.on('expand', field.alignErrorIcon, field);
- }
- field.on('resize', field.alignErrorIcon, field);
- field.on('destroy', function(){
- Ext.destroy(this.errorIcon);
- }, field);
- }
- field.alignErrorIcon();
- field.errorIcon.dom.qtip = msg;
- field.errorIcon.dom.qclass = 'x-form-invalid-tip';
- field.errorIcon.show();
- },
- clear: function(field){
- field.el.removeClass(field.invalidClass);
- if(field.errorIcon){
- field.errorIcon.dom.qtip = '';
- field.errorIcon.hide();
- }else{
- field.el.dom.title = '';
+
+ /**
+ * Determines the 'gap' between the closest adjacent header to the left
+ * that is not hidden.
+ * @private
+ */
+ getLeftGap: function(activeHeader) {
+ var headerCt = this.getHeaderCt(),
+ headers = headerCt.getGridColumns(),
+ activeHeaderIdx = Ext.Array.indexOf(headers, activeHeader),
+ i = activeHeaderIdx - 1,
+ prevIdx;
+
+ for (; i >= 0; i--) {
+ if (!headers[i].hidden) {
+ prevIdx = i;
+ break;
}
}
+
+ return prevIdx - activeHeaderIdx;
}
-};
+});
+/**
+ * @class Ext.grid.View
+ * @extends Ext.view.Table
-// anything other than normal should be considered experimental
-Ext.form.Field.msgFx = {
- normal : {
- show: function(msgEl, f){
- msgEl.setDisplayed('block');
- },
+The grid View class provides extra {@link Ext.grid.Panel} specific functionality to the
+{@link Ext.view.Table}. In general, this class is not instanced directly, instead a viewConfig
+option is passed to the grid:
- hide : function(msgEl, f){
- msgEl.setDisplayed(false).update('');
+ Ext.create('Ext.grid.Panel', {
+ // other options
+ viewConfig: {
+ stripeRows: false
}
- },
-
- slide : {
- show: function(msgEl, f){
- msgEl.slideIn('t', {stopFx:true});
- },
+ });
+
+__Drag Drop__
+Drag and drop functionality can be achieved in the grid by attaching a {@link Ext.grid.plugin.DragDrop} plugin
+when creating the view.
- hide : function(msgEl, f){
- msgEl.slideOut('t', {stopFx:true,useDisplay:true});
+ Ext.create('Ext.grid.Panel', {
+ // other options
+ viewConfig: {
+ plugins: {
+ ddGroup: 'people-group',
+ ptype: 'gridviewdragdrop',
+ enableDrop: false
+ }
}
- },
-
- slideRight : {
- show: function(msgEl, f){
- msgEl.fixDisplay();
- msgEl.alignTo(f.el, 'tl-tr');
- msgEl.slideIn('l', {stopFx:true});
- },
+ });
- hide : function(msgEl, f){
- msgEl.slideOut('l', {stopFx:true,useDisplay:true});
- }
- }
-};
-Ext.reg('field', Ext.form.Field);
-/**
- * @class Ext.form.TextField
- * @extends Ext.form.Field
- * 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.TextArea}
- * and {@link Ext.form.ComboBox}).
- * Validation
- * The validation procedure is described in the documentation for {@link #validateValue}.
- * Alter Validation Behavior
- * Validation behavior for each field can be configured:
- *
- * {@link Ext.form.TextField#invalidText invalidText}
: the default validation message to
- * show if any validation step above does not provide a message when invalid
- * {@link Ext.form.TextField#maskRe maskRe}
: filter out keystrokes before any validation occurs
- * {@link Ext.form.TextField#stripCharsRe stripCharsRe}
: filter characters after being typed in,
- * but before being validated
- * {@link Ext.form.Field#invalidClass invalidClass}
: alternate style when invalid
- * {@link Ext.form.Field#validateOnBlur validateOnBlur}
,
- * {@link Ext.form.Field#validationDelay validationDelay}
, and
- * {@link Ext.form.Field#validationEvent validationEvent}
: modify how/when validation is triggered
- *
- *
- * @constructor Creates a new TextField
- * @param {Object} config Configuration options
- *
- * @xtype textfield
+ * @markdown
*/
-Ext.form.TextField = Ext.extend(Ext.form.Field, {
- /**
- * @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 ''). Note:
- * only applies if {@link #vtype}
is set, else ignored.
- */
- /**
- * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value
- * before validation (defaults to null).
- */
- /**
- * @cfg {Boolean} grow true if this field should automatically grow and shrink to its content
- * (defaults to false)
- */
- grow : false,
- /**
- * @cfg {Number} growMin The minimum width to allow when {@link #grow} = true
(defaults
- * to 30)
- */
- growMin : 30,
- /**
- * @cfg {Number} growMax The maximum width to allow when {@link #grow} = true
(defaults
- * to 800)
- */
- growMax : 800,
- /**
- * @cfg {String} vtype A validation type name as defined in {@link Ext.form.VTypes} (defaults to null)
- */
- vtype : null,
- /**
- * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do
- * not match (defaults to null)
- */
- maskRe : null,
+Ext.define('Ext.grid.View', {
+ extend: 'Ext.view.Table',
+ alias: 'widget.gridview',
+
/**
- * @cfg {Boolean} disableKeyFilter Specify true to disable input keystroke filtering (defaults
- * to false)
+ * @cfg {Boolean} stripeRows true to stripe the rows. Default is false.
+ * This causes the CSS class x-grid-row-alt to be added to alternate rows of
+ * the grid. A default CSS rule is provided which sets a background color, but you can override this
+ * with a rule which either overrides the background-color style using the '!important'
+ * modifier, or which uses a CSS selector of higher specificity.
*/
- disableKeyFilter : false,
+ stripeRows: true,
+
+ invalidateScrollerOnRefresh: true,
+
/**
- * @cfg {Boolean} allowBlank Specify false to validate that the value's length is > 0 (defaults to
- * true)
+ * Scroll the GridView to the top by scrolling the scroller.
+ * @private
*/
- allowBlank : true,
+ scrollToTop : function(){
+ if (this.rendered) {
+ var section = this.ownerCt,
+ verticalScroller = section.verticalScroller;
+
+ if (verticalScroller) {
+ verticalScroller.scrollToTop();
+ }
+ }
+ },
+
+ // after adding a row stripe rows from then on
+ onAdd: function(ds, records, index) {
+ this.callParent(arguments);
+ this.doStripeRows(index);
+ },
+
+ // after removing a row stripe rows from then on
+ onRemove: function(ds, records, index) {
+ this.callParent(arguments);
+ this.doStripeRows(index);
+ },
+
/**
- * @cfg {Number} minLength Minimum input field length required (defaults to 0)
+ * Stripe rows from a particular row index
+ * @param {Number} startRow
+ * @private
*/
- minLength : 0,
- /**
- * @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 {@link Ext.form.Field#autoCreate autoCreate} to add
- * any attributes you want to a field, for example:
-var myField = new Ext.form.NumberField({
- id: 'mobile',
- anchor:'90%',
- fieldLabel: 'Mobile',
- maxLength: 16, // for validation
- autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
+ doStripeRows: function(startRow) {
+ // ensure stripeRows configuration is turned on
+ if (this.stripeRows) {
+ var rows = this.getNodes(startRow),
+ rowsLn = rows.length,
+ i = 0,
+ row;
+
+ for (; i < rowsLn; i++) {
+ row = rows[i];
+ // Remove prior applied row classes.
+ row.className = row.className.replace(this.rowClsRe, ' ');
+ // Every odd row will get an additional cls
+ if (i % 2 === 1) {
+ row.className += (' ' + this.altRowCls);
+ }
+ }
+ }
+ },
+
+ refresh: function(firstPass) {
+ this.callParent(arguments);
+ this.doStripeRows(0);
+ // TODO: Remove gridpanel dependency
+ var g = this.up('gridpanel');
+ if (g && this.invalidateScrollerOnRefresh) {
+ g.invalidateScroller();
+ }
+ }
});
-
- */
- maxLength : Number.MAX_VALUE,
- /**
- * @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}')
- */
- minLengthText : 'The minimum length for this field is {0}',
- /**
- * @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}')
- */
- maxLengthText : 'The maximum length for this field is {0}',
- /**
- * @cfg {Boolean} selectOnFocus true to automatically select any existing field text when the field
- * receives input focus (defaults to false)
- */
- selectOnFocus : false,
- /**
- * @cfg {String} blankText The error text to display if the {@link #allowBlank} validation
- * fails (defaults to 'This field is required')
- */
- blankText : 'This field is required',
- /**
- * @cfg {Function} validator
- * A custom validation function to be called during field validation ({@link #validateValue})
- * (defaults to null). 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 value
- *
- *
This function is to Return:
- *
- * true
: Boolean
- * true
if the value is valid
- * msg
: String
- * An error message if the value is invalid
- *
- */
- validator : null,
- /**
- * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation
- * (defaults to null). If the test fails, the field will be marked invalid using
- * {@link #regexText}.
- */
- regex : null,
- /**
- * @cfg {String} regexText The error text to display if {@link #regex} is used and the
- * test fails during validation (defaults to '')
- */
- regexText : '',
- /**
- * @cfg {String} emptyText The default text to place into an empty field (defaults to null).
- * Note: that this value will be submitted to the server if this field is enabled and configured
- * with a {@link #name}.
- */
- emptyText : null,
- /**
- * @cfg {String} emptyClass 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.
- */
- emptyClass : 'x-form-empty-field',
+/**
+ * @author Aaron Conran
+ * @class Ext.grid.Panel
+ * @extends Ext.panel.Table
+ *
+ * Grids are an excellent way of showing large amounts of tabular data on the client side. Essentially a supercharged
+ * ``, GridPanel makes it easy to fetch, sort and filter large amounts of data.
+ *
+ * Grids are composed of 2 main pieces - a {@link Ext.data.Store Store} full of data and a set of columns to render.
+ *
+ * {@img Ext.grid.Panel/Ext.grid.Panel1.png Ext.grid.Panel component}
+ *
+ * ## Basic GridPanel
+ *
+ * Ext.create('Ext.data.Store', {
+ * storeId:'simpsonsStore',
+ * fields:['name', 'email', 'phone'],
+ * data:{'items':[
+ * {"name":"Lisa", "email":"lisa@simpsons.com", "phone":"555-111-1224"},
+ * {"name":"Bart", "email":"bart@simpsons.com", "phone":"555--222-1234"},
+ * {"name":"Homer", "email":"home@simpsons.com", "phone":"555-222-1244"},
+ * {"name":"Marge", "email":"marge@simpsons.com", "phone":"555-222-1254"}
+ * ]},
+ * proxy: {
+ * type: 'memory',
+ * reader: {
+ * type: 'json',
+ * root: 'items'
+ * }
+ * }
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Simpsons',
+ * store: Ext.data.StoreManager.lookup('simpsonsStore'),
+ * columns: [
+ * {header: 'Name', dataIndex: 'name'},
+ * {header: 'Email', dataIndex: 'email', flex:1},
+ * {header: 'Phone', dataIndex: 'phone'}
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * The code above produces a simple grid with three columns. We specified a Store which will load JSON data inline.
+ * In most apps we would be placing the grid inside another container and wouldn't need to use the
+ * {@link #height}, {@link #width} and {@link #renderTo} configurations but they are included here to make it easy to get
+ * up and running.
+ *
+ * The grid we created above will contain a header bar with a title ('Simpsons'), a row of column headers directly underneath
+ * and finally the grid rows under the headers.
+ *
+ * ## Configuring columns
+ *
+ * By default, each column is sortable and will toggle between ASC and DESC sorting when you click on its header. Each
+ * column header is also reorderable by default, and each gains a drop-down menu with options to hide and show columns.
+ * It's easy to configure each column - here we use the same example as above and just modify the columns config:
+ *
+ * columns: [
+ * {
+ * header: 'Name',
+ * dataIndex: 'name',
+ * sortable: false,
+ * hideable: false,
+ * flex: 1
+ * },
+ * {
+ * header: 'Email',
+ * dataIndex: 'email',
+ * hidden: true
+ * },
+ * {
+ * header: 'Phone',
+ * dataIndex: 'phone',
+ * width: 100
+ * }
+ * ]
+ *
+ * We turned off sorting and hiding on the 'Name' column so clicking its header now has no effect. We also made the Email
+ * column hidden by default (it can be shown again by using the menu on any other column). We also set the Phone column to
+ * a fixed with of 100px and flexed the Name column, which means it takes up all remaining width after the other columns
+ * have been accounted for. See the {@link Ext.grid.column.Column column docs} for more details.
+ *
+ * ## Renderers
+ *
+ * As well as customizing columns, it's easy to alter the rendering of individual cells using renderers. A renderer is
+ * tied to a particular column and is passed the value that would be rendered into each cell in that column. For example,
+ * we could define a renderer function for the email column to turn each email address into a mailto link:
+ *
+ * columns: [
+ * {
+ * header: 'Email',
+ * dataIndex: 'email',
+ * renderer: function(value) {
+ * return Ext.String.format('{1}', value, value);
+ * }
+ * }
+ * ]
+ *
+ * See the {@link Ext.grid.column.Column column docs} for more information on renderers.
+ *
+ * ## Selection Models
+ *
+ * Sometimes all you want is to render data onto the screen for viewing, but usually it's necessary to interact with or
+ * update that data. Grids use a concept called a Selection Model, which is simply a mechanism for selecting some part of
+ * the data in the grid. The two main types of Selection Model are RowSelectionModel, where entire rows are selected, and
+ * CellSelectionModel, where individual cells are selected.
+ *
+ * Grids use a Row Selection Model by default, but this is easy to customise like so:
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * selType: 'cellmodel',
+ * store: ...
+ * });
+ *
+ * Specifying the `cellmodel` changes a couple of things. Firstly, clicking on a cell now
+ * selects just that cell (using a {@link Ext.selection.RowModel rowmodel} will select the entire row), and secondly the
+ * keyboard navigation will walk from cell to cell instead of row to row. Cell-based selection models are usually used in
+ * conjunction with editing.
+ *
+ * {@img Ext.grid.Panel/Ext.grid.Panel2.png Ext.grid.Panel cell editing}
+ *
+ * ## Editing
+ *
+ * Grid has built-in support for in-line editing. There are two chief editing modes - cell editing and row editing. Cell
+ * editing is easy to add to your existing column setup - here we'll just modify the example above to include an editor
+ * on both the name and the email columns:
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Simpsons',
+ * store: Ext.data.StoreManager.lookup('simpsonsStore'),
+ * columns: [
+ * {header: 'Name', dataIndex: 'name', field: 'textfield'},
+ * {header: 'Email', dataIndex: 'email', flex:1,
+ * field:{
+ * xtype:'textfield',
+ * allowBlank:false
+ * }
+ * },
+ * {header: 'Phone', dataIndex: 'phone'}
+ * ],
+ * selType: 'cellmodel',
+ * plugins: [
+ * Ext.create('Ext.grid.plugin.CellEditing', {
+ * clicksToEdit: 1
+ * })
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * This requires a little explanation. We're passing in {@link #store store} and {@link #columns columns} as normal, but
+ * this time we've also specified a {@link #field field} on two of our columns. For the Name column we just want a default
+ * textfield to edit the value, so we specify 'textfield'. For the Email column we customized the editor slightly by
+ * passing allowBlank: false, which will provide inline validation.
+ *
+ * To support cell editing, we also specified that the grid should use the 'cellmodel' {@link #selType}, and created an
+ * instance of the {@link Ext.grid.plugin.CellEditing CellEditing plugin}, which we configured to activate each editor after a
+ * single click.
+ *
+ * {@img Ext.grid.Panel/Ext.grid.Panel3.png Ext.grid.Panel row editing}
+ *
+ * ## Row Editing
+ *
+ * The other type of editing is row-based editing, using the RowEditor component. This enables you to edit an entire row
+ * at a time, rather than editing cell by cell. Row Editing works in exactly the same way as cell editing, all we need to
+ * do is change the plugin type to {@link Ext.grid.plugin.RowEditing}, and set the selType to 'rowmodel':
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Simpsons',
+ * store: Ext.data.StoreManager.lookup('simpsonsStore'),
+ * columns: [
+ * {header: 'Name', dataIndex: 'name', field: 'textfield'},
+ * {header: 'Email', dataIndex: 'email', flex:1,
+ * field:{
+ * xtype:'textfield',
+ * allowBlank:false
+ * }
+ * },
+ * {header: 'Phone', dataIndex: 'phone'}
+ * ],
+ * selType: 'rowmodel',
+ * plugins: [
+ * Ext.create('Ext.grid.plugin.RowEditing', {
+ * clicksToEdit: 1
+ * })
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * Again we passed some configuration to our {@link Ext.grid.plugin.RowEditing} plugin, and now when we click each row a row
+ * editor will appear and enable us to edit each of the columns we have specified an editor for.
+ *
+ * ## Sorting & Filtering
+ *
+ * Every grid is attached to a {@link Ext.data.Store Store}, which provides multi-sort and filtering capabilities. It's
+ * easy to set up a grid to be sorted from the start:
+ *
+ * var myGrid = Ext.create('Ext.grid.Panel', {
+ * store: {
+ * fields: ['name', 'email', 'phone'],
+ * sorters: ['name', 'phone']
+ * },
+ * columns: [
+ * {text: 'Name', dataIndex: 'name'},
+ * {text: 'Email', dataIndex: 'email'}
+ * ]
+ * });
+ *
+ * Sorting at run time is easily accomplished by simply clicking each column header. If you need to perform sorting on
+ * more than one field at run time it's easy to do so by adding new sorters to the store:
+ *
+ * myGrid.store.sort([
+ * {property: 'name', direction: 'ASC'},
+ * {property: 'email', direction: 'DESC'},
+ * ]);
+ *
+ * {@img Ext.grid.Panel/Ext.grid.Panel4.png Ext.grid.Panel grouping}
+ *
+ * ## Grouping
+ *
+ * Grid supports the grouping of rows by any field. For example if we had a set of employee records, we might want to
+ * group by the department that each employee works in. Here's how we might set that up:
+ *
+ * var store = Ext.create('Ext.data.Store', {
+ * storeId:'employeeStore',
+ * fields:['name', 'senority', 'department'],
+ * groupField: 'department',
+ * data:{'employees':[
+ * {"name":"Michael Scott", "senority":7, "department":"Manangement"},
+ * {"name":"Dwight Schrute", "senority":2, "department":"Sales"},
+ * {"name":"Jim Halpert", "senority":3, "department":"Sales"},
+ * {"name":"Kevin Malone", "senority":4, "department":"Accounting"},
+ * {"name":"Angela Martin", "senority":5, "department":"Accounting"}
+ * ]},
+ * proxy: {
+ * type: 'memory',
+ * reader: {
+ * type: 'json',
+ * root: 'employees'
+ * }
+ * }
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Employees',
+ * store: Ext.data.StoreManager.lookup('employeeStore'),
+ * columns: [
+ * {header: 'Name', dataIndex: 'name'},
+ * {header: 'Senority', dataIndex: 'senority'}
+ * ],
+ * features: [{ftype:'grouping'}],
+ * width: 200,
+ * height: 275,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * ## Infinite Scrolling
+ *
+ * Grid supports infinite scrolling as an alternative to using a paging toolbar. Your users can scroll through thousands
+ * of records without the performance penalties of renderering all the records on screen at once. The grid should be bound
+ * to a store with a pageSize specified.
+ *
+ * var grid = Ext.create('Ext.grid.Panel', {
+ * // Use a PagingGridScroller (this is interchangeable with a PagingToolbar)
+ * verticalScrollerType: 'paginggridscroller',
+ * // do not reset the scrollbar when the view refreshs
+ * invalidateScrollerOnRefresh: false,
+ * // infinite scrolling does not support selection
+ * disableSelection: true,
+ * // ...
+ * });
+ *
+ * ## Paging
+ *
+ * Grid supports paging through large sets of data via a PagingToolbar or PagingGridScroller (see the Infinite Scrolling section above).
+ * To leverage paging via a toolbar or scroller, you need to set a pageSize configuration on the Store.
+ *
+ * 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()
+ * });
+ *
+ * {@img Ext.grid.Panel/Ext.grid.Panel5.png Ext.grid.Panel grouping}
+ *
+ * @docauthor Ed Spencer
+ */
+Ext.define('Ext.grid.Panel', {
+ extend: 'Ext.panel.Table',
+ requires: ['Ext.grid.View'],
+ alias: ['widget.gridpanel', 'widget.grid'],
+ alternateClassName: ['Ext.list.ListView', 'Ext.ListView', 'Ext.grid.GridPanel'],
+ viewType: 'gridview',
+
+ lockable: false,
+
+ // Required for the Lockable Mixin. These are the configurations which will be copied to the
+ // normal and locked sub tablepanels
+ normalCfgCopy: ['invalidateScrollerOnRefresh', 'verticalScroller', 'verticalScrollDock', 'verticalScrollerType', 'scroll'],
+ lockedCfgCopy: ['invalidateScrollerOnRefresh'],
+
/**
- * @cfg {Boolean} enableKeyEvents true to enable the proxying of key events for the HTML input
- * field (defaults to false)
+ * @cfg {Boolean} columnLines Adds column line styling
*/
+
+ initComponent: function() {
+ var me = this;
- initComponent : function(){
- Ext.form.TextField.superclass.initComponent.call(this);
- this.addEvents(
- /**
- * @event autosize
- * Fires when the {@link #autoSize} function is triggered. The field may or
- * may not have actually changed size according to the default logic, but this event provides
- * a hook for the developer to apply additional logic at runtime to resize the field if needed.
- * @param {Ext.form.Field} this This text field
- * @param {Number} width The new field width
- */
- 'autosize',
-
- /**
- * @event keydown
- * Keydown input field event. This event only fires if {@link #enableKeyEvents}
- * is set to true.
- * @param {Ext.form.TextField} this This text field
- * @param {Ext.EventObject} e
- */
- 'keydown',
- /**
- * @event keyup
- * Keyup input field event. This event only fires if {@link #enableKeyEvents}
- * is set to true.
- * @param {Ext.form.TextField} this This text field
- * @param {Ext.EventObject} e
- */
- 'keyup',
- /**
- * @event keypress
- * Keypress input field event. This event only fires if {@link #enableKeyEvents}
- * is set to true.
- * @param {Ext.form.TextField} this This text field
- * @param {Ext.EventObject} e
- */
- 'keypress'
- );
+ if (me.columnLines) {
+ me.setColumnLines(me.columnLines);
+ }
+
+ me.callParent();
},
+
+ setColumnLines: function(show) {
+ var me = this,
+ method = (show) ? 'addClsWithUI' : 'removeClsWithUI';
+
+ me[method]('with-col-lines')
+ }
+});
+// Currently has the following issues:
+// - Does not handle postEditValue
+// - Fields without editors need to sync with their values in Store
+// - starting to edit another record while already editing and dirty should probably prevent it
+// - aggregating validation messages
+// - tabIndex is not managed bc we leave elements in dom, and simply move via positioning
+// - layout issues when changing sizes/width while hidden (layout bug)
+
+/**
+ * @class Ext.grid.RowEditor
+ * @extends Ext.form.Panel
+ *
+ * Internal utility class used to provide row editing functionality. For developers, they should use
+ * the RowEditing plugin to use this functionality with a grid.
+ *
+ * @ignore
+ */
+Ext.define('Ext.grid.RowEditor', {
+ extend: 'Ext.form.Panel',
+ requires: [
+ 'Ext.tip.ToolTip',
+ 'Ext.util.HashMap',
+ 'Ext.util.KeyNav'
+ ],
+
+ saveBtnText : 'Update',
+ cancelBtnText: 'Cancel',
+ errorsText: 'Errors',
+ dirtyText: 'You need to commit or cancel your changes',
- // private
- initEvents : function(){
- Ext.form.TextField.superclass.initEvents.call(this);
- if(this.validationEvent == 'keyup'){
- this.validationTask = new Ext.util.DelayedTask(this.validate, this);
- this.mon(this.el, 'keyup', this.filterValidation, this);
- }
- else if(this.validationEvent !== false && this.validationEvent != 'blur'){
- this.mon(this.el, this.validationEvent, this.validate, this, {buffer: this.validationDelay});
- }
- if(this.selectOnFocus || this.emptyText){
- this.mon(this.el, 'mousedown', this.onMouseDown, this);
-
- if(this.emptyText){
- this.applyEmptyText();
+ lastScrollLeft: 0,
+ lastScrollTop: 0,
+
+ border: false,
+
+ initComponent: function() {
+ var me = this,
+ form;
+
+ me.cls = Ext.baseCSSPrefix + 'grid-row-editor';
+
+ me.layout = {
+ type: 'hbox',
+ align: 'middle'
+ };
+
+ // Maintain field-to-column mapping
+ // It's easy to get a field from a column, but not vice versa
+ me.columns = Ext.create('Ext.util.HashMap');
+ me.columns.getKey = function(columnHeader) {
+ var f;
+ if (columnHeader.getEditor) {
+ f = columnHeader.getEditor();
+ if (f) {
+ return f.id;
+ }
}
+ return columnHeader.id;
+ };
+ me.mon(me.columns, {
+ add: me.onFieldAdd,
+ remove: me.onFieldRemove,
+ replace: me.onFieldReplace,
+ scope: me
+ });
+
+ me.callParent(arguments);
+
+ if (me.fields) {
+ me.setField(me.fields);
+ delete me.fields;
}
- if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Ext.form.VTypes[this.vtype+'Mask']))){
- this.mon(this.el, 'keypress', this.filterKeys, this);
- }
- if(this.grow){
- this.mon(this.el, 'keyup', this.onKeyUpBuffered, this, {buffer: 50});
- this.mon(this.el, 'click', this.autoSize, this);
+
+ form = me.getForm();
+ form.trackResetOnLoad = true;
+ },
+
+ onFieldChange: function() {
+ var me = this,
+ form = me.getForm(),
+ valid = form.isValid();
+ if (me.errorSummary && me.isVisible()) {
+ me[valid ? 'hideToolTip' : 'showToolTip']();
}
- if(this.enableKeyEvents){
- this.mon(this.el, {
- scope: this,
- keyup: this.onKeyUp,
- keydown: this.onKeyDown,
- keypress: this.onKeyPress
- });
+ if (me.floatingButtons) {
+ me.floatingButtons.child('#update').setDisabled(!valid);
}
+ me.isValid = valid;
},
-
- onMouseDown: function(e){
- if(!this.hasFocus){
- this.mon(this.el, 'mouseup', Ext.emptyFn, this, { single: true, preventDefault: true });
+
+ afterRender: function() {
+ var me = this,
+ plugin = me.editingPlugin;
+
+ me.callParent(arguments);
+ me.mon(me.renderTo, 'scroll', me.onCtScroll, me, { buffer: 100 });
+
+ // Prevent from bubbling click events to the grid view
+ me.mon(me.el, {
+ click: Ext.emptyFn,
+ stopPropagation: true
+ });
+
+ me.el.swallowEvent([
+ 'keypress',
+ 'keydown'
+ ]);
+
+ me.keyNav = Ext.create('Ext.util.KeyNav', me.el, {
+ enter: plugin.completeEdit,
+ esc: plugin.onEscKey,
+ scope: plugin
+ });
+
+ me.mon(plugin.view, {
+ beforerefresh: me.onBeforeViewRefresh,
+ refresh: me.onViewRefresh,
+ scope: me
+ });
+ },
+
+ onBeforeViewRefresh: function(view) {
+ var me = this,
+ viewDom = view.el.dom;
+
+ if (me.el.dom.parentNode === viewDom) {
+ viewDom.removeChild(me.el.dom);
}
},
- processValue : function(value){
- if(this.stripCharsRe){
- var newValue = value.replace(this.stripCharsRe, '');
- if(newValue !== value){
- this.setRawValue(newValue);
- return newValue;
+ onViewRefresh: function(view) {
+ var me = this,
+ viewDom = view.el.dom,
+ context = me.context,
+ idx;
+
+ viewDom.appendChild(me.el.dom);
+
+ // Recover our row node after a view refresh
+ if (context && (idx = context.store.indexOf(context.record)) >= 0) {
+ context.row = view.getNode(idx);
+ me.reposition();
+ if (me.tooltip && me.tooltip.isVisible()) {
+ me.tooltip.setTarget(context.row);
}
+ } else {
+ me.editingPlugin.cancelEdit();
}
- return value;
},
- filterValidation : function(e){
- if(!e.isNavKeyPress()){
- this.validationTask.delay(this.validationDelay);
+ onCtScroll: function(e, target) {
+ var me = this,
+ scrollTop = target.scrollTop,
+ scrollLeft = target.scrollLeft;
+
+ if (scrollTop !== me.lastScrollTop) {
+ me.lastScrollTop = scrollTop;
+ if ((me.tooltip && me.tooltip.isVisible()) || me.hiddenTip) {
+ me.repositionTip();
+ }
+ }
+ if (scrollLeft !== me.lastScrollLeft) {
+ me.lastScrollLeft = scrollLeft;
+ me.reposition();
}
},
-
- //private
- onDisable: function(){
- Ext.form.TextField.superclass.onDisable.call(this);
- if(Ext.isIE){
- this.el.dom.unselectable = 'on';
+
+ onColumnAdd: function(column) {
+ this.setField(column);
+ },
+
+ onColumnRemove: function(column) {
+ this.columns.remove(column);
+ },
+
+ onColumnResize: function(column, width) {
+ column.getEditor().setWidth(width - 2);
+ if (this.isVisible()) {
+ this.reposition();
}
},
-
- //private
- onEnable: function(){
- Ext.form.TextField.superclass.onEnable.call(this);
- if(Ext.isIE){
- this.el.dom.unselectable = '';
+
+ onColumnHide: function(column) {
+ column.getEditor().hide();
+ if (this.isVisible()) {
+ this.reposition();
}
},
- // private
- onKeyUpBuffered : function(e){
- if(this.doAutoSize(e)){
- this.autoSize();
+ onColumnShow: function(column) {
+ var field = column.getEditor();
+ field.setWidth(column.getWidth() - 2).show();
+ if (this.isVisible()) {
+ this.reposition();
}
},
-
- // private
- doAutoSize : function(e){
- return !e.isNavKeyPress();
+
+ onColumnMove: function(column, fromIdx, toIdx) {
+ var field = column.getEditor();
+ if (this.items.indexOf(field) != toIdx) {
+ this.move(fromIdx, toIdx);
+ }
},
- // private
- onKeyUp : function(e){
- this.fireEvent('keyup', this, e);
+ onFieldAdd: function(hm, fieldId, column) {
+ var me = this,
+ colIdx = me.editingPlugin.grid.headerCt.getHeaderIndex(column),
+ field = column.getEditor({ xtype: 'displayfield' });
+
+ me.insert(colIdx, field);
},
- // private
- onKeyDown : function(e){
- this.fireEvent('keydown', this, e);
+ onFieldRemove: function(hm, fieldId, column) {
+ var me = this,
+ field = column.getEditor(),
+ fieldDom = field.el.dom;
+ me.remove(field, false);
+ fieldDom.parentNode.removeChild(fieldDom);
},
- // private
- onKeyPress : function(e){
- this.fireEvent('keypress', this, e);
+ onFieldReplace: function(hm, fieldId, column, oldColumn) {
+ var me = this;
+ me.onFieldRemove(hm, fieldId, oldColumn);
},
- /**
- * Resets the current field value to the originally-loaded value and clears any validation messages.
- * Also adds {@link #emptyText} and {@link #emptyClass} if the
- * original value was blank.
- */
- reset : function(){
- Ext.form.TextField.superclass.reset.call(this);
- this.applyEmptyText();
+ clearFields: function() {
+ var me = this,
+ hm = me.columns;
+ hm.each(function(fieldId) {
+ hm.removeAtKey(fieldId);
+ });
},
- applyEmptyText : function(){
- if(this.rendered && this.emptyText && this.getRawValue().length < 1 && !this.hasFocus){
- this.setRawValue(this.emptyText);
- this.el.addClass(this.emptyClass);
+ getFloatingButtons: function() {
+ var me = this,
+ cssPrefix = Ext.baseCSSPrefix,
+ btnsCss = cssPrefix + 'grid-row-editor-buttons',
+ plugin = me.editingPlugin,
+ btns;
+
+ if (!me.floatingButtons) {
+ btns = me.floatingButtons = Ext.create('Ext.Container', {
+ renderTpl: [
+ '',
+ '',
+ '',
+ '',
+ ''
+ ],
+
+ renderTo: me.el,
+ baseCls: btnsCss,
+ layout: {
+ type: 'hbox',
+ align: 'middle'
+ },
+ defaults: {
+ margins: '0 1 0 1'
+ },
+ items: [{
+ itemId: 'update',
+ flex: 1,
+ xtype: 'button',
+ handler: plugin.completeEdit,
+ scope: plugin,
+ text: me.saveBtnText,
+ disabled: !me.isValid
+ }, {
+ flex: 1,
+ xtype: 'button',
+ handler: plugin.cancelEdit,
+ scope: plugin,
+ text: me.cancelBtnText
+ }]
+ });
+
+ // Prevent from bubbling click events to the grid view
+ me.mon(btns.el, {
+ // BrowserBug: Opera 11.01
+ // causes the view to scroll when a button is focused from mousedown
+ mousedown: Ext.emptyFn,
+ click: Ext.emptyFn,
+ stopEvent: true
+ });
}
+ return me.floatingButtons;
},
- // private
- preFocus : function(){
- var el = this.el;
- if(this.emptyText){
- if(el.dom.value == this.emptyText){
- this.setRawValue('');
+ reposition: function(animateConfig) {
+ var me = this,
+ context = me.context,
+ row = context && Ext.get(context.row),
+ btns = me.getFloatingButtons(),
+ btnEl = btns.el,
+ grid = me.editingPlugin.grid,
+ viewEl = grid.view.el,
+ scroller = grid.verticalScroller,
+
+ // always get data from ColumnModel as its what drives
+ // the GridView's sizing
+ mainBodyWidth = grid.headerCt.getFullWidth(),
+ scrollerWidth = grid.getWidth(),
+
+ // use the minimum as the columns may not fill up the entire grid
+ // width
+ width = Math.min(mainBodyWidth, scrollerWidth),
+ scrollLeft = grid.view.el.dom.scrollLeft,
+ btnWidth = btns.getWidth(),
+ left = (width - btnWidth) / 2 + scrollLeft,
+ y, rowH, newHeight,
+
+ invalidateScroller = function() {
+ if (scroller) {
+ scroller.invalidate();
+ btnEl.scrollIntoView(viewEl, false);
+ }
+ if (animateConfig && animateConfig.callback) {
+ animateConfig.callback.call(animateConfig.scope || me);
+ }
+ };
+
+ // need to set both top/left
+ if (row && Ext.isElement(row.dom)) {
+ // Bring our row into view if necessary, so a row editor that's already
+ // visible and animated to the row will appear smooth
+ row.scrollIntoView(viewEl, false);
+
+ // Get the y position of the row relative to its top-most static parent.
+ // offsetTop will be relative to the table, and is incorrect
+ // when mixed with certain grid features (e.g., grouping).
+ y = row.getXY()[1] - 5;
+ rowH = row.getHeight();
+ newHeight = rowH + 10;
+
+ // IE doesn't set the height quite right.
+ // This isn't a border-box issue, it even happens
+ // in IE8 and IE7 quirks.
+ // TODO: Test in IE9!
+ if (Ext.isIE) {
+ newHeight += 2;
+ }
+
+ // Set editor height to match the row height
+ if (me.getHeight() != newHeight) {
+ me.setHeight(newHeight);
+ me.el.setLeft(0);
+ }
+
+ if (animateConfig) {
+ var animObj = {
+ to: {
+ y: y
+ },
+ duration: animateConfig.duration || 125,
+ listeners: {
+ afteranimate: function() {
+ invalidateScroller();
+ y = row.getXY()[1] - 5;
+ me.el.setY(y);
+ }
+ }
+ };
+ me.animate(animObj);
+ } else {
+ me.el.setY(y);
+ invalidateScroller();
}
- el.removeClass(this.emptyClass);
}
- if(this.selectOnFocus){
- el.dom.select();
+ if (me.getWidth() != mainBodyWidth) {
+ me.setWidth(mainBodyWidth);
}
+ btnEl.setLeft(left);
},
- // private
- postBlur : function(){
- this.applyEmptyText();
- },
+ getEditor: function(fieldInfo) {
+ var me = this;
- // private
- filterKeys : function(e){
- if(e.ctrlKey){
- return;
+ if (Ext.isNumber(fieldInfo)) {
+ // Query only form fields. This just future-proofs us in case we add
+ // other components to RowEditor later on. Don't want to mess with
+ // indices.
+ return me.query('>[isFormField]')[fieldInfo];
+ } else if (fieldInfo instanceof Ext.grid.column.Column) {
+ return fieldInfo.getEditor();
}
- var k = e.getKey();
- if(Ext.isGecko && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
+ },
+
+ removeField: function(field) {
+ var me = this;
+
+ // Incase we pass a column instead, which is fine
+ field = me.getEditor(field);
+ me.mun(field, 'validitychange', me.onValidityChange, me);
+
+ // Remove field/column from our mapping, which will fire the event to
+ // remove the field from our container
+ me.columns.removeKey(field.id);
+ },
+
+ setField: function(column) {
+ var me = this,
+ field;
+
+ if (Ext.isArray(column)) {
+ Ext.Array.forEach(column, me.setField, me);
return;
}
- var cc = String.fromCharCode(e.getCharCode());
- if(!Ext.isGecko && e.isSpecialKey() && !cc){
- return;
+
+ // Get a default display field if necessary
+ field = column.getEditor(null, { xtype: 'displayfield' });
+ field.margins = '0 0 0 2';
+ field.setWidth(column.getWidth() - 2);
+ me.mon(field, 'change', me.onFieldChange, me);
+
+ // Maintain mapping of fields-to-columns
+ // This will fire events that maintain our container items
+ me.columns.add(field.id, column);
+ },
+
+ loadRecord: function(record) {
+ var me = this,
+ form = me.getForm();
+ form.loadRecord(record);
+ if (form.isValid()) {
+ me.hideToolTip();
+ } else {
+ me.showToolTip();
}
- if(!this.maskRe.test(cc)){
- e.stopEvent();
+
+ // render display fields so they honor the column renderer/template
+ Ext.Array.forEach(me.query('>displayfield'), function(field) {
+ me.renderColumnData(field, record);
+ }, me);
+ },
+
+ renderColumnData: function(field, record) {
+ var me = this,
+ grid = me.editingPlugin.grid,
+ headerCt = grid.headerCt,
+ view = grid.view,
+ store = view.store,
+ column = me.columns.get(field.id),
+ value = field.getRawValue();
+
+ // honor our column's renderer (TemplateHeader sets renderer for us!)
+ if (column.renderer) {
+ var metaData = { tdCls: '', style: '' },
+ rowIdx = store.indexOf(record),
+ colIdx = headerCt.getHeaderIndex(column);
+
+ value = column.renderer.call(
+ column.scope || headerCt.ownerCt,
+ value,
+ metaData,
+ record,
+ rowIdx,
+ colIdx,
+ store,
+ view
+ );
}
+
+ field.setRawValue(value);
+ field.resetOriginalValue();
},
- setValue : function(v){
- if(this.emptyText && this.el && !Ext.isEmpty(v)){
- this.el.removeClass(this.emptyClass);
+ beforeEdit: function() {
+ var me = this;
+
+ if (me.isVisible() && !me.autoCancel && me.isDirty()) {
+ me.showToolTip();
+ return false;
}
- Ext.form.TextField.superclass.setValue.apply(this, arguments);
- this.applyEmptyText();
- this.autoSize();
- return 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.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
+ * Start editing the specified grid at the specified position.
+ * @param {Model} record The Store data record which backs the row to be edited.
+ * @param {Model} columnHeader The Column object defining the column to be edited.
*/
- getErrors: function(value) {
- var errors = Ext.form.TextField.superclass.getErrors.apply(this, arguments);
-
- value = value || this.processValue(this.getRawValue());
-
- if (Ext.isFunction(this.validator)) {
- var msg = this.validator(value);
- if (msg !== true) {
- errors.push(msg);
- }
- }
-
- if (value.length < 1 || value === this.emptyText) {
- if (this.allowBlank) {
- //if value is blank and allowBlank is true, there cannot be any additional errors
- return errors;
- } else {
- errors.push(this.blankText);
- }
- }
-
- if (!this.allowBlank && (value.length < 1 || value === this.emptyText)) { // if it's blank
- errors.push(this.blankText);
- }
-
- if (value.length < this.minLength) {
- errors.push(String.format(this.minLengthText, this.minLength));
- }
-
- if (value.length > this.maxLength) {
- errors.push(String.format(this.maxLengthText, this.maxLength));
+ startEdit: function(record, columnHeader) {
+ var me = this,
+ grid = me.editingPlugin.grid,
+ view = grid.getView(),
+ store = grid.store,
+ context = me.context = Ext.apply(me.editingPlugin.context, {
+ view: grid.getView(),
+ store: store
+ });
+
+ // make sure our row is selected before editing
+ context.grid.getSelectionModel().select(record);
+
+ // Reload the record data
+ me.loadRecord(record);
+
+ if (!me.isVisible()) {
+ me.show();
+ me.focusContextCell();
+ } else {
+ me.reposition({
+ callback: this.focusContextCell
+ });
}
-
- if (this.vtype) {
- var vt = Ext.form.VTypes;
- if(!vt[this.vtype](value, this)){
- errors.push(this.vtypeText || vt[this.vtype +'Text']);
- }
+ },
+
+ // Focus the cell on start edit based upon the current context
+ focusContextCell: function() {
+ var field = this.getEditor(this.context.colIdx);
+ if (field && field.focus) {
+ field.focus();
}
-
- if (this.regex && !this.regex.test(value)) {
- errors.push(this.regexText);
+ },
+
+ cancelEdit: function() {
+ var me = this,
+ form = me.getForm();
+
+ me.hide();
+ form.clearInvalid();
+ form.reset();
+ },
+
+ completeEdit: function() {
+ var me = this,
+ form = me.getForm();
+
+ if (!form.isValid()) {
+ return;
}
-
- return errors;
+
+ form.updateRecord(me.context.record);
+ me.hide();
+ return true;
},
- /**
- * 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)
- */
- selectText : function(start, end){
- var v = this.getRawValue();
- var doFocus = false;
- if(v.length > 0){
- start = start === undefined ? 0 : start;
- end = end === undefined ? v.length : end;
- var d = this.el.dom;
- if(d.setSelectionRange){
- d.setSelectionRange(start, end);
- }else if(d.createTextRange){
- var range = d.createTextRange();
- range.moveStart('character', start);
- range.moveEnd('character', end-v.length);
- range.select();
- }
- doFocus = Ext.isGecko || Ext.isOpera;
- }else{
- doFocus = true;
+ onShow: function() {
+ var me = this;
+ me.callParent(arguments);
+ me.reposition();
+ },
+
+ onHide: function() {
+ var me = this;
+ me.callParent(arguments);
+ me.hideToolTip();
+ me.invalidateScroller();
+ if (me.context) {
+ me.context.view.focus();
+ me.context = null;
}
- if(doFocus){
- this.focus();
+ },
+
+ isDirty: function() {
+ var me = this,
+ form = me.getForm();
+ return form.isDirty();
+ },
+
+ getToolTip: function() {
+ var me = this,
+ tip;
+
+ if (!me.tooltip) {
+ tip = me.tooltip = Ext.createWidget('tooltip', {
+ cls: Ext.baseCSSPrefix + 'grid-row-editor-errors',
+ title: me.errorsText,
+ autoHide: false,
+ closable: true,
+ closeAction: 'disable',
+ anchor: 'left'
+ });
}
+ return me.tooltip;
},
- /**
- * 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.
- */
- autoSize : function(){
- if(!this.grow || !this.rendered){
- return;
+ hideToolTip: function() {
+ var me = this,
+ tip = me.getToolTip();
+ if (tip.rendered) {
+ tip.disable();
}
- if(!this.metrics){
- this.metrics = Ext.util.TextMetrics.createInstance(this.el);
+ me.hiddenTip = false;
+ },
+
+ showToolTip: function() {
+ var me = this,
+ tip = me.getToolTip(),
+ context = me.context,
+ row = Ext.get(context.row),
+ viewEl = context.grid.view.el;
+
+ tip.setTarget(row);
+ tip.showAt([-10000, -10000]);
+ tip.body.update(me.getErrors());
+ tip.mouseOffset = [viewEl.getWidth() - row.getWidth() + me.lastScrollLeft + 15, 0];
+ me.repositionTip();
+ tip.doLayout();
+ tip.enable();
+ },
+
+ repositionTip: function() {
+ var me = this,
+ tip = me.getToolTip(),
+ context = me.context,
+ row = Ext.get(context.row),
+ viewEl = context.grid.view.el,
+ viewHeight = viewEl.getHeight(),
+ viewTop = me.lastScrollTop,
+ viewBottom = viewTop + viewHeight,
+ rowHeight = row.getHeight(),
+ rowTop = row.dom.offsetTop,
+ rowBottom = rowTop + rowHeight;
+
+ if (rowBottom > viewTop && rowTop < viewBottom) {
+ tip.show();
+ me.hiddenTip = false;
+ } else {
+ tip.hide();
+ me.hiddenTip = true;
}
- var el = this.el;
- var v = el.dom.value;
- var d = document.createElement('div');
- d.appendChild(document.createTextNode(v));
- v = d.innerHTML;
- Ext.removeNode(d);
- d = null;
- v += ' ';
- var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
- this.el.setWidth(w);
- this.fireEvent('autosize', this, w);
},
-
- onDestroy: function(){
- if(this.validationTask){
- this.validationTask.cancel();
- this.validationTask = null;
- }
- Ext.form.TextField.superclass.onDestroy.call(this);
- }
-});
-Ext.reg('textfield', Ext.form.TextField);
+
+ getErrors: function() {
+ var me = this,
+ dirtyText = !me.autoCancel && me.isDirty() ? me.dirtyText + '
' : '',
+ errors = [];
+
+ Ext.Array.forEach(me.query('>[isFormField]'), function(field) {
+ errors = errors.concat(
+ Ext.Array.map(field.getErrors(), function(e) {
+ return '- ' + e + '
';
+ })
+ );
+ }, me);
+
+ return dirtyText + '' + errors.join('') + '
';
+ },
+
+ invalidateScroller: function() {
+ var me = this,
+ context = me.context,
+ scroller = context.grid.verticalScroller;
+
+ if (scroller) {
+ scroller.invalidate();
+ }
+ }
+});
/**
- * @class Ext.form.TriggerField
- * @extends Ext.form.TextField
- * 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 TriggerField directly, as it renders exactly like a combobox
- * for which you can provide a custom implementation. For example:
- *
-var trigger = new Ext.form.TriggerField();
-trigger.onTriggerClick = myTriggerFn;
-trigger.applyToMarkup('my-field');
-
+ * @class Ext.grid.header.Container
+ * @extends Ext.container.Container
+ * @private
*
- * However, in general you will most likely want to use TriggerField as the base class for a reusable component.
- * {@link Ext.form.DateField} and {@link Ext.form.ComboBox} are perfect examples of this.
+ * Container which holds headers and is docked at the top or bottom of a TablePanel.
+ * The HeaderContainer drives resizing/moving/hiding of columns within the TableView.
+ * As headers are hidden, moved or resized the headercontainer is responsible for
+ * triggering changes within the view.
*
- * @constructor
- * Create a new TriggerField.
- * @param {Object} config Configuration options (valid {@Ext.form.TextField} config options will also be applied
- * to the base TextField)
- * @xtype trigger
+ * @xtype headercontainer
*/
-Ext.form.TriggerField = Ext.extend(Ext.form.TextField, {
- /**
- * @cfg {String} triggerClass
- * An additional CSS class used to style the trigger button. The trigger will always get the
- * class 'x-form-trigger' by default and triggerClass will be appended if specified.
- */
- /**
- * @cfg {Mixed} triggerConfig
- * A {@link Ext.DomHelper DomHelper} config object specifying the structure of the
- * trigger element for this Field. (Optional).
- * Specify this when you need a customized element to act as the trigger button for a TriggerField.
- * Note that when using this option, it is the developer's responsibility to ensure correct sizing, positioning
- * and appearance of the trigger. Defaults to:
- * {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass}
- */
- /**
- * @cfg {String/Object} autoCreate A {@link Ext.DomHelper DomHelper} element spec, or true for a default
- * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
- * See {@link Ext.Component#autoEl autoEl} for details. Defaults to:
- * {tag: "input", type: "text", size: "16", autocomplete: "off"}
- */
- defaultAutoCreate : {tag: "input", type: "text", size: "16", autocomplete: "off"},
- /**
- * @cfg {Boolean} hideTrigger true to hide the trigger element and display only the base
- * text field (defaults to false)
- */
- hideTrigger:false,
+Ext.define('Ext.grid.header.Container', {
+ extend: 'Ext.container.Container',
+ uses: [
+ 'Ext.grid.ColumnLayout',
+ 'Ext.grid.column.Column',
+ 'Ext.menu.Menu',
+ 'Ext.menu.CheckItem',
+ 'Ext.menu.Separator',
+ 'Ext.grid.plugin.HeaderResizer',
+ 'Ext.grid.plugin.HeaderReorderer'
+ ],
+ border: true,
+
+ alias: 'widget.headercontainer',
+
+ baseCls: Ext.baseCSSPrefix + 'grid-header-ct',
+ dock: 'top',
+
/**
- * @cfg {Boolean} editable false to prevent the user from typing text directly into the field,
- * the field will only respond to a click on the trigger to set the value. (defaults to true).
+ * @cfg {Number} weight
+ * HeaderContainer overrides the default weight of 0 for all docked items to 100.
+ * This is so that it has more priority over things like toolbars.
*/
- editable: true,
+ weight: 100,
+ defaultType: 'gridcolumn',
/**
- * @cfg {Boolean} readOnly true to prevent the user from changing the field, and
- * hides the trigger. Superceeds the editable and hideTrigger options if the value is true.
- * (defaults to false)
+ * @cfg {Number} defaultWidth
+ * Width of the header if no width or flex is specified. Defaults to 100.
*/
- readOnly: false,
+ defaultWidth: 100,
+
+
+ sortAscText: 'Sort Ascending',
+ sortDescText: 'Sort Descending',
+ sortClearText: 'Clear Sort',
+ columnsText: 'Columns',
+
+ lastHeaderCls: Ext.baseCSSPrefix + 'column-header-last',
+ firstHeaderCls: Ext.baseCSSPrefix + 'column-header-first',
+ headerOpenCls: Ext.baseCSSPrefix + 'column-header-open',
+
+ // private; will probably be removed by 4.0
+ triStateSort: false,
+
+ ddLock: false,
+
+ dragging: false,
+
/**
- * @cfg {String} wrapFocusClass The class added to the to the wrap of the trigger element. Defaults to
- * x-trigger-wrap-focus.
+ * true
if this HeaderContainer is in fact a group header which contains sub headers.
+ * @type Boolean
+ * @property isGroupHeader
*/
- wrapFocusClass: 'x-trigger-wrap-focus',
+
/**
- * @hide
- * @method autoSize
+ * @cfg {Boolean} sortable
+ * Provides the default sortable state for all Headers within this HeaderContainer.
+ * Also turns on or off the menus in the HeaderContainer. Note that the menu is
+ * shared across every header and therefore turning it off will remove the menu
+ * items for every header.
*/
- autoSize: Ext.emptyFn,
- // private
- monitorTab : true,
- // private
- deferHeight : true,
- // private
- mimicing : false,
+ sortable: true,
+
+ initComponent: function() {
+ var me = this;
+
+ me.headerCounter = 0;
+ me.plugins = me.plugins || [];
+
+ // TODO: Pass in configurations to turn on/off dynamic
+ // resizing and disable resizing all together
+
+ // Only set up a Resizer and Reorderer for the topmost HeaderContainer.
+ // Nested Group Headers are themselves HeaderContainers
+ if (!me.isHeader) {
+ me.resizer = Ext.create('Ext.grid.plugin.HeaderResizer');
+ me.reorderer = Ext.create('Ext.grid.plugin.HeaderReorderer');
+ if (!me.enableColumnResize) {
+ me.resizer.disable();
+ }
+ if (!me.enableColumnMove) {
+ me.reorderer.disable();
+ }
+ me.plugins.push(me.reorderer, me.resizer);
+ }
+
+ // Base headers do not need a box layout
+ if (me.isHeader && !me.items) {
+ me.layout = 'auto';
+ }
+ // HeaderContainer and Group header needs a gridcolumn layout.
+ else {
+ me.layout = {
+ type: 'gridcolumn',
+ availableSpaceOffset: me.availableSpaceOffset,
+ align: 'stretchmax',
+ resetStretch: true
+ };
+ }
+ me.defaults = me.defaults || {};
+ Ext.applyIf(me.defaults, {
+ width: me.defaultWidth,
+ triStateSort: me.triStateSort,
+ sortable: me.sortable
+ });
+ me.callParent();
+ me.addEvents(
+ /**
+ * @event columnresize
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ * @param {Number} width
+ */
+ 'columnresize',
- actionMode: 'wrap',
+ /**
+ * @event headerclick
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ * @param {Ext.EventObject} e
+ * @param {HTMLElement} t
+ */
+ 'headerclick',
- defaultTriggerWidth: 17,
+ /**
+ * @event headertriggerclick
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ * @param {Ext.EventObject} e
+ * @param {HTMLElement} t
+ */
+ 'headertriggerclick',
- // private
- onResize : function(w, h){
- Ext.form.TriggerField.superclass.onResize.call(this, w, h);
- var tw = this.getTriggerWidth();
- if(Ext.isNumber(w)){
- this.el.setWidth(w - tw);
- }
- this.wrap.setWidth(this.el.getWidth() + tw);
+ /**
+ * @event columnmove
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ * @param {Number} fromIdx
+ * @param {Number} toIdx
+ */
+ 'columnmove',
+ /**
+ * @event columnhide
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ */
+ 'columnhide',
+ /**
+ * @event columnshow
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ */
+ 'columnshow',
+ /**
+ * @event sortchange
+ * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
+ * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
+ * @param {String} direction
+ */
+ 'sortchange',
+ /**
+ * @event menucreate
+ * Fired immediately after the column header menu is created.
+ * @param {Ext.grid.header.Container} ct This instance
+ * @param {Ext.menu.Menu} menu The Menu that was created
+ */
+ 'menucreate'
+ );
},
- getTriggerWidth: function(){
- var tw = this.trigger.getWidth();
- if(!this.hideTrigger && !this.readOnly && tw === 0){
- tw = this.defaultTriggerWidth;
- }
- return tw;
+ onDestroy: function() {
+ Ext.destroy(this.resizer, this.reorderer);
+ this.callParent();
},
- // private
- alignErrorIcon : function(){
- if(this.wrap){
- this.errorIcon.alignTo(this.wrap, 'tl-tr', [2, 0]);
+ // Invalidate column cache on add
+ // We cannot refresh the View on every add because this method is called
+ // when the HeaderDropZone moves Headers around, that will also refresh the view
+ onAdd: function(c) {
+ var me = this;
+ if (!c.headerId) {
+ c.headerId = 'h' + (++me.headerCounter);
}
+ me.callParent(arguments);
+ me.purgeCache();
},
- // private
- onRender : function(ct, position){
- this.doc = Ext.isIE ? Ext.getBody() : Ext.getDoc();
- Ext.form.TriggerField.superclass.onRender.call(this, ct, position);
+ // Invalidate column cache on remove
+ // We cannot refresh the View on every remove because this method is called
+ // when the HeaderDropZone moves Headers around, that will also refresh the view
+ onRemove: function(c) {
+ var me = this;
+ me.callParent(arguments);
+ me.purgeCache();
+ },
- this.wrap = this.el.wrap({cls: 'x-form-field-wrap x-form-field-trigger-wrap'});
- this.trigger = this.wrap.createChild(this.triggerConfig ||
- {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass});
- this.initTrigger();
- if(!this.width){
- this.wrap.setWidth(this.el.getWidth()+this.trigger.getWidth());
+ afterRender: function() {
+ this.callParent();
+ var store = this.up('[store]').store,
+ sorters = store.sorters,
+ first = sorters.first(),
+ hd;
+
+ if (first) {
+ hd = this.down('gridcolumn[dataIndex=' + first.property +']');
+ if (hd) {
+ hd.setSortState(first.direction, false, true);
+ }
}
- this.resizeEl = this.positionEl = this.wrap;
},
- getWidth: function() {
- return(this.el.getWidth() + this.trigger.getWidth());
+ afterLayout: function() {
+ if (!this.isHeader) {
+ var me = this,
+ topHeaders = me.query('>gridcolumn:not([hidden])'),
+ viewEl;
+
+ me.callParent(arguments);
+
+ if (topHeaders.length) {
+ topHeaders[0].el.radioCls(me.firstHeaderCls);
+ topHeaders[topHeaders.length - 1].el.radioCls(me.lastHeaderCls);
+ }
+ }
},
- updateEditState: function(){
- if(this.rendered){
- if (this.readOnly) {
- this.el.dom.readOnly = true;
- this.el.addClass('x-trigger-noedit');
- this.mun(this.el, 'click', this.onTriggerClick, this);
- this.trigger.setDisplayed(false);
- } else {
- if (!this.editable) {
- this.el.dom.readOnly = true;
- this.el.addClass('x-trigger-noedit');
- this.mon(this.el, 'click', this.onTriggerClick, this);
+ onHeaderShow: function(header) {
+ // Pass up to the GridSection
+ var me = this,
+ gridSection = me.ownerCt,
+ menu = me.getMenu(),
+ topItems, topItemsVisible,
+ colCheckItem,
+ itemToEnable,
+ len, i;
+
+ if (menu) {
+
+ colCheckItem = menu.down('menucheckitem[headerId=' + header.id + ']');
+ if (colCheckItem) {
+ colCheckItem.setChecked(true, true);
+ }
+
+ // There's more than one header visible, and we've disabled some checked items... re-enable them
+ topItems = menu.query('#columnItem>menucheckitem[checked]');
+ topItemsVisible = topItems.length;
+ if ((me.getVisibleGridColumns().length > 1) && me.disabledMenuItems && me.disabledMenuItems.length) {
+ if (topItemsVisible == 1) {
+ Ext.Array.remove(me.disabledMenuItems, topItems[0]);
+ }
+ for (i = 0, len = me.disabledMenuItems.length; i < len; i++) {
+ itemToEnable = me.disabledMenuItems[i];
+ if (!itemToEnable.isDestroyed) {
+ itemToEnable[itemToEnable.menu ? 'enableCheckChange' : 'enable']();
+ }
+ }
+ if (topItemsVisible == 1) {
+ me.disabledMenuItems = topItems;
} else {
- this.el.dom.readOnly = false;
- this.el.removeClass('x-trigger-noedit');
- this.mun(this.el, 'click', this.onTriggerClick, this);
+ me.disabledMenuItems = [];
}
- this.trigger.setDisplayed(!this.hideTrigger);
}
- this.onResize(this.width || this.wrap.getWidth());
}
+
+ // Only update the grid UI when we are notified about base level Header shows;
+ // Group header shows just cause a layout of the HeaderContainer
+ if (!header.isGroupHeader) {
+ if (me.view) {
+ me.view.onHeaderShow(me, header, true);
+ }
+ if (gridSection) {
+ gridSection.onHeaderShow(me, header);
+ }
+ }
+ me.fireEvent('columnshow', me, header);
+
+ // The header's own hide suppresses cascading layouts, so lay the headers out now
+ me.doLayout();
},
- setHideTrigger: function(hideTrigger){
- if(hideTrigger != this.hideTrigger){
- this.hideTrigger = hideTrigger;
- this.updateEditState();
+ onHeaderHide: function(header, suppressLayout) {
+ // Pass up to the GridSection
+ var me = this,
+ gridSection = me.ownerCt,
+ menu = me.getMenu(),
+ colCheckItem;
+
+ if (menu) {
+
+ // If the header was hidden programmatically, sync the Menu state
+ colCheckItem = menu.down('menucheckitem[headerId=' + header.id + ']');
+ if (colCheckItem) {
+ colCheckItem.setChecked(false, true);
+ }
+ me.setDisabledItems();
+ }
+
+ // Only update the UI when we are notified about base level Header hides;
+ if (!header.isGroupHeader) {
+ if (me.view) {
+ me.view.onHeaderHide(me, header, true);
+ }
+ if (gridSection) {
+ gridSection.onHeaderHide(me, header);
+ }
+
+ // The header's own hide suppresses cascading layouts, so lay the headers out now
+ if (!suppressLayout) {
+ me.doLayout();
+ }
}
+ me.fireEvent('columnhide', me, header);
},
- /**
- * @param {Boolean} value 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();
+ setDisabledItems: function(){
+ var me = this,
+ menu = me.getMenu(),
+ i = 0,
+ len,
+ itemsToDisable,
+ itemToDisable;
+
+ // Find what to disable. If only one top level item remaining checked, we have to disable stuff.
+ itemsToDisable = menu.query('#columnItem>menucheckitem[checked]');
+ if ((itemsToDisable.length === 1)) {
+ if (!me.disabledMenuItems) {
+ me.disabledMenuItems = [];
+ }
+
+ // If down to only one column visible, also disable any descendant checkitems
+ if ((me.getVisibleGridColumns().length === 1) && itemsToDisable[0].menu) {
+ itemsToDisable = itemsToDisable.concat(itemsToDisable[0].menu.query('menucheckitem[checked]'));
+ }
+
+ len = itemsToDisable.length;
+ // Disable any further unchecking at any level.
+ for (i = 0; i < len; i++) {
+ itemToDisable = itemsToDisable[i];
+ if (!Ext.Array.contains(me.disabledMenuItems, itemToDisable)) {
+ itemToDisable[itemToDisable.menu ? 'disableCheckChange' : 'disable']();
+ me.disabledMenuItems.push(itemToDisable);
+ }
+ }
}
},
/**
- * @param {Boolean} value 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.
+ * Temporarily lock the headerCt. This makes it so that clicking on headers
+ * don't trigger actions like sorting or opening of the header menu. This is
+ * done because extraneous events may be fired on the headers after interacting
+ * with a drag drop operation.
+ * @private
*/
- setReadOnly: function(readOnly){
- if(readOnly != this.readOnly){
- this.readOnly = readOnly;
- this.updateEditState();
- }
+ tempLock: function() {
+ this.ddLock = true;
+ Ext.Function.defer(function() {
+ this.ddLock = false;
+ }, 200, this);
},
- afterRender : function(){
- Ext.form.TriggerField.superclass.afterRender.call(this);
- this.updateEditState();
+ onHeaderResize: function(header, w, suppressFocus) {
+ this.tempLock();
+ if (this.view && this.view.rendered) {
+ this.view.onHeaderResize(header, w, suppressFocus);
+ }
+ this.fireEvent('columnresize', this, header, w);
},
- // private
- initTrigger : function(){
- this.mon(this.trigger, 'click', this.onTriggerClick, this, {preventDefault:true});
- this.trigger.addClassOnOver('x-form-trigger-over');
- this.trigger.addClassOnClick('x-form-trigger-click');
+ onHeaderClick: function(header, e, t) {
+ this.fireEvent("headerclick", this, header, e, t);
},
- // private
- onDestroy : function(){
- Ext.destroy(this.trigger, this.wrap);
- if (this.mimicing){
- this.doc.un('mousedown', this.mimicBlur, this);
+ onHeaderTriggerClick: function(header, e, t) {
+ // generate and cache menu, provide ability to cancel/etc
+ if (this.fireEvent("headertriggerclick", this, header, e, t) !== false) {
+ this.showMenuBy(t, header);
}
- delete this.doc;
- Ext.form.TriggerField.superclass.onDestroy.call(this);
},
- // private
- onFocus : function(){
- Ext.form.TriggerField.superclass.onFocus.call(this);
- if(!this.mimicing){
- this.wrap.addClass(this.wrapFocusClass);
- this.mimicing = true;
- this.doc.on('mousedown', this.mimicBlur, this, {delay: 10});
- if(this.monitorTab){
- this.on('specialkey', this.checkTab, this);
- }
+ showMenuBy: function(t, header) {
+ var menu = this.getMenu(),
+ ascItem = menu.down('#ascItem'),
+ descItem = menu.down('#descItem'),
+ sortableMth;
+
+ menu.activeHeader = menu.ownerCt = header;
+ menu.setFloatParent(header);
+ // TODO: remove coupling to Header's titleContainer el
+ header.titleContainer.addCls(this.headerOpenCls);
+
+ // enable or disable asc & desc menu items based on header being sortable
+ sortableMth = header.sortable ? 'enable' : 'disable';
+ if (ascItem) {
+ ascItem[sortableMth]();
}
+ if (descItem) {
+ descItem[sortableMth]();
+ }
+ menu.showBy(t);
},
- // private
- checkTab : function(me, e){
- if(e.getKey() == e.TAB){
- this.triggerBlur();
- }
+ // remove the trigger open class when the menu is hidden
+ onMenuDeactivate: function() {
+ var menu = this.getMenu();
+ // TODO: remove coupling to Header's titleContainer el
+ menu.activeHeader.titleContainer.removeCls(this.headerOpenCls);
},
- // private
- onBlur : Ext.emptyFn,
+ moveHeader: function(fromIdx, toIdx) {
- // private
- mimicBlur : function(e){
- if(!this.isDestroyed && !this.wrap.contains(e.target) && this.validateBlur(e)){
- this.triggerBlur();
- }
+ // An automatically expiring lock
+ this.tempLock();
+ this.onHeaderMoved(this.move(fromIdx, toIdx), fromIdx, toIdx);
},
- // private
- triggerBlur : function(){
- this.mimicing = false;
- this.doc.un('mousedown', this.mimicBlur, this);
- if(this.monitorTab && this.el){
- this.un('specialkey', this.checkTab, this);
- }
- Ext.form.TriggerField.superclass.onBlur.call(this);
- if(this.wrap){
- this.wrap.removeClass(this.wrapFocusClass);
+ purgeCache: function() {
+ var me = this;
+ // Delete column cache - column order has changed.
+ delete me.gridDataColumns;
+
+ // Menu changes when columns are moved. It will be recreated.
+ if (me.menu) {
+ me.menu.destroy();
+ delete me.menu;
}
},
- beforeBlur : Ext.emptyFn,
+ onHeaderMoved: function(header, fromIdx, toIdx) {
+ var me = this,
+ gridSection = me.ownerCt;
- // private
- // This should be overriden by any subclass that needs to check whether or not the field can be blurred.
- validateBlur : function(e){
- return true;
+ if (gridSection) {
+ gridSection.onHeaderMove(me, header, fromIdx, toIdx);
+ }
+ me.fireEvent("columnmove", me, header, fromIdx, toIdx);
},
/**
- * 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.ComboBox and Ext.form.DateField for
- * sample implementations.
- * @method
- * @param {EventObject} e
+ * Gets the menu (and will create it if it doesn't already exist)
+ * @private
*/
- onTriggerClick : Ext.emptyFn
+ getMenu: function() {
+ var me = this;
- /**
- * @cfg {Boolean} grow @hide
- */
- /**
- * @cfg {Number} growMin @hide
- */
- /**
- * @cfg {Number} growMax @hide
- */
-});
+ if (!me.menu) {
+ me.menu = Ext.create('Ext.menu.Menu', {
+ items: me.getMenuItems(),
+ listeners: {
+ deactivate: me.onMenuDeactivate,
+ scope: me
+ }
+ });
+ me.setDisabledItems();
+ me.fireEvent('menucreate', me, me.menu);
+ }
+ return me.menu;
+ },
-/**
- * @class Ext.form.TwinTriggerField
- * @extends Ext.form.TriggerField
- * TwinTriggerField is not a public class to be used directly. It is meant as an abstract base class
- * to be extended by an implementing class. For an example of implementing this class, see the custom
- * SearchField implementation here:
- * http://extjs.com/deploy/ext/examples/form/custom.html
- */
-Ext.form.TwinTriggerField = Ext.extend(Ext.form.TriggerField, {
- /**
- * @cfg {Mixed} triggerConfig
- * A {@link Ext.DomHelper DomHelper} config object specifying the structure of the trigger elements
- * for this Field. (Optional).
- * Specify this when you need a customized element to contain the two trigger elements for this Field.
- * Each trigger element must be marked by the CSS class x-form-trigger (also see
- * {@link #trigger1Class} and {@link #trigger2Class}).
- * Note that when using this option, it is the developer's responsibility to ensure correct sizing,
- * positioning and appearance of the triggers.
- */
- /**
- * @cfg {String} trigger1Class
- * An additional CSS class used to style the trigger button. The trigger will always get the
- * class 'x-form-trigger' by default and triggerClass will be appended if specified.
- */
/**
- * @cfg {String} trigger2Class
- * An additional CSS class used to style the trigger button. The trigger will always get the
- * class 'x-form-trigger' by default and triggerClass will be appended if specified.
+ * Returns an array of menu items to be placed into the shared menu
+ * across all headers in this header container.
+ * @returns {Array} menuItems
*/
-
- initComponent : function(){
- Ext.form.TwinTriggerField.superclass.initComponent.call(this);
-
- this.triggerConfig = {
- tag:'span', cls:'x-form-twin-triggers', cn:[
- {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger1Class},
- {tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger2Class}
- ]};
- },
-
- getTrigger : function(index){
- return this.triggers[index];
+ getMenuItems: function() {
+ var me = this,
+ menuItems = [{
+ itemId: 'columnItem',
+ text: me.columnsText,
+ cls: Ext.baseCSSPrefix + 'cols-icon',
+ menu: me.getColumnMenu(me)
+ }];
+
+ if (me.sortable) {
+ menuItems.unshift({
+ itemId: 'ascItem',
+ text: me.sortAscText,
+ cls: 'xg-hmenu-sort-asc',
+ handler: me.onSortAscClick,
+ scope: me
+ },{
+ itemId: 'descItem',
+ text: me.sortDescText,
+ cls: 'xg-hmenu-sort-desc',
+ handler: me.onSortDescClick,
+ scope: me
+ },'-');
+ }
+ return menuItems;
},
-
- afterRender: function(){
- Ext.form.TwinTriggerField.superclass.afterRender.call(this);
- var triggers = this.triggers,
- i = 0,
- len = triggers.length;
-
- for(; i < len; ++i){
- if(this['hideTrigger' + (i + 1)]){
- triggers[i].hide();
- }
- }
- },
+ // sort asc when clicking on item in menu
+ onSortAscClick: function() {
+ var menu = this.getMenu(),
+ activeHeader = menu.activeHeader;
- initTrigger : function(){
- var ts = this.trigger.select('.x-form-trigger', true),
- triggerField = this;
-
- ts.each(function(t, all, index){
- var triggerIndex = 'Trigger'+(index+1);
- t.hide = function(){
- var w = triggerField.wrap.getWidth();
- this.dom.style.display = 'none';
- triggerField.el.setWidth(w-triggerField.trigger.getWidth());
- this['hidden' + triggerIndex] = true;
- };
- t.show = function(){
- var w = triggerField.wrap.getWidth();
- this.dom.style.display = '';
- triggerField.el.setWidth(w-triggerField.trigger.getWidth());
- this['hidden' + triggerIndex] = false;
- };
- this.mon(t, 'click', this['on'+triggerIndex+'Click'], this, {preventDefault:true});
- t.addClassOnOver('x-form-trigger-over');
- t.addClassOnClick('x-form-trigger-click');
- }, this);
- this.triggers = ts.elements;
+ activeHeader.setSortState('ASC');
},
- getTriggerWidth: function(){
- var tw = 0;
- Ext.each(this.triggers, function(t, index){
- var triggerIndex = 'Trigger' + (index + 1),
- w = t.getWidth();
- if(w === 0 && !this['hidden' + triggerIndex]){
- tw += this.defaultTriggerWidth;
- }else{
- tw += w;
- }
- }, this);
- return tw;
- },
+ // sort desc when clicking on item in menu
+ onSortDescClick: function() {
+ var menu = this.getMenu(),
+ activeHeader = menu.activeHeader;
- // private
- onDestroy : function() {
- Ext.destroy(this.triggers);
- Ext.form.TwinTriggerField.superclass.onDestroy.call(this);
+ activeHeader.setSortState('DESC');
},
/**
- * The function that should handle the trigger's click event. This method does nothing by default
- * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
- * for additional information.
- * @method
- * @param {EventObject} e
- */
- onTrigger1Click : Ext.emptyFn,
- /**
- * The function that should handle the trigger's click event. This method does nothing by default
- * until overridden by an implementing function. See {@link Ext.form.TriggerField#onTriggerClick}
- * for additional information.
- * @method
- * @param {EventObject} e
- */
- onTrigger2Click : Ext.emptyFn
-});
-Ext.reg('trigger', Ext.form.TriggerField);
-/**
- * @class Ext.form.TextArea
- * @extends Ext.form.TextField
- * Multiline text field. Can be used as a direct replacement for traditional textarea fields, plus adds
- * support for auto-sizing.
- * @constructor
- * Creates a new TextArea
- * @param {Object} config Configuration options
- * @xtype textarea
- */
-Ext.form.TextArea = Ext.extend(Ext.form.TextField, {
- /**
- * @cfg {Number} growMin The minimum height to allow when {@link Ext.form.TextField#grow grow}=true
- * (defaults to 60)
+ * Returns an array of menu CheckItems corresponding to all immediate children of the passed Container which have been configured as hideable.
*/
- growMin : 60,
+ getColumnMenu: function(headerContainer) {
+ var menuItems = [],
+ i = 0,
+ item,
+ items = headerContainer.query('>gridcolumn[hideable]'),
+ itemsLn = items.length,
+ menuItem;
+
+ for (; i < itemsLn; i++) {
+ item = items[i];
+ menuItem = Ext.create('Ext.menu.CheckItem', {
+ text: item.text,
+ checked: !item.hidden,
+ hideOnClick: false,
+ headerId: item.id,
+ menu: item.isGroupHeader ? this.getColumnMenu(item) : undefined,
+ checkHandler: this.onColumnCheckChange,
+ scope: this
+ });
+ if (itemsLn === 1) {
+ menuItem.disabled = true;
+ }
+ menuItems.push(menuItem);
+
+ // If the header is ever destroyed - for instance by dragging out the last remaining sub header,
+ // then the associated menu item must also be destroyed.
+ item.on({
+ destroy: Ext.Function.bind(menuItem.destroy, menuItem)
+ });
+ }
+ return menuItems;
+ },
+
+ onColumnCheckChange: function(checkItem, checked) {
+ var header = Ext.getCmp(checkItem.headerId);
+ header[checked ? 'show' : 'hide']();
+ },
+
/**
- * @cfg {Number} growMax The maximum height to allow when {@link Ext.form.TextField#grow grow}=true
- * (defaults to 1000)
+ * Get the columns used for generating a template via TableChunker.
+ * Returns an array of all columns and their
+ * - dataIndex
+ * - align
+ * - width
+ * - id
+ * - columnId - used to create an identifying CSS class
+ * - cls The tdCls configuration from the Column object
+ * @private
*/
- growMax: 1000,
- growAppend : ' \n ',
-
- enterIsSpecial : false,
+ getColumnsForTpl: function(flushCache) {
+ var cols = [],
+ headers = this.getGridColumns(flushCache),
+ headersLn = headers.length,
+ i = 0,
+ header;
+
+ for (; i < headersLn; i++) {
+ header = headers[i];
+ cols.push({
+ dataIndex: header.dataIndex,
+ align: header.align,
+ width: header.hidden ? 0 : header.getDesiredWidth(),
+ id: header.id,
+ cls: header.tdCls,
+ columnId: header.getItemId()
+ });
+ }
+ return cols;
+ },
/**
- * @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.
+ * Returns the number of grid columns descended from this HeaderContainer.
+ * Group Columns are HeaderContainers. All grid columns are returned, including hidden ones.
*/
- preventScrollbars: false,
+ getColumnCount: function() {
+ return this.getGridColumns().length;
+ },
+
/**
- * @cfg {String/Object} autoCreate A {@link Ext.DomHelper DomHelper} element spec, or true for a default
- * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
- * See {@link Ext.Component#autoEl autoEl} for details. Defaults to:
- * {tag: "textarea", style: "width:100px;height:60px;", autocomplete: "off"}
+ * Gets the full width of all columns that are visible.
*/
+ getFullWidth: function(flushCache) {
+ var fullWidth = 0,
+ headers = this.getVisibleGridColumns(flushCache),
+ headersLn = headers.length,
+ i = 0;
- // private
- onRender : function(ct, position){
- if(!this.el){
- this.defaultAutoCreate = {
- tag: "textarea",
- style:"width:100px;height:60px;",
- autocomplete: "off"
- };
+ for (; i < headersLn; i++) {
+ if (!isNaN(headers[i].width)) {
+ // use headers getDesiredWidth if its there
+ if (headers[i].getDesiredWidth) {
+ fullWidth += headers[i].getDesiredWidth();
+ // if injected a diff cmp use getWidth
+ } else {
+ fullWidth += headers[i].getWidth();
+ }
+ }
}
- Ext.form.TextArea.superclass.onRender.call(this, ct, position);
- if(this.grow){
- this.textSizeEl = Ext.DomHelper.append(document.body, {
- tag: "pre", cls: "x-form-grow-sizer"
- });
- if(this.preventScrollbars){
- this.el.setStyle("overflow", "hidden");
+ return fullWidth;
+ },
+
+ // invoked internally by a header when not using triStateSorting
+ clearOtherSortStates: function(activeHeader) {
+ var headers = this.getGridColumns(),
+ headersLn = headers.length,
+ i = 0,
+ oldSortState;
+
+ for (; i < headersLn; i++) {
+ if (headers[i] !== activeHeader) {
+ oldSortState = headers[i].sortState;
+ // unset the sortstate and dont recurse
+ headers[i].setSortState(null, true);
+ //if (!silent && oldSortState !== null) {
+ // this.fireEvent('sortchange', this, headers[i], null);
+ //}
}
- this.el.setHeight(this.growMin);
}
},
- onDestroy : function(){
- Ext.removeNode(this.textSizeEl);
- Ext.form.TextArea.superclass.onDestroy.call(this);
+ /**
+ * Returns an array of the visible columns in the grid. This goes down to the lowest column header
+ * level, and does not return grouped headers which contain sub headers.
+ * @param {Boolean} refreshCache If omitted, the cached set of columns will be returned. Pass true to refresh the cache.
+ * @returns {Array}
+ */
+ getVisibleGridColumns: function(refreshCache) {
+ return Ext.ComponentQuery.query(':not([hidden])', this.getGridColumns(refreshCache));
},
- fireKey : function(e){
- if(e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() != e.ENTER || e.hasModifier()))){
- this.fireEvent("specialkey", this, e);
+ /**
+ * Returns an array of all columns which map to Store fields. This goes down to the lowest column header
+ * level, and does not return grouped headers which contain sub headers.
+ * @param {Boolean} refreshCache If omitted, the cached set of columns will be returned. Pass true to refresh the cache.
+ * @returns {Array}
+ */
+ getGridColumns: function(refreshCache) {
+ var me = this,
+ result = refreshCache ? null : me.gridDataColumns;
+
+ // Not already got the column cache, so collect the base columns
+ if (!result) {
+ me.gridDataColumns = result = [];
+ me.cascade(function(c) {
+ if ((c !== me) && !c.isGroupHeader) {
+ result.push(c);
+ }
+ });
}
+
+ return result;
},
-
- // private
- doAutoSize : function(e){
- return !e.isNavKeyPress() || e.getKey() == e.ENTER;
+
+ /**
+ * Get the index of a leaf level header regardless of what the nesting
+ * structure is.
+ */
+ getHeaderIndex: function(header) {
+ var columns = this.getGridColumns();
+ return Ext.Array.indexOf(columns, header);
},
/**
- * Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.
- * This only takes effect if grow = true, and fires the {@link #autosize} event if the height changes.
+ * Get a leaf level header by index regardless of what the nesting
+ * structure is.
*/
- autoSize: function(){
- if(!this.grow || !this.textSizeEl){
- return;
- }
- var el = this.el,
- v = Ext.util.Format.htmlEncode(el.dom.value),
- ts = this.textSizeEl,
- h;
-
- Ext.fly(ts).setWidth(this.el.getWidth());
- if(v.length < 1){
- v = " ";
- }else{
- v += this.growAppend;
- if(Ext.isIE){
- v = v.replace(/\n/g, '
');
+ getHeaderAtIndex: function(index) {
+ var columns = this.getGridColumns();
+ return columns[index];
+ },
+
+ /**
+ * Maps the record data to base it on the header id's.
+ * This correlates to the markup/template generated by
+ * TableChunker.
+ */
+ prepareData: function(data, rowIdx, record, view) {
+ var obj = {},
+ headers = this.getGridColumns(),
+ headersLn = headers.length,
+ colIdx = 0,
+ header, value,
+ metaData,
+ g = this.up('tablepanel'),
+ store = g.store;
+
+ for (; colIdx < headersLn; colIdx++) {
+ metaData = {
+ tdCls: '',
+ style: ''
+ };
+ header = headers[colIdx];
+ value = data[header.dataIndex];
+
+ // When specifying a renderer as a string, it always resolves
+ // to Ext.util.Format
+ if (Ext.isString(header.renderer)) {
+ header.renderer = Ext.util.Format[header.renderer];
+ }
+
+ if (Ext.isFunction(header.renderer)) {
+ value = header.renderer.call(
+ header.scope || this.ownerCt,
+ value,
+ // metadata per cell passing an obj by reference so that
+ // it can be manipulated inside the renderer
+ metaData,
+ record,
+ rowIdx,
+ colIdx,
+ store,
+ view
+ );
+ }
+
+ if (metaData.css) {
+ // This warning attribute is used by the compat layer
+ obj.cssWarning = true;
+ metaData.tdCls = metaData.css;
+ delete metaData.css;
}
+ obj[header.id+'-modified'] = record.isModified(header.dataIndex) ? Ext.baseCSSPrefix + 'grid-dirty-cell' : Ext.baseCSSPrefix + 'grid-clean-cell';
+ obj[header.id+'-tdCls'] = metaData.tdCls;
+ obj[header.id+'-tdAttr'] = metaData.tdAttr;
+ obj[header.id+'-style'] = metaData.style;
+ if (value === undefined || value === null || value === '') {
+ value = ' ';
+ }
+ obj[header.id] = value;
}
- ts.innerHTML = v;
- h = Math.min(this.growMax, Math.max(ts.offsetHeight, this.growMin));
- if(h != this.lastHeight){
- this.lastHeight = h;
- this.el.setHeight(h);
- this.fireEvent("autosize", this, h);
+ return obj;
+ },
+
+ expandToFit: function(header) {
+ if (this.view) {
+ this.view.expandToFit(header);
}
}
});
-Ext.reg('textarea', Ext.form.TextArea);/**
- * @class Ext.form.NumberField
- * @extends Ext.form.TextField
- * Numeric text field that provides automatic keystroke filtering and numeric validation.
- * @constructor
- * Creates a new NumberField
- * @param {Object} config Configuration options
- * @xtype numberfield
+
+/**
+ * @class Ext.grid.column.Column
+ * @extends Ext.grid.header.Container
+ *
+ * This class specifies the definition for a column inside a {@link Ext.grid.Panel}. It encompasses
+ * both the grid header configuration as well as displaying data within the grid itself. If the
+ * {@link #columns} configuration is specified, this column will become a column group and can
+ * container other columns inside. In general, this class will not be created directly, rather
+ * an array of column configurations will be passed to the grid:
+ *
+ * {@img Ext.grid.column.Column/Ext.grid.column.Column.png Ext.grid.column.Column grid column}
+ *
+ * ## Code
+ * Ext.create('Ext.data.Store', {
+ * storeId:'employeeStore',
+ * fields:['firstname', 'lastname', 'senority', 'dep', 'hired'],
+ * data:[
+ * {firstname:"Michael", lastname:"Scott", senority:7, dep:"Manangement", hired:"01/10/2004"},
+ * {firstname:"Dwight", lastname:"Schrute", senority:2, dep:"Sales", hired:"04/01/2004"},
+ * {firstname:"Jim", lastname:"Halpert", senority:3, dep:"Sales", hired:"02/22/2006"},
+ * {firstname:"Kevin", lastname:"Malone", senority:4, dep:"Accounting", hired:"06/10/2007"},
+ * {firstname:"Angela", lastname:"Martin", senority:5, dep:"Accounting", hired:"10/21/2008"}
+ * ]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Column Demo',
+ * store: Ext.data.StoreManager.lookup('employeeStore'),
+ * columns: [
+ * {text: 'First Name', dataIndex:'firstname'},
+ * {text: 'Last Name', dataIndex:'lastname'},
+ * {text: 'Hired Month', dataIndex:'hired', xtype:'datecolumn', format:'M'},
+ * {text: 'Deparment (Yrs)', xtype:'templatecolumn', tpl:'{dep} ({senority})'}
+ * ],
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * ## Convenience Subclasses
+ * There are several column subclasses that provide default rendering for various data types
+ *
+ * - {@link Ext.grid.column.Action}: Renders icons that can respond to click events inline
+ * - {@link Ext.grid.column.Boolean}: Renders for boolean values
+ * - {@link Ext.grid.column.Date}: Renders for date values
+ * - {@link Ext.grid.column.Number}: Renders for numeric values
+ * - {@link Ext.grid.column.Template}: Renders a value using an {@link Ext.XTemplate} using the record data
+ *
+ * ## Setting Sizes
+ * The columns are laid out by a {@link Ext.layout.container.HBox} layout, so a column can either
+ * be given an explicit width value or a flex configuration. If no width is specified the grid will
+ * automatically the size the column to 100px. For column groups, the size is calculated by measuring
+ * the width of the child columns, so a width option should not be specified in that case.
+ *
+ * ## Header Options
+ * - {@link #text}: Sets the header text for the column
+ * - {@link #sortable}: Specifies whether the column can be sorted by clicking the header or using the column menu
+ * - {@link #hideable}: Specifies whether the column can be hidden using the column menu
+ * - {@link #menuDisabled}: Disables the column header menu
+ * - {@link #draggable}: Specifies whether the column header can be reordered by dragging
+ * - {@link #groupable}: Specifies whether the grid can be grouped by the column dataIndex. See also {@link Ext.grid.feature.Grouping}
+ *
+ * ## Data Options
+ * - {@link #dataIndex}: The dataIndex is the field in the underlying {@link Ext.data.Store} to use as the value for the column.
+ * - {@link #renderer}: Allows the underlying store value to be transformed before being displayed in the grid
+ *
+ * @xtype gridcolumn
*/
-Ext.form.NumberField = Ext.extend(Ext.form.TextField, {
+Ext.define('Ext.grid.column.Column', {
+ extend: 'Ext.grid.header.Container',
+ alias: 'widget.gridcolumn',
+ requires: ['Ext.util.KeyNav'],
+ alternateClassName: 'Ext.grid.Column',
+
+ baseCls: Ext.baseCSSPrefix + 'column-header ' + Ext.baseCSSPrefix + 'unselectable',
+
+ // Not the standard, automatically applied overCls because we must filter out overs of child headers.
+ hoverCls: Ext.baseCSSPrefix + 'column-header-over',
+
+ handleWidth: 5,
+
+ sortState: null,
+
+ possibleSortStates: ['ASC', 'DESC'],
+
+ renderTpl:
+ '' +
+ '' +
+ '{text}' +
+ '' +
+ ' ' +
+ '',
+
/**
- * @cfg {RegExp} stripCharsRe @hide
+ * @cfg {Array} columns
+ * An optional array of sub-column definitions. This column becomes a group, and houses the columns defined in the columns
config.
+ * Group columns may not be sortable. But they may be hideable and moveable. And you may move headers into and out of a group. Note that
+ * if all sub columns are dragged out of a group, the group is destroyed.
*/
+
/**
- * @cfg {RegExp} maskRe @hide
+ * @cfg {String} dataIndex
Required. The name of the field in the
+ * grid's {@link Ext.data.Store}'s {@link Ext.data.Model} definition from
+ * which to draw the column's value.
*/
+ dataIndex: null,
+
/**
- * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-field x-form-num-field")
+ * @cfg {String} text Optional. The header text to be used as innerHTML
+ * (html tags are accepted) to display in the Grid. Note: to
+ * have a clickable header with no text displayed you can use the
+ * default of ' '.
*/
- fieldClass: "x-form-field x-form-num-field",
+ text: ' ',
+
/**
- * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true)
+ * @cfg {Boolean} sortable Optional. true if sorting is to be allowed on this column.
+ * Whether local/remote sorting is used is specified in {@link Ext.data.Store#remoteSort}
.
*/
- allowDecimals : true,
+ sortable: true,
+
/**
- * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.')
+ * @cfg {Boolean} groupable Optional. If the grid uses a {@link Ext.grid.feature.Grouping}, this option
+ * may be used to disable the header menu item to group by the column selected. By default,
+ * the header menu group option is enabled. Set to false to disable (but still show) the
+ * group option in the header menu for the column.
*/
- decimalSeparator : ".",
+
/**
- * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2)
+ * @cfg {Boolean} hideable Optional. Specify as false to prevent the user from hiding this column
+ * (defaults to true).
*/
- decimalPrecision : 2,
+ hideable: true,
+
/**
- * @cfg {Boolean} allowNegative False to prevent entering a negative sign (defaults to true)
+ * @cfg {Boolean} menuDisabled
+ * True to disabled the column header menu containing sort/hide options. Defaults to false.
*/
- allowNegative : true,
+ menuDisabled: false,
+
/**
- * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)
+ * @cfg {Function} renderer
+ * A renderer is an 'interceptor' method which can be used transform data (value, appearance, etc.) before it
+ * is rendered. Example:
+ * {
+ renderer: function(value){
+ if (value === 1) {
+ return '1 person';
+ }
+ return value + ' people';
+ }
+}
+ *
+ * @param {Mixed} value The data value for the current cell
+ * @param {Object} metaData A collection of metadata about the current cell; can be used or modified by
+ * the renderer. Recognized properties are: tdCls, tdAttr, and style.
+ * @param {Ext.data.Model} record The record for the current row
+ * @param {Number} rowIndex The index of the current row
+ * @param {Number} colIndex The index of the current column
+ * @param {Ext.data.Store} store The data store
+ * @param {Ext.view.View} view The current view
+ * @return {String} The HTML to be rendered
*/
- minValue : Number.NEGATIVE_INFINITY,
+ renderer: false,
+
/**
- * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE)
+ * @cfg {String} align Sets the alignment of the header and rendered columns.
+ * Defaults to 'left'.
*/
- maxValue : Number.MAX_VALUE,
+ align: 'left',
+
/**
- * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")
+ * @cfg {Boolean} draggable Indicates whether or not the header can be drag and drop re-ordered.
+ * Defaults to true.
*/
- minText : "The minimum value for this field is {0}",
+ draggable: true,
+
+ // Header does not use the typical ComponentDraggable class and therefore we
+ // override this with an emptyFn. It is controlled at the HeaderDragZone.
+ initDraggable: Ext.emptyFn,
+
/**
- * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")
+ * @cfg {String} tdCls Optional. A CSS class names to apply to the table cells for this column.
*/
- maxText : "The maximum value for this field is {0}",
+
/**
- * @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")
+ * @property {Ext.core.Element} triggerEl
*/
- nanText : "{0} is not a valid number",
+
/**
- * @cfg {String} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789').
+ * @property {Ext.core.Element} textEl
*/
- baseChars : "0123456789",
- // private
- initEvents : function(){
- var allowed = this.baseChars + '';
- if (this.allowDecimals) {
- allowed += this.decimalSeparator;
- }
- if (this.allowNegative) {
- allowed += '-';
- }
- this.maskRe = new RegExp('[' + Ext.escapeRe(allowed) + ']');
- Ext.form.NumberField.superclass.initEvents.call(this);
- },
-
/**
- * Runs all of NumberFields validations and returns an array of any errors. Note that this first
- * runs TextField'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
+ * @private
+ * Set in this class to identify, at runtime, instances which are not instances of the
+ * HeaderContainer base class, but are in fact, the subclass: Header.
*/
- getErrors: function(value) {
- var errors = Ext.form.NumberField.superclass.getErrors.apply(this, arguments);
-
- value = value || this.processValue(this.getRawValue());
+ isHeader: true,
+
+ initComponent: function() {
+ var me = this,
+ i,
+ len;
- if (value.length < 1) { // if it's blank and textfield didn't flag it then it's valid
- return errors;
+ if (Ext.isDefined(me.header)) {
+ me.text = me.header;
+ delete me.header;
}
-
- value = String(value).replace(this.decimalSeparator, ".");
-
- if(isNaN(value)){
- errors.push(String.format(this.nanText, value));
+
+ // Flexed Headers need to have a minWidth defined so that they can never be squeezed out of existence by the
+ // HeaderContainer's specialized Box layout, the ColumnLayout. The ColumnLayout's overridden calculateChildboxes
+ // method extends the available layout space to accommodate the "desiredWidth" of all the columns.
+ if (me.flex) {
+ me.minWidth = me.minWidth || Ext.grid.plugin.HeaderResizer.prototype.minColWidth;
}
-
- var num = this.parseValue(value);
-
- if(num < this.minValue){
- errors.push(String.format(this.minText, this.minValue));
+ // Non-flexed Headers may never be squeezed in the event of a shortfall so
+ // always set their minWidth to their current width.
+ else {
+ me.minWidth = me.width;
}
-
- if(num > this.maxValue){
- errors.push(String.format(this.maxText, this.maxValue));
+
+ if (!me.triStateSort) {
+ me.possibleSortStates.length = 2;
}
-
- return errors;
+
+ // A group header; It contains items which are themselves Headers
+ if (Ext.isDefined(me.columns)) {
+ me.isGroupHeader = true;
+
+ if (me.dataIndex) {
+ Ext.Error.raise('Ext.grid.column.Column: Group header may not accept a dataIndex');
+ }
+ if ((me.width && me.width !== Ext.grid.header.Container.prototype.defaultWidth) || me.flex) {
+ Ext.Error.raise('Ext.grid.column.Column: Group header does not support setting explicit widths or flexs. The group header width is calculated by the sum of its children.');
+ }
+
+ // The headers become child items
+ me.items = me.columns;
+ delete me.columns;
+ delete me.flex;
+ me.width = 0;
+
+ // Acquire initial width from sub headers
+ for (i = 0, len = me.items.length; i < len; i++) {
+ me.width += me.items[i].width || Ext.grid.header.Container.prototype.defaultWidth;
+ if (me.items[i].flex) {
+ Ext.Error.raise('Ext.grid.column.Column: items of a grouped header do not support flexed values. Each item must explicitly define its width.');
+ }
+ }
+ me.minWidth = me.width;
+
+ me.cls = (me.cls||'') + ' ' + Ext.baseCSSPrefix + 'group-header';
+ me.sortable = false;
+ me.fixed = true;
+ me.align = 'center';
+ }
+
+ Ext.applyIf(me.renderSelectors, {
+ titleContainer: '.' + Ext.baseCSSPrefix + 'column-header-inner',
+ triggerEl: '.' + Ext.baseCSSPrefix + 'column-header-trigger',
+ textEl: '.' + Ext.baseCSSPrefix + 'column-header-text'
+ });
+
+ // Initialize as a HeaderContainer
+ me.callParent(arguments);
},
- getValue : function(){
- return this.fixPrecision(this.parseValue(Ext.form.NumberField.superclass.getValue.call(this)));
+ onAdd: function(childHeader) {
+ childHeader.isSubHeader = true;
+ childHeader.addCls(Ext.baseCSSPrefix + 'group-sub-header');
},
- setValue : function(v){
- v = this.fixPrecision(v);
- v = Ext.isNumber(v) ? v : parseFloat(String(v).replace(this.decimalSeparator, "."));
- v = isNaN(v) ? '' : String(v).replace(".", this.decimalSeparator);
- return Ext.form.NumberField.superclass.setValue.call(this, v);
+ onRemove: function(childHeader) {
+ childHeader.isSubHeader = false;
+ childHeader.removeCls(Ext.baseCSSPrefix + 'group-sub-header');
},
-
- /**
- * Replaces any existing {@link #minValue} with the new value.
- * @param {Number} value The minimum value
- */
- setMinValue : function(value){
- this.minValue = Ext.num(value, Number.NEGATIVE_INFINITY);
+
+ initRenderData: function() {
+ var me = this;
+
+ Ext.applyIf(me.renderData, {
+ text: me.text,
+ menuDisabled: me.menuDisabled
+ });
+ return me.callParent(arguments);
},
-
+
+ // note that this should invalidate the menu cache
+ setText: function(text) {
+ this.text = text;
+ if (this.rendered) {
+ this.textEl.update(text);
+ }
+ },
+
+ // Find the topmost HeaderContainer: An ancestor which is NOT a Header.
+ // Group Headers are themselves HeaderContainers
+ getOwnerHeaderCt: function() {
+ return this.up(':not([isHeader])');
+ },
+
/**
- * Replaces any existing {@link #maxValue} with the new value.
- * @param {Number} value The maximum value
+ * Returns the true grid column index assiciated with this Column only if this column is a base level Column.
+ * If it is a group column, it returns false
*/
- setMaxValue : function(value){
- this.maxValue = Ext.num(value, Number.MAX_VALUE);
+ getIndex: function() {
+ return this.isGroupColumn ? false : this.getOwnerHeaderCt().getHeaderIndex(this);
},
- // private
- parseValue : function(value){
- value = parseFloat(String(value).replace(this.decimalSeparator, "."));
- return isNaN(value) ? '' : value;
- },
+ afterRender: function() {
+ var me = this,
+ el = me.el;
- // private
- fixPrecision : function(value){
- var nan = isNaN(value);
- if(!this.allowDecimals || this.decimalPrecision == -1 || nan || !value){
- return nan ? '' : value;
+ me.callParent(arguments);
+
+ el.addCls(Ext.baseCSSPrefix + 'column-header-align-' + me.align).addClsOnOver(me.overCls);
+
+ me.mon(el, {
+ click: me.onElClick,
+ dblclick: me.onElDblClick,
+ scope: me
+ });
+
+ // BrowserBug: Ie8 Strict Mode, this will break the focus for this browser,
+ // must be fixed when focus management will be implemented.
+ if (!Ext.isIE8 || !Ext.isStrict) {
+ me.mon(me.getFocusEl(), {
+ focus: me.onTitleMouseOver,
+ blur: me.onTitleMouseOut,
+ scope: me
+ });
}
- return parseFloat(parseFloat(value).toFixed(this.decimalPrecision));
+
+ me.mon(me.titleContainer, {
+ mouseenter: me.onTitleMouseOver,
+ mouseleave: me.onTitleMouseOut,
+ scope: me
+ });
+
+ me.keyNav = Ext.create('Ext.util.KeyNav', el, {
+ enter: me.onEnterKey,
+ down: me.onDownKey,
+ scope: me
+ });
},
- beforeBlur : function(){
- var v = this.parseValue(this.getRawValue());
- if(!Ext.isEmpty(v)){
- this.setValue(v);
- }
- }
-});
-Ext.reg('numberfield', Ext.form.NumberField);/**
- * @class Ext.form.DateField
- * @extends Ext.form.TriggerField
- * Provides a date input field with a {@link Ext.DatePicker} dropdown and automatic date validation.
- * @constructor
- * Create a new DateField
- * @param {Object} config
- * @xtype datefield
- */
-Ext.form.DateField = Ext.extend(Ext.form.TriggerField, {
- /**
- * @cfg {String} format
- * The default date format string which can be overriden for localization support. The format must be
- * valid according to {@link Date#parseDate} (defaults to 'm/d/Y').
- */
- format : "m/d/Y",
- /**
- * @cfg {String} altFormats
- * Multiple date formats separated by "|" to try when parsing a user input value and it
- * does not match the defined format (defaults to
- * 'm/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d').
- */
- altFormats : "m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d",
- /**
- * @cfg {String} disabledDaysText
- * The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')
- */
- disabledDaysText : "Disabled",
- /**
- * @cfg {String} disabledDatesText
- * The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')
- */
- disabledDatesText : "Disabled",
- /**
- * @cfg {String} minText
- * The error text to display when the date in the cell is before {@link #minValue} (defaults to
- * 'The date in this field must be after {minValue}').
- */
- minText : "The date in this field must be equal to or after {0}",
- /**
- * @cfg {String} maxText
- * The error text to display when the date in the cell is after {@link #maxValue} (defaults to
- * 'The date in this field must be before {maxValue}').
- */
- maxText : "The date in this field must be equal to or before {0}",
- /**
- * @cfg {String} invalidText
- * The error text to display when the date in the field is invalid (defaults to
- * '{value} is not a valid date - it must be in the format {format}').
- */
- invalidText : "{0} is not a valid date - it must be in the format {1}",
- /**
- * @cfg {String} triggerClass
- * An additional CSS class used to style the trigger button. The trigger will always get the
- * class 'x-form-trigger' and triggerClass will be appended if specified
- * (defaults to 'x-form-date-trigger' which displays a calendar icon).
- */
- triggerClass : 'x-form-date-trigger',
- /**
- * @cfg {Boolean} showToday
- * false to hide the footer area of the DatePicker containing the Today button and disable
- * the keyboard handler for spacebar that selects the current date (defaults to true).
- */
- showToday : true,
- /**
- * @cfg {Date/String} minValue
- * The minimum allowed date. Can be either a Javascript date object or a string date in a
- * valid format (defaults to null).
- */
- /**
- * @cfg {Date/String} maxValue
- * The maximum allowed date. Can be either a Javascript date object or a string date in a
- * valid format (defaults to null).
- */
- /**
- * @cfg {Array} disabledDays
- * An array of days to disable, 0 based (defaults to null). Some examples:
-// disable Sunday and Saturday:
-disabledDays: [0, 6]
-// disable weekdays:
-disabledDays: [1,2,3,4,5]
- *
- */
- /**
- * @cfg {Array} disabledDates
- * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
- * expression so they are very powerful. Some examples:
-// disable these exact dates:
-disabledDates: ["03/08/2003", "09/16/2003"]
-// disable these days for every year:
-disabledDates: ["03/08", "09/16"]
-// only match the beginning (useful if you are using short years):
-disabledDates: ["^03/08"]
-// disable every day in March 2006:
-disabledDates: ["03/../2006"]
-// disable every day in every March:
-disabledDates: ["^03"]
- *
- * Note that the format of the dates included in the array should exactly match the {@link #format} config.
- * In order to support regular expressions, if you are using a {@link #format date format} that has "." in
- * it, you will have to escape the dot when restricting dates. For example: ["03\\.08\\.03"].
- */
- /**
- * @cfg {String/Object} autoCreate
- * A {@link Ext.DomHelper DomHelper element specification object}, or true for the default element
- * specification object:
- * autoCreate: {tag: "input", type: "text", size: "10", autocomplete: "off"}
- *
- */
+ setSize: function(width, height) {
+ var me = this,
+ headerCt = me.ownerCt,
+ ownerHeaderCt = me.getOwnerHeaderCt(),
+ siblings,
+ len, i,
+ oldWidth = me.getWidth(),
+ newWidth = 0;
- // private
- defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"},
+ if (width !== oldWidth) {
- // in the absence of a time value, a default value of 12 noon will be used
- // (note: 12 noon was chosen because it steers well clear of all DST timezone changes)
- initTime: '12', // 24 hour format
+ // Bubble size changes upwards to group headers
+ if (headerCt.isGroupHeader) {
- initTimeFormat: 'H',
+ siblings = headerCt.items.items;
+ len = siblings.length;
- // PUBLIC -- to be documented
- safeParse : function(value, format) {
- if (/[gGhH]/.test(format.replace(/(\\.)/g, ''))) {
- // if parse format contains hour information, no DST adjustment is necessary
- return Date.parseDate(value, format);
- } else {
- // set time to 12 noon, then clear the time
- var parsedDate = Date.parseDate(value + ' ' + this.initTime, format + ' ' + this.initTimeFormat);
+ // Size the owning group to the size of its sub headers
+ if (siblings[len - 1].rendered) {
- if (parsedDate) return parsedDate.clearTime();
+ for (i = 0; i < len; i++) {
+ newWidth += (siblings[i] === me) ? width : siblings[i].getWidth();
+ }
+ headerCt.minWidth = newWidth;
+ headerCt.setWidth(newWidth);
+ }
+ }
+ me.callParent(arguments);
}
},
- initComponent : function(){
- Ext.form.DateField.superclass.initComponent.call(this);
+ afterComponentLayout: function(width, height) {
+ var me = this,
+ ownerHeaderCt = this.getOwnerHeaderCt();
- this.addEvents(
- /**
- * @event select
- * Fires when a date is selected via the date picker.
- * @param {Ext.form.DateField} this
- * @param {Date} date The date that was selected
- */
- 'select'
- );
+ me.callParent(arguments);
+
+ // Only changes at the base level inform the grid's HeaderContainer which will update the View
+ // Skip this if the width is null or undefined which will be the Box layout's initial pass through the child Components
+ // Skip this if it's the initial size setting in which case there is no ownerheaderCt yet - that is set afterRender
+ if (width && !me.isGroupHeader && ownerHeaderCt) {
+ ownerHeaderCt.onHeaderResize(me, width, true);
+ }
+ },
- if(Ext.isString(this.minValue)){
- this.minValue = this.parseDate(this.minValue);
+ // private
+ // After the container has laid out and stretched, it calls this to correctly pad the inner to center the text vertically
+ setPadding: function() {
+ var me = this,
+ headerHeight,
+ lineHeight = parseInt(me.textEl.getStyle('line-height'), 10);
+
+ // Top title containing element must stretch to match height of sibling group headers
+ if (!me.isGroupHeader) {
+ headerHeight = me.el.getViewSize().height;
+ if (me.titleContainer.getHeight() < headerHeight) {
+ me.titleContainer.dom.style.height = headerHeight + 'px';
+ }
}
- if(Ext.isString(this.maxValue)){
- this.maxValue = this.parseDate(this.maxValue);
+ headerHeight = me.titleContainer.getViewSize().height;
+
+ // Vertically center the header text in potentially vertically stretched header
+ if (lineHeight) {
+ me.titleContainer.setStyle({
+ paddingTop: Math.max(((headerHeight - lineHeight) / 2), 0) + 'px'
+ });
+ }
+
+ // Only IE needs this
+ if (Ext.isIE && me.triggerEl) {
+ me.triggerEl.setHeight(headerHeight);
}
- this.disabledDatesRE = null;
- this.initDisabledDays();
},
- initEvents: function() {
- Ext.form.DateField.superclass.initEvents.call(this);
- this.keyNav = new Ext.KeyNav(this.el, {
- "down": function(e) {
- this.onTriggerClick();
- },
- scope: this,
- forceKeyDown: true
- });
+ onDestroy: function() {
+ var me = this;
+ Ext.destroy(me.keyNav);
+ delete me.keyNav;
+ me.callParent(arguments);
},
+ onTitleMouseOver: function() {
+ this.titleContainer.addCls(this.hoverCls);
+ },
- // private
- initDisabledDays : function(){
- if(this.disabledDates){
- var dd = this.disabledDates,
- len = dd.length - 1,
- re = "(?:";
+ onTitleMouseOut: function() {
+ this.titleContainer.removeCls(this.hoverCls);
+ },
- Ext.each(dd, function(d, i){
- re += Ext.isDate(d) ? '^' + Ext.escapeRe(d.dateFormat(this.format)) + '$' : dd[i];
- if(i != len){
- re += '|';
- }
- }, this);
- this.disabledDatesRE = new RegExp(re + ')');
+ onDownKey: function(e) {
+ if (this.triggerEl) {
+ this.onElClick(e, this.triggerEl.dom || this.el.dom);
}
},
- /**
- * Replaces any existing disabled dates with new values and refreshes the DatePicker.
- * @param {Array} disabledDates An array of date strings (see the {@link #disabledDates} config
- * for details on supported values) used to disable a pattern of dates.
- */
- setDisabledDates : function(dd){
- this.disabledDates = dd;
- this.initDisabledDays();
- if(this.menu){
- this.menu.picker.setDisabledDates(this.disabledDatesRE);
- }
+ onEnterKey: function(e) {
+ this.onElClick(e, this.el.dom);
},
/**
- * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker.
- * @param {Array} disabledDays An array of disabled day indexes. See the {@link #disabledDays}
- * config for details on supported values.
+ * @private
+ * Double click
+ * @param e
+ * @param t
*/
- setDisabledDays : function(dd){
- this.disabledDays = dd;
- if(this.menu){
- this.menu.picker.setDisabledDays(dd);
+ onElDblClick: function(e, t) {
+ var me = this,
+ ownerCt = me.ownerCt;
+ if (ownerCt && Ext.Array.indexOf(ownerCt.items, me) !== 0 && me.isOnLeftEdge(e) ) {
+ ownerCt.expandToFit(me.previousSibling('gridcolumn'));
}
},
- /**
- * Replaces any existing {@link #minValue} with the new value and refreshes the DatePicker.
- * @param {Date} value The minimum date that can be selected
- */
- setMinValue : function(dt){
- this.minValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
- if(this.menu){
- this.menu.picker.setMinDate(this.minValue);
+ onElClick: function(e, t) {
+
+ // The grid's docked HeaderContainer.
+ var me = this,
+ ownerHeaderCt = me.getOwnerHeaderCt();
+
+ if (ownerHeaderCt && !ownerHeaderCt.ddLock) {
+ // Firefox doesn't check the current target in a within check.
+ // Therefore we check the target directly and then within (ancestors)
+ if (me.triggerEl && (e.target === me.triggerEl.dom || t === me.triggerEl.dom || e.within(me.triggerEl))) {
+ ownerHeaderCt.onHeaderTriggerClick(me, e, t);
+ // if its not on the left hand edge, sort
+ } else if (e.getKey() || (!me.isOnLeftEdge(e) && !me.isOnRightEdge(e))) {
+ me.toggleSortState();
+ ownerHeaderCt.onHeaderClick(me, e, t);
+ }
}
},
/**
- * Replaces any existing {@link #maxValue} with the new value and refreshes the DatePicker.
- * @param {Date} value The maximum date that can be selected
- */
- setMaxValue : function(dt){
- this.maxValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
- if(this.menu){
- this.menu.picker.setMaxDate(this.maxValue);
+ * @private
+ * Process UI events from the view. The owning TablePanel calls this method, relaying events from the TableView
+ * @param {String} type Event type, eg 'click'
+ * @param {TableView} view TableView Component
+ * @param {HtmlElement} cell Cell HtmlElement the event took place within
+ * @param {Number} recordIndex Index of the associated Store Model (-1 if none)
+ * @param {Number} cellIndex Cell index within the row
+ * @param {EventObject} e Original event
+ */
+ processEvent: function(type, view, cell, recordIndex, cellIndex, e) {
+ return this.fireEvent.apply(this, arguments);
+ },
+
+ toggleSortState: function() {
+ var me = this,
+ idx,
+ nextIdx;
+
+ if (me.sortable) {
+ idx = Ext.Array.indexOf(me.possibleSortStates, me.sortState);
+
+ nextIdx = (idx + 1) % me.possibleSortStates.length;
+ me.setSortState(me.possibleSortStates[nextIdx]);
}
},
+ doSort: function(state) {
+ var ds = this.up('tablepanel').store;
+ ds.sort({
+ property: this.getSortParam(),
+ direction: state
+ });
+ },
+
/**
- * Runs all of NumberFields validations and returns an array of any errors. Note that this first
- * runs TextField's validations, so the returned array is an amalgamation of all field errors.
- * The additional validation checks are testing that the date format is valid, that the chosen
- * date is within the min and max date constraints set, that the date chosen is not in the disabledDates
- * regex and that the day chosed is not one of the disabledDays.
- * @param {Mixed} value The value to get errors for (defaults to the current field value)
- * @return {Array} All validation errors for this field
+ * Returns the parameter to sort upon when sorting this header. By default
+ * this returns the dataIndex and will not need to be overriden in most cases.
*/
- getErrors: function(value) {
- var errors = Ext.form.DateField.superclass.getErrors.apply(this, arguments);
-
- value = this.formatDate(value || this.processValue(this.getRawValue()));
+ getSortParam: function() {
+ return this.dataIndex;
+ },
- if (value.length < 1) { // if it's blank and textfield didn't flag it then it's valid
- return errors;
+ //setSortState: function(state, updateUI) {
+ //setSortState: function(state, doSort) {
+ setSortState: function(state, skipClear, initial) {
+ var me = this,
+ colSortClsPrefix = Ext.baseCSSPrefix + 'column-header-sort-',
+ ascCls = colSortClsPrefix + 'ASC',
+ descCls = colSortClsPrefix + 'DESC',
+ nullCls = colSortClsPrefix + 'null',
+ ownerHeaderCt = me.getOwnerHeaderCt(),
+ oldSortState = me.sortState;
+
+ if (oldSortState !== state && me.getSortParam()) {
+ me.addCls(colSortClsPrefix + state);
+ // don't trigger a sort on the first time, we just want to update the UI
+ if (state && !initial) {
+ me.doSort(state);
+ }
+ switch (state) {
+ case 'DESC':
+ me.removeCls([ascCls, nullCls]);
+ break;
+ case 'ASC':
+ me.removeCls([descCls, nullCls]);
+ break;
+ case null:
+ me.removeCls([ascCls, descCls]);
+ break;
+ }
+ if (ownerHeaderCt && !me.triStateSort && !skipClear) {
+ ownerHeaderCt.clearOtherSortStates(me);
+ }
+ me.sortState = state;
+ ownerHeaderCt.fireEvent('sortchange', ownerHeaderCt, me, state);
}
+ },
- var svalue = value;
- value = this.parseDate(value);
- if (!value) {
- errors.push(String.format(this.invalidText, svalue, this.format));
- return errors;
+ hide: function() {
+ var me = this,
+ items,
+ len, i,
+ lb,
+ newWidth = 0,
+ ownerHeaderCt = me.getOwnerHeaderCt();
+
+ // Hiding means setting to zero width, so cache the width
+ me.oldWidth = me.getWidth();
+
+ // Hiding a group header hides itself, and then informs the HeaderContainer about its sub headers (Suppressing header layout)
+ if (me.isGroupHeader) {
+ items = me.items.items;
+ me.callParent(arguments);
+ ownerHeaderCt.onHeaderHide(me);
+ for (i = 0, len = items.length; i < len; i++) {
+ items[i].hidden = true;
+ ownerHeaderCt.onHeaderHide(items[i], true);
+ }
+ return;
}
- var time = value.getTime();
- if (this.minValue && time < this.minValue.clearTime().getTime()) {
- errors.push(String.format(this.minText, this.formatDate(this.minValue)));
+ // TODO: Work with Jamie to produce a scheme where we can show/hide/resize without triggering a layout cascade
+ lb = me.ownerCt.componentLayout.layoutBusy;
+ me.ownerCt.componentLayout.layoutBusy = true;
+ me.callParent(arguments);
+ me.ownerCt.componentLayout.layoutBusy = lb;
+
+ // Notify owning HeaderContainer
+ ownerHeaderCt.onHeaderHide(me);
+
+ if (me.ownerCt.isGroupHeader) {
+ // If we've just hidden the last header in a group, then hide the group
+ items = me.ownerCt.query('>:not([hidden])');
+ if (!items.length) {
+ me.ownerCt.hide();
+ }
+ // Size the group down to accommodate fewer sub headers
+ else {
+ for (i = 0, len = items.length; i < len; i++) {
+ newWidth += items[i].getWidth();
+ }
+ me.ownerCt.minWidth = newWidth;
+ me.ownerCt.setWidth(newWidth);
+ }
}
+ },
- if (this.maxValue && time > this.maxValue.clearTime().getTime()) {
- errors.push(String.format(this.maxText, this.formatDate(this.maxValue)));
+ show: function() {
+ var me = this,
+ ownerCt = me.getOwnerHeaderCt(),
+ lb,
+ items,
+ len, i,
+ newWidth = 0;
+
+ // TODO: Work with Jamie to produce a scheme where we can show/hide/resize without triggering a layout cascade
+ lb = me.ownerCt.componentLayout.layoutBusy;
+ me.ownerCt.componentLayout.layoutBusy = true;
+ me.callParent(arguments);
+ me.ownerCt.componentLayout.layoutBusy = lb;
+
+ // If a sub header, ensure that the group header is visible
+ if (me.isSubHeader) {
+ if (!me.ownerCt.isVisible()) {
+ me.ownerCt.show();
+ }
}
- if (this.disabledDays) {
- var day = value.getDay();
+ // If we've just shown a group with all its sub headers hidden, then show all its sub headers
+ if (me.isGroupHeader && !me.query(':not([hidden])').length) {
+ items = me.query('>*');
+ for (i = 0, len = items.length; i < len; i++) {
+ items[i].show();
+ }
+ }
- for(var i = 0; i < this.disabledDays.length; i++) {
- if (day === this.disabledDays[i]) {
- errors.push(this.disabledDaysText);
- break;
- }
+ // Resize the owning group to accommodate
+ if (me.ownerCt.isGroupHeader) {
+ items = me.ownerCt.query('>:not([hidden])');
+ for (i = 0, len = items.length; i < len; i++) {
+ newWidth += items[i].getWidth();
}
+ me.ownerCt.minWidth = newWidth;
+ me.ownerCt.setWidth(newWidth);
}
- var fvalue = this.formatDate(value);
- if (this.disabledDatesRE && this.disabledDatesRE.test(fvalue)) {
- errors.push(String.format(this.disabledDatesText, fvalue));
+ // Notify owning HeaderContainer
+ if (ownerCt) {
+ ownerCt.onHeaderShow(me);
}
+ },
- return errors;
+ getDesiredWidth: function() {
+ var me = this;
+ if (me.rendered && me.componentLayout && me.componentLayout.lastComponentSize) {
+ // headers always have either a width or a flex
+ // because HeaderContainer sets a defaults width
+ // therefore we can ignore the natural width
+ // we use the componentLayout's tracked width so that
+ // we can calculate the desired width when rendered
+ // but not visible because its being obscured by a layout
+ return me.componentLayout.lastComponentSize.width;
+ // Flexed but yet to be rendered this could be the case
+ // where a HeaderContainer and Headers are simply used as data
+ // structures and not rendered.
+ }
+ else if (me.flex) {
+ // this is going to be wrong, the defaultWidth
+ return me.width;
+ }
+ else {
+ return me.width;
+ }
},
- // private
- // Provides logic to override the default TriggerField.validateBlur which just returns true
- validateBlur : function(){
- return !this.menu || !this.menu.isVisible();
+ getCellSelector: function() {
+ return '.' + Ext.baseCSSPrefix + 'grid-cell-' + this.getItemId();
+ },
+
+ getCellInnerSelector: function() {
+ return this.getCellSelector() + ' .' + Ext.baseCSSPrefix + 'grid-cell-inner';
+ },
+
+ isOnLeftEdge: function(e) {
+ return (e.getXY()[0] - this.el.getLeft() <= this.handleWidth);
},
+ isOnRightEdge: function(e) {
+ return (this.el.getRight() - e.getXY()[0] <= this.handleWidth);
+ }
+
+ /**
+ * Retrieves the editing field for editing associated with this header. Returns false if there
+ * is no field associated with the Header the method will return false. If the
+ * field has not been instantiated it will be created. Note: These methods only has an implementation
+ * if a Editing plugin has been enabled on the grid.
+ * @param record The {@link Ext.data.Model Model} instance being edited.
+ * @param {Mixed} defaultField An object representing a default field to be created
+ * @returns {Ext.form.field.Field} field
+ * @method getEditor
+ */
+ // intentionally omit getEditor and setEditor definitions bc we applyIf into columns
+ // when the editing plugin is injected
+
+
/**
- * Returns the current date value of the date field.
- * @return {Date} The date value
+ * Sets the form field to be used for editing. Note: This method only has an implementation
+ * if an Editing plugin has been enabled on the grid.
+ * @param {Mixed} field An object representing a field to be created. If no xtype is specified a 'textfield' is assumed.
+ * @method setEditor
*/
- getValue : function(){
- return this.parseDate(Ext.form.DateField.superclass.getValue.call(this)) || "";
- },
+});
+/**
+ * @class Ext.grid.RowNumberer
+ * @extends Ext.grid.column.Column
+ * This is a utility class that can be passed into a {@link Ext.grid.column.Column} as a column config that provides
+ * an automatic row numbering column.
+ *
Usage:
+columns: [
+ Ext.create('Ext.grid.RowNumberer'),
+ {text: "Company", flex: 1, sortable: true, dataIndex: 'company'},
+ {text: "Price", width: 120, sortable: true, renderer: Ext.util.Format.usMoney, dataIndex: 'price'},
+ {text: "Change", width: 120, sortable: true, dataIndex: 'change'},
+ {text: "% Change", width: 120, sortable: true, dataIndex: 'pctChange'},
+ {text: "Last Updated", width: 120, sortable: true, renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'}
+]
+ *
+ * @constructor
+ * @param {Object} config The configuration options
+ */
+Ext.define('Ext.grid.RowNumberer', {
+ extend: 'Ext.grid.column.Column',
+ alias: 'widget.rownumberer',
+ /**
+ * @cfg {String} text Any valid text or HTML fragment to display in the header cell for the row
+ * number column (defaults to ' ').
+ */
+ text: " ",
/**
- * Sets the value of the date field. You can pass a date object or any string that can be
- * parsed into a valid date, using {@link #format} as the date format, according
- * to the same rules as {@link Date#parseDate} (the default format used is "m/d/Y").
- *
Usage:
- *
-//All of these calls set the same date value (May 4, 2006)
+ * @cfg {Number} width The default width in pixels of the row number column (defaults to 23).
+ */
+ width: 23,
-//Pass a date object:
-var dt = new Date('5/4/2006');
-dateField.setValue(dt);
+ /**
+ * @cfg {Boolean} sortable True if the row number column is sortable (defaults to false).
+ * @hide
+ */
+ sortable: false,
-//Pass a date string (default format):
-dateField.setValue('05/04/2006');
+ align: 'right',
-//Pass a date string (custom format):
-dateField.format = 'Y-m-d';
-dateField.setValue('2006-05-04');
-
- * @param {String/Date} date The date or valid date string
- * @return {Ext.form.Field} this
- */
- setValue : function(date){
- return Ext.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
+ constructor : function(config){
+ this.callParent(arguments);
+ if (this.rowspan) {
+ this.renderer = Ext.Function.bind(this.renderer, this);
+ }
},
// private
- parseDate : function(value) {
- if(!value || Ext.isDate(value)){
- return value;
+ fixed: true,
+ hideable: false,
+ menuDisabled: true,
+ dataIndex: '',
+ cls: Ext.baseCSSPrefix + 'row-numberer',
+ rowspan: undefined,
+
+ // private
+ renderer: function(value, metaData, record, rowIdx, colIdx, store) {
+ if (this.rowspan){
+ metaData.cellAttr = 'rowspan="'+this.rowspan+'"';
}
- var v = this.safeParse(value, this.format),
- af = this.altFormats,
- afa = this.altFormatsArray;
+ metaData.tdCls = Ext.baseCSSPrefix + 'grid-cell-special';
+ return store.indexOfTotal(record) + 1;
+ }
+});
+
+/**
+ * @class Ext.view.DropZone
+ * @extends Ext.dd.DropZone
+ * @private
+ */
+Ext.define('Ext.view.DropZone', {
+ extend: 'Ext.dd.DropZone',
+
+ indicatorHtml: '',
+ indicatorCls: 'x-grid-drop-indicator',
- if (!v && af) {
- afa = afa || af.split("|");
+ constructor: function(config) {
+ var me = this;
+ Ext.apply(me, config);
- for (var i = 0, len = afa.length; i < len && !v; i++) {
- v = this.safeParse(value, afa[i]);
- }
+ // Create a ddGroup unless one has been configured.
+ // User configuration of ddGroups allows users to specify which
+ // DD instances can interact with each other. Using one
+ // based on the id of the View would isolate it and mean it can only
+ // interact with a DragZone on the same View also using a generated ID.
+ if (!me.ddGroup) {
+ me.ddGroup = 'view-dd-zone-' + me.view.id;
}
- return v;
- },
- // private
- onDestroy : function(){
- Ext.destroy(this.menu, this.keyNav);
- Ext.form.DateField.superclass.onDestroy.call(this);
+ // The DropZone's encapsulating element is the View's main element. It must be this because drop gestures
+ // may require scrolling on hover near a scrolling boundary. In Ext 4.x two DD instances may not use the
+ // same element, so a DragZone on this same View must use the View's parent element as its element.
+ me.callParent([me.view.el]);
},
- // private
- formatDate : function(date){
- return Ext.isDate(date) ? date.dateFormat(this.format) : date;
+// Fire an event through the client DataView. Lock this DropZone during the event processing so that
+// its data does not become corrupted by processing mouse events.
+ fireViewEvent: function() {
+ this.lock();
+ var result = this.view.fireEvent.apply(this.view, arguments);
+ this.unlock();
+ return result;
},
- /**
- * @method onTriggerClick
- * @hide
- */
- // private
- // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
- onTriggerClick : function(){
- if(this.disabled){
- return;
- }
- if(this.menu == null){
- this.menu = new Ext.menu.DateMenu({
- hideOnClick: false,
- focusOnSelect: false
- });
+ getTargetFromEvent : function(e) {
+ var node = e.getTarget(this.view.getItemSelector()),
+ mouseY, nodeList, testNode, i, len, box;
+
+// Not over a row node: The content may be narrower than the View's encapsulating element, so return the closest.
+// If we fall through because the mouse is below the nodes (or there are no nodes), we'll get an onContainerOver call.
+ if (!node) {
+ mouseY = e.getPageY();
+ for (i = 0, nodeList = this.view.getNodes(), len = nodeList.length; i < len; i++) {
+ testNode = nodeList[i];
+ box = Ext.fly(testNode).getBox();
+ if (mouseY <= box.bottom) {
+ return testNode;
+ }
+ }
}
- this.onFocus();
- Ext.apply(this.menu.picker, {
- minDate : this.minValue,
- maxDate : this.maxValue,
- disabledDatesRE : this.disabledDatesRE,
- disabledDatesText : this.disabledDatesText,
- disabledDays : this.disabledDays,
- disabledDaysText : this.disabledDaysText,
- format : this.format,
- showToday : this.showToday,
- minText : String.format(this.minText, this.formatDate(this.minValue)),
- maxText : String.format(this.maxText, this.formatDate(this.maxValue))
- });
- this.menu.picker.setValue(this.getValue() || new Date());
- this.menu.show(this.el, "tl-bl?");
- this.menuEvents('on');
+ return node;
},
- //private
- menuEvents: function(method){
- this.menu[method]('select', this.onSelect, this);
- this.menu[method]('hide', this.onMenuHide, this);
- this.menu[method]('show', this.onFocus, this);
- },
+ getIndicator: function() {
+ var me = this;
- onSelect: function(m, d){
- this.setValue(d);
- this.fireEvent('select', this, d);
- this.menu.hide();
+ if (!me.indicator) {
+ me.indicator = Ext.createWidget('component', {
+ html: me.indicatorHtml,
+ cls: me.indicatorCls,
+ ownerCt: me.view,
+ floating: true,
+ shadow: false
+ });
+ }
+ return me.indicator;
},
- onMenuHide: function(){
- this.focus(false, 60);
- this.menuEvents('un');
- },
+ getPosition: function(e, node) {
+ var y = e.getXY()[1],
+ region = Ext.fly(node).getRegion(),
+ pos;
- // private
- beforeBlur : function(){
- var v = this.parseDate(this.getRawValue());
- if(v){
- this.setValue(v);
+ if ((region.bottom - y) >= (region.bottom - region.top) / 2) {
+ pos = "before";
+ } else {
+ pos = "after";
}
- }
+ return pos;
+ },
/**
- * @cfg {Boolean} grow @hide
- */
- /**
- * @cfg {Number} growMin @hide
- */
- /**
- * @cfg {Number} growMax @hide
- */
- /**
- * @hide
- * @method autoSize
- */
-});
-Ext.reg('datefield', Ext.form.DateField);
-/**
- * @class Ext.form.DisplayField
- * @extends Ext.form.Field
- * A display-only text field which is not validated and not submitted.
- * @constructor
- * Creates a new DisplayField.
- * @param {Object} config Configuration options
- * @xtype displayfield
- */
-Ext.form.DisplayField = Ext.extend(Ext.form.Field, {
- validationEvent : false,
- validateOnBlur : false,
- defaultAutoCreate : {tag: "div"},
- /**
- * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-display-field")
- */
- fieldClass : "x-form-display-field",
- /**
- * @cfg {Boolean} htmlEncode false to skip HTML-encoding the text when rendering it (defaults to
- * false). This might be useful if you want to include tags in the field's innerHTML rather than
- * rendering them as string literals per the default logic.
+ * @private Determines whether the record at the specified offset from the passed record
+ * is in the drag payload.
+ * @param records
+ * @param record
+ * @param offset
+ * @returns {Boolean} True if the targeted record is in the drag payload
*/
- htmlEncode: false,
-
- // private
- initEvents : Ext.emptyFn,
+ containsRecordAtOffset: function(records, record, offset) {
+ if (!record) {
+ return false;
+ }
+ var view = this.view,
+ recordIndex = view.indexOf(record),
+ nodeBefore = view.getNode(recordIndex + offset),
+ recordBefore = nodeBefore ? view.getRecord(nodeBefore) : null;
- isValid : function(){
- return true;
+ return recordBefore && Ext.Array.contains(records, recordBefore);
},
- validate : function(){
- return true;
- },
+ positionIndicator: function(node, data, e) {
+ var me = this,
+ view = me.view,
+ pos = me.getPosition(e, node),
+ overRecord = view.getRecord(node),
+ draggingRecords = data.records,
+ indicator, indicatorY;
+
+ if (!Ext.Array.contains(draggingRecords, overRecord) && (
+ pos == 'before' && !me.containsRecordAtOffset(draggingRecords, overRecord, -1) ||
+ pos == 'after' && !me.containsRecordAtOffset(draggingRecords, overRecord, 1)
+ )) {
+ me.valid = true;
+
+ if (me.overRecord != overRecord || me.currentPosition != pos) {
+
+ indicatorY = Ext.fly(node).getY() - view.el.getY() - 1;
+ if (pos == 'after') {
+ indicatorY += Ext.fly(node).getHeight();
+ }
+ me.getIndicator().setWidth(Ext.fly(view.el).getWidth()).showAt(0, indicatorY);
- getRawValue : function(){
- var v = this.rendered ? this.el.dom.innerHTML : Ext.value(this.value, '');
- if(v === this.emptyText){
- v = '';
+ // Cache the overRecord and the 'before' or 'after' indicator.
+ me.overRecord = overRecord;
+ me.currentPosition = pos;
+ }
+ } else {
+ me.invalidateDrop();
}
- if(this.htmlEncode){
- v = Ext.util.Format.htmlDecode(v);
+ },
+
+ invalidateDrop: function() {
+ if (this.valid) {
+ this.valid = false;
+ this.getIndicator().hide();
}
- return v;
},
- getValue : function(){
- return this.getRawValue();
+ // The mouse is over a View node
+ onNodeOver: function(node, dragZone, e, data) {
+ if (!Ext.Array.contains(data.records, this.view.getRecord(node))) {
+ this.positionIndicator(node, data, e);
+ }
+ return this.valid ? this.dropAllowed : this.dropNotAllowed;
},
-
- getName: function() {
- return this.name;
+
+ // Moved out of the DropZone without dropping.
+ // Remove drop position indicator
+ notifyOut: function(node, dragZone, e, data) {
+ this.callParent(arguments);
+ delete this.overRecord;
+ delete this.currentPosition;
+ if (this.indicator) {
+ this.indicator.hide();
+ }
},
- setRawValue : function(v){
- if(this.htmlEncode){
- v = Ext.util.Format.htmlEncode(v);
+ // The mouse is past the end of all nodes (or there are no nodes)
+ onContainerOver : function(dd, e, data) {
+ var v = this.view,
+ c = v.store.getCount();
+
+ // There are records, so position after the last one
+ if (c) {
+ this.positionIndicator(v.getNode(c - 1), data, e);
+ }
+
+ // No records, position the indicator at the top
+ else {
+ delete this.overRecord;
+ delete this.currentPosition;
+ this.getIndicator().setWidth(Ext.fly(v.el).getWidth()).showAt(0, 0);
+ this.valid = true;
}
- return this.rendered ? (this.el.dom.innerHTML = (Ext.isEmpty(v) ? '' : v)) : (this.value = v);
+ return this.dropAllowed;
},
- setValue : function(v){
- this.setRawValue(v);
- return this;
- }
- /**
- * @cfg {String} inputType
- * @hide
- */
- /**
- * @cfg {Boolean} disabled
- * @hide
- */
- /**
- * @cfg {Boolean} readOnly
- * @hide
- */
- /**
- * @cfg {Boolean} validateOnBlur
- * @hide
- */
- /**
- * @cfg {Number} validationDelay
- * @hide
- */
- /**
- * @cfg {String/Boolean} validationEvent
- * @hide
- */
-});
+ onContainerDrop : function(dd, e, data) {
+ return this.onNodeDrop(dd, null, e, data);
+ },
-Ext.reg('displayfield', Ext.form.DisplayField);
-/**
- * @class Ext.form.ComboBox
- * @extends Ext.form.TriggerField
- * A combobox control with support for autocomplete, remote-loading, paging and many other features.
- * A ComboBox works in a similar manner to a traditional HTML <select> field. The difference is
- * that to submit the {@link #valueField}, you must specify a {@link #hiddenName} to create a hidden input
- * field to hold the value of the valueField. The {@link #displayField} is shown in the text field
- * which is named according to the {@link #name}.
- * Events
- * To do something when something in ComboBox is selected, configure the select event:
-var cb = new Ext.form.ComboBox({
- // all of your config options
- listeners:{
- scope: yourScope,
- 'select': yourFunction
+ onNodeDrop: function(node, dragZone, e, data) {
+ var me = this,
+ dropped = false,
+
+ // Create a closure to perform the operation which the event handler may use.
+ // Users may now return 0
from the beforedrop handler, and perform any kind
+ // of asynchronous processing such as an Ext.Msg.confirm, or an Ajax request,
+ // and complete the drop gesture at some point in the future by calling this function.
+ processDrop = function () {
+ me.invalidateDrop();
+ me.handleNodeDrop(data, me.overRecord, me.currentPosition);
+ dropped = true;
+ me.fireViewEvent('drop', node, data, me.overRecord, me.currentPosition);
+ },
+ performOperation;
+
+ if (me.valid) {
+ performOperation = me.fireViewEvent('beforedrop', node, data, me.overRecord, me.currentPosition, processDrop);
+ if (performOperation === 0) {
+ return;
+ } else if (performOperation !== false) {
+ // If the processDrop function was called in the event handler, do not do it again.
+ if (!dropped) {
+ processDrop();
+ }
+ } else {
+ return false;
+ }
+ } else {
+ return false;
+ }
}
});
-// Alternatively, you can assign events after the object is created:
-var cb = new Ext.form.ComboBox(yourOptions);
-cb.on('select', yourFunction, yourScope);
- *
- *
- * ComboBox in Grid
- * If using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a {@link Ext.grid.Column#renderer renderer}
- * will be needed to show the displayField when the editor is not active. Set up the renderer manually, or implement
- * a reusable render, for example:
-// create reusable renderer
-Ext.util.Format.comboRenderer = function(combo){
- return function(value){
- var record = combo.findRecord(combo.{@link #valueField}, value);
- return record ? record.get(combo.{@link #displayField}) : combo.{@link #valueNotFoundText};
- }
-}
+Ext.define('Ext.grid.ViewDropZone', {
+ extend: 'Ext.view.DropZone',
-// create the combo instance
-var combo = new Ext.form.ComboBox({
- {@link #typeAhead}: true,
- {@link #triggerAction}: 'all',
- {@link #lazyRender}:true,
- {@link #mode}: 'local',
- {@link #store}: new Ext.data.ArrayStore({
- id: 0,
- fields: [
- 'myId',
- 'displayText'
- ],
- data: [[1, 'item1'], [2, 'item2']]
- }),
- {@link #valueField}: 'myId',
- {@link #displayField}: 'displayText'
-});
+ indicatorHtml: '',
+ indicatorCls: 'x-grid-drop-indicator',
-// snippet of column model used within grid
-var cm = new Ext.grid.ColumnModel([{
- ...
- },{
- header: "Some Header",
- dataIndex: 'whatever',
- width: 130,
- editor: combo, // specify reference to combo instance
- renderer: Ext.util.Format.comboRenderer(combo) // pass combo instance to reusable renderer
- },
- ...
-]);
- *
+ handleNodeDrop : function(data, record, position) {
+ var view = this.view,
+ store = view.getStore(),
+ index, records, i, len;
+
+ // If the copy flag is set, create a copy of the Models with the same IDs
+ if (data.copy) {
+ records = data.records;
+ data.records = [];
+ for (i = 0, len = records.length; i < len; i++) {
+ data.records.push(records[i].copy(records[i].getId()));
+ }
+ } else {
+ /*
+ * Remove from the source store. We do this regardless of whether the store
+ * is the same bacsue the store currently doesn't handle moving records
+ * within the store. In the future it should be possible to do this.
+ * Here was pass the isMove parameter if we're moving to the same view.
+ */
+ data.view.store.remove(data.records, data.view === view);
+ }
+
+ index = store.indexOf(record);
+ if (position == 'after') {
+ index++;
+ }
+ store.insert(index, data.records);
+ view.getSelectionModel().select(data.records);
+ }
+});
+/**
+ * @class Ext.grid.column.Action
+ * @extends Ext.grid.column.Column
+ * A Grid header type which renders an icon, or a series of icons in a grid cell, and offers a scoped click
+ * handler for each icon.
*
- * Filtering
- * A ComboBox {@link #doQuery uses filtering itself}, for information about filtering the ComboBox
- * store manually see {@link #lastQuery}.
- * @constructor
- * Create a new ComboBox.
- * @param {Object} config Configuration options
- * @xtype combo
+ * {@img Ext.grid.column.Action/Ext.grid.column.Action.png Ext.grid.column.Action grid column}
+ *
+ * ## Code
+ * Ext.create('Ext.data.Store', {
+ * storeId:'employeeStore',
+ * fields:['firstname', 'lastname', 'senority', 'dep', 'hired'],
+ * data:[
+ * {firstname:"Michael", lastname:"Scott"},
+ * {firstname:"Dwight", lastname:"Schrute"},
+ * {firstname:"Jim", lastname:"Halpert"},
+ * {firstname:"Kevin", lastname:"Malone"},
+ * {firstname:"Angela", lastname:"Martin"}
+ * ]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Action Column Demo',
+ * store: Ext.data.StoreManager.lookup('employeeStore'),
+ * columns: [
+ * {text: 'First Name', dataIndex:'firstname'},
+ * {text: 'Last Name', dataIndex:'lastname'},
+ * {
+ * xtype:'actioncolumn',
+ * width:50,
+ * items: [{
+ * icon: 'images/edit.png', // Use a URL in the icon config
+ * tooltip: 'Edit',
+ * handler: function(grid, rowIndex, colIndex) {
+ * var rec = grid.getStore().getAt(rowIndex);
+ * alert("Edit " + rec.get('firstname'));
+ * }
+ * },{
+ * icon: 'images/delete.png',
+ * tooltip: 'Delete',
+ * handler: function(grid, rowIndex, colIndex) {
+ * var rec = grid.getStore().getAt(rowIndex);
+ * alert("Terminate " + rec.get('firstname'));
+ * }
+ * }]
+ * }
+ * ],
+ * width: 250,
+ * renderTo: Ext.getBody()
+ * });
+ * The action column can be at any index in the columns array, and a grid can have any number of
+ * action columns.
+ * @xtype actioncolumn
*/
-Ext.form.ComboBox = Ext.extend(Ext.form.TriggerField, {
- /**
- * @cfg {Mixed} transform The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
- * Note that if you specify this and the combo is going to be in an {@link Ext.form.BasicForm} or
- * {@link Ext.form.FormPanel}, you must also set {@link #lazyRender} = true.
- */
- /**
- * @cfg {Boolean} lazyRender true to prevent the ComboBox from rendering until requested
- * (should always be used when rendering into an {@link Ext.Editor} (e.g. {@link Ext.grid.EditorGridPanel Grids}),
- * defaults to false).
- */
- /**
- * @cfg {String/Object} autoCreate A {@link Ext.DomHelper DomHelper} element spec, or true for a default
- * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
- * See {@link Ext.Component#autoEl autoEl} for details. Defaults to:
- * {tag: "input", type: "text", size: "24", autocomplete: "off"}
- */
- /**
- * @cfg {Ext.data.Store/Array} store The data source to which this combo is bound (defaults to undefined).
- * Acceptable values for this property are:
- *
- * - any {@link Ext.data.Store Store} subclass
- * - an Array : Arrays will be converted to a {@link Ext.data.ArrayStore} internally,
- * automatically generating {@link Ext.data.Field#name field names} to work with all data components.
- *
- * - 1-dimensional array : (e.g., ['Foo','Bar'])
- * A 1-dimensional array will automatically be expanded (each array item will be used for both the combo
- * {@link #valueField} and {@link #displayField})
- * - 2-dimensional array : (e.g., [['f','Foo'],['b','Bar']])
- * For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo
- * {@link #valueField}, while the value at index 1 is assumed to be the combo {@link #displayField}.
- *
- * See also {@link #mode}.
- */
- /**
- * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
- * the dropdown list (defaults to undefined, with no header element)
- */
+Ext.define('Ext.grid.column.Action', {
+ extend: 'Ext.grid.column.Column',
+ alias: ['widget.actioncolumn'],
+ alternateClassName: 'Ext.grid.ActionColumn',
- // private
- defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
- /**
- * @cfg {Number} listWidth The width (used as a parameter to {@link Ext.Element#setWidth}) of the dropdown
- * list (defaults to the width of the ComboBox field). See also {@link #minListWidth}
- */
- /**
- * @cfg {String} displayField The underlying {@link Ext.data.Field#name data field name} to bind to this
- * ComboBox (defaults to undefined if {@link #mode} = 'remote' or 'field1' if
- * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
- * the store configuration}).
- * See also {@link #valueField}.
- * Note: if using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a
- * {@link Ext.grid.Column#renderer renderer} will be needed to show the displayField when the editor is not
- * active.
- */
- /**
- * @cfg {String} valueField The underlying {@link Ext.data.Field#name data value name} to bind to this
- * ComboBox (defaults to undefined if {@link #mode} = 'remote' or 'field2' if
- * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
- * the store configuration}).
- * Note: use of a valueField requires the user to make a selection in order for a value to be
- * mapped. See also {@link #hiddenName}, {@link #hiddenValue}, and {@link #displayField}.
- */
/**
- * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
- * field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically
- * post during a form submission. See also {@link #valueField}.
- * Note: the hidden field's id will also default to this name if {@link #hiddenId} is not specified.
- * The ComboBox {@link Ext.Component#id id} and the {@link #hiddenId} should be different, since
- * no two DOM nodes should share the same id. So, if the ComboBox {@link Ext.form.Field#name name} and
- * hiddenName are the same, you should specify a unique {@link #hiddenId}.
+ * @cfg {String} icon
+ * The URL of an image to display as the clickable element in the column.
+ * Optional - defaults to {@link Ext#BLANK_IMAGE_URL Ext.BLANK_IMAGE_URL}
.
*/
/**
- * @cfg {String} hiddenId If {@link #hiddenName} is specified, hiddenId can also be provided
- * to give the hidden field a unique id (defaults to the {@link #hiddenName}). The hiddenId
- * and combo {@link Ext.Component#id id} should be different, since no two DOM
- * nodes should share the same id.
- */
- /**
- * @cfg {String} hiddenValue Sets the initial value of the hidden field if {@link #hiddenName} is
- * specified to contain the selected {@link #valueField}, from the Store. Defaults to the configured
- * {@link Ext.form.Field#value value}.
- */
- /**
- * @cfg {String} listClass The CSS class to add to the predefined 'x-combo-list' class
- * applied the dropdown list element (defaults to '').
- */
- listClass : '',
- /**
- * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list
- * (defaults to 'x-combo-selected')
- */
- selectedClass : 'x-combo-selected',
- /**
- * @cfg {String} listEmptyText The empty text to display in the data view if no items are found.
- * (defaults to '')
+ * @cfg {String} iconCls
+ * A CSS class to apply to the icon image. To determine the class dynamically, configure the Column with a {@link #getClass}
function.
*/
- listEmptyText: '',
/**
- * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always
- * get the class 'x-form-trigger' and triggerClass will be appended if specified
- * (defaults to 'x-form-arrow-trigger' which displays a downward arrow icon).
+ * @cfg {Function} handler A function called when the icon is clicked.
+ * The handler is passed the following parameters:
+ * view
: TableViewThe owning TableView.
+ * rowIndex
: NumberThe row index clicked on.
+ * colIndex
: NumberThe column index clicked on.
+ * item
: ObjectThe clicked item (or this Column if multiple
+ * {@link #items} were not configured).
+ * e
: EventThe click event.
+ *
*/
- triggerClass : 'x-form-arrow-trigger',
/**
- * @cfg {Boolean/String} shadow true or "sides" for the default effect, "frame" for
- * 4-way shadow, and "drop" for bottom-right
+ * @cfg {Object} scope The scope (this reference) in which the {@link #handler}
+ * and {@link #getClass}
fuctions are executed. Defaults to this Column.
*/
- shadow : 'sides',
/**
- * @cfg {String/Array} listAlign A valid anchor position value. See {@link Ext.Element#alignTo} for details
- * on supported anchor positions and offsets. To specify x/y offsets as well, this value
- * may be specified as an Array of {@link Ext.Element#alignTo} method arguments.
- * [ 'tl-bl?', [6,0] ]
(defaults to 'tl-bl?')
+ * @cfg {String} tooltip A tooltip message to be displayed on hover. {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must have
+ * been initialized.
*/
- listAlign : 'tl-bl?',
/**
- * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown
- * (defaults to 300)
+ * @cfg {Boolean} stopSelection Defaults to true
. Prevent grid row selection upon mousedown.
*/
- maxHeight : 300,
/**
- * @cfg {Number} minHeight The minimum height in pixels of the dropdown list when the list is constrained by its
- * distance to the viewport edges (defaults to 90)
+ * @cfg {Function} getClass A function which returns the CSS class to apply to the icon image.
+ * The function is passed the following parameters:
+ * - v : Object
The value of the column's configured field (if any).
+ * - metadata : Object
An object in which you may set the following attributes:
+ * - css : String
A CSS class name to add to the cell's TD element.
+ * - attr : String
An HTML attribute definition string to apply to the data container element within the table cell
+ * (e.g. 'style="color:red;"').
+ *
+ * - r : Ext.data.Record
The Record providing the data.
+ * - rowIndex : Number
The row index..
+ * - colIndex : Number
The column index.
+ * - store : Ext.data.Store
The Store which is providing the data Model.
+ *
*/
- minHeight : 90,
/**
- * @cfg {String} triggerAction The action to execute when the trigger is clicked.
+ * @cfg {Array} items An Array which may contain multiple icon definitions, each element of which may contain:
*
- * - 'query' : Default
- *
{@link #doQuery run the query} using the {@link Ext.form.Field#getRawValue raw value}.
- * - 'all' :
- *
{@link #doQuery run the query} specified by the {@link #allQuery} config option
+ * icon
: StringThe url of an image to display as the clickable element
+ * in the column.
+ * iconCls
: StringA CSS class to apply to the icon image.
+ * To determine the class dynamically, configure the item with a getClass
function.
+ * getClass
: FunctionA function which returns the CSS class to apply to the icon image.
+ * The function is passed the following parameters:
+ * - v : Object
The value of the column's configured field (if any).
+ * - metadata : Object
An object in which you may set the following attributes:
+ * - css : String
A CSS class name to add to the cell's TD element.
+ * - attr : String
An HTML attribute definition string to apply to the data container element within the table cell
+ * (e.g. 'style="color:red;"').
+ *
+ * - r : Ext.data.Record
The Record providing the data.
+ * - rowIndex : Number
The row index..
+ * - colIndex : Number
The column index.
+ * - store : Ext.data.Store
The Store which is providing the data Model.
+ *
+ * handler
: FunctionA function called when the icon is clicked.
+ * scope
: ScopeThe scope (this
reference) in which the
+ * handler
and getClass
functions are executed. Fallback defaults are this Column's
+ * configured scope, then this Column.
+ * tooltip
: StringA tooltip message to be displayed on hover.
+ * {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must have been initialized.
*
- * See also {@link #queryParam}
.
*/
- triggerAction : 'query',
+ header: ' ',
+
+ actionIdRe: /x-action-col-(\d+)/,
+
/**
- * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and
- * {@link #typeAhead} activate (defaults to 4 if {@link #mode} = 'remote' or 0 if
- * {@link #mode} = 'local', does not apply if
- * {@link Ext.form.TriggerField#editable editable} = false).
+ * @cfg {String} altText The alt text to use for the image element. Defaults to ''.
*/
- minChars : 4,
+ altText: '',
+
+ sortable: false,
+
+ constructor: function(config) {
+ var me = this,
+ cfg = Ext.apply({}, config),
+ items = cfg.items || [me],
+ l = items.length,
+ i,
+ item;
+
+ // This is a Container. Delete the items config to be reinstated after construction.
+ delete cfg.items;
+ this.callParent([cfg]);
+
+ // Items is an array property of ActionColumns
+ me.items = items;
+
+// Renderer closure iterates through items creating an element for each and tagging with an identifying
+// class name x-action-col-{n}
+ me.renderer = function(v, meta) {
+// Allow a configured renderer to create initial value (And set the other values in the "metadata" argument!)
+ v = Ext.isFunction(cfg.renderer) ? cfg.renderer.apply(this, arguments)||'' : '';
+
+ meta.tdCls += ' ' + Ext.baseCSSPrefix + 'action-col-cell';
+ for (i = 0; i < l; i++) {
+ item = items[i];
+ v += '';
+ }
+ return v;
+ };
+ },
+
+ destroy: function() {
+ delete this.items;
+ delete this.renderer;
+ return this.callParent(arguments);
+ },
+
/**
- * @cfg {Boolean} autoSelect true to select the first result gathered by the data store (defaults
- * to true). A false value would require a manual selection from the dropdown list to set the components value
- * unless the value of ({@link #typeAheadDelay}) were true.
+ * @private
+ * Process and refire events routed from the GridView's processEvent method.
+ * Also fires any configured click handlers. By default, cancels the mousedown event to prevent selection.
+ * Returns the event handler's status to allow canceling of GridView's bubbling process.
+ */
+ processEvent : function(type, view, cell, recordIndex, cellIndex, e){
+ var m = e.getTarget().className.match(this.actionIdRe),
+ item, fn;
+ if (m && (item = this.items[parseInt(m[1], 10)])) {
+ if (type == 'click') {
+ fn = item.handler;
+ if (fn || this.handler) {
+ fn.call(item.scope||this.scope||this, view, recordIndex, cellIndex, item, e);
+ }
+ } else if ((type == 'mousedown') && (item.stopSelection !== false)) {
+ return false;
+ }
+ }
+ return this.callParent(arguments);
+ },
+
+ cascade: function(fn, scope) {
+ fn.call(scope||this, this);
+ },
+
+ // Private override because this cannot function as a Container, and it has an items property which is an Array, NOT a MixedCollection.
+ getRefItems: function() {
+ return [];
+ }
+});
+/**
+ * @class Ext.grid.column.Boolean
+ * @extends Ext.grid.column.Column
+ * A Column definition class which renders boolean data fields. See the {@link Ext.grid.column.Column#xtype xtype}
+ * config option of {@link Ext.grid.column.Column} for more details.
+ *
+ * {@img Ext.grid.column.Boolean/Ext.grid.column.Boolean.png Ext.grid.column.Boolean grid column}
+ *
+ * ## Code
+ * Ext.create('Ext.data.Store', {
+ * storeId:'sampleStore',
+ * fields:[
+ * {name: 'framework', type: 'string'},
+ * {name: 'rocks', type: 'boolean'}
+ * ],
+ * data:{'items':[
+ * {"framework":"Ext JS 4", "rocks":true},
+ * {"framework":"Sencha Touch", "rocks":true},
+ * {"framework":"Ext GWT", "rocks":true},
+ * {"framework":"Other Guys", "rocks":false}
+ * ]},
+ * proxy: {
+ * type: 'memory',
+ * reader: {
+ * type: 'json',
+ * root: 'items'
+ * }
+ * }
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Boolean Column Demo',
+ * store: Ext.data.StoreManager.lookup('sampleStore'),
+ * columns: [
+ * {text: 'Framework', dataIndex: 'framework', flex: 1},
+ * {
+ * xtype: 'booleancolumn',
+ * text: 'Rocks',
+ * trueText: 'Yes',
+ * falseText: 'No',
+ * dataIndex: 'rocks'}
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * @xtype booleancolumn
+ */
+Ext.define('Ext.grid.column.Boolean', {
+ extend: 'Ext.grid.column.Column',
+ alias: ['widget.booleancolumn'],
+ alternateClassName: 'Ext.grid.BooleanColumn',
+
+ /**
+ * @cfg {String} trueText
+ * The string returned by the renderer when the column value is not falsey (defaults to 'true').
*/
- autoSelect : true,
+ trueText: 'true',
+
/**
- * @cfg {Boolean} typeAhead true to populate and autoselect the remainder of the text being
- * typed after a configurable delay ({@link #typeAheadDelay}) if it matches a known value (defaults
- * to false)
+ * @cfg {String} falseText
+ * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to
+ * 'false').
*/
- typeAhead : false,
+ falseText: 'false',
+
/**
- * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and
- * sending the query to filter the dropdown list (defaults to 500 if {@link #mode} = 'remote'
- * or 10 if {@link #mode} = 'local')
+ * @cfg {String} undefinedText
+ * The string returned by the renderer when the column value is undefined (defaults to ' ').
*/
- queryDelay : 500,
+ undefinedText: ' ',
+
+ constructor: function(cfg){
+ this.callParent(arguments);
+ var trueText = this.trueText,
+ falseText = this.falseText,
+ undefinedText = this.undefinedText;
+
+ this.renderer = function(value){
+ if(value === undefined){
+ return undefinedText;
+ }
+ if(!value || value === 'false'){
+ return falseText;
+ }
+ return trueText;
+ };
+ }
+});
+/**
+ * @class Ext.grid.column.Date
+ * @extends Ext.grid.column.Column
+ * A Column definition class which renders a passed date according to the default locale, or a configured
+ * {@link #format}.
+ *
+ * {@img Ext.grid.column.Date/Ext.grid.column.Date.png Ext.grid.column.Date grid column}
+ *
+ * ## Code
+ * Ext.create('Ext.data.Store', {
+ * storeId:'sampleStore',
+ * fields:[
+ * {name: 'symbol', type: 'string'},
+ * {name: 'date', type: 'date'},
+ * {name: 'change', type: 'number'},
+ * {name: 'volume', type: 'number'},
+ * {name: 'topday', type: 'date'}
+ * ],
+ * data:[
+ * {symbol:"msft", date:'2011/04/22', change:2.43, volume:61606325, topday:'04/01/2010'},
+ * {symbol:"goog", date:'2011/04/22', change:0.81, volume:3053782, topday:'04/11/2010'},
+ * {symbol:"apple", date:'2011/04/22', change:1.35, volume:24484858, topday:'04/28/2010'},
+ * {symbol:"sencha", date:'2011/04/22', change:8.85, volume:5556351, topday:'04/22/2010'}
+ * ]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Date Column Demo',
+ * store: Ext.data.StoreManager.lookup('sampleStore'),
+ * columns: [
+ * {text: 'Symbol', dataIndex: 'symbol', flex: 1},
+ * {text: 'Date', dataIndex: 'date', xtype: 'datecolumn', format:'Y-m-d'},
+ * {text: 'Change', dataIndex: 'change', xtype: 'numbercolumn', format:'0.00'},
+ * {text: 'Volume', dataIndex: 'volume', xtype: 'numbercolumn', format:'0,000'},
+ * {text: 'Top Day', dataIndex: 'topday', xtype: 'datecolumn', format:'l'}
+ * ],
+ * height: 200,
+ * width: 450,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * @xtype datecolumn
+ */
+Ext.define('Ext.grid.column.Date', {
+ extend: 'Ext.grid.column.Column',
+ alias: ['widget.datecolumn'],
+ requires: ['Ext.Date'],
+ alternateClassName: 'Ext.grid.DateColumn',
+
/**
- * @cfg {Number} pageSize If greater than 0, a {@link Ext.PagingToolbar} is displayed in the
- * footer of the dropdown list and the {@link #doQuery filter queries} will execute with page start and
- * {@link Ext.PagingToolbar#pageSize limit} parameters. Only applies when {@link #mode} = 'remote'
- * (defaults to 0).
+ * @cfg {String} format
+ * A formatting string as used by {@link Date#format Date.format} to format a Date for this Column.
+ * This defaults to the default date from {@link Ext.Date#defaultFormat} which itself my be overridden
+ * in a locale file.
*/
- pageSize : 0,
+ format : Ext.Date.defaultFormat,
+
+ constructor: function(cfg){
+ this.callParent(arguments);
+ this.renderer = Ext.util.Format.dateRenderer(this.format);
+ }
+});
+/**
+ * @class Ext.grid.column.Number
+ * @extends Ext.grid.column.Column
+ * A Column definition class which renders a numeric data field according to a {@link #format} string.
+ *
+ * {@img Ext.grid.column.Number/Ext.grid.column.Number.png Ext.grid.column.Number cell editing}
+ *
+ * ## Code
+ * Ext.create('Ext.data.Store', {
+ * storeId:'sampleStore',
+ * fields:[
+ * {name: 'symbol', type: 'string'},
+ * {name: 'price', type: 'number'},
+ * {name: 'change', type: 'number'},
+ * {name: 'volume', type: 'number'},
+ * ],
+ * data:[
+ * {symbol:"msft", price:25.76, change:2.43, volume:61606325},
+ * {symbol:"goog", price:525.73, change:0.81, volume:3053782},
+ * {symbol:"apple", price:342.41, change:1.35, volume:24484858},
+ * {symbol:"sencha", price:142.08, change:8.85, volume:5556351}
+ * ]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Number Column Demo',
+ * store: Ext.data.StoreManager.lookup('sampleStore'),
+ * columns: [
+ * {text: 'Symbol', dataIndex: 'symbol', flex: 1},
+ * {text: 'Current Price', dataIndex: 'price', renderer: Ext.util.Format.usMoney},
+ * {text: 'Change', dataIndex: 'change', xtype: 'numbercolumn', format:'0.00'},
+ * {text: 'Volume', dataIndex: 'volume', xtype: 'numbercolumn', format:'0,000'}
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * @xtype numbercolumn
+ */
+Ext.define('Ext.grid.column.Number', {
+ extend: 'Ext.grid.column.Column',
+ alias: ['widget.numbercolumn'],
+ requires: ['Ext.util.Format'],
+ alternateClassName: 'Ext.grid.NumberColumn',
+
/**
- * @cfg {Boolean} selectOnFocus true to select any existing text in the field immediately on focus.
- * Only applies when {@link Ext.form.TriggerField#editable editable} = true (defaults to
- * false).
+ * @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'
).
*/
- selectOnFocus : false,
+ format : '0,000.00',
+ constructor: function(cfg) {
+ this.callParent(arguments);
+ this.renderer = Ext.util.Format.numberRenderer(this.format);
+ }
+});
+/**
+ * @class Ext.grid.column.Template
+ * @extends Ext.grid.column.Column
+ *
+ * A Column definition class which renders a value by processing a {@link Ext.data.Model Model}'s
+ * {@link Ext.data.Model#data data} using a {@link #tpl configured} {@link Ext.XTemplate XTemplate}.
+ *
+ * {@img Ext.grid.column.Template/Ext.grid.column.Template.png Ext.grid.column.Template grid column}
+ *
+ * ## Code
+ * Ext.create('Ext.data.Store', {
+ * storeId:'employeeStore',
+ * fields:['firstname', 'lastname', 'senority', 'department'],
+ * groupField: 'department',
+ * data:[
+ * {firstname:"Michael", lastname:"Scott", senority:7, department:"Manangement"},
+ * {firstname:"Dwight", lastname:"Schrute", senority:2, department:"Sales"},
+ * {firstname:"Jim", lastname:"Halpert", senority:3, department:"Sales"},
+ * {firstname:"Kevin", lastname:"Malone", senority:4, department:"Accounting"},
+ * {firstname:"Angela", lastname:"Martin", senority:5, department:"Accounting"}
+ * ]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Column Template Demo',
+ * store: Ext.data.StoreManager.lookup('employeeStore'),
+ * columns: [
+ * {text: 'Full Name', xtype:'templatecolumn', tpl:'{firstname} {lastname}', flex:1},
+ * {text: 'Deparment (Yrs)', xtype:'templatecolumn', tpl:'{department} ({senority})'}
+ * ],
+ * height: 200,
+ * width: 300,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * @markdown
+ * @xtype templatecolumn
+ */
+Ext.define('Ext.grid.column.Template', {
+ extend: 'Ext.grid.column.Column',
+ alias: ['widget.templatecolumn'],
+ requires: ['Ext.XTemplate'],
+ alternateClassName: 'Ext.grid.TemplateColumn',
+
/**
- * @cfg {String} queryParam Name of the query ({@link Ext.data.Store#baseParam baseParam} name for the store)
- * as it will be passed on the querystring (defaults to 'query')
+ * @cfg {String/XTemplate} tpl
+ * An {@link Ext.XTemplate XTemplate}, or an XTemplate definition string to use to process a
+ * {@link Ext.data.Model Model}'s {@link Ext.data.Model#data data} to produce a column's rendered value.
*/
- queryParam : 'query',
+ constructor: function(cfg){
+ var me = this,
+ tpl;
+
+ me.callParent(arguments);
+ tpl = me.tpl = (!Ext.isPrimitive(me.tpl) && me.tpl.compile) ? me.tpl : Ext.create('Ext.XTemplate', me.tpl);
+
+ me.renderer = function(value, p, record) {
+ var data = Ext.apply({}, record.data, record.getAssociatedData());
+ return tpl.apply(data);
+ };
+ }
+});
+
+/**
+ * @class Ext.grid.feature.Feature
+ * @extends Ext.util.Observable
+ *
+ * A feature is a type of plugin that is specific to the {@link Ext.grid.Panel}. It provides several
+ * hooks that allows the developer to inject additional functionality at certain points throughout the
+ * grid creation cycle. This class provides the base template methods that are available to the developer,
+ * it should be extended.
+ *
+ * There are several built in features that extend this class, for example:
+ *
+ * - {@link Ext.grid.feature.Grouping} - Shows grid rows in groups as specified by the {@link Ext.data.Store}
+ * - {@link Ext.grid.feature.RowBody} - Adds a body section for each grid row that can contain markup.
+ * - {@link Ext.grid.feature.Summary} - Adds a summary row at the bottom of the grid with aggregate totals for a column.
+ *
+ * ## Using Features
+ * A feature is added to the grid by specifying it an array of features in the configuration:
+ *
+ * var groupingFeature = Ext.create('Ext.grid.feature.Grouping');
+ * Ext.create('Ext.grid.Panel', {
+ * // other options
+ * features: [groupingFeature]
+ * });
+ *
+ * @abstract
+ */
+Ext.define('Ext.grid.feature.Feature', {
+ extend: 'Ext.util.Observable',
+ alias: 'feature.feature',
+
+ isFeature: true,
+ disabled: false,
+
/**
- * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies
- * when {@link #mode} = 'remote' (defaults to 'Loading...')
+ * @property {Boolean}
+ * Most features will expose additional events, some may not and will
+ * need to change this to false.
*/
- loadingText : 'Loading...',
+ hasFeatureEvent: true,
+
/**
- * @cfg {Boolean} resizable true to add a resize handle to the bottom of the dropdown list
- * (creates an {@link Ext.Resizable} with 'se' {@link Ext.Resizable#pinned pinned} handles).
- * Defaults to false.
+ * @property {String}
+ * Prefix to use when firing events on the view.
+ * For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick".
*/
- resizable : false,
+ eventPrefix: null,
+
/**
- * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if
- * {@link #resizable} = true (defaults to 8)
+ * @property {String}
+ * Selector used to determine when to fire the event with the eventPrefix.
*/
- handleHeight : 8,
+ eventSelector: null,
+
/**
- * @cfg {String} allQuery The text query to send to the server to return all records for the list
- * with no filtering (defaults to '')
+ * @property {Ext.view.Table}
+ * Reference to the TableView.
*/
- allQuery: '',
+ view: null,
+
/**
- * @cfg {String} mode Acceptable values are:
- *
- * - 'remote' : Default
- *
Automatically loads the {@link #store} the first time the trigger
- * is clicked. If you do not want the store to be automatically loaded the first time the trigger is
- * clicked, set to 'local' and manually load the store. To force a requery of the store
- * every time the trigger is clicked see {@link #lastQuery}.
- * - 'local' :
- *
ComboBox loads local data
- *
-var combo = new Ext.form.ComboBox({
- renderTo: document.body,
- mode: 'local',
- store: new Ext.data.ArrayStore({
- id: 0,
- fields: [
- 'myId', // numeric value is the key
- 'displayText'
- ],
- data: [[1, 'item1'], [2, 'item2']] // data is local
- }),
- valueField: 'myId',
- displayField: 'displayText',
- triggerAction: 'all'
-});
- *
- *
+ * @property {Ext.grid.Panel}
+ * Reference to the grid panel
*/
- mode: 'remote',
+ grid: null,
+
/**
- * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will
- * be ignored if {@link #listWidth} has a higher value)
+ * Most features will not modify the data returned to the view.
+ * This is limited to one feature that manipulates the data per grid view.
*/
- minListWidth : 70,
+ collectData: false,
+
+ getFeatureTpl: function() {
+ return '';
+ },
+
/**
- * @cfg {Boolean} forceSelection true to restrict the selected value to one of the values in the list,
- * false to allow the user to set arbitrary text into the field (defaults to false)
+ * Abstract method to be overriden when a feature should add additional
+ * arguments to its event signature. By default the event will fire:
+ * - view - The underlying Ext.view.Table
+ * - featureTarget - The matched element by the defined {@link eventSelector}
+ *
+ * The method must also return the eventName as the first index of the array
+ * to be passed to fireEvent.
*/
- forceSelection : false,
+ getFireEventArgs: function(eventName, view, featureTarget) {
+ return [eventName, view, featureTarget];
+ },
+
/**
- * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
- * if {@link #typeAhead} = true (defaults to 250)
+ * Approriate place to attach events to the view, selectionmodel, headerCt, etc
*/
- typeAheadDelay : 250,
+ attachEvents: function() {
+
+ },
+
+ getFragmentTpl: function() {
+ return;
+ },
+
/**
- * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
- * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this
- * default text is used, it means there is no value set and no validation will occur on this field.
+ * Allows a feature to mutate the metaRowTpl.
+ * The array received as a single argument can be manipulated to add things
+ * on the end/begining of a particular row.
*/
-
+ mutateMetaRowTpl: function(metaRowTplArray) {
+
+ },
+
/**
- * @cfg {Boolean} lazyInit true to not initialize the list for this combo until the field is focused
- * (defaults to true)
+ * Allows a feature to inject member methods into the metaRowTpl. This is
+ * important for embedding functionality which will become part of the proper
+ * row tpl.
*/
- lazyInit : true,
+ getMetaRowTplFragments: function() {
+ return {};
+ },
+ getTableFragments: function() {
+ return {};
+ },
+
/**
- * @cfg {Boolean} clearFilterOnReset true to clear any filters on the store (when in local mode) when reset is called
- * (defaults to true)
+ * Provide additional data to the prepareData call within the grid view.
+ * @param {Object} data The data for this particular record.
+ * @param {Number} idx The row index for this record.
+ * @param {Ext.data.Model} record The record instance
+ * @param {Object} orig The original result from the prepareData call to massage.
*/
- clearFilterOnReset : true,
-
+ getAdditionalData: function(data, idx, record, orig) {
+ return {};
+ },
+
/**
- * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
- * If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted.
- * Defaults to undefined.
+ * Enable a feature
*/
- submitValue: undefined,
-
+ enable: function() {
+ this.disabled = false;
+ },
+
/**
- * The value of the match string used to filter the store. Delete this property to force a requery.
- * Example use:
- *
-var combo = new Ext.form.ComboBox({
- ...
- mode: 'remote',
- ...
- listeners: {
- // delete the previous query in the beforequery event or set
- // combo.lastQuery = null (this will reload the store the next time it expands)
- beforequery: function(qe){
- delete qe.combo.lastQuery;
- }
+ * Disable a feature
+ */
+ disable: function() {
+ this.disabled = true;
}
+
});
- *
- * To make sure the filter in the store is not cleared the first time the ComboBox trigger is used
- * configure the combo with lastQuery=''. Example use:
- *
-var combo = new Ext.form.ComboBox({
- ...
- mode: 'local',
- triggerAction: 'all',
- lastQuery: ''
-});
- *
- * @property lastQuery
- * @type String
- */
-
- // private
- initComponent : function(){
- Ext.form.ComboBox.superclass.initComponent.call(this);
- this.addEvents(
- /**
- * @event expand
- * Fires when the dropdown list is expanded
- * @param {Ext.form.ComboBox} combo This combo box
- */
- 'expand',
- /**
- * @event collapse
- * Fires when the dropdown list is collapsed
- * @param {Ext.form.ComboBox} combo This combo box
- */
- 'collapse',
-
- /**
- * @event beforeselect
- * Fires before a list item is selected. Return false to cancel the selection.
- * @param {Ext.form.ComboBox} combo This combo box
- * @param {Ext.data.Record} record The data record returned from the underlying store
- * @param {Number} index The index of the selected item in the dropdown list
- */
- 'beforeselect',
- /**
- * @event select
- * Fires when a list item is selected
- * @param {Ext.form.ComboBox} combo This combo box
- * @param {Ext.data.Record} record The data record returned from the underlying store
- * @param {Number} index The index of the selected item in the dropdown list
- */
- 'select',
- /**
- * @event beforequery
- * Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
- * cancel property to true.
- * @param {Object} queryEvent An object that has these properties:
- * combo
: Ext.form.ComboBox This combo box
- * query
: String The query
- * forceAll
: Boolean True to force "all" query
- * cancel
: Boolean Set to true to cancel the query
- *
- */
- 'beforequery'
- );
- if(this.transform){
- var s = Ext.getDom(this.transform);
- if(!this.hiddenName){
- this.hiddenName = s.name;
- }
- if(!this.store){
- this.mode = 'local';
- var d = [], opts = s.options;
- for(var i = 0, len = opts.length;i < len; i++){
- var o = opts[i],
- value = (o.hasAttribute ? o.hasAttribute('value') : o.getAttributeNode('value').specified) ? o.value : o.text;
- if(o.selected && Ext.isEmpty(this.value, true)) {
- this.value = value;
- }
- d.push([value, o.text]);
- }
- this.store = new Ext.data.ArrayStore({
- 'id': 0,
- fields: ['value', 'text'],
- data : d,
- autoDestroy: true
- });
- this.valueField = 'value';
- this.displayField = 'text';
- }
- s.name = Ext.id(); // wipe out the name in case somewhere else they have a reference
- if(!this.lazyRender){
- this.target = true;
- this.el = Ext.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
- this.render(this.el.parentNode, s);
- }
- Ext.removeNode(s);
- }
- //auto-configure store from local array data
- else if(this.store){
- this.store = Ext.StoreMgr.lookup(this.store);
- if(this.store.autoCreated){
- this.displayField = this.valueField = 'field1';
- if(!this.store.expandData){
- this.displayField = 'field2';
- }
- this.mode = 'local';
- }
- }
-
- this.selectedIndex = -1;
- if(this.mode == 'local'){
- if(!Ext.isDefined(this.initialConfig.queryDelay)){
- this.queryDelay = 10;
- }
- if(!Ext.isDefined(this.initialConfig.minChars)){
- this.minChars = 0;
- }
- }
- },
-
- // private
- onRender : function(ct, position){
- if(this.hiddenName && !Ext.isDefined(this.submitValue)){
- this.submitValue = false;
- }
- Ext.form.ComboBox.superclass.onRender.call(this, ct, position);
- if(this.hiddenName){
- this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName,
- id: (this.hiddenId||this.hiddenName)}, 'before', true);
-
- }
- if(Ext.isGecko){
- this.el.dom.setAttribute('autocomplete', 'off');
- }
-
- if(!this.lazyInit){
- this.initList();
- }else{
- this.on('focus', this.initList, this, {single: true});
- }
- },
-
- // private
- initValue : function(){
- Ext.form.ComboBox.superclass.initValue.call(this);
- if(this.hiddenField){
- this.hiddenField.value =
- Ext.value(Ext.isDefined(this.hiddenValue) ? this.hiddenValue : this.value, '');
- }
- },
-
- getParentZIndex : function(){
- var zindex;
- if (this.ownerCt){
- this.findParentBy(function(ct){
- zindex = parseInt(ct.getPositionEl().getStyle('z-index'), 10);
- return !!zindex;
- });
- }
- return zindex;
- },
+/**
+ * A small abstract class that contains the shared behaviour for any summary
+ * calculations to be used in the grid.
+ * @class Ext.grid.feature.AbstractSummary
+ * @extends Ext.grid.feature.Feature
+ * @ignore
+ */
+Ext.define('Ext.grid.feature.AbstractSummary', {
- getZIndex : function(listParent){
- listParent = listParent || Ext.getDom(this.getListParent() || Ext.getBody());
- var zindex = parseInt(Ext.fly(listParent).getStyle('z-index'), 10);
- if(!zindex){
- zindex = this.getParentZIndex();
- }
- return (zindex || 12000) + 5;
- },
-
- // private
- initList : function(){
- if(!this.list){
- var cls = 'x-combo-list',
- listParent = Ext.getDom(this.getListParent() || Ext.getBody());
-
- this.list = new Ext.Layer({
- parentEl: listParent,
- shadow: this.shadow,
- cls: [cls, this.listClass].join(' '),
- constrain:false,
- zindex: this.getZIndex(listParent)
- });
-
- var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
- this.list.setSize(lw, 0);
- this.list.swallowEvent('mousewheel');
- this.assetHeight = 0;
- if(this.syncFont !== false){
- this.list.setStyle('font-size', this.el.getStyle('font-size'));
- }
- if(this.title){
- this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
- this.assetHeight += this.header.getHeight();
- }
-
- this.innerList = this.list.createChild({cls:cls+'-inner'});
- this.mon(this.innerList, 'mouseover', this.onViewOver, this);
- this.mon(this.innerList, 'mousemove', this.onViewMove, this);
- this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
-
- if(this.pageSize){
- this.footer = this.list.createChild({cls:cls+'-ft'});
- this.pageTb = new Ext.PagingToolbar({
- store: this.store,
- pageSize: this.pageSize,
- renderTo:this.footer
- });
- this.assetHeight += this.footer.getHeight();
- }
-
- if(!this.tpl){
- /**
- * @cfg {String/Ext.XTemplate} tpl The template string, or {@link Ext.XTemplate} instance to
- * use to display each item in the dropdown list. The dropdown list is displayed in a
- * DataView. See {@link #view}.
- * The default template string is:
- '<tpl for="."><div class="x-combo-list-item">{' + this.displayField + '}</div></tpl>'
- *
- * Override the default value to create custom UI layouts for items in the list.
- * For example:
- '<tpl for="."><div ext:qtip="{state}. {nick}" class="x-combo-list-item">{state}</div></tpl>'
- *
- * The template must contain one or more substitution parameters using field
- * names from the Combo's {@link #store Store}. In the example above an
- *
ext:qtip
attribute is added to display other fields from the Store.
- * To preserve the default visual look of list items, add the CSS class name
- *
x-combo-list-item
to the template's container element.
- * Also see {@link #itemSelector} for additional details.
- */
- this.tpl = '{' + this.displayField + '} ';
- /**
- * @cfg {String} itemSelector
- * A simple CSS selector (e.g. div.some-class or span:first-child) that will be
- * used to determine what nodes the {@link #view Ext.DataView} which handles the dropdown
- * display will be working with.
- * Note: this setting is required if a custom XTemplate has been
- * specified in {@link #tpl} which assigns a class other than
'x-combo-list-item'
- * to dropdown list items
- */
- }
-
- /**
- * The {@link Ext.DataView DataView} used to display the ComboBox's options.
- * @type Ext.DataView
- */
- this.view = new Ext.DataView({
- applyTo: this.innerList,
- tpl: this.tpl,
- singleSelect: true,
- selectedClass: this.selectedClass,
- itemSelector: this.itemSelector || '.' + cls + '-item',
- emptyText: this.listEmptyText,
- deferEmptyText: false
- });
-
- this.mon(this.view, {
- containerclick : this.onViewClick,
- click : this.onViewClick,
- scope :this
+ /* Begin Definitions */
+
+ extend: 'Ext.grid.feature.Feature',
+
+ alias: 'feature.abstractsummary',
+
+ /* End Definitions */
+
+ /**
+ * @cfg {Boolean} showSummaryRow True to show the summary row. Defaults to true.
+ */
+ showSummaryRow: true,
+
+ // @private
+ nestedIdRe: /\{\{id\}([\w\-]*)\}/g,
+
+ /**
+ * Toggle whether or not to show the summary row.
+ * @param {Boolan} visible True to show the summary row
+ */
+ toggleSummaryRow: function(visible){
+ this.showSummaryRow = !!visible;
+ },
+
+ /**
+ * Gets any fragments to be used in the tpl
+ * @private
+ * @return {Object} The fragments
+ */
+ getSummaryFragments: function(){
+ var fragments = {};
+ if (this.showSummaryRow) {
+ Ext.apply(fragments, {
+ printSummaryRow: Ext.bind(this.printSummaryRow, this)
});
-
- this.bindStore(this.store, true);
-
- if(this.resizable){
- this.resizer = new Ext.Resizable(this.list, {
- pinned:true, handles:'se'
- });
- this.mon(this.resizer, 'resize', function(r, w, h){
- this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
- this.listWidth = w;
- this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
- this.restrictHeight();
- }, this);
-
- this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
- }
}
+ return fragments;
},
-
+
/**
- * Returns the element used to house this ComboBox's pop-up list. Defaults to the document body.
- * A custom implementation may be provided as a configuration option if the floating list needs to be rendered
- * to a different Element. An example might be rendering the list inside a Menu so that clicking
- * the list does not hide the Menu:
-var store = new Ext.data.ArrayStore({
- autoDestroy: true,
- fields: ['initials', 'fullname'],
- data : [
- ['FF', 'Fred Flintstone'],
- ['BR', 'Barney Rubble']
- ]
-});
-
-var combo = new Ext.form.ComboBox({
- store: store,
- displayField: 'fullname',
- emptyText: 'Select a name...',
- forceSelection: true,
- getListParent: function() {
- return this.el.up('.x-menu');
- },
- iconCls: 'no-icon', //use iconCls if placing within menu to shift to right side of menu
- mode: 'local',
- selectOnFocus: true,
- triggerAction: 'all',
- typeAhead: true,
- width: 135
-});
-
-var menu = new Ext.menu.Menu({
- id: 'mainMenu',
- items: [
- combo // A Field in a Menu
- ]
-});
-
+ * Prints a summary row
+ * @private
+ * @param {Object} index The index in the template
+ * @return {String} The value of the summary row
*/
- getListParent : function() {
- return document.body;
+ printSummaryRow: function(index){
+ var inner = this.view.getTableChunker().metaRowTpl.join('');
+
+ inner = inner.replace('x-grid-row', 'x-grid-row-summary');
+ inner = inner.replace('{{id}}', '{gridSummaryValue}');
+ inner = inner.replace(this.nestedIdRe, '{id$1}');
+ inner = inner.replace('{[this.embedRowCls()]}', '{rowCls}');
+ inner = inner.replace('{[this.embedRowAttr()]}', '{rowAttr}');
+ inner = Ext.create('Ext.XTemplate', inner, {
+ firstOrLastCls: Ext.view.TableChunker.firstOrLastCls
+ });
+
+ return inner.applyTemplate({
+ columns: this.getPrintData(index)
+ });
},
-
+
/**
- * Returns the store associated with this combo.
- * @return {Ext.data.Store} The store
+ * Gets the value for the column from the attached data.
+ * @param {Ext.grid.column.Column} column The header
+ * @param {Object} data The current data
+ * @return {String} The value to be rendered
*/
- getStore : function(){
- return this.store;
+ getColumnValue: function(column, data){
+ var comp = Ext.getCmp(column.id),
+ value = data[column.dataIndex],
+ renderer = comp.summaryRenderer || comp.renderer;
+
+ if (renderer) {
+ value = renderer.call(comp.scope || this, value, data, column.dataIndex);
+ }
+ return value;
},
-
- // private
- bindStore : function(store, initial){
- if(this.store && !initial){
- if(this.store !== store && this.store.autoDestroy){
- this.store.destroy();
- }else{
- this.store.un('beforeload', this.onBeforeLoad, this);
- this.store.un('load', this.onLoad, this);
- this.store.un('exception', this.collapse, this);
+
+ /**
+ * Get the summary data for a field.
+ * @private
+ * @param {Ext.data.Store} store The store to get the data from
+ * @param {String/Function} type The type of aggregation. If a function is specified it will
+ * be passed to the stores aggregate function.
+ * @param {String} field The field to aggregate on
+ * @param {Boolean} group True to aggregate in grouped mode
+ * @return {Mixed} See the return type for the store functions.
+ */
+ getSummary: function(store, type, field, group){
+ if (type) {
+ if (Ext.isFunction(type)) {
+ return store.aggregate(type, null, group);
}
- if(!store){
- this.store = null;
- if(this.view){
- this.view.bindStore(null);
- }
- if(this.pageTb){
- this.pageTb.bindStore(null);
- }
+
+ switch (type) {
+ case 'count':
+ return store.count(group);
+ case 'min':
+ return store.min(field, group);
+ case 'max':
+ return store.max(field, group);
+ case 'sum':
+ return store.sum(field, group);
+ case 'average':
+ return store.average(field, group);
+ default:
+ return group ? {} : '';
+
}
}
- if(store){
- if(!initial) {
- this.lastQuery = null;
- if(this.pageTb) {
- this.pageTb.bindStore(store);
- }
- }
-
- this.store = Ext.StoreMgr.lookup(store);
- this.store.on({
- scope: this,
- beforeload: this.onBeforeLoad,
- load: this.onLoad,
- exception: this.collapse
- });
+ }
+
+});
- if(this.view){
- this.view.bindStore(store);
+/**
+ * @class Ext.grid.feature.Chunking
+ * @extends Ext.grid.feature.Feature
+ */
+Ext.define('Ext.grid.feature.Chunking', {
+ extend: 'Ext.grid.feature.Feature',
+ alias: 'feature.chunking',
+
+ chunkSize: 20,
+ rowHeight: Ext.isIE ? 27 : 26,
+ visibleChunk: 0,
+ hasFeatureEvent: false,
+ attachEvents: function() {
+ var grid = this.view.up('gridpanel'),
+ scroller = grid.down('gridscroller[dock=right]');
+ scroller.el.on('scroll', this.onBodyScroll, this, {buffer: 300});
+ //this.view.on('bodyscroll', this.onBodyScroll, this, {buffer: 300});
+ },
+
+ onBodyScroll: function(e, t) {
+ var view = this.view,
+ top = t.scrollTop,
+ nextChunk = Math.floor(top / this.rowHeight / this.chunkSize);
+ if (nextChunk !== this.visibleChunk) {
+
+ this.visibleChunk = nextChunk;
+ view.refresh();
+ view.el.dom.scrollTop = top;
+ //BrowserBug: IE6,7,8 quirks mode takes setting scrollTop 2x.
+ view.el.dom.scrollTop = top;
+ }
+ },
+
+ collectData: function(records, preppedRecords, startIndex, fullWidth, orig) {
+ var o = {
+ fullWidth: orig.fullWidth,
+ chunks: []
+ },
+ //headerCt = this.view.headerCt,
+ //colums = headerCt.getColumnsForTpl(),
+ recordCount = orig.rows.length,
+ start = 0,
+ i = 0,
+ visibleChunk = this.visibleChunk,
+ chunk,
+ rows,
+ chunkLength;
+
+ for (; start < recordCount; start+=this.chunkSize, i++) {
+ if (start+this.chunkSize > recordCount) {
+ chunkLength = recordCount - start;
+ } else {
+ chunkLength = this.chunkSize;
+ }
+
+ if (i >= visibleChunk - 1 && i <= visibleChunk + 1) {
+ rows = orig.rows.slice(start, start+this.chunkSize);
+ } else {
+ rows = [];
}
+ o.chunks.push({
+ rows: rows,
+ fullWidth: fullWidth,
+ chunkHeight: chunkLength * this.rowHeight
+ });
}
+
+
+ return o;
},
+
+ getTableFragments: function() {
+ return {
+ openTableWrap: function() {
+ return '';
+ },
+ closeTableWrap: function() {
+ return ' ';
+ }
+ };
+ }
+});
- reset : function(){
- Ext.form.ComboBox.superclass.reset.call(this);
- if(this.clearFilterOnReset && this.mode == 'local'){
- this.store.clearFilter();
- }
+/**
+ * @class Ext.grid.feature.Grouping
+ * @extends Ext.grid.feature.Feature
+ *
+ * This feature allows to display the grid rows aggregated into groups as specified by the {@link Ext.data.Store#groupers}
+ * specified on the Store. The group will show the title for the group name and then the appropriate records for the group
+ * underneath. The groups can also be expanded and collapsed.
+ *
+ * ## Extra Events
+ * This feature adds several extra events that will be fired on the grid to interact with the groups:
+ *
+ * - {@link #groupclick}
+ * - {@link #groupdblclick}
+ * - {@link #groupcontextmenu}
+ * - {@link #groupexpand}
+ * - {@link #groupcollapse}
+ *
+ * ## Menu Augmentation
+ * This feature adds extra options to the grid column menu to provide the user with functionality to modify the grouping.
+ * This can be disabled by setting the {@link #enableGroupingMenu} option. The option to disallow grouping from being turned off
+ * by thew user is {@link #enableNoGroups}.
+ *
+ * ## Controlling Group Text
+ * The {@link #groupHeaderTpl} is used to control the rendered title for each group. It can modified to customized
+ * the default display.
+ *
+ * ## Example Usage
+ *
+ * var groupingFeature = Ext.create('Ext.grid.feature.Grouping', {
+ * groupHeaderTpl: 'Group: {name} ({rows.length})', //print the number of items in the group
+ * startCollapsed: true // start all groups collapsed
+ * });
+ *
+ * @ftype grouping
+ * @author Nicolas Ferrero
+ */
+Ext.define('Ext.grid.feature.Grouping', {
+ extend: 'Ext.grid.feature.Feature',
+ alias: 'feature.grouping',
+
+ eventPrefix: 'group',
+ eventSelector: '.' + Ext.baseCSSPrefix + 'grid-group-hd',
+
+ constructor: function() {
+ this.collapsedState = {};
+ this.callParent(arguments);
},
+
+ /**
+ * @event groupclick
+ * @param {Ext.view.Table} view
+ * @param {HTMLElement} node
+ * @param {Number} unused
+ * @param {Number} unused
+ * @param {Ext.EventObject} e
+ */
- // private
- initEvents : function(){
- Ext.form.ComboBox.superclass.initEvents.call(this);
+ /**
+ * @event groupdblclick
+ * @param {Ext.view.Table} view
+ * @param {HTMLElement} node
+ * @param {Number} unused
+ * @param {Number} unused
+ * @param {Ext.EventObject} e
+ */
- /**
- * @property keyNav
- * @type Ext.KeyNav
- * A {@link Ext.KeyNav KeyNav} object which handles navigation keys for this ComboBox. This performs actions
- * based on keystrokes typed when the input field is focused.
- * After the ComboBox has been rendered, you may override existing navigation key functionality,
- * or add your own based upon key names as specified in the {@link Ext.KeyNav KeyNav} class.
- * The function is executed in the scope (this
reference of the ComboBox. Example:
-myCombo.keyNav.esc = function(e) { // Override ESC handling function
- this.collapse(); // Standard behaviour of Ext's ComboBox.
- this.setValue(this.startValue); // We reset to starting value on ESC
-};
-myCombo.keyNav.tab = function() { // Override TAB handling function
- this.onViewClick(false); // Select the currently highlighted row
-};
-
- */
- this.keyNav = new Ext.KeyNav(this.el, {
- "up" : function(e){
- this.inKeyMode = true;
- this.selectPrev();
- },
+ /**
+ * @event groupcontextmenu
+ * @param {Ext.view.Table} view
+ * @param {HTMLElement} node
+ * @param {Number} unused
+ * @param {Number} unused
+ * @param {Ext.EventObject} e
+ */
- "down" : function(e){
- if(!this.isExpanded()){
- this.onTriggerClick();
- }else{
- this.inKeyMode = true;
- this.selectNext();
- }
- },
+ /**
+ * @event groupcollapse
+ * @param {Ext.view.Table} view
+ * @param {HTMLElement} node
+ * @param {Number} unused
+ * @param {Number} unused
+ * @param {Ext.EventObject} e
+ */
- "enter" : function(e){
- this.onViewClick();
- },
+ /**
+ * @event groupexpand
+ * @param {Ext.view.Table} view
+ * @param {HTMLElement} node
+ * @param {Number} unused
+ * @param {Number} unused
+ * @param {Ext.EventObject} e
+ */
- "esc" : function(e){
- this.collapse();
- },
+ /**
+ * @cfg {String} groupHeaderTpl
+ * Template snippet, this cannot be an actual template. {name} will be replaced with the current group.
+ * Defaults to 'Group: {name}'
+ */
+ groupHeaderTpl: 'Group: {name}',
- "tab" : function(e){
- if (this.forceSelection === true) {
- this.collapse();
- } else {
- this.onViewClick(false);
- }
- return true;
- },
+ /**
+ * @cfg {Number} depthToIndent
+ * Number of pixels to indent per grouping level
+ */
+ depthToIndent: 17,
- scope : this,
+ collapsedCls: Ext.baseCSSPrefix + 'grid-group-collapsed',
+ hdCollapsedCls: Ext.baseCSSPrefix + 'grid-group-hd-collapsed',
- doRelay : function(e, h, hname){
- if(hname == 'down' || this.scope.isExpanded()){
- // this MUST be called before ComboBox#fireKey()
- var relay = Ext.KeyNav.prototype.doRelay.apply(this, arguments);
- if(!Ext.isIE && Ext.EventManager.useKeydown){
- // call Combo#fireKey() for browsers which use keydown event (except IE)
- this.scope.fireKey(e);
- }
- return relay;
- }
- return true;
- },
+ /**
+ * @cfg {String} groupByText Text displayed in the grid header menu for grouping by header
+ * (defaults to 'Group By This Field').
+ */
+ groupByText : 'Group By This Field',
+ /**
+ * @cfg {String} showGroupsText Text displayed in the grid header for enabling/disabling grouping
+ * (defaults to 'Show in Groups').
+ */
+ showGroupsText : 'Show in Groups',
- forceKeyDown : true,
- defaultEventAction: 'stopEvent'
- });
- this.queryDelay = Math.max(this.queryDelay || 10,
- this.mode == 'local' ? 10 : 250);
- this.dqTask = new Ext.util.DelayedTask(this.initQuery, this);
- if(this.typeAhead){
- this.taTask = new Ext.util.DelayedTask(this.onTypeAhead, this);
- }
- if(!this.enableKeyEvents){
- this.mon(this.el, 'keyup', this.onKeyUp, this);
- }
- },
+ /**
+ * @cfg {Boolean} hideGroupedHeadertrue to hide the header that is currently grouped (defaults to false)
+ */
+ hideGroupedHeader : false,
+ /**
+ * @cfg {Boolean} startCollapsed true to start all groups collapsed (defaults to false)
+ */
+ startCollapsed : false,
- // private
- onDestroy : function(){
- if (this.dqTask){
- this.dqTask.cancel();
- this.dqTask = null;
- }
- this.bindStore(null);
- Ext.destroy(
- this.resizer,
- this.view,
- this.pageTb,
- this.list
- );
- Ext.destroyMembers(this, 'hiddenField');
- Ext.form.ComboBox.superclass.onDestroy.call(this);
- },
+ /**
+ * @cfg {Boolean} enableGroupingMenu true to enable the grouping control in the header menu (defaults to true)
+ */
+ enableGroupingMenu : true,
- // private
- fireKey : function(e){
- if (!this.isExpanded()) {
- Ext.form.ComboBox.superclass.fireKey.call(this, e);
+ /**
+ * @cfg {Boolean} enableNoGroups true to allow the user to turn off grouping (defaults to true)
+ */
+ enableNoGroups : true,
+
+ enable: function() {
+ var me = this,
+ view = me.view,
+ store = view.store,
+ groupToggleMenuItem;
+
+ if (me.lastGroupIndex) {
+ store.group(me.lastGroupIndex);
}
+ me.callParent();
+ groupToggleMenuItem = me.view.headerCt.getMenu().down('#groupToggleMenuItem');
+ groupToggleMenuItem.setChecked(true, true);
+ view.refresh();
},
- // private
- onResize : function(w, h){
- Ext.form.ComboBox.superclass.onResize.apply(this, arguments);
- if(!isNaN(w) && this.isVisible() && this.list){
- this.doResize(w);
- }else{
- this.bufferSize = w;
+ disable: function() {
+ var me = this,
+ view = me.view,
+ store = view.store,
+ groupToggleMenuItem,
+ lastGroup;
+
+ lastGroup = store.groupers.first();
+ if (lastGroup) {
+ me.lastGroupIndex = lastGroup.property;
+ store.groupers.clear();
}
+
+ me.callParent();
+ groupToggleMenuItem = me.view.headerCt.getMenu().down('#groupToggleMenuItem');
+ groupToggleMenuItem.setChecked(true, true);
+ groupToggleMenuItem.setChecked(false, true);
+ view.refresh();
},
- doResize: function(w){
- if(!Ext.isDefined(this.listWidth)){
- var lw = Math.max(w, this.minListWidth);
- this.list.setWidth(lw);
- this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
- }
+ getFeatureTpl: function(values, parent, x, xcount) {
+ var me = this;
+
+ return [
+ '',
+ // group row tpl
+ '{collapsed}' + me.groupHeaderTpl + ' ',
+ // this is the rowbody
+ '{[this.recurse(values)]} ',
+ ' '
+ ].join('');
},
- // private
- onEnable : function(){
- Ext.form.ComboBox.superclass.onEnable.apply(this, arguments);
- if(this.hiddenField){
- this.hiddenField.disabled = false;
- }
+ getFragmentTpl: function() {
+ return {
+ indentByDepth: this.indentByDepth,
+ depthToIndent: this.depthToIndent
+ };
},
- // private
- onDisable : function(){
- Ext.form.ComboBox.superclass.onDisable.apply(this, arguments);
- if(this.hiddenField){
- this.hiddenField.disabled = true;
- }
+ indentByDepth: function(values) {
+ var depth = values.depth || 0;
+ return 'style="padding-left:'+ depth * this.depthToIndent + 'px;"';
},
- // private
- onBeforeLoad : function(){
- if(!this.hasFocus){
- return;
- }
- this.innerList.update(this.loadingText ?
- ''+this.loadingText+'' : '');
- this.restrictHeight();
- this.selectedIndex = -1;
+ // Containers holding these components are responsible for
+ // destroying them, we are just deleting references.
+ destroy: function() {
+ var me = this;
+
+ delete me.view;
+ delete me.prunedHeader;
},
- // private
- onLoad : function(){
- if(!this.hasFocus){
- return;
- }
- if(this.store.getCount() > 0 || this.listEmptyText){
- this.expand();
- this.restrictHeight();
- if(this.lastQuery == this.allQuery){
- if(this.editable){
- this.el.dom.select();
- }
+ // perhaps rename to afterViewRender
+ attachEvents: function() {
+ var me = this,
+ view = me.view,
+ header, headerId, menu, menuItem;
- if(this.autoSelect !== false && !this.selectByValue(this.value, true)){
- this.select(0, true);
- }
- }else{
- if(this.autoSelect !== false){
- this.selectNext();
- }
- if(this.typeAhead && this.lastKey != Ext.EventObject.BACKSPACE && this.lastKey != Ext.EventObject.DELETE){
- this.taTask.delay(this.typeAheadDelay);
- }
- }
- }else{
- this.collapse();
- }
+ view.on({
+ scope: me,
+ groupclick: me.onGroupClick,
+ rowfocus: me.onRowFocus
+ });
+ view.store.on('groupchange', me.onGroupChange, me);
- },
+ me.pruneGroupedHeader();
- // private
- onTypeAhead : function(){
- if(this.store.getCount() > 0){
- var r = this.store.getAt(0);
- var newValue = r.data[this.displayField];
- var len = newValue.length;
- var selStart = this.getRawValue().length;
- if(selStart != len){
- this.setRawValue(newValue);
- this.selectText(selStart, newValue.length);
- }
+ if (me.enableGroupingMenu) {
+ me.injectGroupingMenu();
}
- },
- // private
- assertValue : function(){
- var val = this.getRawValue(),
- rec = this.findRecord(this.displayField, val);
-
- if(!rec && this.forceSelection){
- if(val.length > 0 && val != this.emptyText){
- this.el.dom.value = Ext.value(this.lastSelectionText, '');
- this.applyEmptyText();
- }else{
- this.clearValue();
- }
- }else{
- if(rec){
- // onSelect may have already set the value and by doing so
- // set the display field properly. Let's not wipe out the
- // valueField here by just sending the displayField.
- if (val == rec.get(this.displayField) && this.value == rec.get(this.valueField)){
- return;
- }
- val = rec.get(this.valueField || this.displayField);
+ if (me.hideGroupedHeader) {
+ header = view.headerCt.down('gridcolumn[dataIndex=' + me.getGroupField() + ']');
+ headerId = header.id;
+ menu = view.headerCt.getMenu();
+ menuItem = menu.down('menuitem[headerId='+ headerId +']');
+ if (menuItem) {
+ menuItem.setChecked(false);
}
- this.setValue(val);
}
},
-
- // private
- onSelect : function(record, index){
- if(this.fireEvent('beforeselect', this, record, index) !== false){
- this.setValue(record.data[this.valueField || this.displayField]);
- this.collapse();
- this.fireEvent('select', this, record, index);
- }
+
+ injectGroupingMenu: function() {
+ var me = this,
+ view = me.view,
+ headerCt = view.headerCt;
+ headerCt.showMenuBy = me.showMenuBy;
+ headerCt.getMenuItems = me.getMenuItems();
},
-
- // inherit docs
- getName: function(){
- var hf = this.hiddenField;
- return hf && hf.name ? hf.name : this.hiddenName || Ext.form.ComboBox.superclass.getName.call(this);
+
+ showMenuBy: function(t, header) {
+ var menu = this.getMenu(),
+ groupMenuItem = menu.down('#groupMenuItem'),
+ groupableMth = header.groupable === false ? 'disable' : 'enable';
+
+ groupMenuItem[groupableMth]();
+ Ext.grid.header.Container.prototype.showMenuBy.apply(this, arguments);
+ },
+
+ getMenuItems: function() {
+ var me = this,
+ groupByText = me.groupByText,
+ disabled = me.disabled,
+ showGroupsText = me.showGroupsText,
+ enableNoGroups = me.enableNoGroups,
+ groupMenuItemClick = Ext.Function.bind(me.onGroupMenuItemClick, me),
+ groupToggleMenuItemClick = Ext.Function.bind(me.onGroupToggleMenuItemClick, me)
+
+ // runs in the scope of headerCt
+ return function() {
+ var o = Ext.grid.header.Container.prototype.getMenuItems.call(this);
+ o.push('-', {
+ itemId: 'groupMenuItem',
+ text: groupByText,
+ handler: groupMenuItemClick
+ });
+ if (enableNoGroups) {
+ o.push({
+ itemId: 'groupToggleMenuItem',
+ text: showGroupsText,
+ checked: !disabled,
+ checkHandler: groupToggleMenuItemClick
+ });
+ }
+ return o;
+ };
},
+
/**
- * Returns the currently selected field value or empty string if no value is set.
- * @return {String} value The selected value
+ * Group by the header the user has clicked on.
+ * @private
*/
- getValue : function(){
- if(this.valueField){
- return Ext.isDefined(this.value) ? this.value : '';
- }else{
- return Ext.form.ComboBox.superclass.getValue.call(this);
- }
+ onGroupMenuItemClick: function(menuItem, e) {
+ var menu = menuItem.parentMenu,
+ hdr = menu.activeHeader,
+ view = this.view;
+
+ delete this.lastGroupIndex;
+ this.enable();
+ view.store.group(hdr.dataIndex);
+ this.pruneGroupedHeader();
+
},
/**
- * Clears any text/value currently set in the field
+ * Turn on and off grouping via the menu
+ * @private
*/
- clearValue : function(){
- if(this.hiddenField){
- this.hiddenField.value = '';
- }
- this.setRawValue('');
- this.lastSelectionText = '';
- this.applyEmptyText();
- this.value = '';
+ onGroupToggleMenuItemClick: function(menuItem, checked) {
+ this[checked ? 'enable' : 'disable']();
},
/**
- * Sets the specified value into the field. If the value finds a match, the corresponding record text
- * will be displayed in the field. If the value does not match the data value of an existing item,
- * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
- * Otherwise the field will be blank (although the value will still be set).
- * @param {String} value The value to match
- * @return {Ext.form.Field} this
+ * Prunes the grouped header from the header container
+ * @private
*/
- setValue : function(v){
- var text = v;
- if(this.valueField){
- var r = this.findRecord(this.valueField, v);
- if(r){
- text = r.data[this.displayField];
- }else if(Ext.isDefined(this.valueNotFoundText)){
- text = this.valueNotFoundText;
+ pruneGroupedHeader: function() {
+ var me = this,
+ view = me.view,
+ store = view.store,
+ groupField = me.getGroupField(),
+ headerCt = view.headerCt,
+ header = headerCt.down('header[dataIndex=' + groupField + ']');
+
+ if (header) {
+ if (me.prunedHeader) {
+ me.prunedHeader.show();
}
+ me.prunedHeader = header;
+ header.hide();
}
- this.lastSelectionText = text;
- if(this.hiddenField){
- this.hiddenField.value = Ext.value(v, '');
- }
- Ext.form.ComboBox.superclass.setValue.call(this, text);
- this.value = v;
- return this;
},
- // private
- findRecord : function(prop, value){
- var record;
- if(this.store.getCount() > 0){
- this.store.each(function(r){
- if(r.data[prop] == value){
- record = r;
- return false;
- }
- });
+ getGroupField: function(){
+ var group = this.view.store.groupers.first();
+ if (group) {
+ return group.property;
}
- return record;
- },
-
- // private
- onViewMove : function(e, t){
- this.inKeyMode = false;
+ return '';
},
- // private
- onViewOver : function(e, t){
- if(this.inKeyMode){ // prevent key nav and mouse over conflicts
- return;
- }
- var item = this.view.findItemFromChild(t);
- if(item){
- var index = this.view.indexOf(item);
- this.select(index, false);
- }
- },
+ /**
+ * When a row gains focus, expand the groups above it
+ * @private
+ */
+ onRowFocus: function(rowIdx) {
+ var node = this.view.getNode(rowIdx),
+ groupBd = Ext.fly(node).up('.' + this.collapsedCls);
- // private
- onViewClick : function(doFocus){
- var index = this.view.getSelectedIndexes()[0],
- s = this.store,
- r = s.getAt(index);
- if(r){
- this.onSelect(r, index);
- }else {
- this.collapse();
- }
- if(doFocus !== false){
- this.el.focus();
+ if (groupBd) {
+ // for multiple level groups, should expand every groupBd
+ // above
+ this.expand(groupBd);
}
},
+ /**
+ * Expand a group by the groupBody
+ * @param {Ext.core.Element} groupBd
+ * @private
+ */
+ expand: function(groupBd) {
+ var me = this,
+ view = me.view,
+ grid = view.up('gridpanel'),
+ groupBdDom = Ext.getDom(groupBd);
+
+ me.collapsedState[groupBdDom.id] = false;
- // private
- restrictHeight : function(){
- this.innerList.dom.style.height = '';
- var inner = this.innerList.dom,
- pad = this.list.getFrameWidth('tb') + (this.resizable ? this.handleHeight : 0) + this.assetHeight,
- h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight),
- ha = this.getPosition()[1]-Ext.getBody().getScroll().top,
- hb = Ext.lib.Dom.getViewHeight()-ha-this.getSize().height,
- space = Math.max(ha, hb, this.minHeight || 0)-this.list.shadowOffset-pad-5;
-
- h = Math.min(h, space, this.maxHeight);
+ groupBd.removeCls(me.collapsedCls);
+ groupBd.prev().removeCls(me.hdCollapsedCls);
- this.innerList.setHeight(h);
- this.list.beginUpdate();
- this.list.setHeight(h+pad);
- this.list.alignTo.apply(this.list, [this.el].concat(this.listAlign));
- this.list.endUpdate();
+ grid.determineScrollbars();
+ grid.invalidateScroller();
+ view.fireEvent('groupexpand');
},
/**
- * Returns true if the dropdown list is expanded, else false.
+ * Collapse a group by the groupBody
+ * @param {Ext.core.Element} groupBd
+ * @private
*/
- isExpanded : function(){
- return this.list && this.list.isVisible();
- },
+ collapse: function(groupBd) {
+ var me = this,
+ view = me.view,
+ grid = view.up('gridpanel'),
+ groupBdDom = Ext.getDom(groupBd);
+
+ me.collapsedState[groupBdDom.id] = true;
- /**
- * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
- * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
- * @param {String} value The data value of the item to select
- * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
- * selected item if it is not currently in view (defaults to true)
- * @return {Boolean} True if the value matched an item in the list, else false
- */
- selectByValue : function(v, scrollIntoView){
- if(!Ext.isEmpty(v, true)){
- var r = this.findRecord(this.valueField || this.displayField, v);
- if(r){
- this.select(this.store.indexOf(r), scrollIntoView);
- return true;
- }
- }
- return false;
+ groupBd.addCls(me.collapsedCls);
+ groupBd.prev().addCls(me.hdCollapsedCls);
+
+ grid.determineScrollbars();
+ grid.invalidateScroller();
+ view.fireEvent('groupcollapse');
+ },
+
+ onGroupChange: function(){
+ this.view.refresh();
},
/**
- * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
- * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
- * @param {Number} index The zero-based index of the list item to select
- * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
- * selected item if it is not currently in view (defaults to true)
+ * Toggle between expanded/collapsed state when clicking on
+ * the group.
+ * @private
*/
- select : function(index, scrollIntoView){
- this.selectedIndex = index;
- this.view.select(index);
- if(scrollIntoView !== false){
- var el = this.view.getNode(index);
- if(el){
- this.innerList.scrollChildIntoView(el, false);
- }
- }
-
- },
+ onGroupClick: function(view, group, idx, foo, e) {
+ var me = this,
+ toggleCls = me.toggleCls,
+ groupBd = Ext.fly(group.nextSibling, '_grouping');
- // private
- selectNext : function(){
- var ct = this.store.getCount();
- if(ct > 0){
- if(this.selectedIndex == -1){
- this.select(0);
- }else if(this.selectedIndex < ct-1){
- this.select(this.selectedIndex+1);
- }
+ if (groupBd.hasCls(me.collapsedCls)) {
+ me.expand(groupBd);
+ } else {
+ me.collapse(groupBd);
}
},
- // private
- selectPrev : function(){
- var ct = this.store.getCount();
- if(ct > 0){
- if(this.selectedIndex == -1){
- this.select(0);
- }else if(this.selectedIndex !== 0){
- this.select(this.selectedIndex-1);
- }
- }
+ // Injects isRow and closeRow into the metaRowTpl.
+ getMetaRowTplFragments: function() {
+ return {
+ isRow: this.isRow,
+ closeRow: this.closeRow
+ };
},
- // private
- onKeyUp : function(e){
- var k = e.getKey();
- if(this.editable !== false && this.readOnly !== true && (k == e.BACKSPACE || !e.isSpecialKey())){
-
- this.lastKey = k;
- this.dqTask.delay(this.queryDelay);
- }
- Ext.form.ComboBox.superclass.onKeyUp.call(this, e);
+ // injected into rowtpl and wrapped around metaRowTpl
+ // becomes part of the standard tpl
+ isRow: function() {
+ return '';
},
- // private
- validateBlur : function(){
- return !this.list || !this.list.isVisible();
+ // injected into rowtpl and wrapped around metaRowTpl
+ // becomes part of the standard tpl
+ closeRow: function() {
+ return ' ';
},
- // private
- initQuery : function(){
- this.doQuery(this.getRawValue());
+ // isRow and closeRow are injected via getMetaRowTplFragments
+ mutateMetaRowTpl: function(metaRowTpl) {
+ metaRowTpl.unshift('{[this.isRow()]}');
+ metaRowTpl.push('{[this.closeRow()]}');
},
- // private
- beforeBlur : function(){
- this.assertValue();
- },
+ // injects an additional style attribute via tdAttrKey with the proper
+ // amount of padding
+ getAdditionalData: function(data, idx, record, orig) {
+ var view = this.view,
+ hCt = view.headerCt,
+ col = hCt.items.getAt(0),
+ o = {},
+ tdAttrKey = col.id + '-tdAttr';
- // private
- postBlur : function(){
- Ext.form.ComboBox.superclass.postBlur.call(this);
- this.collapse();
- this.inKeyMode = false;
+ // maintain the current tdAttr that a user may ahve set.
+ o[tdAttrKey] = this.indentByDepth(data) + " " + (orig[tdAttrKey] ? orig[tdAttrKey] : '');
+ o.collapsed = 'true';
+ return o;
},
- /**
- * Execute a query to filter the dropdown list. Fires the {@link #beforequery} event prior to performing the
- * query allowing the query action to be canceled if needed.
- * @param {String} query The SQL query to execute
- * @param {Boolean} forceAll true to force the query to execute even if there are currently fewer
- * characters in the field than the minimum specified by the {@link #minChars} config option. It
- * also clears any filter previously saved in the current store (defaults to false)
- */
- doQuery : function(q, forceAll){
- q = Ext.isEmpty(q) ? '' : q;
- var qe = {
- query: q,
- forceAll: forceAll,
- combo: this,
- cancel:false
- };
- if(this.fireEvent('beforequery', qe)===false || qe.cancel){
- return false;
- }
- q = qe.query;
- forceAll = qe.forceAll;
- if(forceAll === true || (q.length >= this.minChars)){
- if(this.lastQuery !== q){
- this.lastQuery = q;
- if(this.mode == 'local'){
- this.selectedIndex = -1;
- if(forceAll){
- this.store.clearFilter();
- }else{
- this.store.filter(this.displayField, q);
- }
- this.onLoad();
- }else{
- this.store.baseParams[this.queryParam] = q;
- this.store.load({
- params: this.getParams(q)
- });
- this.expand();
- }
- }else{
- this.selectedIndex = -1;
- this.onLoad();
+ // return matching preppedRecords
+ getGroupRows: function(group, records, preppedRecords, fullWidth) {
+ var me = this,
+ children = group.children,
+ rows = group.rows = [],
+ view = me.view;
+ group.viewId = view.id;
+
+ Ext.Array.each(records, function(record, idx) {
+ if (Ext.Array.indexOf(children, record) != -1) {
+ rows.push(Ext.apply(preppedRecords[idx], {
+ depth: 1
+ }));
}
+ });
+ delete group.children;
+ group.fullWidth = fullWidth;
+ if (me.collapsedState[view.id + '-gp-' + group.name]) {
+ group.collapsedCls = me.collapsedCls;
+ group.hdCollapsedCls = me.hdCollapsedCls;
}
+
+ return group;
},
- // private
- getParams : function(q){
- var p = {};
- //p[this.queryParam] = q;
- if(this.pageSize){
- p.start = 0;
- p.limit = this.pageSize;
+ // return the data in a grouped format.
+ collectData: function(records, preppedRecords, startIndex, fullWidth, o) {
+ var me = this,
+ store = me.view.store,
+ groups;
+
+ if (!me.disabled && store.isGrouped()) {
+ groups = store.getGroups();
+ Ext.Array.each(groups, function(group, idx){
+ me.getGroupRows(group, records, preppedRecords, fullWidth);
+ }, me);
+ return {
+ rows: groups,
+ fullWidth: fullWidth
+ };
}
- return p;
+ return o;
+ },
+
+ // adds the groupName to the groupclick, groupdblclick, groupcontextmenu
+ // events that are fired on the view. Chose not to return the actual
+ // group itself because of its expense and because developers can simply
+ // grab the group via store.getGroups(groupName)
+ getFireEventArgs: function(type, view, featureTarget) {
+ var returnArray = [type, view, featureTarget],
+ groupBd = Ext.fly(featureTarget.nextSibling, '_grouping'),
+ groupBdId = Ext.getDom(groupBd).id,
+ prefix = view.id + '-gp-',
+ groupName = groupBdId.substr(prefix.length);
+
+ returnArray.push(groupName);
+
+ return returnArray;
+ }
+});
+
+/**
+ * @class Ext.grid.feature.GroupingSummary
+ * @extends Ext.grid.feature.Grouping
+ *
+ * This feature adds an aggregate summary row at the bottom of each group that is provided
+ * by the {@link Ext.grid.feature.Grouping} feature. There are 2 aspects to the summary:
+ *
+ * ## Calculation
+ *
+ * The summary value needs to be calculated for each column in the grid. This is controlled
+ * by the summaryType option specified on the column. There are several built in summary types,
+ * which can be specified as a string on the column configuration. These call underlying methods
+ * on the store:
+ *
+ * - {@link Ext.data.Store#count count}
+ * - {@link Ext.data.Store#sum sum}
+ * - {@link Ext.data.Store#min min}
+ * - {@link Ext.data.Store#max max}
+ * - {@link Ext.data.Store#average average}
+ *
+ * Alternatively, the summaryType can be a function definition. If this is the case,
+ * the function is called with an array of records to calculate the summary value.
+ *
+ * ## Rendering
+ *
+ * Similar to a column, the summary also supports a summaryRenderer function. This
+ * summaryRenderer is called before displaying a value. The function is optional, if
+ * not specified the default calculated value is shown. The summaryRenderer is called with:
+ *
+ * - value {Object} - The calculated value.
+ * - data {Object} - Contains all raw summary values for the row.
+ * - field {String} - The name of the field we are calculating
+ *
+ * ## Example Usage
+ *
+ * Ext.define('TestResult', {
+ * extend: 'Ext.data.Model',
+ * fields: ['student', 'subject', {
+ * name: 'mark',
+ * type: 'int'
+ * }]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * width: 200,
+ * height: 240,
+ * renderTo: document.body,
+ * features: [{
+ * groupHeaderTpl: 'Subject: {name}',
+ * ftype: 'groupingsummary'
+ * }],
+ * store: {
+ * model: 'TestResult',
+ * groupField: 'subject',
+ * data: [{
+ * student: 'Student 1',
+ * subject: 'Math',
+ * mark: 84
+ * },{
+ * student: 'Student 1',
+ * subject: 'Science',
+ * mark: 72
+ * },{
+ * student: 'Student 2',
+ * subject: 'Math',
+ * mark: 96
+ * },{
+ * student: 'Student 2',
+ * subject: 'Science',
+ * mark: 68
+ * }]
+ * },
+ * columns: [{
+ * dataIndex: 'student',
+ * text: 'Name',
+ * summaryType: 'count',
+ * summaryRenderer: function(value){
+ * return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : '');
+ * }
+ * }, {
+ * dataIndex: 'mark',
+ * text: 'Mark',
+ * summaryType: 'average'
+ * }]
+ * });
+ */
+Ext.define('Ext.grid.feature.GroupingSummary', {
+
+ /* Begin Definitions */
+
+ extend: 'Ext.grid.feature.Grouping',
+
+ alias: 'feature.groupingsummary',
+
+ mixins: {
+ summary: 'Ext.grid.feature.AbstractSummary'
},
+
+ /* End Definitions */
+
+ /**
+ * Modifies the row template to include the summary row.
+ * @private
+ * @return {String} The modified template
+ */
+ getFeatureTpl: function() {
+ var tpl = this.callParent(arguments);
+
+ if (this.showSummaryRow) {
+ // lop off the end so we can attach it
+ tpl = tpl.replace('', '');
+ tpl += '{[this.printSummaryRow(xindex)]}';
+ }
+ return tpl;
+ },
+
/**
- * Hides the dropdown list if it is currently expanded. Fires the {@link #collapse} event on completion.
+ * Gets any fragments needed for the template.
+ * @private
+ * @return {Object} The fragments
*/
- collapse : function(){
- if(!this.isExpanded()){
- return;
+ getFragmentTpl: function() {
+ var me = this,
+ fragments = me.callParent();
+
+ Ext.apply(fragments, me.getSummaryFragments());
+ if (me.showSummaryRow) {
+ // this gets called before render, so we'll setup the data here.
+ me.summaryGroups = me.view.store.getGroups();
+ me.summaryData = me.generateSummaryData();
}
- this.list.hide();
- Ext.getDoc().un('mousewheel', this.collapseIf, this);
- Ext.getDoc().un('mousedown', this.collapseIf, this);
- this.fireEvent('collapse', this);
+ return fragments;
},
-
- // private
- collapseIf : function(e){
- if(!this.isDestroyed && !e.within(this.wrap) && !e.within(this.list)){
- this.collapse();
+
+ /**
+ * Gets the data for printing a template row
+ * @private
+ * @param {Number} index The index in the template
+ * @return {Array} The template values
+ */
+ getPrintData: function(index){
+ var me = this,
+ columns = me.view.headerCt.getColumnsForTpl(),
+ i = 0,
+ length = columns.length,
+ data = [],
+ name = me.summaryGroups[index - 1].name,
+ active = me.summaryData[name],
+ column;
+
+ for (; i < length; ++i) {
+ column = columns[i];
+ column.gridSummaryValue = this.getColumnValue(column, active);
+ data.push(column);
}
+ return data;
},
-
+
/**
- * Expands the dropdown list if it is currently hidden. Fires the {@link #expand} event on completion.
+ * Generates all of the summary data to be used when processing the template
+ * @private
+ * @return {Object} The summary data
*/
- expand : function(){
- if(this.isExpanded() || !this.hasFocus){
- return;
+ generateSummaryData: function(){
+ var me = this,
+ data = {},
+ remoteData = {},
+ store = me.view.store,
+ groupField = this.getGroupField(),
+ reader = store.proxy.reader,
+ groups = me.summaryGroups,
+ columns = me.view.headerCt.getColumnsForTpl(),
+ i,
+ length,
+ fieldData,
+ root,
+ key,
+ comp;
+
+ for (i = 0, length = groups.length; i < length; ++i) {
+ data[groups[i].name] = {};
}
-
- if(this.title || this.pageSize){
- this.assetHeight = 0;
- if(this.title){
- this.assetHeight += this.header.getHeight();
- }
- if(this.pageSize){
- this.assetHeight += this.footer.getHeight();
+
+ /**
+ * @cfg {String} remoteRoot. The name of the property
+ * which contains the Array of summary objects. Defaults to undefined.
+ * It allows to use server-side calculated summaries.
+ */
+ if (me.remoteRoot && reader.rawData) {
+ // reset reader root and rebuild extractors to extract summaries data
+ root = reader.root;
+ reader.root = me.remoteRoot;
+ reader.buildExtractors(true);
+ Ext.Array.each(reader.getRoot(reader.rawData), function(value) {
+ data[value[groupField]] = value;
+ data[value[groupField]]._remote = true;
+ });
+ // restore initial reader configuration
+ reader.root = root;
+ reader.buildExtractors(true);
+ }
+
+ for (i = 0, length = columns.length; i < length; ++i) {
+ comp = Ext.getCmp(columns[i].id);
+ fieldData = me.getSummary(store, comp.summaryType, comp.dataIndex, true);
+
+ for (key in fieldData) {
+ if (fieldData.hasOwnProperty(key)) {
+ if (!data[key]._remote) {
+ data[key][comp.dataIndex] = fieldData[key];
+ }
+ }
}
}
+ return data;
+ }
+});
- if(this.bufferSize){
- this.doResize(this.bufferSize);
- delete this.bufferSize;
- }
- this.list.alignTo.apply(this.list, [this.el].concat(this.listAlign));
+/**
+ * @class Ext.grid.feature.RowBody
+ * @extends Ext.grid.feature.Feature
+ *
+ * The rowbody feature enhances the grid's markup to have an additional
+ * tr -> td -> div which spans the entire width of the original row.
+ *
+ * This is useful to to associate additional information with a particular
+ * record in a grid.
+ *
+ * Rowbodies are initially hidden unless you override getAdditionalData.
+ *
+ * Will expose additional events on the gridview with the prefix of 'rowbody'.
+ * For example: 'rowbodyclick', 'rowbodydblclick', 'rowbodycontextmenu'.
+ *
+ * @ftype rowbody
+ */
+Ext.define('Ext.grid.feature.RowBody', {
+ extend: 'Ext.grid.feature.Feature',
+ alias: 'feature.rowbody',
+ rowBodyHiddenCls: Ext.baseCSSPrefix + 'grid-row-body-hidden',
+ rowBodyTrCls: Ext.baseCSSPrefix + 'grid-rowbody-tr',
+ rowBodyTdCls: Ext.baseCSSPrefix + 'grid-cell-rowbody',
+ rowBodyDivCls: Ext.baseCSSPrefix + 'grid-rowbody',
+
+ eventPrefix: 'rowbody',
+ eventSelector: '.' + Ext.baseCSSPrefix + 'grid-rowbody-tr',
+
+ getRowBody: function(values) {
+ return [
+ '',
+ '',
+ '{rowBody}',
+ ' ',
+ ' '
+ ].join('');
+ },
+
+ // injects getRowBody into the metaRowTpl.
+ getMetaRowTplFragments: function() {
+ return {
+ getRowBody: this.getRowBody,
+ rowBodyTrCls: this.rowBodyTrCls,
+ rowBodyTdCls: this.rowBodyTdCls,
+ rowBodyDivCls: this.rowBodyDivCls
+ };
+ },
- // zindex can change, re-check it and set it if necessary
- this.list.setZIndex(this.getZIndex());
- this.list.show();
- if(Ext.isGecko2){
- this.innerList.setOverflow('auto'); // necessary for FF 2.0/Mac
- }
- this.mon(Ext.getDoc(), {
- scope: this,
- mousewheel: this.collapseIf,
- mousedown: this.collapseIf
- });
- this.fireEvent('expand', this);
+ mutateMetaRowTpl: function(metaRowTpl) {
+ metaRowTpl.push('{[this.getRowBody(values)]}');
},
/**
- * @method onTriggerClick
- * @hide
+ * Provide additional data to the prepareData call within the grid view.
+ * The rowbody feature adds 3 additional variables into the grid view's template.
+ * These are rowBodyCls, rowBodyColspan, and rowBody.
+ * @param {Object} data The data for this particular record.
+ * @param {Number} idx The row index for this record.
+ * @param {Ext.data.Model} record The record instance
+ * @param {Object} orig The original result from the prepareData call to massage.
*/
- // private
- // Implements the default empty TriggerField.onTriggerClick function
- onTriggerClick : function(){
- if(this.readOnly || this.disabled){
- return;
- }
- if(this.isExpanded()){
- this.collapse();
- this.el.focus();
- }else {
- this.onFocus({});
- if(this.triggerAction == 'all') {
- this.doQuery(this.allQuery, true);
- } else {
- this.doQuery(this.getRawValue());
- }
- this.el.focus();
- }
+ getAdditionalData: function(data, idx, record, orig) {
+ var headerCt = this.view.headerCt,
+ colspan = headerCt.getColumnCount();
+
+ return {
+ rowBody: "",
+ rowBodyCls: this.rowBodyCls,
+ rowBodyColspan: colspan
+ };
}
+});
+/**
+ * @class Ext.grid.feature.RowWrap
+ * @extends Ext.grid.feature.Feature
+ * @private
+ */
+Ext.define('Ext.grid.feature.RowWrap', {
+ extend: 'Ext.grid.feature.Feature',
+ alias: 'feature.rowwrap',
- /**
- * @hide
- * @method autoSize
- */
- /**
- * @cfg {Boolean} grow @hide
- */
- /**
- * @cfg {Number} growMin @hide
- */
- /**
- * @cfg {Number} growMax @hide
- */
+ // turn off feature events.
+ hasFeatureEvent: false,
+
+ mutateMetaRowTpl: function(metaRowTpl) {
+ // Remove "x-grid-row" from the first row, note this could be wrong
+ // if some other feature unshifted things in front.
+ metaRowTpl[0] = metaRowTpl[0].replace(Ext.baseCSSPrefix + 'grid-row', '');
+ metaRowTpl[0] = metaRowTpl[0].replace("{[this.embedRowCls()]}", "");
+ // 2
+ metaRowTpl.unshift('');
+ // 1
+ metaRowTpl.unshift('');
+
+ // 3
+ metaRowTpl.push('
');
+ // 4
+ metaRowTpl.push('');
+ },
+
+ embedColSpan: function() {
+ return '{colspan}';
+ },
+
+ embedFullWidth: function() {
+ return '{fullWidth}';
+ },
+
+ getAdditionalData: function(data, idx, record, orig) {
+ var headerCt = this.view.headerCt,
+ colspan = headerCt.getColumnCount(),
+ fullWidth = headerCt.getFullWidth(),
+ items = headerCt.query('gridcolumn'),
+ itemsLn = items.length,
+ i = 0,
+ o = {
+ colspan: colspan,
+ fullWidth: fullWidth
+ },
+ id,
+ tdClsKey,
+ colResizerCls;
+
+ for (; i < itemsLn; i++) {
+ id = items[i].id;
+ tdClsKey = id + '-tdCls';
+ colResizerCls = Ext.baseCSSPrefix + 'grid-col-resizer-'+id;
+ // give the inner td's the resizer class
+ // while maintaining anything a user may have injected via a custom
+ // renderer
+ o[tdClsKey] = colResizerCls + " " + (orig[tdClsKey] ? orig[tdClsKey] : '');
+ // TODO: Unhackify the initial rendering width's
+ o[id+'-tdAttr'] = " style=\"width: " + (items[i].hidden ? 0 : items[i].getDesiredWidth()) + "px;\" "/* + (i === 0 ? " rowspan=\"2\"" : "")*/;
+ if (orig[id+'-tdAttr']) {
+ o[id+'-tdAttr'] += orig[id+'-tdAttr'];
+ }
+
+ }
+ return o;
+ },
+
+ getMetaRowTplFragments: function() {
+ return {
+ embedFullWidth: this.embedFullWidth,
+ embedColSpan: this.embedColSpan
+ };
+ }
+
});
-Ext.reg('combo', Ext.form.ComboBox);
/**
- * @class Ext.form.Checkbox
- * @extends Ext.form.Field
- * Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.
- * @constructor
- * Creates a new Checkbox
- * @param {Object} config Configuration options
- * @xtype checkbox
+ * @class Ext.grid.feature.Summary
+ * @extends Ext.grid.feature.AbstractSummary
+ *
+ * This feature is used to place a summary row at the bottom of the grid. If using a grouping,
+ * see {@link Ext.grid.feature.GroupingSummary}. There are 2 aspects to calculating the summaries,
+ * calculation and rendering.
+ *
+ * ## Calculation
+ * The summary value needs to be calculated for each column in the grid. This is controlled
+ * by the summaryType option specified on the column. There are several built in summary types,
+ * which can be specified as a string on the column configuration. These call underlying methods
+ * on the store:
+ *
+ * - {@link Ext.data.Store#count count}
+ * - {@link Ext.data.Store#sum sum}
+ * - {@link Ext.data.Store#min min}
+ * - {@link Ext.data.Store#max max}
+ * - {@link Ext.data.Store#average average}
+ *
+ * Alternatively, the summaryType can be a function definition. If this is the case,
+ * the function is called with an array of records to calculate the summary value.
+ *
+ * ## Rendering
+ * Similar to a column, the summary also supports a summaryRenderer function. This
+ * summaryRenderer is called before displaying a value. The function is optional, if
+ * not specified the default calculated value is shown. The summaryRenderer is called with:
+ *
+ * - value {Object} - The calculated value.
+ * - data {Object} - Contains all raw summary values for the row.
+ * - field {String} - The name of the field we are calculating
+ *
+ * ## Example Usage
+ *
+ * Ext.define('TestResult', {
+ * extend: 'Ext.data.Model',
+ * fields: ['student', {
+ * name: 'mark',
+ * type: 'int'
+ * }]
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * width: 200,
+ * height: 140,
+ * renderTo: document.body,
+ * features: [{
+ * ftype: 'summary'
+ * }],
+ * store: {
+ * model: 'TestResult',
+ * data: [{
+ * student: 'Student 1',
+ * mark: 84
+ * },{
+ * student: 'Student 2',
+ * mark: 72
+ * },{
+ * student: 'Student 3',
+ * mark: 96
+ * },{
+ * student: 'Student 4',
+ * mark: 68
+ * }]
+ * },
+ * columns: [{
+ * dataIndex: 'student',
+ * text: 'Name',
+ * summaryType: 'count',
+ * summaryRenderer: function(value){
+ * return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : '');
+ * }
+ * }, {
+ * dataIndex: 'mark',
+ * text: 'Mark',
+ * summaryType: 'average'
+ * }]
+ * });
*/
-Ext.form.Checkbox = Ext.extend(Ext.form.Field, {
- /**
- * @cfg {String} focusClass The CSS class to use when the checkbox receives focus (defaults to undefined)
- */
- focusClass : undefined,
- /**
- * @cfg {String} fieldClass The default CSS class for the checkbox (defaults to 'x-form-field')
- */
- fieldClass : 'x-form-field',
- /**
- * @cfg {Boolean} checked true if the checkbox should render initially checked (defaults to false)
- */
- checked : false,
- /**
- * @cfg {String} boxLabel The text that appears beside the checkbox
- */
- boxLabel: ' ',
+Ext.define('Ext.grid.feature.Summary', {
+
+ /* Begin Definitions */
+
+ extend: 'Ext.grid.feature.AbstractSummary',
+
+ alias: 'feature.summary',
+
+ /* End Definitions */
+
/**
- * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to
- * {tag: 'input', type: 'checkbox', autocomplete: 'off'})
+ * Gets any fragments needed for the template.
+ * @private
+ * @return {Object} The fragments
*/
- defaultAutoCreate : { tag: 'input', type: 'checkbox', autocomplete: 'off'},
+ getFragmentTpl: function() {
+ // this gets called before render, so we'll setup the data here.
+ this.summaryData = this.generateSummaryData();
+ return this.getSummaryFragments();
+ },
+
/**
- * @cfg {String} boxLabel The text that appears beside the checkbox
+ * Overrides the closeRows method on the template so we can include our own custom
+ * footer.
+ * @private
+ * @return {Object} The custom fragments
*/
+ getTableFragments: function(){
+ if (this.showSummaryRow) {
+ return {
+ closeRows: this.closeRows
+ };
+ }
+ },
+
/**
- * @cfg {String} inputValue The value that should go into the generated input element's value attribute
+ * Provide our own custom footer for the grid.
+ * @private
+ * @return {String} The custom footer
*/
+ closeRows: function() {
+ return '{[this.printSummaryRow()]}';
+ },
+
/**
- * @cfg {Function} handler A function called when the {@link #checked} value changes (can be used instead of
- * handling the check event). The handler is passed the following parameters:
- *
- * - checkbox : Ext.form.CheckboxThe Checkbox being toggled.
- * - checked : BooleanThe new checked state of the checkbox.
- *
+ * Gets the data for printing a template row
+ * @private
+ * @param {Number} index The index in the template
+ * @return {Array} The template values
*/
+ getPrintData: function(index){
+ var me = this,
+ columns = me.view.headerCt.getColumnsForTpl(),
+ i = 0,
+ length = columns.length,
+ data = [],
+ active = me.summaryData,
+ column;
+
+ for (; i < length; ++i) {
+ column = columns[i];
+ column.gridSummaryValue = this.getColumnValue(column, active);
+ data.push(column);
+ }
+ return data;
+ },
+
/**
- * @cfg {Object} scope An object to use as the scope ('this' reference) of the {@link #handler} function
- * (defaults to this Checkbox).
+ * Generates all of the summary data to be used when processing the template
+ * @private
+ * @return {Object} The summary data
*/
+ generateSummaryData: function(){
+ var me = this,
+ data = {},
+ store = me.view.store,
+ columns = me.view.headerCt.getColumnsForTpl(),
+ i = 0,
+ length = columns.length,
+ fieldData,
+ key,
+ comp;
+
+ for (i = 0, length = columns.length; i < length; ++i) {
+ comp = Ext.getCmp(columns[i].id);
+ data[comp.dataIndex] = me.getSummary(store, comp.summaryType, comp.dataIndex, false);
+ }
+ return data;
+ }
+});
+/**
+ * @class Ext.grid.header.DragZone
+ * @extends Ext.dd.DragZone
+ * @private
+ */
+Ext.define('Ext.grid.header.DragZone', {
+ extend: 'Ext.dd.DragZone',
+ colHeaderCls: Ext.baseCSSPrefix + 'column-header',
+ maxProxyWidth: 120,
- // private
- actionMode : 'wrap',
+ constructor: function(headerCt) {
+ this.headerCt = headerCt;
+ this.ddGroup = this.getDDGroup();
+ this.callParent([headerCt.el]);
+ this.proxy.el.addCls(Ext.baseCSSPrefix + 'grid-col-dd');
+ },
- // private
- initComponent : function(){
- Ext.form.Checkbox.superclass.initComponent.call(this);
- this.addEvents(
- /**
- * @event check
- * Fires when the checkbox is checked or unchecked.
- * @param {Ext.form.Checkbox} this This checkbox
- * @param {Boolean} checked The new checked value
- */
- 'check'
- );
+ getDDGroup: function() {
+ return 'header-dd-zone-' + this.headerCt.up('[scrollerOwner]').id;
},
- // private
- onResize : function(){
- Ext.form.Checkbox.superclass.onResize.apply(this, arguments);
- if(!this.boxLabel && !this.fieldLabel){
- this.el.alignTo(this.wrap, 'c-c');
+ getDragData: function(e) {
+ var header = e.getTarget('.'+this.colHeaderCls),
+ headerCmp;
+
+ if (header) {
+ headerCmp = Ext.getCmp(header.id);
+ if (!this.headerCt.dragging && headerCmp.draggable && !(headerCmp.isOnLeftEdge(e) || headerCmp.isOnRightEdge(e))) {
+ var ddel = document.createElement('div');
+ ddel.innerHTML = Ext.getCmp(header.id).text;
+ return {
+ ddel: ddel,
+ header: headerCmp
+ };
+ }
}
+ return false;
},
- // private
- initEvents : function(){
- Ext.form.Checkbox.superclass.initEvents.call(this);
- this.mon(this.el, {
- scope: this,
- click: this.onClick,
- change: this.onClick
- });
+ onBeforeDrag: function() {
+ return !(this.headerCt.dragging || this.disabled);
},
- /**
- * @hide
- * Overridden and disabled. The editor element does not support standard valid/invalid marking.
- * @method
- */
- markInvalid : Ext.emptyFn,
- /**
- * @hide
- * Overridden and disabled. The editor element does not support standard valid/invalid marking.
- * @method
- */
- clearInvalid : Ext.emptyFn,
+ onInitDrag: function() {
+ this.headerCt.dragging = true;
+ this.callParent(arguments);
+ },
- // private
- onRender : function(ct, position){
- Ext.form.Checkbox.superclass.onRender.call(this, ct, position);
- if(this.inputValue !== undefined){
- this.el.dom.value = this.inputValue;
- }
- this.wrap = this.el.wrap({cls: 'x-form-check-wrap'});
- if(this.boxLabel){
- this.wrap.createChild({tag: 'label', htmlFor: this.el.id, cls: 'x-form-cb-label', html: this.boxLabel});
- }
- if(this.checked){
- this.setValue(true);
- }else{
- this.checked = this.el.dom.checked;
- }
- // Need to repaint for IE, otherwise positioning is broken
- if (Ext.isIE && !Ext.isStrict) {
- this.wrap.repaint();
- }
- this.resizeEl = this.positionEl = this.wrap;
+ onDragDrop: function() {
+ this.headerCt.dragging = false;
+ this.callParent(arguments);
},
- // private
- onDestroy : function(){
- Ext.destroy(this.wrap);
- Ext.form.Checkbox.superclass.onDestroy.call(this);
+ afterRepair: function() {
+ this.callParent();
+ this.headerCt.dragging = false;
},
- // private
- initValue : function() {
- this.originalValue = this.getValue();
+ getRepairXY: function() {
+ return this.dragData.header.el.getXY();
+ },
+
+ disable: function() {
+ this.disabled = true;
+ },
+
+ enable: function() {
+ this.disabled = false;
+ }
+});
+
+/**
+ * @class Ext.grid.header.DropZone
+ * @extends Ext.dd.DropZone
+ * @private
+ */
+Ext.define('Ext.grid.header.DropZone', {
+ extend: 'Ext.dd.DropZone',
+ colHeaderCls: Ext.baseCSSPrefix + 'column-header',
+ proxyOffsets: [-4, -9],
+
+ constructor: function(headerCt){
+ this.headerCt = headerCt;
+ this.ddGroup = this.getDDGroup();
+ this.callParent([headerCt.el]);
},
- /**
- * Returns the checked state of the checkbox.
- * @return {Boolean} True if checked, else false
- */
- getValue : function(){
- if(this.rendered){
- return this.el.dom.checked;
+ getDDGroup: function() {
+ return 'header-dd-zone-' + this.headerCt.up('[scrollerOwner]').id;
+ },
+
+ getTargetFromEvent : function(e){
+ return e.getTarget('.' + this.colHeaderCls);
+ },
+
+ getTopIndicator: function() {
+ if (!this.topIndicator) {
+ this.topIndicator = Ext.core.DomHelper.append(Ext.getBody(), {
+ cls: "col-move-top",
+ html: " "
+ }, true);
}
- return this.checked;
+ return this.topIndicator;
},
- // private
- onClick : function(){
- if(this.el.dom.checked != this.checked){
- this.setValue(this.el.dom.checked);
+ getBottomIndicator: function() {
+ if (!this.bottomIndicator) {
+ this.bottomIndicator = Ext.core.DomHelper.append(Ext.getBody(), {
+ cls: "col-move-bottom",
+ html: " "
+ }, true);
}
+ return this.bottomIndicator;
},
- /**
- * Sets the checked state of the checkbox, fires the 'check' event, and calls a
- * {@link #handler}
(if configured).
- * @param {Boolean/String} checked The following values will check the checkbox:
- * true, 'true', '1', or 'on'
. Any other value will uncheck the checkbox.
- * @return {Ext.form.Field} this
- */
- setValue : function(v){
- var checked = this.checked ;
- this.checked = (v === true || v === 'true' || v == '1' || String(v).toLowerCase() == 'on');
- if(this.rendered){
- this.el.dom.checked = this.checked;
- this.el.dom.defaultChecked = this.checked;
+ getLocation: function(e, t) {
+ var x = e.getXY()[0],
+ region = Ext.fly(t).getRegion(),
+ pos, header;
+
+ if ((region.right - x) <= (region.right - region.left) / 2) {
+ pos = "after";
+ } else {
+ pos = "before";
}
- if(checked != this.checked){
- this.fireEvent('check', this, this.checked);
- if(this.handler){
- this.handler.call(this.scope || this, this, this.checked);
- }
+ return {
+ pos: pos,
+ header: Ext.getCmp(t.id),
+ node: t
+ };
+ },
+
+ positionIndicator: function(draggedHeader, node, e){
+ var location = this.getLocation(e, node),
+ header = location.header,
+ pos = location.pos,
+ nextHd = draggedHeader.nextSibling('gridcolumn:not([hidden])'),
+ prevHd = draggedHeader.previousSibling('gridcolumn:not([hidden])'),
+ region, topIndicator, bottomIndicator, topAnchor, bottomAnchor,
+ topXY, bottomXY, headerCtEl, minX, maxX;
+
+ // Cannot drag beyond non-draggable start column
+ if (!header.draggable && header.getIndex() == 0) {
+ return false;
}
- return this;
- }
-});
-Ext.reg('checkbox', Ext.form.Checkbox);
-/**
- * @class Ext.form.CheckboxGroup
- * @extends Ext.form.Field
- * A grouping container for {@link Ext.form.Checkbox} controls.
- * Sample usage:
- *
-var myCheckboxGroup = new Ext.form.CheckboxGroup({
- id:'myGroup',
- xtype: 'checkboxgroup',
- fieldLabel: 'Single Column',
- itemCls: 'x-check-group-alt',
- // Put all controls in a single column with width 100%
- columns: 1,
- items: [
- {boxLabel: 'Item 1', name: 'cb-col-1'},
- {boxLabel: 'Item 2', name: 'cb-col-2', checked: true},
- {boxLabel: 'Item 3', name: 'cb-col-3'}
- ]
-});
- *
- * @constructor
- * Creates a new CheckboxGroup
- * @param {Object} config Configuration options
- * @xtype checkboxgroup
- */
-Ext.form.CheckboxGroup = Ext.extend(Ext.form.Field, {
- /**
- * @cfg {Array} items An Array of {@link Ext.form.Checkbox Checkbox}es or Checkbox config objects
- * to arrange in the group.
- */
- /**
- * @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:
- * - '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 : Object
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.
- */
- columns : 'auto',
- /**
- * @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.
- */
- vertical : false,
- /**
- * @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.
- */
- allowBlank : true,
- /**
- * @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 : 'checkbox',
+ this.lastLocation = location;
- // private
- groupCls : 'x-form-check-group',
+ if ((draggedHeader !== header) &&
+ ((pos === "before" && nextHd !== header) ||
+ (pos === "after" && prevHd !== header)) &&
+ !header.isDescendantOf(draggedHeader)) {
- // private
- initComponent: function(){
- this.addEvents(
- /**
- * @event change
- * Fires when the state of a child checkbox changes.
- * @param {Ext.form.CheckboxGroup} this
- * @param {Array} checked An array containing the checked boxes.
- */
- 'change'
- );
- this.on('change', this.validate, this);
- Ext.form.CheckboxGroup.superclass.initComponent.call(this);
- },
+ // As we move in between different DropZones that are in the same
+ // group (such as the case when in a locked grid), invalidateDrop
+ // on the other dropZones.
+ var allDropZones = Ext.dd.DragDropManager.getRelated(this),
+ ln = allDropZones.length,
+ i = 0,
+ dropZone;
- // private
- onRender : function(ct, position){
- if(!this.el){
- var panelCfg = {
- autoEl: {
- id: this.id
- },
- cls: this.groupCls,
- layout: 'column',
- renderTo: ct,
- bufferResize: false // Default this to false, since it doesn't really have a proper ownerCt.
- };
- var colCfg = {
- xtype: 'container',
- defaultType: this.defaultType,
- layout: 'form',
- defaults: {
- hideLabel: true,
- anchor: '100%'
+ for (; i < ln; i++) {
+ dropZone = allDropZones[i];
+ if (dropZone !== this && dropZone.invalidateDrop) {
+ dropZone.invalidateDrop();
}
- };
+ }
- if(this.items[0].items){
- // The container has standard ColumnLayout configs, so pass them in directly
+ this.valid = true;
+ topIndicator = this.getTopIndicator();
+ bottomIndicator = this.getBottomIndicator();
+ if (pos === 'before') {
+ topAnchor = 'tl';
+ bottomAnchor = 'bl';
+ } else {
+ topAnchor = 'tr';
+ bottomAnchor = 'br';
+ }
+ topXY = header.el.getAnchorXY(topAnchor);
+ bottomXY = header.el.getAnchorXY(bottomAnchor);
+
+ // constrain the indicators to the viewable section
+ headerCtEl = this.headerCt.el;
+ minX = headerCtEl.getLeft();
+ maxX = headerCtEl.getRight();
+
+ topXY[0] = Ext.Number.constrain(topXY[0], minX, maxX);
+ bottomXY[0] = Ext.Number.constrain(bottomXY[0], minX, maxX);
+
+ // adjust by offsets, this is to center the arrows so that they point
+ // at the split point
+ topXY[0] -= 4;
+ topXY[1] -= 9;
+ bottomXY[0] -= 4;
+
+ // position and show indicators
+ topIndicator.setXY(topXY);
+ bottomIndicator.setXY(bottomXY);
+ topIndicator.show();
+ bottomIndicator.show();
+ // invalidate drop operation and hide indicators
+ } else {
+ this.invalidateDrop();
+ }
+ },
- Ext.apply(panelCfg, {
- layoutConfig: {columns: this.items.length},
- defaults: this.defaults,
- items: this.items
- });
- for(var i=0, len=this.items.length; i fromCt.items.indexOf(hd))) {
+ toIdx--;
}
- numCols = this.columns.length;
+ // Remove dragged header from where it was without destroying it or relaying its Container
+ if (fromCt !== toCt) {
+ fromCt.suspendLayout = true;
+ fromCt.remove(hd, false);
+ fromCt.suspendLayout = false;
+ }
- // Generate the column configs with the correct width setting
- for(var i=0; i0 && i%rows==0){
- ri++;
- }
- if(this.items[i].fieldLabel){
- this.items[i].hideLabel = false;
- }
- cols[ri].items.push(this.items[i]);
- };
- }else{
- for(var i=0, len=this.items.length; i
-// call with name and value
-myCheckboxGroup.setValue('cb-col-1', true);
-// call with an array of boolean values
-myCheckboxGroup.setValue([true, false, false]);
-// call with an object literal specifying item:value pairs
-myCheckboxGroup.setValue({
- 'cb-col-2': false,
- 'cb-col-3': true
-});
-// use comma separated string to set items with name to true (checked)
-myCheckboxGroup.setValue('cb-col-1,cb-col-3');
- *
- * See {@link Ext.form.Checkbox#setValue} for additional information.
- * @param {Mixed} id The checkbox to check, or as described by example shown.
- * @param {Boolean} value (optional) The value to set the item.
- * @return {Ext.form.CheckboxGroup} this
- */
- setValue: function(){
- if(this.rendered){
- this.onSetValue.apply(this, arguments);
- }else{
- this.buffered = true;
- this.value = arguments;
+ if (!field && defaultField) {
+ field = defaultField;
}
- return this;
- },
- /**
- * @private
- * Sets the values of one or more of the items within the CheckboxGroup
- * @param {String|Array|Object} id Can take multiple forms. Can be optionally:
- *
- * - An ID string to be used with a second argument
- * - An array of the form ['some', 'list', 'of', 'ids', 'to', 'mark', 'checked']
- * - An array in the form [true, true, false, true, false] etc, where each item relates to the check status of
- * the checkbox at the same index
- * - An object containing ids of the checkboxes as keys and check values as properties
- *
- * @param {String} value The value to set the field to if the first argument was a string
- */
- onSetValue: function(id, value){
- if(arguments.length == 1){
- if(Ext.isArray(id)){
- Ext.each(id, function(val, idx){
- if (Ext.isObject(val) && val.setValue){ // array of checkbox components to be checked
- val.setValue(true);
- if (this.resetOriginal === true) {
- val.originalValue = val.getValue();
- }
- } else { // an array of boolean values
- var item = this.items.itemAt(idx);
- if(item){
- item.setValue(val);
- }
- }
- }, this);
- }else if(Ext.isObject(id)){
- // set of name/value pairs
- for(var i in id){
- var f = this.getBox(i);
- if(f){
- f.setValue(id[i]);
- }
- }
- }else{
- this.setValueForItem(id);
+ if (field) {
+ if (Ext.isString(field)) {
+ field = { xtype: field };
}
- }else{
- var f = this.getBox(id);
- if(f){
- f.setValue(value);
+ if (Ext.isObject(field) && !field.isFormField) {
+ field = Ext.ComponentManager.create(field, this.defaultFieldXType);
+ columnHeader.field = field;
}
+
+ Ext.apply(field, {
+ name: columnHeader.dataIndex
+ });
+
+ return field;
}
},
// private
- beforeDestroy: function(){
- Ext.destroy(this.panel);
- Ext.form.CheckboxGroup.superclass.beforeDestroy.call(this);
-
+ // remaps to the public API of Ext.grid.column.Column.setEditor
+ setColumnField: function(column, field) {
+ if (Ext.isObject(field) && !field.isFormField) {
+ field = Ext.ComponentManager.create(field, this.defaultFieldXType);
+ }
+ column.field = field;
},
- setValueForItem : function(val){
- val = String(val).split(',');
- this.eachItem(function(item){
- if(val.indexOf(item.inputValue)> -1){
- item.setValue(true);
- }
- });
+ // private
+ initEvents: function() {
+ var me = this;
+ me.initEditTriggers();
+ me.initCancelTriggers();
},
+ // @abstract
+ initCancelTriggers: Ext.emptyFn,
+
// private
- getBox : function(id){
- var box = null;
- this.eachItem(function(f){
- if(id == f || f.dataIndex == id || f.id == id || f.getName() == id){
- box = f;
- return false;
- }
- });
- return box;
+ initEditTriggers: function() {
+ var me = this,
+ view = me.view,
+ clickEvent = me.clicksToEdit === 1 ? 'click' : 'dblclick';
+
+ // Start editing
+ me.mon(view, 'cell' + clickEvent, me.startEditByClick, me);
+ view.on('render', function() {
+ me.keyNav = Ext.create('Ext.util.KeyNav', view.el, {
+ enter: me.onEnterKey,
+ esc: me.onEscKey,
+ scope: me
+ });
+ }, me, { single: true });
},
- /**
- * Gets an array of the selected {@link Ext.form.Checkbox} in the group.
- * @return {Array} An array of the selected checkboxes.
- */
- getValue : function(){
- var out = [];
- this.eachItem(function(item){
- if(item.checked){
- out.push(item);
- }
- });
- return out;
+ // private
+ onEnterKey: function(e) {
+ var me = this,
+ grid = me.grid,
+ selModel = grid.getSelectionModel(),
+ record,
+ columnHeader = grid.headerCt.getHeaderAtIndex(0);
+
+ // Calculate editing start position from SelectionModel
+ // CellSelectionModel
+ if (selModel.getCurrentPosition) {
+ pos = selModel.getCurrentPosition();
+ record = grid.store.getAt(pos.row);
+ columnHeader = grid.headerCt.getHeaderAtIndex(pos.column);
+ }
+ // RowSelectionModel
+ else {
+ record = selModel.getLastSelected();
+ }
+ me.startEdit(record, columnHeader);
},
- /**
- * @private
- * Convenience function which passes the given function to every item in the composite
- * @param {Function} fn The function to call
- * @param {Object} scope Optional scope object
- */
- eachItem: function(fn, scope) {
- if(this.items && this.items.each){
- this.items.each(fn, scope || this);
- }
+ // private
+ onEscKey: function(e) {
+ this.cancelEdit();
},
- /**
- * @cfg {String} name
- * @hide
- */
+ // private
+ startEditByClick: function(view, cell, colIdx, record, row, rowIdx, e) {
+ this.startEdit(record, view.getHeaderAtIndex(colIdx));
+ },
/**
- * @method getRawValue
- * @hide
+ * @private
+ * @abstract. Template method called before editing begins.
+ * @param {Object} context The current editing context
+ * @return {Boolean} Return false to cancel the editing process
*/
- getRawValue : Ext.emptyFn,
+ beforeEdit: Ext.emptyFn,
/**
- * @method setRawValue
- * @hide
+ * Start editing the specified record, using the specified Column definition to define which field is being edited.
+ * @param {Model} record The Store data record which backs the row to be edited.
+ * @param {Model} columnHeader The Column object defining the column to be edited.
*/
- setRawValue : Ext.emptyFn
-
-});
+ startEdit: function(record, columnHeader) {
+ var me = this,
+ context = me.getEditingContext(record, columnHeader);
-Ext.reg('checkboxgroup', Ext.form.CheckboxGroup);
-/**
- * @class Ext.form.CompositeField
- * @extends Ext.form.Field
- * Composite field allowing a number of form Fields to be rendered on the same row. The fields are rendered
- * using an hbox layout internally, so all of the normal HBox layout config items are available. Example usage:
- *
-{
- xtype: 'compositefield',
- labelWidth: 120
- items: [
- {
- xtype : 'textfield',
- fieldLabel: 'Title',
- width : 20
- },
- {
- xtype : 'textfield',
- fieldLabel: 'First',
- flex : 1
- },
- {
- xtype : 'textfield',
- fieldLabel: 'Last',
- flex : 1
+ if (me.beforeEdit(context) === false || me.fireEvent('beforeedit', context) === false || context.cancel) {
+ return false;
}
- ]
-}
- *
- * In the example above the composite's fieldLabel will be set to 'Title, First, Last' as it groups the fieldLabels
- * of each of its children. This can be overridden by setting a fieldLabel on the compositefield itself:
- *
-{
- xtype: 'compositefield',
- fieldLabel: 'Custom label',
- items: [...]
-}
- *
- * Any Ext.form.* component can be placed inside a composite field.
- */
-Ext.form.CompositeField = Ext.extend(Ext.form.Field, {
- /**
- * @property defaultMargins
- * @type String
- * The margins to apply by default to each field in the composite
- */
- defaultMargins: '0 5 0 0',
+ me.context = context;
+ me.editing = true;
+ },
/**
- * @property skipLastItemMargin
- * @type Boolean
- * If true, the defaultMargins are not applied to the last item in the composite field set (defaults to true)
+ * @private Collects all information necessary for any subclasses to perform their editing functions.
+ * @param record
+ * @param columnHeader
+ * @returns {Object} The editing context based upon the passed record and column
*/
- skipLastItemMargin: true,
+ getEditingContext: function(record, columnHeader) {
+ var me = this,
+ grid = me.grid,
+ store = grid.store,
+ rowIdx,
+ colIdx,
+ view = grid.getView(),
+ value;
- /**
- * @property isComposite
- * @type Boolean
- * Signifies that this is a Composite field
- */
- isComposite: true,
+ // If they'd passed numeric row, column indices, look them up.
+ if (Ext.isNumber(record)) {
+ rowIdx = record;
+ record = store.getAt(rowIdx);
+ } else {
+ rowIdx = store.indexOf(record);
+ }
+ if (Ext.isNumber(columnHeader)) {
+ colIdx = columnHeader;
+ columnHeader = grid.headerCt.getHeaderAtIndex(colIdx);
+ } else {
+ colIdx = columnHeader.getIndex();
+ }
+
+ value = record.get(columnHeader.dataIndex);
+ return {
+ grid: grid,
+ record: record,
+ field: columnHeader.dataIndex,
+ value: value,
+ row: view.getNode(rowIdx),
+ column: columnHeader,
+ rowIdx: rowIdx,
+ colIdx: colIdx
+ };
+ },
/**
- * @property combineErrors
- * @type Boolean
- * True to combine errors from the individual fields into a single error message at the CompositeField level (defaults to true)
+ * Cancel any active edit that is in progress.
*/
- combineErrors: true,
-
+ cancelEdit: function() {
+ this.editing = false;
+ },
+
/**
- * @cfg {String} labelConnector The string to use when joining segments of the built label together (defaults to ', ')
+ * Complete the edit if there is an active edit in progress.
*/
- labelConnector: ', ',
-
- //inherit docs
- //Builds the composite field label
- initComponent: function() {
- var labels = [],
- items = this.items,
- item;
+ completeEdit: function() {
+ var me = this;
- for (var i=0, j = items.length; i < j; i++) {
- item = items[i];
+ if (me.editing && me.validateEdit()) {
+ me.fireEvent('edit', me.context);
+ }
- labels.push(item.fieldLabel);
+ delete me.context;
+ me.editing = false;
+ },
- //apply any defaults
- Ext.apply(item, this.defaults);
+ // @abstract
+ validateEdit: function() {
+ var me = this,
+ context = me.context;
- //apply default margins to each item except the last
- if (!(i == j - 1 && this.skipLastItemMargin)) {
- Ext.applyIf(item, {margins: this.defaultMargins});
- }
- }
+ return me.fireEvent('validateedit', me, context) !== false && !context.cancel;
+ }
+});
+/**
+ * @class Ext.grid.plugin.CellEditing
+ * @extends Ext.grid.plugin.Editing
+ *
+ * The Ext.grid.plugin.CellEditing plugin injects editing at a cell level for a Grid. Only a single
+ * cell will be editable at a time. The field that will be used for the editor is defined at the
+ * {@link Ext.grid.column.Column#field field}. The editor can be a field instance or a field configuration.
+ *
+ * If an editor is not specified for a particular column then that cell will not be editable and it will
+ * be skipped when activated via the mouse or the keyboard.
+ *
+ * The editor may be shared for each column in the grid, or a different one may be specified for each column.
+ * An appropriate field type should be chosen to match the data structure that it will be editing. For example,
+ * to edit a date, it would be useful to specify {@link Ext.form.field.Date} as the editor.
+ *
+ * {@img Ext.grid.plugin.CellEditing/Ext.grid.plugin.CellEditing.png Ext.grid.plugin.CellEditing plugin}
+ *
+ * ## Example Usage
+ * Ext.create('Ext.data.Store', {
+ * storeId:'simpsonsStore',
+ * fields:['name', 'email', 'phone'],
+ * data:{'items':[
+ * {"name":"Lisa", "email":"lisa@simpsons.com", "phone":"555-111-1224"},
+ * {"name":"Bart", "email":"bart@simpsons.com", "phone":"555--222-1234"},
+ * {"name":"Homer", "email":"home@simpsons.com", "phone":"555-222-1244"},
+ * {"name":"Marge", "email":"marge@simpsons.com", "phone":"555-222-1254"}
+ * ]},
+ * proxy: {
+ * type: 'memory',
+ * reader: {
+ * type: 'json',
+ * root: 'items'
+ * }
+ * }
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Simpsons',
+ * store: Ext.data.StoreManager.lookup('simpsonsStore'),
+ * columns: [
+ * {header: 'Name', dataIndex: 'name', field: 'textfield'},
+ * {header: 'Email', dataIndex: 'email', flex:1,
+ * editor: {
+ * xtype:'textfield',
+ * allowBlank:false
+ * }
+ * },
+ * {header: 'Phone', dataIndex: 'phone'}
+ * ],
+ * selType: 'cellmodel',
+ * plugins: [
+ * Ext.create('Ext.grid.plugin.CellEditing', {
+ * clicksToEdit: 1
+ * })
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ */
+Ext.define('Ext.grid.plugin.CellEditing', {
+ alias: 'plugin.cellediting',
+ extend: 'Ext.grid.plugin.Editing',
+ requires: ['Ext.grid.CellEditor'],
- this.fieldLabel = this.fieldLabel || this.buildLabel(labels);
+ constructor: function() {
+ /**
+ * @event beforeedit
+ * Fires before cell editing is triggered. The edit event object has the following properties
+ *
+ * - grid - The grid
+ * - record - The record being edited
+ * - field - The field name being edited
+ * - value - The value for the field being edited.
+ * - row - The grid table row
+ * - column - The grid {@link Ext.grid.column.Column Column} defining the column that is being edited.
+ * - rowIdx - The row index that is being edited
+ * - colIdx - The column index that is being edited
+ * - cancel - Set this to true to cancel the edit or return false from your handler.
+ *
+ * @param {Ext.grid.plugin.Editing} editor
+ * @param {Object} e An edit event (see above for description)
+ */
+ /**
+ * @event edit
+ * Fires after a cell is edited. The edit event object has the following properties
+ *
+ * - grid - The grid
+ * - record - The record that was edited
+ * - field - The field name that was edited
+ * - value - The value being set
+ * - originalValue - The original value for the field, before the edit.
+ * - row - The grid table row
+ * - column - The grid {@link Ext.grid.column.Column Column} defining the column that was edited.
+ * - rowIdx - The row index that was edited
+ * - colIdx - The column index that was edited
+ *
+ *
+ *
+grid.on('edit', onEdit, this);
+function onEdit(e) {
+ // execute an XHR to send/commit data to the server, in callback do (if successful):
+ e.record.commit();
+};
+ *
+ * @param {Ext.grid.plugin.Editing} editor
+ * @param {Object} e An edit event (see above for description)
+ */
/**
- * @property fieldErrors
- * @type Ext.util.MixedCollection
- * MixedCollection of current errors on the Composite's subfields. This is used internally to track when
- * to show and hide error messages at the Composite level. Listeners are attached to the MixedCollection's
- * add, remove and replace events to update the error icon in the UI as errors are added or removed.
+ * @event validateedit
+ * Fires after a cell is edited, but before the value is set in the record. Return false
+ * to cancel the change. The edit event object has the following properties
+ *
+ * - grid - The grid
+ * - record - The record being edited
+ * - field - The field name being edited
+ * - value - The value being set
+ * - originalValue - The original value for the field, before the edit.
+ * - row - The grid table row
+ * - column - The grid {@link Ext.grid.column.Column Column} defining the column that is being edited.
+ * - rowIdx - The row index that is being edited
+ * - colIdx - The column index that is being edited
+ * - cancel - Set this to true to cancel the edit or return false from your handler.
+ *
+ * Usage example showing how to remove the red triangle (dirty record indicator) from some
+ * records (not all). By observing the grid's validateedit event, it can be cancelled if
+ * the edit occurs on a targeted row (for example) and then setting the field's new value
+ * in the Record directly:
+ *
+grid.on('validateedit', function(e) {
+ var myTargetRow = 6;
+
+ if (e.row == myTargetRow) {
+ e.cancel = true;
+ e.record.data[e.field] = e.value;
+ }
+});
+ *
+ * @param {Ext.grid.plugin.Editing} editor
+ * @param {Object} e An edit event (see above for description)
*/
- this.fieldErrors = new Ext.util.MixedCollection(true, function(item) {
- return item.field;
+ this.callParent(arguments);
+ this.editors = Ext.create('Ext.util.MixedCollection', false, function(editor) {
+ return editor.editorId;
});
+ },
- this.fieldErrors.on({
- scope : this,
- add : this.updateInvalidMark,
- remove : this.updateInvalidMark,
- replace: this.updateInvalidMark
- });
+ /**
+ * @private
+ * AbstractComponent calls destroy on all its plugins at destroy time.
+ */
+ destroy: function() {
+ var me = this;
+ me.editors.each(Ext.destroy, Ext);
+ me.editors.clear();
+ me.callParent(arguments);
+ },
+
+ // private
+ // Template method called from base class's initEvents
+ initCancelTriggers: function() {
+ var me = this;
+ grid = me.grid,
+ view = grid.view;
- Ext.form.CompositeField.superclass.initComponent.apply(this, arguments);
+ me.mon(view, {
+ mousewheel: {
+ element: 'el',
+ fn: me.cancelEdit,
+ scope: me
+ }
+ });
+ me.mon(grid, {
+ columnresize: me.cancelEdit,
+ columnmove: me.cancelEdit,
+ scope: me
+ });
},
/**
- * @private
- * Creates an internal container using hbox and renders the fields to it
+ * Start editing the specified record, using the specified Column definition to define which field is being edited.
+ * @param {Model} record The Store data record which backs the row to be edited.
+ * @param {Model} columnHeader The Column object defining the column to be edited.
+ * @override
*/
- onRender: function(ct, position) {
- if (!this.el) {
- /**
- * @property innerCt
- * @type Ext.Container
- * A container configured with hbox layout which is responsible for laying out the subfields
- */
- var innerCt = this.innerCt = new Ext.Container({
- layout : 'hbox',
- renderTo: ct,
- items : this.items,
- cls : 'x-form-composite',
- defaultMargins: '0 3 0 0'
- });
+ startEdit: function(record, columnHeader) {
+ var me = this,
+ ed = me.getEditor(record, columnHeader),
+ value = record.get(columnHeader.dataIndex),
+ context = me.getEditingContext(record, columnHeader);
- this.el = innerCt.getEl();
+ record = context.record;
+ columnHeader = context.column;
- var fields = innerCt.findBy(function(c) {
- return c.isFormField;
- }, this);
+ // Complete the edit now, before getting the editor's target
+ // cell DOM element. Completing the edit causes a view refresh.
+ me.completeEdit();
- /**
- * @property items
- * @type Ext.util.MixedCollection
- * Internal collection of all of the subfields in this Composite
- */
- this.items = new Ext.util.MixedCollection();
- this.items.addAll(fields);
-
- //if we're combining subfield errors into a single message, override the markInvalid and clearInvalid
- //methods of each subfield and show them at the Composite level instead
- if (this.combineErrors) {
- this.eachItem(function(field) {
- Ext.apply(field, {
- markInvalid : this.onFieldMarkInvalid.createDelegate(this, [field], 0),
- clearInvalid: this.onFieldClearInvalid.createDelegate(this, [field], 0)
- });
- });
- }
+ // See if the field is editable for the requested record
+ if (columnHeader && !columnHeader.getEditor(record)) {
+ return false;
+ }
- //set the label 'for' to the first item
- var l = this.el.parent().parent().child('label', true);
- if (l) {
- l.setAttribute('for', this.items.items[0].id);
+ if (ed) {
+ context.originalValue = context.value = value;
+ if (me.beforeEdit(context) === false || me.fireEvent('beforeedit', context) === false || context.cancel) {
+ return false;
}
+
+ me.context = context;
+ me.setActiveEditor(ed);
+ me.setActiveRecord(record);
+ me.setActiveColumn(columnHeader);
+
+ // Defer, so we have some time between view scroll to sync up the editor
+ Ext.defer(ed.startEdit, 15, ed, [me.getCell(record, columnHeader), value]);
+ } else {
+ // BrowserBug: WebKit & IE refuse to focus the element, rather
+ // it will focus it and then immediately focus the body. This
+ // temporary hack works for Webkit and IE6. IE7 and 8 are still
+ // broken
+ me.grid.getView().el.focus((Ext.isWebKit || Ext.isIE) ? 10 : false);
}
+ },
- Ext.form.CompositeField.superclass.onRender.apply(this, arguments);
+ completeEdit: function() {
+ var activeEd = this.getActiveEditor();
+ if (activeEd) {
+ activeEd.completeEdit();
+ }
},
- /**
- * Called if combineErrors is true and a subfield's markInvalid method is called.
- * By default this just adds the subfield's error to the internal fieldErrors MixedCollection
- * @param {Ext.form.Field} field The field that was marked invalid
- * @param {String} message The error message
- */
- onFieldMarkInvalid: function(field, message) {
- var name = field.getName(),
- error = {field: name, error: message};
+ // internal getters/setters
+ setActiveEditor: function(ed) {
+ this.activeEditor = ed;
+ },
- this.fieldErrors.replace(name, error);
+ getActiveEditor: function() {
+ return this.activeEditor;
+ },
- field.el.addClass(field.invalidClass);
+ setActiveColumn: function(column) {
+ this.activeColumn = column;
},
- /**
- * Called if combineErrors is true and a subfield's clearInvalid method is called.
- * By default this just updates the internal fieldErrors MixedCollection.
- * @param {Ext.form.Field} field The field that was marked invalid
- */
- onFieldClearInvalid: function(field) {
- this.fieldErrors.removeKey(field.getName());
+ getActiveColumn: function() {
+ return this.activeColumn;
+ },
+
+ setActiveRecord: function(record) {
+ this.activeRecord = record;
+ },
+
+ getActiveRecord: function() {
+ return this.activeRecord;
+ },
+
+ getEditor: function(record, column) {
+ var editors = this.editors,
+ editorId = column.itemId || column.id,
+ editor = editors.getByKey(editorId);
+
+ if (editor) {
+ return editor;
+ } else {
+ editor = column.getEditor(record);
+ if (!editor) {
+ return false;
+ }
- field.el.removeClass(field.invalidClass);
+ // Allow them to specify a CellEditor in the Column
+ if (!(editor instanceof Ext.grid.CellEditor)) {
+ editor = Ext.create('Ext.grid.CellEditor', {
+ editorId: editorId,
+ field: editor
+ });
+ }
+ editor.parentEl = this.grid.getEditorParent();
+ // editor.parentEl should be set here.
+ editor.on({
+ scope: this,
+ specialkey: this.onSpecialKey,
+ complete: this.onEditComplete,
+ canceledit: this.cancelEdit
+ });
+ editors.add(editor);
+ return editor;
+ }
},
/**
+ * Get the cell (td) for a particular record and column.
+ * @param {Ext.data.Model} record
+ * @param {Ext.grid.column.Colunm} column
* @private
- * Called after a subfield is marked valid or invalid, this checks to see if any of the subfields are
- * currently invalid. If any subfields are invalid it builds a combined error message marks the composite
- * invalid, otherwise clearInvalid is called
*/
- updateInvalidMark: function() {
- var ieStrict = Ext.isIE6 && Ext.isStrict;
-
- if (this.fieldErrors.length == 0) {
- this.clearInvalid();
+ getCell: function(record, column) {
+ return this.grid.getView().getCell(record, column);
+ },
- //IE6 in strict mode has a layout bug when using 'under' as the error message target. This fixes it
- if (ieStrict) {
- this.clearInvalid.defer(50, this);
+ onSpecialKey: function(ed, field, e) {
+ var grid = this.grid,
+ sm;
+ if (e.getKey() === e.TAB) {
+ e.stopEvent();
+ sm = grid.getSelectionModel();
+ if (sm.onEditorTab) {
+ sm.onEditorTab(this, e);
}
- } else {
- var message = this.buildCombinedErrorMessage(this.fieldErrors.items);
+ }
+ },
+
+ onEditComplete : function(ed, value, startValue) {
+ var me = this,
+ grid = me.grid,
+ sm = grid.getSelectionModel(),
+ dataIndex = me.getActiveColumn().dataIndex;
- this.sortErrors();
- this.markInvalid(message);
+ me.setActiveEditor(null);
+ me.setActiveColumn(null);
+ me.setActiveRecord(null);
+ delete sm.wasEditing;
- //IE6 in strict mode has a layout bug when using 'under' as the error message target. This fixes it
- if (ieStrict) {
- this.markInvalid(message);
- }
+ if (!me.validateEdit()) {
+ return;
}
+ me.context.record.set(dataIndex, value);
+ me.fireEvent('edit', me, me.context);
},
/**
- * Performs validation checks on each subfield and returns false if any of them fail validation.
- * @return {Boolean} False if any subfield failed validation
+ * Cancel any active editing.
*/
- validateValue: function() {
- var valid = true;
-
- this.eachItem(function(field) {
- if (!field.isValid()) valid = false;
- });
+ cancelEdit: function() {
+ var me = this,
+ activeEd = me.getActiveEditor(),
+ viewEl = me.grid.getView().el;
- return valid;
+ me.setActiveEditor(null);
+ me.setActiveColumn(null);
+ me.setActiveRecord(null);
+ if (activeEd) {
+ activeEd.cancelEdit();
+ viewEl.focus();
+ }
},
/**
- * Takes an object containing error messages for contained fields, returning a combined error
- * string (defaults to just placing each item on a new line). This can be overridden to provide
- * custom combined error message handling.
- * @param {Array} errors Array of errors in format: [{field: 'title', error: 'some error'}]
- * @return {String} The combined error message
+ * Starts editing by position (row/column)
+ * @param {Object} position A position with keys of row and column.
*/
- buildCombinedErrorMessage: function(errors) {
- var combined = [],
- error;
-
- for (var i = 0, j = errors.length; i < j; i++) {
- error = errors[i];
+ startEditByPosition: function(position) {
+ var me = this,
+ grid = me.grid,
+ sm = grid.getSelectionModel(),
+ editRecord = grid.store.getAt(position.row),
+ editColumnHeader = grid.headerCt.getHeaderAtIndex(position.column);
- combined.push(String.format("{0}: {1}", error.field, error.error));
+ if (sm.selectByPosition) {
+ sm.selectByPosition(position);
}
+ me.startEdit(editRecord, editColumnHeader);
+ }
+});
+/**
+ * @class Ext.grid.plugin.DragDrop
+ * This plugin provides drag and/or drop functionality for a GridView.
+ * It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a {@link Ext.grid.View GridView}
+ * and loads the data object which is passed to a cooperating {@link Ext.dd.DragZone DragZone}'s methods with the following properties:
+ * - copy : Boolean
+ * The value of the GridView's
copy
property, or true
if the GridView was configured
+ * with allowCopy: true
and the control key was pressed when the drag operation was begun.
+ * - view : GridView
+ * The source GridView from which the drag originated.
+ * - ddel : HtmlElement
+ * The drag proxy element which moves with the mouse
+ * - item : HtmlElement
+ * The GridView node upon which the mousedown event was registered.
+ * - records : Array
+ * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView.
+ *
+ * It also creates a specialized instance of {@link Ext.dd.DropZone} which cooperates with other DropZones which are members of the same
+ * ddGroup which processes such data objects.
+ * Adding this plugin to a view means that two new events may be fired from the client GridView, {@link #event-beforedrop beforedrop}
and
+ * {@link #event-drop drop}
+ */
+Ext.define('Ext.grid.plugin.DragDrop', {
+ extend: 'Ext.AbstractPlugin',
+ alias: 'plugin.gridviewdragdrop',
- return combined.join("
");
- },
+ uses: [
+ 'Ext.view.DragZone',
+ 'Ext.grid.ViewDropZone'
+ ],
/**
- * Sorts the internal fieldErrors MixedCollection by the order in which the fields are defined.
- * This is called before displaying errors to ensure that the errors are presented in the expected order.
- * This function can be overridden to provide a custom sorting order if needed.
+ * @event beforedrop
+ * This event is fired through the GridView. Add listeners to the GridView object
+ * Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.
+ * @param {HtmlElement} node The GridView node if any over which the mouse was positioned.
+ * Returning false
to this event signals that the drop gesture was invalid, and if the drag proxy
+ * will animate back to the point from which the drag began.
+ * Returning 0
To this event signals that the data transfer operation should not take place, but
+ * that the gesture was valid, and that the repair operation should not take place.
+ * Any other return value continues with the data transfer operation.
+ * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
+ * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:
+ * - copy : Boolean
+ * The value of the GridView's
copy
property, or true
if the GridView was configured
+ * with allowCopy: true
and the control key was pressed when the drag operation was begun
+ * - view : GridView
+ * The source GridView from which the drag originated.
+ * - ddel : HtmlElement
+ * The drag proxy element which moves with the mouse
+ * - item : HtmlElement
+ * The GridView node upon which the mousedown event was registered.
+ * - records : Array
+ * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView.
+ *
+ * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
+ * @param {String} dropPosition "before"
or "after"
depending on whether the mouse is above or below the midline of the node.
+ * @param {Function} dropFunction A function to call to complete the data transfer operation and either move or copy Model instances from the source
+ * View's Store to the destination View's Store.
+ * This is useful when you want to perform some kind of asynchronous processing before confirming
+ * the drop, such as an {@link Ext.window.MessageBox#confirm confirm} call, or an Ajax request.
+ * Return 0
from this event handler, and call the dropFunction
at any time to perform the data transfer.
+ */
+
+ /**
+ * @event drop
+ * This event is fired through the GridView. Add listeners to the GridView object
+ * Fired when a drop operation has been completed and the data has been moved or copied.
+ * @param {HtmlElement} node The GridView node if any over which the mouse was positioned.
+ * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
+ * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:
+ * - copy : Boolean
+ * The value of the GridView's
copy
property, or true
if the GridView was configured
+ * with allowCopy: true
and the control key was pressed when the drag operation was begun
+ * - view : GridView
+ * The source GridView from which the drag originated.
+ * - ddel : HtmlElement
+ * The drag proxy element which moves with the mouse
+ * - item : HtmlElement
+ * The GridView node upon which the mousedown event was registered.
+ * - records : Array
+ * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView.
+ *
+ * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
+ * @param {String} dropPosition "before"
or "after"
depending on whether the mouse is above or below the midline of the node.
*/
- sortErrors: function() {
- var fields = this.items;
-
- this.fieldErrors.sort("ASC", function(a, b) {
- var findByName = function(key) {
- return function(field) {
- return field.getName() == key;
- };
- };
- var aIndex = fields.findIndexBy(findByName(a.field)),
- bIndex = fields.findIndexBy(findByName(b.field));
+ dragText : '{0} selected row{1}',
- return aIndex < bIndex ? -1 : 1;
- });
- },
+ /**
+ * @cfg {String} ddGroup
+ * A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone
+ * used by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
+ */
+ ddGroup : "GridDD",
/**
- * Resets each field in the composite to their previous value
+ * @cfg {String} dragGroup
+ * The ddGroup to which the DragZone will belong.
+ * This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones
+ * which are members of the same ddGroup.
*/
- reset: function() {
- this.eachItem(function(item) {
- item.reset();
- });
- // Defer the clearInvalid so if BaseForm's collection is being iterated it will be called AFTER it is complete.
- // Important because reset is being called on both the group and the individual items.
- (function() {
- this.clearInvalid();
- }).defer(50, this);
- },
-
/**
- * Calls clearInvalid on all child fields. This is a convenience function and should not often need to be called
- * as fields usually take care of clearing themselves
+ * @cfg {String} dropGroup
+ * The ddGroup to which the DropZone will belong.
+ * This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones
+ * which are members of the same ddGroup.
*/
- clearInvalidChildren: function() {
- this.eachItem(function(item) {
- item.clearInvalid();
- });
- },
/**
- * Builds a label string from an array of subfield labels.
- * By default this just joins the labels together with a comma
- * @param {Array} segments Array of each of the labels in the composite field's subfields
- * @return {String} The built label
+ * @cfg {Boolean} enableDrop
+ * Defaults to true
+ * Set to false
to disallow the View from accepting drop gestures
*/
- buildLabel: function(segments) {
- return Ext.clean(segments).join(this.labelConnector);
- },
+ enableDrop: true,
/**
- * Checks each field in the composite and returns true if any is dirty
- * @return {Boolean} True if any field is dirty
+ * @cfg {Boolean} enableDrag
+ * Defaults to true
+ * Set to false
to disallow dragging items from the View
*/
- isDirty: function(){
- //override the behaviour to check sub items.
- if (this.disabled || !this.rendered) {
- return false;
- }
+ enableDrag: true,
- var dirty = false;
- this.eachItem(function(item){
- if(item.isDirty()){
- dirty = true;
- return false;
- }
- });
- return dirty;
+ init : function(view) {
+ view.on('render', this.onViewRender, this, {single: true});
},
/**
* @private
- * Convenience function which passes the given function to every item in the composite
- * @param {Function} fn The function to call
- * @param {Object} scope Optional scope object
+ * AbstractComponent calls destroy on all its plugins at destroy time.
*/
- eachItem: function(fn, scope) {
- if(this.items && this.items.each){
- this.items.each(fn, scope || this);
+ destroy: function() {
+ Ext.destroy(this.dragZone, this.dropZone);
+ },
+
+ onViewRender : function(view) {
+ var me = this;
+
+ if (me.enableDrag) {
+ me.dragZone = Ext.create('Ext.view.DragZone', {
+ view: view,
+ ddGroup: me.dragGroup || me.ddGroup,
+ dragText: me.dragText
+ });
+ }
+
+ if (me.enableDrop) {
+ me.dropZone = Ext.create('Ext.grid.ViewDropZone', {
+ view: view,
+ ddGroup: me.dropGroup || me.ddGroup
+ });
}
+ }
+});
+/**
+ * @class Ext.grid.plugin.HeaderReorderer
+ * @extends Ext.util.Observable
+ * @private
+ */
+Ext.define('Ext.grid.plugin.HeaderReorderer', {
+ extend: 'Ext.util.Observable',
+ requires: ['Ext.grid.header.DragZone', 'Ext.grid.header.DropZone'],
+ alias: 'plugin.gridheaderreorderer',
+
+ init: function(headerCt) {
+ this.headerCt = headerCt;
+ headerCt.on('render', this.onHeaderCtRender, this);
},
/**
* @private
- * Passes the resize call through to the inner panel
+ * AbstractComponent calls destroy on all its plugins at destroy time.
*/
- onResize: function(adjWidth, adjHeight, rawWidth, rawHeight) {
- var innerCt = this.innerCt;
+ destroy: function() {
+ Ext.destroy(this.dragZone, this.dropZone);
+ },
- if (this.rendered && innerCt.rendered) {
- innerCt.setSize(adjWidth, adjHeight);
+ onHeaderCtRender: function() {
+ this.dragZone = Ext.create('Ext.grid.header.DragZone', this.headerCt);
+ this.dropZone = Ext.create('Ext.grid.header.DropZone', this.headerCt);
+ if (this.disabled) {
+ this.dragZone.disable();
+ }
+ },
+
+ enable: function() {
+ this.disabled = false;
+ if (this.dragZone) {
+ this.dragZone.enable();
}
-
- Ext.form.CompositeField.superclass.onResize.apply(this, arguments);
},
+
+ disable: function() {
+ this.disabled = true;
+ if (this.dragZone) {
+ this.dragZone.disable();
+ }
+ }
+});
+/**
+ * @class Ext.grid.plugin.HeaderResizer
+ * @extends Ext.util.Observable
+ *
+ * Plugin to add header resizing functionality to a HeaderContainer.
+ * Always resizing header to the left of the splitter you are resizing.
+ *
+ * Todo: Consider RTL support, columns would always calculate to the right of
+ * the splitter instead of to the left.
+ */
+Ext.define('Ext.grid.plugin.HeaderResizer', {
+ extend: 'Ext.util.Observable',
+ requires: ['Ext.dd.DragTracker', 'Ext.util.Region'],
+ alias: 'plugin.gridheaderresizer',
+
+ disabled: false,
/**
- * @private
- * Forces the internal container to be laid out again
+ * @cfg {Boolean} dynamic
+ * Set to true to resize on the fly rather than using a proxy marker. Defaults to false.
*/
- doLayout: function(shallow, force) {
- if (this.rendered) {
- var innerCt = this.innerCt;
+ configs: {
+ dynamic: true
+ },
- innerCt.forceLayout = this.ownerCt.forceLayout;
- innerCt.doLayout(shallow, force);
- }
+ colHeaderCls: Ext.baseCSSPrefix + 'column-header',
+
+ minColWidth: 40,
+ maxColWidth: 1000,
+ wResizeCursor: 'col-resize',
+ eResizeCursor: 'col-resize',
+ // not using w and e resize bc we are only ever resizing one
+ // column
+ //wResizeCursor: Ext.isWebKit ? 'w-resize' : 'col-resize',
+ //eResizeCursor: Ext.isWebKit ? 'e-resize' : 'col-resize',
+
+ init: function(headerCt) {
+ this.headerCt = headerCt;
+ headerCt.on('render', this.afterHeaderRender, this, {single: true});
},
/**
* @private
+ * AbstractComponent calls destroy on all its plugins at destroy time.
*/
- beforeDestroy: function(){
- Ext.destroy(this.innerCt);
+ destroy: function() {
+ if (this.tracker) {
+ this.tracker.destroy();
+ }
+ },
+
+ afterHeaderRender: function() {
+ var headerCt = this.headerCt,
+ el = headerCt.el;
- Ext.form.CompositeField.superclass.beforeDestroy.call(this);
+ headerCt.mon(el, 'mousemove', this.onHeaderCtMouseMove, this);
+
+ this.tracker = Ext.create('Ext.dd.DragTracker', {
+ disabled: this.disabled,
+ onBeforeStart: Ext.Function.bind(this.onBeforeStart, this),
+ onStart: Ext.Function.bind(this.onStart, this),
+ onDrag: Ext.Function.bind(this.onDrag, this),
+ onEnd: Ext.Function.bind(this.onEnd, this),
+ tolerance: 3,
+ autoStart: 300,
+ el: el
+ });
},
- //override the behaviour to check sub items.
- setReadOnly : function(readOnly) {
- readOnly = readOnly || true;
+ // As we mouse over individual headers, change the cursor to indicate
+ // that resizing is available, and cache the resize target header for use
+ // if/when they mousedown.
+ onHeaderCtMouseMove: function(e, t) {
+ if (this.headerCt.dragging) {
+ if (this.activeHd) {
+ this.activeHd.el.dom.style.cursor = '';
+ delete this.activeHd;
+ }
+ } else {
+ var headerEl = e.getTarget('.' + this.colHeaderCls, 3, true),
+ overHeader, resizeHeader;
+
+ if (headerEl){
+ overHeader = Ext.getCmp(headerEl.id);
- if(this.rendered){
- this.eachItem(function(item){
- item.setReadOnly(readOnly);
- });
+ // On left edge, we are resizing the previous non-hidden, base level column.
+ if (overHeader.isOnLeftEdge(e)) {
+ resizeHeader = overHeader.previousNode('gridcolumn:not([hidden]):not([isGroupHeader])');
+ }
+ // Else, if on the right edge, we're resizing the column we are over
+ else if (overHeader.isOnRightEdge(e)) {
+ resizeHeader = overHeader;
+ }
+ // Between the edges: we are not resizing
+ else {
+ resizeHeader = null;
+ }
+
+ // We *are* resizing
+ if (resizeHeader) {
+ // If we're attempting to resize a group header, that cannot be resized,
+ // so find its last base level column header; Group headers are sized
+ // by the size of their child headers.
+ if (resizeHeader.isGroupHeader) {
+ resizeHeader = resizeHeader.getVisibleGridColumns();
+ resizeHeader = resizeHeader[resizeHeader.length - 1];
+ }
+
+ if (resizeHeader && !resizeHeader.fixed) {
+ this.activeHd = resizeHeader;
+ overHeader.el.dom.style.cursor = this.eResizeCursor;
+ }
+ // reset
+ } else {
+ overHeader.el.dom.style.cursor = '';
+ delete this.activeHd;
+ }
+ }
}
- this.readOnly = readOnly;
},
- onShow : function() {
- Ext.form.CompositeField.superclass.onShow.call(this);
- this.doLayout();
+ // only start when there is an activeHd
+ onBeforeStart : function(e){
+ var t = e.getTarget();
+ // cache the activeHd because it will be cleared.
+ this.dragHd = this.activeHd;
+
+ if (!!this.dragHd && !Ext.fly(t).hasCls('x-column-header-trigger') && !this.headerCt.dragging) {
+ //this.headerCt.dragging = true;
+ this.tracker.constrainTo = this.getConstrainRegion();
+ return true;
+ } else {
+ this.headerCt.dragging = false;
+ return false;
+ }
},
- //override the behaviour to check sub items.
- onDisable : function(){
- this.eachItem(function(item){
- item.disable();
- });
+ // get the region to constrain to, takes into account max and min col widths
+ getConstrainRegion: function() {
+ var dragHdEl = this.dragHd.el,
+ region = Ext.util.Region.getRegion(dragHdEl);
+
+ return region.adjust(
+ 0,
+ this.maxColWidth - dragHdEl.getWidth(),
+ 0,
+ this.minColWidth
+ );
},
- //override the behaviour to check sub items.
- onEnable : function(){
- this.eachItem(function(item){
- item.enable();
- });
+ // initialize the left and right hand side markers around
+ // the header that we are resizing
+ onStart: function(e){
+ var me = this,
+ dragHd = me.dragHd,
+ dragHdEl = dragHd.el,
+ width = dragHdEl.getWidth(),
+ headerCt = me.headerCt,
+ t = e.getTarget();
+
+ if (me.dragHd && !Ext.fly(t).hasCls('x-column-header-trigger')) {
+ headerCt.dragging = true;
+ }
+
+ me.origWidth = width;
+
+ // setup marker proxies
+ if (!me.dynamic) {
+ var xy = dragHdEl.getXY(),
+ gridSection = headerCt.up('[scrollerOwner]'),
+ dragHct = me.dragHd.up(':not([isGroupHeader])'),
+ firstSection = dragHct.up(),
+ lhsMarker = gridSection.getLhsMarker(),
+ rhsMarker = gridSection.getRhsMarker(),
+ el = rhsMarker.parent(),
+ offsetLeft = el.getLeft(true),
+ offsetTop = el.getTop(true),
+ topLeft = el.translatePoints(xy),
+ markerHeight = firstSection.body.getHeight() + headerCt.getHeight(),
+ top = topLeft.top - offsetTop;
+
+ lhsMarker.setTop(top);
+ rhsMarker.setTop(top);
+ lhsMarker.setHeight(markerHeight);
+ rhsMarker.setHeight(markerHeight);
+ lhsMarker.setLeft(topLeft.left - offsetLeft);
+ rhsMarker.setLeft(topLeft.left + width - offsetLeft);
+ }
+ },
+
+ // synchronize the rhsMarker with the mouse movement
+ onDrag: function(e){
+ if (!this.dynamic) {
+ var xy = this.tracker.getXY('point'),
+ gridSection = this.headerCt.up('[scrollerOwner]'),
+ rhsMarker = gridSection.getRhsMarker(),
+ el = rhsMarker.parent(),
+ topLeft = el.translatePoints(xy),
+ offsetLeft = el.getLeft(true);
+
+ rhsMarker.setLeft(topLeft.left - offsetLeft);
+ // Resize as user interacts
+ } else {
+ this.doResize();
+ }
+ },
+
+ onEnd: function(e){
+ this.headerCt.dragging = false;
+ if (this.dragHd) {
+ if (!this.dynamic) {
+ var dragHd = this.dragHd,
+ gridSection = this.headerCt.up('[scrollerOwner]'),
+ lhsMarker = gridSection.getLhsMarker(),
+ rhsMarker = gridSection.getRhsMarker(),
+ currWidth = dragHd.getWidth(),
+ offset = this.tracker.getOffset('point'),
+ offscreen = -9999;
+
+ // hide markers
+ lhsMarker.setLeft(offscreen);
+ rhsMarker.setLeft(offscreen);
+ }
+ this.doResize();
+ }
+ },
+
+ doResize: function() {
+ if (this.dragHd) {
+ var dragHd = this.dragHd,
+ nextHd,
+ offset = this.tracker.getOffset('point');
+
+ // resize the dragHd
+ if (dragHd.flex) {
+ delete dragHd.flex;
+ }
+
+ // If HeaderContainer is configured forceFit, inhibit upstream layout notification, so that
+ // we can also shrink the following Header by an equal amount, and *then* inform the upstream layout.
+ if (this.headerCt.forceFit) {
+ nextHd = dragHd.nextNode('gridcolumn:not([hidden]):not([isGroupHeader])');
+ if (nextHd) {
+ this.headerCt.componentLayout.layoutBusy = true;
+ }
+ }
+
+ // Non-flexed Headers may never be squeezed in the event of a shortfall so
+ // always set the minWidth to their current width.
+ dragHd.minWidth = this.origWidth + offset[0];
+ dragHd.setWidth(dragHd.minWidth);
+
+ // In the case of forceFit, change the following Header width.
+ // Then apply the two width changes by laying out the owning HeaderContainer
+ if (nextHd) {
+ delete nextHd.flex;
+ nextHd.setWidth(nextHd.getWidth() - offset[0]);
+ this.headerCt.componentLayout.layoutBusy = false;
+ this.headerCt.doComponentLayout();
+ }
+ }
+ },
+
+ disable: function() {
+ this.disabled = true;
+ if (this.tracker) {
+ this.tracker.disable();
+ }
+ },
+
+ enable: function() {
+ this.disabled = false;
+ if (this.tracker) {
+ this.tracker.enable();
+ }
}
});
-
-Ext.reg('compositefield', Ext.form.CompositeField);
/**
- * @class Ext.form.Radio
- * @extends Ext.form.Checkbox
- * Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type.
- * Radio grouping is handled automatically by the browser if you give each radio in a group the same name.
- * @constructor
- * Creates a new Radio
- * @param {Object} config Configuration options
- * @xtype radio
+ * @class Ext.grid.plugin.RowEditing
+ * @extends Ext.grid.plugin.Editing
+ *
+ * The Ext.grid.plugin.RowEditing plugin injects editing at a row level for a Grid. When editing begins,
+ * a small floating dialog will be shown for the appropriate row. Each editable column will show a field
+ * for editing. There is a button to save or cancel all changes for the edit.
+ *
+ * The field that will be used for the editor is defined at the
+ * {@link Ext.grid.column.Column#field field}. The editor can be a field instance or a field configuration.
+ * If an editor is not specified for a particular column then that column won't be editable and the value of
+ * the column will be displayed.
+ * The editor may be shared for each column in the grid, or a different one may be specified for each column.
+ * An appropriate field type should be chosen to match the data structure that it will be editing. For example,
+ * to edit a date, it would be useful to specify {@link Ext.form.field.Date} as the editor.
+ *
+ * {@img Ext.grid.plugin.RowEditing/Ext.grid.plugin.RowEditing.png Ext.grid.plugin.RowEditing plugin}
+ *
+ * ## Example Usage
+ * Ext.create('Ext.data.Store', {
+ * storeId:'simpsonsStore',
+ * fields:['name', 'email', 'phone'],
+ * data:{'items':[
+ * {"name":"Lisa", "email":"lisa@simpsons.com", "phone":"555-111-1224"},
+ * {"name":"Bart", "email":"bart@simpsons.com", "phone":"555--222-1234"},
+ * {"name":"Homer", "email":"home@simpsons.com", "phone":"555-222-1244"},
+ * {"name":"Marge", "email":"marge@simpsons.com", "phone":"555-222-1254"}
+ * ]},
+ * proxy: {
+ * type: 'memory',
+ * reader: {
+ * type: 'json',
+ * root: 'items'
+ * }
+ * }
+ * });
+ *
+ * Ext.create('Ext.grid.Panel', {
+ * title: 'Simpsons',
+ * store: Ext.data.StoreManager.lookup('simpsonsStore'),
+ * columns: [
+ * {header: 'Name', dataIndex: 'name', field: 'textfield'},
+ * {header: 'Email', dataIndex: 'email', flex:1,
+ * editor: {
+ * xtype:'textfield',
+ * allowBlank:false
+ * }
+ * },
+ * {header: 'Phone', dataIndex: 'phone'}
+ * ],
+ * selType: 'rowmodel',
+ * plugins: [
+ * Ext.create('Ext.grid.plugin.RowEditing', {
+ * clicksToEdit: 1
+ * })
+ * ],
+ * height: 200,
+ * width: 400,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * @markdown
+ *
*/
-Ext.form.Radio = Ext.extend(Ext.form.Checkbox, {
- inputType: 'radio',
+Ext.define('Ext.grid.plugin.RowEditing', {
+ extend: 'Ext.grid.plugin.Editing',
+ alias: 'plugin.rowediting',
+
+ requires: [
+ 'Ext.grid.RowEditor'
+ ],
+
+ editStyle: 'row',
/**
- * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
- * @method
+ * @cfg {Boolean} autoCancel
+ * `true` to automatically cancel any pending changes when the row editor begins editing a new row.
+ * `false` to force the user to explicitly cancel the pending changes. Defaults to `true`.
+ * @markdown
*/
- markInvalid : Ext.emptyFn,
+ autoCancel: true,
+
/**
- * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
- * @method
+ * @cfg {Number} clicksToMoveEditor
+ * The number of clicks to move the row editor to a new row while it is visible and actively editing another row.
+ * This will default to the same value as {@link Ext.grid.plugin.Editing#clicksToEdit clicksToEdit}.
+ * @markdown
*/
- clearInvalid : Ext.emptyFn,
/**
- * If this radio is part of a group, it will return the selected value
- * @return {String}
+ * @cfg {Boolean} errorSummary
+ * `true` to show a {@link Ext.tip.ToolTip tooltip} that summarizes all validation errors present
+ * in the row editor. Set to `false` to prevent the tooltip from showing. Defaults to `true`.
+ * @markdown
+ */
+ errorSummary: true,
+
+ /**
+ * @event beforeedit
+ * Fires before row editing is triggered. The edit event object has the following properties
+ *
+ * - grid - The grid this editor is on
+ * - view - The grid view
+ * - store - The grid store
+ * - record - The record being edited
+ * - row - The grid table row
+ * - column - The grid {@link Ext.grid.column.Column Column} defining the column that initiated the edit
+ * - rowIdx - The row index that is being edited
+ * - colIdx - The column index that initiated the edit
+ * - cancel - Set this to true to cancel the edit or return false from your handler.
+ *
+ * @param {Ext.grid.plugin.Editing} editor
+ * @param {Object} e An edit event (see above for description)
+ */
+ /**
+ * @event edit
+ * Fires after a row is edited. The edit event object has the following properties
+ *
+ * - grid - The grid this editor is on
+ * - view - The grid view
+ * - store - The grid store
+ * - record - The record being edited
+ * - row - The grid table row
+ * - column - The grid {@link Ext.grid.column.Column Column} defining the column that initiated the edit
+ * - rowIdx - The row index that is being edited
+ * - colIdx - The column index that initiated the edit
+ *
+ *
+ *
+grid.on('edit', onEdit, this);
+
+function onEdit(e) {
+ // execute an XHR to send/commit data to the server, in callback do (if successful):
+ e.record.commit();
+};
+ *
+ * @param {Ext.grid.plugin.Editing} editor
+ * @param {Object} e An edit event (see above for description)
+ */
+ /**
+ * @event validateedit
+ * Fires after a cell is edited, but before the value is set in the record. Return false
+ * to cancel the change. The edit event object has the following properties
+ *
+ * - grid - The grid this editor is on
+ * - view - The grid view
+ * - store - The grid store
+ * - record - The record being edited
+ * - row - The grid table row
+ * - column - The grid {@link Ext.grid.column.Column Column} defining the column that initiated the edit
+ * - rowIdx - The row index that is being edited
+ * - colIdx - The column index that initiated the edit
+ * - cancel - Set this to true to cancel the edit or return false from your handler.
+ *
+ * Usage example showing how to remove the red triangle (dirty record indicator) from some
+ * records (not all). By observing the grid's validateedit event, it can be cancelled if
+ * the edit occurs on a targeted row (for example) and then setting the field's new value
+ * in the Record directly:
+ *
+grid.on('validateedit', function(e) {
+ var myTargetRow = 6;
+
+ if (e.rowIdx == myTargetRow) {
+ e.cancel = true;
+ e.record.data[e.field] = e.value;
+ }
+});
+ *
+ * @param {Ext.grid.plugin.Editing} editor
+ * @param {Object} e An edit event (see above for description)
*/
- getGroupValue : function(){
- var p = this.el.up('form') || Ext.getBody();
- var c = p.child('input[name='+this.el.dom.name+']:checked', true);
- return c ? c.value : null;
+
+ constructor: function() {
+ var me = this;
+ me.callParent(arguments);
+
+ if (!me.clicksToMoveEditor) {
+ me.clicksToMoveEditor = me.clicksToEdit;
+ }
+
+ me.autoCancel = !!me.autoCancel;
},
- // private
- onClick : function(){
- if(this.el.dom.checked != this.checked){
- var els = this.getCheckEl().select('input[name=' + this.el.dom.name + ']');
- els.each(function(el){
- if(el.dom.id == this.id){
- this.setValue(true);
- }else{
- Ext.getCmp(el.dom.id).setValue(false);
- }
- }, this);
- }
+ /**
+ * @private
+ * AbstractComponent calls destroy on all its plugins at destroy time.
+ */
+ destroy: function() {
+ var me = this;
+ Ext.destroy(me.editor);
+ me.callParent(arguments);
},
/**
- * Sets either the checked/unchecked status of this Radio, or, if a string value
- * is passed, checks a sibling Radio of the same name whose value is the value specified.
- * @param value {String/Boolean} Checked value, or the value of the sibling radio button to check.
- * @return {Ext.form.Field} this
+ * Start editing the specified record, using the specified Column definition to define which field is being edited.
+ * @param {Model} record The Store data record which backs the row to be edited.
+ * @param {Model} columnHeader The Column object defining the column to be edited.
+ * @override
*/
- setValue : function(v){
- if (typeof v == 'boolean') {
- Ext.form.Radio.superclass.setValue.call(this, v);
- } else if (this.rendered) {
- var r = this.getCheckEl().child('input[name=' + this.el.dom.name + '][value=' + v + ']', true);
- if(r){
- Ext.getCmp(r.id).setValue(true);
- }
+ startEdit: function(record, columnHeader) {
+ var me = this,
+ editor = me.getEditor();
+
+ if (me.callParent(arguments) === false) {
+ return false;
+ }
+
+ // Fire off our editor
+ if (editor.beforeEdit() !== false) {
+ editor.startEdit(me.context.record, me.context.column);
}
- return this;
},
// private
- getCheckEl: function(){
- if(this.inGroup){
- return this.el.up('.x-form-radio-group')
+ cancelEdit: function() {
+ var me = this;
+
+ if (me.editing) {
+ me.getEditor().cancelEdit();
+ me.callParent(arguments);
}
- return this.el.up('form') || Ext.getBody();
- }
-});
-Ext.reg('radio', Ext.form.Radio);
-/**
- * @class Ext.form.RadioGroup
- * @extends Ext.form.CheckboxGroup
- * A grouping container for {@link Ext.form.Radio} controls.
- * @constructor
- * Creates a new RadioGroup
- * @param {Object} config Configuration options
- * @xtype radiogroup
- */
-Ext.form.RadioGroup = Ext.extend(Ext.form.CheckboxGroup, {
- /**
- * @cfg {Array} items An Array of {@link Ext.form.Radio Radio}s or Radio config objects
- * to arrange in the group.
- */
- /**
- * @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.
- */
- 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
- defaultType : 'radio',
-
+ completeEdit: function() {
+ var me = this;
+
+ if (me.editing && me.validateEdit()) {
+ me.editing = false;
+ me.fireEvent('edit', me.context);
+ }
+ },
+
// private
- groupCls : 'x-form-radio-group',
-
- /**
- * @event change
- * Fires when the state of a child radio changes.
- * @param {Ext.form.RadioGroup} this
- * @param {Ext.form.Radio} checked The checked radio
- */
-
- /**
- * Gets the selected {@link Ext.form.Radio} in the group, if it exists.
- * @return {Ext.form.Radio} The selected radio.
- */
- getValue : function(){
- var out = null;
- this.eachItem(function(item){
- if(item.checked){
- out = item;
- return false;
- }
- });
- return out;
+ validateEdit: function() {
+ var me = this;
+ return me.callParent(arguments) && me.getEditor().completeEdit();
},
-
- /**
- * Sets the checked radio in the group.
- * @param {String/Ext.form.Radio} id The radio to check.
- * @param {Boolean} value The value to set the radio.
- * @return {Ext.form.RadioGroup} this
- */
- onSetValue : function(id, value){
- if(arguments.length > 1){
- var f = this.getBox(id);
- if(f){
- f.setValue(value);
- if(f.checked){
- this.eachItem(function(item){
- if (item !== f){
- item.setValue(false);
- }
- });
- }
- }
- }else{
- this.setValueForItem(id);
+
+ // private
+ getEditor: function() {
+ var me = this;
+
+ if (!me.editor) {
+ me.editor = me.initEditor();
}
+ return me.editor;
},
-
- setValueForItem : function(val){
- val = String(val).split(',')[0];
- this.eachItem(function(item){
- item.setValue(val == item.inputValue);
+
+ // private
+ initEditor: function() {
+ var me = this,
+ grid = me.grid,
+ view = me.view,
+ headerCt = grid.headerCt;
+
+ return Ext.create('Ext.grid.RowEditor', {
+ autoCancel: me.autoCancel,
+ errorSummary: me.errorSummary,
+ fields: headerCt.getGridColumns(),
+ hidden: true,
+
+ // keep a reference..
+ editingPlugin: me,
+ renderTo: view.el
});
},
-
+
// private
- fireChecked : function(){
- if(!this.checkTask){
- this.checkTask = new Ext.util.DelayedTask(this.bufferChecked, this);
+ initEditTriggers: function() {
+ var me = this,
+ grid = me.grid,
+ view = me.view,
+ headerCt = grid.headerCt,
+ moveEditorEvent = me.clicksToMoveEditor === 1 ? 'click' : 'dblclick';
+
+ me.callParent(arguments);
+
+ if (me.clicksToMoveEditor !== me.clicksToEdit) {
+ me.mon(view, 'cell' + moveEditorEvent, me.moveEditorByClick, me);
+ }
+
+ view.on('render', function() {
+ // Column events
+ me.mon(headerCt, {
+ add: me.onColumnAdd,
+ remove: me.onColumnRemove,
+ columnresize: me.onColumnResize,
+ columnhide: me.onColumnHide,
+ columnshow: me.onColumnShow,
+ columnmove: me.onColumnMove,
+ scope: me
+ });
+ }, me, { single: true });
+ },
+
+ startEditByClick: function() {
+ var me = this;
+ if (!me.editing || me.clicksToMoveEditor === me.clicksToEdit) {
+ me.callParent(arguments);
}
- this.checkTask.delay(10);
},
-
+
+ moveEditorByClick: function() {
+ var me = this;
+ if (me.editing) {
+ me.superclass.startEditByClick.apply(me, arguments);
+ }
+ },
+
// private
- bufferChecked : function(){
- var out = null;
- this.eachItem(function(item){
- if(item.checked){
- out = item;
- return false;
- }
- });
- this.fireEvent('change', this, out);
+ onColumnAdd: function(ct, column) {
+ var me = this,
+ editor = me.getEditor();
+
+ me.initFieldAccessors(column);
+ if (editor && editor.onColumnAdd) {
+ editor.onColumnAdd(column);
+ }
},
-
- onDestroy : function(){
- if(this.checkTask){
- this.checkTask.cancel();
- this.checkTask = null;
+
+ // private
+ onColumnRemove: function(ct, column) {
+ var me = this,
+ editor = me.getEditor();
+
+ if (editor && editor.onColumnRemove) {
+ editor.onColumnRemove(column);
}
- Ext.form.RadioGroup.superclass.onDestroy.call(this);
- }
+ me.removeFieldAccessors(column);
+ },
-});
+ // private
+ onColumnResize: function(ct, column, width) {
+ var me = this,
+ editor = me.getEditor();
+
+ if (editor && editor.onColumnResize) {
+ editor.onColumnResize(column, width);
+ }
+ },
-Ext.reg('radiogroup', Ext.form.RadioGroup);
-/**
- * @class Ext.form.Hidden
- * @extends Ext.form.Field
- * A basic hidden field for storing hidden values in forms that need to be passed in the form submit.
- * @constructor
- * Create a new Hidden field.
- * @param {Object} config Configuration options
- * @xtype hidden
- */
-Ext.form.Hidden = Ext.extend(Ext.form.Field, {
// private
- inputType : 'hidden',
+ onColumnHide: function(ct, column) {
+ var me = this,
+ editor = me.getEditor();
+
+ if (editor && editor.onColumnHide) {
+ editor.onColumnHide(column);
+ }
+ },
// private
- onRender : function(){
- Ext.form.Hidden.superclass.onRender.apply(this, arguments);
+ onColumnShow: function(ct, column) {
+ var me = this,
+ editor = me.getEditor();
+
+ if (editor && editor.onColumnShow) {
+ editor.onColumnShow(column);
+ }
},
// private
- initEvents : function(){
- this.originalValue = this.getValue();
+ onColumnMove: function(ct, column, fromIdx, toIdx) {
+ var me = this,
+ editor = me.getEditor();
+
+ if (editor && editor.onColumnMove) {
+ editor.onColumnMove(column, fromIdx, toIdx);
+ }
},
- // These are all private overrides
- setSize : Ext.emptyFn,
- setWidth : Ext.emptyFn,
- setHeight : Ext.emptyFn,
- setPosition : Ext.emptyFn,
- setPagePosition : Ext.emptyFn,
- markInvalid : Ext.emptyFn,
- clearInvalid : Ext.emptyFn
+ // private
+ setColumnField: function(column, field) {
+ var me = this;
+ me.callParent(arguments);
+ me.getEditor().setField(column.field, column);
+ }
});
-Ext.reg('hidden', Ext.form.Hidden);/**
- * @class Ext.form.BasicForm
- * @extends Ext.util.Observable
- * Encapsulates the DOM <form> element at the heart of the {@link Ext.form.FormPanel FormPanel} class, and provides
- * input field management, validation, submission, and form loading services.
- * By default, Ext Forms are submitted through Ajax, using an instance of {@link Ext.form.Action.Submit}.
- * To enable normal browser submission of an Ext Form, use the {@link #standardSubmit} config option.
- * File Uploads
- * {@link #fileUpload File uploads} are not performed using Ajax submission, 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.
+/**
+ * @class Ext.grid.property.Grid
+ * @extends Ext.grid.Panel
+ * A specialized grid implementation intended to mimic the traditional property grid as typically seen in
+ * development IDEs. Each row in the grid represents a property of some object, and the data is stored
+ * as a set of name/value pairs in {@link Ext.grid.property.Property Properties}. Example usage:
+ *
+var grid = new Ext.grid.property.Grid({
+ title: 'Properties Grid',
+ width: 300,
+ renderTo: 'grid-ct',
+ source: {
+ "(name)": "My Object",
+ "Created": Ext.Date.parse('10/15/2006', 'm/d/Y'),
+ "Available": false,
+ "Version": .01,
+ "Description": "A test object"
+ }
+});
+
* @constructor
- * @param {Mixed} el The form element or its id
- * @param {Object} config Configuration options
+ * @param {Object} config The grid config object
*/
-Ext.form.BasicForm = Ext.extend(Ext.util.Observable, {
+Ext.define('Ext.grid.property.Grid', {
- constructor: function(el, config){
- Ext.apply(this, config);
- if(Ext.isString(this.paramOrder)){
- this.paramOrder = this.paramOrder.split(/[\s,|]/);
- }
- /**
- * A {@link Ext.util.MixedCollection MixedCollection} containing all the Ext.form.Fields in this form.
- * @type MixedCollection
- * @property items
- */
- this.items = new Ext.util.MixedCollection(false, function(o){
- return o.getItemId();
- });
- this.addEvents(
- /**
- * @event beforeaction
- * Fires before any action is performed. Return false to cancel the action.
- * @param {Form} this
- * @param {Action} action The {@link Ext.form.Action} to be performed
- */
- 'beforeaction',
- /**
- * @event actionfailed
- * Fires when an action fails.
- * @param {Form} this
- * @param {Action} action The {@link Ext.form.Action} that failed
- */
- 'actionfailed',
- /**
- * @event actioncomplete
- * Fires when an action is completed.
- * @param {Form} this
- * @param {Action} action The {@link Ext.form.Action} that completed
- */
- 'actioncomplete'
- );
+ extend: 'Ext.grid.Panel',
- if(el){
- this.initEl(el);
- }
- Ext.form.BasicForm.superclass.constructor.call(this);
- },
+ alternateClassName: 'Ext.grid.PropertyGrid',
+
+ uses: [
+ 'Ext.grid.plugin.CellEditing',
+ 'Ext.grid.property.Store',
+ 'Ext.grid.property.HeaderContainer',
+ 'Ext.XTemplate',
+ 'Ext.grid.CellEditor',
+ 'Ext.form.field.Date',
+ 'Ext.form.field.Text',
+ 'Ext.form.field.Number'
+ ],
+
+ /**
+ * @cfg {Object} propertyNames An object containing custom property name/display name pairs.
+ * If specified, the display name will be shown in the name column instead of the property name.
+ */
/**
- * @cfg {String} method
- * The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
- */
- /**
- * @cfg {DataReader} reader
- * An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to read
- * data when executing 'load' actions. This is optional as there is built-in
- * support for processing JSON. For additional information on using an XMLReader
- * see the example provided in examples/form/xml-form.html.
- */
+ * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
+ */
+
/**
- * @cfg {DataReader} errorReader
- * An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to
- * read field error messages returned from 'submit' actions. This is optional
- * as there is built-in support for processing JSON.
- * 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
- * DataReader. It simply needs to implement a read(xhr) function
- * which returns an Array of Records in an object with the following
- * structure:
-{
- records: recordArray
-}
+ * @cfg {Object} customEditors An object containing name/value pairs of custom editor type definitions that allow
+ * the grid to support additional types of editable fields. By default, the grid supports strongly-typed editing
+ * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
+ * associated with a custom input control by specifying a custom editor. The name of the editor
+ * type should correspond with the name of the property that will use the editor. Example usage:
+ *
+var grid = new Ext.grid.property.Grid({
+
+ // Custom editors for certain property names
+ customEditors: {
+ evtStart: Ext.create('Ext.form.TimeField' {selectOnFocus:true})
+ },
+
+ // Displayed name for property names in the source
+ propertyNames: {
+ evtStart: 'Start Time'
+ },
+
+ // Data object containing properties to edit
+ source: {
+ evtStart: '10:00 AM'
+ }
+});
- */
- /**
- * @cfg {String} url
- * The URL to use for form actions if one isn't supplied in the
- * {@link #doAction doAction} options
.
- */
- /**
- * @cfg {Boolean} fileUpload
- * Set to true if this form is a file upload.
- * 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.
- */
- /**
- * @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}.
- */
- /**
- * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
- */
- timeout: 30,
+ */
/**
- * @cfg {Object} api (Optional) If specified load and submit actions will be handled
- * with {@link Ext.form.Action.DirectLoad} and {@link Ext.form.Action.DirectSubmit}.
- * Methods which have been imported by Ext.Direct can be specified here to load and submit
- * forms.
- * Such as the following:
-api: {
- load: App.ss.MyProfile.load,
- submit: App.ss.MyProfile.submit
-}
-
- * Load actions can use {@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 Ext.Direct
- */
+ * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
+ */
/**
- * @cfg {Array/String} paramOrder 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:
-paramOrder: ['param1','param2','param3']
-paramOrder: 'param1 param2 param3'
-paramOrder: 'param1,param2,param3'
-paramOrder: 'param1|param2|param'
-
- */
- paramOrder: undefined,
+ * @cfg {Object} customRenderers An object containing name/value pairs of custom renderer type definitions that allow
+ * the grid to support custom rendering of fields. By default, the grid supports strongly-typed rendering
+ * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
+ * associated with the type of the value. The name of the renderer type should correspond with the name of the property
+ * that it will render. Example usage:
+ *
+var grid = Ext.create('Ext.grid.property.Grid', {
+ customRenderers: {
+ Available: function(v){
+ if (v) {
+ return 'Yes';
+ } else {
+ return 'No';
+ }
+ }
+ },
+ source: {
+ Available: true
+ }
+});
+
+ */
/**
- * @cfg {Boolean} paramsAsHash Only used for the {@link #api}
- * load
configuration. Send parameters as a collection of named
- * arguments (defaults to false). Providing a
- * {@link #paramOrder} nullifies this configuration.
+ * @cfg {String} valueField
+ * Optional. The name of the field from the property store to use as the value field name. Defaults to 'value'
+ * This may be useful if you do not configure the property Grid from an object, but use your own store configuration.
*/
- paramsAsHash: false,
+ valueField: 'value',
/**
- * @cfg {String} waitTitle
- * The default title to show for the waiting message box (defaults to 'Please Wait...')
+ * @cfg {String} nameField
+ * Optional. The name of the field from the property store to use as the property field name. Defaults to 'name'
+ * This may be useful if you do not configure the property Grid from an object, but use your own store configuration.
*/
- waitTitle: 'Please Wait...',
+ nameField: 'name',
+
+ // private config overrides
+ enableColumnMove: false,
+ columnLines: true,
+ stripeRows: false,
+ trackMouseOver: false,
+ clicksToEdit: 1,
+ enableHdMenu: false,
// private
- activeAction : null,
+ initComponent : function(){
+ var me = 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,
+ me.addCls(Ext.baseCSSPrefix + 'property-grid');
+ me.plugins = me.plugins || [];
- /**
- * @cfg {Boolean} standardSubmit
- * If set to true, standard HTML form submits are used instead
- * of XHR (Ajax) style form submissions. Defaults to false.
- *
Note: When using standardSubmit
, the
- * options
to {@link #submit}
are ignored because
- * Ext's Ajax infrastracture is bypassed. To pass extra parameters (e.g.
- * baseParams
and params
), utilize hidden fields
- * to submit extra data, for example:
- *
-new Ext.FormPanel({
- standardSubmit: true,
- baseParams: {
- foo: 'bar'
- },
- {@link url}: 'myProcess.php',
- items: [{
- xtype: 'textfield',
- name: 'userName'
- }],
- buttons: [{
- text: 'Save',
- handler: function(){
- var fp = this.ownerCt.ownerCt,
- form = fp.getForm();
- if (form.isValid()) {
- // check if there are baseParams and if
- // hiddent items have been added already
- if (fp.baseParams && !fp.paramsAdded) {
- // add hidden items for all baseParams
- for (i in fp.baseParams) {
- fp.add({
- xtype: 'hidden',
- name: i,
- value: fp.baseParams[i]
- });
- }
- fp.doLayout();
- // set a custom flag to prevent re-adding
- fp.paramsAdded = true;
+ // Enable cell editing. Inject a custom startEdit which always edits column 1 regardless of which column was clicked.
+ me.plugins.push(Ext.create('Ext.grid.plugin.CellEditing', {
+ clicksToEdit: me.clicksToEdit,
+
+ // Inject a startEdit which always edits the value column
+ startEdit: function(record, column) {
+ // Maintainer: Do not change this 'this' to 'me'! It is the CellEditing object's own scope.
+ Ext.grid.plugin.CellEditing.prototype.startEdit.call(this, record, me.headerCt.child('#' + me.valueField));
+ }
+ }));
+
+ me.selModel = {
+ selType: 'cellmodel',
+ onCellSelect: function(position) {
+ if (position.column != 1) {
+ position.column = 1;
+ Ext.selection.CellModel.prototype.onCellSelect.call(this, position);
}
- form.{@link #submit}();
}
+ };
+ me.customRenderers = me.customRenderers || {};
+ me.customEditors = me.customEditors || {};
+
+ // Create a property.Store from the source object unless configured with a store
+ if (!me.store) {
+ me.propStore = me.store = Ext.create('Ext.grid.property.Store', me, me.source);
}
- }]
-});
- *
- */
- /**
- * 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.
- * @type Mixed
- * @property waitMsgTarget
- */
+
+ me.store.sort('name', 'ASC');
+ me.columns = Ext.create('Ext.grid.property.HeaderContainer', me, me.store);
+
+ me.addEvents(
+ /**
+ * @event beforepropertychange
+ * Fires before a property value changes. Handlers can return false to cancel the property change
+ * (this will internally call {@link Ext.data.Record#reject} on the property's record).
+ * @param {Object} source The source data object for the grid (corresponds to the same object passed in
+ * as the {@link #source} config property).
+ * @param {String} recordId The record's id in the data store
+ * @param {Mixed} value The current edited property value
+ * @param {Mixed} oldValue The original property value prior to editing
+ */
+ 'beforepropertychange',
+ /**
+ * @event propertychange
+ * Fires after a property value has changed.
+ * @param {Object} source The source data object for the grid (corresponds to the same object passed in
+ * as the {@link #source} config property).
+ * @param {String} recordId The record's id in the data store
+ * @param {Mixed} value The current edited property value
+ * @param {Mixed} oldValue The original property value prior to editing
+ */
+ 'propertychange'
+ );
+ me.callParent();
+
+ // Inject a custom implementation of walkCells which only goes up or down
+ me.getView().walkCells = this.walkCells;
+
+ // Set up our default editor set for the 4 atomic data types
+ me.editors = {
+ 'date' : Ext.create('Ext.grid.CellEditor', { field: Ext.create('Ext.form.field.Date', {selectOnFocus: true})}),
+ 'string' : Ext.create('Ext.grid.CellEditor', { field: Ext.create('Ext.form.field.Text', {selectOnFocus: true})}),
+ 'number' : Ext.create('Ext.grid.CellEditor', { field: Ext.create('Ext.form.field.Number', {selectOnFocus: true})}),
+ 'boolean' : Ext.create('Ext.grid.CellEditor', { field: Ext.create('Ext.form.field.ComboBox', {
+ editable: false,
+ store: [[ true, me.headerCt.trueText ], [false, me.headerCt.falseText ]]
+ })})
+ };
+
+ // Track changes to the data so we can fire our events.
+ this.store.on('update', me.onUpdate, me);
+ },
// private
- initEl : function(el){
- this.el = Ext.get(el);
- this.id = this.el.id || Ext.id();
- if(!this.standardSubmit){
- this.el.on('submit', this.onSubmit, this);
+ onUpdate : function(store, record, operation) {
+ var me = this,
+ v, oldValue;
+
+ if (operation == Ext.data.Model.EDIT) {
+ v = record.get(me.valueField);
+ oldValue = record.modified.value;
+ if (me.fireEvent('beforepropertychange', me.source, record.id, v, oldValue) !== false) {
+ if (me.source) {
+ me.source[record.id] = v;
+ }
+ record.commit();
+ me.fireEvent('propertychange', me.source, record.id, v, oldValue);
+ } else {
+ record.reject();
+ }
}
- this.el.addClass('x-form');
},
- /**
- * Get the HTML form Element
- * @return Ext.Element
- */
- getEl: function(){
- return this.el;
+ // Custom implementation of walkCells which only goes up and down.
+ walkCells: function(pos, direction, e, preventWrap, verifierFn, scope) {
+ if (direction == 'left') {
+ direction = 'up';
+ } else if (direction == 'right') {
+ direction = 'down';
+ }
+ var pos = Ext.view.Table.prototype.walkCells.call(this, pos, direction, e, preventWrap, verifierFn, scope);
+ if (!pos.column) {
+ pos.column = 1;
+ }
+ return pos;
},
// private
- onSubmit : function(e){
- e.stopEvent();
+ // returns the correct editor type for the property type, or a custom one keyed by the property name
+ getCellEditor : function(record, column) {
+ var me = this,
+ propName = record.get(me.nameField),
+ val = record.get(me.valueField),
+ editor = me.customEditors[propName];
+
+ // A custom editor was found. If not already wrapped with a CellEditor, wrap it, and stash it back
+ // If it's not even a Field, just a config object, instantiate it before wrapping it.
+ if (editor) {
+ if (!(editor instanceof Ext.grid.CellEditor)) {
+ if (!(editor instanceof Ext.form.field.Base)) {
+ editor = Ext.ComponentManager.create(editor, 'textfield');
+ }
+ editor = me.customEditors[propName] = Ext.create('Ext.grid.CellEditor', { field: editor });
+ }
+ } else if (Ext.isDate(val)) {
+ editor = me.editors.date;
+ } else if (Ext.isNumber(val)) {
+ editor = me.editors.number;
+ } else if (Ext.isBoolean(val)) {
+ editor = me.editors['boolean'];
+ } else {
+ editor = me.editors.string;
+ }
+
+ // Give the editor a unique ID because the CellEditing plugin caches them
+ editor.editorId = propName;
+ return editor;
},
- /**
- * Destroys this object.
- * @private
- * @param {Boolean} bound true if the object is bound to a form panel. If this is the case
- * the FormPanel will take care of destroying certain things, so we're just doubling up.
- */
- destroy: function(bound){
- if(bound !== true){
- this.items.each(function(f){
- Ext.destroy(f);
- });
- Ext.destroy(this.el);
+ beforeDestroy: function() {
+ var me = this;
+ me.callParent();
+ me.destroyEditors(me.editors);
+ me.destroyEditors(me.customEditors);
+ delete me.source;
+ },
+
+ destroyEditors: function (editors) {
+ for (var ed in editors) {
+ Ext.destroy(editors[ed]);
}
- this.items.clear();
- this.purgeListeners();
},
/**
- * Returns true if client-side validation on the form is successful.
- * @return Boolean
+ * Sets the source data object containing the property data. The data object can contain one or more name/value
+ * pairs representing all of the properties of an object to display in the grid, and this data will automatically
+ * be loaded into the grid's {@link #store}. The values should be supplied in the proper data type if needed,
+ * otherwise string type will be assumed. If the grid already contains data, this method will replace any
+ * existing data. See also the {@link #source} config value. Example usage:
+ *
+grid.setSource({
+ "(name)": "My Object",
+ "Created": Ext.Date.parse('10/15/2006', 'm/d/Y'), // date type
+ "Available": false, // boolean type
+ "Version": .01, // decimal type
+ "Description": "A test object"
+});
+
+ * @param {Object} source The data object
*/
- isValid : function(){
- var valid = true;
- this.items.each(function(f){
- if(!f.validate()){
- valid = false;
- }
- });
- return valid;
+ setSource: function(source) {
+ this.source = source;
+ this.propStore.setSource(source);
},
/**
- * 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
+ * Gets the source data object containing the property data. See {@link #setSource} for details regarding the
+ * format of the data object.
+ * @return {Object} The data object
*/
- isDirty : function(){
- var dirty = false;
- this.items.each(function(f){
- if(f.isDirty()){
- dirty = true;
- return false;
- }
- });
- return dirty;
+ getSource: function() {
+ return this.propStore.getSource();
},
/**
- * Performs a predefined action ({@link Ext.form.Action.Submit} or
- * {@link Ext.form.Action.Load}) or a custom extension of {@link Ext.form.Action}
- * to perform application-specific processing.
- * @param {String/Object} actionName The name of the predefined action type,
- * or instance of {@link Ext.form.Action} to perform.
- * @param {Object} options (optional) The options to pass to the {@link Ext.form.Action}.
- * 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):
- *
- * - url : StringThe url for the action (defaults
- * to the form's {@link #url}.)
- *
- * - method : StringThe 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}.
- *
- * - headers : ObjectRequest headers to set for the action
- * (defaults to the form's default headers)
- *
- * - success : FunctionThe 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 : Ext.form.BasicFormThe form that requested the action
- * - action : The {@link Ext.form.Action Action} object which performed the operation.
- * The action object contains these properties of interest:
- * - {@link Ext.form.Action#response response}
- * - {@link Ext.form.Action#result result} : interrogate for custom postprocessing
- * - {@link Ext.form.Action#type type}
- *
- *
- * - failure : FunctionThe callback that will be invoked after a
- * failed transaction attempt. The function is passed the following parameters:
- * - form : The {@link Ext.form.BasicForm} that requested the action.
- * - action : The {@link Ext.form.Action Action} object which performed the operation.
- * The action object contains these properties of interest:
- * - {@link Ext.form.Action#failureType failureType}
- * - {@link Ext.form.Action#response response}
- * - {@link Ext.form.Action#result result} : interrogate for custom postprocessing
- * - {@link Ext.form.Action#type type}
- *
- *
- * - scope : ObjectThe scope in which to call the
- * callback functions (The this reference for the callback functions).
- *
- * - clientValidation : BooleanSubmit Action only.
- * Determines whether a Form's fields are validated in a final call to
- * {@link Ext.form.BasicForm#isValid isValid} prior to submission. Set to false
- * to prevent this. If undefined, pre-submission field validation is performed.
- *
- * @return {BasicForm} this
+ * Sets the value of a property.
+ * @param {String} prop The name of the property to set
+ * @param {Mixed} value The value to test
+ * @param {Boolean} create (Optional) True to create the property if it doesn't already exist. Defaults to false.
*/
- doAction : function(action, options){
- if(Ext.isString(action)){
- action = new Ext.form.Action.ACTION_TYPES[action](this, options);
- }
- if(this.fireEvent('beforeaction', this, action) !== false){
- this.beforeAction(action);
- action.run.defer(100, action);
- }
- return this;
+ setProperty: function(prop, value, create) {
+ this.propStore.setValue(prop, value, create);
},
/**
- * Shortcut to {@link #doAction do} a {@link Ext.form.Action.Submit submit action}.
- * @param {Object} options The options to pass to the action (see {@link #doAction} for details).
- * Note: this is ignored when using the {@link #standardSubmit} option.
- * The following code:
-myFormPanel.getForm().submit({
- clientValidation: true,
- url: 'updateConsignment.php',
- params: {
- newStatus: 'delivered'
- },
- success: function(form, action) {
- Ext.Msg.alert('Success', action.result.msg);
- },
- failure: function(form, action) {
- switch (action.failureType) {
- case Ext.form.Action.CLIENT_INVALID:
- Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');
- break;
- case Ext.form.Action.CONNECT_FAILURE:
- Ext.Msg.alert('Failure', 'Ajax communication failed');
- break;
- case Ext.form.Action.SERVER_INVALID:
- Ext.Msg.alert('Failure', action.result.msg);
- }
- }
-});
-
- * would process the following server response for a successful submission:
-{
- "success":true, // note this is Boolean, not string
- "msg":"Consignment updated"
-}
-
- * and the following server response for a failed submission:
-{
- "success":false, // note this is Boolean, not string
- "msg":"You do not have permission to perform this operation"
-}
-
- * @return {BasicForm} this
+ * Removes a property from the grid.
+ * @param {String} prop The name of the property to remove
*/
- submit : function(options){
- options = options || {};
- if(this.standardSubmit){
- var v = options.clientValidation === false || this.isValid();
- if(v){
- var el = this.el.dom;
- if(this.url && Ext.isEmpty(el.action)){
- el.action = this.url;
- }
- el.submit();
- }
- return v;
- }
- var submitAction = String.format('{0}submit', this.api ? 'direct' : '');
- this.doAction(submitAction, options);
- return this;
- },
+ removeProperty: function(prop) {
+ this.propStore.remove(prop);
+ }
/**
- * 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 {BasicForm} this
+ * @cfg store
+ * @hide
*/
- load : function(options){
- var loadAction = String.format('{0}load', this.api ? 'direct' : '');
- this.doAction(loadAction, options);
- return this;
- },
-
/**
- * Persists the values in this form into the passed {@link Ext.data.Record} object in a beginEdit/endEdit block.
- * @param {Record} record The record to edit
- * @return {BasicForm} this
+ * @cfg colModel
+ * @hide
*/
- updateRecord : function(record){
- record.beginEdit();
- var fs = record.fields;
- fs.each(function(f){
- var field = this.findField(f.name);
- if(field){
- record.set(f.name, field.getValue());
- }
- }, this);
- record.endEdit();
- return this;
- },
-
/**
- * Loads an {@link Ext.data.Record} into this form by calling {@link #setValues} with the
- * {@link Ext.data.Record#data record data}.
- * See also {@link #trackResetOnLoad}.
- * @param {Record} record The record to load
- * @return {BasicForm} this
+ * @cfg cm
+ * @hide
*/
- loadRecord : function(record){
- this.setValues(record.data);
- return this;
+ /**
+ * @cfg columns
+ * @hide
+ */
+});
+/**
+ * @class Ext.grid.property.HeaderContainer
+ * @extends Ext.grid.header.Container
+ * A custom HeaderContainer for the {@link Ext.grid.property.Grid}. Generally it should not need to be used directly.
+ * @constructor
+ * @param {Ext.grid.property.Grid} grid The grid this store will be bound to
+ * @param {Object} source The source data config object
+ */
+Ext.define('Ext.grid.property.HeaderContainer', {
+
+ extend: 'Ext.grid.header.Container',
+
+ alternateClassName: 'Ext.grid.PropertyColumnModel',
+
+ // private - strings used for locale support
+ nameText : 'Name',
+ valueText : 'Value',
+ dateFormat : 'm/j/Y',
+ trueText: 'true',
+ falseText: 'false',
+
+ // private
+ nameColumnCls: Ext.baseCSSPrefix + 'grid-property-name',
+
+ constructor : function(grid, store) {
+
+ this.grid = grid;
+ this.store = store;
+ this.callParent([{
+ items: [{
+ header: this.nameText,
+ width: 115,
+ sortable: true,
+ dataIndex: grid.nameField,
+ renderer: Ext.Function.bind(this.renderProp, this),
+ itemId: grid.nameField,
+ menuDisabled :true,
+ tdCls: this.nameColumnCls
+ }, {
+ header: this.valueText,
+ renderer: Ext.Function.bind(this.renderCell, this),
+ getEditor: function(record) {
+ return grid.getCellEditor(record, this);
+ },
+ flex: 1,
+ fixed: true,
+ dataIndex: grid.valueField,
+ itemId: grid.valueField,
+ menuDisabled: true
+ }]
+ }]);
},
// private
- beforeAction : function(action){
- // Call HtmlEditor's syncValue before actions
- this.items.each(function(f){
- if(f.isFormField && f.syncValue){
- f.syncValue();
- }
- });
- var o = action.options;
- if(o.waitMsg){
- if(this.waitMsgTarget === true){
- this.el.mask(o.waitMsg, 'x-mask-loading');
- }else if(this.waitMsgTarget){
- this.waitMsgTarget = Ext.get(this.waitMsgTarget);
- this.waitMsgTarget.mask(o.waitMsg, 'x-mask-loading');
- }else{
- Ext.MessageBox.wait(o.waitMsg, o.waitTitle || this.waitTitle);
- }
- }
+ // Render a property name cell
+ renderProp : function(v) {
+ return this.getPropertyName(v);
},
// private
- afterAction : function(action, success){
- this.activeAction = null;
- var o = action.options;
- if(o.waitMsg){
- if(this.waitMsgTarget === true){
- this.el.unmask();
- }else if(this.waitMsgTarget){
- this.waitMsgTarget.unmask();
- }else{
- Ext.MessageBox.updateProgress(1);
- Ext.MessageBox.hide();
- }
+ // Render a property value cell
+ renderCell : function(val, meta, rec) {
+ var me = this,
+ renderer = this.grid.customRenderers[rec.get(me.grid.nameField)],
+ result = val;
+
+ if (renderer) {
+ return renderer.apply(this, arguments);
}
- if(success){
- if(o.reset){
- this.reset();
- }
- Ext.callback(o.success, o.scope, [this, action]);
- this.fireEvent('actioncomplete', this, action);
- }else{
- Ext.callback(o.failure, o.scope, [this, action]);
- this.fireEvent('actionfailed', this, action);
+ if (Ext.isDate(val)) {
+ result = this.renderDate(val);
+ } else if (Ext.isBoolean(val)) {
+ result = this.renderBool(val);
}
+ return Ext.util.Format.htmlEncode(result);
},
- /**
- * Find a {@link Ext.form.Field} in this form.
- * @param {String} id The value to search for (specify either a {@link Ext.Component#id id},
- * {@link Ext.grid.Column#dataIndex dataIndex}, {@link Ext.form.Field#getName name or hiddenName}).
- * @return Field
- */
- findField : function(id) {
- var field = this.items.get(id);
+ // private
+ renderDate : Ext.util.Format.date,
- if (!Ext.isObject(field)) {
- //searches for the field corresponding to the given id. Used recursively for composite fields
- var findMatchingField = function(f) {
- if (f.isFormField) {
- if (f.dataIndex == id || f.id == id || f.getName() == id) {
- field = f;
- return false;
- } else if (f.isComposite && f.rendered) {
- return f.items.each(findMatchingField);
- }
- }
- };
+ // private
+ renderBool : function(bVal) {
+ return this[bVal ? 'trueText' : 'falseText'];
+ },
+
+ // private
+ // Renders custom property names instead of raw names if defined in the Grid
+ getPropertyName : function(name) {
+ var pn = this.grid.propertyNames;
+ return pn && pn[name] ? pn[name] : name;
+ }
+});
+/**
+ * @class Ext.grid.property.Property
+ * A specific {@link Ext.data.Model} type that represents a name/value pair and is made to work with the
+ * {@link Ext.grid.property.Grid}. Typically, Properties do not need to be created directly as they can be
+ * created implicitly by simply using the appropriate data configs either via the {@link Ext.grid.property.Grid#source}
+ * config property or by calling {@link Ext.grid.property.Grid#setSource}. However, if the need arises, these records
+ * can also be created explicitly as shown below. Example usage:
+ *
+var rec = new Ext.grid.property.Property({
+ name: 'birthday',
+ value: Ext.Date.parse('17/06/1962', 'd/m/Y')
+});
+// Add record to an already populated grid
+grid.store.addSorted(rec);
+
+ * @constructor
+ * @param {Object} config A data object in the format:
+{
+ name: [name],
+ value: [value]
+}
+ * The specified value's type
+ * will be read automatically by the grid to determine the type of editor to use when displaying it.
+ */
+Ext.define('Ext.grid.property.Property', {
+ extend: 'Ext.data.Model',
+
+ alternateClassName: 'Ext.PropGridProperty',
+
+ fields: [{
+ name: 'name',
+ type: 'string'
+ }, {
+ name: 'value'
+ }],
+ idProperty: 'name'
+});
+/**
+ * @class Ext.grid.property.Store
+ * @extends Ext.data.Store
+ * A custom {@link Ext.data.Store} for the {@link Ext.grid.property.Grid}. This class handles the mapping
+ * between the custom data source objects supported by the grid and the {@link Ext.grid.property.Property} format
+ * used by the {@link Ext.data.Store} base class.
+ * @constructor
+ * @param {Ext.grid.Grid} grid The grid this store will be bound to
+ * @param {Object} source The source data config object
+ */
+Ext.define('Ext.grid.property.Store', {
+
+ extend: 'Ext.data.Store',
+
+ alternateClassName: 'Ext.grid.PropertyStore',
+
+ uses: ['Ext.data.reader.Reader', 'Ext.data.proxy.Proxy', 'Ext.data.ResultSet', 'Ext.grid.property.Property'],
- this.items.each(findMatchingField);
+ constructor : function(grid, source){
+ this.grid = grid;
+ this.source = source;
+ this.callParent([{
+ data: source,
+ model: Ext.grid.property.Property,
+ proxy: this.getProxy()
+ }]);
+ },
+
+ // Return a singleton, customized Proxy object which configures itself with a custom Reader
+ getProxy: function() {
+ if (!this.proxy) {
+ Ext.grid.property.Store.prototype.proxy = Ext.create('Ext.data.proxy.Memory', {
+ model: Ext.grid.property.Property,
+ reader: this.getReader()
+ });
}
- return field || null;
+ return this.proxy;
},
+ // Return a singleton, customized Reader object which reads Ext.grid.property.Property records from an object.
+ getReader: function() {
+ if (!this.reader) {
+ Ext.grid.property.Store.prototype.reader = Ext.create('Ext.data.reader.Reader', {
+ model: Ext.grid.property.Property,
- /**
- * Mark fields in this form invalid in bulk.
- * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
- * @return {BasicForm} this
- */
- markInvalid : function(errors){
- if (Ext.isArray(errors)) {
- for(var i = 0, len = errors.length; i < len; i++){
- var fieldError = errors[i];
- var f = this.findField(fieldError.id);
- if(f){
- f.markInvalid(fieldError.msg);
- }
- }
- } else {
- var field, id;
- for(id in errors){
- if(!Ext.isFunction(errors[id]) && (field = this.findField(id))){
- field.markInvalid(errors[id]);
- }
- }
- }
+ buildExtractors: Ext.emptyFn,
- return this;
- },
+ read: function(dataObject) {
+ return this.readRecords(dataObject);
+ },
- /**
- * Set values for fields in this form in bulk.
- * @param {Array/Object} values Either an array in the form:
-[{id:'clientName', value:'Fred. Olsen Lines'},
- {id:'portOfLoading', value:'FXT'},
- {id:'portOfDischarge', value:'OSL'} ]
- * or an object hash of the form:
-{
- clientName: 'Fred. Olsen Lines',
- portOfLoading: 'FXT',
- portOfDischarge: 'OSL'
-}
- * @return {BasicForm} this
- */
- setValues : function(values){
- if(Ext.isArray(values)){ // array of objects
- for(var i = 0, len = values.length; i < len; i++){
- var v = values[i];
- var f = this.findField(v.id);
- if(f){
- f.setValue(v.value);
- if(this.trackResetOnLoad){
- f.originalValue = f.getValue();
- }
- }
- }
- }else{ // object hash
- var field, id;
- for(id in values){
- if(!Ext.isFunction(values[id]) && (field = this.findField(id))){
- field.setValue(values[id]);
- if(this.trackResetOnLoad){
- field.originalValue = field.getValue();
+ readRecords: function(dataObject) {
+ var val,
+ result = {
+ records: [],
+ success: true
+ };
+
+ for (var propName in dataObject) {
+ val = dataObject[propName];
+ if (dataObject.hasOwnProperty(propName) && this.isEditableValue(val)) {
+ result.records.push(new Ext.grid.property.Property({
+ name: propName,
+ value: val
+ }, propName));
+ }
}
+ result.total = result.count = result.records.length;
+ return Ext.create('Ext.data.ResultSet', result);
+ },
+
+ // private
+ isEditableValue: function(val){
+ return Ext.isPrimitive(val) || Ext.isDate(val);
}
- }
+ });
}
- return this;
+ return this.reader;
},
- /**
- * Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
- * If multiple fields exist with the same name they are returned as an array.
- * Note: The values are collected from all enabled HTML input elements within the form, not from
- * the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the
- * value can potentially be the emptyText of a field.
- * @param {Boolean} asString (optional) Pass true to return the values as a string. (defaults to false, returning an Object)
- * @return {String/Object}
- */
- getValues : function(asString){
- var fs = Ext.lib.Ajax.serializeForm(this.el.dom);
- if(asString === true){
- return fs;
- }
- return Ext.urlDecode(fs);
- },
+ // protected - should only be called by the grid. Use grid.setSource instead.
+ setSource : function(dataObject) {
+ var me = this;
- /**
- * Retrieves the fields in the form as a set of key/value pairs, using the {@link Ext.form.Field#getValue getValue()} method.
- * If multiple fields exist with the same name they are returned as an array.
- * @param {Boolean} dirtyOnly (optional) True to return only fields that are dirty.
- * @return {Object} The values in the form
- */
- getFieldValues : function(dirtyOnly){
- var o = {},
- n,
- key,
- val;
- this.items.each(function(f) {
- if (dirtyOnly !== true || f.isDirty()) {
- n = f.getName();
- key = o[n];
- val = f.getValue();
-
- if(Ext.isDefined(key)){
- if(Ext.isArray(key)){
- o[n].push(val);
- }else{
- o[n] = [key, val];
- }
- }else{
- o[n] = val;
- }
- }
- });
- return o;
+ me.source = dataObject;
+ me.suspendEvents();
+ me.removeAll();
+ me.proxy.data = dataObject;
+ me.load();
+ me.resumeEvents();
+ me.fireEvent('datachanged', me);
},
- /**
- * Clears all invalid messages in this form.
- * @return {BasicForm} this
- */
- clearInvalid : function(){
- this.items.each(function(f){
- f.clearInvalid();
- });
- return this;
+ // private
+ getProperty : function(row) {
+ return Ext.isNumber(row) ? this.store.getAt(row) : this.store.getById(row);
},
- /**
- * Resets this form.
- * @return {BasicForm} this
- */
- reset : function(){
- this.items.each(function(f){
- f.reset();
- });
- return this;
+ // private
+ setValue : function(prop, value, create){
+ var r = this.getRec(prop);
+ if (r) {
+ r.set('value', value);
+ this.source[prop] = value;
+ } else if (create) {
+ // only create if specified.
+ this.source[prop] = value;
+ r = new Ext.grid.property.Property({name: prop, value: value}, prop);
+ this.store.add(r);
+ }
},
- /**
- * Add Ext.form Components to this form's Collection. This does not result in rendering of
- * the passed Component, it just enables the form to validate Fields, and distribute values to
- * Fields.
- * You will not usually call this function. In order to be rendered, a Field must be added
- * to a {@link Ext.Container Container}, usually an {@link Ext.form.FormPanel FormPanel}.
- * The FormPanel to which the field is added takes care of adding the Field to the BasicForm's
- * collection.
- * @param {Field} field1
- * @param {Field} field2 (optional)
- * @param {Field} etc (optional)
- * @return {BasicForm} this
- */
- add : function(){
- this.items.addAll(Array.prototype.slice.call(arguments, 0));
- return this;
+ // private
+ remove : function(prop) {
+ var r = this.getRec(prop);
+ if(r) {
+ this.store.remove(r);
+ delete this.source[prop];
+ }
},
- /**
- * Removes a field from the items collection (does NOT remove its markup).
- * @param {Field} field
- * @return {BasicForm} this
- */
- remove : function(field){
- this.items.remove(field);
- return this;
+ // private
+ getRec : function(prop) {
+ return this.store.getById(prop);
},
- /**
- * Removes all fields from the collection that have been destroyed.
- */
- cleanDestroyed : function() {
- this.items.filterBy(function(o) { return !!o.isDestroyed; }).each(this.remove, this);
- },
+ // protected - should only be called by the grid. Use grid.getSource instead.
+ getSource : function() {
+ return this.source;
+ }
+});
+/**
+ * Component layout for components which maintain an inner body element which must be resized to synchronize with the
+ * Component size.
+ * @class Ext.layout.component.Body
+ * @extends Ext.layout.component.Component
+ * @private
+ */
- /**
- * Iterates through the {@link Ext.form.Field Field}s which have been {@link #add add}ed to this BasicForm,
- * checks them for an id attribute, and calls {@link Ext.form.Field#applyToMarkup} on the existing dom element with that id.
- * @return {BasicForm} this
- */
- render : function(){
- this.items.each(function(f){
- if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
- f.applyToMarkup(f.id);
+Ext.define('Ext.layout.component.Body', {
+
+ /* Begin Definitions */
+
+ alias: ['layout.body'],
+
+ extend: 'Ext.layout.component.Component',
+
+ uses: ['Ext.layout.container.Container'],
+
+ /* End Definitions */
+
+ type: 'body',
+
+ onLayout: function(width, height) {
+ var me = this,
+ owner = me.owner;
+
+ // Size the Component's encapsulating element according to the dimensions
+ me.setTargetSize(width, height);
+
+ // Size the Component's body element according to the content box of the encapsulating element
+ me.setBodySize.apply(me, arguments);
+
+ // We need to bind to the owner whenever we do not have a user set height or width.
+ if (owner && owner.layout && owner.layout.isLayout) {
+ if (!Ext.isNumber(owner.height) || !Ext.isNumber(owner.width)) {
+ owner.layout.bindToOwnerCtComponent = true;
}
- });
- return this;
+ else {
+ owner.layout.bindToOwnerCtComponent = false;
+ }
+ }
+
+ me.callParent(arguments);
},
/**
- * Calls {@link Ext#apply} for all fields in this form with the passed object.
- * @param {Object} values
- * @return {BasicForm} this
+ * @private
+ * Sizes the Component's body element to fit exactly within the content box of the Component's encapsulating element.
*/
- applyToFields : function(o){
- this.items.each(function(f){
- Ext.apply(f, o);
- });
- return this;
- },
+ setBodySize: function(width, height) {
+ var me = this,
+ owner = me.owner,
+ frameSize = owner.frameSize,
+ isNumber = Ext.isNumber;
- /**
- * Calls {@link Ext#applyIf} for all field in this form with the passed object.
- * @param {Object} values
- * @return {BasicForm} this
- */
- applyIfToFields : function(o){
- this.items.each(function(f){
- Ext.applyIf(f, o);
- });
- return this;
- },
+ if (isNumber(width)) {
+ width -= owner.el.getFrameWidth('lr') - frameSize.left - frameSize.right;
+ }
+ if (isNumber(height)) {
+ height -= owner.el.getFrameWidth('tb') - frameSize.top - frameSize.bottom;
+ }
- callFieldMethod : function(fnName, args){
- args = args || [];
- this.items.each(function(f){
- if(Ext.isFunction(f[fnName])){
- f[fnName].apply(f, args);
- }
- });
- return this;
+ me.setElementSize(owner.body, width, height);
}
});
+/**
+ * Component layout for Ext.form.FieldSet components
+ * @class Ext.layout.component.FieldSet
+ * @extends Ext.layout.component.Body
+ * @private
+ */
+Ext.define('Ext.layout.component.FieldSet', {
+ extend: 'Ext.layout.component.Body',
+ alias: ['layout.fieldset'],
-// back compat
-Ext.BasicForm = Ext.form.BasicForm;
+ type: 'fieldset',
+
+ doContainerLayout: function() {
+ // Prevent layout/rendering of children if the fieldset is collapsed
+ if (!this.owner.collapsed) {
+ this.callParent();
+ }
+ }
+});
/**
- * @class Ext.form.FormPanel
- * @extends Ext.Panel
- *
Standard form container.
- *
- * Layout
- * By default, FormPanel is configured with layout:'form' to use an {@link Ext.layout.FormLayout}
- * layout manager, which styles and renders fields and labels correctly. When nesting additional Containers
- * within a FormPanel, you should ensure that any descendant Containers which host input Fields use the
- * {@link Ext.layout.FormLayout} layout manager.
- *
- * BasicForm
- * Although not listed as configuration options of FormPanel, the FormPanel class accepts all
- * of the config options required to configure its internal {@link Ext.form.BasicForm} for:
- *
- * - {@link Ext.form.BasicForm#fileUpload file uploads}
- * - functionality for {@link Ext.form.BasicForm#doAction loading, validating and submitting} the form
- *
- *
- * Note: If subclassing FormPanel, any configuration options for the BasicForm must be applied to
- * the initialConfig property of the FormPanel. Applying {@link Ext.form.BasicForm BasicForm}
- * configuration settings to this will not affect the BasicForm's configuration.
- *
- * Form Validation
- * For information on form validation see the following:
- *
- * - {@link Ext.form.TextField}
- * - {@link Ext.form.VTypes}
- * - {@link Ext.form.BasicForm#doAction BasicForm.doAction clientValidation notes}
- * - {@link Ext.form.FormPanel#monitorValid monitorValid}
- *
- *
- * Form Submission
- * By default, Ext Forms are submitted through Ajax, using {@link Ext.form.Action}. To enable normal browser
- * submission of the {@link Ext.form.BasicForm BasicForm} contained in this FormPanel, see the
- * {@link Ext.form.BasicForm#standardSubmit standardSubmit} option.
- *
- * @constructor
- * @param {Object} config Configuration options
- * @xtype form
+ * Component layout for tabs
+ * @class Ext.layout.component.Tab
+ * @extends Ext.layout.component.Button
+ * @private
*/
-Ext.FormPanel = Ext.extend(Ext.Panel, {
- /**
- * @cfg {String} formId (optional) The id of the FORM tag (defaults to an auto-generated id).
- */
- /**
- * @cfg {Boolean} hideLabels
- * true to hide field labels by default (sets display:none). Defaults to
- * false.
- * Also see {@link Ext.Component}.{@link Ext.Component#hideLabel hideLabel}.
- */
- /**
- * @cfg {Number} labelPad
- * The default padding in pixels for field labels (defaults to 5). labelPad only
- * applies if {@link #labelWidth} is also specified, otherwise it will be ignored.
- */
- /**
- * @cfg {String} labelSeparator
- * See {@link Ext.Component}.{@link Ext.Component#labelSeparator labelSeparator}
- */
- /**
- * @cfg {Number} labelWidth The width of labels in pixels. This property cascades to child containers
- * and can be overridden on any child container (e.g., a fieldset can specify a different labelWidth
- * for its fields) (defaults to 100).
- */
- /**
- * @cfg {String} itemCls A css class to apply to the x-form-item of fields. This property cascades to child containers.
- */
- /**
- * @cfg {Array} buttons
- * An array of {@link Ext.Button}s or {@link Ext.Button} configs used to add buttons to the footer of this FormPanel.
- *
Buttons in the footer of a FormPanel may be configured with the option formBind: true. This causes
- * the form's {@link #monitorValid valid state monitor task} to enable/disable those Buttons depending on
- * the form's valid/invalid state.
- */
+Ext.define('Ext.layout.component.Tab', {
+ alias: ['layout.tab'],
- /**
- * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to 75).
- */
- minButtonWidth : 75,
+ extend: 'Ext.layout.component.Button',
- /**
- * @cfg {String} labelAlign The label alignment value used for the text-align specification
- * for the container. Valid values are "left", "top" or "right"
- * (defaults to "left"). This property cascades to child containers and can be
- * overridden on any child container (e.g., a fieldset can specify a different labelAlign
- * for its fields).
- */
- labelAlign : 'left',
+ //type: 'button',
- /**
- * @cfg {Boolean} monitorValid If true, the form monitors its valid state client-side and
- * regularly fires the {@link #clientvalidation} event passing that state.
- * When monitoring valid state, the FormPanel enables/disables any of its configured
- * {@link #buttons} which have been configured with formBind: true
depending
- * on whether the {@link Ext.form.BasicForm#isValid form is valid} or not. Defaults to false
- */
- monitorValid : false,
+ beforeLayout: function() {
+ var me = this, dirty = me.lastClosable !== me.owner.closable;
- /**
- * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
- */
- monitorPoll : 200,
+ if (dirty) {
+ delete me.adjWidth;
+ }
- /**
- * @cfg {String} layout Defaults to 'form'. Normally this configuration property should not be altered.
- * For additional details see {@link Ext.layout.FormLayout} and {@link Ext.Container#layout Ext.Container.layout}.
- */
- layout : 'form',
+ return this.callParent(arguments) || dirty;
+ },
- // private
- initComponent : function(){
- this.form = this.createForm();
- Ext.FormPanel.superclass.initComponent.call(this);
+ onLayout: function () {
+ var me = this;
- this.bodyCfg = {
- tag: 'form',
- cls: this.baseCls + '-body',
- method : this.method || 'POST',
- id : this.formId || Ext.id()
- };
- if(this.fileUpload) {
- this.bodyCfg.enctype = 'multipart/form-data';
- }
- this.initItems();
+ me.callParent(arguments);
- this.addEvents(
- /**
- * @event clientvalidation
- * If the monitorValid config option is true, this event fires repetitively to notify of valid state
- * @param {Ext.form.FormPanel} this
- * @param {Boolean} valid true if the form has passed client-side validation
- */
- 'clientvalidation'
- );
+ me.lastClosable = me.owner.closable;
+ }
+});
+/**
+ * @private
+ * @class Ext.layout.component.field.File
+ * @extends Ext.layout.component.field.Field
+ * Layout class for {@link Ext.form.field.File} fields. Adjusts the input field size to accommodate
+ * the file picker trigger button.
+ * @private
+ */
- this.relayEvents(this.form, ['beforeaction', 'actionfailed', 'actioncomplete']);
- },
+Ext.define('Ext.layout.component.field.File', {
+ alias: ['layout.filefield'],
+ extend: 'Ext.layout.component.field.Field',
- // private
- createForm : function(){
- var config = Ext.applyIf({listeners: {}}, this.initialConfig);
- return new Ext.form.BasicForm(null, config);
- },
+ type: 'filefield',
- // private
- initFields : function(){
- var f = this.form;
- var formPanel = this;
- var fn = function(c){
- if(formPanel.isField(c)){
- f.add(c);
- }else if(c.findBy && c != formPanel){
- formPanel.applySettings(c);
- //each check required for check/radio groups.
- if(c.items && c.items.each){
- c.items.each(fn, this);
- }
- }
- };
- this.items.each(fn, this);
- },
+ sizeBodyContents: function(width, height) {
+ var me = this,
+ owner = me.owner;
- // private
- applySettings: function(c){
- var ct = c.ownerCt;
- Ext.applyIf(c, {
- labelAlign: ct.labelAlign,
- labelWidth: ct.labelWidth,
- itemCls: ct.itemCls
- });
- },
+ if (!owner.buttonOnly) {
+ // Decrease the field's width by the width of the button and the configured buttonMargin.
+ // Both the text field and the button are floated left in CSS so they'll stack up side by side.
+ me.setElementSize(owner.inputEl, Ext.isNumber(width) ? width - owner.button.getWidth() - owner.buttonMargin : width);
+ }
+ }
+});
+/**
+ * @class Ext.layout.component.field.Slider
+ * @extends Ext.layout.component.field.Field
+ * @private
+ */
- // private
- getLayoutTarget : function(){
- return this.form.el;
- },
+Ext.define('Ext.layout.component.field.Slider', {
- /**
- * Provides access to the {@link Ext.form.BasicForm Form} which this Panel contains.
- * @return {Ext.form.BasicForm} The {@link Ext.form.BasicForm Form} which this Panel contains.
- */
- getForm : function(){
- return this.form;
- },
+ /* Begin Definitions */
- // private
- onRender : function(ct, position){
- this.initFields();
- Ext.FormPanel.superclass.onRender.call(this, ct, position);
- this.form.initEl(this.body);
- },
+ alias: ['layout.sliderfield'],
- // private
- beforeDestroy : function(){
- this.stopMonitoring();
- this.form.destroy(true);
- Ext.FormPanel.superclass.beforeDestroy.call(this);
- },
+ extend: 'Ext.layout.component.field.Field',
- // Determine if a Component is usable as a form Field.
- isField : function(c) {
- return !!c.setValue && !!c.getValue && !!c.markInvalid && !!c.clearInvalid;
- },
+ /* End Definitions */
- // private
- initEvents : function(){
- Ext.FormPanel.superclass.initEvents.call(this);
- // Listeners are required here to catch bubbling events from children.
- this.on({
- scope: this,
- add: this.onAddEvent,
- remove: this.onRemoveEvent
- });
- if(this.monitorValid){ // initialize after render
- this.startMonitoring();
- }
- },
+ type: 'sliderfield',
- // private
- onAdd: function(c){
- Ext.FormPanel.superclass.onAdd.call(this, c);
- this.processAdd(c);
- },
+ sizeBodyContents: function(width, height) {
+ var owner = this.owner,
+ thumbs = owner.thumbs,
+ length = thumbs.length,
+ inputEl = owner.inputEl,
+ innerEl = owner.innerEl,
+ endEl = owner.endEl,
+ i = 0;
- // private
- onAddEvent: function(ct, c){
- if(ct !== this){
- this.processAdd(c);
+ /*
+ * If we happen to be animating during a resize, the position of the thumb will likely be off
+ * when the animation stops. As such, just stop any animations before syncing the thumbs.
+ */
+ for(; i < length; ++i) {
+ thumbs[i].el.stopAnimation();
}
- },
-
- // private
- processAdd : function(c){
- // If a single form Field, add it
- if(this.isField(c)){
- this.form.add(c);
- // If a Container, add any Fields it might contain
- }else if(c.findBy){
- this.applySettings(c);
- this.form.add.apply(this.form, c.findBy(this.isField));
+
+ if (owner.vertical) {
+ inputEl.setHeight(height);
+ innerEl.setHeight(Ext.isNumber(height) ? height - inputEl.getPadding('t') - endEl.getPadding('b') : height);
}
- },
+ else {
+ inputEl.setWidth(width);
+ innerEl.setWidth(Ext.isNumber(width) ? width - inputEl.getPadding('l') - endEl.getPadding('r') : width);
+ }
+ owner.syncThumbs();
+ }
+});
- // private
- onRemove: function(c){
- Ext.FormPanel.superclass.onRemove.call(this, c);
- this.processRemove(c);
- },
+/**
+ * @class Ext.layout.container.Absolute
+ * @extends Ext.layout.container.Anchor
+ * This is a layout that inherits the anchoring of {@link Ext.layout.container.Anchor} and adds the
+ * ability for x/y positioning using the standard x and y component config options.
+ * This class is intended to be extended or created via the {@link Ext.container.Container#layout layout}
+ * configuration property. See {@link Ext.container.Container#layout} for additional details.
+ * {@img Ext.layout.container.Absolute/Ext.layout.container.Absolute.png Ext.layout.container.Absolute container layout}
+ * Example usage:
+ *
+ Ext.create('Ext.form.Panel', {
+ title: 'Absolute Layout',
+ width: 300,
+ height: 275,
+ layout:'absolute',
+ layoutConfig: {
+ // layout-specific configs go here
+ //itemCls: 'x-abs-layout-item',
+ },
+ url:'save-form.php',
+ defaultType: 'textfield',
+ items: [{
+ x: 10,
+ y: 10,
+ xtype:'label',
+ text: 'Send To:'
+ },{
+ x: 80,
+ y: 10,
+ name: 'to',
+ anchor:'90%' // anchor width by percentage
+ },{
+ x: 10,
+ y: 40,
+ xtype:'label',
+ text: 'Subject:'
+ },{
+ x: 80,
+ y: 40,
+ name: 'subject',
+ anchor: '90%' // anchor width by percentage
+ },{
+ x:0,
+ y: 80,
+ xtype: 'textareafield',
+ name: 'msg',
+ anchor: '100% 100%' // anchor width and height
+ }],
+ renderTo: Ext.getBody()
+ });
+
+ */
- onRemoveEvent: function(ct, c){
- if(ct !== this){
- this.processRemove(c);
- }
- },
+Ext.define('Ext.layout.container.Absolute', {
- // private
- processRemove: function(c){
- if(!this.destroying){
- // If a single form Field, remove it
- if(this.isField(c)){
- this.form.remove(c);
- // If a Container, its already destroyed by the time it gets here. Remove any references to destroyed fields.
- }else if (c.findBy){
- Ext.each(c.findBy(this.isField), this.form.remove, this.form);
- if (c.isDestroyed) {
- this.form.cleanDestroyed();
- }
- }
- }
- },
+ /* Begin Definitions */
- /**
- * Starts monitoring of the valid state of this form. Usually this is done by passing the config
- * option "monitorValid"
- */
- startMonitoring : function(){
- if(!this.validTask){
- this.validTask = new Ext.util.TaskRunner();
- this.validTask.start({
- run : this.bindHandler,
- interval : this.monitorPoll || 200,
- scope: this
- });
- }
- },
+ alias: 'layout.absolute',
+ extend: 'Ext.layout.container.Anchor',
+ requires: ['Ext.chart.axis.Axis', 'Ext.fx.Anim'],
+ alternateClassName: 'Ext.layout.AbsoluteLayout',
- /**
- * Stops monitoring of the valid state of this form
- */
- stopMonitoring : function(){
- if(this.validTask){
- this.validTask.stopAll();
- this.validTask = null;
- }
- },
+ /* End Definitions */
- /**
- * This is a proxy for the underlying BasicForm's {@link Ext.form.BasicForm#load} call.
- * @param {Object} options The options to pass to the action (see {@link Ext.form.BasicForm#doAction} for details)
- */
- load : function(){
- this.form.load.apply(this.form, arguments);
- },
+ itemCls: Ext.baseCSSPrefix + 'abs-layout-item',
- // private
- onDisable : function(){
- Ext.FormPanel.superclass.onDisable.call(this);
- if(this.form){
- this.form.items.each(function(){
- this.disable();
- });
+ type: 'absolute',
+
+ onLayout: function() {
+ var me = this,
+ target = me.getTarget(),
+ targetIsBody = target.dom === document.body;
+
+ // Do not set position: relative; when the absolute layout target is the body
+ if (!targetIsBody) {
+ target.position();
}
+ me.paddingLeft = target.getPadding('l');
+ me.paddingTop = target.getPadding('t');
+ me.callParent(arguments);
},
// private
- onEnable : function(){
- Ext.FormPanel.superclass.onEnable.call(this);
- if(this.form){
- this.form.items.each(function(){
- this.enable();
- });
- }
+ adjustWidthAnchor: function(value, comp) {
+ //return value ? value - comp.getPosition(true)[0] + this.paddingLeft: value;
+ return value ? value - comp.getPosition(true)[0] : value;
},
// private
- bindHandler : function(){
- var valid = true;
- this.form.items.each(function(f){
- if(!f.isValid(true)){
- valid = false;
- return false;
- }
- });
- if(this.fbar){
- var fitems = this.fbar.items.items;
- for(var i = 0, len = fitems.length; i < len; i++){
- var btn = fitems[i];
- if(btn.formBind === true && btn.disabled === valid){
- btn.setDisabled(!valid);
- }
- }
- }
- this.fireEvent('clientvalidation', this, valid);
+ adjustHeightAnchor: function(value, comp) {
+ //return value ? value - comp.getPosition(true)[1] + this.paddingTop: value;
+ return value ? value - comp.getPosition(true)[1] : value;
}
});
-Ext.reg('form', Ext.FormPanel);
-
-Ext.form.FormPanel = Ext.FormPanel;
/**
- * @class Ext.form.FieldSet
- * @extends Ext.Panel
- * Standard container used for grouping items within a {@link Ext.form.FormPanel form}.
+ * @class Ext.layout.container.Accordion
+ * @extends Ext.layout.container.VBox
+ * This is a layout that manages multiple Panels in an expandable accordion style such that only
+ * one Panel can be expanded at any given time. Each Panel has built-in support for expanding and collapsing.
+ * Note: Only Ext.Panels and all subclasses of Ext.panel.Panel may be used in an accordion layout Container.
+ * {@img Ext.layout.container.Accordion/Ext.layout.container.Accordion.png Ext.layout.container.Accordion container layout}
+ * Example usage:
*
-var form = new Ext.FormPanel({
- 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: 700,
- renderTo: document.body,
- layout:'column', // arrange items in columns
- defaults: { // defaults applied to items
- layout: 'form',
- border: false,
- bodyStyle: 'padding:4px'
- },
- items: [{
- // Fieldset in Column 1
- xtype:'fieldset',
- columnWidth: 0.5,
- title: 'Fieldset 1',
- collapsible: true,
- autoHeight:true,
+ Ext.create('Ext.panel.Panel', {
+ title: 'Accordion Layout',
+ width: 300,
+ height: 300,
+ layout:'accordion',
defaults: {
- anchor: '-20' // leave room for error icon
+ // applied to each contained panel
+ bodyStyle: 'padding:15px'
},
- defaultType: 'textfield',
- items :[{
- fieldLabel: 'Field 1'
- }, {
- fieldLabel: 'Field 2'
- }, {
- fieldLabel: 'Field 3'
- }
- ]
- },{
- // Fieldset in Column 2 - Panel inside
- xtype:'fieldset',
- title: 'Show Panel', // title, header, or checkboxToggle creates fieldset header
- autoHeight:true,
- 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: 100
- }]
- }]
-});
- *
- * @constructor
- * @param {Object} config Configuration options
- * @xtype fieldset
+ layoutConfig: {
+ // layout-specific configs go here
+ titleCollapse: false,
+ animate: true,
+ activeOnTop: true
+ },
+ items: [{
+ title: 'Panel 1',
+ html: 'Panel content!
'
+ },{
+ title: 'Panel 2',
+ html: 'Panel content!
'
+ },{
+ title: 'Panel 3',
+ html: 'Panel content!
'
+ }],
+ renderTo: Ext.getBody()
+ });
+
*/
-Ext.form.FieldSet = Ext.extend(Ext.Panel, {
+Ext.define('Ext.layout.container.Accordion', {
+ extend: 'Ext.layout.container.VBox',
+ alias: ['layout.accordion'],
+ alternateClassName: 'Ext.layout.AccordionLayout',
+
+ align: 'stretch',
+
/**
- * @cfg {Mixed} checkboxToggle 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).
- * A {@link Ext.DomHelper DomHelper} element spec may also be specified to create the checkbox.
- * If true is specified, the default DomHelper config object used to create the element
- * is:
- * {tag: 'input', type: 'checkbox', name: this.checkboxName || this.id+'-checkbox'}
- *
+ * @cfg {Boolean} fill
+ * True to adjust the active item's height to fill the available space in the container, false to use the
+ * item's current height, or auto height if not explicitly set (defaults to true).
*/
+ fill : true,
/**
- * @cfg {String} checkboxName The name to assign to the fieldset's checkbox if {@link #checkboxToggle} = true
- * (defaults to '[checkbox id]-checkbox').
+ * @cfg {Boolean} autoWidth
+ * This config is ignored in ExtJS 4.x.
+ * Child Panels have their width actively managed to fit within the accordion's width.
*/
+ autoWidth : true,
/**
- * @cfg {Boolean} collapsible
- * 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}.
+ * @cfg {Boolean} titleCollapse
+ * Not implemented in PR2.
+ * True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow
+ * expand/collapse only when the toggle tool button is clicked (defaults to true). When set to false,
+ * {@link #hideCollapseTool} should be false also.
*/
+ titleCollapse : true,
/**
- * @cfg {Number} labelWidth The width of labels. This property cascades to child containers.
+ * @cfg {Boolean} hideCollapseTool
+ * True to hide the contained Panels' collapse/expand toggle buttons, false to display them (defaults to false).
+ * When set to true, {@link #titleCollapse} is automatically set to true
.
*/
+ hideCollapseTool : false,
/**
- * @cfg {String} itemCls A css class to apply to the x-form-item of fields (see
- * {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl} for details).
- * This property cascades to child containers.
+ * @cfg {Boolean} collapseFirst
+ * True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools
+ * in the contained Panels' title bars, false to render it last (defaults to false).
*/
+ collapseFirst : false,
/**
- * @cfg {String} baseCls The base CSS class applied to the fieldset (defaults to 'x-fieldset').
+ * @cfg {Boolean} animate
+ * True to slide the contained panels open and closed during expand/collapse using animation, false to open and
+ * close directly with no animation (defaults to true
). Note: The layout performs animated collapsing
+ * and expanding, not the child Panels.
*/
- baseCls : 'x-fieldset',
+ animate : true,
/**
- * @cfg {String} layout The {@link Ext.Container#layout} to use inside the fieldset (defaults to 'form').
+ * @cfg {Boolean} activeOnTop
+ * Not implemented in PR4.
+ * Only valid when {@link #multi" is false
.
+ * True to swap the position of each panel as it is expanded so that it becomes the first item in the container,
+ * false to keep the panels in the rendered order. This is NOT compatible with "animate:true" (defaults to false).
*/
- layout : 'form',
+ activeOnTop : false,
/**
- * @cfg {Boolean} animCollapse
- * true to animate the transition when the panel is collapsed, false to skip the
- * animation (defaults to false).
+ * @cfg {Boolean} multi
+ * Defaults to false
. Set to true
to enable multiple accordion items to be open at once.
*/
- animCollapse : false,
+ multi: false,
- // private
- onRender : function(ct, position){
- if(!this.el){
- this.el = document.createElement('fieldset');
- this.el.id = this.id;
- if (this.title || this.header || this.checkboxToggle) {
- this.el.appendChild(document.createElement('legend')).className = this.baseCls + '-header';
- }
+ constructor: function() {
+ var me = this;
+
+ me.callParent(arguments);
+
+ // animate flag must be false during initial render phase so we don't get animations.
+ me.initialAnimate = me.animate;
+ me.animate = false;
+
+ // Child Panels are not absolutely positioned if we are not filling, so use a different itemCls.
+ if (me.fill === false) {
+ me.itemCls = Ext.baseCSSPrefix + 'accordion-item';
}
+ },
- Ext.form.FieldSet.superclass.onRender.call(this, ct, position);
+ // Cannot lay out a fitting accordion before we have been allocated a height.
+ // So during render phase, layout will not be performed.
+ beforeLayout: function() {
+ var me = this;
- if(this.checkboxToggle){
- var o = typeof this.checkboxToggle == 'object' ?
- this.checkboxToggle :
- {tag: 'input', type: 'checkbox', name: this.checkboxName || this.id+'-checkbox'};
- this.checkbox = this.header.insertFirst(o);
- this.checkbox.dom.checked = !this.collapsed;
- this.mon(this.checkbox, 'click', this.onCheckClick, this);
+ me.callParent(arguments);
+ if (me.fill) {
+ if (!me.owner.el.dom.style.height) {
+ return false;
+ }
+ } else {
+ me.owner.componentLayout.monitorChildren = false;
+ me.autoSize = true;
+ me.owner.setAutoScroll(true);
}
},
- // private
- onCollapse : function(doAnim, animArg){
- if(this.checkbox){
- this.checkbox.dom.checked = false;
+ renderItems : function(items, target) {
+ var me = this,
+ ln = items.length,
+ i = 0,
+ comp,
+ targetSize = me.getLayoutTargetSize(),
+ renderedPanels = [],
+ border;
+
+ for (; i < ln; i++) {
+ comp = items[i];
+ if (!comp.rendered) {
+ renderedPanels.push(comp);
+
+ // Set up initial properties for Panels in an accordion.
+ if (me.collapseFirst) {
+ comp.collapseFirst = me.collapseFirst;
+ }
+ if (me.hideCollapseTool) {
+ comp.hideCollapseTool = me.hideCollapseTool;
+ comp.titleCollapse = true;
+ }
+ else if (me.titleCollapse) {
+ comp.titleCollapse = me.titleCollapse;
+ }
+
+ delete comp.hideHeader;
+ comp.collapsible = true;
+ comp.title = comp.title || ' ';
+ comp.setBorder(false);
+
+ // Set initial sizes
+ comp.width = targetSize.width;
+ if (me.fill) {
+ delete comp.height;
+ delete comp.flex;
+
+ // If there is an expanded item, all others must be rendered collapsed.
+ if (me.expandedItem !== undefined) {
+ comp.collapsed = true;
+ }
+ // Otherwise expand the first item with collapsed explicitly configured as false
+ else if (comp.collapsed === false) {
+ comp.flex = 1;
+ me.expandedItem = i;
+ } else {
+ comp.collapsed = true;
+ }
+ } else {
+ delete comp.flex;
+ comp.animCollapse = me.initialAnimate;
+ comp.autoHeight = true;
+ comp.autoScroll = false;
+ }
+ }
+ }
+
+ // If no collapsed:false Panels found, make the first one expanded.
+ if (ln && me.expandedItem === undefined) {
+ me.expandedItem = 0;
+ comp = items[0];
+ comp.collapsed = false;
+ if (me.fill) {
+ comp.flex = 1;
+ }
}
- Ext.form.FieldSet.superclass.onCollapse.call(this, doAnim, animArg);
+
+ // Render all Panels.
+ me.callParent(arguments);
+
+ // Postprocess rendered Panels.
+ ln = renderedPanels.length;
+ for (i = 0; i < ln; i++) {
+ comp = renderedPanels[i];
+
+ // Delete the dimension property so that our align: 'stretch' processing manages the width from here
+ delete comp.width;
+ comp.header.addCls(Ext.baseCSSPrefix + 'accordion-hd');
+ comp.body.addCls(Ext.baseCSSPrefix + 'accordion-body');
+
+ // If we are fitting, then intercept expand/collapse requests.
+ if (me.fill) {
+ me.owner.mon(comp, {
+ show: me.onComponentShow,
+ beforeexpand: me.onComponentExpand,
+ beforecollapse: me.onComponentCollapse,
+ scope: me
+ });
+ }
+ }
},
- // private
- onExpand : function(doAnim, animArg){
- if(this.checkbox){
- this.checkbox.dom.checked = true;
+ onLayout: function() {
+ var me = this;
+
+ me.updatePanelClasses();
+
+ if (me.fill) {
+ me.callParent(arguments);
+ } else {
+ var targetSize = me.getLayoutTargetSize(),
+ items = me.getVisibleItems(),
+ len = items.length,
+ i = 0, comp;
+
+ for (; i < len; i++) {
+ comp = items[i];
+ if (comp.collapsed) {
+ items[i].setWidth(targetSize.width);
+ } else {
+ items[i].setSize(null, null);
+ }
+ }
+ }
+
+ return me;
+ },
+
+ updatePanelClasses: function() {
+ var children = this.getLayoutItems(),
+ ln = children.length,
+ siblingCollapsed = true,
+ i, child;
+
+ for (i = 0; i < ln; i++) {
+ child = children[i];
+ if (!siblingCollapsed) {
+ child.header.addCls(Ext.baseCSSPrefix + 'accordion-hd-sibling-expanded');
+ }
+ else {
+ child.header.removeCls(Ext.baseCSSPrefix + 'accordion-hd-sibling-expanded');
+ }
+ if (i + 1 == ln && child.collapsed) {
+ child.header.addCls(Ext.baseCSSPrefix + 'accordion-hd-last-collapsed');
+ }
+ else {
+ child.header.removeCls(Ext.baseCSSPrefix + 'accordion-hd-last-collapsed');
+ }
+ siblingCollapsed = child.collapsed;
}
- Ext.form.FieldSet.superclass.onExpand.call(this, doAnim, animArg);
},
- /**
- * This function is called by the fieldset's checkbox when it is toggled (only applies when
- * checkboxToggle = true). This method should never be called externally, but can be
- * overridden to provide custom behavior when the checkbox is toggled if needed.
- */
- onCheckClick : function(){
- this[this.checkbox.dom.checked ? 'expand' : 'collapse']();
- }
+ // When a Component expands, adjust the heights of the other Components to be just enough to accommodate
+ // their headers.
+ // The expanded Component receives the only flex value, and so gets all remaining space.
+ onComponentExpand: function(toExpand) {
+ var me = this,
+ it = me.owner.items.items,
+ len = it.length,
+ i = 0,
+ comp;
- /**
- * @cfg {String/Number} activeItem
- * @hide
- */
- /**
- * @cfg {Mixed} applyTo
- * @hide
- */
- /**
- * @cfg {Boolean} bodyBorder
- * @hide
- */
- /**
- * @cfg {Boolean} border
- * @hide
- */
- /**
- * @cfg {Boolean/Number} bufferResize
- * @hide
- */
- /**
- * @cfg {Boolean} collapseFirst
- * @hide
- */
- /**
- * @cfg {String} defaultType
- * @hide
- */
- /**
- * @cfg {String} disabledClass
- * @hide
- */
- /**
- * @cfg {String} elements
- * @hide
- */
- /**
- * @cfg {Boolean} floating
- * @hide
- */
- /**
- * @cfg {Boolean} footer
- * @hide
- */
- /**
- * @cfg {Boolean} frame
- * @hide
- */
- /**
- * @cfg {Boolean} header
- * @hide
- */
- /**
- * @cfg {Boolean} headerAsText
- * @hide
- */
- /**
- * @cfg {Boolean} hideCollapseTool
- * @hide
- */
- /**
- * @cfg {String} iconCls
- * @hide
- */
- /**
- * @cfg {Boolean/String} shadow
- * @hide
- */
- /**
- * @cfg {Number} shadowOffset
- * @hide
- */
- /**
- * @cfg {Boolean} shim
- * @hide
- */
- /**
- * @cfg {Object/Array} tbar
- * @hide
- */
- /**
- * @cfg {Array} tools
- * @hide
- */
- /**
- * @cfg {Ext.Template/Ext.XTemplate} toolTemplate
- * @hide
- */
- /**
- * @cfg {String} xtype
- * @hide
- */
- /**
- * @property header
- * @hide
- */
- /**
- * @property footer
- * @hide
- */
- /**
- * @method focus
- * @hide
- */
- /**
- * @method getBottomToolbar
- * @hide
- */
- /**
- * @method getTopToolbar
- * @hide
- */
- /**
- * @method setIconClass
- * @hide
- */
- /**
- * @event activate
- * @hide
- */
- /**
- * @event beforeclose
- * @hide
- */
- /**
- * @event bodyresize
- * @hide
- */
- /**
- * @event close
- * @hide
- */
- /**
- * @event deactivate
- * @hide
- */
-});
-Ext.reg('fieldset', Ext.form.FieldSet);/**
- * @class Ext.form.HtmlEditor
- * @extends Ext.form.Field
- * Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be
- * automatically hidden when needed. These are noted in the config options where appropriate.
- *
The editor's toolbar buttons have tooltips defined in the {@link #buttonTips} property, but they are not
- * enabled by default unless the global {@link Ext.QuickTips} singleton is {@link Ext.QuickTips#init initialized}.
- *
Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT
- * supported by this editor.
- *
An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within
- * any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.
- *
Example usage:
- *
-// Simple example rendered with default options:
-Ext.QuickTips.init(); // enable tooltips
-new Ext.form.HtmlEditor({
- renderTo: Ext.getBody(),
- width: 800,
- height: 300
-});
+ for (; i < len; i++) {
+ comp = it[i];
+ if (comp === toExpand && comp.collapsed) {
+ me.setExpanded(comp);
+ } else if (!me.multi && (comp.rendered && comp.header.rendered && comp !== toExpand && !comp.collapsed)) {
+ me.setCollapsed(comp);
+ }
+ }
+
+ me.animate = me.initialAnimate;
+ me.layout();
+ me.animate = false;
+ return false;
+ },
-// Passed via xtype into a container and with custom options:
-Ext.QuickTips.init(); // enable tooltips
-new Ext.Panel({
- title: 'HTML Editor',
- renderTo: Ext.getBody(),
- width: 600,
- height: 300,
- frame: true,
- layout: 'fit',
- items: {
- xtype: 'htmleditor',
- enableColors: false,
- enableAlignments: false
- }
-});
-
- * @constructor
- * Create a new HtmlEditor
- * @param {Object} config
- * @xtype htmleditor
- */
+ onComponentCollapse: function(comp) {
+ var me = this,
+ toExpand = comp.next() || comp.prev(),
+ expanded = me.multi ? me.owner.query('>panel:not([collapsed])') : [];
-Ext.form.HtmlEditor = Ext.extend(Ext.form.Field, {
- /**
- * @cfg {Boolean} enableFormat Enable the bold, italic and underline buttons (defaults to true)
- */
- enableFormat : true,
- /**
- * @cfg {Boolean} enableFontSize Enable the increase/decrease font size buttons (defaults to true)
- */
- enableFontSize : true,
- /**
- * @cfg {Boolean} enableColors Enable the fore/highlight color buttons (defaults to true)
- */
- enableColors : true,
- /**
- * @cfg {Boolean} enableAlignments Enable the left, center, right alignment buttons (defaults to true)
- */
- enableAlignments : true,
- /**
- * @cfg {Boolean} enableLists Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
- */
- enableLists : true,
- /**
- * @cfg {Boolean} enableSourceEdit Enable the switch to source edit button. Not available in Safari. (defaults to true)
- */
- enableSourceEdit : true,
- /**
- * @cfg {Boolean} enableLinks Enable the create link button. Not available in Safari. (defaults to true)
- */
- enableLinks : true,
- /**
- * @cfg {Boolean} enableFont Enable font selection. Not available in Safari. (defaults to true)
- */
- enableFont : true,
- /**
- * @cfg {String} createLinkText The default text for the create link prompt
- */
- createLinkText : 'Please enter the URL for the link:',
- /**
- * @cfg {String} defaultLinkValue The default value for the create link prompt (defaults to http:/ /)
- */
- defaultLinkValue : 'http:/'+'/',
- /**
- * @cfg {Array} fontFamilies An array of available font families
- */
- fontFamilies : [
- 'Arial',
- 'Courier New',
- 'Tahoma',
- 'Times New Roman',
- 'Verdana'
- ],
- defaultFont: 'tahoma',
- /**
- * @cfg {String} defaultValue A default value to be put into the editor to resolve focus issues (defaults to (Non-breaking space) in Opera and IE6, (Zero-width space) in all other browsers).
- */
- defaultValue: (Ext.isOpera || Ext.isIE6) ? ' ' : '',
+ // If we are allowing multi, and the "toCollapse" component is NOT the only expanded Component,
+ // then ask the box layout to collapse it to its header.
+ if (me.multi) {
+ me.setCollapsed(comp);
- // private properties
- actionMode: 'wrap',
- validationEvent : false,
- deferHeight: true,
- initialized : false,
- activated : false,
- sourceEditMode : false,
- onFocus : Ext.emptyFn,
- iframePad:3,
- hideMode:'offsets',
- defaultAutoCreate : {
- tag: "textarea",
- style:"width:500px;height:300px;",
- autocomplete: "off"
+ // If the collapsing Panel is the only expanded one, expand the following Component.
+ // All this is handling fill: true, so there must be at least one expanded,
+ if (expanded.length === 1 && expanded[0] === comp) {
+ me.setExpanded(toExpand);
+ }
+
+ me.animate = me.initialAnimate;
+ me.layout();
+ me.animate = false;
+ }
+ // Not allowing multi: expand the next sibling if possible, prev sibling if we collapsed the last
+ else if (toExpand) {
+ me.onComponentExpand(toExpand);
+ }
+ return false;
},
- // private
- initComponent : function(){
- this.addEvents(
- /**
- * @event initialize
- * Fires when the editor is fully initialized (including the iframe)
- * @param {HtmlEditor} this
- */
- 'initialize',
- /**
- * @event activate
- * Fires when the editor is first receives the focus. Any insertion must wait
- * until after this event.
- * @param {HtmlEditor} this
- */
- 'activate',
- /**
- * @event beforesync
- * Fires before the textarea is updated with content from the editor iframe. Return false
- * to cancel the sync.
- * @param {HtmlEditor} this
- * @param {String} html
- */
- 'beforesync',
- /**
- * @event beforepush
- * Fires before the iframe editor is updated with content from the textarea. Return false
- * to cancel the push.
- * @param {HtmlEditor} this
- * @param {String} html
- */
- 'beforepush',
- /**
- * @event sync
- * Fires when the textarea is updated with content from the editor iframe.
- * @param {HtmlEditor} this
- * @param {String} html
- */
- 'sync',
- /**
- * @event push
- * Fires when the iframe editor is updated with content from the textarea.
- * @param {HtmlEditor} this
- * @param {String} html
- */
- 'push',
- /**
- * @event editmodechange
- * Fires when the editor switches edit modes
- * @param {HtmlEditor} this
- * @param {Boolean} sourceEdit True if source edit, false if standard editing.
- */
- 'editmodechange'
- );
+ onComponentShow: function(comp) {
+ // Showing a Component means that you want to see it, so expand it.
+ this.onComponentExpand(comp);
},
- // private
- createFontOptions : function(){
- var buf = [], fs = this.fontFamilies, ff, lc;
- for(var i = 0, len = fs.length; i< len; i++){
- ff = fs[i];
- lc = ff.toLowerCase();
- buf.push(
- ''
- );
+ setCollapsed: function(comp) {
+ var otherDocks = comp.getDockedItems(),
+ dockItem,
+ len = otherDocks.length,
+ i = 0;
+
+ // Hide all docked items except the header
+ comp.hiddenDocked = [];
+ for (; i < len; i++) {
+ dockItem = otherDocks[i];
+ if ((dockItem !== comp.header) && !dockItem.hidden) {
+ dockItem.hidden = true;
+ comp.hiddenDocked.push(dockItem);
+ }
+ }
+ comp.addCls(comp.collapsedCls);
+ comp.header.addCls(comp.collapsedHeaderCls);
+ comp.height = comp.header.getHeight();
+ comp.el.setHeight(comp.height);
+ comp.collapsed = true;
+ delete comp.flex;
+ comp.fireEvent('collapse', comp);
+ if (comp.collapseTool) {
+ comp.collapseTool.setType('expand-' + comp.getOppositeDirection(comp.collapseDirection));
}
- return buf.join('');
},
- /*
- * Protected method that will not generally be called directly. It
- * is called when the editor creates its toolbar. Override this method if you need to
- * add custom toolbar buttons.
- * @param {HtmlEditor} editor
+ setExpanded: function(comp) {
+ var otherDocks = comp.hiddenDocked,
+ len = otherDocks ? otherDocks.length : 0,
+ i = 0;
+
+ // Show temporarily hidden docked items
+ for (; i < len; i++) {
+ otherDocks[i].hidden = false;
+ }
+
+ // If it was an initial native collapse which hides the body
+ if (!comp.body.isVisible()) {
+ comp.body.show();
+ }
+ delete comp.collapsed;
+ delete comp.height;
+ delete comp.componentLayout.lastComponentSize;
+ comp.suspendLayout = false;
+ comp.flex = 1;
+ comp.removeCls(comp.collapsedCls);
+ comp.header.removeCls(comp.collapsedHeaderCls);
+ comp.fireEvent('expand', comp);
+ if (comp.collapseTool) {
+ comp.collapseTool.setType('collapse-' + comp.collapseDirection);
+ }
+ comp.setAutoScroll(comp.initialConfig.autoScroll);
+ }
+});
+/**
+ * @class Ext.resizer.Splitter
+ * @extends Ext.Component
+ * This class functions between siblings of a {@link Ext.layout.container.VBox VBox} or {@link Ext.layout.container.HBox HBox}
+ * layout to resize both immediate siblings.
+ * By default it will set the size of both siblings. One of the siblings may be configured with
+ * {@link Ext.Component#maintainFlex maintainFlex}: true
which will cause it not to receive a new size explicitly, but to be resized
+ * by the layout.
+ * A Splitter may be configured to show a centered mini-collapse tool orientated to collapse the {@link #collapseTarget}.
+ * The Splitter will then call that sibling Panel's {@link Ext.panel.Panel#collapse collapse} or {@link Ext.panel.Panel#expand expand} method
+ * to perform the appropriate operation (depending on the sibling collapse state). To create the mini-collapse tool but take care
+ * of collapsing yourself, configure the splitter with {@link #performCollapse} false
.
+ *
+ * @xtype splitter
+ */
+Ext.define('Ext.resizer.Splitter', {
+ extend: 'Ext.Component',
+ requires: ['Ext.XTemplate'],
+ uses: ['Ext.resizer.SplitterTracker'],
+ alias: 'widget.splitter',
+
+ renderTpl: [
+ ' '
+ ],
+
+ baseCls: Ext.baseCSSPrefix + 'splitter',
+ collapsedCls: Ext.baseCSSPrefix + 'splitter-collapsed',
+
+ /**
+ * @cfg {Boolean} collapsible
+ * true
to show a mini-collapse tool in the Splitter to toggle expand and collapse on the {@link #collapseTarget} Panel.
+ * Defaults to the {@link Ext.panel.Panel#collapsible collapsible} setting of the Panel.
*/
- createToolbar : function(editor){
- var items = [];
- var tipsEnabled = Ext.QuickTips && Ext.QuickTips.isEnabled();
+ collapsible: false,
+ /**
+ * @cfg {Boolean} performCollapse
+ * Set to false
to prevent this Splitter's mini-collapse tool from managing the collapse
+ * state of the {@link #collapseTarget}.
+ */
- function btn(id, toggle, handler){
- return {
- itemId : id,
- cls : 'x-btn-icon',
- iconCls: 'x-edit-'+id,
- enableToggle:toggle !== false,
- scope: editor,
- handler:handler||editor.relayBtnCmd,
- clickEvent:'mousedown',
- tooltip: tipsEnabled ? editor.buttonTips[id] || undefined : undefined,
- overflowText: editor.buttonTips[id].title || undefined,
- tabIndex:-1
- };
- }
+ /**
+ * @cfg {Boolean} collapseOnDblClick
+ * true
to enable dblclick to toggle expand and collapse on the {@link #collapseTarget} Panel.
+ */
+ collapseOnDblClick: true,
+ /**
+ * @cfg {Number} defaultSplitMin
+ * Provides a default minimum width or height for the two components
+ * that the splitter is between.
+ */
+ defaultSplitMin: 40,
- if(this.enableFont && !Ext.isSafari2){
- var fontSelectItem = new Ext.Toolbar.Item({
- autoEl: {
- tag:'select',
- cls:'x-font-select',
- html: this.createFontOptions()
- }
- });
+ /**
+ * @cfg {Number} defaultSplitMax
+ * Provides a default maximum width or height for the two components
+ * that the splitter is between.
+ */
+ defaultSplitMax: 1000,
- items.push(
- fontSelectItem,
- '-'
- );
- }
+ width: 5,
+ height: 5,
- if(this.enableFormat){
- items.push(
- btn('bold'),
- btn('italic'),
- btn('underline')
- );
- }
+ /**
+ * @cfg {Mixed} collapseTarget
+ * A string describing the relative position of the immediate sibling Panel to collapse. May be 'prev' or 'next' (Defaults to 'next')
+ * Or the immediate sibling Panel to collapse.
+ * The orientation of the mini-collapse tool will be inferred from this setting.
+ * Note that only Panels may be collapsed.
+ */
+ collapseTarget: 'next',
- if(this.enableFontSize){
- items.push(
- '-',
- btn('increasefontsize', false, this.adjustFont),
- btn('decreasefontsize', false, this.adjustFont)
- );
- }
+ /**
+ * @property orientation
+ * @type String
+ * Orientation of this Splitter. 'vertical'
when used in an hbox layout, 'horizontal'
+ * when used in a vbox layout.
+ */
- if(this.enableColors){
- items.push(
- '-', {
- itemId:'forecolor',
- cls:'x-btn-icon',
- iconCls: 'x-edit-forecolor',
- clickEvent:'mousedown',
- tooltip: tipsEnabled ? editor.buttonTips.forecolor || undefined : undefined,
- tabIndex:-1,
- menu : new Ext.menu.ColorMenu({
- allowReselect: true,
- focus: Ext.emptyFn,
- value:'000000',
- plain:true,
- listeners: {
- scope: this,
- select: function(cp, color){
- this.execCmd('forecolor', Ext.isWebKit || Ext.isIE ? '#'+color : color);
- this.deferFocus();
- }
- },
- clickEvent:'mousedown'
- })
- }, {
- itemId:'backcolor',
- cls:'x-btn-icon',
- iconCls: 'x-edit-backcolor',
- clickEvent:'mousedown',
- tooltip: tipsEnabled ? editor.buttonTips.backcolor || undefined : undefined,
- tabIndex:-1,
- menu : new Ext.menu.ColorMenu({
- focus: Ext.emptyFn,
- value:'FFFFFF',
- plain:true,
- allowReselect: true,
- listeners: {
- scope: this,
- select: function(cp, color){
- if(Ext.isGecko){
- this.execCmd('useCSS', false);
- this.execCmd('hilitecolor', color);
- this.execCmd('useCSS', true);
- this.deferFocus();
- }else{
- this.execCmd(Ext.isOpera ? 'hilitecolor' : 'backcolor', Ext.isWebKit || Ext.isIE ? '#'+color : color);
- this.deferFocus();
- }
- }
- },
- clickEvent:'mousedown'
- })
- }
- );
- }
+ onRender: function() {
+ var me = this,
+ target = me.getCollapseTarget(),
+ collapseDir = me.getCollapseDirection();
- if(this.enableAlignments){
- items.push(
- '-',
- btn('justifyleft'),
- btn('justifycenter'),
- btn('justifyright')
- );
- }
+ Ext.applyIf(me.renderData, {
+ collapseDir: collapseDir,
+ collapsible: me.collapsible || target.collapsible
+ });
+ Ext.applyIf(me.renderSelectors, {
+ collapseEl: '.' + Ext.baseCSSPrefix + 'collapse-el'
+ });
- if(!Ext.isSafari2){
- if(this.enableLinks){
- items.push(
- '-',
- btn('createlink', false, this.createLink)
- );
- }
+ this.callParent(arguments);
- if(this.enableLists){
- items.push(
- '-',
- btn('insertorderedlist'),
- btn('insertunorderedlist')
- );
+ // Add listeners on the mini-collapse tool unless performCollapse is set to false
+ if (me.performCollapse !== false) {
+ if (me.renderData.collapsible) {
+ me.mon(me.collapseEl, 'click', me.toggleTargetCmp, me);
}
- if(this.enableSourceEdit){
- items.push(
- '-',
- btn('sourceedit', true, function(btn){
- this.toggleSourceEdit(!this.sourceEditMode);
- })
- );
+ if (me.collapseOnDblClick) {
+ me.mon(me.el, 'dblclick', me.toggleTargetCmp, me);
}
}
- // build the toolbar
- var tb = new Ext.Toolbar({
- renderTo: this.wrap.dom.firstChild,
- items: items
- });
+ // Ensure the mini collapse icon is set to the correct direction when the target is collapsed/expanded by any means
+ me.mon(target, 'collapse', me.onTargetCollapse, me);
+ me.mon(target, 'expand', me.onTargetExpand, me);
- if (fontSelectItem) {
- this.fontSelect = fontSelectItem.el;
+ me.el.addCls(me.baseCls + '-' + me.orientation);
+ me.el.unselectable();
- this.mon(this.fontSelect, 'change', function(){
- var font = this.fontSelect.dom.value;
- this.relayCmd('fontname', font);
- this.deferFocus();
- }, this);
+ me.tracker = Ext.create('Ext.resizer.SplitterTracker', {
+ el: me.el
+ });
+ },
+
+ getCollapseDirection: function() {
+ var me = this,
+ idx,
+ type = me.ownerCt.layout.type;
+
+ // Avoid duplication of string tests.
+ // Create a two bit truth table of the configuration of the Splitter:
+ // Collapse Target | orientation
+ // 0 0 = next, horizontal
+ // 0 1 = next, vertical
+ // 1 0 = prev, horizontal
+ // 1 1 = prev, vertical
+ if (me.collapseTarget.isComponent) {
+ idx = Number(me.ownerCt.items.indexOf(me.collapseTarget) == me.ownerCt.items.indexOf(me) - 1) << 1 | Number(type == 'hbox');
+ } else {
+ idx = Number(me.collapseTarget == 'prev') << 1 | Number(type == 'hbox');
}
- // stop form submits
- this.mon(tb.el, 'click', function(e){
- e.preventDefault();
- });
+ // Read the data out the truth table
+ me.orientation = ['horizontal', 'vertical'][idx & 1];
+ return ['bottom', 'right', 'top', 'left'][idx];
+ },
- this.tb = tb;
- this.tb.doLayout();
+ getCollapseTarget: function() {
+ return this.collapseTarget.isComponent ? this.collapseTarget : this.collapseTarget == 'prev' ? this.previousSibling() : this.nextSibling();
},
- onDisable: function(){
- this.wrap.mask();
- Ext.form.HtmlEditor.superclass.onDisable.call(this);
+ onTargetCollapse: function(target) {
+ this.el.addCls(this.collapsedCls);
},
- onEnable: function(){
- this.wrap.unmask();
- Ext.form.HtmlEditor.superclass.onEnable.call(this);
+ onTargetExpand: function(target) {
+ this.el.removeCls(this.collapsedCls);
},
- setReadOnly: function(readOnly){
+ toggleTargetCmp: function(e, t) {
+ var cmp = this.getCollapseTarget();
- Ext.form.HtmlEditor.superclass.setReadOnly.call(this, readOnly);
- if(this.initialized){
- if(Ext.isIE){
- this.getEditorBody().contentEditable = !readOnly;
- }else{
- this.setDesignMode(!readOnly);
- }
- var bd = this.getEditorBody();
- if(bd){
- bd.style.cursor = this.readOnly ? 'default' : 'text';
+ if (cmp.isVisible()) {
+ // restore
+ if (cmp.collapsed) {
+ cmp.expand(cmp.animCollapse);
+ // collapse
+ } else {
+ cmp.collapse(this.renderData.collapseDir, cmp.animCollapse);
}
- this.disableItems(readOnly);
}
},
- /**
- * Protected method that will not generally be called directly. It
- * is called when the editor initializes the iframe with HTML contents. Override this method if you
- * want to change the initialization markup of the iframe (e.g. to add stylesheets).
- *
- * Note: IE8-Standards has unwanted scroller behavior, so the default meta tag forces IE7 compatibility
+ /*
+ * Work around IE bug. %age margins do not get recalculated on element resize unless repaint called.
*/
- getDocMarkup : function(){
- var h = Ext.fly(this.iframe).getHeight() - this.iframePad * 2;
- return String.format('', this.iframePad, h);
- },
+ setSize: function() {
+ var me = this;
+ me.callParent(arguments);
+ if (Ext.isIE) {
+ me.el.repaint();
+ }
+ }
+});
- // private
- getEditorBody : function(){
- var doc = this.getDoc();
- return doc.body || doc.documentElement;
- },
+/**
+ * @class Ext.layout.container.Border
+ * @extends Ext.layout.container.Container
+ * This is a multi-pane, application-oriented UI layout style that supports multiple
+ * nested panels, automatic bars between regions and built-in
+ * {@link Ext.panel.Panel#collapsible expanding and collapsing} of regions.
+ * This class is intended to be extended or created via the layout:'border'
+ * {@link Ext.container.Container#layout} config, and should generally not need to be created directly
+ * via the new keyword.
+ * {@img Ext.layout.container.Border/Ext.layout.container.Border.png Ext.layout.container.Border container layout}
+ * Example usage:
+ *
+ Ext.create('Ext.panel.Panel', {
+ width: 500,
+ height: 400,
+ title: 'Border Layout',
+ layout: 'border',
+ items: [{
+ title: 'South Region is resizable',
+ region: 'south', // position for region
+ xtype: 'panel',
+ height: 100,
+ split: true, // enable resizing
+ margins: '0 5 5 5'
+ },{
+ // xtype: 'panel' implied by default
+ title: 'West Region is collapsible',
+ region:'west',
+ xtype: 'panel',
+ margins: '5 0 0 5',
+ width: 200,
+ collapsible: true, // make collapsible
+ id: 'west-region-container',
+ layout: 'fit'
+ },{
+ title: 'Center Region',
+ region: 'center', // center region is required, no width/height specified
+ xtype: 'panel',
+ layout: 'fit',
+ margins: '5 5 0 0'
+ }],
+ renderTo: Ext.getBody()
+ });
+
+ * Notes:
+ * - Any Container using the Border layout must have a child item with
region:'center'
.
+ * The child item in the center region will always be resized to fill the remaining space not used by
+ * the other regions in the layout.
+ * - Any child items with a region of
west
or east
may be configured with either
+ * an initial width
, or a {@link Ext.layout.container.Box#flex} value, or an initial percentage width string (Which is simply divided by 100 and used as a flex value). The 'center' region has a flex value of 1
.
+ * - Any child items with a region of
north
or south
may be configured with either
+ * an initial height
, or a {@link Ext.layout.container.Box#flex} value, or an initial percentage height string (Which is simply divided by 100 and used as a flex value). The 'center' region has a flex value of 1
.
+ * - The regions of a BorderLayout are fixed at render time and thereafter, its child Components may not be removed or added.To add/remove
+ * Components within a BorderLayout, have them wrapped by an additional Container which is directly
+ * managed by the BorderLayout. If the region is to be collapsible, the Container used directly
+ * by the BorderLayout manager should be a Panel. In the following example a Container (an Ext.panel.Panel)
+ * is added to the west region:
+wrc = {@link Ext#getCmp Ext.getCmp}('west-region-container');
+wrc.{@link Ext.container.Container#removeAll removeAll}();
+wrc.{@link Ext.container.Container#add add}({
+ title: 'Added Panel',
+ html: 'Some content'
+});
+ *
+ *
+ * - There is no BorderLayout.Region class in ExtJS 4.0+
+ *
+ */
+Ext.define('Ext.layout.container.Border', {
- // private
- getDoc : function(){
- return Ext.isIE ? this.getWin().document : (this.iframe.contentDocument || this.getWin().document);
+ alias: ['layout.border'],
+ extend: 'Ext.layout.container.Container',
+ requires: ['Ext.resizer.Splitter', 'Ext.container.Container', 'Ext.fx.Anim'],
+ alternateClassName: 'Ext.layout.BorderLayout',
+
+ targetCls: Ext.baseCSSPrefix + 'border-layout-ct',
+
+ itemCls: Ext.baseCSSPrefix + 'border-item',
+
+ bindToOwnerCtContainer: true,
+
+ fixedLayout: false,
+
+ percentageRe: /(\d+)%/,
+
+ slideDirection: {
+ north: 't',
+ south: 'b',
+ west: 'l',
+ east: 'r'
},
- // private
- getWin : function(){
- return Ext.isIE ? this.iframe.contentWindow : window.frames[this.iframe.name];
+ constructor: function(config) {
+ this.initialConfig = config;
+ this.callParent(arguments);
},
- // private
- onRender : function(ct, position){
- Ext.form.HtmlEditor.superclass.onRender.call(this, ct, position);
- this.el.dom.style.border = '0 none';
- this.el.dom.setAttribute('tabIndex', -1);
- this.el.addClass('x-hidden');
- if(Ext.isIE){ // fix IE 1px bogus margin
- this.el.applyStyles('margin-top:-1px;margin-bottom:-1px;');
- }
- this.wrap = this.el.wrap({
- cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'}
- });
+ onLayout: function() {
+ var me = this;
+ if (!me.borderLayoutInitialized) {
+ me.initializeBorderLayout();
+ }
- this.createToolbar(this);
+ // Delegate this operation to the shadow "V" or "H" box layout, and then down to any embedded layout.
+ me.shadowLayout.onLayout();
+ if (me.embeddedContainer) {
+ me.embeddedContainer.layout.onLayout();
+ }
- this.disableItems(true);
+ // If the panel was originally configured with collapsed: true, it will have
+ // been initialized with a "borderCollapse" flag: Collapse it now before the first layout.
+ if (!me.initialCollapsedComplete) {
+ Ext.iterate(me.regions, function(name, region){
+ if (region.borderCollapse) {
+ me.onBeforeRegionCollapse(region, region.collapseDirection, false, 0);
+ }
+ });
+ me.initialCollapsedComplete = true;
+ }
+ },
- this.tb.doLayout();
+ isValidParent : function(item, target, position) {
+ if (!this.borderLayoutInitialized) {
+ this.initializeBorderLayout();
+ }
- this.createIFrame();
+ // Delegate this operation to the shadow "V" or "H" box layout.
+ return this.shadowLayout.isValidParent(item, target, position);
+ },
- if(!this.width){
- var sz = this.el.getSize();
- this.setSize(sz.width, this.height || sz.height);
+ beforeLayout: function() {
+ if (!this.borderLayoutInitialized) {
+ this.initializeBorderLayout();
}
- this.resizeEl = this.positionEl = this.wrap;
- },
- createIFrame: function(){
- var iframe = document.createElement('iframe');
- iframe.name = Ext.id();
- iframe.frameBorder = '0';
- iframe.style.overflow = 'auto';
+ // Delegate this operation to the shadow "V" or "H" box layout.
+ this.shadowLayout.beforeLayout();
+ },
- this.wrap.dom.appendChild(iframe);
- this.iframe = iframe;
+ renderItems: function(items, target) {
+ Ext.Error.raise('This should not be called');
+ },
- this.monitorTask = Ext.TaskMgr.start({
- run: this.checkDesignMode,
- scope: this,
- interval:100
- });
+ renderItem: function(item) {
+ Ext.Error.raise('This should not be called');
},
- initFrame : function(){
- Ext.TaskMgr.stop(this.monitorTask);
- var doc = this.getDoc();
- this.win = this.getWin();
+ initializeBorderLayout: function() {
+ var me = this,
+ i = 0,
+ items = me.getLayoutItems(),
+ ln = items.length,
+ regions = (me.regions = {}),
+ vBoxItems = [],
+ hBoxItems = [],
+ horizontalFlex = 0,
+ verticalFlex = 0,
+ comp, percentage;
+
+ // Map of Splitters for each region
+ me.splitters = {};
+
+ // Map of regions
+ for (; i < ln; i++) {
+ comp = items[i];
+ regions[comp.region] = comp;
+
+ // Intercept collapsing to implement showing an alternate Component as a collapsed placeholder
+ if (comp.region != 'center' && comp.collapsible && comp.collapseMode != 'header') {
+
+ // This layout intercepts any initial collapsed state. Panel must not do this itself.
+ comp.borderCollapse = comp.collapsed;
+ delete comp.collapsed;
+
+ comp.on({
+ beforecollapse: me.onBeforeRegionCollapse,
+ beforeexpand: me.onBeforeRegionExpand,
+ destroy: me.onRegionDestroy,
+ scope: me
+ });
+ me.setupState(comp);
+ }
+ }
+ if (!regions.center) {
+ Ext.Error.raise("You must specify a center region when defining a BorderLayout.");
+ }
+ comp = regions.center;
+ if (!comp.flex) {
+ comp.flex = 1;
+ }
+ delete comp.width;
+ comp.maintainFlex = true;
+
+ // Begin the VBox and HBox item list.
+ comp = regions.west;
+ if (comp) {
+ comp.collapseDirection = Ext.Component.DIRECTION_LEFT;
+ hBoxItems.push(comp);
+ if (comp.split) {
+ hBoxItems.push(me.splitters.west = me.createSplitter(comp));
+ }
+ percentage = Ext.isString(comp.width) && comp.width.match(me.percentageRe);
+ if (percentage) {
+ horizontalFlex += (comp.flex = parseInt(percentage[1], 10) / 100);
+ delete comp.width;
+ }
+ }
+ comp = regions.north;
+ if (comp) {
+ comp.collapseDirection = Ext.Component.DIRECTION_TOP;
+ vBoxItems.push(comp);
+ if (comp.split) {
+ vBoxItems.push(me.splitters.north = me.createSplitter(comp));
+ }
+ percentage = Ext.isString(comp.height) && comp.height.match(me.percentageRe);
+ if (percentage) {
+ verticalFlex += (comp.flex = parseInt(percentage[1], 10) / 100);
+ delete comp.height;
+ }
+ }
+
+ // Decide into which Collection the center region goes.
+ if (regions.north || regions.south) {
+ if (regions.east || regions.west) {
+
+ // Create the embedded center. Mark it with the region: 'center' property so that it can be identified as the center.
+ vBoxItems.push(me.embeddedContainer = Ext.create('Ext.container.Container', {
+ xtype: 'container',
+ region: 'center',
+ id: me.owner.id + '-embedded-center',
+ cls: Ext.baseCSSPrefix + 'border-item',
+ flex: regions.center.flex,
+ maintainFlex: true,
+ layout: {
+ type: 'hbox',
+ align: 'stretch'
+ }
+ }));
+ hBoxItems.push(regions.center);
+ }
+ // No east or west: the original center goes straight into the vbox
+ else {
+ vBoxItems.push(regions.center);
+ }
+ }
+ // If we have no north or south, then the center is part of the HBox items
+ else {
+ hBoxItems.push(regions.center);
+ }
+
+ // Finish off the VBox and HBox item list.
+ comp = regions.south;
+ if (comp) {
+ comp.collapseDirection = Ext.Component.DIRECTION_BOTTOM;
+ if (comp.split) {
+ vBoxItems.push(me.splitters.south = me.createSplitter(comp));
+ }
+ percentage = Ext.isString(comp.height) && comp.height.match(me.percentageRe);
+ if (percentage) {
+ verticalFlex += (comp.flex = parseInt(percentage[1], 10) / 100);
+ delete comp.height;
+ }
+ vBoxItems.push(comp);
+ }
+ comp = regions.east;
+ if (comp) {
+ comp.collapseDirection = Ext.Component.DIRECTION_RIGHT;
+ if (comp.split) {
+ hBoxItems.push(me.splitters.east = me.createSplitter(comp));
+ }
+ percentage = Ext.isString(comp.width) && comp.width.match(me.percentageRe);
+ if (percentage) {
+ horizontalFlex += (comp.flex = parseInt(percentage[1], 10) / 100);
+ delete comp.width;
+ }
+ hBoxItems.push(comp);
+ }
+
+ // Create the injected "items" collections for the Containers.
+ // If we have north or south, then the shadow Container will be a VBox.
+ // If there are also east or west regions, its center will be a shadow HBox.
+ // If there are *only* east or west regions, then the shadow layout will be an HBox (or Fit).
+ if (regions.north || regions.south) {
+
+ me.shadowContainer = Ext.create('Ext.container.Container', {
+ ownerCt: me.owner,
+ el: me.getTarget(),
+ layout: Ext.applyIf({
+ type: 'vbox',
+ align: 'stretch'
+ }, me.initialConfig)
+ });
+ me.createItems(me.shadowContainer, vBoxItems);
- doc.open();
- doc.write(this.getDocMarkup());
- doc.close();
+ // Allow the Splitters to orientate themselves
+ if (me.splitters.north) {
+ me.splitters.north.ownerCt = me.shadowContainer;
+ }
+ if (me.splitters.south) {
+ me.splitters.south.ownerCt = me.shadowContainer;
+ }
+
+ // Inject items into the HBox Container if there is one - if there was an east or west.
+ if (me.embeddedContainer) {
+ me.embeddedContainer.ownerCt = me.shadowContainer;
+ me.createItems(me.embeddedContainer, hBoxItems);
- var task = { // must defer to wait for browser to be ready
- run : function(){
- var doc = this.getDoc();
- if(doc.body || doc.readyState == 'complete'){
- Ext.TaskMgr.stop(task);
- this.setDesignMode(true);
- this.initEditor.defer(10, this);
+ // Allow the Splitters to orientate themselves
+ if (me.splitters.east) {
+ me.splitters.east.ownerCt = me.embeddedContainer;
+ }
+ if (me.splitters.west) {
+ me.splitters.west.ownerCt = me.embeddedContainer;
}
- },
- interval : 10,
- duration:10000,
- scope: this
- };
- Ext.TaskMgr.start(task);
- },
+ // The east or west region wanted a percentage
+ if (horizontalFlex) {
+ regions.center.flex -= horizontalFlex;
+ }
+ // The north or south region wanted a percentage
+ if (verticalFlex) {
+ me.embeddedContainer.flex -= verticalFlex;
+ }
+ } else {
+ // The north or south region wanted a percentage
+ if (verticalFlex) {
+ regions.center.flex -= verticalFlex;
+ }
+ }
+ }
+ // If we have no north or south, then there's only one Container, and it's
+ // an HBox, or, if only a center region was specified, a Fit.
+ else {
+ me.shadowContainer = Ext.create('Ext.container.Container', {
+ ownerCt: me.owner,
+ el: me.getTarget(),
+ layout: Ext.applyIf({
+ type: (hBoxItems.length == 1) ? 'fit' : 'hbox',
+ align: 'stretch'
+ }, me.initialConfig)
+ });
+ me.createItems(me.shadowContainer, hBoxItems);
- checkDesignMode : function(){
- if(this.wrap && this.wrap.dom.offsetWidth){
- var doc = this.getDoc();
- if(!doc){
- return;
+ // Allow the Splitters to orientate themselves
+ if (me.splitters.east) {
+ me.splitters.east.ownerCt = me.shadowContainer;
}
- if(!doc.editorInitialized || this.getDesignMode() != 'on'){
- this.initFrame();
+ if (me.splitters.west) {
+ me.splitters.west.ownerCt = me.shadowContainer;
+ }
+
+ // The east or west region wanted a percentage
+ if (horizontalFlex) {
+ regions.center.flex -= verticalFlex;
}
}
- },
- /* private
- * set current design mode. To enable, mode can be true or 'on', off otherwise
- */
- setDesignMode : function(mode){
- var doc ;
- if(doc = this.getDoc()){
- if(this.readOnly){
- mode = false;
+ // Create upward links from the region Components to their shadow ownerCts
+ for (i = 0, items = me.shadowContainer.items.items, ln = items.length; i < ln; i++) {
+ items[i].shadowOwnerCt = me.shadowContainer;
+ }
+ if (me.embeddedContainer) {
+ for (i = 0, items = me.embeddedContainer.items.items, ln = items.length; i < ln; i++) {
+ items[i].shadowOwnerCt = me.embeddedContainer;
}
- doc.designMode = (/on|true/i).test(String(mode).toLowerCase()) ?'on':'off';
}
+ // This is the layout that we delegate all operations to
+ me.shadowLayout = me.shadowContainer.getLayout();
+
+ me.borderLayoutInitialized = true;
},
- // private
- getDesignMode : function(){
- var doc = this.getDoc();
- if(!doc){ return ''; }
- return String(doc.designMode).toLowerCase();
+ setupState: function(comp){
+ var getState = comp.getState;
+ comp.getState = function(){
+ // call the original getState
+ var state = getState.call(comp) || {},
+ region = comp.region;
+
+ state.collapsed = !!comp.collapsed;
+ if (region == 'west' || region == 'east') {
+ state.width = comp.getWidth();
+ } else {
+ state.height = comp.getHeight();
+ }
+ return state;
+ };
+ comp.addStateEvents(['collapse', 'expand', 'resize']);
+ },
+
+ /**
+ * Create the items collection for our shadow/embedded containers
+ * @private
+ */
+ createItems: function(container, items){
+ // Have to inject an items Collection *after* construction.
+ // The child items of the shadow layout must retain their original, user-defined ownerCt
+ delete container.items;
+ container.initItems();
+ container.items.addAll(items);
},
- disableItems: function(disabled){
- if(this.fontSelect){
- this.fontSelect.dom.disabled = disabled;
+ // Private
+ // Create a splitter for a child of the layout.
+ createSplitter: function(comp) {
+ var me = this,
+ interceptCollapse = (comp.collapseMode != 'header'),
+ resizer;
+
+ resizer = Ext.create('Ext.resizer.Splitter', {
+ hidden: !!comp.hidden,
+ collapseTarget: comp,
+ performCollapse: !interceptCollapse,
+ listeners: interceptCollapse ? {
+ click: {
+ fn: Ext.Function.bind(me.onSplitterCollapseClick, me, [comp]),
+ element: 'collapseEl'
+ }
+ } : null
+ });
+
+ // Mini collapse means that the splitter is the placeholder Component
+ if (comp.collapseMode == 'mini') {
+ comp.placeholder = resizer;
}
- this.tb.items.each(function(item){
- if(item.getItemId() != 'sourceedit'){
- item.setDisabled(disabled);
- }
+
+ // Arrange to hide/show a region's associated splitter when the region is hidden/shown
+ comp.on({
+ hide: me.onRegionVisibilityChange,
+ show: me.onRegionVisibilityChange,
+ scope: me
});
+ return resizer;
},
- // private
- onResize : function(w, h){
- Ext.form.HtmlEditor.superclass.onResize.apply(this, arguments);
- if(this.el && this.iframe){
- if(Ext.isNumber(w)){
- var aw = w - this.wrap.getFrameWidth('lr');
- this.el.setWidth(aw);
- this.tb.setWidth(aw);
- this.iframe.style.width = Math.max(aw, 0) + 'px';
- }
- if(Ext.isNumber(h)){
- var ah = h - this.wrap.getFrameWidth('tb') - this.tb.el.getHeight();
- this.el.setHeight(ah);
- this.iframe.style.height = Math.max(ah, 0) + 'px';
- var bd = this.getEditorBody();
- if(bd){
- bd.style.height = Math.max((ah - (this.iframePad*2)), 0) + 'px';
- }
- }
+ // Hide/show a region's associated splitter when the region is hidden/shown
+ onRegionVisibilityChange: function(comp){
+ this.splitters[comp.region][comp.hidden ? 'hide' : 'show']();
+ this.layout();
+ },
+
+ // Called when a splitter mini-collapse tool is clicked on.
+ // The listener is only added if this layout is controlling collapsing,
+ // not if the component's collapseMode is 'mini' or 'header'.
+ onSplitterCollapseClick: function(comp) {
+ if (comp.collapsed) {
+ this.onPlaceHolderToolClick(null, null, null, {client: comp});
+ } else {
+ comp.collapse();
}
},
/**
- * Toggles the editor between standard and source edit mode.
- * @param {Boolean} sourceEdit (optional) True for source edit, false for standard
+ * Return the {@link Ext.panel.Panel#placeholder placeholder} Component to which the passed child Panel of the layout will collapse.
+ * By default, this will be a {@link Ext.panel.Header Header} component (Docked to the appropriate border). See {@link Ext.panel.Panel#placeholder placeholder}.
+ * config to customize this.
+ * Note that this will be a fully instantiated Component, but will only be rendered when the Panel is first collapsed.
+ * @param {Panel} panel The child Panel of the layout for which to return the {@link Ext.panel.Panel#placeholder placeholder}.
+ * @returns {Component} The Panel's {@link Ext.panel.Panel#placeholder placeholder} unless the {@link Ext.panel.Panel#collapseMode collapseMode} is
+ * 'header'
, in which case undefined is returned.
*/
- toggleSourceEdit : function(sourceEditMode){
- var iframeHeight,
- elHeight;
-
- if (sourceEditMode === undefined) {
- sourceEditMode = !this.sourceEditMode;
+ getPlaceholder: function(comp) {
+ var me = this,
+ placeholder = comp.placeholder,
+ shadowContainer = comp.shadowOwnerCt,
+ shadowLayout = shadowContainer.layout,
+ oppositeDirection = Ext.panel.Panel.prototype.getOppositeDirection(comp.collapseDirection),
+ horiz = (comp.region == 'north' || comp.region == 'south');
+
+ // No placeholder if the collapse mode is not the Border layout default
+ if (comp.collapseMode == 'header') {
+ return;
}
- this.sourceEditMode = sourceEditMode === true;
- var btn = this.tb.getComponent('sourceedit');
- if (btn.pressed !== this.sourceEditMode) {
- btn.toggle(this.sourceEditMode);
- if (!btn.xtbHidden) {
- return;
+ // Provide a replacement Container with an expand tool
+ if (!placeholder) {
+ if (comp.collapseMode == 'mini') {
+ placeholder = Ext.create('Ext.resizer.Splitter', {
+ id: 'collapse-placeholder-' + comp.id,
+ collapseTarget: comp,
+ performCollapse: false,
+ listeners: {
+ click: {
+ fn: Ext.Function.bind(me.onSplitterCollapseClick, me, [comp]),
+ element: 'collapseEl'
+ }
+ }
+ });
+ placeholder.addCls(placeholder.collapsedCls);
+ } else {
+ placeholder = {
+ id: 'collapse-placeholder-' + comp.id,
+ margins: comp.initialConfig.margins || Ext.getClass(comp).prototype.margins,
+ xtype: 'header',
+ orientation: horiz ? 'horizontal' : 'vertical',
+ title: comp.title,
+ textCls: comp.headerTextCls,
+ iconCls: comp.iconCls,
+ baseCls: comp.baseCls + '-header',
+ ui: comp.ui,
+ indicateDrag: comp.draggable,
+ cls: Ext.baseCSSPrefix + 'region-collapsed-placeholder ' + Ext.baseCSSPrefix + 'region-collapsed-' + comp.collapseDirection + '-placeholder',
+ listeners: comp.floatable ? {
+ click: {
+ fn: function(e) {
+ me.floatCollapsedPanel(e, comp);
+ },
+ element: 'el'
+ }
+ } : null
+ };
+ // Hack for IE6/7/IEQuirks's inability to display an inline-block
+ if ((Ext.isIE6 || Ext.isIE7 || (Ext.isIEQuirks)) && !horiz) {
+ placeholder.width = 25;
+ }
+ placeholder[horiz ? 'tools' : 'items'] = [{
+ xtype: 'tool',
+ client: comp,
+ type: 'expand-' + oppositeDirection,
+ handler: me.onPlaceHolderToolClick,
+ scope: me
+ }];
+ }
+ placeholder = me.owner.createComponent(placeholder);
+ if (comp.isXType('panel')) {
+ comp.on({
+ titlechange: me.onRegionTitleChange,
+ iconchange: me.onRegionIconChange,
+ scope: me
+ });
}
}
- if (this.sourceEditMode) {
- // grab the height of the containing panel before we hide the iframe
- this.previousSize = this.getSize();
-
- iframeHeight = Ext.get(this.iframe).getHeight();
-
- this.disableItems(true);
- this.syncValue();
- this.iframe.className = 'x-hidden';
- this.el.removeClass('x-hidden');
- this.el.dom.removeAttribute('tabIndex');
- this.el.focus();
- this.el.dom.style.height = iframeHeight + 'px';
- }
- else {
- elHeight = parseInt(this.el.dom.style.height, 10);
- if (this.initialized) {
- this.disableItems(this.readOnly);
- }
- this.pushValue();
- this.iframe.className = '';
- this.el.addClass('x-hidden');
- this.el.dom.setAttribute('tabIndex', -1);
- this.deferFocus();
- this.setSize(this.previousSize);
- delete this.previousSize;
- this.iframe.style.height = elHeight + 'px';
- }
- this.fireEvent('editmodechange', this, this.sourceEditMode);
- },
+ // The collapsed Component holds a reference to its placeholder and vice versa
+ comp.placeholder = placeholder;
+ placeholder.comp = comp;
- // private used internally
- createLink : function() {
- var url = prompt(this.createLinkText, this.defaultLinkValue);
- if(url && url != 'http:/'+'/'){
- this.relayCmd('createlink', url);
- }
+ return placeholder;
},
- // private
- initEvents : function(){
- this.originalValue = this.getValue();
+ /**
+ * @private
+ * Update the placeholder title when panel title has been set or changed.
+ */
+ onRegionTitleChange: function(comp, newTitle) {
+ comp.placeholder.setTitle(newTitle);
},
/**
- * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
- * @method
+ * @private
+ * Update the placeholder iconCls when panel iconCls has been set or changed.
*/
- markInvalid : Ext.emptyFn,
+ onRegionIconChange: function(comp, newIconCls) {
+ comp.placeholder.setIconCls(newIconCls);
+ },
/**
- * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
- * @method
+ * @private
+ * Calculates the size and positioning of the passed child item. Must be present because Panel's expand,
+ * when configured with a flex, calls this method on its ownerCt's layout.
+ * @param {Component} child The child Component to calculate the box for
+ * @return {Object} Object containing box measurements for the child. Properties are left,top,width,height.
*/
- clearInvalid : Ext.emptyFn,
-
- // docs inherit from Field
- setValue : function(v){
- Ext.form.HtmlEditor.superclass.setValue.call(this, v);
- this.pushValue();
- return this;
+ calculateChildBox: function(comp) {
+ var me = this;
+ if (me.shadowContainer.items.contains(comp)) {
+ return me.shadowContainer.layout.calculateChildBox(comp);
+ }
+ else if (me.embeddedContainer && me.embeddedContainer.items.contains(comp)) {
+ return me.embeddedContainer.layout.calculateChildBox(comp);
+ }
},
/**
- * Protected method that will not generally be called directly. If you need/want
- * custom HTML cleanup, this is the method you should override.
- * @param {String} html The HTML to be cleaned
- * @return {String} The cleaned HTML
- */
- cleanHtml: function(html) {
- html = String(html);
- if(Ext.isWebKit){ // strip safari nonsense
- html = html.replace(/\sclass="(?:Apple-style-span|khtml-block-placeholder)"/gi, '');
+ * @private
+ * Intercepts the Panel's own collapse event and perform's substitution of the Panel
+ * with a placeholder Header orientated in the appropriate dimension.
+ * @param comp The Panel being collapsed.
+ * @param direction
+ * @param animate
+ * @returns {Boolean} false to inhibit the Panel from performing its own collapse.
+ */
+ onBeforeRegionCollapse: function(comp, direction, animate) {
+ var me = this,
+ compEl = comp.el,
+ miniCollapse = comp.collapseMode == 'mini',
+ shadowContainer = comp.shadowOwnerCt,
+ shadowLayout = shadowContainer.layout,
+ placeholder = comp.placeholder,
+ placeholderBox,
+ targetSize = shadowLayout.getLayoutTargetSize(),
+ sl = me.owner.suspendLayout,
+ scsl = shadowContainer.suspendLayout,
+ isNorthOrWest = (comp.region == 'north' || comp.region == 'west'); // Flag to keep the placeholder non-adjacent to any Splitter
+
+ // Do not trigger a layout during transition to collapsed Component
+ me.owner.suspendLayout = true;
+ shadowContainer.suspendLayout = true;
+
+ // Prevent upward notifications from downstream layouts
+ shadowLayout.layoutBusy = true;
+ if (shadowContainer.componentLayout) {
+ shadowContainer.componentLayout.layoutBusy = true;
+ }
+ me.shadowContainer.layout.layoutBusy = true;
+ me.layoutBusy = true;
+ me.owner.componentLayout.layoutBusy = true;
+
+ // Provide a replacement Container with an expand tool
+ if (!placeholder) {
+ placeholder = me.getPlaceholder(comp);
+ }
+
+ // placeholder already in place; show it.
+ if (placeholder.shadowOwnerCt === shadowContainer) {
+ placeholder.show();
+ }
+ // Insert the collapsed placeholder Component into the appropriate Box layout shadow Container
+ // It must go next to its client Component, but non-adjacent to the splitter so splitter can find its collapse client.
+ // Inject an ownerCt value pointing to the owner, border layout Container as the user will expect.
+ else {
+ shadowContainer.insert(shadowContainer.items.indexOf(comp) + (isNorthOrWest ? 0 : 1), placeholder);
+ placeholder.shadowOwnerCt = shadowContainer;
+ placeholder.ownerCt = me.owner;
+ }
+
+ // Flag the collapsing Component as hidden and show the placeholder.
+ // This causes the shadow Box layout's calculateChildBoxes to calculate the correct new arrangement.
+ // We hide or slideOut the Component's element
+ comp.hidden = true;
+
+ if (!placeholder.rendered) {
+ shadowLayout.renderItem(placeholder, shadowLayout.innerCt);
+ }
+
+ // Jobs to be done after the collapse has been done
+ function afterCollapse() {
+
+ // Reinstate automatic laying out.
+ me.owner.suspendLayout = sl;
+ shadowContainer.suspendLayout = scsl;
+ delete shadowLayout.layoutBusy;
+ if (shadowContainer.componentLayout) {
+ delete shadowContainer.componentLayout.layoutBusy;
+ }
+ delete me.shadowContainer.layout.layoutBusy;
+ delete me.layoutBusy;
+ delete me.owner.componentLayout.layoutBusy;
+
+ // Fire the collapse event: The Panel has in fact been collapsed, but by substitution of an alternative Component
+ comp.collapsed = true;
+ comp.fireEvent('collapse', comp);
}
/*
- * Neat little hack. Strips out all the non-digit characters from the default
- * value and compares it to the character code of the first character in the string
- * because it can cause encoding issues when posted to the server.
+ * Set everything to the new positions. Note that we
+ * only want to animate the collapse if it wasn't configured
+ * initially with collapsed: true
*/
- if(html.charCodeAt(0) == this.defaultValue.replace(/\D/g, '')){
- html = html.substring(1);
- }
- return html;
- },
+ if (comp.animCollapse && me.initialCollapsedComplete) {
+ shadowLayout.layout();
+ compEl.dom.style.zIndex = 100;
- /**
- * Protected method that will not generally be called directly. Syncs the contents
- * of the editor iframe with the textarea.
- */
- syncValue : function(){
- if(this.initialized){
- var bd = this.getEditorBody();
- var html = bd.innerHTML;
- if(Ext.isWebKit){
- var bs = bd.getAttribute('style'); // Safari puts text-align styles on the body element!
- var m = bs.match(/text-align:(.*?);/i);
- if(m && m[1]){
- html = '' + html + '';
- }
+ // If we're mini-collapsing, the placholder is a Splitter. We don't want it to "bounce in"
+ if (!miniCollapse) {
+ placeholder.el.hide();
}
- html = this.cleanHtml(html);
- if(this.fireEvent('beforesync', this, html) !== false){
- this.el.dom.value = html;
- this.fireEvent('sync', this, html);
+ compEl.slideOut(me.slideDirection[comp.region], {
+ duration: Ext.Number.from(comp.animCollapse, Ext.fx.Anim.prototype.duration),
+ listeners: {
+ afteranimate: function() {
+ compEl.show().setLeftTop(-10000, -10000);
+ compEl.dom.style.zIndex = '';
+
+ // If we're mini-collapsing, the placholder is a Splitter. We don't want it to "bounce in"
+ if (!miniCollapse) {
+ placeholder.el.slideIn(me.slideDirection[comp.region], {
+ easing: 'linear',
+ duration: 100
+ });
+ }
+ afterCollapse();
+ }
+ }
+ });
+ } else {
+ compEl.setLeftTop(-10000, -10000);
+ shadowLayout.layout();
+ afterCollapse();
+
+ // Horrible workaround for https://sencha.jira.com/browse/EXTJSIV-1562
+ if (Ext.isIE) {
+ placeholder.setCalculatedSize(placeholder.el.getWidth());
}
}
+
+ return false;
},
- //docs inherit from Field
- getValue : function() {
- this[this.sourceEditMode ? 'pushValue' : 'syncValue']();
- return Ext.form.HtmlEditor.superclass.getValue.call(this);
+ // Hijack the expand operation to remove the placeholder and slide the region back in.
+ onBeforeRegionExpand: function(comp, animate) {
+ this.onPlaceHolderToolClick(null, null, null, {client: comp});
+ return false;
},
- /**
- * Protected method that will not generally be called directly. Pushes the value of the textarea
- * into the iframe editor.
- */
- pushValue : function(){
- if(this.initialized){
- var v = this.el.dom.value;
- if(!this.activated && v.length < 1){
- v = this.defaultValue;
- }
- if(this.fireEvent('beforepush', this, v) !== false){
- this.getEditorBody().innerHTML = v;
- if(Ext.isGecko){
- // Gecko hack, see: https://bugzilla.mozilla.org/show_bug.cgi?id=232791#c8
- this.setDesignMode(false); //toggle off first
- this.setDesignMode(true);
+ // Called when the collapsed placeholder is clicked to reinstate a "collapsed" (in reality hidden) Panel.
+ onPlaceHolderToolClick: function(e, target, owner, tool) {
+ var me = this,
+ comp = tool.client,
+
+ // Hide the placeholder unless it was the Component's preexisting splitter
+ hidePlaceholder = (comp.collapseMode != 'mini') || !comp.split,
+ compEl = comp.el,
+ toCompBox,
+ placeholder = comp.placeholder,
+ placeholderEl = placeholder.el,
+ shadowContainer = comp.shadowOwnerCt,
+ shadowLayout = shadowContainer.layout,
+ curSize,
+ sl = me.owner.suspendLayout,
+ scsl = shadowContainer.suspendLayout,
+ isFloating;
+
+ // If the slide in is still going, stop it.
+ // This will either leave the Component in its fully floated state (which is processed below)
+ // or in its collapsed state. Either way, we expand it..
+ if (comp.getActiveAnimation()) {
+ comp.stopAnimation();
+ }
+
+ // If the Component is fully floated when they click the placeholder Tool,
+ // it will be primed with a slide out animation object... so delete that
+ // and remove the mouseout listeners
+ if (comp.slideOutAnim) {
+ // Remove mouse leave monitors
+ compEl.un(comp.panelMouseMon);
+ placeholderEl.un(comp.placeholderMouseMon);
+
+ delete comp.slideOutAnim;
+ delete comp.panelMouseMon;
+ delete comp.placeholderMouseMon;
+
+ // If the Panel was floated and primed with a slideOut animation, we don't want to animate its layout operation.
+ isFloating = true;
+ }
+
+ // Do not trigger a layout during transition to expanded Component
+ me.owner.suspendLayout = true;
+ shadowContainer.suspendLayout = true;
+
+ // Prevent upward notifications from downstream layouts
+ shadowLayout.layoutBusy = true;
+ if (shadowContainer.componentLayout) {
+ shadowContainer.componentLayout.layoutBusy = true;
+ }
+ me.shadowContainer.layout.layoutBusy = true;
+ me.layoutBusy = true;
+ me.owner.componentLayout.layoutBusy = true;
+
+ // Unset the hidden and collapsed flags set in onBeforeRegionCollapse. The shadowLayout will now take it into account
+ // Find where the shadow Box layout plans to put the expanding Component.
+ comp.hidden = false;
+ comp.collapsed = false;
+ if (hidePlaceholder) {
+ placeholder.hidden = true;
+ }
+ toCompBox = shadowLayout.calculateChildBox(comp);
+
+ // Show the collapse tool in case it was hidden by the slide-in
+ if (comp.collapseTool) {
+ comp.collapseTool.show();
+ }
+
+ // If we're going to animate, we need to hide the component before moving it back into position
+ if (comp.animCollapse && !isFloating) {
+ compEl.setStyle('visibility', 'hidden');
+ }
+ compEl.setLeftTop(toCompBox.left, toCompBox.top);
+
+ // Equalize the size of the expanding Component prior to animation
+ // in case the layout area has changed size during the time it was collapsed.
+ curSize = comp.getSize();
+ if (curSize.height != toCompBox.height || curSize.width != toCompBox.width) {
+ me.setItemSize(comp, toCompBox.width, toCompBox.height);
+ }
+
+ // Jobs to be done after the expand has been done
+ function afterExpand() {
+ // Reinstate automatic laying out.
+ me.owner.suspendLayout = sl;
+ shadowContainer.suspendLayout = scsl;
+ delete shadowLayout.layoutBusy;
+ if (shadowContainer.componentLayout) {
+ delete shadowContainer.componentLayout.layoutBusy;
+ }
+ delete me.shadowContainer.layout.layoutBusy;
+ delete me.layoutBusy;
+ delete me.owner.componentLayout.layoutBusy;
+
+ // In case it was floated out and they clicked the re-expand tool
+ comp.removeCls(Ext.baseCSSPrefix + 'border-region-slide-in');
+
+ // Fire the expand event: The Panel has in fact been expanded, but by removal of an alternative Component
+ comp.fireEvent('expand', comp);
+ }
+
+ // Hide the placeholder
+ if (hidePlaceholder) {
+ placeholder.el.hide();
+ }
+
+ // Slide the expanding Component to its new position.
+ // When that is done, layout the layout.
+ if (comp.animCollapse && !isFloating) {
+ compEl.dom.style.zIndex = 100;
+ compEl.slideIn(me.slideDirection[comp.region], {
+ duration: Ext.Number.from(comp.animCollapse, Ext.fx.Anim.prototype.duration),
+ listeners: {
+ afteranimate: function() {
+ compEl.dom.style.zIndex = '';
+ comp.hidden = false;
+ shadowLayout.onLayout();
+ afterExpand();
+ }
}
- this.fireEvent('push', this, v);
+ });
+ } else {
+ shadowLayout.onLayout();
+ afterExpand();
+ }
+ },
+
+ floatCollapsedPanel: function(e, comp) {
+
+ if (comp.floatable === false) {
+ return;
+ }
+
+ var me = this,
+ compEl = comp.el,
+ placeholder = comp.placeholder,
+ placeholderEl = placeholder.el,
+ shadowContainer = comp.shadowOwnerCt,
+ shadowLayout = shadowContainer.layout,
+ placeholderBox = shadowLayout.getChildBox(placeholder),
+ scsl = shadowContainer.suspendLayout,
+ curSize, toCompBox, compAnim;
+
+ // Ignore clicks on tools.
+ if (e.getTarget('.' + Ext.baseCSSPrefix + 'tool')) {
+ return;
+ }
+
+ // It's *being* animated, ignore the click.
+ // Possible future enhancement: Stop and *reverse* the current active Fx.
+ if (compEl.getActiveAnimation()) {
+ return;
+ }
+
+ // If the Component is already fully floated when they click the placeholder,
+ // it will be primed with a slide out animation object... so slide it out.
+ if (comp.slideOutAnim) {
+ me.slideOutFloatedComponent(comp);
+ return;
+ }
+
+ // Function to be called when the mouse leaves the floated Panel
+ // Slide out when the mouse leaves the region bounded by the slid Component and its placeholder.
+ function onMouseLeaveFloated(e) {
+ var slideRegion = compEl.getRegion().union(placeholderEl.getRegion()).adjust(1, -1, -1, 1);
+
+ // If mouse is not within slide Region, slide it out
+ if (!slideRegion.contains(e.getPoint())) {
+ me.slideOutFloatedComponent(comp);
}
+ }
+
+ // Monitor for mouseouting of the placeholder. Hide it if they exit for half a second or more
+ comp.placeholderMouseMon = placeholderEl.monitorMouseLeave(500, onMouseLeaveFloated);
+
+ // Do not trigger a layout during slide out of the Component
+ shadowContainer.suspendLayout = true;
+ // Prevent upward notifications from downstream layouts
+ me.layoutBusy = true;
+ me.owner.componentLayout.layoutBusy = true;
+
+ // The collapse tool is hidden while slid.
+ // It is re-shown on expand.
+ if (comp.collapseTool) {
+ comp.collapseTool.hide();
+ }
+
+ // Set flags so that the layout will calculate the boxes for what we want
+ comp.hidden = false;
+ comp.collapsed = false;
+ placeholder.hidden = true;
+
+ // Recalculate new arrangement of the Component being floated.
+ toCompBox = shadowLayout.calculateChildBox(comp);
+ placeholder.hidden = false;
+
+ // Component to appear just after the placeholder, whatever "after" means in the context of the shadow Box layout.
+ if (comp.region == 'north' || comp.region == 'west') {
+ toCompBox[shadowLayout.parallelBefore] += placeholderBox[shadowLayout.parallelPrefix] - 1;
+ } else {
+ toCompBox[shadowLayout.parallelBefore] -= (placeholderBox[shadowLayout.parallelPrefix] - 1);
+ }
+ compEl.setStyle('visibility', 'hidden');
+ compEl.setLeftTop(toCompBox.left, toCompBox.top);
+
+ // Equalize the size of the expanding Component prior to animation
+ // in case the layout area has changed size during the time it was collapsed.
+ curSize = comp.getSize();
+ if (curSize.height != toCompBox.height || curSize.width != toCompBox.width) {
+ me.setItemSize(comp, toCompBox.width, toCompBox.height);
}
+
+ // This animation slides the collapsed Component's el out to just beyond its placeholder
+ compAnim = {
+ listeners: {
+ afteranimate: function() {
+ shadowContainer.suspendLayout = scsl;
+ delete me.layoutBusy;
+ delete me.owner.componentLayout.layoutBusy;
+
+ // Prime the Component with an Anim config object to slide it back out
+ compAnim.listeners = {
+ afterAnimate: function() {
+ compEl.show().removeCls(Ext.baseCSSPrefix + 'border-region-slide-in').setLeftTop(-10000, -10000);
+
+ // Reinstate the correct, current state after slide out animation finishes
+ comp.hidden = true;
+ comp.collapsed = true;
+ delete comp.slideOutAnim;
+ delete comp.panelMouseMon;
+ delete comp.placeholderMouseMon;
+ }
+ };
+ comp.slideOutAnim = compAnim;
+ }
+ },
+ duration: 500
+ };
+
+ // Give the element the correct class which places it at a high z-index
+ compEl.addCls(Ext.baseCSSPrefix + 'border-region-slide-in');
+
+ // Begin the slide in
+ compEl.slideIn(me.slideDirection[comp.region], compAnim);
+
+ // Monitor for mouseouting of the slid area. Hide it if they exit for half a second or more
+ comp.panelMouseMon = compEl.monitorMouseLeave(500, onMouseLeaveFloated);
+
},
- // private
- deferFocus : function(){
- this.focus.defer(10, this);
+ slideOutFloatedComponent: function(comp) {
+ var compEl = comp.el,
+ slideOutAnim;
+
+ // Remove mouse leave monitors
+ compEl.un(comp.panelMouseMon);
+ comp.placeholder.el.un(comp.placeholderMouseMon);
+
+ // Slide the Component out
+ compEl.slideOut(this.slideDirection[comp.region], comp.slideOutAnim);
+
+ delete comp.slideOutAnim;
+ delete comp.panelMouseMon;
+ delete comp.placeholderMouseMon;
},
- // docs inherit from Field
- focus : function(){
- if(this.win && !this.sourceEditMode){
- this.win.focus();
- }else{
- this.el.focus();
+ /*
+ * @private
+ * Ensure any collapsed placeholder Component is destroyed along with its region.
+ * Can't do this in onDestroy because they may remove a Component and use it elsewhere.
+ */
+ onRegionDestroy: function(comp) {
+ var placeholder = comp.placeholder;
+ if (placeholder) {
+ delete placeholder.ownerCt;
+ placeholder.destroy();
}
},
- // private
- initEditor : function(){
- //Destroying the component during/before initEditor can cause issues.
- try{
- var dbody = this.getEditorBody(),
- ss = this.el.getStyles('font-size', 'font-family', 'background-image', 'background-repeat', 'background-color', 'color'),
- doc,
- fn;
+ /*
+ * @private
+ * Ensure any shadow Containers are destroyed.
+ * Ensure we don't keep references to Components.
+ */
+ onDestroy: function() {
+ var me = this,
+ shadowContainer = me.shadowContainer,
+ embeddedContainer = me.embeddedContainer;
- ss['background-attachment'] = 'fixed'; // w3c
- dbody.bgProperties = 'fixed'; // ie
+ if (shadowContainer) {
+ delete shadowContainer.ownerCt;
+ Ext.destroy(shadowContainer);
+ }
+
+ if (embeddedContainer) {
+ delete embeddedContainer.ownerCt;
+ Ext.destroy(embeddedContainer);
+ }
+ delete me.regions;
+ delete me.splitters;
+ delete me.shadowContainer;
+ delete me.embeddedContainer;
+ me.callParent(arguments);
+ }
+});
+
+/**
+ * @class Ext.layout.container.Card
+ * @extends Ext.layout.container.AbstractCard
+ * This layout manages multiple child Components, each fitted to the Container, where only a single child Component can be
+ * visible at any given time. This layout style is most commonly used for wizards, tab implementations, etc.
+ * This class is intended to be extended or created via the layout:'card' {@link Ext.container.Container#layout} config,
+ * and should generally not need to be created directly via the new keyword.
+ * The CardLayout's focal method is {@link #setActiveItem}. Since only one panel is displayed at a time,
+ * the only way to move from one Component to the next is by calling setActiveItem, passing the id or index of
+ * the next panel to display. The layout itself does not provide a user interface for handling this navigation,
+ * so that functionality must be provided by the developer.
+ * In the following example, a simplistic wizard setup is demonstrated. A button bar is added
+ * to the footer of the containing panel to provide navigation buttons. The buttons will be handled by a
+ * common navigation routine -- for this example, the implementation of that routine has been ommitted since
+ * it can be any type of custom logic. Note that other uses of a CardLayout (like a tab control) would require a
+ * completely different implementation. For serious implementations, a better approach would be to extend
+ * CardLayout to provide the custom functionality needed.
+ * {@img Ext.layout.container.Card/Ext.layout.container.Card.png Ext.layout.container.Card container layout}
+ * Example usage:
+ *
+ var navHandler = function(direction){
+ // This routine could contain business logic required to manage the navigation steps.
+ // It would call setActiveItem as needed, manage navigation button state, handle any
+ // branching logic that might be required, handle alternate actions like cancellation
+ // or finalization, etc. A complete wizard implementation could get pretty
+ // sophisticated depending on the complexity required, and should probably be
+ // done as a subclass of CardLayout in a real-world implementation.
+ };
+
+ Ext.create('Ext.panel.Panel', {
+ title: 'Example Wizard',
+ width: 300,
+ height: 200,
+ layout: 'card',
+ activeItem: 0, // make sure the active item is set on the container config!
+ bodyStyle: 'padding:15px',
+ defaults: {
+ // applied to each contained panel
+ border:false
+ },
+ // just an example of one possible navigation scheme, using buttons
+ bbar: [
+ {
+ id: 'move-prev',
+ text: 'Back',
+ handler: navHandler(this, [-1]),
+ disabled: true
+ },
+ '->', // greedy spacer so that the buttons are aligned to each side
+ {
+ id: 'move-next',
+ text: 'Next',
+ handler: navHandler(this, [1])
+ }],
+ // the panels (or "cards") within the layout
+ items: [{
+ id: 'card-0',
+ html: 'Welcome to the Wizard!
Step 1 of 3
'
+ },{
+ id: 'card-1',
+ html: 'Step 2 of 3
'
+ },{
+ id: 'card-2',
+ html: 'Congratulations!
Step 3 of 3 - Complete
'
+ }],
+ renderTo: Ext.getBody()
+ });
+
+ */
+Ext.define('Ext.layout.container.Card', {
- Ext.DomHelper.applyStyles(dbody, ss);
+ /* Begin Definitions */
- doc = this.getDoc();
+ alias: ['layout.card'],
+ alternateClassName: 'Ext.layout.CardLayout',
- if(doc){
- try{
- Ext.EventManager.removeAll(doc);
- }catch(e){}
+ extend: 'Ext.layout.container.AbstractCard',
+
+ /* End Definitions */
+
+ setActiveItem: function(newCard) {
+ var me = this,
+ owner = me.owner,
+ oldCard = me.activeItem,
+ newIndex;
+
+ // Block upward layouts until we are done.
+ me.layoutBusy = true;
+
+ newCard = me.parseActiveItem(newCard);
+ newIndex = owner.items.indexOf(newCard);
+
+ // If the card is not a child of the owner, then add it
+ if (newIndex == -1) {
+ newIndex = owner.items.items.length;
+ owner.add(newCard);
+ }
+
+ // Is this a valid, different card?
+ if (newCard && oldCard != newCard) {
+ // If the card has not been rendered yet, now is the time to do so.
+ if (!newCard.rendered) {
+ me.renderItem(newCard, me.getRenderTarget(), owner.items.length);
+ me.configureItem(newCard, 0);
}
- /*
- * We need to use createDelegate here, because when using buffer, the delayed task is added
- * as a property to the function. When the listener is removed, the task is deleted from the function.
- * Since onEditorEvent is shared on the prototype, if we have multiple html editors, the first time one of the editors
- * is destroyed, it causes the fn to be deleted from the prototype, which causes errors. Essentially, we're just anonymizing the function.
- */
- fn = this.onEditorEvent.createDelegate(this);
- Ext.EventManager.on(doc, {
- mousedown: fn,
- dblclick: fn,
- click: fn,
- keyup: fn,
- buffer:100
- });
+ me.activeItem = newCard;
- if(Ext.isGecko){
- Ext.EventManager.on(doc, 'keypress', this.applyCommand, this);
+ // Fire the beforeactivate and beforedeactivate events on the cards
+ if (newCard.fireEvent('beforeactivate', newCard, oldCard) === false) {
+ me.layoutBusy = false;
+ return false;
}
- if(Ext.isIE || Ext.isWebKit || Ext.isOpera){
- Ext.EventManager.on(doc, 'keydown', this.fixKeys, this);
+ if (oldCard && oldCard.fireEvent('beforedeactivate', oldCard, newCard) === false) {
+ me.layoutBusy = false;
+ return false;
}
- doc.editorInitialized = true;
- this.initialized = true;
- this.pushValue();
- this.setReadOnly(this.readOnly);
- this.fireEvent('initialize', this);
- }catch(e){}
- },
- // private
- onDestroy : function(){
- if(this.monitorTask){
- Ext.TaskMgr.stop(this.monitorTask);
- }
- if(this.rendered){
- Ext.destroy(this.tb);
- var doc = this.getDoc();
- if(doc){
- try{
- Ext.EventManager.removeAll(doc);
- for (var prop in doc){
- delete doc[prop];
- }
- }catch(e){}
+ // If the card hasnt been sized yet, do it now
+ if (!me.sizeAllCards) {
+ me.setItemBox(newCard, me.getTargetBox());
}
- if(this.wrap){
- this.wrap.dom.innerHTML = '';
- this.wrap.remove();
+ else {
+ // onLayout calls setItemBox
+ me.onLayout();
}
- }
- if(this.el){
- this.el.removeAllListeners();
- this.el.remove();
- }
- this.purgeListeners();
- },
+ if (oldCard) {
+ if (me.hideInactive) {
+ oldCard.hide();
+ }
+ oldCard.fireEvent('deactivate', oldCard, newCard);
+ }
- // private
- onFirstFocus : function(){
- this.activated = true;
- this.disableItems(this.readOnly);
- if(Ext.isGecko){ // prevent silly gecko errors
- this.win.focus();
- var s = this.win.getSelection();
- if(!s.focusNode || s.focusNode.nodeType != 3){
- var r = s.getRangeAt(0);
- r.selectNodeContents(this.getEditorBody());
- r.collapse(true);
- this.deferFocus();
+ // Make sure the new card is shown
+ if (newCard.hidden) {
+ newCard.show();
}
- try{
- this.execCmd('useCSS', true);
- this.execCmd('styleWithCSS', false);
- }catch(e){}
- }
- this.fireEvent('activate', this);
- },
- // private
- adjustFont: function(btn){
- var adjust = btn.getItemId() == 'increasefontsize' ? 1 : -1,
- doc = this.getDoc(),
- v = parseInt(doc.queryCommandValue('FontSize') || 2, 10);
- if((Ext.isSafari && !Ext.isSafari2) || Ext.isChrome || Ext.isAir){
- // Safari 3 values
- // 1 = 10px, 2 = 13px, 3 = 16px, 4 = 18px, 5 = 24px, 6 = 32px
- if(v <= 10){
- v = 1 + adjust;
- }else if(v <= 13){
- v = 2 + adjust;
- }else if(v <= 16){
- v = 3 + adjust;
- }else if(v <= 18){
- v = 4 + adjust;
- }else if(v <= 24){
- v = 5 + adjust;
- }else {
- v = 6 + adjust;
- }
- v = v.constrain(1, 6);
- }else{
- if(Ext.isSafari){ // safari
- adjust *= 2;
+ newCard.fireEvent('activate', newCard, oldCard);
+
+ me.layoutBusy = false;
+
+ if (!me.sizeAllCards) {
+ if (!owner.componentLayout.layoutBusy) {
+ me.onLayout();
+ }
}
- v = Math.max(1, v+adjust) + (Ext.isSafari ? 'px' : 0);
+ return newCard;
}
- this.execCmd('FontSize', v);
- },
- // private
- onEditorEvent : function(e){
- this.updateToolbar();
- },
+ me.layoutBusy = false;
+ return false;
+ }
+});
+/**
+ * @class Ext.layout.container.Column
+ * @extends Ext.layout.container.Auto
+ * This is the layout style of choice for creating structural layouts in a multi-column format where the width of
+ * each column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.
+ * This class is intended to be extended or created via the layout:'column' {@link Ext.container.Container#layout} config,
+ * and should generally not need to be created directly via the new keyword.
+ * ColumnLayout does not have any direct config options (other than inherited ones), but it does support a
+ * specific config property of columnWidth that can be included in the config of any panel added to it. The
+ * layout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.
+ * If width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).
+ * The width property is always evaluated as pixels, and must be a number greater than or equal to 1.
+ * The columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and
+ * less than 1 (e.g., .25).
+ * The basic rules for specifying column widths are pretty simple. The logic makes two passes through the
+ * set of contained panels. During the first layout pass, all panels that either have a fixed width or none
+ * specified (auto) are skipped, but their widths are subtracted from the overall container width. During the second
+ * pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on
+ * the total remaining container width. In other words, percentage width panels are designed to fill the space
+ * left over by all the fixed-width and/or auto-width panels. Because of this, while you can specify any number of columns
+ * with different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your
+ * layout may not render as expected.
+ * {@img Ext.layout.container.Column/Ext.layout.container.Column1.png Ext.layout.container.Column container layout}
+ * Example usage:
+ *
+ // All columns are percentages -- they must add up to 1
+ Ext.create('Ext.panel.Panel', {
+ title: 'Column Layout - Percentage Only',
+ width: 350,
+ height: 250,
+ layout:'column',
+ items: [{
+ title: 'Column 1',
+ columnWidth: .25
+ },{
+ title: 'Column 2',
+ columnWidth: .55
+ },{
+ title: 'Column 3',
+ columnWidth: .20
+ }],
+ renderTo: Ext.getBody()
+ });
+// {@img Ext.layout.container.Column/Ext.layout.container.Column2.png Ext.layout.container.Column container layout}
+// Mix of width and columnWidth -- all columnWidth values must add up
+// to 1. The first column will take up exactly 120px, and the last two
+// columns will fill the remaining container width.
- /**
- * Protected method that will not generally be called directly. It triggers
- * a toolbar update by reading the markup state of the current selection in the editor.
- */
- updateToolbar: function(){
+ Ext.create('Ext.Panel', {
+ title: 'Column Layout - Mixed',
+ width: 350,
+ height: 250,
+ layout:'column',
+ items: [{
+ title: 'Column 1',
+ width: 120
+ },{
+ title: 'Column 2',
+ columnWidth: .7
+ },{
+ title: 'Column 3',
+ columnWidth: .3
+ }],
+ renderTo: Ext.getBody()
+ });
+
+ */
+Ext.define('Ext.layout.container.Column', {
- if(this.readOnly){
- return;
- }
+ extend: 'Ext.layout.container.Auto',
+ alias: ['layout.column'],
+ alternateClassName: 'Ext.layout.ColumnLayout',
- if(!this.activated){
- this.onFirstFocus();
- return;
- }
+ type: 'column',
- var btns = this.tb.items.map,
- doc = this.getDoc();
+ itemCls: Ext.baseCSSPrefix + 'column',
- if(this.enableFont && !Ext.isSafari2){
- var name = (doc.queryCommandValue('FontName')||this.defaultFont).toLowerCase();
- if(name != this.fontSelect.dom.value){
- this.fontSelect.dom.value = name;
- }
- }
- if(this.enableFormat){
- btns.bold.toggle(doc.queryCommandState('bold'));
- btns.italic.toggle(doc.queryCommandState('italic'));
- btns.underline.toggle(doc.queryCommandState('underline'));
- }
- if(this.enableAlignments){
- btns.justifyleft.toggle(doc.queryCommandState('justifyleft'));
- btns.justifycenter.toggle(doc.queryCommandState('justifycenter'));
- btns.justifyright.toggle(doc.queryCommandState('justifyright'));
- }
- if(!Ext.isSafari2 && this.enableLists){
- btns.insertorderedlist.toggle(doc.queryCommandState('insertorderedlist'));
- btns.insertunorderedlist.toggle(doc.queryCommandState('insertunorderedlist'));
- }
+ targetCls: Ext.baseCSSPrefix + 'column-layout-ct',
- Ext.menu.MenuMgr.hideAll();
+ scrollOffset: 0,
- this.syncValue();
- },
+ bindToOwnerCtComponent: false,
- // private
- relayBtnCmd : function(btn){
- this.relayCmd(btn.getItemId());
- },
+ getRenderTarget : function() {
+ if (!this.innerCt) {
- /**
- * Executes a Midas editor command on the editor document and performs necessary focus and
- * toolbar updates. This should only be called after the editor is initialized.
- * @param {String} cmd The Midas command
- * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null)
- */
- relayCmd : function(cmd, value){
- (function(){
- this.focus();
- this.execCmd(cmd, value);
- this.updateToolbar();
- }).defer(10, this);
- },
+ // the innerCt prevents wrapping and shuffling while
+ // the container is resizing
+ this.innerCt = this.getTarget().createChild({
+ cls: Ext.baseCSSPrefix + 'column-inner'
+ });
- /**
- * Executes a Midas editor command directly on the editor document.
- * For visual commands, you should use {@link #relayCmd} instead.
- * This should only be called after the editor is initialized.
- * @param {String} cmd The Midas command
- * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null)
- */
- execCmd : function(cmd, value){
- var doc = this.getDoc();
- doc.execCommand(cmd, false, value === undefined ? null : value);
- this.syncValue();
+ // Column 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"
+ this.clearEl = this.innerCt.createChild({
+ cls: Ext.baseCSSPrefix + 'clear',
+ role: 'presentation'
+ });
+ }
+ return this.innerCt;
},
// private
- applyCommand : function(e){
- if(e.ctrlKey){
- var c = e.getCharCode(), cmd;
- if(c > 0){
- c = String.fromCharCode(c);
- switch(c){
- case 'b':
- cmd = 'bold';
- break;
- case 'i':
- cmd = 'italic';
- break;
- case 'u':
- cmd = 'underline';
- break;
- }
- if(cmd){
- this.win.focus();
- this.execCmd(cmd);
- this.deferFocus();
- e.preventDefault();
+ onLayout : function() {
+ var me = this,
+ target = me.getTarget(),
+ items = me.getLayoutItems(),
+ len = items.length,
+ item,
+ i,
+ parallelMargins = [],
+ itemParallelMargins,
+ size,
+ availableWidth,
+ columnWidth;
+
+ size = me.getLayoutTargetSize();
+ if (size.width < len * 10) { // Don't lay out in impossibly small target (probably display:none, or initial, unsized Container)
+ return;
+ }
+
+ // On the first pass, for all except IE6-7, we lay out the items with no scrollbars visible using style overflow: hidden.
+ // If, after the layout, it is detected that there is vertical overflow,
+ // we will recurse back through here. Do not adjust overflow style at that time.
+ if (me.adjustmentPass) {
+ if (Ext.isIE6 || Ext.isIE7 || Ext.isIEQuirks) {
+ size.width = me.adjustedWidth;
+ }
+ } else {
+ i = target.getStyle('overflow');
+ if (i && i != 'hidden') {
+ me.autoScroll = true;
+ if (!(Ext.isIE6 || Ext.isIE7 || Ext.isIEQuirks)) {
+ target.setStyle('overflow', 'hidden');
+ size = me.getLayoutTargetSize();
}
}
}
- },
- /**
- * Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
- * to insert text.
- * @param {String} text
- */
- insertAtCursor : function(text){
- if(!this.activated){
- return;
- }
- if(Ext.isIE){
- this.win.focus();
- var doc = this.getDoc(),
- r = doc.selection.createRange();
- if(r){
- r.pasteHTML(text);
- this.syncValue();
- this.deferFocus();
+ availableWidth = size.width - me.scrollOffset;
+ me.innerCt.setWidth(availableWidth);
+
+ // some columns can be percentages while others are fixed
+ // so we need to make 2 passes
+ for (i = 0; i < len; i++) {
+ item = items[i];
+ itemParallelMargins = parallelMargins[i] = item.getEl().getMargin('lr');
+ if (!item.columnWidth) {
+ availableWidth -= (item.getWidth() + itemParallelMargins);
}
- }else{
- this.win.focus();
- this.execCmd('InsertHTML', text);
- this.deferFocus();
}
- },
- // private
- fixKeys : function(){ // load time branching for fastest keydown performance
- if(Ext.isIE){
- return function(e){
- var k = e.getKey(),
- doc = this.getDoc(),
- r;
- if(k == e.TAB){
- e.stopEvent();
- r = doc.selection.createRange();
- if(r){
- r.collapse(true);
- r.pasteHTML(' ');
- this.deferFocus();
- }
- }else if(k == e.ENTER){
- r = doc.selection.createRange();
- if(r){
- var target = r.parentElement();
- if(!target || target.tagName.toLowerCase() != 'li'){
- e.stopEvent();
- r.pasteHTML('
');
- r.collapse(false);
- r.select();
- }
- }
- }
- };
- }else if(Ext.isOpera){
- return function(e){
- var k = e.getKey();
- if(k == e.TAB){
- e.stopEvent();
- this.win.focus();
- this.execCmd('InsertHTML',' ');
- this.deferFocus();
- }
- };
- }else if(Ext.isWebKit){
- return function(e){
- var k = e.getKey();
- if(k == e.TAB){
- e.stopEvent();
- this.execCmd('InsertText','\t');
- this.deferFocus();
- }else if(k == e.ENTER){
- e.stopEvent();
- this.execCmd('InsertHtml','
');
- this.deferFocus();
+ availableWidth = availableWidth < 0 ? 0 : availableWidth;
+ for (i = 0; i < len; i++) {
+ item = items[i];
+ if (item.columnWidth) {
+ columnWidth = Math.floor(item.columnWidth * availableWidth) - parallelMargins[i];
+ if (item.getWidth() != columnWidth) {
+ me.setItemSize(item, columnWidth, item.height);
}
- };
+ }
}
- }(),
- /**
- * Returns the editor's toolbar. This is only available after the editor has been rendered.
- * @return {Ext.Toolbar}
- */
- getToolbar : function(){
- return this.tb;
- },
+ // After the first pass on an autoScroll layout, restore the overflow settings if it had been changed (only changed for non-IE6)
+ if (!me.adjustmentPass && me.autoScroll) {
- /**
- * Object collection of toolbar tooltips for the buttons in the editor. The key
- * is the command id associated with that button and the value is a valid QuickTips object.
- * For example:
-
-{
- bold : {
- title: 'Bold (Ctrl+B)',
- text: 'Make the selected text bold.',
- cls: 'x-html-editor-tip'
- },
- italic : {
- title: 'Italic (Ctrl+I)',
- text: 'Make the selected text italic.',
- cls: 'x-html-editor-tip'
- },
- ...
-
- * @type Object
- */
- buttonTips : {
- bold : {
- title: 'Bold (Ctrl+B)',
- text: 'Make the selected text bold.',
- cls: 'x-html-editor-tip'
- },
- italic : {
- title: 'Italic (Ctrl+I)',
- text: 'Make the selected text italic.',
- cls: 'x-html-editor-tip'
- },
- underline : {
- title: 'Underline (Ctrl+U)',
- text: 'Underline the selected text.',
- cls: 'x-html-editor-tip'
- },
- increasefontsize : {
- title: 'Grow Text',
- text: 'Increase the font size.',
- cls: 'x-html-editor-tip'
- },
- decreasefontsize : {
- title: 'Shrink Text',
- text: 'Decrease the font size.',
- cls: 'x-html-editor-tip'
- },
- backcolor : {
- title: 'Text Highlight Color',
- text: 'Change the background color of the selected text.',
- cls: 'x-html-editor-tip'
- },
- forecolor : {
- title: 'Font Color',
- text: 'Change the color of the selected text.',
- cls: 'x-html-editor-tip'
- },
- justifyleft : {
- title: 'Align Text Left',
- text: 'Align text to the left.',
- cls: 'x-html-editor-tip'
- },
- justifycenter : {
- title: 'Center Text',
- text: 'Center text in the editor.',
- cls: 'x-html-editor-tip'
- },
- justifyright : {
- title: 'Align Text Right',
- text: 'Align text to the right.',
- cls: 'x-html-editor-tip'
- },
- insertunorderedlist : {
- title: 'Bullet List',
- text: 'Start a bulleted list.',
- cls: 'x-html-editor-tip'
- },
- insertorderedlist : {
- title: 'Numbered List',
- text: 'Start a numbered list.',
- cls: 'x-html-editor-tip'
- },
- createlink : {
- title: 'Hyperlink',
- text: 'Make the selected text a hyperlink.',
- cls: 'x-html-editor-tip'
- },
- sourceedit : {
- title: 'Source Edit',
- text: 'Switch to source editing mode.',
- cls: 'x-html-editor-tip'
+ // If there's a vertical overflow, relay with scrollbars
+ target.setStyle('overflow', 'auto');
+ me.adjustmentPass = (target.dom.scrollHeight > size.height);
+ if (Ext.isIE6 || Ext.isIE7 || Ext.isIEQuirks) {
+ me.adjustedWidth = size.width - Ext.getScrollBarWidth();
+ } else {
+ target.setStyle('overflow', 'auto');
+ }
+
+ // If the layout caused height overflow, recurse back and recalculate (with overflow setting restored on non-IE6)
+ if (me.adjustmentPass) {
+ me.onLayout();
+ }
}
+ delete me.adjustmentPass;
}
-
- // hide stuff that is not compatible
- /**
- * @event blur
- * @hide
- */
- /**
- * @event change
- * @hide
- */
- /**
- * @event focus
- * @hide
- */
- /**
- * @event specialkey
- * @hide
- */
- /**
- * @cfg {String} fieldClass @hide
- */
- /**
- * @cfg {String} focusClass @hide
- */
- /**
- * @cfg {String} autoCreate @hide
- */
- /**
- * @cfg {String} inputType @hide
- */
- /**
- * @cfg {String} invalidClass @hide
- */
- /**
- * @cfg {String} invalidText @hide
- */
- /**
- * @cfg {String} msgFx @hide
- */
- /**
- * @cfg {String} validateOnBlur @hide
- */
- /**
- * @cfg {Boolean} allowDomMove @hide
- */
- /**
- * @cfg {String} applyTo @hide
- */
- /**
- * @cfg {String} autoHeight @hide
- */
- /**
- * @cfg {String} autoWidth @hide
- */
- /**
- * @cfg {String} cls @hide
- */
- /**
- * @cfg {String} disabled @hide
- */
- /**
- * @cfg {String} disabledClass @hide
- */
- /**
- * @cfg {String} msgTarget @hide
- */
- /**
- * @cfg {String} readOnly @hide
- */
- /**
- * @cfg {String} style @hide
- */
- /**
- * @cfg {String} validationDelay @hide
- */
- /**
- * @cfg {String} validationEvent @hide
- */
- /**
- * @cfg {String} tabIndex @hide
- */
- /**
- * @property disabled
- * @hide
- */
- /**
- * @method applyToMarkup
- * @hide
- */
- /**
- * @method disable
- * @hide
- */
- /**
- * @method enable
- * @hide
- */
- /**
- * @method validate
- * @hide
- */
- /**
- * @event valid
- * @hide
- */
- /**
- * @method setDisabled
- * @hide
- */
- /**
- * @cfg keys
- * @hide
- */
});
-Ext.reg('htmleditor', Ext.form.HtmlEditor);
/**
- * @class Ext.form.TimeField
- * @extends Ext.form.ComboBox
- * Provides a time input field with a time dropdown and automatic time validation. Example usage:
+ * @class Ext.layout.container.Table
+ * @extends Ext.layout.container.Auto
+ * This layout allows you to easily render content into an HTML table. The total number of columns can be
+ * specified, and rowspan and colspan can be used to create complex layouts within the table.
+ * This class is intended to be extended or created via the layout: {type: 'table'}
+ * {@link Ext.container.Container#layout} config, and should generally not need to be created directly via the new keyword.
+ * Note that when creating a layout via config, the layout-specific config properties must be passed in via
+ * the {@link Ext.container.Container#layout} object which will then be applied internally to the layout. In the
+ * case of TableLayout, the only valid layout config properties are {@link #columns} and {@link #tableAttrs}.
+ * However, the items added to a TableLayout can supply the following table-specific config properties:
+ *
+ * - rowspan Applied to the table cell containing the item.
+ * - colspan Applied to the table cell containing the item.
+ * - cellId An id applied to the table cell containing the item.
+ * - cellCls A CSS class name added to the table cell containing the item.
+ *
+ * The basic concept of building up a TableLayout is conceptually very similar to building up a standard
+ * HTML table. You simply add each panel (or "cell") that you want to include along with any span attributes
+ * specified as the special config properties of rowspan and colspan which work exactly like their HTML counterparts.
+ * Rather than explicitly creating and nesting rows and columns as you would in HTML, you simply specify the
+ * total column count in the layoutConfig and start adding panels in their natural order from left to right,
+ * top to bottom. The layout will automatically figure out, based on the column count, rowspans and colspans,
+ * how to position each panel within the table. Just like with HTML tables, your rowspans and colspans must add
+ * up correctly in your overall layout or you'll end up with missing and/or extra cells! Example usage:
+ * {@img Ext.layout.container.Table/Ext.layout.container.Table.png Ext.layout.container.Table container layout}
*
-new Ext.form.TimeField({
- minValue: '9:00 AM',
- maxValue: '6:00 PM',
- increment: 30
-});
+// This code will generate a layout table that is 3 columns by 2 rows
+// with some spanning included. The basic layout will be:
+// +--------+-----------------+
+// | A | B |
+// | |--------+--------|
+// | | C | D |
+// +--------+--------+--------+
+ Ext.create('Ext.panel.Panel', {
+ title: 'Table Layout',
+ width: 300,
+ height: 150,
+ layout: {
+ type: 'table',
+ // The total column count must be specified here
+ columns: 3
+ },
+ defaults: {
+ // applied to each contained panel
+ bodyStyle:'padding:20px'
+ },
+ items: [{
+ html: 'Cell A content
',
+ rowspan: 2
+ },{
+ html: 'Cell B content
',
+ colspan: 2
+ },{
+ html: 'Cell C content
',
+ cellCls: 'highlight'
+ },{
+ html: 'Cell D content
'
+ }],
+ renderTo: Ext.getBody()
+ });
- * @constructor
- * Create a new TimeField
- * @param {Object} config
- * @xtype timefield
*/
-Ext.form.TimeField = Ext.extend(Ext.form.ComboBox, {
- /**
- * @cfg {Date/String} minValue
- * The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
- * time in a valid format -- see {@link #format} and {@link #altFormats} (defaults to undefined).
- */
- minValue : undefined,
- /**
- * @cfg {Date/String} maxValue
- * The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
- * time in a valid format -- see {@link #format} and {@link #altFormats} (defaults to undefined).
- */
- maxValue : undefined,
- /**
- * @cfg {String} minText
- * The error text to display when the date in the cell is before minValue (defaults to
- * 'The time in this field must be equal to or after {0}').
- */
- minText : "The time in this field must be equal to or after {0}",
- /**
- * @cfg {String} maxText
- * The error text to display when the time is after maxValue (defaults to
- * 'The time in this field must be equal to or before {0}').
- */
- maxText : "The time in this field must be equal to or before {0}",
- /**
- * @cfg {String} invalidText
- * The error text to display when the time in the field is invalid (defaults to
- * '{value} is not a valid time').
- */
- invalidText : "{0} is not a valid time",
- /**
- * @cfg {String} format
- * The default time format string which can be overriden for localization support. The format must be
- * valid according to {@link Date#parseDate} (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
- * format try 'H:i' instead.
- */
- format : "g:i A",
- /**
- * @cfg {String} altFormats
- * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
- * format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A').
- */
- altFormats : "g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A",
+
+Ext.define('Ext.layout.container.Table', {
+
+ /* Begin Definitions */
+
+ alias: ['layout.table'],
+ extend: 'Ext.layout.container.Auto',
+ alternateClassName: 'Ext.layout.TableLayout',
+
+ /* End Definitions */
+
/**
- * @cfg {Number} increment
- * The number of minutes between each time value in the list (defaults to 15).
+ * @cfg {Number} columns
+ * The total number of columns to create in the table for this layout. If not specified, all Components added to
+ * this layout will be rendered into a single row using one column per Component.
*/
- increment: 15,
- // private override
- mode: 'local',
- // private override
- triggerAction: 'all',
- // private override
- typeAhead: false,
+ // private
+ monitorResize:false,
- // private - This is the date to use when generating time values in the absence of either minValue
- // or maxValue. Using the current date causes DST issues on DST boundary dates, so this is an
- // arbitrary "safe" date that can be any date aside from DST boundary dates.
- initDate: '1/1/2008',
+ type: 'table',
- initDateFormat: 'j/n/Y',
+ // Table layout is a self-sizing layout. When an item of for example, a dock layout, the Panel must expand to accommodate
+ // a table layout. See in particular AbstractDock::onLayout for use of this flag.
+ autoSize: true,
- // private
- initComponent : function(){
- if(Ext.isDefined(this.minValue)){
- this.setMinValue(this.minValue, true);
- }
- if(Ext.isDefined(this.maxValue)){
- this.setMaxValue(this.maxValue, true);
- }
- if(!this.store){
- this.generateStore(true);
- }
- Ext.form.TimeField.superclass.initComponent.call(this);
- },
+ clearEl: true, // Base class will not create it if already truthy. Not needed in tables.
+
+ targetCls: Ext.baseCSSPrefix + 'table-layout-ct',
+ tableCls: Ext.baseCSSPrefix + 'table-layout',
+ cellCls: Ext.baseCSSPrefix + 'table-layout-cell',
/**
- * Replaces any existing {@link #minValue} with the new time and refreshes the store.
- * @param {Date/String} value The minimum time that can be selected
+ * @cfg {Object} tableAttrs
+ * An object containing properties which are added to the {@link Ext.core.DomHelper DomHelper} specification
+ * used to create the layout's <table> element. Example:
+{
+ xtype: 'panel',
+ layout: {
+ type: 'table',
+ columns: 3,
+ tableAttrs: {
+ style: {
+ width: '100%'
+ }
+ }
+ }
+}
*/
- setMinValue: function(value, /* private */ initial){
- this.setLimit(value, true, initial);
- return this;
- },
+ tableAttrs:null,
/**
- * Replaces any existing {@link #maxValue} with the new time and refreshes the store.
- * @param {Date/String} value The maximum time that can be selected
+ * @private
+ * Iterates over all passed items, ensuring they are rendered in a cell in the proper
+ * location in the table structure.
*/
- setMaxValue: function(value, /* private */ initial){
- this.setLimit(value, false, initial);
- return this;
- },
+ renderItems: function(items) {
+ var tbody = this.getTable().tBodies[0],
+ rows = tbody.rows,
+ i = 0,
+ len = items.length,
+ cells, curCell, rowIdx, cellIdx, item, trEl, tdEl, itemCt;
+
+ // Calculate the correct cell structure for the current items
+ cells = this.calculateCells(items);
+
+ // Loop over each cell and compare to the current cells in the table, inserting/
+ // removing/moving cells as needed, and making sure each item is rendered into
+ // the correct cell.
+ for (; i < len; i++) {
+ curCell = cells[i];
+ rowIdx = curCell.rowIdx;
+ cellIdx = curCell.cellIdx;
+ item = items[i];
- // private
- generateStore: function(initial){
- var min = this.minValue || new Date(this.initDate).clearTime(),
- max = this.maxValue || new Date(this.initDate).clearTime().add('mi', (24 * 60) - 1),
- times = [];
+ // If no row present, create and insert one
+ trEl = rows[rowIdx];
+ if (!trEl) {
+ trEl = tbody.insertRow(rowIdx);
+ }
- while(min <= max){
- times.push(min.dateFormat(this.format));
- min = min.add('mi', this.increment);
- }
- this.bindStore(times, initial);
- },
+ // If no cell present, create and insert one
+ itemCt = tdEl = Ext.get(trEl.cells[cellIdx] || trEl.insertCell(cellIdx));
+ if (this.needsDivWrap()) { //create wrapper div if needed - see docs below
+ itemCt = tdEl.first() || tdEl.createChild({tag: 'div'});
+ itemCt.setWidth(null);
+ }
- // private
- setLimit: function(value, isMin, initial){
- var d;
- if(Ext.isString(value)){
- d = this.parseDate(value);
- }else if(Ext.isDate(value)){
- d = value;
- }
- if(d){
- var val = new Date(this.initDate).clearTime();
- val.setHours(d.getHours(), d.getMinutes(), d.getSeconds(), d.getMilliseconds());
- this[isMin ? 'minValue' : 'maxValue'] = val;
- if(!initial){
- this.generateStore();
+ // Render or move the component into the cell
+ if (!item.rendered) {
+ this.renderItem(item, itemCt, 0);
+ }
+ else if (!this.isValidParent(item, itemCt, 0)) {
+ this.moveItem(item, itemCt, 0);
+ }
+
+ // Set the cell properties
+ tdEl.set({
+ colSpan: item.colspan || 1,
+ rowSpan: item.rowspan || 1,
+ id: item.cellId || '',
+ cls: this.cellCls + ' ' + (item.cellCls || '')
+ });
+
+ // If at the end of a row, remove any extra cells
+ if (!cells[i + 1] || cells[i + 1].rowIdx !== rowIdx) {
+ cellIdx++;
+ while (trEl.cells[cellIdx]) {
+ trEl.deleteCell(cellIdx);
+ }
}
}
- },
- // inherited docs
- getValue : function(){
- var v = Ext.form.TimeField.superclass.getValue.call(this);
- return this.formatDate(this.parseDate(v)) || '';
+ // Delete any extra rows
+ rowIdx++;
+ while (tbody.rows[rowIdx]) {
+ tbody.deleteRow(rowIdx);
+ }
},
- // inherited docs
- setValue : function(value){
- return Ext.form.TimeField.superclass.setValue.call(this, this.formatDate(this.parseDate(value)));
+ afterLayout: function() {
+ this.callParent();
+
+ if (this.needsDivWrap()) {
+ // set wrapper div width to match layed out item - see docs below
+ Ext.Array.forEach(this.getLayoutItems(), function(item) {
+ Ext.fly(item.el.dom.parentNode).setWidth(item.getWidth());
+ });
+ }
},
- // private overrides
- validateValue : Ext.form.DateField.prototype.validateValue,
+ /**
+ * @private
+ * Determine the row and cell indexes for each component, taking into consideration
+ * the number of columns and each item's configured colspan/rowspan values.
+ * @param {Array} items The layout components
+ * @return {Array} List of row and cell indexes for each of the components
+ */
+ calculateCells: function(items) {
+ var cells = [],
+ rowIdx = 0,
+ colIdx = 0,
+ cellIdx = 0,
+ totalCols = this.columns || Infinity,
+ rowspans = [], //rolling list of active rowspans for each column
+ i = 0, j,
+ len = items.length,
+ item;
- formatDate : Ext.form.DateField.prototype.formatDate,
+ for (; i < len; i++) {
+ item = items[i];
- parseDate: function(value) {
- if (!value || Ext.isDate(value)) {
- return value;
+ // Find the first available row/col slot not taken up by a spanning cell
+ while (colIdx >= totalCols || rowspans[colIdx] > 0) {
+ if (colIdx >= totalCols) {
+ // move down to next row
+ colIdx = 0;
+ cellIdx = 0;
+ rowIdx++;
+
+ // decrement all rowspans
+ for (j = 0; j < totalCols; j++) {
+ if (rowspans[j] > 0) {
+ rowspans[j]--;
+ }
+ }
+ } else {
+ colIdx++;
+ }
+ }
+
+ // Add the cell info to the list
+ cells.push({
+ rowIdx: rowIdx,
+ cellIdx: cellIdx
+ });
+
+ // Increment
+ rowspans[colIdx] = item.rowspan || 1;
+ colIdx += item.colspan || 1;
+ cellIdx++;
}
- var id = this.initDate + ' ',
- idf = this.initDateFormat + ' ',
- v = Date.parseDate(id + value, idf + this.format), // *** handle DST. note: this.format is a TIME-only format
- af = this.altFormats;
+ return cells;
+ },
- if (!v && af) {
- if (!this.altFormatsArray) {
- this.altFormatsArray = af.split("|");
- }
- for (var i = 0, afa = this.altFormatsArray, len = afa.length; i < len && !v; i++) {
- v = Date.parseDate(id + value, idf + afa[i]);
- }
+ /**
+ * @private
+ * Return the layout's table element, creating it if necessary.
+ */
+ getTable: function() {
+ var table = this.table;
+ if (!table) {
+ table = this.table = this.getTarget().createChild(
+ Ext.apply({
+ tag: 'table',
+ role: 'presentation',
+ cls: this.tableCls,
+ cellspacing: 0, //TODO should this be specified or should CSS handle it?
+ cn: {tag: 'tbody'}
+ }, this.tableAttrs),
+ null, true
+ );
}
+ return table;
+ },
- return v;
+ /**
+ * @private
+ * Opera 10.5 has a bug where if a table cell's child has box-sizing:border-box and padding, it
+ * will include that padding in the size of the cell, making it always larger than the
+ * shrink-wrapped size of its contents. To get around this we have to wrap the contents in a div
+ * and then set that div's width to match the item rendered within it afterLayout. This method
+ * determines whether we need the wrapper div; it currently does a straight UA sniff as this bug
+ * seems isolated to just Opera 10.5, but feature detection could be added here if needed.
+ */
+ needsDivWrap: function() {
+ return Ext.isOpera10_5;
}
});
-Ext.reg('timefield', Ext.form.TimeField);/**
- * @class Ext.form.SliderField
- * @extends Ext.form.Field
- * Wraps a {@link Ext.Slider Slider} so it can be used as a form field.
+/**
+ * @class Ext.menu.Item
+ * @extends Ext.Component
+
+ * A base class for all menu items that require menu-related functionality such as click handling,
+ * sub-menus, icons, etc.
+ * {@img Ext.menu.Menu/Ext.menu.Menu.png Ext.menu.Menu component}
+__Example Usage:__
+ Ext.create('Ext.menu.Menu', {
+ width: 100,
+ height: 100,
+ floating: false, // usually you want this set to True (default)
+ renderTo: Ext.getBody(), // usually rendered by it's containing component
+ items: [{
+ text: 'icon item',
+ iconCls: 'add16'
+ },{
+ text: 'text item',
+ },{
+ text: 'plain item',
+ plain: true
+ }]
+ });
+
+ * @xtype menuitem
+ * @markdown
* @constructor
- * Creates a new SliderField
- * @param {Object} config Configuration options. Note that you can pass in any slider configuration options, as well as
- * as any field configuration options.
- * @xtype sliderfield
+ * @param {Object} config The config object
*/
-Ext.form.SliderField = Ext.extend(Ext.form.Field, {
-
- /**
- * @cfg {Boolean} useTips
- * True to use an Ext.slider.Tip to display tips for the value. Defaults to true.
- */
- useTips : true,
+Ext.define('Ext.menu.Item', {
+ extend: 'Ext.Component',
+ alias: 'widget.menuitem',
+ alternateClassName: 'Ext.menu.TextItem',
/**
- * @cfg {Function} tipText
- * A function used to display custom text for the slider tip. Defaults to null, which will
- * use the default on the plugin.
+ * @property {Boolean} activated
+ * Whether or not this item is currently activated
*/
- tipText : null,
-
- // private override
- actionMode: 'wrap',
-
+
/**
- * Initialize the component.
- * @private
+ * @cfg {String} activeCls
+ * The CSS class added to the menu item when the item is activated (focused/mouseover).
+ * Defaults to `Ext.baseCSSPrefix + 'menu-item-active'`.
+ * @markdown
*/
- initComponent : function() {
- var cfg = Ext.copyTo({
- id: this.id + '-slider'
- }, this.initialConfig, ['vertical', 'minValue', 'maxValue', 'decimalPrecision', 'keyIncrement', 'increment', 'clickToChange', 'animate']);
-
- // only can use it if it exists.
- if (this.useTips) {
- var plug = this.tipText ? {getText: this.tipText} : {};
- cfg.plugins = [new Ext.slider.Tip(plug)];
- }
- this.slider = new Ext.Slider(cfg);
- Ext.form.SliderField.superclass.initComponent.call(this);
- },
+ activeCls: Ext.baseCSSPrefix + 'menu-item-active',
/**
- * Set up the hidden field
- * @param {Object} ct The container to render to.
- * @param {Object} position The position in the container to render to.
- * @private
+ * @cfg {String} ariaRole @hide
*/
- onRender : function(ct, position){
- this.autoCreate = {
- id: this.id,
- name: this.name,
- type: 'hidden',
- tag: 'input'
- };
- Ext.form.SliderField.superclass.onRender.call(this, ct, position);
- this.wrap = this.el.wrap({cls: 'x-form-field-wrap'});
- this.resizeEl = this.positionEl = this.wrap;
- this.slider.render(this.wrap);
- },
+ ariaRole: 'menuitem',
/**
- * Ensure that the slider size is set automatically when the field resizes.
- * @param {Object} w The width
- * @param {Object} h The height
- * @param {Object} aw The adjusted width
- * @param {Object} ah The adjusted height
- * @private
+ * @cfg {Boolean} canActivate
+ * Whether or not this menu item can be activated when focused/mouseovered. Defaults to `true`.
+ * @markdown
*/
- onResize : function(w, h, aw, ah){
- Ext.form.SliderField.superclass.onResize.call(this, w, h, aw, ah);
- this.slider.setSize(w, h);
- },
+ canActivate: true,
/**
- * Initialize any events for this class.
- * @private
+ * @cfg {Number} clickHideDelay
+ * The delay in milliseconds to wait before hiding the menu after clicking the menu item.
+ * This only has an effect when `hideOnClick: true`. Defaults to `1`.
+ * @markdown
*/
- initEvents : function(){
- Ext.form.SliderField.superclass.initEvents.call(this);
- this.slider.on('change', this.onChange, this);
- },
+ clickHideDelay: 1,
/**
- * Utility method to set the value of the field when the slider changes.
- * @param {Object} slider The slider object.
- * @param {Object} v The new value.
- * @private
+ * @cfg {Boolean} destroyMenu
+ * Whether or not to destroy any associated sub-menu when this item is destroyed. Defaults to `true`.
*/
- onChange : function(slider, v){
- this.setValue(v, undefined, true);
- },
+ destroyMenu: true,
/**
- * Enable the slider when the field is enabled.
- * @private
+ * @cfg {String} disabledCls
+ * The CSS class added to the menu item when the item is disabled.
+ * Defaults to `Ext.baseCSSPrefix + 'menu-item-disabled'`.
+ * @markdown
*/
- onEnable : function(){
- Ext.form.SliderField.superclass.onEnable.call(this);
- this.slider.enable();
- },
+ disabledCls: Ext.baseCSSPrefix + 'menu-item-disabled',
/**
- * Disable the slider when the field is disabled.
- * @private
+ * @cfg {String} href
+ * The href attribute to use for the underlying anchor link. Defaults to `#`.
+ * @markdown
*/
- onDisable : function(){
- Ext.form.SliderField.superclass.onDisable.call(this);
- this.slider.disable();
- },
+
+ /**
+ * @cfg {String} hrefTarget
+ * The target attribute to use for the underlying anchor link. Defaults to `undefined`.
+ * @markdown
+ */
/**
- * Ensure the slider is destroyed when the field is destroyed.
- * @private
+ * @cfg {Boolean} hideOnClick
+ * Whether to not to hide the owning menu when this item is clicked. Defaults to `true`.
+ * @markdown
*/
- beforeDestroy : function(){
- Ext.destroy(this.slider);
- Ext.form.SliderField.superclass.beforeDestroy.call(this);
- },
+ hideOnClick: true,
/**
- * If a side icon is shown, do alignment to the slider
- * @private
+ * @cfg {String} icon
+ * The path to an icon to display in this item. Defaults to `Ext.BLANK_IMAGE_URL`.
+ * @markdown
*/
- alignErrorIcon : function(){
- this.errorIcon.alignTo(this.slider.el, 'tl-tr', [2, 0]);
- },
-
+
/**
- * Sets the minimum field value.
- * @param {Number} v The new minimum value.
- * @return {Ext.form.SliderField} this
+ * @cfg {String} iconCls
+ * A CSS class that specifies a `background-image` to use as the icon for this item. Defaults to `undefined`.
+ * @markdown
*/
- setMinValue : function(v){
- this.slider.setMinValue(v);
- return this;
- },
+
+ isMenuItem: true,
/**
- * Sets the maximum field value.
- * @param {Number} v The new maximum value.
- * @return {Ext.form.SliderField} this
+ * @cfg {Mixed} menu
+ * Either an instance of {@link Ext.menu.Menu} or a config object for an {@link Ext.menu.Menu}
+ * which will act as a sub-menu to this item.
+ * @markdown
+ * @property {Ext.menu.Menu} menu The sub-menu associated with this item, if one was configured.
*/
- setMaxValue : function(v){
- this.slider.setMaxValue(v);
- return this;
- },
/**
- * Sets the value for this field.
- * @param {Number} v The new value.
- * @param {Boolean} animate (optional) Whether to animate the transition. If not specified, it will default to the animate config.
- * @return {Ext.form.SliderField} this
+ * @cfg {String} menuAlign
+ * The default {@link Ext.core.Element#getAlignToXY Ext.Element.getAlignToXY} anchor position value for this
+ * item's sub-menu relative to this item's position. Defaults to `'tl-tr?'`.
+ * @markdown
*/
- setValue : function(v, animate, /* private */ silent){
- // silent is used if the setValue method is invoked by the slider
- // which means we don't need to set the value on the slider.
- if(!silent){
- this.slider.setValue(v, animate);
- }
- return Ext.form.SliderField.superclass.setValue.call(this, this.slider.getValue());
- },
+ menuAlign: 'tl-tr?',
/**
- * Gets the current value for this field.
- * @return {Number} The current value.
+ * @cfg {Number} menuExpandDelay
+ * The delay in milliseconds before this item's sub-menu expands after this item is moused over. Defaults to `200`.
+ * @markdown
*/
- getValue : function(){
- return this.slider.getValue();
- }
-});
-
-Ext.reg('sliderfield', Ext.form.SliderField);/**
- * @class Ext.form.Label
- * @extends Ext.BoxComponent
- * Basic Label field.
- * @constructor
- * Creates a new Label
- * @param {Ext.Element/String/Object} config The configuration options. If an element is passed, it is set as the internal
- * element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element
- * and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.
- * @xtype label
- */
-Ext.form.Label = Ext.extend(Ext.BoxComponent, {
+ menuExpandDelay: 200,
+
/**
- * @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.
+ * @cfg {Number} menuHideDelay
+ * The delay in milliseconds before this item's sub-menu hides after this item is moused out. Defaults to `200`.
+ * @markdown
*/
+ menuHideDelay: 200,
+
/**
- * @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.
+ * @cfg {Boolean} plain
+ * Whether or not this item is plain text/html with no icon or visual activation. Defaults to `false`.
+ * @markdown
*/
+
+ renderTpl: [
+ '',
+ '{text}',
+ ' ',
+ '',
+ 'target="{hrefTarget}" hidefocus="true" unselectable="on">',
+ '',
+ ' ',
+ '',
+ '',
+ ' ',
+ '',
+ ''
+ ],
+
+ maskOnDisable: false,
+
/**
- * @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.
+ * @cfg {String} text
+ * The text/html to display in this item. Defaults to `undefined`.
+ * @markdown
*/
-
- // private
- onRender : function(ct, position){
- if(!this.el){
- this.el = document.createElement('label');
- this.el.id = this.getId();
- this.el.innerHTML = this.text ? Ext.util.Format.htmlEncode(this.text) : (this.html || '');
- if(this.forId){
- this.el.setAttribute('for', this.forId);
- }
+
+ activate: function() {
+ var me = this;
+
+ if (!me.activated && me.canActivate && me.rendered && !me.isDisabled() && me.isVisible()) {
+ me.el.addCls(me.activeCls);
+ me.focus();
+ me.activated = true;
+ me.fireEvent('activate', me);
}
- Ext.form.Label.superclass.onRender.call(this, ct, position);
},
-
- /**
- * 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
- */
- setText : function(t, encode){
- var e = encode === false;
- this[!e ? 'text' : 'html'] = t;
- delete this[e ? 'text' : 'html'];
- if(this.rendered){
- this.el.dom.innerHTML = encode !== false ? Ext.util.Format.htmlEncode(t) : t;
+
+ blur: function() {
+ this.$focused = false;
+ this.callParent(arguments);
+ },
+
+ deactivate: function() {
+ var me = this;
+
+ if (me.activated) {
+ me.el.removeCls(me.activeCls);
+ me.blur();
+ me.hideMenu();
+ me.activated = false;
+ me.fireEvent('deactivate', me);
}
- return this;
- }
-});
-
-Ext.reg('label', Ext.form.Label);/**
- * @class Ext.form.Action
- * The subclasses of this class provide actions to perform upon {@link Ext.form.BasicForm Form}s.
- * Instances of this class are only created by a {@link Ext.form.BasicForm 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.BasicForm#submit submit},
- * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#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.BasicForm#submit submit},
- * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}),
- * and to the {@link Ext.form.BasicForm#actioncomplete actioncomplete} and
- * {@link Ext.form.BasicForm#actionfailed actionfailed} event handlers.
- */
-Ext.form.Action = function(form, options){
- this.form = form;
- this.options = options || {};
-};
-
-/**
- * Failure type returned when client side validation of the Form fails
- * thus aborting a submit action. Client side validation is performed unless
- * {@link #clientValidation} is explicitly set to false.
- * @type {String}
- * @static
- */
-Ext.form.Action.CLIENT_INVALID = 'client';
-/**
- * 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
- */
-Ext.form.Action.SERVER_INVALID = 'server';
-/**
- * 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
- */
-Ext.form.Action.CONNECT_FAILURE = 'connect';
-/**
- * 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
- */
-Ext.form.Action.LOAD_FAILURE = 'load';
-
-Ext.form.Action.prototype = {
-/**
- * @cfg {String} url The URL that the Action is to invoke.
- */
-/**
- * @cfg {Boolean} reset When set to true, causes the Form to be
- * {@link Ext.form.BasicForm.reset reset} on Action success. If specified, this happens
- * before the {@link #success} callback is called and before the Form's
- * {@link Ext.form.BasicForm.actioncomplete actioncomplete} event fires.
- */
-/**
- * @cfg {String} method The HTTP method to use to access the requested URL. Defaults to the
- * {@link Ext.form.BasicForm}'s method, or if that is not specified, the underlying DOM form's method.
- */
-/**
- * @cfg {Mixed} params Extra parameter values to pass. These are added to the Form's
- * {@link Ext.form.BasicForm#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}.
- */
-/**
- * @cfg {Number} timeout The number of seconds to wait for a server response before
- * failing with the {@link #failureType} as {@link #Action.CONNECT_FAILURE}. If not specified,
- * defaults to the configured {@link Ext.form.BasicForm#timeout timeout} of the
- * {@link Ext.form.BasicForm form}.
- */
-/**
- * @cfg {Function} success The function to call when a valid success return packet is recieved.
- * The function is passed the following parameters:
- * - form : Ext.form.BasicFormThe form that requested the action
- * - action : Ext.form.ActionThe Action class. The {@link #result}
- * property of this object may be examined to perform custom postprocessing.
- *
- */
-/**
- * @cfg {Function} failure The function to call when a failure packet was recieved, or when an
- * error ocurred in the Ajax communication.
- * The function is passed the following parameters:
- * - form : Ext.form.BasicFormThe form that requested the action
- * - action : Ext.form.ActionThe 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.
- *
- */
-/**
- * @cfg {Object} scope The scope in which to call the callback functions (The this reference
- * for the callback functions).
- */
-/**
- * @cfg {String} waitMsg The message to be displayed by a call to {@link Ext.MessageBox#wait}
- * during the time the action is being processed.
- */
-/**
- * @cfg {String} waitTitle The title to be displayed by a call to {@link Ext.MessageBox#wait}
- * during the time the action is being processed.
- */
-
-/**
- * @cfg {Boolean} submitEmptyText If set to true, the emptyText value will be sent with the form
- * when it is submitted. Defaults to true.
- */
-
-/**
- * The type of action this Action instance performs.
- * Currently only "submit" and "load" are supported.
- * @type {String}
- */
- type : 'default',
-/**
- * The type of failure detected will be one of these: {@link #CLIENT_INVALID},
- * {@link #SERVER_INVALID}, {@link #CONNECT_FAILURE}, or {@link #LOAD_FAILURE}. Usage:
- *
-var fp = new Ext.form.FormPanel({
-...
-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} === Ext.form.Action.{@link #CONNECT_FAILURE}) {
- Ext.Msg.alert('Error',
- 'Status:'+action.{@link #response}.status+': '+
- action.{@link #response}.statusText);
- }
- if (action.failureType === Ext.form.Action.{@link #SERVER_INVALID}){
- // server responded with success = false
- Ext.Msg.alert('Invalid', action.{@link #result}.errormsg);
- }
- }
- });
+ },
+
+ deferExpandMenu: function() {
+ var me = this;
+
+ if (!me.menu.rendered || !me.menu.isVisible()) {
+ me.parentMenu.activeChild = me.menu;
+ me.menu.parentItem = me;
+ me.menu.parentMenu = me.menu.ownerCt = me.parentMenu;
+ me.menu.showBy(me, me.menuAlign);
}
- }
-},{
- text: 'Reset',
- handler: function(){
- fp.getForm().reset();
- }
-}]
- *
- * @property failureType
- * @type {String}
- */
- /**
- * The XMLHttpRequest object used to perform the action.
- * @property response
- * @type {Object}
- */
- /**
- * The decoded response object containing a boolean success property and
- * other, action-specific properties.
- * @property result
- * @type {Object}
- */
-
- // interface method
- run : function(options){
-
},
-
- // interface method
- success : function(response){
-
+
+ deferHideMenu: function() {
+ if (this.menu.isVisible()) {
+ this.menu.hide();
+ }
},
-
- // interface method
- handleResponse : function(response){
-
+
+ deferHideParentMenus: function() {
+ Ext.menu.Manager.hideAll();
},
-
- // default connection failure
- failure : function(response){
- this.response = response;
- this.failureType = Ext.form.Action.CONNECT_FAILURE;
- this.form.afterAction(this, false);
+
+ expandMenu: function(delay) {
+ var me = this;
+
+ if (me.menu) {
+ clearTimeout(me.hideMenuTimer);
+ if (delay === 0) {
+ me.deferExpandMenu();
+ } else {
+ me.expandMenuTimer = Ext.defer(me.deferExpandMenu, Ext.isNumber(delay) ? delay : me.menuExpandDelay, me);
+ }
+ }
},
-
- // private
- // shared code among all Actions to validate that there was a response
- // with either responseText or responseXml
- processResponse : function(response){
- this.response = response;
- if(!response.responseText && !response.responseXML){
- return true;
+
+ focus: function() {
+ this.$focused = true;
+ this.callParent(arguments);
+ },
+
+ getRefItems: function(deep){
+ var menu = this.menu,
+ items;
+
+ if (menu) {
+ items = menu.getRefItems(deep);
+ items.unshift(menu);
+ }
+ return items || [];
+ },
+
+ hideMenu: function(delay) {
+ var me = this;
+
+ if (me.menu) {
+ clearTimeout(me.expandMenuTimer);
+ me.hideMenuTimer = Ext.defer(me.deferHideMenu, Ext.isNumber(delay) ? delay : me.menuHideDelay, me);
}
- this.result = this.handleResponse(response);
- return this.result;
},
-
- // utility functions used internally
- getUrl : function(appendParams){
- var url = this.options.url || this.form.url || this.form.el.dom.action;
- if(appendParams){
- var p = this.getParams();
- if(p){
- url = Ext.urlAppend(url, p);
- }
+
+ initComponent: function() {
+ var me = this,
+ prefix = Ext.baseCSSPrefix,
+ cls = [prefix + 'menu-item'];
+
+ me.addEvents(
+ /**
+ * @event activate
+ * Fires when this item is activated
+ * @param {Ext.menu.Item} item The activated item
+ */
+ 'activate',
+
+ /**
+ * @event click
+ * Fires when this item is clicked
+ * @param {Ext.menu.Item} item The item that was clicked
+ * @param {Ext.EventObject} e The underyling {@link Ext.EventObject}.
+ */
+ 'click',
+
+ /**
+ * @event deactivate
+ * Fires when this tiem is deactivated
+ * @param {Ext.menu.Item} item The deactivated item
+ */
+ 'deactivate'
+ );
+
+ if (me.plain) {
+ cls.push(prefix + 'menu-item-plain');
}
- return url;
+
+ if (me.cls) {
+ cls.push(me.cls);
+ }
+
+ me.cls = cls.join(' ');
+
+ if (me.menu) {
+ me.menu = Ext.menu.Manager.get(me.menu);
+ }
+
+ me.callParent(arguments);
},
-
- // private
- getMethod : function(){
- return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase();
+
+ onClick: function(e) {
+ var me = this;
+
+ if (!me.href) {
+ e.stopEvent();
+ }
+
+ if (me.disabled) {
+ return;
+ }
+
+ if (me.hideOnClick) {
+ me.deferHideParentMenusTimer = Ext.defer(me.deferHideParentMenus, me.clickHideDelay, me);
+ }
+
+ Ext.callback(me.handler, me.scope || me, [me, e]);
+ me.fireEvent('click', me, e);
+
+ if (!me.hideOnClick) {
+ me.focus();
+ }
},
-
- // private
- getParams : function(){
- var bp = this.form.baseParams;
- var p = this.options.params;
- if(p){
- if(typeof p == "object"){
- p = Ext.urlEncode(Ext.applyIf(p, bp));
- }else if(typeof p == 'string' && bp){
- p += '&' + Ext.urlEncode(bp);
- }
- }else if(bp){
- p = Ext.urlEncode(bp);
+
+ onDestroy: function() {
+ var me = this;
+
+ clearTimeout(me.expandMenuTimer);
+ clearTimeout(me.hideMenuTimer);
+ clearTimeout(me.deferHideParentMenusTimer);
+
+ if (me.menu) {
+ delete me.menu.parentItem;
+ delete me.menu.parentMenu;
+ delete me.menu.ownerCt;
+ if (me.destroyMenu !== false) {
+ me.menu.destroy();
+ }
}
- return p;
+ me.callParent(arguments);
},
-
- // private
- createCallback : function(opts){
- var opts = opts || {};
- return {
- success: this.success,
- failure: this.failure,
- scope: this,
- timeout: (opts.timeout*1000) || (this.form.timeout*1000),
- upload: this.form.fileUpload ? this.success : undefined
- };
- }
-};
-
-/**
- * @class Ext.form.Action.Submit
- * @extends Ext.form.Action
- * A class which handles submission of data from {@link Ext.form.BasicForm Form}s
- * and processes the returned response.
- * Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
- * {@link Ext.form.BasicForm#submit submit}ting.
- * Response Packet Criteria
- * A response packet may contain:
- *
- * success
property : Boolean
- * The success
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:
-{
- 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.BasicForm}'s callback
- * or event handler methods. The object decoded from this JSON is available in the
- * {@link Ext.form.Action#result result} property.
- * Alternatively, if an {@link #errorReader} is specified as an {@link Ext.data.XmlReader XmlReader}:
- errorReader: new Ext.data.XmlReader({
- record : 'field',
- success: '@success'
- }, [
- 'id', 'msg'
- ]
- )
-
- * 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>
-
- * Other elements may be placed into the response XML for processing by the {@link Ext.form.BasicForm}'s callback
- * or event handler methods. The XML document is available in the {@link #errorReader}'s {@link Ext.data.XmlReader#xmlData xmlData} property.
- */
-Ext.form.Action.Submit = function(form, options){
- Ext.form.Action.Submit.superclass.constructor.call(this, form, options);
-};
-
-Ext.extend(Ext.form.Action.Submit, Ext.form.Action, {
+
+ onRender: function(ct, pos) {
+ var me = this,
+ prefix = '.' + Ext.baseCSSPrefix;
+
+ Ext.applyIf(me.renderData, {
+ href: me.href || '#',
+ hrefTarget: me.hrefTarget,
+ icon: me.icon || Ext.BLANK_IMAGE_URL,
+ iconCls: me.iconCls,
+ menu: Ext.isDefined(me.menu),
+ plain: me.plain,
+ text: me.text
+ });
+
+ Ext.applyIf(me.renderSelectors, {
+ itemEl: prefix + 'menu-item-link',
+ iconEl: prefix + 'menu-item-icon',
+ textEl: prefix + 'menu-item-text',
+ arrowEl: prefix + 'menu-item-arrow'
+ });
+
+ me.callParent(arguments);
+ },
+
/**
- * @cfg {Ext.data.DataReader} errorReader Optional. JSON is interpreted with
- * no need for an errorReader.
- * A Reader which reads a single record from the returned data. The DataReader's
- * success property specifies how submission success is determined. The Record's
- * data provides the error messages to apply to any invalid form Fields.
+ * Sets the {@link #click} handler of this item
+ * @param {Function} fn The handler function
+ * @param {Object} scope (optional) The scope of the handler function
*/
+ setHandler: function(fn, scope) {
+ this.handler = fn || null;
+ this.scope = scope;
+ },
+
/**
- * @cfg {boolean} clientValidation Determines whether a Form's fields are validated
- * in a final call to {@link Ext.form.BasicForm#isValid isValid} prior to submission.
- * Pass false in the Form's submit options to prevent this. If not defined, pre-submission field validation
- * is performed.
+ * Sets the {@link #iconCls} of this item
+ * @param {String} iconCls The CSS class to set to {@link #iconCls}
*/
- type : 'submit',
-
- // private
- run : function(){
- var o = this.options,
- method = this.getMethod(),
- isGet = method == 'GET';
- if(o.clientValidation === false || this.form.isValid()){
- if (o.submitEmptyText === false) {
- var fields = this.form.items,
- emptyFields = [];
- fields.each(function(f) {
- if (f.el.getValue() == f.emptyText) {
- emptyFields.push(f);
- f.el.dom.value = "";
- }
- });
+ setIconCls: function(iconCls) {
+ var me = this;
+
+ if (me.iconEl) {
+ if (me.iconCls) {
+ me.iconEl.removeCls(me.iconCls);
}
- Ext.Ajax.request(Ext.apply(this.createCallback(o), {
- form:this.form.el.dom,
- url:this.getUrl(isGet),
- method: method,
- headers: o.headers,
- params:!isGet ? this.getParams() : null,
- isUpload: this.form.fileUpload
- }));
- if (o.submitEmptyText === false) {
- Ext.each(emptyFields, function(f) {
- if (f.applyEmptyText) {
- f.applyEmptyText();
- }
- });
+
+ if (iconCls) {
+ me.iconEl.addCls(iconCls);
}
- }else if (o.clientValidation !== false){ // client validation failed
- this.failureType = Ext.form.Action.CLIENT_INVALID;
- this.form.afterAction(this, false);
- }
- },
-
- // private
- success : function(response){
- var result = this.processResponse(response);
- if(result === true || result.success){
- this.form.afterAction(this, true);
- return;
}
- if(result.errors){
- this.form.markInvalid(result.errors);
- }
- this.failureType = Ext.form.Action.SERVER_INVALID;
- this.form.afterAction(this, false);
+
+ me.iconCls = iconCls;
},
-
- // private
- handleResponse : function(response){
- if(this.form.errorReader){
- var rs = this.form.errorReader.read(response);
- var errors = [];
- if(rs.records){
- for(var i = 0, len = rs.records.length; i < len; i++) {
- var r = rs.records[i];
- errors[i] = r.data;
+
+ /**
+ * Sets the {@link #text} of this item
+ * @param {String} text The {@link #text}
+ */
+ setText: function(text) {
+ var me = this,
+ el = me.textEl || me.el,
+ newWidth;
+
+ if (text && el) {
+ el.update(text);
+
+ if (me.textEl) {
+ // Resize the menu to fit the text
+ newWidth = me.textEl.getWidth() + me.iconEl.getWidth() + 25 + (me.arrowEl ? me.arrowEl.getWidth() : 0);
+ if (newWidth > me.itemEl.getWidth()) {
+ me.parentMenu.setWidth(newWidth);
}
}
- if(errors.length < 1){
- errors = null;
- }
- return {
- success : rs.success,
- errors : errors
- };
+ } else if (el) {
+ el.update('');
}
- return Ext.decode(response.responseText);
+
+ me.text = text;
}
});
-
/**
- * @class Ext.form.Action.Load
- * @extends Ext.form.Action
- * A class which handles loading of data from a server into the Fields of an {@link Ext.form.BasicForm}.
- * Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
- * {@link Ext.form.BasicForm#load load}ing.
- * Response Packet Criteria
- * A response packet must contain:
- *
- * success
property : Boolean
- * data
property : Object
- * The 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#setValue setValue} method.
- *
- * JSON Packets
- * By default, response packets are assumed to be JSON, so for the following form load call:
-var myFormPanel = new Ext.form.FormPanel({
- 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.FormPanel#getForm getForm}().{@link Ext.form.BasicForm#load load}({
- url: '/getRoutingInfo.php',
- params: {
- consignmentRef: myConsignmentRef
- },
- failure: function(form, action) {
- Ext.Msg.alert("Load failed", action.result.errorMessage);
- }
-});
-
- * a success response packet may look like this:
-{
- success: true,
- data: {
- clientName: "Fred. Olsen Lines",
- portOfLoading: "FXT",
- portOfDischarge: "OSL"
- }
-}
- * while a failure response packet may look like this:
-{
- success: false,
- errorMessage: "Consignment reference not found"
-}
- * Other data may be placed into the response for processing the {@link Ext.form.BasicForm Form}'s
- * callback or event handler methods. The object decoded from this JSON is available in the
- * {@link Ext.form.Action#result result} property.
- */
-Ext.form.Action.Load = function(form, options){
- Ext.form.Action.Load.superclass.constructor.call(this, form, options);
- this.reader = this.form.reader;
-};
+ * @class Ext.menu.CheckItem
+ * @extends Ext.menu.Item
-Ext.extend(Ext.form.Action.Load, Ext.form.Action, {
- // private
- type : 'load',
+A menu item that contains a togglable checkbox by default, but that can also be a part of a radio group.
+{@img Ext.menu.CheckItem/Ext.menu.CheckItem.png Ext.menu.CheckItem component}
+__Example Usage__
+ Ext.create('Ext.menu.Menu', {
+ width: 100,
+ height: 110,
+ floating: false, // usually you want this set to True (default)
+ renderTo: Ext.getBody(), // usually rendered by it's containing component
+ items: [{
+ xtype: 'menucheckitem',
+ text: 'select all'
+ },{
+ xtype: 'menucheckitem',
+ text: 'select specific',
+ },{
+ iconCls: 'add16',
+ text: 'icon item'
+ },{
+ text: 'regular item'
+ }]
+ });
+
+ * @xtype menucheckitem
+ * @markdown
+ * @constructor
+ * @param {Object} config The config object
+ */
- // private
- run : function(){
- Ext.Ajax.request(Ext.apply(
- this.createCallback(this.options), {
- method:this.getMethod(),
- url:this.getUrl(false),
- headers: this.options.headers,
- params:this.getParams()
- }));
- },
+Ext.define('Ext.menu.CheckItem', {
+ extend: 'Ext.menu.Item',
+ alias: 'widget.menucheckitem',
- // private
- success : function(response){
- var result = this.processResponse(response);
- if(result === true || !result.success || !result.data){
- this.failureType = Ext.form.Action.LOAD_FAILURE;
- this.form.afterAction(this, false);
- return;
- }
- this.form.clearInvalid();
- this.form.setValues(result.data);
- this.form.afterAction(this, true);
- },
+ /**
+ * @cfg {String} checkedCls
+ * The CSS class used by {@link #cls} to show the checked state.
+ * Defaults to `Ext.baseCSSPrefix + 'menu-item-checked'`.
+ * @markdown
+ */
+ checkedCls: Ext.baseCSSPrefix + 'menu-item-checked',
+ /**
+ * @cfg {String} uncheckedCls
+ * The CSS class used by {@link #cls} to show the unchecked state.
+ * Defaults to `Ext.baseCSSPrefix + 'menu-item-unchecked'`.
+ * @markdown
+ */
+ uncheckedCls: Ext.baseCSSPrefix + 'menu-item-unchecked',
+ /**
+ * @cfg {String} groupCls
+ * The CSS class applied to this item's icon image to denote being a part of a radio group.
+ * Defaults to `Ext.baseCSSClass + 'menu-group-icon'`.
+ * Any specified {@link #iconCls} overrides this.
+ * @markdown
+ */
+ groupCls: Ext.baseCSSPrefix + 'menu-group-icon',
- // private
- handleResponse : function(response){
- if(this.form.reader){
- var rs = this.form.reader.read(response);
- var data = rs.records && rs.records[0] ? rs.records[0].data : null;
- return {
- success : rs.success,
- data : data
- };
- }
- return Ext.decode(response.responseText);
- }
-});
+ /**
+ * @cfg {Boolean} hideOnClick
+ * Whether to not to hide the owning menu when this item is clicked.
+ * Defaults to `false` for checkbox items, and to `true` for radio group items.
+ * @markdown
+ */
+ hideOnClick: false,
+ afterRender: function() {
+ var me = this;
+ this.callParent();
+ me.checked = !me.checked;
+ me.setChecked(!me.checked, true);
+ },
+ initComponent: function() {
+ var me = this;
+ me.addEvents(
+ /**
+ * @event beforecheckchange
+ * Fires before a change event. Return false to cancel.
+ * @param {Ext.menu.CheckItem} this
+ * @param {Boolean} checked
+ */
+ 'beforecheckchange',
-/**
- * @class Ext.form.Action.DirectLoad
- * @extends Ext.form.Action.Load
- * Provides Ext.direct support for loading form data.
- * This example illustrates usage of Ext.Direct to load a form through Ext.Direct.
- *
-var myFormPanel = new Ext.form.FormPanel({
- // configs for FormPanel
- title: 'Basic Information',
- renderTo: document.body,
- width: 300, height: 160,
- padding: 10,
+ /**
+ * @event checkchange
+ * Fires after a change event.
+ * @param {Ext.menu.CheckItem} this
+ * @param {Boolean} checked
+ */
+ 'checkchange'
+ );
- // configs apply to child items
- defaults: {anchor: '100%'},
- defaultType: 'textfield',
- items: [{
- fieldLabel: 'Name',
- name: 'name'
- },{
- fieldLabel: 'Email',
- name: 'email'
- },{
- fieldLabel: 'Company',
- name: 'company'
- }],
+ me.callParent(arguments);
- // 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']
-});
+ Ext.menu.Manager.registerCheckable(me);
-// load the form
-myFormPanel.getForm().load({
- // pass 2 arguments to server side getBasicInfo method (len=2)
- params: {
- foo: 'bar',
- uid: 34
- }
-});
- *
- * The data packet sent to the server will resemble something like:
- *
-[
- {
- "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
- "data":[34,"bar"] // note the order of the params
- }
-]
- *
- * 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,
- "result":{
- "success":true,
- "data":{
- "name":"Fred Flintstone",
- "company":"Slate Rock and Gravel",
- "email":"fred.flintstone@slaterg.com"
+ if (me.group) {
+ if (!me.iconCls) {
+ me.iconCls = me.groupCls;
+ }
+ if (me.initialConfig.hideOnClick !== false) {
+ me.hideOnClick = true;
}
}
- }
-]
- *
- */
-Ext.form.Action.DirectLoad = Ext.extend(Ext.form.Action.Load, {
- constructor: function(form, opts) {
- Ext.form.Action.DirectLoad.superclass.constructor.call(this, form, opts);
},
- type : 'directload',
- run : function(){
- var args = this.getParams();
- args.push(this.success, this);
- this.form.api.load.apply(window, args);
+ /**
+ * Disables just the checkbox functionality of this menu Item. If this menu item has a submenu, that submenu
+ * will still be accessible
+ */
+ disableCheckChange: function() {
+ var me = this;
+
+ me.iconEl.addCls(me.disabledCls);
+ me.checkChangeDisabled = true;
+ },
+
+ /**
+ * Reenables the checkbox functionality of this menu item after having been disabled by {@link #disableCheckChange}
+ */
+ enableCheckChange: function() {
+ var me = this;
+
+ me.iconEl.removeCls(me.disabledCls);
+ me.checkChangeDisabled = false;
},
- getParams : function() {
- var buf = [], o = {};
- var bp = this.form.baseParams;
- var p = this.options.params;
- Ext.apply(o, p, bp);
- var paramOrder = this.form.paramOrder;
- if(paramOrder){
- for(var i = 0, len = paramOrder.length; i < len; i++){
- buf.push(o[paramOrder[i]]);
- }
- }else if(this.form.paramsAsHash){
- buf.push(o);
+ onClick: function(e) {
+ var me = this;
+ if(!me.disabled && !me.checkChangeDisabled && !(me.checked && me.group)) {
+ me.setChecked(!me.checked);
}
- return buf;
+ this.callParent([e]);
},
- // 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) {
- this.result = result;
- return result;
+
+ onDestroy: function() {
+ Ext.menu.Manager.unregisterCheckable(this);
+ this.callParent(arguments);
},
- success : function(response, trans){
- if(trans.type == Ext.Direct.exceptions.SERVER){
- response = {};
+ /**
+ * Sets the checked state of the item
+ * @param {Boolean} checked True to check, false to uncheck
+ * @param {Boolean} suppressEvents (optional) True to prevent firing the checkchange events. Defaults to `false`.
+ * @markdown
+ */
+ setChecked: function(checked, suppressEvents) {
+ var me = this;
+ if (me.checked !== checked && (suppressEvents || me.fireEvent('beforecheckchange', me, checked) !== false)) {
+ if (me.el) {
+ me.el[checked ? 'addCls' : 'removeCls'](me.checkedCls)[!checked ? 'addCls' : 'removeCls'](me.uncheckedCls);
+ }
+ me.checked = checked;
+ Ext.menu.Manager.onCheckChange(me, checked);
+ if (!suppressEvents) {
+ Ext.callback(me.checkHandler, me.scope, [me, checked]);
+ me.fireEvent('checkchange', me, checked);
+ }
}
- Ext.form.Action.DirectLoad.superclass.success.call(this, response);
}
});
/**
- * @class Ext.form.Action.DirectSubmit
- * @extends Ext.form.Action.Submit
- * Provides Ext.direct support for submitting form data.
- * This example illustrates usage of Ext.Direct to submit a form through Ext.Direct.
- *
-var myFormPanel = new Ext.form.FormPanel({
- // 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
- }
- });
- }
- }],
+ * @class Ext.menu.KeyNav
+ * @private
+ */
+Ext.define('Ext.menu.KeyNav', {
+ extend: 'Ext.util.KeyNav',
- // configs apply to child items
- defaults: {anchor: '100%'},
- defaultType: 'textfield',
- items: [{
- fieldLabel: 'Name',
- name: 'name'
- },{
- fieldLabel: 'Email',
- name: 'email'
- },{
- fieldLabel: 'Company',
- name: 'company'
- }],
+ requires: ['Ext.FocusManager'],
+
+ constructor: function(menu) {
+ var me = this;
- // 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
+ me.menu = menu;
+ me.callParent([menu.el, {
+ down: me.down,
+ enter: me.enter,
+ esc: me.escape,
+ left: me.left,
+ right: me.right,
+ space: me.enter,
+ tab: me.tab,
+ up: me.up
+ }]);
},
- // specify the order for the passed params
- paramOrder: ['uid', 'foo']
-});
- *
- * The data packet sent to the server will resemble something like:
- *
-{
- "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@extjs.com","company":"Ext JS, LLC"
- }
- }
-}
- *
- * The form will process a data packet returned by the server that is similar
- * to the following:
- *
-// sample success packet (batched requests)
-[
- {
- "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":3,
- "result":{
- "success":true
- }
- }
-]
-// sample failure packet (one request)
-{
- "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6",
- "result":{
- "errors":{
- "email":"already taken"
- },
- "success":false,
- "foo":"bar"
+ down: function(e) {
+ var me = this,
+ fi = me.menu.focusedItem;
+
+ if (fi && e.getKey() == Ext.EventObject.DOWN && me.isWhitelisted(fi)) {
+ return true;
}
-}
- *
- * Also see the discussion in {@link Ext.form.Action.DirectLoad}.
- */
-Ext.form.Action.DirectSubmit = Ext.extend(Ext.form.Action.Submit, {
- constructor : function(form, opts) {
- Ext.form.Action.DirectSubmit.superclass.constructor.call(this, form, opts);
+ me.focusNextItem(1);
},
- type : 'directsubmit',
- // override of Submit
- run : function(){
- var o = this.options;
- if(o.clientValidation === false || this.form.isValid()){
- // tag on any additional params to be posted in the
- // form scope
- this.success.params = this.getParams();
- this.form.api.submit(this.form.el.dom, this.success, this);
- }else if (o.clientValidation !== false){ // client validation failed
- this.failureType = Ext.form.Action.CLIENT_INVALID;
- this.form.afterAction(this, false);
- }
- },
-
- getParams : function() {
- var o = {};
- var bp = this.form.baseParams;
- var p = this.options.params;
- Ext.apply(o, p, bp);
- return o;
+
+ enter: function(e) {
+ var menu = this.menu;
+
+ if (menu.activeItem) {
+ menu.onClick(e);
+ }
},
- // 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) {
- this.result = result;
- return result;
+
+ escape: function(e) {
+ Ext.menu.Manager.hideAll();
},
- success : function(response, trans){
- if(trans.type == Ext.Direct.exceptions.SERVER){
- response = {};
- }
- Ext.form.Action.DirectSubmit.superclass.success.call(this, response);
- }
-});
+ focusNextItem: function(step) {
+ var menu = this.menu,
+ items = menu.items,
+ focusedItem = menu.focusedItem,
+ startIdx = focusedItem ? items.indexOf(focusedItem) : -1,
+ idx = startIdx + step;
-Ext.form.Action.ACTION_TYPES = {
- 'load' : Ext.form.Action.Load,
- 'submit' : Ext.form.Action.Submit,
- 'directload' : Ext.form.Action.DirectLoad,
- 'directsubmit' : Ext.form.Action.DirectSubmit
-};
-/**
- * @class Ext.form.VTypes
- * 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.TextField#vtype vtype}
validation
- * test function, and optionally specify any corresponding error text to display and any keystroke
- * filtering mask to apply. For 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.VTypes, {
- // vtype validation function
- time: function(val, field) {
- return timeTest.test(val);
+ while (idx != startIdx) {
+ if (idx < 0) {
+ idx = items.length - 1;
+ } else if (idx >= items.length) {
+ idx = 0;
+ }
+
+ var item = items.getAt(idx);
+ if (menu.canActivateItem(item)) {
+ menu.setActiveItem(item);
+ break;
+ }
+ idx += step;
+ }
},
- // 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
-});
- *
- * Another example:
- *
-// custom Vtype for vtype:'IPAddress'
-Ext.apply(Ext.form.VTypes, {
- IPAddress: function(v) {
- return /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(v);
+
+ isWhitelisted: function(item) {
+ return Ext.FocusManager.isWhitelisted(item);
},
- IPAddressText: 'Must be a numeric IP address',
- IPAddressMask: /[\d\.]/i
-});
- *
- * @singleton
- */
-Ext.form.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 {
- /**
- * 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,
+ left: function(e) {
+ var menu = this.menu,
+ fi = menu.focusedItem,
+ ai = menu.activeItem;
- /**
- * 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"',
+ if (fi && this.isWhitelisted(fi)) {
+ return true;
+ }
- /**
- * 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,
+ menu.hide();
+ if (menu.parentMenu) {
+ menu.parentMenu.focus();
+ }
+ },
- /**
- * 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
- };
-}();
-/**
- * @class Ext.grid.GridPanel
- * @extends Ext.Panel
- * This class represents the primary interface of a component based grid control to represent data
- * in a tabular format of rows and columns. The GridPanel is composed of the following:
- *
- * - {@link Ext.data.Store Store} : The Model holding the data records (rows)
- *
- * - {@link Ext.grid.ColumnModel Column model} : Column makeup
- *
- * - {@link Ext.grid.GridView View} : Encapsulates the user interface
- *
- * - {@link Ext.grid.AbstractSelectionModel selection model} : Selection behavior
- *
- *
- * Example usage:
- *
-var grid = new Ext.grid.GridPanel({
- {@link #store}: new {@link Ext.data.Store}({
- {@link Ext.data.Store#autoDestroy autoDestroy}: true,
- {@link Ext.data.Store#reader reader}: reader,
- {@link Ext.data.Store#data data}: xg.dummyData
- }),
- {@link #colModel}: new {@link Ext.grid.ColumnModel}({
- {@link Ext.grid.ColumnModel#defaults defaults}: {
- width: 120,
- sortable: true
- },
- {@link Ext.grid.ColumnModel#columns columns}: [
- {id: 'company', header: 'Company', width: 200, sortable: true, dataIndex: 'company'},
- {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price'},
- {header: 'Change', dataIndex: 'change'},
- {header: '% Change', dataIndex: 'pctChange'},
- // instead of specifying renderer: Ext.util.Format.dateRenderer('m/d/Y') use xtype
- {
- header: 'Last Updated', width: 135, dataIndex: 'lastChange',
- xtype: 'datecolumn', format: 'M d, Y'
- }
- ],
- }),
- {@link #viewConfig}: {
- {@link Ext.grid.GridView#forceFit forceFit}: true,
+ right: function(e) {
+ var menu = this.menu,
+ fi = menu.focusedItem,
+ ai = menu.activeItem,
+ am;
+
+ if (fi && this.isWhitelisted(fi)) {
+ return true;
+ }
-// Return CSS class to apply to rows depending upon data values
- {@link Ext.grid.GridView#getRowClass getRowClass}: function(record, index) {
- var c = record.{@link Ext.data.Record#get get}('change');
- if (c < 0) {
- return 'price-fall';
- } else if (c > 0) {
- return 'price-rise';
+ if (ai) {
+ am = menu.activeItem.menu;
+ if (am) {
+ ai.expandMenu(0);
+ Ext.defer(function() {
+ am.setActiveItem(am.items.getAt(0));
+ }, 25);
}
}
},
- {@link #sm}: new Ext.grid.RowSelectionModel({singleSelect:true}),
- width: 600,
- height: 300,
- frame: true,
- title: 'Framed with Row Selection and Horizontal Scrolling',
- iconCls: 'icon-grid'
+
+ tab: function(e) {
+ var me = this;
+
+ if (e.shiftKey) {
+ me.up(e);
+ } else {
+ me.down(e);
+ }
+ },
+
+ up: function(e) {
+ var me = this,
+ fi = me.menu.focusedItem;
+
+ if (fi && e.getKey() == Ext.EventObject.UP && me.isWhitelisted(fi)) {
+ return true;
+ }
+ me.focusNextItem(-1);
+ }
});
- *
- * Notes:
- *
- * - Although this class inherits many configuration options from base classes, some of them
- * (such as autoScroll, autoWidth, layout, items, etc) are not used by this class, and will
- * have no effect.
- * - A grid requires a width in which to scroll its columns, and a height in which to
- * scroll its rows. These dimensions can either be set explicitly through the
- * {@link Ext.BoxComponent#height height} and {@link Ext.BoxComponent#width width}
- * configuration options or implicitly set by using the grid as a child item of a
- * {@link Ext.Container Container} which will have a {@link Ext.Container#layout layout manager}
- * provide the sizing of its child items (for example the Container of the Grid may specify
- * {@link Ext.Container#layout layout}:'fit').
- * - To access the data in a Grid, it is necessary to use the data model encapsulated
- * by the {@link #store Store}. See the {@link #cellclick} event for more details.
- *
+/**
+ * @class Ext.menu.Separator
+ * @extends Ext.menu.Item
+ *
+ * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
+ * add one of these by using "-" in your call to add() or in your items config rather than creating one directly.
+ *
+ * {@img Ext.menu.Separator/Ext.menu.Separator.png Ext.menu.Separator component}
+ *
+ * ## Code
+ *
+ * Ext.create('Ext.menu.Menu', {
+ * width: 100,
+ * height: 100,
+ * floating: false, // usually you want this set to True (default)
+ * renderTo: Ext.getBody(), // usually rendered by it's containing component
+ * items: [{
+ * text: 'icon item',
+ * iconCls: 'add16'
+ * },{
+ * xtype: 'menuseparator'
+ * },{
+ * text: 'seperator above',
+ * },{
+ * text: 'regular item',
+ * }]
+ * });
+ *
+ * @xtype menuseparator
+ * @markdown
* @constructor
* @param {Object} config The config object
- * @xtype grid
*/
-Ext.grid.GridPanel = Ext.extend(Ext.Panel, {
- /**
- * @cfg {String} autoExpandColumn
- * The {@link Ext.grid.Column#id id} of a {@link Ext.grid.Column column} in
- * this grid that should expand to fill unused space. This value specified here can not
- * be 0.
- *
Note: If the Grid's {@link Ext.grid.GridView view} is configured with
- * {@link Ext.grid.GridView#forceFit forceFit}=true the autoExpandColumn
- * is ignored. See {@link Ext.grid.Column}.{@link Ext.grid.Column#width width}
- * for additional details.
- * See {@link #autoExpandMax} and {@link #autoExpandMin} also.
- */
- autoExpandColumn : false,
- /**
- * @cfg {Number} autoExpandMax The maximum width the {@link #autoExpandColumn}
- * can have (if enabled). Defaults to 1000.
- */
- autoExpandMax : 1000,
+Ext.define('Ext.menu.Separator', {
+ extend: 'Ext.menu.Item',
+ alias: 'widget.menuseparator',
+
/**
- * @cfg {Number} autoExpandMin The minimum width the {@link #autoExpandColumn}
- * can have (if enabled). Defaults to 50.
+ * @cfg {String} activeCls @hide
*/
- autoExpandMin : 50,
+
/**
- * @cfg {Boolean} columnLines true to add css for column separation lines.
- * Default is false.
+ * @cfg {Boolean} canActivate @hide
*/
- columnLines : false,
+ canActivate: false,
+
/**
- * @cfg {Object} cm Shorthand for {@link #colModel}.
+ * @cfg {Boolean} clickHideDelay @hide
*/
+
/**
- * @cfg {Object} colModel The {@link Ext.grid.ColumnModel} to use when rendering the grid (required).
+ * @cfg {Boolean} destroyMenu @hide
*/
+
/**
- * @cfg {Array} columns An array of {@link Ext.grid.Column columns} to auto create a
- * {@link Ext.grid.ColumnModel}. The ColumnModel may be explicitly created via the
- * {@link #colModel} configuration property.
+ * @cfg {Boolean} disabledCls @hide
*/
+
+ focusable: false,
+
/**
- * @cfg {String} ddGroup The DD group this GridPanel belongs to. Defaults to 'GridDD' if not specified.
+ * @cfg {String} href @hide
*/
+
/**
- * @cfg {String} ddText
- * Configures the text in the drag proxy. Defaults to:
- *
- * ddText : '{0} selected row{1}'
- *
- * {0} is replaced with the number of selected rows.
+ * @cfg {String} hrefTarget @hide
*/
- ddText : '{0} selected row{1}',
+
/**
- * @cfg {Boolean} deferRowRender Defaults to true to enable deferred row rendering.
- * This allows the GridPanel to be initially rendered empty, with the expensive update of the row
- * structure deferred so that layouts with GridPanels appear more quickly.
+ * @cfg {Boolean} hideOnClick @hide
*/
- deferRowRender : true,
+ hideOnClick: false,
+
/**
- * @cfg {Boolean} disableSelection true to disable selections in the grid. Defaults to false.
- * Ignored if a {@link #selModel SelectionModel} is specified.
+ * @cfg {String} icon @hide
*/
+
/**
- * @cfg {Boolean} enableColumnResize false to turn off column resizing for the whole grid. Defaults to true.
+ * @cfg {String} iconCls @hide
*/
+
/**
- * @cfg {Boolean} enableColumnHide
- * Defaults to true to enable {@link Ext.grid.Column#hidden hiding of columns}
- * with the {@link #enableHdMenu header menu}.
+ * @cfg {Mixed} menu @hide
*/
- enableColumnHide : true,
+
/**
- * @cfg {Boolean} enableColumnMove Defaults to true to enable drag and drop reorder of columns. false
- * to turn off column reordering via drag drop.
+ * @cfg {String} menuAlign @hide
*/
- enableColumnMove : true,
+
/**
- * @cfg {Boolean} enableDragDrop Enables dragging of the selected rows of the GridPanel. Defaults to false.
- * Setting this to true causes this GridPanel's {@link #getView GridView} to
- * create an instance of {@link Ext.grid.GridDragZone}. Note: this is available only after
- * the Grid has been rendered as the GridView's {@link Ext.grid.GridView#dragZone dragZone}
- * property.
- * A cooperating {@link Ext.dd.DropZone DropZone} must be created who's implementations of
- * {@link Ext.dd.DropZone#onNodeEnter onNodeEnter}, {@link Ext.dd.DropZone#onNodeOver onNodeOver},
- * {@link Ext.dd.DropZone#onNodeOut onNodeOut} and {@link Ext.dd.DropZone#onNodeDrop onNodeDrop} are able
- * to process the {@link Ext.grid.GridDragZone#getDragData data} which is provided.
+ * @cfg {Number} menuExpandDelay @hide
*/
- enableDragDrop : false,
+
/**
- * @cfg {Boolean} enableHdMenu Defaults to true to enable the drop down button for menu in the headers.
+ * @cfg {Number} menuHideDelay @hide
*/
- enableHdMenu : true,
+
/**
- * @cfg {Boolean} hideHeaders True to hide the grid's header. Defaults to false
.
+ * @cfg {Boolean} plain @hide
*/
+ plain: true,
+
/**
- * @cfg {Object} loadMask An {@link Ext.LoadMask} config or true to mask the grid while
- * loading. Defaults to false
.
+ * @cfg {String} separatorCls
+ * The CSS class used by the separator item to show the incised line.
+ * Defaults to `Ext.baseCSSPrefix + 'menu-item-separator'`.
+ * @markdown
*/
- loadMask : false,
+ separatorCls: Ext.baseCSSPrefix + 'menu-item-separator',
+
/**
- * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if autoHeight is not on.
+ * @cfg {String} text @hide
*/
+ text: ' ',
+
+ onRender: function(ct, pos) {
+ var me = this,
+ sepCls = me.separatorCls;
+
+ me.cls += ' ' + sepCls;
+
+ Ext.applyIf(me.renderSelectors, {
+ itemSepEl: '.' + sepCls
+ });
+
+ me.callParent(arguments);
+ }
+});
+/**
+ * @class Ext.menu.Menu
+ * @extends Ext.panel.Panel
+ *
+ * A menu object. This is the container to which you may add {@link Ext.menu.Item menu items}.
+ *
+ * Menus may contain either {@link Ext.menu.Item menu items}, or general {@link Ext.Component Components}.
+ * Menus may also contain {@link Ext.panel.AbstractPanel#dockedItems docked items} because it extends {@link Ext.panel.Panel}.
+ *
+ * To make a contained general {@link Ext.Component Component} line up with other {@link Ext.menu.Item menu items},
+ * specify `{@link Ext.menu.Item#iconCls iconCls}: 'no-icon'` _or_ `{@link Ext.menu.Item#indent indent}: true`.
+ * This reserves a space for an icon, and indents the Component in line with the other menu items.
+ * See {@link Ext.form.field.ComboBox}.{@link Ext.form.field.ComboBox#getListParent getListParent} for an example.
+
+ * By default, Menus are absolutely positioned, floating Components. By configuring a Menu with `{@link #floating}:false`,
+ * a Menu may be used as a child of a {@link Ext.container.Container Container}.
+ * {@img Ext.menu.Item/Ext.menu.Item.png Ext.menu.Item component}
+__Example Usage__
+ Ext.create('Ext.menu.Menu', {
+ width: 100,
+ height: 100,
+ margin: '0 0 10 0',
+ floating: false, // usually you want this set to True (default)
+ renderTo: Ext.getBody(), // usually rendered by it's containing component
+ items: [{
+ text: 'regular item 1'
+ },{
+ text: 'regular item 2'
+ },{
+ text: 'regular item 3'
+ }]
+ });
+
+ Ext.create('Ext.menu.Menu', {
+ width: 100,
+ height: 100,
+ plain: true,
+ floating: false, // usually you want this set to True (default)
+ renderTo: Ext.getBody(), // usually rendered by it's containing component
+ items: [{
+ text: 'plain item 1'
+ },{
+ text: 'plain item 2'
+ },{
+ text: 'plain item 3'
+ }]
+ });
+ * @xtype menu
+ * @markdown
+ * @constructor
+ * @param {Object} config The config object
+ */
+Ext.define('Ext.menu.Menu', {
+ extend: 'Ext.panel.Panel',
+ alias: 'widget.menu',
+ requires: [
+ 'Ext.layout.container.Fit',
+ 'Ext.layout.container.VBox',
+ 'Ext.menu.CheckItem',
+ 'Ext.menu.Item',
+ 'Ext.menu.KeyNav',
+ 'Ext.menu.Manager',
+ 'Ext.menu.Separator'
+ ],
+
/**
- * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Defaults to 25.
+ * @cfg {Boolean} allowOtherMenus
+ * True to allow multiple menus to be displayed at the same time. Defaults to `false`.
+ * @markdown
*/
- minColumnWidth : 25,
+ allowOtherMenus: false,
+
/**
- * @cfg {Object} sm Shorthand for {@link #selModel}.
+ * @cfg {String} ariaRole @hide
*/
+ ariaRole: 'menu',
+
/**
- * @cfg {Object} selModel Any subclass of {@link Ext.grid.AbstractSelectionModel} that will provide
- * the selection model for the grid (defaults to {@link Ext.grid.RowSelectionModel} if not specified).
+ * @cfg {Boolean} autoRender @hide
+ * floating is true, so autoRender always happens
*/
+
/**
- * @cfg {Ext.data.Store} store The {@link Ext.data.Store} the grid should use as its data source (required).
+ * @cfg {String} defaultAlign
+ * The default {@link Ext.core.Element#getAlignToXY Ext.core.Element#getAlignToXY} anchor position value for this menu
+ * relative to its element of origin. Defaults to `'tl-bl?'`.
+ * @markdown
*/
+ defaultAlign: 'tl-bl?',
+
/**
- * @cfg {Boolean} stripeRows true to stripe the rows. Default is false.
- * This causes the CSS class x-grid3-row-alt to be added to alternate rows of
- * the grid. A default CSS rule is provided which sets a background colour, but you can override this
- * with a rule which either overrides the background-color style using the '!important'
- * modifier, or which uses a CSS selector of higher specificity.
+ * @cfg {Boolean} floating
+ * A Menu configured as `floating: true` (the default) will be rendered as an absolutely positioned,
+ * {@link Ext.Component#floating floating} {@link Ext.Component Component}. If configured as `floating: false`, the Menu may be
+ * used as a child item of another {@link Ext.container.Container Container}.
+ * @markdown
*/
- stripeRows : false,
+ floating: true,
+
/**
- * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is true
- * for GridPanel, but false for EditorGridPanel.
+ * @cfg {Boolean} @hide
+ * Menu performs its own size changing constraining, so ensure Component's constraining is not applied
*/
- trackMouseOver : true,
+ constrain: false,
+
/**
- * @cfg {Array} stateEvents
- * An array of events that, when fired, should trigger this component to save its state.
- * Defaults to:
- * stateEvents: ['columnmove', 'columnresize', 'sortchange', 'groupchange']
- *
- * These can be any types of events supported by this component, including browser or
- * custom events (e.g., ['click', 'customerchange']).
- * See {@link Ext.Component#stateful} for an explanation of saving and restoring
- * Component state.
+ * @cfg {Boolean} hidden
+ * True to initially render the Menu as hidden, requiring to be shown manually.
+ * Defaults to `true` when `floating: true`, and defaults to `false` when `floating: false`.
+ * @markdown
*/
- stateEvents : ['columnmove', 'columnresize', 'sortchange', 'groupchange'],
+ hidden: true,
+
/**
- * @cfg {Object} view The {@link Ext.grid.GridView} used by the grid. This can be set
- * before a call to {@link Ext.Component#render render()}.
+ * @cfg {Boolean} ignoreParentClicks
+ * True to ignore clicks on any item in this menu that is a parent item (displays a submenu)
+ * so that the submenu is not dismissed when clicking the parent item. Defaults to `false`.
+ * @markdown
*/
- view : null,
+ ignoreParentClicks: false,
+
+ isMenu: true,
/**
- * @cfg {Array} bubbleEvents
- * An array of events that, when fired, should be bubbled to any parent container.
- * See {@link Ext.util.Observable#enableBubble}.
- * Defaults to [].
+ * @cfg {String/Object} layout @hide
*/
- bubbleEvents: [],
/**
- * @cfg {Object} viewConfig A config object that will be applied to the grid's UI view. Any of
- * the config options available for {@link Ext.grid.GridView} can be specified here. This option
- * is ignored if {@link #view} is specified.
+ * @cfg {Boolean} showSeparator True to show the icon separator. (defaults to true).
*/
-
- // private
- rendered : false,
- // private
- viewReady : false,
-
- // private
- initComponent : function(){
- Ext.grid.GridPanel.superclass.initComponent.call(this);
-
- if(this.columnLines){
- this.cls = (this.cls || '') + ' x-grid-with-col-lines';
- }
- // override any provided value since it isn't valid
- // and is causing too many bug reports ;)
- this.autoScroll = false;
- this.autoWidth = false;
-
- if(Ext.isArray(this.columns)){
- this.colModel = new Ext.grid.ColumnModel(this.columns);
- delete this.columns;
- }
-
- // check and correct shorthanded configs
- if(this.ds){
- this.store = this.ds;
- delete this.ds;
- }
- if(this.cm){
- this.colModel = this.cm;
- delete this.cm;
- }
- if(this.sm){
- this.selModel = this.sm;
- delete this.sm;
- }
- this.store = Ext.StoreMgr.lookup(this.store);
-
- this.addEvents(
- // raw events
- /**
- * @event click
- * The raw click event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'click',
- /**
- * @event dblclick
- * The raw dblclick event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'dblclick',
- /**
- * @event contextmenu
- * The raw contextmenu event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'contextmenu',
- /**
- * @event mousedown
- * The raw mousedown event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'mousedown',
- /**
- * @event mouseup
- * The raw mouseup event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'mouseup',
- /**
- * @event mouseover
- * The raw mouseover event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'mouseover',
- /**
- * @event mouseout
- * The raw mouseout event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'mouseout',
- /**
- * @event keypress
- * The raw keypress event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'keypress',
- /**
- * @event keydown
- * The raw keydown event for the entire grid.
- * @param {Ext.EventObject} e
- */
- 'keydown',
-
- // custom events
- /**
- * @event cellmousedown
- * Fires before a cell is clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'cellmousedown',
- /**
- * @event rowmousedown
- * Fires before a row is clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowmousedown',
- /**
- * @event headermousedown
- * Fires before a header is clicked
- * @param {Grid} this
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'headermousedown',
-
- /**
- * @event groupmousedown
- * Fires before a group header is clicked. Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}.
- * @param {Grid} this
- * @param {String} groupField
- * @param {String} groupValue
- * @param {Ext.EventObject} e
- */
- 'groupmousedown',
-
- /**
- * @event rowbodymousedown
- * Fires before the row body is clicked. Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowbodymousedown',
-
- /**
- * @event containermousedown
- * Fires before the container is clicked. The container consists of any part of the grid body that is not covered by a row.
- * @param {Grid} this
- * @param {Ext.EventObject} e
- */
- 'containermousedown',
-
- /**
- * @event cellclick
- * Fires when a cell is clicked.
- * The data for the cell is drawn from the {@link Ext.data.Record Record}
- * for this row. To access the data in the listener function use the
- * following technique:
- *
-function(grid, rowIndex, columnIndex, e) {
- var record = grid.getStore().getAt(rowIndex); // Get the Record
- var fieldName = grid.getColumnModel().getDataIndex(columnIndex); // Get field name
- var data = record.get(fieldName);
-}
-
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'cellclick',
- /**
- * @event celldblclick
- * Fires when a cell is double clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'celldblclick',
- /**
- * @event rowclick
- * Fires when a row is clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowclick',
- /**
- * @event rowdblclick
- * Fires when a row is double clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowdblclick',
- /**
- * @event headerclick
- * Fires when a header is clicked
- * @param {Grid} this
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'headerclick',
- /**
- * @event headerdblclick
- * Fires when a header cell is double clicked
- * @param {Grid} this
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'headerdblclick',
- /**
- * @event groupclick
- * Fires when group header is clicked. Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}.
- * @param {Grid} this
- * @param {String} groupField
- * @param {String} groupValue
- * @param {Ext.EventObject} e
- */
- 'groupclick',
- /**
- * @event groupdblclick
- * Fires when group header is double clicked. Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}.
- * @param {Grid} this
- * @param {String} groupField
- * @param {String} groupValue
- * @param {Ext.EventObject} e
- */
- 'groupdblclick',
- /**
- * @event containerclick
- * Fires when the container is clicked. The container consists of any part of the grid body that is not covered by a row.
- * @param {Grid} this
- * @param {Ext.EventObject} e
- */
- 'containerclick',
- /**
- * @event containerdblclick
- * Fires when the container is double clicked. The container consists of any part of the grid body that is not covered by a row.
- * @param {Grid} this
- * @param {Ext.EventObject} e
- */
- 'containerdblclick',
-
- /**
- * @event rowbodyclick
- * Fires when the row body is clicked. Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowbodyclick',
- /**
- * @event rowbodydblclick
- * Fires when the row body is double clicked. Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowbodydblclick',
-
- /**
- * @event rowcontextmenu
- * Fires when a row is right clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowcontextmenu',
- /**
- * @event cellcontextmenu
- * Fires when a cell is right clicked
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Number} cellIndex
- * @param {Ext.EventObject} e
- */
- 'cellcontextmenu',
- /**
- * @event headercontextmenu
- * Fires when a header is right clicked
- * @param {Grid} this
- * @param {Number} columnIndex
- * @param {Ext.EventObject} e
- */
- 'headercontextmenu',
- /**
- * @event groupcontextmenu
- * Fires when group header is right clicked. Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}.
- * @param {Grid} this
- * @param {String} groupField
- * @param {String} groupValue
- * @param {Ext.EventObject} e
- */
- 'groupcontextmenu',
- /**
- * @event containercontextmenu
- * Fires when the container is right clicked. The container consists of any part of the grid body that is not covered by a row.
- * @param {Grid} this
- * @param {Ext.EventObject} e
- */
- 'containercontextmenu',
- /**
- * @event rowbodycontextmenu
- * Fires when the row body is right clicked. Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.
- * @param {Grid} this
- * @param {Number} rowIndex
- * @param {Ext.EventObject} e
- */
- 'rowbodycontextmenu',
- /**
- * @event bodyscroll
- * Fires when the body element is scrolled
- * @param {Number} scrollLeft
- * @param {Number} scrollTop
- */
- 'bodyscroll',
- /**
- * @event columnresize
- * Fires when the user resizes a column
- * @param {Number} columnIndex
- * @param {Number} newSize
- */
- 'columnresize',
- /**
- * @event columnmove
- * Fires when the user moves a column
- * @param {Number} oldIndex
- * @param {Number} newIndex
- */
- 'columnmove',
+ showSeparator : true,
+
+ /**
+ * @cfg {Number} minWidth
+ * The minimum width of the Menu. Defaults to `120`.
+ * @markdown
+ */
+ minWidth: 120,
+
+ /**
+ * @cfg {Boolean} plain
+ * True to remove the incised line down the left side of the menu and to not
+ * indent general Component items. Defaults to `false`.
+ * @markdown
+ */
+
+ initComponent: function() {
+ var me = this,
+ prefix = Ext.baseCSSPrefix;
+
+ me.addEvents(
/**
- * @event sortchange
- * Fires when the grid's store sort changes
- * @param {Grid} this
- * @param {Object} sortInfo An object with the keys field and direction
+ * @event click
+ * Fires when this menu is clicked
+ * @param {Ext.menu.Menu} menu The menu which has been clicked
+ * @param {Ext.Component} item The menu item that was clicked. `undefined` if not applicable.
+ * @param {Ext.EventObject} e The underlying {@link Ext.EventObject}.
+ * @markdown
*/
- 'sortchange',
+ 'click',
+
/**
- * @event groupchange
- * Fires when the grid's grouping changes (only applies for grids with a {@link Ext.grid.GroupingView GroupingView})
- * @param {Grid} this
- * @param {String} groupField A string with the grouping field, null if the store is not grouped.
+ * @event mouseenter
+ * Fires when the mouse enters this menu
+ * @param {Ext.menu.Menu} menu The menu
+ * @param {Ext.EventObject} e The underlying {@link Ext.EventObject}
+ * @markdown
*/
- 'groupchange',
+ 'mouseenter',
+
/**
- * @event reconfigure
- * Fires when the grid is reconfigured with a new store and/or column model.
- * @param {Grid} this
- * @param {Ext.data.Store} store The new store
- * @param {Ext.grid.ColumnModel} colModel The new column model
+ * @event mouseleave
+ * Fires when the mouse leaves this menu
+ * @param {Ext.menu.Menu} menu The menu
+ * @param {Ext.EventObject} e The underlying {@link Ext.EventObject}
+ * @markdown
*/
- 'reconfigure',
+ 'mouseleave',
+
/**
- * @event viewready
- * Fires when the grid view is available (use this for selecting a default row).
- * @param {Grid} this
+ * @event mouseover
+ * Fires when the mouse is hovering over this menu
+ * @param {Ext.menu.Menu} menu The menu
+ * @param {Ext.Component} item The menu item that the mouse is over. `undefined` if not applicable.
+ * @param {Ext.EventObject} e The underlying {@link Ext.EventObject}
*/
- 'viewready'
+ 'mouseover'
);
- },
- // private
- onRender : function(ct, position){
- Ext.grid.GridPanel.superclass.onRender.apply(this, arguments);
+ Ext.menu.Manager.register(me);
+
+ // Menu classes
+ var cls = [prefix + 'menu'];
+ if (me.plain) {
+ cls.push(prefix + 'menu-plain');
+ }
+ me.cls = cls.join(' ');
+
+ // Menu body classes
+ var bodyCls = me.bodyCls ? [me.bodyCls] : [];
+ bodyCls.unshift(prefix + 'menu-body');
+ me.bodyCls = bodyCls.join(' ');
+
+ // Internal vbox layout, with scrolling overflow
+ // Placed in initComponent (rather than prototype) in order to support dynamic layout/scroller
+ // options if we wish to allow for such configurations on the Menu.
+ // e.g., scrolling speed, vbox align stretch, etc.
+ me.layout = {
+ type: 'vbox',
+ align: 'stretchmax',
+ autoSize: true,
+ clearInnerCtOnLayout: true,
+ overflowHandler: 'Scroller'
+ };
- var c = this.getGridEl();
+ // hidden defaults to false if floating is configured as false
+ if (me.floating === false && me.initialConfig.hidden !== true) {
+ me.hidden = false;
+ }
- this.el.addClass('x-grid-panel');
+ me.callParent(arguments);
- this.mon(c, {
- scope: this,
- mousedown: this.onMouseDown,
- click: this.onClick,
- dblclick: this.onDblClick,
- contextmenu: this.onContextMenu
+ me.on('beforeshow', function() {
+ var hasItems = !!me.items.length;
+ // FIXME: When a menu has its show cancelled because of no items, it
+ // gets a visibility: hidden applied to it (instead of the default display: none)
+ // Not sure why, but we remove this style when we want to show again.
+ if (hasItems && me.rendered) {
+ me.el.setStyle('visibility', null);
+ }
+ return hasItems;
});
-
- this.relayEvents(c, ['mousedown','mouseup','mouseover','mouseout','keypress', 'keydown']);
-
- var view = this.getView();
- view.init(this);
- view.render();
- this.getSelectionModel().init(this);
},
- // private
- initEvents : function(){
- Ext.grid.GridPanel.superclass.initEvents.call(this);
+ afterRender: function(ct) {
+ var me = this,
+ prefix = Ext.baseCSSPrefix,
+ space = ' ';
- if(this.loadMask){
- this.loadMask = new Ext.LoadMask(this.bwrap,
- Ext.apply({store:this.store}, this.loadMask));
+ me.callParent(arguments);
+
+ // TODO: Move this to a subTemplate When we support them in the future
+ if (me.showSeparator) {
+ me.iconSepEl = me.layout.getRenderTarget().insertFirst({
+ cls: prefix + 'menu-icon-separator',
+ html: space
+ });
}
- },
- initStateEvents : function(){
- Ext.grid.GridPanel.superclass.initStateEvents.call(this);
- this.mon(this.colModel, 'hiddenchange', this.saveState, this, {delay: 100});
- },
+ me.focusEl = me.el.createChild({
+ cls: prefix + 'menu-focus',
+ tabIndex: '-1',
+ html: space
+ });
- applyState : function(state){
- var cm = this.colModel,
- cs = state.columns,
- store = this.store,
- s,
- c,
- oldIndex;
+ me.mon(me.el, {
+ click: me.onClick,
+ mouseover: me.onMouseOver,
+ scope: me
+ });
+ me.mouseMonitor = me.el.monitorMouseLeave(100, me.onMouseLeave, me);
- if(cs){
- for(var i = 0, len = cs.length; i < len; i++){
- s = cs[i];
- c = cm.getColumnById(s.id);
- if(c){
- cm.setState(i, {
- hidden: s.hidden,
- width: s.width
- });
- oldIndex = cm.getIndexById(s.id);
- if(oldIndex != i){
- cm.moveColumn(oldIndex, i);
- }
- }
- }
+ if (me.showSeparator && ((!Ext.isStrict && Ext.isIE) || Ext.isIE6)) {
+ me.iconSepEl.setHeight(me.el.getHeight());
}
- if(store){
- s = state.sort;
- if(s){
- store[store.remoteSort ? 'setDefaultSort' : 'sort'](s.field, s.direction);
- }
- s = state.group;
- if(store.groupBy){
- if(s){
- store.groupBy(s);
- }else{
- store.clearGrouping();
- }
- }
- }
- var o = Ext.apply({}, state);
- delete o.columns;
- delete o.sort;
- Ext.grid.GridPanel.superclass.applyState.call(this, o);
+ me.keyNav = Ext.create('Ext.menu.KeyNav', me);
},
- getState : function(){
- var o = {columns: []},
- store = this.store,
- ss,
- gs;
+ afterLayout: function() {
+ var me = this;
+ me.callParent(arguments);
+
+ // For IE6 & IE quirks, we have to resize the el and body since position: absolute
+ // floating elements inherit their parent's width, making them the width of
+ // document.body instead of the width of their contents.
+ // This includes left/right dock items.
+ if ((!Ext.iStrict && Ext.isIE) || Ext.isIE6) {
+ var innerCt = me.layout.getRenderTarget(),
+ innerCtWidth = 0,
+ dis = me.dockedItems,
+ l = dis.length,
+ i = 0,
+ di, clone, newWidth;
- for(var i = 0, c; (c = this.colModel.config[i]); i++){
- o.columns[i] = {
- id: c.id,
- width: c.width
- };
- if(c.hidden){
- o.columns[i].hidden = true;
- }
- }
- if(store){
- ss = store.getSortState();
- if(ss){
- o.sort = ss;
- }
- if(store.getGroupState){
- gs = store.getGroupState();
- if(gs){
- o.group = gs;
+ innerCtWidth = innerCt.getWidth();
+
+ newWidth = innerCtWidth + me.body.getBorderWidth('lr') + me.body.getPadding('lr');
+
+ // First set the body to the new width
+ me.body.setWidth(newWidth);
+
+ // Now we calculate additional width (docked items) and set the el's width
+ for (; i < l, di = dis.getAt(i); i++) {
+ if (di.dock == 'left' || di.dock == 'right') {
+ newWidth += di.getWidth();
}
}
+ me.el.setWidth(newWidth);
}
- return o;
},
- // private
- afterRender : function(){
- Ext.grid.GridPanel.superclass.afterRender.call(this);
- var v = this.view;
- this.on('bodyresize', v.layout, v);
- v.layout();
- if(this.deferRowRender){
- if (!this.deferRowRenderTask){
- this.deferRowRenderTask = new Ext.util.DelayedTask(v.afterRender, this.view);
- }
- this.deferRowRenderTask.delay(10);
- }else{
- v.afterRender();
- }
- this.viewReady = true;
+ /**
+ * Returns whether a menu item can be activated or not.
+ * @return {Boolean}
+ */
+ canActivateItem: function(item) {
+ return item && !item.isDisabled() && item.isVisible() && (item.canActivate || item.getXTypes().indexOf('menuitem') < 0);
},
/**
- * Reconfigures the grid to use a different Store and Column Model
- * and fires the 'reconfigure' event. The View will be bound to the new
- * objects and refreshed.
- * Be aware that upon reconfiguring a GridPanel, certain existing settings may become
- * invalidated. For example the configured {@link #autoExpandColumn} may no longer exist in the
- * new ColumnModel. Also, an existing {@link Ext.PagingToolbar PagingToolbar} will still be bound
- * to the old Store, and will need rebinding. Any {@link #plugins} might also need reconfiguring
- * with the new data.
- * @param {Ext.data.Store} store The new {@link Ext.data.Store} object
- * @param {Ext.grid.ColumnModel} colModel The new {@link Ext.grid.ColumnModel} object
+ * Deactivates the current active item on the menu, if one exists.
*/
- reconfigure : function(store, colModel){
- var rendered = this.rendered;
- if(rendered){
- if(this.loadMask){
- this.loadMask.destroy();
- this.loadMask = new Ext.LoadMask(this.bwrap,
- Ext.apply({}, {store:store}, this.initialConfig.loadMask));
+ deactivateActiveItem: function() {
+ var me = this;
+
+ if (me.activeItem) {
+ me.activeItem.deactivate();
+ if (!me.activeItem.activated) {
+ delete me.activeItem;
}
}
- if(this.view){
- this.view.initData(store, colModel);
- }
- this.store = store;
- this.colModel = colModel;
- if(rendered){
- this.view.refresh(true);
+ if (me.focusedItem) {
+ me.focusedItem.blur();
+ if (!me.focusedItem.$focused) {
+ delete me.focusedItem;
+ }
}
- this.fireEvent('reconfigure', this, store, colModel);
},
- // private
- onDestroy : function(){
- if (this.deferRowRenderTask && this.deferRowRenderTask.cancel){
- this.deferRowRenderTask.cancel();
- }
- if(this.rendered){
- Ext.destroy(this.view, this.loadMask);
- }else if(this.store && this.store.autoDestroy){
- this.store.destroy();
- }
- Ext.destroy(this.colModel, this.selModel);
- this.store = this.selModel = this.colModel = this.view = this.loadMask = null;
- Ext.grid.GridPanel.superclass.onDestroy.call(this);
+ // inherit docs
+ getFocusEl: function() {
+ return this.focusEl;
},
- // private
- processEvent : function(name, e){
- this.view.processEvent(name, e);
+ // inherit docs
+ hide: function() {
+ this.deactivateActiveItem();
+ this.callParent(arguments);
},
// private
- onClick : function(e){
- this.processEvent('click', e);
+ getItemFromEvent: function(e) {
+ return this.getChildByElement(e.getTarget());
},
- // private
- onMouseDown : function(e){
- this.processEvent('mousedown', e);
- },
+ lookupComponent: function(cmp) {
+ var me = this;
- // private
- onContextMenu : function(e, t){
- this.processEvent('contextmenu', e);
- },
+ if (Ext.isString(cmp)) {
+ cmp = me.lookupItemFromString(cmp);
+ } else if (Ext.isObject(cmp)) {
+ cmp = me.lookupItemFromObject(cmp);
+ }
- // private
- onDblClick : function(e){
- this.processEvent('dblclick', e);
+ // Apply our minWidth to all of our child components so it's accounted
+ // for in our VBox layout
+ cmp.minWidth = cmp.minWidth || me.minWidth;
+
+ return cmp;
},
// private
- walkCells : function(row, col, step, fn, scope){
- var cm = this.colModel,
- clen = cm.getColumnCount(),
- ds = this.store,
- rlen = ds.getCount(),
- first = true;
-
- if(step < 0){
- if(col < 0){
- row--;
- first = false;
+ lookupItemFromObject: function(cmp) {
+ var me = this,
+ prefix = Ext.baseCSSPrefix;
+
+ if (!cmp.isComponent) {
+ if (!cmp.xtype) {
+ cmp = Ext.create('Ext.menu.' + (Ext.isBoolean(cmp.checked) ? 'Check': '') + 'Item', cmp);
+ } else {
+ cmp = Ext.ComponentManager.create(cmp, cmp.xtype);
}
- while(row >= 0){
- if(!first){
- col = clen-1;
- }
- first = false;
- while(col >= 0){
- if(fn.call(scope || this, row, col, cm) === true){
- return [row, col];
- }
- col--;
- }
- row--;
+ }
+
+ if (cmp.isMenuItem) {
+ cmp.parentMenu = me;
+ }
+
+ if (!cmp.isMenuItem && !cmp.dock) {
+ var cls = [
+ prefix + 'menu-item',
+ prefix + 'menu-item-cmp'
+ ],
+ intercept = Ext.Function.createInterceptor;
+
+ // Wrap focus/blur to control component focus
+ cmp.focus = intercept(cmp.focus, function() {
+ this.$focused = true;
+ }, cmp);
+ cmp.blur = intercept(cmp.blur, function() {
+ this.$focused = false;
+ }, cmp);
+
+ if (!me.plain && (cmp.indent === true || cmp.iconCls === 'no-icon')) {
+ cls.push(prefix + 'menu-item-indent');
}
- } else {
- if(col >= clen){
- row++;
- first = false;
+
+ if (cmp.rendered) {
+ cmp.el.addCls(cls);
+ } else {
+ cmp.cls = (cmp.cls ? cmp.cls : '') + ' ' + cls.join(' ');
}
- while(row < rlen){
- if(!first){
- col = 0;
- }
- first = false;
- while(col < clen){
- if(fn.call(scope || this, row, col, cm) === true){
- return [row, col];
+ cmp.isMenuItem = true;
+ }
+ return cmp;
+ },
+
+ // private
+ lookupItemFromString: function(cmp) {
+ return (cmp == 'separator' || cmp == '-') ?
+ Ext.createWidget('menuseparator')
+ : Ext.createWidget('menuitem', {
+ canActivate: false,
+ hideOnClick: false,
+ plain: true,
+ text: cmp
+ });
+ },
+
+ onClick: function(e) {
+ var me = this,
+ item;
+
+ if (me.disabled) {
+ e.stopEvent();
+ return;
+ }
+
+ if ((e.getTarget() == me.focusEl.dom) || e.within(me.layout.getRenderTarget())) {
+ item = me.getItemFromEvent(e) || me.activeItem;
+
+ if (item) {
+ if (item.getXTypes().indexOf('menuitem') >= 0) {
+ if (!item.menu || !me.ignoreParentClicks) {
+ item.onClick(e);
+ } else {
+ e.stopEvent();
}
- col++;
}
- row++;
}
+ me.fireEvent('click', me, item, e);
}
- return null;
},
- /**
- * Returns the grid's underlying element.
- * @return {Element} The element
- */
- getGridEl : function(){
- return this.body;
+ onDestroy: function() {
+ var me = this;
+
+ Ext.menu.Manager.unregister(me);
+ if (me.rendered) {
+ me.el.un(me.mouseMonitor);
+ me.keyNav.destroy();
+ delete me.keyNav;
+ }
+ me.callParent(arguments);
},
- // private for compatibility, overridden by editor grid
- stopEditing : Ext.emptyFn,
+ onMouseLeave: function(e) {
+ var me = this;
- /**
- * Returns the grid's selection model configured by the {@link #selModel}
- * configuration option. If no selection model was configured, this will create
- * and return a {@link Ext.grid.RowSelectionModel RowSelectionModel}.
- * @return {SelectionModel}
- */
- getSelectionModel : function(){
- if(!this.selModel){
- this.selModel = new Ext.grid.RowSelectionModel(
- this.disableSelection ? {selectRow: Ext.emptyFn} : null);
+ me.deactivateActiveItem();
+
+ if (me.disabled) {
+ return;
}
- return this.selModel;
+
+ me.fireEvent('mouseleave', me, e);
},
- /**
- * Returns the grid's data store.
- * @return {Ext.data.Store} The store
- */
- getStore : function(){
- return this.store;
+ onMouseOver: function(e) {
+ var me = this,
+ fromEl = e.getRelatedTarget(),
+ mouseEnter = !me.el.contains(fromEl),
+ item = me.getItemFromEvent(e);
+
+ if (mouseEnter && me.parentMenu) {
+ me.parentMenu.setActiveItem(me.parentItem);
+ me.parentMenu.mouseMonitor.mouseenter();
+ }
+
+ if (me.disabled) {
+ return;
+ }
+
+ if (item) {
+ me.setActiveItem(item);
+ if (item.activated && item.expandMenu) {
+ item.expandMenu();
+ }
+ }
+ if (mouseEnter) {
+ me.fireEvent('mouseenter', me, e);
+ }
+ me.fireEvent('mouseover', me, item, e);
},
- /**
- * Returns the grid's ColumnModel.
- * @return {Ext.grid.ColumnModel} The column model
- */
- getColumnModel : function(){
- return this.colModel;
+ setActiveItem: function(item) {
+ var me = this;
+
+ if (item && (item != me.activeItem && item != me.focusedItem)) {
+ me.deactivateActiveItem();
+ if (me.canActivateItem(item)) {
+ if (item.activate) {
+ item.activate();
+ if (item.activated) {
+ me.activeItem = item;
+ me.focusedItem = item;
+ me.focus();
+ }
+ } else {
+ item.focus();
+ me.focusedItem = item;
+ }
+ }
+ item.el.scrollIntoView(me.layout.getRenderTarget());
+ }
},
/**
- * Returns the grid's GridView object.
- * @return {Ext.grid.GridView} The grid view
+ * Shows the floating menu by the specified {@link Ext.Component Component} or {@link Ext.core.Element Element}.
+ * @param {Mixed component} The {@link Ext.Component} or {@link Ext.core.Element} to show the menu by.
+ * @param {String} position (optional) Alignment position as used by {@link Ext.core.Element#getAlignToXY Ext.core.Element.getAlignToXY}. Defaults to `{@link #defaultAlign}`.
+ * @param {Array} offsets (optional) Alignment offsets as used by {@link Ext.core.Element#getAlignToXY Ext.core.Element.getAlignToXY}. Defaults to `undefined`.
+ * @return {Menu} This Menu.
+ * @markdown
*/
- getView : function(){
- if(!this.view){
- this.view = new Ext.grid.GridView(this.viewConfig);
+ showBy: function(cmp, pos, off) {
+ var me = this;
+
+ if (me.floating && cmp) {
+ me.layout.autoSize = true;
+ me.show();
+
+ // Component or Element
+ cmp = cmp.el || cmp;
+
+ // Convert absolute to floatParent-relative coordinates if necessary.
+ var xy = me.el.getAlignToXY(cmp, pos || me.defaultAlign, off);
+ if (me.floatParent) {
+ var r = me.floatParent.getTargetEl().getViewRegion();
+ xy[0] -= r.x;
+ xy[1] -= r.y;
+ }
+ me.showAt(xy);
+ me.doConstrain();
}
- return this.view;
+ return me;
},
- /**
- * Called to get grid's drag proxy text, by default returns this.ddText.
- * @return {String} The text
- */
- getDragDropText : function(){
- var count = this.selModel.getCount();
- return String.format(this.ddText, count, count == 1 ? '' : 's');
+
+ doConstrain : function() {
+ var me = this,
+ y = this.el.getY(),
+ max, full,
+ returnY = y, normalY, parentEl, scrollTop, viewHeight;
+
+ delete me.height;
+ me.setSize();
+ full = me.getHeight();
+ if (me.floating) {
+ parentEl = Ext.fly(me.el.dom.parentNode);
+ scrollTop = parentEl.getScroll().top;
+ viewHeight = parentEl.getViewSize().height;
+ //Normalize y by the scroll position for the parent element. Need to move it into the coordinate space
+ //of the view.
+ normalY = y - scrollTop;
+ max = me.maxHeight ? me.maxHeight : viewHeight - normalY;
+ if (full > viewHeight) {
+ max = viewHeight;
+ //Set returnY equal to (0,0) in view space by reducing y by the value of normalY
+ returnY = y - normalY;
+ } else if (max < full) {
+ returnY = y - (full - max);
+ max = full;
+ }
+ }else{
+ max = me.getHeight();
+ }
+ // Always respect maxHeight
+ if (me.maxHeight){
+ max = Math.min(me.maxHeight, max);
+ }
+ if (full > max && max > 0){
+ me.layout.autoSize = false;
+ me.setHeight(max);
+ if (me.showSeparator){
+ me.iconSepEl.setHeight(me.layout.getRenderTarget().dom.scrollHeight);
+ }
+ }
+ me.el.setY(returnY);
}
+});
+/**
+ * @class Ext.menu.ColorPicker
+ * @extends Ext.menu.Menu
+ * A menu containing a {@link Ext.picker.Color} Component.
+ * Notes:
+ * - Although not listed here, the constructor for this class
+ * accepts all of the configuration options of {@link Ext.picker.Color}.
+ * - If subclassing ColorMenu, any configuration options for the ColorPicker must be
+ * applied to the initialConfig property of the ColorMenu.
+ * Applying {@link Ext.picker.Color ColorPicker} configuration settings to
+ * this will not affect the ColorPicker's configuration.
+ *
+ * {@img Ext.menu.ColorPicker/Ext.menu.ColorPicker.png Ext.menu.ColorPicker component}
+ * __Example Usage__
+ var colorPicker = Ext.create('Ext.menu.ColorPicker', {
+ value: '000000'
+ });
+
+ Ext.create('Ext.menu.Menu', {
+ width: 100,
+ height: 90,
+ floating: false, // usually you want this set to True (default)
+ renderTo: Ext.getBody(), // usually rendered by it's containing component
+ items: [{
+ text: 'choose a color',
+ menu: colorPicker
+ },{
+ iconCls: 'add16',
+ text: 'icon item'
+ },{
+ text: 'regular item'
+ }]
+ });
+
+ * @xtype colormenu
+ * @author Nicolas Ferrero
+ */
+ Ext.define('Ext.menu.ColorPicker', {
+ extend: 'Ext.menu.Menu',
+
+ alias: 'widget.colormenu',
+
+ requires: [
+ 'Ext.picker.Color'
+ ],
/**
- * @cfg {String/Number} activeItem
- * @hide
- */
- /**
- * @cfg {Boolean} autoDestroy
- * @hide
- */
- /**
- * @cfg {Object/String/Function} autoLoad
- * @hide
- */
- /**
- * @cfg {Boolean} autoWidth
- * @hide
- */
- /**
- * @cfg {Boolean/Number} bufferResize
- * @hide
- */
- /**
- * @cfg {String} defaultType
- * @hide
- */
- /**
- * @cfg {Object} defaults
- * @hide
- */
- /**
- * @cfg {Boolean} hideBorders
- * @hide
- */
- /**
- * @cfg {Mixed} items
- * @hide
- */
- /**
- * @cfg {String} layout
- * @hide
- */
- /**
- * @cfg {Object} layoutConfig
- * @hide
- */
- /**
- * @cfg {Boolean} monitorResize
- * @hide
- */
- /**
- * @property items
- * @hide
- */
- /**
- * @method add
- * @hide
- */
- /**
- * @method cascade
- * @hide
- */
- /**
- * @method doLayout
- * @hide
- */
- /**
- * @method find
- * @hide
- */
- /**
- * @method findBy
- * @hide
- */
- /**
- * @method findById
- * @hide
+ * @cfg {Boolean} hideOnClick
+ * False to continue showing the menu after a date is selected, defaults to true.
*/
+ hideOnClick : true,
+
/**
- * @method findByType
- * @hide
+ * @cfg {String} pickerId
+ * An id to assign to the underlying color picker. Defaults to null.
*/
+ pickerId : null,
+
/**
- * @method getComponent
+ * @cfg {Number} maxHeight
* @hide
*/
+
/**
- * @method getLayout
- * @hide
+ * The {@link Ext.picker.Color} instance for this ColorMenu
+ * @property picker
+ * @type ColorPicker
*/
+
/**
- * @method getUpdater
+ * @event click
* @hide
*/
+
/**
- * @method insert
+ * @event itemclick
* @hide
*/
+
+ initComponent : function(){
+ var me = this;
+
+ Ext.apply(me, {
+ plain: true,
+ showSeparator: false,
+ items: Ext.applyIf({
+ cls: Ext.baseCSSPrefix + 'menu-color-item',
+ id: me.pickerId,
+ xtype: 'colorpicker'
+ }, me.initialConfig)
+ });
+
+ me.callParent(arguments);
+
+ me.picker = me.down('colorpicker');
+
+ /**
+ * @event select
+ * Fires when a date is selected from the {@link #picker Ext.picker.Color}
+ * @param {Ext.picker.Color} picker The {@link #picker Ext.picker.Color}
+ * @param {String} color The 6-digit color hex code (without the # symbol)
+ */
+ me.relayEvents(me.picker, ['select']);
+
+ if (me.hideOnClick) {
+ me.on('select', me.hidePickerOnSelect, me);
+ }
+ },
+
/**
- * @method load
- * @hide
+ * Hides picker on select if hideOnClick is true
+ * @private
*/
+ hidePickerOnSelect: function() {
+ Ext.menu.Manager.hideAll();
+ }
+ });
+/**
+ * @class Ext.menu.DatePicker
+ * @extends Ext.menu.Menu
+ * A menu containing an {@link Ext.picker.Date} Component.
+ * Notes:
+ * - Although not listed here, the constructor for this class
+ * accepts all of the configuration options of {@link Ext.picker.Date}.
+ * - If subclassing DateMenu, any configuration options for the DatePicker must be
+ * applied to the initialConfig property of the DateMenu.
+ * Applying {@link Ext.picker.Date DatePicker} configuration settings to
+ * this will not affect the DatePicker's configuration.
+ *
+ * {@img Ext.menu.DatePicker/Ext.menu.DatePicker.png Ext.menu.DatePicker component}
+ * __Example Usage__
+ var dateMenu = Ext.create('Ext.menu.DatePicker', {
+ handler: function(dp, date){
+ Ext.Msg.alert('Date Selected', 'You choose {0}.', Ext.Date.format(date, 'M j, Y'));
+
+ }
+ });
+
+ Ext.create('Ext.menu.Menu', {
+ width: 100,
+ height: 90,
+ floating: false, // usually you want this set to True (default)
+ renderTo: Ext.getBody(), // usually rendered by it's containing component
+ items: [{
+ text: 'choose a date',
+ menu: dateMenu
+ },{
+ iconCls: 'add16',
+ text: 'icon item'
+ },{
+ text: 'regular item'
+ }]
+ });
+
+ * @xtype datemenu
+ * @author Nicolas Ferrero
+ */
+ Ext.define('Ext.menu.DatePicker', {
+ extend: 'Ext.menu.Menu',
+
+ alias: 'widget.datemenu',
+
+ requires: [
+ 'Ext.picker.Date'
+ ],
+
/**
- * @method remove
- * @hide
+ * @cfg {Boolean} hideOnClick
+ * False to continue showing the menu after a date is selected, defaults to true.
*/
+ hideOnClick : true,
+
/**
- * @event add
- * @hide
+ * @cfg {String} pickerId
+ * An id to assign to the underlying date picker. Defaults to null.
*/
+ pickerId : null,
+
/**
- * @event afterlayout
+ * @cfg {Number} maxHeight
* @hide
*/
+
/**
- * @event beforeadd
- * @hide
+ * The {@link Ext.picker.Date} instance for this DateMenu
+ * @property picker
+ * @type Ext.picker.Date
*/
+
/**
- * @event beforeremove
+ * @event click
* @hide
*/
+
/**
- * @event remove
+ * @event itemclick
* @hide
*/
+ initComponent : function(){
+ var me = this;
+ Ext.apply(me, {
+ showSeparator: false,
+ plain: true,
+ items: Ext.applyIf({
+ cls: Ext.baseCSSPrefix + 'menu-date-item',
+ id: me.pickerId,
+ xtype: 'datepicker'
+ }, me.initialConfig)
+ });
+ me.callParent(arguments);
+
+ me.picker = me.down('datepicker');
+ /**
+ * @event select
+ * Fires when a date is selected from the {@link #picker Ext.picker.Date}
+ * @param {Ext.picker.Date} picker The {@link #picker Ext.picker.Date}
+ * @param {Date} date The selected date
+ */
+ me.relayEvents(me.picker, ['select']);
+
+ if (me.hideOnClick) {
+ me.on('select', me.hidePickerOnSelect, me);
+ }
+ },
+
+ hidePickerOnSelect: function() {
+ Ext.menu.Manager.hideAll();
+ }
+ });
+/**
+ * @class Ext.panel.Tool
+ * @extends Ext.Component
+
+This class is used to display small visual icons in the header of a panel. There are a set of
+25 icons that can be specified by using the {@link #type} config. The {@link #handler} config
+can be used to provide a function that will respond to any click events. In general, this class
+will not be instantiated directly, rather it will be created by specifying the {@link Ext.panel.Panel#tools}
+configuration on the Panel itself.
+
+__Example Usage__
+
+ Ext.create('Ext.panel.Panel', {
+ width: 200,
+ height: 200,
+ renderTo: document.body,
+ title: 'A Panel',
+ tools: [{
+ type: 'help',
+ handler: function(){
+ // show help here
+ }
+ }, {
+ itemId: 'refresh',
+ type: 'refresh',
+ hidden: true,
+ handler: function(){
+ // do refresh
+ }
+ }, {
+ type: 'search',
+ handler: function(event, target, owner, tool){
+ // do search
+ owner.child('#refresh').show();
+ }
+ }]
+ });
+
+ * @markdown
+ * @xtype tool
+ */
+Ext.define('Ext.panel.Tool', {
+ extend: 'Ext.Component',
+ requires: ['Ext.tip.QuickTipManager'],
+ alias: 'widget.tool',
+
+ baseCls: Ext.baseCSSPrefix + 'tool',
+ disabledCls: Ext.baseCSSPrefix + 'tool-disabled',
+ toolPressedCls: Ext.baseCSSPrefix + 'tool-pressed',
+ toolOverCls: Ext.baseCSSPrefix + 'tool-over',
+ ariaRole: 'button',
+ renderTpl: [''],
+
/**
- * @cfg {String} allowDomMove @hide
- */
- /**
- * @cfg {String} autoEl @hide
- */
- /**
- * @cfg {String} applyTo @hide
- */
- /**
- * @cfg {String} autoScroll @hide
- */
- /**
- * @cfg {String} bodyBorder @hide
- */
- /**
- * @cfg {String} bodyStyle @hide
+ * @cfg {Function} handler
+ * A function to execute when the tool is clicked.
+ * Arguments passed are:
+ *
+ * - event : Ext.EventObjectThe click event.
+ * - toolEl : Ext.core.ElementThe tool Element.
+ * - panel : Ext.panel.PanelThe host Panel
+ * - tool : Ext.panel.ToolThe tool object
+ *
*/
+
/**
- * @cfg {String} contentEl @hide
+ * @cfg {Object} scope
+ * The scope to execute the {@link #handler} function. Defaults to the tool.
*/
+
/**
- * @cfg {String} disabledClass @hide
+ * @cfg {String} type
+ * The type of tool to render. The following types are available:
+ *
+ * - close
+ * - collapse
+ * - down
+ * - expand
+ * - gear
+ * - help
+ * - left
+ * - maximize
+ * - minimize
+ * - minus
+ * - move
+ * - next
+ * - pin
+ * - plus
+ * - prev
+ * - print
+ * - refresh
+ * - resize
+ * - restore
+ * - right
+ * - save
+ * - search
+ * - toggle
+ * - unpin
+ * - up
+ *
*/
+
/**
- * @cfg {String} elements @hide
+ * @cfg {String/Object} tooltip
+ * The tooltip for the tool - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object
*/
+
/**
- * @cfg {String} html @hide
+ * @cfg {Boolean} stopEvent
+ * Defaults to true. Specify as false to allow click event to propagate.
*/
+ stopEvent: true,
+
+ initComponent: function() {
+ var me = this;
+ me.addEvents(
+ /**
+ * @event click
+ * Fires when the tool is clicked
+ * @param {Ext.panel.Tool} this
+ * @param {Ext.EventObject} e The event object
+ */
+ 'click'
+ );
+
+ var types = [
+ 'close',
+ 'collapse',
+ 'down',
+ 'expand',
+ 'gear',
+ 'help',
+ 'left',
+ 'maximize',
+ 'minimize',
+ 'minus',
+ 'move',
+ 'next',
+ 'pin',
+ 'plus',
+ 'prev',
+ 'print',
+ 'refresh',
+ 'resize',
+ 'restore',
+ 'right',
+ 'save',
+ 'search',
+ 'toggle',
+ 'unpin',
+ 'up'
+ ];
+
+ if (me.id && Ext.Array.indexOf(types, me.id) > -1) {
+ Ext.global.console.warn('When specifying a tool you should use the type option, the id can conflict now that tool is a Component');
+ }
+
+ me.type = me.type || me.id;
+
+ Ext.applyIf(me.renderData, {
+ baseCls: me.baseCls,
+ blank: Ext.BLANK_IMAGE_URL,
+ type: me.type
+ });
+ me.renderSelectors.toolEl = '.' + me.baseCls + '-' + me.type;
+ me.callParent();
+ },
+
+ // inherit docs
+ afterRender: function() {
+ var me = this;
+ me.callParent(arguments);
+ if (me.qtip) {
+ if (Ext.isObject(me.qtip)) {
+ Ext.tip.QuickTipManager.register(Ext.apply({
+ target: me.id
+ }, me.qtip));
+ }
+ else {
+ me.toolEl.dom.qtip = me.qtip;
+ }
+ }
+
+ me.mon(me.toolEl, {
+ click: me.onClick,
+ mousedown: me.onMouseDown,
+ mouseover: me.onMouseOver,
+ mouseout: me.onMouseOut,
+ scope: me
+ });
+ },
+
/**
- * @cfg {Boolean} preventBodyReset
- * @hide
+ * Set the type of the tool. Allows the icon to be changed.
+ * @param {String} type The new type. See the {@link #type} config.
+ * @return {Ext.panel.Tool} this
*/
+ setType: function(type) {
+ var me = this;
+
+ me.type = type;
+ if (me.rendered) {
+ me.toolEl.dom.className = me.baseCls + '-' + type;
+ }
+ return me;
+ },
+
/**
- * @property disabled
- * @hide
+ * Binds this tool to a component.
+ * @private
+ * @param {Ext.Component} component The component
*/
+ bindTo: function(component) {
+ this.owner = component;
+ },
+
/**
- * @method applyToMarkup
- * @hide
+ * Fired when the tool element is clicked
+ * @private
+ * @param {Ext.EventObject} e
+ * @param {HTMLElement} target The target element
*/
+ onClick: function(e, target) {
+ var me = this,
+ owner;
+
+ if (me.disabled) {
+ return false;
+ }
+ owner = me.owner || me.ownerCt;
+
+ //remove the pressed + over class
+ me.el.removeCls(me.toolPressedCls);
+ me.el.removeCls(me.toolOverCls);
+
+ if (me.stopEvent !== false) {
+ e.stopEvent();
+ }
+
+ Ext.callback(me.handler, me.scope || me, [e, target, owner, me]);
+ me.fireEvent('click', me, e);
+ return true;
+ },
+
+ // inherit docs
+ onDestroy: function(){
+ if (Ext.isObject(this.tooltip)) {
+ Ext.tip.QuickTipManager.unregister(this.id);
+ }
+ this.callParent();
+ },
+
/**
- * @method enable
- * @hide
+ * Called then the user pressing their mouse button down on a tool
+ * Adds the press class ({@link #toolPressedCls})
+ * @private
*/
+ onMouseDown: function() {
+ if (this.disabled) {
+ return false;
+ }
+
+ this.el.addCls(this.toolPressedCls);
+ },
+
/**
- * @method disable
- * @hide
+ * Called when the user rolls over a tool
+ * Adds the over class ({@link #toolOverCls})
+ * @private
*/
+ onMouseOver: function() {
+ if (this.disabled) {
+ return false;
+ }
+ this.el.addCls(this.toolOverCls);
+ },
+
/**
- * @method setDisabled
- * @hide
+ * Called when the user rolls out from a tool.
+ * Removes the over class ({@link #toolOverCls})
+ * @private
*/
+ onMouseOut: function() {
+ this.el.removeCls(this.toolOverCls);
+ }
});
-Ext.reg('grid', Ext.grid.GridPanel);/**
- * @class Ext.grid.GridView
- * @extends Ext.util.Observable
- * This class encapsulates the user interface of an {@link Ext.grid.GridPanel}.
- * Methods of this class may be used to access user interface elements to enable
- * special display effects. Do not change the DOM structure of the user interface.
- * This class does not provide ways to manipulate the underlying data. The data
- * model of a Grid is held in an {@link Ext.data.Store}.
- * @constructor
- * @param {Object} config
+/**
+ * @class Ext.resizer.Handle
+ * @extends Ext.Component
+ *
+ * Provides a handle for 9-point resizing of Elements or Components.
*/
-Ext.grid.GridView = Ext.extend(Ext.util.Observable, {
- /**
- * Override this function to apply custom CSS classes to rows during rendering. You can also supply custom
- * parameters to the row template for the current row to customize how it is rendered using the rowParams
- * parameter. This function should return the CSS class name (or empty string '' for none) that will be added
- * to the row's wrapping div. To apply multiple class names, simply return them space-delimited within the string
- * (e.g., 'my-class another-class'). Example usage:
-
-viewConfig: {
- forceFit: true,
- showPreview: true, // custom property
- enableRowBody: true, // required to create a second, full-width row to show expanded Record data
- getRowClass: function(record, rowIndex, rp, ds){ // rp = rowParams
- if(this.showPreview){
- rp.body = '<p>'+record.data.excerpt+'</p>';
- return 'x-grid3-row-expanded';
- }
- return 'x-grid3-row-collapsed';
+Ext.define('Ext.resizer.Handle', {
+ extend: 'Ext.Component',
+ handleCls: '',
+ baseHandleCls: Ext.baseCSSPrefix + 'resizable-handle',
+ // Ext.resizer.Resizer.prototype.possiblePositions define the regions
+ // which will be passed in as a region configuration.
+ region: '',
+
+ onRender: function() {
+ this.addCls(
+ this.baseHandleCls,
+ this.baseHandleCls + '-' + this.region,
+ this.handleCls
+ );
+ this.callParent(arguments);
+ this.el.unselectable();
}
-},
-
- * @param {Record} record The {@link Ext.data.Record} corresponding to the current row.
- * @param {Number} index The row index.
- * @param {Object} rowParams A config object that is passed to the row template during rendering that allows
- * customization of various aspects of a grid row.
- * If {@link #enableRowBody} is configured true, then the following properties may be set
- * by this function, and will be used to render a full-width expansion row below each grid row:
- *
- * body
: String An HTML fragment to be used as the expansion row's body content (defaults to '').
- * bodyStyle
: String A CSS style specification that will be applied to the expansion row's <tr> element. (defaults to '').
- *
- * The following property will be passed in, and may be appended to:
- *
- * tstyle
: String A CSS style specification that willl be applied to the <table> element which encapsulates
- * both the standard grid row, and any expansion row.
- *
- * @param {Store} store The {@link Ext.data.Store} this grid is bound to
- * @method getRowClass
- * @return {String} a CSS class name to add to the row.
- */
+});
- /**
- * @cfg {Boolean} enableRowBody True to add a second TR element per row that can be used to provide a row body
- * that spans beneath the data row. Use the {@link #getRowClass} method's rowParams config to customize the row body.
- */
+/**
+ * @class Ext.resizer.Resizer
+ * Applies drag handles to an element or component to make it resizable. The
+ * drag handles are inserted into the element (or component's element) and
+ * positioned absolute.
+ *
+ * Textarea and img elements will be wrapped with an additional div because
+ * these elements do not support child nodes. The original element can be accessed
+ * through the originalTarget property.
+ *
+ * Here is the list of valid resize handles:
+ *
+Value Description
+------ -------------------
+ 'n' north
+ 's' south
+ 'e' east
+ 'w' west
+ 'nw' northwest
+ 'sw' southwest
+ 'se' southeast
+ 'ne' northeast
+ 'all' all
+
+ * {@img Ext.resizer.Resizer/Ext.resizer.Resizer.png Ext.resizer.Resizer component}
+ * Here's an example showing the creation of a typical Resizer:
+ *
+
+
+ Ext.create('Ext.resizer.Resizer', {
+ el: 'elToResize',
+ handles: 'all',
+ minWidth: 200,
+ minHeight: 100,
+ maxWidth: 500,
+ maxHeight: 400,
+ pinned: true
+ });
+
+*/
+Ext.define('Ext.resizer.Resizer', {
+ mixins: {
+ observable: 'Ext.util.Observable'
+ },
+ uses: ['Ext.resizer.ResizeTracker', 'Ext.Component'],
- /**
- * @cfg {String} emptyText Default text (html tags are accepted) to display in the grid body when no rows
- * are available (defaults to ''). This value will be used to update the {@link #mainBody}:
-
- this.mainBody.update('<div class="x-grid-empty">' + this.emptyText + '</div>');
-
- */
+ alternateClassName: 'Ext.Resizable',
- /**
- * @cfg {Boolean} headersDisabled True to disable the grid column headers (defaults to false).
- * Use the {@link Ext.grid.ColumnModel ColumnModel} {@link Ext.grid.ColumnModel#menuDisabled menuDisabled}
- * config to disable the menu for individual columns. While this config is true the
- * following will be disabled:
- * - clicking on header to sort
- * - the trigger to reveal the menu.
- *
- */
+ handleCls: Ext.baseCSSPrefix + 'resizable-handle',
+ pinnedCls: Ext.baseCSSPrefix + 'resizable-pinned',
+ overCls: Ext.baseCSSPrefix + 'resizable-over',
+ proxyCls: Ext.baseCSSPrefix + 'resizable-proxy',
+ wrapCls: Ext.baseCSSPrefix + 'resizable-wrap',
/**
- * A customized implementation of a {@link Ext.dd.DragZone DragZone} which provides default implementations
- * of the template methods of DragZone to enable dragging of the selected rows of a GridPanel.
- * See {@link Ext.grid.GridDragZone} for details.
- * This will only be present:
- * - if the owning GridPanel was configured with {@link Ext.grid.GridPanel#enableDragDrop enableDragDrop}: true.
- * - after the owning GridPanel has been rendered.
- *
- * @property dragZone
- * @type {Ext.grid.GridDragZone}
+ * @cfg {Boolean} dynamic
+ * Specify as true to update the {@link #target} (Element or {@link Ext.Component Component}) dynamically during dragging.
+ * This is true
by default, but the {@link Ext.Component Component} class passes false
when it
+ * is configured as {@link Ext.Component#resizable}.
+ * If specified as false
, a proxy element is displayed during the resize operation, and the {@link #target}
+ * is updated on mouseup.
*/
+ dynamic: true,
/**
- * @cfg {Boolean} deferEmptyText True to defer {@link #emptyText} being applied until the store's
- * first load (defaults to true).
+ * @cfg {String} handles String consisting of the resize handles to display. Defaults to 's e se' for
+ * Elements and fixed position Components. Defaults to 8 point resizing for floating Components (such as Windows).
+ * Specify either 'all'
or any of 'n s e w ne nw se sw'
.
*/
- deferEmptyText : true,
+ handles: 's e se',
/**
- * @cfg {Number} scrollOffset The amount of space to reserve for the vertical scrollbar
- * (defaults to undefined). If an explicit value isn't specified, this will be automatically
- * calculated.
+ * @cfg {Number} height Optional. The height to set target to in pixels (defaults to null)
*/
- scrollOffset : undefined,
+ height : null,
/**
- * @cfg {Boolean} autoFill
- * Defaults to false. Specify true to have the column widths re-proportioned
- * when the grid is initially rendered. The
- * {@link Ext.grid.Column#width initially configured width} of each column will be adjusted
- * to fit the grid width and prevent horizontal scrolling. If columns are later resized (manually
- * or programmatically), the other columns in the grid will not be resized to fit the grid width.
- * See {@link #forceFit} also.
+ * @cfg {Number} width Optional. The width to set the target to in pixels (defaults to null)
*/
- autoFill : false,
+ width : null,
/**
- * @cfg {Boolean} forceFit
- * Defaults to false. Specify true to have the column widths re-proportioned
- * at all times. The {@link Ext.grid.Column#width initially configured width} of each
- * column will be adjusted to fit the grid width and prevent horizontal scrolling. If columns are
- * later resized (manually or programmatically), the other columns in the grid will be resized
- * to fit the grid width. See {@link #autoFill} also.
+ * @cfg {Number} minHeight The minimum height for the element (defaults to 20)
*/
- forceFit : false,
+ minHeight : 20,
/**
- * @cfg {Array} sortClasses The CSS classes applied to a header when it is sorted. (defaults to ['sort-asc', 'sort-desc'])
+ * @cfg {Number} minWidth The minimum width for the element (defaults to 20)
*/
- sortClasses : ['sort-asc', 'sort-desc'],
+ minWidth : 20,
/**
- * @cfg {String} sortAscText The text displayed in the 'Sort Ascending' menu item (defaults to 'Sort Ascending')
+ * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000)
*/
- sortAscText : 'Sort Ascending',
+ maxHeight : 10000,
/**
- * @cfg {String} sortDescText The text displayed in the 'Sort Descending' menu item (defaults to 'Sort Descending')
+ * @cfg {Number} maxWidth The maximum width for the element (defaults to 10000)
*/
- sortDescText : 'Sort Descending',
+ maxWidth : 10000,
/**
- * @cfg {String} columnsText The text displayed in the 'Columns' menu item (defaults to 'Columns')
+ * @cfg {Boolean} pinned True to ensure that the resize handles are always
+ * visible, false indicates resizing by cursor changes only (defaults to false)
*/
- columnsText : 'Columns',
+ pinned: false,
/**
- * @cfg {String} selectedRowClass The CSS class applied to a selected row (defaults to 'x-grid3-row-selected'). An
- * example overriding the default styling:
-
- .x-grid3-row-selected {background-color: yellow;}
-
- * Note that this only controls the row, and will not do anything for the text inside it. To style inner
- * facets (like text) use something like:
-
- .x-grid3-row-selected .x-grid3-cell-inner {
- color: #FFCC00;
- }
-
- * @type String
+ * @cfg {Boolean} preserveRatio True to preserve the original ratio between height
+ * and width during resize (defaults to false)
*/
- selectedRowClass : 'x-grid3-row-selected',
+ preserveRatio: false,
- // private
- borderWidth : 2,
- tdClass : 'x-grid3-cell',
- hdCls : 'x-grid3-hd',
- markDirty : true,
-
- /**
- * @cfg {Number} cellSelectorDepth The number of levels to search for cells in event delegation (defaults to 4)
- */
- cellSelectorDepth : 4,
/**
- * @cfg {Number} rowSelectorDepth The number of levels to search for rows in event delegation (defaults to 10)
+ * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false)
*/
- rowSelectorDepth : 10,
+ transparent: false,
/**
- * @cfg {Number} rowBodySelectorDepth The number of levels to search for row bodies in event delegation (defaults to 10)
+ * @cfg {Mixed} constrainTo Optional. An element, or a {@link Ext.util.Region} into which the resize operation
+ * must be constrained.
*/
- rowBodySelectorDepth : 10,
+
+ possiblePositions: {
+ n: 'north',
+ s: 'south',
+ e: 'east',
+ w: 'west',
+ se: 'southeast',
+ sw: 'southwest',
+ nw: 'northwest',
+ ne: 'northeast'
+ },
/**
- * @cfg {String} cellSelector The selector used to find cells internally (defaults to 'td.x-grid3-cell')
- */
- cellSelector : 'td.x-grid3-cell',
- /**
- * @cfg {String} rowSelector The selector used to find rows internally (defaults to 'div.x-grid3-row')
+ * @cfg {Mixed} target The Element or Component to resize.
*/
- rowSelector : 'div.x-grid3-row',
/**
- * @cfg {String} rowBodySelector The selector used to find row bodies internally (defaults to 'div.x-grid3-row')
+ * Outer element for resizing behavior.
+ * @type Ext.core.Element
+ * @property el
*/
- rowBodySelector : 'div.x-grid3-row-body',
- // private
- firstRowCls: 'x-grid3-row-first',
- lastRowCls: 'x-grid3-row-last',
- rowClsRe: /(?:^|\s+)x-grid3-row-(first|last|alt)(?:\s+|$)/g,
+ constructor: function(config) {
+ var me = this,
+ target,
+ tag,
+ handles = me.handles,
+ handleCls,
+ possibles,
+ len,
+ i = 0,
+ pos;
- constructor : function(config){
- Ext.apply(this, config);
- // These events are only used internally by the grid components
this.addEvents(
/**
- * @event beforerowremoved
- * Internal UI Event. Fired before a row is removed.
- * @param {Ext.grid.GridView} view
- * @param {Number} rowIndex The index of the row to be removed.
- * @param {Ext.data.Record} record The Record to be removed
- */
- 'beforerowremoved',
- /**
- * @event beforerowsinserted
- * Internal UI Event. Fired before rows are inserted.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the first row to be inserted.
- * @param {Number} lastRow The index of the last row to be inserted.
- */
- 'beforerowsinserted',
- /**
- * @event beforerefresh
- * Internal UI Event. Fired before the view is refreshed.
- * @param {Ext.grid.GridView} view
- */
- 'beforerefresh',
- /**
- * @event rowremoved
- * Internal UI Event. Fired after a row is removed.
- * @param {Ext.grid.GridView} view
- * @param {Number} rowIndex The index of the row that was removed.
- * @param {Ext.data.Record} record The Record that was removed
- */
- 'rowremoved',
- /**
- * @event rowsinserted
- * Internal UI Event. Fired after rows are inserted.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the first inserted.
- * @param {Number} lastRow The index of the last row inserted.
+ * @event beforeresize
+ * Fired before resize is allowed. Return false to cancel resize.
+ * @param {Ext.resizer.Resizer} this
+ * @param {Number} width The start width
+ * @param {Number} height The start height
+ * @param {Ext.EventObject} e The mousedown event
*/
- 'rowsinserted',
+ 'beforeresize',
/**
- * @event rowupdated
- * Internal UI Event. Fired after a row has been updated.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the row updated.
- * @param {Ext.data.record} record The Record backing the row updated.
+ * @event resizedrag
+ * Fires during resizing. Return false to cancel resize.
+ * @param {Ext.resizer.Resizer} this
+ * @param {Number} width The new width
+ * @param {Number} height The new height
+ * @param {Ext.EventObject} e The mousedown event
*/
- 'rowupdated',
+ 'resizedrag',
/**
- * @event refresh
- * Internal UI Event. Fired after the GridView's body has been refreshed.
- * @param {Ext.grid.GridView} view
+ * @event resize
+ * Fired after a resize.
+ * @param {Ext.resizer.Resizer} this
+ * @param {Number} width The new width
+ * @param {Number} height The new height
+ * @param {Ext.EventObject} e The mouseup event
*/
- 'refresh'
+ 'resize'
);
- Ext.grid.GridView.superclass.constructor.call(this);
- },
- /* -------------------------------- UI Specific ----------------------------- */
+ if (Ext.isString(config) || Ext.isElement(config) || config.dom) {
+ target = config;
+ config = arguments[1] || {};
+ config.target = target;
+ }
+ // will apply config to this
+ me.mixins.observable.constructor.call(me, config);
- // private
- initTemplates : function(){
- var ts = this.templates || {};
- if(!ts.master){
- ts.master = new Ext.Template(
- '',
- ' ',
- ' ',
- ''
- );
+ // If target is a Component, ensure that we pull the element out.
+ // Resizer must examine the underlying Element.
+ target = me.target;
+ if (target) {
+ if (target.isComponent) {
+ me.el = target.getEl();
+ if (target.minWidth) {
+ me.minWidth = target.minWidth;
+ }
+ if (target.minHeight) {
+ me.minHeight = target.minHeight;
+ }
+ if (target.maxWidth) {
+ me.maxWidth = target.maxWidth;
+ }
+ if (target.maxHeight) {
+ me.maxHeight = target.maxHeight;
+ }
+ if (target.floating) {
+ if (!this.hasOwnProperty('handles')) {
+ this.handles = 'n ne e se s sw w nw';
+ }
+ }
+ } else {
+ me.el = me.target = Ext.get(target);
+ }
+ }
+ // Backwards compatibility with Ext3.x's Resizable which used el as a config.
+ else {
+ me.target = me.el = Ext.get(me.el);
}
- if(!ts.header){
- ts.header = new Ext.Template(
- ' ',
- '',
- '{cells} ',
- '
'
- );
+ // Tags like textarea and img cannot
+ // have children and therefore must
+ // be wrapped
+ tag = me.el.dom.tagName;
+ if (tag == 'TEXTAREA' || tag == 'IMG') {
+ /**
+ * Reference to the original resize target if the element of the original
+ * resize target was an IMG or a TEXTAREA which must be wrapped in a DIV.
+ * @type Mixed
+ * @property originalTarget
+ */
+ me.originalTarget = me.target;
+ me.target = me.el = me.el.wrap({
+ cls: me.wrapCls,
+ id: me.el.id + '-rzwrap'
+ });
+
+ // Transfer originalTarget's positioning/sizing
+ me.el.setPositioning(me.originalTarget.getPositioning());
+ me.originalTarget.clearPositioning();
+ var box = me.originalTarget.getBox();
+ me.el.setBox(box);
}
- if(!ts.hcell){
- ts.hcell = new Ext.Template(
- ' '
- );
+ // Position the element, this enables us to absolute position
+ // the handles within this.el
+ me.el.position();
+ if (me.pinned) {
+ me.el.addCls(me.pinnedCls);
}
- if(!ts.body){
- ts.body = new Ext.Template('{rows}');
+ /**
+ * @type Ext.resizer.ResizeTracker
+ * @property resizeTracker
+ */
+ me.resizeTracker = Ext.create('Ext.resizer.ResizeTracker', {
+ disabled: me.disabled,
+ target: me.target,
+ constrainTo: me.constrainTo,
+ overCls: me.overCls,
+ throttle: me.throttle,
+ originalTarget: me.originalTarget,
+ delegate: '.' + me.handleCls,
+ dynamic: me.dynamic,
+ preserveRatio: me.preserveRatio,
+ minHeight: me.minHeight,
+ maxHeight: me.maxHeight,
+ minWidth: me.minWidth,
+ maxWidth: me.maxWidth
+ });
+
+ // Relay the ResizeTracker's superclass events as our own resize events
+ me.resizeTracker.on('mousedown', me.onBeforeResize, me);
+ me.resizeTracker.on('drag', me.onResize, me);
+ me.resizeTracker.on('dragend', me.onResizeEnd, me);
+
+ if (me.handles == 'all') {
+ me.handles = 'n s e w ne nw se sw';
}
- if(!ts.row){
- ts.row = new Ext.Template(
- '',
- '{cells} ',
- (this.enableRowBody ? '{body} ' : ''),
- '
'
- );
+ handles = me.handles = me.handles.split(/ |\s*?[,;]\s*?/);
+ possibles = me.possiblePositions;
+ len = handles.length;
+ handleCls = me.handleCls + ' ' + (this.target.isComponent ? (me.target.baseCls + '-handle ') : '') + me.handleCls + '-';
+
+ for(; i < len; i++){
+ // if specified and possible, create
+ if (handles[i] && possibles[handles[i]]) {
+ pos = possibles[handles[i]];
+ // store a reference in this.east, this.west, etc
+
+ me[pos] = Ext.create('Ext.Component', {
+ owner: this,
+ region: pos,
+ cls: handleCls + pos,
+ renderTo: me.el
+ });
+ me[pos].el.unselectable();
+ if (me.transparent) {
+ me[pos].el.setOpacity(0);
+ }
+ }
}
- if(!ts.cell){
- ts.cell = new Ext.Template(
- '',
- '{value}',
- ' '
- );
+ // Constrain within configured maxima
+ if (Ext.isNumber(me.width)) {
+ me.width = Ext.Number.constrain(me.width, me.minWidth, me.maxWidth);
+ }
+ if (Ext.isNumber(me.height)) {
+ me.height = Ext.Number.constrain(me.height, me.minHeight, me.maxHeight);
}
- for(var k in ts){
- var t = ts[k];
- if(t && Ext.isFunction(t.compile) && !t.compiled){
- t.disableFormats = true;
- t.compile();
+ // Size the element
+ if (me.width != null || me.height != null) {
+ if (me.originalTarget) {
+ me.originalTarget.setWidth(me.width);
+ me.originalTarget.setHeight(me.height);
}
+ me.resizeTo(me.width, me.height);
}
- this.templates = ts;
- this.colRe = new RegExp('x-grid3-td-([^\\s]+)', '');
+ me.forceHandlesHeight();
},
- // private
- fly : function(el){
- if(!this._flyweight){
- this._flyweight = new Ext.Element.Flyweight(document.body);
- }
- this._flyweight.dom = el;
- return this._flyweight;
+ disable: function() {
+ this.resizeTracker.disable();
},
- // private
- getEditorParent : function(){
- return this.scroller.dom;
+ enable: function() {
+ this.resizeTracker.enable();
},
- // private
- initElements : function(){
- var E = Ext.Element;
+ /**
+ * @private Relay the Tracker's mousedown event as beforeresize
+ * @param tracker The Resizer
+ * @param e The Event
+ */
+ onBeforeResize: function(tracker, e) {
+ var b = this.target.getBox();
+ return this.fireEvent('beforeresize', this, b.width, b.height, e);
+ },
+
+ /**
+ * @private Relay the Tracker's drag event as resizedrag
+ * @param tracker The Resizer
+ * @param e The Event
+ */
+ onResize: function(tracker, e) {
+ var me = this,
+ b = me.target.getBox();
+ me.forceHandlesHeight();
+ return me.fireEvent('resizedrag', me, b.width, b.height, e);
+ },
+
+ /**
+ * @private Relay the Tracker's dragend event as resize
+ * @param tracker The Resizer
+ * @param e The Event
+ */
+ onResizeEnd: function(tracker, e) {
+ var me = this,
+ b = me.target.getBox();
+ me.forceHandlesHeight();
+ return me.fireEvent('resize', me, b.width, b.height, e);
+ },
- var el = this.grid.getGridEl().dom.firstChild;
- var cs = el.childNodes;
+ /**
+ * Perform a manual resize and fires the 'resize' event.
+ * @param {Number} width
+ * @param {Number} height
+ */
+ resizeTo : function(width, height){
+ this.target.setSize(width, height);
+ this.fireEvent('resize', this, width, height, null);
+ },
- this.el = new E(el);
+ /**
+ * Returns the element that was configured with the el or target config property.
+ * If a component was configured with the target property then this will return the
+ * element of this component.
+ *
Textarea and img elements will be wrapped with an additional div because
+ * these elements do not support child nodes. The original element can be accessed
+ * through the originalTarget property.
+ * @return {Element} element
+ */
+ getEl : function() {
+ return this.el;
+ },
- this.mainWrap = new E(cs[0]);
- this.mainHd = new E(this.mainWrap.dom.firstChild);
+ /**
+ * Returns the element or component that was configured with the target config property.
+ *
Textarea and img elements will be wrapped with an additional div because
+ * these elements do not support child nodes. The original element can be accessed
+ * through the originalTarget property.
+ * @return {Element/Component}
+ */
+ getTarget: function() {
+ return this.target;
+ },
- if(this.grid.hideHeaders){
- this.mainHd.setDisplayed(false);
+ destroy: function() {
+ var h;
+ for (var i = 0, l = this.handles.length; i < l; i++) {
+ h = this[this.possiblePositions[this.handles[i]]];
+ delete h.owner;
+ Ext.destroy(h);
}
+ },
- this.innerHd = this.mainHd.dom.firstChild;
- this.scroller = new E(this.mainWrap.dom.childNodes[1]);
- if(this.forceFit){
- this.scroller.setStyle('overflow-x', 'hidden');
+ /**
+ * @private
+ * Fix IE6 handle height issue.
+ */
+ forceHandlesHeight : function() {
+ var me = this,
+ handle;
+ if (Ext.isIE6) {
+ handle = me.east;
+ if (handle) {
+ handle.setHeight(me.el.getHeight());
+ }
+ handle = me.west;
+ if (handle) {
+ handle.setHeight(me.el.getHeight());
+ }
+ me.el.repaint();
}
- /**
- * Read-only. The GridView's body Element which encapsulates all rows in the Grid.
- * This {@link Ext.Element Element} is only available after the GridPanel has been rendered.
- * @type Ext.Element
- * @property mainBody
- */
- this.mainBody = new E(this.scroller.dom.firstChild);
+ }
+});
- this.focusEl = new E(this.scroller.dom.childNodes[1]);
- this.focusEl.swallowEvent('click', true);
+/**
+ * @class Ext.resizer.ResizeTracker
+ * @extends Ext.dd.DragTracker
+ */
+Ext.define('Ext.resizer.ResizeTracker', {
+ extend: 'Ext.dd.DragTracker',
+ dynamic: true,
+ preserveRatio: false,
- this.resizeMarker = new E(cs[1]);
- this.resizeProxy = new E(cs[2]);
- },
+ // Default to no constraint
+ constrainTo: null,
- // private
- getRows : function(){
- return this.hasRows() ? this.mainBody.dom.childNodes : [];
- },
+ constructor: function(config) {
+ var me = this;
+
+ if (!config.el) {
+ if (config.target.isComponent) {
+ me.el = config.target.getEl();
+ } else {
+ me.el = config.target;
+ }
+ }
+ this.callParent(arguments);
- // finder methods, used with delegation
+ // Ensure that if we are preserving aspect ratio, the largest minimum is honoured
+ if (me.preserveRatio && me.minWidth && me.minHeight) {
+ var widthRatio = me.minWidth / me.el.getWidth(),
+ heightRatio = me.minHeight / me.el.getHeight();
- // private
- findCell : function(el){
- if(!el){
- return false;
+ // largest ratio of minimum:size must be preserved.
+ // So if a 400x200 pixel image has
+ // minWidth: 50, maxWidth: 50, the maxWidth will be 400 * (50/200)... that is 100
+ if (heightRatio > widthRatio) {
+ me.minWidth = me.el.getWidth() * heightRatio;
+ } else {
+ me.minHeight = me.el.getHeight() * widthRatio;
+ }
+ }
+
+ // If configured as throttled, create an instance version of resize which calls
+ // a throttled function to perform the resize operation.
+ if (me.throttle) {
+ var throttledResizeFn = Ext.Function.createThrottled(function() {
+ Ext.resizer.ResizeTracker.prototype.resize.apply(me, arguments);
+ }, me.throttle);
+
+ me.resize = function(box, direction, atEnd) {
+ if (atEnd) {
+ Ext.resizer.ResizeTracker.prototype.resize.apply(me, arguments);
+ } else {
+ throttledResizeFn.apply(null, arguments);
+ }
+ };
}
- return this.fly(el).findParent(this.cellSelector, this.cellSelectorDepth);
+ },
+
+ onBeforeStart: function(e) {
+ // record the startBox
+ this.startBox = this.el.getBox();
},
/**
- * Return the index of the grid column which contains the passed HTMLElement.
- * See also {@link #findRowIndex}
- * @param {HTMLElement} el The target element
- * @return {Number} The column index, or false if the target element is not within a row of this GridView.
+ * @private
+ * Returns the object that will be resized on every mousemove event.
+ * If dynamic is false, this will be a proxy, otherwise it will be our actual target.
*/
- findCellIndex : function(el, requiredCls){
- var cell = this.findCell(el);
- if(cell && (!requiredCls || this.fly(cell).hasClass(requiredCls))){
- return this.getCellIndex(cell);
+ getDynamicTarget: function() {
+ var d = this.target;
+ if (this.dynamic) {
+ return d;
+ } else if (!this.proxy) {
+ this.proxy = d.isComponent ? d.getProxy().addCls(Ext.baseCSSPrefix + 'resizable-proxy') : d.createProxy({tag: 'div', cls: Ext.baseCSSPrefix + 'resizable-proxy', id: d.id + '-rzproxy'}, Ext.getBody());
+ this.proxy.removeCls(Ext.baseCSSPrefix + 'proxy-el');
}
- return false;
+ this.proxy.show();
+ return this.proxy;
},
- // private
- getCellIndex : function(el){
- if(el){
- var m = el.className.match(this.colRe);
- if(m && m[1]){
- return this.cm.getIndexById(m[1]);
+ onStart: function(e) {
+ // returns the Ext.ResizeHandle that the user started dragging
+ this.activeResizeHandle = Ext.getCmp(this.getDragTarget().id);
+
+ // If we are using a proxy, ensure it is sized.
+ if (!this.dynamic) {
+ this.resize(this.startBox, {
+ horizontal: 'none',
+ vertical: 'none'
+ });
+ }
+ },
+
+ onDrag: function(e) {
+ // dynamic resizing, update dimensions during resize
+ if (this.dynamic || this.proxy) {
+ this.updateDimensions(e);
+ }
+ },
+
+ updateDimensions: function(e, atEnd) {
+ var me = this,
+ region = me.activeResizeHandle.region,
+ offset = me.getOffset(me.constrainTo ? 'dragTarget' : null),
+ box = me.startBox,
+ ratio,
+ widthAdjust = 0,
+ heightAdjust = 0,
+ adjustX = 0,
+ adjustY = 0,
+ dragRatio,
+ horizDir = offset[0] < 0 ? 'right' : 'left',
+ vertDir = offset[1] < 0 ? 'down' : 'up',
+ oppositeCorner,
+ axis; // 1 = x, 2 = y, 3 = x and y.
+
+ switch (region) {
+ case 'south':
+ heightAdjust = offset[1];
+ axis = 2;
+ break;
+ case 'north':
+ heightAdjust = -offset[1];
+ adjustY = -heightAdjust;
+ axis = 2;
+ break;
+ case 'east':
+ widthAdjust = offset[0];
+ axis = 1;
+ break;
+ case 'west':
+ widthAdjust = -offset[0];
+ adjustX = -widthAdjust;
+ axis = 1;
+ break;
+ case 'northeast':
+ heightAdjust = -offset[1];
+ adjustY = -heightAdjust;
+ widthAdjust = offset[0];
+ oppositeCorner = [box.x, box.y + box.height];
+ axis = 3;
+ break;
+ case 'southeast':
+ heightAdjust = offset[1];
+ widthAdjust = offset[0];
+ oppositeCorner = [box.x, box.y];
+ axis = 3;
+ break;
+ case 'southwest':
+ widthAdjust = -offset[0];
+ adjustX = -widthAdjust;
+ heightAdjust = offset[1];
+ oppositeCorner = [box.x + box.width, box.y];
+ axis = 3;
+ break;
+ case 'northwest':
+ heightAdjust = -offset[1];
+ adjustY = -heightAdjust;
+ widthAdjust = -offset[0];
+ adjustX = -widthAdjust;
+ oppositeCorner = [box.x + box.width, box.y + box.height];
+ axis = 3;
+ break;
+ }
+
+ var newBox = {
+ width: box.width + widthAdjust,
+ height: box.height + heightAdjust,
+ x: box.x + adjustX,
+ y: box.y + adjustY
+ };
+
+ // out of bounds
+ if (newBox.width < me.minWidth || newBox.width > me.maxWidth) {
+ newBox.width = Ext.Number.constrain(newBox.width, me.minWidth, me.maxWidth);
+ newBox.x = me.lastX || newBox.x;
+ } else {
+ me.lastX = newBox.x;
+ }
+ if (newBox.height < me.minHeight || newBox.height > me.maxHeight) {
+ newBox.height = Ext.Number.constrain(newBox.height, me.minHeight, me.maxHeight);
+ newBox.y = me.lastY || newBox.y;
+ } else {
+ me.lastY = newBox.y;
+ }
+
+ // If this is configured to preserve the aspect ratio, or they are dragging using the shift key
+ if (me.preserveRatio || e.shiftKey) {
+ var newHeight,
+ newWidth;
+
+ ratio = me.startBox.width / me.startBox.height;
+
+ // Calculate aspect ratio constrained values.
+ newHeight = Math.min(Math.max(me.minHeight, newBox.width / ratio), me.maxHeight);
+ newWidth = Math.min(Math.max(me.minWidth, newBox.height * ratio), me.maxWidth);
+
+ // X axis: width-only change, height must obey
+ if (axis == 1) {
+ newBox.height = newHeight;
+ }
+
+ // Y axis: height-only change, width must obey
+ else if (axis == 2) {
+ newBox.width = newWidth;
+ }
+
+ // Corner drag.
+ else {
+ // Drag ratio is the ratio of the mouse point from the opposite corner.
+ // Basically what edge we are dragging, a horizontal edge or a vertical edge.
+ dragRatio = Math.abs(oppositeCorner[0] - this.lastXY[0]) / Math.abs(oppositeCorner[1] - this.lastXY[1]);
+
+ // If drag ratio > aspect ratio then width is dominant and height must obey
+ if (dragRatio > ratio) {
+ newBox.height = newHeight;
+ } else {
+ newBox.width = newWidth;
+ }
+
+ // Handle dragging start coordinates
+ if (region == 'northeast') {
+ newBox.y = box.y - (newBox.height - box.height);
+ } else if (region == 'northwest') {
+ newBox.y = box.y - (newBox.height - box.height);
+ newBox.x = box.x - (newBox.width - box.width);
+ } else if (region == 'southwest') {
+ newBox.x = box.x - (newBox.width - box.width);
+ }
}
}
- return false;
+
+ if (heightAdjust === 0) {
+ vertDir = 'none';
+ }
+ if (widthAdjust === 0) {
+ horizDir = 'none';
+ }
+ me.resize(newBox, {
+ horizontal: horizDir,
+ vertical: vertDir
+ }, atEnd);
},
- // private
- findHeaderCell : function(el){
- var cell = this.findCell(el);
- return cell && this.fly(cell).hasClass(this.hdCls) ? cell : null;
+ getResizeTarget: function(atEnd) {
+ return atEnd ? this.target : this.getDynamicTarget();
},
- // private
- findHeaderIndex : function(el){
- return this.findCellIndex(el, this.hdCls);
+ resize: function(box, direction, atEnd) {
+ var target = this.getResizeTarget(atEnd);
+ if (target.isComponent) {
+ if (target.floating) {
+ target.setPagePosition(box.x, box.y);
+ }
+ target.setSize(box.width, box.height);
+ } else {
+ target.setBox(box);
+ // update the originalTarget if this was wrapped.
+ if (this.originalTarget) {
+ this.originalTarget.setBox(box);
+ }
+ }
},
- /**
- * Return the HtmlElement representing the grid row which contains the passed element.
- * @param {HTMLElement} el The target HTMLElement
- * @return {HTMLElement} The row element, or null if the target element is not within a row of this GridView.
- */
- findRow : function(el){
- if(!el){
+ onEnd: function(e) {
+ this.updateDimensions(e, true);
+ if (this.proxy) {
+ this.proxy.hide();
+ }
+ }
+});
+
+/**
+ * @class Ext.resizer.SplitterTracker
+ * @extends Ext.dd.DragTracker
+ * Private utility class for Ext.Splitter.
+ * @private
+ */
+Ext.define('Ext.resizer.SplitterTracker', {
+ extend: 'Ext.dd.DragTracker',
+ requires: ['Ext.util.Region'],
+ enabled: true,
+
+ getPrevCmp: function() {
+ var splitter = this.getSplitter();
+ return splitter.previousSibling();
+ },
+
+ getNextCmp: function() {
+ var splitter = this.getSplitter();
+ return splitter.nextSibling();
+ },
+
+ // ensure the tracker is enabled, store boxes of previous and next
+ // components and calculate the constrain region
+ onBeforeStart: function(e) {
+ var prevCmp = this.getPrevCmp(),
+ nextCmp = this.getNextCmp();
+
+ // SplitterTracker is disabled if any of its adjacents are collapsed.
+ if (nextCmp.collapsed || prevCmp.collapsed) {
return false;
}
- return this.fly(el).findParent(this.rowSelector, this.rowSelectorDepth);
+ // store boxes of previous and next
+ this.prevBox = prevCmp.getEl().getBox();
+ this.nextBox = nextCmp.getEl().getBox();
+ this.constrainTo = this.calculateConstrainRegion();
+ },
+
+ // We move the splitter el. Add the proxy class.
+ onStart: function(e) {
+ var splitter = this.getSplitter();
+ splitter.addCls(splitter.baseCls + '-active');
+ },
+
+ // calculate the constrain Region in which the splitter el may be moved.
+ calculateConstrainRegion: function() {
+ var splitter = this.getSplitter(),
+ topPad = 0,
+ bottomPad = 0,
+ splitWidth = splitter.getWidth(),
+ defaultMin = splitter.defaultSplitMin,
+ orient = splitter.orientation,
+ prevBox = this.prevBox,
+ prevCmp = this.getPrevCmp(),
+ nextBox = this.nextBox,
+ nextCmp = this.getNextCmp(),
+ // prev and nextConstrainRegions are the maximumBoxes minus the
+ // minimumBoxes. The result is always the intersection
+ // of these two boxes.
+ prevConstrainRegion, nextConstrainRegion;
+
+ // vertical splitters, so resizing left to right
+ if (orient === 'vertical') {
+
+ // Region constructor accepts (top, right, bottom, left)
+ // anchored/calculated from the left
+ prevConstrainRegion = Ext.create('Ext.util.Region',
+ prevBox.y,
+ // Right boundary is x + maxWidth if there IS a maxWidth.
+ // Otherwise it is calculated based upon the minWidth of the next Component
+ (prevCmp.maxWidth ? prevBox.x + prevCmp.maxWidth : nextBox.right - (nextCmp.minWidth || defaultMin)) + splitWidth,
+ prevBox.bottom,
+ prevBox.x + (prevCmp.minWidth || defaultMin)
+ );
+ // anchored/calculated from the right
+ nextConstrainRegion = Ext.create('Ext.util.Region',
+ nextBox.y,
+ nextBox.right - (nextCmp.minWidth || defaultMin),
+ nextBox.bottom,
+ // Left boundary is right - maxWidth if there IS a maxWidth.
+ // Otherwise it is calculated based upon the minWidth of the previous Component
+ (nextCmp.maxWidth ? nextBox.right - nextCmp.maxWidth : prevBox.x + (prevBox.minWidth || defaultMin)) - splitWidth
+ );
+ } else {
+ // anchored/calculated from the top
+ prevConstrainRegion = Ext.create('Ext.util.Region',
+ prevBox.y + (prevCmp.minHeight || defaultMin),
+ prevBox.right,
+ // Bottom boundary is y + maxHeight if there IS a maxHeight.
+ // Otherwise it is calculated based upon the minWidth of the next Component
+ (prevCmp.maxHeight ? prevBox.y + prevCmp.maxHeight : nextBox.bottom - (nextCmp.minHeight || defaultMin)) + splitWidth,
+ prevBox.x
+ );
+ // anchored/calculated from the bottom
+ nextConstrainRegion = Ext.create('Ext.util.Region',
+ // Top boundary is bottom - maxHeight if there IS a maxHeight.
+ // Otherwise it is calculated based upon the minHeight of the previous Component
+ (nextCmp.maxHeight ? nextBox.bottom - nextCmp.maxHeight : prevBox.y + (prevCmp.minHeight || defaultMin)) - splitWidth,
+ nextBox.right,
+ nextBox.bottom - (nextCmp.minHeight || defaultMin),
+ nextBox.x
+ );
+ }
+
+ // intersection of the two regions to provide region draggable
+ return prevConstrainRegion.intersect(nextConstrainRegion);
},
- /**
- * Return the index of the grid row which contains the passed HTMLElement.
- * See also {@link #findCellIndex}
- * @param {HTMLElement} el The target HTMLElement
- * @return {Number} The row index, or false if the target element is not within a row of this GridView.
- */
- findRowIndex : function(el){
- var r = this.findRow(el);
- return r ? r.rowIndex : false;
+ // Performs the actual resizing of the previous and next components
+ performResize: function(e) {
+ var offset = this.getOffset('dragTarget'),
+ splitter = this.getSplitter(),
+ orient = splitter.orientation,
+ prevCmp = this.getPrevCmp(),
+ nextCmp = this.getNextCmp(),
+ owner = splitter.ownerCt,
+ layout = owner.getLayout();
+
+ // Inhibit automatic container layout caused by setSize calls below.
+ owner.suspendLayout = true;
+
+ if (orient === 'vertical') {
+ if (prevCmp) {
+ if (!prevCmp.maintainFlex) {
+ delete prevCmp.flex;
+ prevCmp.setSize(this.prevBox.width + offset[0], prevCmp.getHeight());
+ }
+ }
+ if (nextCmp) {
+ if (!nextCmp.maintainFlex) {
+ delete nextCmp.flex;
+ nextCmp.setSize(this.nextBox.width - offset[0], nextCmp.getHeight());
+ }
+ }
+ // verticals
+ } else {
+ if (prevCmp) {
+ if (!prevCmp.maintainFlex) {
+ delete prevCmp.flex;
+ prevCmp.setSize(prevCmp.getWidth(), this.prevBox.height + offset[1]);
+ }
+ }
+ if (nextCmp) {
+ if (!nextCmp.maintainFlex) {
+ delete nextCmp.flex;
+ nextCmp.setSize(prevCmp.getWidth(), this.nextBox.height - offset[1]);
+ }
+ }
+ }
+ delete owner.suspendLayout;
+ layout.onLayout();
},
+ // perform the resize and remove the proxy class from the splitter el
+ onEnd: function(e) {
+ var splitter = this.getSplitter();
+ splitter.removeCls(splitter.baseCls + '-active');
+ this.performResize();
+ },
+
+ // Track the proxy and set the proper XY coordinates
+ // while constraining the drag
+ onDrag: function(e) {
+ var offset = this.getOffset('dragTarget'),
+ splitter = this.getSplitter(),
+ splitEl = splitter.getEl(),
+ orient = splitter.orientation;
+
+ if (orient === "vertical") {
+ splitEl.setX(this.startRegion.left + offset[0]);
+ } else {
+ splitEl.setY(this.startRegion.top + offset[1]);
+ }
+ },
+
+ getSplitter: function() {
+ return Ext.getCmp(this.getDragCt().id);
+ }
+});
+/**
+ * @class Ext.selection.CellModel
+ * @extends Ext.selection.Model
+ * @private
+ */
+Ext.define('Ext.selection.CellModel', {
+ extend: 'Ext.selection.Model',
+ alias: 'selection.cellmodel',
+ requires: ['Ext.util.KeyNav'],
+
/**
- * Return the HtmlElement representing the grid row body which contains the passed element.
- * @param {HTMLElement} el The target HTMLElement
- * @return {HTMLElement} The row body element, or null if the target element is not within a row body of this GridView.
+ * @cfg {Boolean} enableKeyNav
+ * Turns on/off keyboard navigation within the grid. Defaults to true.
*/
- findRowBody : function(el){
- if(!el){
- return false;
+ enableKeyNav: true,
+
+ /**
+ * @cfg {Boolean} preventWrap
+ * Set this configuration to true to prevent wrapping around of selection as
+ * a user navigates to the first or last column. Defaults to false.
+ */
+ preventWrap: false,
+
+ constructor: function(){
+ this.addEvents(
+ /**
+ * @event deselect
+ * Fired after a cell is deselected
+ * @param {Ext.selection.CellModel} this
+ * @param {Ext.data.Model} record The record of the deselected cell
+ * @param {Number} row The row index deselected
+ * @param {Number} column The column index deselected
+ */
+ 'deselect',
+
+ /**
+ * @event select
+ * Fired after a cell is selected
+ * @param {Ext.selection.CellModel} this
+ * @param {Ext.data.Model} record The record of the selected cell
+ * @param {Number} row The row index selected
+ * @param {Number} column The column index selected
+ */
+ 'select'
+ );
+ this.callParent(arguments);
+ },
+
+ bindComponent: function(view) {
+ var me = this;
+ me.primaryView = view;
+ me.views = me.views || [];
+ me.views.push(view);
+ me.bind(view.getStore(), true);
+
+ view.on({
+ cellmousedown: me.onMouseDown,
+ refresh: me.onViewRefresh,
+ scope: me
+ });
+
+ if (me.enableKeyNav) {
+ me.initKeyNav(view);
+ }
+ },
+
+ initKeyNav: function(view) {
+ var me = this;
+
+ if (!view.rendered) {
+ view.on('render', Ext.Function.bind(me.initKeyNav, me, [view], 0), me, {single: true});
+ return;
}
- return this.fly(el).findParent(this.rowBodySelector, this.rowBodySelectorDepth);
+
+ view.el.set({
+ tabIndex: -1
+ });
+
+ // view.el has tabIndex -1 to allow for
+ // keyboard events to be passed to it.
+ me.keyNav = Ext.create('Ext.util.KeyNav', view.el, {
+ up: me.onKeyUp,
+ down: me.onKeyDown,
+ right: me.onKeyRight,
+ left: me.onKeyLeft,
+ tab: me.onKeyTab,
+ scope: me
+ });
+ },
+
+ getHeaderCt: function() {
+ return this.primaryView.headerCt;
+ },
+
+ onKeyUp: function(e, t) {
+ this.move('up', e);
},
- // getter methods for fetching elements dynamically in the grid
+ onKeyDown: function(e, t) {
+ this.move('down', e);
+ },
+
+ onKeyLeft: function(e, t) {
+ this.move('left', e);
+ },
+
+ onKeyRight: function(e, t) {
+ this.move('right', e);
+ },
+
+ move: function(dir, e) {
+ var me = this,
+ pos = me.primaryView.walkCells(me.getCurrentPosition(), dir, e, me.preventWrap);
+ if (pos) {
+ me.setCurrentPosition(pos);
+ }
+ return pos;
+ },
/**
- * Return the <div> HtmlElement which represents a Grid row for the specified index.
- * @param {Number} index The row index
- * @return {HtmlElement} The div element.
+ * Returns the current position in the format {row: row, column: column}
*/
- getRow : function(row){
- return this.getRows()[row];
+ getCurrentPosition: function() {
+ return this.position;
},
-
+
/**
- * Returns the grid's <td> HtmlElement at the specified coordinates.
- * @param {Number} row The row index in which to find the cell.
- * @param {Number} col The column index of the cell.
- * @return {HtmlElement} The td at the specified coordinates.
+ * Sets the current position
+ * @param {Object} position The position to set.
*/
- getCell : function(row, col){
- return this.getRow(row).getElementsByTagName('td')[col];
+ setCurrentPosition: function(pos) {
+ var me = this;
+
+ if (me.position) {
+ me.onCellDeselect(me.position);
+ }
+ if (pos) {
+ me.onCellSelect(pos);
+ }
+ me.position = pos;
},
/**
- * Return the <td> HtmlElement which represents the Grid's header cell for the specified column index.
- * @param {Number} index The column index
- * @return {HtmlElement} The td element.
+ * Set the current position based on where the user clicks.
+ * @private
*/
- getHeaderCell : function(index){
- return this.mainHd.dom.getElementsByTagName('td')[index];
+ onMouseDown: function(view, cell, cellIndex, record, row, rowIndex, e) {
+ this.setCurrentPosition({
+ row: rowIndex,
+ column: cellIndex
+ });
+ },
+
+ // notify the view that the cell has been selected to update the ui
+ // appropriately and bring the cell into focus
+ onCellSelect: function(position) {
+ var me = this,
+ store = me.view.getStore(),
+ record = store.getAt(position.row);
+
+ me.doSelect(record);
+ me.primaryView.onCellSelect(position);
+ // TODO: Remove temporary cellFocus call here.
+ me.primaryView.onCellFocus(position);
+ me.fireEvent('select', me, record, position.row, position.column);
+ },
+
+ // notify view that the cell has been deselected to update the ui
+ // appropriately
+ onCellDeselect: function(position) {
+ var me = this,
+ store = me.view.getStore(),
+ record = store.getAt(position.row);
+
+ me.doDeselect(record);
+ me.primaryView.onCellDeselect(position);
+ me.fireEvent('deselect', me, record, position.row, position.column);
},
- // manipulating elements
+ onKeyTab: function(e, t) {
+ var me = this,
+ direction = e.shiftKey ? 'left' : 'right',
+ editingPlugin = me.view.editingPlugin,
+ position = me.move(direction, e);
- // private - use getRowClass to apply custom row classes
- addRowClass : function(row, cls){
- var r = this.getRow(row);
- if(r){
- this.fly(r).addClass(cls);
+ if (editingPlugin && position && me.wasEditing) {
+ editingPlugin.startEditByPosition(position);
}
+ delete me.wasEditing;
},
- // private
- removeRowClass : function(row, cls){
- var r = this.getRow(row);
- if(r){
- this.fly(r).removeClass(cls);
+ onEditorTab: function(editingPlugin, e) {
+ var me = this,
+ direction = e.shiftKey ? 'left' : 'right',
+ position = me.move(direction, e);
+
+ if (position) {
+ editingPlugin.startEditByPosition(position);
+ me.wasEditing = true;
}
},
- // private
- removeRow : function(row){
- Ext.removeNode(this.getRow(row));
- this.syncFocusEl(row);
+ refresh: function() {
+ var pos = this.getCurrentPosition();
+ if (pos) {
+ this.onCellSelect(pos);
+ }
},
- // private
- removeRows : function(firstRow, lastRow){
- var bd = this.mainBody.dom;
- for(var rowIndex = firstRow; rowIndex <= lastRow; rowIndex++){
- Ext.removeNode(bd.childNodes[firstRow]);
+ onViewRefresh: function() {
+ var pos = this.getCurrentPosition();
+ if (pos) {
+ this.onCellDeselect(pos);
+ this.setCurrentPosition(null);
+ }
+ },
+
+ selectByPosition: function(position) {
+ this.setCurrentPosition(position);
+ }
+});
+/**
+ * @class Ext.selection.RowModel
+ * @extends Ext.selection.Model
+ *
+ * Implement row based navigation via keyboard.
+ *
+ * Must synchronize across grid sections
+ */
+Ext.define('Ext.selection.RowModel', {
+ extend: 'Ext.selection.Model',
+ alias: 'selection.rowmodel',
+ requires: ['Ext.util.KeyNav'],
+
+ /**
+ * @private
+ * Number of pixels to scroll to the left/right when pressing
+ * left/right keys.
+ */
+ deltaScroll: 5,
+
+ /**
+ * @cfg {Boolean} enableKeyNav
+ *
+ * Turns on/off keyboard navigation within the grid. Defaults to true.
+ */
+ enableKeyNav: true,
+
+ constructor: function(){
+ this.addEvents(
+ /**
+ * @event deselect
+ * Fired after a record is deselected
+ * @param {Ext.selection.RowSelectionModel} this
+ * @param {Ext.data.Model} record The deselected record
+ * @param {Number} index The row index deselected
+ */
+ 'deselect',
+
+ /**
+ * @event select
+ * Fired after a record is selected
+ * @param {Ext.selection.RowSelectionModel} this
+ * @param {Ext.data.Model} record The selected record
+ * @param {Number} index The row index selected
+ */
+ 'select'
+ );
+ this.callParent(arguments);
+ },
+
+ bindComponent: function(view) {
+ var me = this;
+
+ me.views = me.views || [];
+ me.views.push(view);
+ me.bind(view.getStore(), true);
+
+ view.on({
+ itemmousedown: me.onRowMouseDown,
+ scope: me
+ });
+
+ if (me.enableKeyNav) {
+ me.initKeyNav(view);
}
- this.syncFocusEl(firstRow);
},
- // scrolling stuff
+ initKeyNav: function(view) {
+ var me = this;
+
+ if (!view.rendered) {
+ view.on('render', Ext.Function.bind(me.initKeyNav, me, [view], 0), me, {single: true});
+ return;
+ }
- // private
- getScrollState : function(){
- var sb = this.scroller.dom;
- return {left: sb.scrollLeft, top: sb.scrollTop};
+ view.el.set({
+ tabIndex: -1
+ });
+
+ // view.el has tabIndex -1 to allow for
+ // keyboard events to be passed to it.
+ me.keyNav = new Ext.util.KeyNav(view.el, {
+ up: me.onKeyUp,
+ down: me.onKeyDown,
+ right: me.onKeyRight,
+ left: me.onKeyLeft,
+ pageDown: me.onKeyPageDown,
+ pageUp: me.onKeyPageUp,
+ home: me.onKeyHome,
+ end: me.onKeyEnd,
+ scope: me
+ });
+ view.el.on(Ext.EventManager.getKeyEvent(), me.onKeyPress, me);
},
- // private
- restoreScroll : function(state){
- var sb = this.scroller.dom;
- sb.scrollLeft = state.left;
- sb.scrollTop = state.top;
+ // Returns the number of rows currently visible on the screen or
+ // false if there were no rows. This assumes that all rows are
+ // of the same height and the first view is accurate.
+ getRowsVisible: function() {
+ var rowsVisible = false,
+ view = this.views[0],
+ row = view.getNode(0),
+ rowHeight, gridViewHeight;
+
+ if (row) {
+ rowHeight = Ext.fly(row).getHeight();
+ gridViewHeight = view.el.getHeight();
+ rowsVisible = Math.floor(gridViewHeight / rowHeight);
+ }
+
+ return rowsVisible;
},
- /**
- * Scrolls the grid to the top
- */
- scrollToTop : function(){
- this.scroller.dom.scrollTop = 0;
- this.scroller.dom.scrollLeft = 0;
+ // go to last visible record in grid.
+ onKeyEnd: function(e, t) {
+ var me = this,
+ last = me.store.getAt(me.store.getCount() - 1);
+
+ if (last) {
+ if (e.shiftKey) {
+ me.selectRange(last, me.lastFocused || 0);
+ me.setLastFocused(last);
+ } else if (e.ctrlKey) {
+ me.setLastFocused(last);
+ } else {
+ me.doSelect(last);
+ }
+ }
},
- // private
- syncScroll : function(){
- this.syncHeaderScroll();
- var mb = this.scroller.dom;
- this.grid.fireEvent('bodyscroll', mb.scrollLeft, mb.scrollTop);
+ // go to first visible record in grid.
+ onKeyHome: function(e, t) {
+ var me = this,
+ first = me.store.getAt(0);
+
+ if (first) {
+ if (e.shiftKey) {
+ me.selectRange(first, me.lastFocused || 0);
+ me.setLastFocused(first);
+ } else if (e.ctrlKey) {
+ me.setLastFocused(first);
+ } else {
+ me.doSelect(first, false);
+ }
+ }
},
- // private
- syncHeaderScroll : function(){
- var mb = this.scroller.dom;
- this.innerHd.scrollLeft = mb.scrollLeft;
- this.innerHd.scrollLeft = mb.scrollLeft; // second time for IE (1/2 time first fails, other browsers ignore)
+ // Go one page up from the lastFocused record in the grid.
+ onKeyPageUp: function(e, t) {
+ var me = this,
+ rowsVisible = me.getRowsVisible(),
+ selIdx,
+ prevIdx,
+ prevRecord,
+ currRec;
+
+ if (rowsVisible) {
+ selIdx = me.lastFocused ? me.store.indexOf(me.lastFocused) : 0;
+ prevIdx = selIdx - rowsVisible;
+ if (prevIdx < 0) {
+ prevIdx = 0;
+ }
+ prevRecord = me.store.getAt(prevIdx);
+ if (e.shiftKey) {
+ currRec = me.store.getAt(selIdx);
+ me.selectRange(prevRecord, currRec, e.ctrlKey, 'up');
+ me.setLastFocused(prevRecord);
+ } else if (e.ctrlKey) {
+ e.preventDefault();
+ me.setLastFocused(prevRecord);
+ } else {
+ me.doSelect(prevRecord);
+ }
+
+ }
},
- // private
- updateSortIcon : function(col, dir){
- var sc = this.sortClasses;
- var hds = this.mainHd.select('td').removeClass(sc);
- hds.item(col).addClass(sc[dir == 'DESC' ? 1 : 0]);
+ // Go one page down from the lastFocused record in the grid.
+ onKeyPageDown: function(e, t) {
+ var me = this,
+ rowsVisible = me.getRowsVisible(),
+ selIdx,
+ nextIdx,
+ nextRecord,
+ currRec;
+
+ if (rowsVisible) {
+ selIdx = me.lastFocused ? me.store.indexOf(me.lastFocused) : 0;
+ nextIdx = selIdx + rowsVisible;
+ if (nextIdx >= me.store.getCount()) {
+ nextIdx = me.store.getCount() - 1;
+ }
+ nextRecord = me.store.getAt(nextIdx);
+ if (e.shiftKey) {
+ currRec = me.store.getAt(selIdx);
+ me.selectRange(nextRecord, currRec, e.ctrlKey, 'down');
+ me.setLastFocused(nextRecord);
+ } else if (e.ctrlKey) {
+ // some browsers, this means go thru browser tabs
+ // attempt to stop.
+ e.preventDefault();
+ me.setLastFocused(nextRecord);
+ } else {
+ me.doSelect(nextRecord);
+ }
+ }
},
- // private
- updateAllColumnWidths : function(){
- var tw = this.getTotalWidth(),
- clen = this.cm.getColumnCount(),
- ws = [],
- len,
- i;
+ // Select/Deselect based on pressing Spacebar.
+ // Assumes a SIMPLE selectionmode style
+ onKeyPress: function(e, t) {
+ if (e.getKey() === e.SPACE) {
+ e.stopEvent();
+ var me = this,
+ record = me.lastFocused;
+
+ if (record) {
+ if (me.isSelected(record)) {
+ me.doDeselect(record, false);
+ } else {
+ me.doSelect(record, true);
+ }
+ }
+ }
+ },
+
+ // Navigate one record up. This could be a selection or
+ // could be simply focusing a record for discontiguous
+ // selection. Provides bounds checking.
+ onKeyUp: function(e, t) {
+ var me = this,
+ view = me.views[0],
+ idx = me.store.indexOf(me.lastFocused),
+ record;
+
+ if (idx > 0) {
+ // needs to be the filtered count as thats what
+ // will be visible.
+ record = me.store.getAt(idx - 1);
+ if (e.shiftKey && me.lastFocused) {
+ if (me.isSelected(me.lastFocused) && me.isSelected(record)) {
+ me.doDeselect(me.lastFocused, true);
+ me.setLastFocused(record);
+ } else if (!me.isSelected(me.lastFocused)) {
+ me.doSelect(me.lastFocused, true);
+ me.doSelect(record, true);
+ } else {
+ me.doSelect(record, true);
+ }
+ } else if (e.ctrlKey) {
+ me.setLastFocused(record);
+ } else {
+ me.doSelect(record);
+ //view.focusRow(idx - 1);
+ }
+ }
+ // There was no lastFocused record, and the user has pressed up
+ // Ignore??
+ //else if (this.selected.getCount() == 0) {
+ //
+ // this.doSelect(record);
+ // //view.focusRow(idx - 1);
+ //}
+ },
- for(i = 0; i < clen; i++){
- ws[i] = this.getColumnWidth(i);
+ // Navigate one record down. This could be a selection or
+ // could be simply focusing a record for discontiguous
+ // selection. Provides bounds checking.
+ onKeyDown: function(e, t) {
+ var me = this,
+ view = me.views[0],
+ idx = me.store.indexOf(me.lastFocused),
+ record;
+
+ // needs to be the filtered count as thats what
+ // will be visible.
+ if (idx + 1 < me.store.getCount()) {
+ record = me.store.getAt(idx + 1);
+ if (me.selected.getCount() === 0) {
+ me.doSelect(record);
+ //view.focusRow(idx + 1);
+ } else if (e.shiftKey && me.lastFocused) {
+ if (me.isSelected(me.lastFocused) && me.isSelected(record)) {
+ me.doDeselect(me.lastFocused, true);
+ me.setLastFocused(record);
+ } else if (!me.isSelected(me.lastFocused)) {
+ me.doSelect(me.lastFocused, true);
+ me.doSelect(record, true);
+ } else {
+ me.doSelect(record, true);
+ }
+ } else if (e.ctrlKey) {
+ me.setLastFocused(record);
+ } else {
+ me.doSelect(record);
+ //view.focusRow(idx + 1);
+ }
+ }
+ },
+
+ scrollByDeltaX: function(delta) {
+ var view = this.views[0],
+ section = view.up(),
+ hScroll = section.horizontalScroller;
+
+ if (hScroll) {
+ hScroll.scrollByDeltaX(delta);
}
+ },
+
+ onKeyLeft: function(e, t) {
+ this.scrollByDeltaX(-this.deltaScroll);
+ },
+
+ onKeyRight: function(e, t) {
+ this.scrollByDeltaX(this.deltaScroll);
+ },
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = tw;
- this.mainBody.dom.style.width = tw;
+ // Select the record with the event included so that
+ // we can take into account ctrlKey, shiftKey, etc
+ onRowMouseDown: function(view, record, item, index, e) {
+ view.el.focus();
+ this.selectWithEvent(record, e);
+ },
- for(i = 0; i < clen; i++){
- var hd = this.getHeaderCell(i);
- hd.style.width = ws[i];
+ // Allow the GridView to update the UI by
+ // adding/removing a CSS class from the row.
+ onSelectChange: function(record, isSelected, suppressEvent) {
+ var me = this,
+ views = me.views,
+ viewsLn = views.length,
+ store = me.store,
+ rowIdx = store.indexOf(record),
+ i = 0;
+
+ for (; i < viewsLn; i++) {
+ if (isSelected) {
+ views[i].onRowSelect(rowIdx, suppressEvent);
+ if (!suppressEvent) {
+ me.fireEvent('select', me, record, rowIdx);
+ }
+ } else {
+ views[i].onRowDeselect(rowIdx, suppressEvent);
+ if (!suppressEvent) {
+ me.fireEvent('deselect', me, record, rowIdx);
+ }
+ }
}
+ },
- var ns = this.getRows(), row, trow;
- for(i = 0, len = ns.length; i < len; i++){
- row = ns[i];
- row.style.width = tw;
- if(row.firstChild){
- row.firstChild.style.width = tw;
- trow = row.firstChild.rows[0];
- for (var j = 0; j < clen; j++) {
- trow.childNodes[j].style.width = ws[j];
+ // Provide indication of what row was last focused via
+ // the gridview.
+ onLastFocusChanged: function(oldFocused, newFocused, supressFocus) {
+ var views = this.views,
+ viewsLn = views.length,
+ store = this.store,
+ rowIdx,
+ i = 0;
+
+ if (oldFocused) {
+ rowIdx = store.indexOf(oldFocused);
+ if (rowIdx != -1) {
+ for (; i < viewsLn; i++) {
+ views[i].onRowFocus(rowIdx, false);
}
}
}
- this.onAllColumnWidthsUpdated(ws, tw);
+ if (newFocused) {
+ rowIdx = store.indexOf(newFocused);
+ if (rowIdx != -1) {
+ for (i = 0; i < viewsLn; i++) {
+ views[i].onRowFocus(rowIdx, true, supressFocus);
+ }
+ }
+ }
+ },
+
+ onEditorTab: function(editingPlugin, e) {
+ var me = this,
+ view = me.views[0],
+ record = editingPlugin.getActiveRecord(),
+ header = editingPlugin.getActiveColumn(),
+ position = view.getPosition(record, header),
+ direction = e.shiftKey ? 'left' : 'right',
+ newPosition = view.walkCells(position, direction, e, this.preventWrap);
+
+ if (newPosition) {
+ editingPlugin.startEditByPosition(newPosition);
+ }
},
+
+ selectByPosition: function(position) {
+ var record = this.store.getAt(position.row);
+ this.select(record);
+ }
+});
+/**
+ * @class Ext.selection.CheckboxModel
+ * @extends Ext.selection.RowModel
+ *
+ * A selection model that renders a column of checkboxes that can be toggled to
+ * select or deselect rows. The default mode for this selection model is MULTI.
+ *
+ * The selection model will inject a header for the checkboxes in the first view
+ * and according to the 'injectCheckbox' configuration.
+ */
+Ext.define('Ext.selection.CheckboxModel', {
+ extend: 'Ext.selection.RowModel',
- // private
- updateColumnWidth : function(col, width){
- var w = this.getColumnWidth(col);
- var tw = this.getTotalWidth();
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = tw;
- this.mainBody.dom.style.width = tw;
- var hd = this.getHeaderCell(col);
- hd.style.width = w;
+ /**
+ * @cfg {String} mode
+ * Modes of selection.
+ * Valid values are SINGLE, SIMPLE, and MULTI. Defaults to 'MULTI'
+ */
+ mode: 'MULTI',
- var ns = this.getRows(), row;
- for(var i = 0, len = ns.length; i < len; i++){
- row = ns[i];
- row.style.width = tw;
- if(row.firstChild){
- row.firstChild.style.width = tw;
- row.firstChild.rows[0].childNodes[col].style.width = w;
- }
- }
+ /**
+ * @cfg {Mixed} injectCheckbox
+ * Instructs the SelectionModel whether or not to inject the checkbox header
+ * automatically or not. (Note: By not placing the checkbox in manually, the
+ * grid view will need to be rendered 2x on initial render.)
+ * Supported values are a Number index, false and the strings 'first' and 'last'.
+ * Default is 0.
+ */
+ injectCheckbox: 0,
- this.onColumnWidthUpdated(col, w, tw);
- },
+ /**
+ * @cfg {Boolean} checkOnly true if rows can only be selected by clicking on the
+ * checkbox column (defaults to false).
+ */
+ checkOnly: false,
// private
- updateColumnHidden : function(col, hidden){
- var tw = this.getTotalWidth();
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = tw;
- this.mainBody.dom.style.width = tw;
- var display = hidden ? 'none' : '';
+ checkerOnCls: Ext.baseCSSPrefix + 'grid-hd-checker-on',
+
+ bindComponent: function() {
+ this.sortable = false;
+ this.callParent(arguments);
- var hd = this.getHeaderCell(col);
- hd.style.display = display;
+ var view = this.views[0],
+ headerCt = view.headerCt;
- var ns = this.getRows(), row;
- for(var i = 0, len = ns.length; i < len; i++){
- row = ns[i];
- row.style.width = tw;
- if(row.firstChild){
- row.firstChild.style.width = tw;
- row.firstChild.rows[0].childNodes[col].style.display = display;
+ if (this.injectCheckbox !== false) {
+ if (this.injectCheckbox == 'first') {
+ this.injectCheckbox = 0;
+ } else if (this.injectCheckbox == 'last') {
+ this.injectCheckbox = headerCt.getColumnCount();
}
+ headerCt.add(this.injectCheckbox, this.getHeaderConfig());
}
-
- this.onColumnHiddenUpdated(col, hidden, tw);
- delete this.lastViewWidth; // force recalc
- this.layout();
+ headerCt.on('headerclick', this.onHeaderClick, this);
},
/**
+ * Toggle the ui header between checked and unchecked state.
+ * @param {Boolean} isChecked
* @private
- * Renders all of the rows to a string buffer and returns the string. This is called internally
- * by renderRows and performs the actual string building for the rows - it does not inject HTML into the DOM.
- * @param {Array} columns The column data acquired from getColumnData.
- * @param {Array} records The array of records to render
- * @param {Ext.data.Store} store The store to render the rows from
- * @param {Number} startRow The index of the first row being rendered. Sometimes we only render a subset of
- * the rows so this is used to maintain logic for striping etc
- * @param {Number} colCount The total number of columns in the column model
- * @param {Boolean} stripe True to stripe the rows
- * @return {String} A string containing the HTML for the rendered rows
*/
- doRender : function(columns, records, store, startRow, colCount, stripe) {
- var templates = this.templates,
- cellTemplate = templates.cell,
- rowTemplate = templates.row,
- last = colCount - 1;
-
- var tstyle = 'width:' + this.getTotalWidth() + ';';
-
- // buffers
- var rowBuffer = [],
- colBuffer = [],
- rowParams = {tstyle: tstyle},
- meta = {},
- column,
- record;
-
- //build up each row's HTML
- for (var j = 0, len = records.length; j < len; j++) {
- record = records[j];
- colBuffer = [];
-
- var rowIndex = j + startRow;
-
- //build up each column's HTML
- for (var i = 0; i < colCount; i++) {
- column = columns[i];
-
- meta.id = column.id;
- meta.css = i === 0 ? 'x-grid3-cell-first ' : (i == last ? 'x-grid3-cell-last ' : '');
- meta.attr = meta.cellAttr = '';
- meta.style = column.style;
- meta.value = column.renderer.call(column.scope, record.data[column.name], meta, record, rowIndex, i, store);
-
- if (Ext.isEmpty(meta.value)) {
- meta.value = ' ';
- }
-
- if (this.markDirty && record.dirty && Ext.isDefined(record.modified[column.name])) {
- meta.css += ' x-grid3-dirty-cell';
- }
-
- colBuffer[colBuffer.length] = cellTemplate.apply(meta);
- }
-
- //set up row striping and row dirtiness CSS classes
- var alt = [];
-
- if (stripe && ((rowIndex + 1) % 2 === 0)) {
- alt[0] = 'x-grid3-row-alt';
- }
+ toggleUiHeader: function(isChecked) {
+ var view = this.views[0],
+ headerCt = view.headerCt,
+ checkHd = headerCt.child('gridcolumn[isCheckerHd]');
- if (record.dirty) {
- alt[1] = ' x-grid3-dirty-row';
- }
-
- rowParams.cols = colCount;
-
- if (this.getRowClass) {
- alt[2] = this.getRowClass(record, rowIndex, rowParams, store);
+ if (checkHd) {
+ if (isChecked) {
+ checkHd.el.addCls(this.checkerOnCls);
+ } else {
+ checkHd.el.removeCls(this.checkerOnCls);
}
-
- rowParams.alt = alt.join(' ');
- rowParams.cells = colBuffer.join('');
-
- rowBuffer[rowBuffer.length] = rowTemplate.apply(rowParams);
}
-
- return rowBuffer.join('');
},
- // private
- processRows : function(startRow, skipStripe) {
- if (!this.ds || this.ds.getCount() < 1) {
- return;
- }
-
- var rows = this.getRows(),
- len = rows.length,
- i, r;
-
- skipStripe = skipStripe || !this.grid.stripeRows;
- startRow = startRow || 0;
-
- for (i = 0; i
';
},
- afterRender : function(){
- if(!this.ds || !this.cm){
+ // override
+ onRowMouseDown: function(view, record, item, index, e) {
+ view.el.focus();
+ var me = this,
+ checker = e.getTarget('.' + Ext.baseCSSPrefix + 'grid-row-checker');
+
+ // checkOnly set, but we didn't click on a checker.
+ if (me.checkOnly && !checker) {
return;
}
- this.mainBody.dom.innerHTML = this.renderRows() || ' ';
- this.processRows(0, true);
- if(this.deferEmptyText !== true){
- this.applyEmptyText();
+ if (checker) {
+ var mode = me.getSelectionMode();
+ // dont change the mode if its single otherwise
+ // we would get multiple selection
+ if (mode !== 'SINGLE') {
+ me.setSelectionMode('SIMPLE');
+ }
+ me.selectWithEvent(record, e);
+ me.setSelectionMode(mode);
+ } else {
+ me.selectWithEvent(record, e);
}
- this.grid.fireEvent('viewready', this.grid);
},
/**
+ * Synchronize header checker value as selection changes.
* @private
- * Renders each of the UI elements in turn. This is called internally, once, by this.render. It does not
- * render rows from the store, just the surrounding UI elements. It also sets up listeners on the UI elements
- * and sets up options like column menus, moving and resizing.
*/
- renderUI : function() {
- var templates = this.templates,
- header = this.renderHeaders(),
- body = templates.body.apply({rows:' '});
-
- var html = templates.master.apply({
- body : body,
- header: header,
- ostyle: 'width:' + this.getOffsetWidth() + ';',
- bstyle: 'width:' + this.getTotalWidth() + ';'
- });
-
- var g = this.grid;
-
- g.getGridEl().dom.innerHTML = html;
-
- this.initElements();
-
- // get mousedowns early
- Ext.fly(this.innerHd).on('click', this.handleHdDown, this);
-
- this.mainHd.on({
- scope : this,
- mouseover: this.handleHdOver,
- mouseout : this.handleHdOut,
- mousemove: this.handleHdMove
- });
-
- this.scroller.on('scroll', this.syncScroll, this);
- if (g.enableColumnResize !== false) {
- this.splitZone = new Ext.grid.GridView.SplitDragZone(g, this.mainHd.dom);
- }
-
- if (g.enableColumnMove) {
- this.columnDrag = new Ext.grid.GridView.ColumnDragZone(g, this.innerHd);
- this.columnDrop = new Ext.grid.HeaderDropZone(g, this.mainHd.dom);
- }
-
- if (g.enableHdMenu !== false) {
- this.hmenu = new Ext.menu.Menu({id: g.id + '-hctx'});
- this.hmenu.add(
- {itemId:'asc', text: this.sortAscText, cls: 'xg-hmenu-sort-asc'},
- {itemId:'desc', text: this.sortDescText, cls: 'xg-hmenu-sort-desc'}
- );
+ onSelectChange: function(record, isSelected) {
+ this.callParent([record, isSelected]);
+ // check to see if all records are selected
+ var hdSelectStatus = this.selected.getCount() === this.store.getCount();
+ this.toggleUiHeader(hdSelectStatus);
+ }
+});
- if (g.enableColumnHide !== false) {
- this.colMenu = new Ext.menu.Menu({id:g.id + '-hcols-menu'});
- this.colMenu.on({
- scope : this,
- beforeshow: this.beforeColMenuShow,
- itemclick : this.handleHdMenuClick
- });
- this.hmenu.add('-', {
- itemId:'columns',
- hideOnClick: false,
- text: this.columnsText,
- menu: this.colMenu,
- iconCls: 'x-cols-icon'
- });
+/**
+ * @class Ext.selection.TreeModel
+ * @extends Ext.selection.RowModel
+ *
+ * Adds custom behavior for left/right keyboard navigation for use with a tree.
+ * Depends on the view having an expand and collapse method which accepts a
+ * record.
+ *
+ * @private
+ */
+Ext.define('Ext.selection.TreeModel', {
+ extend: 'Ext.selection.RowModel',
+ alias: 'selection.treemodel',
+
+ // typically selection models prune records from the selection
+ // model when they are removed, because the TreeView constantly
+ // adds/removes records as they are expanded/collapsed
+ pruneRemoved: false,
+
+ onKeyRight: function(e, t) {
+ var focused = this.getLastFocused(),
+ view = this.view;
+
+ if (focused) {
+ // tree node is already expanded, go down instead
+ // this handles both the case where we navigate to firstChild and if
+ // there are no children to the nextSibling
+ if (focused.isExpanded()) {
+ this.onKeyDown(e, t);
+ // if its not a leaf node, expand it
+ } else if (!focused.isLeaf()) {
+ view.expand(focused);
}
-
- this.hmenu.on('itemclick', this.handleHdMenuClick, this);
- }
-
- if (g.trackMouseOver) {
- this.mainBody.on({
- scope : this,
- mouseover: this.onRowOver,
- mouseout : this.onRowOut
- });
- }
-
- if (g.enableDragDrop || g.enableDrag) {
- this.dragZone = new Ext.grid.GridDragZone(g, {
- ddGroup : g.ddGroup || 'GridDD'
- });
}
-
- this.updateHeaderSortState();
},
-
- // private
- processEvent : function(name, e) {
- var t = e.getTarget(),
- g = this.grid,
- header = this.findHeaderIndex(t);
- g.fireEvent(name, e);
- if (header !== false) {
- g.fireEvent('header' + name, g, header, e);
- } else {
- var row = this.findRowIndex(t),
- cell,
- body;
- if (row !== false) {
- g.fireEvent('row' + name, g, row, e);
- cell = this.findCellIndex(t);
- if (cell !== false) {
- g.fireEvent('cell' + name, g, row, cell, e);
+
+ onKeyLeft: function(e, t) {
+ var focused = this.getLastFocused(),
+ view = this.view,
+ viewSm = view.getSelectionModel(),
+ parentNode, parentRecord;
+
+ if (focused) {
+ parentNode = focused.parentNode;
+ // if focused node is already expanded, collapse it
+ if (focused.isExpanded()) {
+ view.collapse(focused);
+ // has a parentNode and its not root
+ // TODO: this needs to cover the case where the root isVisible
+ } else if (parentNode && !parentNode.isRoot()) {
+ // Select a range of records when doing multiple selection.
+ if (e.shiftKey) {
+ viewSm.selectRange(parentNode, focused, e.ctrlKey, 'up');
+ viewSm.setLastFocused(parentNode);
+ // just move focus, not selection
+ } else if (e.ctrlKey) {
+ viewSm.setLastFocused(parentNode);
+ // select it
} else {
- body = this.findRowBody(t);
- if (body) {
- g.fireEvent('rowbody' + name, g, row, e);
- }
+ viewSm.select(parentNode);
}
- } else {
- g.fireEvent('container' + name, g, e);
}
}
},
-
- // private
- layout : function() {
- if(!this.mainBody){
- return; // not rendered
+
+ onKeyPress: function(e, t) {
+ var selected, checked;
+
+ if (e.getKey() === e.SPACE || e.getKey() === e.ENTER) {
+ e.stopEvent();
+ selected = this.getLastSelected();
+ if (selected && selected.isLeaf()) {
+ checked = selected.get('checked');
+ if (Ext.isBoolean(checked)) {
+ selected.set('checked', !checked);
+ }
+ }
+ } else {
+ this.callParent(arguments);
}
- var g = this.grid;
- var c = g.getGridEl();
- var csize = c.getSize(true);
- var vw = csize.width;
+ }
+});
- if(!g.hideHeaders && (vw < 20 || csize.height < 20)){ // display: none?
- return;
- }
+/**
+ * @private
+ * @class Ext.slider.Thumb
+ * @extends Ext.Base
+ * @private
+ * Represents a single thumb element on a Slider. This would not usually be created manually and would instead
+ * be created internally by an {@link Ext.slider.Multi Ext.Slider}.
+ */
+Ext.define('Ext.slider.Thumb', {
+ requires: ['Ext.dd.DragTracker', 'Ext.util.Format'],
+ /**
+ * @private
+ * @property topThumbZIndex
+ * @type Number
+ * The number used internally to set the z index of the top thumb (see promoteThumb for details)
+ */
+ topZIndex: 10000,
+ /**
+ * @constructor
+ * @cfg {Ext.slider.MultiSlider} slider The Slider to render to (required)
+ */
+ constructor: function(config) {
+ var me = this;
+
+ /**
+ * @property slider
+ * @type Ext.slider.MultiSlider
+ * The slider this thumb is contained within
+ */
+ Ext.apply(me, config || {}, {
+ cls: Ext.baseCSSPrefix + 'slider-thumb',
- if(g.autoHeight){
- this.scroller.dom.style.overflow = 'visible';
- if(Ext.isWebKit){
- this.scroller.dom.style.position = 'static';
- }
- }else{
- this.el.setSize(csize.width, csize.height);
+ /**
+ * @cfg {Boolean} constrain True to constrain the thumb so that it cannot overlap its siblings
+ */
+ constrain: false
+ });
+ me.callParent([config]);
- var hdHeight = this.mainHd.getHeight();
- var vh = csize.height - (hdHeight);
+ if (me.slider.vertical) {
+ Ext.apply(me, Ext.slider.Thumb.Vertical);
+ }
+ },
- this.scroller.setSize(vw, vh);
- if(this.innerHd){
- this.innerHd.style.width = (vw)+'px';
- }
+ /**
+ * Renders the thumb into a slider
+ */
+ render: function() {
+ var me = this;
+
+ me.el = me.slider.innerEl.insertFirst({cls: me.cls});
+ if (me.disabled) {
+ me.disable();
}
- if(this.forceFit){
- if(this.lastViewWidth != vw){
- this.fitColumns(false, false);
- this.lastViewWidth = vw;
- }
- }else {
- this.autoExpand();
- this.syncHeaderScroll();
+ me.initEvents();
+ },
+
+ /**
+ * @private
+ * move the thumb
+ */
+ move: function(v, animate){
+ if(!animate){
+ this.el.setLeft(v);
+ }else{
+ Ext.create('Ext.fx.Anim', {
+ target: this.el,
+ duration: 350,
+ to: {
+ left: v
+ }
+ });
}
- this.onLayout(vw, vh);
},
- // template functions for subclasses and plugins
- // these functions include precalculated values
- onLayout : function(vw, vh){
- // do nothing
+ /**
+ * @private
+ * Bring thumb dom element to front.
+ */
+ bringToFront: function() {
+ this.el.setStyle('zIndex', this.topZIndex);
},
-
- onColumnWidthUpdated : function(col, w, tw){
- //template method
+
+ /**
+ * @private
+ * Send thumb dom element to back.
+ */
+ sendToBack: function() {
+ this.el.setStyle('zIndex', '');
},
-
- onAllColumnWidthsUpdated : function(ws, tw){
- //template method
+
+ /**
+ * Enables the thumb if it is currently disabled
+ */
+ enable: function() {
+ var me = this;
+
+ me.disabled = false;
+ if (me.el) {
+ me.el.removeCls(me.slider.disabledCls);
+ }
},
- onColumnHiddenUpdated : function(col, hidden, tw){
- // template method
+ /**
+ * Disables the thumb if it is currently enabled
+ */
+ disable: function() {
+ var me = this;
+
+ me.disabled = true;
+ if (me.el) {
+ me.el.addCls(me.slider.disabledCls);
+ }
},
- updateColumnText : function(col, text){
- // template method
+ /**
+ * Sets up an Ext.dd.DragTracker for this thumb
+ */
+ initEvents: function() {
+ var me = this,
+ el = me.el;
+
+ me.tracker = Ext.create('Ext.dd.DragTracker', {
+ onBeforeStart: Ext.Function.bind(me.onBeforeDragStart, me),
+ onStart : Ext.Function.bind(me.onDragStart, me),
+ onDrag : Ext.Function.bind(me.onDrag, me),
+ onEnd : Ext.Function.bind(me.onDragEnd, me),
+ tolerance : 3,
+ autoStart : 300,
+ overCls : Ext.baseCSSPrefix + 'slider-thumb-over'
+ });
+
+ me.tracker.initEl(el);
},
- afterMove : function(colIndex){
- // template method
+ /**
+ * @private
+ * This is tied into the internal Ext.dd.DragTracker. If the slider is currently disabled,
+ * this returns false to disable the DragTracker too.
+ * @return {Boolean} False if the slider is currently disabled
+ */
+ onBeforeDragStart : function(e) {
+ if (this.disabled) {
+ return false;
+ } else {
+ this.slider.promoteThumb(this);
+ return true;
+ }
},
- /* ----------------------------------- Core Specific -------------------------------------------*/
- // private
- init : function(grid){
- this.grid = grid;
+ /**
+ * @private
+ * This is tied into the internal Ext.dd.DragTracker's onStart template method. Adds the drag CSS class
+ * to the thumb and fires the 'dragstart' event
+ */
+ onDragStart: function(e){
+ var me = this;
+
+ me.el.addCls(Ext.baseCSSPrefix + 'slider-thumb-drag');
+ me.dragging = true;
+ me.dragStartValue = me.value;
- this.initTemplates();
- this.initData(grid.store, grid.colModel);
- this.initUI(grid);
+ me.slider.fireEvent('dragstart', me.slider, e, me);
},
- // private
- getColumnId : function(index){
- return this.cm.getColumnId(index);
- },
+ /**
+ * @private
+ * This is tied into the internal Ext.dd.DragTracker's onDrag template method. This is called every time
+ * the DragTracker detects a drag movement. It updates the Slider's value using the position of the drag
+ */
+ onDrag: function(e) {
+ var me = this,
+ slider = me.slider,
+ index = me.index,
+ newValue = me.getNewValue(),
+ above,
+ below;
- // private
- getOffsetWidth : function() {
- return (this.cm.getTotalWidth() + this.getScrollOffset()) + 'px';
+ if (me.constrain) {
+ above = slider.thumbs[index + 1];
+ below = slider.thumbs[index - 1];
+
+ if (below !== undefined && newValue <= below.value) {
+ newValue = below.value;
+ }
+
+ if (above !== undefined && newValue >= above.value) {
+ newValue = above.value;
+ }
+ }
+
+ slider.setValue(index, newValue, false);
+ slider.fireEvent('drag', slider, e, me);
},
- getScrollOffset: function(){
- return Ext.num(this.scrollOffset, Ext.getScrollBarWidth());
+ getNewValue: function() {
+ var slider = this.slider,
+ pos = slider.innerEl.translatePoints(this.tracker.getXY());
+
+ return Ext.util.Format.round(slider.reverseValue(pos.left), slider.decimalPrecision);
},
/**
* @private
- * Renders the header row using the 'header' template. Does not inject the HTML into the DOM, just
- * returns a string.
- * @return {String} Rendered header row
+ * This is tied to the internal Ext.dd.DragTracker's onEnd template method. Removes the drag CSS class and
+ * fires the 'changecomplete' event with the new value
*/
- renderHeaders : function() {
- var cm = this.cm,
- ts = this.templates,
- ct = ts.hcell,
- cb = [],
- p = {},
- len = cm.getColumnCount(),
- last = len - 1;
+ onDragEnd: function(e) {
+ var me = this,
+ slider = me.slider,
+ value = me.value;
- for (var i = 0; i < len; i++) {
- p.id = cm.getColumnId(i);
- p.value = cm.getColumnHeader(i) || '';
- p.style = this.getColumnStyle(i, true);
- p.tooltip = this.getColumnTooltip(i);
- p.css = i === 0 ? 'x-grid3-cell-first ' : (i == last ? 'x-grid3-cell-last ' : '');
+ me.el.removeCls(Ext.baseCSSPrefix + 'slider-thumb-drag');
- if (cm.config[i].align == 'right') {
- p.istyle = 'padding-right:16px';
- } else {
- delete p.istyle;
- }
- cb[cb.length] = ct.apply(p);
+ me.dragging = false;
+ slider.fireEvent('dragend', slider, e);
+
+ if (me.dragStartValue != value) {
+ slider.fireEvent('changecomplete', slider, value, me);
}
- return ts.header.apply({cells: cb.join(''), tstyle:'width:'+this.getTotalWidth()+';'});
},
- // private
- getColumnTooltip : function(i){
- var tt = this.cm.getColumnTooltip(i);
- if(tt){
- if(Ext.QuickTips.isEnabled()){
- return 'ext:qtip="'+tt+'"';
- }else{
- return 'title="'+tt+'"';
+ destroy: function() {
+ Ext.destroy(this.tracker);
+ },
+ statics: {
+ // Method overrides to support vertical dragging of thumb within slider
+ Vertical: {
+ getNewValue: function() {
+ var slider = this.slider,
+ innerEl = slider.innerEl,
+ pos = innerEl.translatePoints(this.tracker.getXY()),
+ bottom = innerEl.getHeight() - pos.top;
+
+ return Ext.util.Format.round(slider.reverseValue(bottom), slider.decimalPrecision);
+ },
+ move: function(v, animate) {
+ if (!animate) {
+ this.el.setBottom(v);
+ } else {
+ Ext.create('Ext.fx.Anim', {
+ target: this.el,
+ duration: 350,
+ to: {
+ bottom: v
+ }
+ });
+ }
}
}
- return '';
- },
+ }
+});
- // private
- beforeUpdate : function(){
- this.grid.stopEditing(true);
- },
+/**
+ * @class Ext.slider.Tip
+ * @extends Ext.tip.Tip
+ * Simple plugin for using an Ext.tip.Tip with a slider to show the slider value. In general this
+ * class is not created directly, instead pass the {@link Ext.slider.Multi#useTips} and
+ * {@link Ext.slider.Multi#tipText} configuration options to the slider directly.
+ * {@img Ext.slider.Tip/Ext.slider.Tip1.png Ext.slider.Tip component}
+ * Example usage:
+
+ Ext.create('Ext.slider.Single', {
+ width: 214,
+ minValue: 0,
+ maxValue: 100,
+ useTips: true,
+ renderTo: Ext.getBody()
+ });
+
+ * Optionally provide your own tip text by passing tipText:
+
+ new Ext.slider.Single({
+ width: 214,
+ minValue: 0,
+ maxValue: 100,
+ useTips: true,
+ tipText: function(thumb){
+ return Ext.String.format('{0}% complete', thumb.value);
+ }
+ });
+
+ * @xtype slidertip
+ */
+Ext.define('Ext.slider.Tip', {
+ extend: 'Ext.tip.Tip',
+ minWidth: 10,
+ alias: 'widget.slidertip',
+ offsets : [0, -10],
+
+ isSliderTip: true,
- // private
- updateHeaders : function(){
- this.innerHd.firstChild.innerHTML = this.renderHeaders();
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = this.getTotalWidth();
+ init: function(slider) {
+ var me = this;
+
+ slider.on({
+ scope : me,
+ dragstart: me.onSlide,
+ drag : me.onSlide,
+ dragend : me.hide,
+ destroy : me.destroy
+ });
},
-
/**
- * Focuses the specified row.
- * @param {Number} row The row index
+ * @private
+ * Called whenever a dragstart or drag event is received on the associated Thumb.
+ * Aligns the Tip with the Thumb's new position.
+ * @param {Ext.slider.MultiSlider} slider The slider
+ * @param {Ext.EventObject} e The Event object
+ * @param {Ext.slider.Thumb} thumb The thumb that the Tip is attached to
*/
- focusRow : function(row){
- this.focusCell(row, 0, false);
+ onSlide : function(slider, e, thumb) {
+ var me = this;
+ me.show();
+ me.update(me.getText(thumb));
+ me.doComponentLayout();
+ me.el.alignTo(thumb.el, 'b-t?', me.offsets);
},
/**
- * Focuses the specified cell.
- * @param {Number} row The row index
- * @param {Number} col The column index
+ * Used to create the text that appears in the Tip's body. By default this just returns
+ * the value of the Slider Thumb that the Tip is attached to. Override to customize.
+ * @param {Ext.slider.Thumb} thumb The Thumb that the Tip is attached to
+ * @return {String} The text to display in the tip
*/
- focusCell : function(row, col, hscroll){
- this.syncFocusEl(this.ensureVisible(row, col, hscroll));
- if(Ext.isGecko){
- this.focusEl.focus();
- }else{
- this.focusEl.focus.defer(1, this.focusEl);
- }
- },
+ getText : function(thumb) {
+ return String(thumb.value);
+ }
+});
+/**
+ * @class Ext.slider.Multi
+ * @extends Ext.form.field.Base
+ * Slider which supports vertical or horizontal orientation, keyboard adjustments, configurable snapping, axis
+ * clicking and animation. Can be added as an item to any container. In addition,
+ * {@img Ext.slider.Multi/Ext.slider.Multi.png Ext.slider.Multi component}
+ *
Example usage:
+ * Sliders can be created with more than one thumb handle by passing an array of values instead of a single one:
+
+ Ext.create('Ext.slider.Multi', {
+ width: 200,
+ values: [25, 50, 75],
+ increment: 5,
+ minValue: 0,
+ maxValue: 100,
+
+ //this defaults to true, setting to false allows the thumbs to pass each other
+ {@link #constrainThumbs}: false,
+ renderTo: Ext.getBody()
+ });
+
+ * @xtype multislider
+ */
+Ext.define('Ext.slider.Multi', {
+ extend: 'Ext.form.field.Base',
+ alias: 'widget.multislider',
+ alternateClassName: 'Ext.slider.MultiSlider',
+
+ requires: [
+ 'Ext.slider.Thumb',
+ 'Ext.slider.Tip',
+ 'Ext.Number',
+ 'Ext.util.Format',
+ 'Ext.Template',
+ 'Ext.layout.component.field.Slider'
+ ],
- resolveCell : function(row, col, hscroll){
- if(!Ext.isNumber(row)){
- row = row.rowIndex;
- }
- if(!this.ds){
- return null;
- }
- if(row < 0 || row >= this.ds.getCount()){
- return null;
+ fieldSubTpl: [
+ ' ',
+ {
+ disableFormats: true,
+ compiled: true
}
- col = (col !== undefined ? col : 0);
+ ],
- var rowEl = this.getRow(row),
- cm = this.cm,
- colCount = cm.getColumnCount(),
- cellEl;
- if(!(hscroll === false && col === 0)){
- while(col < colCount && cm.isHidden(col)){
- col++;
- }
- cellEl = this.getCell(row, col);
- }
+ /**
+ * @cfg {Number} value
+ * A value with which to initialize the slider. Defaults to minValue. Setting this will only
+ * result in the creation of a single slider thumb; if you want multiple thumbs then use the
+ * {@link #values} config instead.
+ */
- return {row: rowEl, cell: cellEl};
- },
+ /**
+ * @cfg {Array} values
+ * Array of Number values with which to initalize the slider. A separate slider thumb will be created for
+ * each value in this array. This will take precedence over the single {@link #value} config.
+ */
- getResolvedXY : function(resolved){
- if(!resolved){
- return null;
- }
- var s = this.scroller.dom, c = resolved.cell, r = resolved.row;
- return c ? Ext.fly(c).getXY() : [this.el.getX(), Ext.fly(r).getY()];
- },
+ /**
+ * @cfg {Boolean} vertical Orient the Slider vertically rather than horizontally, defaults to false.
+ */
+ vertical: false,
+ /**
+ * @cfg {Number} minValue The minimum value for the Slider. Defaults to 0.
+ */
+ minValue: 0,
+ /**
+ * @cfg {Number} maxValue The maximum value for the Slider. Defaults to 100.
+ */
+ maxValue: 100,
+ /**
+ * @cfg {Number/Boolean} decimalPrecision.
+ * The number of decimal places to which to round the Slider's value. Defaults to 0.
+ * To disable rounding, configure as false.
+ */
+ decimalPrecision: 0,
+ /**
+ * @cfg {Number} keyIncrement How many units to change the Slider when adjusting with keyboard navigation. Defaults to 1. If the increment config is larger, it will be used instead.
+ */
+ keyIncrement: 1,
+ /**
+ * @cfg {Number} increment How many units to change the slider when adjusting by drag and drop. Use this option to enable 'snapping'.
+ */
+ increment: 0,
- syncFocusEl : function(row, col, hscroll){
- var xy = row;
- if(!Ext.isArray(xy)){
- row = Math.min(row, Math.max(0, this.getRows().length-1));
- if (isNaN(row)) {
- return;
- }
- xy = this.getResolvedXY(this.resolveCell(row, col, hscroll));
- }
- this.focusEl.setXY(xy||this.scroller.getXY());
- },
+ /**
+ * @private
+ * @property clickRange
+ * @type Array
+ * Determines whether or not a click to the slider component is considered to be a user request to change the value. Specified as an array of [top, bottom],
+ * the click event's 'top' property is compared to these numbers and the click only considered a change request if it falls within them. e.g. if the 'top'
+ * value of the click event is 4 or 16, the click is not considered a change request as it falls outside of the [5, 15] range
+ */
+ clickRange: [5,15],
- ensureVisible : function(row, col, hscroll){
- var resolved = this.resolveCell(row, col, hscroll);
- if(!resolved || !resolved.row){
- return;
- }
+ /**
+ * @cfg {Boolean} clickToChange Determines whether or not clicking on the Slider axis will change the slider. Defaults to true
+ */
+ clickToChange : true,
+ /**
+ * @cfg {Boolean} animate Turn on or off animation. Defaults to true
+ */
+ animate: true,
+
+ /**
+ * True while the thumb is in a drag operation
+ * @type Boolean
+ */
+ dragging: false,
- var rowEl = resolved.row,
- cellEl = resolved.cell,
- c = this.scroller.dom,
- ctop = 0,
- p = rowEl,
- stop = this.el.dom;
+ /**
+ * @cfg {Boolean} constrainThumbs True to disallow thumbs from overlapping one another. Defaults to true
+ */
+ constrainThumbs: true,
- while(p && p != stop){
- ctop += p.offsetTop;
- p = p.offsetParent;
- }
+ componentLayout: 'sliderfield',
- ctop -= this.mainHd.dom.offsetHeight;
- stop = parseInt(c.scrollTop, 10);
+ /**
+ * @cfg {Boolean} useTips
+ * True to use an Ext.slider.Tip to display tips for the value. Defaults to true.
+ */
+ useTips : true,
- var cbot = ctop + rowEl.offsetHeight,
- ch = c.clientHeight,
- sbot = stop + ch;
+ /**
+ * @cfg {Function} tipText
+ * A function used to display custom text for the slider tip. Defaults to null, which will
+ * use the default on the plugin.
+ */
+ tipText : null,
+ ariaRole: 'slider',
- if(ctop < stop){
- c.scrollTop = ctop;
- }else if(cbot > sbot){
- c.scrollTop = cbot-ch;
- }
+ // private override
+ initValue: function() {
+ var me = this,
+ extValue = Ext.value,
+ // Fallback for initial values: values config -> value config -> minValue config -> 0
+ values = extValue(me.values, [extValue(me.value, extValue(me.minValue, 0))]),
+ i = 0,
+ len = values.length;
- if(hscroll !== false){
- var cleft = parseInt(cellEl.offsetLeft, 10);
- var cright = cleft + cellEl.offsetWidth;
+ // Store for use in dirty check
+ me.originalValue = values;
- var sleft = parseInt(c.scrollLeft, 10);
- var sright = sleft + c.clientWidth;
- if(cleft < sleft){
- c.scrollLeft = cleft;
- }else if(cright > sright){
- c.scrollLeft = cright-c.clientWidth;
- }
+ // Add a thumb for each value
+ for (; i < len; i++) {
+ me.addThumb(values[i]);
}
- return this.getResolvedXY(resolved);
},
- // private
- insertRows : function(dm, firstRow, lastRow, isUpdate) {
- var last = dm.getCount() - 1;
- if( !isUpdate && firstRow === 0 && lastRow >= last) {
- this.fireEvent('beforerowsinserted', this, firstRow, lastRow);
- this.refresh();
- this.fireEvent('rowsinserted', this, firstRow, lastRow);
- } else {
- if (!isUpdate) {
- this.fireEvent('beforerowsinserted', this, firstRow, lastRow);
- }
- var html = this.renderRows(firstRow, lastRow),
- before = this.getRow(firstRow);
- if (before) {
- if(firstRow === 0){
- Ext.fly(this.getRow(0)).removeClass(this.firstRowCls);
- }
- Ext.DomHelper.insertHtml('beforeBegin', before, html);
- } else {
- var r = this.getRow(last - 1);
- if(r){
- Ext.fly(r).removeClass(this.lastRowCls);
- }
- Ext.DomHelper.insertHtml('beforeEnd', this.mainBody.dom, html);
- }
- if (!isUpdate) {
- this.fireEvent('rowsinserted', this, firstRow, lastRow);
- this.processRows(firstRow);
- } else if (firstRow === 0 || firstRow >= last) {
- //ensure first/last row is kept after an update.
- Ext.fly(this.getRow(firstRow)).addClass(firstRow === 0 ? this.firstRowCls : this.lastRowCls);
- }
- }
- this.syncFocusEl(firstRow);
- },
+ // private override
+ initComponent : function() {
+ var me = this,
+ tipPlug,
+ hasTip;
+
+ /**
+ * @property thumbs
+ * @type Array
+ * Array containing references to each thumb
+ */
+ me.thumbs = [];
- // private
- deleteRows : function(dm, firstRow, lastRow){
- if(dm.getRowCount()<1){
- this.refresh();
- }else{
- this.fireEvent('beforerowsdeleted', this, firstRow, lastRow);
+ me.keyIncrement = Math.max(me.increment, me.keyIncrement);
- this.removeRows(firstRow, lastRow);
+ me.addEvents(
+ /**
+ * @event beforechange
+ * Fires before the slider value is changed. By returning false from an event handler,
+ * you can cancel the event and prevent the slider from changing.
+ * @param {Ext.slider.Multi} slider The slider
+ * @param {Number} newValue The new value which the slider is being changed to.
+ * @param {Number} oldValue The old value which the slider was previously.
+ */
+ 'beforechange',
- this.processRows(firstRow);
- this.fireEvent('rowsdeleted', this, firstRow, lastRow);
- }
- },
+ /**
+ * @event change
+ * Fires when the slider value is changed.
+ * @param {Ext.slider.Multi} slider The slider
+ * @param {Number} newValue The new value which the slider has been changed to.
+ * @param {Ext.slider.Thumb} thumb The thumb that was changed
+ */
+ 'change',
- // private
- getColumnStyle : function(col, isHeader){
- var style = !isHeader ? (this.cm.config[col].css || '') : '';
- style += 'width:'+this.getColumnWidth(col)+';';
- if(this.cm.isHidden(col)){
- style += 'display:none;';
- }
- var align = this.cm.config[col].align;
- if(align){
- style += 'text-align:'+align+';';
- }
- return style;
- },
+ /**
+ * @event changecomplete
+ * Fires when the slider value is changed by the user and any drag operations have completed.
+ * @param {Ext.slider.Multi} slider The slider
+ * @param {Number} newValue The new value which the slider has been changed to.
+ * @param {Ext.slider.Thumb} thumb The thumb that was changed
+ */
+ 'changecomplete',
- // private
- getColumnWidth : function(col){
- var w = this.cm.getColumnWidth(col);
- if(Ext.isNumber(w)){
- return (Ext.isBorderBox || (Ext.isWebKit && !Ext.isSafari2) ? w : (w - this.borderWidth > 0 ? w - this.borderWidth : 0)) + 'px';
- }
- return w;
- },
+ /**
+ * @event dragstart
+ * Fires after a drag operation has started.
+ * @param {Ext.slider.Multi} slider The slider
+ * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
+ */
+ 'dragstart',
- // private
- getTotalWidth : function(){
- return this.cm.getTotalWidth()+'px';
- },
+ /**
+ * @event drag
+ * Fires continuously during the drag operation while the mouse is moving.
+ * @param {Ext.slider.Multi} slider The slider
+ * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
+ */
+ 'drag',
- // private
- fitColumns : function(preventRefresh, onlyExpand, omitColumn){
- var cm = this.cm, i;
- var tw = cm.getTotalWidth(false);
- var aw = this.grid.getGridEl().getWidth(true)-this.getScrollOffset();
+ /**
+ * @event dragend
+ * Fires after the drag operation has completed.
+ * @param {Ext.slider.Multi} slider The slider
+ * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
+ */
+ 'dragend'
+ );
- if(aw < 20){ // not initialized, so don't screw up the default widths
- return;
+ if (me.vertical) {
+ Ext.apply(me, Ext.slider.Multi.Vertical);
}
- var extra = aw - tw;
- if(extra === 0){
- return false;
- }
+ me.callParent();
- var vc = cm.getColumnCount(true);
- var ac = vc-(Ext.isNumber(omitColumn) ? 1 : 0);
- if(ac === 0){
- ac = 1;
- omitColumn = undefined;
- }
- var colCount = cm.getColumnCount();
- var cols = [];
- var extraCol = 0;
- var width = 0;
- var w;
- for (i = 0; i < colCount; i++){
- if(!cm.isFixed(i) && i !== omitColumn){
- w = cm.getColumnWidth(i);
- cols.push(i, w);
- if(!cm.isHidden(i)){
- extraCol = i;
- width += w;
+ // only can use it if it exists.
+ if (me.useTips) {
+ tipPlug = me.tipText ? {getText: me.tipText} : {};
+ me.plugins = me.plugins || [];
+ Ext.each(me.plugins, function(plug){
+ if (plug.isSliderTip) {
+ hasTip = true;
+ return false;
}
+ });
+ if (!hasTip) {
+ me.plugins.push(Ext.create('Ext.slider.Tip', tipPlug));
}
}
- var frac = (aw - cm.getTotalWidth())/width;
- while (cols.length){
- w = cols.pop();
- i = cols.pop();
- cm.setColumnWidth(i, Math.max(this.grid.minColumnWidth, Math.floor(w + w*frac)), true);
- }
-
- if((tw = cm.getTotalWidth(false)) > aw){
- var adjustCol = ac != vc ? omitColumn : extraCol;
- cm.setColumnWidth(adjustCol, Math.max(1,
- cm.getColumnWidth(adjustCol)- (tw-aw)), true);
- }
-
- if(preventRefresh !== true){
- this.updateAllColumnWidths();
- }
-
-
- return true;
},
- // private
- autoExpand : function(preventUpdate){
- var g = this.grid, cm = this.cm;
- if(!this.userResized && g.autoExpandColumn){
- var tw = cm.getTotalWidth(false);
- var aw = this.grid.getGridEl().getWidth(true)-this.getScrollOffset();
- if(tw != aw){
- var ci = cm.getIndexById(g.autoExpandColumn);
- var currentWidth = cm.getColumnWidth(ci);
- var cw = Math.min(Math.max(((aw-tw)+currentWidth), g.autoExpandMin), g.autoExpandMax);
- if(cw != currentWidth){
- cm.setColumnWidth(ci, cw, true);
- if(preventUpdate !== true){
- this.updateColumnWidth(ci, cw);
- }
- }
- }
+ /**
+ * Creates a new thumb and adds it to the slider
+ * @param {Number} value The initial value to set on the thumb. Defaults to 0
+ * @return {Ext.slider.Thumb} The thumb
+ */
+ addThumb: function(value) {
+ var me = this,
+ thumb = Ext.create('Ext.slider.Thumb', {
+ value : value,
+ slider : me,
+ index : me.thumbs.length,
+ constrain: me.constrainThumbs
+ });
+ me.thumbs.push(thumb);
+
+ //render the thumb now if needed
+ if (me.rendered) {
+ thumb.render();
}
+
+ return thumb;
},
/**
* @private
- * Returns an array of column configurations - one for each column
- * @return {Array} Array of column config objects. This includes the column name, renderer, id style and renderer
+ * Moves the given thumb above all other by increasing its z-index. This is called when as drag
+ * any thumb, so that the thumb that was just dragged is always at the highest z-index. This is
+ * required when the thumbs are stacked on top of each other at one of the ends of the slider's
+ * range, which can result in the user not being able to move any of them.
+ * @param {Ext.slider.Thumb} topThumb The thumb to move to the top
*/
- getColumnData : function(){
- // build a map for all the columns
- var cs = [],
- cm = this.cm,
- colCount = cm.getColumnCount();
-
- for (var i = 0; i < colCount; i++) {
- var name = cm.getDataIndex(i);
+ promoteThumb: function(topThumb) {
+ var thumbs = this.thumbs,
+ ln = thumbs.length,
+ zIndex, thumb, i;
+
+ for (i = 0; i < ln; i++) {
+ thumb = thumbs[i];
- cs[i] = {
- name : (!Ext.isDefined(name) ? this.ds.fields.get(i).name : name),
- renderer: cm.getRenderer(i),
- scope : cm.getRendererScope(i),
- id : cm.getColumnId(i),
- style : this.getColumnStyle(i)
- };
+ if (thumb == topThumb) {
+ thumb.bringToFront();
+ } else {
+ thumb.sendToBack();
+ }
}
-
- return cs;
},
- // private
- renderRows : function(startRow, endRow){
- // pull in all the crap needed to render rows
- var g = this.grid, cm = g.colModel, ds = g.store, stripe = g.stripeRows;
- var colCount = cm.getColumnCount();
-
- if(ds.getCount() < 1){
- return '';
- }
+ // private override
+ onRender : function() {
+ var me = this,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ thumb;
- var cs = this.getColumnData();
+ Ext.applyIf(me.subTplData, {
+ vertical: me.vertical ? Ext.baseCSSPrefix + 'slider-vert' : Ext.baseCSSPrefix + 'slider-horz',
+ minValue: me.minValue,
+ maxValue: me.maxValue,
+ value: me.value
+ });
- startRow = startRow || 0;
- endRow = !Ext.isDefined(endRow) ? ds.getCount()-1 : endRow;
+ Ext.applyIf(me.renderSelectors, {
+ endEl: '.' + Ext.baseCSSPrefix + 'slider-end',
+ innerEl: '.' + Ext.baseCSSPrefix + 'slider-inner',
+ focusEl: '.' + Ext.baseCSSPrefix + 'slider-focus'
+ });
- // records to render
- var rs = ds.getRange(startRow, endRow);
+ me.callParent(arguments);
- return this.doRender(cs, rs, ds, startRow, colCount, stripe);
- },
+ //render each thumb
+ for (; i < len; i++) {
+ thumbs[i].render();
+ }
- // private
- renderBody : function(){
- var markup = this.renderRows() || ' ';
- return this.templates.body.apply({rows: markup});
- },
+ //calculate the size of half a thumb
+ thumb = me.innerEl.down('.' + Ext.baseCSSPrefix + 'slider-thumb');
+ me.halfThumb = (me.vertical ? thumb.getHeight() : thumb.getWidth()) / 2;
- // private
- refreshRow : function(record){
- var ds = this.ds, index;
- if(Ext.isNumber(record)){
- index = record;
- record = ds.getAt(index);
- if(!record){
- return;
- }
- }else{
- index = ds.indexOf(record);
- if(index < 0){
- return;
- }
- }
- this.insertRows(ds, index, index, true);
- this.getRow(index).rowIndex = index;
- this.onRemove(ds, record, index+1, true);
- this.fireEvent('rowupdated', this, index, record);
},
/**
- * Refreshs the grid UI
- * @param {Boolean} headersToo (optional) True to also refresh the headers
+ * Utility method to set the value of the field when the slider changes.
+ * @param {Object} slider The slider object.
+ * @param {Object} v The new value.
+ * @private
*/
- refresh : function(headersToo){
- this.fireEvent('beforerefresh', this);
- this.grid.stopEditing(true);
-
- var result = this.renderBody();
- this.mainBody.update(result).setWidth(this.getTotalWidth());
- if(headersToo === true){
- this.updateHeaders();
- this.updateHeaderSortState();
- }
- this.processRows(0, true);
- this.layout();
- this.applyEmptyText();
- this.fireEvent('refresh', this);
+ onChange : function(slider, v) {
+ this.setValue(v, undefined, true);
},
/**
* @private
- * Displays the configured emptyText if there are currently no rows to display
+ * Adds keyboard and mouse listeners on this.el. Ignores click events on the internal focus element.
*/
- applyEmptyText : function(){
- if(this.emptyText && !this.hasRows()){
- this.mainBody.update('' + this.emptyText + '');
- }
+ initEvents : function() {
+ var me = this;
+
+ me.mon(me.el, {
+ scope : me,
+ mousedown: me.onMouseDown,
+ keydown : me.onKeyDown,
+ change : me.onChange
+ });
+
+ me.focusEl.swallowEvent("click", true);
},
/**
* @private
- * Adds sorting classes to the column headers based on the bound store's sortInfo. Fires the 'sortchange' event
- * if the sorting has changed since this function was last run.
+ * Mousedown handler for the slider. If the clickToChange is enabled and the click was not on the draggable 'thumb',
+ * this calculates the new value of the slider and tells the implementation (Horizontal or Vertical) to move the thumb
+ * @param {Ext.EventObject} e The click event
*/
- updateHeaderSortState : function(){
- var state = this.ds.getSortState();
- if (!state) {
+ onMouseDown : function(e) {
+ var me = this,
+ thumbClicked = false,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ local;
+
+ if (me.disabled) {
return;
}
- if (!this.sortState || (this.sortState.field != state.field || this.sortState.direction != state.direction)) {
- this.grid.fireEvent('sortchange', this.grid, state);
+ //see if the click was on any of the thumbs
+ for (; i < len; i++) {
+ thumbClicked = thumbClicked || e.target == thumbs[i].el.dom;
}
- this.sortState = state;
-
- var sortColumn = this.cm.findColumnIndex(state.field);
- if (sortColumn != -1){
- var sortDir = state.direction;
- this.updateSortIcon(sortColumn, sortDir);
+ if (me.clickToChange && !thumbClicked) {
+ local = me.innerEl.translatePoints(e.getXY());
+ me.onClickChange(local);
}
+ me.focus();
},
/**
* @private
- * Removes any sorting indicator classes from the column headers
+ * Moves the thumb to the indicated position. Note that a Vertical implementation is provided in Ext.slider.Multi.Vertical.
+ * Only changes the value if the click was within this.clickRange.
+ * @param {Object} local Object containing top and left values for the click event.
*/
- clearHeaderSortState : function(){
- if (!this.sortState) {
- return;
+ onClickChange : function(local) {
+ var me = this,
+ thumb, index;
+
+ if (local.top > me.clickRange[0] && local.top < me.clickRange[1]) {
+ //find the nearest thumb to the click event
+ thumb = me.getNearest(local, 'left');
+ if (!thumb.disabled) {
+ index = thumb.index;
+ me.setValue(index, Ext.util.Format.round(me.reverseValue(local.left), me.decimalPrecision), undefined, true);
+ }
}
- this.grid.fireEvent('sortchange', this.grid, null);
- this.mainHd.select('td').removeClass(this.sortClasses);
- delete this.sortState;
},
- // private
- destroy : function(){
- if (this.scrollToTopTask && this.scrollToTopTask.cancel){
- this.scrollToTopTask.cancel();
- }
- if(this.colMenu){
- Ext.menu.MenuMgr.unregister(this.colMenu);
- this.colMenu.destroy();
- delete this.colMenu;
- }
- if(this.hmenu){
- Ext.menu.MenuMgr.unregister(this.hmenu);
- this.hmenu.destroy();
- delete this.hmenu;
- }
+ /**
+ * @private
+ * Returns the nearest thumb to a click event, along with its distance
+ * @param {Object} local Object containing top and left values from a click event
+ * @param {String} prop The property of local to compare on. Use 'left' for horizontal sliders, 'top' for vertical ones
+ * @return {Object} The closest thumb object and its distance from the click event
+ */
+ getNearest: function(local, prop) {
+ var me = this,
+ localValue = prop == 'top' ? me.innerEl.getHeight() - local[prop] : local[prop],
+ clickValue = me.reverseValue(localValue),
+ nearestDistance = (me.maxValue - me.minValue) + 5, //add a small fudge for the end of the slider
+ index = 0,
+ nearest = null,
+ thumbs = me.thumbs,
+ i = 0,
+ len = thumbs.length,
+ thumb,
+ value,
+ dist;
- this.initData(null, null);
- this.purgeListeners();
- Ext.fly(this.innerHd).un("click", this.handleHdDown, this);
+ for (; i < len; i++) {
+ thumb = me.thumbs[i];
+ value = thumb.value;
+ dist = Math.abs(value - clickValue);
- if(this.grid.enableColumnMove){
- Ext.destroy(
- this.columnDrag.el,
- this.columnDrag.proxy.ghost,
- this.columnDrag.proxy.el,
- this.columnDrop.el,
- this.columnDrop.proxyTop,
- this.columnDrop.proxyBottom,
- this.columnDrag.dragData.ddel,
- this.columnDrag.dragData.header
- );
- if (this.columnDrag.proxy.anim) {
- Ext.destroy(this.columnDrag.proxy.anim);
+ if (Math.abs(dist <= nearestDistance)) {
+ nearest = thumb;
+ index = i;
+ nearestDistance = dist;
}
- delete this.columnDrag.proxy.ghost;
- delete this.columnDrag.dragData.ddel;
- delete this.columnDrag.dragData.header;
- this.columnDrag.destroy();
- delete Ext.dd.DDM.locationCache[this.columnDrag.id];
- delete this.columnDrag._domRef;
-
- delete this.columnDrop.proxyTop;
- delete this.columnDrop.proxyBottom;
- this.columnDrop.destroy();
- delete Ext.dd.DDM.locationCache["gridHeader" + this.grid.getGridEl().id];
- delete this.columnDrop._domRef;
- delete Ext.dd.DDM.ids[this.columnDrop.ddGroup];
}
+ return nearest;
+ },
- if (this.splitZone){ // enableColumnResize
- this.splitZone.destroy();
- delete this.splitZone._domRef;
- delete Ext.dd.DDM.ids["gridSplitters" + this.grid.getGridEl().id];
+ /**
+ * @private
+ * Handler for any keypresses captured by the slider. If the key is UP or RIGHT, the thumb is moved along to the right
+ * by this.keyIncrement. If DOWN or LEFT it is moved left. Pressing CTRL moves the slider to the end in either direction
+ * @param {Ext.EventObject} e The Event object
+ */
+ onKeyDown : function(e) {
+ /*
+ * The behaviour for keyboard handling with multiple thumbs is currently undefined.
+ * There's no real sane default for it, so leave it like this until we come up
+ * with a better way of doing it.
+ */
+ var me = this,
+ k,
+ val;
+
+ if(me.disabled || me.thumbs.length !== 1) {
+ e.preventDefault();
+ return;
}
-
- Ext.fly(this.innerHd).removeAllListeners();
- Ext.removeNode(this.innerHd);
- delete this.innerHd;
-
- Ext.destroy(
- this.el,
- this.mainWrap,
- this.mainHd,
- this.scroller,
- this.mainBody,
- this.focusEl,
- this.resizeMarker,
- this.resizeProxy,
- this.activeHdBtn,
- this.dragZone,
- this.splitZone,
- this._flyweight
- );
-
- delete this.grid.container;
-
- if(this.dragZone){
- this.dragZone.destroy();
+ k = e.getKey();
+
+ switch(k) {
+ case e.UP:
+ case e.RIGHT:
+ e.stopEvent();
+ val = e.ctrlKey ? me.maxValue : me.getValue(0) + me.keyIncrement;
+ me.setValue(0, val, undefined, true);
+ break;
+ case e.DOWN:
+ case e.LEFT:
+ e.stopEvent();
+ val = e.ctrlKey ? me.minValue : me.getValue(0) - me.keyIncrement;
+ me.setValue(0, val, undefined, true);
+ break;
+ default:
+ e.preventDefault();
}
-
- Ext.dd.DDM.currentTarget = null;
- delete Ext.dd.DDM.locationCache[this.grid.getGridEl().id];
-
- Ext.EventManager.removeResizeListener(this.onWindowResize, this);
- },
-
- // private
- onDenyColumnHide : function(){
-
},
- // private
- render : function(){
- if(this.autoFill){
- var ct = this.grid.ownerCt;
- if (ct && ct.getLayout()){
- ct.on('afterlayout', function(){
- this.fitColumns(true, true);
- this.updateHeaders();
- }, this, {single: true});
- }else{
- this.fitColumns(true, true);
+ /**
+ * @private
+ * If using snapping, this takes a desired new value and returns the closest snapped
+ * value to it
+ * @param {Number} value The unsnapped value
+ * @return {Number} The value of the nearest snap target
+ */
+ doSnap : function(value) {
+ var newValue = value,
+ inc = this.increment,
+ m;
+
+ if (!(inc && value)) {
+ return value;
+ }
+ m = value % inc;
+ if (m !== 0) {
+ newValue -= m;
+ if (m * 2 >= inc) {
+ newValue += inc;
+ } else if (m * 2 < -inc) {
+ newValue -= inc;
}
- }else if(this.forceFit){
- this.fitColumns(true, false);
- }else if(this.grid.autoExpandColumn){
- this.autoExpand(true);
}
-
- this.renderUI();
+ return Ext.Number.constrain(newValue, this.minValue, this.maxValue);
},
- /* --------------------------------- Model Events and Handlers --------------------------------*/
// private
- initData : function(ds, cm){
- if(this.ds){
- this.ds.un('load', this.onLoad, this);
- this.ds.un('datachanged', this.onDataChange, this);
- this.ds.un('add', this.onAdd, this);
- this.ds.un('remove', this.onRemove, this);
- this.ds.un('update', this.onUpdate, this);
- this.ds.un('clear', this.onClear, this);
- if(this.ds !== ds && this.ds.autoDestroy){
- this.ds.destroy();
- }
- }
- if(ds){
- ds.on({
- scope: this,
- load: this.onLoad,
- datachanged: this.onDataChange,
- add: this.onAdd,
- remove: this.onRemove,
- update: this.onUpdate,
- clear: this.onClear
- });
- }
- this.ds = ds;
+ afterRender : function() {
+ var me = this,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ thumb,
+ v;
+
+ me.callParent(arguments);
- if(this.cm){
- this.cm.un('configchange', this.onColConfigChange, this);
- this.cm.un('widthchange', this.onColWidthChange, this);
- this.cm.un('headerchange', this.onHeaderChange, this);
- this.cm.un('hiddenchange', this.onHiddenChange, this);
- this.cm.un('columnmoved', this.onColumnMove, this);
- }
- if(cm){
- delete this.lastViewWidth;
- cm.on({
- scope: this,
- configchange: this.onColConfigChange,
- widthchange: this.onColWidthChange,
- headerchange: this.onHeaderChange,
- hiddenchange: this.onHiddenChange,
- columnmoved: this.onColumnMove
- });
- }
- this.cm = cm;
- },
+ for (; i < len; i++) {
+ thumb = thumbs[i];
- // private
- onDataChange : function(){
- this.refresh();
- this.updateHeaderSortState();
- this.syncFocusEl(0);
+ if (thumb.value !== undefined) {
+ v = me.normalizeValue(thumb.value);
+ if (v !== thumb.value) {
+ // delete this.value;
+ me.setValue(i, v, false);
+ } else {
+ thumb.move(me.translateValue(v), false);
+ }
+ }
+ }
},
- // private
- onClear : function(){
- this.refresh();
- this.syncFocusEl(0);
+ /**
+ * @private
+ * Returns the ratio of pixels to mapped values. e.g. if the slider is 200px wide and maxValue - minValue is 100,
+ * the ratio is 2
+ * @return {Number} The ratio of pixels to mapped values
+ */
+ getRatio : function() {
+ var w = this.innerEl.getWidth(),
+ v = this.maxValue - this.minValue;
+ return v === 0 ? w : (w/v);
},
- // private
- onUpdate : function(ds, record){
- this.refreshRow(record);
+ /**
+ * @private
+ * Returns a snapped, constrained value when given a desired value
+ * @param {Number} value Raw number value
+ * @return {Number} The raw value rounded to the correct d.p. and constrained within the set max and min values
+ */
+ normalizeValue : function(v) {
+ var me = this;
+
+ v = me.doSnap(v);
+ v = Ext.util.Format.round(v, me.decimalPrecision);
+ v = Ext.Number.constrain(v, me.minValue, me.maxValue);
+ return v;
},
- // private
- onAdd : function(ds, records, index){
- this.insertRows(ds, index, index + (records.length-1));
- },
+ /**
+ * Sets the minimum value for the slider instance. If the current value is less than the
+ * minimum value, the current value will be changed.
+ * @param {Number} val The new minimum value
+ */
+ setMinValue : function(val) {
+ var me = this,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ t;
+
+ me.minValue = val;
+ me.inputEl.dom.setAttribute('aria-valuemin', val);
- // private
- onRemove : function(ds, record, index, isUpdate){
- if(isUpdate !== true){
- this.fireEvent('beforerowremoved', this, index, record);
- }
- this.removeRow(index);
- if(isUpdate !== true){
- this.processRows(index);
- this.applyEmptyText();
- this.fireEvent('rowremoved', this, index, record);
+ for (; i < len; ++i) {
+ t = thumbs[i];
+ t.value = t.value < val ? val : t.value;
}
+ me.syncThumbs();
},
- // private
- onLoad : function(){
- if (Ext.isGecko){
- if (!this.scrollToTopTask) {
- this.scrollToTopTask = new Ext.util.DelayedTask(this.scrollToTop, this);
- }
- this.scrollToTopTask.delay(1);
- }else{
- this.scrollToTop();
- }
- },
+ /**
+ * Sets the maximum value for the slider instance. If the current value is more than the
+ * maximum value, the current value will be changed.
+ * @param {Number} val The new maximum value
+ */
+ setMaxValue : function(val) {
+ var me = this,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ t;
+
+ me.maxValue = val;
+ me.inputEl.dom.setAttribute('aria-valuemax', val);
- // private
- onColWidthChange : function(cm, col, width){
- this.updateColumnWidth(col, width);
+ for (; i < len; ++i) {
+ t = thumbs[i];
+ t.value = t.value > val ? val : t.value;
+ }
+ me.syncThumbs();
},
- // private
- onHeaderChange : function(cm, col, text){
- this.updateHeaders();
- },
+ /**
+ * Programmatically sets the value of the Slider. Ensures that the value is constrained within
+ * the minValue and maxValue.
+ * @param {Number} index Index of the thumb to move
+ * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
+ * @param {Boolean} animate Turn on or off animation, defaults to true
+ */
+ setValue : function(index, value, animate, changeComplete) {
+ var me = this,
+ thumb = me.thumbs[index];
+
+ // ensures value is contstrained and snapped
+ value = me.normalizeValue(value);
+
+ if (value !== thumb.value && me.fireEvent('beforechange', me, value, thumb.value, thumb) !== false) {
+ thumb.value = value;
+ if (me.rendered) {
+ // TODO this only handles a single value; need a solution for exposing multiple values to aria.
+ // Perhaps this should go on each thumb element rather than the outer element.
+ me.inputEl.set({
+ 'aria-valuenow': value,
+ 'aria-valuetext': value
+ });
- // private
- onHiddenChange : function(cm, col, hidden){
- this.updateColumnHidden(col, hidden);
- },
+ thumb.move(me.translateValue(value), Ext.isDefined(animate) ? animate !== false : me.animate);
- // private
- onColumnMove : function(cm, oldIndex, newIndex){
- this.indexMap = null;
- var s = this.getScrollState();
- this.refresh(true);
- this.restoreScroll(s);
- this.afterMove(newIndex);
- this.grid.fireEvent('columnmove', oldIndex, newIndex);
+ me.fireEvent('change', me, value, thumb);
+ if (changeComplete) {
+ me.fireEvent('changecomplete', me, value, thumb);
+ }
+ }
+ }
},
- // private
- onColConfigChange : function(){
- delete this.lastViewWidth;
- this.indexMap = null;
- this.refresh(true);
+ /**
+ * @private
+ */
+ translateValue : function(v) {
+ var ratio = this.getRatio();
+ return (v * ratio) - (this.minValue * ratio) - this.halfThumb;
},
- /* -------------------- UI Events and Handlers ------------------------------ */
- // private
- initUI : function(grid){
- grid.on('headerclick', this.onHeaderClick, this);
+ /**
+ * @private
+ * Given a pixel location along the slider, returns the mapped slider value for that pixel.
+ * E.g. if we have a slider 200px wide with minValue = 100 and maxValue = 500, reverseValue(50)
+ * returns 200
+ * @param {Number} pos The position along the slider to return a mapped value for
+ * @return {Number} The mapped value for the given position
+ */
+ reverseValue : function(pos) {
+ var ratio = this.getRatio();
+ return (pos + (this.minValue * ratio)) / ratio;
},
// private
- initEvents : function(){
+ focus : function() {
+ this.focusEl.focus(10);
},
- // private
- onHeaderClick : function(g, index){
- if(this.headersDisabled || !this.cm.isSortable(index)){
- return;
- }
- g.stopEditing(true);
- g.store.sort(this.cm.getDataIndex(index));
- },
+ //private
+ onDisable: function() {
+ var me = this,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ thumb,
+ el,
+ xy;
+
+ me.callParent();
- // private
- onRowOver : function(e, t){
- var row;
- if((row = this.findRowIndex(t)) !== false){
- this.addRowClass(row, 'x-grid3-row-over');
- }
- },
+ for (; i < len; i++) {
+ thumb = thumbs[i];
+ el = thumb.el;
- // private
- onRowOut : function(e, t){
- var row;
- if((row = this.findRowIndex(t)) !== false && !e.within(this.getRow(row), true)){
- this.removeRowClass(row, 'x-grid3-row-over');
- }
- },
+ thumb.disable();
- // private
- handleWheel : function(e){
- e.stopPropagation();
- },
+ if(Ext.isIE) {
+ //IE breaks when using overflow visible and opacity other than 1.
+ //Create a place holder for the thumb and display it.
+ xy = el.getXY();
+ el.hide();
- // private
- onRowSelect : function(row){
- this.addRowClass(row, this.selectedRowClass);
- },
+ me.innerEl.addCls(me.disabledCls).dom.disabled = true;
- // private
- onRowDeselect : function(row){
- this.removeRowClass(row, this.selectedRowClass);
- },
+ if (!me.thumbHolder) {
+ me.thumbHolder = me.endEl.createChild({cls: Ext.baseCSSPrefix + 'slider-thumb ' + me.disabledCls});
+ }
- // private
- onCellSelect : function(row, col){
- var cell = this.getCell(row, col);
- if(cell){
- this.fly(cell).addClass('x-grid3-cell-selected');
+ me.thumbHolder.show().setXY(xy);
+ }
}
},
- // private
- onCellDeselect : function(row, col){
- var cell = this.getCell(row, col);
- if(cell){
- this.fly(cell).removeClass('x-grid3-cell-selected');
- }
- },
+ //private
+ onEnable: function() {
+ var me = this,
+ i = 0,
+ thumbs = me.thumbs,
+ len = thumbs.length,
+ thumb,
+ el;
+
+ this.callParent();
- // private
- onColumnSplitterMoved : function(i, w){
- this.userResized = true;
- var cm = this.grid.colModel;
- cm.setColumnWidth(i, w, true);
-
- if(this.forceFit){
- this.fitColumns(true, false, i);
- this.updateAllColumnWidths();
- }else{
- this.updateColumnWidth(i, w);
- this.syncHeaderScroll();
- }
+ for (; i < len; i++) {
+ thumb = thumbs[i];
+ el = thumb.el;
- this.grid.fireEvent('columnresize', i, w);
- },
+ thumb.enable();
- // private
- handleHdMenuClick : function(item){
- var index = this.hdCtxIndex,
- cm = this.cm,
- ds = this.ds,
- id = item.getItemId();
- switch(id){
- case 'asc':
- ds.sort(cm.getDataIndex(index), 'ASC');
- break;
- case 'desc':
- ds.sort(cm.getDataIndex(index), 'DESC');
- break;
- default:
- index = cm.getIndexById(id.substr(4));
- if(index != -1){
- if(item.checked && cm.getColumnsBy(this.isHideableColumn, this).length <= 1){
- this.onDenyColumnHide();
- return false;
- }
- cm.setHidden(index, item.checked);
+ if (Ext.isIE) {
+ me.innerEl.removeCls(me.disabledCls).dom.disabled = false;
+
+ if (me.thumbHolder) {
+ me.thumbHolder.hide();
}
+
+ el.show();
+ me.syncThumbs();
+ }
}
- return true;
},
- // private
- isHideableColumn : function(c){
- return !c.hidden;
- },
+ /**
+ * Synchronizes thumbs position to the proper proportion of the total component width based
+ * on the current slider {@link #value}. This will be called automatically when the Slider
+ * is resized by a layout, but if it is rendered auto width, this method can be called from
+ * another resize handler to sync the Slider if necessary.
+ */
+ syncThumbs : function() {
+ if (this.rendered) {
+ var thumbs = this.thumbs,
+ length = thumbs.length,
+ i = 0;
- // private
- beforeColMenuShow : function(){
- var cm = this.cm, colCount = cm.getColumnCount();
- this.colMenu.removeAll();
- for(var i = 0; i < colCount; i++){
- if(cm.config[i].hideable !== false){
- this.colMenu.add(new Ext.menu.CheckItem({
- itemId: 'col-'+cm.getColumnId(i),
- text: cm.getColumnHeader(i),
- checked: !cm.isHidden(i),
- hideOnClick:false,
- disabled: cm.config[i].hideable === false
- }));
+ for (; i < length; i++) {
+ thumbs[i].move(this.translateValue(thumbs[i].value));
}
}
},
- // private
- handleHdDown : function(e, t){
- if(Ext.fly(t).hasClass('x-grid3-hd-btn')){
- e.stopEvent();
- var hd = this.findHeaderCell(t);
- Ext.fly(hd).addClass('x-grid3-hd-menu-open');
- var index = this.getCellIndex(hd);
- this.hdCtxIndex = index;
- var ms = this.hmenu.items, cm = this.cm;
- ms.get('asc').setDisabled(!cm.isSortable(index));
- ms.get('desc').setDisabled(!cm.isSortable(index));
- this.hmenu.on('hide', function(){
- Ext.fly(hd).removeClass('x-grid3-hd-menu-open');
- }, this, {single:true});
- this.hmenu.show(t, 'tl-bl?');
- }
+ /**
+ * Returns the current value of the slider
+ * @param {Number} index The index of the thumb to return a value for
+ * @return {Number/Array} The current value of the slider at the given index, or an array of
+ * all thumb values if no index is given.
+ */
+ getValue : function(index) {
+ return Ext.isNumber(index) ? this.thumbs[index].value : this.getValues();
},
- // private
- handleHdOver : function(e, t){
- var hd = this.findHeaderCell(t);
- if(hd && !this.headersDisabled){
- this.activeHdRef = t;
- this.activeHdIndex = this.getCellIndex(hd);
- var fly = this.fly(hd);
- this.activeHdRegion = fly.getRegion();
- if(!this.cm.isMenuDisabled(this.activeHdIndex)){
- fly.addClass('x-grid3-hd-over');
- this.activeHdBtn = fly.child('.x-grid3-hd-btn');
- if(this.activeHdBtn){
- this.activeHdBtn.dom.style.height = (hd.firstChild.offsetHeight-1)+'px';
- }
- }
+ /**
+ * Returns an array of values - one for the location of each thumb
+ * @return {Array} The set of thumb values
+ */
+ getValues: function() {
+ var values = [],
+ i = 0,
+ thumbs = this.thumbs,
+ len = thumbs.length;
+
+ for (; i < len; i++) {
+ values.push(thumbs[i].value);
}
+
+ return values;
},
- // private
- handleHdMove : function(e, t){
- var hd = this.findHeaderCell(this.activeHdRef);
- if(hd && !this.headersDisabled){
- var hw = this.splitHandleWidth || 5,
- r = this.activeHdRegion,
- x = e.getPageX(),
- ss = hd.style,
- cur = '';
- if(this.grid.enableColumnResize !== false){
- if(x - r.left <= hw && this.cm.isResizable(this.activeHdIndex-1)){
- cur = Ext.isAir ? 'move' : Ext.isWebKit ? 'e-resize' : 'col-resize'; // col-resize not always supported
- }else if(r.right - x <= (!this.activeHdBtn ? hw : 2) && this.cm.isResizable(this.activeHdIndex)){
- cur = Ext.isAir ? 'move' : Ext.isWebKit ? 'w-resize' : 'col-resize';
- }
- }
- ss.cursor = cur;
- }
+ getSubmitValue: function() {
+ var me = this;
+ return (me.disabled || !me.submitValue) ? null : me.getValue();
},
- // private
- handleHdOut : function(e, t){
- var hd = this.findHeaderCell(t);
- if(hd && (!Ext.isIE || !e.within(hd, true))){
- this.activeHdRef = null;
- this.fly(hd).removeClass('x-grid3-hd-over');
- hd.style.cursor = '';
- }
+ reset: function() {
+ var me = this,
+ Array = Ext.Array;
+ Array.forEach(Array.from(me.originalValue), function(val, i) {
+ me.setValue(i, val);
+ });
+ me.clearInvalid();
+ // delete here so we reset back to the original state
+ delete me.wasValid;
},
// private
- hasRows : function(){
- var fc = this.mainBody.dom.firstChild;
- return fc && fc.nodeType == 1 && fc.className != 'x-grid-empty';
- },
+ beforeDestroy : function() {
+ var me = this;
+
+ Ext.destroyMembers(me.innerEl, me.endEl, me.focusEl);
+ Ext.each(me.thumbs, function(thumb) {
+ Ext.destroy(thumb);
+ }, me);
- // back compat
- bind : function(d, c){
- this.initData(d, c);
- }
-});
+ me.callParent();
+ },
+ statics: {
+ // Method overrides to support slider with vertical orientation
+ Vertical: {
+ getRatio : function() {
+ var h = this.innerEl.getHeight(),
+ v = this.maxValue - this.minValue;
+ return h/v;
+ },
-// private
-// This is a support class used internally by the Grid components
-Ext.grid.GridView.SplitDragZone = Ext.extend(Ext.dd.DDProxy, {
-
- constructor: function(grid, hd){
- this.grid = grid;
- this.view = grid.getView();
- this.marker = this.view.resizeMarker;
- this.proxy = this.view.resizeProxy;
- Ext.grid.GridView.SplitDragZone.superclass.constructor.call(this, hd,
- 'gridSplitters' + this.grid.getGridEl().id, {
- dragElId : Ext.id(this.proxy.dom), resizeFrame:false
- });
- this.scroll = false;
- this.hw = this.view.splitHandleWidth || 5;
- },
-
- b4StartDrag : function(x, y){
- this.dragHeadersDisabled = this.view.headersDisabled;
- this.view.headersDisabled = true;
- var h = this.view.mainWrap.getHeight();
- this.marker.setHeight(h);
- this.marker.show();
- this.marker.alignTo(this.view.getHeaderCell(this.cellIndex), 'tl-tl', [-2, 0]);
- this.proxy.setHeight(h);
- var w = this.cm.getColumnWidth(this.cellIndex),
- minw = Math.max(w-this.grid.minColumnWidth, 0);
- this.resetConstraints();
- this.setXConstraint(minw, 1000);
- this.setYConstraint(0, 0);
- this.minX = x - minw;
- this.maxX = x + 1000;
- this.startPos = x;
- Ext.dd.DDProxy.prototype.b4StartDrag.call(this, x, y);
- },
+ onClickChange : function(local) {
+ var me = this,
+ thumb, index, bottom;
- allowHeaderDrag : function(e){
- return true;
- },
+ if (local.left > me.clickRange[0] && local.left < me.clickRange[1]) {
+ thumb = me.getNearest(local, 'top');
+ if (!thumb.disabled) {
+ index = thumb.index;
+ bottom = me.reverseValue(me.innerEl.getHeight() - local.top);
- handleMouseDown : function(e){
- var t = this.view.findHeaderCell(e.getTarget());
- if(t && this.allowHeaderDrag(e)){
- var xy = this.view.fly(t).getXY(),
- x = xy[0],
- y = xy[1],
- exy = e.getXY(), ex = exy[0],
- w = t.offsetWidth, adjust = false;
-
- if((ex - x) <= this.hw){
- adjust = -1;
- }else if((x+w) - ex <= this.hw){
- adjust = 0;
- }
- if(adjust !== false){
- this.cm = this.grid.colModel;
- var ci = this.view.getCellIndex(t);
- if(adjust == -1){
- if (ci + adjust < 0) {
- return;
- }
- while(this.cm.isHidden(ci+adjust)){
- --adjust;
- if(ci+adjust < 0){
- return;
- }
+ me.setValue(index, Ext.util.Format.round(me.minValue + bottom, me.decimalPrecision), undefined, true);
}
}
- this.cellIndex = ci+adjust;
- this.split = t.dom;
- if(this.cm.isResizable(this.cellIndex) && !this.cm.isFixed(this.cellIndex)){
- Ext.grid.GridView.SplitDragZone.superclass.handleMouseDown.apply(this, arguments);
- }
- }else if(this.view.columnDrag){
- this.view.columnDrag.callHandleMouseDown(e);
}
}
+ }
+});
+
+/**
+ * @class Ext.slider.Single
+ * @extends Ext.slider.Multi
+ * Slider which supports vertical or horizontal orientation, keyboard adjustments,
+ * configurable snapping, axis clicking and animation. Can be added as an item to
+ * any container.
+ * {@img Ext.slider.Single/Ext.slider.Single.png Ext.slider.Single component}
+ * Example usage:
+
+ Ext.create('Ext.slider.Single', {
+ width: 200,
+ value: 50,
+ increment: 10,
+ minValue: 0,
+ maxValue: 100,
+ renderTo: Ext.getBody()
+ });
+
+ * The class Ext.slider.Single is aliased to Ext.Slider for backwards compatibility.
+ * @xtype slider
+ */
+Ext.define('Ext.slider.Single', {
+ extend: 'Ext.slider.Multi',
+ alias: ['widget.slider', 'widget.sliderfield'],
+ alternateClassName: ['Ext.Slider', 'Ext.form.SliderField', 'Ext.slider.SingleSlider', 'Ext.slider.Slider'],
+
+ /**
+ * Returns the current value of the slider
+ * @return {Number} The current value of the slider
+ */
+ getValue: function() {
+ //just returns the value of the first thumb, which should be the only one in a single slider
+ return this.callParent([0]);
},
- endDrag : function(e){
- this.marker.hide();
- var v = this.view,
- endX = Math.max(this.minX, e.getPageX()),
- diff = endX - this.startPos,
- disabled = this.dragHeadersDisabled;
-
- v.onColumnSplitterMoved(this.cellIndex, this.cm.getColumnWidth(this.cellIndex)+diff);
- setTimeout(function(){
- v.headersDisabled = disabled;
- }, 50);
+ /**
+ * Programmatically sets the value of the Slider. Ensures that the value is constrained within
+ * the minValue and maxValue.
+ * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
+ * @param {Boolean} animate Turn on or off animation, defaults to true
+ */
+ setValue: function(value, animate) {
+ var args = Ext.toArray(arguments),
+ len = args.length;
+
+ //this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
+ //index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
+ //signature without the required index. The index will always be 0 for a single slider
+ if (len == 1 || (len <= 3 && typeof arguments[1] != 'number')) {
+ args.unshift(0);
+ }
+
+ return this.callParent(args);
},
- autoOffset : function(){
- this.setDelta(0,0);
+ // private
+ getNearest : function(){
+ // Since there's only 1 thumb, it's always the nearest
+ return this.thumbs[0];
}
});
-// private
-// This is a support class used internally by the Grid components
-Ext.grid.HeaderDragZone = Ext.extend(Ext.dd.DragZone, {
- maxDragWidth: 120,
-
- constructor : function(grid, hd, hd2){
- this.grid = grid;
- this.view = grid.getView();
- this.ddGroup = "gridHeader" + this.grid.getGridEl().id;
- Ext.grid.HeaderDragZone.superclass.constructor.call(this, hd);
- if(hd2){
- this.setHandleElId(Ext.id(hd));
- this.setOuterHandleElId(Ext.id(hd2));
- }
- this.scroll = false;
- },
+
+/**
+ * @author Ed Spencer
+ * @class Ext.tab.Tab
+ * @extends Ext.button.Button
+ *
+ * Represents a single Tab in a {@link Ext.tab.Panel TabPanel}. A Tab is simply a slightly customized {@link Ext.button.Button Button},
+ * styled to look like a tab. Tabs are optionally closable, and can also be disabled. 99% of the time you will not
+ * need to create Tabs manually as the framework does so automatically when you use a {@link Ext.tab.Panel TabPanel}
+ *
+ * @xtype tab
+ */
+Ext.define('Ext.tab.Tab', {
+ extend: 'Ext.button.Button',
+ alias: 'widget.tab',
- getDragData : function(e){
- var t = Ext.lib.Event.getTarget(e),
- h = this.view.findHeaderCell(t);
- if(h){
- return {ddel: h.firstChild, header:h};
- }
- return false;
- },
+ requires: [
+ 'Ext.layout.component.Tab',
+ 'Ext.util.KeyNav'
+ ],
- onInitDrag : function(e){
- // keep the value here so we can restore it;
- this.dragHeadersDisabled = this.view.headersDisabled;
- this.view.headersDisabled = true;
- var clone = this.dragData.ddel.cloneNode(true);
- clone.id = Ext.id();
- clone.style.width = Math.min(this.dragData.header.offsetWidth,this.maxDragWidth) + "px";
- this.proxy.update(clone);
- return true;
- },
+ componentLayout: 'tab',
- afterValidDrop : function(){
- this.completeDrop();
- },
+ isTab: true,
- afterInvalidDrop : function(){
- this.completeDrop();
- },
+ baseCls: Ext.baseCSSPrefix + 'tab',
+
+ /**
+ * @cfg {String} activeCls
+ * The CSS class to be applied to a Tab when it is active. Defaults to 'x-tab-active'.
+ * Providing your own CSS for this class enables you to customize the active state.
+ */
+ activeCls: 'active',
- completeDrop: function(){
- var v = this.view,
- disabled = this.dragHeadersDisabled;
- setTimeout(function(){
- v.headersDisabled = disabled;
- }, 50);
- }
-});
+ /**
+ * @cfg {String} disabledCls
+ * The CSS class to be applied to a Tab when it is disabled. Defaults to 'x-tab-disabled'.
+ */
+
+ /**
+ * @cfg {String} closableCls
+ * The CSS class which is added to the tab when it is closable
+ */
+ closableCls: 'closable',
+
+ /**
+ * @cfg {Boolean} closable True to make the Tab start closable (the close icon will be visible). Defaults to true
+ */
+ closable: true,
+
+ /**
+ * @cfg {String} closeText
+ * The accessible text label for the close button link; only used when {@link #closable} = true.
+ * Defaults to 'Close Tab'.
+ */
+ closeText: 'Close Tab',
+
+ /**
+ * @property Boolean
+ * Read-only property indicating that this tab is currently active. This is NOT a public configuration.
+ */
+ active: false,
+
+ /**
+ * @property closable
+ * @type Boolean
+ * True if the tab is currently closable
+ */
+
+ scale: false,
-// private
-// This is a support class used internally by the Grid components
-Ext.grid.HeaderDropZone = Ext.extend(Ext.dd.DropZone, {
- proxyOffsets : [-4, -9],
- fly: Ext.Element.fly,
+ position: 'top',
- constructor : function(grid, hd, hd2){
- this.grid = grid;
- this.view = grid.getView();
- // split the proxies so they don't interfere with mouse events
- this.proxyTop = Ext.DomHelper.append(document.body, {
- cls:"col-move-top", html:" "
- }, true);
- this.proxyBottom = Ext.DomHelper.append(document.body, {
- cls:"col-move-bottom", html:" "
- }, true);
- this.proxyTop.hide = this.proxyBottom.hide = function(){
- this.setLeftTop(-100,-100);
- this.setStyle("visibility", "hidden");
- };
- this.ddGroup = "gridHeader" + this.grid.getGridEl().id;
- // temporarily disabled
- //Ext.dd.ScrollManager.register(this.view.scroller.dom);
- Ext.grid.HeaderDropZone.superclass.constructor.call(this, grid.getGridEl().dom);
- },
+ initComponent: function() {
+ var me = this;
- getTargetFromEvent : function(e){
- var t = Ext.lib.Event.getTarget(e),
- cindex = this.view.findCellIndex(t);
- if(cindex !== false){
- return this.view.getHeaderCell(cindex);
- }
- },
+ me.addEvents(
+ /**
+ * @event activate
+ * @param {Ext.tab.Tab} this
+ */
+ 'activate',
+
+ /**
+ * @event deactivate
+ * @param {Ext.tab.Tab} this
+ */
+ 'deactivate',
+
+ /**
+ * @event beforeclose
+ * Fires if the user clicks on the Tab's close button, but before the {@link #close} event is fired. Return
+ * false from any listener to stop the close event being fired
+ * @param {Ext.tab.Tab} tab The Tab object
+ */
+ 'beforeclose',
+
+ /**
+ * @event beforeclose
+ * Fires to indicate that the tab is to be closed, usually because the user has clicked the close button.
+ * @param {Ext.tab.Tab} tab The Tab object
+ */
+ 'close'
+ );
+
+ me.callParent(arguments);
- nextVisible : function(h){
- var v = this.view, cm = this.grid.colModel;
- h = h.nextSibling;
- while(h){
- if(!cm.isHidden(v.getCellIndex(h))){
- return h;
- }
- h = h.nextSibling;
+ if (me.card) {
+ me.setCard(me.card);
}
- return null;
},
- prevVisible : function(h){
- var v = this.view, cm = this.grid.colModel;
- h = h.prevSibling;
- while(h){
- if(!cm.isHidden(v.getCellIndex(h))){
- return h;
- }
- h = h.prevSibling;
- }
- return null;
- },
+ /**
+ * @ignore
+ */
+ onRender: function() {
+ var me = this;
+
+ me.addClsWithUI(me.position);
+
+ // Set all the state classNames, as they need to include the UI
+ // me.disabledCls = me.getClsWithUIs('disabled');
- positionIndicator : function(h, n, e){
- var x = Ext.lib.Event.getPageX(e),
- r = Ext.lib.Dom.getRegion(n.firstChild),
- px,
- pt,
- py = r.top + this.proxyOffsets[1];
- if((r.right - x) <= (r.right-r.left)/2){
- px = r.right+this.view.borderWidth;
- pt = "after";
- }else{
- px = r.left;
- pt = "before";
- }
+ me.syncClosableUI();
- if(this.grid.colModel.isFixed(this.view.getCellIndex(n))){
- return false;
+ me.callParent(arguments);
+
+ if (me.active) {
+ me.activate(true);
}
- px += this.proxyOffsets[0];
- this.proxyTop.setLeftTop(px, py);
- this.proxyTop.show();
- if(!this.bottomOffset){
- this.bottomOffset = this.view.mainHd.getHeight();
- }
- this.proxyBottom.setLeftTop(px, py+this.proxyTop.dom.offsetHeight+this.bottomOffset);
- this.proxyBottom.show();
- return pt;
+ me.syncClosableElements();
+
+ me.keyNav = Ext.create('Ext.util.KeyNav', me.el, {
+ enter: me.onEnterKey,
+ del: me.onDeleteKey,
+ scope: me
+ });
},
+
+ // inherit docs
+ enable : function(silent) {
+ var me = this;
- onNodeEnter : function(n, dd, e, data){
- if(data.header != n){
- this.positionIndicator(data.header, n, e);
- }
- },
+ me.callParent(arguments);
+
+ me.removeClsWithUI(me.position + '-disabled');
- onNodeOver : function(n, dd, e, data){
- var result = false;
- if(data.header != n){
- result = this.positionIndicator(data.header, n, e);
- }
- if(!result){
- this.proxyTop.hide();
- this.proxyBottom.hide();
- }
- return result ? this.dropAllowed : this.dropNotAllowed;
+ return me;
},
- onNodeOut : function(n, dd, e, data){
- this.proxyTop.hide();
- this.proxyBottom.hide();
+ // inherit docs
+ disable : function(silent) {
+ var me = this;
+
+ me.callParent(arguments);
+
+ me.addClsWithUI(me.position + '-disabled');
+
+ return me;
},
+
+ /**
+ * @ignore
+ */
+ onDestroy: function() {
+ var me = this;
- onNodeDrop : function(n, dd, e, data){
- var h = data.header;
- if(h != n){
- var cm = this.grid.colModel,
- x = Ext.lib.Event.getPageX(e),
- r = Ext.lib.Dom.getRegion(n.firstChild),
- pt = (r.right - x) <= ((r.right-r.left)/2) ? "after" : "before",
- oldIndex = this.view.getCellIndex(h),
- newIndex = this.view.getCellIndex(n);
- if(pt == "after"){
- newIndex++;
- }
- if(oldIndex < newIndex){
- newIndex--;
- }
- cm.moveColumn(oldIndex, newIndex);
- return true;
+ if (me.closeEl) {
+ me.closeEl.un('click', Ext.EventManager.preventDefault);
+ me.closeEl = null;
}
- return false;
- }
-});
-Ext.grid.GridView.ColumnDragZone = Ext.extend(Ext.grid.HeaderDragZone, {
-
- constructor : function(grid, hd){
- Ext.grid.GridView.ColumnDragZone.superclass.constructor.call(this, grid, hd, null);
- this.proxy.el.addClass('x-grid3-col-dd');
- },
-
- handleMouseDown : function(e){
- },
+ Ext.destroy(me.keyNav);
+ delete me.keyNav;
- callHandleMouseDown : function(e){
- Ext.grid.GridView.ColumnDragZone.superclass.handleMouseDown.call(this, e);
- }
-});// private
-// This is a support class used internally by the Grid components
-Ext.grid.SplitDragZone = Ext.extend(Ext.dd.DDProxy, {
- fly: Ext.Element.fly,
-
- constructor : function(grid, hd, hd2){
- this.grid = grid;
- this.view = grid.getView();
- this.proxy = this.view.resizeProxy;
- Ext.grid.SplitDragZone.superclass.constructor.call(this, hd,
- "gridSplitters" + this.grid.getGridEl().id, {
- dragElId : Ext.id(this.proxy.dom), resizeFrame:false
- });
- this.setHandleElId(Ext.id(hd));
- this.setOuterHandleElId(Ext.id(hd2));
- this.scroll = false;
+ me.callParent(arguments);
},
- b4StartDrag : function(x, y){
- this.view.headersDisabled = true;
- this.proxy.setHeight(this.view.mainWrap.getHeight());
- var w = this.cm.getColumnWidth(this.cellIndex);
- var minw = Math.max(w-this.grid.minColumnWidth, 0);
- this.resetConstraints();
- this.setXConstraint(minw, 1000);
- this.setYConstraint(0, 0);
- this.minX = x - minw;
- this.maxX = x + 1000;
- this.startPos = x;
- Ext.dd.DDProxy.prototype.b4StartDrag.call(this, x, y);
- },
+ /**
+ * Sets the tab as either closable or not
+ * @param {Boolean} closable Pass false to make the tab not closable. Otherwise the tab will be made closable (eg a
+ * close button will appear on the tab)
+ */
+ setClosable: function(closable) {
+ var me = this;
+ // Closable must be true if no args
+ closable = (!arguments.length || !!closable);
- handleMouseDown : function(e){
- var ev = Ext.EventObject.setEvent(e);
- var t = this.fly(ev.getTarget());
- if(t.hasClass("x-grid-split")){
- this.cellIndex = this.view.getCellIndex(t.dom);
- this.split = t.dom;
- this.cm = this.grid.colModel;
- if(this.cm.isResizable(this.cellIndex) && !this.cm.isFixed(this.cellIndex)){
- Ext.grid.SplitDragZone.superclass.handleMouseDown.apply(this, arguments);
- }
- }
- },
+ if (me.closable != closable) {
+ me.closable = closable;
- endDrag : function(e){
- this.view.headersDisabled = false;
- var endX = Math.max(this.minX, Ext.lib.Event.getPageX(e));
- var diff = endX - this.startPos;
- this.view.onColumnSplitterMoved(this.cellIndex, this.cm.getColumnWidth(this.cellIndex)+diff);
- },
+ // set property on the user-facing item ('card'):
+ if (me.card) {
+ me.card.closable = closable;
+ }
- autoOffset : function(){
- this.setDelta(0,0);
- }
-});/**
- * @class Ext.grid.GridDragZone
- * @extends Ext.dd.DragZone
- * A customized implementation of a {@link Ext.dd.DragZone DragZone} which provides default implementations of two of the
- * template methods of DragZone to enable dragging of the selected rows of a GridPanel.
- * A cooperating {@link Ext.dd.DropZone DropZone} must be created who's template method implementations of
- * {@link Ext.dd.DropZone#onNodeEnter onNodeEnter}, {@link Ext.dd.DropZone#onNodeOver onNodeOver},
- * {@link Ext.dd.DropZone#onNodeOut onNodeOut} and {@link Ext.dd.DropZone#onNodeDrop onNodeDrop}
are able
- * to process the {@link #getDragData data} which is provided.
- */
-Ext.grid.GridDragZone = function(grid, config){
- this.view = grid.getView();
- Ext.grid.GridDragZone.superclass.constructor.call(this, this.view.mainBody.dom, config);
- this.scroll = false;
- this.grid = grid;
- this.ddel = document.createElement('div');
- this.ddel.className = 'x-grid-dd-wrap';
-};
+ me.syncClosableUI();
-Ext.extend(Ext.grid.GridDragZone, Ext.dd.DragZone, {
- ddGroup : "GridDD",
+ if (me.rendered) {
+ me.syncClosableElements();
- /**
- * The provided implementation of the getDragData method which collects the data to be dragged from the GridPanel on mousedown.
- * This data is available for processing in the {@link Ext.dd.DropZone#onNodeEnter onNodeEnter}, {@link Ext.dd.DropZone#onNodeOver onNodeOver},
- * {@link Ext.dd.DropZone#onNodeOut onNodeOut} and {@link Ext.dd.DropZone#onNodeDrop onNodeDrop} methods of a cooperating {@link Ext.dd.DropZone DropZone}.
- * The data object contains the following properties:
- * - grid : Ext.Grid.GridPanelThe GridPanel from which the data is being dragged.
- * - ddel : htmlElementAn htmlElement which provides the "picture" of the data being dragged.
- * - rowIndex : NumberThe index of the row which receieved the mousedown gesture which triggered the drag.
- * - selections : ArrayAn Array of the selected Records which are being dragged from the GridPanel.
- *
- */
- getDragData : function(e){
- var t = Ext.lib.Event.getTarget(e);
- var rowIndex = this.view.findRowIndex(t);
- if(rowIndex !== false){
- var sm = this.grid.selModel;
- if(!sm.isSelected(rowIndex) || e.hasModifier()){
- sm.handleMouseDown(this.grid, rowIndex, e);
+ // Tab will change width to accommodate close icon
+ me.doComponentLayout();
+ if (me.ownerCt) {
+ me.ownerCt.doLayout();
+ }
}
- return {grid: this.grid, ddel: this.ddel, rowIndex: rowIndex, selections:sm.getSelections()};
}
- return false;
},
/**
- * The provided implementation of the onInitDrag method. Sets the innerHTML of the drag proxy which provides the "picture"
- * of the data being dragged.
- * The innerHTML data is found by calling the owning GridPanel's {@link Ext.grid.GridPanel#getDragDropText getDragDropText}.
+ * This method ensures that the closeBtn element exists or not based on 'closable'.
+ * @private
*/
- onInitDrag : function(e){
- var data = this.dragData;
- this.ddel.innerHTML = this.grid.getDragDropText();
- this.proxy.update(this.ddel);
- // fire start drag?
- },
+ syncClosableElements: function () {
+ var me = this;
- /**
- * An empty immplementation. Implement this to provide behaviour after a repair of an invalid drop. An implementation might highlight
- * the selected rows to show that they have not been dragged.
- */
- afterRepair : function(){
- this.dragging = false;
+ if (me.closable) {
+ if (!me.closeEl) {
+ me.closeEl = me.el.createChild({
+ tag: 'a',
+ cls: me.baseCls + '-close-btn',
+ href: '#',
+ html: me.closeText,
+ title: me.closeText
+ }).on('click', Ext.EventManager.preventDefault); // mon ???
+ }
+ } else {
+ var closeEl = me.closeEl;
+ if (closeEl) {
+ closeEl.un('click', Ext.EventManager.preventDefault);
+ closeEl.remove();
+ me.closeEl = null;
+ }
+ }
},
/**
- * An empty implementation. Implement this to provide coordinates for the drag proxy to slide back to after an invalid drop.
- * Called before a repair of an invalid drop to get the XY to animate to.
- * @param {EventObject} e The mouse up event
- * @return {Array} The xy location (e.g. [100, 200])
+ * This method ensures that the UI classes are added or removed based on 'closable'.
+ * @private
*/
- getRepairXY : function(e, data){
- return false;
- },
-
- onEndDrag : function(data, e){
- // fire end drag?
- },
+ syncClosableUI: function () {
+ var me = this, classes = [me.closableCls, me.closableCls + '-' + me.position];
- onValidDrop : function(dd, e, id){
- // fire drag drop?
- this.hideProxy();
+ if (me.closable) {
+ me.addClsWithUI(classes);
+ } else {
+ me.removeClsWithUI(classes);
+ }
},
- beforeInvalidDrop : function(e, id){
-
- }
-});
-/**
- * @class Ext.grid.ColumnModel
- * @extends Ext.util.Observable
- * After the data has been read into the client side cache ({@link Ext.data.Store Store}),
- * the ColumnModel is used to configure how and what parts of that data will be displayed in the
- * vertical slices (columns) of the grid. The Ext.grid.ColumnModel Class is the default implementation
- * of a ColumnModel used by implentations of {@link Ext.grid.GridPanel GridPanel}.
- * Data is mapped into the store's records and then indexed into the ColumnModel using the
- * {@link Ext.grid.Column#dataIndex dataIndex}:
- *
-{data source} == mapping ==> {data store} == {@link Ext.grid.Column#dataIndex dataIndex} ==> {ColumnModel}
- *
- * Each {@link Ext.grid.Column Column} in the grid's ColumnModel is configured with a
- * {@link Ext.grid.Column#dataIndex dataIndex} to specify how the data within
- * each record in the store is indexed into the ColumnModel.
- * There are two ways to initialize the ColumnModel class:
- * Initialization Method 1: an Array
-
- var colModel = new Ext.grid.ColumnModel([
- { header: "Ticker", width: 60, sortable: true},
- { header: "Company Name", width: 150, sortable: true, id: 'company'},
- { header: "Market Cap.", width: 100, sortable: true},
- { header: "$ Sales", width: 100, sortable: true, renderer: money},
- { header: "Employees", width: 100, sortable: true, resizable: false}
- ]);
-
- * The ColumnModel may be initialized with an Array of {@link Ext.grid.Column} column configuration
- * objects to define the initial layout / display of the columns in the Grid. The order of each
- * {@link Ext.grid.Column} column configuration object within the specified Array defines the initial
- * order of the column display. A Column's display may be initially hidden using the
- * {@link Ext.grid.Column#hidden hidden} config property (and then shown using the column
- * header menu). Fields that are not included in the ColumnModel will not be displayable at all.
- * How each column in the grid correlates (maps) to the {@link Ext.data.Record} field in the
- * {@link Ext.data.Store Store} the column draws its data from is configured through the
- * {@link Ext.grid.Column#dataIndex dataIndex}. If the
- * {@link Ext.grid.Column#dataIndex dataIndex} is not explicitly defined (as shown in the
- * example above) it will use the column configuration's index in the Array as the index.
- * See {@link Ext.grid.Column} for additional configuration options for each column.
- * Initialization Method 2: an Object
- * In order to use configuration options from Ext.grid.ColumnModel, an Object may be used to
- * initialize the ColumnModel. The column configuration Array will be specified in the {@link #columns}
- * config property. The {@link #defaults} config property can be used to apply defaults
- * for all columns, e.g.:
- var colModel = new Ext.grid.ColumnModel({
- columns: [
- { header: "Ticker", width: 60, menuDisabled: false},
- { header: "Company Name", width: 150, id: 'company'},
- { header: "Market Cap."},
- { header: "$ Sales", renderer: money},
- { header: "Employees", resizable: false}
- ],
- defaults: {
- sortable: true,
- menuDisabled: true,
- width: 100
- },
- listeners: {
- {@link #hiddenchange}: function(cm, colIndex, hidden) {
- saveConfig(colIndex, hidden);
- }
- }
-});
-
- * In both examples above, the ability to apply a CSS class to all cells in a column (including the
- * header) is demonstrated through the use of the {@link Ext.grid.Column#id id} config
- * option. This column could be styled by including the following css:
- //add this css *after* the core css is loaded
-.x-grid3-td-company {
- color: red; // entire column will have red font
-}
-// modify the header row only, adding an icon to the column header
-.x-grid3-hd-company {
- background: transparent
- url(../../resources/images/icons/silk/building.png)
- no-repeat 3px 3px ! important;
- padding-left:20px;
-}
-
- * Note that the "Company Name" column could be specified as the
- * {@link Ext.grid.GridPanel}.{@link Ext.grid.GridPanel#autoExpandColumn autoExpandColumn}.
- * @constructor
- * @param {Mixed} config Specify either an Array of {@link Ext.grid.Column} configuration objects or specify
- * a configuration Object (see introductory section discussion utilizing Initialization Method 2 above).
- */
-Ext.grid.ColumnModel = Ext.extend(Ext.util.Observable, {
- /**
- * @cfg {Number} defaultWidth (optional) The width of columns which have no {@link #width}
- * specified (defaults to 100). This property shall preferably be configured through the
- * {@link #defaults} config property.
- */
- defaultWidth: 100,
- /**
- * @cfg {Boolean} defaultSortable (optional) Default sortable of columns which have no
- * sortable specified (defaults to false). This property shall preferably be configured
- * through the {@link #defaults} config property.
- */
- defaultSortable: false,
- /**
- * @cfg {Array} columns An Array of object literals. The config options defined by
- * {@link Ext.grid.Column} are the options which may appear in the object literal for each
- * individual column definition.
- */
/**
- * @cfg {Object} defaults Object literal which will be used to apply {@link Ext.grid.Column}
- * configuration options to all {@link #columns}. Configuration options specified with
- * individual {@link Ext.grid.Column column} configs will supersede these {@link #defaults}.
+ * Sets this tab's attached card. Usually this is handled automatically by the {@link Ext.tab.Panel} that this Tab
+ * belongs to and would not need to be done by the developer
+ * @param {Ext.Component} card The card to set
*/
+ setCard: function(card) {
+ var me = this;
- constructor : function(config){
- /**
- * An Array of {@link Ext.grid.Column Column definition} objects representing the configuration
- * of this ColumnModel. See {@link Ext.grid.Column} for the configuration properties that may
- * be specified.
- * @property config
- * @type Array
- */
- if(config.columns){
- Ext.apply(this, config);
- this.setConfig(config.columns, true);
- }else{
- this.setConfig(config, true);
- }
- this.addEvents(
- /**
- * @event widthchange
- * Fires when the width of a column is programmaticially changed using
- * {@link #setColumnWidth}
.
- * Note internal resizing suppresses the event from firing. See also
- * {@link Ext.grid.GridPanel}.{@link #columnresize}
.
- * @param {ColumnModel} this
- * @param {Number} columnIndex The column index
- * @param {Number} newWidth The new width
- */
- "widthchange",
- /**
- * @event headerchange
- * Fires when the text of a header changes.
- * @param {ColumnModel} this
- * @param {Number} columnIndex The column index
- * @param {String} newText The new header text
- */
- "headerchange",
- /**
- * @event hiddenchange
- * Fires when a column is hidden or "unhidden".
- * @param {ColumnModel} this
- * @param {Number} columnIndex The column index
- * @param {Boolean} hidden true if hidden, false otherwise
- */
- "hiddenchange",
- /**
- * @event columnmoved
- * Fires when a column is moved.
- * @param {ColumnModel} this
- * @param {Number} oldIndex
- * @param {Number} newIndex
- */
- "columnmoved",
- /**
- * @event configchange
- * Fires when the configuration is changed
- * @param {ColumnModel} this
- */
- "configchange"
- );
- Ext.grid.ColumnModel.superclass.constructor.call(this);
- },
-
- /**
- * Returns the id of the column at the specified index.
- * @param {Number} index The column index
- * @return {String} the id
- */
- getColumnId : function(index){
- return this.config[index].id;
- },
-
- getColumnAt : function(index){
- return this.config[index];
- },
-
- /**
- * Reconfigures this column model according to the passed Array of column definition objects.
- * For a description of the individual properties of a column definition object, see the
- * Config Options.
- * Causes the {@link #configchange} event to be fired. A {@link Ext.grid.GridPanel GridPanel}
- * using this ColumnModel will listen for this event and refresh its UI automatically.
- * @param {Array} config Array of Column definition objects.
- * @param {Boolean} initial Specify true to bypass cleanup which deletes the totalWidth
- * and destroys existing editors.
- */
- setConfig : function(config, initial){
- var i, c, len;
- if(!initial){ // cleanup
- delete this.totalWidth;
- for(i = 0, len = this.config.length; i < len; i++){
- c = this.config[i];
- if(c.setEditor){
- //check here, in case we have a special column like a CheckboxSelectionModel
- c.setEditor(null);
- }
- }
- }
-
- // backward compatibility
- this.defaults = Ext.apply({
- width: this.defaultWidth,
- sortable: this.defaultSortable
- }, this.defaults);
-
- this.config = config;
- this.lookup = {};
-
- for(i = 0, len = config.length; i < len; i++){
- c = Ext.applyIf(config[i], this.defaults);
- // if no id, create one using column's ordinal position
- if(Ext.isEmpty(c.id)){
- c.id = i;
- }
- if(!c.isColumn){
- var Cls = Ext.grid.Column.types[c.xtype || 'gridcolumn'];
- c = new Cls(c);
- config[i] = c;
- }
- this.lookup[c.id] = c;
- }
- if(!initial){
- this.fireEvent('configchange', this);
- }
- },
-
- /**
- * Returns the column for a specified id.
- * @param {String} id The column id
- * @return {Object} the column
- */
- getColumnById : function(id){
- return this.lookup[id];
+ me.card = card;
+ me.setText(me.title || card.title);
+ me.setIconCls(me.iconCls || card.iconCls);
},
/**
- * Returns the index for a specified column id.
- * @param {String} id The column id
- * @return {Number} the index, or -1 if not found
+ * @private
+ * Listener attached to click events on the Tab's close button
*/
- getIndexById : function(id){
- for(var i = 0, len = this.config.length; i < len; i++){
- if(this.config[i].id == id){
- return i;
+ onCloseClick: function() {
+ var me = this;
+
+ if (me.fireEvent('beforeclose', me) !== false) {
+ if (me.tabBar) {
+ me.tabBar.closeTab(me);
}
+
+ me.fireEvent('close', me);
}
- return -1;
},
-
+
/**
- * Moves a column from one position to another.
- * @param {Number} oldIndex The index of the column to move.
- * @param {Number} newIndex The position at which to reinsert the coolumn.
+ * @private
*/
- moveColumn : function(oldIndex, newIndex){
- var c = this.config[oldIndex];
- this.config.splice(oldIndex, 1);
- this.config.splice(newIndex, 0, c);
- this.dataMap = null;
- this.fireEvent("columnmoved", this, oldIndex, newIndex);
+ onEnterKey: function(e) {
+ var me = this;
+
+ if (me.tabBar) {
+ me.tabBar.onClick(e, me.el);
+ }
},
-
- /**
- * Returns the number of columns.
- * @param {Boolean} visibleOnly Optional. Pass as true to only include visible columns.
- * @return {Number}
+
+ /**
+ * @private
*/
- getColumnCount : function(visibleOnly){
- if(visibleOnly === true){
- var c = 0;
- for(var i = 0, len = this.config.length; i < len; i++){
- if(!this.isHidden(i)){
- c++;
- }
- }
- return c;
+ onDeleteKey: function(e) {
+ var me = this;
+
+ if (me.closable) {
+ me.onCloseClick();
}
- return this.config.length;
},
+
+ // @private
+ activate : function(supressEvent) {
+ var me = this;
+
+ me.active = true;
+ me.addClsWithUI([me.activeCls, me.position + '-' + me.activeCls]);
- /**
- * Returns the column configs that return true by the passed function that is called
- * with (columnConfig, index)
-
-// returns an array of column config objects for all hidden columns
-var columns = grid.getColumnModel().getColumnsBy(function(c){
- return c.hidden;
-});
-
- * @param {Function} fn A function which, when passed a {@link Ext.grid.Column Column} object, must
- * return true
if the column is to be included in the returned Array.
- * @param {Object} scope (optional) The scope (this
reference) in which the function
- * is executed. Defaults to this ColumnModel.
- * @return {Array} result
- */
- getColumnsBy : function(fn, scope){
- var r = [];
- for(var i = 0, len = this.config.length; i < len; i++){
- var c = this.config[i];
- if(fn.call(scope||this, c, i) === true){
- r[r.length] = c;
- }
+ if (supressEvent !== true) {
+ me.fireEvent('activate', me);
}
- return r;
},
+ // @private
+ deactivate : function(supressEvent) {
+ var me = this;
+
+ me.active = false;
+ me.removeClsWithUI([me.activeCls, me.position + '-' + me.activeCls]);
+
+ if (supressEvent !== true) {
+ me.fireEvent('deactivate', me);
+ }
+ }
+});
+
+/**
+ * @author Ed Spencer
+ * @class Ext.tab.Bar
+ * @extends Ext.panel.Header
+ * TabBar is used internally by a {@link Ext.tab.Panel TabPanel} and wouldn't usually need to be created manually.
+ *
+ * @xtype tabbar
+ */
+Ext.define('Ext.tab.Bar', {
+ extend: 'Ext.panel.Header',
+ alias: 'widget.tabbar',
+ baseCls: Ext.baseCSSPrefix + 'tab-bar',
+
+ requires: [
+ 'Ext.tab.Tab',
+ 'Ext.FocusManager'
+ ],
+
+ // @private
+ defaultType: 'tab',
+
/**
- * Returns true if the specified column is sortable.
- * @param {Number} col The column index
- * @return {Boolean}
+ * @cfg Boolean plain
+ * True to not show the full background on the tabbar
*/
- isSortable : function(col){
- return !!this.config[col].sortable;
- },
+ plain: false,
+
+ // @private
+ renderTpl: [
+ ' {baseCls}-body-{ui} {parent.baseCls}-body-{parent.ui}-{.} " style="{bodyStyle}" >',
+ ' {baseCls}-strip-{ui} {parent.baseCls}-strip-{parent.ui}-{.} ">'
+ ],
/**
- * Returns true if the specified column menu is disabled.
- * @param {Number} col The column index
- * @return {Boolean}
+ * @cfg {Number} minTabWidth The minimum width for each tab. Defaults to 30.
*/
- isMenuDisabled : function(col){
- return !!this.config[col].menuDisabled;
- },
+ minTabWidth: 30,
/**
- * Returns the rendering (formatting) function defined for the column.
- * @param {Number} col The column index.
- * @return {Function} The function used to render the cell. See {@link #setRenderer}.
+ * @cfg {Number} maxTabWidth The maximum width for each tab. Defaults to undefined.
*/
- getRenderer : function(col){
- if(!this.config[col].renderer){
- return Ext.grid.ColumnModel.defaultRenderer;
+ maxTabWidth: undefined,
+
+ // @private
+ initComponent: function() {
+ var me = this,
+ keys;
+
+ if (me.plain) {
+ me.setUI(me.ui + '-plain');
}
- return this.config[col].renderer;
- },
+
+ me.addClsWithUI(me.dock);
+
+ me.addEvents(
+ /**
+ * @event change
+ * Fired when the currently-active tab has changed
+ * @param {Ext.tab.Bar} tabBar The TabBar
+ * @param {Ext.Tab} tab The new Tab
+ * @param {Ext.Component} card The card that was just shown in the TabPanel
+ */
+ 'change'
+ );
- getRendererScope : function(col){
- return this.config[col].scope;
+ Ext.applyIf(this.renderSelectors, {
+ body : '.' + this.baseCls + '-body',
+ strip: '.' + this.baseCls + '-strip'
+ });
+ me.callParent(arguments);
+
+ // TabBar must override the Header's align setting.
+ me.layout.align = (me.orientation == 'vertical') ? 'left' : 'top';
+ me.layout.overflowHandler = Ext.create('Ext.layout.container.boxOverflow.Scroller', me.layout);
+ me.items.removeAt(me.items.getCount() - 1);
+ me.items.removeAt(me.items.getCount() - 1);
+
+ // Subscribe to Ext.FocusManager for key navigation
+ keys = me.orientation == 'vertical' ? ['up', 'down'] : ['left', 'right'];
+ Ext.FocusManager.subscribe(me, {
+ keys: keys
+ });
},
- /**
- * Sets the rendering (formatting) function for a column. See {@link Ext.util.Format} for some
- * default formatting functions.
- * @param {Number} col The column index
- * @param {Function} fn The function to use to process the cell's raw data
- * to return HTML markup for the grid view. The render function is called with
- * the following parameters:
- * - value : Object
The data value for the cell.
- * - metadata : Object
An object in which you may set the following attributes:
- * - css : String
A CSS class name to add to the cell's TD element.
- * - attr : String
An HTML attribute definition string to apply to the data container element within the table cell
- * (e.g. 'style="color:red;"').
- * - record : Ext.data.record
The {@link Ext.data.Record} from which the data was extracted.
- * - rowIndex : Number
Row index
- * - colIndex : Number
Column index
- * - store : Ext.data.Store
The {@link Ext.data.Store} object from which the Record was extracted.
- */
- setRenderer : function(col, fn){
- this.config[col].renderer = fn;
+ // @private
+ onAdd: function(tab) {
+ var me = this,
+ tabPanel = me.tabPanel,
+ hasOwner = !!tabPanel;
+
+ me.callParent(arguments);
+ tab.position = me.dock;
+ if (hasOwner) {
+ tab.minWidth = tabPanel.minTabWidth;
+ }
+ else {
+ tab.minWidth = me.minTabWidth + (tab.iconCls ? 25 : 0);
+ }
+ tab.maxWidth = me.maxTabWidth || (hasOwner ? tabPanel.maxTabWidth : undefined);
},
- /**
- * Returns the width for the specified column.
- * @param {Number} col The column index
- * @return {Number}
- */
- getColumnWidth : function(col){
- return this.config[col].width;
+ // @private
+ afterRender: function() {
+ var me = this;
+
+ me.mon(me.el, {
+ scope: me,
+ click: me.onClick,
+ delegate: '.' + Ext.baseCSSPrefix + 'tab'
+ });
+ me.callParent(arguments);
+
},
- /**
- * Sets the width for a column.
- * @param {Number} col The column index
- * @param {Number} width The new width
- * @param {Boolean} suppressEvent True to suppress firing the {@link #widthchange}
- * event. Defaults to false.
- */
- setColumnWidth : function(col, width, suppressEvent){
- this.config[col].width = width;
- this.totalWidth = null;
- if(!suppressEvent){
- this.fireEvent("widthchange", this, col, width);
- }
+ afterComponentLayout : function() {
+ var me = this;
+
+ me.callParent(arguments);
+ me.strip.setWidth(me.el.getWidth());
},
- /**
- * Returns the total width of all columns.
- * @param {Boolean} includeHidden True to include hidden column widths
- * @return {Number}
- */
- getTotalWidth : function(includeHidden){
- if(!this.totalWidth){
- this.totalWidth = 0;
- for(var i = 0, len = this.config.length; i < len; i++){
- if(includeHidden || !this.isHidden(i)){
- this.totalWidth += this.getColumnWidth(i);
+ // @private
+ onClick: function(e, target) {
+ // The target might not be a valid tab el.
+ var tab = Ext.getCmp(target.id),
+ tabPanel = this.tabPanel;
+
+ target = e.getTarget();
+
+ if (tab && tab.isDisabled && !tab.isDisabled()) {
+ if (tab.closable && target === tab.closeEl.dom) {
+ tab.onCloseClick();
+ } else {
+ this.setActiveTab(tab);
+ if (tabPanel) {
+ tabPanel.setActiveTab(tab.card);
}
+ tab.focus();
}
}
- return this.totalWidth;
},
/**
- * Returns the header for the specified column.
- * @param {Number} col The column index
- * @return {String}
+ * @private
+ * Closes the given tab by removing it from the TabBar and removing the corresponding card from the TabPanel
+ * @param {Ext.Tab} tab The tab to close
*/
- getColumnHeader : function(col){
- return this.config[col].header;
- },
+ closeTab: function(tab) {
+ var card = tab.card,
+ tabPanel = this.tabPanel,
+ nextTab;
- /**
- * Sets the header for a column.
- * @param {Number} col The column index
- * @param {String} header The new header
- */
- setColumnHeader : function(col, header){
- this.config[col].header = header;
- this.fireEvent("headerchange", this, col, header);
- },
+ if (tab.active && this.items.getCount() > 1) {
+ nextTab = tab.next('tab') || this.items.items[0];
+ this.setActiveTab(nextTab);
+ if (tabPanel) {
+ tabPanel.setActiveTab(nextTab.card);
+ }
+ }
+ this.remove(tab);
- /**
- * Returns the tooltip for the specified column.
- * @param {Number} col The column index
- * @return {String}
- */
- getColumnTooltip : function(col){
- return this.config[col].tooltip;
- },
- /**
- * Sets the tooltip for a column.
- * @param {Number} col The column index
- * @param {String} tooltip The new tooltip
- */
- setColumnTooltip : function(col, tooltip){
- this.config[col].tooltip = tooltip;
+ if (tabPanel && card) {
+ tabPanel.remove(card);
+ }
+
+ if (nextTab) {
+ nextTab.focus();
+ }
},
/**
- * Returns the dataIndex for the specified column.
-
-// Get field name for the column
-var fieldName = grid.getColumnModel().getDataIndex(columnIndex);
-
- * @param {Number} col The column index
- * @return {String} The column's dataIndex
+ * @private
+ * Marks the given tab as active
+ * @param {Ext.Tab} tab The tab to mark active
*/
- getDataIndex : function(col){
- return this.config[col].dataIndex;
- },
+ setActiveTab: function(tab) {
+ if (tab.disabled) {
+ return;
+ }
+ var me = this;
+ if (me.activeTab) {
+ me.activeTab.deactivate();
+ }
+ tab.activate();
+
+ if (me.rendered) {
+ me.layout.layout();
+ tab.el.scrollIntoView(me.layout.getRenderTarget());
+ }
+ me.activeTab = tab;
+ me.fireEvent('change', me, tab, tab.card);
+ }
+});
+/**
+ * @author Ed Spencer, Tommy Maintz, Brian Moeskau
+ * @class Ext.tab.Panel
+ * @extends Ext.panel.Panel
- /**
- * Sets the dataIndex for a column.
- * @param {Number} col The column index
- * @param {String} dataIndex The new dataIndex
- */
- setDataIndex : function(col, dataIndex){
- this.config[col].dataIndex = dataIndex;
- },
+A basic tab container. TabPanels can be used exactly like a standard {@link Ext.panel.Panel} for layout purposes, but also
+have special support for containing child Components (`{@link Ext.container.Container#items items}`) that are managed
+using a {@link Ext.layout.container.Card CardLayout layout manager}, and displayed as separate tabs.
- /**
- * Finds the index of the first matching column for the given dataIndex.
- * @param {String} col The dataIndex to find
- * @return {Number} The column index, or -1 if no match was found
- */
- findColumnIndex : function(dataIndex){
- var c = this.config;
- for(var i = 0, len = c.length; i < len; i++){
- if(c[i].dataIndex == dataIndex){
- return i;
+__Note:__
+
+By default, a tab's close tool _destroys_ the child tab Component and all its descendants. This makes the child tab
+Component, and all its descendants __unusable__. To enable re-use of a tab, configure the TabPanel with `{@link #autoDestroy autoDestroy: false}`.
+
+__TabPanel's layout:__
+
+TabPanels use a Dock layout to position the {@link Ext.tab.Bar TabBar} at the top of the widget. Panels added to the TabPanel will have their
+header hidden by default because the Tab will automatically take the Panel's configured title and icon.
+
+TabPanels use their {@link Ext.panel.Panel#header header} or {@link Ext.panel.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.Panel#tools tools}.
+
+To display a header, embed the TabPanel in a {@link Ext.panel.Panel Panel} which uses `{@link Ext.container.Container#layout layout:'fit'}`.
+
+__Examples:__
+
+Here is a basic TabPanel rendered to the body. This also shows the useful configuration {@link #activeTab}, which allows you to set the active tab on render.
+If you do not set an {@link #activeTab}, no tabs will be active by default.
+{@img Ext.tab.Panel/Ext.tab.Panel1.png TabPanel component}
+Example usage:
+
+ Ext.create('Ext.tab.Panel', {
+ width: 300,
+ height: 200,
+ activeTab: 0,
+ items: [
+ {
+ title: 'Tab 1',
+ bodyPadding: 10,
+ html : 'A simple tab'
+ },
+ {
+ title: 'Tab 2',
+ html : 'Another one'
+ }
+ ],
+ renderTo : Ext.getBody()
+ });
+
+It is easy to control the visibility of items in the tab bar. Specify hidden: true to have the
+tab button hidden initially. Items can be subsequently hidden and show by accessing the
+tab property on the child item.
+
+Example usage:
+
+ var tabs = Ext.create('Ext.tab.Panel', {
+ width: 400,
+ height: 400,
+ renderTo: document.body,
+ items: [{
+ title: 'Home',
+ html: 'Home',
+ itemId: 'home'
+ }, {
+ title: 'Users',
+ html: 'Users',
+ itemId: 'users',
+ hidden: true
+ }, {
+ title: 'Tickets',
+ html: 'Tickets',
+ itemId: 'tickets'
+ }]
+ });
+
+ setTimeout(function(){
+ tabs.child('#home').tab.hide();
+ var users = tabs.child('#users');
+ users.tab.show();
+ tabs.setActiveTab(users);
+ }, 1000);
+
+You can remove the background of the TabBar by setting the {@link #plain} property to `false`.
+
+Example usage:
+
+ Ext.create('Ext.tab.Panel', {
+ width: 300,
+ height: 200,
+ activeTab: 0,
+ plain: true,
+ items: [
+ {
+ title: 'Tab 1',
+ bodyPadding: 10,
+ html : 'A simple tab'
+ },
+ {
+ title: 'Tab 2',
+ html : 'Another one'
+ }
+ ],
+ renderTo : Ext.getBody()
+ });
+
+Another useful configuration of TabPanel is {@link #tabPosition}. This allows you to change the position where the tabs are displayed. The available
+options for this are `'top'` (default) and `'bottom'`.
+{@img Ext.tab.Panel/Ext.tab.Panel2.png TabPanel component}
+Example usage:
+
+ Ext.create('Ext.tab.Panel', {
+ width: 300,
+ height: 200,
+ activeTab: 0,
+ bodyPadding: 10,
+ tabPosition: 'bottom',
+ items: [
+ {
+ title: 'Tab 1',
+ html : 'A simple tab'
+ },
+ {
+ title: 'Tab 2',
+ html : 'Another one'
+ }
+ ],
+ renderTo : Ext.getBody()
+ });
+
+The {@link #setActiveTab} is a very useful method in TabPanel which will allow you to change the current active tab. You can either give it an index or
+an instance of a tab.
+
+Example usage:
+
+ var tabs = Ext.create('Ext.tab.Panel', {
+ items: [
+ {
+ id : 'my-tab',
+ title: 'Tab 1',
+ html : 'A simple tab'
+ },
+ {
+ title: 'Tab 2',
+ html : 'Another one'
}
+ ],
+ renderTo : Ext.getBody()
+ });
+
+ var tab = Ext.getCmp('my-tab');
+
+ Ext.create('Ext.button.Button', {
+ renderTo: Ext.getBody(),
+ text : 'Select the first tab',
+ scope : this,
+ handler : function() {
+ tabs.setActiveTab(tab);
}
- return -1;
- },
+ });
+
+ Ext.create('Ext.button.Button', {
+ text : 'Select the second tab',
+ scope : this,
+ handler : function() {
+ tabs.setActiveTab(1);
+ },
+ renderTo : Ext.getBody()
+ });
- /**
- * Returns true if the cell is editable.
-
-var store = new Ext.data.Store({...});
-var colModel = new Ext.grid.ColumnModel({
- columns: [...],
- isCellEditable: function(col, row) {
- var record = store.getAt(row);
- if (record.get('readonly')) { // replace with your condition
- return false;
- }
- return Ext.grid.ColumnModel.prototype.isCellEditable.call(this, col, row);
- }
-});
-var grid = new Ext.grid.GridPanel({
- store: store,
- colModel: colModel,
- ...
-});
-
- * @param {Number} colIndex The column index
- * @param {Number} rowIndex The row index
- * @return {Boolean}
- */
- isCellEditable : function(colIndex, rowIndex){
- var c = this.config[colIndex],
- ed = c.editable;
+The {@link #getActiveTab} is a another useful method in TabPanel which will return the current active tab.
- //force boolean
- return !!(ed || (!Ext.isDefined(ed) && c.editor));
- },
+Example usage:
- /**
- * Returns the editor defined for the cell/column.
- * @param {Number} colIndex The column index
- * @param {Number} rowIndex The row index
- * @return {Ext.Editor} The {@link Ext.Editor Editor} that was created to wrap
- * the {@link Ext.form.Field Field} used to edit the cell.
- */
- getCellEditor : function(colIndex, rowIndex){
- return this.config[colIndex].getCellEditor(rowIndex);
- },
+ var tabs = Ext.create('Ext.tab.Panel', {
+ items: [
+ {
+ title: 'Tab 1',
+ html : 'A simple tab'
+ },
+ {
+ title: 'Tab 2',
+ html : 'Another one'
+ }
+ ],
+ renderTo : Ext.getBody()
+ });
+
+ Ext.create('Ext.button.Button', {
+ text : 'Get active tab',
+ scope : this,
+ handler : function() {
+ var tab = tabs.getActiveTab();
+ alert('Current tab: ' + tab.title);
+ },
+ renderTo : Ext.getBody()
+ });
- /**
- * Sets if a column is editable.
- * @param {Number} col The column index
- * @param {Boolean} editable True if the column is editable
- */
- setEditable : function(col, editable){
- this.config[col].editable = editable;
- },
+Adding a new tab is very simple with a TabPanel. You simple call the {@link #add} method with an config object for a panel.
+
+Example usage:
+
+ var tabs = Ext.Create('Ext.tab.Panel', {
+ items: [
+ {
+ title: 'Tab 1',
+ html : 'A simple tab'
+ },
+ {
+ title: 'Tab 2',
+ html : 'Another one'
+ }
+ ],
+ renderTo : Ext.getBody()
+ });
+
+ Ext.create('Ext.button.Button', {
+ text : 'New tab',
+ scope : this,
+ handler : function() {
+ var tab = tabs.add({
+ title: 'Tab ' + (tabs.items.length + 1), //we use the tabs.items property to get the length of current items/tabs
+ html : 'Another one'
+ });
+
+ tabs.setActiveTab(tab);
+ },
+ renderTo : Ext.getBody()
+ });
+
+Additionally, removing a tab is very also simple with a TabPanel. You simple call the {@link #remove} method with an config object for a panel.
+
+Example usage:
+
+ var tabs = Ext.Create('Ext.tab.Panel', {
+ items: [
+ {
+ title: 'Tab 1',
+ html : 'A simple tab'
+ },
+ {
+ id : 'remove-this-tab',
+ title: 'Tab 2',
+ html : 'Another one'
+ }
+ ],
+ renderTo : Ext.getBody()
+ });
+
+ Ext.Create('Ext.button.Button', {
+ text : 'Remove tab',
+ scope : this,
+ handler : function() {
+ var tab = Ext.getCmp('remove-this-tab');
+ tabs.remove(tab);
+ },
+ renderTo : Ext.getBody()
+ });
+
+ * @extends Ext.Panel
+ * @constructor
+ * @param {Object} config The configuration options
+ * @xtype tabpanel
+ * @markdown
+ */
+Ext.define('Ext.tab.Panel', {
+ extend: 'Ext.panel.Panel',
+ alias: 'widget.tabpanel',
+ alternateClassName: ['Ext.TabPanel'],
+
+ requires: ['Ext.layout.container.Card', 'Ext.tab.Bar'],
/**
- * Returns true if the column is {@link Ext.grid.Column#hidden hidden}
,
- * false otherwise.
- * @param {Number} colIndex The column index
- * @return {Boolean}
+ * @cfg {String} tabPosition The position where the tab strip should be rendered (defaults to 'top'
).
+ * In 4.0, The only other supported value is 'bottom'
.
*/
- isHidden : function(colIndex){
- return !!this.config[colIndex].hidden; // ensure returns boolean
- },
-
+ tabPosition : 'top',
+
/**
- * Returns true if the column is {@link Ext.grid.Column#fixed fixed}
,
- * false otherwise.
- * @param {Number} colIndex The column index
- * @return {Boolean}
+ * @cfg {Object} tabBar Optional configuration object for the internal {@link Ext.tab.Bar}. If present, this is
+ * passed straight through to the TabBar's constructor
*/
- isFixed : function(colIndex){
- return !!this.config[colIndex].fixed;
- },
/**
- * Returns true if the column can be resized
- * @return {Boolean}
+ * @cfg {Object} layout Optional configuration object for the internal {@link Ext.layout.container.Card card layout}.
+ * If present, this is passed straight through to the layout's constructor
*/
- isResizable : function(colIndex){
- return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true;
- },
+
/**
- * Sets if a column is hidden.
-
-myGrid.getColumnModel().setHidden(0, true); // hide column 0 (0 = the first column).
-
- * @param {Number} colIndex The column index
- * @param {Boolean} hidden True if the column is hidden
+ * @cfg {Boolean} removePanelHeader True to instruct each Panel added to the TabContainer to not render its header
+ * element. This is to ensure that the title of the panel does not appear twice. Defaults to true.
*/
- setHidden : function(colIndex, hidden){
- var c = this.config[colIndex];
- if(c.hidden !== hidden){
- c.hidden = hidden;
- this.totalWidth = null;
- this.fireEvent("hiddenchange", this, colIndex, hidden);
- }
- },
+ removePanelHeader: true,
/**
- * Sets the editor for a column and destroys the prior editor.
- * @param {Number} col The column index
- * @param {Object} editor The editor object
+ * @cfg Boolean plain
+ * True to not show the full background on the TabBar
*/
- setEditor : function(col, editor){
- this.config[col].setEditor(editor);
- },
+ plain: false,
/**
- * Destroys this column model by purging any event listeners, and removing any editors.
+ * @cfg {String} itemCls The class added to each child item of this TabPanel. Defaults to 'x-tabpanel-child'.
*/
- destroy : function(){
- var c;
- for(var i = 0, len = this.config.length; i < len; i++){
- c = this.config[i];
- if(c.setEditor){
- c.setEditor(null);
- }
- }
- this.purgeListeners();
- },
-
+ itemCls: 'x-tabpanel-child',
+
/**
- * @private
- * Setup any saved state for the column, ensures that defaults are applied.
+ * @cfg {Number} minTabWidth The minimum width for a tab in the {@link #tabBar}. Defaults to 30
.
*/
- setState : function(col, state){
- Ext.applyIf(this.config[col], state);
- }
-});
-// private
-Ext.grid.ColumnModel.defaultRenderer = function(value){
- if(typeof value == "string" && value.length < 1){
- return " ";
- }
- return value;
-};/**
- * @class Ext.grid.AbstractSelectionModel
- * @extends Ext.util.Observable
- * Abstract base class for grid SelectionModels. It provides the interface that should be
- * implemented by descendant classes. This class should not be directly instantiated.
- * @constructor
- */
-Ext.grid.AbstractSelectionModel = Ext.extend(Ext.util.Observable, {
/**
- * The GridPanel for which this SelectionModel is handling selection. Read-only.
- * @type Object
- * @property grid
+ * @cfg {Boolean} deferredRender
+ * true by default to defer the rendering of child {@link Ext.container.Container#items items}
+ * to the browsers DOM until a tab is activated. false will render all contained
+ * {@link Ext.container.Container#items items} as soon as the {@link Ext.layout.container.Card layout}
+ * is rendered. If there is a significant amount of content or a lot of heavy controls being
+ * rendered into panels that are not displayed by default, setting this to true might
+ * improve performance.
+ *
The deferredRender property is internally passed to the layout manager for
+ * TabPanels ({@link Ext.layout.container.Card}) as its {@link Ext.layout.container.Card#deferredRender}
+ * configuration value.
+ *
Note: leaving deferredRender as true means that the content
+ * within an unactivated tab will not be available
*/
+ deferredRender : true,
- constructor : function(){
- this.locked = false;
- Ext.grid.AbstractSelectionModel.superclass.constructor.call(this);
- },
+ //inherit docs
+ initComponent: function() {
+ var me = this,
+ dockedItems = me.dockedItems || [],
+ activeTab = me.activeTab || 0;
- /** @ignore Called by the grid automatically. Do not call directly. */
- init : function(grid){
- this.grid = grid;
- if(this.lockOnInit){
- delete this.lockOnInit;
- this.locked = false;
- this.lock();
+ me.layout = Ext.create('Ext.layout.container.Card', Ext.apply({
+ owner: me,
+ deferredRender: me.deferredRender,
+ itemCls: me.itemCls
+ }, me.layout));
+
+ /**
+ * @property tabBar
+ * @type Ext.TabBar
+ * Internal reference to the docked TabBar
+ */
+ me.tabBar = Ext.create('Ext.tab.Bar', Ext.apply({}, me.tabBar, {
+ dock: me.tabPosition,
+ plain: me.plain,
+ border: me.border,
+ cardLayout: me.layout,
+ tabPanel: me
+ }));
+
+ if (dockedItems && !Ext.isArray(dockedItems)) {
+ dockedItems = [dockedItems];
}
- this.initEvents();
+
+ dockedItems.push(me.tabBar);
+ me.dockedItems = dockedItems;
+
+ me.addEvents(
+ /**
+ * @event beforetabchange
+ * Fires before a tab change (activated by {@link #setActiveTab}). Return false in any listener to cancel
+ * the tabchange
+ * @param {Ext.tab.Panel} tabPanel The TabPanel
+ * @param {Ext.Component} newCard The card that is about to be activated
+ * @param {Ext.Component} oldCard The card that is currently active
+ */
+ 'beforetabchange',
+
+ /**
+ * @event tabchange
+ * Fires when a new tab has been activated (activated by {@link #setActiveTab}).
+ * @param {Ext.tab.Panel} tabPanel The TabPanel
+ * @param {Ext.Component} newCard The newly activated item
+ * @param {Ext.Component} oldCard The previously active item
+ */
+ 'tabchange'
+ );
+ me.callParent(arguments);
+
+ //set the active tab
+ me.setActiveTab(activeTab);
+ //set the active tab after initial layout
+ me.on('afterlayout', me.afterInitialLayout, me, {single: true});
},
/**
- * Locks the selections.
+ * @private
+ * We have to wait until after the initial layout to visually activate the activeTab (if set).
+ * The active tab has different margins than normal tabs, so if the initial layout happens with
+ * a tab active, its layout will be offset improperly due to the active margin style. Waiting
+ * until after the initial layout avoids this issue.
*/
- lock : function(){
- if(!this.locked){
- this.locked = true;
- // If the grid has been set, then the view is already initialized.
- var g = this.grid;
- if(g){
- g.getView().on({
- scope: this,
- beforerefresh: this.sortUnLock,
- refresh: this.sortLock
- });
- }else{
- this.lockOnInit = true;
- }
+ afterInitialLayout: function() {
+ var me = this,
+ card = me.getComponent(me.activeTab);
+
+ if (card) {
+ me.layout.setActiveItem(card);
}
},
- // set the lock states before and after a view refresh
- sortLock : function() {
- this.locked = true;
- },
-
- // set the lock states before and after a view refresh
- sortUnLock : function() {
- this.locked = false;
- },
-
/**
- * Unlocks the selections.
+ * Makes the given card active (makes it the visible card in the TabPanel's CardLayout and highlights the Tab)
+ * @param {Ext.Component} card The card to make active
*/
- unlock : function(){
- if(this.locked){
- this.locked = false;
- var g = this.grid,
- gv;
-
- // If the grid has been set, then the view is already initialized.
- if(g){
- gv = g.getView();
- gv.un('beforerefresh', this.sortUnLock, this);
- gv.un('refresh', this.sortLock, this);
- }else{
- delete this.lockOnInit;
+ setActiveTab: function(card) {
+ var me = this,
+ previous;
+
+ card = me.getComponent(card);
+ if (card) {
+ previous = me.getActiveTab();
+
+ if (previous && previous !== card && me.fireEvent('beforetabchange', me, card, previous) === false) {
+ return false;
+ }
+
+ me.tabBar.setActiveTab(card.tab);
+ me.activeTab = card;
+ if (me.rendered) {
+ me.layout.setActiveItem(card);
+ }
+
+ if (previous && previous !== card) {
+ me.fireEvent('tabchange', me, card, previous);
}
}
},
/**
- * Returns true if the selections are locked.
- * @return {Boolean}
+ * Returns the item that is currently active inside this TabPanel. Note that before the TabPanel first activates a
+ * child component this will return whatever was configured in the {@link #activeTab} config option
+ * @return {Ext.Component/Integer} The currently active item
*/
- isLocked : function(){
- return this.locked;
+ getActiveTab: function() {
+ return this.activeTab;
},
- destroy: function(){
- this.unlock();
- this.purgeListeners();
- }
-});/**
- * @class Ext.grid.RowSelectionModel
- * @extends Ext.grid.AbstractSelectionModel
- * The default SelectionModel used by {@link Ext.grid.GridPanel}.
- * It supports multiple selections and keyboard selection/navigation. The objects stored
- * as selections and returned by {@link #getSelected}, and {@link #getSelections} are
- * the {@link Ext.data.Record Record}s which provide the data for the selected rows.
- * @constructor
- * @param {Object} config
- */
-Ext.grid.RowSelectionModel = Ext.extend(Ext.grid.AbstractSelectionModel, {
/**
- * @cfg {Boolean} singleSelect
- * true to allow selection of only one row at a time (defaults to false
- * allowing multiple selections)
+ * Returns the {@link Ext.tab.Bar} currently used in this TabPanel
+ * @return {Ext.TabBar} The TabBar
*/
- singleSelect : false,
-
- constructor : function(config){
- Ext.apply(this, config);
- this.selections = new Ext.util.MixedCollection(false, function(o){
- return o.id;
- });
-
- this.last = false;
- this.lastActive = false;
-
- this.addEvents(
- /**
- * @event selectionchange
- * Fires when the selection changes
- * @param {SelectionModel} this
- */
- 'selectionchange',
- /**
- * @event beforerowselect
- * Fires before a row is selected, return false to cancel the selection.
- * @param {SelectionModel} this
- * @param {Number} rowIndex The index to be selected
- * @param {Boolean} keepExisting False if other selections will be cleared
- * @param {Record} record The record to be selected
- */
- 'beforerowselect',
- /**
- * @event rowselect
- * Fires when a row is selected.
- * @param {SelectionModel} this
- * @param {Number} rowIndex The selected index
- * @param {Ext.data.Record} r The selected record
- */
- 'rowselect',
- /**
- * @event rowdeselect
- * Fires when a row is deselected. To prevent deselection
- * {@link Ext.grid.AbstractSelectionModel#lock lock the selections}.
- * @param {SelectionModel} this
- * @param {Number} rowIndex
- * @param {Record} record
- */
- 'rowdeselect'
- );
- Ext.grid.RowSelectionModel.superclass.constructor.call(this);
+ getTabBar: function() {
+ return this.tabBar;
},
/**
- * @cfg {Boolean} moveEditorOnEnter
- * false to turn off moving the editor to the next row down when the enter key is pressed
- * or the next row up when shift + enter keys are pressed.
+ * @ignore
+ * Makes sure we have a Tab for each item added to the TabPanel
*/
- // private
- initEvents : function(){
-
- if(!this.grid.enableDragDrop && !this.grid.enableDrag){
- this.grid.on('rowmousedown', this.handleMouseDown, this);
- }
+ onAdd: function(item, index) {
+ var me = this;
- this.rowNav = new Ext.KeyNav(this.grid.getGridEl(), {
- 'up' : function(e){
- if(!e.shiftKey || this.singleSelect){
- this.selectPrevious(false);
- }else if(this.last !== false && this.lastActive !== false){
- var last = this.last;
- this.selectRange(this.last, this.lastActive-1);
- this.grid.getView().focusRow(this.lastActive);
- if(last !== false){
- this.last = last;
- }
- }else{
- this.selectFirstRow();
- }
- },
- 'down' : function(e){
- if(!e.shiftKey || this.singleSelect){
- this.selectNext(false);
- }else if(this.last !== false && this.lastActive !== false){
- var last = this.last;
- this.selectRange(this.last, this.lastActive+1);
- this.grid.getView().focusRow(this.lastActive);
- if(last !== false){
- this.last = last;
- }
- }else{
- this.selectFirstRow();
- }
- },
- scope: this
+ item.tab = me.tabBar.insert(index, {
+ xtype: 'tab',
+ card: item,
+ disabled: item.disabled,
+ closable: item.closable,
+ hidden: item.hidden,
+ tabBar: me.tabBar
});
-
- this.grid.getView().on({
- scope: this,
- refresh: this.onRefresh,
- rowupdated: this.onRowUpdated,
- rowremoved: this.onRemove
+
+ item.on({
+ scope : me,
+ enable: me.onItemEnable,
+ disable: me.onItemDisable,
+ beforeshow: me.onItemBeforeShow,
+ iconchange: me.onItemIconChange,
+ titlechange: me.onItemTitleChange
});
- },
-
- // private
- onRefresh : function(){
- var ds = this.grid.store, index;
- var s = this.getSelections();
- this.clearSelections(true);
- for(var i = 0, len = s.length; i < len; i++){
- var r = s[i];
- if((index = ds.indexOfId(r.id)) != -1){
- this.selectRow(index, true);
- }
- }
- if(s.length != this.selections.getCount()){
- this.fireEvent('selectionchange', this);
- }
- },
- // private
- onRemove : function(v, index, r){
- if(this.selections.remove(r) !== false){
- this.fireEvent('selectionchange', this);
+ if (item.isPanel) {
+ if (me.removePanelHeader) {
+ item.preventHeader = true;
+ if (item.rendered) {
+ item.updateHeader();
+ }
+ }
+ if (item.isPanel && me.border) {
+ item.setBorder(false);
+ }
}
- },
- // private
- onRowUpdated : function(v, index, r){
- if(this.isSelected(r)){
- v.onRowSelect(index);
+ // ensure that there is at least one active tab
+ if (this.rendered && me.items.getCount() === 1) {
+ me.setActiveTab(0);
}
},
-
+
/**
- * Select records.
- * @param {Array} records The records to select
- * @param {Boolean} keepExisting (optional) true to keep existing selections
+ * @private
+ * Enable corresponding tab when item is enabled.
*/
- selectRecords : function(records, keepExisting){
- if(!keepExisting){
- this.clearSelections();
- }
- var ds = this.grid.store;
- for(var i = 0, len = records.length; i < len; i++){
- this.selectRow(ds.indexOf(records[i]), true);
- }
+ onItemEnable: function(item){
+ item.tab.enable();
},
/**
- * Gets the number of selected rows.
- * @return {Number}
- */
- getCount : function(){
- return this.selections.length;
+ * @private
+ * Disable corresponding tab when item is enabled.
+ */
+ onItemDisable: function(item){
+ item.tab.disable();
},
-
+
/**
- * Selects the first row in the grid.
+ * @private
+ * Sets activeTab before item is shown.
*/
- selectFirstRow : function(){
- this.selectRow(0);
+ onItemBeforeShow: function(item) {
+ if (item !== this.activeTab) {
+ this.setActiveTab(item);
+ return false;
+ }
},
-
+
/**
- * Select the last row.
- * @param {Boolean} keepExisting (optional) true to keep existing selections
+ * @private
+ * Update the tab iconCls when panel iconCls has been set or changed.
*/
- selectLastRow : function(keepExisting){
- this.selectRow(this.grid.store.getCount() - 1, keepExisting);
+ onItemIconChange: function(item, newIconCls) {
+ item.tab.setIconCls(newIconCls);
+ this.getTabBar().doLayout();
},
-
+
/**
- * Selects the row immediately following the last selected row.
- * @param {Boolean} keepExisting (optional) true to keep existing selections
- * @return {Boolean} true if there is a next row, else false
+ * @private
+ * Update the tab title when panel title has been set or changed.
*/
- selectNext : function(keepExisting){
- if(this.hasNext()){
- this.selectRow(this.last+1, keepExisting);
- this.grid.getView().focusRow(this.last);
- return true;
- }
- return false;
+ onItemTitleChange: function(item, newTitle) {
+ item.tab.setText(newTitle);
+ this.getTabBar().doLayout();
},
+
/**
- * Selects the row that precedes the last selected row.
- * @param {Boolean} keepExisting (optional) true to keep existing selections
- * @return {Boolean} true if there is a previous row, else false
+ * @ignore
+ * If we're removing the currently active tab, activate the nearest one. The item is removed when we call super,
+ * so we can do preprocessing before then to find the card's index
*/
- selectPrevious : function(keepExisting){
- if(this.hasPrevious()){
- this.selectRow(this.last-1, keepExisting);
- this.grid.getView().focusRow(this.last);
- return true;
+ doRemove: function(item, autoDestroy) {
+ var me = this,
+ items = me.items,
+ /**
+ * At this point the item hasn't been removed from the items collection.
+ * As such, if we want to check if there are no more tabs left, we have to
+ * check for one, as opposed to 0.
+ */
+ hasItemsLeft = items.getCount() > 1;
+
+ if (me.destroying || !hasItemsLeft) {
+ me.activeTab = null;
+ } else if (item === me.activeTab) {
+ me.setActiveTab(item.next() || items.getAt(0));
}
- return false;
- },
+ me.callParent(arguments);
- /**
- * Returns true if there is a next record to select
- * @return {Boolean}
- */
- hasNext : function(){
- return this.last !== false && (this.last+1) < this.grid.store.getCount();
+ // Remove the two references
+ delete item.tab.card;
+ delete item.tab;
},
/**
- * Returns true if there is a previous record to select
- * @return {Boolean}
+ * @ignore
+ * Makes sure we remove the corresponding Tab when an item is removed
*/
- hasPrevious : function(){
- return !!this.last;
- },
+ onRemove: function(item, autoDestroy) {
+ var me = this;
+
+ item.un({
+ scope : me,
+ enable: me.onItemEnable,
+ disable: me.onItemDisable,
+ beforeshow: me.onItemBeforeShow
+ });
+ if (!me.destroying && item.tab.ownerCt == me.tabBar) {
+ me.tabBar.remove(item.tab);
+ }
+ }
+});
+/**
+ * @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:
+ *
+ .x-toolbar .x-toolbar-spacer {
+ width:2px;
+ }
+ *
+ * Example usage:
+ * {@img Ext.toolbar.Spacer/Ext.toolbar.Spacer.png Toolbar Spacer}
+ *
+ Ext.create('Ext.panel.Panel', {
+ title: 'Toolbar Spacer Example',
+ width: 300,
+ height: 200,
+ tbar : [
+ 'Item 1',
+ {xtype: 'tbspacer'}, // or ' '
+ 'Item 2',
+ // space width is also configurable via javascript
+ {xtype: 'tbspacer', width: 50}, // add a 50px space
+ 'Item 3'
+ ],
+ renderTo: Ext.getBody()
+ });
+
+ * @constructor
+ * Creates a new Spacer
+ * @xtype tbspacer
+ */
+Ext.define('Ext.toolbar.Spacer', {
+ extend: 'Ext.Component',
+ alias: 'widget.tbspacer',
+ alternateClassName: 'Ext.Toolbar.Spacer',
+ baseCls: Ext.baseCSSPrefix + 'toolbar-spacer',
+ focusable: false
+});
+/**
+ * @class Ext.tree.Column
+ * @extends Ext.grid.column.Column
+ *
+ * Provides indentation and folder structure markup for a Tree taking into account
+ * depth and position within the tree hierarchy.
+ *
+ * @private
+ */
+Ext.define('Ext.tree.Column', {
+ extend: 'Ext.grid.column.Column',
+ alias: 'widget.treecolumn',
- /**
- * Returns the selected records
- * @return {Array} Array of selected records
- */
- getSelections : function(){
- return [].concat(this.selections.items);
+ initComponent: function() {
+ var origRenderer = this.renderer || this.defaultRenderer,
+ origScope = this.scope || window;
+
+ this.renderer = function(value, metaData, record, rowIdx, colIdx, store, view) {
+ var buf = [],
+ format = Ext.String.format,
+ depth = record.getDepth(),
+ treePrefix = Ext.baseCSSPrefix + 'tree-',
+ elbowPrefix = treePrefix + 'elbow-',
+ expanderCls = treePrefix + 'expander',
+ imgText = '',
+ checkboxText= '',
+ formattedValue = origRenderer.apply(origScope, arguments),
+ href = record.get('href'),
+ target = record.get('hrefTarget');
+
+ while (record) {
+ if (!record.isRoot() || (record.isRoot() && view.rootVisible)) {
+ if (record.getDepth() === depth) {
+ buf.unshift(format(imgText,
+ treePrefix + 'icon ' +
+ treePrefix + 'icon' + (record.get('icon') ? '-inline ' : (record.isLeaf() ? '-leaf ' : '-parent ')) +
+ (record.get('iconCls') || ''),
+ record.get('icon') || Ext.BLANK_IMAGE_URL
+ ));
+ if (record.get('checked') !== null) {
+ buf.unshift(format(
+ checkboxText,
+ (treePrefix + 'checkbox') + (record.get('checked') ? ' ' + treePrefix + 'checkbox-checked' : ''),
+ record.get('checked') ? 'aria-checked="true"' : ''
+ ));
+ if (record.get('checked')) {
+ metaData.tdCls += (' ' + Ext.baseCSSPrefix + 'tree-checked');
+ }
+ }
+ if (record.isLast()) {
+ if (record.isLeaf() || (record.isLoaded() && !record.hasChildNodes())) {
+ buf.unshift(format(imgText, (elbowPrefix + 'end'), Ext.BLANK_IMAGE_URL));
+ } else {
+ buf.unshift(format(imgText, (elbowPrefix + 'end-plus ' + expanderCls), Ext.BLANK_IMAGE_URL));
+ }
+
+ } else {
+ if (record.isLeaf() || (record.isLoaded() && !record.hasChildNodes())) {
+ buf.unshift(format(imgText, (treePrefix + 'elbow'), Ext.BLANK_IMAGE_URL));
+ } else {
+ buf.unshift(format(imgText, (elbowPrefix + 'plus ' + expanderCls), Ext.BLANK_IMAGE_URL));
+ }
+ }
+ } else {
+ if (record.isLast() || record.getDepth() === 0) {
+ buf.unshift(format(imgText, (elbowPrefix + 'empty'), Ext.BLANK_IMAGE_URL));
+ } else if (record.getDepth() !== 0) {
+ buf.unshift(format(imgText, (elbowPrefix + 'line'), Ext.BLANK_IMAGE_URL));
+ }
+ }
+ }
+ record = record.parentNode;
+ }
+ if (href) {
+ formattedValue = format('{2}', href, target, formattedValue);
+ }
+ return buf.join("") + formattedValue;
+ };
+ this.callParent(arguments);
},
- /**
- * Returns the first selected record.
- * @return {Record}
+ defaultRenderer: function(value) {
+ return value;
+ }
+});
+/**
+ * @class Ext.tree.View
+ * @extends Ext.view.Table
+ */
+Ext.define('Ext.tree.View', {
+ extend: 'Ext.view.Table',
+ alias: 'widget.treeview',
+
+ loadingCls: Ext.baseCSSPrefix + 'grid-tree-loading',
+ expandedCls: Ext.baseCSSPrefix + 'grid-tree-node-expanded',
+
+ expanderSelector: '.' + Ext.baseCSSPrefix + 'tree-expander',
+ checkboxSelector: '.' + Ext.baseCSSPrefix + 'tree-checkbox',
+ expanderIconOverCls: Ext.baseCSSPrefix + 'tree-expander-over',
+
+ blockRefresh: true,
+
+ /**
+ * @cfg {Boolean} rootVisible false to hide the root node (defaults to true)
*/
- getSelected : function(){
- return this.selections.itemAt(0);
- },
+ rootVisible: true,
- /**
- * Calls the passed function with each selection. If the function returns
- * false, iteration is stopped and this function returns
- * false. Otherwise it returns true.
- * @param {Function} fn The function to call upon each iteration. It is passed the selected {@link Ext.data.Record Record}.
- * @param {Object} scope (optional) The scope (this
reference) in which the function is executed. Defaults to this RowSelectionModel.
- * @return {Boolean} true if all selections were iterated
+ /**
+ * @cfg {Boolean} animate true to enable animated expand/collapse (defaults to the value of {@link Ext#enableFx Ext.enableFx})
*/
- each : function(fn, scope){
- var s = this.getSelections();
- for(var i = 0, len = s.length; i < len; i++){
- if(fn.call(scope || this, s[i], i) === false){
- return false;
+
+ expandDuration: 250,
+ collapseDuration: 250,
+
+ toggleOnDblClick: true,
+
+ initComponent: function() {
+ var me = this;
+
+ if (me.initialConfig.animate === undefined) {
+ me.animate = Ext.enableFx;
+ }
+
+ me.store = Ext.create('Ext.data.NodeStore', {
+ recursive: true,
+ rootVisible: me.rootVisible,
+ listeners: {
+ beforeexpand: me.onBeforeExpand,
+ expand: me.onExpand,
+ beforecollapse: me.onBeforeCollapse,
+ collapse: me.onCollapse,
+ scope: me
}
+ });
+
+ if (me.node) {
+ me.setRootNode(me.node);
}
- return true;
+ me.animQueue = {};
+ me.callParent(arguments);
+ },
+
+ onClear: function(){
+ this.store.removeAll();
},
- /**
- * Clears all selections if the selection model
- * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
- * @param {Boolean} fast (optional) true to bypass the
- * conditional checks and events described in {@link #deselectRow}.
- */
- clearSelections : function(fast){
- if(this.isLocked()){
- return;
- }
- if(fast !== true){
- var ds = this.grid.store;
- var s = this.selections;
- s.each(function(r){
- this.deselectRow(ds.indexOfId(r.id));
- }, this);
- s.clear();
- }else{
- this.selections.clear();
+ setRootNode: function(node) {
+ var me = this;
+ me.store.setNode(node);
+ me.node = node;
+ if (!me.rootVisible) {
+ node.expand();
}
- this.last = false;
},
+
+ onRender: function() {
+ var me = this,
+ opts = {delegate: me.expanderSelector},
+ el;
+ me.callParent(arguments);
- /**
- * Selects all rows if the selection model
- * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
- */
- selectAll : function(){
- if(this.isLocked()){
- return;
- }
- this.selections.clear();
- for(var i = 0, len = this.grid.store.getCount(); i < len; i++){
- this.selectRow(i, true);
- }
+ el = me.el;
+ el.on({
+ scope: me,
+ delegate: me.expanderSelector,
+ mouseover: me.onExpanderMouseOver,
+ mouseout: me.onExpanderMouseOut
+ });
+ el.on({
+ scope: me,
+ delegate: me.checkboxSelector,
+ click: me.onCheckboxChange
+ });
},
- /**
- * Returns true if there is a selection.
- * @return {Boolean}
- */
- hasSelection : function(){
- return this.selections.length > 0;
+ onCheckboxChange: function(e, t) {
+ var item = e.getTarget(this.getItemSelector(), this.getTargetEl()),
+ record, value;
+
+ if (item) {
+ record = this.getRecord(item);
+ value = !record.get('checked');
+ record.set('checked', value);
+ this.fireEvent('checkchange', record, value);
+ }
},
- /**
- * Returns true if the specified row is selected.
- * @param {Number/Record} index The record or index of the record to check
- * @return {Boolean}
- */
- isSelected : function(index){
- var r = Ext.isNumber(index) ? this.grid.store.getAt(index) : index;
- return (r && this.selections.key(r.id) ? true : false);
+ getChecked: function() {
+ var checked = [];
+ this.node.cascadeBy(function(rec){
+ if (rec.get('checked')) {
+ checked.push(rec);
+ }
+ });
+ return checked;
},
+
+ isItemChecked: function(rec){
+ return rec.get('checked');
+ },
+
+ createAnimWrap: function(record, index) {
+ var thHtml = '',
+ headerCt = this.panel.headerCt,
+ headers = headerCt.getGridColumns(),
+ i = 0, len = headers.length, item,
+ node = this.getNode(record),
+ tmpEl, nodeEl;
+
+ for (; i < len; i++) {
+ item = headers[i];
+ thHtml += ' ';
+ }
+
+ nodeEl = Ext.get(node);
+ tmpEl = nodeEl.insertSibling({
+ tag: 'tr',
+ html: [
+ '',
+ '',
+ '',
+ thHtml,
+ '
',
+ '',
+ ' '
+ ].join('')
+ }, 'after');
- /**
- * Returns true if the specified record id is selected.
- * @param {String} id The id of record to check
- * @return {Boolean}
- */
- isIdSelected : function(id){
- return (this.selections.key(id) ? true : false);
+ return {
+ record: record,
+ node: node,
+ el: tmpEl,
+ expanding: false,
+ collapsing: false,
+ animating: false,
+ animateEl: tmpEl.down('div'),
+ targetEl: tmpEl.down('tbody')
+ };
},
- // private
- handleMouseDown : function(g, rowIndex, e){
- if(e.button !== 0 || this.isLocked()){
- return;
+ getAnimWrap: function(parent) {
+ if (!this.animate) {
+ return null;
}
- var view = this.grid.getView();
- if(e.shiftKey && !this.singleSelect && this.last !== false){
- var last = this.last;
- this.selectRange(last, rowIndex, e.ctrlKey);
- this.last = last; // reset the last
- view.focusRow(rowIndex);
- }else{
- var isSelected = this.isSelected(rowIndex);
- if(e.ctrlKey && isSelected){
- this.deselectRow(rowIndex);
- }else if(!isSelected || this.getCount() > 1){
- this.selectRow(rowIndex, e.ctrlKey || e.shiftKey);
- view.focusRow(rowIndex);
+
+ // We are checking to see which parent is having the animation wrap
+ while (parent) {
+ if (parent.animWrap) {
+ return parent.animWrap;
}
+ parent = parent.parentNode;
}
+ return null;
},
- /**
- * Selects multiple rows.
- * @param {Array} rows Array of the indexes of the row to select
- * @param {Boolean} keepExisting (optional) true to keep
- * existing selections (defaults to false)
- */
- selectRows : function(rows, keepExisting){
- if(!keepExisting){
- this.clearSelections();
- }
- for(var i = 0, len = rows.length; i < len; i++){
- this.selectRow(rows[i], true);
+ doAdd: function(nodes, records, index) {
+ // If we are adding records which have a parent that is currently expanding
+ // lets add them to the animation wrap
+ var me = this,
+ record = records[0],
+ parent = record.parentNode,
+ a = me.all.elements,
+ relativeIndex = 0,
+ animWrap = me.getAnimWrap(parent),
+ targetEl, children, len;
+
+ if (!animWrap || !animWrap.expanding) {
+ me.resetScrollers();
+ return me.callParent(arguments);
}
- },
- /**
- * Selects a range of rows if the selection model
- * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
- * All rows in between startRow and endRow are also selected.
- * @param {Number} startRow The index of the first row in the range
- * @param {Number} endRow The index of the last row in the range
- * @param {Boolean} keepExisting (optional) True to retain existing selections
- */
- selectRange : function(startRow, endRow, keepExisting){
- var i;
- if(this.isLocked()){
- return;
+ // We need the parent that has the animWrap, not the nodes parent
+ parent = animWrap.record;
+
+ // If there is an anim wrap we do our special magic logic
+ targetEl = animWrap.targetEl;
+ children = targetEl.dom.childNodes;
+
+ // We subtract 1 from the childrens length because we have a tr in there with the th'es
+ len = children.length - 1;
+
+ // The relative index is the index in the full flat collection minus the index of the wraps parent
+ relativeIndex = index - me.indexOf(parent) - 1;
+
+ // If we are adding records to the wrap that have a higher relative index then there are currently children
+ // it means we have to append the nodes to the wrap
+ if (!len || relativeIndex >= len) {
+ targetEl.appendChild(nodes);
}
- if(!keepExisting){
- this.clearSelections();
+ // If there are already more children then the relative index it means we are adding child nodes of
+ // some expanded node in the anim wrap. In this case we have to insert the nodes in the right location
+ else {
+ // +1 because of the tr with th'es that is already there
+ Ext.fly(children[relativeIndex + 1]).insertSibling(nodes, 'before', true);
}
- if(startRow <= endRow){
- for(i = startRow; i <= endRow; i++){
- this.selectRow(i, true);
- }
- }else{
- for(i = startRow; i >= endRow; i--){
- this.selectRow(i, true);
- }
+
+ // We also have to update the CompositeElementLite collection of the DataView
+ if (index < a.length) {
+ a.splice.apply(a, [index, 0].concat(nodes));
+ }
+ else {
+ a.push.apply(a, nodes);
+ }
+
+ // If we were in an animation we need to now change the animation
+ // because the targetEl just got higher.
+ if (animWrap.isAnimating) {
+ me.onExpand(parent);
}
},
+
+ doRemove: function(record, index) {
+ // If we are adding records which have a parent that is currently expanding
+ // lets add them to the animation wrap
+ var me = this,
+ parent = record.parentNode,
+ all = me.all,
+ animWrap = me.getAnimWrap(record),
+ node = all.item(index).dom;
- /**
- * Deselects a range of rows if the selection model
- * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
- * All rows in between startRow and endRow are also deselected.
- * @param {Number} startRow The index of the first row in the range
- * @param {Number} endRow The index of the last row in the range
- */
- deselectRange : function(startRow, endRow, preventViewNotify){
- if(this.isLocked()){
- return;
- }
- for(var i = startRow; i <= endRow; i++){
- this.deselectRow(i, preventViewNotify);
+ if (!animWrap || !animWrap.collapsing) {
+ me.resetScrollers();
+ return me.callParent(arguments);
}
+
+ animWrap.targetEl.appendChild(node);
+ all.removeElement(index);
},
- /**
- * Selects a row. Before selecting a row, checks if the selection model
- * {@link Ext.grid.AbstractSelectionModel#isLocked is locked} and fires the
- * {@link #beforerowselect} event. If these checks are satisfied the row
- * will be selected and followed up by firing the {@link #rowselect} and
- * {@link #selectionchange} events.
- * @param {Number} row The index of the row to select
- * @param {Boolean} keepExisting (optional) true to keep existing selections
- * @param {Boolean} preventViewNotify (optional) Specify true to
- * prevent notifying the view (disables updating the selected appearance)
- */
- selectRow : function(index, keepExisting, preventViewNotify){
- if(this.isLocked() || (index < 0 || index >= this.grid.store.getCount()) || (keepExisting && this.isSelected(index))){
+ onBeforeExpand: function(parent, records, index) {
+ var me = this,
+ animWrap;
+
+ if (!me.animate) {
return;
}
- var r = this.grid.store.getAt(index);
- if(r && this.fireEvent('beforerowselect', this, index, keepExisting, r) !== false){
- if(!keepExisting || this.singleSelect){
- this.clearSelections();
- }
- this.selections.add(r);
- this.last = this.lastActive = index;
- if(!preventViewNotify){
- this.grid.getView().onRowSelect(index);
+
+ if (me.getNode(parent)) {
+ animWrap = me.getAnimWrap(parent);
+ if (!animWrap) {
+ animWrap = parent.animWrap = me.createAnimWrap(parent);
+ animWrap.animateEl.setHeight(0);
}
- this.fireEvent('rowselect', this, index, r);
- this.fireEvent('selectionchange', this);
+ else if (animWrap.collapsing) {
+ // If we expand this node while it is still expanding then we
+ // have to remove the nodes from the animWrap.
+ animWrap.targetEl.select(me.itemSelector).remove();
+ }
+ animWrap.expanding = true;
+ animWrap.collapsing = false;
}
},
- /**
- * Deselects a row. Before deselecting a row, checks if the selection model
- * {@link Ext.grid.AbstractSelectionModel#isLocked is locked}.
- * If this check is satisfied the row will be deselected and followed up by
- * firing the {@link #rowdeselect} and {@link #selectionchange} events.
- * @param {Number} row The index of the row to deselect
- * @param {Boolean} preventViewNotify (optional) Specify true to
- * prevent notifying the view (disables updating the selected appearance)
- */
- deselectRow : function(index, preventViewNotify){
- if(this.isLocked()){
- return;
- }
- if(this.last == index){
- this.last = false;
+ onExpand: function(parent) {
+ var me = this,
+ queue = me.animQueue,
+ id = parent.getId(),
+ animWrap,
+ animateEl,
+ targetEl,
+ queueItem;
+
+ if (me.singleExpand) {
+ me.ensureSingleExpand(parent);
}
- if(this.lastActive == index){
- this.lastActive = false;
+
+ animWrap = me.getAnimWrap(parent);
+
+ if (!animWrap) {
+ me.resetScrollers();
+ return;
}
- var r = this.grid.store.getAt(index);
- if(r){
- this.selections.remove(r);
- if(!preventViewNotify){
- this.grid.getView().onRowDeselect(index);
+
+ animateEl = animWrap.animateEl;
+ targetEl = animWrap.targetEl;
+
+ animateEl.stopAnimation();
+ // @TODO: we are setting it to 1 because quirks mode on IE seems to have issues with 0
+ queue[id] = true;
+ animateEl.slideIn('t', {
+ duration: me.expandDuration,
+ listeners: {
+ scope: me,
+ lastframe: function() {
+ // Move all the nodes out of the anim wrap to their proper location
+ animWrap.el.insertSibling(targetEl.query(me.itemSelector), 'before');
+ animWrap.el.remove();
+ me.resetScrollers();
+ delete animWrap.record.animWrap;
+ delete queue[id];
+ }
}
- this.fireEvent('rowdeselect', this, index, r);
- this.fireEvent('selectionchange', this);
- }
+ });
+
+ animWrap.isAnimating = true;
},
-
- // private
- restoreLast : function(){
- if(this._last){
- this.last = this._last;
- }
+
+ resetScrollers: function(){
+ var panel = this.panel;
+
+ panel.determineScrollbars();
+ panel.invalidateScroller();
},
- // private
- acceptsNav : function(row, col, cm){
- return !cm.isHidden(col) && cm.isCellEditable(col, row);
- },
+ onBeforeCollapse: function(parent, records, index) {
+ var me = this,
+ animWrap;
+
+ if (!me.animate) {
+ return;
+ }
- // private
- onEditorKey : function(field, e){
- var k = e.getKey(),
- newCell,
- g = this.grid,
- last = g.lastEdit,
- ed = g.activeEditor,
- ae, last, r, c;
- var shift = e.shiftKey;
- if(k == e.TAB){
- e.stopEvent();
- ed.completeEdit();
- if(shift){
- newCell = g.walkCells(ed.row, ed.col-1, -1, this.acceptsNav, this);
- }else{
- newCell = g.walkCells(ed.row, ed.col+1, 1, this.acceptsNav, this);
+ if (me.getNode(parent)) {
+ animWrap = me.getAnimWrap(parent);
+ if (!animWrap) {
+ animWrap = parent.animWrap = me.createAnimWrap(parent, index);
}
- }else if(k == e.ENTER){
- if(this.moveEditorOnEnter !== false){
- if(shift){
- newCell = g.walkCells(last.row - 1, last.col, -1, this.acceptsNav, this);
- }else{
- newCell = g.walkCells(last.row + 1, last.col, 1, this.acceptsNav, this);
- }
+ else if (animWrap.expanding) {
+ // If we collapse this node while it is still expanding then we
+ // have to remove the nodes from the animWrap.
+ animWrap.targetEl.select(this.itemSelector).remove();
}
+ animWrap.expanding = false;
+ animWrap.collapsing = true;
}
- if(newCell){
- r = newCell[0];
- c = newCell[1];
+ },
+
+ onCollapse: function(parent) {
+ var me = this,
+ queue = me.animQueue,
+ id = parent.getId(),
+ animWrap = me.getAnimWrap(parent),
+ animateEl, targetEl;
- if(last.row != r){
- this.selectRow(r); // *** highlight newly-selected cell and update selection
- }
+ if (!animWrap) {
+ me.resetScrollers();
+ return;
+ }
+
+ animateEl = animWrap.animateEl;
+ targetEl = animWrap.targetEl;
- if(g.isEditor && g.editing){ // *** handle tabbing while editorgrid is in edit mode
- ae = g.activeEditor;
- if(ae && ae.field.triggerBlur){
- // *** if activeEditor is a TriggerField, explicitly call its triggerBlur() method
- ae.field.triggerBlur();
- }
+ queue[id] = true;
+
+ // @TODO: we are setting it to 1 because quirks mode on IE seems to have issues with 0
+ animateEl.stopAnimation();
+ animateEl.slideOut('t', {
+ duration: me.collapseDuration,
+ listeners: {
+ scope: me,
+ lastframe: function() {
+ animWrap.el.remove();
+ delete animWrap.record.animWrap;
+ me.resetScrollers();
+ delete queue[id];
+ }
}
- g.startEditing(r, c);
- }
+ });
+ animWrap.isAnimating = true;
},
- destroy : function(){
- if(this.rowNav){
- this.rowNav.disable();
- this.rowNav = null;
- }
- Ext.grid.RowSelectionModel.superclass.destroy.call(this);
- }
-});/**
- * @class Ext.grid.Column
- * This class encapsulates column configuration data to be used in the initialization of a
- * {@link Ext.grid.ColumnModel ColumnModel}.
- * 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.grid.Column = Ext.extend(Object, {
- /**
- * @cfg {Boolean} editable Optional. Defaults to true, enabling the configured
- * {@link #editor}. Set to false to initially disable editing on this column.
- * The initial configuration may be dynamically altered using
- * {@link Ext.grid.ColumnModel}.{@link Ext.grid.ColumnModel#setEditable setEditable()}.
- */
- /**
- * @cfg {String} id Optional. A name which identifies this column (defaults to the column's initial
- * ordinal position.) The id is used to create a CSS class name which is applied to all
- * table cells (including headers) in that column (in this context the id does not need to be
- * unique). The class name takes the form of x-grid3-td-id
- * Header cells will also receive this class name, but will also have the class x-grid3-hd
- * So, to target header cells, use CSS selectors such as:.x-grid3-hd-row .x-grid3-td-id
- * The {@link Ext.grid.GridPanel#autoExpandColumn} grid config option references the column via this
- * unique identifier.
- */
- /**
- * @cfg {String} header Optional. The header text to be used as innerHTML
- * (html tags are accepted) to display in the Grid view. Note: to
- * have a clickable header with no text displayed use ' '.
- */
- /**
- * @cfg {Boolean} groupable Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
- * may be used to disable the header menu item to group by the column selected. Defaults to true,
- * which enables the header menu group option. Set to false to disable (but still show) the
- * group option in the header menu for the column. See also {@link #groupName}
.
- */
- /**
- * @cfg {String} groupName Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
- * may be used to specify the text with which to prefix the group field value in the group header line.
- * See also {@link #groupRenderer} and
- * {@link Ext.grid.GroupingView}.{@link Ext.grid.GroupingView#showGroupName showGroupName}.
- */
- /**
- * @cfg {Function} groupRenderer Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
- * may be used to specify the function used to format the grouping field value for display in the group
- * {@link #groupName header}. If a groupRenderer is not specified, the configured
- * {@link #renderer} will be called; if a {@link #renderer} is also not specified
- * the new value of the group field will be used.
- * The called function (either the groupRenderer or {@link #renderer}) will be
- * passed the following parameters:
- *
- * - v : Object
The new value of the group field.
- * - unused : undefined
Unused parameter.
- * - r : Ext.data.Record
The Record providing the data
- * for the row which caused group change.
- * - rowIndex : Number
The row index of the Record which caused group change.
- * - colIndex : Number
The column index of the group field.
- * - ds : Ext.data.Store
The Store which is providing the data Model.
- *
- * The function should return a string value.
- */
- /**
- * @cfg {String} emptyGroupText Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
- * may be used to specify the text to display when there is an empty group value. Defaults to the
- * {@link Ext.grid.GroupingView}.{@link Ext.grid.GroupingView#emptyGroupText emptyGroupText}.
- */
- /**
- * @cfg {String} dataIndex Required. The name of the field in the
- * grid's {@link Ext.data.Store}'s {@link Ext.data.Record} definition from
- * which to draw the column's value.
- */
- /**
- * @cfg {Number} width
- * Optional. The initial width in pixels of the column.
- * The width of each column can also be affected if any of the following are configured:
- *
- * - {@link Ext.grid.GridPanel}.{@link Ext.grid.GridPanel#autoExpandColumn autoExpandColumn}
- * - {@link Ext.grid.GridView}.{@link Ext.grid.GridView#forceFit forceFit}
- *
- *
By specifying forceFit:true, {@link #fixed non-fixed width} columns will be
- * re-proportioned (based on the relative initial widths) to fill the width of the grid so
- * that no horizontal scrollbar is shown.
- *
- * - {@link Ext.grid.GridView}.{@link Ext.grid.GridView#autoFill autoFill}
- * - {@link Ext.grid.GridPanel}.{@link Ext.grid.GridPanel#minColumnWidth minColumnWidth}
- *
Note: when the width of each column is determined, a space on the right side
- * is reserved for the vertical scrollbar. The
- * {@link Ext.grid.GridView}.{@link Ext.grid.GridView#scrollOffset scrollOffset}
- * can be modified to reduce or eliminate the reserved offset.
- */
- /**
- * @cfg {Boolean} sortable Optional. true if sorting is to be allowed on this column.
- * Defaults to the value of the {@link Ext.grid.ColumnModel#defaultSortable}
property.
- * Whether local/remote sorting is used is specified in {@link Ext.data.Store#remoteSort}
.
- */
- /**
- * @cfg {Boolean} fixed Optional. true if the column width cannot be changed. Defaults to false.
- */
- /**
- * @cfg {Boolean} resizable Optional. false to disable column resizing. Defaults to true.
- */
- /**
- * @cfg {Boolean} menuDisabled Optional. true to disable the column menu. Defaults to false.
- */
- /**
- * @cfg {Boolean} hidden
- * Optional. true to initially hide this column. Defaults to false.
- * A hidden column {@link Ext.grid.GridPanel#enableColumnHide may be shown via the header row menu}.
- * If a column is never to be shown, simply do not include this column in the Column Model at all.
- */
- /**
- * @cfg {String} tooltip Optional. A text string to use as the column header's tooltip. If Quicktips
- * are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the
- * header's HTML title attribute. Defaults to ''.
- */
- /**
- * @cfg {Mixed} renderer
- * For an alternative to specifying a renderer see {@link #xtype}
- * Optional. A renderer is an 'interceptor' method which can be used transform data (value,
- * appearance, etc.) before it is rendered). This may be specified in either of three ways:
- *
- * - A renderer function used to return HTML markup for a cell given the cell's data value.
- * - A string which references a property name of the {@link Ext.util.Format} class which
- * provides a renderer function.
- * - An object specifying both the renderer function, and its execution scope (this
- * reference) e.g.:
-{
- fn: this.gridRenderer,
- scope: this
-}
-
- * If not specified, the default renderer uses the raw data value.
- * For information about the renderer function (passed parameters, etc.), see
- * {@link Ext.grid.ColumnModel#setRenderer}. An example of specifying renderer function inline:
-var companyColumn = {
- header: 'Company Name',
- dataIndex: 'company',
- renderer: function(value, metaData, record, rowIndex, colIndex, store) {
- // provide the logic depending on business rules
- // name of your own choosing to manipulate the cell depending upon
- // the data in the underlying Record object.
- if (value == 'whatever') {
- //metaData.css : String : A CSS class name to add to the TD element of the cell.
- //metaData.attr : String : An html attribute definition string to apply to
- // the data container element within the table
- // cell (e.g. 'style="color:red;"').
- metaData.css = 'name-of-css-class-you-will-define';
- }
- return value;
- }
-}
- *
- * See also {@link #scope}.
- */
- /**
- * @cfg {String} xtype Optional. A String which references a predefined {@link Ext.grid.Column} subclass
- * type which is preconfigured with an appropriate {@link #renderer}
to be easily
- * configured into a ColumnModel. The predefined {@link Ext.grid.Column} subclass types are:
- *
- * - gridcolumn : {@link Ext.grid.Column} (Default)
- * - booleancolumn : {@link Ext.grid.BooleanColumn}
- * - numbercolumn : {@link Ext.grid.NumberColumn}
- * - datecolumn : {@link Ext.grid.DateColumn}
- * - templatecolumn : {@link Ext.grid.TemplateColumn}
- *
- * Configuration properties for the specified xtype
may be specified with
- * the Column configuration properties, for example:
- *
-var grid = new Ext.grid.GridPanel({
- ...
- columns: [{
- header: 'Last Updated',
- dataIndex: 'lastChange',
- width: 85,
- sortable: true,
- //renderer: Ext.util.Format.dateRenderer('m/d/Y'),
- xtype: 'datecolumn', // use xtype instead of renderer
- format: 'M/d/Y' // configuration property for {@link Ext.grid.DateColumn}
- }, {
- ...
- }]
-});
- *
- */
- /**
- * @cfg {Object} scope Optional. The scope (this reference) in which to execute the
- * renderer. Defaults to the Column configuration object.
- */
- /**
- * @cfg {String} align Optional. Set the CSS text-align property of the column. Defaults to undefined.
- */
/**
- * @cfg {String} css Optional. An inline style definition string which is applied to all table cells in the column
- * (excluding headers). Defaults to undefined.
+ * Checks if a node is currently undergoing animation
+ * @private
+ * @param {Ext.data.Model} node The node
+ * @return {Boolean} True if the node is animating
*/
+ isAnimating: function(node) {
+ return !!this.animQueue[node.getId()];
+ },
+
+ collectData: function(records) {
+ var data = this.callParent(arguments),
+ rows = data.rows,
+ len = rows.length,
+ i = 0,
+ row, record;
+
+ for (; i < len; i++) {
+ row = rows[i];
+ record = records[i];
+ if (record.get('qtip')) {
+ row.rowAttr = 'data-qtip="' + record.get('qtip') + '"';
+ if (record.get('qtitle')) {
+ row.rowAttr += ' ' + 'data-qtitle="' + record.get('qtitle') + '"';
+ }
+ }
+ if (record.isExpanded()) {
+ row.rowCls = (row.rowCls || '') + ' ' + this.expandedCls;
+ }
+ if (record.isLoading()) {
+ row.rowCls = (row.rowCls || '') + ' ' + this.loadingCls;
+ }
+ }
+
+ return data;
+ },
+
/**
- * @cfg {Boolean} hideable Optional. Specify as false to prevent the user from hiding this column
- * (defaults to true). To disallow column hiding globally for all columns in the grid, use
- * {@link Ext.grid.GridPanel#enableColumnHide} instead.
+ * Expand a record that is loaded in the view.
+ * @param {Ext.data.Model} record The record to expand
+ * @param {Boolean} deep (optional) True to expand nodes all the way down the tree hierarchy.
+ * @param {Function} callback (optional) The function to run after the expand is completed
+ * @param {Object} scope (optional) The scope of the callback function.
*/
+ expand: function(record, deep, callback, scope) {
+ return record.expand(deep, callback, scope);
+ },
+
/**
- * @cfg {Ext.form.Field} editor Optional. The {@link Ext.form.Field} to use when editing values in this column
- * if editing is supported by the grid. See {@link #editable} also.
+ * Collapse a record that is loaded in the view.
+ * @param {Ext.data.Model} record The record to collapse
+ * @param {Boolean} deep (optional) True to collapse nodes all the way up the tree hierarchy.
+ * @param {Function} callback (optional) The function to run after the collapse is completed
+ * @param {Object} scope (optional) The scope of the callback function.
*/
-
+ collapse: function(record, deep, callback, scope) {
+ return record.collapse(deep, callback, scope);
+ },
+
/**
- * @private
- * @cfg {Boolean} isColumn
- * Used by ColumnModel setConfig method to avoid reprocessing a Column
- * if isColumn
is not set ColumnModel will recreate a new Ext.grid.Column
- * Defaults to true.
+ * Toggle a record between expanded and collapsed.
+ * @param {Ext.data.Record} recordInstance
*/
- isColumn : true,
-
- constructor : function(config){
- Ext.apply(this, config);
-
- if(Ext.isString(this.renderer)){
- this.renderer = Ext.util.Format[this.renderer];
- }else if(Ext.isObject(this.renderer)){
- this.scope = this.renderer.scope;
- this.renderer = this.renderer.fn;
+ toggle: function(record) {
+ this[record.isExpanded() ? 'collapse' : 'expand'](record);
+ },
+
+ onItemDblClick: function(record, item, index) {
+ this.callParent(arguments);
+ if (this.toggleOnDblClick) {
+ this.toggle(record);
}
- if(!this.scope){
- this.scope = this;
+ },
+
+ onBeforeItemMouseDown: function(record, item, index, e) {
+ if (e.getTarget(this.expanderSelector, item)) {
+ return false;
}
-
- var ed = this.editor;
- delete this.editor;
- this.setEditor(ed);
+ return this.callParent(arguments);
},
-
- /**
- * Optional. A function which returns displayable data when passed the following parameters:
- *
- * - value : Object
The data value for the cell.
- * - metadata : Object
An object in which you may set the following attributes:
- * - css : String
A CSS class name to add to the cell's TD element.
- * - attr : String
An HTML attribute definition string to apply to the data container
- * element within the table cell (e.g. 'style="color:red;"').
- * - record : Ext.data.record
The {@link Ext.data.Record} from which the data was
- * extracted.
- * - rowIndex : Number
Row index
- * - colIndex : Number
Column index
- * - store : Ext.data.Store
The {@link Ext.data.Store} object from which the Record
- * was extracted.
- *
- * @property renderer
- * @type Function
- */
- renderer : function(value){
- if(Ext.isString(value) && value.length < 1){
- return ' ';
+
+ onItemClick: function(record, item, index, e) {
+ if (e.getTarget(this.expanderSelector, item)) {
+ this.toggle(record);
+ return false;
}
- return value;
+ return this.callParent(arguments);
},
-
- // private
- getEditor: function(rowIndex){
- return this.editable !== false ? this.editor : null;
+
+ onExpanderMouseOver: function(e, t) {
+ e.getTarget(this.cellSelector, 10, true).addCls(this.expanderIconOverCls);
},
-
- /**
- * Sets a new editor for this column.
- * @param {Ext.Editor/Ext.form.Field} editor The editor to set
- */
- setEditor : function(editor){
- var ed = this.editor;
- if(ed){
- if(ed.gridEditor){
- ed.gridEditor.destroy();
- delete ed.gridEditor;
- }else{
- ed.destroy();
- }
- }
- this.editor = null;
- if(editor){
- //not an instance, create it
- if(!editor.isXType){
- editor = Ext.create(editor, 'textfield');
- }
- this.editor = editor;
- }
+
+ onExpanderMouseOut: function(e, t) {
+ e.getTarget(this.cellSelector, 10, true).removeCls(this.expanderIconOverCls);
},
-
+
/**
- * Returns the {@link Ext.Editor editor} defined for this column that was created to wrap the {@link Ext.form.Field Field}
- * used to edit the cell.
- * @param {Number} rowIndex The row index
- * @return {Ext.Editor}
+ * Gets the base TreeStore from the bound TreePanel.
*/
- getCellEditor: function(rowIndex){
- var ed = this.getEditor(rowIndex);
- if(ed){
- if(!ed.startEdit){
- if(!ed.gridEditor){
- ed.gridEditor = new Ext.grid.GridEditor(ed);
+ getTreeStore: function() {
+ return this.panel.store;
+ },
+
+ ensureSingleExpand: function(node) {
+ var parent = node.parentNode;
+ if (parent) {
+ parent.eachChild(function(child) {
+ if (child !== node && child.isExpanded()) {
+ child.collapse();
}
- ed = ed.gridEditor;
- }
+ });
}
- return ed;
}
});
-
/**
- * @class Ext.grid.BooleanColumn
- * @extends Ext.grid.Column
- * A Column definition class which renders boolean data fields. See the {@link Ext.grid.Column#xtype xtype}
- * config option of {@link Ext.grid.Column} for more details.
+ * @class Ext.tree.Panel
+ * @extends Ext.panel.Table
+ *
+ * The TreePanel provides tree-structured UI representation of tree-structured data.
+ * A TreePanel must be bound to a {@link Ext.data.TreeStore}. TreePanel's support
+ * multiple columns through the {@link columns} configuration.
+ *
+ * Simple TreePanel using inline data.
+ *
+ * {@img Ext.tree.Panel/Ext.tree.Panel1.png Ext.tree.Panel component}
+ *
+ * ## Simple Tree Panel (no columns)
+ *
+ * var store = Ext.create('Ext.data.TreeStore', {
+ * root: {
+ * expanded: true,
+ * text:"",
+ * user:"",
+ * status:"",
+ * children: [
+ * { text:"detention", leaf: true },
+ * { text:"homework", expanded: true,
+ * children: [
+ * { text:"book report", leaf: true },
+ * { text:"alegrbra", leaf: true}
+ * ]
+ * },
+ * { text: "buy lottery tickets", leaf:true }
+ * ]
+ * }
+ * });
+ *
+ * Ext.create('Ext.tree.Panel', {
+ * title: 'Simple Tree',
+ * width: 200,
+ * height: 150,
+ * store: store,
+ * rootVisible: false,
+ * renderTo: Ext.getBody()
+ * });
+ *
+ * @xtype treepanel
*/
-Ext.grid.BooleanColumn = Ext.extend(Ext.grid.Column, {
- /**
- * @cfg {String} trueText
- * The string returned by the renderer when the column value is not falsey (defaults to 'true').
- */
- trueText: 'true',
+Ext.define('Ext.tree.Panel', {
+ extend: 'Ext.panel.Table',
+ alias: 'widget.treepanel',
+ alternateClassName: ['Ext.tree.TreePanel', 'Ext.TreePanel'],
+ requires: ['Ext.tree.View', 'Ext.selection.TreeModel', 'Ext.tree.Column'],
+ viewType: 'treeview',
+ selType: 'treemodel',
+
+ treeCls: Ext.baseCSSPrefix + 'tree-panel',
+
/**
- * @cfg {String} falseText
- * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to
- * 'false').
+ * @cfg {Boolean} lines false to disable tree lines (defaults to true)
*/
- falseText: 'false',
+ lines: true,
+
/**
- * @cfg {String} undefinedText
- * The string returned by the renderer when the column value is undefined (defaults to ' ').
+ * @cfg {Boolean} useArrows true to use Vista-style arrows in the tree (defaults to false)
*/
- undefinedText: ' ',
-
- constructor: function(cfg){
- Ext.grid.BooleanColumn.superclass.constructor.call(this, cfg);
- var t = this.trueText, f = this.falseText, u = this.undefinedText;
- this.renderer = function(v){
- if(v === undefined){
- return u;
- }
- if(!v || v === 'false'){
- return f;
- }
- return t;
- };
- }
-});
-
-/**
- * @class Ext.grid.NumberColumn
- * @extends Ext.grid.Column
- * A Column definition class which renders a numeric data field according to a {@link #format} string. See the
- * {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column} for more details.
- */
-Ext.grid.NumberColumn = Ext.extend(Ext.grid.Column, {
+ useArrows: false,
+
/**
- * @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').
+ * @cfg {Boolean} singleExpand true if only 1 node per branch may be expanded
*/
- format : '0,000.00',
- constructor: function(cfg){
- Ext.grid.NumberColumn.superclass.constructor.call(this, cfg);
- this.renderer = Ext.util.Format.numberRenderer(this.format);
- }
-});
-
-/**
- * @class Ext.grid.DateColumn
- * @extends Ext.grid.Column
- * A Column definition class which renders a passed date according to the default locale, or a configured
- * {@link #format}. See the {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column}
- * for more details.
- */
-Ext.grid.DateColumn = Ext.extend(Ext.grid.Column, {
- /**
- * @cfg {String} format
- * A formatting string as used by {@link Date#format} to format a Date for this Column
- * (defaults to 'm/d/Y').
+ singleExpand: false,
+
+ ddConfig: {
+ enableDrag: true,
+ enableDrop: true
+ },
+
+ /**
+ * @cfg {Boolean} animate true to enable animated expand/collapse (defaults to the value of {@link Ext#enableFx Ext.enableFx})
*/
- format : 'm/d/Y',
- constructor: function(cfg){
- Ext.grid.DateColumn.superclass.constructor.call(this, cfg);
- this.renderer = Ext.util.Format.dateRenderer(this.format);
- }
-});
-
-/**
- * @class Ext.grid.TemplateColumn
- * @extends Ext.grid.Column
- * A Column definition class which renders a value by processing a {@link Ext.data.Record Record}'s
- * {@link Ext.data.Record#data data} using a {@link #tpl configured} {@link Ext.XTemplate XTemplate}.
- * See the {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column} for more
- * details.
- */
-Ext.grid.TemplateColumn = Ext.extend(Ext.grid.Column, {
- /**
- * @cfg {String/XTemplate} tpl
- * An {@link Ext.XTemplate XTemplate}, or an XTemplate definition string to use to process a
- * {@link Ext.data.Record Record}'s {@link Ext.data.Record#data data} to produce a column's rendered value.
+
+ /**
+ * @cfg {Boolean} rootVisible false to hide the root node (defaults to true)
*/
- constructor: function(cfg){
- Ext.grid.TemplateColumn.superclass.constructor.call(this, cfg);
- var tpl = (!Ext.isPrimitive(this.tpl) && this.tpl.compile) ? this.tpl : new Ext.XTemplate(this.tpl);
- this.renderer = function(value, p, r){
- return tpl.apply(r.data);
- };
- this.tpl = tpl;
- }
-});
+ rootVisible: true,
+
+ /**
+ * @cfg {Boolean} displayField The field inside the model that will be used as the node's text. (defaults to text)
+ */
+ displayField: 'text',
-/*
- * @property types
- * @type Object
- * @member Ext.grid.Column
- * @static
- * An object containing predefined Column classes keyed by a mnemonic code which may be referenced
- * by the {@link Ext.grid.ColumnModel#xtype xtype} config option of ColumnModel.
- * This contains the following properties
- * - gridcolumn : {@link Ext.grid.Column Column constructor}
- * - booleancolumn : {@link Ext.grid.BooleanColumn BooleanColumn constructor}
- * - numbercolumn : {@link Ext.grid.NumberColumn NumberColumn constructor}
- * - datecolumn : {@link Ext.grid.DateColumn DateColumn constructor}
- * - templatecolumn : {@link Ext.grid.TemplateColumn TemplateColumn constructor}
- *
- */
-Ext.grid.Column.types = {
- gridcolumn : Ext.grid.Column,
- booleancolumn: Ext.grid.BooleanColumn,
- numbercolumn: Ext.grid.NumberColumn,
- datecolumn: Ext.grid.DateColumn,
- templatecolumn: Ext.grid.TemplateColumn
-};/**
- * @class Ext.grid.RowNumberer
- * This is a utility class that can be passed into a {@link Ext.grid.ColumnModel} as a column config that provides
- * an automatic row numbering column.
- *
Usage:
-
- // This is a typical column config with the first column providing row numbers
- var colModel = new Ext.grid.ColumnModel([
- new Ext.grid.RowNumberer(),
- {header: "Name", width: 80, sortable: true},
- {header: "Code", width: 50, sortable: true},
- {header: "Description", width: 200, sortable: true}
- ]);
-
- * @constructor
- * @param {Object} config The configuration options
- */
-Ext.grid.RowNumberer = Ext.extend(Object, {
- /**
- * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the row
- * number column (defaults to '').
- */
- header: "",
- /**
- * @cfg {Number} width The default width in pixels of the row number column (defaults to 23).
- */
- width: 23,
- /**
- * @cfg {Boolean} sortable True if the row number column is sortable (defaults to false).
- * @hide
+ /**
+ * @cfg {Boolean} root Allows you to not specify a store on this TreePanel. This is useful for creating a simple
+ * tree with preloaded data without having to specify a TreeStore and Model. A store and model will be created and
+ * root will be passed to that store.
*/
- sortable: false,
+ root: null,
- constructor : function(config){
- Ext.apply(this, config);
- if(this.rowspan){
- this.renderer = this.renderer.createDelegate(this);
- }
- },
-
- // private
- fixed:true,
- hideable: false,
- menuDisabled:true,
- dataIndex: '',
- id: 'numberer',
- rowspan: undefined,
+ // Required for the Lockable Mixin. These are the configurations which will be copied to the
+ // normal and locked sub tablepanels
+ normalCfgCopy: ['displayField', 'root', 'singleExpand', 'useArrows', 'lines', 'rootVisible', 'scroll'],
+ lockedCfgCopy: ['displayField', 'root', 'singleExpand', 'useArrows', 'lines', 'rootVisible'],
- // private
- renderer : function(v, p, record, rowIndex){
- if(this.rowspan){
- p.cellAttr = 'rowspan="'+this.rowspan+'"';
- }
- return rowIndex+1;
- }
-});/**
- * @class Ext.grid.CheckboxSelectionModel
- * @extends Ext.grid.RowSelectionModel
- * A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.
- * @constructor
- * @param {Object} config The configuration options
- */
-Ext.grid.CheckboxSelectionModel = Ext.extend(Ext.grid.RowSelectionModel, {
-
- /**
- * @cfg {Boolean} checkOnly true if rows can only be selected by clicking on the
- * checkbox column (defaults to false).
- */
- /**
- * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the
- * checkbox column. Defaults to:
- * '<div class="x-grid3-hd-checker"> </div>'
- *
- * The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header
- * and provides support for automatic check all/none behavior on header click. This string
- * can be replaced by any valid HTML fragment, including a simple text string (e.g.,
- * 'Select Rows'), but the automatic check all/none behavior will only work if the
- * 'x-grid3-hd-checker' class is supplied.
- */
- header : ' ',
/**
- * @cfg {Number} width The default width in pixels of the checkbox column (defaults to 20).
+ * @cfg {Boolean} hideHeaders
+ * Specify as true
to hide the headers.
*/
- width : 20,
+
/**
- * @cfg {Boolean} sortable true if the checkbox column is sortable (defaults to
- * false).
- */
- sortable : false,
-
- // private
- menuDisabled : true,
- fixed : true,
- hideable: false,
- dataIndex : '',
- id : 'checker',
-
- constructor : function(){
- Ext.grid.CheckboxSelectionModel.superclass.constructor.apply(this, arguments);
-
- if(this.checkOnly){
- this.handleMouseDown = Ext.emptyFn;
- }
- },
-
- // private
- initEvents : function(){
- Ext.grid.CheckboxSelectionModel.superclass.initEvents.call(this);
- this.grid.on('render', function(){
- var view = this.grid.getView();
- view.mainBody.on('mousedown', this.onMouseDown, this);
- Ext.fly(view.innerHd).on('mousedown', this.onHdMouseDown, this);
-
- }, this);
- },
-
- // If handleMouseDown was called from another event (enableDragDrop), set a flag so
- // onMouseDown does not process it a second time
- handleMouseDown : function() {
- Ext.grid.CheckboxSelectionModel.superclass.handleMouseDown.apply(this, arguments);
- this.mouseHandled = true;
- },
-
- // private
- onMouseDown : function(e, t){
- if(e.button === 0 && t.className == 'x-grid3-row-checker'){ // Only fire if left-click
- e.stopEvent();
- var row = e.getTarget('.x-grid3-row');
-
- // mouseHandled flag check for a duplicate selection (handleMouseDown) call
- if(!this.mouseHandled && row){
- var index = row.rowIndex;
- if(this.isSelected(index)){
- this.deselectRow(index);
- }else{
- this.selectRow(index, true);
- this.grid.getView().focusRow(index);
- }
- }
+ * @cfg {Boolean} folderSort Set to true to automatically prepend a leaf sorter to the store (defaults to undefined)
+ */
+
+ constructor: function(config) {
+ config = config || {};
+ if (config.animate === undefined) {
+ config.animate = Ext.enableFx;
}
- this.mouseHandled = false;
+ this.enableAnimations = config.animate;
+ delete config.animate;
+
+ this.callParent([config]);
},
+
+ initComponent: function() {
+ var me = this,
+ cls = [me.treeCls];
- // private
- onHdMouseDown : function(e, t){
- if(t.className == 'x-grid3-hd-checker'){
- e.stopEvent();
- var hd = Ext.fly(t.parentNode);
- var isChecked = hd.hasClass('x-grid3-hd-checker-on');
- if(isChecked){
- hd.removeClass('x-grid3-hd-checker-on');
- this.clearSelections();
- }else{
- hd.addClass('x-grid3-hd-checker-on');
- this.selectAll();
- }
+ if (me.useArrows) {
+ cls.push(Ext.baseCSSPrefix + 'tree-arrows');
+ me.lines = false;
}
- },
-
- // private
- renderer : function(v, p, record){
- return ' ';
- }
-});/**
- * @class Ext.grid.CellSelectionModel
- * @extends Ext.grid.AbstractSelectionModel
- * This class provides the basic implementation for single cell selection in a grid.
- * The object stored as the selection contains the following properties:
- *
- * - cell : see {@link #getSelectedCell}
- *
- record : Ext.data.record The {@link Ext.data.Record Record}
- * which provides the data for the row containing the selection
- *
- * @constructor
- * @param {Object} config The object containing the configuration of this model.
- */
-Ext.grid.CellSelectionModel = Ext.extend(Ext.grid.AbstractSelectionModel, {
+
+ if (me.lines) {
+ cls.push(Ext.baseCSSPrefix + 'tree-lines');
+ } else if (!me.useArrows) {
+ cls.push(Ext.baseCSSPrefix + 'tree-no-lines');
+ }
+
+ if (!me.store || Ext.isObject(me.store) && !me.store.isStore) {
+ me.store = Ext.create('Ext.data.TreeStore', Ext.apply({}, me.store || {}, {
+ root: me.root,
+ fields: me.fields,
+ model: me.model,
+ folderSort: me.folderSort
+ }));
+ }
+ else if (me.root) {
+ me.store = Ext.data.StoreManager.lookup(me.store);
+ me.store.setRootNode(me.root);
+ if (me.folderSort !== undefined) {
+ me.store.folderSort = me.folderSort;
+ me.store.sort();
+ }
+ }
+
+ // I'm not sure if we want to this. It might be confusing
+ // if (me.initialConfig.rootVisible === undefined && !me.getRootNode()) {
+ // me.rootVisible = false;
+ // }
+
+ me.viewConfig = Ext.applyIf(me.viewConfig || {}, {
+ rootVisible: me.rootVisible,
+ animate: me.enableAnimations,
+ singleExpand: me.singleExpand,
+ node: me.store.getRootNode(),
+ hideHeaders: me.hideHeaders
+ });
+
+ me.mon(me.store, {
+ scope: me,
+ rootchange: me.onRootChange,
+ clear: me.onClear
+ });
- constructor : function(config){
- Ext.apply(this, config);
-
- this.selection = null;
-
- this.addEvents(
- /**
- * @event beforecellselect
- * Fires before a cell is selected, return false to cancel the selection.
- * @param {SelectionModel} this
- * @param {Number} rowIndex The selected row index
- * @param {Number} colIndex The selected cell index
- */
- "beforecellselect",
- /**
- * @event cellselect
- * Fires when a cell is selected.
- * @param {SelectionModel} this
- * @param {Number} rowIndex The selected row index
- * @param {Number} colIndex The selected cell index
- */
- "cellselect",
- /**
- * @event selectionchange
- * Fires when the active selection changes.
- * @param {SelectionModel} this
- * @param {Object} selection null for no selection or an object with two properties
- *
- * - cell : see {@link #getSelectedCell}
- *
- record : Ext.data.record
The {@link Ext.data.Record Record}
- * which provides the data for the row containing the selection
- *
- */
- "selectionchange"
- );
-
- Ext.grid.CellSelectionModel.superclass.constructor.call(this);
- },
+ me.relayEvents(me.store, [
+ /**
+ * @event beforeload
+ * Event description
+ * @param {Ext.data.Store} store This Store
+ * @param {Ext.data.Operation} operation The Ext.data.Operation object that will be passed to the Proxy to load the Store
+ */
+ 'beforeload',
- /** @ignore */
- initEvents : function(){
- this.grid.on('cellmousedown', this.handleMouseDown, this);
- this.grid.on(Ext.EventManager.useKeydown ? 'keydown' : 'keypress', this.handleKeyDown, this);
- this.grid.getView().on({
- scope: this,
- refresh: this.onViewChange,
- rowupdated: this.onRowUpdated,
- beforerowremoved: this.clearSelections,
- beforerowsinserted: this.clearSelections
+ /**
+ * @event load
+ * Fires whenever the store reads data from a remote data source.
+ * @param {Ext.data.store} this
+ * @param {Array} records An array of records
+ * @param {Boolean} successful True if the operation was successful.
+ */
+ 'load'
+ ]);
+
+ me.store.on({
+ /**
+ * @event itemappend
+ * Fires when a new child node is appended to a node in the tree.
+ * @param {Tree} tree The owner tree
+ * @param {Node} parent The parent node
+ * @param {Node} node The newly appended node
+ * @param {Number} index The index of the newly appended node
+ */
+ append: me.createRelayer('itemappend'),
+
+ /**
+ * @event itemremove
+ * Fires when a child node is removed from a node in the tree
+ * @param {Tree} tree The owner tree
+ * @param {Node} parent The parent node
+ * @param {Node} node The child node removed
+ */
+ remove: me.createRelayer('itemremove'),
+
+ /**
+ * @event itemmove
+ * Fires when a node is moved to a new location in the tree
+ * @param {Tree} tree The owner tree
+ * @param {Node} node The node moved
+ * @param {Node} oldParent The old parent of this node
+ * @param {Node} newParent The new parent of this node
+ * @param {Number} index The index it was moved to
+ */
+ move: me.createRelayer('itemmove'),
+
+ /**
+ * @event iteminsert
+ * Fires when a new child node is inserted in a node in tree
+ * @param {Tree} tree The owner tree
+ * @param {Node} parent The parent node
+ * @param {Node} node The child node inserted
+ * @param {Node} refNode The child node the node was inserted before
+ */
+ insert: me.createRelayer('iteminsert'),
+
+ /**
+ * @event beforeitemappend
+ * Fires before a new child is appended to a node in this tree, return false to cancel the append.
+ * @param {Tree} tree The owner tree
+ * @param {Node} parent The parent node
+ * @param {Node} node The child node to be appended
+ */
+ beforeappend: me.createRelayer('beforeitemappend'),
+
+ /**
+ * @event beforeitemremove
+ * Fires before a child is removed from a node in this tree, return false to cancel the remove.
+ * @param {Tree} tree The owner tree
+ * @param {Node} parent The parent node
+ * @param {Node} node The child node to be removed
+ */
+ beforeremove: me.createRelayer('beforeitemremove'),
+
+ /**
+ * @event beforeitemmove
+ * Fires before a node is moved to a new location in the tree. Return false to cancel the move.
+ * @param {Tree} tree The owner tree
+ * @param {Node} node The node being moved
+ * @param {Node} oldParent The parent of the node
+ * @param {Node} newParent The new parent the node is moving to
+ * @param {Number} index The index it is being moved to
+ */
+ beforemove: me.createRelayer('beforeitemmove'),
+
+ /**
+ * @event beforeiteminsert
+ * Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
+ * @param {Tree} tree The owner tree
+ * @param {Node} parent The parent node
+ * @param {Node} node The child node to be inserted
+ * @param {Node} refNode The child node the node is being inserted before
+ */
+ beforeinsert: me.createRelayer('beforeiteminsert'),
+
+ /**
+ * @event itemexpand
+ * Fires when a node is expanded.
+ * @param {Node} this The expanding node
+ */
+ expand: me.createRelayer('itemexpand'),
+
+ /**
+ * @event itemcollapse
+ * Fires when a node is collapsed.
+ * @param {Node} this The collapsing node
+ */
+ collapse: me.createRelayer('itemcollapse'),
+
+ /**
+ * @event beforeitemexpand
+ * Fires before a node is expanded.
+ * @param {Node} this The expanding node
+ */
+ beforeexpand: me.createRelayer('beforeitemexpand'),
+
+ /**
+ * @event beforeitemcollapse
+ * Fires before a node is collapsed.
+ * @param {Node} this The collapsing node
+ */
+ beforecollapse: me.createRelayer('beforeitemcollapse')
});
- if(this.grid.isEditor){
- this.grid.on('beforeedit', this.beforeEdit, this);
+
+ // If the user specifies the headers collection manually then dont inject our own
+ if (!me.columns) {
+ if (me.initialConfig.hideHeaders === undefined) {
+ me.hideHeaders = true;
+ }
+ me.columns = [{
+ xtype : 'treecolumn',
+ text : 'Name',
+ flex : 1,
+ dataIndex: me.displayField
+ }];
+ }
+
+ if (me.cls) {
+ cls.push(me.cls);
+ }
+ me.cls = cls.join(' ');
+ me.callParent();
+
+ me.relayEvents(me.getView(), [
+ /**
+ * @event checkchange
+ * Fires when a node with a checkbox's checked property changes
+ * @param {Ext.data.Model} node The node who's checked property was changed
+ * @param {Boolean} checked The node's new checked state
+ */
+ 'checkchange'
+ ]);
+
+ // If the root is not visible and there is no rootnode defined, then just lets load the store
+ if (!me.getView().rootVisible && !me.getRootNode()) {
+ me.setRootNode({
+ expanded: true
+ });
}
},
-
- //private
- beforeEdit : function(e){
- this.select(e.row, e.column, false, true, e.record);
+
+ onClear: function(){
+ this.view.onClear();
},
-
- //private
- onRowUpdated : function(v, index, r){
- if(this.selection && this.selection.record == r){
- v.onCellSelect(index, this.selection.cell[1]);
- }
+
+ setRootNode: function() {
+ return this.store.setRootNode.apply(this.store, arguments);
},
-
- //private
- onViewChange : function(){
- this.clearSelections(true);
+
+ getRootNode: function() {
+ return this.store.getRootNode();
},
-
- /**
- * Returns an array containing the row and column indexes of the currently selected cell
- * (e.g., [0, 0]), or null if none selected. The array has elements:
- *
- * - rowIndex : Number
The index of the selected row
- * - cellIndex : Number
The index of the selected cell.
- * Due to possible column reordering, the cellIndex should not be used as an
- * index into the Record's data. Instead, use the cellIndex to determine the name
- * of the selected cell and use the field name to retrieve the data value from the record:
-// get name
-var fieldName = grid.getColumnModel().getDataIndex(cellIndex);
-// get data value based on name
-var data = record.get(fieldName);
- *
- *
- * @return {Array} An array containing the row and column indexes of the selected cell, or null if none selected.
- */
- getSelectedCell : function(){
- return this.selection ? this.selection.cell : null;
+
+ onRootChange: function(root) {
+ this.view.setRootNode(root);
},
/**
- * If anything is selected, clears all selections and fires the selectionchange event.
- * @param {Boolean} preventNotify true to prevent the gridview from
- * being notified about the change.
+ * Retrieve an array of checked records.
+ * @return {Array} An array containing the checked records
*/
- clearSelections : function(preventNotify){
- var s = this.selection;
- if(s){
- if(preventNotify !== true){
- this.grid.view.onCellDeselect(s.cell[0], s.cell[1]);
- }
- this.selection = null;
- this.fireEvent("selectionchange", this, null);
- }
+ getChecked: function() {
+ return this.getView().getChecked();
},
-
+
+ isItemChecked: function(rec) {
+ return rec.get('checked');
+ },
+
/**
- * Returns true if there is a selection.
- * @return {Boolean}
+ * Expand all nodes
+ * @param {Function} callback (optional) A function to execute when the expand finishes.
+ * @param {Object} scope (optional) The scope of the callback function
*/
- hasSelection : function(){
- return this.selection ? true : false;
- },
-
- /** @ignore */
- handleMouseDown : function(g, row, cell, e){
- if(e.button !== 0 || this.isLocked()){
- return;
- }
- this.select(row, cell);
- },
-
- /**
- * Selects a cell. Before selecting a cell, fires the
- * {@link #beforecellselect} event. If this check is satisfied the cell
- * will be selected and followed up by firing the {@link #cellselect} and
- * {@link #selectionchange} events.
- * @param {Number} rowIndex The index of the row to select
- * @param {Number} colIndex The index of the column to select
- * @param {Boolean} preventViewNotify (optional) Specify true to
- * prevent notifying the view (disables updating the selected appearance)
- * @param {Boolean} preventFocus (optional) Whether to prevent the cell at
- * the specified rowIndex / colIndex from being focused.
- * @param {Ext.data.Record} r (optional) The record to select
- */
- select : function(rowIndex, colIndex, preventViewNotify, preventFocus, /*internal*/ r){
- if(this.fireEvent("beforecellselect", this, rowIndex, colIndex) !== false){
- this.clearSelections();
- r = r || this.grid.store.getAt(rowIndex);
- this.selection = {
- record : r,
- cell : [rowIndex, colIndex]
- };
- if(!preventViewNotify){
- var v = this.grid.getView();
- v.onCellSelect(rowIndex, colIndex);
- if(preventFocus !== true){
- v.focusCell(rowIndex, colIndex);
- }
- }
- this.fireEvent("cellselect", this, rowIndex, colIndex);
- this.fireEvent("selectionchange", this, this.selection);
+ expandAll : function(callback, scope) {
+ var root = this.getRootNode();
+ if (root) {
+ root.expand(true, callback, scope);
}
},
- //private
- isSelectable : function(rowIndex, colIndex, cm){
- return !cm.isHidden(colIndex);
- },
-
- // private
- onEditorKey: function(field, e){
- if(e.getKey() == e.TAB){
- this.handleKeyDown(e);
+ /**
+ * Collapse all nodes
+ * @param {Function} callback (optional) A function to execute when the collapse finishes.
+ * @param {Object} scope (optional) The scope of the callback function
+ */
+ collapseAll : function(callback, scope) {
+ var root = this.getRootNode();
+ if (root) {
+ if (this.getView().rootVisible) {
+ root.collapse(true, callback, scope);
+ }
+ else {
+ root.collapseChildren(true, callback, scope);
+ }
}
},
- /** @ignore */
- handleKeyDown : function(e){
- if(!e.isNavKeyPress()){
+ /**
+ * Expand the tree to the path of a particular node.
+ * @param {String} path The path to expand
+ * @param {String} field (optional) The field to get the data from. Defaults to the model idProperty.
+ * @param {String} separator (optional) A separator to use. Defaults to '/'.
+ * @param {Function} callback (optional) A function to execute when the expand finishes. The callback will be called with
+ * (success, lastNode) where success is if the expand was successful and lastNode is the last node that was expanded.
+ * @param {Object} scope (optional) The scope of the callback function
+ */
+ expandPath: function(path, field, separator, callback, scope) {
+ var me = this,
+ current = me.getRootNode(),
+ index = 1,
+ view = me.getView(),
+ keys,
+ expander;
+
+ field = field || me.getRootNode().idProperty;
+ separator = separator || '/';
+
+ if (Ext.isEmpty(path)) {
+ Ext.callback(callback, scope || me, [false, null]);
return;
}
- var k = e.getKey(),
- g = this.grid,
- s = this.selection,
- sm = this,
- walk = function(row, col, step){
- return g.walkCells(
- row,
- col,
- step,
- g.isEditor && g.editing ? sm.acceptsNav : sm.isSelectable, // *** handle tabbing while editorgrid is in edit mode
- sm
- );
- },
- cell, newCell, r, c, ae;
-
- switch(k){
- case e.ESC:
- case e.PAGE_UP:
- case e.PAGE_DOWN:
- // do nothing
- break;
- default:
- // *** call e.stopEvent() only for non ESC, PAGE UP/DOWN KEYS
- e.stopEvent();
- break;
- }
-
- if(!s){
- cell = walk(0, 0, 1); // *** use private walk() function defined above
- if(cell){
- this.select(cell[0], cell[1]);
- }
+ keys = path.split(separator);
+ if (current.get(field) != keys[1]) {
+ // invalid root
+ Ext.callback(callback, scope || me, [false, current]);
return;
}
-
- cell = s.cell; // currently selected cell
- r = cell[0]; // current row
- c = cell[1]; // current column
- switch(k){
- case e.TAB:
- if(e.shiftKey){
- newCell = walk(r, c - 1, -1);
- }else{
- newCell = walk(r, c + 1, 1);
- }
- break;
- case e.DOWN:
- newCell = walk(r + 1, c, 1);
- break;
- case e.UP:
- newCell = walk(r - 1, c, -1);
- break;
- case e.RIGHT:
- newCell = walk(r, c + 1, 1);
- break;
- case e.LEFT:
- newCell = walk(r, c - 1, -1);
- break;
- case e.ENTER:
- if (g.isEditor && !g.editing) {
- g.startEditing(r, c);
- return;
- }
- break;
- }
-
- if(newCell){
- // *** reassign r & c variables to newly-selected cell's row and column
- r = newCell[0];
- c = newCell[1];
-
- this.select(r, c); // *** highlight newly-selected cell and update selection
-
- if(g.isEditor && g.editing){ // *** handle tabbing while editorgrid is in edit mode
- ae = g.activeEditor;
- if(ae && ae.field.triggerBlur){
- // *** if activeEditor is a TriggerField, explicitly call its triggerBlur() method
- ae.field.triggerBlur();
- }
- g.startEditing(r, c);
+ expander = function(){
+ if (++index === keys.length) {
+ Ext.callback(callback, scope || me, [true, current]);
+ return;
}
- }
+ var node = current.findChild(field, keys[index]);
+ if (!node) {
+ Ext.callback(callback, scope || me, [false, current]);
+ return;
+ }
+ current = node;
+ current.expand(false, expander);
+ };
+ current.expand(false, expander);
},
-
- acceptsNav : function(row, col, cm){
- return !cm.isHidden(col) && cm.isCellEditable(col, row);
- }
-});/**
- * @class Ext.grid.EditorGridPanel
- * @extends Ext.grid.GridPanel
- * This class extends the {@link Ext.grid.GridPanel GridPanel Class} to provide cell editing
- * on selected {@link Ext.grid.Column columns}. The editable columns are specified by providing
- * an {@link Ext.grid.ColumnModel#editor editor} in the {@link Ext.grid.Column column configuration}.
- * Editability of columns may be controlled programatically by inserting an implementation
- * of {@link Ext.grid.ColumnModel#isCellEditable isCellEditable} into the
- * {@link Ext.grid.ColumnModel ColumnModel}.
- * Editing is performed on the value of the field specified by the column's
- * {@link Ext.grid.ColumnModel#dataIndex dataIndex} in the backing {@link Ext.data.Store Store}
- * (so if you are using a {@link Ext.grid.ColumnModel#setRenderer renderer} in order to display
- * transformed data, this must be accounted for).
- * If a value-to-description mapping is used to render a column, then a {@link Ext.form.Field#ComboBox ComboBox}
- * which uses the same {@link Ext.form.Field#valueField value}-to-{@link Ext.form.Field#displayFieldField description}
- * mapping would be an appropriate editor.
- * If there is a more complex mismatch between the visible data in the grid, and the editable data in
- * the {@link Edt.data.Store Store}, then code to transform the data both before and after editing can be
- * injected using the {@link #beforeedit} and {@link #afteredit} events.
- * @constructor
- * @param {Object} config The config object
- * @xtype editorgrid
- */
-Ext.grid.EditorGridPanel = Ext.extend(Ext.grid.GridPanel, {
- /**
- * @cfg {Number} clicksToEdit
- * The number of clicks on a cell required to display the cell's editor (defaults to 2).
- * Setting this option to 'auto' means that mousedown on the selected cell starts
- * editing that cell.
- */
- clicksToEdit: 2,
-
- /**
- * @cfg {Boolean} forceValidation
- * True to force validation even if the value is unmodified (defaults to false)
- */
- forceValidation: false,
-
- // private
- isEditor : true,
- // private
- detectEdit: false,
-
+
/**
- * @cfg {Boolean} autoEncode
- * True to automatically HTML encode and decode values pre and post edit (defaults to false)
+ * Expand the tree to the path of a particular node, then selecti t.
+ * @param {String} path The path to select
+ * @param {String} field (optional) The field to get the data from. Defaults to the model idProperty.
+ * @param {String} separator (optional) A separator to use. Defaults to '/'.
+ * @param {Function} callback (optional) A function to execute when the select finishes. The callback will be called with
+ * (bSuccess, oLastNode) where bSuccess is if the select was successful and oLastNode is the last node that was expanded.
+ * @param {Object} scope (optional) The scope of the callback function
*/
- autoEncode : false,
+ selectPath: function(path, field, separator, callback, scope) {
+ var me = this,
+ keys,
+ last;
+
+ field = field || me.getRootNode().idProperty;
+ separator = separator || '/';
+
+ keys = path.split(separator);
+ last = keys.pop();
+
+ me.expandPath(keys.join('/'), field, separator, function(success, node){
+ var doSuccess = false;
+ if (success && node) {
+ node = node.findChild(field, last);
+ if (node) {
+ me.getSelectionModel().select(node);
+ Ext.callback(callback, scope || me, [true, node]);
+ doSuccess = true;
+ }
+ } else if (node === me.getRootNode()) {
+ doSuccess = true;
+ }
+ Ext.callback(callback, scope || me, [doSuccess, node]);
+ }, me);
+ }
+});
+/**
+ * @class Ext.view.DragZone
+ * @extends Ext.dd.DragZone
+ * @private
+ */
+Ext.define('Ext.view.DragZone', {
+ extend: 'Ext.dd.DragZone',
+ containerScroll: false,
- /**
- * @cfg {Boolean} trackMouseOver @hide
- */
- // private
- trackMouseOver: false, // causes very odd FF errors
+ constructor: function(config) {
+ var me = this;
- // private
- initComponent : function(){
- Ext.grid.EditorGridPanel.superclass.initComponent.call(this);
+ Ext.apply(me, config);
- if(!this.selModel){
- /**
- * @cfg {Object} selModel Any subclass of AbstractSelectionModel that will provide the selection model for
- * the grid (defaults to {@link Ext.grid.CellSelectionModel} if not specified).
- */
- this.selModel = new Ext.grid.CellSelectionModel();
+ // Create a ddGroup unless one has been configured.
+ // User configuration of ddGroups allows users to specify which
+ // DD instances can interact with each other. Using one
+ // based on the id of the View would isolate it and mean it can only
+ // interact with a DropZone on the same View also using a generated ID.
+ if (!me.ddGroup) {
+ me.ddGroup = 'view-dd-zone-' + me.view.id;
}
- this.activeEditor = null;
-
- this.addEvents(
- /**
- * @event beforeedit
- * Fires before cell editing is triggered. The edit event object has the following properties
- *
- * - grid - This grid
- * - record - The record being edited
- * - field - The field name being edited
- * - value - The value for the field being edited.
- * - row - The grid row index
- * - column - The grid column index
- * - cancel - Set this to true to cancel the edit or return false from your handler.
- *
- * @param {Object} e An edit event (see above for description)
- */
- "beforeedit",
- /**
- * @event afteredit
- * Fires after a cell is edited. The edit event object has the following properties
- *
- * - grid - This grid
- * - record - The record being edited
- * - field - The field name being edited
- * - value - The value being set
- * - originalValue - The original value for the field, before the edit.
- * - row - The grid row index
- * - column - The grid column index
- *
- *
- *
-grid.on('afteredit', afterEdit, this );
-
-function afterEdit(e) {
- // execute an XHR to send/commit data to the server, in callback do (if successful):
- e.record.commit();
-};
- *
- * @param {Object} e An edit event (see above for description)
- */
- "afteredit",
- /**
- * @event validateedit
- * Fires after a cell is edited, but before the value is set in the record. Return false
- * to cancel the change. The edit event object has the following properties
- *
- * - grid - This grid
- * - record - The record being edited
- * - field - The field name being edited
- * - value - The value being set
- * - originalValue - The original value for the field, before the edit.
- * - row - The grid row index
- * - column - The grid column index
- * - cancel - Set this to true to cancel the edit or return false from your handler.
- *
- * Usage example showing how to remove the red triangle (dirty record indicator) from some
- * records (not all). By observing the grid's validateedit event, it can be cancelled if
- * the edit occurs on a targeted row (for example) and then setting the field's new value
- * in the Record directly:
- *
-grid.on('validateedit', function(e) {
- var myTargetRow = 6;
+ // Ext.dd.DragDrop instances are keyed by the ID of their encapsulating element.
+ // So a View's DragZone cannot use the View's main element because the DropZone must use that
+ // because the DropZone may need to scroll on hover at a scrolling boundary, and it is the View's
+ // main element which handles scrolling.
+ // We use the View's parent element to drag from. Ideally, we would use the internal structure, but that
+ // is transient; DataView's recreate the internal structure dynamically as data changes.
+ // TODO: Ext 5.0 DragDrop must allow multiple DD objects to share the same element.
+ me.callParent([me.view.el.dom.parentNode]);
- if (e.row == myTargetRow) {
- e.cancel = true;
- e.record.data[e.field] = e.value;
- }
-});
- *
- * @param {Object} e An edit event (see above for description)
- */
- "validateedit"
- );
+ me.ddel = Ext.get(document.createElement('div'));
+ me.ddel.addCls(Ext.baseCSSPrefix + 'grid-dd-wrap');
},
- // private
- initEvents : function(){
- Ext.grid.EditorGridPanel.superclass.initEvents.call(this);
-
- this.getGridEl().on('mousewheel', this.stopEditing.createDelegate(this, [true]), this);
- this.on('columnresize', this.stopEditing, this, [true]);
-
- if(this.clicksToEdit == 1){
- this.on("cellclick", this.onCellDblClick, this);
- }else {
- var view = this.getView();
- if(this.clicksToEdit == 'auto' && view.mainBody){
- view.mainBody.on('mousedown', this.onAutoEditClick, this);
- }
- this.on('celldblclick', this.onCellDblClick, this);
- }
+ init: function(id, sGroup, config) {
+ this.initTarget(id, sGroup, config);
+ this.view.mon(this.view, {
+ itemmousedown: this.onItemMouseDown,
+ scope: this
+ });
},
- onResize : function(){
- Ext.grid.EditorGridPanel.superclass.onResize.apply(this, arguments);
- var ae = this.activeEditor;
- if(this.editing && ae){
- ae.realign(true);
+ onItemMouseDown: function(view, record, item, index, e) {
+ if (!this.isPreventDrag(e, record, item, index)) {
+ this.handleMouseDown(e);
}
},
- // private
- onCellDblClick : function(g, row, col){
- this.startEditing(row, col);
+ // private template method
+ isPreventDrag: function(e) {
+ return false;
},
- // private
- onAutoEditClick : function(e, t){
- if(e.button !== 0){
- return;
- }
- var row = this.view.findRowIndex(t),
- col = this.view.findCellIndex(t);
- if(row !== false && col !== false){
- this.stopEditing();
- if(this.selModel.getSelectedCell){ // cell sm
- var sc = this.selModel.getSelectedCell();
- if(sc && sc[0] === row && sc[1] === col){
- this.startEditing(row, col);
- }
- }else{
- if(this.selModel.isSelected(row)){
- this.startEditing(row, col);
- }
- }
- }
- },
+ getDragData: function(e) {
+ var view = this.view,
+ item = e.getTarget(view.getItemSelector()),
+ record, selectionModel, records;
- // private
- onEditComplete : function(ed, value, startValue){
- this.editing = false;
- this.lastActiveEditor = this.activeEditor;
- this.activeEditor = null;
-
- var r = ed.record,
- field = this.colModel.getDataIndex(ed.col);
- value = this.postEditValue(value, startValue, r, field);
- if(this.forceValidation === true || String(value) !== String(startValue)){
- var e = {
- grid: this,
- record: r,
- field: field,
- originalValue: startValue,
- value: value,
- row: ed.row,
- column: ed.col,
- cancel:false
+ if (item) {
+ record = view.getRecord(item);
+ selectionModel = view.getSelectionModel();
+ records = selectionModel.getSelection();
+ return {
+ copy: this.view.copy || (this.view.allowCopy && e.ctrlKey),
+ event: new Ext.EventObjectImpl(e),
+ view: view,
+ ddel: this.ddel,
+ item: item,
+ records: records,
+ fromPosition: Ext.fly(item).getXY()
};
- if(this.fireEvent("validateedit", e) !== false && !e.cancel && String(value) !== String(startValue)){
- r.set(field, e.value);
- delete e.cancel;
- this.fireEvent("afteredit", e);
- }
- }
- this.view.focusCell(ed.row, ed.col);
- },
-
- /**
- * Starts editing the specified for the specified row/column
- * @param {Number} rowIndex
- * @param {Number} colIndex
- */
- startEditing : function(row, col){
- this.stopEditing();
- if(this.colModel.isCellEditable(col, row)){
- this.view.ensureVisible(row, col, true);
- var r = this.store.getAt(row),
- field = this.colModel.getDataIndex(col),
- e = {
- grid: this,
- record: r,
- field: field,
- value: r.data[field],
- row: row,
- column: col,
- cancel:false
- };
- if(this.fireEvent("beforeedit", e) !== false && !e.cancel){
- this.editing = true;
- var ed = this.colModel.getCellEditor(col, row);
- if(!ed){
- return;
- }
- if(!ed.rendered){
- ed.parentEl = this.view.getEditorParent(ed);
- ed.on({
- scope: this,
- render: {
- fn: function(c){
- c.field.focus(false, true);
- },
- single: true,
- scope: this
- },
- specialkey: function(field, e){
- this.getSelectionModel().onEditorKey(field, e);
- },
- complete: this.onEditComplete,
- canceledit: this.stopEditing.createDelegate(this, [true])
- });
- }
- Ext.apply(ed, {
- row : row,
- col : col,
- record : r
- });
- this.lastEdit = {
- row: row,
- col: col
- };
- this.activeEditor = ed;
- // Set the selectSameEditor flag if we are reusing the same editor again and
- // need to prevent the editor from firing onBlur on itself.
- ed.selectSameEditor = (this.activeEditor == this.lastActiveEditor);
- var v = this.preEditValue(r, field);
- ed.startEdit(this.view.getCell(row, col).firstChild, Ext.isDefined(v) ? v : '');
-
- // Clear the selectSameEditor flag
- (function(){
- delete ed.selectSameEditor;
- }).defer(50);
- }
}
},
- // private
- preEditValue : function(r, field){
- var value = r.data[field];
- return this.autoEncode && Ext.isString(value) ? Ext.util.Format.htmlDecode(value) : value;
+ onInitDrag: function(x, y) {
+ var me = this,
+ data = me.dragData,
+ view = data.view,
+ selectionModel = view.getSelectionModel(),
+ record = view.getRecord(data.item),
+ e = data.event;
+
+ // Update the selection to match what would have been selected if the user had
+ // done a full click on the target node rather than starting a drag from it
+ if (!selectionModel.isSelected(record) || e.hasModifier()) {
+ selectionModel.selectWithEvent(record, e);
+ }
+ data.records = selectionModel.getSelection();
+
+ me.ddel.update(me.getDragText());
+ me.proxy.update(me.ddel.dom);
+ me.onStartDrag(x, y);
+ return true;
},
- // private
- postEditValue : function(value, originalValue, r, field){
- return this.autoEncode && Ext.isString(value) ? Ext.util.Format.htmlEncode(value) : value;
+ getDragText: function() {
+ var count = this.dragData.records.length;
+ return Ext.String.format(this.dragText, count, count == 1 ? '' : 's');
},
- /**
- * Stops any active editing
- * @param {Boolean} cancel (optional) True to cancel any changes
- */
- stopEditing : function(cancel){
- if(this.editing){
- // Store the lastActiveEditor to check if it is changing
- var ae = this.lastActiveEditor = this.activeEditor;
- if(ae){
- ae[cancel === true ? 'cancelEdit' : 'completeEdit']();
- this.view.focusCell(ae.row, ae.col);
- }
- this.activeEditor = null;
- }
- this.editing = false;
+ getRepairXY : function(e, data){
+ return data ? data.fromPosition : false;
}
});
-Ext.reg('editorgrid', Ext.grid.EditorGridPanel);// private
-// This is a support class used internally by the Grid components
-Ext.grid.GridEditor = function(field, config){
- Ext.grid.GridEditor.superclass.constructor.call(this, field, config);
- field.monitorTab = false;
-};
-
-Ext.extend(Ext.grid.GridEditor, Ext.Editor, {
- alignment: "tl-tl",
- autoSize: "width",
- hideEl : false,
- cls: "x-small-editor x-grid-editor",
- shim:false,
- shadow:false
-});/**
- * @class Ext.grid.PropertyRecord
- * A specific {@link Ext.data.Record} type that represents a name/value pair and is made to work with the
- * {@link Ext.grid.PropertyGrid}. Typically, PropertyRecords do not need to be created directly as they can be
- * created implicitly by simply using the appropriate data configs either via the {@link Ext.grid.PropertyGrid#source}
- * config property or by calling {@link Ext.grid.PropertyGrid#setSource}. However, if the need arises, these records
- * can also be created explicitly as shwon below. Example usage:
- *
-var rec = new Ext.grid.PropertyRecord({
- name: 'Birthday',
- value: new Date(Date.parse('05/26/1972'))
-});
-// Add record to an already populated grid
-grid.store.addSorted(rec);
-
- * @constructor
- * @param {Object} config A data object in the format: {name: [name], value: [value]}. The specified value's type
- * will be read automatically by the grid to determine the type of editor to use when displaying it.
- */
-Ext.grid.PropertyRecord = Ext.data.Record.create([
- {name:'name',type:'string'}, 'value'
-]);
-
-/**
- * @class Ext.grid.PropertyStore
- * @extends Ext.util.Observable
- * A custom wrapper for the {@link Ext.grid.PropertyGrid}'s {@link Ext.data.Store}. This class handles the mapping
- * between the custom data source objects supported by the grid and the {@link Ext.grid.PropertyRecord} format
- * required for compatibility with the underlying store. Generally this class should not need to be used directly --
- * the grid's data should be accessed from the underlying store via the {@link #store} property.
- * @constructor
- * @param {Ext.grid.Grid} grid The grid this store will be bound to
- * @param {Object} source The source data config object
- */
-Ext.grid.PropertyStore = Ext.extend(Ext.util.Observable, {
-
- constructor : function(grid, source){
- this.grid = grid;
- this.store = new Ext.data.Store({
- recordType : Ext.grid.PropertyRecord
- });
- this.store.on('update', this.onUpdate, this);
- if(source){
- this.setSource(source);
- }
- Ext.grid.PropertyStore.superclass.constructor.call(this);
- },
-
- // protected - should only be called by the grid. Use grid.setSource instead.
- setSource : function(o){
- this.source = o;
- this.store.removeAll();
- var data = [];
- for(var k in o){
- if(this.isEditableValue(o[k])){
- data.push(new Ext.grid.PropertyRecord({name: k, value: o[k]}, k));
- }
- }
- this.store.loadRecords({records: data}, {}, true);
- },
-
- // private
- onUpdate : function(ds, record, type){
- if(type == Ext.data.Record.EDIT){
- var v = record.data.value;
- var oldValue = record.modified.value;
- if(this.grid.fireEvent('beforepropertychange', this.source, record.id, v, oldValue) !== false){
- this.source[record.id] = v;
- record.commit();
- this.grid.fireEvent('propertychange', this.source, record.id, v, oldValue);
- }else{
- record.reject();
- }
- }
- },
-
- // private
- getProperty : function(row){
- return this.store.getAt(row);
- },
-
- // private
- isEditableValue: function(val){
- return Ext.isPrimitive(val) || Ext.isDate(val);
- },
-
- // private
- setValue : function(prop, value, create){
- var r = this.getRec(prop);
- if(r){
- r.set('value', value);
- this.source[prop] = value;
- }else if(create){
- // only create if specified.
- this.source[prop] = value;
- r = new Ext.grid.PropertyRecord({name: prop, value: value}, prop);
- this.store.add(r);
+Ext.define('Ext.tree.ViewDragZone', {
+ extend: 'Ext.view.DragZone',
- }
+ isPreventDrag: function(e, record) {
+ return (record.get('allowDrag') === false) || !!e.getTarget(this.view.expanderSelector);
},
- // private
- remove : function(prop){
- var r = this.getRec(prop);
- if(r){
- this.store.remove(r);
- delete this.source[prop];
+ afterRepair: function() {
+ var me = this,
+ view = me.view,
+ selectedRowCls = view.selectedItemCls,
+ records = me.dragData.records,
+ fly = Ext.fly;
+
+ if (Ext.enableFx && me.repairHighlight) {
+ // Roll through all records and highlight all the ones we attempted to drag.
+ Ext.Array.forEach(records, function(record) {
+ // anonymous fns below, don't hoist up unless below is wrapped in
+ // a self-executing function passing in item.
+ var item = view.getNode(record);
+
+ // We must remove the selected row class before animating, because
+ // the selected row class declares !important on its background-color.
+ fly(item.firstChild).highlight(me.repairHighlightColor, {
+ listeners: {
+ beforeanimate: function() {
+ if (view.isSelected(item)) {
+ fly(item).removeCls(selectedRowCls);
+ }
+ },
+ afteranimate: function() {
+ if (view.isSelected(item)) {
+ fly(item).addCls(selectedRowCls);
+ }
+ }
+ }
+ });
+ });
}
- },
-
- // private
- getRec : function(prop){
- return this.store.getById(prop);
- },
-
- // protected - should only be called by the grid. Use grid.getSource instead.
- getSource : function(){
- return this.source;
+ me.dragging = false;
}
});
-
/**
- * @class Ext.grid.PropertyColumnModel
- * @extends Ext.grid.ColumnModel
- * A custom column model for the {@link Ext.grid.PropertyGrid}. Generally it should not need to be used directly.
- * @constructor
- * @param {Ext.grid.Grid} grid The grid this store will be bound to
- * @param {Object} source The source data config object
+ * @class Ext.tree.ViewDropZone
+ * @extends Ext.view.DropZone
+ * @private
*/
-Ext.grid.PropertyColumnModel = Ext.extend(Ext.grid.ColumnModel, {
- // private - strings used for locale support
- nameText : 'Name',
- valueText : 'Value',
- dateFormat : 'm/j/Y',
- trueText: 'true',
- falseText: 'false',
-
- constructor : function(grid, store){
- var g = Ext.grid,
- f = Ext.form;
-
- this.grid = grid;
- g.PropertyColumnModel.superclass.constructor.call(this, [
- {header: this.nameText, width:50, sortable: true, dataIndex:'name', id: 'name', menuDisabled:true},
- {header: this.valueText, width:50, resizable:false, dataIndex: 'value', id: 'value', menuDisabled:true}
- ]);
- this.store = store;
-
- var bfield = new f.Field({
- autoCreate: {tag: 'select', children: [
- {tag: 'option', value: 'true', html: this.trueText},
- {tag: 'option', value: 'false', html: this.falseText}
- ]},
- getValue : function(){
- return this.el.dom.value == 'true';
- }
- });
- this.editors = {
- 'date' : new g.GridEditor(new f.DateField({selectOnFocus:true})),
- 'string' : new g.GridEditor(new f.TextField({selectOnFocus:true})),
- 'number' : new g.GridEditor(new f.NumberField({selectOnFocus:true, style:'text-align:left;'})),
- 'boolean' : new g.GridEditor(bfield, {
- autoSize: 'both'
- })
- };
- this.renderCellDelegate = this.renderCell.createDelegate(this);
- this.renderPropDelegate = this.renderProp.createDelegate(this);
- },
+Ext.define('Ext.tree.ViewDropZone', {
+ extend: 'Ext.view.DropZone',
- // private
- renderDate : function(dateVal){
- return dateVal.dateFormat(this.dateFormat);
- },
+ /**
+ * @cfg {Boolean} allowParentInsert
+ * Allow inserting a dragged node between an expanded parent node and its first child that will become a
+ * sibling of the parent when dropped (defaults to false)
+ */
+ allowParentInserts: false,
+
+ /**
+ * @cfg {String} allowContainerDrop
+ * True if drops on the tree container (outside of a specific tree node) are allowed (defaults to false)
+ */
+ allowContainerDrops: false,
- // private
- renderBool : function(bVal){
- return this[bVal ? 'trueText' : 'falseText'];
- },
+ /**
+ * @cfg {String} appendOnly
+ * True if the tree should only allow append drops (use for trees which are sorted, defaults to false)
+ */
+ appendOnly: false,
- // private
- isCellEditable : function(colIndex, rowIndex){
- return colIndex == 1;
- },
+ /**
+ * @cfg {String} expandDelay
+ * The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node
+ * over the target (defaults to 500)
+ */
+ expandDelay : 500,
+
+ indicatorCls: 'x-tree-ddindicator',
// private
- getRenderer : function(col){
- return col == 1 ?
- this.renderCellDelegate : this.renderPropDelegate;
+ expandNode : function(node) {
+ var view = this.view;
+ if (!node.isLeaf() && !node.isExpanded()) {
+ view.expand(node);
+ this.expandProcId = false;
+ }
},
// private
- renderProp : function(v){
- return this.getPropertyName(v);
+ queueExpand : function(node) {
+ this.expandProcId = Ext.Function.defer(this.expandNode, this.expandDelay, this, [node]);
},
// private
- renderCell : function(val, meta, rec){
- var renderer = this.grid.customRenderers[rec.get('name')];
- if(renderer){
- return renderer.apply(this, arguments);
- }
- var rv = val;
- if(Ext.isDate(val)){
- rv = this.renderDate(val);
- }else if(typeof val == 'boolean'){
- rv = this.renderBool(val);
+ cancelExpand : function() {
+ if (this.expandProcId) {
+ clearTimeout(this.expandProcId);
+ this.expandProcId = false;
}
- return Ext.util.Format.htmlEncode(rv);
},
- // private
- getPropertyName : function(name){
- var pn = this.grid.propertyNames;
- return pn && pn[name] ? pn[name] : name;
- },
+ getPosition: function(e, node) {
+ var view = this.view,
+ record = view.getRecord(node),
+ y = e.getPageY(),
+ noAppend = record.isLeaf(),
+ noBelow = false,
+ region = Ext.fly(node).getRegion(),
+ fragment;
- // private
- getCellEditor : function(colIndex, rowIndex){
- var p = this.store.getProperty(rowIndex),
- n = p.data.name,
- val = p.data.value;
- if(this.grid.customEditors[n]){
- return this.grid.customEditors[n];
- }
- if(Ext.isDate(val)){
- return this.editors.date;
- }else if(typeof val == 'number'){
- return this.editors.number;
- }else if(typeof val == 'boolean'){
- return this.editors['boolean'];
- }else{
- return this.editors.string;
+ // If we are dragging on top of the root node of the tree, we always want to append.
+ if (record.isRoot()) {
+ return 'append';
}
- },
- // inherit docs
- destroy : function(){
- Ext.grid.PropertyColumnModel.superclass.destroy.call(this);
- for(var ed in this.editors){
- Ext.destroy(this.editors[ed]);
+ // Return 'append' if the node we are dragging on top of is not a leaf else return false.
+ if (this.appendOnly) {
+ return noAppend ? false : 'append';
}
- }
-});
-/**
- * @class Ext.grid.PropertyGrid
- * @extends Ext.grid.EditorGridPanel
- * A specialized grid implementation intended to mimic the traditional property grid as typically seen in
- * development IDEs. Each row in the grid represents a property of some object, and the data is stored
- * as a set of name/value pairs in {@link Ext.grid.PropertyRecord}s. Example usage:
- *
-var grid = new Ext.grid.PropertyGrid({
- title: 'Properties Grid',
- autoHeight: true,
- width: 300,
- renderTo: 'grid-ct',
- source: {
- "(name)": "My Object",
- "Created": new Date(Date.parse('10/15/2006')),
- "Available": false,
- "Version": .01,
- "Description": "A test object"
- }
-});
-
- * @constructor
- * @param {Object} config The grid config object
- */
-Ext.grid.PropertyGrid = Ext.extend(Ext.grid.EditorGridPanel, {
- /**
- * @cfg {Object} propertyNames An object containing property name/display name pairs.
- * If specified, the display name will be shown in the name column instead of the property name.
- */
- /**
- * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
- */
- /**
- * @cfg {Object} customEditors An object containing name/value pairs of custom editor type definitions that allow
- * the grid to support additional types of editable fields. By default, the grid supports strongly-typed editing
- * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
- * associated with a custom input control by specifying a custom editor. The name of the editor
- * type should correspond with the name of the property that will use the editor. Example usage:
- *
-var grid = new Ext.grid.PropertyGrid({
- ...
- customEditors: {
- 'Start Time': new Ext.grid.GridEditor(new Ext.form.TimeField({selectOnFocus:true}))
- },
- source: {
- 'Start Time': '10:00 AM'
- }
-});
-
- */
- /**
- * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
- */
- /**
- * @cfg {Object} customRenderers An object containing name/value pairs of custom renderer type definitions that allow
- * the grid to support custom rendering of fields. By default, the grid supports strongly-typed rendering
- * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
- * associated with the type of the value. The name of the renderer type should correspond with the name of the property
- * that it will render. Example usage:
- *
-var grid = new Ext.grid.PropertyGrid({
- ...
- customRenderers: {
- Available: function(v){
- if(v){
- return 'Yes';
- }else{
- return 'No';
- }
+ if (!this.allowParentInsert) {
+ noBelow = record.hasChildNodes() && record.isExpanded();
}
- },
- source: {
- Available: true
- }
-});
-
- */
- // private config overrides
- enableColumnMove:false,
- stripeRows:false,
- trackMouseOver: false,
- clicksToEdit:1,
- enableHdMenu : false,
- viewConfig : {
- forceFit:true
+ fragment = (region.bottom - region.top) / (noAppend ? 2 : 3);
+ if (y >= region.top && y < (region.top + fragment)) {
+ return 'before';
+ }
+ else if (!noBelow && (noAppend || (y >= (region.bottom - fragment) && y <= region.bottom))) {
+ return 'after';
+ }
+ else {
+ return 'append';
+ }
},
- // private
- initComponent : function(){
- this.customRenderers = this.customRenderers || {};
- this.customEditors = this.customEditors || {};
- this.lastEditRow = null;
- var store = new Ext.grid.PropertyStore(this);
- this.propStore = store;
- var cm = new Ext.grid.PropertyColumnModel(this, store);
- store.store.sort('name', 'ASC');
- this.addEvents(
- /**
- * @event beforepropertychange
- * Fires before a property value changes. Handlers can return false to cancel the property change
- * (this will internally call {@link Ext.data.Record#reject} on the property's record).
- * @param {Object} source The source data object for the grid (corresponds to the same object passed in
- * as the {@link #source} config property).
- * @param {String} recordId The record's id in the data store
- * @param {Mixed} value The current edited property value
- * @param {Mixed} oldValue The original property value prior to editing
- */
- 'beforepropertychange',
- /**
- * @event propertychange
- * Fires after a property value has changed.
- * @param {Object} source The source data object for the grid (corresponds to the same object passed in
- * as the {@link #source} config property).
- * @param {String} recordId The record's id in the data store
- * @param {Mixed} value The current edited property value
- * @param {Mixed} oldValue The original property value prior to editing
- */
- 'propertychange'
- );
- this.cm = cm;
- this.ds = store.store;
- Ext.grid.PropertyGrid.superclass.initComponent.call(this);
+ isValidDropPoint : function(node, position, dragZone, e, data) {
+ if (!node || !data.item) {
+ return false;
+ }
+
+ var view = this.view,
+ targetNode = view.getRecord(node),
+ draggedRecords = data.records,
+ dataLength = draggedRecords.length,
+ ln = draggedRecords.length,
+ i, record;
+
+ // No drop position, or dragged records: invalid drop point
+ if (!(targetNode && position && dataLength)) {
+ return false;
+ }
- this.mon(this.selModel, 'beforecellselect', function(sm, rowIndex, colIndex){
- if(colIndex === 0){
- this.startEditing.defer(200, this, [rowIndex, 1]);
+ // If the targetNode is within the folder we are dragging
+ for (i = 0; i < ln; i++) {
+ record = draggedRecords[i];
+ if (record.isNode && record.contains(targetNode)) {
return false;
}
- }, this);
- },
+ }
+
+ // Respect the allowDrop field on Tree nodes
+ if (position === 'append' && targetNode.get('allowDrop') == false) {
+ return false;
+ }
+ else if (position != 'append' && targetNode.parentNode.get('allowDrop') == false) {
+ return false;
+ }
- // private
- onRender : function(){
- Ext.grid.PropertyGrid.superclass.onRender.apply(this, arguments);
+ // If the target record is in the dragged dataset, then invalid drop
+ if (Ext.Array.contains(draggedRecords, targetNode)) {
+ return false;
+ }
- this.getGridEl().addClass('x-props-grid');
+ // @TODO: fire some event to notify that there is a valid drop possible for the node you're dragging
+ // Yes: this.fireViewEvent(blah....) fires an event through the owning View.
+ return true;
},
- // private
- afterRender: function(){
- Ext.grid.PropertyGrid.superclass.afterRender.apply(this, arguments);
- if(this.source){
- this.setSource(this.source);
+ onNodeOver : function(node, dragZone, e, data) {
+ var position = this.getPosition(e, node),
+ returnCls = this.dropNotAllowed,
+ view = this.view,
+ targetNode = view.getRecord(node),
+ indicator = this.getIndicator(),
+ indicatorX = 0,
+ indicatorY = 0;
+
+ // auto node expand check
+ this.cancelExpand();
+ if (position == 'append' && !this.expandProcId && !Ext.Array.contains(data.records, targetNode) && !targetNode.isLeaf() && !targetNode.isExpanded()) {
+ this.queueExpand(targetNode);
}
- },
+
+ if (this.isValidDropPoint(node, position, dragZone, e, data)) {
+ this.valid = true;
+ this.currentPosition = position;
+ this.overRecord = targetNode;
- /**
- * Sets the source data object containing the property data. The data object can contain one or more name/value
- * pairs representing all of the properties of an object to display in the grid, and this data will automatically
- * be loaded into the grid's {@link #store}. The values should be supplied in the proper data type if needed,
- * otherwise string type will be assumed. If the grid already contains data, this method will replace any
- * existing data. See also the {@link #source} config value. Example usage:
- *
-grid.setSource({
- "(name)": "My Object",
- "Created": new Date(Date.parse('10/15/2006')), // date type
- "Available": false, // boolean type
- "Version": .01, // decimal type
- "Description": "A test object"
-});
-
- * @param {Object} source The data object
- */
- setSource : function(source){
- this.propStore.setSource(source);
+ indicator.setWidth(Ext.fly(node).getWidth());
+ indicatorY = Ext.fly(node).getY() - Ext.fly(view.el).getY() - 1;
+
+ if (position == 'before') {
+ returnCls = targetNode.isFirst() ? Ext.baseCSSPrefix + 'tree-drop-ok-above' : Ext.baseCSSPrefix + 'tree-drop-ok-between';
+ indicator.showAt(0, indicatorY);
+ indicator.toFront();
+ }
+ else if (position == 'after') {
+ returnCls = targetNode.isLast() ? Ext.baseCSSPrefix + 'tree-drop-ok-below' : Ext.baseCSSPrefix + 'tree-drop-ok-between';
+ indicatorY += Ext.fly(node).getHeight();
+ indicator.showAt(0, indicatorY);
+ indicator.toFront();
+ }
+ else {
+ returnCls = Ext.baseCSSPrefix + 'tree-drop-ok-append';
+ // @TODO: set a class on the parent folder node to be able to style it
+ indicator.hide();
+ }
+ }
+ else {
+ this.valid = false;
+ }
+
+ this.currentCls = returnCls;
+ return returnCls;
},
- /**
- * Gets the source data object containing the property data. See {@link #setSource} for details regarding the
- * format of the data object.
- * @return {Object} The data object
- */
- getSource : function(){
- return this.propStore.getSource();
+ onContainerOver : function(dd, e, data) {
+ return e.getTarget('.' + this.indicatorCls) ? this.currentCls : this.dropNotAllowed;
},
- /**
- * Sets the value of a property.
- * @param {String} prop The name of the property to set
- * @param {Mixed} value The value to test
- * @param {Boolean} create (Optional) True to create the property if it doesn't already exist. Defaults to false.
- */
- setProperty : function(prop, value, create){
- this.propStore.setValue(prop, value, create);
+ notifyOut: function() {
+ this.callParent(arguments);
+ this.cancelExpand();
},
-
- /**
- * Removes a property from the grid.
- * @param {String} prop The name of the property to remove
- */
- removeProperty : function(prop){
- this.propStore.remove(prop);
- }
- /**
- * @cfg store
- * @hide
- */
- /**
- * @cfg colModel
- * @hide
- */
- /**
- * @cfg cm
- * @hide
- */
- /**
- * @cfg columns
- * @hide
- */
-});
-Ext.reg("propertygrid", Ext.grid.PropertyGrid);
-/**
- * @class Ext.grid.GroupingView
- * @extends Ext.grid.GridView
- * Adds the ability for single level grouping to the grid. A {@link Ext.data.GroupingStore GroupingStore}
- * must be used to enable grouping. Some grouping characteristics may also be configured at the
- * {@link Ext.grid.Column Column level}
- * {@link Ext.grid.Column#emptyGroupText emptyGroupText}
- * {@link Ext.grid.Column#groupable groupable}
- * {@link Ext.grid.Column#groupName groupName}
- * {@link Ext.grid.Column#groupRender groupRender}
- *
- * Sample usage:
- *
-var grid = new Ext.grid.GridPanel({
- // A groupingStore is required for a GroupingView
- store: new {@link Ext.data.GroupingStore}({
- autoDestroy: true,
- reader: reader,
- data: xg.dummyData,
- sortInfo: {field: 'company', direction: 'ASC'},
- {@link Ext.data.GroupingStore#groupOnSort groupOnSort}: true,
- {@link Ext.data.GroupingStore#remoteGroup remoteGroup}: true,
- {@link Ext.data.GroupingStore#groupField groupField}: 'industry'
- }),
- colModel: new {@link Ext.grid.ColumnModel}({
- columns:[
- {id:'company',header: 'Company', width: 60, dataIndex: 'company'},
- // {@link Ext.grid.Column#groupable groupable}, {@link Ext.grid.Column#groupName groupName}, {@link Ext.grid.Column#groupRender groupRender} are also configurable at column level
- {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price', {@link Ext.grid.Column#groupable groupable}: false},
- {header: 'Change', dataIndex: 'change', renderer: Ext.util.Format.usMoney},
- {header: 'Industry', dataIndex: 'industry'},
- {header: 'Last Updated', renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'}
- ],
- defaults: {
- sortable: true,
- menuDisabled: false,
- width: 20
+ handleNodeDrop : function(data, targetNode, position) {
+ var me = this,
+ view = me.view,
+ parentNode = targetNode.parentNode,
+ store = view.getStore(),
+ recordDomNodes = [],
+ records, i, len,
+ insertionMethod, argList,
+ needTargetExpand,
+ transferData,
+ processDrop;
+
+ // If the copy flag is set, create a copy of the Models with the same IDs
+ if (data.copy) {
+ records = data.records;
+ data.records = [];
+ for (i = 0, len = records.length; i < len; i++) {
+ data.records.push(Ext.apply({}, records[i].data));
+ }
+ }
+
+ // Cancel any pending expand operation
+ me.cancelExpand();
+
+ // Grab a reference to the correct node insertion method.
+ // Create an arg list array intended for the apply method of the
+ // chosen node insertion method.
+ // Ensure the target object for the method is referenced by 'targetNode'
+ if (position == 'before') {
+ insertionMethod = parentNode.insertBefore;
+ argList = [null, targetNode];
+ targetNode = parentNode;
+ }
+ else if (position == 'after') {
+ if (targetNode.nextSibling) {
+ insertionMethod = parentNode.insertBefore;
+ argList = [null, targetNode.nextSibling];
+ }
+ else {
+ insertionMethod = parentNode.appendChild;
+ argList = [null];
+ }
+ targetNode = parentNode;
+ }
+ else {
+ if (!targetNode.isExpanded()) {
+ needTargetExpand = true;
+ }
+ insertionMethod = targetNode.appendChild;
+ argList = [null];
}
- }),
- view: new Ext.grid.GroupingView({
- {@link Ext.grid.GridView#forceFit forceFit}: true,
- // custom grouping text template to display the number of items per group
- {@link #groupTextTpl}: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
- }),
+ // A function to transfer the data into the destination tree
+ transferData = function() {
+ var node;
+ for (i = 0, len = data.records.length; i < len; i++) {
+ argList[0] = data.records[i];
+ node = insertionMethod.apply(targetNode, argList);
+
+ if (Ext.enableFx && me.dropHighlight) {
+ recordDomNodes.push(view.getNode(node));
+ }
+ }
+
+ // Kick off highlights after everything's been inserted, so they are
+ // more in sync without insertion/render overhead.
+ if (Ext.enableFx && me.dropHighlight) {
+ //FIXME: the check for n.firstChild is not a great solution here. Ideally the line should simply read
+ //Ext.fly(n.firstChild) but this yields errors in IE6 and 7. See ticket EXTJSIV-1705 for more details
+ Ext.Array.forEach(recordDomNodes, function(n) {
+ Ext.fly(n.firstChild ? n.firstChild : n).highlight(me.dropHighlightColor);
+ });
+ }
+ };
- frame:true,
- width: 700,
- height: 450,
- collapsible: true,
- animCollapse: false,
- title: 'Grouping Example',
- iconCls: 'icon-grid',
- renderTo: document.body
+ // If dropping right on an unexpanded node, transfer the data after it is expanded.
+ if (needTargetExpand) {
+ targetNode.expand(false, transferData);
+ }
+ // Otherwise, call the data transfer function immediately
+ else {
+ transferData();
+ }
+ }
});
- *
- * @constructor
- * @param {Object} config
+/**
+ * @class Ext.tree.ViewDDPlugin
+ * @extends Ext.AbstractPlugin
+ * This plugin provides drag and/or drop functionality for a TreeView.
+ * It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a {@link Ext.tree.View TreeView}
+ * and loads the data object which is passed to a cooperating {@link Ext.dd.DragZone DragZone}'s methods with the following properties:
+ * - copy : Boolean
+ * The value of the TreeView's
copy
property, or true
if the TreeView was configured
+ * with allowCopy: true
and the control key was pressed when the drag operation was begun.
+ * - view : TreeView
+ * The source TreeView from which the drag originated.
+ * - ddel : HtmlElement
+ * The drag proxy element which moves with the mouse
+ * - item : HtmlElement
+ * The TreeView node upon which the mousedown event was registered.
+ * - records : Array
+ * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source TreeView.
+ *
+ * It also creates a specialized instance of {@link Ext.dd.DropZone} which cooperates with other DropZones which are members of the same
+ * ddGroup which processes such data objects.
+ * Adding this plugin to a view means that two new events may be fired from the client TreeView, {@link #event-beforedrop beforedrop}
and
+ * {@link #event-drop drop}
*/
-Ext.grid.GroupingView = Ext.extend(Ext.grid.GridView, {
+Ext.define('Ext.tree.plugin.TreeViewDragDrop', {
+ extend: 'Ext.AbstractPlugin',
+ alias: 'plugin.treeviewdragdrop',
+
+ uses: [
+ 'Ext.tree.ViewDragZone',
+ 'Ext.tree.ViewDropZone'
+ ],
/**
- * @cfg {String} groupByText Text displayed in the grid header menu for grouping by a column
- * (defaults to 'Group By This Field').
+ * @event beforedrop
+ * This event is fired through the TreeView. Add listeners to the TreeView object
+ * Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the TreeView.
+ * @param {HtmlElement} node The TreeView node if any over which the mouse was positioned.
+ * Returning false
to this event signals that the drop gesture was invalid, and if the drag proxy
+ * will animate back to the point from which the drag began.
+ * Returning 0
To this event signals that the data transfer operation should not take place, but
+ * that the gesture was valid, and that the repair operation should not take place.
+ * Any other return value continues with the data transfer operation.
+ * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
+ * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:
+ * - copy : Boolean
+ * The value of the TreeView's
copy
property, or true
if the TreeView was configured
+ * with allowCopy: true
and the control key was pressed when the drag operation was begun
+ * - view : TreeView
+ * The source TreeView from which the drag originated.
+ * - ddel : HtmlElement
+ * The drag proxy element which moves with the mouse
+ * - item : HtmlElement
+ * The TreeView node upon which the mousedown event was registered.
+ * - records : Array
+ * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source TreeView.
+ *
+ * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
+ * @param {String} dropPosition "before"
, "after"
or "append"
depending on whether the mouse is above or below the midline of the node,
+ * or the node is a branch node which accepts new child nodes.
+ * @param {Function} dropFunction A function to call to complete the data transfer operation and either move or copy Model instances from the source
+ * View's Store to the destination View's Store.
+ * This is useful when you want to perform some kind of asynchronous processing before confirming
+ * the drop, such as an {@link Ext.window.MessageBox#confirm confirm} call, or an Ajax request.
+ * Return 0
from this event handler, and call the dropFunction
at any time to perform the data transfer.
+ */
+
+ /**
+ * @event drop
+ * This event is fired through the TreeView. Add listeners to the TreeView object
+ * Fired when a drop operation has been completed and the data has been moved or copied.
+ * @param {HtmlElement} node The TreeView node if any over which the mouse was positioned.
+ * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
+ * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:
+ * - copy : Boolean
+ * The value of the TreeView's
copy
property, or true
if the TreeView was configured
+ * with allowCopy: true
and the control key was pressed when the drag operation was begun
+ * - view : TreeView
+ * The source TreeView from which the drag originated.
+ * - ddel : HtmlElement
+ * The drag proxy element which moves with the mouse
+ * - item : HtmlElement
+ * The TreeView node upon which the mousedown event was registered.
+ * - records : Array
+ * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source TreeView.
+ *
+ * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
+ * @param {String} dropPosition "before"
, "after"
or "append"
depending on whether the mouse is above or below the midline of the node,
+ * or the node is a branch node which accepts new child nodes.
*/
- groupByText : 'Group By This Field',
+
+ dragText : '{0} selected node{1}',
+
/**
- * @cfg {String} showGroupsText Text displayed in the grid header for enabling/disabling grouping
- * (defaults to 'Show in Groups').
+ * @cfg {Boolean} allowParentInsert
+ * Allow inserting a dragged node between an expanded parent node and its first child that will become a
+ * sibling of the parent when dropped (defaults to false)
*/
- showGroupsText : 'Show in Groups',
+ allowParentInserts: false,
+
/**
- * @cfg {Boolean} hideGroupedColumn true to hide the column that is currently grouped (defaults to false)
+ * @cfg {String} allowContainerDrop
+ * True if drops on the tree container (outside of a specific tree node) are allowed (defaults to false)
*/
- hideGroupedColumn : false,
+ allowContainerDrops: false,
+
/**
- * @cfg {Boolean} showGroupName If true will display a prefix plus a ': ' before the group field value
- * in the group header line. The prefix will consist of the {@link Ext.grid.Column#groupName groupName}
- * (or the configured {@link Ext.grid.Column#header header} if not provided) configured in the
- * {@link Ext.grid.Column} for each set of grouped rows (defaults to true).
+ * @cfg {String} appendOnly
+ * True if the tree should only allow append drops (use for trees which are sorted, defaults to false)
*/
- showGroupName : true,
+ appendOnly: false,
+
/**
- * @cfg {Boolean} startCollapsed true to start all groups collapsed (defaults to false)
+ * @cfg {String} ddGroup
+ * A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone
+ * used by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
*/
- startCollapsed : false,
+ ddGroup : "TreeDD",
+
/**
- * @cfg {Boolean} enableGrouping false to disable grouping functionality (defaults to true)
+ * @cfg {String} dragGroup
+ * The ddGroup to which the DragZone will belong.
+ * This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones
+ * which are members of the same ddGroup.
*/
- enableGrouping : true,
+
/**
- * @cfg {Boolean} enableGroupingMenu true to enable the grouping control in the column menu (defaults to true)
+ * @cfg {String} dropGroup
+ * The ddGroup to which the DropZone will belong.
+ * This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones
+ * which are members of the same ddGroup.
*/
- enableGroupingMenu : true,
+
/**
- * @cfg {Boolean} enableNoGroups true to allow the user to turn off grouping (defaults to true)
+ * @cfg {String} expandDelay
+ * The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node
+ * over the target (defaults to 1000)
*/
- enableNoGroups : true,
+ expandDelay : 1000,
+
/**
- * @cfg {String} emptyGroupText The text to display when there is an empty group value (defaults to '(None)').
- * May also be specified per column, see {@link Ext.grid.Column}.{@link Ext.grid.Column#emptyGroupText emptyGroupText}.
+ * @cfg {Boolean} enableDrop
+ * Defaults to true
+ * Set to false
to disallow the View from accepting drop gestures
*/
- emptyGroupText : '(None)',
+ enableDrop: true,
+
/**
- * @cfg {Boolean} ignoreAdd true to skip refreshing the view when new rows are added (defaults to false)
+ * @cfg {Boolean} enableDrag
+ * Defaults to true
+ * Set to false
to disallow dragging items from the View
*/
- ignoreAdd : false,
+ enableDrag: true,
+
/**
- * @cfg {String} groupTextTpl The template used to render the group header (defaults to '{text}').
- * This is used to format an object which contains the following properties:
- *
- * - group : String
The rendered value of the group field.
- * By default this is the unchanged value of the group field. If a {@link Ext.grid.Column#groupRenderer groupRenderer}
- * is specified, it is the result of a call to that function.
- * - gvalue : Object
The raw value of the group field.
- * - text : String
The configured header (as described in {@link #showGroupName})
- * if {@link #showGroupName} is true) plus the rendered group field value.
- * - groupId : String
A unique, generated ID which is applied to the
- * View Element which contains the group.
- * - startRow : Number
The row index of the Record which caused group change.
- * - rs : Array
Contains a single element: The Record providing the data
- * for the row which caused group change.
- * - cls : String
The generated class name string to apply to the group header Element.
- * - style : String
The inline style rules to apply to the group header Element.
- *
- * See {@link Ext.XTemplate} for information on how to format data using a template. Possible usage:
-var grid = new Ext.grid.GridPanel({
- ...
- view: new Ext.grid.GroupingView({
- groupTextTpl: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
- }),
-});
- *
+ * @cfg {String} nodeHighlightColor The color to use when visually highlighting the dragged
+ * or dropped node (defaults to 'c3daf9' - light blue). The color must be a 6 digit hex value, without
+ * a preceding '#'. See also {@link #nodeHighlightOnDrop} and {@link #nodeHighlightOnRepair}.
*/
- groupTextTpl : '{text}',
-
+ nodeHighlightColor: 'c3daf9',
+
/**
- * @cfg {String} groupMode Indicates how to construct the group identifier. 'value' constructs the id using
- * raw value, 'display' constructs the id using the rendered value. Defaults to 'value'.
+ * @cfg {Boolean} nodeHighlightOnDrop Whether or not to highlight any nodes after they are
+ * successfully dropped on their target. Defaults to the value of `Ext.enableFx`.
+ * See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnRepair}.
+ * @markdown
*/
- groupMode: 'value',
-
+ nodeHighlightOnDrop: Ext.enableFx,
+
/**
- * @cfg {Function} groupRenderer This property must be configured in the {@link Ext.grid.Column} for
- * each column.
+ * @cfg {Boolean} nodeHighlightOnRepair Whether or not to highlight any nodes after they are
+ * repaired from an unsuccessful drag/drop. Defaults to the value of `Ext.enableFx`.
+ * See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnDrop}.
+ * @markdown
*/
+ nodeHighlightOnRepair: Ext.enableFx,
- // private
- initTemplates : function(){
- Ext.grid.GroupingView.superclass.initTemplates.call(this);
- this.state = {};
-
- var sm = this.grid.getSelectionModel();
- sm.on(sm.selectRow ? 'beforerowselect' : 'beforecellselect',
- this.onBeforeRowSelect, this);
-
- if(!this.startGroup){
- this.startGroup = new Ext.XTemplate(
- '',
- '', this.groupTextTpl ,'',
- ''
- );
- }
- this.startGroup.compile();
-
- if (!this.endGroup) {
- this.endGroup = '';
- }
+ init : function(view) {
+ view.on('render', this.onViewRender, this, {single: true});
},
- // private
- findGroup : function(el){
- return Ext.fly(el).up('.x-grid-group', this.mainBody.dom);
+ /**
+ * @private
+ * AbstractComponent calls destroy on all its plugins at destroy time.
+ */
+ destroy: function() {
+ Ext.destroy(this.dragZone, this.dropZone);
},
- // private
- getGroups : function(){
- return this.hasRows() ? this.mainBody.dom.childNodes : [];
- },
+ onViewRender : function(view) {
+ var me = this;
- // private
- onAdd : function(ds, records, index) {
- if (this.canGroup() && !this.ignoreAdd) {
- var ss = this.getScrollState();
- this.fireEvent('beforerowsinserted', ds, index, index + (records.length-1));
- this.refresh();
- this.restoreScroll(ss);
- this.fireEvent('rowsinserted', ds, index, index + (records.length-1));
- } else if (!this.canGroup()) {
- Ext.grid.GroupingView.superclass.onAdd.apply(this, arguments);
+ if (me.enableDrag) {
+ me.dragZone = Ext.create('Ext.tree.ViewDragZone', {
+ view: view,
+ ddGroup: me.dragGroup || me.ddGroup,
+ dragText: me.dragText,
+ repairHighlightColor: me.nodeHighlightColor,
+ repairHighlight: me.nodeHighlightOnRepair
+ });
}
- },
- // private
- onRemove : function(ds, record, index, isUpdate){
- Ext.grid.GroupingView.superclass.onRemove.apply(this, arguments);
- var g = document.getElementById(record._groupId);
- if(g && g.childNodes[1].childNodes.length < 1){
- Ext.removeNode(g);
+ if (me.enableDrop) {
+ me.dropZone = Ext.create('Ext.tree.ViewDropZone', {
+ view: view,
+ ddGroup: me.dropGroup || me.ddGroup,
+ allowContainerDrops: me.allowContainerDrops,
+ appendOnly: me.appendOnly,
+ allowParentInserts: me.allowParentInserts,
+ expandDelay: me.expandDelay,
+ dropHighlightColor: me.nodeHighlightColor,
+ dropHighlight: me.nodeHighlightOnDrop
+ });
}
- this.applyEmptyText();
+ }
+});
+/**
+ * @class Ext.util.Cookies
+
+Utility class for setting/reading values from browser cookies.
+Values can be written using the {@link #set} method.
+Values can be read using the {@link #get} method.
+A cookie can be invalidated on the client machine using the {@link #clear} method.
+
+ * @markdown
+ * @singleton
+ */
+Ext.define('Ext.util.Cookies', {
+ singleton: true,
+
+ /**
+ * Create a cookie with the specified name and value. Additional settings
+ * for the cookie may be optionally specified (for example: expiration,
+ * access restriction, SSL).
+ * @param {String} name The name of the cookie to set.
+ * @param {Mixed} value The value to set for the cookie.
+ * @param {Object} expires (Optional) Specify an expiration date the
+ * cookie is to persist until. Note that the specified Date object will
+ * be converted to Greenwich Mean Time (GMT).
+ * @param {String} path (Optional) Setting a path on the cookie restricts
+ * access to pages that match that path. Defaults to all pages ('/').
+ * @param {String} domain (Optional) Setting a domain restricts access to
+ * pages on a given domain (typically used to allow cookie access across
+ * subdomains). For example, "sencha.com" will create a cookie that can be
+ * accessed from any subdomain of sencha.com, including www.sencha.com,
+ * support.sencha.com, etc.
+ * @param {Boolean} secure (Optional) Specify true to indicate that the cookie
+ * should only be accessible via SSL on a page using the HTTPS protocol.
+ * Defaults to false. Note that this will only work if the page
+ * calling this code uses the HTTPS protocol, otherwise the cookie will be
+ * created with default options.
+ */
+ set : function(name, value){
+ var argv = arguments,
+ argc = arguments.length,
+ expires = (argc > 2) ? argv[2] : null,
+ path = (argc > 3) ? argv[3] : '/',
+ domain = (argc > 4) ? argv[4] : null,
+ secure = (argc > 5) ? argv[5] : false;
+
+ document.cookie = name + "=" + escape(value) + ((expires === null) ? "" : ("; expires=" + expires.toGMTString())) + ((path === null) ? "" : ("; path=" + path)) + ((domain === null) ? "" : ("; domain=" + domain)) + ((secure === true) ? "; secure" : "");
},
- // private
- refreshRow : function(record){
- if(this.ds.getCount()==1){
- this.refresh();
- }else{
- this.isUpdating = true;
- Ext.grid.GroupingView.superclass.refreshRow.apply(this, arguments);
- this.isUpdating = false;
+ /**
+ * Retrieves cookies that are accessible by the current page. If a cookie
+ * does not exist, get()
returns null. The following
+ * example retrieves the cookie called "valid" and stores the String value
+ * in the variable validStatus.
+ *
+ * var validStatus = Ext.util.Cookies.get("valid");
+ *
+ * @param {String} name The name of the cookie to get
+ * @return {Mixed} Returns the cookie value for the specified name;
+ * null if the cookie name does not exist.
+ */
+ get : function(name){
+ var arg = name + "=",
+ alen = arg.length,
+ clen = document.cookie.length,
+ i = 0,
+ j = 0;
+
+ while(i < clen){
+ j = i + alen;
+ if(document.cookie.substring(i, j) == arg){
+ return this.getCookieVal(j);
+ }
+ i = document.cookie.indexOf(" ", i) + 1;
+ if(i === 0){
+ break;
+ }
}
+ return null;
},
- // private
- beforeMenuShow : function(){
- var item, items = this.hmenu.items, disabled = this.cm.config[this.hdCtxIndex].groupable === false;
- if((item = items.get('groupBy'))){
- item.setDisabled(disabled);
- }
- if((item = items.get('showGroups'))){
- item.setDisabled(disabled);
- item.setChecked(this.canGroup(), true);
+ /**
+ * Removes a cookie with the provided name from the browser
+ * if found by setting its expiration date to sometime in the past.
+ * @param {String} name The name of the cookie to remove
+ * @param {String} path (optional) The path for the cookie. This must be included if you included a path while setting the cookie.
+ */
+ clear : function(name, path){
+ if(this.get(name)){
+ path = path || '/';
+ document.cookie = name + '=' + '; expires=Thu, 01-Jan-70 00:00:01 GMT; path=' + path;
}
},
+
+ /**
+ * @private
+ */
+ getCookieVal : function(offset){
+ var endstr = document.cookie.indexOf(";", offset);
+ if(endstr == -1){
+ endstr = document.cookie.length;
+ }
+ return unescape(document.cookie.substring(offset, endstr));
+ }
+});
- // private
- renderUI : function(){
- Ext.grid.GroupingView.superclass.renderUI.call(this);
- this.mainBody.on('mousedown', this.interceptMouse, this);
-
- if(this.enableGroupingMenu && this.hmenu){
- this.hmenu.add('-',{
- itemId:'groupBy',
- text: this.groupByText,
- handler: this.onGroupByClick,
- scope: this,
- iconCls:'x-group-by-icon'
- });
- if(this.enableNoGroups){
- this.hmenu.add({
- itemId:'showGroups',
- text: this.showGroupsText,
- checked: true,
- checkHandler: this.onShowGroupsClick,
- scope: this
- });
+/**
+ * @class Ext.util.CSS
+ * Utility class for manipulating CSS rules
+ * @singleton
+ */
+Ext.define('Ext.util.CSS', function() {
+ var rules = null;
+ var doc = document;
+
+ var camelRe = /(-[a-z])/gi;
+ var camelFn = function(m, a){ return a.charAt(1).toUpperCase(); };
+
+ return {
+
+ singleton: true,
+
+ constructor: function() {
+ this.rules = {};
+ this.initialized = false;
+ },
+
+ /**
+ * Creates a stylesheet from a text blob of rules.
+ * These rules will be wrapped in a STYLE tag and appended to the HEAD of the document.
+ * @param {String} cssText The text containing the css rules
+ * @param {String} id An id to add to the stylesheet for later removal
+ * @return {StyleSheet}
+ */
+ createStyleSheet : function(cssText, id) {
+ var ss,
+ head = doc.getElementsByTagName("head")[0],
+ styleEl = doc.createElement("style");
+
+ styleEl.setAttribute("type", "text/css");
+ if (id) {
+ styleEl.setAttribute("id", id);
}
- this.hmenu.on('beforeshow', this.beforeMenuShow, this);
- }
- },
- processEvent: function(name, e){
- Ext.grid.GroupingView.superclass.processEvent.call(this, name, e);
- var hd = e.getTarget('.x-grid-group-hd', this.mainBody);
- if(hd){
- // group value is at the end of the string
- var field = this.getGroupField(),
- prefix = this.getPrefix(field),
- groupValue = hd.id.substring(prefix.length),
- emptyRe = new RegExp('gp-' + Ext.escapeRe(field) + '--hd');
+ if (Ext.isIE) {
+ head.appendChild(styleEl);
+ ss = styleEl.styleSheet;
+ ss.cssText = cssText;
+ } else {
+ try{
+ styleEl.appendChild(doc.createTextNode(cssText));
+ } catch(e) {
+ styleEl.cssText = cssText;
+ }
+ head.appendChild(styleEl);
+ ss = styleEl.styleSheet ? styleEl.styleSheet : (styleEl.sheet || doc.styleSheets[doc.styleSheets.length-1]);
+ }
+ this.cacheStyleSheet(ss);
+ return ss;
+ },
+
+ /**
+ * Removes a style or link tag by id
+ * @param {String} id The id of the tag
+ */
+ removeStyleSheet : function(id) {
+ var existing = document.getElementById(id);
+ if (existing) {
+ existing.parentNode.removeChild(existing);
+ }
+ },
- // remove trailing '-hd'
- groupValue = groupValue.substr(0, groupValue.length - 3);
-
- // also need to check for empty groups
- if(groupValue || emptyRe.test(hd.id)){
- this.grid.fireEvent('group' + name, this.grid, field, groupValue, e);
+ /**
+ * Dynamically swaps an existing stylesheet reference for a new one
+ * @param {String} id The id of an existing link tag to remove
+ * @param {String} url The href of the new stylesheet to include
+ */
+ swapStyleSheet : function(id, url) {
+ var doc = document;
+ this.removeStyleSheet(id);
+ var ss = doc.createElement("link");
+ ss.setAttribute("rel", "stylesheet");
+ ss.setAttribute("type", "text/css");
+ ss.setAttribute("id", id);
+ ss.setAttribute("href", url);
+ doc.getElementsByTagName("head")[0].appendChild(ss);
+ },
+
+ /**
+ * Refresh the rule cache if you have dynamically added stylesheets
+ * @return {Object} An object (hash) of rules indexed by selector
+ */
+ refreshCache : function() {
+ return this.getRules(true);
+ },
+
+ // private
+ cacheStyleSheet : function(ss) {
+ if(!rules){
+ rules = {};
+ }
+ try {// try catch for cross domain access issue
+ var ssRules = ss.cssRules || ss.rules,
+ selectorText,
+ i = ssRules.length - 1,
+ j,
+ selectors;
+
+ for (; i >= 0; --i) {
+ selectorText = ssRules[i].selectorText;
+ if (selectorText) {
+
+ // Split in case there are multiple, comma-delimited selectors
+ selectorText = selectorText.split(',');
+ selectors = selectorText.length;
+ for (j = 0; j < selectors; j++) {
+ rules[Ext.String.trim(selectorText[j]).toLowerCase()] = ssRules[i];
+ }
+ }
+ }
+ } catch(e) {}
+ },
+
+ /**
+ * Gets all css rules for the document
+ * @param {Boolean} refreshCache true to refresh the internal cache
+ * @return {Object} An object (hash) of rules indexed by selector
+ */
+ getRules : function(refreshCache) {
+ if (rules === null || refreshCache) {
+ rules = {};
+ var ds = doc.styleSheets,
+ i = 0,
+ len = ds.length;
+
+ for (; i < len; i++) {
+ try {
+ if (!ds[i].disabled) {
+ this.cacheStyleSheet(ds[i]);
+ }
+ } catch(e) {}
+ }
+ }
+ return rules;
+ },
+
+ /**
+ * Gets an an individual CSS rule by selector(s)
+ * @param {String/Array} selector The CSS selector or an array of selectors to try. The first selector that is found is returned.
+ * @param {Boolean} refreshCache true to refresh the internal cache if you have recently updated any rules or added styles dynamically
+ * @return {CSSRule} The CSS rule or null if one is not found
+ */
+ getRule: function(selector, refreshCache) {
+ var rs = this.getRules(refreshCache);
+ if (!Ext.isArray(selector)) {
+ return rs[selector.toLowerCase()];
+ }
+ for (var i = 0; i < selector.length; i++) {
+ if (rs[selector[i]]) {
+ return rs[selector[i].toLowerCase()];
+ }
}
- if(name == 'mousedown' && e.button == 0){
- this.toggleGroup(hd.parentNode);
+ return null;
+ },
+
+ /**
+ * Updates a rule property
+ * @param {String/Array} selector If it's an array it tries each selector until it finds one. Stops immediately once one is found.
+ * @param {String} property The css property
+ * @param {String} value The new value for the property
+ * @return {Boolean} true If a rule was found and updated
+ */
+ updateRule : function(selector, property, value){
+ if (!Ext.isArray(selector)) {
+ var rule = this.getRule(selector);
+ if (rule) {
+ rule.style[property.replace(camelRe, camelFn)] = value;
+ return true;
+ }
+ } else {
+ for (var i = 0; i < selector.length; i++) {
+ if (this.updateRule(selector[i], property, value)) {
+ return true;
+ }
+ }
}
+ return false;
}
+ };
+}());
+/**
+ * @class Ext.util.History
+ * 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
+ */
+Ext.define('Ext.util.History', {
+ singleton: true,
+ alternateClassName: 'Ext.History',
+ mixins: {
+ observable: 'Ext.util.Observable'
+ },
+
+ constructor: function() {
+ var me = this;
+ me.oldIEMode = Ext.isIE6 || Ext.isIE7 || !Ext.isStrict && Ext.isIE8;
+ me.iframe = null;
+ me.hiddenField = null;
+ me.ready = false;
+ me.currentToken = null;
+ },
+
+ getHash: function() {
+ var href = window.location.href,
+ i = href.indexOf("#");
+
+ return i >= 0 ? href.substr(i + 1) : null;
+ },
+ doSave: function() {
+ this.hiddenField.value = this.currentToken;
},
+
- // private
- onGroupByClick : function(){
- this.enableGrouping = true;
- this.grid.store.groupBy(this.cm.getDataIndex(this.hdCtxIndex));
- this.grid.fireEvent('groupchange', this, this.grid.store.getGroupState());
- this.beforeMenuShow(); // Make sure the checkboxes get properly set when changing groups
- this.refresh();
+ handleStateChange: function(token) {
+ this.currentToken = token;
+ this.fireEvent('change', token);
},
- // private
- onShowGroupsClick : function(mi, checked){
- this.enableGrouping = checked;
- if(checked){
- this.onGroupByClick();
- }else{
- this.grid.store.clearGrouping();
- this.grid.fireEvent('groupchange', this, null);
+ updateIFrame: function(token) {
+ var html = '' +
+ Ext.util.Format.htmlEncode(token) +
+ '';
+
+ try {
+ var doc = this.iframe.contentWindow.document;
+ doc.open();
+ doc.write(html);
+ doc.close();
+ return true;
+ } catch (e) {
+ return false;
}
},
- /**
- * Toggle the group that contains the specific row.
- * @param {Number} rowIndex The row inside the group
- * @param {Boolean} expanded (optional)
- */
- toggleRowIndex : function(rowIndex, expanded){
- if(!this.canGroup()){
+ checkIFrame: function () {
+ var me = this,
+ contentWindow = me.iframe.contentWindow;
+
+ if (!contentWindow || !contentWindow.document) {
+ Ext.Function.defer(this.checkIFrame, 10, this);
return;
}
- var row = this.getRow(rowIndex);
- if(row){
- this.toggleGroup(this.findGroup(row), expanded);
- }
+
+ var doc = contentWindow.document,
+ elem = doc.getElementById("state"),
+ oldToken = elem ? elem.innerText : null,
+ oldHash = me.getHash();
+
+ Ext.TaskManager.start({
+ run: function () {
+ var doc = contentWindow.document,
+ elem = doc.getElementById("state"),
+ newToken = elem ? elem.innerText : null,
+ newHash = me.getHash();
+
+ if (newToken !== oldToken) {
+ oldToken = newToken;
+ me.handleStateChange(newToken);
+ window.top.location.hash = newToken;
+ oldHash = newToken;
+ me.doSave();
+ } else if (newHash !== oldHash) {
+ oldHash = newHash;
+ me.updateIFrame(newHash);
+ }
+ },
+ interval: 50,
+ scope: me
+ });
+ me.ready = true;
+ me.fireEvent('ready', me);
},
- /**
- * Toggles the specified group if no value is passed, otherwise sets the expanded state of the group to the value passed.
- * @param {String} groupId The groupId assigned to the group (see getGroupId)
- * @param {Boolean} expanded (optional)
- */
- toggleGroup : function(group, expanded){
- var gel = Ext.get(group);
- expanded = Ext.isDefined(expanded) ? expanded : gel.hasClass('x-grid-group-collapsed');
- if(this.state[gel.id] !== expanded){
- this.grid.stopEditing(true);
- this.state[gel.id] = expanded;
- gel[expanded ? 'removeClass' : 'addClass']('x-grid-group-collapsed');
+ startUp: function () {
+ var me = this;
+
+ me.currentToken = me.hiddenField.value || this.getHash();
+
+ if (me.oldIEMode) {
+ me.checkIFrame();
+ } else {
+ var hash = me.getHash();
+ Ext.TaskManager.start({
+ run: function () {
+ var newHash = me.getHash();
+ if (newHash !== hash) {
+ hash = newHash;
+ me.handleStateChange(hash);
+ me.doSave();
+ }
+ },
+ interval: 50,
+ scope: me
+ });
+ me.ready = true;
+ me.fireEvent('ready', me);
}
+
},
/**
- * Toggles all groups if no value is passed, otherwise sets the expanded state of all groups to the value passed.
- * @param {Boolean} expanded (optional)
+ * The id of the hidden field required for storing the current history token.
+ * @type String
+ * @property
*/
- toggleAllGroups : function(expanded){
- var groups = this.getGroups();
- for(var i = 0, len = groups.length; i < len; i++){
- this.toggleGroup(groups[i], expanded);
- }
- },
-
+ fieldId: Ext.baseCSSPrefix + 'history-field',
/**
- * Expands all grouped rows.
+ * The id of the iframe required by IE to manage the history stack.
+ * @type String
+ * @property
*/
- expandAllGroups : function(){
- this.toggleAllGroups(true);
- },
+ iframeId: Ext.baseCSSPrefix + 'history-frame',
/**
- * Collapses all grouped rows.
+ * 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 (this
reference) in which the callback is executed. Defaults to the browser window.
*/
- collapseAllGroups : function(){
- this.toggleAllGroups(false);
- },
-
- // private
- interceptMouse : function(e){
- var hd = e.getTarget('.x-grid-group-hd', this.mainBody);
- if(hd){
- e.stopEvent();
- this.toggleGroup(hd.parentNode);
- }
- },
-
- // private
- getGroup : function(v, r, groupRenderer, rowIndex, colIndex, ds){
- var g = groupRenderer ? groupRenderer(v, {}, r, rowIndex, colIndex, ds) : String(v);
- if(g === '' || g === ' '){
- g = this.cm.config[colIndex].emptyGroupText || this.emptyGroupText;
- }
- return g;
- },
-
- // private
- getGroupField : function(){
- return this.grid.store.getGroupState();
- },
-
- // private
- afterRender : function(){
- if(!this.ds || !this.cm){
+ init: function (onReady, scope) {
+ var me = this;
+
+ if (me.ready) {
+ Ext.callback(onReady, scope, [me]);
return;
}
- Ext.grid.GroupingView.superclass.afterRender.call(this);
- if(this.grid.deferRowRender){
- this.updateGroupWidths();
+
+ if (!Ext.isReady) {
+ Ext.onReady(function() {
+ me.init(onReady, scope);
+ });
+ return;
}
- },
-
- // private
- renderRows : function(){
- var groupField = this.getGroupField();
- var eg = !!groupField;
- // if they turned off grouping and the last grouped field is hidden
- if(this.hideGroupedColumn) {
- var colIndex = this.cm.findColumnIndex(groupField),
- hasLastGroupField = Ext.isDefined(this.lastGroupField);
- if(!eg && hasLastGroupField){
- this.mainBody.update('');
- this.cm.setHidden(this.cm.findColumnIndex(this.lastGroupField), false);
- delete this.lastGroupField;
- }else if (eg && !hasLastGroupField){
- this.lastGroupField = groupField;
- this.cm.setHidden(colIndex, true);
- }else if (eg && hasLastGroupField && groupField !== this.lastGroupField) {
- this.mainBody.update('');
- var oldIndex = this.cm.findColumnIndex(this.lastGroupField);
- this.cm.setHidden(oldIndex, false);
- this.lastGroupField = groupField;
- this.cm.setHidden(colIndex, true);
- }
- }
- return Ext.grid.GroupingView.superclass.renderRows.apply(
- this, arguments);
- },
-
- // private
- doRender : function(cs, rs, ds, startRow, colCount, stripe){
- if(rs.length < 1){
- return '';
+
+ me.hiddenField = Ext.getDom(me.fieldId);
+
+ if (me.oldIEMode) {
+ me.iframe = Ext.getDom(me.iframeId);
}
-
- if(!this.canGroup() || this.isUpdating){
- return Ext.grid.GroupingView.superclass.doRender.apply(this, arguments);
+
+ me.addEvents(
+ /**
+ * @event ready
+ * Fires when the Ext.util.History singleton has been initialized and is ready for use.
+ * @param {Ext.util.History} The Ext.util.History singleton.
+ */
+ 'ready',
+ /**
+ * @event change
+ * Fires when navigation back or forwards within the local page's history occurs.
+ * @param {String} token An identifier associated with the page state at that point in its history.
+ */
+ 'change'
+ );
+
+ if (onReady) {
+ me.on('ready', onReady, scope, {single: true});
}
+ me.startUp();
+ },
- var groupField = this.getGroupField(),
- colIndex = this.cm.findColumnIndex(groupField),
- g,
- gstyle = 'width:' + this.getTotalWidth() + ';',
- cfg = this.cm.config[colIndex],
- groupRenderer = cfg.groupRenderer || cfg.renderer,
- prefix = this.showGroupName ? (cfg.groupName || cfg.header)+': ' : '',
- groups = [],
- curGroup, i, len, gid;
-
- for(i = 0, len = rs.length; i < len; i++){
- var rowIndex = startRow + i,
- r = rs[i],
- gvalue = r.data[groupField];
-
- g = this.getGroup(gvalue, r, groupRenderer, rowIndex, colIndex, ds);
- if(!curGroup || curGroup.group != g){
- gid = this.constructId(gvalue, groupField, colIndex);
- // if state is defined use it, however state is in terms of expanded
- // so negate it, otherwise use the default.
- this.state[gid] = !(Ext.isDefined(this.state[gid]) ? !this.state[gid] : this.startCollapsed);
- curGroup = {
- group: g,
- gvalue: gvalue,
- text: prefix + g,
- groupId: gid,
- startRow: rowIndex,
- rs: [r],
- cls: this.state[gid] ? '' : 'x-grid-group-collapsed',
- style: gstyle
- };
- groups.push(curGroup);
- }else{
- curGroup.rs.push(r);
+ /**
+ * 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:
+ *
+// Handle tab changes on a TabPanel
+tabPanel.on('tabchange', function(tabPanel, tab){
+Ext.History.add(tabPanel.id + ':' + tab.id);
+});
+
+ * @param {String} token The value that defines a particular application-specific history state
+ * @param {Boolean} preventDuplicates 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) {
+ var me = this;
+
+ if (preventDup !== false) {
+ if (me.getToken() === token) {
+ return true;
}
- r._groupId = gid;
}
-
- var buf = [];
- for(i = 0, len = groups.length; i < len; i++){
- g = groups[i];
- this.doGroupStart(buf, g, cs, ds, colCount);
- buf[buf.length] = Ext.grid.GroupingView.superclass.doRender.call(
- this, cs, g.rs, ds, g.startRow, colCount, stripe);
-
- this.doGroupEnd(buf, g, cs, ds, colCount);
+
+ if (me.oldIEMode) {
+ return me.updateIFrame(token);
+ } else {
+ window.top.location.hash = token;
+ return true;
}
- return buf.join('');
},
/**
- * Dynamically tries to determine the groupId of a specific value
- * @param {String} value
- * @return {String} The group id
+ * Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).
*/
- getGroupId : function(value){
- var field = this.getGroupField();
- return this.constructId(value, field, this.cm.findColumnIndex(field));
+ back: function() {
+ window.history.go(-1);
},
- // private
- constructId : function(value, field, idx){
- var cfg = this.cm.config[idx],
- groupRenderer = cfg.groupRenderer || cfg.renderer,
- val = (this.groupMode == 'value') ? value : this.getGroup(value, {data:{}}, groupRenderer, 0, idx, this.ds);
-
- return this.getPrefix(field) + Ext.util.Format.htmlEncode(val);
+ /**
+ * Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).
+ */
+ forward: function(){
+ window.history.go(1);
},
- // private
- canGroup : function(){
- return this.enableGrouping && !!this.getGroupField();
+ /**
+ * Retrieves the currently-active history token.
+ * @return {String} The token
+ */
+ getToken: function() {
+ return this.ready ? this.currentToken : this.getHash();
+ }
+});
+/**
+ * @class Ext.view.TableChunker
+ *
+ * Produces optimized XTemplates for chunks of tables to be
+ * used in grids, trees and other table based widgets.
+ *
+ * @singleton
+ */
+Ext.define('Ext.view.TableChunker', {
+ singleton: true,
+ requires: ['Ext.XTemplate'],
+ metaTableTpl: [
+ '{[this.openTableWrap()]}',
+ '',
+ '',
+ '',
+ '',
+ ' ',
+ ' ',
+ ' ',
+ '{[this.openRows()]}',
+ '{row}',
+ '',
+ '{[this.embedFeature(values, parent, xindex, xcount)]}',
+ ' ',
+ '{[this.closeRows()]}',
+ '',
+ '
',
+ '{[this.closeTableWrap()]}'
+ ],
+
+ constructor: function() {
+ Ext.XTemplate.prototype.recurse = function(values, reference) {
+ return this.apply(reference ? values[reference] : values);
+ };
},
- // private
- getPrefix: function(field){
- return this.grid.getGridEl().id + '-gp-' + field + '-';
+ embedFeature: function(values, parent, x, xcount) {
+ var tpl = '';
+ if (!values.disabled) {
+ tpl = values.getFeatureTpl(values, parent, x, xcount);
+ }
+ return tpl;
},
- // private
- doGroupStart : function(buf, g, cs, ds, colCount){
- buf[buf.length] = this.startGroup.apply(g);
+ embedFullWidth: function() {
+ return 'style="width: {fullWidth}px;"';
},
- // private
- doGroupEnd : function(buf, g, cs, ds, colCount){
- buf[buf.length] = this.endGroup;
+ openRows: function() {
+ return '';
},
- // private
- getRows : function(){
- if(!this.canGroup()){
- return Ext.grid.GroupingView.superclass.getRows.call(this);
- }
- var r = [],
- gs = this.getGroups(),
- g,
- i = 0,
- len = gs.length,
- j,
- jlen;
- for(; i < len; ++i){
- g = gs[i].childNodes[1];
- if(g){
- g = g.childNodes;
- for(j = 0, jlen = g.length; j < jlen; ++j){
- r[r.length] = g[j];
- }
- }
- }
- return r;
+ closeRows: function() {
+ return ' ';
},
- // private
- updateGroupWidths : function(){
- if(!this.canGroup() || !this.hasRows()){
- return;
- }
- var tw = Math.max(this.cm.getTotalWidth(), this.el.dom.offsetWidth-this.getScrollOffset()) +'px';
- var gs = this.getGroups();
- for(var i = 0, len = gs.length; i < len; i++){
- gs[i].firstChild.style.width = tw;
+ metaRowTpl: [
+ '',
+ '',
+ '{{id}} ',
+ ' ',
+ ' '
+ ],
+
+ firstOrLastCls: function(xindex, xcount) {
+ var cssCls = '';
+ if (xindex === 1) {
+ cssCls = Ext.baseCSSPrefix + 'grid-cell-first';
+ } else if (xindex === xcount) {
+ cssCls = Ext.baseCSSPrefix + 'grid-cell-last';
}
+ return cssCls;
},
-
- // private
- onColumnWidthUpdated : function(col, w, tw){
- Ext.grid.GroupingView.superclass.onColumnWidthUpdated.call(this, col, w, tw);
- this.updateGroupWidths();
+
+ embedRowCls: function() {
+ return '{rowCls}';
},
-
- // private
- onAllColumnWidthsUpdated : function(ws, tw){
- Ext.grid.GroupingView.superclass.onAllColumnWidthsUpdated.call(this, ws, tw);
- this.updateGroupWidths();
+
+ embedRowAttr: function() {
+ return '{rowAttr}';
},
-
- // private
- onColumnHiddenUpdated : function(col, hidden, tw){
- Ext.grid.GroupingView.superclass.onColumnHiddenUpdated.call(this, col, hidden, tw);
- this.updateGroupWidths();
+
+ openTableWrap: function() {
+ return '';
},
-
- // private
- onLayout : function(){
- this.updateGroupWidths();
+
+ closeTableWrap: function() {
+ return '';
},
- // private
- onBeforeRowSelect : function(sm, rowIndex){
- this.toggleRowIndex(rowIndex, true);
+ getTableTpl: function(cfg, textOnly) {
+ var tpl,
+ tableTplMemberFns = {
+ openRows: this.openRows,
+ closeRows: this.closeRows,
+ embedFeature: this.embedFeature,
+ embedFullWidth: this.embedFullWidth,
+ openTableWrap: this.openTableWrap,
+ closeTableWrap: this.closeTableWrap
+ },
+ tplMemberFns = {},
+ features = cfg.features || [],
+ ln = features.length,
+ i = 0,
+ memberFns = {
+ embedRowCls: this.embedRowCls,
+ embedRowAttr: this.embedRowAttr,
+ firstOrLastCls: this.firstOrLastCls
+ },
+ // copy the default
+ metaRowTpl = Array.prototype.slice.call(this.metaRowTpl, 0),
+ metaTableTpl;
+
+ for (; i < ln; i++) {
+ if (!features[i].disabled) {
+ features[i].mutateMetaRowTpl(metaRowTpl);
+ Ext.apply(memberFns, features[i].getMetaRowTplFragments());
+ Ext.apply(tplMemberFns, features[i].getFragmentTpl());
+ Ext.apply(tableTplMemberFns, features[i].getTableFragments());
+ }
+ }
+
+ metaRowTpl = Ext.create('Ext.XTemplate', metaRowTpl.join(''), memberFns);
+ cfg.row = metaRowTpl.applyTemplate(cfg);
+
+ metaTableTpl = Ext.create('Ext.XTemplate', this.metaTableTpl.join(''), tableTplMemberFns);
+
+ tpl = metaTableTpl.applyTemplate(cfg);
+
+ // TODO: Investigate eliminating.
+ if (!textOnly) {
+ tpl = Ext.create('Ext.XTemplate', tpl, tplMemberFns);
+ }
+ return tpl;
+
}
});
-// private
-Ext.grid.GroupingView.GROUP_ID = 1000;
\ No newline at end of file
+
+
+
+