+DomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.

+All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example "div.foo:nth-child(odd)[@foo=bar].bar:first" would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure. +

Element Selectors:

Attribute Selectors:

The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.

Pseudo Classes:

CSS Value Selectors:

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.

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.

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:

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:

+ * Combining Options
+ * In the following examples, the shorthand form {@link #on} is used rather than the more verbose + * addListener. The two are equivalent. Using the options argument, it is possible to combine different + * types of listeners:
+ *
+ * A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the + * options object. The options object is available as the third parameter in the handler function.

+ * Code:


+el.on('click', this.onClick, this, {
+    single: true,
+    delay: 100,
+    stopEvent : true,
+    forumId: 4
+});

+ *

+ * Attaching multiple handlers in 1 call
+ * The method also allows for a single argument to be passed which is a config object containing properties + * which specify multiple handlers.

+ *

+ * Code:


+el.on({
+    'click' : {
+        fn: this.onClick,
+        scope: this,
+        delay: 100
+    },
+    'mouseover' : {
+        fn: this.onMouseOver,
+        scope: this
+    },
+    'mouseout' : {
+        fn: this.onMouseOut,
+        scope: this
+    }
+});

+ *

+ * Or a shorthand syntax:
+ * Code:


+el.on({
+    'click' : this.onClick,
+    'mouseover' : this.onMouseOver,
+    'mouseout' : this.onMouseOut,
+    scope: this
+});
+     *

+ *

delegate

+ *

This is a configuration option that you can pass along when registering a handler for + * an event to assist with event delegation. Event delegation is a technique that is used to + * reduce memory consumption and prevent exposure to memory-leaks. By registering an event + * for a container element as opposed to each element within a container. By setting this + * configuration option to a simple selector, the target element will be filtered to look for + * a descendant of the target. + * For example:


+// 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 + * @method + */ + getAttribute: (Ext.isIE && !(Ext.isIE9 && document.documentMode === 9)) ? + function(name, ns) { + var d = this.dom, + type; + if(ns) { + type = typeof d[ns + ":" + name]; + if (type != 'undefined' && type != 'unknown') { + return d[ns + ":" + name] || null; + } + return null; + } + if (name === "for") { + name = "htmlFor"; + } + return d[name] || null; + }: function(name, ns) { + var d = this.dom; + if (ns) { + return d.getAttributeNS(ns, name) || d.getAttribute(ns + ":" + name); + } + return d.getAttribute(name) || d[name] || null; + }, + + /** + * Update the innerHTML of this element + * @param {String} html The new HTML + * @return {Ext.core.Element} this + */ + update: function(html) { + if (this.dom) { + this.dom.innerHTML = html; + } + return this; + } + }; + + var ep = El.prototype; + + El.addMethods = function(o) { + Ext.apply(ep, o); + }; + + /** + * Appends an event handler (shorthand for {@link #addListener}). + * @param {String} eventName The name of event to handle. + * @param {Function} fn The handler function the event invokes. + * @param {Object} scope (optional) The scope (this reference) in which the handler function is executed. + * @param {Object} options (optional) An object containing standard {@link #addListener} options + * @member Ext.core.Element + * @method on + */ + ep.on = ep.addListener; + + /** + * Removes an event handler from this element (see {@link #removeListener} for additional notes). + * @param {String} eventName The name of the event from which to remove the handler. + * @param {Function} fn The handler function to remove. This must be a reference to the function passed into the {@link #addListener} call. + * @param {Object} scope If a scope (this reference) was specified when the listener was added, + * then this must refer to the same object. + * @return {Ext.core.Element} this + * @member Ext.core.Element + * @method un + */ + ep.un = ep.removeListener; + + /** + * Removes all previous added listeners from this element + * @return {Ext.core.Element} this + * @member Ext.core.Element + * @method clearListeners + */ + ep.clearListeners = ep.removeAllListeners; + + /** + * Removes this element's dom reference. Note that event and cache removal is handled at {@link Ext#removeNode Ext.removeNode}. + * Alias to {@link #remove}. + * @member Ext.core.Element + * @method destroy + */ + ep.destroy = ep.remove; + + /** + * true to automatically adjust width and height settings for box-model issues (default to true) + */ + ep.autoBoxAdjust = true; + + // private + var unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i, + docEl; + + /** + * Retrieves Ext.core.Element objects. + *

This method does not retrieve {@link Ext.Component Component}s. This method + * retrieves Ext.core.Element objects which encapsulate DOM elements. To retrieve a Component by + * its ID, use {@link Ext.ComponentManager#get}.

+ *

Uses simple caching to consistently return the same object. Automatically fixes if an + * object was recreated with the same id via AJAX or DOM.

+ * @param {Mixed} el The id of the node, a DOM Node or an existing Element. + * @return {Element} The Element object (or null if no matching element was found) + * @static + * @member Ext.core.Element + * @method get + */ + El.get = function(el) { + var ex, + elm, + id; + if (!el) { + return null; + } + if (typeof el == "string") { + // element id + if (! (elm = DOC.getElementById(el))) { + return null; + } + if (EC[el] && EC[el].el) { + ex = EC[el].el; + ex.dom = elm; + } else { + ex = El.addToCache(new El(elm)); + } + return ex; + } else if (el.tagName) { + // dom element + if (! (id = el.id)) { + id = Ext.id(el); + } + if (EC[id] && EC[id].el) { + ex = EC[id].el; + ex.dom = el; + } else { + ex = El.addToCache(new El(el)); + } + return ex; + } else if (el instanceof El) { + if (el != docEl) { + // refresh dom element in case no longer valid, + // catch case where it hasn't been appended + // If an el instance is passed, don't pass to getElementById without some kind of id + if (Ext.isIE && (el.id == undefined || el.id == '')) { + el.dom = el.dom; + } else { + el.dom = DOC.getElementById(el.id) || el.dom; + } + } + return el; + } else if (el.isComposite) { + return el; + } else if (Ext.isArray(el)) { + return El.select(el); + } else if (el == DOC) { + // create a bogus element object representing the document object + if (!docEl) { + var f = function() {}; + f.prototype = El.prototype; + docEl = new f(); + docEl.dom = DOC; + } + return docEl; + } + return null; + }; + + El.addToCache = function(el, id) { + if (el) { + id = id || el.id; + EC[id] = { + el: el, + data: {}, + events: {} + }; + } + return el; + }; + + // private method for getting and setting element data + El.data = function(el, key, value) { + el = El.get(el); + if (!el) { + return null; + } + var c = EC[el.id].data; + if (arguments.length == 2) { + return c[key]; + } else { + return (c[key] = value); + } + }; + + // private + // Garbage collection - uncache elements/purge listeners on orphaned elements + // so we don't hold a reference and cause the browser to retain them + function garbageCollect() { + if (!Ext.enableGarbageCollector) { + clearInterval(El.collectorThreadId); + } else { + var eid, + el, + d, + o; + + for (eid in EC) { + if (!EC.hasOwnProperty(eid)) { + continue; + } + o = EC[eid]; + if (o.skipGarbageCollection) { + continue; + } + el = o.el; + d = el.dom; + // ------------------------------------------------------- + // Determining what is garbage: + // ------------------------------------------------------- + // !d + // dom node is null, definitely garbage + // ------------------------------------------------------- + // !d.parentNode + // no parentNode == direct orphan, definitely garbage + // ------------------------------------------------------- + // !d.offsetParent && !document.getElementById(eid) + // display none elements have no offsetParent so we will + // also try to look it up by it's id. However, check + // offsetParent first so we don't do unneeded lookups. + // This enables collection of elements that are not orphans + // directly, but somewhere up the line they have an orphan + // parent. + // ------------------------------------------------------- + if (!d || !d.parentNode || (!d.offsetParent && !DOC.getElementById(eid))) { + if (d && Ext.enableListenerCollection) { + Ext.EventManager.removeAll(d); + } + delete EC[eid]; + } + } + // Cleanup IE Object leaks + if (Ext.isIE) { + var t = {}; + for (eid in EC) { + if (!EC.hasOwnProperty(eid)) { + continue; + } + t[eid] = EC[eid]; + } + EC = Ext.cache = t; + } + } + } + El.collectorThreadId = setInterval(garbageCollect, 30000); + + var flyFn = function() {}; + flyFn.prototype = El.prototype; + + // dom is optional + El.Flyweight = function(dom) { + this.dom = dom; + }; + + El.Flyweight.prototype = new flyFn(); + El.Flyweight.prototype.isFlyweight = true; + El._flyweights = {}; + + /** + *

Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - + * the dom node can be overwritten by other code. Shorthand of {@link Ext.core.Element#fly}

+ *

Use this to make one-time references to DOM elements which are not going to be accessed again either by + * application code, or by Ext's classes. If accessing an element which will be processed regularly, then {@link Ext#get Ext.get} + * will be more appropriate to take advantage of the caching provided by the Ext.core.Element class.

+ *

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; + + /** + *

+ *

+ * @param {String/HTMLElement} el The dom node or id + * @param {String} named (optional) Allows for creation of named reusable flyweights to prevent conflicts + * (e.g. internally Ext uses "_global") + * @return {Element} The shared Element object (or null if no matching element was found) + * @member Ext + * @method fly + */ + Ext.fly = El.fly; + + // speedy lookup for elements never to box adjust + var noBoxAdjust = Ext.isStrict ? { + select: 1 + }: { + input: 1, + select: 1, + textarea: 1 + }; + if (Ext.isIE || Ext.isGecko) { + noBoxAdjust['button'] = 1; + } +})(); + +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods({ + /** + * Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) + * @param {String} selector The simple selector to test + * @param {Number/Mixed} maxDepth (optional) The max depth to search as a number or element (defaults to 50 || document.body) + * @param {Boolean} returnEl (optional) True to return a Ext.core.Element object instead of DOM node + * @return {HTMLElement} The matching DOM node (or null if no match was found) + */ + findParent : function(simpleSelector, maxDepth, returnEl) { + var p = this.dom, + b = document.body, + depth = 0, + stopEl; + + maxDepth = maxDepth || 50; + if (isNaN(maxDepth)) { + stopEl = Ext.getDom(maxDepth); + maxDepth = Number.MAX_VALUE; + } + while (p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl) { + if (Ext.DomQuery.is(p, simpleSelector)) { + return returnEl ? Ext.get(p) : p; + } + depth++; + p = p.parentNode; + } + return null; + }, + + /** + * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) + * @param {String} selector The simple selector to test + * @param {Number/Mixed} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @param {Boolean} returnEl (optional) True to return a Ext.core.Element object instead of DOM node + * @return {HTMLElement} The matching DOM node (or null if no match was found) + */ + findParentNode : function(simpleSelector, maxDepth, returnEl) { + var p = Ext.fly(this.dom.parentNode, '_internal'); + return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null; + }, + + /** + * Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child). + * This is a shortcut for findParentNode() that always returns an Ext.core.Element. + * @param {String} selector The simple selector to test + * @param {Number/Mixed} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @return {Ext.core.Element} The matching DOM node (or null if no match was found) + */ + up : function(simpleSelector, maxDepth) { + return this.findParentNode(simpleSelector, maxDepth, true); + }, + + /** + * Creates a {@link Ext.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @return {CompositeElement/CompositeElement} The composite element + */ + select : function(selector) { + return Ext.core.Element.select(selector, false, this.dom); + }, + + /** + * Selects child nodes based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @return {Array} An array of the matched nodes + */ + query : function(selector) { + return Ext.DomQuery.select(selector, this.dom); + }, + + /** + * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @param {Boolean} returnDom (optional) True to return the DOM node instead of Ext.core.Element (defaults to false) + * @return {HTMLElement/Ext.core.Element} The child Ext.core.Element (or DOM node if returnDom = true) + */ + down : function(selector, returnDom) { + var n = Ext.DomQuery.selectNode(selector, this.dom); + return returnDom ? n : Ext.get(n); + }, + + /** + * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @param {Boolean} returnDom (optional) True to return the DOM node instead of Ext.core.Element (defaults to false) + * @return {HTMLElement/Ext.core.Element} The child Ext.core.Element (or DOM node if returnDom = true) + */ + child : function(selector, returnDom) { + var node, + me = this, + id; + id = Ext.get(me).id; + // Escape . or : + id = id.replace(/[\.:]/g, "\\$0"); + node = Ext.DomQuery.selectNode('#' + id + " > " + selector, me.dom); + return returnDom ? node : Ext.get(node); + }, + + /** + * Gets the parent node for this element, optionally chaining up trying to match a selector + * @param {String} selector (optional) Find a parent node that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.Element/HTMLElement} The parent node or null + */ + parent : function(selector, returnDom) { + return this.matchNode('parentNode', 'parentNode', selector, returnDom); + }, + + /** + * Gets the next sibling, skipping text nodes + * @param {String} selector (optional) Find the next sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.Element/HTMLElement} The next sibling or null + */ + next : function(selector, returnDom) { + return this.matchNode('nextSibling', 'nextSibling', selector, returnDom); + }, + + /** + * Gets the previous sibling, skipping text nodes + * @param {String} selector (optional) Find the previous sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.Element/HTMLElement} The previous sibling or null + */ + prev : function(selector, returnDom) { + return this.matchNode('previousSibling', 'previousSibling', selector, returnDom); + }, + + + /** + * Gets the first child, skipping text nodes + * @param {String} selector (optional) Find the next sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.Element/HTMLElement} The first child or null + */ + first : function(selector, returnDom) { + return this.matchNode('nextSibling', 'firstChild', selector, returnDom); + }, + + /** + * Gets the last child, skipping text nodes + * @param {String} selector (optional) Find the previous sibling that matches the passed simple selector + * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.core.Element + * @return {Ext.core.Element/HTMLElement} The last child or null + */ + last : function(selector, returnDom) { + return this.matchNode('previousSibling', 'lastChild', selector, returnDom); + }, + + matchNode : function(dir, start, selector, returnDom) { + if (!this.dom) { + return null; + } + + var n = this.dom[start]; + while (n) { + if (n.nodeType == 1 && (!selector || Ext.DomQuery.is(n, selector))) { + return !returnDom ? Ext.get(n) : n; + } + n = n[dir]; + } + return null; + } +}); + +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods({ + /** + * Appends the passed element(s) to this element + * @param {String/HTMLElement/Array/Element/CompositeElement} el + * @return {Ext.core.Element} this + */ + appendChild : function(el) { + return Ext.get(el).appendTo(this); + }, + + /** + * Appends this element to the passed element + * @param {Mixed} el The new parent element + * @return {Ext.core.Element} this + */ + appendTo : function(el) { + Ext.getDom(el).appendChild(this.dom); + return this; + }, + + /** + * Inserts this element before the passed element in the DOM + * @param {Mixed} el The element before which this element will be inserted + * @return {Ext.core.Element} this + */ + insertBefore : function(el) { + el = Ext.getDom(el); + el.parentNode.insertBefore(this.dom, el); + return this; + }, + + /** + * Inserts this element after the passed element in the DOM + * @param {Mixed} el The element to insert after + * @return {Ext.core.Element} this + */ + insertAfter : function(el) { + el = Ext.getDom(el); + el.parentNode.insertBefore(this.dom, el.nextSibling); + return this; + }, + + /** + * Inserts (or creates) an element (or DomHelper config) as the first child of this element + * @param {Mixed/Object} el The id or element to insert or a DomHelper config to create and insert + * @return {Ext.core.Element} The new child + */ + insertFirst : function(el, returnDom) { + el = el || {}; + if (el.nodeType || el.dom || typeof el == 'string') { // element + el = Ext.getDom(el); + this.dom.insertBefore(el, this.dom.firstChild); + return !returnDom ? Ext.get(el) : el; + } + else { // dh config + return this.createChild(el, this.dom.firstChild, returnDom); + } + }, + + /** + * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element + * @param {Mixed/Object/Array} el The id, element to insert or a DomHelper config to create and insert *or* an array of any of those. + * @param {String} where (optional) 'before' or 'after' defaults to before + * @param {Boolean} returnDom (optional) True to return the .;ll;l,raw DOM element instead of Ext.core.Element + * @return {Ext.core.Element} The inserted Element. If an array is passed, the last inserted element is returned. + */ + insertSibling: function(el, where, returnDom){ + var me = this, rt, + isAfter = (where || 'before').toLowerCase() == 'after', + insertEl; + + if(Ext.isArray(el)){ + insertEl = me; + Ext.each(el, function(e) { + rt = Ext.fly(insertEl, '_internal').insertSibling(e, where, returnDom); + if(isAfter){ + insertEl = rt; + } + }); + return rt; + } + + el = el || {}; + + if(el.nodeType || el.dom){ + rt = me.dom.parentNode.insertBefore(Ext.getDom(el), isAfter ? me.dom.nextSibling : me.dom); + if (!returnDom) { + rt = Ext.get(rt); + } + }else{ + if (isAfter && !me.dom.nextSibling) { + rt = Ext.core.DomHelper.append(me.dom.parentNode, el, !returnDom); + } else { + rt = Ext.core.DomHelper[isAfter ? 'insertAfter' : 'insertBefore'](me.dom, el, !returnDom); + } + } + return rt; + }, + + /** + * Replaces the passed element with this element + * @param {Mixed} el The element to replace + * @return {Ext.core.Element} this + */ + replace : function(el) { + el = Ext.get(el); + this.insertBefore(el); + el.remove(); + return this; + }, + + /** + * Replaces this element with the passed element + * @param {Mixed/Object} el The new element or a DomHelper config of an element to create + * @return {Ext.core.Element} this + */ + replaceWith: function(el){ + var me = this; + + if(el.nodeType || el.dom || typeof el == 'string'){ + el = Ext.get(el); + me.dom.parentNode.insertBefore(el, me.dom); + }else{ + el = Ext.core.DomHelper.insertBefore(me.dom, el); + } + + delete Ext.cache[me.id]; + Ext.removeNode(me.dom); + me.id = Ext.id(me.dom = el); + Ext.core.Element.addToCache(me.isFlyweight ? new Ext.core.Element(me.dom) : me); + return me; + }, + + /** + * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element. + * @param {Object} config DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be + * automatically generated with the specified attributes. + * @param {HTMLElement} insertBefore (optional) a child element of this element + * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element + * @return {Ext.core.Element} The new child element + */ + createChild : function(config, insertBefore, returnDom) { + config = config || {tag:'div'}; + if (insertBefore) { + return Ext.core.DomHelper.insertBefore(insertBefore, config, returnDom !== true); + } + else { + return Ext.core.DomHelper[!this.dom.firstChild ? 'insertFirst' : 'append'](this.dom, config, returnDom !== true); + } + }, + + /** + * Creates and wraps this element with another element + * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div + * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Ext.core.Element + * @return {HTMLElement/Element} The newly created wrapper element + */ + wrap : function(config, returnDom) { + var newEl = Ext.core.DomHelper.insertBefore(this.dom, config || {tag: "div"}, !returnDom), + d = newEl.dom || newEl; + + d.appendChild(this.dom); + return newEl; + }, + + /** + * Inserts an html fragment into this element + * @param {String} where Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd. + * @param {String} html The HTML fragment + * @param {Boolean} returnEl (optional) True to return an Ext.core.Element (defaults to false) + * @return {HTMLElement/Ext.core.Element} The inserted node (or nearest related if more than 1 inserted) + */ + insertHtml : function(where, html, returnEl) { + var el = Ext.core.DomHelper.insertHtml(where, this.dom, html); + return returnEl ? Ext.get(el) : el; + } +}); + +/** + * @class Ext.core.Element + */ +(function(){ + Ext.core.Element.boxMarkup = '

'; + // local style camelizing for speed + var supports = Ext.supports, + view = document.defaultView, + opacityRe = /alpha$opacity=(.*)$/i, + trimRe = /^\s+|\s+$/g, + spacesRe = /\s+/, + wordsRe = /\w/g, + adjustDirect2DTableRe = /table-row|table-.*-group/, + INTERNAL = '_internal', + PADDING = 'padding', + MARGIN = 'margin', + BORDER = 'border', + LEFT = '-left', + RIGHT = '-right', + TOP = '-top', + BOTTOM = '-bottom', + WIDTH = '-width', + MATH = Math, + HIDDEN = 'hidden', + ISCLIPPED = 'isClipped', + OVERFLOW = 'overflow', + OVERFLOWX = 'overflow-x', + OVERFLOWY = 'overflow-y', + ORIGINALCLIP = 'originalClip', + // special markup used throughout Ext when box wrapping elements + borders = {l: BORDER + LEFT + WIDTH, r: BORDER + RIGHT + WIDTH, t: BORDER + TOP + WIDTH, b: BORDER + BOTTOM + WIDTH}, + paddings = {l: PADDING + LEFT, r: PADDING + RIGHT, t: PADDING + TOP, b: PADDING + BOTTOM}, + margins = {l: MARGIN + LEFT, r: MARGIN + RIGHT, t: MARGIN + TOP, b: MARGIN + BOTTOM}, + data = Ext.core.Element.data; + + Ext.override(Ext.core.Element, { + + /** + * TODO: Look at this + */ + // private ==> used by Fx + adjustWidth : function(width) { + var me = this, + isNum = (typeof width == 'number'); + + if(isNum && me.autoBoxAdjust && !me.isBorderBox()){ + width -= (me.getBorderWidth("lr") + me.getPadding("lr")); + } + return (isNum && width < 0) ? 0 : width; + }, + + // private ==> used by Fx + adjustHeight : function(height) { + var me = this, + isNum = (typeof height == "number"); + + if(isNum && me.autoBoxAdjust && !me.isBorderBox()){ + height -= (me.getBorderWidth("tb") + me.getPadding("tb")); + } + return (isNum && height < 0) ? 0 : height; + }, + + + /** + * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. + * @param {String/Array} className The CSS classes to add separated by space, or an array of classes + * @return {Ext.core.Element} this + */ + addCls : function(className){ + var me = this, + cls = [], + space = ((me.dom.className.replace(trimRe, '') == '') ? "" : " "), + i, len, v; + if (!Ext.isDefined(className)) { + return me; + } + // Separate case is for speed + if (!Ext.isArray(className)) { + if (typeof className === 'string') { + className = className.replace(trimRe, '').split(spacesRe); + if (className.length === 1) { + className = className[0]; + if (!me.hasCls(className)) { + me.dom.className += space + className; + } + } else { + this.addCls(className); + } + } + } else { + for (i = 0, len = className.length; i < len; i++) { + v = className[i]; + if (typeof v == 'string' && (' ' + me.dom.className + ' ').indexOf(' ' + v + ' ') == -1) { + cls.push(v); + } + } + if (cls.length) { + me.dom.className += space + cls.join(" "); + } + } + return me; + }, + + /** + * Removes one or more CSS classes from the element. + * @param {String/Array} className The CSS classes to remove separated by space, or an array of classes + * @return {Ext.core.Element} this + */ + removeCls : function(className){ + var me = this, + i, idx, len, cls, elClasses; + if (!Ext.isDefined(className)) { + return me; + } + if (!Ext.isArray(className)){ + className = className.replace(trimRe, '').split(spacesRe); + } + if (me.dom && me.dom.className) { + elClasses = me.dom.className.replace(trimRe, '').split(spacesRe); + for (i = 0, len = className.length; i < len; i++) { + cls = className[i]; + if (typeof cls == 'string') { + cls = cls.replace(trimRe, ''); + idx = Ext.Array.indexOf(elClasses, cls); + if (idx != -1) { + elClasses.splice(idx, 1); + } + } + } + me.dom.className = elClasses.join(" "); + } + return me; + }, + + /** + * Adds one or more CSS classes to this element and removes the same class(es) from all siblings. + * @param {String/Array} className The CSS class to add, or an array of classes + * @return {Ext.core.Element} this + */ + radioCls : function(className){ + var cn = this.dom.parentNode.childNodes, + v, i, len; + className = Ext.isArray(className) ? className : [className]; + for (i = 0, len = cn.length; i < len; i++) { + v = cn[i]; + if (v && v.nodeType == 1) { + Ext.fly(v, '_internal').removeCls(className); + } + } + return this.addCls(className); + }, + + /** + * Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). + * @param {String} className The CSS class to toggle + * @return {Ext.core.Element} this + * @method + */ + toggleCls : Ext.supports.ClassList ? + function(className) { + this.dom.classList.toggle(Ext.String.trim(className)); + return this; + } : + function(className) { + return this.hasCls(className) ? this.removeCls(className) : this.addCls(className); + }, + + /** + * Checks if the specified CSS class exists on this element's DOM node. + * @param {String} className The CSS class to check for + * @return {Boolean} True if the class exists, else false + * @method + */ + hasCls : Ext.supports.ClassList ? + function(className) { + if (!className) { + return false; + } + className = className.split(spacesRe); + var ln = className.length, + i = 0; + for (; i < ln; i++) { + if (className[i] && this.dom.classList.contains(className[i])) { + return true; + } + } + return false; + } : + function(className){ + return className && (' ' + this.dom.className + ' ').indexOf(' ' + className + ' ') != -1; + }, + + /** + * Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. + * @param {String} oldClassName The CSS class to replace + * @param {String} newClassName The replacement CSS class + * @return {Ext.core.Element} this + */ + replaceCls : function(oldClassName, newClassName){ + return this.removeCls(oldClassName).addCls(newClassName); + }, + + isStyle : function(style, val) { + return this.getStyle(style) == val; + }, + + /** + * Normalizes currentStyle and computedStyle. + * @param {String} property The style property whose value is returned. + * @return {String} The current value of the style property for this element. + * @method + */ + getStyle : function(){ + return view && view.getComputedStyle ? + function(prop){ + var el = this.dom, + v, cs, out, display, cleaner; + + if(el == document){ + return null; + } + prop = Ext.core.Element.normalize(prop); + out = (v = el.style[prop]) ? v : + (cs = view.getComputedStyle(el, "")) ? cs[prop] : null; + + // Ignore cases when the margin is correctly reported as 0, the bug only shows + // numbers larger. + if(prop == 'marginRight' && out != '0px' && !supports.RightMargin){ + cleaner = Ext.core.Element.getRightMarginFixCleaner(el); + display = this.getStyle('display'); + el.style.display = 'inline-block'; + out = view.getComputedStyle(el, '').marginRight; + el.style.display = display; + cleaner(); + } + + if(prop == 'backgroundColor' && out == 'rgba(0, 0, 0, 0)' && !supports.TransparentColor){ + out = 'transparent'; + } + return out; + } : + function(prop){ + var el = this.dom, + m, cs; + + if (el == document) { + return null; + } + + if (prop == 'opacity') { + if (el.style.filter.match) { + m = el.style.filter.match(opacityRe); + if(m){ + var fv = parseFloat(m[1]); + if(!isNaN(fv)){ + return fv ? fv / 100 : 0; + } + } + } + return 1; + } + prop = Ext.core.Element.normalize(prop); + return el.style[prop] || ((cs = el.currentStyle) ? cs[prop] : null); + }; + }(), + + /** + * Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values + * are convert to standard 6 digit hex color. + * @param {String} attr The css attribute + * @param {String} defaultValue The default value to use when a valid color isn't found + * @param {String} prefix (optional) defaults to #. Use an empty string when working with + * color anims. + */ + getColor : function(attr, defaultValue, prefix){ + var v = this.getStyle(attr), + color = prefix || prefix === '' ? prefix : '#', + h; + + if(!v || (/transparent|inherit/.test(v))) { + return defaultValue; + } + if(/^r/.test(v)){ + Ext.each(v.slice(4, v.length -1).split(','), function(s){ + h = parseInt(s, 10); + color += (h < 16 ? '0' : '') + h.toString(16); + }); + }else{ + v = v.replace('#', ''); + color += v.length == 3 ? v.replace(/^(\w)(\w)(\w)$/, '$1$1$2$2$3$3') : v; + } + return(color.length > 5 ? color.toLowerCase() : defaultValue); + }, + + /** + * Wrapper for setting style properties, also takes single object parameter of multiple styles. + * @param {String/Object} property The style property to be set, or an object of multiple styles. + * @param {String} value (optional) The value to apply to the given property, or null if an object was passed. + * @return {Ext.core.Element} this + */ + setStyle : function(prop, value){ + var me = this, + tmp, style; + + if (!me.dom) { + return me; + } + + if (!Ext.isObject(prop)) { + tmp = {}; + tmp[prop] = value; + prop = tmp; + } + for (style in prop) { + if (prop.hasOwnProperty(style)) { + value = Ext.value(prop[style], ''); + if (style == 'opacity') { + me.setOpacity(value); + } + else { + me.dom.style[Ext.core.Element.normalize(style)] = value; + } + } + } + return me; + }, + + /** + * Set the opacity of the element + * @param {Float} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc + * @param {Boolean/Object} animate (optional) a standard Element animation config object or true for + * the default animation ({duration: .35, easing: 'easeIn'}) + * @return {Ext.core.Element} this + */ + setOpacity: function(opacity, animate) { + var me = this, + dom = me.dom, + val, + style; + + if (!me.dom) { + return me; + } + + style = me.dom.style; + + if (!animate || !me.anim) { + if (!Ext.supports.Opacity) { + opacity = opacity < 1 ? 'alpha(opacity=' + opacity * 100 + ')': ''; + val = style.filter.replace(opacityRe, '').replace(trimRe, ''); + + style.zoom = 1; + style.filter = val + (val.length > 0 ? ' ': '') + opacity; + } + else { + style.opacity = opacity; + } + } + else { + if (!Ext.isObject(animate)) { + animate = { + duration: 350, + easing: 'ease-in' + }; + } + me.animate(Ext.applyIf({ + to: { + opacity: opacity + } + }, + animate)); + } + return me; + }, + + + /** + * Clears any opacity settings from this element. Required in some cases for IE. + * @return {Ext.core.Element} this + */ + clearOpacity : function(){ + var style = this.dom.style; + if(!Ext.supports.Opacity){ + if(!Ext.isEmpty(style.filter)){ + style.filter = style.filter.replace(opacityRe, '').replace(trimRe, ''); + } + }else{ + style.opacity = style['-moz-opacity'] = style['-khtml-opacity'] = ''; + } + return this; + }, + + /** + * @private + * Returns 1 if the browser returns the subpixel dimension rounded to the lowest pixel. + * @return {Number} 0 or 1 + */ + adjustDirect2DDimension: function(dimension) { + var me = this, + dom = me.dom, + display = me.getStyle('display'), + inlineDisplay = dom.style['display'], + inlinePosition = dom.style['position'], + originIndex = dimension === 'width' ? 0 : 1, + floating; + + if (display === 'inline') { + dom.style['display'] = 'inline-block'; + } + + dom.style['position'] = display.match(adjustDirect2DTableRe) ? 'absolute' : 'static'; + + // floating will contain digits that appears after the decimal point + // if height or width are set to auto we fallback to msTransformOrigin calculation + floating = (parseFloat(me.getStyle(dimension)) || parseFloat(dom.currentStyle.msTransformOrigin.split(' ')[originIndex]) * 2) % 1; + + dom.style['position'] = inlinePosition; + + if (display === 'inline') { + dom.style['display'] = inlineDisplay; + } + + return floating; + }, + + /** + * Returns the offset height of the element + * @param {Boolean} contentHeight (optional) true to get the height minus borders and padding + * @return {Number} The element's height + */ + getHeight: function(contentHeight, preciseHeight) { + var me = this, + dom = me.dom, + hidden = Ext.isIE && me.isStyle('display', 'none'), + height, overflow, style, floating; + + // IE Quirks mode acts more like a max-size measurement unless overflow is hidden during measurement. + // We will put the overflow back to it's original value when we are done measuring. + if (Ext.isIEQuirks) { + style = dom.style; + overflow = style.overflow; + me.setStyle({ overflow: 'hidden'}); + } + + height = dom.offsetHeight; + + height = MATH.max(height, hidden ? 0 : dom.clientHeight) || 0; + + // IE9 Direct2D dimension rounding bug + if (!hidden && Ext.supports.Direct2DBug) { + floating = me.adjustDirect2DDimension('height'); + if (preciseHeight) { + height += floating; + } + else if (floating > 0 && floating < 0.5) { + height++; + } + } + + if (contentHeight) { + height -= (me.getBorderWidth("tb") + me.getPadding("tb")); + } + + if (Ext.isIEQuirks) { + me.setStyle({ overflow: overflow}); + } + + if (height < 0) { + height = 0; + } + return height; + }, + + /** + * Returns the offset width of the element + * @param {Boolean} contentWidth (optional) true to get the width minus borders and padding + * @return {Number} The element's width + */ + getWidth: function(contentWidth, preciseWidth) { + var me = this, + dom = me.dom, + hidden = Ext.isIE && me.isStyle('display', 'none'), + rect, width, overflow, style, floating, parentPosition; + + // IE Quirks mode acts more like a max-size measurement unless overflow is hidden during measurement. + // We will put the overflow back to it's original value when we are done measuring. + if (Ext.isIEQuirks) { + style = dom.style; + overflow = style.overflow; + me.setStyle({overflow: 'hidden'}); + } + + // Fix Opera 10.5x width calculation issues + if (Ext.isOpera10_5) { + if (dom.parentNode.currentStyle.position === 'relative') { + parentPosition = dom.parentNode.style.position; + dom.parentNode.style.position = 'static'; + width = dom.offsetWidth; + dom.parentNode.style.position = parentPosition; + } + width = Math.max(width || 0, dom.offsetWidth); + + // Gecko will in some cases report an offsetWidth that is actually less than the width of the + // text contents, because it measures fonts with sub-pixel precision but rounds the calculated + // value down. Using getBoundingClientRect instead of offsetWidth allows us to get the precise + // subpixel measurements so we can force them to always be rounded up. See + // https://bugzilla.mozilla.org/show_bug.cgi?id=458617 + } else if (Ext.supports.BoundingClientRect) { + rect = dom.getBoundingClientRect(); + width = rect.right - rect.left; + width = preciseWidth ? width : Math.ceil(width); + } else { + width = dom.offsetWidth; + } + + width = MATH.max(width, hidden ? 0 : dom.clientWidth) || 0; + + // IE9 Direct2D dimension rounding bug + if (!hidden && Ext.supports.Direct2DBug) { + floating = me.adjustDirect2DDimension('width'); + if (preciseWidth) { + width += floating; + } + else if (floating > 0 && floating < 0.5) { + width++; + } + } + + if (contentWidth) { + width -= (me.getBorderWidth("lr") + me.getPadding("lr")); + } + + if (Ext.isIEQuirks) { + me.setStyle({ overflow: overflow}); + } + + if (width < 0) { + width = 0; + } + return width; + }, + + /** + * Set the width of this Element. + * @param {Mixed} width The new width. This may be one of:

A Number specifying the new width in this Element's {@link #defaultUnit}s (by default, pixels).
A String used to set the CSS width style. Animation may not be used. + *

+ * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setWidth : function(width, animate){ + var me = this; + width = me.adjustWidth(width); + if (!animate || !me.anim) { + me.dom.style.width = me.addUnits(width); + } + else { + if (!Ext.isObject(animate)) { + animate = {}; + } + me.animate(Ext.applyIf({ + to: { + width: width + } + }, animate)); + } + return me; + }, + + /** + * Set the height of this Element. + *


+// 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:

A Number specifying the new height in this Element's {@link #defaultUnit}s (by default, pixels.)
A String used to set the CSS height style. Animation may not be used.

+ * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setHeight : function(height, animate){ + var me = this; + height = me.adjustHeight(height); + if (!animate || !me.anim) { + me.dom.style.height = me.addUnits(height); + } + else { + if (!Ext.isObject(animate)) { + animate = {}; + } + me.animate(Ext.applyIf({ + to: { + height: height + } + }, animate)); + } + return me; + }, + + /** + * Gets the width of the border(s) for the specified side(s) + * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example, + * passing 'lr' would get the border left width + the border right width. + * @return {Number} The width of the sides passed added together + */ + getBorderWidth : function(side){ + return this.addStyles(side, borders); + }, + + /** + * Gets the width of the padding(s) for the specified side(s) + * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example, + * passing 'lr' would get the padding left + the padding right. + * @return {Number} The padding of the sides passed added together + */ + getPadding : function(side){ + return this.addStyles(side, paddings); + }, + + /** + * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove + * @return {Ext.core.Element} this + */ + clip : function(){ + var me = this, + dom = me.dom; + + if(!data(dom, ISCLIPPED)){ + data(dom, ISCLIPPED, true); + data(dom, ORIGINALCLIP, { + o: me.getStyle(OVERFLOW), + x: me.getStyle(OVERFLOWX), + y: me.getStyle(OVERFLOWY) + }); + me.setStyle(OVERFLOW, HIDDEN); + me.setStyle(OVERFLOWX, HIDDEN); + me.setStyle(OVERFLOWY, HIDDEN); + } + return me; + }, + + /** + * Return clipping (overflow) to original clipping before {@link #clip} was called + * @return {Ext.core.Element} this + */ + unclip : function(){ + var me = this, + dom = me.dom, + clip; + + if(data(dom, ISCLIPPED)){ + data(dom, ISCLIPPED, false); + clip = data(dom, ORIGINALCLIP); + if(o.o){ + me.setStyle(OVERFLOW, o.o); + } + if(o.x){ + me.setStyle(OVERFLOWX, o.x); + } + if(o.y){ + me.setStyle(OVERFLOWY, o.y); + } + } + return me; + }, + + // private + addStyles : function(sides, styles){ + var totalSize = 0, + sidesArr = sides.match(wordsRe), + i = 0, + len = sidesArr.length, + side, size; + for (; i < len; i++) { + side = sidesArr[i]; + size = side && parseInt(this.getStyle(styles[side]), 10); + if (size) { + totalSize += MATH.abs(size); + } + } + return totalSize; + }, + + margins : margins, + + /** + * More flexible version of {@link #setStyle} for setting style properties. + * @param {String/Object/Function} styles A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or + * a function which returns such a specification. + * @return {Ext.core.Element} this + */ + applyStyles : function(style){ + Ext.core.DomHelper.applyStyles(this.dom, style); + return this; + }, + + /** + * Returns an object with properties matching the styles requested. + * For example, el.getStyles('color', 'font-size', 'width') might return + * {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}. + * @param {String} style1 A style name + * @param {String} style2 A style name + * @param {String} etc. + * @return {Object} The style object + */ + getStyles : function(){ + var styles = {}, + len = arguments.length, + i = 0, style; + + for(; i < len; ++i) { + style = arguments[i]; + styles[style] = this.getStyle(style); + } + return styles; + }, + + /** + *

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", "

" + Ext.String.format(Ext.core.Element.boxMarkup, cls) + "

")); + Ext.DomQuery.selectNode('.' + cls + '-mc', el.dom).appendChild(this.dom); + return el; + }, + + /** + * Set the size of this Element. If animation is true, both width and height will be animated concurrently. + * @param {Mixed} width The new width. This may be one of:

A Number specifying the new width in this Element's {@link #defaultUnit}s (by default, pixels).
A String used to set the CSS width style. Animation may not be used. + *
A size object in the format {width: widthValue, height: heightValue}.

+ * @param {Mixed} height The new height. This may be one of:

A Number specifying the new height in this Element's {@link #defaultUnit}s (by default, pixels).
A String used to set the CSS height style. Animation may not be used.

+ * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setSize : function(width, height, animate){ + var me = this; + if (Ext.isObject(width)){ // in case of object from getSize() + height = width.height; + width = width.width; + } + width = me.adjustWidth(width); + height = me.adjustHeight(height); + if(!animate || !me.anim){ + me.dom.style.width = me.addUnits(width); + me.dom.style.height = me.addUnits(height); + } + else { + if (!Ext.isObject(animate)) { + animate = {}; + } + me.animate(Ext.applyIf({ + to: { + width: width, + height: height + } + }, animate)); + } + return me; + }, + + /** + * Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders + * when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements + * if a height has not been set using CSS. + * @return {Number} + */ + getComputedHeight : function(){ + var me = this, + h = Math.max(me.dom.offsetHeight, me.dom.clientHeight); + if(!h){ + h = parseFloat(me.getStyle('height')) || 0; + if(!me.isBorderBox()){ + h += me.getFrameWidth('tb'); + } + } + return h; + }, + + /** + * Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders + * when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements + * if a width has not been set using CSS. + * @return {Number} + */ + getComputedWidth : function(){ + var me = this, + w = Math.max(me.dom.offsetWidth, me.dom.clientWidth); + + if(!w){ + w = parseFloat(me.getStyle('width')) || 0; + if(!me.isBorderBox()){ + w += me.getFrameWidth('lr'); + } + } + return w; + }, + + /** + * Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() + for more information about the sides. + * @param {String} sides + * @return {Number} + */ + getFrameWidth : function(sides, onlyContentBox){ + return onlyContentBox && this.isBorderBox() ? 0 : (this.getPadding(sides) + this.getBorderWidth(sides)); + }, + + /** + * Sets up event handlers to add and remove a css class when the mouse is over this element + * @param {String} className + * @return {Ext.core.Element} this + */ + addClsOnOver : function(className){ + var dom = this.dom; + this.hover( + function(){ + Ext.fly(dom, INTERNAL).addCls(className); + }, + function(){ + Ext.fly(dom, INTERNAL).removeCls(className); + } + ); + return this; + }, + + /** + * Sets up event handlers to add and remove a css class when this element has the focus + * @param {String} className + * @return {Ext.core.Element} this + */ + addClsOnFocus : function(className){ + var me = this, + dom = me.dom; + me.on("focus", function(){ + Ext.fly(dom, INTERNAL).addCls(className); + }); + me.on("blur", function(){ + Ext.fly(dom, INTERNAL).removeCls(className); + }); + return me; + }, + + /** + * Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect) + * @param {String} className + * @return {Ext.core.Element} this + */ + addClsOnClick : function(className){ + var dom = this.dom; + this.on("mousedown", function(){ + Ext.fly(dom, INTERNAL).addCls(className); + var d = Ext.getDoc(), + fn = function(){ + Ext.fly(dom, INTERNAL).removeCls(className); + d.removeListener("mouseup", fn); + }; + d.on("mouseup", fn); + }); + return this; + }, + + /** + *

Returns the dimensions of the element available to lay content out in.

+ *

If the element (or any ancestor element) has CSS style display : none, the dimensions will be zero.

+ * example:


+        var vpSize = Ext.getBody().getViewSize();
+
+        // all Windows created afterwards will have a default value of 90% height and 95% width
+        Ext.Window.override({
+            width: vpSize.width * 0.9,
+            height: vpSize.height * 0.95
+        });
+        // To handle window resizing you would have to hook onto onWindowResize.
+        *

+ * + * getViewSize utilizes clientHeight/clientWidth which excludes sizing of scrollbars. + * To obtain the size including scrollbars, use getStyleSize + * + * Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc. + */ + + 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: + *

border-width -> borderWidth
padding-top -> paddingTop

+ * @static + * @param {String} prop The property to normalize + * @return {String} The normalized string + */ + normalize : function(prop) { + if (prop == 'float') { + prop = Ext.supports.Float ? 'cssFloat' : 'styleFloat'; + } + return this.propertyCache[prop] || (this.propertyCache[prop] = prop.replace(this.camelRe, this.camelReplaceFn)); + }, + + /** + * Retrieves the document height + * @static + * @return {Number} documentHeight + */ + getDocumentHeight: function() { + return Math.max(!Ext.isStrict ? document.body.scrollHeight : document.documentElement.scrollHeight, this.getViewportHeight()); + }, + + /** + * Retrieves the document width + * @static + * @return {Number} documentWidth + */ + getDocumentWidth: function() { + return Math.max(!Ext.isStrict ? document.body.scrollWidth : document.documentElement.scrollWidth, this.getViewportWidth()); + }, + + /** + * Retrieves the viewport height of the window. + * @static + * @return {Number} viewportHeight + */ + getViewportHeight: function(){ + return window.innerHeight; + }, + + /** + * Retrieves the viewport width of the window. + * @static + * @return {Number} viewportWidth + */ + getViewportWidth : function() { + return window.innerWidth; + }, + + /** + * Retrieves the viewport size of the window. + * @static + * @return {Object} object containing width and height properties + */ + getViewSize : function() { + return { + width: window.innerWidth, + height: window.innerHeight + }; + }, + + /** + * Retrieves the current orientation of the window. This is calculated by + * determing if the height is greater than the width. + * @static + * @return {String} Orientation of window: 'portrait' or 'landscape' + */ + getOrientation : function() { + if (Ext.supports.OrientationChange) { + return (window.orientation == 0) ? 'portrait' : 'landscape'; + } + + return (window.innerHeight > window.innerWidth) ? 'portrait' : 'landscape'; + }, + + /** + * Returns the top Element that is located at the passed coordinates + * @static + * @param {Number} x The x coordinate + * @param {Number} x The y coordinate + * @return {String} The found Element + */ + fromPoint: function(x, y) { + return Ext.get(document.elementFromPoint(x, y)); + }, + + /** + * Converts a CSS string into an object with a property for each style. + *

+ * 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; iCalls the passed function for each element in this composite.

+ * @param {Function} fn The function to call. The function is passed the following parameters:

el : Element
The current Element in the iteration. + * This is the flyweight (shared) Ext.core.Element instance, so if you require a + * a reference to the dom node, use el.dom.
c : Composite
This Composite object.
idx : Number
The zero-based index in the iteration.

+ * @param {Object} scope (optional) The scope (this reference) in which the function is executed. (defaults to the Element) + * @return {CompositeElement} this + */ + each : function(fn, scope){ + var me = this, + els = me.elements, + len = els.length, + i, e; + + for(i = 0; i + *

el : Ext.core.Element

The current DOM element.

+ *

index : Number

The current index within the collection.

+ * + * @return {CompositeElement} this + */ + filter : function(selector){ + var els = [], + me = this, + fn = Ext.isFunction(selector) ? selector + : function(el){ + return el.is(selector); + }; + + me.each(function(el, self, i) { + if (fn(el, i) !== false) { + els[els.length] = me.transformElement(el); + } + }); + + me.elements = els; + return me; + }, + + /** + * Find the index of the passed element within the composite collection. + * @param el {Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection. + * @return Number The index of the passed Ext.core.Element in the composite collection, or -1 if not found. + */ + indexOf : function(el){ + return Ext.Array.indexOf(this.elements, this.transformElement(el)); + }, + + /** + * Replaces the specified element with the passed element. + * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite + * to replace. + * @param {Mixed} replacement The id of an element or the Element itself. + * @param {Boolean} domReplace (Optional) True to remove and replace the element in the document too. + * @return {CompositeElement} this + */ + replaceElement : function(el, replacement, domReplace){ + var index = !isNaN(el) ? el : this.indexOf(el), + d; + if(index > -1){ + replacement = Ext.getDom(replacement); + if(domReplace){ + d = this.elements[index]; + d.parentNode.insertBefore(replacement, d); + Ext.removeNode(d); + } + this.elements.splice(index, 1, replacement); + } + return this; + }, + + /** + * Removes all elements. + */ + clear : function(){ + this.elements = []; + } +}; + +Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addListener; + +/** + * @private + * Copies all of the functions from Ext.core.Element's prototype onto CompositeElementLite's prototype. + * This is called twice - once immediately below, and once again after additional Ext.core.Element + * are added in Ext JS + */ +Ext.CompositeElementLite.importElementMethods = function() { + var fnName, + ElProto = Ext.core.Element.prototype, + CelProto = Ext.CompositeElementLite.prototype; + + for (fnName in ElProto) { + if (typeof ElProto[fnName] == 'function'){ + (function(fnName) { + CelProto[fnName] = CelProto[fnName] || function() { + return this.invoke(fnName, arguments); + }; + }).call(CelProto, fnName); + + } + } +}; + +Ext.CompositeElementLite.importElementMethods(); + +if(Ext.DomQuery){ + Ext.core.Element.selectorFunction = Ext.DomQuery.select; +} + +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods + * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or + * {@link Ext.CompositeElementLite CompositeElementLite} object. + * @param {String/Array} selector The CSS selector or an array of elements + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Ext.core.Element + * @method select + */ +Ext.core.Element.select = function(selector, root){ + var els; + if(typeof selector == "string"){ + els = Ext.core.Element.selectorFunction(selector, root); + }else if(selector.length !== undefined){ + els = selector; + }else{ + Ext.Error.raise({ + sourceClass: "Ext.core.Element", + sourceMethod: "select", + selector: selector, + root: root, + msg: "Invalid selector specified: " + selector + }); + } + return new Ext.CompositeElementLite(els); +}; +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods + * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or + * {@link Ext.CompositeElementLite CompositeElementLite} object. + * @param {String/Array} selector The CSS selector or an array of elements + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Ext + * @method select + */ +Ext.select = Ext.core.Element.select; + +/** + * @class Ext.util.DelayedTask + * + * The DelayedTask class provides a convenient way to "buffer" the execution of a method, + * performing setTimeout where a new timeout cancels the old timeout. When called, the + * task will wait the specified time period before executing. If durng that time period, + * the task is called again, the original call will be cancelled. This continues so that + * the function is only called a single time for each iteration. + * + * This method is especially useful for things like detecting whether a user has finished + * typing in a text field. An example would be performing validation on a keypress. You can + * use this class to buffer the keypress events for a certain number of milliseconds, and + * perform only if they stop for that amount of time. + * + * ## Usage + * + * var task = new Ext.util.DelayedTask(function(){ + * alert(Ext.getDom('myInputField').value.length); + * }); + * + * // Wait 500ms before calling our function. If the user presses another key + * // during that 500ms, it will be cancelled and we'll wait another 500ms. + * Ext.get('myInputField').on('keypress', function(){ + * task.{@link #delay}(500); + * }); + * + * Note that we are using a DelayedTask here to illustrate a point. The configuration + * option `buffer` for {@link Ext.util.Observable#addListener addListener/on} will + * also setup a delayed task for you to buffer events. + * + * @constructor The parameters to this constructor serve as defaults and are not required. + * @param {Function} fn (optional) The default function to call. + * @param {Object} scope The default scope (The this reference) in which the + * function is called. If not specified, this will refer to the browser window. + * @param {Array} args (optional) The default Array of arguments. + */ +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:

evt : EventObject
The {@link Ext.EventObject EventObject} describing the event.
t : Element
The {@link Ext.core.Element Element} which was the target of the event. + * Note that this may be filtered by using the delegate option.
o : Object
The options object from the addListener call.

+ * @param {Object} scope (optional) The scope (this reference) in which the handler function is executed. Defaults to the Element. + * @param {Object} options (optional) An object containing handler configuration properties. + * This may contain any of the following properties:

scope : Object
The scope (this reference) in which the handler function is executed. Defaults to the Element.
delegate : String
A simple selector to filter the target or look for a descendant of the target
stopEvent : Boolean
True to stop the event. That is stop propagation, and prevent the default action.
preventDefault : Boolean
True to prevent the default action
stopPropagation : Boolean
True to prevent event propagation
normalized : Boolean
False to pass a browser event to the handler function instead of an Ext.EventObject
delay : Number
The number of milliseconds to delay the invocation of the handler after te event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an {@link Ext.util.DelayedTask} delayed + * by the specified number of milliseconds. If the event fires again within that time, the original + * handler is not invoked, but the new handler is scheduled in its place.
target : Element
Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node.

+ *

See {@link Ext.core.Element#addListener} for examples of how to use these options.

+ */ + addListener: function(element, eventName, fn, scope, options){ + // Check if we've been passed a "config style" event. + if (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} options The options + * @return {Function} the wrapper function + */ + createListenerWrap : function(dom, ename, fn, scope, options) { + options = !Ext.isObject(options) ? {} : options; + + var f, gen; + + return function wrap(e, args) { + // Compile the implementation upon first firing + if (!gen) { + f = ['if(!Ext) {return;}']; + + if(options.buffer || options.delay || options.freezeEvent) { + f.push('e = new Ext.EventObjectImpl(e, ' + (options.freezeEvent ? 'true' : 'false' ) + ');'); + } else { + f.push('e = Ext.EventObject.setEvent(e);'); + } + + if (options.delegate) { + f.push('var t = e.getTarget("' + options.delegate + '", this);'); + f.push('if(!t) {return;}'); + } else { + f.push('var t = e.target;'); + } + + if (options.target) { + f.push('if(e.target !== options.target) {return;}'); + } + + if(options.stopEvent) { + f.push('e.stopEvent();'); + } else { + if(options.preventDefault) { + f.push('e.preventDefault();'); + } + if(options.stopPropagation) { + f.push('e.stopPropagation();'); + } + } + + if(options.normalized === false) { + f.push('e = e.browserEvent;'); + } + + if(options.buffer) { + f.push('(wrap.task && clearTimeout(wrap.task));'); + f.push('wrap.task = setTimeout(function(){'); + } + + if(options.delay) { + f.push('wrap.tasks = wrap.tasks || [];'); + f.push('wrap.tasks.push(setTimeout(function(){'); + } + + // finally call the actual handler fn + f.push('fn.call(scope || dom, e, t, options);'); + + if(options.single) { + f.push('Ext.EventManager.removeListener(dom, ename, fn, scope);'); + } + + if(options.delay) { + f.push('}, ' + options.delay + '));'); + } + + if(options.buffer) { + f.push('}, ' + options.buffer + ');'); + } + + gen = Ext.functionFactory('e', 'options', 'fn', 'scope', 'ename', 'dom', 'wrap', 'args', f.join('\n')); + } + + gen.call(dom, e, options, fn, scope, ename, dom, wrap, args); + }; + }, + + /** + * Get the event cache for a particular element for a particular event + * @private + * @param {HTMLElement} element The element + * @param {Object} eventName The event name + * @return {Array} The events for the element + */ + getEventListenerCache : function(element, eventName) { + 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

+ *

load
unload
select
change
submit
reset
resize
scroll

+ *

MouseEvents

+ *

click
dblclick
mousedown
mouseup
mouseover
mousemove
mouseout

+ *

UIEvents

+ *

focusin
focusout
activate
focus
blur

+ * @param {Element/HTMLElement} target If specified, the target for the event. This + * is likely to be used when relaying a DOM event. If not specified, {@link #getTarget} + * is used to determine the target. + */ + injectEvent: function () { + var API, + dispatchers = {}; // keyed by event type (e.g., 'mousedown') + + // Good reference: http://developer.yahoo.com/yui/docs/UserAction.js.html + + // IE9 has createEvent, but this code causes major problems with htmleditor (it + // blocks all mouse events and maybe more). TODO + + if (!Ext.isIE && document.createEvent) { // if (DOM compliant) + API = { + createHtmlEvent: function (doc, type, bubbles, cancelable) { + var event = doc.createEvent('HTMLEvents'); + + event.initEvent(type, bubbles, cancelable); + return event; + }, + + createMouseEvent: function (doc, type, bubbles, cancelable, detail, + clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, + button, relatedTarget) { + var event = doc.createEvent('MouseEvents'), + view = doc.defaultView || window; + + if (event.initMouseEvent) { + event.initMouseEvent(type, bubbles, cancelable, view, detail, + clientX, clientY, clientX, clientY, ctrlKey, altKey, + shiftKey, metaKey, button, relatedTarget); + } else { // old Safari + event = doc.createEvent('UIEvents'); + event.initEvent(type, bubbles, cancelable); + event.view = view; + event.detail = detail; + event.screenX = clientX; + event.screenY = clientY; + event.clientX = clientX; + event.clientY = clientY; + event.ctrlKey = ctrlKey; + event.altKey = altKey; + event.metaKey = metaKey; + event.shiftKey = shiftKey; + event.button = button; + event.relatedTarget = relatedTarget; + } + + return event; + }, + + createUIEvent: function (doc, type, bubbles, cancelable, detail) { + var event = doc.createEvent('UIEvents'), + view = doc.defaultView || window; + + event.initUIEvent(type, bubbles, cancelable, view, detail); + return event; + }, + + fireEvent: function (target, type, event) { + target.dispatchEvent(event); + }, + + fixTarget: function (target) { + // Safari3 doesn't have window.dispatchEvent() + if (target == window && !target.dispatchEvent) { + return document; + } + + return target; + } + } + } else if (document.createEventObject) { // else if (IE) + var crazyIEButtons = { 0: 1, 1: 4, 2: 2 }; + + API = { + createHtmlEvent: function (doc, type, bubbles, cancelable) { + var event = doc.createEventObject(); + event.bubbles = bubbles; + event.cancelable = cancelable; + return event; + }, + + createMouseEvent: function (doc, type, bubbles, cancelable, detail, + clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, + button, relatedTarget) { + var event = doc.createEventObject(); + event.bubbles = bubbles; + event.cancelable = cancelable; + event.detail = detail; + event.screenX = clientX; + event.screenY = clientY; + event.clientX = clientX; + event.clientY = clientY; + event.ctrlKey = ctrlKey; + event.altKey = altKey; + event.shiftKey = shiftKey; + event.metaKey = metaKey; + event.button = crazyIEButtons[button] || button; + event.relatedTarget = relatedTarget; // cannot assign to/fromElement + return event; + }, + + createUIEvent: function (doc, type, bubbles, cancelable, detail) { + var event = doc.createEventObject(); + event.bubbles = bubbles; + event.cancelable = cancelable; + return event; + }, + + fireEvent: function (target, type, event) { + target.fireEvent('on' + type, event); + }, + + fixTarget: function (target) { + if (target == document) { + // IE6,IE7 thinks window==document and doesn't have window.fireEvent() + // IE6,IE7 cannot properly call document.fireEvent() + return document.documentElement; + } + + return target; + } + }; + } + + //---------------- + // HTMLEvents + + Ext.Object.each({ + load: [false, false], + unload: [false, false], + select: [true, false], + change: [true, false], + submit: [true, true], + reset: [true, false], + resize: [true, false], + scroll: [true, false] + }, + function (name, value) { + var bubbles = value[0], cancelable = value[1]; + dispatchers[name] = function (targetEl, srcEvent) { + var e = API.createHtmlEvent(name, bubbles, cancelable); + API.fireEvent(targetEl, name, e); + }; + }); + + //---------------- + // MouseEvents + + function createMouseEventDispatcher (type, detail) { + var cancelable = (type != 'mousemove'); + return function (targetEl, srcEvent) { + var xy = srcEvent.getXY(), + e = API.createMouseEvent(targetEl.ownerDocument, type, true, cancelable, + detail, xy[0], xy[1], srcEvent.ctrlKey, srcEvent.altKey, + srcEvent.shiftKey, srcEvent.metaKey, srcEvent.button, + srcEvent.relatedTarget); + API.fireEvent(targetEl, type, e); + }; + } + + Ext.each(['click', 'dblclick', 'mousedown', 'mouseup', 'mouseover', 'mousemove', 'mouseout'], + function (eventName) { + dispatchers[eventName] = createMouseEventDispatcher(eventName, 1); + }); + + //---------------- + // UIEvents + + Ext.Object.each({ + focusin: [true, false], + focusout: [true, false], + activate: [true, true], + focus: [false, false], + blur: [false, false] + }, + function (name, value) { + var bubbles = value[0], cancelable = value[1]; + dispatchers[name] = function (targetEl, srcEvent) { + var e = API.createUIEvent(targetEl.ownerDocument, name, bubbles, cancelable, 1); + API.fireEvent(targetEl, name, e); + }; + }); + + //--------- + if (!API) { + // not even sure what ancient browsers fall into this category... + + dispatchers = {}; // never mind all those we just built :P + + API = { + fixTarget: function (t) { + return t; + } + }; + } + + function cannotInject (target, srcEvent) { + // TODO log something + } + + return function (target) { + var me = this, + dispatcher = dispatchers[me.type] || cannotInject, + t = target ? (target.dom || target) : me.getTarget(); + + t = API.fixTarget(t); + dispatcher(t, me); + }; + }() // call to produce method + +}, function() { + +Ext.EventObject = new Ext.EventObjectImpl(); + +}); + + +/** + * @class Ext.core.Element + */ +(function(){ + var doc = document, + activeElement = null, + isCSS1 = doc.compatMode == "CSS1Compat", + ELEMENT = Ext.core.Element, + fly = function(el){ + if (!_fly) { + _fly = new Ext.core.Element.Flyweight(); + } + _fly.dom = el; + return _fly; + }, _fly; + + // If the browser does not support document.activeElement we need some assistance. + // This covers old Safari 3.2 (4.0 added activeElement along with just about all + // other browsers). We need this support to handle issues with old Safari. + if (!('activeElement' in doc) && doc.addEventListener) { + doc.addEventListener('focus', + function (ev) { + if (ev && ev.target) { + activeElement = (ev.target == doc) ? null : ev.target; + } + }, true); + } + + /* + * Helper function to create the function that will restore the selection. + */ + function makeSelectionRestoreFn (activeEl, start, end) { + return function () { + activeEl.selectionStart = start; + activeEl.selectionEnd = end; + }; + } + + Ext.apply(ELEMENT, { + isAncestor : function(p, c) { + var ret = false; + + p = Ext.getDom(p); + c = Ext.getDom(c); + if (p && c) { + if (p.contains) { + return p.contains(c); + } else if (p.compareDocumentPosition) { + return !!(p.compareDocumentPosition(c) & 16); + } else { + while ((c = c.parentNode)) { + ret = c == p || ret; + } + } + } + return ret; + }, + + /** + * Returns the active element in the DOM. If the browser supports activeElement + * on the document, this is returned. If not, the focus is tracked and the active + * element is maintained internally. + * @return {HTMLElement} The active (focused) element in the document. + */ + getActiveElement: function () { + return doc.activeElement || activeElement; + }, + + /** + * Creates a function to call to clean up problems with the work-around for the + * WebKit RightMargin bug. The work-around is to add "display: 'inline-block'" to + * the element before calling getComputedStyle and then to restore its original + * display value. The problem with this is that it corrupts the selection of an + * INPUT or TEXTAREA element (as in the "I-beam" goes away but ths focus remains). + * To cleanup after this, we need to capture the selection of any such element and + * then restore it after we have restored the display style. + * + * @param target {Element} The top-most element being adjusted. + * @private + */ + getRightMarginFixCleaner: function (target) { + var supports = Ext.supports, + hasInputBug = supports.DisplayChangeInputSelectionBug, + hasTextAreaBug = supports.DisplayChangeTextAreaSelectionBug; + + if (hasInputBug || hasTextAreaBug) { + var activeEl = doc.activeElement || activeElement, // save a call + tag = activeEl && activeEl.tagName, + start, + end; + + if ((hasTextAreaBug && tag == 'TEXTAREA') || + (hasInputBug && tag == 'INPUT' && activeEl.type == 'text')) { + if (ELEMENT.isAncestor(target, activeEl)) { + start = activeEl.selectionStart; + end = activeEl.selectionEnd; + + if (Ext.isNumber(start) && Ext.isNumber(end)) { // to be safe... + // We don't create the raw closure here inline because that + // will be costly even if we don't want to return it (nested + // function decls and exprs are often instantiated on entry + // regardless of whether execution ever reaches them): + return makeSelectionRestoreFn(activeEl, start, end); + } + } + } + } + + return Ext.emptyFn; // avoid special cases, just return a nop + }, + + getViewWidth : function(full) { + return full ? ELEMENT.getDocumentWidth() : ELEMENT.getViewportWidth(); + }, + + getViewHeight : function(full) { + return full ? ELEMENT.getDocumentHeight() : ELEMENT.getViewportHeight(); + }, + + getDocumentHeight: function() { + return Math.max(!isCSS1 ? doc.body.scrollHeight : doc.documentElement.scrollHeight, ELEMENT.getViewportHeight()); + }, + + getDocumentWidth: function() { + return Math.max(!isCSS1 ? doc.body.scrollWidth : doc.documentElement.scrollWidth, ELEMENT.getViewportWidth()); + }, + + getViewportHeight: function(){ + return Ext.isIE ? + (Ext.isStrict ? doc.documentElement.clientHeight : doc.body.clientHeight) : + self.innerHeight; + }, + + getViewportWidth : function() { + return (!Ext.isStrict && !Ext.isOpera) ? doc.body.clientWidth : + Ext.isIE ? doc.documentElement.clientWidth : self.innerWidth; + }, + + getY : function(el) { + return ELEMENT.getXY(el)[1]; + }, + + getX : function(el) { + return ELEMENT.getXY(el)[0]; + }, + + getXY : function(el) { + var p, + pe, + b, + bt, + bl, + dbd, + x = 0, + y = 0, + scroll, + hasAbsolute, + bd = (doc.body || doc.documentElement), + ret = [0,0]; + + el = Ext.getDom(el); + + if(el != bd){ + hasAbsolute = fly(el).isStyle("position", "absolute"); + + if (el.getBoundingClientRect) { + b = el.getBoundingClientRect(); + scroll = fly(document).getScroll(); + ret = [Math.round(b.left + scroll.left), Math.round(b.top + scroll.top)]; + } else { + p = el; + + while (p) { + pe = fly(p); + x += p.offsetLeft; + y += p.offsetTop; + + hasAbsolute = hasAbsolute || pe.isStyle("position", "absolute"); + + if (Ext.isGecko) { + y += bt = parseInt(pe.getStyle("borderTopWidth"), 10) || 0; + x += bl = parseInt(pe.getStyle("borderLeftWidth"), 10) || 0; + + if (p != el && !pe.isStyle('overflow','visible')) { + x += bl; + y += bt; + } + } + p = p.offsetParent; + } + + if (Ext.isSafari && hasAbsolute) { + x -= bd.offsetLeft; + y -= bd.offsetTop; + } + + if (Ext.isGecko && !hasAbsolute) { + dbd = fly(bd); + x += parseInt(dbd.getStyle("borderLeftWidth"), 10) || 0; + y += parseInt(dbd.getStyle("borderTopWidth"), 10) || 0; + } + + p = el.parentNode; + while (p && p != bd) { + if (!Ext.isOpera || (p.tagName != 'TR' && !fly(p).isStyle("display", "inline"))) { + x -= p.scrollLeft; + y -= p.scrollTop; + } + p = p.parentNode; + } + ret = [x,y]; + } + } + return ret; + }, + + setXY : function(el, xy) { + (el = Ext.fly(el, '_setXY')).position(); + + var pts = el.translatePoints(xy), + style = el.dom.style, + pos; + + for (pos in pts) { + if (!isNaN(pts[pos])) { + style[pos] = pts[pos] + "px"; + } + } + }, + + setX : function(el, x) { + ELEMENT.setXY(el, [x, false]); + }, + + setY : function(el, y) { + ELEMENT.setXY(el, [false, y]); + }, + + /** + * Serializes a DOM form into a url encoded string + * @param {Object} form The form + * @return {String} The url encoded form + */ + serializeForm: function(form) { + var fElements = form.elements || (document.forms[form] || Ext.getDom(form)).elements, + hasSubmit = false, + encoder = encodeURIComponent, + name, + data = '', + type, + hasValue; + + Ext.each(fElements, function(element){ + name = element.name; + type = element.type; + + if (!element.disabled && name) { + if (/select-(one|multiple)/i.test(type)) { + Ext.each(element.options, function(opt){ + if (opt.selected) { + hasValue = opt.hasAttribute ? opt.hasAttribute('value') : opt.getAttributeNode('value').specified; + data += Ext.String.format("{0}={1}&", encoder(name), encoder(hasValue ? opt.value : opt.text)); + } + }); + } else if (!(/file|undefined|reset|button/i.test(type))) { + if (!(/radio|checkbox/i.test(type) && !element.checked) && !(type == 'submit' && hasSubmit)) { + data += encoder(name) + '=' + encoder(element.value) + '&'; + hasSubmit = /submit/i.test(type); + } + } + } + }); + return data.substr(0, data.length - 1); + } + }); +})(); + +/** + * @class Ext.core.Element + */ + +Ext.core.Element.addMethods({ + + /** + * Monitors this Element for the mouse leaving. Calls the function after the specified delay only if + * the mouse was not moved back into the Element within the delay. If the mouse was moved + * back in, the function is not called. + * @param {Number} delay The delay in milliseconds to wait for possible mouse re-entry before calling the handler function. + * @param {Function} handler The function to call if the mouse remains outside of this Element for the specified time. + * @param {Object} scope The scope (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 = /(?:]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig, + srcRe = /\ssrc=([\'\"])(.*?)\1/i, + typeRe = /\stype=([\'\"])(.*?)\1/i, + match, + attrs, + srcMatch, + typeMatch, + el, + s; + + while ((match = re.exec(html))) { + attrs = match[1]; + srcMatch = attrs ? attrs.match(srcRe) : false; + if (srcMatch && srcMatch[2]) { + s = DOC.createElement("script"); + s.src = srcMatch[2]; + typeMatch = attrs.match(typeRe); + if (typeMatch && typeMatch[2]) { + s.type = typeMatch[2]; + } + hd.appendChild(s); + } else if (match[2] && match[2].length > 0) { + if (window.execScript) { + window.execScript(match[2]); + } else { + window.eval(match[2]); + } + } + } + + el = DOC.getElementById(id); + if (el) { + Ext.removeNode(el); + } + Ext.callback(callback, me); + }, 20); + dom.innerHTML = html.replace(/(?:)((\n|\r|.)*?)(?:<\/script>)/ig, ''); + return me; + }, + + // inherit docs, overridden so we can add removeAnchor + removeAllListeners : function() { + this.removeAnchor(); + Ext.EventManager.removeAll(this.dom); + return this; + }, + + /** + * Creates a proxy element of this element + * @param {String/Object} config The class name of the proxy element or a DomHelper config object + * @param {String/HTMLElement} renderTo (optional) The element or element id to render the proxy to (defaults to document.body) + * @param {Boolean} matchBox (optional) True to align and size the proxy to this element now (defaults to false) + * @return {Ext.core.Element} The new proxy element + */ + createProxy : function(config, renderTo, matchBox) { + config = (typeof config == 'object') ? config : {tag : "div", cls: config}; + + var me = this, + proxy = renderTo ? Ext.core.DomHelper.append(renderTo, config, true) : + Ext.core.DomHelper.insertBefore(me.dom, config, true); + + proxy.setVisibilityMode(Ext.core.Element.DISPLAY); + proxy.hide(); + if (matchBox && me.setBox && me.getBox) { // check to make sure Element.position.js is loaded + proxy.setBox(me.getBox()); + } + return proxy; + } +}); +Ext.core.Element.prototype.clearListeners = Ext.core.Element.prototype.removeAllListeners; + +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods({ + /** + * Gets the x,y coordinates specified by the anchor position on the element. + * @param {String} anchor (optional) The specified anchor position (defaults to "c"). See {@link #alignTo} + * for details on supported anchor positions. + * @param {Boolean} local (optional) True to get the local (element top/left-relative) anchor position instead + * of page coordinates + * @param {Object} size (optional) An object containing the size to use for calculating anchor position + * {width: (target width), height: (target height)} (defaults to the element's current size) + * @return {Array} [x, y] An array containing the element's x and y coordinates + */ + getAnchorXY : function(anchor, local, s){ + //Passing a different size is useful for pre-calculating anchors, + //especially for anchored animations that change the el size. + anchor = (anchor || "tl").toLowerCase(); + s = s || {}; + + var me = this, + vp = me.dom == document.body || me.dom == document, + w = s.width || vp ? Ext.core.Element.getViewWidth() : me.getWidth(), + h = s.height || vp ? Ext.core.Element.getViewHeight() : me.getHeight(), + xy, + r = Math.round, + o = me.getXY(), + scroll = me.getScroll(), + extraX = vp ? scroll.left : !local ? o[0] : 0, + extraY = vp ? scroll.top : !local ? o[1] : 0, + hash = { + c : [r(w * 0.5), r(h * 0.5)], + t : [r(w * 0.5), 0], + l : [0, r(h * 0.5)], + r : [w, r(h * 0.5)], + b : [r(w * 0.5), h], + tl : [0, 0], + bl : [0, h], + br : [w, h], + tr : [w, 0] + }; + + xy = hash[anchor]; + return [xy[0] + extraX, xy[1] + extraY]; + }, + + /** + * Anchors an element to another element and realigns it when the window is resized. + * @param {Mixed} element The element to align to. + * @param {String} position The position to align to. + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @param {Boolean/Object} animate (optional) True for the default animation or a standard Element animation config object + * @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). + * @param {Function} callback The function to call after the animation finishes + * @return {Ext.core.Element} this + */ + anchorTo : function(el, alignment, offsets, animate, monitorScroll, callback){ + var me = this, + dom = me.dom, + scroll = !Ext.isEmpty(monitorScroll), + action = function(){ + Ext.fly(dom).alignTo(el, alignment, offsets, animate); + Ext.callback(callback, Ext.fly(dom)); + }, + anchor = this.getAnchor(); + + // previous listener anchor, remove it + this.removeAnchor(); + Ext.apply(anchor, { + fn: action, + scroll: scroll + }); + + Ext.EventManager.onWindowResize(action, null); + + if(scroll){ + Ext.EventManager.on(window, 'scroll', action, null, + {buffer: !isNaN(monitorScroll) ? monitorScroll : 50}); + } + action.call(me); // align immediately + return me; + }, + + /** + * Remove any anchor to this element. See {@link #anchorTo}. + * @return {Ext.core.Element} this + */ + removeAnchor : function(){ + var me = this, + anchor = this.getAnchor(); + + if(anchor && anchor.fn){ + Ext.EventManager.removeResizeListener(anchor.fn); + if(anchor.scroll){ + Ext.EventManager.un(window, 'scroll', anchor.fn); + } + delete anchor.fn; + } + return me; + }, + + // private + getAnchor : function(){ + var data = Ext.core.Element.data, + dom = this.dom; + if (!dom) { + return; + } + var anchor = data(dom, '_anchor'); + + if(!anchor){ + anchor = data(dom, '_anchor', {}); + } + return anchor; + }, + + getAlignVector: function(el, spec, offset) { + var me = this, + side = {t:"top", l:"left", r:"right", b: "bottom"}, + thisRegion = me.getRegion(), + elRegion; + + el = Ext.get(el); + if(!el || !el.dom){ + Ext.Error.raise({ + sourceClass: 'Ext.core.Element', + sourceMethod: 'getAlignVector', + msg: 'Attempted to align an element that doesn\'t exist' + }); + } + + elRegion = el.getRegion(); + }, + + /** + * Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the + * supported position values. + * @param {Mixed} element The element to align to. + * @param {String} position (optional, defaults to "tl-bl?") The position to align to. + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @return {Array} [x, y] + */ + getAlignToXY : function(el, p, o){ + el = Ext.get(el); + + if(!el || !el.dom){ + Ext.Error.raise({ + sourceClass: 'Ext.core.Element', + sourceMethod: 'getAlignToXY', + msg: 'Attempted to align an element that doesn\'t exist' + }); + } + + o = o || [0,0]; + p = (!p || p == "?" ? "tl-bl?" : (!(/-/).test(p) && p !== "" ? "tl-" + p : p || "tl-bl")).toLowerCase(); + + var me = this, + d = me.dom, + a1, + a2, + x, + y, + //constrain the aligned el to viewport if necessary + w, + h, + r, + dw = Ext.core.Element.getViewWidth() -10, // 10px of margin for ie + dh = Ext.core.Element.getViewHeight()-10, // 10px of margin for ie + p1y, + p1x, + p2y, + p2x, + swapY, + swapX, + doc = document, + docElement = doc.documentElement, + docBody = doc.body, + scrollX = (docElement.scrollLeft || docBody.scrollLeft || 0)+5, + scrollY = (docElement.scrollTop || docBody.scrollTop || 0)+5, + c = false, //constrain to viewport + p1 = "", + p2 = "", + m = p.match(/^([a-z]+)-([a-z]+)(\?)?$/); + + if(!m){ + Ext.Error.raise({ + sourceClass: 'Ext.core.Element', + sourceMethod: 'getAlignToXY', + el: el, + position: p, + offset: o, + msg: 'Attemmpted to align an element with an invalid position: "' + p + '"' + }); + } + + p1 = m[1]; + p2 = m[2]; + c = !!m[3]; + + //Subtract the aligned el's internal xy from the target's offset xy + //plus custom offset to get the aligned el's new offset xy + a1 = me.getAnchorXY(p1, true); + a2 = el.getAnchorXY(p2, false); + + x = a2[0] - a1[0] + o[0]; + y = a2[1] - a1[1] + o[1]; + + if(c){ + w = me.getWidth(); + h = me.getHeight(); + r = el.getRegion(); + //If we are at a viewport boundary and the aligned el is anchored on a target border that is + //perpendicular to the vp border, allow the aligned el to slide on that border, + //otherwise swap the aligned el to the opposite border of the target. + p1y = p1.charAt(0); + p1x = p1.charAt(p1.length-1); + p2y = p2.charAt(0); + p2x = p2.charAt(p2.length-1); + swapY = ((p1y=="t" && p2y=="b") || (p1y=="b" && p2y=="t")); + swapX = ((p1x=="r" && p2x=="l") || (p1x=="l" && p2x=="r")); + + + if (x + w > dw + scrollX) { + x = swapX ? r.left-w : dw+scrollX-w; + } + if (x < scrollX) { + x = swapX ? r.right : scrollX; + } + if (y + h > dh + scrollY) { + y = swapY ? r.top-h : dh+scrollY-h; + } + if (y < scrollY){ + y = swapY ? r.bottom : scrollY; + } + } + return [x,y]; + }, + + /** + * Aligns this element with another element relative to the specified anchor points. If the other element is the + * document it aligns it to the viewport. + * The position parameter is optional, and can be specified in any one of the following formats: + *

Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").
One anchor (deprecated): The passed anchor position is used as the target element's anchor point. + * The element being aligned will position its top-left corner (tl) to that point. This method has been + * deprecated in favor of the newer two anchor syntax below.
Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the + * element's anchor point, and the second value is used as the target's anchor point.

+ * In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of + * the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to + * the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than + * that specified in order to enforce the viewport constraints. + * Following are all of the supported anchor positions: +

+Value  Description
+-----  -----------------------------
+tl     The top left corner (default)
+t      The center of the top edge
+tr     The top right corner
+l      The center of the left edge
+c      In the center of the element
+r      The center of the right edge
+bl     The bottom left corner
+b      The center of the bottom edge
+br     The bottom right corner
+

+Example Usage: +


+// align el to other-el using the default positioning ("tl-bl", non-constrained)
+el.alignTo("other-el");
+
+// align the top left corner of el with the top right corner of other-el (constrained to viewport)
+el.alignTo("other-el", "tr?");
+
+// align the bottom right corner of el with the center left edge of other-el
+el.alignTo("other-el", "br-l?");
+
+// align the center of el with the bottom left corner of other-el and
+// adjust the x position by -6 pixels (and the y position by 0)
+el.alignTo("other-el", "c-bl", [-6, 0]);
+

+ * @param {Mixed} element The element to align to. + * @param {String} position (optional, defaults to "tl-bl?") The position to align to. + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + alignTo : function(element, position, offsets, animate){ + var me = this; + return me.setXY(me.getAlignToXY(element, position, offsets), + me.anim && !!animate ? me.anim(animate) : false); + }, + + // private ==> used outside of core + adjustForConstraints : function(xy, parent) { + var vector = this.getConstrainVector(parent, xy); + if (vector) { + xy[0] += vector[0]; + xy[1] += vector[1]; + } + return xy; + }, + + /** + *

Returns the [X, Y] vector by which this element must be translated to make a best attempt + * to constrain within the passed constraint. Returns false is this element does not need to be moved.

+ *

Priority is given to constraining the top and left within the constraint.

+ *

The constraint may either be an existing element into which this element is to be constrained, or + * an {@link Ext.util.Region Region} into which this element is to be constrained.

+ * @param constrainTo {Mixed} The Element or {@link Ext.util.Region Region} into which this element is to be constrained. + * @param proposedPosition {Array} A proposed [X, Y] position to test for validity and to produce a vector for instead + * of using this Element's current position; + * @returns {Array} If this element needs to be translated, an [X, Y] + * vector by which this element must be translated. Otherwise, false. + */ + getConstrainVector: function(constrainTo, proposedPosition) { + if (!(constrainTo instanceof Ext.util.Region)) { + constrainTo = Ext.get(constrainTo).getViewRegion(); + } + var thisRegion = this.getRegion(), + vector = [0, 0], + shadowSize = this.shadow && this.shadow.offset, + overflowed = false; + + // Shift this region to occupy the proposed position + if (proposedPosition) { + thisRegion.translateBy(proposedPosition[0] - thisRegion.x, proposedPosition[1] - thisRegion.y); + } + + // Reduce the constrain region to allow for shadow + // TODO: Rewrite the Shadow class. When that's done, get the extra for each side from the Shadow. + if (shadowSize) { + constrainTo.adjust(0, -shadowSize, -shadowSize, shadowSize); + } + + // Constrain the X coordinate by however much this Element overflows + if (thisRegion.right > constrainTo.right) { + overflowed = true; + vector[0] = (constrainTo.right - thisRegion.right); // overflowed the right + } + if (thisRegion.left + vector[0] < constrainTo.left) { + overflowed = true; + vector[0] = (constrainTo.left - thisRegion.left); // overflowed the left + } + + // Constrain the Y coordinate by however much this Element overflows + if (thisRegion.bottom > constrainTo.bottom) { + overflowed = true; + vector[1] = (constrainTo.bottom - thisRegion.bottom); // overflowed the bottom + } + if (thisRegion.top + vector[1] < constrainTo.top) { + overflowed = true; + vector[1] = (constrainTo.top - thisRegion.top); // overflowed the top + } + return overflowed ? vector : false; + }, + + /** + * Calculates the x, y to center this element on the screen + * @return {Array} The x, y values [x, y] + */ + getCenterXY : function(){ + return this.getAlignToXY(document, 'c-c'); + }, + + /** + * Centers the Element in either the viewport, or another Element. + * @param {Mixed} centerIn (optional) The element in which to center the element. + */ + center : function(centerIn){ + return this.alignTo(centerIn || document, 'c-c'); + } +}); + +/** + * @class Ext.core.Element + */ +(function(){ + +var ELEMENT = Ext.core.Element, + LEFT = "left", + RIGHT = "right", + TOP = "top", + BOTTOM = "bottom", + POSITION = "position", + STATIC = "static", + RELATIVE = "relative", + AUTO = "auto", + ZINDEX = "z-index"; + +Ext.override(Ext.core.Element, { + /** + * Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @return {Number} The X position of the element + */ + getX : function(){ + return ELEMENT.getX(this.dom); + }, + + /** + * Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @return {Number} The Y position of the element + */ + getY : function(){ + return ELEMENT.getY(this.dom); + }, + + /** + * Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @return {Array} The XY position of the element + */ + getXY : function(){ + return ELEMENT.getXY(this.dom); + }, + + /** + * Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have display:none to have page coordinates. + * @param {Mixed} element The element to get the offsets from. + * @return {Array} The XY page offsets (e.g. [100, -200]) + */ + getOffsetsTo : function(el){ + var o = this.getXY(), + e = Ext.fly(el, '_internal').getXY(); + return [o[0]-e[0],o[1]-e[1]]; + }, + + /** + * Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} The X position of the element + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setX : function(x, animate){ + return this.setXY([x, this.getY()], animate); + }, + + /** + * Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} The Y position of the element + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setY : function(y, animate){ + return this.setXY([this.getX(), y], animate); + }, + + /** + * Sets the element's left position directly using CSS style (instead of {@link #setX}). + * @param {String} left The left CSS property value + * @return {Ext.core.Element} this + */ + setLeft : function(left){ + this.setStyle(LEFT, this.addUnits(left)); + return this; + }, + + /** + * Sets the element's top position directly using CSS style (instead of {@link #setY}). + * @param {String} top The top CSS property value + * @return {Ext.core.Element} this + */ + setTop : function(top){ + this.setStyle(TOP, this.addUnits(top)); + return this; + }, + + /** + * Sets the element's CSS right style. + * @param {String} right The right CSS property value + * @return {Ext.core.Element} this + */ + setRight : function(right){ + this.setStyle(RIGHT, this.addUnits(right)); + return this; + }, + + /** + * Sets the element's CSS bottom style. + * @param {String} bottom The bottom CSS property value + * @return {Ext.core.Element} this + */ + setBottom : function(bottom){ + this.setStyle(BOTTOM, this.addUnits(bottom)); + return this; + }, + + /** + * Sets the position of the element in page coordinates, regardless of how the element is positioned. + * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Array} pos Contains X & Y [x, y] values for new position (coordinates are page-based) + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setXY: function(pos, animate) { + var me = this; + if (!animate || !me.anim) { + ELEMENT.setXY(me.dom, pos); + } + else { + if (!Ext.isObject(animate)) { + animate = {}; + } + me.animate(Ext.applyIf({ to: { x: pos[0], y: pos[1] } }, animate)); + } + return me; + }, + + /** + * Sets the position of the element in page coordinates, regardless of how the element is positioned. + * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} x X value for new position (coordinates are page-based) + * @param {Number} y Y value for new position (coordinates are page-based) + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setLocation : function(x, y, animate){ + return this.setXY([x, y], animate); + }, + + /** + * Sets the position of the element in page coordinates, regardless of how the element is positioned. + * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} x X value for new position (coordinates are page-based) + * @param {Number} y Y value for new position (coordinates are page-based) + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Ext.core.Element} this + */ + moveTo : function(x, y, animate){ + return this.setXY([x, y], animate); + }, + + /** + * Gets the left X coordinate + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getLeft : function(local){ + return !local ? this.getX() : parseInt(this.getStyle(LEFT), 10) || 0; + }, + + /** + * Gets the right X coordinate of the element (element X position + element width) + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getRight : function(local){ + var me = this; + return !local ? me.getX() + me.getWidth() : (me.getLeft(true) + me.getWidth()) || 0; + }, + + /** + * Gets the top Y coordinate + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getTop : function(local) { + return !local ? this.getY() : parseInt(this.getStyle(TOP), 10) || 0; + }, + + /** + * Gets the bottom Y coordinate of the element (element Y position + element height) + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getBottom : function(local){ + var me = this; + return !local ? me.getY() + me.getHeight() : (me.getTop(true) + me.getHeight()) || 0; + }, + + /** + * Initializes positioning on this element. If a desired position is not passed, it will make the + * the element positioned relative IF it is not already positioned. + * @param {String} pos (optional) Positioning to use "relative", "absolute" or "fixed" + * @param {Number} zIndex (optional) The zIndex to apply + * @param {Number} x (optional) Set the page X position + * @param {Number} y (optional) Set the page Y position + */ + position : function(pos, zIndex, x, y) { + var me = this; + + if (!pos && me.isStyle(POSITION, STATIC)){ + me.setStyle(POSITION, RELATIVE); + } else if(pos) { + me.setStyle(POSITION, pos); + } + if (zIndex){ + me.setStyle(ZINDEX, zIndex); + } + if (x || y) { + me.setXY([x || false, y || false]); + } + }, + + /** + * Clear positioning back to the default when the document was loaded + * @param {String} value (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'. + * @return {Ext.core.Element} this + */ + clearPositioning : function(value){ + value = value || ''; + this.setStyle({ + left : value, + right : value, + top : value, + bottom : value, + "z-index" : "", + position : STATIC + }); + return this; + }, + + /** + * Gets an object with all CSS positioning properties. Useful along with setPostioning to get + * snapshot before performing an update and then restoring the element. + * @return {Object} + */ + getPositioning : function(){ + var l = this.getStyle(LEFT); + var t = this.getStyle(TOP); + return { + "position" : this.getStyle(POSITION), + "left" : l, + "right" : l ? "" : this.getStyle(RIGHT), + "top" : t, + "bottom" : t ? "" : this.getStyle(BOTTOM), + "z-index" : this.getStyle(ZINDEX) + }; + }, + + /** + * Set positioning with an object returned by getPositioning(). + * @param {Object} posCfg + * @return {Ext.core.Element} this + */ + setPositioning : function(pc){ + var me = this, + style = me.dom.style; + + me.setStyle(pc); + + if(pc.right == AUTO){ + style.right = ""; + } + if(pc.bottom == AUTO){ + style.bottom = ""; + } + + return me; + }, + + /** + * Translates the passed page coordinates into left/top css values for this element + * @param {Number/Array} x The page x or an array containing [x, y] + * @param {Number} y (optional) The page y, required if x is not an array + * @return {Object} An object with left and top properties. e.g. {left: (value), top: (value)} + */ + translatePoints: function(x, y) { + if (Ext.isArray(x)) { + y = x[1]; + x = x[0]; + } + var me = this, + relative = me.isStyle(POSITION, RELATIVE), + o = me.getXY(), + left = parseInt(me.getStyle(LEFT), 10), + top = parseInt(me.getStyle(TOP), 10); + + if (!Ext.isNumber(left)) { + left = relative ? 0 : me.dom.offsetLeft; + } + if (!Ext.isNumber(top)) { + top = relative ? 0 : me.dom.offsetTop; + } + left = (Ext.isNumber(x)) ? x - o[0] + left : undefined; + top = (Ext.isNumber(y)) ? y - o[1] + top : undefined; + return { + left: left, + top: top + }; + }, + + /** + * Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently. + * @param {Object} box The box to fill {x, y, width, height} + * @param {Boolean} adjust (optional) Whether to adjust for box-model issues automatically + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setBox: function(box, adjust, animate) { + var me = this, + w = box.width, + h = box.height; + if ((adjust && !me.autoBoxAdjust) && !me.isBorderBox()) { + w -= (me.getBorderWidth("lr") + me.getPadding("lr")); + h -= (me.getBorderWidth("tb") + me.getPadding("tb")); + } + me.setBounds(box.x, box.y, w, h, animate); + return me; + }, + + /** + * Return an object defining the area of this Element which can be passed to {@link #setBox} to + * set another Element's size/location to match this element. + * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned. + * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y. + * @return {Object} box An object in the format


+{
+    x: <Element's X position>,
+    y: <Element's Y position>,
+    width: <Element's width>,
+    height: <Element's height>,
+    bottom: <Element's lower bound>,
+    right: <Element's rightmost bound>
+}
+

+ * The returned object may also be addressed as an Array where index 0 contains the X position + * and index 1 contains the Y position. So the result may also be used for {@link #setXY} + */ + getBox: function(contentBox, local) { + var me = this, + xy, + left, + top, + getBorderWidth = me.getBorderWidth, + getPadding = me.getPadding, + l, r, t, b, w, h, bx; + if (!local) { + xy = me.getXY(); + } else { + left = parseInt(me.getStyle("left"), 10) || 0; + top = parseInt(me.getStyle("top"), 10) || 0; + xy = [left, top]; + } + w = me.getWidth(); + h = me.getHeight(); + if (!contentBox) { + bx = { + x: xy[0], + y: xy[1], + 0: xy[0], + 1: xy[1], + width: w, + height: h + }; + } else { + l = getBorderWidth.call(me, "l") + getPadding.call(me, "l"); + r = getBorderWidth.call(me, "r") + getPadding.call(me, "r"); + t = getBorderWidth.call(me, "t") + getPadding.call(me, "t"); + b = getBorderWidth.call(me, "b") + getPadding.call(me, "b"); + bx = { + x: xy[0] + l, + y: xy[1] + t, + 0: xy[0] + l, + 1: xy[1] + t, + width: w - (l + r), + height: h - (t + b) + }; + } + bx.right = bx.x + bx.width; + bx.bottom = bx.y + bx.height; + return bx; + }, + + /** + * Move this element relative to its current position. + * @param {String} direction Possible values are: "l" (or "left"), "r" (or "right"), "t" (or "top", or "up"), "b" (or "bottom", or "down"). + * @param {Number} distance How far to move the element in pixels + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + move: function(direction, distance, animate) { + var me = this, + xy = me.getXY(), + x = xy[0], + y = xy[1], + left = [x - distance, y], + right = [x + distance, y], + top = [x, y - distance], + bottom = [x, y + distance], + hash = { + l: left, + left: left, + r: right, + right: right, + t: top, + top: top, + up: top, + b: bottom, + bottom: bottom, + down: bottom + }; + + direction = direction.toLowerCase(); + me.moveTo(hash[direction][0], hash[direction][1], animate); + }, + + /** + * Quick set left and top adding default units + * @param {String} left The left CSS property value + * @param {String} top The top CSS property value + * @return {Ext.core.Element} this + */ + setLeftTop: function(left, top) { + var me = this, + style = me.dom.style; + style.left = me.addUnits(left); + style.top = me.addUnits(top); + return me; + }, + + /** + * Returns the region of this element. + * The element must be part of the DOM tree to have a region (display:none or elements not appended return false). + * @return {Region} A Ext.util.Region containing "top, left, bottom, right" member data. + */ + getRegion: function() { + return this.getPageBox(true); + }, + + /** + * Returns the content region of this element. That is the region within the borders and padding. + * @return {Region} A Ext.util.Region containing "top, left, bottom, right" member data. + */ + getViewRegion: function() { + var me = this, + isBody = me.dom === document.body, + scroll, pos, top, left, width, height; + + // For the body we want to do some special logic + if (isBody) { + scroll = me.getScroll(); + left = scroll.left; + top = scroll.top; + width = Ext.core.Element.getViewportWidth(); + height = Ext.core.Element.getViewportHeight(); + } + else { + pos = me.getXY(); + left = pos[0] + me.getBorderWidth('l') + me.getPadding('l'); + top = pos[1] + me.getBorderWidth('t') + me.getPadding('t'); + width = me.getWidth(true); + height = me.getHeight(true); + } + + return Ext.create('Ext.util.Region', top, left + width, top + height, left); + }, + + /** + * Return an object defining the area of this Element which can be passed to {@link #setBox} to + * set another Element's size/location to match this element. + * @param {Boolean} asRegion(optional) If true an Ext.util.Region will be returned + * @return {Object} box An object in the format


+{
+    x: <Element's X position>,
+    y: <Element's Y position>,
+    width: <Element's width>,
+    height: <Element's height>,
+    bottom: <Element's lower bound>,
+    right: <Element's rightmost bound>
+}
+

+ * The returned object may also be addressed as an Array where index 0 contains the X position + * and index 1 contains the Y position. So the result may also be used for {@link #setXY} + */ + getPageBox : function(getRegion) { + var me = this, + el = me.dom, + isDoc = el === document.body, + w = isDoc ? Ext.core.Element.getViewWidth() : el.offsetWidth, + h = isDoc ? Ext.core.Element.getViewHeight() : el.offsetHeight, + xy = me.getXY(), + t = xy[1], + r = xy[0] + w, + b = xy[1] + h, + l = xy[0]; + + if (getRegion) { + return Ext.create('Ext.util.Region', t, r, b, l); + } + else { + return { + left: l, + top: t, + width: w, + height: h, + right: r, + bottom: b + }; + } + }, + + /** + * Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently. + * @param {Number} x X value for new position (coordinates are page-based) + * @param {Number} y Y value for new position (coordinates are page-based) + * @param {Mixed} width The new width. This may be one of:

A Number specifying the new width in this Element's {@link #defaultUnit}s (by default, pixels)
A String used to set the CSS width style. Animation may not be used. + *

+ * @param {Mixed} height The new height. This may be one of:

A Number specifying the new height in this Element's {@link #defaultUnit}s (by default, pixels)
A String used to set the CSS height style. Animation may not be used.

+ * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setBounds: function(x, y, width, height, animate) { + var me = this; + if (!animate || !me.anim) { + me.setSize(width, height); + me.setLocation(x, y); + } else { + if (!Ext.isObject(animate)) { + animate = {}; + } + me.animate(Ext.applyIf({ + to: { + x: x, + y: y, + width: me.adjustWidth(width), + height: me.adjustHeight(height) + } + }, animate)); + } + return me; + }, + + /** + * Sets the element's position and size the specified region. If animation is true then width, height, x and y will be animated concurrently. + * @param {Ext.util.Region} region The region to fill + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Ext.core.Element} this + */ + setRegion: function(region, animate) { + return this.setBounds(region.left, region.top, region.right - region.left, region.bottom - region.top, animate); + } +}); +})(); + +/** + * @class Ext.core.Element + */ +Ext.override(Ext.core.Element, { + /** + * Returns true if this element is scrollable. + * @return {Boolean} + */ + isScrollable : function(){ + var dom = this.dom; + return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth; + }, + + /** + * Returns the current scroll position of the element. + * @return {Object} An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)} + */ + getScroll : function() { + var d = this.dom, + doc = document, + body = doc.body, + docElement = doc.documentElement, + l, + t, + ret; + + if (d == doc || d == body) { + if (Ext.isIE && Ext.isStrict) { + l = docElement.scrollLeft; + t = docElement.scrollTop; + } else { + l = window.pageXOffset; + t = window.pageYOffset; + } + ret = { + left: l || (body ? body.scrollLeft : 0), + top : t || (body ? body.scrollTop : 0) + }; + } else { + ret = { + left: d.scrollLeft, + top : d.scrollTop + }; + } + + return ret; + }, + + /** + * Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll(). + * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values. + * @param {Number} value The new scroll value + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Element} this + */ + scrollTo : function(side, value, animate) { + //check if we're scrolling top or left + var top = /top/i.test(side), + me = this, + dom = me.dom, + obj = {}, + prop; + if (!animate || !me.anim) { + // just setting the value, so grab the direction + prop = 'scroll' + (top ? 'Top' : 'Left'); + dom[prop] = value; + } + else { + if (!Ext.isObject(animate)) { + animate = {}; + } + obj['scroll' + (top ? 'Top' : 'Left')] = value; + me.animate(Ext.applyIf({ + to: obj + }, animate)); + } + return me; + }, + + /** + * Scrolls this element into view within the passed container. + * @param {Mixed} container (optional) The container element to scroll (defaults to document.body). Should be a + * string (id), dom node, or Ext.core.Element. + * @param {Boolean} hscroll (optional) False to disable horizontal scroll (defaults to true) + * @return {Ext.core.Element} this + */ + scrollIntoView : function(container, hscroll) { + container = Ext.getDom(container) || Ext.getBody().dom; + var el = this.dom, + offsets = this.getOffsetsTo(container), + // el's box + left = offsets[0] + container.scrollLeft, + top = offsets[1] + container.scrollTop, + bottom = top + el.offsetHeight, + right = left + el.offsetWidth, + // ct's box + ctClientHeight = container.clientHeight, + ctScrollTop = parseInt(container.scrollTop, 10), + ctScrollLeft = parseInt(container.scrollLeft, 10), + ctBottom = ctScrollTop + ctClientHeight, + ctRight = ctScrollLeft + container.clientWidth; + + if (el.offsetHeight > ctClientHeight || top < ctScrollTop) { + container.scrollTop = top; + } else if (bottom > ctBottom) { + container.scrollTop = bottom - ctClientHeight; + } + // corrects IE, other browsers will ignore + container.scrollTop = container.scrollTop; + + if (hscroll !== false) { + if (el.offsetWidth > container.clientWidth || left < ctScrollLeft) { + container.scrollLeft = left; + } + else if (right > ctRight) { + container.scrollLeft = right - container.clientWidth; + } + container.scrollLeft = container.scrollLeft; + } + return this; + }, + + // private + scrollChildIntoView : function(child, hscroll) { + Ext.fly(child, '_scrollChildIntoView').scrollIntoView(this, hscroll); + }, + + /** + * Scrolls this element the specified direction. Does bounds checking to make sure the scroll is + * within this element's scrollable range. + * @param {String} direction Possible values are: "l" (or "left"), "r" (or "right"), "t" (or "top", or "up"), "b" (or "bottom", or "down"). + * @param {Number} distance How far to scroll the element in pixels + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Boolean} Returns true if a scroll was triggered or false if the element + * was scrolled as far as it could go. + */ + scroll : function(direction, distance, animate) { + if (!this.isScrollable()) { + return false; + } + var el = this.dom, + l = el.scrollLeft, t = el.scrollTop, + w = el.scrollWidth, h = el.scrollHeight, + cw = el.clientWidth, ch = el.clientHeight, + scrolled = false, v, + hash = { + l: Math.min(l + distance, w-cw), + r: v = Math.max(l - distance, 0), + t: Math.max(t - distance, 0), + b: Math.min(t + distance, h-ch) + }; + hash.d = hash.b; + hash.u = hash.t; + + direction = direction.substr(0, 1); + if ((v = hash[direction]) > -1) { + scrolled = true; + this.scrollTo(direction == 'l' || direction == 'r' ? 'left' : 'top', v, this.anim(animate)); + } + return scrolled; + } +}); +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods( + function() { + var VISIBILITY = "visibility", + DISPLAY = "display", + HIDDEN = "hidden", + NONE = "none", + XMASKED = Ext.baseCSSPrefix + "masked", + XMASKEDRELATIVE = Ext.baseCSSPrefix + "masked-relative", + data = Ext.core.Element.data; + + return { + /** + * Checks whether the element is currently visible using both visibility and display properties. + * @param {Boolean} deep (optional) True to walk the dom and see if parent elements are hidden (defaults to false) + * @return {Boolean} True if the element is currently visible, else false + */ + isVisible : function(deep) { + var vis = !this.isStyle(VISIBILITY, HIDDEN) && !this.isStyle(DISPLAY, NONE), + p = this.dom.parentNode; + + if (deep !== true || !vis) { + return vis; + } + + while (p && !(/^body/i.test(p.tagName))) { + if (!Ext.fly(p, '_isVisible').isVisible()) { + return false; + } + p = p.parentNode; + } + return true; + }, + + /** + * Returns true if display is not "none" + * @return {Boolean} + */ + isDisplayed : function() { + return !this.isStyle(DISPLAY, NONE); + }, + + /** + * Convenience method for setVisibilityMode(Element.DISPLAY) + * @param {String} display (optional) What to set display to when visible + * @return {Ext.core.Element} this + */ + enableDisplayMode : function(display) { + this.setVisibilityMode(Ext.core.Element.DISPLAY); + + if (!Ext.isEmpty(display)) { + data(this.dom, 'originalDisplay', display); + } + + return this; + }, + + /** + * Puts a mask over this element to disable user interaction. Requires core.css. + * This method can only be applied to elements which accept child nodes. + * @param {String} msg (optional) A message to display in the mask + * @param {String} msgCls (optional) A css class to apply to the msg element + * @return {Element} The mask element + */ + mask : function(msg, msgCls) { + var me = this, + dom = me.dom, + setExpression = dom.style.setExpression, + dh = Ext.core.DomHelper, + EXTELMASKMSG = Ext.baseCSSPrefix + "mask-msg", + el, + mask; + + if (!(/^body/i.test(dom.tagName) && me.getStyle('position') == 'static')) { + me.addCls(XMASKEDRELATIVE); + } + el = data(dom, 'maskMsg'); + if (el) { + el.remove(); + } + el = data(dom, 'mask'); + if (el) { + el.remove(); + } + + mask = dh.append(dom, {cls : Ext.baseCSSPrefix + "mask"}, true); + data(dom, 'mask', mask); + + me.addCls(XMASKED); + mask.setDisplayed(true); + + if (typeof msg == 'string') { + var mm = dh.append(dom, {cls : EXTELMASKMSG, cn:{tag:'div'}}, true); + data(dom, 'maskMsg', mm); + mm.dom.className = msgCls ? EXTELMASKMSG + " " + msgCls : EXTELMASKMSG; + mm.dom.firstChild.innerHTML = msg; + mm.setDisplayed(true); + mm.center(me); + } + // NOTE: CSS expressions are resource intensive and to be used only as a last resort + // These expressions are removed as soon as they are no longer necessary - in the unmask method. + // In normal use cases an element will be masked for a limited period of time. + // Fix for https://sencha.jira.com/browse/EXTJSIV-19. + // IE6 strict mode and IE6-9 quirks mode takes off left+right padding when calculating width! + if (!Ext.supports.IncludePaddingInWidthCalculation && setExpression) { + mask.dom.style.setExpression('width', 'this.parentNode.offsetWidth + "px"'); + } + + // Some versions and modes of IE subtract top+bottom padding when calculating height. + // Different versions from those which make the same error for width! + if (!Ext.supports.IncludePaddingInHeightCalculation && setExpression) { + mask.dom.style.setExpression('height', 'this.parentNode.offsetHeight + "px"'); + } + // ie will not expand full height automatically + else if (Ext.isIE && !(Ext.isIE7 && Ext.isStrict) && me.getStyle('height') == 'auto') { + mask.setSize(undefined, me.getHeight()); + } + return mask; + }, + + /** + * Removes a previously applied mask. + */ + unmask : function() { + var me = this, + dom = me.dom, + mask = data(dom, 'mask'), + maskMsg = data(dom, 'maskMsg'); + + if (mask) { + // Remove resource-intensive CSS expressions as soon as they are not required. + if (mask.dom.style.clearExpression) { + mask.dom.style.clearExpression('width'); + mask.dom.style.clearExpression('height'); + } + if (maskMsg) { + maskMsg.remove(); + data(dom, 'maskMsg', undefined); + } + + mask.remove(); + data(dom, 'mask', undefined); + me.removeCls([XMASKED, XMASKEDRELATIVE]); + } + }, + /** + * Returns true if this element is masked. Also re-centers any displayed message within the mask. + * @return {Boolean} + */ + isMasked : function() { + var me = this, + mask = data(me.dom, 'mask'), + maskMsg = data(me.dom, 'maskMsg'); + + if (mask && mask.isVisible()) { + if (maskMsg) { + maskMsg.center(me); + } + return true; + } + return false; + }, + + /** + * Creates an iframe shim for this element to keep selects and other windowed objects from + * showing through. + * @return {Ext.core.Element} The new shim element + */ + createShim : function() { + var el = document.createElement('iframe'), + shim; + + el.frameBorder = '0'; + el.className = Ext.baseCSSPrefix + 'shim'; + el.src = Ext.SSL_SECURE_URL; + shim = Ext.get(this.dom.parentNode.insertBefore(el, this.dom)); + shim.autoBoxAdjust = false; + return shim; + } + }; + }() +); +/** + * @class Ext.core.Element + */ +Ext.core.Element.addMethods({ + /** + * Convenience method for constructing a KeyMap + * @param {Number/Array/Object/String} key Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: + * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope (this reference) in which the specified function is executed. Defaults to this Element. + * @return {Ext.util.KeyMap} The KeyMap created + */ + addKeyListener : function(key, fn, scope){ + var config; + if(typeof key != 'object' || Ext.isArray(key)){ + config = { + key: key, + fn: fn, + scope: scope + }; + }else{ + config = { + key : key.key, + shift : key.shift, + ctrl : key.ctrl, + alt : key.alt, + fn: fn, + scope: scope + }; + } + return Ext.create('Ext.util.KeyMap', this, config); + }, + + /** + * Creates a KeyMap for this element + * @param {Object} config The KeyMap config. See {@link Ext.util.KeyMap} for more details + * @return {Ext.util.KeyMap} The KeyMap created + */ + addKeyMap : function(config){ + return Ext.create('Ext.util.KeyMap', this, config); + } +}); + +//Import the newly-added Ext.core.Element functions into CompositeElementLite. We call this here because +//Element.keys.js is the last extra Ext.core.Element include in the ext-all.js build +Ext.CompositeElementLite.importElementMethods(); + +/** + * @class Ext.CompositeElementLite + */ +Ext.apply(Ext.CompositeElementLite.prototype, { + addElements : function(els, root){ + if(!els){ + return this; + } + if(typeof els == "string"){ + els = Ext.core.Element.selectorFunction(els, root); + } + var yels = this.elements; + Ext.each(els, function(e) { + yels.push(Ext.get(e)); + }); + return this; + }, + + /** + * Returns the first Element + * @return {Ext.core.Element} + */ + first : function(){ + return this.item(0); + }, + + /** + * Returns the last Element + * @return {Ext.core.Element} + */ + last : function(){ + return this.item(this.getCount()-1); + }, + + /** + * Returns true if this composite contains the passed element + * @param el {Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection. + * @return Boolean + */ + contains : function(el){ + return this.indexOf(el) != -1; + }, + + /** + * Removes the specified element(s). + * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite + * or an array of any of those. + * @param {Boolean} removeDom (optional) True to also remove the element from the document + * @return {CompositeElement} this + */ + removeElement : function(keys, removeDom){ + var me = this, + els = this.elements, + el; + Ext.each(keys, function(val){ + if ((el = (els[val] || els[val = me.indexOf(val)]))) { + if(removeDom){ + if(el.dom){ + el.remove(); + }else{ + Ext.removeNode(el); + } + } + els.splice(val, 1); + } + }); + return this; + } +}); + +/** + * @class Ext.CompositeElement + * @extends Ext.CompositeElementLite + *

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

+ *

All methods return this and can be chained.

+ * Usage: +


+var els = Ext.select("#some-el div.some-class", true);
+// or select directly from an existing element
+var el = Ext.get('some-el');
+el.select('div.some-class', true);
+
+els.setWidth(100); // all elements become 100 width
+els.hide(true); // all elements fade out and hide
+// or
+els.setWidth(100).hide(true);
+

+ */ +Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, { + + constructor : function(els, root){ + this.elements = []; + this.add(els, root); + }, + + // private + getElement : function(el){ + // In this case just return it, since we already have a reference to it + return el; + }, + + // private + transformElement : function(el){ + return Ext.get(el); + } + + /** + * Adds elements to this composite. + * @param {String/Array} els A string CSS selector, an array of elements or an element + * @return {CompositeElement} this + */ + + /** + * Returns the Element object at the specified index + * @param {Number} index + * @return {Ext.core.Element} + */ + + /** + * Iterates each `element` in this `composite` calling the supplied function using {@link Ext#each Ext.each}. + * @param {Function} fn + +The function to be called with each +`element`. If the supplied function returns false, +iteration stops. This function is called with the following arguments: + +- `element` : __Ext.core.Element++ + The element at the current `index` in the `composite` + +- `composite` : __Object__ + This composite. + +- `index` : __Number__ + The current index within the `composite` + + * @param {Object} scope (optional) The scope (this reference) in which the specified function is executed. + * Defaults to the element at the current index + * within the composite. + * @return {CompositeElement} this + * @markdown + */ +}); + +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods + * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or + * {@link Ext.CompositeElementLite CompositeElementLite} object. + * @param {String/Array} selector The CSS selector or an array of elements + * @param {Boolean} unique (optional) true to create a unique Ext.core.Element for each element (defaults to a shared flyweight object) + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Ext.core.Element + * @method select + */ +Ext.core.Element.select = function(selector, unique, root){ + var els; + if(typeof selector == "string"){ + els = Ext.core.Element.selectorFunction(selector, root); + }else if(selector.length !== undefined){ + els = selector; + }else{ + Ext.Error.raise({ + sourceClass: "Ext.core.Element", + sourceMethod: "select", + selector: selector, + unique: unique, + root: root, + msg: "Invalid selector specified: " + selector + }); + } + return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els); +}; + +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods + * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or + * {@link Ext.CompositeElementLite CompositeElementLite} object. + * @param {String/Array} selector The CSS selector or an array of elements + * @param {Boolean} unique (optional) true to create a unique Ext.core.Element for each element (defaults to a shared flyweight object) + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Ext + * @method select + */ +Ext.select = Ext.core.Element.select; + + +/* +Ext JS - JavaScript Library +Copyright (c) 2006-2011, Sencha Inc. +All rights reserved. +licensing@sencha.com +*/ +/** + * @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.
+ * For example: + *


+Ext.define('Employee', {
+    extend: 'Ext.util.Observable',
+    constructor: function(config){
+        this.name = config.name;
+        this.addEvents({
+            "fired" : true,
+            "quit" : true
+        });
+
+        // Copy configured listeners into *this* object so that the base class's
+        // constructor will add them.
+        this.listeners = config.listeners;
+
+        // 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!");
+        }
+    }
+});
+

+ */ + +Ext.define('Ext.util.Observable', { + + /* Begin Definitions */ + + requires: ['Ext.util.Event'], + + statics: { + /** + * Removes all added captures from the Observable. + * @param {Observable} o The Observable to release + * @static + */ + releaseCapture: function(o) { + o.fireEvent = this.prototype.fireEvent; + }, + + /** + * 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 + */ + capture: function(o, fn, scope) { + o.fireEvent = Ext.Function.createInterceptor(o.fireEvent, fn, scope); + }, + + /** +Sets observability on the passed class constructor. + +This makes any event fired on any instance of the passed class also fire a single event through +the __class__ allowing for central handling of events on many instances at once. + +Usage: + + Ext.util.Observable.observe(Ext.data.Connection); + Ext.data.Connection.on('beforerequest', function(con, options) { + console.log('Ajax request made to ' + options.url); + }); + + * @param {Function} c The class constructor to make observable. + * @param {Object} listeners An object containing a series of listeners to add. See {@link #addListener}. + * @static + * @markdown + */ + observe: function(cls, listeners) { + if (cls) { + if (!cls.isObservable) { + Ext.applyIf(cls, new this()); + this.capture(cls.prototype, cls.fireEvent, cls); + } + if (Ext.isObject(listeners)) { + cls.on(listeners); + } + return cls; + } + } + }, + + /* End Definitions */ + + /** + * @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.view.View DataView}'s + * {@link Ext.view.View#click click} event passing the node clicked on. To access DOM + * events directly from a child element of a Component, we need to specify the element option to + * identify the Component property to add a DOM listener to: + *


+new Ext.panel.Panel({
+    width: 400,
+    height: 200,
+    dockedItems: [{
+        xtype: 'toolbar'
+    }],
+    listeners: {
+        click: {
+            element: 'el', //bind to the underlying el property on the panel
+            fn: function(){ console.log('click el'); }
+        },
+        dblclick: {
+            element: 'body', //bind to the underlying body property on the panel
+            fn: function(){ console.log('dblclick body'); }
+        }
+    }
+});
+

+ *

+ */ + // @private + isObservable: true, + + constructor: function(config) { + var me = this; + + Ext.apply(me, config); + if (me.listeners) { + me.on(me.listeners); + delete me.listeners; + } + me.events = me.events || {}; + + if (me.bubbleEvents) { + me.enableBubble(me.bubbleEvents); + } + }, + + // @private + eventOptionsRe : /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal)$/, + + /** + *

Adds listeners to any Observable object (or Element) which are automatically removed when this Component + * is destroyed. + * @param {Observable/Element} item The item to which to add a listener/listeners. + * @param {Object/String} ename The event name, or an object containing event name properties. + * @param {Function} fn Optional. If the ename parameter was an event name, this + * is the handler function. + * @param {Object} scope Optional. If the ename parameter was an event name, this + * is the scope (this reference) in which the handler function is executed. + * @param {Object} opt Optional. If the ename parameter was an event name, this + * is the {@link Ext.util.Observable#addListener addListener} options. + */ + addManagedListener : function(item, ename, fn, scope, options) { + var me = this, + managedListeners = me.managedListeners = me.managedListeners || [], + config; + + if (Ext.isObject(ename)) { + options = ename; + for (ename in options) { + if (options.hasOwnProperty(ename)) { + config = options[ename]; + if (!me.eventOptionsRe.test(ename)) { + me.addManagedListener(item, ename, config.fn || config, config.scope || options.scope, config.fn ? config : options); + } + } + } + } + else { + managedListeners.push({ + item: item, + ename: ename, + fn: fn, + scope: scope, + options: options + }); + + item.on(ename, fn, scope, options); + } + }, + + /** + * Removes listeners that were added by the {@link #mon} method. + * @param {Observable|Element} item The item from which to remove a listener/listeners. + * @param {Object|String} ename The event name, or an object containing event name properties. + * @param {Function} fn Optional. If the ename parameter was an event name, this + * is the handler function. + * @param {Object} scope Optional. If the ename parameter was an event name, this + * is the scope (this reference) in which the handler function is executed. + */ + removeManagedListener : function(item, ename, fn, scope) { + var me = this, + options, + config, + managedListeners, + length, + i; + + if (Ext.isObject(ename)) { + options = ename; + for (ename in options) { + if (options.hasOwnProperty(ename)) { + config = options[ename]; + if (!me.eventOptionsRe.test(ename)) { + me.removeManagedListener(item, ename, config.fn || config, config.scope || options.scope); + } + } + } + } + + managedListeners = me.managedListeners ? me.managedListeners.slice() : []; + + for (i = 0, length = managedListeners.length; i < length; i++) { + me.removeManagedListenerItem(false, managedListeners[i], item, ename, fn, scope); + } + }, + + /** + *

Fires the specified event with the passed parameters (minus the event name).

+ *

An event may be set to bubble up an Observable parent hierarchy (See {@link Ext.Component#getBubbleTarget}) + * by calling {@link #enableBubble}.

+ * @param {String} eventName The name of the event to fire. + * @param {Object...} args Variable number of parameters are passed to handlers. + * @return {Boolean} returns false if any of the handlers return false otherwise it returns true. + */ + fireEvent: function() { + var me = this, + args = Ext.Array.toArray(arguments), + ename = args[0].toLowerCase(), + ret = true, + event = me.events[ename], + queue = me.eventQueue, + parent; + + if (me.eventsSuspended === true) { + if (queue) { + queue.push(args); + } + } else if (event && Ext.isObject(event) && event.bubble) { + if (event.fire.apply(event, args.slice(1)) === false) { + return false; + } + parent = me.getBubbleTarget && me.getBubbleTarget(); + if (parent && parent.isObservable) { + if (!parent.events[ename] || !Ext.isObject(parent.events[ename]) || !parent.events[ename].bubble) { + parent.enableBubble(ename); + } + return parent.fireEvent.apply(parent, args); + } + } else if (event && Ext.isObject(event)) { + args.shift(); + ret = event.fire.apply(event, args); + } + return ret; + }, + + /** + * Appends an event handler to this object. + * @param {String} eventName The name of the event to listen for. May also be an object who's property names are event names. See + * @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:

scope : Object
The scope (this reference) in which the handler function is executed. + * If omitted, defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an {@link Ext.util.DelayedTask} delayed + * by the specified number of milliseconds. If the event fires again within that time, the original + * handler is not invoked, but the new handler is scheduled in its place.
target : Observable
Only call the handler if the event was fired on the target Observable, not + * if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to {@link Ext.Component Components}. + * The name of a Component property which references an element to add a listener to. + *
This option is useful during Component construction to add DOM event listeners to elements of {@link Ext.Component Components} which + * will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
```
+new Ext.panel.Panel({
+    title: 'The title',
+    listeners: {
+        click: this.handlePanelClick,
+        element: 'body'
+    }
+});
+
```
+ *
When added in this way, the options available are the options applicable to {@link Ext.core.Element#addListener}

+ *

+ * Combining Options
+ * Using the options argument, it is possible to combine different types of listeners:
+ *
+ * A delayed, one-time listener. + *


+myPanel.on('hide', this.handleClick, this, {
+single: true,
+delay: 100
+});

+ *

+ * 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 events. For example:


+myGridPanel.on({
+    cellClick: this.onCellClick,
+    mouseover: this.onMouseOver,
+    mouseout: this.onMouseOut,
+    scope: this // Important. Ensure "this" is correct during handler execution
+});
+

. + *

+ */ + addListener: function(ename, fn, scope, options) { + var me = this, + config, + event; + + if (Ext.isObject(ename)) { + options = ename; + for (ename in options) { + if (options.hasOwnProperty(ename)) { + config = options[ename]; + if (!me.eventOptionsRe.test(ename)) { + me.addListener(ename, config.fn || config, config.scope || options.scope, config.fn ? config : options); + } + } + } + } + else { + ename = ename.toLowerCase(); + me.events[ename] = me.events[ename] || true; + event = me.events[ename] || true; + if (Ext.isBoolean(event)) { + me.events[ename] = event = new Ext.util.Event(me, ename); + } + event.addListener(fn, scope, Ext.isObject(options) ? options : {}); + } + }, + + /** + * 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. + */ + removeListener: function(ename, fn, scope) { + var me = this, + config, + event, + options; + + if (Ext.isObject(ename)) { + options = ename; + for (ename in options) { + if (options.hasOwnProperty(ename)) { + config = options[ename]; + if (!me.eventOptionsRe.test(ename)) { + me.removeListener(ename, config.fn || config, config.scope || options.scope); + } + } + } + } else { + ename = ename.toLowerCase(); + event = me.events[ename]; + if (event && event.isEvent) { + event.removeListener(fn, scope); + } + } + }, + + /** + * Removes all listeners for this object including the managed listeners + */ + clearListeners: function() { + var events = this.events, + event, + key; + + for (key in events) { + if (events.hasOwnProperty(key)) { + event = events[key]; + if (event.isEvent) { + event.clearListeners(); + } + } + } + + this.clearManagedListeners(); + }, + + purgeListeners : function() { + if (Ext.global.console) { + Ext.global.console.warn('Observable: purgeListeners has been deprecated. Please use clearListeners.'); + } + return this.clearListeners.apply(this, arguments); + }, + + /** + * Removes all managed listeners for this object. + */ + clearManagedListeners : function() { + var managedListeners = this.managedListeners || [], + i = 0, + len = managedListeners.length; + + for (; i < len; i++) { + this.removeManagedListenerItem(true, managedListeners[i]); + } + + this.managedListeners = []; + }, + + /** + * Remove a single managed listener item + * @private + * @param {Boolean} isClear True if this is being called during a clear + * @param {Object} managedListener The managed listener item + * See removeManagedListener for other args + */ + removeManagedListenerItem: function(isClear, managedListener, item, ename, fn, scope){ + if (isClear || (managedListener.item === item && managedListener.ename === ename && (!fn || managedListener.fn === fn) && (!scope || managedListener.scope === scope))) { + managedListener.item.un(managedListener.ename, managedListener.fn, managedListener.scope); + if (!isClear) { + Ext.Array.remove(this.managedListeners, managedListener); + } + } + }, + + purgeManagedListeners : function() { + if (Ext.global.console) { + Ext.global.console.warn('Observable: purgeManagedListeners has been deprecated. Please use clearManagedListeners.'); + } + return this.clearManagedListeners.apply(this, arguments); + }, + + /** + * Adds the specified events to the list of events which this Observable may fire. + * @param {Object/String} 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} [additional] Optional additional event names if multiple event names are being passed as separate parameters. + * Usage:


+this.addEvents('storeloaded', 'storecleared');
+

+ */ + addEvents: function(o) { + var me = this, + args, + len, + i; + + me.events = me.events || {}; + if (Ext.isString(o)) { + args = arguments; + i = args.length; + + while (i--) { + me.events[args[i]] = me.events[args[i]] || true; + } + } else { + Ext.applyIf(me.events, o); + } + }, + + /** + * Checks to see if this object has any listeners for a specified event + * @param {String} eventName The name of the event to check for + * @return {Boolean} True if the event is being listened for, else false + */ + hasListener: function(ename) { + var event = this.events[ename.toLowerCase()]; + return event && event.isEvent === true && event.listeners.length > 0; + }, + + /** + * 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; + */ + suspendEvents: function(queueSuspended) { + this.eventsSuspended = true; + if (queueSuspended && !this.eventQueue) { + this.eventQueue = []; + } + }, + + /** + * 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. + */ + resumeEvents: function() { + var me = this, + queued = me.eventQueue || []; + + me.eventsSuspended = false; + delete me.eventQueue; + + Ext.each(queued, + function(e) { + me.fireEvent.apply(me, e); + }); + }, + + /** + * Relays selected events from the specified Observable as if the events were fired by this. + * @param {Object} origin The Observable whose events this object is to relay. + * @param {Array} events Array of event names to relay. + */ + relayEvents : function(origin, events, prefix) { + prefix = prefix || ''; + var me = this, + len = events.length, + i = 0, + oldName, + newName; + + for (; i < len; i++) { + oldName = events[i].substr(prefix.length); + newName = prefix + oldName; + me.events[newName] = me.events[newName] || true; + origin.on(oldName, me.createRelayer(newName)); + } + }, + + /** + * @private + * Creates an event handling function which refires the event from this object as the passed event name. + * @param newName + * @returns {Function} + */ + createRelayer: function(newName){ + var me = this; + return function(){ + return me.fireEvent.apply(me, [newName].concat(Array.prototype.slice.call(arguments, 0, -1))); + }; + }, + + /** + *

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.Base, {
+//  Add functionality to Field's initComponent to enable the change event to bubble
+initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
+    this.enableBubble('change');
+}),
+
+//  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;
+}
+});
+
+var myForm = new Ext.formPanel({
+title: 'User Details',
+items: [{
+    ...
+}],
+listeners: {
+    change: function() {
+        // Title goes red if form has been modified.
+        myForm.header.setStyle('color', 'red');
+    }
+}
+});
+

+ * @param {String/Array} events The event name to bubble, or an Array of event names. + */ + enableBubble: function(events) { + var me = this; + if (!Ext.isEmpty(events)) { + events = Ext.isArray(events) ? events: Ext.Array.toArray(arguments); + Ext.each(events, + function(ename) { + ename = ename.toLowerCase(); + var ce = me.events[ename] || true; + if (Ext.isBoolean(ce)) { + ce = new Ext.util.Event(me, ename); + me.events[ename] = ce; + } + ce.bubble = true; + }); + } + } +}, function() { + /** + * 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 un + */ + + /** + * 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 on + */ + + this.createAlias({ + on: 'addListener', + un: 'removeListener', + mon: 'addManagedListener', + mun: 'removeManagedListener' + }); + + //deprecated, will be removed in 5.0 + this.observeClass = this.observe; + + 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; + } + } + }; + + this[method] = function(){ + var args = Array.prototype.slice.call(arguments, 0), + b, i, len; + returnValue = v = undefined; + cancel = false; + + for(i = 0, len = e.before.length; i < len; i++){ + b = e.before[i]; + makeCall(b.fn, b.scope, args); + if (cancel) { + return returnValue; + } + } + + if((v = e.originalFn.apply(obj, args)) !== undefined){ + returnValue = v; + } + + for(i = 0, len = e.after.length; i < len; i++){ + b = e.after[i]; + makeCall(b.fn, b.scope, args); + if (cancel) { + return returnValue; + } + } + return returnValue; + }; + } + return e; + } + + 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 + }); + }, + + // adds a 'sequence' called after the original method + afterMethod : function(method, fn, scope){ + getMethodEvent.call(this, method).after.push({ + fn: fn, + scope: scope + }); + }, + + removeMethodListener: function(method, fn, scope){ + var e = this.getMethodEvent(method), + i, len; + for(i = 0, len = e.before.length; i < len; i++){ + if(e.before[i].fn == fn && e.before[i].scope == scope){ + e.before.splice(i, 1); + return; + } + } + for(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; + } + } + }, + + toggleEventLogging: function(toggle) { + Ext.util.Observable[toggle ? 'capture' : 'releaseCapture'](this, function(en) { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.log(en, arguments); + } + }); + } + }; + }()); +}); + +/** + * @class Ext.util.Animate + * This animation class is a mixin. + * + * Ext.util.Animate provides an API for the creation of animated transitions of properties and styles. + * This class is used as a mixin and currently applied to {@link Ext.core.Element}, {@link Ext.CompositeElement}, + * {@link Ext.draw.Sprite}, {@link Ext.draw.CompositeSprite}, and {@link Ext.Component}. Note that Components + * have a limited subset of what attributes can be animated such as top, left, x, y, height, width, and + * opacity (color, paddings, and margins can not be animated). + * + * ## Animation Basics + * + * All animations require three things - `easing`, `duration`, and `to` (the final end value for each property) + * you wish to animate. Easing and duration are defaulted values specified below. + * Easing describes how the intermediate values used during a transition will be calculated. + * {@link Ext.fx.Anim#easing Easing} allows for a transition to change speed over its duration. + * You may use the defaults for easing and duration, but you must always set a + * {@link Ext.fx.Anim#to to} property which is the end value for all animations. + * + * Popular element 'to' configurations are: + * + * - opacity + * - x + * - y + * - color + * - height + * - width + * + * Popular sprite 'to' configurations are: + * + * - translation + * - path + * - scale + * - stroke + * - rotation + * + * The default duration for animations is 250 (which is a 1/4 of a second). Duration is denoted in + * milliseconds. Therefore 1 second is 1000, 1 minute would be 60000, and so on. The default easing curve + * used for all animations is 'ease'. Popular easing functions are included and can be found in {@link Ext.fx.Anim#easing Easing}. + * + * For example, a simple animation to fade out an element with a default easing and duration: + * + * var p1 = Ext.get('myElementId'); + * + * p1.animate({ + * to: { + * opacity: 0 + * } + * }); + * + * To make this animation fade out in a tenth of a second: + * + * var p1 = Ext.get('myElementId'); + * + * p1.animate({ + * duration: 100, + * to: { + * opacity: 0 + * } + * }); + * + * ## Animation Queues + * + * By default all animations are added to a queue which allows for animation via a chain-style API. + * For example, the following code will queue 4 animations which occur sequentially (one right after the other): + * + * p1.animate({ + * to: { + * x: 500 + * } + * }).animate({ + * to: { + * y: 150 + * } + * }).animate({ + * to: { + * backgroundColor: '#f00' //red + * } + * }).animate({ + * to: { + * opacity: 0 + * } + * }); + * + * You can change this behavior by calling the {@link Ext.util.Animate#syncFx syncFx} method and all + * subsequent animations for the specified target will be run concurrently (at the same time). + * + * p1.syncFx(); //this will make all animations run at the same time + * + * p1.animate({ + * to: { + * x: 500 + * } + * }).animate({ + * to: { + * y: 150 + * } + * }).animate({ + * to: { + * backgroundColor: '#f00' //red + * } + * }).animate({ + * to: { + * opacity: 0 + * } + * }); + * + * This works the same as: + * + * p1.animate({ + * to: { + * x: 500, + * y: 150, + * backgroundColor: '#f00' //red + * opacity: 0 + * } + * }); + * + * The {@link Ext.util.Animate#stopAnimation stopAnimation} method can be used to stop any + * currently running animations and clear any queued animations. + * + * ## Animation Keyframes + * + * You can also set up complex animations with {@link Ext.fx.Anim#keyframe keyframe} which follows the + * CSS3 Animation configuration pattern. Note rotation, translation, and scaling can only be done for sprites. + * The previous example can be written with the following syntax: + * + * p1.animate({ + * duration: 1000, //one second total + * keyframes: { + * 25: { //from 0 to 250ms (25%) + * x: 0 + * }, + * 50: { //from 250ms to 500ms (50%) + * y: 0 + * }, + * 75: { //from 500ms to 750ms (75%) + * backgroundColor: '#f00' //red + * }, + * 100: { //from 750ms to 1sec + * opacity: 0 + * } + * } + * }); + * + * ## Animation Events + * + * Each animation you create has events for {@link Ext.fx.Anim#beforeanimation beforeanimation}, + * {@link Ext.fx.Anim#afteranimate afteranimate}, and {@link Ext.fx.Anim#lastframe lastframe}. + * Keyframed animations adds an additional {@link Ext.fx.Animator#keyframe keyframe} event which + * fires for each keyframe in your animation. + * + * All animations support the {@link Ext.util.Observable#listeners listeners} configuration to attact functions to these events. + * + * startAnimate: function() { + * var p1 = Ext.get('myElementId'); + * p1.animate({ + * duration: 100, + * to: { + * opacity: 0 + * }, + * listeners: { + * beforeanimate: function() { + * // Execute my custom method before the animation + * this.myBeforeAnimateFn(); + * }, + * afteranimate: function() { + * // Execute my custom method after the animation + * this.myAfterAnimateFn(); + * }, + * scope: this + * }); + * }, + * myBeforeAnimateFn: function() { + * // My custom logic + * }, + * myAfterAnimateFn: function() { + * // My custom logic + * } + * + * Due to the fact that animations run asynchronously, you can determine if an animation is currently + * running on any target by using the {@link Ext.util.Animate#getActiveAnimation getActiveAnimation} + * method. This method will return false if there are no active animations or return the currently + * running {@link Ext.fx.Anim} instance. + * + * In this example, we're going to wait for the current animation to finish, then stop any other + * queued animations before we fade our element's opacity to 0: + * + * var curAnim = p1.getActiveAnimation(); + * if (curAnim) { + * curAnim.on('afteranimate', function() { + * p1.stopAnimation(); + * p1.animate({ + * to: { + * opacity: 0 + * } + * }); + * }); + * } + * + * @docauthor Jamie Avins + */ +Ext.define('Ext.util.Animate', { + + uses: ['Ext.fx.Manager', 'Ext.fx.Anim'], + + /** + *

Perform custom animation on this object.

+ *

This method is applicable to both the the {@link Ext.Component Component} class and the {@link Ext.core.Element Element} class. + * It performs animated transitions of certain properties of this object over a specified timeline.

+ *

The sole parameter is an object which specifies start property values, end property values, and properties which + * describe the timeline. Of the properties listed below, only to is mandatory.

+ *

Properties include

from
An object which specifies start values for the properties being animated. + * If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon + * ths object being animated. See the sections below on Element and Component animation.
to
An object which specifies end values for the properties being animated.
duration
The duration in milliseconds for which the animation will run.
easing
A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:+ * ease + * easeIn + * easeOut + * easeInOut + * backIn + * backOut + * elasticIn + * elasticOut + * bounceIn + * bounceOut + *
keyframes
This is an object which describes the state of animated properties at certain points along the timeline. + * it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
listeners
This is a standard {@link Ext.util.Observable#listeners listeners} configuration object which may be used + * to inject behaviour at either the beforeanimate event or the afteranimate event.

+ *

Animating an {@link Ext.core.Element Element}

+ * When animating an Element, the following properties may be specified in from, to, and keyframe objects:

x
The page X position in pixels.
y
The page Y position in pixels
left
The element's CSS left value. Units must be supplied.
top
The element's CSS top value. Units must be supplied.
width
The element's CSS width value. Units must be supplied.
height
The element's CSS height value. Units must be supplied.
scrollLeft
The element's scrollLeft value.
scrollTop
The element's scrollLeft value.
opacity
The element's opacity value. This must be a value between 0 and 1.

+ *

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state + * will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to + * directly animate certain properties of Components.

+ *

Animating a {@link Ext.Component Component}

+ * When animating an Element, the following properties may be specified in from, to, and keyframe objects:

x
The Component's page X position in pixels.
y
The Component's page Y position in pixels
left
The Component's left value in pixels.
top
The Component's top value in pixels.
width
The Component's width value in pixels.
width
The Component's width value in pixels.
dynamic
Specify as true to update the Component's layout (if it is a Container) at every frame + * of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

+ *

For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:

+ *


+myWindow = Ext.create('Ext.window.Window', {
+    title: 'Test Component animation',
+    width: 500,
+    height: 300,
+    layout: {
+        type: 'hbox',
+        align: 'stretch'
+    },
+    items: [{
+        title: 'Left: 33%',
+        margins: '5 0 5 5',
+        flex: 1
+    }, {
+        title: 'Left: 66%',
+        margins: '5 5 5 5',
+        flex: 2
+    }]
+});
+myWindow.show();
+myWindow.header.el.on('click', function() {
+    myWindow.animate({
+        to: {
+            width: (myWindow.getWidth() == 500) ? 700 : 500,
+            height: (myWindow.getHeight() == 300) ? 400 : 300,
+        }
+    });
+});
+

+ *

For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child + * Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

+ * @param {Object} config An object containing properties which describe the animation's start and end states, and the timeline of the animation. + * @return {Object} this + */ + animate: function(animObj) { + var me = this; + if (Ext.fx.Manager.hasFxBlock(me.id)) { + return me; + } + Ext.fx.Manager.queueFx(Ext.create('Ext.fx.Anim', me.anim(animObj))); + return this; + }, + + // @private - process the passed fx configuration. + anim: function(config) { + if (!Ext.isObject(config)) { + return (config) ? {} : false; + } + + var me = this; + + if (config.stopAnimation) { + me.stopAnimation(); + } + + Ext.applyIf(config, Ext.fx.Manager.getFxDefaults(me.id)); + + return Ext.apply({ + target: me, + paused: true + }, config); + }, + + /** + * @deprecated 4.0 Replaced by {@link #stopAnimation} + * Stops any running effects and clears this object's internal effects queue if it contains + * any additional effects that haven't started yet. + * @return {Ext.core.Element} The Element + * @method + */ + stopFx: Ext.Function.alias(Ext.util.Animate, 'stopAnimation'), + + /** + * Stops any running effects and clears this object's internal effects queue if it contains + * any additional effects that haven't started yet. + * @return {Ext.core.Element} The Element + */ + stopAnimation: function() { + Ext.fx.Manager.stopAnimation(this.id); + return this; + }, + + /** + * Ensures that all effects queued after syncFx is called on this object are + * run concurrently. This is the opposite of {@link #sequenceFx}. + * @return {Object} this + */ + syncFx: function() { + Ext.fx.Manager.setFxDefaults(this.id, { + concurrent: true + }); + return this; + }, + + /** + * Ensures that all effects queued after sequenceFx is called on this object are + * run in sequence. This is the opposite of {@link #syncFx}. + * @return {Object} this + */ + sequenceFx: function() { + Ext.fx.Manager.setFxDefaults(this.id, { + concurrent: false + }); + return this; + }, + + /** + * @deprecated 4.0 Replaced by {@link #getActiveAnimation} + * Returns thq current animation if this object has any effects actively running or queued, else returns false. + * @return {Mixed} anim if element has active effects, else false + * @method + */ + hasActiveFx: Ext.Function.alias(Ext.util.Animate, 'getActiveAnimation'), + + /** + * Returns thq current animation if this object has any effects actively running or queued, else returns false. + * @return {Mixed} anim if element has active effects, else false + */ + getActiveAnimation: function() { + return Ext.fx.Manager.getActiveAnimation(this.id); + } +}); + +// Apply Animate mixin manually until Element is defined in the proper 4.x way +Ext.applyIf(Ext.core.Element.prototype, Ext.util.Animate.prototype); +/** + * @class Ext.state.Provider + *

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

+ * + *

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

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

+ * Represents a collection of a set of key and value pairs. Each key in the HashMap + * must be unique, the same key cannot exist twice. Access to items is provided via + * the key only. Sample usage: + *


+var map = new Ext.util.HashMap();
+map.add('key1', 1);
+map.add('key2', 2);
+map.add('key3', 3);
+
+map.each(function(key, value, length){
+    console.log(key, value, length);
+});
+ *

+ *

+ * + *

The HashMap is an unordered class, + * there is no guarantee when iterating over the items that they will be in any particular + * order. If this is required, then use a {@link Ext.util.MixedCollection}. + *

+ * @constructor + * @param {Object} config The configuration options + */ +Ext.define('Ext.util.HashMap', { + + /** + * @cfg {Function} keyFn A function that is used to retrieve a default key for a passed object. + * A default is provided that returns the id property on the object. This function is only used + * if the add method is called with a single argument. + */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + constructor: function(config) { + var me = this; + + me.addEvents( + /** + * @event add + * Fires when a new item is added to the hash + * @param {Ext.util.HashMap} this. + * @param {String} key The key of the added item. + * @param {Object} value The value of the added item. + */ + 'add', + /** + * @event clear + * Fires when the hash is cleared. + * @param {Ext.util.HashMap} this. + */ + 'clear', + /** + * @event remove + * Fires when an item is removed from the hash. + * @param {Ext.util.HashMap} this. + * @param {String} key The key of the removed item. + * @param {Object} value The value of the removed item. + */ + 'remove', + /** + * @event replace + * Fires when an item is replaced in the hash. + * @param {Ext.util.HashMap} this. + * @param {String} key The key of the replaced item. + * @param {Object} value The new value for the item. + * @param {Object} old The old value for the item. + */ + 'replace' + ); + + me.mixins.observable.constructor.call(me, config); + me.clear(true); + }, + + /** + * Gets the number of items in the hash. + * @return {Number} The number of items in the hash. + */ + getCount: function() { + return this.length; + }, + + /** + * Implementation for being able to extract the key from an object if only + * a single argument is passed. + * @private + * @param {String} key The key + * @param {Object} value The value + * @return {Array} [key, value] + */ + getData: function(key, value) { + // if we have no value, it means we need to get the key from the object + if (value === undefined) { + value = key; + key = this.getKey(value); + } + + return [key, value]; + }, + + /** + * Extracts the key from an object. This is a default implementation, it may be overridden + * @private + * @param {Object} o The object to get the key from + * @return {String} The key to use. + */ + getKey: function(o) { + return o.id; + }, + + /** + * Adds an item to the collection. Fires the {@link #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 HashMap, + * or if the key of the stored items is in a property called id, + * the HashMap will be able to derive the key for the new item. + * In this case just pass the new item in this parameter.

+ * @param {Object} o The item to add. + * @return {Object} The item added. + */ + add: function(key, value) { + var me = this, + data; + + if (arguments.length === 1) { + value = key; + key = me.getKey(value); + } + + if (me.containsKey(key)) { + me.replace(key, value); + } + + data = me.getData(key, value); + key = data[0]; + value = data[1]; + me.map[key] = value; + ++me.length; + me.fireEvent('add', me, key, value); + return value; + }, + + /** + * Replaces an item in the hash. If the key doesn't exist, the + * {@link #add} method will be used. + * @param {String} key The key of the item. + * @param {Object} value The new value for the item. + * @return {Object} The new value of the item. + */ + replace: function(key, value) { + var me = this, + map = me.map, + old; + + if (!me.containsKey(key)) { + me.add(key, value); + } + old = map[key]; + map[key] = value; + me.fireEvent('replace', me, key, value, old); + return value; + }, + + /** + * Remove an item from the hash. + * @param {Object} o The value of the item to remove. + * @return {Boolean} True if the item was successfully removed. + */ + remove: function(o) { + var key = this.findKey(o); + if (key !== undefined) { + return this.removeAtKey(key); + } + return false; + }, + + /** + * Remove an item from the hash. + * @param {String} key The key to remove. + * @return {Boolean} True if the item was successfully removed. + */ + removeAtKey: function(key) { + var me = this, + value; + + if (me.containsKey(key)) { + value = me.map[key]; + delete me.map[key]; + --me.length; + me.fireEvent('remove', me, key, value); + return true; + } + return false; + }, + + /** + * Retrieves an item with a particular key. + * @param {String} key The key to lookup. + * @return {Object} The value at that key. If it doesn't exist, undefined is returned. + */ + get: function(key) { + return this.map[key]; + }, + + /** + * Removes all items from the hash. + * @return {Ext.util.HashMap} this + */ + clear: function(/* private */ initial) { + var me = this; + me.map = {}; + me.length = 0; + if (initial !== true) { + me.fireEvent('clear', me); + } + return me; + }, + + /** + * Checks whether a key exists in the hash. + * @param {String} key The key to check for. + * @return {Boolean} True if they key exists in the hash. + */ + containsKey: function(key) { + return this.map[key] !== undefined; + }, + + /** + * Checks whether a value exists in the hash. + * @param {Object} value The value to check for. + * @return {Boolean} True if the value exists in the dictionary. + */ + contains: function(value) { + return this.containsKey(this.findKey(value)); + }, + + /** + * Return all of the keys in the hash. + * @return {Array} An array of keys. + */ + getKeys: function() { + return this.getArray(true); + }, + + /** + * Return all of the values in the hash. + * @return {Array} An array of values. + */ + getValues: function() { + return this.getArray(false); + }, + + /** + * Gets either the keys/values in an array from the hash. + * @private + * @param {Boolean} isKey True to extract the keys, otherwise, the value + * @return {Array} An array of either keys/values from the hash. + */ + getArray: function(isKey) { + var arr = [], + key, + map = this.map; + for (key in map) { + if (map.hasOwnProperty(key)) { + arr.push(isKey ? key: map[key]); + } + } + return arr; + }, + + /** + * Executes the specified function once for each item in the hash. + * Returning false from the function will cease iteration. + * + * The paramaters passed to the function are: + *

key : String
The key of the item
value : Number
The value of the item
length : Number
The total number of items in the hash

+ * @param {Function} fn The function to execute. + * @param {Object} scope The scope to execute in. Defaults to this. + * @return {Ext.util.HashMap} this + */ + each: function(fn, scope) { + // copy items so they may be removed during iteration. + var items = Ext.apply({}, this.map), + key, + length = this.length; + + scope = scope || this; + for (key in items) { + if (items.hasOwnProperty(key)) { + if (fn.call(scope, key, items[key], length) === false) { + break; + } + } + } + return this; + }, + + /** + * Performs a shallow copy on this hash. + * @return {Ext.util.HashMap} The new hash object. + */ + clone: function() { + var hash = new this.self(), + map = this.map, + key; + + hash.suspendEvents(); + for (key in map) { + if (map.hasOwnProperty(key)) { + hash.add(key, map[key]); + } + } + hash.resumeEvents(); + return hash; + }, + + /** + * @private + * Find the key for a value. + * @param {Object} value The value to find. + * @return {Object} The value of the item. Returns undefined if not found. + */ + findKey: function(value) { + var key, + map = this.map; + + for (key in map) { + if (map.hasOwnProperty(key) && map[key] === value) { + return key; + } + } + return undefined; + } +}); + +/** + * @class Ext.Template + *

Represents an HTML fragment template. Templates may be {@link #compile precompiled} + * for greater performance.

+ * An instance of this class may be created by passing to the constructor either + * a single argument, or multiple arguments: + *

single argument : String/Array + *

+ * The single argument may be either a String or an Array:

String :


+var t = new Ext.Template("<div>Hello {0}.</div>");
+t.{@link #append}('some-element', ['foo']);
+

Array :

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'});
+

multiple arguments : String, Object, Array, ... + *
+ * Multiple arguments will be combined with join(''). + *
```
+var t = new Ext.Template(
+    '<div name="{id}">',
+        '<span class="{cls}">{name} {value}</span>',
+    '</div>',
+    // a configuration object:
+    {
+        compiled: true,      // {@link #compile} immediately
+    }
+);
+   
```
+ *
Notes:
+ *
- For a list of available format functions, see {@link Ext.util.Format}.
- disableFormats reduces {@link #apply} time + * when no formatting is required.
+ *

+ * @param {Mixed} config + */ + +Ext.define('Ext.Template', { + + /* Begin Definitions */ + + requires: ['Ext.core.DomHelper', 'Ext.util.Format'], + + statics: { + /** + * 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 + */ + from: function(el, config) { + el = Ext.getDom(el); + return new this(el.value || el.innerHTML, config || ''); + } + }, + + /* End Definitions */ + + constructor: function(html) { + var me = this, + args = arguments, + buffer = [], + i = 0, + length = args.length, + value; + + me.initialConfig = {}; + + if (length > 1) { + for (; i < length; i++) { + value = args[i]; + if (typeof value == 'object') { + Ext.apply(me.initialConfig, value); + Ext.apply(me, value); + } else { + buffer.push(value); + } + } + html = buffer.join(''); + } else { + if (Ext.isArray(html)) { + buffer.push(html.join('')); + } else { + buffer.push(html); + } + } + + // @private + me.html = buffer.join(''); + + if (me.compiled) { + me.compile(); + } + }, + isTemplate: true, + /** + * @cfg {Boolean} disableFormats true to disable format functions in the template. If the template doesn't contain format functions, setting + * disableFormats to true will reduce apply time (defaults to false) + */ + disableFormats: false, + + re: /\{([\w\-]+)(?:\:([\w\.]*)(?:$(.*?)?$)?)?\}/g, + /** + * Returns an HTML fragment of this template with the specified values applied. + * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @return {String} The HTML fragment + * @hide repeat doc + */ + applyTemplate: function(values) { + var me = this, + useFormat = me.disableFormats !== true, + fm = Ext.util.Format, + tpl = me; + + if (me.compiled) { + return me.compiled(values); + } + function fn(m, name, format, args) { + if (format && useFormat) { + if (args) { + args = [values[name]].concat(Ext.functionFactory('return ['+ args +'];')()); + } else { + args = [values[name]]; + } + if (format.substr(0, 5) == "this.") { + return tpl[format.substr(5)].apply(tpl, args); + } + else { + return fm[format].apply(fm, args); + } + } + else { + return values[name] !== undefined ? values[name] : ""; + } + } + return me.html.replace(me.re, fn); + }, + + /** + * 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 + */ + set: function(html, compile) { + var me = this; + me.html = html; + me.compiled = null; + return compile ? me.compile() : me; + }, + + compileARe: /\\/g, + compileBRe: /(\r\n|\n)/g, + compileCRe: /'/g, + /** + * Compiles the template into an internal function, eliminating the RegEx overhead. + * @return {Ext.Template} this + * @hide repeat doc + */ + compile: function() { + var me = this, + fm = Ext.util.Format, + useFormat = me.disableFormats !== true, + body, bodyReturn; + + function fn(m, name, format, args) { + if (format && useFormat) { + args = args ? ',' + args: ""; + if (format.substr(0, 5) != "this.") { + format = "fm." + format + '('; + } + else { + format = 'this.' + format.substr(5) + '('; + } + } + else { + args = ''; + format = "(values['" + name + "'] == undefined ? '' : "; + } + return "'," + format + "values['" + name + "']" + args + ") ,'"; + } + + bodyReturn = me.html.replace(me.compileARe, '\\\\').replace(me.compileBRe, '\\n').replace(me.compileCRe, "\\'").replace(me.re, fn); + body = "this.compiled = function(values){ return ['" + bodyReturn + "'].join('');};"; + eval(body); + return me; + }, + + /** + * 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.core.Element (defaults to undefined) + * @return {HTMLElement/Ext.core.Element} The new node or Element + */ + insertFirst: function(el, values, returnElement) { + return this.doInsert('afterBegin', el, values, returnElement); + }, + + /** + * Applies the supplied values to the template and inserts the new node(s) before el. + * @param {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.core.Element (defaults to undefined) + * @return {HTMLElement/Ext.core.Element} The new node or Element + */ + insertBefore: function(el, values, returnElement) { + return this.doInsert('beforeBegin', el, values, returnElement); + }, + + /** + * Applies the supplied values to the template and inserts the new node(s) after el. + * @param {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.core.Element (defaults to undefined) + * @return {HTMLElement/Ext.core.Element} The new node or Element + */ + insertAfter: function(el, values, returnElement) { + return this.doInsert('afterEnd', el, values, returnElement); + }, + + /** + * Applies the supplied values to the template and appends + * the new node(s) to the specified el. + *

For example usage {@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.core.Element (defaults to undefined) + * @return {HTMLElement/Ext.core.Element} The new node or Element + */ + append: function(el, values, returnElement) { + return this.doInsert('beforeEnd', el, values, returnElement); + }, + + doInsert: function(where, el, values, returnEl) { + el = Ext.getDom(el); + var newNode = Ext.core.DomHelper.insertHtml(where, el, this.applyTemplate(values)); + return returnEl ? Ext.get(newNode, true) : newNode; + }, + + /** + * 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.core.Element (defaults to undefined) + * @return {HTMLElement/Ext.core.Element} The new node or Element + */ + overwrite: function(el, values, returnElement) { + el = Ext.getDom(el); + el.innerHTML = this.applyTemplate(values); + return returnElement ? Ext.get(el.firstChild, true) : el.firstChild; + } +}, function() { + + /** + * 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 + */ + this.createAlias('apply', 'applyTemplate'); +}); + +/** + * @class Ext.ComponentQuery + * @extends Object + * + * Provides searching of Components within Ext.ComponentManager (globally) or a specific + * Ext.container.Container on the document with a similar syntax to a CSS selector. + * + * Components can be retrieved by using their {@link Ext.Component xtype} with an optional . prefix +

component or .component
gridpanel or .gridpanel

+ * + * An itemId or id must be prefixed with a # +

#myContainer

+ * + * + * Attributes must be wrapped in brackets +

component[autoScroll]
panel[title="Test"]

+ * + * Member expressions from candidate Components may be tested. If the expression returns a truthy value, + * the candidate Component will be included in the query:


+var disabledFields = myFormPanel.query("{isDisabled()}");
+

+ * + * Pseudo classes may be used to filter results in the same way as in {@link Ext.DomQuery DomQuery}:

+// Function receives array and returns a filtered array.
+Ext.ComponentQuery.pseudos.invalid = function(items) {
+    var i = 0, l = items.length, c, result = [];
+    for (; i < l; i++) {
+        if (!(c = items[i]).isValid()) {
+            result.push(c);
+        }
+    }
+    return result;
+};
+
+var invalidFields = myFormPanel.query('field:invalid');
+if (invalidFields.length) {
+    invalidFields[0].getEl().scrollIntoView(myFormPanel.body);
+    for (var i = 0, l = invalidFields.length; i < l; i++) {
+        invalidFields[i].getEl().frame("red");
+    }
+}
+

+ *

+ * Default pseudos include:
+ * - not + *

+ * + * Queries return an array of components. + * Here are some example queries. +


+    // retrieve all Ext.Panels in the document by xtype
+    var panelsArray = Ext.ComponentQuery.query('panel');
+
+    // retrieve all Ext.Panels within the container with an id myCt
+    var panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel');
+
+    // retrieve all direct children which are Ext.Panels within myCt
+    var directChildPanel = Ext.ComponentQuery.query('#myCt > panel');
+
+    // retrieve all gridpanels and listviews
+    var gridsAndLists = Ext.ComponentQuery.query('gridpanel, listview');
+

+ +For easy access to queries based from a particular Container see the {@link Ext.container.Container#query}, +{@link Ext.container.Container#down} and {@link Ext.container.Container#child} methods. Also see +{@link Ext.Component#up}. + * @singleton + */ +Ext.define('Ext.ComponentQuery', { + singleton: true, + uses: ['Ext.ComponentManager'] +}, function() { + + var cq = this, + + // A function source code pattern with a placeholder which accepts an expression which yields a truth value when applied + // as a member on each item in the passed array. + filterFnPattern = [ + 'var r = [],', + 'i = 0,', + 'it = items,', + 'l = it.length,', + 'c;', + 'for (; i < l; i++) {', + 'c = it[i];', + 'if (c.{0}) {', + 'r.push(c);', + '}', + '}', + 'return r;' + ].join(''), + + filterItems = function(items, operation) { + // Argument list for the operation is [ itemsArray, operationArg1, operationArg2...] + // The operation's method loops over each item in the candidate array and + // returns an array of items which match its criteria + return operation.method.apply(this, [ items ].concat(operation.args)); + }, + + getItems = function(items, mode) { + var result = [], + i = 0, + length = items.length, + candidate, + deep = mode !== '>'; + + for (; i < length; i++) { + candidate = items[i]; + if (candidate.getRefItems) { + result = result.concat(candidate.getRefItems(deep)); + } + } + return result; + }, + + getAncestors = function(items) { + var result = [], + i = 0, + length = items.length, + candidate; + for (; i < length; i++) { + candidate = items[i]; + while (!!(candidate = (candidate.ownerCt || candidate.floatParent))) { + result.push(candidate); + } + } + return result; + }, + + // Filters the passed candidate array and returns only items which match the passed xtype + filterByXType = function(items, xtype, shallow) { + if (xtype === '*') { + return items.slice(); + } + else { + var result = [], + i = 0, + length = items.length, + candidate; + for (; i < length; i++) { + candidate = items[i]; + if (candidate.isXType(xtype, shallow)) { + result.push(candidate); + } + } + return result; + } + }, + + // Filters the passed candidate array and returns only items which have the passed className + filterByClassName = function(items, className) { + var EA = Ext.Array, + result = [], + i = 0, + length = items.length, + candidate; + for (; i < length; i++) { + candidate = items[i]; + if (candidate.el ? candidate.el.hasCls(className) : EA.contains(candidate.initCls(), className)) { + result.push(candidate); + } + } + return result; + }, + + // Filters the passed candidate array and returns only items which have the specified property match + filterByAttribute = function(items, property, operator, value) { + var result = [], + i = 0, + length = items.length, + candidate; + for (; i < length; i++) { + candidate = items[i]; + if (!value ? !!candidate[property] : (String(candidate[property]) === value)) { + result.push(candidate); + } + } + return result; + }, + + // Filters the passed candidate array and returns only items which have the specified itemId or id + filterById = function(items, id) { + var result = [], + i = 0, + length = items.length, + candidate; + for (; i < length; i++) { + candidate = items[i]; + if (candidate.getItemId() === id) { + result.push(candidate); + } + } + return result; + }, + + // Filters the passed candidate array and returns only items which the named pseudo class matcher filters in + filterByPseudo = function(items, name, value) { + return cq.pseudos[name](items, value); + }, + + // Determines leading mode + // > for direct child, and ^ to switch to ownerCt axis + modeRe = /^(\s?([>\^])\s?|\s|$)/, + + // Matches a token with possibly (true|false) appended for the "shallow" parameter + tokenRe = /^(#)?([\w\-]+|\*)(?:$(true|false)$)?/, + + matchers = [{ + // Checks for .xtype with possibly (true|false) appended for the "shallow" parameter + re: /^\.([\w\-]+)(?:$(true|false)$)?/, + method: filterByXType + },{ + // checks for [attribute=value] + re: /^(?:[\[](?:@)?([\w\-]+)\s?(?:(=|.=)\s?['"]?(.*?)["']?)?[\]])/, + method: filterByAttribute + }, { + // checks for #cmpItemId + re: /^#([\w\-]+)/, + method: filterById + }, { + // checks for :() + re: /^\:([\w\-]+)(?:$((?:\{[^\}]+\})|(?:(?!\{)[^\s>\/]*?(?!\})))$)?/, + method: filterByPseudo + }, { + // checks for {} + re: /^(?:\{([^\}]+)\})/, + method: filterFnPattern + }]; + + /** + * @class Ext.ComponentQuery.Query + * @extends Object + * @private + */ + cq.Query = Ext.extend(Object, { + constructor: function(cfg) { + cfg = cfg || {}; + Ext.apply(this, cfg); + }, + + /** + * @private + * Executes this Query upon the selected root. + * The root provides the initial source of candidate Component matches which are progressively + * filtered by iterating through this Query's operations cache. + * If no root is provided, all registered Components are searched via the ComponentManager. + * root may be a Container who's descendant Components are filtered + * root may be a Component with an implementation of getRefItems which provides some nested Components such as the + * docked items within a Panel. + * root may be an array of candidate Components to filter using this Query. + */ + execute : function(root) { + var operations = this.operations, + i = 0, + length = operations.length, + operation, + workingItems; + + // no root, use all Components in the document + if (!root) { + workingItems = Ext.ComponentManager.all.getArray(); + } + // Root is a candidate Array + else if (Ext.isArray(root)) { + workingItems = root; + } + + // We are going to loop over our operations and take care of them + // one by one. + for (; i < length; i++) { + operation = operations[i]; + + // The mode operation requires some custom handling. + // All other operations essentially filter down our current + // working items, while mode replaces our current working + // items by getting children from each one of our current + // working items. The type of mode determines the type of + // children we get. (e.g. > only gets direct children) + if (operation.mode === '^') { + workingItems = getAncestors(workingItems || [root]); + } + else if (operation.mode) { + workingItems = getItems(workingItems || [root], operation.mode); + } + else { + workingItems = filterItems(workingItems || getItems([root]), operation); + } + + // If this is the last operation, it means our current working + // items are the final matched items. Thus return them! + if (i === length -1) { + return workingItems; + } + } + return []; + }, + + is: function(component) { + var operations = this.operations, + components = Ext.isArray(component) ? component : [component], + originalLength = components.length, + lastOperation = operations[operations.length-1], + ln, i; + + components = filterItems(components, lastOperation); + if (components.length === originalLength) { + if (operations.length > 1) { + for (i = 0, ln = components.length; i < ln; i++) { + if (Ext.Array.indexOf(this.execute(), components[i]) === -1) { + return false; + } + } + } + return true; + } + return false; + } + }); + + Ext.apply(this, { + + // private cache of selectors and matching ComponentQuery.Query objects + cache: {}, + + // private cache of pseudo class filter functions + pseudos: { + not: function(components, selector){ + var CQ = Ext.ComponentQuery, + i = 0, + length = components.length, + results = [], + index = -1, + component; + + for(; i < length; ++i) { + component = components[i]; + if (!CQ.is(component, selector)) { + results[++index] = component; + } + } + return results; + } + }, + + /** + *

Returns an array of matched Components from within the passed root object.

+ *

This method filters returned Components in a similar way to how CSS selector based DOM + * queries work using a textual selector string.

+ *

See class summary for details.

+ * @param selector The selector string to filter returned Components + * @param root

The Container within which to perform the query. If omitted, all Components + * within the document are included in the search.

+ *

This parameter may also be an array of Components to filter according to the selector.

+ * @returns {Array} The matched Components. + * @member Ext.ComponentQuery + */ + query: function(selector, root) { + var selectors = selector.split(','), + length = selectors.length, + i = 0, + results = [], + noDupResults = [], + dupMatcher = {}, + query, resultsLn, cmp; + + for (; i < length; i++) { + selector = Ext.String.trim(selectors[i]); + query = this.cache[selector]; + if (!query) { + this.cache[selector] = query = this.parse(selector); + } + results = results.concat(query.execute(root)); + } + + // multiple selectors, potential to find duplicates + // lets filter them out. + if (length > 1) { + resultsLn = results.length; + for (i = 0; i < resultsLn; i++) { + cmp = results[i]; + if (!dupMatcher[cmp.id]) { + noDupResults.push(cmp); + dupMatcher[cmp.id] = true; + } + } + results = noDupResults; + } + return results; + }, + + /** + * Tests whether the passed Component matches the selector string. + * @param component The Component to test + * @param selector The selector string to test against. + * @return {Boolean} True if the Component matches the selector. + * @member Ext.ComponentQuery + */ + is: function(component, selector) { + if (!selector) { + return true; + } + var query = this.cache[selector]; + if (!query) { + this.cache[selector] = query = this.parse(selector); + } + return query.is(component); + }, + + parse: function(selector) { + var operations = [], + length = matchers.length, + lastSelector, + tokenMatch, + matchedChar, + modeMatch, + selectorMatch, + i, matcher, method; + + // We are going to parse the beginning of the selector over and + // over again, slicing off the selector any portions we converted into an + // operation, until it is an empty string. + while (selector && lastSelector !== selector) { + lastSelector = selector; + + // First we check if we are dealing with a token like #, * or an xtype + tokenMatch = selector.match(tokenRe); + + if (tokenMatch) { + matchedChar = tokenMatch[1]; + + // If the token is prefixed with a # we push a filterById operation to our stack + if (matchedChar === '#') { + operations.push({ + method: filterById, + args: [Ext.String.trim(tokenMatch[2])] + }); + } + // If the token is prefixed with a . we push a filterByClassName operation to our stack + // FIXME: Not enabled yet. just needs \. adding to the tokenRe prefix + else if (matchedChar === '.') { + operations.push({ + method: filterByClassName, + args: [Ext.String.trim(tokenMatch[2])] + }); + } + // If the token is a * or an xtype string, we push a filterByXType + // operation to the stack. + else { + operations.push({ + method: filterByXType, + args: [Ext.String.trim(tokenMatch[2]), Boolean(tokenMatch[3])] + }); + } + + // Now we slice of the part we just converted into an operation + selector = selector.replace(tokenMatch[0], ''); + } + + // If the next part of the query is not a space or > or ^, it means we + // are going to check for more things that our current selection + // has to comply to. + while (!(modeMatch = selector.match(modeRe))) { + // Lets loop over each type of matcher and execute it + // on our current selector. + for (i = 0; selector && i < length; i++) { + matcher = matchers[i]; + selectorMatch = selector.match(matcher.re); + method = matcher.method; + + // If we have a match, add an operation with the method + // associated with this matcher, and pass the regular + // expression matches are arguments to the operation. + if (selectorMatch) { + operations.push({ + method: Ext.isString(matcher.method) + // Turn a string method into a function by formatting the string with our selector matche expression + // A new method is created for different match expressions, eg {id=='textfield-1024'} + // Every expression may be different in different selectors. + ? Ext.functionFactory('items', Ext.String.format.apply(Ext.String, [method].concat(selectorMatch.slice(1)))) + : matcher.method, + args: selectorMatch.slice(1) + }); + selector = selector.replace(selectorMatch[0], ''); + break; // Break on match + } + // Exhausted all matches: It's an error + if (i === (length - 1)) { + Ext.Error.raise('Invalid ComponentQuery selector: "' + arguments[0] + '"'); + } + } + } + + // Now we are going to check for a mode change. This means a space + // or a > to determine if we are going to select all the children + // of the currently matched items, or a ^ if we are going to use the + // ownerCt axis as the candidate source. + if (modeMatch[1]) { // Assignment, and test for truthiness! + operations.push({ + mode: modeMatch[2]||modeMatch[1] + }); + selector = selector.replace(modeMatch[0], ''); + } + } + + // Now that we have all our operations in an array, we are going + // to create a new Query using these operations. + return new cq.Query({ + operations: operations + }); + } + }); +}); +/** + * @class Ext.util.Filter + * @extends Object + *

Represents a filter that can be applied to a {@link Ext.util.MixedCollection MixedCollection}. Can either simply + * filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context + * of MixedCollections, though {@link Ext.data.Store Store}s frequently create them when filtering and searching on their + * records. Example usage:


+//set up a fictional MixedCollection containing a few people to filter on
+var allNames = new Ext.util.MixedCollection();
+allNames.addAll([
+    {id: 1, name: 'Ed',    age: 25},
+    {id: 2, name: 'Jamie', age: 37},
+    {id: 3, name: 'Abe',   age: 32},
+    {id: 4, name: 'Aaron', age: 26},
+    {id: 5, name: 'David', age: 32}
+]);
+
+var ageFilter = new Ext.util.Filter({
+    property: 'age',
+    value   : 32
+});
+
+var longNameFilter = new Ext.util.Filter({
+    filterFn: function(item) {
+        return item.name.length > 4;
+    }
+});
+
+//a new MixedCollection with the 3 names longer than 4 characters
+var longNames = allNames.filter(longNameFilter);
+
+//a new MixedCollection with the 2 people of age 24:
+var youngFolk = allNames.filter(ageFilter);
+

+ * @constructor + * @param {Object} config Config object + */ +Ext.define('Ext.util.Filter', { + + /* Begin Definitions */ + + /* End Definitions */ + /** + * @cfg {String} property The property to filter on. Required unless a {@link #filter} is passed + */ + + /** + * @cfg {Function} filterFn A custom filter function which is passed each item in the {@link Ext.util.MixedCollection} + * in turn. Should return true to accept each item or false to reject it + */ + + /** + * @cfg {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false + */ + anyMatch: false, + + /** + * @cfg {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. + * Ignored if anyMatch is true. + */ + exactMatch: false, + + /** + * @cfg {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false. + */ + caseSensitive: false, + + /** + * @cfg {String} root Optional root property. This is mostly useful when filtering a Store, in which case we set the + * root to 'data' to make the filter pull the {@link #property} out of the data object of each item + */ + + constructor: function(config) { + Ext.apply(this, config); + + //we're aliasing filter to filterFn mostly for API cleanliness reasons, despite the fact it dirties the code here. + //Ext.util.Sorter takes a sorterFn property but allows .sort to be called - we do the same here + this.filter = this.filter || this.filterFn; + + if (this.filter == undefined) { + if (this.property == undefined || this.value == undefined) { + // Commented this out temporarily because it stops us using string ids in models. TODO: Remove this once + // Model has been updated to allow string ids + + // Ext.Error.raise("A Filter requires either a property or a filterFn to be set"); + } else { + this.filter = this.createFilterFn(); + } + + this.filterFn = this.filter; + } + }, + + /** + * @private + * Creates a filter function for the configured property/value/anyMatch/caseSensitive options for this Filter + */ + createFilterFn: function() { + var me = this, + matcher = me.createValueMatcher(), + property = me.property; + + return function(item) { + return matcher.test(me.getRoot.call(me, item)[property]); + }; + }, + + /** + * @private + * Returns the root property of the given item, based on the configured {@link #root} property + * @param {Object} item The item + * @return {Object} The root property of the object + */ + getRoot: function(item) { + return this.root == undefined ? item : item[this.root]; + }, + + /** + * @private + * Returns a regular expression based on the given value and matching options + */ + createValueMatcher : function() { + var me = this, + value = me.value, + anyMatch = me.anyMatch, + exactMatch = me.exactMatch, + caseSensitive = me.caseSensitive, + escapeRe = Ext.String.escapeRegex; + + if (!value.exec) { // not a regex + value = String(value); + + if (anyMatch === true) { + value = escapeRe(value); + } else { + value = '^' + escapeRe(value); + if (exactMatch === true) { + value += '$'; + } + } + value = new RegExp(value, caseSensitive ? '' : 'i'); + } + + return value; + } +}); +/** + * @class Ext.util.Sorter + * @extends Object + * Represents a single sorter that can be applied to a Store + */ +Ext.define('Ext.util.Sorter', { + + /** + * @cfg {String} property The property to sort by. Required unless {@link #sorter} is provided + */ + + /** + * @cfg {Function} sorterFn A specific sorter function to execute. Can be passed instead of {@link #property} + */ + + /** + * @cfg {String} root Optional root property. This is mostly useful when sorting a Store, in which case we set the + * root to 'data' to make the filter pull the {@link #property} out of the data object of each item + */ + + /** + * @cfg {Function} transform A function that will be run on each value before + * it is compared in the sorter. The function will receive a single argument, + * the value. + */ + + /** + * @cfg {String} direction The direction to sort by. Defaults to ASC + */ + direction: "ASC", + + constructor: function(config) { + var me = this; + + Ext.apply(me, config); + + if (me.property == undefined && me.sorterFn == undefined) { + Ext.Error.raise("A Sorter requires either a property or a sorter function"); + } + + me.updateSortFunction(); + }, + + /** + * @private + * Creates and returns a function which sorts an array by the given property and direction + * @return {Function} A function which sorts by the property/direction combination provided + */ + createSortFunction: function(sorterFn) { + var me = this, + property = me.property, + direction = me.direction || "ASC", + modifier = direction.toUpperCase() == "DESC" ? -1 : 1; + + //create a comparison function. Takes 2 objects, returns 1 if object 1 is greater, + //-1 if object 2 is greater or 0 if they are equal + return function(o1, o2) { + return modifier * sorterFn.call(me, o1, o2); + }; + }, + + /** + * @private + * Basic default sorter function that just compares the defined property of each object + */ + defaultSorterFn: function(o1, o2) { + var me = this, + transform = me.transform, + v1 = me.getRoot(o1)[me.property], + v2 = me.getRoot(o2)[me.property]; + + if (transform) { + v1 = transform(v1); + v2 = transform(v2); + } + + return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0); + }, + + /** + * @private + * Returns the root property of the given item, based on the configured {@link #root} property + * @param {Object} item The item + * @return {Object} The root property of the object + */ + getRoot: function(item) { + return this.root == undefined ? item : item[this.root]; + }, + + // @TODO: Add docs for these three methods + setDirection: function(direction) { + var me = this; + me.direction = direction; + me.updateSortFunction(); + }, + + toggle: function() { + var me = this; + me.direction = Ext.String.toggle(me.direction, "ASC", "DESC"); + me.updateSortFunction(); + }, + + updateSortFunction: function() { + var me = this; + me.sort = me.createSortFunction(me.sorterFn || me.defaultSorterFn); + } +}); +/** + * @class Ext.ElementLoader + * A class used to load remote content to an Element. Sample usage: + *


+Ext.get('el').load({
+    url: 'myPage.php',
+    scripts: true,
+    params: {
+        id: 1
+    }
+});
+ *

+ *

+ * In general this class will not be instanced directly, rather the {@link Ext.core.Element#load} method + * will be used. + *

+ */ +Ext.define('Ext.ElementLoader', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + uses: [ + 'Ext.data.Connection', + 'Ext.Ajax' + ], + + statics: { + Renderer: { + Html: function(loader, response, active){ + loader.getTarget().update(response.responseText, active.scripts === true); + return true; + } + } + }, + + /* End Definitions */ + + /** + * @cfg {String} url The url to retrieve the content from. Defaults to null. + */ + url: null, + + /** + * @cfg {Object} params Any params to be attached to the Ajax request. These parameters will + * be overridden by any params in the load options. Defaults to null. + */ + params: null, + + /** + * @cfg {Object} baseParams Params that will be attached to every request. These parameters + * will not be overridden by any params in the load options. Defaults to null. + */ + baseParams: null, + + /** + * @cfg {Boolean/Object} autoLoad True to have the loader make a request as soon as it is created. Defaults to false. + * This argument can also be a set of options that will be passed to {@link #load} is called. + */ + autoLoad: false, + + /** + * @cfg {Mixed} target The target element for the loader. It can be the DOM element, the id or an Ext.Element. + */ + target: null, + + /** + * @cfg {Mixed} loadMask True or a string to show when the element is loading. + */ + loadMask: false, + + /** + * @cfg {Object} ajaxOptions Any additional options to be passed to the request, for example timeout or headers. Defaults to null. + */ + ajaxOptions: null, + + /** + * @cfg {Boolean} scripts True to parse any inline script tags in the response. + */ + scripts: false, + + /** + * @cfg {Function} success A function to be called when a load request is successful. + */ + + /** + * @cfg {Function} failure A function to be called when a load request fails. + */ + + /** + * @cfg {Object} scope The scope to execute the {@link #success} and {@link #failure} functions in. + */ + + /** + * @cfg {Function} renderer A custom function to render the content to the element. The passed parameters + * are + *

The loader
The response
The active request

+ */ + + isLoader: true, + + constructor: function(config) { + var me = this, + autoLoad; + + config = config || {}; + Ext.apply(me, config); + me.setTarget(me.target); + me.addEvents( + /** + * @event beforeload + * Fires before a load request is made to the server. + * Returning false from an event listener can prevent the load + * from occurring. + * @param {Ext.ElementLoader} this + * @param {Object} options The options passed to the request + */ + 'beforeload', + + /** + * @event exception + * Fires after an unsuccessful load. + * @param {Ext.ElementLoader} this + * @param {Object} response The response from the server + * @param {Object} options The options passed to the request + */ + 'exception', + + /** + * @event exception + * Fires after a successful load. + * @param {Ext.ElementLoader} this + * @param {Object} response The response from the server + * @param {Object} options The options passed to the request + */ + 'load' + ); + + // don't pass config because we have already applied it. + me.mixins.observable.constructor.call(me); + + if (me.autoLoad) { + autoLoad = me.autoLoad; + if (autoLoad === true) { + autoLoad = {}; + } + me.load(autoLoad); + } + }, + + /** + * Set an {Ext.Element} as the target of this loader. Note that if the target is changed, + * any active requests will be aborted. + * @param {Mixed} target The element + */ + setTarget: function(target){ + var me = this; + target = Ext.get(target); + if (me.target && me.target != target) { + me.abort(); + } + me.target = target; + }, + + /** + * Get the target of this loader. + * @return {Ext.Component} target The target, null if none exists. + */ + getTarget: function(){ + return this.target || null; + }, + + /** + * Aborts the active load request + */ + abort: function(){ + var active = this.active; + if (active !== undefined) { + Ext.Ajax.abort(active.request); + if (active.mask) { + this.removeMask(); + } + delete this.active; + } + }, + + /** + * Remove the mask on the target + * @private + */ + removeMask: function(){ + this.target.unmask(); + }, + + /** + * Add the mask on the target + * @private + * @param {Mixed} mask The mask configuration + */ + addMask: function(mask){ + this.target.mask(mask === true ? null : mask); + }, + + /** + * Load new data from the server. + * @param {Object} options The options for the request. They can be any configuration option that can be specified for + * the class, with the exception of the target option. Note that any options passed to the method will override any + * class defaults. + */ + load: function(options) { + if (!this.target) { + Ext.Error.raise('A valid target is required when loading content'); + } + + options = Ext.apply({}, options); + + var me = this, + target = me.target, + mask = Ext.isDefined(options.loadMask) ? options.loadMask : me.loadMask, + params = Ext.apply({}, options.params), + ajaxOptions = Ext.apply({}, options.ajaxOptions), + callback = options.callback || me.callback, + scope = options.scope || me.scope || me, + request; + + Ext.applyIf(ajaxOptions, me.ajaxOptions); + Ext.applyIf(options, ajaxOptions); + + Ext.applyIf(params, me.params); + Ext.apply(params, me.baseParams); + + Ext.applyIf(options, { + url: me.url + }); + + if (!options.url) { + Ext.Error.raise('You must specify the URL from which content should be loaded'); + } + + Ext.apply(options, { + scope: me, + params: params, + callback: me.onComplete + }); + + if (me.fireEvent('beforeload', me, options) === false) { + return; + } + + if (mask) { + me.addMask(mask); + } + + request = Ext.Ajax.request(options); + me.active = { + request: request, + options: options, + mask: mask, + scope: scope, + callback: callback, + success: options.success || me.success, + failure: options.failure || me.failure, + renderer: options.renderer || me.renderer, + scripts: Ext.isDefined(options.scripts) ? options.scripts : me.scripts + }; + me.setOptions(me.active, options); + }, + + /** + * Set any additional options on the active request + * @private + * @param {Object} active The active request + * @param {Object} options The initial options + */ + setOptions: Ext.emptyFn, + + /** + * Parse the response after the request completes + * @private + * @param {Object} options Ajax options + * @param {Boolean} success Success status of the request + * @param {Object} response The response object + */ + onComplete: function(options, success, response) { + var me = this, + active = me.active, + scope = active.scope, + renderer = me.getRenderer(active.renderer); + + + if (success) { + success = renderer.call(me, me, response, active); + } + + if (success) { + Ext.callback(active.success, scope, [me, response, options]); + me.fireEvent('load', me, response, options); + } else { + Ext.callback(active.failure, scope, [me, response, options]); + me.fireEvent('exception', me, response, options); + } + Ext.callback(active.callback, scope, [me, success, response, options]); + + if (active.mask) { + me.removeMask(); + } + + delete me.active; + }, + + /** + * Gets the renderer to use + * @private + * @param {String/Function} renderer The renderer to use + * @return {Function} A rendering function to use. + */ + getRenderer: function(renderer){ + if (Ext.isFunction(renderer)) { + return renderer; + } + return this.statics().Renderer.Html; + }, + + /** + * Automatically refreshes the content over a specified period. + * @param {Number} interval The interval to refresh in ms. + * @param {Object} options (optional) The options to pass to the load method. See {@link #load} + */ + startAutoRefresh: function(interval, options){ + var me = this; + me.stopAutoRefresh(); + me.autoRefresh = setInterval(function(){ + me.load(options); + }, interval); + }, + + /** + * Clears any auto refresh. See {@link #startAutoRefresh}. + */ + stopAutoRefresh: function(){ + clearInterval(this.autoRefresh); + delete this.autoRefresh; + }, + + /** + * Checks whether the loader is automatically refreshing. See {@link #startAutoRefresh}. + * @return {Boolean} True if the loader is automatically refreshing + */ + isAutoRefreshing: function(){ + return Ext.isDefined(this.autoRefresh); + }, + + /** + * Destroys the loader. Any active requests will be aborted. + */ + destroy: function(){ + var me = this; + me.stopAutoRefresh(); + delete me.target; + me.abort(); + me.clearListeners(); + } +}); + +/** + * @class Ext.layout.Layout + * @extends Object + * @private + * Base Layout class - extended by ComponentLayout and ContainerLayout + */ + +Ext.define('Ext.layout.Layout', { + + /* Begin Definitions */ + + /* End Definitions */ + + isLayout: true, + initialized: false, + + statics: { + create: function(layout, defaultType) { + var type; + if (layout instanceof Ext.layout.Layout) { + return Ext.createByAlias('layout.' + layout); + } else { + if (Ext.isObject(layout)) { + type = layout.type; + } + else { + type = layout || defaultType; + layout = {}; + } + return Ext.createByAlias('layout.' + type, layout || {}); + } + } + }, + + constructor : function(config) { + this.id = Ext.id(null, this.type + '-'); + Ext.apply(this, config); + }, + + /** + * @private + */ + layout : function() { + var me = this; + me.layoutBusy = true; + me.initLayout(); + + if (me.beforeLayout.apply(me, arguments) !== false) { + me.layoutCancelled = false; + me.onLayout.apply(me, arguments); + me.childrenChanged = false; + me.owner.needsLayout = false; + me.layoutBusy = false; + me.afterLayout.apply(me, arguments); + } + else { + me.layoutCancelled = true; + } + me.layoutBusy = false; + me.doOwnerCtLayouts(); + }, + + beforeLayout : function() { + this.renderItems(this.getLayoutItems(), this.getRenderTarget()); + return true; + }, + + /** + * @private + * Iterates over all passed items, ensuring they are rendered. If the items are already rendered, + * also determines if the items are in the proper place dom. + */ + renderItems : function(items, target) { + var ln = items.length, + i = 0, + item; + + for (; i < ln; i++) { + item = items[i]; + if (item && !item.rendered) { + this.renderItem(item, target, i); + } + else if (!this.isValidParent(item, target, i)) { + this.moveItem(item, target, i); + } + } + }, + + // @private - Validates item is in the proper place in the dom. + isValidParent : function(item, target, position) { + var dom = item.el ? item.el.dom : Ext.getDom(item); + if (dom && target && target.dom) { + if (Ext.isNumber(position) && dom !== target.dom.childNodes[position]) { + return false; + } + return (dom.parentNode == (target.dom || target)); + } + return false; + }, + + /** + * @private + * Renders the given Component into the target Element. + * @param {Ext.Component} item The Component to render + * @param {Ext.core.Element} target The target Element + * @param {Number} position The position within the target to render the item to + */ + renderItem : function(item, target, position) { + if (!item.rendered) { + item.render(target, position); + this.configureItem(item); + this.childrenChanged = true; + } + }, + + /** + * @private + * Moved Component to the provided target instead. + */ + moveItem : function(item, target, position) { + // Make sure target is a dom element + target = target.dom || target; + if (typeof position == 'number') { + position = target.childNodes[position]; + } + target.insertBefore(item.el.dom, position || null); + item.container = Ext.get(target); + this.configureItem(item); + this.childrenChanged = true; + }, + + /** + * @private + * Adds the layout's targetCls if necessary and sets + * initialized flag when complete. + */ + initLayout : function() { + if (!this.initialized && !Ext.isEmpty(this.targetCls)) { + this.getTarget().addCls(this.targetCls); + } + this.initialized = true; + }, + + // @private Sets the layout owner + setOwner : function(owner) { + this.owner = owner; + }, + + // @private - Returns empty array + getLayoutItems : function() { + return []; + }, + + /** + * @private + * Applies itemCls + */ + configureItem: function(item) { + var me = this, + el = item.el, + owner = me.owner; + + if (me.itemCls) { + el.addCls(me.itemCls); + } + if (owner.itemCls) { + el.addCls(owner.itemCls); + } + }, + + // Placeholder empty functions for subclasses to extend + onLayout : Ext.emptyFn, + afterLayout : Ext.emptyFn, + onRemove : Ext.emptyFn, + onDestroy : Ext.emptyFn, + doOwnerCtLayouts : Ext.emptyFn, + + /** + * @private + * Removes itemCls + */ + afterRemove : function(item) { + var me = this, + el = item.el, + owner = me.owner; + + if (item.rendered) { + if (me.itemCls) { + el.removeCls(me.itemCls); + } + if (owner.itemCls) { + el.removeCls(owner.itemCls); + } + } + }, + + /* + * Destroys this layout. This is a template method that is empty by default, but should be implemented + * by subclasses that require explicit destruction to purge event handlers or remove DOM nodes. + * @protected + */ + destroy : function() { + if (!Ext.isEmpty(this.targetCls)) { + var target = this.getTarget(); + if (target) { + target.removeCls(this.targetCls); + } + } + this.onDestroy(); + } +}); +/** + * @class Ext.layout.component.Component + * @extends Ext.layout.Layout + * @private + *

This class is intended to be extended or created via the {@link Ext.Component#componentLayout layout} + * configuration property. See {@link Ext.Component#componentLayout} for additional details.

+ */ + +Ext.define('Ext.layout.component.Component', { + + /* Begin Definitions */ + + extend: 'Ext.layout.Layout', + + /* End Definitions */ + + type: 'component', + + monitorChildren: true, + + initLayout : function() { + var me = this, + owner = me.owner, + ownerEl = owner.el; + + if (!me.initialized) { + if (owner.frameSize) { + me.frameSize = owner.frameSize; + } + else { + owner.frameSize = me.frameSize = { + top: 0, + left: 0, + bottom: 0, + right: 0 + }; + } + } + me.callParent(arguments); + }, + + beforeLayout : function(width, height, isSetSize, layoutOwner) { + this.callParent(arguments); + + var me = this, + owner = me.owner, + ownerCt = owner.ownerCt, + layout = owner.layout, + isVisible = owner.isVisible(true), + ownerElChild = owner.el.child, + layoutCollection; + + /* + * Do not layout calculatedSized components for fixedLayouts unless the ownerCt == layoutOwner + * fixedLayouts means layouts which are never auto/auto in the sizing that comes from their ownerCt. + * Currently 3 layouts MAY be auto/auto (Auto, Border, and Box) + * The reason for not allowing component layouts is to stop component layouts from things such as Updater and + * form Validation. + */ + if (!isSetSize && !(Ext.isNumber(width) && Ext.isNumber(height)) && ownerCt && ownerCt.layout && ownerCt.layout.fixedLayout && ownerCt != layoutOwner) { + me.doContainerLayout(); + return false; + } + + // If an ownerCt is hidden, add my reference onto the layoutOnShow stack. Set the needsLayout flag. + // If the owner itself is a directly hidden floater, set the needsLayout object on that for when it is shown. + if (!isVisible && (owner.hiddenAncestor || owner.floating)) { + if (owner.hiddenAncestor) { + layoutCollection = owner.hiddenAncestor.layoutOnShow; + layoutCollection.remove(owner); + layoutCollection.add(owner); + } + owner.needsLayout = { + width: width, + height: height, + isSetSize: false + }; + } + + if (isVisible && this.needsLayout(width, height)) { + me.rawWidth = width; + me.rawHeight = height; + return owner.beforeComponentLayout(width, height, isSetSize, layoutOwner); + } + else { + return false; + } + }, + + /** + * Check if the new size is different from the current size and only + * trigger a layout if it is necessary. + * @param {Mixed} width The new width to set. + * @param {Mixed} height The new height to set. + */ + needsLayout : function(width, height) { + this.lastComponentSize = this.lastComponentSize || { + width: -Infinity, + height: -Infinity + }; + return (this.childrenChanged || this.lastComponentSize.width !== width || this.lastComponentSize.height !== height); + }, + + /** + * Set the size of any element supporting undefined, null, and values. + * @param {Mixed} width The new width to set. + * @param {Mixed} height The new height to set. + */ + setElementSize: function(el, width, height) { + if (width !== undefined && height !== undefined) { + el.setSize(width, height); + } + else if (height !== undefined) { + el.setHeight(height); + } + else if (width !== undefined) { + el.setWidth(width); + } + }, + + /** + * Returns the owner component's resize element. + * @return {Ext.core.Element} + */ + getTarget : function() { + return this.owner.el; + }, + + /** + *

Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.

+ * May be overridden in Component layout managers which implement an inner element. + * @return {Ext.core.Element} + */ + getRenderTarget : function() { + return this.owner.el; + }, + + /** + * Set the size of the target element. + * @param {Mixed} width The new width to set. + * @param {Mixed} height The new height to set. + */ + setTargetSize : function(width, height) { + var me = this; + me.setElementSize(me.owner.el, width, height); + + if (me.owner.frameBody) { + var targetInfo = me.getTargetInfo(), + padding = targetInfo.padding, + border = targetInfo.border, + frameSize = me.frameSize; + + me.setElementSize(me.owner.frameBody, + Ext.isNumber(width) ? (width - frameSize.left - frameSize.right - padding.left - padding.right - border.left - border.right) : width, + Ext.isNumber(height) ? (height - frameSize.top - frameSize.bottom - padding.top - padding.bottom - border.top - border.bottom) : height + ); + } + + me.autoSized = { + width: !Ext.isNumber(width), + height: !Ext.isNumber(height) + }; + + me.lastComponentSize = { + width: width, + height: height + }; + }, + + getTargetInfo : function() { + if (!this.targetInfo) { + var target = this.getTarget(), + body = this.owner.getTargetEl(); + + this.targetInfo = { + padding: { + top: target.getPadding('t'), + right: target.getPadding('r'), + bottom: target.getPadding('b'), + left: target.getPadding('l') + }, + border: { + top: target.getBorderWidth('t'), + right: target.getBorderWidth('r'), + bottom: target.getBorderWidth('b'), + left: target.getBorderWidth('l') + }, + bodyMargin: { + top: body.getMargin('t'), + right: body.getMargin('r'), + bottom: body.getMargin('b'), + left: body.getMargin('l') + } + }; + } + return this.targetInfo; + }, + + // Start laying out UP the ownerCt's layout when flagged to do so. + doOwnerCtLayouts: function() { + var owner = this.owner, + ownerCt = owner.ownerCt, + ownerCtComponentLayout, ownerCtContainerLayout; + + if (!ownerCt) { + return; + } + + ownerCtComponentLayout = ownerCt.componentLayout; + ownerCtContainerLayout = ownerCt.layout; + + if (!owner.floating && ownerCtComponentLayout && ownerCtComponentLayout.monitorChildren && !ownerCtComponentLayout.layoutBusy) { + if (!ownerCt.suspendLayout && ownerCtContainerLayout && !ownerCtContainerLayout.layoutBusy) { + // AutoContainer Layout and Dock with auto in some dimension + if (ownerCtContainerLayout.bindToOwnerCtComponent === true) { + ownerCt.doComponentLayout(); + } + // Box Layouts + else if (ownerCtContainerLayout.bindToOwnerCtContainer === true) { + ownerCtContainerLayout.layout(); + } + } + } + }, + + doContainerLayout: function() { + var me = this, + owner = me.owner, + ownerCt = owner.ownerCt, + layout = owner.layout, + ownerCtComponentLayout; + + // Run the container layout if it exists (layout for child items) + // **Unless automatic laying out is suspended, or the layout is currently running** + if (!owner.suspendLayout && layout && layout.isLayout && !layout.layoutBusy) { + layout.layout(); + } + + // Tell the ownerCt that it's child has changed and can be re-layed by ignoring the lastComponentSize cache. + if (ownerCt && ownerCt.componentLayout) { + ownerCtComponentLayout = ownerCt.componentLayout; + if (!owner.floating && ownerCtComponentLayout.monitorChildren && !ownerCtComponentLayout.layoutBusy) { + ownerCtComponentLayout.childrenChanged = true; + } + } + }, + + afterLayout : function(width, height, isSetSize, layoutOwner) { + this.doContainerLayout(); + this.owner.afterComponentLayout(width, height, isSetSize, layoutOwner); + } +}); + +/** + * @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();
+}
+

+ * This class passes on calls from components to the underlying {@link Ext.state.Provider} so that + * there is a common interface that can be used without needing to refer to a specific provider instance + * in every component. + * @singleton + * @docauthor Evan Trimboli + */ +Ext.define('Ext.state.Manager', { + singleton: true, + requires: ['Ext.state.Provider'], + constructor: function() { + this.provider = Ext.create('Ext.state.Provider'); + }, + + + /** + * Configures the default state provider for your application + * @param {Provider} stateProvider The state provider to set + */ + setProvider : function(stateProvider){ + this.provider = stateProvider; + }, + + /** + * Returns the current value for a key + * @param {String} name The key name + * @param {Mixed} defaultValue The default value to return if the key lookup does not match + * @return {Mixed} The state data + */ + get : function(key, defaultValue){ + return this.provider.get(key, defaultValue); + }, + + /** + * Sets the value for a key + * @param {String} name The key name + * @param {Mixed} value The state data + */ + set : function(key, value){ + this.provider.set(key, value); + }, + + /** + * Clears a value from the state + * @param {String} name The key name + */ + clear : function(key){ + this.provider.clear(key); + }, + + /** + * Gets the currently configured state provider + * @return {Provider} The state provider + */ + getProvider : function(){ + return this.provider; + } +}); +/** + * @class Ext.state.Stateful + * A mixin for being able to save the state of an object to an underlying + * {@link Ext.state.Provider}. + */ +Ext.define('Ext.state.Stateful', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: ['Ext.state.Manager'], + + /* End Definitions */ + + /** + * @cfg {Boolean} stateful + *

A flag which causes the object to attempt to restore the state of + * internal properties from a saved state on startup. The object must have + * a {@link #stateId} for state to be managed. + * Auto-generated ids are not guaranteed to be stable across page loads and + * cannot be relied upon to save and restore the same state for a object.

+ *

For state saving to work, the state manager's provider must have been + * set to an implementation of {@link Ext.state.Provider} which overrides the + * {@link Ext.state.Provider#set set} and {@link Ext.state.Provider#get get} + * methods to save and recall name/value pairs. A built-in implementation, + * {@link Ext.state.CookieProvider} is available.

+ *

To set the state provider for the current page:

+ *


+Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
+    expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
+}));
+     *

+ *

A stateful object attempts to save state when one of the events + * listed in the {@link #stateEvents} configuration fires.

+ *

To save state, a stateful object first serializes its state by + * calling {@link #getState}. By default, this function does + * nothing. The developer must provide an implementation which returns an + * object hash which represents the restorable state of the object.

+ *

The value yielded by getState is passed to {@link Ext.state.Manager#set} + * which uses the configured {@link Ext.state.Provider} to save the object + * keyed by the {@link stateId}

. + *

During construction, a stateful object attempts to restore + * its state by calling {@link Ext.state.Manager#get} passing the + * {@link #stateId}

+ *

The resulting object is passed to {@link #applyState}. + * The default implementation of {@link #applyState} simply copies + * properties into the object, but a developer may override this to support + * more behaviour.

+ *

You can perform extra processing on state save and restore by attaching + * handlers to the {@link #beforestaterestore}, {@link #staterestore}, + * {@link #beforestatesave} and {@link #statesave} events.

+ */ + stateful: true, + + /** + * @cfg {String} stateId + * The unique id for this object to use for state management purposes. + *

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

+ */ + + /** + * @cfg {Array} stateEvents + *

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

+ *

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

+ */ + + /** + * @cfg {Number} saveBuffer A buffer to be applied if many state events are fired within + * a short period. Defaults to 100. + */ + saveDelay: 100, + + autoGenIdRe: /^((\w+-)|(ext-comp-))\d{4,}$/i, + + constructor: function(config) { + var me = this; + + config = config || {}; + if (Ext.isDefined(config.stateful)) { + me.stateful = config.stateful; + } + if (Ext.isDefined(config.saveDelay)) { + me.saveDelay = config.saveDelay; + } + me.stateId = config.stateId; + + if (!me.stateEvents) { + me.stateEvents = []; + } + if (config.stateEvents) { + me.stateEvents.concat(config.stateEvents); + } + this.addEvents( + /** + * @event beforestaterestore + * Fires before the state of the object is restored. Return false from an event handler to stop the restore. + * @param {Ext.state.Stateful} this + * @param {Object} state The hash of state values returned from the StateProvider. If this + * event is not vetoed, then the state object is passed to applyState. By default, + * that simply copies property values into this object. The method maybe overriden to + * provide custom state restoration. + */ + 'beforestaterestore', + + /** + * @event staterestore + * Fires after the state of the object is restored. + * @param {Ext.state.Stateful} this + * @param {Object} state The hash of state values returned from the StateProvider. This is passed + * to applyState. By default, that simply copies property values into this + * object. The method maybe overriden to provide custom state restoration. + */ + 'staterestore', + + /** + * @event beforestatesave + * Fires before the state of the object is saved to the configured state provider. Return false to stop the save. + * @param {Ext.state.Stateful} this + * @param {Object} state The hash of state values. This is determined by calling + * getState() on the object. This method must be provided by the + * developer to return whetever representation of state is required, by default, Ext.state.Stateful + * has a null implementation. + */ + 'beforestatesave', + + /** + * @event statesave + * Fires after the state of the object is saved to the configured state provider. + * @param {Ext.state.Stateful} this + * @param {Object} state The hash of state values. This is determined by calling + * getState() on the object. This method must be provided by the + * developer to return whetever representation of state is required, by default, Ext.state.Stateful + * has a null implementation. + */ + 'statesave' + ); + me.mixins.observable.constructor.call(me); + if (me.stateful !== false) { + me.initStateEvents(); + me.initState(); + } + }, + + /** + * Initializes any state events for this object. + * @private + */ + initStateEvents: function() { + this.addStateEvents(this.stateEvents); + }, + + /** + * Add events that will trigger the state to be saved. + * @param {String/Array} events The event name or an array of event names. + */ + addStateEvents: function(events){ + if (!Ext.isArray(events)) { + events = [events]; + } + + var me = this, + i = 0, + len = events.length; + + for (; i < len; ++i) { + me.on(events[i], me.onStateChange, me); + } + }, + + /** + * This method is called when any of the {@link #stateEvents} are fired. + * @private + */ + onStateChange: function(){ + var me = this, + delay = me.saveDelay; + + if (delay > 0) { + if (!me.stateTask) { + me.stateTask = Ext.create('Ext.util.DelayedTask', me.saveState, me); + } + me.stateTask.delay(me.saveDelay); + } else { + me.saveState(); + } + }, + + /** + * Saves the state of the object to the persistence store. + * @private + */ + saveState: function() { + var me = this, + id, + state; + + if (me.stateful !== false) { + id = me.getStateId(); + if (id) { + state = me.getState(); + if (me.fireEvent('beforestatesave', me, state) !== false) { + Ext.state.Manager.set(id, state); + me.fireEvent('statesave', me, state); + } + } + } + }, + + /** + * Gets the current state of the object. By default this function returns null, + * it should be overridden in subclasses to implement methods for getting the state. + * @return {Object} The current state + */ + getState: function(){ + return null; + }, + + /** + * Applies the state to the object. This should be overridden in subclasses to do + * more complex state operations. By default it applies the state properties onto + * the current object. + * @param {Object} state The state + */ + applyState: function(state) { + if (state) { + Ext.apply(this, state); + } + }, + + /** + * Gets the state id for this object. + * @return {String} The state id, null if not found. + */ + getStateId: function() { + var me = this, + id = me.stateId; + + if (!id) { + id = me.autoGenIdRe.test(String(me.id)) ? null : me.id; + } + return id; + }, + + /** + * Initializes the state of the object upon construction. + * @private + */ + initState: function(){ + var me = this, + id = me.getStateId(), + state; + + if (me.stateful !== false) { + if (id) { + state = Ext.state.Manager.get(id); + if (state) { + state = Ext.apply({}, state); + if (me.fireEvent('beforestaterestore', me, state) !== false) { + me.applyState(state); + me.fireEvent('staterestore', me, state); + } + } + } + } + }, + + /** + * Destroys this stateful object. + */ + destroy: function(){ + var task = this.stateTask; + if (task) { + task.cancel(); + } + this.clearListeners(); + + } + +}); + +/** + * @class Ext.AbstractManager + * @extends Object + * @ignore + * Base Manager class + */ + +Ext.define('Ext.AbstractManager', { + + /* Begin Definitions */ + + requires: ['Ext.util.HashMap'], + + /* End Definitions */ + + typeName: 'type', + + constructor: function(config) { + Ext.apply(this, config || {}); + + /** + * Contains all of the items currently managed + * @property all + * @type Ext.util.MixedCollection + */ + this.all = Ext.create('Ext.util.HashMap'); + + this.types = {}; + }, + + /** + * Returns an item by id. + * For additional details see {@link Ext.util.HashMap#get}. + * @param {String} id The id of the item + * @return {Mixed} The item, undefined if not found. + */ + get : function(id) { + return this.all.get(id); + }, + + /** + * Registers an item to be managed + * @param {Mixed} item The item to register + */ + register: function(item) { + this.all.add(item); + }, + + /** + * Unregisters an item by removing it from this manager + * @param {Mixed} item The item to unregister + */ + unregister: function(item) { + this.all.remove(item); + }, + + /** + *

Registers a new item constructor, keyed by a type key. + * @param {String} type The mnemonic string by which the class may be looked up. + * @param {Constructor} cls The new instance class. + */ + registerType : function(type, cls) { + this.types[type] = cls; + cls[this.typeName] = type; + }, + + /** + * Checks if an item type is registered. + * @param {String} type The mnemonic string by which the class may be looked up + * @return {Boolean} Whether the type is registered. + */ + isRegistered : function(type){ + return this.types[type] !== undefined; + }, + + /** + * Creates and returns an instance of whatever this manager manages, based on the supplied type and config object + * @param {Object} config The config object + * @param {String} defaultType If no type is discovered in the config object, we fall back to this type + * @return {Mixed} The instance of whatever this manager is managing + */ + create: function(config, defaultType) { + var type = config[this.typeName] || config.type || defaultType, + Constructor = this.types[type]; + + if (Constructor == undefined) { + Ext.Error.raise("The '" + type + "' type has not been registered with this manager"); + } + + return new Constructor(config); + }, + + /** + * Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation. + * @param {String} id The item id + * @param {Function} fn The callback function. Called with a single parameter, the item. + * @param {Object} scope The scope (this reference) in which the callback is executed. Defaults to the item. + */ + onAvailable : function(id, fn, scope){ + var all = this.all, + item; + + if (all.containsKey(id)) { + item = all.get(id); + fn.call(scope || item, item); + } else { + all.on('add', function(map, key, item){ + if (key == id) { + fn.call(scope || item, item); + all.un('add', fn, scope); + } + }); + } + }, + + /** + * Executes the specified function once for each item in the collection. + * Returning false from the function will cease iteration. + * + * The paramaters passed to the function are: + *

key : String
The key of the item
value : Number
The value of the item
length : Number
The total number of items in the collection

+ * @param {Object} fn The function to execute. + * @param {Object} scope The scope to execute in. Defaults to this. + */ + each: function(fn, scope){ + this.all.each(fn, scope || this); + }, + + /** + * Gets the number of items in the collection. + * @return {Number} The number of items in the collection. + */ + getCount: function(){ + return this.all.getCount(); + } +}); + +/** + * @class Ext.PluginManager + * @extends Ext.AbstractManager + *

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

+ *

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

+ *

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

+ * @singleton + */ +Ext.define('Ext.PluginManager', { + extend: 'Ext.AbstractManager', + alternateClassName: 'Ext.PluginMgr', + singleton: true, + typeName: 'ptype', + + /** + * Creates a new Plugin from the specified config object using the + * config object's ptype to determine the class to instantiate. + * @param {Object} config A configuration object for the Plugin you wish to create. + * @param {Constructor} defaultType The constructor to provide the default Plugin type if + * the config object does not contain a ptype. (Optional if the config contains a ptype). + * @return {Ext.Component} The newly instantiated Plugin. + */ + //create: function(plugin, defaultType) { + // if (plugin instanceof this) { + // return plugin; + // } else { + // var type, config = {}; + // + // if (Ext.isString(plugin)) { + // type = plugin; + // } + // else { + // type = plugin[this.typeName] || defaultType; + // config = plugin; + // } + // + // return Ext.createByAlias('plugin.' + type, config); + // } + //}, + + create : function(config, defaultType){ + if (config.init) { + return config; + } else { + return Ext.createByAlias('plugin.' + (config.ptype || defaultType), config); + } + + // Prior system supported Singleton plugins. + //var PluginCls = this.types[config.ptype || defaultType]; + //if (PluginCls.init) { + // return PluginCls; + //} else { + // return new PluginCls(config); + //} + }, + + /** + * Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype. + * @param {String} type The type to search for + * @param {Boolean} defaultsOnly True to only return plugins of this type where the plugin's isDefault property is truthy + * @return {Array} All matching plugins + */ + findByType: function(type, defaultsOnly) { + var matches = [], + types = this.types; + + for (var name in types) { + if (!types.hasOwnProperty(name)) { + continue; + } + var item = types[name]; + + if (item.type == type && (!defaultsOnly || (defaultsOnly === true && item.isDefault))) { + matches.push(item); + } + } + + return matches; + } +}, function() { + /** + * Shorthand for {@link Ext.PluginManager#registerType} + * @param {String} ptype The ptype mnemonic string by which the Plugin class + * may be looked up. + * @param {Constructor} cls The new Plugin class. + * @member Ext + * @method preg + */ + Ext.preg = function() { + return Ext.PluginManager.registerType.apply(Ext.PluginManager, arguments); + }; +}); + +/** + * @class Ext.ComponentManager + * @extends Ext.AbstractManager + *

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

+ *

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

+ *

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

+ * @singleton + */ +Ext.define('Ext.ComponentManager', { + extend: 'Ext.AbstractManager', + alternateClassName: 'Ext.ComponentMgr', + + singleton: true, + + typeName: 'xtype', + + /** + * Creates a new Component from the specified config object using the + * config object's xtype to determine the class to instantiate. + * @param {Object} config A configuration object for the Component you wish to create. + * @param {Constructor} defaultType The constructor to provide the default Component type if + * the config object does not contain a xtype. (Optional if the config contains a xtype). + * @return {Ext.Component} The newly instantiated Component. + */ + create: function(component, defaultType){ + if (component instanceof Ext.AbstractComponent) { + return component; + } + else if (Ext.isString(component)) { + return Ext.createByAlias('widget.' + component); + } + else { + var type = component.xtype || defaultType, + config = component; + + return Ext.createByAlias('widget.' + type, config); + } + }, + + registerType: function(type, cls) { + this.types[type] = cls; + cls[this.typeName] = type; + cls.prototype[this.typeName] = type; + } +}); +/** + * @class Ext.XTemplate + * @extends Ext.Template + *

A template class that supports advanced functionality like:

Autofilling arrays using templates and sub-templates
Conditional processing with basic comparison operators
Basic math function support
Execute arbitrary inline code with special built-in template variables
Custom member functions
Many special tags and built-in operators that aren't defined as part of + * the API, but are supported in the templates that can be created

+ *

XTemplate provides the templating mechanism built into:

{@link Ext.view.View}

+ * + * The {@link Ext.Template} describes + * the acceptable parameters to pass to the constructor. The following + * examples demonstrate all of the supported features.

+ * + *

Sample Data + *

+ *

This is the data object used for reference in each code example:

+ *


+var data = {
+name: 'Tommy Maintz',
+title: 'Lead Developer',
+company: 'Sencha Inc.',
+email: 'tommy@sencha.com',
+address: '5 Cups Drive',
+city: 'Palo Alto',
+state: 'CA',
+zip: '44102',
+drinks: ['Coffee', 'Soda', 'Water'],
+kids: [{
+        name: 'Joshua',
+        age:3
+    },{
+        name: 'Matthew',
+        age:2
+    },{
+        name: 'Solomon',
+        age:0
+}]
+};
+

+ *

Auto filling of arrays + *

+ *

The tpl tag and the for operator are used + * to process the provided data object: + *

If the value specified in for is an array, it will auto-fill, + * repeating the template block inside the tpl tag for each item in the + * array.
If for="." is specified, the data object provided is examined.
While processing an array, the special variable {#} + * will provide the current array index + 1 (starts at 1, not 0).

+ *


+<tpl for=".">...</tpl>       // loop through array at root node
+<tpl for="foo">...</tpl>     // loop through array at foo node
+<tpl for="foo.bar">...</tpl> // loop through array at foo.bar node
+

+ * Using the sample data above: + *


+var tpl = new Ext.XTemplate(
+    '<p>Kids: ',
+    '<tpl for=".">',       // process the data.kids node
+        '<p>{#}. {name}</p>',  // use current array index to autonumber
+    '</tpl></p>'
+);
+tpl.overwrite(panel.body, data.kids); // pass the kids property of the data object
+

+ *

An example illustrating how the for property can be leveraged + * to access specified members of the provided data object to populate the template:

+ *


+var tpl = new Ext.XTemplate(
+    '<p>Name: {name}</p>',
+    '<p>Title: {title}</p>',
+    '<p>Company: {company}</p>',
+    '<p>Kids: ',
+    '<tpl for="kids">',     // interrogate the kids property within the data
+        '<p>{name}</p>',
+    '</tpl></p>'
+);
+tpl.overwrite(panel.body, data);  // pass the root node of the data object
+

+ *

Flat arrays that contain values (and not objects) can be auto-rendered + * using the special {.} variable inside a loop. This variable + * will represent the value of the array at the current index:

+ *


+var tpl = new Ext.XTemplate(
+    '<p>{name}\'s favorite beverages:</p>',
+    '<tpl for="drinks">',
+        '<div> - {.}</div>',
+    '</tpl>'
+);
+tpl.overwrite(panel.body, data);
+

+ *

When processing a sub-template, for example while looping through a child array, + * you can access the parent object's members via the parent object:

+ *


+var tpl = new Ext.XTemplate(
+    '<p>Name: {name}</p>',
+    '<p>Kids: ',
+    '<tpl for="kids">',
+        '<tpl if="age &gt; 1">',
+            '<p>{name}</p>',
+            '<p>Dad: {parent.name}</p>',
+        '</tpl>',
+    '</tpl></p>'
+);
+tpl.overwrite(panel.body, data);
+

+ *

Conditional processing with basic comparison operators + *

+ *

The tpl tag and the if operator are used + * to provide conditional checks for deciding whether or not to render specific + * parts of the template. Notes:

Double quotes must be encoded if used within the conditional
There is no else operator — if needed, two opposite + * if statements should be used.

+ *


+<tpl if="age > 1 && age < 10">Child</tpl>
+<tpl if="age >= 10 && age < 18">Teenager</tpl>
+<tpl if="this.isGirl(name)">...</tpl>
+<tpl if="id==\'download\'">...</tpl>
+<tpl if="needsIcon"><img src="{icon}" class="{iconCls}"/></tpl>
+// no good:
+<tpl if="name == "Tommy"">Hello</tpl>
+// encode " if it is part of the condition, e.g.
+<tpl if="name == &quot;Tommy&quot;">Hello</tpl>
+ *

+ * Using the sample data above: + *


+var tpl = new Ext.XTemplate(
+    '<p>Name: {name}</p>',
+    '<p>Kids: ',
+    '<tpl for="kids">',
+        '<tpl if="age &gt; 1">',
+            '<p>{name}</p>',
+        '</tpl>',
+    '</tpl></p>'
+);
+tpl.overwrite(panel.body, data);
+

+ *

Basic math support + *

+ *

The following basic math operators may be applied directly on numeric + * data values:

+ * + - * /
+ *

+ * For example: + *


+var tpl = new Ext.XTemplate(
+    '<p>Name: {name}</p>',
+    '<p>Kids: ',
+    '<tpl for="kids">',
+        '<tpl if="age &gt; 1">',  // <-- Note that the > is encoded
+            '<p>{#}: {name}</p>',  // <-- Auto-number each item
+            '<p>In 5 Years: {age+5}</p>',  // <-- Basic math
+            '<p>Dad: {parent.name}</p>',
+        '</tpl>',
+    '</tpl></p>'
+);
+tpl.overwrite(panel.body, data);
+

+ *

Execute arbitrary inline code with special built-in template variables + *
+ *
Anything between {[ ... ]} is considered code to be executed + * in the scope of the template. There are some special variables available in that code: + *
- values: The values in the current scope. If you are using + * scope changing sub-templates, you can change what values is.
- parent: The scope (values) of the ancestor template.
- xindex: If you are in a looping template, the index of the + * loop you are in (1-based).
- xcount: If you are in a looping template, the total length + * of the array you are looping.
+ * This example demonstrates basic row striping using an inline code block and the + * xindex variable:
+ *
```
+var tpl = new Ext.XTemplate(
+    '<p>Name: {name}</p>',
+    '<p>Company: {[values.company.toUpperCase() + ", " + values.title]}</p>',
+    '<p>Kids: ',
+    '<tpl for="kids">',
+        '<div class="{[xindex % 2 === 0 ? "even" : "odd"]}">',
+        '{name}',
+        '</div>',
+    '</tpl></p>'
+ );
+tpl.overwrite(panel.body, data);
+ 
```
+ *
+ *

Template member functions + *

+ *

One or more member functions can be specified in a configuration + * object passed into the XTemplate constructor for more complex processing:

+ *


+var tpl = new Ext.XTemplate(
+    '<p>Name: {name}</p>',
+    '<p>Kids: ',
+    '<tpl for="kids">',
+        '<tpl if="this.isGirl(name)">',
+            '<p>Girl: {name} - {age}</p>',
+        '</tpl>',
+         // use opposite if statement to simulate 'else' processing:
+        '<tpl if="this.isGirl(name) == false">',
+            '<p>Boy: {name} - {age}</p>',
+        '</tpl>',
+        '<tpl if="this.isBaby(age)">',
+            '<p>{name} is a baby!</p>',
+        '</tpl>',
+    '</tpl></p>',
+    {
+        // XTemplate configuration:
+        compiled: true,
+        // member functions:
+        isGirl: function(name){
+           return name == 'Sara Grace';
+        },
+        isBaby: function(age){
+           return age < 1;
+        }
+    }
+);
+tpl.overwrite(panel.body, data);
+

+ *

+ * + * @param {Mixed} config + */ + +Ext.define('Ext.XTemplate', { + + /* Begin Definitions */ + + extend: 'Ext.Template', + + statics: { + /** + * 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 + * @return {Ext.Template} The created template + * @static + */ + from: function(el, config) { + el = Ext.getDom(el); + return new this(el.value || el.innerHTML, config || {}); + } + }, + + /* End Definitions */ + + argsRe: /]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/, + nameRe: /^]*?for="(.*?)"/, + ifRe: /^]*?if="(.*?)"/, + execRe: /^]*?exec="(.*?)"/, + constructor: function() { + this.callParent(arguments); + + var me = this, + html = me.html, + argsRe = me.argsRe, + nameRe = me.nameRe, + ifRe = me.ifRe, + execRe = me.execRe, + id = 0, + tpls = [], + VALUES = 'values', + PARENT = 'parent', + XINDEX = 'xindex', + XCOUNT = 'xcount', + RETURN = 'return ', + WITHVALUES = 'with(values){ ', + m, matchName, matchIf, matchExec, exp, fn, exec, name, i; + + html = ['', html, ''].join(''); + + while ((m = html.match(argsRe))) { + exp = null; + fn = null; + exec = null; + matchName = m[0].match(nameRe); + matchIf = m[0].match(ifRe); + matchExec = m[0].match(execRe); + + exp = matchIf ? matchIf[1] : null; + if (exp) { + fn = Ext.functionFactory(VALUES, PARENT, XINDEX, XCOUNT, WITHVALUES + 'try{' + RETURN + Ext.String.htmlDecode(exp) + ';}catch(e){return;}}'); + } + + exp = matchExec ? matchExec[1] : null; + if (exp) { + exec = Ext.functionFactory(VALUES, PARENT, XINDEX, XCOUNT, WITHVALUES + Ext.String.htmlDecode(exp) + ';}'); + } + + name = matchName ? matchName[1] : null; + if (name) { + if (name === '.') { + name = VALUES; + } else if (name === '..') { + name = PARENT; + } + name = Ext.functionFactory(VALUES, PARENT, 'try{' + WITHVALUES + RETURN + name + ';}}catch(e){return;}'); + } + + tpls.push({ + id: id, + target: name, + exec: exec, + test: fn, + body: m[1] || '' + }); + + html = html.replace(m[0], '{xtpl' + id + '}'); + id = id + 1; + } + + for (i = tpls.length - 1; i >= 0; --i) { + me.compileTpl(tpls[i]); + } + me.master = tpls[tpls.length - 1]; + me.tpls = tpls; + }, + + // @private + applySubTemplate: function(id, values, parent, xindex, xcount) { + var me = this, t = me.tpls[id]; + return t.compiled.call(me, values, parent, xindex, xcount); + }, + /** + * @cfg {RegExp} codeRe The regular expression used to match code variables (default: matches {[expression]}). + */ + codeRe: /\{\[((?:\\\]|.|\n)*?)\]\}/g, + + re: /\{([\w-\.\#]+)(?:\:([\w\.]*)(?:$(.*?)?$)?)?(\s?[\+\-\*\/]\s?[\d\.\+\-\*\/]+)?\}/g, + + // @private + compileTpl: function(tpl) { + var fm = Ext.util.Format, + me = this, + useFormat = me.disableFormats !== true, + body, bodyReturn, evaluatedFn; + + function fn(m, name, format, args, math) { + var v; + // name is what is inside the {} + // Name begins with xtpl, use a Sub Template + if (name.substr(0, 4) == 'xtpl') { + return "',this.applySubTemplate(" + name.substr(4) + ", values, parent, xindex, xcount),'"; + } + // name = "." - Just use the values object. + if (name == '.') { + // filter to not include arrays/objects/nulls + v = 'Ext.Array.indexOf(["string", "number", "boolean"], typeof values) > -1 || Ext.isDate(values) ? values : ""'; + } + + // name = "#" - Use the xindex + else if (name == '#') { + v = 'xindex'; + } + else if (name.substr(0, 7) == "parent.") { + v = name; + } + // name has a . in it - Use object literal notation, starting from values + else if (name.indexOf('.') != -1) { + v = "values." + name; + } + + // name is a property of values + else { + v = "values['" + name + "']"; + } + if (math) { + v = '(' + v + math + ')'; + } + if (format && useFormat) { + args = args ? ',' + args : ""; + if (format.substr(0, 5) != "this.") { + format = "fm." + format + '('; + } + else { + format = 'this.' + format.substr(5) + '('; + } + } + else { + args = ''; + format = "(" + v + " === undefined ? '' : "; + } + return "'," + format + v + args + "),'"; + } + + function codeFn(m, code) { + // Single quotes get escaped when the template is compiled, however we want to undo this when running code. + return "',(" + code.replace(me.compileARe, "'") + "),'"; + } + + bodyReturn = tpl.body.replace(me.compileBRe, '\\n').replace(me.compileCRe, "\\'").replace(me.re, fn).replace(me.codeRe, codeFn); + body = "evaluatedFn = function(values, parent, xindex, xcount){return ['" + bodyReturn + "'].join('');};"; + eval(body); + + tpl.compiled = function(values, parent, xindex, xcount) { + var vs, + length, + buffer, + i; + + if (tpl.test && !tpl.test.call(me, values, parent, xindex, xcount)) { + return ''; + } + + vs = tpl.target ? tpl.target.call(me, values, parent) : values; + if (!vs) { + return ''; + } + + parent = tpl.target ? values : parent; + if (tpl.target && Ext.isArray(vs)) { + buffer = []; + length = vs.length; + if (tpl.exec) { + for (i = 0; i < length; i++) { + buffer[buffer.length] = evaluatedFn.call(me, vs[i], parent, i + 1, length); + tpl.exec.call(me, vs[i], parent, i + 1, length); + } + } else { + for (i = 0; i < length; i++) { + buffer[buffer.length] = evaluatedFn.call(me, vs[i], parent, i + 1, length); + } + } + return buffer.join(''); + } + + if (tpl.exec) { + tpl.exec.call(me, vs, parent, xindex, xcount); + } + return evaluatedFn.call(me, vs, parent, xindex, xcount); + }; + + return this; + }, + + /** + * Returns an HTML fragment of this template with the specified values applied. + * @param {Object} 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 + */ + applyTemplate: function(values) { + return this.master.compiled.call(this, values, {}, 1, 1); + }, + + /** + * Compile the template to a function for optimized performance. Recommended if the template will be used frequently. + * @return {Function} The compiled function + */ + compile: function() { + return this; + } +}, function() { + /** + * 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 your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @return {String} The HTML fragment + * @member Ext.XTemplate + * @method apply + */ + this.createAlias('apply', 'applyTemplate'); +}); + +/** + * @class Ext.util.AbstractMixedCollection + */ +Ext.define('Ext.util.AbstractMixedCollection', { + requires: ['Ext.util.Filter'], + + mixins: { + observable: 'Ext.util.Observable' + }, + + constructor: function(allowFunctions, keyFn) { + var me = this; + + me.items = []; + me.map = {}; + me.keys = []; + me.length = 0; + + me.addEvents( + /** + * @event clear + * Fires when the collection is cleared. + */ + 'clear', + + /** + * @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. + */ + 'add', + + /** + * @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. + */ + 'replace', + + /** + * @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. + */ + 'remove' + ); + + me.allowFunctions = allowFunctions === true; + + if (keyFn) { + me.getKey = keyFn; + } + + me.mixins.observable.constructor.call(me); + }, + + /** + * @cfg {Boolean} allowFunctions Specify true if the {@link #addAll} + * function should add function references to the collection. Defaults to + * false. + */ + 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, obj){ + var me = this, + myObj = obj, + myKey = key, + old; + + if (arguments.length == 1) { + myObj = myKey; + myKey = me.getKey(myObj); + } + if (typeof myKey != 'undefined' && myKey !== null) { + old = me.map[myKey]; + if (typeof old != 'undefined') { + return me.replace(myKey, myObj); + } + me.map[myKey] = myObj; + } + me.length++; + me.items.push(myObj); + me.keys.push(myKey); + me.fireEvent('add', me.length - 1, myObj, myKey); + return myObj; + }, + + /** + * 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
+
+// using getKey
+var mc = new Ext.util.MixedCollection();
+mc.getKey = function(el){
+   return el.dom.id;
+};
+mc.add(someEl);
+mc.add(otherEl);
+
+// or via the constructor
+var mc = new Ext.util.MixedCollection(false, function(el){
+   return el.dom.id;
+});
+mc.add(someEl);
+mc.add(otherEl);
+     *

+ * @param {Object} item The item for which to find the key. + * @return {Object} The key for the passed item. + */ + getKey : function(o){ + return o.id; + }, + + /** + * 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){ + var me = this, + old, + index; + + if (arguments.length == 1) { + o = arguments[0]; + key = me.getKey(o); + } + old = me.map[key]; + if (typeof key == 'undefined' || key === null || typeof old == 'undefined') { + return me.add(key, o); + } + index = me.indexOfKey(key); + me.items[index] = o; + me.map[key] = o; + me.fireEvent('replace', key, old, o); + return o; + }, + + /** + * 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){ + var me = this, + i = 0, + args, + len, + key; + + if (arguments.length > 1 || Ext.isArray(objs)) { + args = arguments.length > 1 ? arguments : objs; + for (len = args.length; i < len; i++) { + me.add(args[i]); + } + } else { + for (key in objs) { + if (objs.hasOwnProperty(key)) { + if (me.allowFunctions || typeof objs[key] != 'function') { + me.add(key, objs[key]); + } + } + } + } + }, + + /** + * Executes the specified function once for every item in the collection, passing the following arguments: + *

item : Mixed
The collection item
index : Number
The item's index
length : Number
The total number of items in the collection

+ * The function should return a boolean value. Returning false from the function will stop the iteration. + * @param {Function} fn The function to execute for each item. + * @param {Object} scope (optional) The scope (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 + i = 0, + len = items.length, + item; + + for (; i < len; i++) { + item = items[i]; + if (fn.call(scope || item, item, i, len) === false) { + break; + } + } + }, + + /** + * Executes the specified function once for every key in the collection, passing each + * key, and its associated item as the first two parameters. + * @param {Function} fn The function to execute for each item. + * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to the browser window. + */ + eachKey : function(fn, scope){ + var keys = this.keys, + items = this.items, + i = 0, + len = keys.length; + + for (; i < len; i++) { + fn.call(scope || window, keys[i], items[i], i, len); + } + }, + + /** + * Returns the first item in the collection which elicits a true return value from the + * passed selection function. + * @param {Function} fn The selection function to execute for each item. + * @param {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. + */ + findBy : function(fn, scope) { + var keys = this.keys, + items = this.items, + i = 0, + len = items.length; + + for (; i < len; i++) { + if (fn.call(scope || window, items[i], keys[i])) { + return items[i]; + } + } + return null; + }, + + find : function() { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.util.MixedCollection: find has been deprecated. Use findBy instead.'); + } + return this.findBy.apply(this, arguments); + }, + + /** + * Inserts an item at the specified index in the collection. Fires the {@link #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, obj){ + var me = this, + myKey = key, + myObj = obj; + + if (arguments.length == 2) { + myObj = myKey; + myKey = me.getKey(myObj); + } + if (me.containsKey(myKey)) { + me.suspendEvents(); + me.removeAtKey(myKey); + me.resumeEvents(); + } + if (index >= me.length) { + return me.add(myKey, myObj); + } + me.length++; + me.items.splice(index, 0, myObj); + if (typeof myKey != 'undefined' && myKey !== null) { + me.map[myKey] = myObj; + } + me.keys.splice(index, 0, myKey); + me.fireEvent('add', index, myObj, myKey); + return myObj; + }, + + /** + * 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)); + }, + + /** + * Remove all items in the passed array from the collection. + * @param {Array} items An array of items to be removed. + * @return {Ext.util.MixedCollection} this object + */ + removeAll : function(items){ + Ext.each(items || [], function(item) { + this.remove(item); + }, this); + + return this; + }, + + /** + * 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){ + var me = this, + o, + key; + + if (index < me.length && index >= 0) { + me.length--; + o = me.items[index]; + me.items.splice(index, 1); + key = me.keys[index]; + if (typeof key != 'undefined') { + delete me.map[key]; + } + me.keys.splice(index, 1); + me.fireEvent('remove', o, key); + return o; + } + 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. + */ + removeAtKey : 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 Ext.Array.indexOf(this.items, 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 Ext.Array.indexOf(this.keys, 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 #getAt}. + * @param {String/Number} key The key or index of the item. + * @return {Object} If the item is found, returns the item. If the item was not found, returns undefined. + * If an item was found, but is a Class, returns null. + */ + get : function(key) { + var me = this, + mk = me.map[key], + item = mk !== undefined ? mk : (typeof key == 'number') ? me.items[key] : undefined; + return typeof item != 'function' || me.allowFunctions ? item : null; // for prototype! + }, + + /** + * Returns the item at the specified index. + * @param {Number} index The index of the item. + * @return {Object} The item at the specified index. + */ + getAt : function(index) { + return this.items[index]; + }, + + /** + * Returns the item associated with the passed key. + * @param {String/Number} key The key of the item. + * @return {Object} The item associated with the passed key. + */ + getByKey : function(key) { + return this.map[key]; + }, + + /** + * Returns true if the collection contains the passed Object as an item. + * @param {Object} o The Object to look for in the collection. + * @return {Boolean} True if the collection contains the Object as an item. + */ + contains : function(o){ + return Ext.Array.contains(this.items, o); + }, + + /** + * 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(){ + var me = this; + + me.length = 0; + me.items = []; + me.keys = []; + me.map = {}; + me.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]; + }, + + /** + * Collects all of the values of the given property and returns their sum + * @param {String} property The property to sum by + * @param {String} root Optional 'root' property to extract the first argument from. This is used mainly when + * summing fields in records, where the fields are all stored inside the 'data' object + * @param {Number} start (optional) The record index to start at (defaults to 0) + * @param {Number} end (optional) The record index to end at (defaults to -1) + * @return {Number} The total + */ + sum: function(property, root, start, end) { + var values = this.extractValues(property, root), + length = values.length, + sum = 0, + i; + + start = start || 0; + end = (end || end === 0) ? end : length - 1; + + for (i = start; i <= end; i++) { + sum += values[i]; + } + + return sum; + }, + + /** + * Collects unique values of a particular property in this MixedCollection + * @param {String} property The property to collect on + * @param {String} root Optional 'root' property to extract the first argument from. This is used mainly when + * summing fields in records, where the fields are all stored inside the 'data' object + * @param {Boolean} allowBlank (optional) Pass true to allow null, undefined or empty string values + * @return {Array} The unique values + */ + collect: function(property, root, allowNull) { + var values = this.extractValues(property, root), + length = values.length, + hits = {}, + unique = [], + value, strValue, i; + + for (i = 0; i < length; i++) { + value = values[i]; + strValue = String(value); + + if ((allowNull || !Ext.isEmpty(value)) && !hits[strValue]) { + hits[strValue] = true; + unique.push(value); + } + } + + return unique; + }, + + /** + * @private + * Extracts all of the given property values from the items in the MC. Mainly used as a supporting method for + * functions like sum and collect. + * @param {String} property The property to extract + * @param {String} root Optional 'root' property to extract the first argument from. This is used mainly when + * extracting field data from Model instances, where the fields are stored inside the 'data' object + * @return {Array} The extracted values + */ + extractValues: function(property, root) { + var values = this.items; + + if (root) { + values = Ext.Array.pluck(values, root); + } + + return Ext.Array.pluck(values, property); + }, + + /** + * 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 me = this, + items = me.items, + range = [], + i; + + if (items.length < 1) { + return range; + } + + start = start || 0; + end = Math.min(typeof end == 'undefined' ? me.length - 1 : end, me.length - 1); + if (start <= end) { + for (i = start; i <= end; i++) { + range[range.length] = items[i]; + } + } else { + for (i = start; i >= end; i--) { + range[range.length] = items[i]; + } + } + return range; + }, + + /** + *

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


+//create a simple store with a few people defined
+var people = new Ext.util.MixedCollection();
+people.addAll([
+    {id: 1, age: 25, name: 'Ed'},
+    {id: 2, age: 24, name: 'Tommy'},
+    {id: 3, age: 24, name: 'Arne'},
+    {id: 4, age: 26, name: 'Aaron'}
+]);
+
+//a new MixedCollection containing only the items where age == 24
+var middleAged = people.filter('age', 24);
+

+ * + * + * @param {Array/String} property A property on your objects, or an array of {@link Ext.util.Filter Filter} objects + * @param {String/RegExp} value Either string that the property values + * should start with or a RegExp to test against the property + * @param {Boolean} anyMatch (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) { + var filters = [], + filterFn; + + //support for the simple case of filtering by property/value + if (Ext.isString(property)) { + filters.push(Ext.create('Ext.util.Filter', { + property : property, + value : value, + anyMatch : anyMatch, + caseSensitive: caseSensitive + })); + } else if (Ext.isArray(property) || property instanceof Ext.util.Filter) { + filters = filters.concat(property); + } + + //at this point we have an array of zero or more Ext.util.Filter objects to filter with, + //so here we construct a function that combines these filters by ANDing them together + filterFn = function(record) { + var isMatch = true, + length = filters.length, + i; + + for (i = 0; i < length; i++) { + var filter = filters[i], + fn = filter.filterFn, + scope = filter.scope; + + isMatch = isMatch && fn.call(scope, record); + } + + return isMatch; + }; + + return this.filterBy(filterFn); + }, + + /** + * 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 me = this, + newMC = new this.self(), + keys = me.keys, + items = me.items, + length = items.length, + i; + + newMC.getKey = me.getKey; + + for (i = 0; i < length; i++) { + if (fn.call(scope || me, items[i], keys[i])) { + newMC.add(keys[i], items[i]); + } + } + + return newMC; + }, + + /** + * Finds the index of the first matching object in this collection by a specific property/value. + * @param {String} property The name of a property on your objects. + * @param {String/RegExp} value A string that the property values + * should start with or a RegExp to test against the property. + * @param {Number} start (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); + }, + + /** + * 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 me = this, + keys = me.keys, + items = me.items, + i = start || 0, + len = items.length; + + for (; i < len; i++) { + if (fn.call(scope || me, items[i], keys[i])) { + return i; + } + } + return -1; + }, + + /** + * Returns a regular expression based on the given value and matching options. This is used internally for finding and filtering, + * and by Ext.data.Store#filter + * @private + * @param {String} value The value to create the regex for. This is escaped using Ext.escapeRe + * @param {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false + * @param {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false. + * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true. + */ + createValueMatcher : function(value, anyMatch, caseSensitive, exactMatch) { + if (!value.exec) { // not a regex + var er = Ext.String.escapeRegex; + value = String(value); + + if (anyMatch === true) { + value = er(value); + } else { + value = '^' + er(value); + if (exactMatch === true) { + value += '$'; + } + } + value = new RegExp(value, caseSensitive ? '' : 'i'); + } + return value; + }, + + /** + * Creates a shallow copy of this collection + * @return {MixedCollection} + */ + clone : function() { + var me = this, + copy = new this.self(), + keys = me.keys, + items = me.items, + i = 0, + len = items.length; + + for(; i < len; i++){ + copy.add(keys[i], items[i]); + } + copy.getKey = me.getKey; + return copy; + } +}); + +/** + * @class Ext.util.Sortable + +A mixin which allows a data component to be sorted. This is used by e.g. {@link Ext.data.Store} and {@link Ext.data.TreeStore}. + +**NOTE**: This mixin is mainly for internal 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.data.Store} or {@link Ext.data.TreeStore}. + * @markdown + * @docauthor Tommy Maintz + */ +Ext.define("Ext.util.Sortable", { + /** + * @property isSortable + * @type Boolean + * Flag denoting that this object is sortable. Always true. + */ + isSortable: true, + + /** + * The default sort direction to use if one is not specified (defaults to "ASC") + * @property defaultSortDirection + * @type String + */ + defaultSortDirection: "ASC", + + requires: [ + 'Ext.util.Sorter' + ], + + /** + * The property in each item that contains the data to sort. (defaults to null) + * @type String + */ + sortRoot: null, + + /** + * Performs initialization of this mixin. Component classes using this mixin should call this method + * during their own initialization. + */ + initSortable: function() { + var me = this, + sorters = me.sorters; + + /** + * The collection of {@link Ext.util.Sorter Sorters} currently applied to this Store + * @property sorters + * @type Ext.util.MixedCollection + */ + me.sorters = Ext.create('Ext.util.AbstractMixedCollection', false, function(item) { + return item.id || item.property; + }); + + if (sorters) { + me.sorters.addAll(me.decodeSorters(sorters)); + } + }, + + /** + *

Sorts the data in the Store by one or more of its properties. Example usage:


+//sort by a single field
+myStore.sort('myField', 'DESC');
+
+//sorting by multiple fields
+myStore.sort([
+    {
+        property : 'age',
+        direction: 'ASC'
+    },
+    {
+        property : 'name',
+        direction: 'DESC'
+    }
+]);
+

+ *

Internally, Store converts the passed arguments into an array of {@link Ext.util.Sorter} instances, and delegates the actual + * sorting to its internal {@link Ext.util.MixedCollection}.

+ *

When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:


+store.sort('myField');
+store.sort('myField');
+

+ *

Is equivalent to this code, because Store handles the toggling automatically:


+store.sort('myField', 'ASC');
+store.sort('myField', 'DESC');
+

+ * @param {String|Array} sorters Either a string name of one of the fields in this Store's configured {@link Ext.data.Model Model}, + * or an Array of sorter configurations. + * @param {String} direction The overall direction to sort the data by. Defaults to "ASC". + */ + sort: function(sorters, direction, where, doSort) { + var me = this, + sorter, sorterFn, + newSorters; + + if (Ext.isArray(sorters)) { + doSort = where; + where = direction; + newSorters = sorters; + } + else if (Ext.isObject(sorters)) { + doSort = where; + where = direction; + newSorters = [sorters]; + } + else if (Ext.isString(sorters)) { + sorter = me.sorters.get(sorters); + + if (!sorter) { + sorter = { + property : sorters, + direction: direction + }; + newSorters = [sorter]; + } + else if (direction === undefined) { + sorter.toggle(); + } + else { + sorter.setDirection(direction); + } + } + + if (newSorters && newSorters.length) { + newSorters = me.decodeSorters(newSorters); + if (Ext.isString(where)) { + if (where === 'prepend') { + sorters = me.sorters.clone().items; + + me.sorters.clear(); + me.sorters.addAll(newSorters); + me.sorters.addAll(sorters); + } + else { + me.sorters.addAll(newSorters); + } + } + else { + me.sorters.clear(); + me.sorters.addAll(newSorters); + } + + if (doSort !== false) { + me.onBeforeSort(newSorters); + } + } + + if (doSort !== false) { + sorters = me.sorters.items; + if (sorters.length) { + //construct an amalgamated sorter function which combines all of the Sorters passed + sorterFn = function(r1, r2) { + var result = sorters[0].sort(r1, r2), + length = sorters.length, + i; + + //if we have more than one sorter, OR any additional sorter functions together + for (i = 1; i < length; i++) { + result = result || sorters[i].sort.call(this, r1, r2); + } + + return result; + }; + + me.doSort(sorterFn); + } + } + + return sorters; + }, + + onBeforeSort: Ext.emptyFn, + + /** + * @private + * Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances + * @param {Array} sorters The sorters array + * @return {Array} Array of Ext.util.Sorter objects + */ + decodeSorters: function(sorters) { + if (!Ext.isArray(sorters)) { + if (sorters === undefined) { + sorters = []; + } else { + sorters = [sorters]; + } + } + + var length = sorters.length, + Sorter = Ext.util.Sorter, + fields = this.model ? this.model.prototype.fields : null, + field, + config, i; + + for (i = 0; i < length; i++) { + config = sorters[i]; + + if (!(config instanceof Sorter)) { + if (Ext.isString(config)) { + config = { + property: config + }; + } + + Ext.applyIf(config, { + root : this.sortRoot, + direction: "ASC" + }); + + //support for 3.x style sorters where a function can be defined as 'fn' + if (config.fn) { + config.sorterFn = config.fn; + } + + //support a function to be passed as a sorter definition + if (typeof config == 'function') { + config = { + sorterFn: config + }; + } + + // ensure sortType gets pushed on if necessary + if (fields && !config.transform) { + field = fields.get(config.property); + config.transform = field ? field.sortType : undefined; + } + sorters[i] = Ext.create('Ext.util.Sorter', config); + } + } + + return sorters; + }, + + getSorters: function() { + return this.sorters.items; + } +}); +/** + * @class Ext.util.MixedCollection + *

+ * Represents a collection of a set of key and value pairs. Each key in the MixedCollection + * must be unique, the same key cannot exist twice. This collection is ordered, items in the + * collection can be accessed by index or via the key. Newly added items are added to + * the end of the collection. This class is similar to {@link Ext.util.HashMap} however it + * is heavier and provides more functionality. Sample usage: + *


+var coll = new Ext.util.MixedCollection();
+coll.add('key1', 'val1');
+coll.add('key2', 'val2');
+coll.add('key3', 'val3');
+
+console.log(coll.get('key1')); // prints 'val1'
+console.log(coll.indexOfKey('key3')); // prints 2
+ *

+ * + *

+ * The MixedCollection also has support for sorting and filtering of the values in the collection. + *


+var coll = new Ext.util.MixedCollection();
+coll.add('key1', 100);
+coll.add('key2', -100);
+coll.add('key3', 17);
+coll.add('key4', 0);
+var biggerThanZero = coll.filterBy(function(value){
+    return value > 0;
+});
+console.log(biggerThanZero.getCount()); // prints 2
+ *

+ *

+ * + * @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.define('Ext.util.MixedCollection', { + extend: 'Ext.util.AbstractMixedCollection', + mixins: { + sortable: 'Ext.util.Sortable' + }, + + constructor: function() { + var me = this; + me.callParent(arguments); + me.addEvents('sort'); + me.mixins.sortable.initSortable.call(me); + }, + + doSort: function(sorterFn) { + this.sortBy(sorterFn); + }, + + /** + * @private + * Performs the actual sorting based on a direction and a sorting function. Internally, + * this creates a temporary array of all items in the MixedCollection, sorts it and then writes + * the sorted array data back into this.items and this.keys + * @param {String} property Property to sort by ('key', 'value', or 'index') + * @param {String} dir (optional) Direction to sort 'ASC' or 'DESC'. Defaults to 'ASC'. + * @param {Function} fn (optional) Comparison function that defines the sort order. + * Defaults to sorting by numeric value. + */ + _sort : function(property, dir, fn){ + var me = this, + i, len, + dsc = String(dir).toUpperCase() == 'DESC' ? -1 : 1, + + //this is a temporary array used to apply the sorting function + c = [], + keys = me.keys, + items = me.items; + + //default to a simple sorter function if one is not provided + fn = fn || function(a, b) { + return a - b; + }; + + //copy all the items into a temporary array, which we will sort + for(i = 0, len = items.length; i < len; i++){ + c[c.length] = { + key : keys[i], + value: items[i], + index: i + }; + } + + //sort the temporary array + Ext.Array.sort(c, function(a, b){ + var v = fn(a[property], b[property]) * dsc; + if(v === 0){ + v = (a.index < b.index ? -1 : 1); + } + 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; + } + + me.fireEvent('sort', me); + }, + + /** + * Sorts the collection by a single sorter function + * @param {Function} sorterFn The function to sort by + */ + sortBy: function(sorterFn) { + var me = this, + items = me.items, + keys = me.keys, + length = items.length, + temp = [], + i; + + //first we create a copy of the items array so that we can sort it + for (i = 0; i < length; i++) { + temp[i] = { + key : keys[i], + value: items[i], + index: i + }; + } + + Ext.Array.sort(temp, function(a, b) { + var v = sorterFn(a.value, b.value); + if (v === 0) { + v = (a.index < b.index ? -1 : 1); + } + + return v; + }); + + //copy the temporary array back into the main this.items and this.keys objects + for (i = 0; i < length; i++) { + items[i] = temp[i].value; + keys[i] = temp[i].key; + } + + me.fireEvent('sort', me, items, keys); + }, + + /** + * Reorders each of the items based on a mapping from old index to new index. Internally this + * just translates into a sort. The 'sort' event is fired whenever reordering has occured. + * @param {Object} mapping Mapping from old item index to new item index + */ + reorder: function(mapping) { + var me = this, + items = me.items, + index = 0, + length = items.length, + order = [], + remaining = [], + oldIndex; + + me.suspendEvents(); + + //object of {oldPosition: newPosition} reversed to {newPosition: oldPosition} + for (oldIndex in mapping) { + order[mapping[oldIndex]] = items[oldIndex]; + } + + for (index = 0; index < length; index++) { + if (mapping[index] == undefined) { + remaining.push(items[index]); + } + } + + for (index = 0; index < length; index++) { + if (order[index] == undefined) { + order[index] = remaining.shift(); + } + } + + me.clear(); + me.addAll(order); + + me.resumeEvents(); + me.fireEvent('sort', me); + }, + + /** + * Sorts this collection by keys. + * @param {String} direction (optional) 'ASC' or 'DESC'. Defaults to 'ASC'. + * @param {Function} fn (optional) Comparison function that defines the sort order. + * Defaults to sorting by case insensitive string. + */ + sortByKey : function(dir, fn){ + this._sort('key', dir, fn || function(a, b){ + var v1 = String(a).toUpperCase(), v2 = String(b).toUpperCase(); + return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0); + }); + } +}); + +/** + * @class Ext.data.StoreManager + * @extends Ext.util.MixedCollection + *

Contains a collection of all stores that are created that have an identifier. + * An identifier can be assigned by setting the {@link Ext.data.AbstractStore#storeId storeId} + * property. When a store is in the StoreManager, it can be referred to via it's identifier: + *


+Ext.create('Ext.data.Store', {
+    model: 'SomeModel',
+    storeId: 'myStore'
+});
+
+var store = Ext.data.StoreManager.lookup('myStore');
+ *

+ * Also note that the {@link #lookup} method is aliased to {@link Ext#getStore} for convenience.

+ *

+ * If a store is registered with the StoreManager, you can also refer to the store by it's identifier when + * registering it with any Component that consumes data from a store: + *


+Ext.create('Ext.data.Store', {
+    model: 'SomeModel',
+    storeId: 'myStore'
+});
+
+Ext.create('Ext.view.View', {
+    store: 'myStore',
+    // other configuration here
+});
+ *

+ *

+ * @singleton + * @docauthor Evan Trimboli + * TODO: Make this an AbstractMgr + */ +Ext.define('Ext.data.StoreManager', { + extend: 'Ext.util.MixedCollection', + alternateClassName: ['Ext.StoreMgr', 'Ext.data.StoreMgr', 'Ext.StoreManager'], + singleton: true, + uses: ['Ext.data.ArrayStore'], + + /** + * @cfg {Object} listeners @hide + */ + + /** + * Registers one or more Stores with the StoreManager. You do not normally need to register stores + * manually. Any store initialized with a {@link Ext.data.Store#storeId} will be auto-registered. + * @param {Ext.data.Store} store1 A Store instance + * @param {Ext.data.Store} store2 (optional) + * @param {Ext.data.Store} etc... (optional) + */ + register : function() { + for (var i = 0, s; (s = arguments[i]); i++) { + this.add(s); + } + }, + + /** + * Unregisters one or more Stores with the StoreManager + * @param {String/Object} id1 The id of the Store, or a Store instance + * @param {String/Object} id2 (optional) + * @param {String/Object} etc... (optional) + */ + unregister : function() { + for (var i = 0, s; (s = arguments[i]); i++) { + this.remove(this.lookup(s)); + } + }, + + /** + * Gets a registered Store by id + * @param {String/Object} id The id of the Store, or a Store instance, or a store configuration + * @return {Ext.data.Store} + */ + lookup : function(store) { + // handle the case when we are given an array or an array of arrays. + if (Ext.isArray(store)) { + var fields = ['field1'], + expand = !Ext.isArray(store[0]), + data = store, + i, + len; + + if(expand){ + data = []; + for (i = 0, len = store.length; i < len; ++i) { + data.push([store[i]]); + } + } else { + for(i = 2, len = store[0].length; i <= len; ++i){ + fields.push('field' + i); + } + } + return Ext.create('Ext.data.ArrayStore', { + data : data, + fields: fields, + autoDestroy: true, + autoCreated: true, + expanded: expand + }); + } + + if (Ext.isString(store)) { + // store id + return this.get(store); + } else { + // store instance or store config + return Ext.data.AbstractStore.create(store); + } + }, + + // getKey implementation for MixedCollection + getKey : function(o) { + return o.storeId; + } +}, function() { + /** + *

Creates a new store for the given id and config, then registers it with the {@link Ext.data.StoreManager Store Mananger}. + * Sample usage:


+    Ext.regStore('AllUsers', {
+        model: 'User'
+    });
+
+    //the store can now easily be used throughout the application
+    new Ext.List({
+        store: 'AllUsers',
+        ... other config
+    });
+

+ * @param {String} id The id to set on the new store + * @param {Object} config The store config + * @param {Constructor} cls The new Component class. + * @member Ext + * @method regStore + */ + Ext.regStore = function(name, config) { + var store; + + if (Ext.isObject(name)) { + config = name; + } else { + config.storeId = name; + } + + if (config instanceof Ext.data.Store) { + store = config; + } else { + store = Ext.create('Ext.data.Store', config); + } + + return Ext.data.StoreManager.register(store); + }; + + /** + * Gets a registered Store by id (shortcut to {@link #lookup}) + * @param {String/Object} id The id of the Store, or a Store instance + * @return {Ext.data.Store} + * @member Ext + * @method getStore + */ + Ext.getStore = function(name) { + return Ext.data.StoreManager.lookup(name); + }; +}); + +/** + * @class Ext.LoadMask + * A simple utility class for generically masking elements while loading data. If the {@link #store} + * config option is specified, the masking will be automatically synchronized with the store's loading + * process and the mask element will be cached for reuse. + *

Example usage:

+ *


+// Basic mask:
+var myMask = new Ext.LoadMask(Ext.getBody(), {msg:"Please wait..."});
+myMask.show();
+

+ + * @constructor + * Create a new LoadMask + * @param {Mixed} el The element, element ID, or DOM node you wish to mask. Also, may be a Component who's element you wish to mask. + * @param {Object} config The config object + */ + +Ext.define('Ext.LoadMask', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: ['Ext.data.StoreManager'], + + /* End Definitions */ + + /** + * @cfg {Ext.data.Store} store + * Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and + * hidden on either load success, or load fail. + */ + + /** + * @cfg {String} msg + * The text to display in a centered loading message box (defaults to 'Loading...') + */ + msg : 'Loading...', + /** + * @cfg {String} msgCls + * The CSS class to apply to the loading message element (defaults to "x-mask-loading") + */ + msgCls : Ext.baseCSSPrefix + 'mask-loading', + + /** + * @cfg {Boolean} useMsg + * Whether or not to use a loading message class or simply mask the bound element. + */ + useMsg: true, + + /** + * Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false) + * @type Boolean + */ + disabled: false, + + constructor : function(el, config) { + var me = this; + + if (el.isComponent) { + me.bindComponent(el); + } else { + me.el = Ext.get(el); + } + Ext.apply(me, config); + + me.addEvents('beforeshow', 'show', 'hide'); + if (me.store) { + me.bindStore(me.store, true); + } + me.mixins.observable.constructor.call(me, config); + }, + + bindComponent: function(comp) { + var me = this, + listeners = { + resize: me.onComponentResize, + scope: me + }; + + if (comp.el) { + me.onComponentRender(comp); + } else { + listeners.render = { + fn: me.onComponentRender, + scope: me, + single: true + }; + } + me.mon(comp, listeners); + }, + + /** + * @private + * Called if we were configured with a Component, and that Component was not yet rendered. Collects the element to mask. + */ + onComponentRender: function(comp) { + this.el = comp.getContentTarget(); + }, + + /** + * @private + * Called when this LoadMask's Component is resized. The isMasked method also re-centers any displayed message. + */ + onComponentResize: function(comp, w, h) { + this.el.isMasked(); + }, + + /** + * Changes the data store bound to this LoadMask. + * @param {Store} store The store to bind to this LoadMask + */ + bindStore : function(store, initial) { + var me = this; + + if (!initial && me.store) { + me.mun(me.store, { + scope: me, + beforeload: me.onBeforeLoad, + load: me.onLoad, + exception: me.onLoad + }); + if(!store) { + me.store = null; + } + } + if (store) { + store = Ext.data.StoreManager.lookup(store); + me.mon(store, { + scope: me, + beforeload: me.onBeforeLoad, + load: me.onLoad, + exception: me.onLoad + }); + + } + me.store = store; + if (store && store.isLoading()) { + me.onBeforeLoad(); + } + }, + + /** + * Disables the mask to prevent it from being displayed + */ + disable : function() { + var me = this; + + me.disabled = true; + if (me.loading) { + me.onLoad(); + } + }, + + /** + * Enables the mask so that it can be displayed + */ + enable : function() { + this.disabled = false; + }, + + /** + * Method to determine whether this LoadMask is currently disabled. + * @return {Boolean} the disabled state of this LoadMask. + */ + isDisabled : function() { + return this.disabled; + }, + + // private + onLoad : function() { + var me = this; + + me.loading = false; + me.el.unmask(); + me.fireEvent('hide', me, me.el, me.store); + }, + + // private + onBeforeLoad : function() { + var me = this; + + if (!me.disabled && !me.loading && me.fireEvent('beforeshow', me, me.el, me.store) !== false) { + if (me.useMsg) { + me.el.mask(me.msg, me.msgCls, false); + } else { + me.el.mask(); + } + + me.fireEvent('show', me, me.el, me.store); + me.loading = true; + } + }, + + /** + * Show this LoadMask over the configured Element. + */ + show: function() { + this.onBeforeLoad(); + }, + + /** + * Hide this LoadMask. + */ + hide: function() { + this.onLoad(); + }, + + // private + destroy : function() { + this.hide(); + this.clearListeners(); + } +}); + +/** + * @class Ext.ComponentLoader + * @extends Ext.ElementLoader + * + * This class is used to load content via Ajax into a {@link Ext.Component}. In general + * this class will not be instanced directly, rather a loader configuration will be passed to the + * constructor of the {@link Ext.Component}. + * + * ## HTML Renderer + * By default, the content loaded will be processed as raw html. The response text + * from the request is taken and added to the component. This can be used in + * conjunction with the {@link #scripts} option to execute any inline scripts in + * the resulting content. Using this renderer has the same effect as passing the + * {@link Ext.Component#html} configuration option. + * + * ## Data Renderer + * This renderer allows content to be added by using JSON data and a {@link Ext.XTemplate}. + * The content received from the response is passed to the {@link Ext.Component#update} method. + * This content is run through the attached {@link Ext.Component#tpl} and the data is added to + * the Component. Using this renderer has the same effect as using the {@link Ext.Component#data} + * configuration in conjunction with a {@link Ext.Component#tpl}. + * + * ## Component Renderer + * This renderer can only be used with a {@link Ext.Container} and subclasses. It allows for + * Components to be loaded remotely into a Container. The response is expected to be a single/series of + * {@link Ext.Component} configuration objects. When the response is received, the data is decoded + * and then passed to {@link Ext.Container#add}. Using this renderer has the same effect as specifying + * the {@link Ext.Container#items} configuration on a Container. + * + * ## Custom Renderer + * A custom function can be passed to handle any other special case, see the {@link #renderer} option. + * + * ## Example Usage + * new Ext.Component({ + * tpl: '{firstName} - {lastName}', + * loader: { + * url: 'myPage.php', + * renderer: 'data', + * params: { + * userId: 1 + * } + * } + * }); + */ +Ext.define('Ext.ComponentLoader', { + + /* Begin Definitions */ + + extend: 'Ext.ElementLoader', + + statics: { + Renderer: { + Data: function(loader, response, active){ + var success = true; + try { + loader.getTarget().update(Ext.decode(response.responseText)); + } catch (e) { + success = false; + } + return success; + }, + + Component: function(loader, response, active){ + var success = true, + target = loader.getTarget(), + items = []; + + if (!target.isContainer) { + Ext.Error.raise({ + target: target, + msg: 'Components can only be loaded into a container' + }); + } + + try { + items = Ext.decode(response.responseText); + } catch (e) { + success = false; + } + + if (success) { + if (active.removeAll) { + target.removeAll(); + } + target.add(items); + } + return success; + } + } + }, + + /* End Definitions */ + + /** + * @cfg {Ext.Component/String} target The target {@link Ext.Component} for the loader. Defaults to null. + * If a string is passed it will be looked up via the id. + */ + target: null, + + /** + * @cfg {Mixed} loadMask True or a {@link Ext.LoadMask} configuration to enable masking during loading. Defaults to false. + */ + loadMask: false, + + /** + * @cfg {Boolean} scripts True to parse any inline script tags in the response. This only used when using the html + * {@link #renderer}. + */ + + /** + * @cfg {String/Function} renderer + +The type of content that is to be loaded into, which can be one of 3 types: + ++ **html** : Loads raw html content, see {@link Ext.Component#html} ++ **data** : Loads raw html content, see {@link Ext.Component#data} ++ **component** : Loads child {Ext.Component} instances. This option is only valid when used with a Container. + +Defaults to `html`. + +Alternatively, you can pass a function which is called with the following parameters. + ++ loader - Loader instance ++ response - The server response ++ active - The active request + +The function must return false is loading is not successful. Below is a sample of using a custom renderer: + + new Ext.Component({ + loader: { + url: 'myPage.php', + renderer: function(loader, response, active) { + var text = response.responseText; + loader.getTarget().update('The response is ' + text); + return true; + } + } + }); + * @markdown + */ + renderer: 'html', + + /** + * Set a {Ext.Component} as the target of this loader. Note that if the target is changed, + * any active requests will be aborted. + * @param {String/Ext.Component} target The component to be the target of this loader. If a string is passed + * it will be looked up via its id. + */ + setTarget: function(target){ + var me = this; + + if (Ext.isString(target)) { + target = Ext.getCmp(target); + } + + if (me.target && me.target != target) { + me.abort(); + } + me.target = target; + }, + + // inherit docs + removeMask: function(){ + this.target.setLoading(false); + }, + + /** + * Add the mask on the target + * @private + * @param {Mixed} mask The mask configuration + */ + addMask: function(mask){ + this.target.setLoading(mask); + }, + + /** + * Get the target of this loader. + * @return {Ext.Component} target The target, null if none exists. + */ + + setOptions: function(active, options){ + active.removeAll = Ext.isDefined(options.removeAll) ? options.removeAll : this.removeAll; + }, + + /** + * Gets the renderer to use + * @private + * @param {String/Function} renderer The renderer to use + * @return {Function} A rendering function to use. + */ + getRenderer: function(renderer){ + if (Ext.isFunction(renderer)) { + return renderer; + } + + var renderers = this.statics().Renderer; + switch (renderer) { + case 'component': + return renderers.Component; + case 'data': + return renderers.Data; + default: + return Ext.ElementLoader.Renderer.Html; + } + } +}); + +/** + * @class Ext.layout.component.Auto + * @extends Ext.layout.component.Component + * @private + * + *

The AutoLayout is the default layout manager delegated by {@link Ext.Component} to + * render any child Elements when no {@link Ext.Component#layout layout} is configured.

+ */ + +Ext.define('Ext.layout.component.Auto', { + + /* Begin Definitions */ + + alias: 'layout.autocomponent', + + extend: 'Ext.layout.component.Component', + + /* End Definitions */ + + type: 'autocomponent', + + onLayout : function(width, height) { + this.setTargetSize(width, height); + } +}); +/** + * @class Ext.AbstractComponent + *

An abstract base class which provides shared methods for Components across the Sencha product line.

+ *

Please refer to sub class's documentation

+ * @constructor + */ + +Ext.define('Ext.AbstractComponent', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable', + animate: 'Ext.util.Animate', + state: 'Ext.state.Stateful' + }, + + requires: [ + 'Ext.PluginManager', + 'Ext.ComponentManager', + 'Ext.core.Element', + 'Ext.core.DomHelper', + 'Ext.XTemplate', + 'Ext.ComponentQuery', + 'Ext.LoadMask', + 'Ext.ComponentLoader', + 'Ext.EventManager', + 'Ext.layout.Layout', + 'Ext.layout.component.Auto' + ], + + // Please remember to add dependencies whenever you use it + // I had to fix these many times already + uses: [ + 'Ext.ZIndexManager' + ], + + statics: { + AUTO_ID: 1000 + }, + + /* End Definitions */ + + isComponent: true, + + getAutoId: function() { + return ++Ext.AbstractComponent.AUTO_ID; + }, + + /** + * @cfg {String} id + *

The unique id of this component instance (defaults to an {@link #getId auto-assigned id}).

+ *

It should not be necessary to use this configuration except for singleton objects in your application. + * Components created with an id may be accessed globally using {@link Ext#getCmp Ext.getCmp}.

+ *

Instead of using assigned ids, use the {@link #itemId} config, and {@link Ext.ComponentQuery ComponentQuery} which + * provides selector-based searching for Sencha Components analogous to DOM querying. The {@link Ext.container.Container Container} + * class contains {@link Ext.container.Container#down shortcut methods} to query its descendant Components by selector.

+ *

Note that this id will also be used as the element id for the containing HTML element + * that is rendered to the page for this component. This allows you to write id-based CSS + * rules to style the specific instance of this component uniquely, and also to select + * sub-elements using this component's id as the parent.

+ *

Note: to avoid complications imposed by a unique id also see {@link #itemId}.

+ *

Note: to access the container of a Component see {@link #ownerCt}.

+ */ + + /** + * @cfg {String} itemId + *

An itemId can be used as an alternative way to get a reference to a component + * when no object reference is available. Instead of using an {@link #id} with + * {@link Ext}.{@link Ext#getCmp getCmp}, use itemId with + * {@link Ext.container.Container}.{@link Ext.container.Container#getComponent getComponent} which will retrieve + * itemId's or {@link #id}'s. Since itemId's are an index to the + * container's internal MixedCollection, the itemId is scoped locally to the container -- + * avoiding potential conflicts with {@link Ext.ComponentManager} which requires a unique + * {@link #id}.

+ *


+var c = new Ext.panel.Panel({ //
+    {@link Ext.Component#height height}: 300,
+    {@link #renderTo}: document.body,
+    {@link Ext.container.Container#layout layout}: 'auto',
+    {@link Ext.container.Container#items items}: [
+        {
+            itemId: 'p1',
+            {@link Ext.panel.Panel#title title}: 'Panel 1',
+            {@link Ext.Component#height height}: 150
+        },
+        {
+            itemId: 'p2',
+            {@link Ext.panel.Panel#title title}: 'Panel 2',
+            {@link Ext.Component#height height}: 150
+        }
+    ]
+})
+p1 = c.{@link Ext.container.Container#getComponent getComponent}('p1'); // not the same as {@link Ext#getCmp Ext.getCmp()}
+p2 = p1.{@link #ownerCt}.{@link Ext.container.Container#getComponent getComponent}('p2'); // reference via a sibling
+     *

+ *

Also see {@link #id}, {@link #query}, {@link #down} and {@link #child}.

+ *

Note: to access the container of an item see {@link #ownerCt}.

+ */ + + /** + * This Component's owner {@link Ext.container.Container Container} (defaults to undefined, and is set automatically when + * this Component is added to a Container). Read-only. + *

Note: to access items within the Container see {@link #itemId}.

+ * @type Ext.Container + * @property ownerCt + */ + + /** + * @cfg {Mixed} autoEl + *

A tag name or {@link Ext.core.DomHelper DomHelper} spec used to create the {@link #getEl Element} which will + * encapsulate this Component.

+ *

You do not normally need to specify this. For the base classes {@link Ext.Component} and {@link Ext.container.Container}, + * this defaults to 'div'. The more complex Sencha classes use a more complex + * DOM structure specified by their own {@link #renderTpl}s.

+ *

This is intended to allow the developer to create application-specific utility Components encapsulated by + * different DOM elements. Example usage:


+{
+    xtype: 'component',
+    autoEl: {
+        tag: 'img',
+        src: 'http://www.example.com/example.jpg'
+    }
+}, {
+    xtype: 'component',
+    autoEl: {
+        tag: 'blockquote',
+        html: 'autoEl is cool!'
+    }
+}, {
+    xtype: 'container',
+    autoEl: 'ul',
+    cls: 'ux-unordered-list',
+    items: {
+        xtype: 'component',
+        autoEl: 'li',
+        html: 'First list item'
+    }
+}
+

+ */ + + /** + * @cfg {Mixed} renderTpl + *

An {@link Ext.XTemplate XTemplate} used to create the internal structure inside this Component's + * encapsulating {@link #getEl Element}.

+ *

You do not normally need to specify this. For the base classes {@link Ext.Component} + * and {@link Ext.container.Container}, this defaults to null which means that they will be initially rendered + * with no internal structure; they render their {@link #getEl Element} empty. The more specialized ExtJS and Touch classes + * which use a more complex DOM structure, provide their own template definitions.

+ *

This is intended to allow the developer to create application-specific utility Components with customized + * internal structure.

+ *

Upon rendering, any created child elements may be automatically imported into object properties using the + * {@link #renderSelectors} option.

+ */ + renderTpl: null, + + /** + * @cfg {Object} renderSelectors + +An object containing properties specifying {@link Ext.DomQuery DomQuery} selectors which identify child elements +created by the render process. + +After the Component's internal structure is rendered according to the {@link #renderTpl}, this object is iterated through, +and the found Elements are added as properties to the Component using the `renderSelector` property name. + +For example, a Component which rendered an image, and description into its element might use the following properties +coded into its prototype: + + renderTpl: '<img src="{imageUrl}" class="x-image-component-img"><div class="x-image-component-desc">{description}>/div<', + + renderSelectors: { + image: 'img.x-image-component-img', + descEl: 'div.x-image-component-desc' + } + +After rendering, the Component would have a property image referencing its child `img` Element, +and a property `descEl` referencing the `div` Element which contains the description. + + * @markdown + */ + + /** + * @cfg {Mixed} renderTo + *

Specify the id of the element, a DOM element or an existing Element that this component + * will be rendered into.

Notes :

+ *

See {@link #render} also.

+ */ + + /** + * @cfg {Boolean} frame + *

Specify as true to have the Component inject framing elements within the Component at render time to + * provide a graphical rounded frame around the Component content.

+ *

This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer + * prior to version 9 which do not support rounded corners natively.

+ *

The extra space taken up by this framing is available from the read only property {@link #frameSize}.

+ */ + + /** + *

Read-only property indicating the width of any framing elements which were added within the encapsulating element + * to provide graphical, rounded borders. See the {@link #frame} config.

+ *

This is an object containing the frame width in pixels for all four sides of the Component containing + * the following properties:

top The width of the top framing element in pixels.
right The width of the right framing element in pixels.
bottom The width of the bottom framing element in pixels.
left The width of the left framing element in pixels.

+ * @property frameSize + * @type {Object} + */ + + /** + * @cfg {String/Object} componentLayout + *

The sizing and positioning of a Component's internal Elements is the responsibility of + * the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.

+ *

Generally, developers will not use this configuration as all provided Components which need their internal + * elements sizing (Such as {@link Ext.form.field.Base input fields}) come with their own componentLayout managers.

+ *

The {@link Ext.layout.container.Auto default layout manager} will be used on instances of the base Ext.Component class + * which simply sizes the Component's encapsulating element to the height and width specified in the {@link #setSize} method.

+ */ + + /** + * @cfg {Mixed} tpl + * An {@link Ext.Template}, {@link Ext.XTemplate} + * or an array of strings to form an Ext.XTemplate. + * Used in conjunction with the {@link #data} and + * {@link #tplWriteMode} configurations. + */ + + /** + * @cfg {Mixed} data + * The initial set of data to apply to the {@link #tpl} to + * update the content area of the Component. + */ + + /** + * @cfg {String} tplWriteMode The Ext.(X)Template method to use when + * updating the content area of the Component. Defaults to 'overwrite' + * (see {@link Ext.XTemplate#overwrite}). + */ + tplWriteMode: 'overwrite', + + /** + * @cfg {String} baseCls + * The base CSS class to apply to this components's element. This will also be prepended to + * elements within this component like Panel's body will get a class x-panel-body. This means + * that if you create a subclass of Panel, and you want it to get all the Panels styling for the + * element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this + * component. + */ + baseCls: Ext.baseCSSPrefix + 'component', + + /** + * @cfg {String} componentCls + * CSS Class to be added to a components root level element to give distinction to it + * via styling. + */ + + /** + * @cfg {String} cls + * An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be + * useful for adding customized styles to the component or any of its children using standard CSS rules. + */ + + /** + * @cfg {String} overCls + * An optional extra CSS class that will be added to this component's Element when the mouse moves + * over the Element, and removed when the mouse moves out. (defaults to ''). This can be + * useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. + */ + + /** + * @cfg {String} disabledCls + * CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'. + */ + disabledCls: Ext.baseCSSPrefix + 'item-disabled', + + /** + * @cfg {String/Array} ui + * A set style for a component. Can be a string or an Array of multiple strings (UIs) + */ + ui: 'default', + + /** + * @cfg {Array} uiCls + * An array of of classNames which are currently applied to this component + * @private + */ + uiCls: [], + + /** + * @cfg {String} style + * A custom style specification to be applied to this component's Element. Should be a valid argument to + * {@link Ext.core.Element#applyStyles}. + *


+        new Ext.panel.Panel({
+            title: 'Some Title',
+            renderTo: Ext.getBody(),
+            width: 400, height: 300,
+            layout: 'form',
+            items: [{
+                xtype: 'textarea',
+                style: {
+                    width: '95%',
+                    marginBottom: '10px'
+                }
+            },
+            new Ext.button.Button({
+                text: 'Send',
+                minWidth: '100',
+                style: {
+                    marginBottom: '10px'
+                }
+            })
+            ]
+        });
+

+ */ + + /** + * @cfg {Number} width + * The width of this component in pixels. + */ + + /** + * @cfg {Number} height + * The height of this component in pixels. + */ + + /** + * @cfg {Number/String} border + * Specifies the border for this component. The border can be a single numeric value to apply to all sides or + * it can be a CSS style specification for each style, for example: '10 5 3 10'. + */ + + /** + * @cfg {Number/String} padding + * Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or + * it can be a CSS style specification for each style, for example: '10 5 3 10'. + */ + + /** + * @cfg {Number/String} margin + * Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or + * it can be a CSS style specification for each style, for example: '10 5 3 10'. + */ + + /** + * @cfg {Boolean} hidden + * Defaults to false. + */ + hidden: false, + + /** + * @cfg {Boolean} disabled + * Defaults to false. + */ + disabled: false, + + /** + * @cfg {Boolean} draggable + * Allows the component to be dragged. + */ + + /** + * Read-only property indicating whether or not the component can be dragged + * @property draggable + * @type {Boolean} + */ + draggable: false, + + /** + * @cfg {Boolean} floating + * Create the Component as a floating and use absolute positioning. + * Defaults to false. + */ + floating: false, + + /** + * @cfg {String} hideMode + * A String which specifies how this Component's encapsulating DOM element will be hidden. + * Values may be

'display' : The Component will be hidden using the display: none style.
'visibility' : The Component will be hidden using the visibility: hidden style.
'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This + * is useful when a hidden Component must maintain measurable dimensions. Hiding using display results + * in a Component having zero dimensions.

+ * Defaults to 'display'. + */ + hideMode: 'display', + + /** + * @cfg {String} contentEl + *

Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content + * for this component.

+ *

Description : + *
This config option is used to take an existing HTML element and place it in the layout element + * of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
Notes : + *
The specified HTML element is appended to the layout element of the component after any configured + * {@link #html HTML} has been inserted, and so the document will not contain this element at the time the {@link #render} event is fired.
+ *
The specified HTML element used will not participate in any {@link Ext.container.Container#layout layout} + * scheme that the Component may use. It is just HTML. Layouts operate on child {@link Ext.container.Container#items items}.
+ *
Add either the x-hidden or the x-hide-display CSS class to + * prevent a brief flicker of the content before it is rendered to the panel.

+ */ + + /** + * @cfg {String/Object} html + * An HTML fragment, or a {@link Ext.core.DomHelper DomHelper} specification to use as the layout element + * content (defaults to ''). The HTML content is added after the component is rendered, + * so the document will not contain this HTML at the time the {@link #render} event is fired. + * This content is inserted into the body before any configured {@link #contentEl} is appended. + */ + + /** + * @cfg {Boolean} styleHtmlContent + * True to automatically style the html inside the content target of this component (body for panels). + * Defaults to false. + */ + styleHtmlContent: false, + + /** + * @cfg {String} styleHtmlCls + * The class that is added to the content target when you set styleHtmlContent to true. + * Defaults to 'x-html' + */ + styleHtmlCls: Ext.baseCSSPrefix + 'html', + + /** + * @cfg {Number} minHeight + *

The minimum value in pixels which this Component will set its height to.

+ *

Warning: This will override any size management applied by layout managers.

+ */ + /** + * @cfg {Number} minWidth + *

The minimum value in pixels which this Component will set its width to.

+ *

Warning: This will override any size management applied by layout managers.

+ */ + /** + * @cfg {Number} maxHeight + *

The maximum value in pixels which this Component will set its height to.

+ *

Warning: This will override any size management applied by layout managers.

+ */ + /** + * @cfg {Number} maxWidth + *

The maximum value in pixels which this Component will set its width to.

+ *

Warning: This will override any size management applied by layout managers.

+ */ + + /** + * @cfg {Ext.ComponentLoader/Object} loader + * A configuration object or an instance of a {@link Ext.ComponentLoader} to load remote + * content for this Component. + */ + + // @private + allowDomMove: true, + + /** + * @cfg {Boolean} autoShow True to automatically show the component upon creation. + * This config option may only be used for {@link #floating} components or components + * that use {@link #autoRender}. Defaults to false. + */ + autoShow: false, + + /** + * @cfg {Mixed} autoRender + *

This config is intended mainly for {@link #floating} Components which may or may not be shown. Instead + * of using {@link #renderTo} in the configuration, and rendering upon construction, this allows a Component + * to render itself upon first {@link #show}.

+ *

Specify as true to have this Component render to the document body upon first show.

+ *

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

+ *

This defaults to true for the {@link Ext.window.Window Window} class.

+ */ + autoRender: false, + + needsLayout: false, + + /** + * @cfg {Object/Array} plugins + * An object or array of objects that will provide custom functionality for this component. The only + * requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. + * When a component is created, if any plugins are available, the component will call the init method on each + * plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the + * component as needed to provide its functionality. + */ + + /** + * Read-only property indicating whether or not the component has been rendered. + * @property rendered + * @type {Boolean} + */ + rendered: false, + + weight: 0, + + trimRe: /^\s+|\s+$/g, + spacesRe: /\s+/, + + + /** + * This is an internal flag that you use when creating custom components. + * By default this is set to true which means that every component gets a mask when its disabled. + * Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false + * since they want to implement custom disable logic. + * @property maskOnDisable + * @type {Boolean} + */ + maskOnDisable: true, + + constructor : function(config) { + var me = this, + i, len; + + config = config || {}; + me.initialConfig = config; + Ext.apply(me, config); + + me.addEvents( + /** + * @event beforeactivate + * Fires before a Component has been visually activated. + * Returning false from an event listener can prevent the activate + * from occurring. + * @param {Ext.Component} this + */ + 'beforeactivate', + /** + * @event activate + * Fires after a Component has been visually activated. + * @param {Ext.Component} this + */ + 'activate', + /** + * @event beforedeactivate + * Fires before a Component has been visually deactivated. + * Returning false from an event listener can prevent the deactivate + * from occurring. + * @param {Ext.Component} this + */ + 'beforedeactivate', + /** + * @event deactivate + * Fires after a Component has been visually deactivated. + * @param {Ext.Component} this + */ + 'deactivate', + /** + * @event added + * Fires after a Component had been added to a Container. + * @param {Ext.Component} this + * @param {Ext.container.Container} container Parent Container + * @param {Number} pos position of Component + */ + 'added', + /** + * @event disable + * Fires after the component is disabled. + * @param {Ext.Component} this + */ + 'disable', + /** + * @event enable + * Fires after the component is enabled. + * @param {Ext.Component} this + */ + 'enable', + /** + * @event beforeshow + * Fires before the component is shown when calling the {@link #show} method. + * Return false from an event handler to stop the show. + * @param {Ext.Component} this + */ + 'beforeshow', + /** + * @event show + * Fires after the component is shown when calling the {@link #show} method. + * @param {Ext.Component} this + */ + 'show', + /** + * @event beforehide + * Fires before the component is hidden when calling the {@link #hide} method. + * Return false from an event handler to stop the hide. + * @param {Ext.Component} this + */ + 'beforehide', + /** + * @event hide + * Fires after the component is hidden. + * Fires after the component is hidden when calling the {@link #hide} method. + * @param {Ext.Component} this + */ + 'hide', + /** + * @event removed + * Fires when a component is removed from an Ext.container.Container + * @param {Ext.Component} this + * @param {Ext.container.Container} ownerCt Container which holds the component + */ + 'removed', + /** + * @event beforerender + * Fires before the component is {@link #rendered}. Return false from an + * event handler to stop the {@link #render}. + * @param {Ext.Component} this + */ + 'beforerender', + /** + * @event render + * Fires after the component markup is {@link #rendered}. + * @param {Ext.Component} this + */ + 'render', + /** + * @event afterrender + *

Fires after the component rendering is finished.

+ *

The afterrender event is fired after this Component has been {@link #rendered}, been postprocesed + * by any afterRender method defined for the Component.

+ * @param {Ext.Component} this + */ + 'afterrender', + /** + * @event beforedestroy + * Fires before the component is {@link #destroy}ed. Return false from an event handler to stop the {@link #destroy}. + * @param {Ext.Component} this + */ + 'beforedestroy', + /** + * @event destroy + * Fires after the component is {@link #destroy}ed. + * @param {Ext.Component} this + */ + 'destroy', + /** + * @event resize + * Fires after the component is resized. + * @param {Ext.Component} this + * @param {Number} adjWidth The box-adjusted width that was set + * @param {Number} adjHeight The box-adjusted height that was set + */ + 'resize', + /** + * @event move + * Fires after the component is moved. + * @param {Ext.Component} this + * @param {Number} x The new x position + * @param {Number} y The new y position + */ + 'move' + ); + + me.getId(); + + me.mons = []; + me.additionalCls = []; + me.renderData = me.renderData || {}; + me.renderSelectors = me.renderSelectors || {}; + + if (me.plugins) { + me.plugins = [].concat(me.plugins); + for (i = 0, len = me.plugins.length; i < len; i++) { + me.plugins[i] = me.constructPlugin(me.plugins[i]); + } + } + + me.initComponent(); + + // ititComponent gets a chance to change the id property before registering + Ext.ComponentManager.register(me); + + // Dont pass the config so that it is not applied to 'this' again + me.mixins.observable.constructor.call(me); + me.mixins.state.constructor.call(me, config); + + // Move this into Observable? + if (me.plugins) { + me.plugins = [].concat(me.plugins); + for (i = 0, len = me.plugins.length; i < len; i++) { + me.plugins[i] = me.initPlugin(me.plugins[i]); + } + } + + me.loader = me.getLoader(); + + if (me.renderTo) { + me.render(me.renderTo); + // EXTJSIV-1935 - should be a way to do afterShow or something, but that + // won't work. Likewise, rendering hidden and then showing (w/autoShow) has + // implications to afterRender so we cannot do that. + } + + if (me.autoShow) { + me.show(); + } + + if (Ext.isDefined(me.disabledClass)) { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.Component: disabledClass has been deprecated. Please use disabledCls.'); + } + me.disabledCls = me.disabledClass; + delete me.disabledClass; + } + }, + + initComponent: Ext.emptyFn, + + show: Ext.emptyFn, + + animate: function(animObj) { + var me = this, + to; + + animObj = animObj || {}; + to = animObj.to || {}; + + if (Ext.fx.Manager.hasFxBlock(me.id)) { + return me; + } + // Special processing for animating Component dimensions. + if (!animObj.dynamic && (to.height || to.width)) { + var curWidth = me.getWidth(), + w = curWidth, + curHeight = me.getHeight(), + h = curHeight, + needsResize = false; + + if (to.height && to.height > curHeight) { + h = to.height; + needsResize = true; + } + if (to.width && to.width > curWidth) { + w = to.width; + needsResize = true; + } + + // If any dimensions are being increased, we must resize the internal structure + // of the Component, but then clip it by sizing its encapsulating element back to original dimensions. + // The animation will then progressively reveal the larger content. + if (needsResize) { + var clearWidth = !Ext.isNumber(me.width), + clearHeight = !Ext.isNumber(me.height); + + me.componentLayout.childrenChanged = true; + me.setSize(w, h, me.ownerCt); + me.el.setSize(curWidth, curHeight); + if (clearWidth) { + delete me.width; + } + if (clearHeight) { + delete me.height; + } + } + } + return me.mixins.animate.animate.apply(me, arguments); + }, + + /** + *

This method finds the topmost active layout who's processing will eventually determine the size and position of this + * Component.

+ *

This method is useful when dynamically adding Components into Containers, and some processing must take place after the + * final sizing and positioning of the Component has been performed.

+ * @returns + */ + findLayoutController: function() { + return this.findParentBy(function(c) { + // Return true if we are at the root of the Container tree + // or this Container's layout is busy but the next one up is not. + return !c.ownerCt || (c.layout.layoutBusy && !c.ownerCt.layout.layoutBusy); + }); + }, + + onShow : function() { + // Layout if needed + var needsLayout = this.needsLayout; + if (Ext.isObject(needsLayout)) { + this.doComponentLayout(needsLayout.width, needsLayout.height, needsLayout.isSetSize, needsLayout.ownerCt); + } + }, + + constructPlugin: function(plugin) { + if (plugin.ptype && typeof plugin.init != 'function') { + plugin.cmp = this; + plugin = Ext.PluginManager.create(plugin); + } + else if (typeof plugin == 'string') { + plugin = Ext.PluginManager.create({ + ptype: plugin, + cmp: this + }); + } + return plugin; + }, + + // @private + initPlugin : function(plugin) { + plugin.init(this); + + return plugin; + }, + + /** + * Handles autoRender. + * Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that + * ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body + */ + doAutoRender: function() { + var me = this; + if (me.floating) { + me.render(document.body); + } else { + me.render(Ext.isBoolean(me.autoRender) ? Ext.getBody() : me.autoRender); + } + }, + + // @private + render : function(container, position) { + var me = this; + + if (!me.rendered && me.fireEvent('beforerender', me) !== false) { + // If this.el is defined, we want to make sure we are dealing with + // an Ext Element. + if (me.el) { + me.el = Ext.get(me.el); + } + + // Perform render-time processing for floating Components + if (me.floating) { + me.onFloatRender(); + } + + container = me.initContainer(container); + + me.onRender(container, position); + + // Tell the encapsulating element to hide itself in the way the Component is configured to hide + // This means DISPLAY, VISIBILITY or OFFSETS. + me.el.setVisibilityMode(Ext.core.Element[me.hideMode.toUpperCase()]); + + if (me.overCls) { + me.el.hover(me.addOverCls, me.removeOverCls, me); + } + + me.fireEvent('render', me); + + me.initContent(); + + me.afterRender(container); + me.fireEvent('afterrender', me); + + me.initEvents(); + + if (me.hidden) { + // Hiding during the render process should not perform any ancillary + // actions that the full hide process does; It is not hiding, it begins in a hidden state.' + // So just make the element hidden according to the configured hideMode + me.el.hide(); + } + + if (me.disabled) { + // pass silent so the event doesn't fire the first time. + me.disable(true); + } + } + return me; + }, + + // @private + onRender : function(container, position) { + var me = this, + el = me.el, + cls = me.initCls(), + styles = me.initStyles(), + renderTpl, renderData, i; + + position = me.getInsertPosition(position); + + if (!el) { + if (position) { + el = Ext.core.DomHelper.insertBefore(position, me.getElConfig(), true); + } + else { + el = Ext.core.DomHelper.append(container, me.getElConfig(), true); + } + } + else if (me.allowDomMove !== false) { + if (position) { + container.dom.insertBefore(el.dom, position); + } else { + container.dom.appendChild(el.dom); + } + } + + if (Ext.scopeResetCSS && !me.ownerCt) { + // If this component's el is the body element, we add the reset class to the html tag + if (el.dom == Ext.getBody().dom) { + el.parent().addCls(Ext.baseCSSPrefix + 'reset'); + } + else { + // Else we wrap this element in an element that adds the reset class. + me.resetEl = el.wrap({ + cls: Ext.baseCSSPrefix + 'reset' + }); + } + } + + el.addCls(cls); + el.setStyle(styles); + + // Here we check if the component has a height set through style or css. + // If it does then we set the this.height to that value and it won't be + // considered an auto height component + // if (this.height === undefined) { + // var height = el.getHeight(); + // // This hopefully means that the panel has an explicit height set in style or css + // if (height - el.getPadding('tb') - el.getBorderWidth('tb') > 0) { + // this.height = height; + // } + // } + + me.el = el; + + me.rendered = true; + me.addUIToElement(true); + //loop through all exisiting uiCls and update the ui in them + for (i = 0; i < me.uiCls.length; i++) { + me.addUIClsToElement(me.uiCls[i], true); + } + me.rendered = false; + me.initFrame(); + + renderTpl = me.initRenderTpl(); + if (renderTpl) { + renderData = me.initRenderData(); + renderTpl.append(me.getTargetEl(), renderData); + } + + me.applyRenderSelectors(); + + me.rendered = true; + + me.setUI(me.ui); + }, + + // @private + afterRender : function() { + var me = this, + pos, + xy; + + me.getComponentLayout(); + + // Set the size if a size is configured, or if this is the outermost Container + if (!me.ownerCt || (me.height || me.width)) { + me.setSize(me.width, me.height); + } + + // For floaters, calculate x and y if they aren't defined by aligning + // the sized element to the center of either the the container or the ownerCt + if (me.floating && (me.x === undefined || me.y === undefined)) { + if (me.floatParent) { + xy = me.el.getAlignToXY(me.floatParent.getTargetEl(), 'c-c'); + pos = me.floatParent.getTargetEl().translatePoints(xy[0], xy[1]); + } else { + xy = me.el.getAlignToXY(me.container, 'c-c'); + pos = me.container.translatePoints(xy[0], xy[1]); + } + me.x = me.x === undefined ? pos.left: me.x; + me.y = me.y === undefined ? pos.top: me.y; + } + + if (Ext.isDefined(me.x) || Ext.isDefined(me.y)) { + me.setPosition(me.x, me.y); + } + + if (me.styleHtmlContent) { + me.getTargetEl().addCls(me.styleHtmlCls); + } + }, + + frameCls: Ext.baseCSSPrefix + 'frame', + + frameTpl: [ + '', + '

{parent.baseCls}-{parent.ui}-{.}-tl" style="background-position: {tl}; padding-left: {frameWidth}px" role="presentation">', + '

{parent.baseCls}-{parent.ui}-{.}-tr" style="background-position: {tr}; padding-right: {frameWidth}px" role="presentation">', + '

{parent.baseCls}-{parent.ui}-{.}-tc" style="background-position: {tc}; height: {frameWidth}px" role="presentation">

', + '

', + '', + '

{parent.baseCls}-{parent.ui}-{.}-ml" style="background-position: {ml}; padding-left: {frameWidth}px" role="presentation">', + '

{parent.baseCls}-{parent.ui}-{.}-mr" style="background-position: {mr}; padding-right: {frameWidth}px" role="presentation">', + '

{parent.baseCls}-{parent.ui}-{.}-mc" role="presentation">

', + '

', + '', + '

{parent.baseCls}-{parent.ui}-{.}-bl" style="background-position: {bl}; padding-left: {frameWidth}px" role="presentation">', + '

{parent.baseCls}-{parent.ui}-{.}-br" style="background-position: {br}; padding-right: {frameWidth}px" role="presentation">', + '

{parent.baseCls}-{parent.ui}-{.}-bc" style="background-position: {bc}; height: {frameWidth}px" role="presentation">

', + '

', + '' + ], + + frameTableTpl: [ + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '

{parent.baseCls}-{parent.ui}-{.}-tl" style="background-position: {tl}; padding-left:{frameWidth}px" role="presentation">	{parent.baseCls}-{parent.ui}-{.}-tc" style="background-position: {tc}; height: {frameWidth}px" role="presentation">	{parent.baseCls}-{parent.ui}-{.}-tr" style="background-position: {tr}; padding-left: {frameWidth}px" role="presentation">
{parent.baseCls}-{parent.ui}-{.}-ml" style="background-position: {ml}; padding-left: {frameWidth}px" role="presentation">	{parent.baseCls}-{parent.ui}-{.}-mc" style="background-position: 0 0;" role="presentation">	{parent.baseCls}-{parent.ui}-{.}-mr" style="background-position: {mr}; padding-left: {frameWidth}px" role="presentation">
{parent.baseCls}-{parent.ui}-{.}-bl" style="background-position: {bl}; padding-left: {frameWidth}px" role="presentation">	{parent.baseCls}-{parent.ui}-{.}-bc" style="background-position: {bc}; height: {frameWidth}px" role="presentation">	{parent.baseCls}-{parent.ui}-{.}-br" style="background-position: {br}; padding-left: {frameWidth}px" role="presentation">

' + ], + + /** + * @private + */ + initFrame : function() { + if (Ext.supports.CSS3BorderRadius) { + return false; + } + + var me = this, + frameInfo = me.getFrameInfo(), + frameWidth = frameInfo.width, + frameTpl = me.getFrameTpl(frameInfo.table); + + if (me.frame) { + // Here we render the frameTpl to this component. This inserts the 9point div or the table framing. + frameTpl.insertFirst(me.el, Ext.apply({}, { + ui: me.ui, + uiCls: me.uiCls, + frameCls: me.frameCls, + baseCls: me.baseCls, + frameWidth: frameWidth, + top: !!frameInfo.top, + left: !!frameInfo.left, + right: !!frameInfo.right, + bottom: !!frameInfo.bottom + }, me.getFramePositions(frameInfo))); + + // The frameBody is returned in getTargetEl, so that layouts render items to the correct target.= + me.frameBody = me.el.down('.' + me.frameCls + '-mc'); + + // Add the render selectors for each of the frame elements + Ext.apply(me.renderSelectors, { + frameTL: '.' + me.baseCls + '-tl', + frameTC: '.' + me.baseCls + '-tc', + frameTR: '.' + me.baseCls + '-tr', + frameML: '.' + me.baseCls + '-ml', + frameMC: '.' + me.baseCls + '-mc', + frameMR: '.' + me.baseCls + '-mr', + frameBL: '.' + me.baseCls + '-bl', + frameBC: '.' + me.baseCls + '-bc', + frameBR: '.' + me.baseCls + '-br' + }); + } + }, + + updateFrame: function() { + if (Ext.supports.CSS3BorderRadius) { + return false; + } + + var me = this, + wasTable = this.frameSize && this.frameSize.table, + oldFrameTL = this.frameTL, + oldFrameBL = this.frameBL, + oldFrameML = this.frameML, + oldFrameMC = this.frameMC, + newMCClassName; + + this.initFrame(); + + if (oldFrameMC) { + if (me.frame) { + // Reapply render selectors + delete me.frameTL; + delete me.frameTC; + delete me.frameTR; + delete me.frameML; + delete me.frameMC; + delete me.frameMR; + delete me.frameBL; + delete me.frameBC; + delete me.frameBR; + this.applyRenderSelectors(); + + // Store the class names set on the new mc + newMCClassName = this.frameMC.dom.className; + + // Replace the new mc with the old mc + oldFrameMC.insertAfter(this.frameMC); + this.frameMC.remove(); + + // Restore the reference to the old frame mc as the framebody + this.frameBody = this.frameMC = oldFrameMC; + + // Apply the new mc classes to the old mc element + oldFrameMC.dom.className = newMCClassName; + + // Remove the old framing + if (wasTable) { + me.el.query('> table')[1].remove(); + } + else { + if (oldFrameTL) { + oldFrameTL.remove(); + } + if (oldFrameBL) { + oldFrameBL.remove(); + } + oldFrameML.remove(); + } + } + else { + // We were framed but not anymore. Move all content from the old frame to the body + + } + } + else if (me.frame) { + this.applyRenderSelectors(); + } + }, + + getFrameInfo: function() { + if (Ext.supports.CSS3BorderRadius) { + return false; + } + + var me = this, + left = me.el.getStyle('background-position-x'), + top = me.el.getStyle('background-position-y'), + info, frameInfo = false, max; + + // Some browsers dont support background-position-x and y, so for those + // browsers let's split background-position into two parts. + if (!left && !top) { + info = me.el.getStyle('background-position').split(' '); + left = info[0]; + top = info[1]; + } + + // We actually pass a string in the form of '[type][tl][tr]px [type][br][bl]px' as + // the background position of this.el from the css to indicate to IE that this component needs + // framing. We parse it here and change the markup accordingly. + if (parseInt(left, 10) >= 1000000 && parseInt(top, 10) >= 1000000) { + max = Math.max; + + frameInfo = { + // Table markup starts with 110, div markup with 100. + table: left.substr(0, 3) == '110', + + // Determine if we are dealing with a horizontal or vertical component + vertical: top.substr(0, 3) == '110', + + // Get and parse the different border radius sizes + top: max(left.substr(3, 2), left.substr(5, 2)), + right: max(left.substr(5, 2), top.substr(3, 2)), + bottom: max(top.substr(3, 2), top.substr(5, 2)), + left: max(top.substr(5, 2), left.substr(3, 2)) + }; + + frameInfo.width = max(frameInfo.top, frameInfo.right, frameInfo.bottom, frameInfo.left); + + // Just to be sure we set the background image of the el to none. + me.el.setStyle('background-image', 'none'); + } + + // This happens when you set frame: true explicitly without using the x-frame mixin in sass. + // This way IE can't figure out what sizes to use and thus framing can't work. + if (me.frame === true && !frameInfo) { + Ext.Error.raise("You have set frame: true explicity on this component while it doesn't have any " + + "framing defined in the CSS template. In this case IE can't figure out what sizes " + + "to use and thus framing on this component will be disabled."); + } + + me.frame = me.frame || !!frameInfo; + me.frameSize = frameInfo || false; + + return frameInfo; + }, + + getFramePositions: function(frameInfo) { + var me = this, + frameWidth = frameInfo.width, + dock = me.dock, + positions, tc, bc, ml, mr; + + if (frameInfo.vertical) { + tc = '0 -' + (frameWidth * 0) + 'px'; + bc = '0 -' + (frameWidth * 1) + 'px'; + + if (dock && dock == "right") { + tc = 'right -' + (frameWidth * 0) + 'px'; + bc = 'right -' + (frameWidth * 1) + 'px'; + } + + positions = { + tl: '0 -' + (frameWidth * 0) + 'px', + tr: '0 -' + (frameWidth * 1) + 'px', + bl: '0 -' + (frameWidth * 2) + 'px', + br: '0 -' + (frameWidth * 3) + 'px', + + ml: '-' + (frameWidth * 1) + 'px 0', + mr: 'right 0', + + tc: tc, + bc: bc + }; + } else { + ml = '-' + (frameWidth * 0) + 'px 0'; + mr = 'right 0'; + + if (dock && dock == "bottom") { + ml = 'left bottom'; + mr = 'right bottom'; + } + + positions = { + tl: '0 -' + (frameWidth * 2) + 'px', + tr: 'right -' + (frameWidth * 3) + 'px', + bl: '0 -' + (frameWidth * 4) + 'px', + br: 'right -' + (frameWidth * 5) + 'px', + + ml: ml, + mr: mr, + + tc: '0 -' + (frameWidth * 0) + 'px', + bc: '0 -' + (frameWidth * 1) + 'px' + }; + } + + return positions; + }, + + /** + * @private + */ + getFrameTpl : function(table) { + return table ? this.getTpl('frameTableTpl') : this.getTpl('frameTpl'); + }, + + /** + *

Creates an array of class names from the configurations to add to this Component's el on render.

+ *

Private, but (possibly) used by ComponentQuery for selection by class name if Component is not rendered.

+ * @return {Array} An array of class names with which the Component's element will be rendered. + * @private + */ + initCls: function() { + var me = this, + cls = []; + + cls.push(me.baseCls); + + if (Ext.isDefined(me.cmpCls)) { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.Component: cmpCls has been deprecated. Please use componentCls.'); + } + me.componentCls = me.cmpCls; + delete me.cmpCls; + } + + if (me.componentCls) { + cls.push(me.componentCls); + } else { + me.componentCls = me.baseCls; + } + if (me.cls) { + cls.push(me.cls); + delete me.cls; + } + + return cls.concat(me.additionalCls); + }, + + /** + * Sets the UI for the component. This will remove any existing UIs on the component. It will also + * loop through any uiCls set on the component and rename them so they include the new UI + * @param {String} ui The new UI for the component + */ + setUI: function(ui) { + var me = this, + oldUICls = Ext.Array.clone(me.uiCls), + newUICls = [], + cls, + i; + + //loop through all exisiting uiCls and update the ui in them + for (i = 0; i < oldUICls.length; i++) { + cls = oldUICls[i]; + + me.removeClsWithUI(cls); + newUICls.push(cls); + } + + //remove the UI from the element + me.removeUIFromElement(); + + //set the UI + me.ui = ui; + + //add the new UI to the elemend + me.addUIToElement(); + + //loop through all exisiting uiCls and update the ui in them + for (i = 0; i < newUICls.length; i++) { + cls = newUICls[i]; + + me.addClsWithUI(cls); + } + }, + + /** + * Adds a cls to the uiCls array, which will also call {@link #addUIClsToElement} and adds + * to all elements of this component. + * @param {String/Array} cls A string or an array of strings to add to the uiCls + */ + addClsWithUI: function(cls) { + var me = this, + i; + + if (!Ext.isArray(cls)) { + cls = [cls]; + } + + for (i = 0; i < cls.length; i++) { + if (cls[i] && !me.hasUICls(cls[i])) { + me.uiCls = Ext.Array.clone(me.uiCls); + me.uiCls.push(cls[i]); + me.addUIClsToElement(cls[i]); + } + } + }, + + /** + * Removes a cls to the uiCls array, which will also call {@link #removeUIClsToElement} and removes + * it from all elements of this component. + * @param {String/Array} cls A string or an array of strings to remove to the uiCls + */ + removeClsWithUI: function(cls) { + var me = this, + i; + + if (!Ext.isArray(cls)) { + cls = [cls]; + } + + for (i = 0; i < cls.length; i++) { + if (cls[i] && me.hasUICls(cls[i])) { + me.uiCls = Ext.Array.remove(me.uiCls, cls[i]); + me.removeUIClsFromElement(cls[i]); + } + } + }, + + /** + * Checks if there is currently a specified uiCls + * @param {String} cls The cls to check + */ + hasUICls: function(cls) { + var me = this, + uiCls = me.uiCls || []; + + return Ext.Array.contains(uiCls, cls); + }, + + /** + * Method which adds a specified UI + uiCls to the components element. + * Can be overridden to remove the UI from more than just the components element. + * @param {String} ui The UI to remove from the element + * @private + */ + addUIClsToElement: function(cls, force) { + var me = this; + + me.addCls(Ext.baseCSSPrefix + cls); + me.addCls(me.baseCls + '-' + cls); + me.addCls(me.baseCls + '-' + me.ui + '-' + cls); + + if (!force && me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { + // define each element of the frame + var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], + i, el; + + // loop through each of them, and if they are defined add the ui + for (i = 0; i < els.length; i++) { + el = me['frame' + els[i].toUpperCase()]; + + if (el && el.dom) { + el.addCls(me.baseCls + '-' + me.ui + '-' + els[i]); + el.addCls(me.baseCls + '-' + me.ui + '-' + cls + '-' + els[i]); + } + } + } + }, + + /** + * Method which removes a specified UI + uiCls from the components element. + * The cls which is added to the element will be: `this.baseCls + '-' + ui` + * @param {String} ui The UI to add to the element + * @private + */ + removeUIClsFromElement: function(cls, force) { + var me = this; + + me.removeCls(Ext.baseCSSPrefix + cls); + me.removeCls(me.baseCls + '-' + cls); + me.removeCls(me.baseCls + '-' + me.ui + '-' + cls); + + if (!force &&me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { + // define each element of the frame + var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], + i, el; + + // loop through each of them, and if they are defined add the ui + for (i = 0; i < els.length; i++) { + el = me['frame' + els[i].toUpperCase()]; + if (el && el.dom) { + el.removeCls(me.baseCls + '-' + me.ui + '-' + cls + '-' + els[i]); + } + } + } + }, + + /** + * Method which adds a specified UI to the components element. + * @private + */ + addUIToElement: function(force) { + var me = this; + + me.addCls(me.baseCls + '-' + me.ui); + + if (me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { + // define each element of the frame + var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], + i, el; + + // loop through each of them, and if they are defined add the ui + for (i = 0; i < els.length; i++) { + el = me['frame' + els[i].toUpperCase()]; + + if (el) { + el.addCls(me.baseCls + '-' + me.ui + '-' + els[i]); + } + } + } + }, + + /** + * Method which removes a specified UI from the components element. + * @private + */ + removeUIFromElement: function() { + var me = this; + + me.removeCls(me.baseCls + '-' + me.ui); + + if (me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { + // define each element of the frame + var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], + i, el; + + // loop through each of them, and if they are defined add the ui + for (i = 0; i < els.length; i++) { + el = me['frame' + els[i].toUpperCase()]; + if (el) { + el.removeCls(me.baseCls + '-' + me.ui + '-' + els[i]); + } + } + } + }, + + getElConfig : function() { + var result = this.autoEl || {tag: 'div'}; + result.id = this.id; + return result; + }, + + /** + * This function takes the position argument passed to onRender and returns a + * DOM element that you can use in the insertBefore. + * @param {String/Number/Element/HTMLElement} position Index, element id or element you want + * to put this component before. + * @return {HTMLElement} DOM element that you can use in the insertBefore + */ + getInsertPosition: function(position) { + // Convert the position to an element to insert before + if (position !== undefined) { + if (Ext.isNumber(position)) { + position = this.container.dom.childNodes[position]; + } + else { + position = Ext.getDom(position); + } + } + + return position; + }, + + /** + * Adds ctCls to container. + * @return {Ext.core.Element} The initialized container + * @private + */ + initContainer: function(container) { + var me = this; + + // If you render a component specifying the el, we get the container + // of the el, and make sure we dont move the el around in the dom + // during the render + if (!container && me.el) { + container = me.el.dom.parentNode; + me.allowDomMove = false; + } + + me.container = Ext.get(container); + + if (me.ctCls) { + me.container.addCls(me.ctCls); + } + + return me.container; + }, + + /** + * Initialized the renderData to be used when rendering the renderTpl. + * @return {Object} Object with keys and values that are going to be applied to the renderTpl + * @private + */ + initRenderData: function() { + var me = this; + + return Ext.applyIf(me.renderData, { + ui: me.ui, + uiCls: me.uiCls, + baseCls: me.baseCls, + componentCls: me.componentCls, + frame: me.frame + }); + }, + + /** + * @private + */ + getTpl: function(name) { + var prototype = this.self.prototype, + ownerPrototype; + + if (this.hasOwnProperty(name)) { + if (!(this[name] instanceof Ext.XTemplate)) { + this[name] = Ext.ClassManager.dynInstantiate('Ext.XTemplate', this[name]); + } + + return this[name]; + } + + if (!(prototype[name] instanceof Ext.XTemplate)) { + ownerPrototype = prototype; + + do { + if (ownerPrototype.hasOwnProperty(name)) { + ownerPrototype[name] = Ext.ClassManager.dynInstantiate('Ext.XTemplate', ownerPrototype[name]); + break; + } + + ownerPrototype = ownerPrototype.superclass; + } while (ownerPrototype); + } + + return prototype[name]; + }, + + /** + * Initializes the renderTpl. + * @return {Ext.XTemplate} The renderTpl XTemplate instance. + * @private + */ + initRenderTpl: function() { + return this.getTpl('renderTpl'); + }, + + /** + * Function description + * @return {String} A CSS style string with style, padding, margin and border. + * @private + */ + initStyles: function() { + var style = {}, + me = this, + Element = Ext.core.Element; + + if (Ext.isString(me.style)) { + style = Element.parseStyles(me.style); + } else { + style = Ext.apply({}, me.style); + } + + // Convert the padding, margin and border properties from a space seperated string + // into a proper style string + if (me.padding !== undefined) { + style.padding = Element.unitizeBox((me.padding === true) ? 5 : me.padding); + } + + if (me.margin !== undefined) { + style.margin = Element.unitizeBox((me.margin === true) ? 5 : me.margin); + } + + delete me.style; + return style; + }, + + /** + * Initializes this components contents. It checks for the properties + * html, contentEl and tpl/data. + * @private + */ + initContent: function() { + var me = this, + target = me.getTargetEl(), + contentEl, + pre; + + if (me.html) { + target.update(Ext.core.DomHelper.markup(me.html)); + delete me.html; + } + + if (me.contentEl) { + contentEl = Ext.get(me.contentEl); + pre = Ext.baseCSSPrefix; + contentEl.removeCls([pre + 'hidden', pre + 'hide-display', pre + 'hide-offsets', pre + 'hide-nosize']); + target.appendChild(contentEl.dom); + } + + if (me.tpl) { + // Make sure this.tpl is an instantiated XTemplate + if (!me.tpl.isTemplate) { + me.tpl = Ext.create('Ext.XTemplate', me.tpl); + } + + if (me.data) { + me.tpl[me.tplWriteMode](target, me.data); + delete me.data; + } + } + }, + + // @private + initEvents : function() { + var me = this, + afterRenderEvents = me.afterRenderEvents, + property, listeners; + if (afterRenderEvents) { + for (property in afterRenderEvents) { + if (afterRenderEvents.hasOwnProperty(property)) { + listeners = afterRenderEvents[property]; + if (me[property] && me[property].on) { + me.mon(me[property], listeners); + } + } + } + } + }, + + /** + * Sets references to elements inside the component. E.g body -> x-panel-body + * @private + */ + applyRenderSelectors: function() { + var selectors = this.renderSelectors || {}, + el = this.el.dom, + selector; + + for (selector in selectors) { + if (selectors.hasOwnProperty(selector) && selectors[selector]) { + this[selector] = Ext.get(Ext.DomQuery.selectNode(selectors[selector], el)); + } + } + }, + + /** + * Tests whether this Component matches the selector string. + * @param {String} selector The selector string to test against. + * @return {Boolean} True if this Component matches the selector. + */ + is: function(selector) { + return Ext.ComponentQuery.is(this, selector); + }, + + /** + *

Walks up the ownerCt axis looking for an ancestor Container which matches + * the passed simple selector.

+ *

Example:


+var owningTabPanel = grid.up('tabpanel');
+

+ * @param {String} selector Optional. The simple selector to test. + * @return {Container} The matching ancestor Container (or undefined if no match was found). + */ + up: function(selector) { + var result = this.ownerCt; + if (selector) { + for (; result; result = result.ownerCt) { + if (Ext.ComponentQuery.is(result, selector)) { + return result; + } + } + } + return result; + }, + + /** + *

Returns the next sibling of this Component.

+ *

Optionally selects the next sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery} selector.

+ *

May also be refered to as next()

+ *

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with {@link #nextNode}

+ * @param {String} selector Optional A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following items. + * @returns The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling. + */ + nextSibling: function(selector) { + var o = this.ownerCt, it, last, idx, c; + if (o) { + it = o.items; + idx = it.indexOf(this) + 1; + if (idx) { + if (selector) { + for (last = it.getCount(); idx < last; idx++) { + if ((c = it.getAt(idx)).is(selector)) { + return c; + } + } + } else { + if (idx < it.getCount()) { + return it.getAt(idx); + } + } + } + } + return null; + }, + + /** + *

Returns the previous sibling of this Component.

+ *

Optionally selects the previous sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery} selector.

+ *

May also be refered to as prev()

+ *

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with {@link #previousNode}

+ * @param {String} selector Optional. A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding items. + * @returns The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling. + */ + previousSibling: function(selector) { + var o = this.ownerCt, it, idx, c; + if (o) { + it = o.items; + idx = it.indexOf(this); + if (idx != -1) { + if (selector) { + for (--idx; idx >= 0; idx--) { + if ((c = it.getAt(idx)).is(selector)) { + return c; + } + } + } else { + if (idx) { + return it.getAt(--idx); + } + } + } + } + return null; + }, + + /** + *

Returns the previous node in the Component tree in tree traversal order.

+ *

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will + * walk the tree in reverse order to attempt to find a match. Contrast with {@link #previousSibling}.

+ * @param {String} selector Optional. A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding nodes. + * @returns The previous node (or the previous node which matches the selector). Returns null if there is no matching node. + */ + previousNode: function(selector, includeSelf) { + var node = this, + result, + it, len, i; + + // If asked to include self, test me + if (includeSelf && node.is(selector)) { + return node; + } + + result = this.prev(selector); + if (result) { + return result; + } + + if (node.ownerCt) { + for (it = node.ownerCt.items.items, i = Ext.Array.indexOf(it, node) - 1; i > -1; i--) { + if (it[i].query) { + result = it[i].query(selector); + result = result[result.length - 1]; + if (result) { + return result; + } + } + } + return node.ownerCt.previousNode(selector, true); + } + }, + + /** + *

Returns the next node in the Component tree in tree traversal order.

+ *

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will + * walk the tree to attempt to find a match. Contrast with {@link #pnextSibling}.

+ * @param {String} selector Optional A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following nodes. + * @returns The next node (or the next node which matches the selector). Returns null if there is no matching node. + */ + nextNode: function(selector, includeSelf) { + var node = this, + result, + it, len, i; + + // If asked to include self, test me + if (includeSelf && node.is(selector)) { + return node; + } + + result = this.next(selector); + if (result) { + return result; + } + + if (node.ownerCt) { + for (it = node.ownerCt.items, i = it.indexOf(node) + 1, it = it.items, len = it.length; i < len; i++) { + if (it[i].down) { + result = it[i].down(selector); + if (result) { + return result; + } + } + } + return node.ownerCt.nextNode(selector); + } + }, + + /** + * Retrieves the id of this component. + * Will autogenerate an id if one has not already been set. + */ + getId : function() { + return this.id || (this.id = 'ext-comp-' + (this.getAutoId())); + }, + + getItemId : function() { + return this.itemId || this.id; + }, + + /** + * Retrieves the top level element representing this component. + */ + getEl : function() { + return this.el; + }, + + /** + * This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. + * @private + */ + getTargetEl: function() { + return this.frameBody || this.el; + }, + + /** + *

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended + * from the xtype (default) or whether it is directly of the xtype specified (shallow = true).

+ *

If using your own subclasses, be aware that a Component must register its own xtype + * to participate in determination of inherited xtypes.

+ *

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

+ *

Example usage:

+ *


+var t = new Ext.form.field.Text();
+var isText = t.isXType('textfield');        // true
+var isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.field.Base
+var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance
+

+ * @param {String} xtype The xtype to check for this Component + * @param {Boolean} shallow (optional) False to check whether this Component is descended from the xtype (this is + * the default), or true to check whether this Component is directly of the specified xtype. + * @return {Boolean} True if this component descends from the specified xtype, false otherwise. + */ + isXType: function(xtype, shallow) { + //assume a string by default + if (Ext.isFunction(xtype)) { + xtype = xtype.xtype; + //handle being passed the class, e.g. Ext.Component + } else if (Ext.isObject(xtype)) { + xtype = xtype.statics().xtype; + //handle being passed an instance + } + + return !shallow ? ('/' + this.getXTypes() + '/').indexOf('/' + xtype + '/') != -1: this.self.xtype == xtype; + }, + + /** + *

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all + * available xtypes, see the {@link Ext.Component} header.

+ *

If using your own subclasses, be aware that a Component must register its own xtype + * to participate in determination of inherited xtypes.

+ *

Example usage:

+ *


+var t = new Ext.form.field.Text();
+alert(t.getXTypes());  // alerts 'component/field/textfield'
+

+ * @return {String} The xtype hierarchy string + */ + getXTypes: function() { + var self = this.self, + xtypes = [], + parentPrototype = this, + xtype; + + if (!self.xtypes) { + while (parentPrototype && Ext.getClass(parentPrototype)) { + xtype = Ext.getClass(parentPrototype).xtype; + + if (xtype !== undefined) { + xtypes.unshift(xtype); + } + + parentPrototype = parentPrototype.superclass; + } + + self.xtypeChain = xtypes; + self.xtypes = xtypes.join('/'); + } + + return self.xtypes; + }, + + /** + * Update the content area of a component. + * @param {Mixed} htmlOrData + * If this component has been configured with a template via the tpl config + * then it will use this argument as data to populate the template. + * If this component was not configured with a template, the components + * content area will be updated via Ext.core.Element update + * @param {Boolean} loadScripts + * (optional) Only legitimate when using the html configuration. Defaults to false + * @param {Function} callback + * (optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading + */ + update : function(htmlOrData, loadScripts, cb) { + var me = this; + + if (me.tpl && !Ext.isString(htmlOrData)) { + me.data = htmlOrData; + if (me.rendered) { + me.tpl[me.tplWriteMode](me.getTargetEl(), htmlOrData || {}); + } + } else { + me.html = Ext.isObject(htmlOrData) ? Ext.core.DomHelper.markup(htmlOrData) : htmlOrData; + if (me.rendered) { + me.getTargetEl().update(me.html, loadScripts, cb); + } + } + + if (me.rendered) { + me.doComponentLayout(); + } + }, + + /** + * Convenience function to hide or show this component by boolean. + * @param {Boolean} visible True to show, false to hide + * @return {Ext.Component} this + */ + setVisible : function(visible) { + return this[visible ? 'show': 'hide'](); + }, + + /** + * Returns true if this component is visible. + * @param {Boolean} deep.

Optional. Pass true to interrogate the visibility status of all + * parent Containers to determine whether this Component is truly visible to the user.

+ *

Generally, to determine whether a Component is hidden, the no argument form is needed. For example + * when creating dynamically laid out UIs in a hidden Container before showing them.

+ * @return {Boolean} True if this component is visible, false otherwise. + */ + isVisible: function(deep) { + var me = this, + child = me, + visible = !me.hidden, + ancestor = me.ownerCt; + + // Clear hiddenOwnerCt property + me.hiddenAncestor = false; + if (me.destroyed) { + return false; + } + + if (deep && visible && me.rendered && ancestor) { + while (ancestor) { + // If any ancestor is hidden, then this is hidden. + // If an ancestor Panel (only Panels have a collapse method) is collapsed, + // then its layoutTarget (body) is hidden, so this is hidden unless its within a + // docked item; they are still visible when collapsed (Unless they themseves are hidden) + if (ancestor.hidden || (ancestor.collapsed && + !(ancestor.getDockedItems && Ext.Array.contains(ancestor.getDockedItems(), child)))) { + // Store hiddenOwnerCt property if needed + me.hiddenAncestor = ancestor; + visible = false; + break; + } + child = ancestor; + ancestor = ancestor.ownerCt; + } + } + return visible; + }, + + /** + * Enable the component + * @param {Boolean} silent + * Passing false will supress the 'enable' event from being fired. + */ + enable: function(silent) { + var me = this; + + if (me.rendered) { + me.el.removeCls(me.disabledCls); + me.el.dom.disabled = false; + me.onEnable(); + } + + me.disabled = false; + + if (silent !== true) { + me.fireEvent('enable', me); + } + + return me; + }, + + /** + * Disable the component. + * @param {Boolean} silent + * Passing true, will supress the 'disable' event from being fired. + */ + disable: function(silent) { + var me = this; + + if (me.rendered) { + me.el.addCls(me.disabledCls); + me.el.dom.disabled = true; + me.onDisable(); + } + + me.disabled = true; + + if (silent !== true) { + me.fireEvent('disable', me); + } + + return me; + }, + + // @private + onEnable: function() { + if (this.maskOnDisable) { + this.el.unmask(); + } + }, + + // @private + onDisable : function() { + if (this.maskOnDisable) { + this.el.mask(); + } + }, + + /** + * Method to determine whether this Component is currently disabled. + * @return {Boolean} the disabled state of this Component. + */ + isDisabled : function() { + return this.disabled; + }, + + /** + * Enable or disable the component. + * @param {Boolean} disabled + */ + setDisabled : function(disabled) { + return this[disabled ? 'disable': 'enable'](); + }, + + /** + * Method to determine whether this Component is currently set to hidden. + * @return {Boolean} the hidden state of this Component. + */ + isHidden : function() { + return this.hidden; + }, + + /** + * Adds a CSS class to the top level element representing this component. + * @param {String} cls The CSS class name to add + * @return {Ext.Component} Returns the Component to allow method chaining. + */ + addCls : function(className) { + var me = this; + if (!className) { + return me; + } + if (!Ext.isArray(className)){ + className = className.replace(me.trimRe, '').split(me.spacesRe); + } + if (me.rendered) { + me.el.addCls(className); + } + else { + me.additionalCls = Ext.Array.unique(me.additionalCls.concat(className)); + } + return me; + }, + + /** + * @deprecated 4.0 Replaced by {@link #addCls} + * Adds a CSS class to the top level element representing this component. + * @param {String} cls The CSS class name to add + * @return {Ext.Component} Returns the Component to allow method chaining. + */ + addClass : function() { + return this.addCls.apply(this, arguments); + }, + + /** + * Removes a CSS class from the top level element representing this component. + * @returns {Ext.Component} Returns the Component to allow method chaining. + */ + removeCls : function(className) { + var me = this; + + if (!className) { + return me; + } + if (!Ext.isArray(className)){ + className = className.replace(me.trimRe, '').split(me.spacesRe); + } + if (me.rendered) { + me.el.removeCls(className); + } + else if (me.additionalCls.length) { + Ext.each(className, function(cls) { + Ext.Array.remove(me.additionalCls, cls); + }); + } + return me; + }, + + removeClass : function() { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.Component: removeClass has been deprecated. Please use removeCls.'); + } + return this.removeCls.apply(this, arguments); + }, + + addOverCls: function() { + var me = this; + if (!me.disabled) { + me.el.addCls(me.overCls); + } + }, + + removeOverCls: function() { + this.el.removeCls(this.overCls); + }, + + addListener : function(element, listeners, scope, options) { + var me = this, + fn, + option; + + if (Ext.isString(element) && (Ext.isObject(listeners) || options && options.element)) { + if (options.element) { + fn = listeners; + + listeners = {}; + listeners[element] = fn; + element = options.element; + if (scope) { + listeners.scope = scope; + } + + for (option in options) { + if (options.hasOwnProperty(option)) { + if (me.eventOptionsRe.test(option)) { + listeners[option] = options[option]; + } + } + } + } + + // At this point we have a variable called element, + // and a listeners object that can be passed to on + if (me[element] && me[element].on) { + me.mon(me[element], listeners); + } else { + me.afterRenderEvents = me.afterRenderEvents || {}; + me.afterRenderEvents[element] = listeners; + } + } + + return me.mixins.observable.addListener.apply(me, arguments); + }, + + // inherit docs + removeManagedListenerItem: function(isClear, managedListener, item, ename, fn, scope){ + var me = this, + element = managedListener.options ? managedListener.options.element : null; + + if (element) { + element = me[element]; + if (element && element.un) { + if (isClear || (managedListener.item === item && managedListener.ename === ename && (!fn || managedListener.fn === fn) && (!scope || managedListener.scope === scope))) { + element.un(managedListener.ename, managedListener.fn, managedListener.scope); + if (!isClear) { + Ext.Array.remove(me.managedListeners, managedListener); + } + } + } + } else { + return me.mixins.observable.removeManagedListenerItem.apply(me, arguments); + } + }, + + /** + * Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. + * @return {Ext.container.Container} the Container which owns this Component. + */ + getBubbleTarget : function() { + return this.ownerCt; + }, + + /** + * Method to determine whether this Component is floating. + * @return {Boolean} the floating state of this component. + */ + isFloating : function() { + return this.floating; + }, + + /** + * Method to determine whether this Component is draggable. + * @return {Boolean} the draggable state of this component. + */ + isDraggable : function() { + return !!this.draggable; + }, + + /** + * Method to determine whether this Component is droppable. + * @return {Boolean} the droppable state of this component. + */ + isDroppable : function() { + return !!this.droppable; + }, + + /** + * @private + * Method to manage awareness of when components are added to their + * respective Container, firing an added event. + * References are established at add time rather than at render time. + * @param {Ext.container.Container} container Container which holds the component + * @param {number} pos Position at which the component was added + */ + onAdded : function(container, pos) { + this.ownerCt = container; + this.fireEvent('added', this, container, pos); + }, + + /** + * @private + * Method to manage awareness of when components are removed from their + * respective Container, firing an removed event. References are properly + * cleaned up after removing a component from its owning container. + */ + onRemoved : function() { + var me = this; + + me.fireEvent('removed', me, me.ownerCt); + delete me.ownerCt; + }, + + // @private + beforeDestroy : Ext.emptyFn, + // @private + // @private + onResize : Ext.emptyFn, + + /** + * Sets the width and height of this Component. This method fires the {@link #resize} event. This method can accept + * either width and height as separate arguments, or you can pass a size object like {width:10, height:20}. + * @param {Mixed} width The new width to set. This may be one of:

A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.core.Element#defaultUnit}s (by default, pixels).
A String used to set the CSS width style.
A size object in the format {width: widthValue, height: heightValue}.
undefined to leave the width unchanged.

+ * @param {Mixed} height The new height to set (not required if a size object is passed as the first arg). + * This may be one of:

A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.core.Element#defaultUnit}s (by default, pixels).
A String used to set the CSS height style. Animation may not be used.
undefined to leave the height unchanged.

+ * @return {Ext.Component} this + */ + setSize : function(width, height) { + var me = this, + layoutCollection; + + // support for standard size objects + if (Ext.isObject(width)) { + height = width.height; + width = width.width; + } + + // Constrain within configured maxima + if (Ext.isNumber(width)) { + width = Ext.Number.constrain(width, me.minWidth, me.maxWidth); + } + if (Ext.isNumber(height)) { + height = Ext.Number.constrain(height, me.minHeight, me.maxHeight); + } + + if (!me.rendered || !me.isVisible()) { + // If an ownerCt is hidden, add my reference onto the layoutOnShow stack. Set the needsLayout flag. + if (me.hiddenAncestor) { + layoutCollection = me.hiddenAncestor.layoutOnShow; + layoutCollection.remove(me); + layoutCollection.add(me); + } + me.needsLayout = { + width: width, + height: height, + isSetSize: true + }; + if (!me.rendered) { + me.width = (width !== undefined) ? width : me.width; + me.height = (height !== undefined) ? height : me.height; + } + return me; + } + me.doComponentLayout(width, height, true); + + return me; + }, + + setCalculatedSize : function(width, height, ownerCt) { + var me = this, + layoutCollection; + + // support for standard size objects + if (Ext.isObject(width)) { + ownerCt = width.ownerCt; + height = width.height; + width = width.width; + } + + // Constrain within configured maxima + if (Ext.isNumber(width)) { + width = Ext.Number.constrain(width, me.minWidth, me.maxWidth); + } + if (Ext.isNumber(height)) { + height = Ext.Number.constrain(height, me.minHeight, me.maxHeight); + } + + if (!me.rendered || !me.isVisible()) { + // If an ownerCt is hidden, add my reference onto the layoutOnShow stack. Set the needsLayout flag. + if (me.hiddenAncestor) { + layoutCollection = me.hiddenAncestor.layoutOnShow; + layoutCollection.remove(me); + layoutCollection.add(me); + } + me.needsLayout = { + width: width, + height: height, + isSetSize: false, + ownerCt: ownerCt + }; + return me; + } + me.doComponentLayout(width, height, false, ownerCt); + + return me; + }, + + /** + * This method needs to be called whenever you change something on this component that requires the Component's + * layout to be recalculated. + * @return {Ext.container.Container} this + */ + doComponentLayout : function(width, height, isSetSize, ownerCt) { + var me = this, + componentLayout = me.getComponentLayout(); + + // collapsed state is not relevant here, so no testing done. + // Only Panels have a collapse method, and that just sets the width/height such that only + // a single docked Header parallel to the collapseTo side are visible, and the Panel body is hidden. + if (me.rendered && componentLayout) { + width = (width !== undefined) ? width : me.width; + height = (height !== undefined) ? height : me.height; + if (isSetSize) { + me.width = width; + me.height = height; + } + + componentLayout.layout(width, height, isSetSize, ownerCt); + } + return me; + }, + + // @private + setComponentLayout : function(layout) { + var currentLayout = this.componentLayout; + if (currentLayout && currentLayout.isLayout && currentLayout != layout) { + currentLayout.setOwner(null); + } + this.componentLayout = layout; + layout.setOwner(this); + }, + + getComponentLayout : function() { + var me = this; + + if (!me.componentLayout || !me.componentLayout.isLayout) { + me.setComponentLayout(Ext.layout.Layout.create(me.componentLayout, 'autocomponent')); + } + return me.componentLayout; + }, + + /** + * @param {Number} adjWidth The box-adjusted width that was set + * @param {Number} adjHeight The box-adjusted height that was set + * @param {Boolean} isSetSize Whether or not the height/width are stored on the component permanently + * @param {Ext.Component} layoutOwner Component which sent the layout. Only used when isSetSize is false. + */ + afterComponentLayout: function(width, height, isSetSize, layoutOwner) { + this.fireEvent('resize', this, width, height); + }, + + /** + * Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout + * from being executed. + * @param {Number} adjWidth The box-adjusted width that was set + * @param {Number} adjHeight The box-adjusted height that was set + * @param {Boolean} isSetSize Whether or not the height/width are stored on the component permanently + * @param {Ext.Component} layoutOwner Component which sent the layout. Only used when isSetSize is false. + */ + beforeComponentLayout: function(width, height, isSetSize, layoutOwner) { + return true; + }, + + /** + * Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}. + * This method fires the {@link #move} event. + * @param {Number} left The new left + * @param {Number} top The new top + * @return {Ext.Component} this + */ + setPosition : function(x, y) { + var me = this; + + if (Ext.isObject(x)) { + y = x.y; + x = x.x; + } + + if (!me.rendered) { + return me; + } + + if (x !== undefined || y !== undefined) { + me.el.setBox(x, y); + me.onPosition(x, y); + me.fireEvent('move', me, x, y); + } + return me; + }, + + /* @private + * Called after the component is moved, this method is empty by default but can be implemented by any + * subclass that needs to perform custom logic after a move occurs. + * @param {Number} x The new x position + * @param {Number} y The new y position + */ + onPosition: Ext.emptyFn, + + /** + * Sets the width of the component. This method fires the {@link #resize} event. + * @param {Number} width The new width to setThis may be one of:

A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.core.Element#defaultUnit}s (by default, pixels).
A String used to set the CSS width style.

+ * @return {Ext.Component} this + */ + setWidth : function(width) { + return this.setSize(width); + }, + + /** + * Sets the height of the component. This method fires the {@link #resize} event. + * @param {Number} height The new height to set. This may be one of:

A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.core.Element#defaultUnit}s (by default, pixels).
A String used to set the CSS height style.
undefined to leave the height unchanged.

+ * @return {Ext.Component} this + */ + setHeight : function(height) { + return this.setSize(undefined, height); + }, + + /** + * Gets the current size of the component's underlying element. + * @return {Object} An object containing the element's size {width: (element width), height: (element height)} + */ + getSize : function() { + return this.el.getSize(); + }, + + /** + * Gets the current width of the component's underlying element. + * @return {Number} + */ + getWidth : function() { + return this.el.getWidth(); + }, + + /** + * Gets the current height of the component's underlying element. + * @return {Number} + */ + getHeight : function() { + return this.el.getHeight(); + }, + + /** + * Gets the {@link Ext.ComponentLoader} for this Component. + * @return {Ext.ComponentLoader} The loader instance, null if it doesn't exist. + */ + getLoader: function(){ + var me = this, + autoLoad = me.autoLoad ? (Ext.isObject(me.autoLoad) ? me.autoLoad : {url: me.autoLoad}) : null, + loader = me.loader || autoLoad; + + if (loader) { + if (!loader.isLoader) { + me.loader = Ext.create('Ext.ComponentLoader', Ext.apply({ + target: me, + autoLoad: autoLoad + }, loader)); + } else { + loader.setTarget(me); + } + return me.loader; + + } + return null; + }, + + /** + * This method allows you to show or hide a LoadMask on top of this component. + * @param {Boolean/Object/String} load True to show the default LoadMask, a config object + * that will be passed to the LoadMask constructor, or a message String to show. False to + * hide the current LoadMask. + * @param {Boolean} targetEl True to mask the targetEl of this Component instead of the this.el. + * For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false) + * @return {Ext.LoadMask} The LoadMask instance that has just been shown. + */ + setLoading : function(load, targetEl) { + var me = this, + config; + + if (me.rendered) { + if (load !== false && !me.collapsed) { + if (Ext.isObject(load)) { + config = load; + } + else if (Ext.isString(load)) { + config = {msg: load}; + } + else { + config = {}; + } + me.loadMask = me.loadMask || Ext.create('Ext.LoadMask', targetEl ? me.getTargetEl() : me.el, config); + me.loadMask.show(); + } else if (me.loadMask) { + Ext.destroy(me.loadMask); + me.loadMask = null; + } + } + + return me.loadMask; + }, + + /** + * Sets the dock position of this component in its parent panel. Note that + * this only has effect if this item is part of the dockedItems collection + * of a parent that has a DockLayout (note that any Panel has a DockLayout + * by default) + * @return {Component} this + */ + setDocked : function(dock, layoutParent) { + var me = this; + + me.dock = dock; + if (layoutParent && me.ownerCt && me.rendered) { + me.ownerCt.doComponentLayout(); + } + return me; + }, + + onDestroy : function() { + var me = this; + + if (me.monitorResize && Ext.EventManager.resizeEvent) { + Ext.EventManager.resizeEvent.removeListener(me.setSize, me); + } + Ext.destroy(me.componentLayout, me.loadMask); + }, + + /** + * Destroys the Component. + */ + destroy : function() { + var me = this; + + if (!me.isDestroyed) { + if (me.fireEvent('beforedestroy', me) !== false) { + me.destroying = true; + me.beforeDestroy(); + + if (me.floating) { + delete me.floatParent; + // A zIndexManager is stamped into a *floating* Component when it is added to a Container. + // If it has no zIndexManager at render time, it is assigned to the global Ext.WindowManager instance. + if (me.zIndexManager) { + me.zIndexManager.unregister(me); + } + } else if (me.ownerCt && me.ownerCt.remove) { + me.ownerCt.remove(me, false); + } + + if (me.rendered) { + me.el.remove(); + } + + me.onDestroy(); + + // Attempt to destroy all plugins + Ext.destroy(me.plugins); + + Ext.ComponentManager.unregister(me); + me.fireEvent('destroy', me); + + me.mixins.state.destroy.call(me); + + me.clearListeners(); + me.destroying = false; + me.isDestroyed = true; + } + } + }, + + /** + * Retrieves a plugin by its pluginId which has been bound to this + * component. + * @returns {Ext.AbstractPlugin} pluginInstance + */ + getPlugin: function(pluginId) { + var i = 0, + plugins = this.plugins, + ln = plugins.length; + for (; i < ln; i++) { + if (plugins[i].pluginId === pluginId) { + return plugins[i]; + } + } + }, + + /** + * Determines whether this component is the descendant of a particular container. + * @param {Ext.Container} container + * @returns {Boolean} isDescendant + */ + isDescendantOf: function(container) { + return !!this.findParentBy(function(p){ + return p === container; + }); + } +}, function() { + this.createAlias({ + on: 'addListener', + prev: 'previousSibling', + next: 'nextSibling' + }); +}); + +/** + * @class Ext.AbstractPlugin + * @extends Object + * + * Plugins are injected + */ +Ext.define('Ext.AbstractPlugin', { + disabled: false, + + constructor: function(config) { + if (!config.cmp && Ext.global.console) { + Ext.global.console.warn("Attempted to attach a plugin "); + } + Ext.apply(this, config); + }, + + getCmp: function() { + return this.cmp; + }, + + /** + * The init method is invoked after initComponent has been run for the + * component which we are injecting the plugin into. + * @method + */ + init: Ext.emptyFn, + + /** + * The destroy method is invoked by the owning Component at the time the Component is being destroyed. + * Use this method to clean up an resources. + * @method + */ + destroy: Ext.emptyFn, + + /** + * Enable the plugin and set the disabled flag to false. + */ + enable: function() { + this.disabled = false; + }, + + /** + * Disable the plugin and set the disabled flag to true. + */ + disable: function() { + this.disabled = true; + } +}); + +/** + * @class Ext.data.Connection + * The Connection class encapsulates a connection to the page's originating domain, allowing requests to be made either + * to a configured URL, or to a URL specified at request time. + * + * Requests made by this class are asynchronous, and will return immediately. No data from the server will be available + * to the statement immediately following the {@link #request} call. To process returned data, use a success callback + * in the request options object, or an {@link #requestcomplete event listener}. + * + *

File Uploads

+ * + * File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. + * Instead the form is submitted in the standard manner with the DOM <form> element temporarily modified to have its + * target set to refer to a dynamically generated, hidden <iframe> which is inserted into the document but removed + * after the return data has been gathered. + * + * The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to + * send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to + * insert the text unchanged into the document body. + * + * Characters which are significant to an HTML parser must be sent as HTML entities, so encode "<" as "<", "&" as + * "&" etc. + * + * The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a + * responseText property in order to conform to the requirements of event handlers and callbacks. + * + * Be aware that file upload packets are sent with the content type multipart/form and some server technologies + * (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the + * packet content. + * + * Also note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire. + */ +Ext.define('Ext.data.Connection', { + mixins: { + observable: 'Ext.util.Observable' + }, + + statics: { + requestId: 0 + }, + + url: null, + async: true, + method: null, + username: '', + password: '', + + /** + * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true) + */ + disableCaching: true, + + /** + * @cfg {String} disableCachingParam (Optional) Change the parameter which is sent went disabling caching + * through a cache buster. Defaults to '_dc' + */ + disableCachingParam: '_dc', + + /** + * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000) + */ + timeout : 30000, + + /** + * @cfg {Object} extraParams (Optional) Any parameters to be appended to the request. + */ + + useDefaultHeader : true, + defaultPostHeader : 'application/x-www-form-urlencoded; charset=UTF-8', + useDefaultXhrHeader : true, + defaultXhrHeader : 'XMLHttpRequest', + + constructor : function(config) { + config = config || {}; + Ext.apply(this, config); + + this.addEvents( + /** + * @event beforerequest + * Fires before a network request is made to retrieve a data object. + * @param {Connection} conn This Connection object. + * @param {Object} options The options config object passed to the {@link #request} method. + */ + 'beforerequest', + /** + * @event requestcomplete + * Fires if the request was successfully completed. + * @param {Connection} conn This Connection object. + * @param {Object} response The XHR object containing the response data. + * See The XMLHttpRequest Object + * for details. + * @param {Object} options The options config object passed to the {@link #request} method. + */ + 'requestcomplete', + /** + * @event requestexception + * Fires if an error HTTP status was returned from the server. + * See HTTP Status Code Definitions + * for details of HTTP status codes. + * @param {Connection} conn This Connection object. + * @param {Object} response The XHR object containing the response data. + * See The XMLHttpRequest Object + * for details. + * @param {Object} options The options config object passed to the {@link #request} method. + */ + 'requestexception' + ); + this.requests = {}; + this.mixins.observable.constructor.call(this); + }, + + /** + *

Sends an HTTP request to a remote server.

+ *

Important: Ajax server requests are asynchronous, and this call will + * return before the response has been received. Process any returned data + * in a callback function.

+ *


+Ext.Ajax.request({
+url: 'ajax_demo/sample.json',
+success: function(response, opts) {
+  var obj = Ext.decode(response.responseText);
+  console.dir(obj);
+},
+failure: function(response, opts) {
+  console.log('server-side failure with status code ' + response.status);
+}
+});
+     *

+ *

To execute a callback function in the correct scope, use the scope option.

+ * @param {Object} options An object which may contain the following properties:

url : String/Function (Optional)
The URL to + * which to send the request, or a function to call which returns a URL string. The scope of the + * function is specified by the scope option. Defaults to the configured + * {@link #url}.
params : Object/String/Function (Optional)
+ * An object containing properties which are used as parameters to the + * request, a url encoded string or a function to call to get either. The scope of the function + * is specified by the scope option.
method : String (Optional)
The HTTP method to use + * for the request. Defaults to the configured method, or if no method was configured, + * "GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that + * the method name is case-sensitive and should be all caps.
callback : Function (Optional)
The + * function to be called upon receipt of the HTTP response. The callback is + * called regardless of success or failure and is passed the following + * parameters:
- options : Object
  The parameter to the request call.
- success : Boolean
  True if the request succeeded.
- response : Object
  The XMLHttpRequest object containing the response data. + * See http://www.w3.org/TR/XMLHttpRequest/ for details about + * accessing elements of the response.
success : Function (Optional)
The function + * to be called upon success of the request. The callback is passed the following + * parameters:
- response : Object
  The XMLHttpRequest object containing the response data.
- options : Object
  The parameter to the request call.
failure : Function (Optional)
The function + * to be called upon failure of the request. The callback is passed the + * following parameters:
- response : Object
  The XMLHttpRequest object containing the response data.
- options : Object
  The parameter to the request call.
scope : Object (Optional)
The scope in + * which to execute the callbacks: The "this" object for the callback function. If the url, or params options were + * specified as functions from which to draw values, then this also serves as the scope for those function calls. + * Defaults to the browser window.
timeout : Number (Optional)
The timeout in milliseconds to be used for this request. Defaults to 30 seconds.
form : Element/HTMLElement/String (Optional)
The <form> + * Element or the id of the <form> to pull parameters from.
isUpload : Boolean (Optional)
Only meaningful when used + * with the form option. + *
True if the form object is a file upload (will be set automatically if the form was + * configured with enctype "multipart/form-data").
+ *
File uploads are not performed using normal "Ajax" techniques, that is they are not + * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the + * DOM <form> element temporarily modified to have its + * target set to refer + * to a dynamically generated, hidden <iframe> which is inserted into the document + * but removed after the return data has been gathered.
+ *
The server response is parsed by the browser to create the document for the IFRAME. If the + * server is using JSON to send the return object, then the + * Content-Type header + * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
+ *
The response text is retrieved from the document, and a fake XMLHttpRequest object + * is created containing a responseText property in order to conform to the + * requirements of event handlers and callbacks.
+ *
Be aware that file upload packets are sent with the content type multipart/form + * and some server technologies (notably JEE) may require some custom processing in order to + * retrieve parameter names and parameter values from the packet content.
+ *
headers : Object (Optional)
Request + * headers to set for the request.
xmlData : Object (Optional)
XML document + * to use for the post. Note: This will be used instead of params for the post + * data. Any params will be appended to the URL.
jsonData : Object/String (Optional)
JSON + * data to use as the post. Note: This will be used instead of params for the post + * data. Any params will be appended to the URL.
disableCaching : Boolean (Optional)
True + * to add a unique cache-buster param to GET requests.

+ *

The options object may also contain any other property which might be needed to perform + * postprocessing in a callback because it is passed to callback functions.

+ * @return {Object} request The request object. This may be used + * to cancel the request. + */ + request : function(options) { + options = options || {}; + var me = this, + scope = options.scope || window, + username = options.username || me.username, + password = options.password || me.password || '', + async, + requestOptions, + request, + headers, + xhr; + + if (me.fireEvent('beforerequest', me, options) !== false) { + + requestOptions = me.setOptions(options, scope); + + if (this.isFormUpload(options) === true) { + this.upload(options.form, requestOptions.url, requestOptions.data, options); + return null; + } + + // if autoabort is set, cancel the current transactions + if (options.autoAbort === true || me.autoAbort) { + me.abort(); + } + + // create a connection object + xhr = this.getXhrInstance(); + + async = options.async !== false ? (options.async || me.async) : false; + + // open the request + if (username) { + xhr.open(requestOptions.method, requestOptions.url, async, username, password); + } else { + xhr.open(requestOptions.method, requestOptions.url, async); + } + + headers = me.setupHeaders(xhr, options, requestOptions.data, requestOptions.params); + + // create the transaction object + request = { + id: ++Ext.data.Connection.requestId, + xhr: xhr, + headers: headers, + options: options, + async: async, + timeout: setTimeout(function() { + request.timedout = true; + me.abort(request); + }, options.timeout || me.timeout) + }; + me.requests[request.id] = request; + + // bind our statechange listener + if (async) { + xhr.onreadystatechange = Ext.Function.bind(me.onStateChange, me, [request]); + } + + // start the request! + xhr.send(requestOptions.data); + if (!async) { + return this.onComplete(request); + } + return request; + } else { + Ext.callback(options.callback, options.scope, [options, undefined, undefined]); + return null; + } + }, + + /** + * Upload a form using a hidden iframe. + * @param {Mixed} form The form to upload + * @param {String} url The url to post to + * @param {String} params Any extra parameters to pass + * @param {Object} options The initial options + */ + upload: function(form, url, params, options){ + form = Ext.getDom(form); + options = options || {}; + + var id = Ext.id(), + frame = document.createElement('iframe'), + hiddens = [], + encoding = 'multipart/form-data', + buf = { + target: form.target, + method: form.method, + encoding: form.encoding, + enctype: form.enctype, + action: form.action + }, hiddenItem; + + /* + * Originally this behaviour was modified for Opera 10 to apply the secure URL after + * the frame had been added to the document. It seems this has since been corrected in + * Opera so the behaviour has been reverted, the URL will be set before being added. + */ + Ext.fly(frame).set({ + id: id, + name: id, + cls: Ext.baseCSSPrefix + 'hide-display', + src: Ext.SSL_SECURE_URL + }); + + document.body.appendChild(frame); + + // This is required so that IE doesn't pop the response up in a new window. + if (document.frames) { + document.frames[id].name = id; + } + + Ext.fly(form).set({ + target: id, + method: 'POST', + enctype: encoding, + encoding: encoding, + action: url || buf.action + }); + + // add dynamic params + if (params) { + Ext.iterate(Ext.Object.fromQueryString(params), function(name, value){ + hiddenItem = document.createElement('input'); + Ext.fly(hiddenItem).set({ + type: 'hidden', + value: value, + name: name + }); + form.appendChild(hiddenItem); + hiddens.push(hiddenItem); + }); + } + + Ext.fly(frame).on('load', Ext.Function.bind(this.onUploadComplete, this, [frame, options]), null, {single: true}); + form.submit(); + + Ext.fly(form).set(buf); + Ext.each(hiddens, function(h) { + Ext.removeNode(h); + }); + }, + + onUploadComplete: function(frame, options){ + var me = this, + // bogus response object + response = { + responseText: '', + responseXML: null + }, doc, firstChild; + + try { + doc = frame.contentWindow.document || frame.contentDocument || window.frames[id].document; + if (doc) { + if (doc.body) { + if (/textarea/i.test((firstChild = doc.body.firstChild || {}).tagName)) { // json response wrapped in textarea + response.responseText = firstChild.value; + } else { + response.responseText = doc.body.innerHTML; + } + } + //in IE the document may still have a body even if returns XML. + response.responseXML = doc.XMLDocument || doc; + } + } catch (e) { + } + + me.fireEvent('requestcomplete', me, response, options); + + Ext.callback(options.success, options.scope, [response, options]); + Ext.callback(options.callback, options.scope, [options, true, response]); + + setTimeout(function(){ + Ext.removeNode(frame); + }, 100); + }, + + /** + * Detect whether the form is intended to be used for an upload. + * @private + */ + isFormUpload: function(options){ + var form = this.getForm(options); + if (form) { + return (options.isUpload || (/multipart\/form-data/i).test(form.getAttribute('enctype'))); + } + return false; + }, + + /** + * Get the form object from options. + * @private + * @param {Object} options The request options + * @return {HTMLElement} The form, null if not passed + */ + getForm: function(options){ + return Ext.getDom(options.form) || null; + }, + + /** + * Set various options such as the url, params for the request + * @param {Object} options The initial options + * @param {Object} scope The scope to execute in + * @return {Object} The params for the request + */ + setOptions: function(options, scope){ + var me = this, + params = options.params || {}, + extraParams = me.extraParams, + urlParams = options.urlParams, + url = options.url || me.url, + jsonData = options.jsonData, + method, + disableCache, + data; + + + // allow params to be a method that returns the params object + if (Ext.isFunction(params)) { + params = params.call(scope, options); + } + + // allow url to be a method that returns the actual url + if (Ext.isFunction(url)) { + url = url.call(scope, options); + } + + url = this.setupUrl(options, url); + + if (!url) { + Ext.Error.raise({ + options: options, + msg: 'No URL specified' + }); + } + + // check for xml or json data, and make sure json data is encoded + data = options.rawData || options.xmlData || jsonData || null; + if (jsonData && !Ext.isPrimitive(jsonData)) { + data = Ext.encode(data); + } + + // make sure params are a url encoded string and include any extraParams if specified + if (Ext.isObject(params)) { + params = Ext.Object.toQueryString(params); + } + + if (Ext.isObject(extraParams)) { + extraParams = Ext.Object.toQueryString(extraParams); + } + + params = params + ((extraParams) ? ((params) ? '&' : '') + extraParams : ''); + + urlParams = Ext.isObject(urlParams) ? Ext.Object.toQueryString(urlParams) : urlParams; + + params = this.setupParams(options, params); + + // decide the proper method for this request + method = (options.method || me.method || ((params || data) ? 'POST' : 'GET')).toUpperCase(); + this.setupMethod(options, method); + + + disableCache = options.disableCaching !== false ? (options.disableCaching || me.disableCaching) : false; + // if the method is get append date to prevent caching + if (method === 'GET' && disableCache) { + url = Ext.urlAppend(url, (options.disableCachingParam || me.disableCachingParam) + '=' + (new Date().getTime())); + } + + // if the method is get or there is json/xml data append the params to the url + if ((method == 'GET' || data) && params) { + url = Ext.urlAppend(url, params); + params = null; + } + + // allow params to be forced into the url + if (urlParams) { + url = Ext.urlAppend(url, urlParams); + } + + return { + url: url, + method: method, + data: data || params || null + }; + }, + + /** + * Template method for overriding url + * @private + * @param {Object} options + * @param {String} url + * @return {String} The modified url + */ + setupUrl: function(options, url){ + var form = this.getForm(options); + if (form) { + url = url || form.action; + } + return url; + }, + + + /** + * Template method for overriding params + * @private + * @param {Object} options + * @param {String} params + * @return {String} The modified params + */ + setupParams: function(options, params) { + var form = this.getForm(options), + serializedForm; + if (form && !this.isFormUpload(options)) { + serializedForm = Ext.core.Element.serializeForm(form); + params = params ? (params + '&' + serializedForm) : serializedForm; + } + return params; + }, + + /** + * Template method for overriding method + * @private + * @param {Object} options + * @param {String} method + * @return {String} The modified method + */ + setupMethod: function(options, method){ + if (this.isFormUpload(options)) { + return 'POST'; + } + return method; + }, + + /** + * Setup all the headers for the request + * @private + * @param {Object} xhr The xhr object + * @param {Object} options The options for the request + * @param {Object} data The data for the request + * @param {Object} params The params for the request + */ + setupHeaders: function(xhr, options, data, params){ + var me = this, + headers = Ext.apply({}, options.headers || {}, me.defaultHeaders || {}), + contentType = me.defaultPostHeader, + jsonData = options.jsonData, + xmlData = options.xmlData, + key, + header; + + if (!headers['Content-Type'] && (data || params)) { + if (data) { + if (options.rawData) { + contentType = 'text/plain'; + } else { + if (xmlData && Ext.isDefined(xmlData)) { + contentType = 'text/xml'; + } else if (jsonData && Ext.isDefined(jsonData)) { + contentType = 'application/json'; + } + } + } + headers['Content-Type'] = contentType; + } + + if (me.useDefaultXhrHeader && !headers['X-Requested-With']) { + headers['X-Requested-With'] = me.defaultXhrHeader; + } + // set up all the request headers on the xhr object + try{ + for (key in headers) { + if (headers.hasOwnProperty(key)) { + header = headers[key]; + xhr.setRequestHeader(key, header); + } + + } + } catch(e) { + me.fireEvent('exception', key, header); + } + return headers; + }, + + /** + * Creates the appropriate XHR transport for the browser. + * @private + */ + getXhrInstance: (function(){ + var options = [function(){ + return new XMLHttpRequest(); + }, function(){ + return new ActiveXObject('MSXML2.XMLHTTP.3.0'); + }, function(){ + return new ActiveXObject('MSXML2.XMLHTTP'); + }, function(){ + return new ActiveXObject('Microsoft.XMLHTTP'); + }], i = 0, + len = options.length, + xhr; + + for(; i < len; ++i) { + try{ + xhr = options[i]; + xhr(); + break; + }catch(e){} + } + return xhr; + })(), + + /** + * Determine whether this object has a request outstanding. + * @param {Object} request (Optional) defaults to the last transaction + * @return {Boolean} True if there is an outstanding request. + */ + isLoading : function(request) { + if (!(request && request.xhr)) { + return false; + } + // if there is a connection and readyState is not 0 or 4 + var state = request.xhr.readyState; + return !(state === 0 || state == 4); + }, + + /** + * Aborts any outstanding request. + * @param {Object} request (Optional) defaults to the last request + */ + abort : function(request) { + var me = this, + requests = me.requests, + id; + + if (request && me.isLoading(request)) { + /* + * Clear out the onreadystatechange here, this allows us + * greater control, the browser may/may not fire the function + * depending on a series of conditions. + */ + request.xhr.onreadystatechange = null; + request.xhr.abort(); + me.clearTimeout(request); + if (!request.timedout) { + request.aborted = true; + } + me.onComplete(request); + me.cleanup(request); + } else if (!request) { + for(id in requests) { + if (requests.hasOwnProperty(id)) { + me.abort(requests[id]); + } + } + } + }, + + /** + * Fires when the state of the xhr changes + * @private + * @param {Object} request The request + */ + onStateChange : function(request) { + if (request.xhr.readyState == 4) { + this.clearTimeout(request); + this.onComplete(request); + this.cleanup(request); + } + }, + + /** + * Clear the timeout on the request + * @private + * @param {Object} The request + */ + clearTimeout: function(request){ + clearTimeout(request.timeout); + delete request.timeout; + }, + + /** + * Clean up any left over information from the request + * @private + * @param {Object} The request + */ + cleanup: function(request){ + request.xhr = null; + delete request.xhr; + }, + + /** + * To be called when the request has come back from the server + * @private + * @param {Object} request + * @return {Object} The response + */ + onComplete : function(request) { + var me = this, + options = request.options, + result = me.parseStatus(request.xhr.status), + success = result.success, + response; + + if (success) { + response = me.createResponse(request); + me.fireEvent('requestcomplete', me, response, options); + Ext.callback(options.success, options.scope, [response, options]); + } else { + if (result.isException || request.aborted || request.timedout) { + response = me.createException(request); + } else { + response = me.createResponse(request); + } + me.fireEvent('requestexception', me, response, options); + Ext.callback(options.failure, options.scope, [response, options]); + } + Ext.callback(options.callback, options.scope, [options, success, response]); + delete me.requests[request.id]; + return response; + }, + + /** + * Check if the response status was successful + * @param {Number} status The status code + * @return {Object} An object containing success/status state + */ + parseStatus: function(status) { + // see: https://prototype.lighthouseapp.com/projects/8886/tickets/129-ie-mangles-http-response-status-code-204-to-1223 + status = status == 1223 ? 204 : status; + + var success = (status >= 200 && status < 300) || status == 304, + isException = false; + + if (!success) { + switch (status) { + case 12002: + case 12029: + case 12030: + case 12031: + case 12152: + case 13030: + isException = true; + break; + } + } + return { + success: success, + isException: isException + }; + }, + + /** + * Create the response object + * @private + * @param {Object} request + */ + createResponse : function(request) { + var xhr = request.xhr, + headers = {}, + lines = xhr.getAllResponseHeaders().replace(/\r\n/g, '\n').split('\n'), + count = lines.length, + line, index, key, value, response; + + while (count--) { + line = lines[count]; + index = line.indexOf(':'); + if(index >= 0) { + key = line.substr(0, index).toLowerCase(); + if (line.charAt(index + 1) == ' ') { + ++index; + } + headers[key] = line.substr(index + 1); + } + } + + request.xhr = null; + delete request.xhr; + + response = { + request: request, + requestId : request.id, + status : xhr.status, + statusText : xhr.statusText, + getResponseHeader : function(header){ return headers[header.toLowerCase()]; }, + getAllResponseHeaders : function(){ return headers; }, + responseText : xhr.responseText, + responseXML : xhr.responseXML + }; + + // If we don't explicitly tear down the xhr reference, IE6/IE7 will hold this in the closure of the + // functions created with getResponseHeader/getAllResponseHeaders + xhr = null; + return response; + }, + + /** + * Create the exception object + * @private + * @param {Object} request + */ + createException : function(request) { + return { + request : request, + requestId : request.id, + status : request.aborted ? -1 : 0, + statusText : request.aborted ? 'transaction aborted' : 'communication failure', + aborted: request.aborted, + timedout: request.timedout + }; + } +}); + +/** + * @class Ext.Ajax + * @singleton + * @markdown + * @extends Ext.data.Connection + +A singleton instance of an {@link Ext.data.Connection}. This class +is used to communicate with your server side code. It can be used as follows: + + Ext.Ajax.request({ + url: 'page.php', + params: { + id: 1 + }, + success: function(response){ + var text = response.responseText; + // process server response here + } + }); + +Default options for all requests can be set by changing a property on the Ext.Ajax class: + + Ext.Ajax.timeout = 60000; // 60 seconds + +Any options specified in the request method for the Ajax request will override any +defaults set on the Ext.Ajax class. In the code sample below, the timeout for the +request will be 60 seconds. + + Ext.Ajax.timeout = 120000; // 120 seconds + Ext.Ajax.request({ + url: 'page.aspx', + timeout: 60000 + }); + +In general, this class will be used for all Ajax requests in your application. +The main reason for creating a separate {@link Ext.data.Connection} is for a +series of requests that share common settings that are different to all other +requests in the application. + + */ +Ext.define('Ext.Ajax', { + extend: 'Ext.data.Connection', + singleton: true, + + /** + * @cfg {String} url @hide + */ + /** + * @cfg {Object} extraParams @hide + */ + /** + * @cfg {Object} defaultHeaders @hide + */ + /** + * @cfg {String} method (Optional) @hide + */ + /** + * @cfg {Number} timeout (Optional) @hide + */ + /** + * @cfg {Boolean} autoAbort (Optional) @hide + */ + + /** + * @cfg {Boolean} disableCaching (Optional) @hide + */ + + /** + * @property disableCaching + * True to add a unique cache-buster param to GET requests. (defaults to true) + * @type Boolean + */ + /** + * @property url + * The default URL to be used for requests to the server. (defaults to undefined) + * If the server receives all requests through one URL, setting this once is easier than + * entering it on every request. + * @type String + */ + /** + * @property extraParams + * An object containing properties which are used as extra parameters to each request made + * by this object (defaults to undefined). Session information and other data that you need + * to pass with each request are commonly put here. + * @type Object + */ + /** + * @property defaultHeaders + * An object containing request headers which are added to each request made by this object + * (defaults to undefined). + * @type Object + */ + /** + * @property method + * The default HTTP method to be used for requests. Note that this is case-sensitive and + * should be all caps (defaults to undefined; if not set but params are present will use + * "POST", otherwise will use "GET".) + * @type String + */ + /** + * @property timeout + * The timeout in milliseconds to be used for requests. (defaults to 30000) + * @type Number + */ + + /** + * @property autoAbort + * Whether a new request should abort any pending requests. (defaults to false) + * @type Boolean + */ + autoAbort : false +}); +/** + * @author Ed Spencer + * @class Ext.data.Association + * @extends Object + * + *

Associations enable you to express relationships between different {@link Ext.data.Model Models}. Let's say we're + * writing an ecommerce system where Users can make Orders - there's a relationship between these Models that we can + * express like this:

+ * +


+Ext.define('User', {
+    extend: 'Ext.data.Model',
+    fields: ['id', 'name', 'email'],
+
+    hasMany: {model: 'Order', name: 'orders'}
+});
+
+Ext.define('Order', {
+    extend: 'Ext.data.Model',
+    fields: ['id', 'user_id', 'status', 'price'],
+
+    belongsTo: 'User'
+});
+

+ * + *

We've set up two models - User and Order - and told them about each other. You can set up as many associations on + * each Model as you need using the two default types - {@link Ext.data.HasManyAssociation hasMany} and + * {@link Ext.data.BelongsToAssociation belongsTo}. There's much more detail on the usage of each of those inside their + * documentation pages. If you're not familiar with Models already, {@link Ext.data.Model there is plenty on those too}.

+ * + *

Further Reading

+ * + *

{@link Ext.data.HasManyAssociation hasMany associations} + *
{@link Ext.data.BelongsToAssociation belongsTo associations} + *
{@link Ext.data.Model using Models} + *

+ * + * Self association models + *

We can also have models that create parent/child associations between the same type. Below is an example, where + * groups can be nested inside other groups:

+ *


+
+// Server Data
+{
+    "groups": {
+        "id": 10,
+        "parent_id": 100,
+        "name": "Main Group",
+        "parent_group": {
+            "id": 100,
+            "parent_id": null,
+            "name": "Parent Group"
+        },
+        "child_groups": [{
+            "id": 2,
+            "parent_id": 10,
+            "name": "Child Group 1"
+        },{
+            "id": 3,
+            "parent_id": 10,
+            "name": "Child Group 2"
+        },{
+            "id": 4,
+            "parent_id": 10,
+            "name": "Child Group 3"
+        }]
+    }
+}
+
+// Client code
+Ext.define('Group', {
+    extend: 'Ext.data.Model',
+    fields: ['id', 'parent_id', 'name'],
+    proxy: {
+        type: 'ajax',
+        url: 'data.json',
+        reader: {
+            type: 'json',
+            root: 'groups'
+        }
+    },
+    associations: [{
+        type: 'hasMany',
+        model: 'Group',
+        primaryKey: 'id',
+        foreignKey: 'parent_id',
+        autoLoad: true,
+        associationKey: 'child_groups' // read child data from child_groups
+    }, {
+        type: 'belongsTo',
+        model: 'Group',
+        primaryKey: 'id',
+        foreignKey: 'parent_id',
+        autoLoad: true,
+        associationKey: 'parent_group' // read parent data from parent_group
+    }]
+});
+
+
+Ext.onReady(function(){
+    
+    Group.load(10, {
+        success: function(group){
+            console.log(group.getGroup().get('name'));
+            
+            group.groups().each(function(rec){
+                console.log(rec.get('name'));
+            });
+        }
+    });
+    
+});
+ *

+ * + * @constructor + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.Association', { + /** + * @cfg {String} ownerModel The string name of the model that owns the association. Required + */ + + /** + * @cfg {String} associatedModel The string name of the model that is being associated with. Required + */ + + /** + * @cfg {String} primaryKey The name of the primary key on the associated model. Defaults to 'id'. + * In general this will be the {@link Ext.data.Model#idProperty} of the Model. + */ + primaryKey: 'id', + + /** + * @cfg {Ext.data.reader.Reader} reader A special reader to read associated data + */ + + /** + * @cfg {String} associationKey The name of the property in the data to read the association from. + * Defaults to the name of the associated model. + */ + + defaultReaderType: 'json', + + statics: { + create: function(association){ + if (!association.isAssociation) { + if (Ext.isString(association)) { + association = { + type: association + }; + } + + switch (association.type) { + case 'belongsTo': + return Ext.create('Ext.data.BelongsToAssociation', association); + case 'hasMany': + return Ext.create('Ext.data.HasManyAssociation', association); + //TODO Add this back when it's fixed +// case 'polymorphic': +// return Ext.create('Ext.data.PolymorphicAssociation', association); + default: + Ext.Error.raise('Unknown Association type: "' + association.type + '"'); + } + } + return association; + } + }, + + constructor: function(config) { + Ext.apply(this, config); + + var types = Ext.ModelManager.types, + ownerName = config.ownerModel, + associatedName = config.associatedModel, + ownerModel = types[ownerName], + associatedModel = types[associatedName], + ownerProto; + + if (ownerModel === undefined) { + Ext.Error.raise("The configured ownerModel was not valid (you tried " + ownerName + ")"); + } + if (associatedModel === undefined) { + Ext.Error.raise("The configured associatedModel was not valid (you tried " + associatedName + ")"); + } + + this.ownerModel = ownerModel; + this.associatedModel = associatedModel; + + /** + * The name of the model that 'owns' the association + * @property ownerName + * @type String + */ + + /** + * The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is 'Order') + * @property associatedName + * @type String + */ + + Ext.applyIf(this, { + ownerName : ownerName, + associatedName: associatedName + }); + }, + + /** + * Get a specialized reader for reading associated data + * @return {Ext.data.reader.Reader} The reader, null if not supplied + */ + getReader: function(){ + var me = this, + reader = me.reader, + model = me.associatedModel; + + if (reader) { + if (Ext.isString(reader)) { + reader = { + type: reader + }; + } + if (reader.isReader) { + reader.setModel(model); + } else { + Ext.applyIf(reader, { + model: model, + type : me.defaultReaderType + }); + } + me.reader = Ext.createByAlias('reader.' + reader.type, reader); + } + return me.reader || null; + } +}); + +/** + * @author Ed Spencer + * @class Ext.ModelManager + * @extends Ext.AbstractManager + +The ModelManager keeps track of all {@link Ext.data.Model} types defined in your application. + +__Creating Model Instances__ +Model instances can be created by using the {@link #create} function. It is also possible to do +this by using the Model type directly. The following snippets are equivalent: + + Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['first', 'last'] + }); + + // method 1, create through the manager + Ext.ModelManager.create({ + first: 'Ed', + last: 'Spencer' + }, 'User'); + + // method 2, create on the type directly + new User({ + first: 'Ed', + last: 'Spencer' + }); + +__Accessing Model Types__ +A reference to a Model type can be obtained by using the {@link #getModel} function. Since models types +are normal classes, you can access the type directly. The following snippets are equivalent: + + Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['first', 'last'] + }); + + // method 1, access model type through the manager + var UserType = Ext.ModelManager.getModel('User'); + + // method 2, reference the type directly + var UserType = User; + + * @markdown + * @singleton + */ +Ext.define('Ext.ModelManager', { + extend: 'Ext.AbstractManager', + alternateClassName: 'Ext.ModelMgr', + requires: ['Ext.data.Association'], + + singleton: true, + + typeName: 'mtype', + + /** + * Private stack of associations that must be created once their associated model has been defined + * @property associationStack + * @type Array + */ + associationStack: [], + + /** + * Registers a model definition. All model plugins marked with isDefault: true are bootstrapped + * immediately, as are any addition plugins defined in the model config. + * @private + */ + registerType: function(name, config) { + var proto = config.prototype, + model; + if (proto && proto.isModel) { + // registering an already defined model + model = config; + } else { + // passing in a configuration + if (!config.extend) { + config.extend = 'Ext.data.Model'; + } + model = Ext.define(name, config); + } + this.types[name] = model; + return model; + }, + + /** + * @private + * Private callback called whenever a model has just been defined. This sets up any associations + * that were waiting for the given model to be defined + * @param {Function} model The model that was just created + */ + onModelDefined: function(model) { + var stack = this.associationStack, + length = stack.length, + create = [], + association, i, created; + + for (i = 0; i < length; i++) { + association = stack[i]; + + if (association.associatedModel == model.modelName) { + create.push(association); + } + } + + for (i = 0, length = create.length; i < length; i++) { + created = create[i]; + this.types[created.ownerModel].prototype.associations.add(Ext.data.Association.create(created)); + Ext.Array.remove(stack, created); + } + }, + + /** + * Registers an association where one of the models defined doesn't exist yet. + * The ModelManager will check when new models are registered if it can link them + * together + * @private + * @param {Ext.data.Association} association The association + */ + registerDeferredAssociation: function(association){ + this.associationStack.push(association); + }, + + /** + * Returns the {@link Ext.data.Model} for a given model name + * @param {String/Object} id The id of the model or the model instance. + */ + getModel: function(id) { + var model = id; + if (typeof model == 'string') { + model = this.types[model]; + } + return model; + }, + + /** + * Creates a new instance of a Model using the given data. + * @param {Object} data Data to initialize the Model's fields with + * @param {String} name The name of the model to create + * @param {Number} id Optional unique id of the Model instance (see {@link Ext.data.Model}) + */ + create: function(config, name, id) { + var con = typeof name == 'function' ? name : this.types[name || config.name]; + + return new con(config, id); + } +}, function() { + + /** + * Creates a new Model class from the specified config object. See {@link Ext.data.Model} for full examples. + * + * @param {Object} config A configuration object for the Model you wish to create. + * @return {Ext.data.Model} The newly registered Model + * @member Ext + * @method regModel + */ + Ext.regModel = function() { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.regModel has been deprecated. Models can now be created by extending Ext.data.Model: Ext.define("MyModel", {extend: "Ext.data.Model", fields: []});.'); + } + return this.ModelManager.registerType.apply(this.ModelManager, arguments); + }; +}); + +/** + * @class Ext.app.Controller + * + * Controllers are the glue that binds an application together. All they really do is listen for events (usually from + * views) and take some action. Here's how we might create a Controller to manage Users: + * + * Ext.define('MyApp.controller.Users', { + * extend: 'Ext.app.Controller', + * + * init: function() { + * console.log('Initialized Users! This happens before the Application launch function is called'); + * } + * }); + * + * The init function is a special method that is called when your application boots. It is called before the + * {@link Ext.app.Application Application}'s launch function is executed so gives a hook point to run any code before + * your Viewport is created. + * + * The init function is a great place to set up how your controller interacts with the view, and is usually used in + * conjunction with another Controller function - {@link Ext.app.Controller#control control}. The control function + * makes it easy to listen to events on your view classes and take some action with a handler function. Let's update + * our Users controller to tell us when the panel is rendered: + * + * Ext.define('MyApp.controller.Users', { + * extend: 'Ext.app.Controller', + * + * init: function() { + * this.control({ + * 'viewport > panel': { + * render: this.onPanelRendered + * } + * }); + * }, + * + * onPanelRendered: function() { + * console.log('The panel was rendered'); + * } + * }); + * + * We've updated the init function to use this.control to set up listeners on views in our application. The control + * function uses the new ComponentQuery engine to quickly and easily get references to components on the page. If you + * are not familiar with ComponentQuery yet, be sure to check out THIS GUIDE for a full explanation. In brief though, + * it allows us to pass a CSS-like selector that will find every matching component on the page. + * + * In our init function above we supplied 'viewport > panel', which translates to "find me every Panel that is a direct + * child of a Viewport". We then supplied an object that maps event names (just 'render' in this case) to handler + * functions. The overall effect is that whenever any component that matches our selector fires a 'render' event, our + * onPanelRendered function is called. + * + * Using refs + * + * One of the most useful parts of Controllers is the new ref system. These use the new {@link Ext.ComponentQuery} to + * make it really easy to get references to Views on your page. Let's look at an example of this now: + * + * Ext.define('MyApp.controller.Users', { + * extend: 'Ext.app.Controller', + * + * refs: [ + * { + * ref: 'list', + * selector: 'grid' + * } + * ], + * + * init: function() { + * this.control({ + * 'button': { + * click: this.refreshGrid + * } + * }); + * }, + * + * refreshGrid: function() { + * this.getList().store.load(); + * } + * }); + * + * This example assumes the existence of a {@link Ext.grid.Panel Grid} on the page, which contains a single button to + * refresh the Grid when clicked. In our refs array, we set up a reference to the grid. There are two parts to this - + * the 'selector', which is a {@link Ext.ComponentQuery ComponentQuery} selector which finds any grid on the page and + * assigns it to the reference 'list'. + * + * By giving the reference a name, we get a number of things for free. The first is the getList function that we use in + * the refreshGrid method above. This is generated automatically by the Controller based on the name of our ref, which + * was capitalized and prepended with get to go from 'list' to 'getList'. + * + * The way this works is that the first time getList is called by your code, the ComponentQuery selector is run and the + * first component that matches the selector ('grid' in this case) will be returned. All future calls to getList will + * use a cached reference to that grid. Usually it is advised to use a specific ComponentQuery selector that will only + * match a single View in your application (in the case above our selector will match any grid on the page). + * + * Bringing it all together, our init function is called when the application boots, at which time we call this.control + * to listen to any click on a {@link Ext.button.Button button} and call our refreshGrid function (again, this will + * match any button on the page so we advise a more specific selector than just 'button', but have left it this way for + * simplicity). When the button is clicked we use out getList function to refresh the grid. + * + * You can create any number of refs and control any number of components this way, simply adding more functions to + * your Controller as you go. For an example of real-world usage of Controllers see the Feed Viewer example in the + * examples/app/feed-viewer folder in the SDK download. + * + * Generated getter methods + * + * Refs aren't the only thing that generate convenient getter methods. Controllers often have to deal with Models and + * Stores so the framework offers a couple of easy ways to get access to those too. Let's look at another example: + * + * Ext.define('MyApp.controller.Users', { + * extend: 'Ext.app.Controller', + * + * models: ['User'], + * stores: ['AllUsers', 'AdminUsers'], + * + * init: function() { + * var User = this.getUserModel(), + * allUsers = this.getAllUsersStore(); + * + * var ed = new User({name: 'Ed'}); + * allUsers.add(ed); + * } + * }); + * + * By specifying Models and Stores that the Controller cares about, it again dynamically loads them from the appropriate + * locations (app/model/User.js, app/store/AllUsers.js and app/store/AdminUsers.js in this case) and creates getter + * functions for them all. The example above will create a new User model instance and add it to the AllUsers Store. + * Of course, you could do anything in this function but in this case we just did something simple to demonstrate the + * functionality. + * + * Further Reading + * + * For more information about writing Ext JS 4 applications, please see the + * application architecture guide. Also see the {@link Ext.app.Application} documentation. + * + * @docauthor Ed Spencer + * @constructor + */ +Ext.define('Ext.app.Controller', { + /** + * @cfg {String} id The id of this controller. You can use this id when dispatching. + */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + onClassExtended: function(cls, data) { + var className = Ext.getClassName(cls), + match = className.match(/^(.*)\.controller\./); + + if (match !== null) { + var namespace = Ext.Loader.getPrefix(className) || match[1], + onBeforeClassCreated = data.onBeforeClassCreated, + requires = [], + modules = ['model', 'view', 'store'], + prefix; + + data.onBeforeClassCreated = function(cls, data) { + var i, ln, module, + items, j, subLn, item; + + for (i = 0,ln = modules.length; i < ln; i++) { + module = modules[i]; + + items = Ext.Array.from(data[module + 's']); + + for (j = 0,subLn = items.length; j < subLn; j++) { + item = items[j]; + + prefix = Ext.Loader.getPrefix(item); + + if (prefix === '' || prefix === item) { + requires.push(namespace + '.' + module + '.' + item); + } + else { + requires.push(item); + } + } + } + + Ext.require(requires, Ext.Function.pass(onBeforeClassCreated, arguments, this)); + }; + } + }, + + constructor: function(config) { + this.mixins.observable.constructor.call(this, config); + + Ext.apply(this, config || {}); + + this.createGetters('model', this.models); + this.createGetters('store', this.stores); + this.createGetters('view', this.views); + + if (this.refs) { + this.ref(this.refs); + } + }, + + // Template method + init: function(application) {}, + // Template method + onLaunch: function(application) {}, + + createGetters: function(type, refs) { + type = Ext.String.capitalize(type); + Ext.Array.each(refs, function(ref) { + var fn = 'get', + parts = ref.split('.'); + + // Handle namespaced class names. E.g. feed.Add becomes getFeedAddView etc. + Ext.Array.each(parts, function(part) { + fn += Ext.String.capitalize(part); + }); + fn += type; + + if (!this[fn]) { + this[fn] = Ext.Function.pass(this['get' + type], [ref], this); + } + // Execute it right away + this[fn](ref); + }, + this); + }, + + ref: function(refs) { + var me = this; + refs = Ext.Array.from(refs); + Ext.Array.each(refs, function(info) { + var ref = info.ref, + fn = 'get' + Ext.String.capitalize(ref); + if (!me[fn]) { + me[fn] = Ext.Function.pass(me.getRef, [ref, info], me); + } + }); + }, + + getRef: function(ref, info, config) { + this.refCache = this.refCache || {}; + info = info || {}; + config = config || {}; + + Ext.apply(info, config); + + if (info.forceCreate) { + return Ext.ComponentManager.create(info, 'component'); + } + + var me = this, + selector = info.selector, + cached = me.refCache[ref]; + + if (!cached) { + me.refCache[ref] = cached = Ext.ComponentQuery.query(info.selector)[0]; + if (!cached && info.autoCreate) { + me.refCache[ref] = cached = Ext.ComponentManager.create(info, 'component'); + } + if (cached) { + cached.on('beforedestroy', function() { + me.refCache[ref] = null; + }); + } + } + + return cached; + }, + + control: function(selectors, listeners) { + this.application.control(selectors, listeners, this); + }, + + getController: function(name) { + return this.application.getController(name); + }, + + getStore: function(name) { + return this.application.getStore(name); + }, + + getModel: function(model) { + return this.application.getModel(model); + }, + + getView: function(view) { + return this.application.getView(view); + } +}); + +/** + * @class Ext.data.SortTypes + * This class defines a series of static methods that are used on a + * {@link Ext.data.Field} for performing sorting. The methods cast the + * underlying values into a data type that is appropriate for sorting on + * that particular field. If a {@link Ext.data.Field#type} is specified, + * the sortType will be set to a sane default if the sortType is not + * explicitly defined on the field. The sortType will make any necessary + * modifications to the value and return it. + *

asText - Removes any tags and converts the value to a string
asUCText - Removes any tags and converts the value to an uppercase string
asUCText - Converts the value to an uppercase string
asDate - Converts the value into Unix epoch time
asFloat - Converts the value to a floating point number
asInt - Converts the value to an integer number

+ *

+ * It is also possible to create a custom sortType that can be used throughout + * an application. + *


+Ext.apply(Ext.data.SortTypes, {
+    asPerson: function(person){
+        // expects an object with a first and last name property
+        return person.lastName.toUpperCase() + person.firstName.toLowerCase();
+    }    
+});
+
+Ext.define('Employee', {
+    extend: 'Ext.data.Model',
+    fields: [{
+        name: 'person',
+        sortType: 'asPerson'
+    }, {
+        name: 'salary',
+        type: 'float' // sortType set to asFloat
+    }]
+});
+ *

+ *

+ * @singleton + * @docauthor Evan Trimboli + */ +Ext.define('Ext.data.SortTypes', { + + singleton: true, + + /** + * Default sort that does nothing + * @param {Mixed} s The value being converted + * @return {Mixed} The comparison value + */ + none : function(s) { + return s; + }, + + /** + * The regular expression used to strip tags + * @type {RegExp} + * @property + */ + stripTagsRE : /<\/?[^>]+>/gi, + + /** + * Strips all HTML tags to sort on text only + * @param {Mixed} s The value being converted + * @return {String} The comparison value + */ + asText : function(s) { + return String(s).replace(this.stripTagsRE, ""); + }, + + /** + * Strips all HTML tags to sort on text only - Case insensitive + * @param {Mixed} s The value being converted + * @return {String} The comparison value + */ + asUCText : function(s) { + return String(s).toUpperCase().replace(this.stripTagsRE, ""); + }, + + /** + * Case insensitive string + * @param {Mixed} s The value being converted + * @return {String} The comparison value + */ + asUCString : function(s) { + return String(s).toUpperCase(); + }, + + /** + * Date sorting + * @param {Mixed} s The value being converted + * @return {Number} The comparison value + */ + asDate : function(s) { + if(!s){ + return 0; + } + if(Ext.isDate(s)){ + return s.getTime(); + } + return Date.parse(String(s)); + }, + + /** + * Float sorting + * @param {Mixed} s The value being converted + * @return {Float} The comparison value + */ + asFloat : function(s) { + var val = parseFloat(String(s).replace(/,/g, "")); + return isNaN(val) ? 0 : val; + }, + + /** + * Integer sorting + * @param {Mixed} s The value being converted + * @return {Number} The comparison value + */ + asInt : function(s) { + var val = parseInt(String(s).replace(/,/g, ""), 10); + return isNaN(val) ? 0 : val; + } +}); +/** + * @author Ed Spencer + * @class Ext.data.Errors + * @extends Ext.util.MixedCollection + * + *

Wraps a collection of validation error responses and provides convenient functions for + * accessing and errors for specific fields.

+ * + *

Usually this class does not need to be instantiated directly - instances are instead created + * automatically when {@link Ext.data.Model#validate validate} on a model instance:

+ * +


+//validate some existing model instance - in this case it returned 2 failures messages
+var errors = myModel.validate();
+
+errors.isValid(); //false
+
+errors.length; //2
+errors.getByField('name');  // [{field: 'name',  message: 'must be present'}]
+errors.getByField('title'); // [{field: 'title', message: 'is too short'}]
+

+ */ +Ext.define('Ext.data.Errors', { + extend: 'Ext.util.MixedCollection', + + /** + * Returns true if there are no errors in the collection + * @return {Boolean} + */ + isValid: function() { + return this.length === 0; + }, + + /** + * Returns all of the errors for the given field + * @param {String} fieldName The field to get errors for + * @return {Array} All errors for the given field + */ + getByField: function(fieldName) { + var errors = [], + error, field, i; + + for (i = 0; i < this.length; i++) { + error = this.items[i]; + + if (error.field == fieldName) { + errors.push(error); + } + } + + return errors; + } +}); + +/** + * @author Ed Spencer + * @class Ext.data.Operation + * @extends Object + * + *

Represents a single read or write operation performed by a {@link Ext.data.proxy.Proxy Proxy}. + * Operation objects are used to enable communication between Stores and Proxies. Application + * developers should rarely need to interact with Operation objects directly.

+ * + *

Several Operations can be batched together in a {@link Ext.data.Batch batch}.

+ * + * @constructor + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.Operation', { + /** + * @cfg {Boolean} synchronous True if this Operation is to be executed synchronously (defaults to true). This + * property is inspected by a {@link Ext.data.Batch Batch} to see if a series of Operations can be executed in + * parallel or not. + */ + synchronous: true, + + /** + * @cfg {String} action The action being performed by this Operation. Should be one of 'create', 'read', 'update' or 'destroy' + */ + action: undefined, + + /** + * @cfg {Array} filters Optional array of filter objects. Only applies to 'read' actions. + */ + filters: undefined, + + /** + * @cfg {Array} sorters Optional array of sorter objects. Only applies to 'read' actions. + */ + sorters: undefined, + + /** + * @cfg {Object} group Optional grouping configuration. Only applies to 'read' actions where grouping is desired. + */ + group: undefined, + + /** + * @cfg {Number} start The start index (offset), used in paging when running a 'read' action. + */ + start: undefined, + + /** + * @cfg {Number} limit The number of records to load. Used on 'read' actions when paging is being used. + */ + limit: undefined, + + /** + * @cfg {Ext.data.Batch} batch The batch that this Operation is a part of (optional) + */ + batch: undefined, + + /** + * Read-only property tracking the start status of this Operation. Use {@link #isStarted}. + * @property started + * @type Boolean + * @private + */ + started: false, + + /** + * Read-only property tracking the run status of this Operation. Use {@link #isRunning}. + * @property running + * @type Boolean + * @private + */ + running: false, + + /** + * Read-only property tracking the completion status of this Operation. Use {@link #isComplete}. + * @property complete + * @type Boolean + * @private + */ + complete: false, + + /** + * Read-only property tracking whether the Operation was successful or not. This starts as undefined and is set to true + * or false by the Proxy that is executing the Operation. It is also set to false by {@link #setException}. Use + * {@link #wasSuccessful} to query success status. + * @property success + * @type Boolean + * @private + */ + success: undefined, + + /** + * Read-only property tracking the exception status of this Operation. Use {@link #hasException} and see {@link #getError}. + * @property exception + * @type Boolean + * @private + */ + exception: false, + + /** + * The error object passed when {@link #setException} was called. This could be any object or primitive. + * @property error + * @type Mixed + * @private + */ + error: undefined, + + constructor: function(config) { + Ext.apply(this, config || {}); + }, + + /** + * Marks the Operation as started + */ + setStarted: function() { + this.started = true; + this.running = true; + }, + + /** + * Marks the Operation as completed + */ + setCompleted: function() { + this.complete = true; + this.running = false; + }, + + /** + * Marks the Operation as successful + */ + setSuccessful: function() { + this.success = true; + }, + + /** + * Marks the Operation as having experienced an exception. Can be supplied with an option error message/object. + * @param {Mixed} error Optional error string/object + */ + setException: function(error) { + this.exception = true; + this.success = false; + this.running = false; + this.error = error; + }, + + /** + * Returns true if this Operation encountered an exception (see also {@link #getError}) + * @return {Boolean} True if there was an exception + */ + hasException: function() { + return this.exception === true; + }, + + /** + * Returns the error string or object that was set using {@link #setException} + * @return {Mixed} The error object + */ + getError: function() { + return this.error; + }, + + /** + * Returns an array of Ext.data.Model instances as set by the Proxy. + * @return {Array} Any loaded Records + */ + getRecords: function() { + var resultSet = this.getResultSet(); + + return (resultSet === undefined ? this.records : resultSet.records); + }, + + /** + * Returns the ResultSet object (if set by the Proxy). This object will contain the {@link Ext.data.Model model} instances + * as well as meta data such as number of instances fetched, number available etc + * @return {Ext.data.ResultSet} The ResultSet object + */ + getResultSet: function() { + return this.resultSet; + }, + + /** + * Returns true if the Operation has been started. Note that the Operation may have started AND completed, + * see {@link #isRunning} to test if the Operation is currently running. + * @return {Boolean} True if the Operation has started + */ + isStarted: function() { + return this.started === true; + }, + + /** + * Returns true if the Operation has been started but has not yet completed. + * @return {Boolean} True if the Operation is currently running + */ + isRunning: function() { + return this.running === true; + }, + + /** + * Returns true if the Operation has been completed + * @return {Boolean} True if the Operation is complete + */ + isComplete: function() { + return this.complete === true; + }, + + /** + * Returns true if the Operation has completed and was successful + * @return {Boolean} True if successful + */ + wasSuccessful: function() { + return this.isComplete() && this.success === true; + }, + + /** + * @private + * Associates this Operation with a Batch + * @param {Ext.data.Batch} batch The batch + */ + setBatch: function(batch) { + this.batch = batch; + }, + + /** + * Checks whether this operation should cause writing to occur. + * @return {Boolean} Whether the operation should cause a write to occur. + */ + allowWrite: function() { + return this.action != 'read'; + } +}); +/** + * @author Ed Spencer + * @class Ext.data.validations + * @extends Object + * + *

This singleton contains a set of validation functions that can be used to validate any type + * of data. They are most often used in {@link Ext.data.Model Models}, where they are automatically + * set up and executed.

+ */ +Ext.define('Ext.data.validations', { + singleton: true, + + /** + * The default error message used when a presence validation fails + * @property presenceMessage + * @type String + */ + presenceMessage: 'must be present', + + /** + * The default error message used when a length validation fails + * @property lengthMessage + * @type String + */ + lengthMessage: 'is the wrong length', + + /** + * The default error message used when a format validation fails + * @property formatMessage + * @type Boolean + */ + formatMessage: 'is the wrong format', + + /** + * The default error message used when an inclusion validation fails + * @property inclusionMessage + * @type String + */ + inclusionMessage: 'is not included in the list of acceptable values', + + /** + * The default error message used when an exclusion validation fails + * @property exclusionMessage + * @type String + */ + exclusionMessage: 'is not an acceptable value', + + /** + * Validates that the given value is present + * @param {Object} config Optional config object + * @param {Mixed} value The value to validate + * @return {Boolean} True if validation passed + */ + presence: function(config, value) { + if (value === undefined) { + value = config; + } + + return !!value; + }, + + /** + * Returns true if the given value is between the configured min and max values + * @param {Object} config Optional config object + * @param {String} value The value to validate + * @return {Boolean} True if the value passes validation + */ + length: function(config, value) { + if (value === undefined) { + return false; + } + + var length = value.length, + min = config.min, + max = config.max; + + if ((min && length < min) || (max && length > max)) { + return false; + } else { + return true; + } + }, + + /** + * Returns true if the given value passes validation against the configured {@link #matcher} regex + * @param {Object} config Optional config object + * @param {String} value The value to validate + * @return {Boolean} True if the value passes the format validation + */ + format: function(config, value) { + return !!(config.matcher && config.matcher.test(value)); + }, + + /** + * Validates that the given value is present in the configured {@link #list} + * @param {String} value The value to validate + * @return {Boolean} True if the value is present in the list + */ + inclusion: function(config, value) { + return config.list && Ext.Array.indexOf(config.list,value) != -1; + }, + + /** + * Validates that the given value is present in the configured {@link #list} + * @param {Object} config Optional config object + * @param {String} value The value to validate + * @return {Boolean} True if the value is not present in the list + */ + exclusion: function(config, value) { + return config.list && Ext.Array.indexOf(config.list,value) == -1; + } +}); +/** + * @author Ed Spencer + * @class Ext.data.ResultSet + * @extends Object + * + *

Simple wrapper class that represents a set of records returned by a Proxy.

+ * + * @constructor + * Creates the new ResultSet + */ +Ext.define('Ext.data.ResultSet', { + /** + * @cfg {Boolean} loaded + * True if the records have already been loaded. This is only meaningful when dealing with + * SQL-backed proxies + */ + loaded: true, + + /** + * @cfg {Number} count + * The number of records in this ResultSet. Note that total may differ from this number + */ + count: 0, + + /** + * @cfg {Number} total + * The total number of records reported by the data source. This ResultSet may form a subset of + * those records (see count) + */ + total: 0, + + /** + * @cfg {Boolean} success + * True if the ResultSet loaded successfully, false if any errors were encountered + */ + success: false, + + /** + * @cfg {Array} records The array of record instances. Required + */ + + constructor: function(config) { + Ext.apply(this, config); + + /** + * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.total - use that instead + * @property totalRecords + * @type Mixed + */ + this.totalRecords = this.total; + + if (config.count === undefined) { + this.count = this.records.length; + } + } +}); +/** + * @author Ed Spencer + * @class Ext.data.writer.Writer + * @extends Object + * + *

Base Writer class used by most subclasses of {@link Ext.data.proxy.Server}. This class is + * responsible for taking a set of {@link Ext.data.Operation} objects and a {@link Ext.data.Request} + * object and modifying that request based on the Operations.

+ * + *

For example a Ext.data.writer.Json would format the Operations and their {@link Ext.data.Model} + * instances based on the config options passed to the JsonWriter's constructor.

+ * + *

Writers are not needed for any kind of local storage - whether via a + * {@link Ext.data.proxy.WebStorage Web Storage proxy} (see {@link Ext.data.proxy.LocalStorage localStorage} + * and {@link Ext.data.proxy.SessionStorage sessionStorage}) or just in memory via a + * {@link Ext.data.proxy.Memory MemoryProxy}.

+ * + * @constructor + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.writer.Writer', { + alias: 'writer.base', + alternateClassName: ['Ext.data.DataWriter', 'Ext.data.Writer'], + + /** + * @cfg {Boolean} writeAllFields True to write all fields from the record to the server. If set to false it + * will only send the fields that were modified. Defaults to true. Note that any fields that have + * {@link Ext.data.Field#persist} set to false will still be ignored. + */ + writeAllFields: true, + + /** + * @cfg {String} nameProperty This property is used to read the key for each value that will be sent to the server. + * For example: + *


+Ext.define('Person', {
+    extend: 'Ext.data.Model',
+    fields: [{
+        name: 'first',
+        mapping: 'firstName'
+    }, {
+        name: 'last',
+        mapping: 'lastName'
+    }, {
+        name: 'age'
+    }]
+});
+new Ext.data.writer.Writer({
+    writeAllFields: true,
+    nameProperty: 'mapping'
+});
+
+// This will be sent to the server
+{
+    firstName: 'first name value',
+    lastName: 'last name value',
+    age: 1
+}
+
+     *

+ * Defaults to name. If the value is not present, the field name will always be used. + */ + nameProperty: 'name', + + constructor: function(config) { + Ext.apply(this, config); + }, + + /** + * Prepares a Proxy's Ext.data.Request object + * @param {Ext.data.Request} request The request object + * @return {Ext.data.Request} The modified request object + */ + write: function(request) { + var operation = request.operation, + records = operation.records || [], + len = records.length, + i = 0, + data = []; + + for (; i < len; i++) { + data.push(this.getRecordData(records[i])); + } + return this.writeRecords(request, data); + }, + + /** + * Formats the data for each record before sending it to the server. This + * method should be overridden to format the data in a way that differs from the default. + * @param {Object} record The record that we are writing to the server. + * @return {Object} An object literal of name/value keys to be written to the server. + * By default this method returns the data property on the record. + */ + getRecordData: function(record) { + var isPhantom = record.phantom === true, + writeAll = this.writeAllFields || isPhantom, + nameProperty = this.nameProperty, + fields = record.fields, + data = {}, + changes, + name, + field, + key; + + if (writeAll) { + fields.each(function(field){ + if (field.persist) { + name = field[nameProperty] || field.name; + data[name] = record.get(field.name); + } + }); + } else { + // Only write the changes + changes = record.getChanges(); + for (key in changes) { + if (changes.hasOwnProperty(key)) { + field = fields.get(key); + name = field[nameProperty] || field.name; + data[name] = changes[key]; + } + } + if (!isPhantom) { + // always include the id for non phantoms + data[record.idProperty] = record.getId(); + } + } + return data; + } +}); + +/** + * @class Ext.util.Floating + * A mixin to add floating capability to a Component + */ +Ext.define('Ext.util.Floating', { + + uses: ['Ext.Layer', 'Ext.window.Window'], + + /** + * @cfg {Boolean} focusOnToFront + * Specifies whether the floated component should be automatically {@link #focus focused} when it is + * {@link #toFront brought to the front}. Defaults to true. + */ + focusOnToFront: true, + + /** + * @cfg {String/Boolean} shadow Specifies whether the floating component should be given a shadow. Set to + * true to automatically create an {@link Ext.Shadow}, or a string indicating the + * shadow's display {@link Ext.Shadow#mode}. Set to false to disable the shadow. + * (Defaults to 'sides'.) + */ + shadow: 'sides', + + constructor: function(config) { + this.floating = true; + this.el = Ext.create('Ext.Layer', Ext.apply({}, config, { + hideMode: this.hideMode, + hidden: this.hidden, + shadow: Ext.isDefined(this.shadow) ? this.shadow : 'sides', + shadowOffset: this.shadowOffset, + constrain: false, + shim: this.shim === false ? false : undefined + }), this.el); + }, + + onFloatRender: function() { + var me = this; + me.zIndexParent = me.getZIndexParent(); + me.setFloatParent(me.ownerCt); + delete me.ownerCt; + + if (me.zIndexParent) { + me.zIndexParent.registerFloatingItem(me); + } else { + Ext.WindowManager.register(me); + } + }, + + setFloatParent: function(floatParent) { + var me = this; + + // Remove listeners from previous floatParent + if (me.floatParent) { + me.mun(me.floatParent, { + hide: me.onFloatParentHide, + show: me.onFloatParentShow, + scope: me + }); + } + + me.floatParent = floatParent; + + // Floating Components as children of Containers must hide when their parent hides. + if (floatParent) { + me.mon(me.floatParent, { + hide: me.onFloatParentHide, + show: me.onFloatParentShow, + scope: me + }); + } + + // If a floating Component is configured to be constrained, but has no configured + // constrainTo setting, set its constrainTo to be it's ownerCt before rendering. + if ((me.constrain || me.constrainHeader) && !me.constrainTo) { + me.constrainTo = floatParent ? floatParent.getTargetEl() : me.container; + } + }, + + onFloatParentHide: function() { + this.showOnParentShow = this.isVisible(); + this.hide(); + }, + + onFloatParentShow: function() { + if (this.showOnParentShow) { + delete this.showOnParentShow; + this.show(); + } + }, + + /** + * @private + *

Finds the ancestor Container responsible for allocating zIndexes for the passed Component.

+ *

That will be the outermost floating Container (a Container which has no ownerCt and has floating:true).

+ *

If we have no ancestors, or we walk all the way up to the document body, there's no zIndexParent, + * and the global Ext.WindowManager will be used.

+ */ + getZIndexParent: function() { + var p = this.ownerCt, + c; + + if (p) { + while (p) { + c = p; + p = p.ownerCt; + } + if (c.floating) { + return c; + } + } + }, + + // private + // z-index is managed by the zIndexManager and may be overwritten at any time. + // Returns the next z-index to be used. + // If this is a Container, then it will have rebased any managed floating Components, + // and so the next available z-index will be approximately 10000 above that. + setZIndex: function(index) { + var me = this; + this.el.setZIndex(index); + + // Next item goes 10 above; + index += 10; + + // When a Container with floating items has its z-index set, it rebases any floating items it is managing. + // The returned value is a round number approximately 10000 above the last z-index used. + if (me.floatingItems) { + index = Math.floor(me.floatingItems.setBase(index) / 100) * 100 + 10000; + } + return index; + }, + + /** + *

Moves this floating Component into a constrain region.

+ *

By default, this Component is constrained to be within the container it was added to, or the element + * it was rendered to.

+ *

An alternative constraint may be passed.

+ * @param {Mixed} constrainTo Optional. The Element or {@link Ext.util.Region Region} into which this Component is to be constrained. + */ + doConstrain: function(constrainTo) { + var me = this, + vector = me.getConstrainVector(constrainTo), + xy; + + if (vector) { + xy = me.getPosition(); + xy[0] += vector[0]; + xy[1] += vector[1]; + me.setPosition(xy); + } + }, + + + /** + * Gets the x/y offsets to constrain this float + * @private + * @param {Mixed} constrainTo Optional. The Element or {@link Ext.util.Region Region} into which this Component is to be constrained. + * @return {Array} The x/y constraints + */ + getConstrainVector: function(constrainTo){ + var me = this, + el; + + if (me.constrain || me.constrainHeader) { + el = me.constrainHeader ? me.header.el : me.el; + constrainTo = constrainTo || (me.floatParent && me.floatParent.getTargetEl()) || me.container; + return el.getConstrainVector(constrainTo); + } + }, + + /** + * Aligns this floating Component to the specified element + * @param {Mixed} element The element or {@link Ext.Component} to align to. If passing a component, it must + * be a omponent instance. If a string id is passed, it will be used as an element id. + * @param {String} position (optional, defaults to "tl-bl?") The position to align to (see {@link Ext.core.Element#alignTo} for more details). + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @return {Component} this + */ + alignTo: function(element, position, offsets) { + if (element.isComponent) { + element = element.getEl(); + } + var xy = this.el.getAlignToXY(element, position, offsets); + this.setPagePosition(xy); + return this; + }, + + /** + *

Brings this floating Component to the front of any other visible, floating Components managed by the same {@link Ext.ZIndexManager ZIndexManager}

+ *

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

+ * @param {Boolean} preventFocus (optional) Specify true to prevent the Component from being focused. + * @return {Component} this + */ + toFront: function(preventFocus) { + var me = this; + + // Find the floating Component which provides the base for this Component's zIndexing. + // That must move to front to then be able to rebase its zIndex stack and move this to the front + if (me.zIndexParent) { + me.zIndexParent.toFront(true); + } + if (me.zIndexManager.bringToFront(me)) { + if (!Ext.isDefined(preventFocus)) { + preventFocus = !me.focusOnToFront; + } + if (!preventFocus) { + // Kick off a delayed focus request. + // If another floating Component is toFronted before the delay expires + // this will not receive focus. + me.focus(false, true); + } + } + return me; + }, + + /** + *

This method is called internally by {@link Ext.ZIndexManager} to signal that a floating + * Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

+ *

If a Window is superceded by another Window, deactivating it hides its shadow.

+ *

This method also fires the {@link #activate} or {@link #deactivate} event depending on which action occurred.

+ * @param {Boolean} active True to activate the Component, false to deactivate it (defaults to false) + * @param {Component} newActive The newly active Component which is taking over topmost zIndex position. + */ + setActive: function(active, newActive) { + if (active) { + if ((this instanceof Ext.window.Window) && !this.maximized) { + this.el.enableShadow(true); + } + this.fireEvent('activate', this); + } else { + // Only the *Windows* in a zIndex stack share a shadow. All other types of floaters + // can keep their shadows all the time + if ((this instanceof Ext.window.Window) && (newActive instanceof Ext.window.Window)) { + this.el.disableShadow(); + } + this.fireEvent('deactivate', this); + } + }, + + /** + * Sends this Component to the back of (lower z-index than) any other visible windows + * @return {Component} this + */ + toBack: function() { + this.zIndexManager.sendToBack(this); + return this; + }, + + /** + * Center this Component in its container. + * @return {Component} this + */ + center: function() { + var xy = this.el.getAlignToXY(this.container, 'c-c'); + this.setPagePosition(xy); + return this; + }, + + // private + syncShadow : function(){ + if (this.floating) { + this.el.sync(true); + } + }, + + // private + fitContainer: function() { + var parent = this.floatParent, + container = parent ? parent.getTargetEl() : this.container, + size = container.getViewSize(false); + + this.setSize(size); + } +}); +/** + * @class Ext.layout.container.AbstractContainer + * @extends Ext.layout.Layout + * Please refer to sub classes documentation + */ + +Ext.define('Ext.layout.container.AbstractContainer', { + + /* Begin Definitions */ + + extend: 'Ext.layout.Layout', + + /* End Definitions */ + + type: 'container', + + fixedLayout: true, + + // @private + managedHeight: true, + // @private + managedWidth: true, + + /** + * @cfg {Boolean} bindToOwnerCtComponent + * Flag to notify the ownerCt Component on afterLayout of a change + */ + bindToOwnerCtComponent: false, + + /** + * @cfg {Boolean} bindToOwnerCtContainer + * Flag to notify the ownerCt Container on afterLayout of a change + */ + bindToOwnerCtContainer: false, + + /** + * @cfg {String} itemCls + *

An optional extra CSS class that will be added to the container. This can be useful for adding + * customized styles to the container or any of its children using standard CSS rules. See + * {@link Ext.Component}.{@link Ext.Component#ctCls ctCls} also.

+ *

+ */ + + isManaged: function(dimension) { + dimension = Ext.String.capitalize(dimension); + var me = this, + child = me, + managed = me['managed' + dimension], + ancestor = me.owner.ownerCt; + + if (ancestor && ancestor.layout) { + while (ancestor && ancestor.layout) { + if (managed === false || ancestor.layout['managed' + dimension] === false) { + managed = false; + break; + } + ancestor = ancestor.ownerCt; + } + } + return managed; + }, + + layout: function() { + var me = this, + owner = me.owner; + if (Ext.isNumber(owner.height) || owner.isViewport) { + me.managedHeight = false; + } + if (Ext.isNumber(owner.width) || owner.isViewport) { + me.managedWidth = false; + } + me.callParent(arguments); + }, + + /** + * Set the size of an item within the Container. We should always use setCalculatedSize. + * @private + */ + setItemSize: function(item, width, height) { + if (Ext.isObject(width)) { + height = width.height; + width = width.width; + } + item.setCalculatedSize(width, height, this.owner); + }, + + /** + *

Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's + * base class), or the layout phase (onLayout).

+ * @return {Array} of child components + */ + getLayoutItems: function() { + return this.owner && this.owner.items && this.owner.items.items || []; + }, + + afterLayout: function() { + this.owner.afterLayout(this); + }, + /** + * Returns the owner component's resize element. + * @return {Ext.core.Element} + */ + getTarget: function() { + return this.owner.getTargetEl(); + }, + /** + *

Returns the element into which rendering must take place. Defaults to the owner Container's {@link Ext.AbstractComponent#targetEl}.

+ * May be overridden in layout managers which implement an inner element. + * @return {Ext.core.Element} + */ + getRenderTarget: function() { + return this.owner.getTargetEl(); + } +}); + +/** + * @class Ext.ZIndexManager + *

A class that manages a group of {@link Ext.Component#floating} Components and provides z-order management, + * and Component activation behavior, including masking below the active (topmost) Component.

+ *

{@link Ext.Component#floating Floating} Components which are rendered directly into the document (Such as {@link Ext.window.Window Window}s which are + * {@link Ext.Component#show show}n are managed by a {@link Ext.WindowManager global instance}.

+ *

{@link Ext.Component#floating Floating} Components which are descendants of {@link Ext.Component#floating floating} Containers + * (For example a {Ext.view.BoundList BoundList} within an {@link Ext.window.Window Window}, or a {@link Ext.menu.Menu Menu}), + * are managed by a ZIndexManager owned by that floating Container. So ComboBox dropdowns within Windows will have managed z-indices + * guaranteed to be correct, relative to the Window.

+ * @constructor + */ +Ext.define('Ext.ZIndexManager', { + + alternateClassName: 'Ext.WindowGroup', + + statics: { + zBase : 9000 + }, + + constructor: function(container) { + var me = this; + + me.list = {}; + me.zIndexStack = []; + me.front = null; + + if (container) { + + // This is the ZIndexManager for an Ext.container.Container, base its zseed on the zIndex of the Container's element + if (container.isContainer) { + container.on('resize', me._onContainerResize, me); + me.zseed = Ext.Number.from(container.getEl().getStyle('zIndex'), me.getNextZSeed()); + // The containing element we will be dealing with (eg masking) is the content target + me.targetEl = container.getTargetEl(); + me.container = container; + } + // This is the ZIndexManager for a DOM element + else { + Ext.EventManager.onWindowResize(me._onContainerResize, me); + me.zseed = me.getNextZSeed(); + me.targetEl = Ext.get(container); + } + } + // No container passed means we are the global WindowManager. Our target is the doc body. + // DOM must be ready to collect that ref. + else { + Ext.EventManager.onWindowResize(me._onContainerResize, me); + me.zseed = me.getNextZSeed(); + Ext.onDocumentReady(function() { + me.targetEl = Ext.getBody(); + }); + } + }, + + getNextZSeed: function() { + return (Ext.ZIndexManager.zBase += 10000); + }, + + setBase: function(baseZIndex) { + this.zseed = baseZIndex; + return this.assignZIndices(); + }, + + // private + assignZIndices: function() { + var a = this.zIndexStack, + len = a.length, + i = 0, + zIndex = this.zseed, + comp; + + for (; i < len; i++) { + comp = a[i]; + if (comp && !comp.hidden) { + + // Setting the zIndex of a Component returns the topmost zIndex consumed by + // that Component. + // If it's just a plain floating Component such as a BoundList, then the + // return value is the passed value plus 10, ready for the next item. + // If a floating *Container* has its zIndex set, it re-orders its managed + // floating children, starting from that new base, and returns a value 10000 above + // the highest zIndex which it allocates. + zIndex = comp.setZIndex(zIndex); + } + } + this._activateLast(); + return zIndex; + }, + + // private + _setActiveChild: function(comp) { + if (comp != this.front) { + + if (this.front) { + this.front.setActive(false, comp); + } + this.front = comp; + if (comp) { + comp.setActive(true); + if (comp.modal) { + this._showModalMask(comp.el.getStyle('zIndex') - 4); + } + } + } + }, + + // private + _activateLast: function(justHidden) { + var comp, + lastActivated = false, + i; + + // Go down through the z-index stack. + // Activate the next visible one down. + // Keep going down to find the next visible modal one to shift the modal mask down under + for (i = this.zIndexStack.length-1; i >= 0; --i) { + comp = this.zIndexStack[i]; + if (!comp.hidden) { + if (!lastActivated) { + this._setActiveChild(comp); + lastActivated = true; + } + + // Move any modal mask down to just under the next modal floater down the stack + if (comp.modal) { + this._showModalMask(comp.el.getStyle('zIndex') - 4); + return; + } + } + } + + // none to activate, so there must be no modal mask. + // And clear the currently active property + this._hideModalMask(); + if (!lastActivated) { + this._setActiveChild(null); + } + }, + + _showModalMask: function(zIndex) { + if (!this.mask) { + this.mask = this.targetEl.createChild({ + cls: Ext.baseCSSPrefix + 'mask' + }); + this.mask.setVisibilityMode(Ext.core.Element.DISPLAY); + this.mask.on('click', this._onMaskClick, this); + } + Ext.getBody().addCls(Ext.baseCSSPrefix + 'body-masked'); + this.mask.setSize(this.targetEl.getViewSize(true)); + this.mask.setStyle('zIndex', zIndex); + this.mask.show(); + }, + + _hideModalMask: function() { + if (this.mask) { + Ext.getBody().removeCls(Ext.baseCSSPrefix + 'body-masked'); + this.mask.hide(); + } + }, + + _onMaskClick: function() { + if (this.front) { + this.front.focus(); + } + }, + + _onContainerResize: function() { + if (this.mask && this.mask.isVisible()) { + this.mask.setSize(this.targetEl.getViewSize(true)); + } + }, + + /** + *

Registers a floating {@link Ext.Component} with this ZIndexManager. This should not + * need to be called under normal circumstances. Floating Components (such as Windows, BoundLists and Menus) are automatically registered + * with a {@link Ext.Component#zIndexManager zIndexManager} at render time.

+ *

Where this may be useful is moving Windows between two ZIndexManagers. For example, + * to bring the Ext.MessageBox dialog under the same manager as the Desktop's + * ZIndexManager in the desktop sample app:

+MyDesktop.getDesktop().getManager().register(Ext.MessageBox);
+

+ * @param {Component} comp The Component to register. + */ + register : function(comp) { + if (comp.zIndexManager) { + comp.zIndexManager.unregister(comp); + } + comp.zIndexManager = this; + + this.list[comp.id] = comp; + this.zIndexStack.push(comp); + comp.on('hide', this._activateLast, this); + }, + + /** + *

Unregisters a {@link Ext.Component} from this ZIndexManager. This should not + * need to be called. Components are automatically unregistered upon destruction. + * See {@link #register}.

+ * @param {Component} comp The Component to unregister. + */ + unregister : function(comp) { + delete comp.zIndexManager; + if (this.list && this.list[comp.id]) { + delete this.list[comp.id]; + comp.un('hide', this._activateLast); + Ext.Array.remove(this.zIndexStack, comp); + + // Destruction requires that the topmost visible floater be activated. Same as hiding. + this._activateLast(comp); + } + }, + + /** + * Gets a registered Component by id. + * @param {String/Object} id The id of the Component or a {@link Ext.Component} instance + * @return {Ext.Component} + */ + get : function(id) { + return typeof id == "object" ? id : this.list[id]; + }, + + /** + * Brings the specified Component to the front of any other active Components in this ZIndexManager. + * @param {String/Object} comp The id of the Component or a {@link Ext.Component} instance + * @return {Boolean} True if the dialog was brought to the front, else false + * if it was already in front + */ + bringToFront : function(comp) { + comp = this.get(comp); + if (comp != this.front) { + Ext.Array.remove(this.zIndexStack, comp); + this.zIndexStack.push(comp); + this.assignZIndices(); + return true; + } + if (comp.modal) { + Ext.getBody().addCls(Ext.baseCSSPrefix + 'body-masked'); + this.mask.setSize(Ext.core.Element.getViewWidth(true), Ext.core.Element.getViewHeight(true)); + this.mask.show(); + } + return false; + }, + + /** + * Sends the specified Component to the back of other active Components in this ZIndexManager. + * @param {String/Object} comp The id of the Component or a {@link Ext.Component} instance + * @return {Ext.Component} The Component + */ + sendToBack : function(comp) { + comp = this.get(comp); + Ext.Array.remove(this.zIndexStack, comp); + this.zIndexStack.unshift(comp); + this.assignZIndices(); + return comp; + }, + + /** + * Hides all Components managed by this ZIndexManager. + */ + hideAll : function() { + for (var id in this.list) { + if (this.list[id].isComponent && this.list[id].isVisible()) { + this.list[id].hide(); + } + } + }, + + /** + * @private + * Temporarily hides all currently visible managed Components. This is for when + * dragging a Window which may manage a set of floating descendants in its ZIndexManager; + * they should all be hidden just for the duration of the drag. + */ + hide: function() { + var i = 0, + ln = this.zIndexStack.length, + comp; + + this.tempHidden = []; + for (; i < ln; i++) { + comp = this.zIndexStack[i]; + if (comp.isVisible()) { + this.tempHidden.push(comp); + comp.hide(); + } + } + }, + + /** + * @private + * Restores temporarily hidden managed Components to visibility. + */ + show: function() { + var i = 0, + ln = this.tempHidden.length, + comp, + x, + y; + + for (; i < ln; i++) { + comp = this.tempHidden[i]; + x = comp.x; + y = comp.y; + comp.show(); + comp.setPosition(x, y); + } + delete this.tempHidden; + }, + + /** + * Gets the currently-active Component in this ZIndexManager. + * @return {Ext.Component} The active Component + */ + getActive : function() { + return this.front; + }, + + /** + * Returns zero or more Components in this ZIndexManager using the custom search function passed to this method. + * The function should accept a single {@link Ext.Component} reference as its only argument and should + * return true if the Component 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 Component 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 = [], + i = 0, + len = this.zIndexStack.length, + comp; + + for (; i < len; i++) { + comp = this.zIndexStack[i]; + if (fn.call(scope||comp, comp) !== false) { + r.push(comp); + } + } + return r; + }, + + /** + * Executes the specified function once for every Component in this ZIndexManager, passing each + * Component 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 Component in the iteration. + */ + each : function(fn, scope) { + var comp; + for (var id in this.list) { + comp = this.list[id]; + if (comp.isComponent && fn.call(scope || comp, comp) === false) { + return; + } + } + }, + + /** + * Executes the specified function once for every Component in this ZIndexManager, passing each + * Component as the only parameter. Returning false from the function will stop the iteration. + * The components are passed to the function starting at the bottom and proceeding to the top. + * @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 Component in the iteration. + */ + eachBottomUp: function (fn, scope) { + var comp, + stack = this.zIndexStack, + i, n; + + for (i = 0, n = stack.length ; i < n; i++) { + comp = stack[i]; + if (comp.isComponent && fn.call(scope || comp, comp) === false) { + return; + } + } + }, + + /** + * Executes the specified function once for every Component in this ZIndexManager, passing each + * Component as the only parameter. Returning false from the function will stop the iteration. + * The components are passed to the function starting at the top and proceeding to the bottom. + * @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 Component in the iteration. + */ + eachTopDown: function (fn, scope) { + var comp, + stack = this.zIndexStack, + i; + + for (i = stack.length ; i-- > 0; ) { + comp = stack[i]; + if (comp.isComponent && fn.call(scope || comp, comp) === false) { + return; + } + } + }, + + destroy: function() { + delete this.zIndexStack; + delete this.list; + delete this.container; + delete this.targetEl; + } +}, function() { + /** + * @class Ext.WindowManager + * @extends Ext.ZIndexManager + *

The default global floating Component group that is available automatically.

+ *

This manages instances of floating Components which were rendered programatically without + * being added to a {@link Ext.container.Container Container}, and for floating Components which were added into non-floating Containers.

+ *

Floating Containers create their own instance of ZIndexManager, and floating Components added at any depth below + * there are managed by that ZIndexManager.

+ * @singleton + */ + Ext.WindowManager = Ext.WindowMgr = new this(); +}); + +/** + * @class Ext.layout.container.boxOverflow.None + * @extends Object + * @private + * Base class for Box Layout overflow handlers. These specialized classes are invoked when a Box Layout + * (either an HBox or a VBox) has child items that are either too wide (for HBox) or too tall (for VBox) + * for its container. + */ +Ext.define('Ext.layout.container.boxOverflow.None', { + + alternateClassName: 'Ext.layout.boxOverflow.None', + + constructor: function(layout, config) { + this.layout = layout; + Ext.apply(this, config || {}); + }, + + handleOverflow: Ext.emptyFn, + + clearOverflow: Ext.emptyFn, + + onRemove: Ext.emptyFn, + + /** + * @private + * Normalizes an item reference, string id or numerical index into a reference to the item + * @param {Ext.Component|String|Number} item The item reference, id or index + * @return {Ext.Component} The item + */ + getItem: function(item) { + return this.layout.owner.getComponent(item); + }, + + onRemove: Ext.emptyFn +}); +/** + * @class Ext.util.KeyMap + * Handles mapping keys to actions for an element. One key map can be used for multiple actions. + * The constructor accepts the same config object as defined by {@link #addBinding}. + * If you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key + * combination it will call the function with this signature (if the match is a multi-key + * combination the callback will still be called only once): (String key, Ext.EventObject e) + * A KeyMap can also handle a string representation of keys.
+ * Usage: +


+// map one key by key code
+var map = new Ext.util.KeyMap("my-element", {
+    key: 13, // or Ext.EventObject.ENTER
+    fn: myHandler,
+    scope: myObject
+});
+
+// map multiple keys to one action by string
+var map = new Ext.util.KeyMap("my-element", {
+    key: "a\r\n\t",
+    fn: myHandler,
+    scope: myObject
+});
+
+// map multiple keys to multiple actions by strings and array of codes
+var map = new Ext.util.KeyMap("my-element", [
+    {
+        key: [10,13],
+        fn: function(){ alert("Return was pressed"); }
+    }, {
+        key: "abc",
+        fn: function(){ alert('a, b or c was pressed'); }
+    }, {
+        key: "\t",
+        ctrl:true,
+        shift:true,
+        fn: function(){ alert('Control + shift + tab was pressed.'); }
+    }
+]);
+

+ * Note: A KeyMap starts enabled + * @constructor + * @param {Mixed} el The element to bind to + * @param {Object} binding The binding (see {@link #addBinding}) + * @param {String} eventName (optional) The event to bind to (defaults to "keydown") + */ +Ext.define('Ext.util.KeyMap', { + alternateClassName: 'Ext.KeyMap', + + constructor: function(el, binding, eventName){ + var me = this; + + Ext.apply(me, { + el: Ext.get(el), + eventName: eventName || me.eventName, + bindings: [] + }); + if (binding) { + me.addBinding(binding); + } + me.enable(); + }, + + eventName: 'keydown', + + /** + * Add a new binding to this KeyMap. The following config object properties are supported: + *

+Property            Type             Description
+----------          ---------------  ----------------------------------------------------------------------
+key                 String/Array     A single keycode or an array of keycodes to handle
+shift               Boolean          True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined)
+ctrl                Boolean          True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined)
+alt                 Boolean          True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined)
+handler             Function         The function to call when KeyMap finds the expected key combination
+fn                  Function         Alias of handler (for backwards-compatibility)
+scope               Object           The scope of the callback function
+defaultEventAction  String           A default action to apply to the event. Possible values are: stopEvent, stopPropagation, preventDefault. If no value is set no action is performed. 
+

+ * + * Usage: + *


+// Create a KeyMap
+var map = new Ext.util.KeyMap(document, {
+    key: Ext.EventObject.ENTER,
+    fn: handleKey,
+    scope: this
+});
+
+//Add a new binding to the existing KeyMap later
+map.addBinding({
+    key: 'abc',
+    shift: true,
+    fn: handleKey,
+    scope: this
+});
+

+ * @param {Object/Array} binding A single KeyMap config or an array of configs + */ + addBinding : function(binding){ + if (Ext.isArray(binding)) { + Ext.each(binding, this.addBinding, this); + return; + } + + var keyCode = binding.key, + processed = false, + key, + keys, + keyString, + i, + len; + + if (Ext.isString(keyCode)) { + keys = []; + keyString = keyCode.toLowerCase(); + + for (i = 0, len = keyString.length; i < len; ++i){ + keys.push(keyString.charCodeAt(i)); + } + keyCode = keys; + processed = true; + } + + if (!Ext.isArray(keyCode)) { + keyCode = [keyCode]; + } + + if (!processed) { + for (i = 0, len = keyCode.length; i < len; ++i) { + key = keyCode[i]; + if (Ext.isString(key)) { + keyCode[i] = key.toLowerCase().charCodeAt(0); + } + } + } + + this.bindings.push(Ext.apply({ + keyCode: keyCode + }, binding)); + }, + + /** + * Process any keydown events on the element + * @private + * @param {Ext.EventObject} event + */ + handleKeyDown: function(event) { + if (this.enabled) { //just in case + var bindings = this.bindings, + i = 0, + len = bindings.length; + + event = this.processEvent(event); + for(; i < len; ++i){ + this.processBinding(bindings[i], event); + } + } + }, + + /** + * Ugly hack to allow this class to be tested. Currently WebKit gives + * no way to raise a key event properly with both + * a) A keycode + * b) The alt/ctrl/shift modifiers + * So we have to simulate them here. Yuk! + * This is a stub method intended to be overridden by tests. + * More info: https://bugs.webkit.org/show_bug.cgi?id=16735 + * @private + */ + processEvent: function(event){ + return event; + }, + + /** + * Process a particular binding and fire the handler if necessary. + * @private + * @param {Object} binding The binding information + * @param {Ext.EventObject} event + */ + processBinding: function(binding, event){ + if (this.checkModifiers(binding, event)) { + var key = event.getKey(), + handler = binding.fn || binding.handler, + scope = binding.scope || this, + keyCode = binding.keyCode, + defaultEventAction = binding.defaultEventAction, + i, + len, + keydownEvent = new Ext.EventObjectImpl(event); + + + for (i = 0, len = keyCode.length; i < len; ++i) { + if (key === keyCode[i]) { + if (handler.call(scope, key, event) !== true && defaultEventAction) { + keydownEvent[defaultEventAction](); + } + break; + } + } + } + }, + + /** + * Check if the modifiers on the event match those on the binding + * @private + * @param {Object} binding + * @param {Ext.EventObject} event + * @return {Boolean} True if the event matches the binding + */ + checkModifiers: function(binding, e){ + var keys = ['shift', 'ctrl', 'alt'], + i = 0, + len = keys.length, + val, key; + + for (; i < len; ++i){ + key = keys[i]; + val = binding[key]; + if (!(val === undefined || (val === e[key + 'Key']))) { + return false; + } + } + return true; + }, + + /** + * Shorthand for adding a single key listener + * @param {Number/Array/Object} key Either the numeric key code, array of key codes or an object with the + * following options: + * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to the browser window. + */ + on: function(key, fn, scope) { + var keyCode, shift, ctrl, alt; + if (Ext.isObject(key) && !Ext.isArray(key)) { + keyCode = key.key; + shift = key.shift; + ctrl = key.ctrl; + alt = key.alt; + } else { + keyCode = key; + } + this.addBinding({ + key: keyCode, + shift: shift, + ctrl: ctrl, + alt: alt, + fn: fn, + scope: scope + }); + }, + + /** + * Returns true if this KeyMap is enabled + * @return {Boolean} + */ + isEnabled : function(){ + return this.enabled; + }, + + /** + * Enables this KeyMap + */ + enable: function(){ + if(!this.enabled){ + this.el.on(this.eventName, this.handleKeyDown, this); + this.enabled = true; + } + }, + + /** + * Disable this KeyMap + */ + disable: function(){ + if(this.enabled){ + this.el.removeListener(this.eventName, this.handleKeyDown, this); + this.enabled = false; + } + }, + + /** + * Convenience function for setting disabled/enabled by boolean. + * @param {Boolean} disabled + */ + setDisabled : function(disabled){ + if (disabled) { + this.disable(); + } else { + this.enable(); + } + }, + + /** + * Destroys the KeyMap instance and removes all handlers. + * @param {Boolean} removeEl True to also remove the attached element + */ + destroy: function(removeEl){ + var me = this; + + me.bindings = []; + me.disable(); + if (removeEl === true) { + me.el.remove(); + } + delete me.el; + } +}); +/** + * @class Ext.util.ClickRepeater + * @extends Ext.util.Observable + * + * A wrapper class which can be applied to any element. Fires a "click" event while the + * mouse is pressed. The interval between firings may be specified in the config but + * defaults to 20 milliseconds. + * + * Optionally, a CSS class may be applied to the element during the time it is pressed. + * + * @constructor + * @param {Mixed} el The element to listen on + * @param {Object} config + */ + +Ext.define('Ext.util.ClickRepeater', { + extend: 'Ext.util.Observable', + + constructor : function(el, config){ + this.el = Ext.get(el); + this.el.unselectable(); + + Ext.apply(this, config); + + this.addEvents( + /** + * @event mousedown + * Fires when the mouse button is depressed. + * @param {Ext.util.ClickRepeater} this + * @param {Ext.EventObject} e + */ + "mousedown", + /** + * @event click + * Fires on a specified interval during the time the element is pressed. + * @param {Ext.util.ClickRepeater} this + * @param {Ext.EventObject} e + */ + "click", + /** + * @event mouseup + * Fires when the mouse key is released. + * @param {Ext.util.ClickRepeater} this + * @param {Ext.EventObject} e + */ + "mouseup" + ); + + if(!this.disabled){ + this.disabled = true; + this.enable(); + } + + // allow inline handler + if(this.handler){ + this.on("click", this.handler, this.scope || this); + } + + this.callParent(); + }, + + /** + * @cfg {Mixed} el The element to act as a button. + */ + + /** + * @cfg {String} pressedCls A CSS class name to be applied to the element while pressed. + */ + + /** + * @cfg {Boolean} accelerate True if autorepeating should start slowly and accelerate. + * "interval" and "delay" are ignored. + */ + + /** + * @cfg {Number} interval The interval between firings of the "click" event. Default 20 ms. + */ + interval : 20, + + /** + * @cfg {Number} delay The initial delay before the repeating event begins firing. + * Similar to an autorepeat key delay. + */ + delay: 250, + + /** + * @cfg {Boolean} preventDefault True to prevent the default click event + */ + preventDefault : true, + /** + * @cfg {Boolean} stopDefault True to stop the default click event + */ + stopDefault : false, + + timer : 0, + + /** + * Enables the repeater and allows events to fire. + */ + enable: function(){ + if(this.disabled){ + this.el.on('mousedown', this.handleMouseDown, this); + if (Ext.isIE){ + this.el.on('dblclick', this.handleDblClick, this); + } + if(this.preventDefault || this.stopDefault){ + this.el.on('click', this.eventOptions, this); + } + } + this.disabled = false; + }, + + /** + * Disables the repeater and stops events from firing. + */ + disable: function(/* private */ force){ + if(force || !this.disabled){ + clearTimeout(this.timer); + if(this.pressedCls){ + this.el.removeCls(this.pressedCls); + } + Ext.getDoc().un('mouseup', this.handleMouseUp, this); + this.el.removeAllListeners(); + } + this.disabled = true; + }, + + /** + * Convenience function for setting disabled/enabled by boolean. + * @param {Boolean} disabled + */ + setDisabled: function(disabled){ + this[disabled ? 'disable' : 'enable'](); + }, + + eventOptions: function(e){ + if(this.preventDefault){ + e.preventDefault(); + } + if(this.stopDefault){ + e.stopEvent(); + } + }, + + // private + destroy : function() { + this.disable(true); + Ext.destroy(this.el); + this.clearListeners(); + }, + + handleDblClick : function(e){ + clearTimeout(this.timer); + this.el.blur(); + + this.fireEvent("mousedown", this, e); + this.fireEvent("click", this, e); + }, + + // private + handleMouseDown : function(e){ + clearTimeout(this.timer); + this.el.blur(); + if(this.pressedCls){ + this.el.addCls(this.pressedCls); + } + this.mousedownTime = new Date(); + + Ext.getDoc().on("mouseup", this.handleMouseUp, this); + this.el.on("mouseout", this.handleMouseOut, this); + + this.fireEvent("mousedown", this, e); + this.fireEvent("click", this, e); + + // Do not honor delay or interval if acceleration wanted. + if (this.accelerate) { + this.delay = 400; + } + + // Re-wrap the event object in a non-shared object, so it doesn't lose its context if + // the global shared EventObject gets a new Event put into it before the timer fires. + e = new Ext.EventObjectImpl(e); + + this.timer = Ext.defer(this.click, this.delay || this.interval, this, [e]); + }, + + // private + click : function(e){ + this.fireEvent("click", this, e); + this.timer = Ext.defer(this.click, this.accelerate ? + this.easeOutExpo(Ext.Date.getElapsed(this.mousedownTime), + 400, + -390, + 12000) : + this.interval, this, [e]); + }, + + easeOutExpo : function (t, b, c, d) { + return (t==d) ? b+c : c * (-Math.pow(2, -10 * t/d) + 1) + b; + }, + + // private + handleMouseOut : function(){ + clearTimeout(this.timer); + if(this.pressedCls){ + this.el.removeCls(this.pressedCls); + } + this.el.on("mouseover", this.handleMouseReturn, this); + }, + + // private + handleMouseReturn : function(){ + this.el.un("mouseover", this.handleMouseReturn, this); + if(this.pressedCls){ + this.el.addCls(this.pressedCls); + } + this.click(); + }, + + // private + handleMouseUp : function(e){ + clearTimeout(this.timer); + this.el.un("mouseover", this.handleMouseReturn, this); + this.el.un("mouseout", this.handleMouseOut, this); + Ext.getDoc().un("mouseup", this.handleMouseUp, this); + if(this.pressedCls){ + this.el.removeCls(this.pressedCls); + } + this.fireEvent("mouseup", this, e); + } +}); + +/** + * Component layout for buttons + * @class Ext.layout.component.Button + * @extends Ext.layout.component.Component + * @private + */ +Ext.define('Ext.layout.component.Button', { + + /* Begin Definitions */ + + alias: ['layout.button'], + + extend: 'Ext.layout.component.Component', + + /* End Definitions */ + + type: 'button', + + cellClsRE: /-btn-(tl|br)\b/, + htmlRE: /<.*>/, + + beforeLayout: function() { + return this.callParent(arguments) || this.lastText !== this.owner.text; + }, + + /** + * Set the dimensions of the inner <button> element to match the + * component dimensions. + */ + onLayout: function(width, height) { + var me = this, + isNum = Ext.isNumber, + owner = me.owner, + ownerEl = owner.el, + btnEl = owner.btnEl, + btnInnerEl = owner.btnInnerEl, + minWidth = owner.minWidth, + maxWidth = owner.maxWidth, + ownerWidth, btnFrameWidth, metrics; + + me.getTargetInfo(); + me.callParent(arguments); + + btnInnerEl.unclip(); + me.setTargetSize(width, height); + + if (!isNum(width)) { + // In IE7 strict mode button elements with width:auto get strange extra side margins within + // the wrapping table cell, but they go away if the width is explicitly set. So we measure + // the size of the text and set the width to match. + if (owner.text && Ext.isIE7 && Ext.isStrict && btnEl && btnEl.getWidth() > 20) { + btnFrameWidth = me.btnFrameWidth; + metrics = Ext.util.TextMetrics.measure(btnInnerEl, owner.text); + ownerEl.setWidth(metrics.width + btnFrameWidth + me.adjWidth); + btnEl.setWidth(metrics.width + btnFrameWidth); + btnInnerEl.setWidth(metrics.width + btnFrameWidth); + } else { + // Remove any previous fixed widths + ownerEl.setWidth(null); + btnEl.setWidth(null); + btnInnerEl.setWidth(null); + } + + // Handle maxWidth/minWidth config + if (minWidth || maxWidth) { + ownerWidth = ownerEl.getWidth(); + if (minWidth && (ownerWidth < minWidth)) { + me.setTargetSize(minWidth, height); + } + else if (maxWidth && (ownerWidth > maxWidth)) { + btnInnerEl.clip(); + me.setTargetSize(maxWidth, height); + } + } + } + + this.lastText = owner.text; + }, + + setTargetSize: function(width, height) { + var me = this, + owner = me.owner, + isNum = Ext.isNumber, + btnInnerEl = owner.btnInnerEl, + btnWidth = (isNum(width) ? width - me.adjWidth : width), + btnHeight = (isNum(height) ? height - me.adjHeight : height), + btnFrameHeight = me.btnFrameHeight, + text = owner.getText(), + textHeight; + + me.callParent(arguments); + me.setElementSize(owner.btnEl, btnWidth, btnHeight); + me.setElementSize(btnInnerEl, btnWidth, btnHeight); + if (isNum(btnHeight)) { + btnInnerEl.setStyle('line-height', btnHeight - btnFrameHeight + 'px'); + } + + // Button text may contain markup that would force it to wrap to more than one line (e.g. 'Button
Label'). + // When this happens, we cannot use the line-height set above for vertical centering; we instead reset the + // line-height to normal, measure the rendered text height, and add padding-top to center the text block + // vertically within the button's height. This is more expensive than the basic line-height approach so + // we only do it if the text contains markup. + if (text && this.htmlRE.test(text)) { + btnInnerEl.setStyle('line-height', 'normal'); + textHeight = Ext.util.TextMetrics.measure(btnInnerEl, text).height; + btnInnerEl.setStyle('padding-top', me.btnFrameTop + Math.max(btnInnerEl.getHeight() - btnFrameHeight - textHeight, 0) / 2 + 'px'); + me.setElementSize(btnInnerEl, btnWidth, btnHeight); + } + }, + + getTargetInfo: function() { + var me = this, + owner = me.owner, + ownerEl = owner.el, + frameSize = me.frameSize, + frameBody = owner.frameBody, + btnWrap = owner.btnWrap, + innerEl = owner.btnInnerEl; + + if (!('adjWidth' in me)) { + Ext.apply(me, { + // Width adjustment must take into account the arrow area. The btnWrap is the which has padding to accommodate the arrow. + adjWidth: frameSize.left + frameSize.right + ownerEl.getBorderWidth('lr') + ownerEl.getPadding('lr') + + btnWrap.getPadding('lr') + (frameBody ? frameBody.getFrameWidth('lr') : 0), + adjHeight: frameSize.top + frameSize.bottom + ownerEl.getBorderWidth('tb') + ownerEl.getPadding('tb') + + btnWrap.getPadding('tb') + (frameBody ? frameBody.getFrameWidth('tb') : 0), + btnFrameWidth: innerEl.getFrameWidth('lr'), + btnFrameHeight: innerEl.getFrameWidth('tb'), + btnFrameTop: innerEl.getFrameWidth('t') + }); + } + + return me.callParent(); + } +}); +/** + * @class Ext.util.TextMetrics + *
+ * Provides precise pixel measurements for blocks of text so that you can determine exactly how high and + * wide, in pixels, a given block of text will be. Note that when measuring text, it should be plain text and + * should not contain any HTML, otherwise it may not be measured correctly.
+ *
The measurement works by copying the relevant CSS styles that can affect the font related display, + * then checking the size of an element that is auto-sized. Note that if the text is multi-lined, you must + * provide a fixed width when doing the measurement.
+ * + *
+ * If multiple measurements are being done on the same element, you create a new instance to initialize + * to avoid the overhead of copying the styles to the element repeatedly. + *
+ */ +Ext.define('Ext.util.TextMetrics', { + statics: { + shared: null, + /** + * Measures the size of the specified text + * @param {String/HTMLElement} el The element, dom node or id from which to copy existing CSS styles + * that can affect the size of the rendered text + * @param {String} text The text to measure + * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width + * in order to accurately measure the text height + * @return {Object} An object containing the text's size {width: (width), height: (height)} + */ + measure: function(el, text, fixedWidth){ + var me = this, + shared = me.shared; + + if(!shared){ + shared = me.shared = new me(el, fixedWidth); + } + shared.bind(el); + shared.setFixedWidth(fixedWidth || 'auto'); + return shared.getSize(text); + }, + + /** + * Destroy the TextMetrics instance created by {@link #measure}. + */ + destroy: function(){ + var me = this; + Ext.destroy(me.shared); + me.shared = null; + } + }, + + /** + * @constructor + * @param {Mixed} bindTo The element to bind to. + * @param {Number} fixedWidth A fixed width to apply to the measuring element. + */ + constructor: function(bindTo, fixedWidth){ + var measure = this.measure = Ext.getBody().createChild({ + cls: 'x-textmetrics' + }); + this.el = Ext.get(bindTo); + + measure.position('absolute'); + measure.setLeftTop(-1000, -1000); + measure.hide(); + + if (fixedWidth) { + measure.setWidth(fixedWidth); + } + }, + + /** + *
Only available on the instance returned from {@link #createInstance}, not on the singleton.
+ * Returns the size of the specified text based on the internal element's style and width properties + * @param {String} text The text to measure + * @return {Object} An object containing the text's size {width: (width), height: (height)} + */ + getSize: function(text){ + var measure = this.measure, + size; + + measure.update(text); + size = measure.getSize(); + measure.update(''); + return size; + }, + + /** + * Binds this TextMetrics instance to a new element + * @param {Mixed} el The element + */ + bind: function(el){ + var me = this; + + me.el = Ext.get(el); + me.measure.setStyle( + me.el.getStyles('font-size','font-style', 'font-weight', 'font-family','line-height', 'text-transform', 'letter-spacing') + ); + }, + + /** + * Sets a fixed width on the internal measurement element. If the text will be multiline, you have + * to set a fixed width in order to accurately measure the text height. + * @param {Number} width The width to set on the element + */ + setFixedWidth : function(width){ + this.measure.setWidth(width); + }, + + /** + * Returns the measured width of the specified text + * @param {String} text The text to measure + * @return {Number} width The width in pixels + */ + getWidth : function(text){ + this.measure.dom.style.width = 'auto'; + return this.getSize(text).width; + }, + + /** + * Returns the measured height of the specified text + * @param {String} text The text to measure + * @return {Number} height The height in pixels + */ + getHeight : function(text){ + return this.getSize(text).height; + }, + + /** + * Destroy this instance + */ + destroy: function(){ + var me = this; + me.measure.remove(); + delete me.el; + delete me.measure; + } +}, function(){ + Ext.core.Element.addMethods({ + /** + * Returns the width in pixels of the passed text, or the width of the text in this Element. + * @param {String} text The text to measure. Defaults to the innerHTML of the element. + * @param {Number} min (Optional) The minumum value to return. + * @param {Number} max (Optional) The maximum value to return. + * @return {Number} The text width in pixels. + * @member Ext.core.Element getTextWidth + */ + getTextWidth : function(text, min, max){ + return Ext.Number.constrain(Ext.util.TextMetrics.measure(this.dom, Ext.value(text, this.dom.innerHTML, true)).width, min || 0, max || 1000000); + } + }); +}); + +/** + * @class Ext.layout.container.boxOverflow.Scroller + * @extends Ext.layout.container.boxOverflow.None + * @private + */ +Ext.define('Ext.layout.container.boxOverflow.Scroller', { + + /* Begin Definitions */ + + extend: 'Ext.layout.container.boxOverflow.None', + requires: ['Ext.util.ClickRepeater', 'Ext.core.Element'], + alternateClassName: 'Ext.layout.boxOverflow.Scroller', + mixins: { + observable: 'Ext.util.Observable' + }, + + /* End Definitions */ + + /** + * @cfg {Boolean} animateScroll + * True to animate the scrolling of items within the layout (defaults to true, ignored if enableScroll is false) + */ + animateScroll: false, + + /** + * @cfg {Number} scrollIncrement + * The number of pixels to scroll by on scroller click (defaults to 24) + */ + scrollIncrement: 20, + + /** + * @cfg {Number} wheelIncrement + * The number of pixels to increment on mouse wheel scrolling (defaults to 3). + */ + wheelIncrement: 10, + + /** + * @cfg {Number} scrollRepeatInterval + * Number of milliseconds between each scroll while a scroller button is held down (defaults to 20) + */ + scrollRepeatInterval: 60, + + /** + * @cfg {Number} scrollDuration + * Number of milliseconds that each scroll animation lasts (defaults to 400) + */ + scrollDuration: 400, + + /** + * @cfg {String} beforeCtCls + * CSS class added to the beforeCt element. This is the element that holds any special items such as scrollers, + * which must always be present at the leftmost edge of the Container + */ + + /** + * @cfg {String} afterCtCls + * CSS class added to the afterCt element. This is the element that holds any special items such as scrollers, + * which must always be present at the rightmost edge of the Container + */ + + /** + * @cfg {String} scrollerCls + * CSS class added to both scroller elements if enableScroll is used + */ + scrollerCls: Ext.baseCSSPrefix + 'box-scroller', + + /** + * @cfg {String} beforeScrollerCls + * CSS class added to the left scroller element if enableScroll is used + */ + + /** + * @cfg {String} afterScrollerCls + * CSS class added to the right scroller element if enableScroll is used + */ + + constructor: function(layout, config) { + this.layout = layout; + Ext.apply(this, config || {}); + + this.addEvents( + /** + * @event scroll + * @param {Ext.layout.container.boxOverflow.Scroller} scroller The layout scroller + * @param {Number} newPosition The new position of the scroller + * @param {Boolean/Object} animate If animating or not. If true, it will be a animation configuration, else it will be false + */ + 'scroll' + ); + }, + + initCSSClasses: function() { + var me = this, + layout = me.layout; + + if (!me.CSSinitialized) { + me.beforeCtCls = me.beforeCtCls || Ext.baseCSSPrefix + 'box-scroller-' + layout.parallelBefore; + me.afterCtCls = me.afterCtCls || Ext.baseCSSPrefix + 'box-scroller-' + layout.parallelAfter; + me.beforeScrollerCls = me.beforeScrollerCls || Ext.baseCSSPrefix + layout.owner.getXType() + '-scroll-' + layout.parallelBefore; + me.afterScrollerCls = me.afterScrollerCls || Ext.baseCSSPrefix + layout.owner.getXType() + '-scroll-' + layout.parallelAfter; + me.CSSinitializes = true; + } + }, + + handleOverflow: function(calculations, targetSize) { + var me = this, + layout = me.layout, + methodName = 'get' + layout.parallelPrefixCap, + newSize = {}; + + me.initCSSClasses(); + me.callParent(arguments); + this.createInnerElements(); + this.showScrollers(); + newSize[layout.perpendicularPrefix] = targetSize[layout.perpendicularPrefix]; + newSize[layout.parallelPrefix] = targetSize[layout.parallelPrefix] - (me.beforeCt[methodName]() + me.afterCt[methodName]()); + return { targetSize: newSize }; + }, + + /** + * @private + * Creates the beforeCt and afterCt elements if they have not already been created + */ + createInnerElements: function() { + var me = this, + target = me.layout.getRenderTarget(); + + //normal items will be rendered to the innerCt. beforeCt and afterCt allow for fixed positioning of + //special items such as scrollers or dropdown menu triggers + if (!me.beforeCt) { + target.addCls(Ext.baseCSSPrefix + me.layout.direction + '-box-overflow-body'); + me.beforeCt = target.insertSibling({cls: Ext.layout.container.Box.prototype.innerCls + ' ' + me.beforeCtCls}, 'before'); + me.afterCt = target.insertSibling({cls: Ext.layout.container.Box.prototype.innerCls + ' ' + me.afterCtCls}, 'after'); + me.createWheelListener(); + } + }, + + /** + * @private + * Sets up an listener to scroll on the layout's innerCt mousewheel event + */ + createWheelListener: function() { + this.layout.innerCt.on({ + scope : this, + mousewheel: function(e) { + e.stopEvent(); + + this.scrollBy(e.getWheelDelta() * this.wheelIncrement * -1, false); + } + }); + }, + + /** + * @private + */ + clearOverflow: function() { + this.hideScrollers(); + }, + + /** + * @private + * Shows the scroller elements in the beforeCt and afterCt. Creates the scrollers first if they are not already + * present. + */ + showScrollers: function() { + this.createScrollers(); + this.beforeScroller.show(); + this.afterScroller.show(); + this.updateScrollButtons(); + + this.layout.owner.addClsWithUI('scroller'); + }, + + /** + * @private + * Hides the scroller elements in the beforeCt and afterCt + */ + hideScrollers: function() { + if (this.beforeScroller != undefined) { + this.beforeScroller.hide(); + this.afterScroller.hide(); + + this.layout.owner.removeClsWithUI('scroller'); + } + }, + + /** + * @private + * Creates the clickable scroller elements and places them into the beforeCt and afterCt + */ + createScrollers: function() { + if (!this.beforeScroller && !this.afterScroller) { + var before = this.beforeCt.createChild({ + cls: Ext.String.format("{0} {1} ", this.scrollerCls, this.beforeScrollerCls) + }); + + var after = this.afterCt.createChild({ + cls: Ext.String.format("{0} {1}", this.scrollerCls, this.afterScrollerCls) + }); + + before.addClsOnOver(this.beforeScrollerCls + '-hover'); + after.addClsOnOver(this.afterScrollerCls + '-hover'); + + before.setVisibilityMode(Ext.core.Element.DISPLAY); + after.setVisibilityMode(Ext.core.Element.DISPLAY); + + this.beforeRepeater = Ext.create('Ext.util.ClickRepeater', before, { + interval: this.scrollRepeatInterval, + handler : this.scrollLeft, + scope : this + }); + + this.afterRepeater = Ext.create('Ext.util.ClickRepeater', after, { + interval: this.scrollRepeatInterval, + handler : this.scrollRight, + scope : this + }); + + /** + * @property beforeScroller + * @type Ext.core.Element + * The left scroller element. Only created when needed. + */ + this.beforeScroller = before; + + /** + * @property afterScroller + * @type Ext.core.Element + * The left scroller element. Only created when needed. + */ + this.afterScroller = after; + } + }, + + /** + * @private + */ + destroy: function() { + Ext.destroy(this.beforeRepeater, this.afterRepeater, this.beforeScroller, this.afterScroller, this.beforeCt, this.afterCt); + }, + + /** + * @private + * Scrolls left or right by the number of pixels specified + * @param {Number} delta Number of pixels to scroll to the right by. Use a negative number to scroll left + */ + scrollBy: function(delta, animate) { + this.scrollTo(this.getScrollPosition() + delta, animate); + }, + + /** + * @private + * @return {Object} Object passed to scrollTo when scrolling + */ + getScrollAnim: function() { + return { + duration: this.scrollDuration, + callback: this.updateScrollButtons, + scope : this + }; + }, + + /** + * @private + * Enables or disables each scroller button based on the current scroll position + */ + updateScrollButtons: function() { + if (this.beforeScroller == undefined || this.afterScroller == undefined) { + return; + } + + var beforeMeth = this.atExtremeBefore() ? 'addCls' : 'removeCls', + afterMeth = this.atExtremeAfter() ? 'addCls' : 'removeCls', + beforeCls = this.beforeScrollerCls + '-disabled', + afterCls = this.afterScrollerCls + '-disabled'; + + this.beforeScroller[beforeMeth](beforeCls); + this.afterScroller[afterMeth](afterCls); + this.scrolling = false; + }, + + /** + * @private + * Returns true if the innerCt scroll is already at its left-most point + * @return {Boolean} True if already at furthest left point + */ + atExtremeBefore: function() { + return this.getScrollPosition() === 0; + }, + + /** + * @private + * Scrolls to the left by the configured amount + */ + scrollLeft: function() { + this.scrollBy(-this.scrollIncrement, false); + }, + + /** + * @private + * Scrolls to the right by the configured amount + */ + scrollRight: function() { + this.scrollBy(this.scrollIncrement, false); + }, + + /** + * Returns the current scroll position of the innerCt element + * @return {Number} The current scroll position + */ + getScrollPosition: function(){ + var layout = this.layout; + return parseInt(layout.innerCt.dom['scroll' + layout.parallelBeforeCap], 10) || 0; + }, + + /** + * @private + * Returns the maximum value we can scrollTo + * @return {Number} The max scroll value + */ + getMaxScrollPosition: function() { + var layout = this.layout; + return layout.innerCt.dom['scroll' + layout.parallelPrefixCap] - this.layout.innerCt['get' + layout.parallelPrefixCap](); + }, + + /** + * @private + * Returns true if the innerCt scroll is already at its right-most point + * @return {Boolean} True if already at furthest right point + */ + atExtremeAfter: function() { + return this.getScrollPosition() >= this.getMaxScrollPosition(); + }, + + /** + * @private + * Scrolls to the given position. Performs bounds checking. + * @param {Number} position The position to scroll to. This is constrained. + * @param {Boolean} animate True to animate. If undefined, falls back to value of this.animateScroll + */ + scrollTo: function(position, animate) { + var me = this, + layout = me.layout, + oldPosition = me.getScrollPosition(), + newPosition = Ext.Number.constrain(position, 0, me.getMaxScrollPosition()); + + if (newPosition != oldPosition && !me.scrolling) { + if (animate == undefined) { + animate = me.animateScroll; + } + + layout.innerCt.scrollTo(layout.parallelBefore, newPosition, animate ? me.getScrollAnim() : false); + if (animate) { + me.scrolling = true; + } else { + me.scrolling = false; + me.updateScrollButtons(); + } + + me.fireEvent('scroll', me, newPosition, animate ? me.getScrollAnim() : false); + } + }, + + /** + * Scrolls to the given component. + * @param {String|Number|Ext.Component} item The item to scroll to. Can be a numerical index, component id + * or a reference to the component itself. + * @param {Boolean} animate True to animate the scrolling + */ + scrollToItem: function(item, animate) { + var me = this, + layout = me.layout, + visibility, + box, + newPos; + + item = me.getItem(item); + if (item != undefined) { + visibility = this.getItemVisibility(item); + if (!visibility.fullyVisible) { + box = item.getBox(true, true); + newPos = box[layout.parallelPosition]; + if (visibility.hiddenEnd) { + newPos -= (this.layout.innerCt['get' + layout.parallelPrefixCap]() - box[layout.parallelPrefix]); + } + this.scrollTo(newPos, animate); + } + } + }, + + /** + * @private + * For a given item in the container, return an object with information on whether the item is visible + * with the current innerCt scroll value. + * @param {Ext.Component} item The item + * @return {Object} Values for fullyVisible, hiddenStart and hiddenEnd + */ + getItemVisibility: function(item) { + var me = this, + box = me.getItem(item).getBox(true, true), + layout = me.layout, + itemStart = box[layout.parallelPosition], + itemEnd = itemStart + box[layout.parallelPrefix], + scrollStart = me.getScrollPosition(), + scrollEnd = scrollStart + layout.innerCt['get' + layout.parallelPrefixCap](); + + return { + hiddenStart : itemStart < scrollStart, + hiddenEnd : itemEnd > scrollEnd, + fullyVisible: itemStart > scrollStart && itemEnd < scrollEnd + }; + } +}); +/** + * @class Ext.util.Offset + * @ignore + */ +Ext.define('Ext.util.Offset', { + + /* Begin Definitions */ + + statics: { + fromObject: function(obj) { + return new this(obj.x, obj.y); + } + }, + + /* End Definitions */ + + constructor: function(x, y) { + this.x = (x != null && !isNaN(x)) ? x : 0; + this.y = (y != null && !isNaN(y)) ? y : 0; + + return this; + }, + + copy: function() { + return new Ext.util.Offset(this.x, this.y); + }, + + copyFrom: function(p) { + this.x = p.x; + this.y = p.y; + }, + + toString: function() { + return "Offset[" + this.x + "," + this.y + "]"; + }, + + equals: function(offset) { + if(!(offset instanceof this.statics())) { + Ext.Error.raise('Offset must be an instance of Ext.util.Offset'); + } + + return (this.x == offset.x && this.y == offset.y); + }, + + round: function(to) { + if (!isNaN(to)) { + var factor = Math.pow(10, to); + this.x = Math.round(this.x * factor) / factor; + this.y = Math.round(this.y * factor) / factor; + } else { + this.x = Math.round(this.x); + this.y = Math.round(this.y); + } + }, + + isZero: function() { + return this.x == 0 && this.y == 0; + } +}); + +/** + * @class Ext.util.KeyNav + *
Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind + * navigation keys to function calls that will get called when the keys are pressed, providing an easy + * way to implement custom navigation schemes for any UI component.
+ *
The following are all of the possible keys that can be implemented: enter, space, left, right, up, down, tab, esc, + * pageUp, pageDown, del, backspace, home, end. Usage:
+
+var nav = new Ext.util.KeyNav("my-element", { + "left" : function(e){ + this.moveLeft(e.ctrlKey); + }, + "right" : function(e){ + this.moveRight(e.ctrlKey); + }, + "enter" : function(e){ + this.save(); + }, + scope : this +}); +
+ * @constructor + * @param {Mixed} el The element to bind to + * @param {Object} config The config + */ +Ext.define('Ext.util.KeyNav', { + + alternateClassName: 'Ext.KeyNav', + + requires: ['Ext.util.KeyMap'], + + statics: { + keyOptions: { + left: 37, + right: 39, + up: 38, + down: 40, + space: 32, + pageUp: 33, + pageDown: 34, + del: 46, + backspace: 8, + home: 36, + end: 35, + enter: 13, + esc: 27, + tab: 9 + } + }, + + constructor: function(el, config){ + this.setConfig(el, config || {}); + }, + + /** + * Sets up a configuration for the KeyNav. + * @private + * @param {Mixed} el The element to bind to + * @param {Object}A configuration object as specified in the constructor. + */ + setConfig: function(el, config) { + if (this.map) { + this.map.destroy(); + } + + var map = Ext.create('Ext.util.KeyMap', el, null, this.getKeyEvent('forceKeyDown' in config ? config.forceKeyDown : this.forceKeyDown)), + keys = Ext.util.KeyNav.keyOptions, + scope = config.scope || this, + key; + + this.map = map; + for (key in keys) { + if (keys.hasOwnProperty(key)) { + if (config[key]) { + map.addBinding({ + scope: scope, + key: keys[key], + handler: Ext.Function.bind(this.handleEvent, scope, [config[key]], true), + defaultEventAction: config.defaultEventAction || this.defaultEventAction + }); + } + } + } + + map.disable(); + if (!config.disabled) { + map.enable(); + } + }, + + /** + * Method for filtering out the map argument + * @private + * @param {Ext.util.KeyMap} map + * @param {Ext.EventObject} event + * @param {Object} options Contains the handler to call + */ + handleEvent: function(map, event, handler){ + return handler.call(this, event); + }, + + /** + * @cfg {Boolean} disabled + * True to disable this KeyNav instance (defaults to false) + */ + disabled: false, + + /** + * @cfg {String} defaultEventAction + * The method to call on the {@link Ext.EventObject} after this KeyNav intercepts a key. Valid values are + * {@link Ext.EventObject#stopEvent}, {@link Ext.EventObject#preventDefault} and + * {@link Ext.EventObject#stopPropagation} (defaults to 'stopEvent') + */ + defaultEventAction: "stopEvent", + + /** + * @cfg {Boolean} forceKeyDown + * Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since + * IE does not propagate special keys on keypress, but setting this to true will force other browsers to also + * handle keydown instead of keypress. + */ + forceKeyDown: false, + + /** + * Destroy this KeyNav (this is the same as calling disable). + * @param {Boolean} removeEl True to remove the element associated with this KeyNav. + */ + destroy: function(removeEl){ + this.map.destroy(removeEl); + delete this.map; + }, + + /** + * Enable this KeyNav + */ + enable: function() { + this.map.enable(); + this.disabled = false; + }, + + /** + * Disable this KeyNav + */ + disable: function() { + this.map.disable(); + this.disabled = true; + }, + + /** + * Convenience function for setting disabled/enabled by boolean. + * @param {Boolean} disabled + */ + setDisabled : function(disabled){ + this.map.setDisabled(disabled); + this.disabled = disabled; + }, + + /** + * Determines the event to bind to listen for keys. Depends on the {@link #forceKeyDown} setting, + * as well as the useKeyDown option on the EventManager. + * @return {String} The type of event to listen for. + */ + getKeyEvent: function(forceKeyDown){ + return (forceKeyDown || Ext.EventManager.useKeyDown) ? 'keydown' : 'keypress'; + } +}); + +/** + * @class Ext.fx.Queue + * Animation Queue mixin to handle chaining and queueing by target. + * @private + */ + +Ext.define('Ext.fx.Queue', { + + requires: ['Ext.util.HashMap'], + + constructor: function() { + this.targets = Ext.create('Ext.util.HashMap'); + this.fxQueue = {}; + }, + + // @private + getFxDefaults: function(targetId) { + var target = this.targets.get(targetId); + if (target) { + return target.fxDefaults; + } + return {}; + }, + + // @private + setFxDefaults: function(targetId, obj) { + var target = this.targets.get(targetId); + if (target) { + target.fxDefaults = Ext.apply(target.fxDefaults || {}, obj); + } + }, + + // @private + stopAnimation: function(targetId) { + var me = this, + queue = me.getFxQueue(targetId), + ln = queue.length; + while (ln) { + queue[ln - 1].end(); + ln--; + } + }, + + /** + * @private + * Returns current animation object if the element has any effects actively running or queued, else returns false. + */ + getActiveAnimation: function(targetId) { + var queue = this.getFxQueue(targetId); + return (queue && !!queue.length) ? queue[0] : false; + }, + + // @private + hasFxBlock: function(targetId) { + var queue = this.getFxQueue(targetId); + return queue && queue[0] && queue[0].block; + }, + + // @private get fx queue for passed target, create if needed. + getFxQueue: function(targetId) { + if (!targetId) { + return false; + } + var me = this, + queue = me.fxQueue[targetId], + target = me.targets.get(targetId); + + if (!target) { + return false; + } + + if (!queue) { + me.fxQueue[targetId] = []; + // GarbageCollector will need to clean up Elements since they aren't currently observable + if (target.type != 'element') { + target.target.on('destroy', function() { + me.fxQueue[targetId] = []; + }); + } + } + return me.fxQueue[targetId]; + }, + + // @private + queueFx: function(anim) { + var me = this, + target = anim.target, + queue, ln; + + if (!target) { + return; + } + + queue = me.getFxQueue(target.getId()); + ln = queue.length; + + if (ln) { + if (anim.concurrent) { + anim.paused = false; + } + else { + queue[ln - 1].on('afteranimate', function() { + anim.paused = false; + }); + } + } + else { + anim.paused = false; + } + anim.on('afteranimate', function() { + Ext.Array.remove(queue, anim); + if (anim.remove) { + if (target.type == 'element') { + var el = Ext.get(target.id); + if (el) { + el.remove(); + } + } + } + }, this); + queue.push(anim); + } +}); +/** + * @class Ext.fx.target.Target + +This class specifies a generic target for an animation. It provides a wrapper around a +series of different types of objects to allow for a generic animation API. +A target can be a single object or a Composite object containing other objects that are +to be animated. This class and it's subclasses are generally not created directly, the +underlying animation will create the appropriate Ext.fx.target.Target object by passing +the instance to be animated. + +The following types of objects can be animated: +- {@link #Ext.fx.target.Component Components} +- {@link #Ext.fx.target.Element Elements} +- {@link #Ext.fx.target.Sprite Sprites} + + * @markdown + * @abstract + * @constructor + * @param {Mixed} target The object to be animated + */ + +Ext.define('Ext.fx.target.Target', { + + isAnimTarget: true, + + constructor: function(target) { + this.target = target; + this.id = this.getId(); + }, + + getId: function() { + return this.target.id; + } +}); + +/** + * @class Ext.fx.target.Sprite + * @extends Ext.fx.target.Target + +This class represents a animation target for a {@link Ext.draw.Sprite}. In general this class will not be +created directly, the {@link Ext.draw.Sprite} will be passed to the animation and +and the appropriate target will be created. + + * @markdown + */ + +Ext.define('Ext.fx.target.Sprite', { + + /* Begin Definitions */ + + extend: 'Ext.fx.target.Target', + + /* End Definitions */ + + type: 'draw', + + getFromPrim: function(sprite, attr) { + var o; + if (attr == 'translate') { + o = { + x: sprite.attr.translation.x || 0, + y: sprite.attr.translation.y || 0 + }; + } + else if (attr == 'rotate') { + o = { + degrees: sprite.attr.rotation.degrees || 0, + x: sprite.attr.rotation.x, + y: sprite.attr.rotation.y + }; + } + else { + o = sprite.attr[attr]; + } + return o; + }, + + getAttr: function(attr, val) { + return [[this.target, val != undefined ? val : this.getFromPrim(this.target, attr)]]; + }, + + setAttr: function(targetData) { + var ln = targetData.length, + spriteArr = [], + attrs, attr, attrArr, attPtr, spritePtr, idx, value, i, j, x, y, ln2; + for (i = 0; i < ln; i++) { + attrs = targetData[i].attrs; + for (attr in attrs) { + attrArr = attrs[attr]; + ln2 = attrArr.length; + for (j = 0; j < ln2; j++) { + spritePtr = attrArr[j][0]; + attPtr = attrArr[j][1]; + if (attr === 'translate') { + value = { + x: attPtr.x, + y: attPtr.y + }; + } + else if (attr === 'rotate') { + x = attPtr.x; + if (isNaN(x)) { + x = null; + } + y = attPtr.y; + if (isNaN(y)) { + y = null; + } + value = { + degrees: attPtr.degrees, + x: x, + y: y + }; + } + else if (attr === 'width' || attr === 'height' || attr === 'x' || attr === 'y') { + value = parseFloat(attPtr); + } + else { + value = attPtr; + } + idx = Ext.Array.indexOf(spriteArr, spritePtr); + if (idx == -1) { + spriteArr.push([spritePtr, {}]); + idx = spriteArr.length - 1; + } + spriteArr[idx][1][attr] = value; + } + } + } + ln = spriteArr.length; + for (i = 0; i < ln; i++) { + spritePtr = spriteArr[i]; + spritePtr[0].setAttributes(spritePtr[1]); + } + this.target.redraw(); + } +}); + +/** + * @class Ext.fx.target.CompositeSprite + * @extends Ext.fx.target.Sprite + +This class represents a animation target for a {@link Ext.draw.CompositeSprite}. It allows +each {@link Ext.draw.Sprite} in the group to be animated as a whole. In general this class will not be +created directly, the {@link Ext.draw.CompositeSprite} will be passed to the animation and +and the appropriate target will be created. + + * @markdown + */ + +Ext.define('Ext.fx.target.CompositeSprite', { + + /* Begin Definitions */ + + extend: 'Ext.fx.target.Sprite', + + /* End Definitions */ + + getAttr: function(attr, val) { + var out = [], + target = this.target; + target.each(function(sprite) { + out.push([sprite, val != undefined ? val : this.getFromPrim(sprite, attr)]); + }, this); + return out; + } +}); + +/** + * @class Ext.fx.target.Component + * @extends Ext.fx.target.Target + * + * This class represents a animation target for a {@link Ext.Component}. In general this class will not be + * created directly, the {@link Ext.Component} will be passed to the animation and + * and the appropriate target will be created. + */ +Ext.define('Ext.fx.target.Component', { + + /* Begin Definitions */ + + extend: 'Ext.fx.target.Target', + + /* End Definitions */ + + type: 'component', + + // Methods to call to retrieve unspecified "from" values from a target Component + getPropMethod: { + top: function() { + return this.getPosition(true)[1]; + }, + left: function() { + return this.getPosition(true)[0]; + }, + x: function() { + return this.getPosition()[0]; + }, + y: function() { + return this.getPosition()[1]; + }, + height: function() { + return this.getHeight(); + }, + width: function() { + return this.getWidth(); + }, + opacity: function() { + return this.el.getStyle('opacity'); + } + }, + + compMethod: { + top: 'setPosition', + left: 'setPosition', + x: 'setPagePosition', + y: 'setPagePosition', + height: 'setSize', + width: 'setSize', + opacity: 'setOpacity' + }, + + // Read the named attribute from the target Component. Use the defined getter for the attribute + getAttr: function(attr, val) { + return [[this.target, val !== undefined ? val : this.getPropMethod[attr].call(this.target)]]; + }, + + setAttr: function(targetData, isFirstFrame, isLastFrame) { + var me = this, + target = me.target, + ln = targetData.length, + attrs, attr, o, i, j, meth, targets, left, top, w, h; + for (i = 0; i < ln; i++) { + attrs = targetData[i].attrs; + for (attr in attrs) { + targets = attrs[attr].length; + meth = { + setPosition: {}, + setPagePosition: {}, + setSize: {}, + setOpacity: {} + }; + for (j = 0; j < targets; j++) { + o = attrs[attr][j]; + // We REALLY want a single function call, so push these down to merge them: eg + // meth.setPagePosition.target = + // meth.setPagePosition['x'] = 100 + // meth.setPagePosition['y'] = 100 + meth[me.compMethod[attr]].target = o[0]; + meth[me.compMethod[attr]][attr] = o[1]; + } + if (meth.setPosition.target) { + o = meth.setPosition; + left = (o.left === undefined) ? undefined : parseInt(o.left, 10); + top = (o.top === undefined) ? undefined : parseInt(o.top, 10); + o.target.setPosition(left, top); + } + if (meth.setPagePosition.target) { + o = meth.setPagePosition; + o.target.setPagePosition(o.x, o.y); + } + if (meth.setSize.target) { + o = meth.setSize; + // Dimensions not being animated MUST NOT be autosized. They must remain at current value. + w = (o.width === undefined) ? o.target.getWidth() : parseInt(o.width, 10); + h = (o.height === undefined) ? o.target.getHeight() : parseInt(o.height, 10); + + // Only set the size of the Component on the last frame, or if the animation was + // configured with dynamic: true. + // In other cases, we just set the target element size. + // This will result in either clipping if animating a reduction in size, or the revealing of + // the inner elements of the Component if animating an increase in size. + // Component's animate function initially resizes to the larger size before resizing the + // outer element to clip the contents. + if (isLastFrame || me.dynamic) { + o.target.componentLayout.childrenChanged = true; + + // Flag if we are being called by an animating layout: use setCalculatedSize + if (me.layoutAnimation) { + o.target.setCalculatedSize(w, h); + } else { + o.target.setSize(w, h); + } + } + else { + o.target.el.setSize(w, h); + } + } + if (meth.setOpacity.target) { + o = meth.setOpacity; + o.target.el.setStyle('opacity', o.opacity); + } + } + } + } +}); + +/** + * @class Ext.fx.CubicBezier + * @ignore + */ +Ext.define('Ext.fx.CubicBezier', { + + /* Begin Definitions */ + + singleton: true, + + /* End Definitions */ + + cubicBezierAtTime: function(t, p1x, p1y, p2x, p2y, duration) { + var cx = 3 * p1x, + bx = 3 * (p2x - p1x) - cx, + ax = 1 - cx - bx, + cy = 3 * p1y, + by = 3 * (p2y - p1y) - cy, + ay = 1 - cy - by; + function sampleCurveX(t) { + return ((ax * t + bx) * t + cx) * t; + } + function solve(x, epsilon) { + var t = solveCurveX(x, epsilon); + return ((ay * t + by) * t + cy) * t; + } + function solveCurveX(x, epsilon) { + var t0, t1, t2, x2, d2, i; + for (t2 = x, i = 0; i < 8; i++) { + x2 = sampleCurveX(t2) - x; + if (Math.abs(x2) < epsilon) { + return t2; + } + d2 = (3 * ax * t2 + 2 * bx) * t2 + cx; + if (Math.abs(d2) < 1e-6) { + break; + } + t2 = t2 - x2 / d2; + } + t0 = 0; + t1 = 1; + t2 = x; + if (t2 < t0) { + return t0; + } + if (t2 > t1) { + return t1; + } + while (t0 < t1) { + x2 = sampleCurveX(t2); + if (Math.abs(x2 - x) < epsilon) { + return t2; + } + if (x > x2) { + t0 = t2; + } else { + t1 = t2; + } + t2 = (t1 - t0) / 2 + t0; + } + return t2; + } + return solve(t, 1 / (200 * duration)); + }, + + cubicBezier: function(x1, y1, x2, y2) { + var fn = function(pos) { + return Ext.fx.CubicBezier.cubicBezierAtTime(pos, x1, y1, x2, y2, 1); + }; + fn.toCSS3 = function() { + return 'cubic-bezier(' + [x1, y1, x2, y2].join(',') + ')'; + }; + fn.reverse = function() { + return Ext.fx.CubicBezier.cubicBezier(1 - x2, 1 - y2, 1 - x1, 1 - y1); + }; + return fn; + } +}); +/** + * @class Ext.draw.Color + * @extends Object + * + * Represents an RGB color and provides helper functions get + * color components in HSL color space. + */ +Ext.define('Ext.draw.Color', { + + /* Begin Definitions */ + + /* End Definitions */ + + colorToHexRe: /(.*?)rgb$(\d+),\s*(\d+),\s*(\d+)$/, + rgbRe: /\s*rgb\s*$\s*([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)\s*$\s*/, + hexRe: /\s*#([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)\s*/, + + /** + * @cfg {Number} lightnessFactor + * + * The default factor to compute the lighter or darker color. Defaults to 0.2. + */ + lightnessFactor: 0.2, + + /** + * @constructor + * @param {Number} red Red component (0..255) + * @param {Number} green Green component (0..255) + * @param {Number} blue Blue component (0..255) + */ + constructor : function(red, green, blue) { + var me = this, + clamp = Ext.Number.constrain; + me.r = clamp(red, 0, 255); + me.g = clamp(green, 0, 255); + me.b = clamp(blue, 0, 255); + }, + + /** + * Get the red component of the color, in the range 0..255. + * @return {Number} + */ + getRed: function() { + return this.r; + }, + + /** + * Get the green component of the color, in the range 0..255. + * @return {Number} + */ + getGreen: function() { + return this.g; + }, + + /** + * Get the blue component of the color, in the range 0..255. + * @return {Number} + */ + getBlue: function() { + return this.b; + }, + + /** + * Get the RGB values. + * @return {Array} + */ + getRGB: function() { + var me = this; + return [me.r, me.g, me.b]; + }, + + /** + * Get the equivalent HSL components of the color. + * @return {Array} + */ + getHSL: function() { + var me = this, + r = me.r / 255, + g = me.g / 255, + b = me.b / 255, + max = Math.max(r, g, b), + min = Math.min(r, g, b), + delta = max - min, + h, + s = 0, + l = 0.5 * (max + min); + + // min==max means achromatic (hue is undefined) + if (min != max) { + s = (l < 0.5) ? delta / (max + min) : delta / (2 - max - min); + if (r == max) { + h = 60 * (g - b) / delta; + } else if (g == max) { + h = 120 + 60 * (b - r) / delta; + } else { + h = 240 + 60 * (r - g) / delta; + } + if (h < 0) { + h += 360; + } + if (h >= 360) { + h -= 360; + } + } + return [h, s, l]; + }, + + /** + * Return a new color that is lighter than this color. + * @param {Number} factor Lighter factor (0..1), default to 0.2 + * @return Ext.draw.Color + */ + getLighter: function(factor) { + var hsl = this.getHSL(); + factor = factor || this.lightnessFactor; + hsl[2] = Ext.Number.constrain(hsl[2] + factor, 0, 1); + return this.fromHSL(hsl[0], hsl[1], hsl[2]); + }, + + /** + * Return a new color that is darker than this color. + * @param {Number} factor Darker factor (0..1), default to 0.2 + * @return Ext.draw.Color + */ + getDarker: function(factor) { + factor = factor || this.lightnessFactor; + return this.getLighter(-factor); + }, + + /** + * Return the color in the hex format, i.e. '#rrggbb'. + * @return {String} + */ + toString: function() { + var me = this, + round = Math.round, + r = round(me.r).toString(16), + g = round(me.g).toString(16), + b = round(me.b).toString(16); + r = (r.length == 1) ? '0' + r : r; + g = (g.length == 1) ? '0' + g : g; + b = (b.length == 1) ? '0' + b : b; + return ['#', r, g, b].join(''); + }, + + /** + * Convert a color to hexadecimal format. + * + * @param {String|Array} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff'). + * Can also be an Array, in this case the function handles the first member. + * @returns {String} The color in hexadecimal format. + */ + toHex: function(color) { + if (Ext.isArray(color)) { + color = color[0]; + } + if (!Ext.isString(color)) { + return ''; + } + if (color.substr(0, 1) === '#') { + return color; + } + var digits = this.colorToHexRe.exec(color); + + if (Ext.isArray(digits)) { + var red = parseInt(digits[2], 10), + green = parseInt(digits[3], 10), + blue = parseInt(digits[4], 10), + rgb = blue | (green << 8) | (red << 16); + return digits[1] + '#' + ("000000" + rgb.toString(16)).slice(-6); + } + else { + return ''; + } + }, + + /** + * Parse the string and create a new color. + * + * Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'. + * + * If the string is not recognized, an undefined will be returned instead. + * + * @param {String} str Color in string. + * @returns Ext.draw.Color + */ + fromString: function(str) { + var values, r, g, b, + parse = parseInt; + + if ((str.length == 4 || str.length == 7) && str.substr(0, 1) === '#') { + values = str.match(this.hexRe); + if (values) { + r = parse(values[1], 16) >> 0; + g = parse(values[2], 16) >> 0; + b = parse(values[3], 16) >> 0; + if (str.length == 4) { + r += (r * 16); + g += (g * 16); + b += (b * 16); + } + } + } + else { + values = str.match(this.rgbRe); + if (values) { + r = values[1]; + g = values[2]; + b = values[3]; + } + } + + return (typeof r == 'undefined') ? undefined : Ext.create('Ext.draw.Color', r, g, b); + }, + + /** + * Returns the gray value (0 to 255) of the color. + * + * The gray value is calculated using the formula r*0.3 + g*0.59 + b*0.11. + * + * @returns {Number} + */ + getGrayscale: function() { + // http://en.wikipedia.org/wiki/Grayscale#Converting_color_to_grayscale + return this.r * 0.3 + this.g * 0.59 + this.b * 0.11; + }, + + /** + * Create a new color based on the specified HSL values. + * + * @param {Number} h Hue component (0..359) + * @param {Number} s Saturation component (0..1) + * @param {Number} l Lightness component (0..1) + * @returns Ext.draw.Color + */ + fromHSL: function(h, s, l) { + var C, X, m, i, rgb = [], + abs = Math.abs, + floor = Math.floor; + + if (s == 0 || h == null) { + // achromatic + rgb = [l, l, l]; + } + else { + // http://en.wikipedia.org/wiki/HSL_and_HSV#From_HSL + // C is the chroma + // X is the second largest component + // m is the lightness adjustment + h /= 60; + C = s * (1 - abs(2 * l - 1)); + X = C * (1 - abs(h - 2 * floor(h / 2) - 1)); + m = l - C / 2; + switch (floor(h)) { + case 0: + rgb = [C, X, 0]; + break; + case 1: + rgb = [X, C, 0]; + break; + case 2: + rgb = [0, C, X]; + break; + case 3: + rgb = [0, X, C]; + break; + case 4: + rgb = [X, 0, C]; + break; + case 5: + rgb = [C, 0, X]; + break; + } + rgb = [rgb[0] + m, rgb[1] + m, rgb[2] + m]; + } + return Ext.create('Ext.draw.Color', rgb[0] * 255, rgb[1] * 255, rgb[2] * 255); + } +}, function() { + var prototype = this.prototype; + + //These functions are both static and instance. TODO: find a more elegant way of copying them + this.addStatics({ + fromHSL: function() { + return prototype.fromHSL.apply(prototype, arguments); + }, + fromString: function() { + return prototype.fromString.apply(prototype, arguments); + }, + toHex: function() { + return prototype.toHex.apply(prototype, arguments); + } + }); +}); + +/** + * @class Ext.dd.StatusProxy + * A specialized drag proxy that supports a drop status icon, {@link Ext.Layer} styles and auto-repair. This is the + * default drag proxy used by all Ext.dd components. + * @constructor + * @param {Object} config + */ +Ext.define('Ext.dd.StatusProxy', { + animRepair: false, + + constructor: function(config){ + Ext.apply(this, config); + this.id = this.id || Ext.id(); + this.proxy = Ext.createWidget('component', { + floating: true, + id: this.id, + html: '
' + + '
', + cls: Ext.baseCSSPrefix + 'dd-drag-proxy ' + this.dropNotAllowed, + shadow: !config || config.shadow !== false, + renderTo: document.body + }); + + this.el = this.proxy.el; + this.el.show(); + this.el.setVisibilityMode(Ext.core.Element.VISIBILITY); + this.el.hide(); + + this.ghost = Ext.get(this.el.dom.childNodes[1]); + this.dropStatus = this.dropNotAllowed; + }, + /** + * @cfg {String} dropAllowed + * The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok"). + */ + dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok', + /** + * @cfg {String} dropNotAllowed + * The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop"). + */ + dropNotAllowed : Ext.baseCSSPrefix + 'dd-drop-nodrop', + + /** + * Updates the proxy's visual element to indicate the status of whether or not drop is allowed + * over the current target element. + * @param {String} cssClass The css class for the new drop status indicator image + */ + setStatus : function(cssClass){ + cssClass = cssClass || this.dropNotAllowed; + if(this.dropStatus != cssClass){ + this.el.replaceCls(this.dropStatus, cssClass); + this.dropStatus = cssClass; + } + }, + + /** + * Resets the status indicator to the default dropNotAllowed value + * @param {Boolean} clearGhost True to also remove all content from the ghost, false to preserve it + */ + reset : function(clearGhost){ + this.el.dom.className = Ext.baseCSSPrefix + 'dd-drag-proxy ' + this.dropNotAllowed; + this.dropStatus = this.dropNotAllowed; + if(clearGhost){ + this.ghost.update(""); + } + }, + + /** + * Updates the contents of the ghost element + * @param {String/HTMLElement} html The html that will replace the current innerHTML of the ghost element, or a + * DOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first). + */ + update : function(html){ + if(typeof html == "string"){ + this.ghost.update(html); + }else{ + this.ghost.update(""); + html.style.margin = "0"; + this.ghost.dom.appendChild(html); + } + var el = this.ghost.dom.firstChild; + if(el){ + Ext.fly(el).setStyle('float', 'none'); + } + }, + + /** + * Returns the underlying proxy {@link Ext.Layer} + * @return {Ext.Layer} el + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the ghost element + * @return {Ext.core.Element} el + */ + getGhost : function(){ + return this.ghost; + }, + + /** + * Hides the proxy + * @param {Boolean} clear True to reset the status and clear the ghost contents, false to preserve them + */ + hide : function(clear) { + this.proxy.hide(); + if (clear) { + this.reset(true); + } + }, + + /** + * Stops the repair animation if it's currently running + */ + stop : function(){ + if(this.anim && this.anim.isAnimated && this.anim.isAnimated()){ + this.anim.stop(); + } + }, + + /** + * Displays this proxy + */ + show : function() { + this.proxy.show(); + this.proxy.toFront(); + }, + + /** + * Force the Layer to sync its shadow and shim positions to the element + */ + sync : function(){ + this.proxy.el.sync(); + }, + + /** + * Causes the proxy to return to its position of origin via an animation. Should be called after an + * invalid drop operation by the item being dragged. + * @param {Array} xy The XY position of the element ([x, y]) + * @param {Function} callback The function to call after the repair is complete. + * @param {Object} scope The scope (this reference) in which the callback function is executed. Defaults to the browser window. + */ + repair : function(xy, callback, scope){ + this.callback = callback; + this.scope = scope; + if (xy && this.animRepair !== false) { + this.el.addCls(Ext.baseCSSPrefix + 'dd-drag-repair'); + this.el.hideUnders(true); + this.anim = this.el.animate({ + duration: this.repairDuration || 500, + easing: 'ease-out', + to: { + x: xy[0], + y: xy[1] + }, + stopAnimation: true, + callback: this.afterRepair, + scope: this + }); + } else { + this.afterRepair(); + } + }, + + // private + afterRepair : function(){ + this.hide(true); + if(typeof this.callback == "function"){ + this.callback.call(this.scope || this); + } + this.callback = null; + this.scope = null; + }, + + destroy: function(){ + Ext.destroy(this.ghost, this.proxy, this.el); + } +}); +/** + * @class Ext.panel.Proxy + * @extends Object + * A custom drag proxy implementation specific to {@link Ext.panel.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.Panel} to proxy for + * @param config Configuration options + */ +Ext.define('Ext.panel.Proxy', { + + alternateClassName: 'Ext.dd.PanelProxy', + + constructor: function(panel, config){ + /** + * @property panel + * @type Ext.panel.Panel + */ + this.panel = panel; + this.id = this.panel.id +'-ddproxy'; + Ext.apply(this, config); + }, + + /** + * @cfg {Boolean} insertProxy True to insert a placeholder proxy element + * while dragging the panel, false to drag with no proxy (defaults to true). + * Most Panels are not absolute positioned and therefore we need to reserve + * this space. + */ + 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 + */ + getEl: function(){ + return this.ghost.el; + }, + + /** + * Gets the proxy's ghost Panel + * @return {Panel} The proxy's ghost Panel + */ + getGhost: function(){ + return this.ghost; + }, + + /** + * Gets the proxy element. This is the element that represents where the + * Panel was before we started the drag operation. + * @return {Element} The proxy's element + */ + getProxy: function(){ + return this.proxy; + }, + + /** + * Hides the proxy + */ + hide : function(){ + if (this.ghost) { + if (this.proxy) { + this.proxy.remove(); + delete this.proxy; + } + + // Unghost the Panel, do not move the Panel to where the ghost was + this.panel.unghost(null, false); + delete this.ghost; + } + }, + + /** + * Shows the proxy + */ + show: function(){ + if (!this.ghost) { + var panelSize = this.panel.getSize(); + this.panel.el.setVisibilityMode(Ext.core.Element.DISPLAY); + this.ghost = this.panel.ghost(); + if (this.insertProxy) { + // bc Panels aren't absolute positioned we need to take up the space + // of where the panel previously was + this.proxy = this.panel.el.insertSibling({cls: Ext.baseCSSPrefix + 'panel-dd-spacer'}); + this.proxy.setSize(panelSize); + } + } + }, + + // private + repair: function(xy, callback, scope) { + this.hide(); + if (typeof callback == "function") { + callback.call(scope || this); + } + }, + + /** + * 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) + */ + moveProxy : function(parentNode, before){ + if (this.proxy) { + parentNode.insertBefore(this.proxy.dom, before); + } + } +}); +/** + * @class Ext.layout.component.AbstractDock + * @extends Ext.layout.component.Component + * @private + * This ComponentLayout handles docking for Panels. It takes care of panels that are + * part of a ContainerLayout that sets this Panel's size and Panels that are part of + * an AutoContainerLayout in which this panel get his height based of the CSS or + * or its content. + */ + +Ext.define('Ext.layout.component.AbstractDock', { + + /* Begin Definitions */ + + extend: 'Ext.layout.component.Component', + + /* End Definitions */ + + type: 'dock', + + /** + * @private + * @property autoSizing + * @type boolean + * This flag is set to indicate this layout may have an autoHeight/autoWidth. + */ + autoSizing: true, + + beforeLayout: function() { + var returnValue = this.callParent(arguments); + if (returnValue !== false && (!this.initializedBorders || this.childrenChanged) && (!this.owner.border || this.owner.manageBodyBorders)) { + this.handleItemBorders(); + this.initializedBorders = true; + } + return returnValue; + }, + + handleItemBorders: function() { + var owner = this.owner, + body = owner.body, + docked = this.getLayoutItems(), + borders = { + top: [], + right: [], + bottom: [], + left: [] + }, + oldBorders = this.borders, + opposites = { + top: 'bottom', + right: 'left', + bottom: 'top', + left: 'right' + }, + i, ln, item, dock, side; + + for (i = 0, ln = docked.length; i < ln; i++) { + item = docked[i]; + dock = item.dock; + + if (item.ignoreBorderManagement) { + continue; + } + + if (!borders[dock].satisfied) { + borders[dock].push(item); + borders[dock].satisfied = true; + } + + if (!borders.top.satisfied && opposites[dock] !== 'top') { + borders.top.push(item); + } + if (!borders.right.satisfied && opposites[dock] !== 'right') { + borders.right.push(item); + } + if (!borders.bottom.satisfied && opposites[dock] !== 'bottom') { + borders.bottom.push(item); + } + if (!borders.left.satisfied && opposites[dock] !== 'left') { + borders.left.push(item); + } + } + + if (oldBorders) { + for (side in oldBorders) { + if (oldBorders.hasOwnProperty(side)) { + ln = oldBorders[side].length; + if (!owner.manageBodyBorders) { + for (i = 0; i < ln; i++) { + oldBorders[side][i].removeCls(Ext.baseCSSPrefix + 'docked-noborder-' + side); + } + if (!oldBorders[side].satisfied && !owner.bodyBorder) { + body.removeCls(Ext.baseCSSPrefix + 'docked-noborder-' + side); + } + } + else if (oldBorders[side].satisfied) { + body.setStyle('border-' + side + '-width', ''); + } + } + } + } + + for (side in borders) { + if (borders.hasOwnProperty(side)) { + ln = borders[side].length; + if (!owner.manageBodyBorders) { + for (i = 0; i < ln; i++) { + borders[side][i].addCls(Ext.baseCSSPrefix + 'docked-noborder-' + side); + } + if ((!borders[side].satisfied && !owner.bodyBorder) || owner.bodyBorder === false) { + body.addCls(Ext.baseCSSPrefix + 'docked-noborder-' + side); + } + } + else if (borders[side].satisfied) { + body.setStyle('border-' + side + '-width', '1px'); + } + } + } + + this.borders = borders; + }, + + /** + * @protected + * @param {Ext.Component} owner The Panel that owns this DockLayout + * @param {Ext.core.Element} target The target in which we are going to render the docked items + * @param {Array} args The arguments passed to the ComponentLayout.layout method + */ + onLayout: function(width, height) { + var me = this, + owner = me.owner, + body = owner.body, + layout = owner.layout, + target = me.getTarget(), + autoWidth = false, + autoHeight = false, + padding, border, frameSize; + + // We start of by resetting all the layouts info + var info = me.info = { + boxes: [], + size: { + width: width, + height: height + }, + bodyBox: {} + }; + + Ext.applyIf(info, me.getTargetInfo()); + + // We need to bind to the ownerCt whenever we do not have a user set height or width. + if (owner && owner.ownerCt && owner.ownerCt.layout && owner.ownerCt.layout.isLayout) { + if (!Ext.isNumber(owner.height) || !Ext.isNumber(owner.width)) { + owner.ownerCt.layout.bindToOwnerCtComponent = true; + } + else { + owner.ownerCt.layout.bindToOwnerCtComponent = false; + } + } + + // Determine if we have an autoHeight or autoWidth. + if (height === undefined || height === null || width === undefined || width === null) { + padding = info.padding; + border = info.border; + frameSize = me.frameSize; + + // Auto-everything, clear out any style height/width and read from css + if ((height === undefined || height === null) && (width === undefined || width === null)) { + autoHeight = true; + autoWidth = true; + me.setTargetSize(null); + me.setBodyBox({width: null, height: null}); + } + // Auto-height + else if (height === undefined || height === null) { + autoHeight = true; + // Clear any sizing that we already set in a previous layout + me.setTargetSize(width); + me.setBodyBox({width: width - padding.left - border.left - padding.right - border.right - frameSize.left - frameSize.right, height: null}); + // Auto-width + } + else { + autoWidth = true; + // Clear any sizing that we already set in a previous layout + me.setTargetSize(null, height); + me.setBodyBox({width: null, height: height - padding.top - padding.bottom - border.top - border.bottom - frameSize.top - frameSize.bottom}); + } + + // Run the container + if (layout && layout.isLayout) { + // Auto-Sized so have the container layout notify the component layout. + layout.bindToOwnerCtComponent = true; + layout.layout(); + + // If this is an autosized container layout, then we must compensate for a + // body that is being autosized. We do not want to adjust the body's size + // to accommodate the dock items, but rather we will want to adjust the + // target's size. + // + // This is necessary because, particularly in a Box layout, all child items + // are set with absolute dimensions that are not flexible to the size of its + // innerCt/target. So once they are laid out, they are sized for good. By + // shrinking the body box to accommodate dock items, we're merely cutting off + // parts of the body. Not good. Instead, the target's size should expand + // to fit the dock items in. This is valid because the target container is + // suppose to be autosized to fit everything accordingly. + info.autoSizedCtLayout = layout.autoSize === true; + } + + // The dockItems method will add all the top and bottom docked items height + // to the info.panelSize height. That's why we have to call setSize after + // we dock all the items to actually set the panel's width and height. + // We have to do this because the panel body and docked items will be position + // absolute which doesn't stretch the panel. + me.dockItems(autoWidth, autoHeight); + me.setTargetSize(info.size.width, info.size.height); + } + else { + me.setTargetSize(width, height); + me.dockItems(); + } + me.callParent(arguments); + }, + + /** + * @protected + * This method will first update all the information about the docked items, + * body dimensions and position, the panel's total size. It will then + * set all these values on the docked items and panel body. + * @param {Array} items Array containing all the docked items + * @param {Boolean} autoBoxes Set this to true if the Panel is part of an + * AutoContainerLayout + */ + dockItems : function(autoWidth, autoHeight) { + this.calculateDockBoxes(autoWidth, autoHeight); + + // Both calculateAutoBoxes and calculateSizedBoxes are changing the + // information about the body, panel size, and boxes for docked items + // inside a property called info. + var info = this.info, + boxes = info.boxes, + ln = boxes.length, + dock, i; + + // We are going to loop over all the boxes that were calculated + // and set the position of each item the box belongs to. + for (i = 0; i < ln; i++) { + dock = boxes[i]; + dock.item.setPosition(dock.x, dock.y); + if ((autoWidth || autoHeight) && dock.layout && dock.layout.isLayout) { + // Auto-Sized so have the container layout notify the component layout. + dock.layout.bindToOwnerCtComponent = true; + } + } + + // Don't adjust body width/height if the target is using an auto container layout. + // But, we do want to adjust the body size if the container layout is auto sized. + if (!info.autoSizedCtLayout) { + if (autoWidth) { + info.bodyBox.width = null; + } + if (autoHeight) { + info.bodyBox.height = null; + } + } + + // If the bodyBox has been adjusted because of the docked items + // we will update the dimensions and position of the panel's body. + this.setBodyBox(info.bodyBox); + }, + + /** + * @protected + * This method will set up some initial information about the panel size and bodybox + * and then loop over all the items you pass it to take care of stretching, aligning, + * dock position and all calculations involved with adjusting the body box. + * @param {Array} items Array containing all the docked items we have to layout + */ + calculateDockBoxes : function(autoWidth, autoHeight) { + // We want to use the Panel's el width, and the Panel's body height as the initial + // size we are going to use in calculateDockBoxes. We also want to account for + // the border of the panel. + var me = this, + target = me.getTarget(), + items = me.getLayoutItems(), + owner = me.owner, + bodyEl = owner.body, + info = me.info, + size = info.size, + ln = items.length, + padding = info.padding, + border = info.border, + frameSize = me.frameSize, + item, i, box, rect; + + // If this Panel is inside an AutoContainerLayout, we will base all the calculations + // around the height of the body and the width of the panel. + if (autoHeight) { + size.height = bodyEl.getHeight() + padding.top + border.top + padding.bottom + border.bottom + frameSize.top + frameSize.bottom; + } + else { + size.height = target.getHeight(); + } + if (autoWidth) { + size.width = bodyEl.getWidth() + padding.left + border.left + padding.right + border.right + frameSize.left + frameSize.right; + } + else { + size.width = target.getWidth(); + } + + info.bodyBox = { + x: padding.left + frameSize.left, + y: padding.top + frameSize.top, + width: size.width - padding.left - border.left - padding.right - border.right - frameSize.left - frameSize.right, + height: size.height - border.top - padding.top - border.bottom - padding.bottom - frameSize.top - frameSize.bottom + }; + + // Loop over all the docked items + for (i = 0; i < ln; i++) { + item = items[i]; + // The initBox method will take care of stretching and alignment + // In some cases it will also layout the dock items to be able to + // get a width or height measurement + box = me.initBox(item); + + if (autoHeight === true) { + box = me.adjustAutoBox(box, i); + } + else { + box = me.adjustSizedBox(box, i); + } + + // Save our box. This allows us to loop over all docked items and do all + // calculations first. Then in one loop we will actually size and position + // all the docked items that have changed. + info.boxes.push(box); + } + }, + + /** + * @protected + * This method will adjust the position of the docked item and adjust the body box + * accordingly. + * @param {Object} box The box containing information about the width and height + * of this docked item + * @param {Number} index The index position of this docked item + * @return {Object} The adjusted box + */ + adjustSizedBox : function(box, index) { + var bodyBox = this.info.bodyBox, + frameSize = this.frameSize, + info = this.info, + padding = info.padding, + pos = box.type, + border = info.border; + + switch (pos) { + case 'top': + box.y = bodyBox.y; + break; + + case 'left': + box.x = bodyBox.x; + break; + + case 'bottom': + box.y = (bodyBox.y + bodyBox.height) - box.height; + break; + + case 'right': + box.x = (bodyBox.x + bodyBox.width) - box.width; + break; + } + + if (box.ignoreFrame) { + if (pos == 'bottom') { + box.y += (frameSize.bottom + padding.bottom + border.bottom); + } + else { + box.y -= (frameSize.top + padding.top + border.top); + } + if (pos == 'right') { + box.x += (frameSize.right + padding.right + border.right); + } + else { + box.x -= (frameSize.left + padding.left + border.left); + } + } + + // If this is not an overlaying docked item, we have to adjust the body box + if (!box.overlay) { + switch (pos) { + case 'top': + bodyBox.y += box.height; + bodyBox.height -= box.height; + break; + + case 'left': + bodyBox.x += box.width; + bodyBox.width -= box.width; + break; + + case 'bottom': + bodyBox.height -= box.height; + break; + + case 'right': + bodyBox.width -= box.width; + break; + } + } + return box; + }, + + /** + * @protected + * This method will adjust the position of the docked item inside an AutoContainerLayout + * and adjust the body box accordingly. + * @param {Object} box The box containing information about the width and height + * of this docked item + * @param {Number} index The index position of this docked item + * @return {Object} The adjusted box + */ + adjustAutoBox : function (box, index) { + var info = this.info, + bodyBox = info.bodyBox, + size = info.size, + boxes = info.boxes, + boxesLn = boxes.length, + pos = box.type, + frameSize = this.frameSize, + padding = info.padding, + border = info.border, + autoSizedCtLayout = info.autoSizedCtLayout, + ln = (boxesLn < index) ? boxesLn : index, + i, adjustBox; + + if (pos == 'top' || pos == 'bottom') { + // This can affect the previously set left and right and bottom docked items + for (i = 0; i < ln; i++) { + adjustBox = boxes[i]; + if (adjustBox.stretched && adjustBox.type == 'left' || adjustBox.type == 'right') { + adjustBox.height += box.height; + } + else if (adjustBox.type == 'bottom') { + adjustBox.y += box.height; + } + } + } + + switch (pos) { + case 'top': + box.y = bodyBox.y; + if (!box.overlay) { + bodyBox.y += box.height; + } + size.height += box.height; + break; + + case 'bottom': + box.y = (bodyBox.y + bodyBox.height); + size.height += box.height; + break; + + case 'left': + box.x = bodyBox.x; + if (!box.overlay) { + bodyBox.x += box.width; + if (autoSizedCtLayout) { + size.width += box.width; + } else { + bodyBox.width -= box.width; + } + } + break; + + case 'right': + if (!box.overlay) { + if (autoSizedCtLayout) { + size.width += box.width; + } else { + bodyBox.width -= box.width; + } + } + box.x = (bodyBox.x + bodyBox.width); + break; + } + + if (box.ignoreFrame) { + if (pos == 'bottom') { + box.y += (frameSize.bottom + padding.bottom + border.bottom); + } + else { + box.y -= (frameSize.top + padding.top + border.top); + } + if (pos == 'right') { + box.x += (frameSize.right + padding.right + border.right); + } + else { + box.x -= (frameSize.left + padding.left + border.left); + } + } + return box; + }, + + /** + * @protected + * This method will create a box object, with a reference to the item, the type of dock + * (top, left, bottom, right). It will also take care of stretching and aligning of the + * docked items. + * @param {Ext.Component} item The docked item we want to initialize the box for + * @return {Object} The initial box containing width and height and other useful information + */ + initBox : function(item) { + var me = this, + bodyBox = me.info.bodyBox, + horizontal = (item.dock == 'top' || item.dock == 'bottom'), + owner = me.owner, + frameSize = me.frameSize, + info = me.info, + padding = info.padding, + border = info.border, + box = { + item: item, + overlay: item.overlay, + type: item.dock, + offsets: Ext.core.Element.parseBox(item.offsets || {}), + ignoreFrame: item.ignoreParentFrame + }; + // First we are going to take care of stretch and align properties for all four dock scenarios. + if (item.stretch !== false) { + box.stretched = true; + if (horizontal) { + box.x = bodyBox.x + box.offsets.left; + box.width = bodyBox.width - (box.offsets.left + box.offsets.right); + if (box.ignoreFrame) { + box.width += (frameSize.left + frameSize.right + border.left + border.right + padding.left + padding.right); + } + item.setCalculatedSize(box.width - item.el.getMargin('lr'), undefined, owner); + } + else { + box.y = bodyBox.y + box.offsets.top; + box.height = bodyBox.height - (box.offsets.bottom + box.offsets.top); + if (box.ignoreFrame) { + box.height += (frameSize.top + frameSize.bottom + border.top + border.bottom + padding.top + padding.bottom); + } + item.setCalculatedSize(undefined, box.height - item.el.getMargin('tb'), owner); + + // At this point IE will report the left/right-docked toolbar as having a width equal to the + // container's full width. Forcing a repaint kicks it into shape so it reports the correct width. + if (!Ext.supports.ComputedStyle) { + item.el.repaint(); + } + } + } + else { + item.doComponentLayout(); + box.width = item.getWidth() - (box.offsets.left + box.offsets.right); + box.height = item.getHeight() - (box.offsets.bottom + box.offsets.top); + box.y += box.offsets.top; + if (horizontal) { + box.x = (item.align == 'right') ? bodyBox.width - box.width : bodyBox.x; + box.x += box.offsets.left; + } + } + + // If we haven't calculated the width or height of the docked item yet + // do so, since we need this for our upcoming calculations + if (box.width == undefined) { + box.width = item.getWidth() + item.el.getMargin('lr'); + } + if (box.height == undefined) { + box.height = item.getHeight() + item.el.getMargin('tb'); + } + + return box; + }, + + /** + * @protected + * Returns an array containing all the visible docked items inside this layout's owner Panel + * @return {Array} An array containing all the visible docked items of the Panel + */ + getLayoutItems : function() { + var it = this.owner.getDockedItems(), + ln = it.length, + i = 0, + result = []; + for (; i < ln; i++) { + if (it[i].isVisible(true)) { + result.push(it[i]); + } + } + return result; + }, + + /** + * @protected + * Render the top and left docked items before any existing DOM nodes in our render target, + * and then render the right and bottom docked items after. This is important, for such things + * as tab stops and ARIA readers, that the DOM nodes are in a meaningful order. + * Our collection of docked items will already be ordered via Panel.getDockedItems(). + */ + renderItems: function(items, target) { + var cns = target.dom.childNodes, + cnsLn = cns.length, + ln = items.length, + domLn = 0, + i, j, cn, item; + + // Calculate the number of DOM nodes in our target that are not our docked items + for (i = 0; i < cnsLn; i++) { + cn = Ext.get(cns[i]); + for (j = 0; j < ln; j++) { + item = items[j]; + if (item.rendered && (cn.id == item.el.id || cn.down('#' + item.el.id))) { + break; + } + } + + if (j === ln) { + domLn++; + } + } + + // Now we go through our docked items and render/move them + for (i = 0, j = 0; i < ln; i++, j++) { + item = items[i]; + + // If we're now at the right/bottom docked item, we jump ahead in our + // DOM position, just past the existing DOM nodes. + // + // TODO: This is affected if users provide custom weight values to their + // docked items, which puts it out of (t,l,r,b) order. Avoiding a second + // sort operation here, for now, in the name of performance. getDockedItems() + // needs the sort operation not just for this layout-time rendering, but + // also for getRefItems() to return a logical ordering (FocusManager, CQ, et al). + if (i === j && (item.dock === 'right' || item.dock === 'bottom')) { + j += domLn; + } + + // Same logic as Layout.renderItems() + if (item && !item.rendered) { + this.renderItem(item, target, j); + } + else if (!this.isValidParent(item, target, j)) { + this.moveItem(item, target, j); + } + } + }, + + /** + * @protected + * This function will be called by the dockItems method. Since the body is positioned absolute, + * we need to give it dimensions and a position so that it is in the middle surrounded by + * docked items + * @param {Object} box An object containing new x, y, width and height values for the + * Panel's body + */ + setBodyBox : function(box) { + var me = this, + owner = me.owner, + body = owner.body, + info = me.info, + bodyMargin = info.bodyMargin, + padding = info.padding, + border = info.border, + frameSize = me.frameSize; + + // Panel collapse effectively hides the Panel's body, so this is a no-op. + if (owner.collapsed) { + return; + } + + if (Ext.isNumber(box.width)) { + box.width -= bodyMargin.left + bodyMargin.right; + } + + if (Ext.isNumber(box.height)) { + box.height -= bodyMargin.top + bodyMargin.bottom; + } + + me.setElementSize(body, box.width, box.height); + if (Ext.isNumber(box.x)) { + body.setLeft(box.x - padding.left - frameSize.left); + } + if (Ext.isNumber(box.y)) { + body.setTop(box.y - padding.top - frameSize.top); + } + }, + + /** + * @protected + * We are overriding the Ext.layout.Layout configureItem method to also add a class that + * indicates the position of the docked item. We use the itemCls (x-docked) as a prefix. + * An example of a class added to a dock: right item is x-docked-right + * @param {Ext.Component} item The item we are configuring + */ + configureItem : function(item, pos) { + this.callParent(arguments); + + item.addCls(Ext.baseCSSPrefix + 'docked'); + item.addClsWithUI('docked-' + item.dock); + }, + + afterRemove : function(item) { + this.callParent(arguments); + if (this.itemCls) { + item.el.removeCls(this.itemCls + '-' + item.dock); + } + var dom = item.el.dom; + + if (!item.destroying && dom) { + dom.parentNode.removeChild(dom); + } + this.childrenChanged = true; + } +}); +/** + * @class Ext.app.EventBus + * @private + * + * Class documentation for the MVC classes will be present before 4.0 final, in the mean time please refer to the MVC + * guide + */ +Ext.define('Ext.app.EventBus', { + requires: [ + 'Ext.util.Event' + ], + mixins: { + observable: 'Ext.util.Observable' + }, + + constructor: function() { + this.mixins.observable.constructor.call(this); + + this.bus = {}; + + var me = this; + Ext.override(Ext.Component, { + fireEvent: function(ev) { + if (Ext.util.Observable.prototype.fireEvent.apply(this, arguments) !== false) { + return me.dispatch.call(me, ev, this, arguments); + } + return false; + } + }); + }, + + dispatch: function(ev, target, args) { + var bus = this.bus, + selectors = bus[ev], + selector, controllers, id, events, event, i, ln; + + if (selectors) { + // Loop over all the selectors that are bound to this event + for (selector in selectors) { + // Check if the target matches the selector + if (target.is(selector)) { + // Loop over all the controllers that are bound to this selector + controllers = selectors[selector]; + for (id in controllers) { + // Loop over all the events that are bound to this selector on this controller + events = controllers[id]; + for (i = 0, ln = events.length; i < ln; i++) { + event = events[i]; + // Fire the event! + return event.fire.apply(event, Array.prototype.slice.call(args, 1)); + } + } + } + } + } + }, + + control: function(selectors, listeners, controller) { + var bus = this.bus, + selector, fn; + + if (Ext.isString(selectors)) { + selector = selectors; + selectors = {}; + selectors[selector] = listeners; + this.control(selectors, null, controller); + return; + } + + Ext.Object.each(selectors, function(selector, listeners) { + Ext.Object.each(listeners, function(ev, listener) { + var options = {}, + scope = controller, + event = Ext.create('Ext.util.Event', controller, ev); + + // Normalize the listener + if (Ext.isObject(listener)) { + options = listener; + listener = options.fn; + scope = options.scope || controller; + delete options.fn; + delete options.scope; + } + + event.addListener(listener, scope, options); + + // Create the bus tree if it is not there yet + bus[ev] = bus[ev] || {}; + bus[ev][selector] = bus[ev][selector] || {}; + bus[ev][selector][controller.id] = bus[ev][selector][controller.id] || []; + + // Push our listener in our bus + bus[ev][selector][controller.id].push(event); + }); + }); + } +}); +/** + * @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 : Function
A function to convert raw data values from a data block into the data + * to be stored in the Field. The function is passed the collowing parameters: + *
+ *
v : Mixed
The data value as read by the Reader, if undefined will use + * the configured {@link Ext.data.Field#defaultValue defaultValue}.
+ *
rec : Mixed
The data object containing the row as read by the Reader. + * Depending on the Reader type, this could be an Array ({@link Ext.data.reader.Array ArrayReader}), an object + * ({@link Ext.data.reader.Json JsonReader}), or an XML element.
+ *
+ *
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 Model, use
+var types = Ext.data.Types; // allow shorthand type access +Ext.define('Unit', + extend: 'Ext.data.Model', + fields: [ + { 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.define('Ext.data.Types', { + singleton: true, + requires: ['Ext.data.SortTypes'] +}, function() { + var st = Ext.data.SortTypes; + + Ext.apply(Ext.data.Types, { + /** + * @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) { + var defaultValue = this.useNull ? null : ''; + return (v === undefined || v === null) ? defaultValue : String(v); + }, + sortType: st.asUCString, + type: 'string' + }, + + /** + * @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) : (this.useNull ? null : 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) : (this.useNull ? null : 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) { + if (this.useNull && v === undefined || v === null || v === '') { + return null; + } + 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 Ext.Date.parse(v, df); + } + + var parsed = Date.parse(v); + return parsed ? new Date(parsed) : null; + }, + sortType: st.asDate, + type: 'date' + } + }); + + Ext.apply(Ext.data.Types, { + /** + * @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 + }); +}); + +/** + * @author Ed Spencer + * @class Ext.data.Field + * @extends Object + * + *
Fields are used to define what a Model is. They aren't instantiated directly - instead, when we create a class + * that extends {@link Ext.data.Model}, it will automatically create a Field instance for each field configured in a + * {@link Ext.data.Model Model}. For example, we might set up a model like this:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + 'name', 'email', + {name: 'age', type: 'int'}, + {name: 'gender', type: 'string', defaultValue: 'Unknown'} + ] +}); +
+ * + *
Four fields will have been created for the User Model - name, email, age and gender. Note that we specified a + * couple of different formats here; if we only pass in the string name of the field (as with name and email), the + * field is set up with the 'auto' type. It's as if we'd done this instead:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + {name: 'name', type: 'auto'}, + {name: 'email', type: 'auto'}, + {name: 'age', type: 'int'}, + {name: 'gender', type: 'string', defaultValue: 'Unknown'} + ] +}); +
+ * + *
Types and conversion
+ * + *
The {@link #type} is important - it's used to automatically convert data passed to the field into the correct + * format. In our example above, the name and email fields used the 'auto' type and will just accept anything that is + * passed into them. The 'age' field had an 'int' type however, so if we passed 25.4 this would be rounded to 25.
+ * + *
Sometimes a simple type isn't enough, or we want to perform some processing when we load a Field's data. We can + * do this using a {@link #convert} function. Here, we're going to create a new field based on another:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + 'name', 'email', + {name: 'age', type: 'int'}, + {name: 'gender', type: 'string', defaultValue: 'Unknown'}, + + { + name: 'firstName', + convert: function(value, record) { + var fullName = record.get('name'), + splits = fullName.split(" "), + firstName = splits[0]; + + return firstName; + } + } + ] +}); +
+ * + *
Now when we create a new User, the firstName is populated automatically based on the name:
+ * +
+var ed = Ext.ModelManager.create({name: 'Ed Spencer'}, 'User'); + +console.log(ed.get('firstName')); //logs 'Ed', based on our convert function +
+ * + *
In fact, if we log out all of the data inside ed, we'll see this:
+ * +
+console.log(ed.data); + +//outputs this: +{ + age: 0, + email: "", + firstName: "Ed", + gender: "Unknown", + name: "Ed Spencer" +} +
+ * + *
The age field has been given a default of zero because we made it an int type. As an auto field, email has + * defaulted to an empty string. When we registered the User model we set gender's {@link #defaultValue} to 'Unknown' + * so we see that now. Let's correct that and satisfy ourselves that the types work as we expect:
+ * +
+ed.set('gender', 'Male'); +ed.get('gender'); //returns 'Male' + +ed.set('age', 25.4); +ed.get('age'); //returns 25 - we wanted an int, not a float, so no decimal places allowed +
+ * + */ +Ext.define('Ext.data.Field', { + requires: ['Ext.data.Types', 'Ext.data.SortTypes'], + alias: 'data.field', + + constructor : function(config) { + if (Ext.isString(config)) { + config = {name: config}; + } + Ext.apply(this, config); + + var types = Ext.data.Types, + st = this.sortType, + t; + + if (this.type) { + if (Ext.isString(this.type)) { + this.type = types[this.type.toUpperCase()] || types.AUTO; + } + } else { + this.type = types.AUTO; + } + + // named sortTypes are supported, here we look them up + if (Ext.isString(st)) { + this.sortType = Ext.data.SortTypes[st]; + } else if(Ext.isEmpty(st)) { + this.sortType = this.type.sortType; + } + + if (!this.convert) { + this.convert = this.type.convert; + } + }, + + /** + * @cfg {String} name + * The name by which the field is referenced within the Model. This is referenced by, for example, + * the dataIndex property in column definition objects passed to {@link Ext.grid.property.HeaderContainer}. + *
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.
+ */ + + /** + * @cfg {Mixed} type + * (Optional) The data type for automatic conversion from received data to the stored value if {@link Ext.data.Field#convert convert} + * has not been specified. This may be specified as a string value. Possible values are + *
+ *
auto (Default, implies no conversion)
+ *
string
+ *
int
+ *
float
+ *
boolean
+ *
date
+ *
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 {Function} convert + * (Optional) A function which converts the value provided by the Reader into an object that will be stored + * in the Model. It is passed the following parameters:
+ *
v : Mixed
The data value as read by the Reader, if undefined will use + * the configured {@link Ext.data.Field#defaultValue defaultValue}.
+ *
rec : Ext.data.Model
The data object containing the Model as read so far by the + * Reader. Note that the Model may not be fully populated at this point as the fields are read in the order that + * they are defined in your {@link #fields} array.
+ *
+ *
+// 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); +} + +Ext.define('Dude', { + extend: 'Ext.data.Model', + fields: [ + {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: { + type: 'json', + model: 'Dude', + idProperty: 'key', + root: 'daRoot', + totalProperty: 'total' + } +}); + +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 Ext.Date#parse Ext.Date.parse} 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 {Boolean} useNull + *
(Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed, + * null will be used if useNull is true, otherwise the value will be 0. Defaults to false + */ + useNull: false, + + /** + * @cfg {Mixed} defaultValue + * (Optional) The default value used when a Model is being created by a {@link Ext.data.reader.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.reader.Reader} implementation + * that is creating the {@link Ext.data.Model Model} 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.
+ *
+ *
{@link Ext.data.reader.Json}
The mapping is a string containing the javascript + * expression to reference the data from an element of the data item's {@link Ext.data.reader.Json#root root} Array. Defaults to the field name.
+ *
{@link Ext.data.reader.Xml}
The mapping is an {@link Ext.DomQuery} path to the data + * item relative to the DOM element that represents the {@link Ext.data.reader.Xml#record record}. Defaults to the field name.
+ *
{@link Ext.data.reader.Array}
The mapping is a number indicating the Array index + * of the field's value. Defaults to the field specification's Array position.
+ *
+ *
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.
+ */ + 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 | +// +-+------+ +-+------+ + +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 + * @private + * (Optional) Used for validating a {@link Ext.data.Model model}, defaults to true. + * An empty value here will cause {@link Ext.data.Model}.{@link Ext.data.Model#isValid isValid} + * to evaluate to false. + */ + allowBlank : true, + + /** + * @cfg {Boolean} persist + * False to exclude this field from the {@link Ext.data.Model#modified} fields in a model. This + * will also exclude the field from being written using a {@link Ext.data.writer.Writer}. This option + * is useful when model fields are used to keep state on the client but do not need to be persisted + * to the server. Defaults to true. + */ + persist: true +}); + +/** + * @author Ed Spencer + * @class Ext.data.reader.Reader + * @extends Object + * + *
Readers are used to interpret data to be loaded into a {@link Ext.data.Model Model} instance or a {@link Ext.data.Store Store} + * - usually in response to an AJAX request. This is normally handled transparently by passing some configuration to either the + * {@link Ext.data.Model Model} or the {@link Ext.data.Store Store} in question - see their documentation for further details.
+ * + *
Loading Nested Data
+ * + *
Readers have the ability to automatically load deeply-nested data objects based on the {@link Ext.data.Association associations} + * configured on each Model. Below is an example demonstrating the flexibility of these associations in a fictional CRM system which + * manages a User, their Orders, OrderItems and Products. First we'll define the models: + * +
+Ext.define("User", { + extend: 'Ext.data.Model', + fields: [ + 'id', 'name' + ], + + hasMany: {model: 'Order', name: 'orders'}, + + proxy: { + type: 'rest', + url : 'users.json', + reader: { + type: 'json', + root: 'users' + } + } +}); + +Ext.define("Order", { + extend: 'Ext.data.Model', + fields: [ + 'id', 'total' + ], + + hasMany : {model: 'OrderItem', name: 'orderItems', associationKey: 'order_items'}, + belongsTo: 'User' +}); + +Ext.define("OrderItem", { + extend: 'Ext.data.Model', + fields: [ + 'id', 'price', 'quantity', 'order_id', 'product_id' + ], + + belongsTo: ['Order', {model: 'Product', associationKey: 'product'}] +}); + +Ext.define("Product", { + extend: 'Ext.data.Model', + fields: [ + 'id', 'name' + ], + + hasMany: 'OrderItem' +}); +
+ * + *
This may be a lot to take in - basically a User has many Orders, each of which is composed of several OrderItems. Finally, + * each OrderItem has a single Product. This allows us to consume data like this:
+ * +
+{ + "users": [ + { + "id": 123, + "name": "Ed", + "orders": [ + { + "id": 50, + "total": 100, + "order_items": [ + { + "id" : 20, + "price" : 40, + "quantity": 2, + "product" : { + "id": 1000, + "name": "MacBook Pro" + } + }, + { + "id" : 21, + "price" : 20, + "quantity": 3, + "product" : { + "id": 1001, + "name": "iPhone" + } + } + ] + } + ] + } + ] +} +
+ * + *
The JSON response is deeply nested - it returns all Users (in this case just 1 for simplicity's sake), all of the Orders + * for each User (again just 1 in this case), all of the OrderItems for each Order (2 order items in this case), and finally + * the Product associated with each OrderItem. Now we can read the data and use it as follows: + * +
+var store = new Ext.data.Store({ + model: "User" +}); + +store.load({ + callback: function() { + //the user that was loaded + var user = store.first(); + + console.log("Orders for " + user.get('name') + ":") + + //iterate over the Orders for each User + user.orders().each(function(order) { + console.log("Order ID: " + order.getId() + ", which contains items:"); + + //iterate over the OrderItems for each Order + order.orderItems().each(function(orderItem) { + //we know that the Product data is already loaded, so we can use the synchronous getProduct + //usually, we would use the asynchronous version (see {@link Ext.data.BelongsToAssociation}) + var product = orderItem.getProduct(); + + console.log(orderItem.get('quantity') + ' orders of ' + product.get('name')); + }); + }); + } +}); +
+ * + *
Running the code above results in the following:
+ * +
+Orders for Ed: +Order ID: 50, which contains items: +2 orders of MacBook Pro +3 orders of iPhone +
+ * + * @constructor + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.reader.Reader', { + requires: ['Ext.data.ResultSet'], + alternateClassName: ['Ext.data.Reader', 'Ext.data.DataReader'], + + /** + * @cfg {String} idProperty Name of the property within a row object + * that contains a record identifier value. Defaults to The id of the model. + * If an idProperty is explicitly specified it will override that of the one specified + * on the model + */ + + /** + * @cfg {String} totalProperty 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. + */ + totalProperty: 'total', + + /** + * @cfg {String} successProperty Name of the property from which to + * retrieve the success attribute. Defaults to success. See + * {@link Ext.data.proxy.Proxy}.{@link Ext.data.proxy.Proxy#exception exception} + * for additional information. + */ + successProperty: 'success', + + /** + * @cfg {String} root 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. + */ + root: '', + + /** + * @cfg {String} messageProperty The name of the property which contains a response message. + * This property is optional. + */ + + /** + * @cfg {Boolean} implicitIncludes True to automatically parse models nested within other models in a response + * object. See the Ext.data.reader.Reader intro docs for full explanation. Defaults to true. + */ + implicitIncludes: true, + + isReader: true, + + constructor: function(config) { + var me = this; + + Ext.apply(me, config || {}); + me.fieldCount = 0; + me.model = Ext.ModelManager.getModel(config.model); + if (me.model) { + me.buildExtractors(); + } + }, + + /** + * Sets a new model for the reader. + * @private + * @param {Object} model The model to set. + * @param {Boolean} setOnProxy True to also set on the Proxy, if one is configured + */ + setModel: function(model, setOnProxy) { + var me = this; + + me.model = Ext.ModelManager.getModel(model); + me.buildExtractors(true); + + if (setOnProxy && me.proxy) { + me.proxy.setModel(me.model, true); + } + }, + + /** + * Reads the given response object. This method normalizes the different types of response object that may be passed + * to it, before handing off the reading of records to the {@link #readRecords} function. + * @param {Object} response The response object. This may be either an XMLHttpRequest object or a plain JS object + * @return {Ext.data.ResultSet} The parsed ResultSet object + */ + read: function(response) { + var data = response; + + if (response && response.responseText) { + data = this.getResponseData(response); + } + + if (data) { + return this.readRecords(data); + } else { + return this.nullResultSet; + } + }, + + /** + * Abstracts common functionality used by all Reader subclasses. Each subclass is expected to call + * this function before running its own logic and returning the Ext.data.ResultSet instance. For most + * Readers additional processing should not be needed. + * @param {Mixed} data The raw data object + * @return {Ext.data.ResultSet} A ResultSet object + */ + readRecords: function(data) { + var me = this; + + /* + * We check here whether the number of fields has changed since the last read. + * This works around an issue when a Model is used for both a Tree and another + * source, because the tree decorates the model with extra fields and it causes + * issues because the readers aren't notified. + */ + if (me.fieldCount !== me.getFields().length) { + me.buildExtractors(true); + } + + /** + * The raw data object that was last passed to readRecords. Stored for further processing if needed + * @property rawData + * @type Mixed + */ + me.rawData = data; + + data = me.getData(data); + + // If we pass an array as the data, we dont use getRoot on the data. + // Instead the root equals to the data. + var root = Ext.isArray(data) ? data : me.getRoot(data), + success = true, + recordCount = 0, + total, value, records, message; + + if (root) { + total = root.length; + } + + if (me.totalProperty) { + value = parseInt(me.getTotal(data), 10); + if (!isNaN(value)) { + total = value; + } + } + + if (me.successProperty) { + value = me.getSuccess(data); + if (value === false || value === 'false') { + success = false; + } + } + + if (me.messageProperty) { + message = me.getMessage(data); + } + + if (root) { + records = me.extractData(root); + recordCount = records.length; + } else { + recordCount = 0; + records = []; + } + + return Ext.create('Ext.data.ResultSet', { + total : total || recordCount, + count : recordCount, + records: records, + success: success, + message: message + }); + }, + + /** + * Returns extracted, type-cast rows of data. Iterates to call #extractValues for each row + * @param {Object[]/Object} data-root from server response + * @private + */ + extractData : function(root) { + var me = this, + values = [], + records = [], + Model = me.model, + i = 0, + length = root.length, + idProp = me.getIdProperty(), + node, id, record; + + if (!root.length && Ext.isObject(root)) { + root = [root]; + length = 1; + } + + for (; i < length; i++) { + node = root[i]; + values = me.extractValues(node); + id = me.getId(node); + + + record = new Model(values, id, node); + records.push(record); + + if (me.implicitIncludes) { + me.readAssociated(record, node); + } + } + + return records; + }, + + /** + * @private + * Loads a record's associations from the data object. This prepopulates hasMany and belongsTo associations + * on the record provided. + * @param {Ext.data.Model} record The record to load associations for + * @param {Mixed} data The data object + * @return {String} Return value description + */ + readAssociated: function(record, data) { + var associations = record.associations.items, + i = 0, + length = associations.length, + association, associationData, proxy, reader; + + for (; i < length; i++) { + association = associations[i]; + associationData = this.getAssociatedDataRoot(data, association.associationKey || association.name); + + if (associationData) { + reader = association.getReader(); + if (!reader) { + proxy = association.associatedModel.proxy; + // if the associated model has a Reader already, use that, otherwise attempt to create a sensible one + if (proxy) { + reader = proxy.getReader(); + } else { + reader = new this.constructor({ + model: association.associatedName + }); + } + } + association.read(record, reader, associationData); + } + } + }, + + /** + * @private + * Used internally by {@link #readAssociated}. Given a data object (which could be json, xml etc) for a specific + * record, this should return the relevant part of that data for the given association name. This is only really + * needed to support the XML Reader, which has to do a query to get the associated data object + * @param {Mixed} data The raw data object + * @param {String} associationName The name of the association to get data for (uses associationKey if present) + * @return {Mixed} The root + */ + getAssociatedDataRoot: function(data, associationName) { + return data[associationName]; + }, + + getFields: function() { + return this.model.prototype.fields.items; + }, + + /** + * @private + * Given an object representing a single model instance's data, iterates over the model's fields and + * builds an object with the value for each field. + * @param {Object} data The data object to convert + * @return {Object} Data object suitable for use with a model constructor + */ + extractValues: function(data) { + var fields = this.getFields(), + i = 0, + length = fields.length, + output = {}, + field, value; + + for (; i < length; i++) { + field = fields[i]; + value = this.extractorFunctions[i](data); + + output[field.name] = value; + } + + return output; + }, + + /** + * @private + * By default this function just returns what is passed to it. It can be overridden in a subclass + * to return something else. See XmlReader for an example. + * @param {Object} data The data object + * @return {Object} The normalized data object + */ + getData: function(data) { + return data; + }, + + /** + * @private + * This will usually need to be implemented in a subclass. Given a generic data object (the type depends on the type + * of data we are reading), this function should return the object as configured by the Reader's 'root' meta data config. + * See XmlReader's getRoot implementation for an example. By default the same data object will simply be returned. + * @param {Mixed} data The data object + * @return {Mixed} The same data object + */ + getRoot: function(data) { + return data; + }, + + /** + * Takes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be implemented by each subclass + * @param {Object} response The responce object + * @return {Object} The useful data from the response + */ + getResponseData: function(response) { + Ext.Error.raise("getResponseData must be implemented in the Ext.data.reader.Reader subclass"); + }, + + /** + * @private + * Reconfigures the meta data tied to this Reader + */ + onMetaChange : function(meta) { + var fields = meta.fields, + newModel; + + Ext.apply(this, meta); + + if (fields) { + newModel = Ext.define("Ext.data.reader.Json-Model" + Ext.id(), { + extend: 'Ext.data.Model', + fields: fields + }); + this.setModel(newModel, true); + } else { + this.buildExtractors(true); + } + }, + + /** + * Get the idProperty to use for extracting data + * @private + * @return {String} The id property + */ + getIdProperty: function(){ + var prop = this.idProperty; + if (Ext.isEmpty(prop)) { + prop = this.model.prototype.idProperty; + } + return prop; + }, + + /** + * @private + * This builds optimized functions for retrieving record data and meta data from an object. + * Subclasses may need to implement their own getRoot function. + * @param {Boolean} force True to automatically remove existing extractor functions first (defaults to false) + */ + buildExtractors: function(force) { + var me = this, + idProp = me.getIdProperty(), + totalProp = me.totalProperty, + successProp = me.successProperty, + messageProp = me.messageProperty, + accessor; + + if (force === true) { + delete me.extractorFunctions; + } + + if (me.extractorFunctions) { + return; + } + + //build the extractors for all the meta data + if (totalProp) { + me.getTotal = me.createAccessor(totalProp); + } + + if (successProp) { + me.getSuccess = me.createAccessor(successProp); + } + + if (messageProp) { + me.getMessage = me.createAccessor(messageProp); + } + + if (idProp) { + accessor = me.createAccessor(idProp); + + me.getId = function(record) { + var id = accessor.call(me, record); + return (id === undefined || id === '') ? null : id; + }; + } else { + me.getId = function() { + return null; + }; + } + me.buildFieldExtractors(); + }, + + /** + * @private + */ + buildFieldExtractors: function() { + //now build the extractors for all the fields + var me = this, + fields = me.getFields(), + ln = fields.length, + i = 0, + extractorFunctions = [], + field, map; + + for (; i < ln; i++) { + field = fields[i]; + map = (field.mapping !== undefined && field.mapping !== null) ? field.mapping : field.name; + + extractorFunctions.push(me.createAccessor(map)); + } + me.fieldCount = ln; + + me.extractorFunctions = extractorFunctions; + } +}, function() { + Ext.apply(this, { + // Private. Empty ResultSet to return when response is falsy (null|undefined|empty string) + nullResultSet: Ext.create('Ext.data.ResultSet', { + total : 0, + count : 0, + records: [], + success: true + }) + }); +}); +/** + * @author Ed Spencer + * @class Ext.data.reader.Json + * @extends Ext.data.reader.Reader + * + *
The JSON Reader is used by a Proxy to read a server response that is sent back in JSON format. This usually + * happens as a result of loading a Store - for example we might create something like this:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id', 'name', 'email'] +}); + +var store = new Ext.data.Store({ + model: 'User', + proxy: { + type: 'ajax', + url : 'users.json', + reader: { + type: 'json' + } + } +}); +
+ * + *
The example above creates a 'User' model. Models are explained in the {@link Ext.data.Model Model} docs if you're + * not already familiar with them.
+ * + *
We created the simplest type of JSON Reader possible by simply telling our {@link Ext.data.Store Store}'s + * {@link Ext.data.proxy.Proxy Proxy} that we want a JSON Reader. The Store automatically passes the configured model to the + * Store, so it is as if we passed this instead: + * +
+reader: { + type : 'json', + model: 'User' +} +
+ * + *
The reader we set up is ready to read data from our server - at the moment it will accept a response like this:
+ * +
+[ + { + "id": 1, + "name": "Ed Spencer", + "email": "ed@sencha.com" + }, + { + "id": 2, + "name": "Abe Elias", + "email": "abe@sencha.com" + } +] +
+ * + *
Reading other JSON formats
+ * + *
If you already have your JSON format defined and it doesn't look quite like what we have above, you can usually + * pass JsonReader a couple of configuration options to make it parse your format. For example, we can use the + * {@link #root} configuration to parse data that comes back like this:
+ * +
+{ + "users": [ + { + "id": 1, + "name": "Ed Spencer", + "email": "ed@sencha.com" + }, + { + "id": 2, + "name": "Abe Elias", + "email": "abe@sencha.com" + } + ] +} +
+ * + *
To parse this we just pass in a {@link #root} configuration that matches the 'users' above:
+ * +
+reader: { + type: 'json', + root: 'users' +} +
+ * + *
Sometimes the JSON structure is even more complicated. Document databases like CouchDB often provide metadata + * around each record inside a nested structure like this:
+ * +
+{ + "total": 122, + "offset": 0, + "users": [ + { + "id": "ed-spencer-1", + "value": 1, + "user": { + "id": 1, + "name": "Ed Spencer", + "email": "ed@sencha.com" + } + } + ] +} +
+ * + *
In the case above the record data is nested an additional level inside the "users" array as each "user" item has + * additional metadata surrounding it ('id' and 'value' in this case). To parse data out of each "user" item in the + * JSON above we need to specify the {@link #record} configuration like this:
+ * +
+reader: { + type : 'json', + root : 'users', + record: 'user' +} +
+ * + *
Response metadata
+ * + *
The server can return additional data in its response, such as the {@link #totalProperty total number of records} + * and the {@link #successProperty success status of the response}. These are typically included in the JSON response + * like this:
+ * +
+{ + "total": 100, + "success": true, + "users": [ + { + "id": 1, + "name": "Ed Spencer", + "email": "ed@sencha.com" + } + ] +} +
+ * + *
If these properties are present in the JSON response they can be parsed out by the JsonReader and used by the + * Store that loaded it. We can set up the names of these properties by specifying a final pair of configuration + * options:
+ * +
+reader: { + type : 'json', + root : 'users', + totalProperty : 'total', + successProperty: 'success' +} +
+ * + *
These final options are not necessary to make the Reader work, but can be useful when the server needs to report + * an error or if it needs to indicate that there is a lot of data available of which only a subset is currently being + * returned.
+ */ +Ext.define('Ext.data.reader.Json', { + extend: 'Ext.data.reader.Reader', + alternateClassName: 'Ext.data.JsonReader', + alias : 'reader.json', + + root: '', + + /** + * @cfg {String} record The optional location within the JSON response that the record data itself can be found at. + * See the JsonReader intro docs for more details. This is not often needed and defaults to undefined. + */ + + /** + * @cfg {Boolean} useSimpleAccessors True to ensure that field names/mappings are treated as literals when + * reading values. Defalts to false. + * For example, by default, using the mapping "foo.bar.baz" will try and read a property foo from the root, then a property bar + * from foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name + * "foo.bar.baz" direct from the root object. + */ + useSimpleAccessors: false, + + /** + * Reads a JSON object and returns a ResultSet. Uses the internal getTotal and getSuccess extractors to + * retrieve meta data from the response, and extractData to turn the JSON data into model instances. + * @param {Object} data The raw JSON data + * @return {Ext.data.ResultSet} A ResultSet containing model instances and meta data about the results + */ + readRecords: function(data) { + //this has to be before the call to super because we use the meta data in the superclass readRecords + if (data.metaData) { + this.onMetaChange(data.metaData); + } + + /** + * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead + * @property jsonData + * @type Mixed + */ + this.jsonData = data; + return this.callParent([data]); + }, + + //inherit docs + getResponseData: function(response) { + try { + var data = Ext.decode(response.responseText); + } + catch (ex) { + Ext.Error.raise({ + response: response, + json: response.responseText, + parseError: ex, + msg: 'Unable to parse the JSON returned by the server: ' + ex.toString() + }); + } + if (!data) { + Ext.Error.raise('JSON object not found'); + } + + return data; + }, + + //inherit docs + buildExtractors : function() { + var me = this; + + me.callParent(arguments); + + if (me.root) { + me.getRoot = me.createAccessor(me.root); + } else { + me.getRoot = function(root) { + return root; + }; + } + }, + + /** + * @private + * We're just preparing the data for the superclass by pulling out the record objects we want. If a {@link #record} + * was specified we have to pull those out of the larger JSON object, which is most of what this function is doing + * @param {Object} root The JSON root node + * @return {Array} The records + */ + extractData: function(root) { + var recordName = this.record, + data = [], + length, i; + + if (recordName) { + length = root.length; + + for (i = 0; i < length; i++) { + data[i] = root[i][recordName]; + } + } else { + data = root; + } + return this.callParent([data]); + }, + + /** + * @private + * Returns an accessor function for the given property string. Gives support for properties such as the following: + * 'someProperty' + * 'some.property' + * 'some["property"]' + * This is used by buildExtractors to create optimized extractor functions when casting raw data into model instances. + */ + createAccessor: function() { + var re = /[\[\.]/; + + return function(expr) { + if (Ext.isEmpty(expr)) { + return Ext.emptyFn; + } + if (Ext.isFunction(expr)) { + return expr; + } + if (this.useSimpleAccessors !== true) { + var i = String(expr).search(re); + if (i >= 0) { + return Ext.functionFactory('obj', 'return obj' + (i > 0 ? '.' : '') + expr); + } + } + return function(obj) { + return obj[expr]; + }; + }; + }() +}); +/** + * @class Ext.data.writer.Json + * @extends Ext.data.writer.Writer + +This class is used to write {@link Ext.data.Model} data to the server in a JSON format. +The {@link #allowSingle} configuration can be set to false to force the records to always be +encoded in an array, even if there is only a single record being sent. + + * @markdown + */ +Ext.define('Ext.data.writer.Json', { + extend: 'Ext.data.writer.Writer', + alternateClassName: 'Ext.data.JsonWriter', + alias: 'writer.json', + + /** + * @cfg {String} root The key under which the records in this Writer will be placed. Defaults to undefined. + * Example generated request, using root: 'records': +
+{'records': [{name: 'my record'}, {name: 'another record'}]} +
+ */ + root: undefined, + + /** + * @cfg {Boolean} encode True to use Ext.encode() on the data before sending. Defaults to false. + * The encode option should only be set to true when a {@link #root} is defined, because the values will be + * sent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter + * sent to the server. + */ + encode: false, + + /** + * @cfg {Boolean} allowSingle False to ensure that records are always wrapped in an array, even if there is only + * one record being sent. When there is more than one record, they will always be encoded into an array. + * Defaults to true. Example: + *
+// with allowSingle: true +"root": { + "first": "Mark", + "last": "Corrigan" +} + +// with allowSingle: false +"root": [{ + "first": "Mark", + "last": "Corrigan" +}] + *
+ */ + allowSingle: true, + + //inherit docs + writeRecords: function(request, data) { + var root = this.root; + + if (this.allowSingle && data.length == 1) { + // convert to single object format + data = data[0]; + } + + if (this.encode) { + if (root) { + // sending as a param, need to encode + request.params[root] = Ext.encode(data); + } else { + Ext.Error.raise('Must specify a root when using encode'); + } + } else { + // send as jsonData + request.jsonData = request.jsonData || {}; + if (root) { + request.jsonData[root] = data; + } else { + request.jsonData = data; + } + } + return request; + } +}); + +/** + * @author Ed Spencer + * @class Ext.data.proxy.Proxy + * + *
Proxies are used by {@link Ext.data.Store Stores} to handle the loading and saving of {@link Ext.data.Model Model} data. + * Usually developers will not need to create or interact with proxies directly.
+ *
Types of Proxy
+ * + *
There are two main types of Proxy - {@link Ext.data.proxy.Client Client} and {@link Ext.data.proxy.Server Server}. The Client proxies + * save their data locally and include the following subclasses:
+ * + *
+ *
{@link Ext.data.proxy.LocalStorage LocalStorageProxy} - saves its data to localStorage if the browser supports it
+ *
{@link Ext.data.proxy.SessionStorage SessionStorageProxy} - saves its data to sessionStorage if the browsers supports it
+ *
{@link Ext.data.proxy.Memory MemoryProxy} - holds data in memory only, any data is lost when the page is refreshed
+ *
+ * + *
The Server proxies save their data by sending requests to some remote server. These proxies include:
+ * + *
+ *
{@link Ext.data.proxy.Ajax Ajax} - sends requests to a server on the same domain
+ *
{@link Ext.data.proxy.JsonP JsonP} - uses JSON-P to send requests to a server on a different domain
+ *
{@link Ext.data.proxy.Direct Direct} - uses {@link Ext.direct} to send requests
+ *
+ * + *
Proxies operate on the principle that all operations performed are either Create, Read, Update or Delete. These four operations + * are mapped to the methods {@link #create}, {@link #read}, {@link #update} and {@link #destroy} respectively. Each Proxy subclass + * implements these functions.
+ * + *
The CRUD methods each expect an {@link Ext.data.Operation Operation} object as the sole argument. The Operation encapsulates + * information about the action the Store wishes to perform, the {@link Ext.data.Model model} instances that are to be modified, etc. + * See the {@link Ext.data.Operation Operation} documentation for more details. Each CRUD method also accepts a callback function to be + * called asynchronously on completion.
+ * + *
Proxies also support batching of Operations via a {@link Ext.data.Batch batch} object, invoked by the {@link #batch} method.
+ * + * @constructor + * Creates the Proxy + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.proxy.Proxy', { + alias: 'proxy.proxy', + alternateClassName: ['Ext.data.DataProxy', 'Ext.data.Proxy'], + requires: [ + 'Ext.data.reader.Json', + 'Ext.data.writer.Json' + ], + uses: [ + 'Ext.data.Batch', + 'Ext.data.Operation', + 'Ext.data.Model' + ], + mixins: { + observable: 'Ext.util.Observable' + }, + + /** + * @cfg {String} batchOrder + * Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this + * to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy' + */ + batchOrder: 'create,update,destroy', + + /** + * @cfg {Boolean} batchActions True to batch actions of a particular type when synchronizing the store. + * Defaults to true. + */ + batchActions: true, + + /** + * @cfg {String} defaultReaderType The default registered reader type. Defaults to 'json' + * @private + */ + defaultReaderType: 'json', + + /** + * @cfg {String} defaultWriterType The default registered writer type. Defaults to 'json' + * @private + */ + defaultWriterType: 'json', + + /** + * @cfg {String/Ext.data.Model} model The name of the Model to tie to this Proxy. Can be either the string name of + * the Model, or a reference to the Model constructor. Required. + */ + + isProxy: true, + + constructor: function(config) { + config = config || {}; + + if (config.model === undefined) { + delete config.model; + } + + this.mixins.observable.constructor.call(this, config); + + if (this.model !== undefined && !(this.model instanceof Ext.data.Model)) { + this.setModel(this.model); + } + }, + + /** + * Sets the model associated with this proxy. This will only usually be called by a Store + * @param {String|Ext.data.Model} model The new model. Can be either the model name string, + * or a reference to the model's constructor + * @param {Boolean} setOnStore Sets the new model on the associated Store, if one is present + */ + setModel: function(model, setOnStore) { + this.model = Ext.ModelManager.getModel(model); + + var reader = this.reader, + writer = this.writer; + + this.setReader(reader); + this.setWriter(writer); + + if (setOnStore && this.store) { + this.store.setModel(this.model); + } + }, + + /** + * Returns the model attached to this Proxy + * @return {Ext.data.Model} The model + */ + getModel: function() { + return this.model; + }, + + /** + * Sets the Proxy's Reader by string, config object or Reader instance + * @param {String|Object|Ext.data.reader.Reader} reader The new Reader, which can be either a type string, a configuration object + * or an Ext.data.reader.Reader instance + * @return {Ext.data.reader.Reader} The attached Reader object + */ + setReader: function(reader) { + var me = this; + + if (reader === undefined || typeof reader == 'string') { + reader = { + type: reader + }; + } + + if (reader.isReader) { + reader.setModel(me.model); + } else { + Ext.applyIf(reader, { + proxy: me, + model: me.model, + type : me.defaultReaderType + }); + + reader = Ext.createByAlias('reader.' + reader.type, reader); + } + + me.reader = reader; + return me.reader; + }, + + /** + * Returns the reader currently attached to this proxy instance + * @return {Ext.data.reader.Reader} The Reader instance + */ + getReader: function() { + return this.reader; + }, + + /** + * Sets the Proxy's Writer by string, config object or Writer instance + * @param {String|Object|Ext.data.writer.Writer} writer The new Writer, which can be either a type string, a configuration object + * or an Ext.data.writer.Writer instance + * @return {Ext.data.writer.Writer} The attached Writer object + */ + setWriter: function(writer) { + if (writer === undefined || typeof writer == 'string') { + writer = { + type: writer + }; + } + + if (!(writer instanceof Ext.data.writer.Writer)) { + Ext.applyIf(writer, { + model: this.model, + type : this.defaultWriterType + }); + + writer = Ext.createByAlias('writer.' + writer.type, writer); + } + + this.writer = writer; + + return this.writer; + }, + + /** + * Returns the writer currently attached to this proxy instance + * @return {Ext.data.writer.Writer} The Writer instance + */ + getWriter: function() { + return this.writer; + }, + + /** + * Performs the given create operation. + * @param {Ext.data.Operation} operation The Operation to perform + * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) + * @param {Object} scope Scope to execute the callback function in + * @method + */ + create: Ext.emptyFn, + + /** + * Performs the given read operation. + * @param {Ext.data.Operation} operation The Operation to perform + * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) + * @param {Object} scope Scope to execute the callback function in + * @method + */ + read: Ext.emptyFn, + + /** + * Performs the given update operation. + * @param {Ext.data.Operation} operation The Operation to perform + * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) + * @param {Object} scope Scope to execute the callback function in + * @method + */ + update: Ext.emptyFn, + + /** + * Performs the given destroy operation. + * @param {Ext.data.Operation} operation The Operation to perform + * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) + * @param {Object} scope Scope to execute the callback function in + * @method + */ + destroy: Ext.emptyFn, + + /** + * Performs a batch of {@link Ext.data.Operation Operations}, in the order specified by {@link #batchOrder}. Used internally by + * {@link Ext.data.Store}'s {@link Ext.data.Store#sync sync} method. Example usage: + *
+ * myProxy.batch({ + * create : [myModel1, myModel2], + * update : [myModel3], + * destroy: [myModel4, myModel5] + * }); + *
+ * Where the myModel* above are {@link Ext.data.Model Model} instances - in this case 1 and 2 are new instances and have not been + * saved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed. + * @param {Object} operations Object containing the Model instances to act upon, keyed by action name + * @param {Object} listeners Optional listeners object passed straight through to the Batch - see {@link Ext.data.Batch} + * @return {Ext.data.Batch} The newly created Ext.data.Batch object + */ + batch: function(operations, listeners) { + var me = this, + batch = Ext.create('Ext.data.Batch', { + proxy: me, + listeners: listeners || {} + }), + useBatch = me.batchActions, + records; + + Ext.each(me.batchOrder.split(','), function(action) { + records = operations[action]; + if (records) { + if (useBatch) { + batch.add(Ext.create('Ext.data.Operation', { + action: action, + records: records + })); + } else { + Ext.each(records, function(record){ + batch.add(Ext.create('Ext.data.Operation', { + action : action, + records: [record] + })); + }); + } + } + }, me); + + batch.start(); + return batch; + } +}, function() { + // Ext.data.proxy.ProxyMgr.registerType('proxy', this); + + //backwards compatibility + Ext.data.DataProxy = this; + // Ext.deprecate('platform', '2.0', function() { + // Ext.data.DataProxy = this; + // }, this); +}); + +/** + * @author Ed Spencer + * @class Ext.data.proxy.Server + * @extends Ext.data.proxy.Proxy + * + *
ServerProxy is a superclass of {@link Ext.data.proxy.JsonP JsonPProxy} and {@link Ext.data.proxy.Ajax AjaxProxy}, + * and would not usually be used directly.
+ * + *
ServerProxy should ideally be named HttpProxy as it is a superclass for all HTTP proxies - for Ext JS 4.x it has been + * called ServerProxy to enable any 3.x applications that reference the HttpProxy to continue to work (HttpProxy is now an + * alias of AjaxProxy).
+ */ +Ext.define('Ext.data.proxy.Server', { + extend: 'Ext.data.proxy.Proxy', + alias : 'proxy.server', + alternateClassName: 'Ext.data.ServerProxy', + uses : ['Ext.data.Request'], + + /** + * @cfg {String} url The URL from which to request the data object. + */ + + /** + * @cfg {Object/String/Ext.data.reader.Reader} reader The Ext.data.reader.Reader to use to decode the server's response. This can + * either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml'). + */ + + /** + * @cfg {Object/String/Ext.data.writer.Writer} writer The Ext.data.writer.Writer to use to encode any request sent to the server. + * This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml'). + */ + + /** + * @cfg {String} pageParam The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to + * undefined if you don't want to send a page parameter + */ + pageParam: 'page', + + /** + * @cfg {String} startParam The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this + * to undefined if you don't want to send a start parameter + */ + startParam: 'start', + + /** + * @cfg {String} limitParam The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this + * to undefined if you don't want to send a limit parameter + */ + limitParam: 'limit', + + /** + * @cfg {String} groupParam The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this + * to undefined if you don't want to send a group parameter + */ + groupParam: 'group', + + /** + * @cfg {String} sortParam The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this + * to undefined if you don't want to send a sort parameter + */ + sortParam: 'sort', + + /** + * @cfg {String} filterParam The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set + * this to undefined if you don't want to send a filter parameter + */ + filterParam: 'filter', + + /** + * @cfg {String} directionParam The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true. + * Defaults to 'dir'. + */ + directionParam: 'dir', + + /** + * @cfg {Boolean} simpleSortMode Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested. + * The directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC' + */ + simpleSortMode: false, + + /** + * @cfg {Boolean} noCache (optional) Defaults to true. Disable caching by adding a unique parameter + * name to the request. + */ + noCache : true, + + /** + * @cfg {String} cacheString The name of the cache param added to the url when using noCache (defaults to "_dc") + */ + cacheString: "_dc", + + /** + * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds. + */ + timeout : 30000, + + /** + * @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.proxy.Server#url url}.

+ *
For example:
+ *
+api: { + load : '/controller/load', + create : '/controller/new', + save : '/controller/update', + destroy : '/controller/destroy_action' +} + *
+ *
If the specific URL for a given CRUD action is undefined, the CRUD action request + * will be directed to the configured {@link Ext.data.proxy.Server#url url}.
+ */ + + /** + * @ignore + */ + constructor: function(config) { + var me = this; + + config = config || {}; + this.addEvents( + /** + * @event exception + * Fires when the server returns an exception + * @param {Ext.data.proxy.Proxy} this + * @param {Object} response The response from the AJAX request + * @param {Ext.data.Operation} operation The operation that triggered request + */ + 'exception' + ); + me.callParent([config]); + + /** + * @cfg {Object} extraParams Extra parameters that will be included on every request. Individual requests with params + * of the same name will override these params when they are in conflict. + */ + me.extraParams = config.extraParams || {}; + + me.api = config.api || {}; + + //backwards compatibility, will be deprecated in 5.0 + me.nocache = me.noCache; + }, + + //in a ServerProxy all four CRUD operations are executed in the same manner, so we delegate to doRequest in each case + create: function() { + return this.doRequest.apply(this, arguments); + }, + + read: function() { + return this.doRequest.apply(this, arguments); + }, + + update: function() { + return this.doRequest.apply(this, arguments); + }, + + destroy: function() { + return this.doRequest.apply(this, arguments); + }, + + /** + * Creates and returns an Ext.data.Request object based on the options passed by the {@link Ext.data.Store Store} + * that this Proxy is attached to. + * @param {Ext.data.Operation} operation The {@link Ext.data.Operation Operation} object to execute + * @return {Ext.data.Request} The request object + */ + buildRequest: function(operation) { + var params = Ext.applyIf(operation.params || {}, this.extraParams || {}), + request; + + //copy any sorters, filters etc into the params so they can be sent over the wire + params = Ext.applyIf(params, this.getParams(params, operation)); + + if (operation.id && !params.id) { + params.id = operation.id; + } + + request = Ext.create('Ext.data.Request', { + params : params, + action : operation.action, + records : operation.records, + operation: operation, + url : operation.url + }); + + request.url = this.buildUrl(request); + + /* + * Save the request on the Operation. Operations don't usually care about Request and Response data, but in the + * ServerProxy and any of its subclasses we add both request and response as they may be useful for further processing + */ + operation.request = request; + + return request; + }, + + /** + * + */ + processResponse: function(success, operation, request, response, callback, scope){ + var me = this, + reader, + result, + records, + length, + mc, + record, + i; + + if (success === true) { + reader = me.getReader(); + result = reader.read(me.extractResponseData(response)); + records = result.records; + length = records.length; + + if (result.success !== false) { + mc = Ext.create('Ext.util.MixedCollection', true, function(r) {return r.getId();}); + mc.addAll(operation.records); + for (i = 0; i < length; i++) { + record = mc.get(records[i].getId()); + + if (record) { + record.beginEdit(); + record.set(record.data); + record.endEdit(true); + } + } + + //see comment in buildRequest for why we include the response object here + Ext.apply(operation, { + response: response, + resultSet: result + }); + + operation.setCompleted(); + operation.setSuccessful(); + } else { + operation.setException(result.message); + me.fireEvent('exception', this, response, operation); + } + } else { + me.setException(operation, response); + me.fireEvent('exception', this, response, operation); + } + + //this callback is the one that was passed to the 'read' or 'write' function above + if (typeof callback == 'function') { + callback.call(scope || me, operation); + } + + me.afterRequest(request, success); + }, + + /** + * Sets up an exception on the operation + * @private + * @param {Ext.data.Operation} operation The operation + * @param {Object} response The response + */ + setException: function(operation, response){ + operation.setException({ + status: response.status, + statusText: response.statusText + }); + }, + + /** + * Template method to allow subclasses to specify how to get the response for the reader. + * @private + * @param {Object} response The server response + * @return {Mixed} The response data to be used by the reader + */ + extractResponseData: function(response){ + return response; + }, + + /** + * Encode any values being sent to the server. Can be overridden in subclasses. + * @private + * @param {Array} An array of sorters/filters. + * @return {Mixed} The encoded value + */ + applyEncoding: function(value){ + return Ext.encode(value); + }, + + /** + * Encodes the array of {@link Ext.util.Sorter} objects into a string to be sent in the request url. By default, + * this simply JSON-encodes the sorter data + * @param {Array} sorters The array of {@link Ext.util.Sorter Sorter} objects + * @return {String} The encoded sorters + */ + encodeSorters: function(sorters) { + var min = [], + length = sorters.length, + i = 0; + + for (; i < length; i++) { + min[i] = { + property : sorters[i].property, + direction: sorters[i].direction + }; + } + return this.applyEncoding(min); + + }, + + /** + * Encodes the array of {@link Ext.util.Filter} objects into a string to be sent in the request url. By default, + * this simply JSON-encodes the filter data + * @param {Array} sorters The array of {@link Ext.util.Filter Filter} objects + * @return {String} The encoded filters + */ + encodeFilters: function(filters) { + var min = [], + length = filters.length, + i = 0; + + for (; i < length; i++) { + min[i] = { + property: filters[i].property, + value : filters[i].value + }; + } + return this.applyEncoding(min); + }, + + /** + * @private + * Copy any sorters, filters etc into the params so they can be sent over the wire + */ + getParams: function(params, operation) { + params = params || {}; + + var me = this, + isDef = Ext.isDefined, + groupers = operation.groupers, + sorters = operation.sorters, + filters = operation.filters, + page = operation.page, + start = operation.start, + limit = operation.limit, + + simpleSortMode = me.simpleSortMode, + + pageParam = me.pageParam, + startParam = me.startParam, + limitParam = me.limitParam, + groupParam = me.groupParam, + sortParam = me.sortParam, + filterParam = me.filterParam, + directionParam = me.directionParam; + + if (pageParam && isDef(page)) { + params[pageParam] = page; + } + + if (startParam && isDef(start)) { + params[startParam] = start; + } + + if (limitParam && isDef(limit)) { + params[limitParam] = limit; + } + + if (groupParam && groupers && groupers.length > 0) { + // Grouper is a subclass of sorter, so we can just use the sorter method + params[groupParam] = me.encodeSorters(groupers); + } + + if (sortParam && sorters && sorters.length > 0) { + if (simpleSortMode) { + params[sortParam] = sorters[0].property; + params[directionParam] = sorters[0].direction; + } else { + params[sortParam] = me.encodeSorters(sorters); + } + + } + + if (filterParam && filters && filters.length > 0) { + params[filterParam] = me.encodeFilters(filters); + } + + return params; + }, + + /** + * Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will + * add the cache-buster param to the end of the url. Subclasses may need to perform additional modifications + * to the url. + * @param {Ext.data.Request} request The request object + * @return {String} The url + */ + buildUrl: function(request) { + var me = this, + url = me.getUrl(request); + + if (!url) { + Ext.Error.raise("You are using a ServerProxy but have not supplied it with a url."); + } + + if (me.noCache) { + url = Ext.urlAppend(url, Ext.String.format("{0}={1}", me.cacheString, Ext.Date.now())); + } + + return url; + }, + + /** + * Get the url for the request taking into account the order of priority, + * - The request + * - The api + * - The url + * @private + * @param {Ext.data.Request} request The request + * @return {String} The url + */ + getUrl: function(request){ + return request.url || this.api[request.action] || this.url; + }, + + /** + * In ServerProxy subclasses, the {@link #create}, {@link #read}, {@link #update} and {@link #destroy} methods all pass + * through to doRequest. Each ServerProxy subclass must implement the doRequest method - see {@link Ext.data.proxy.JsonP} + * and {@link Ext.data.proxy.Ajax} for examples. This method carries the same signature as each of the methods that delegate to it. + * @param {Ext.data.Operation} operation The Ext.data.Operation object + * @param {Function} callback The callback function to call when the Operation has completed + * @param {Object} scope The scope in which to execute the callback + */ + doRequest: function(operation, callback, scope) { + Ext.Error.raise("The doRequest function has not been implemented on your Ext.data.proxy.Server subclass. See src/data/ServerProxy.js for details"); + }, + + /** + * Optional callback function which can be used to clean up after a request has been completed. + * @param {Ext.data.Request} request The Request object + * @param {Boolean} success True if the request was successful + * @method + */ + afterRequest: Ext.emptyFn, + + onDestroy: function() { + Ext.destroy(this.reader, this.writer); + } +}); + +/** + * @author Ed Spencer + * @class Ext.data.proxy.Ajax + * @extends Ext.data.proxy.Server + * + *
AjaxProxy is one of the most widely-used ways of getting data into your application. It uses AJAX requests to + * load data from the server, usually to be placed into a {@link Ext.data.Store Store}. Let's take a look at a typical + * setup. Here we're going to set up a Store that has an AjaxProxy. To prepare, we'll also set up a + * {@link Ext.data.Model Model}:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id', 'name', 'email'] +}); + +//The Store contains the AjaxProxy as an inline configuration +var store = new Ext.data.Store({ + model: 'User', + proxy: { + type: 'ajax', + url : 'users.json' + } +}); + +store.load(); +
+ * + *
Our example is going to load user data into a Store, so we start off by defining a {@link Ext.data.Model Model} + * with the fields that we expect the server to return. Next we set up the Store itself, along with a {@link #proxy} + * configuration. This configuration was automatically turned into an Ext.data.proxy.Ajax instance, with the url we + * specified being passed into AjaxProxy's constructor. It's as if we'd done this:
+ * +
+new Ext.data.proxy.Ajax({ + url: 'users.json', + model: 'User', + reader: 'json' +}); +
+ * + *
A couple of extra configurations appeared here - {@link #model} and {@link #reader}. These are set by default + * when we create the proxy via the Store - the Store already knows about the Model, and Proxy's default + * {@link Ext.data.reader.Reader Reader} is {@link Ext.data.reader.Json JsonReader}.
+ * + *
Now when we call store.load(), the AjaxProxy springs into action, making a request to the url we configured + * ('users.json' in this case). As we're performing a read, it sends a GET request to that url (see {@link #actionMethods} + * to customize this - by default any kind of read will be sent as a GET request and any kind of write will be sent as a + * POST request).
+ * + *
Limitations
+ * + *
AjaxProxy cannot be used to retrieve data from other domains. If your application is running on http://domainA.com + * it cannot load data from http://domainB.com because browsers have a built-in security policy that prohibits domains + * talking to each other via AJAX.
+ * + *
If you need to read data from another domain and can't set up a proxy server (some software that runs on your own + * domain's web server and transparently forwards requests to http://domainB.com, making it look like they actually came + * from http://domainA.com), you can use {@link Ext.data.proxy.JsonP} and a technique known as JSON-P (JSON with + * Padding), which can help you get around the problem so long as the server on http://domainB.com is set up to support + * JSON-P responses. See {@link Ext.data.proxy.JsonP JsonPProxy}'s introduction docs for more details.
+ * + *
Readers and Writers
+ * + *
AjaxProxy can be configured to use any type of {@link Ext.data.reader.Reader Reader} to decode the server's response. If + * no Reader is supplied, AjaxProxy will default to using a {@link Ext.data.reader.Json JsonReader}. Reader configuration + * can be passed in as a simple object, which the Proxy automatically turns into a {@link Ext.data.reader.Reader Reader} + * instance:
+ * +
+var proxy = new Ext.data.proxy.Ajax({ + model: 'User', + reader: { + type: 'xml', + root: 'users' + } +}); + +proxy.getReader(); //returns an {@link Ext.data.reader.Xml XmlReader} instance based on the config we supplied +
+ * + *
Url generation
+ * + *
AjaxProxy automatically inserts any sorting, filtering, paging and grouping options into the url it generates for + * each request. These are controlled with the following configuration options:
+ * + *
+ *
{@link #pageParam} - controls how the page number is sent to the server + * (see also {@link #startParam} and {@link #limitParam})
+ *
{@link #sortParam} - controls how sort information is sent to the server
+ *
{@link #groupParam} - controls how grouping information is sent to the server
+ *
{@link #filterParam} - controls how filter information is sent to the server
+ *
+ * + *
Each request sent by AjaxProxy is described by an {@link Ext.data.Operation Operation}. To see how we can + * customize the generated urls, let's say we're loading the Proxy with the following Operation:
+ * +
+var operation = new Ext.data.Operation({ + action: 'read', + page : 2 +}); +
+ * + *
Now we'll issue the request for this Operation by calling {@link #read}:
+ * +
+var proxy = new Ext.data.proxy.Ajax({ + url: '/users' +}); + +proxy.read(operation); //GET /users?page=2 +
+ * + *
Easy enough - the Proxy just copied the page property from the Operation. We can customize how this page data is + * sent to the server:
+ * +
+var proxy = new Ext.data.proxy.Ajax({ + url: '/users', + pagePage: 'pageNumber' +}); + +proxy.read(operation); //GET /users?pageNumber=2 +
+ * + *
Alternatively, our Operation could have been configured to send start and limit parameters instead of page:
+ * +
+var operation = new Ext.data.Operation({ + action: 'read', + start : 50, + limit : 25 +}); + +var proxy = new Ext.data.proxy.Ajax({ + url: '/users' +}); + +proxy.read(operation); //GET /users?start=50&limit=25 +
+ * + *
Again we can customize this url:
+ * +
+var proxy = new Ext.data.proxy.Ajax({ + url: '/users', + startParam: 'startIndex', + limitParam: 'limitIndex' +}); + +proxy.read(operation); //GET /users?startIndex=50&limitIndex=25 +
+ * + *
AjaxProxy will also send sort and filter information to the server. Let's take a look at how this looks with a + * more expressive Operation object:
+ * +
+var operation = new Ext.data.Operation({ + action: 'read', + sorters: [ + new Ext.util.Sorter({ + property : 'name', + direction: 'ASC' + }), + new Ext.util.Sorter({ + property : 'age', + direction: 'DESC' + }) + ], + filters: [ + new Ext.util.Filter({ + property: 'eyeColor', + value : 'brown' + }) + ] +}); +
+ * + *
This is the type of object that is generated internally when loading a {@link Ext.data.Store Store} with sorters + * and filters defined. By default the AjaxProxy will JSON encode the sorters and filters, resulting in something like + * this (note that the url is escaped before sending the request, but is left unescaped here for clarity):
+ * +
+var proxy = new Ext.data.proxy.Ajax({ + url: '/users' +}); + +proxy.read(operation); //GET /users?sort=[{"property":"name","direction":"ASC"},{"property":"age","direction":"DESC"}]&filter=[{"property":"eyeColor","value":"brown"}] +
+ * + *
We can again customize how this is created by supplying a few configuration options. Let's say our server is set + * up to receive sorting information is a format like "sortBy=name#ASC,age#DESC". We can configure AjaxProxy to provide + * that format like this:
+ * +
+ var proxy = new Ext.data.proxy.Ajax({ + url: '/users', + sortParam: 'sortBy', + filterParam: 'filterBy', + + //our custom implementation of sorter encoding - turns our sorters into "name#ASC,age#DESC" + encodeSorters: function(sorters) { + var length = sorters.length, + sortStrs = [], + sorter, i; + + for (i = 0; i < length; i++) { + sorter = sorters[i]; + + sortStrs[i] = sorter.property + '#' + sorter.direction + } + + return sortStrs.join(","); + } + }); + + proxy.read(operation); //GET /users?sortBy=name#ASC,age#DESC&filterBy=[{"property":"eyeColor","value":"brown"}] +
+ * + *
We can also provide a custom {@link #encodeFilters} function to encode our filters.
+ * + * @constructor + * + *
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.define('Ext.data.proxy.Ajax', { + requires: ['Ext.util.MixedCollection', 'Ext.Ajax'], + extend: 'Ext.data.proxy.Server', + alias: 'proxy.ajax', + alternateClassName: ['Ext.data.HttpProxy', 'Ext.data.AjaxProxy'], + + /** + * @property actionMethods + * Mapping of action name to HTTP request method. In the basic AjaxProxy these are set to 'GET' for 'read' actions and 'POST' + * for 'create', 'update' and 'destroy' actions. The {@link Ext.data.proxy.Rest} maps these to the correct RESTful methods. + */ + actionMethods: { + create : 'POST', + read : 'GET', + update : 'POST', + destroy: 'POST' + }, + + /** + * @cfg {Object} headers Any headers to add to the Ajax request. Defaults to undefined. + */ + + /** + * @ignore + */ + doRequest: function(operation, callback, scope) { + var writer = this.getWriter(), + request = this.buildRequest(operation, callback, scope); + + if (operation.allowWrite()) { + request = writer.write(request); + } + + Ext.apply(request, { + headers : this.headers, + timeout : this.timeout, + scope : this, + callback : this.createRequestCallback(request, operation, callback, scope), + method : this.getMethod(request), + disableCaching: false // explicitly set it to false, ServerProxy handles caching + }); + + Ext.Ajax.request(request); + + return request; + }, + + /** + * Returns the HTTP method name for a given request. By default this returns based on a lookup on {@link #actionMethods}. + * @param {Ext.data.Request} request The request object + * @return {String} The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE') + */ + getMethod: function(request) { + return this.actionMethods[request.action]; + }, + + /** + * @private + * TODO: This is currently identical to the JsonPProxy version except for the return function's signature. There is a lot + * of code duplication inside the returned function so we need to find a way to DRY this up. + * @param {Ext.data.Request} request The Request object + * @param {Ext.data.Operation} operation The Operation being executed + * @param {Function} callback The callback function to be called when the request completes. This is usually the callback + * passed to doRequest + * @param {Object} scope The scope in which to execute the callback function + * @return {Function} The callback function + */ + createRequestCallback: function(request, operation, callback, scope) { + var me = this; + + return function(options, success, response) { + me.processResponse(success, operation, request, response, callback, scope); + }; + } +}, function() { + //backwards compatibility, remove in Ext JS 5.0 + Ext.data.HttpProxy = this; +}); + +/** + * @author Ed Spencer + * @class Ext.data.Model + * + *
A Model represents some object that your application manages. For example, one might define a Model for Users, Products, + * Cars, or any other real-world object that we want to model in the system. Models are registered via the {@link Ext.ModelManager model manager}, + * and are used by {@link Ext.data.Store stores}, which are in turn used by many of the data-bound components in Ext.
+ * + *
Models are defined as a set of fields and any arbitrary methods and properties relevant to the model. For example:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + {name: 'name', type: 'string'}, + {name: 'age', type: 'int'}, + {name: 'phone', type: 'string'}, + {name: 'alive', type: 'boolean', defaultValue: true} + ], + + changeName: function() { + var oldName = this.get('name'), + newName = oldName + " The Barbarian"; + + this.set('name', newName); + } +}); +
+* +*
The fields array is turned into a {@link Ext.util.MixedCollection MixedCollection} automatically by the {@link Ext.ModelManager ModelManager}, and all +* other functions and properties are copied to the new Model's prototype.
+* +*
Now we can create instances of our User model and call any model logic we defined:
+* +
+var user = Ext.ModelManager.create({ + name : 'Conan', + age : 24, + phone: '555-555-5555' +}, 'User'); + +user.changeName(); +user.get('name'); //returns "Conan The Barbarian" +
+ * + *
Validations
+ * + *
Models have built-in support for validations, which are executed against the validator functions in + * {@link Ext.data.validations} ({@link Ext.data.validations see all validation functions}). Validations are easy to add to models:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + {name: 'name', type: 'string'}, + {name: 'age', type: 'int'}, + {name: 'phone', type: 'string'}, + {name: 'gender', type: 'string'}, + {name: 'username', type: 'string'}, + {name: 'alive', type: 'boolean', defaultValue: true} + ], + + validations: [ + {type: 'presence', field: 'age'}, + {type: 'length', field: 'name', min: 2}, + {type: 'inclusion', field: 'gender', list: ['Male', 'Female']}, + {type: 'exclusion', field: 'username', list: ['Admin', 'Operator']}, + {type: 'format', field: 'username', matcher: /([a-z]+)[0-9]{2,3}/} + ] +}); +
+ * + *
The validations can be run by simply calling the {@link #validate} function, which returns a {@link Ext.data.Errors} + * object:
+ * +
+var instance = Ext.ModelManager.create({ + name: 'Ed', + gender: 'Male', + username: 'edspencer' +}, 'User'); + +var errors = instance.validate(); +
+ * + *
Associations
+ * + *
Models can have associations with other Models via {@link Ext.data.BelongsToAssociation belongsTo} and + * {@link Ext.data.HasManyAssociation hasMany} associations. For example, let's say we're writing a blog administration + * application which deals with Users, Posts and Comments. We can express the relationships between these models like this:
+ * +
+Ext.define('Post', { + extend: 'Ext.data.Model', + fields: ['id', 'user_id'], + + belongsTo: 'User', + hasMany : {model: 'Comment', name: 'comments'} +}); + +Ext.define('Comment', { + extend: 'Ext.data.Model', + fields: ['id', 'user_id', 'post_id'], + + belongsTo: 'Post' +}); + +Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id'], + + hasMany: [ + 'Post', + {model: 'Comment', name: 'comments'} + ] +}); +
+ * + *
See the docs for {@link Ext.data.BelongsToAssociation} and {@link Ext.data.HasManyAssociation} for details on the usage + * and configuration of associations. Note that associations can also be specified like this:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id'], + + associations: [ + {type: 'hasMany', model: 'Post', name: 'posts'}, + {type: 'hasMany', model: 'Comment', name: 'comments'} + ] +}); +
+ * + *
Using a Proxy
+ * + *
Models are great for representing types of data and relationships, but sooner or later we're going to want to + * load or save that data somewhere. All loading and saving of data is handled via a {@link Ext.data.proxy.Proxy Proxy}, + * which can be set directly on the Model:
+ * +
+Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id', 'name', 'email'], + + proxy: { + type: 'rest', + url : '/users' + } +}); +
+ * + *
Here we've set up a {@link Ext.data.proxy.Rest Rest Proxy}, which knows how to load and save data to and from a + * RESTful backend. Let's see how this works:
+ * +
+var user = Ext.ModelManager.create({name: 'Ed Spencer', email: 'ed@sencha.com'}, 'User'); + +user.save(); //POST /users +
+ * + *
Calling {@link #save} on the new Model instance tells the configured RestProxy that we wish to persist this + * Model's data onto our server. RestProxy figures out that this Model hasn't been saved before because it doesn't + * have an id, and performs the appropriate action - in this case issuing a POST request to the url we configured + * (/users). We configure any Proxy on any Model and always follow this API - see {@link Ext.data.proxy.Proxy} for a full + * list.
+ * + *
Loading data via the Proxy is equally easy:
+ * +
+//get a reference to the User model class +var User = Ext.ModelManager.getModel('User'); + +//Uses the configured RestProxy to make a GET request to /users/123 +User.load(123, { + success: function(user) { + console.log(user.getId()); //logs 123 + } +}); +
+ * + *
Models can also be updated and destroyed easily:
+ * +
+//the user Model we loaded in the last snippet: +user.set('name', 'Edward Spencer'); + +//tells the Proxy to save the Model. In this case it will perform a PUT request to /users/123 as this Model already has an id +user.save({ + success: function() { + console.log('The User was updated'); + } +}); + +//tells the Proxy to destroy the Model. Performs a DELETE request to /users/123 +user.destroy({ + success: function() { + console.log('The User was destroyed!'); + } +}); +
+ * + *
Usage in Stores
+ * + *
It is very common to want to load a set of Model instances to be displayed and manipulated in the UI. We do this + * by creating a {@link Ext.data.Store Store}:
+ * +
+var store = new Ext.data.Store({ + model: 'User' +}); + +//uses the Proxy we set up on Model to load the Store data +store.load(); +
+ * + *
A Store is just a collection of Model instances - usually loaded from a server somewhere. Store can also maintain + * a set of added, updated and removed Model instances to be synchronized with the server via the Proxy. See the + * {@link Ext.data.Store Store docs} for more information on Stores.
+ * + * @constructor + * @param {Object} data An object containing keys corresponding to this model's fields, and their associated values + * @param {Number} id Optional unique ID to assign to this model instance + */ +Ext.define('Ext.data.Model', { + alternateClassName: 'Ext.data.Record', + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: [ + 'Ext.ModelManager', + 'Ext.data.Field', + 'Ext.data.Errors', + 'Ext.data.Operation', + 'Ext.data.validations', + 'Ext.data.proxy.Ajax', + 'Ext.util.MixedCollection' + ], + + onClassExtended: function(cls, data) { + var onBeforeClassCreated = data.onBeforeClassCreated; + + data.onBeforeClassCreated = function(cls, data) { + var me = this, + name = Ext.getClassName(cls), + prototype = cls.prototype, + superCls = cls.prototype.superclass, + + validations = data.validations || [], + fields = data.fields || [], + associations = data.associations || [], + belongsTo = data.belongsTo, + hasMany = data.hasMany, + + fieldsMixedCollection = new Ext.util.MixedCollection(false, function(field) { + return field.name; + }), + + associationsMixedCollection = new Ext.util.MixedCollection(false, function(association) { + return association.name; + }), + + superValidations = superCls.validations, + superFields = superCls.fields, + superAssociations = superCls.associations, + + association, i, ln, + dependencies = []; + + // Save modelName on class and its prototype + cls.modelName = name; + prototype.modelName = name; + + // Merge the validations of the superclass and the new subclass + if (superValidations) { + validations = superValidations.concat(validations); + } + + data.validations = validations; + + // Merge the fields of the superclass and the new subclass + if (superFields) { + fields = superFields.items.concat(fields); + } + + for (i = 0, ln = fields.length; i < ln; ++i) { + fieldsMixedCollection.add(new Ext.data.Field(fields[i])); + } + + data.fields = fieldsMixedCollection; + + //associations can be specified in the more convenient format (e.g. not inside an 'associations' array). + //we support that here + if (belongsTo) { + belongsTo = Ext.Array.from(belongsTo); + + for (i = 0, ln = belongsTo.length; i < ln; ++i) { + association = belongsTo[i]; + + if (!Ext.isObject(association)) { + association = {model: association}; + } + + association.type = 'belongsTo'; + associations.push(association); + } + + delete data.belongsTo; + } + + if (hasMany) { + hasMany = Ext.Array.from(hasMany); + for (i = 0, ln = hasMany.length; i < ln; ++i) { + association = hasMany[i]; + + if (!Ext.isObject(association)) { + association = {model: association}; + } + + association.type = 'hasMany'; + associations.push(association); + } + + delete data.hasMany; + } + + if (superAssociations) { + associations = superAssociations.items.concat(associations); + } + + for (i = 0, ln = associations.length; i < ln; ++i) { + dependencies.push('association.' + associations[i].type.toLowerCase()); + } + + if (data.proxy) { + if (typeof data.proxy === 'string') { + dependencies.push('proxy.' + data.proxy); + } + else if (typeof data.proxy.type === 'string') { + dependencies.push('proxy.' + data.proxy.type); + } + } + + Ext.require(dependencies, function() { + Ext.ModelManager.registerType(name, cls); + + for (i = 0, ln = associations.length; i < ln; ++i) { + association = associations[i]; + + Ext.apply(association, { + ownerModel: name, + associatedModel: association.model + }); + + if (Ext.ModelManager.getModel(association.model) === undefined) { + Ext.ModelManager.registerDeferredAssociation(association); + } else { + associationsMixedCollection.add(Ext.data.Association.create(association)); + } + } + + data.associations = associationsMixedCollection; + + onBeforeClassCreated.call(me, cls, data); + + cls.setProxy(cls.prototype.proxy || cls.prototype.defaultProxyType); + + // Fire the onModelDefined template method on ModelManager + Ext.ModelManager.onModelDefined(cls); + }); + }; + }, + + inheritableStatics: { + /** + * Sets the Proxy to use for this model. Accepts any options that can be accepted by {@link Ext#createByAlias Ext.createByAlias} + * @param {String/Object/Ext.data.proxy.Proxy} proxy The proxy + * @static + */ + setProxy: function(proxy) { + //make sure we have an Ext.data.proxy.Proxy object + if (!proxy.isProxy) { + if (typeof proxy == "string") { + proxy = { + type: proxy + }; + } + proxy = Ext.createByAlias("proxy." + proxy.type, proxy); + } + proxy.setModel(this); + this.proxy = this.prototype.proxy = proxy; + + return proxy; + }, + + /** + * Returns the configured Proxy for this Model + * @return {Ext.data.proxy.Proxy} The proxy + */ + getProxy: function() { + return this.proxy; + }, + + /** + * Static. Asynchronously loads a model instance by id. Sample usage: +
+ MyApp.User = Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + {name: 'id', type: 'int'}, + {name: 'name', type: 'string'} + ] + }); + + MyApp.User.load(10, { + scope: this, + failure: function(record, operation) { + //do something if the load failed + }, + success: function(record, operation) { + //do something if the load succeeded + }, + callback: function(record, operation) { + //do something whether the load succeeded or failed + } + }); +
+ * @param {Number} id The id of the model to load + * @param {Object} config Optional config object containing success, failure and callback functions, plus optional scope + * @member Ext.data.Model + * @method load + * @static + */ + load: function(id, config) { + config = Ext.apply({}, config); + config = Ext.applyIf(config, { + action: 'read', + id : id + }); + + var operation = Ext.create('Ext.data.Operation', config), + scope = config.scope || this, + record = null, + callback; + + callback = function(operation) { + if (operation.wasSuccessful()) { + record = operation.getRecords()[0]; + Ext.callback(config.success, scope, [record, operation]); + } else { + Ext.callback(config.failure, scope, [record, operation]); + } + Ext.callback(config.callback, scope, [record, operation]); + }; + + this.proxy.read(operation, callback, this); + } + }, + + statics: { + PREFIX : 'ext-record', + AUTO_ID: 1, + EDIT : 'edit', + REJECT : 'reject', + COMMIT : 'commit', + + /** + * Generates a sequential id. This method is typically called when a record is {@link #create}d + * and {@link #Record no id has been specified}. The id will automatically be assigned + * to the record. The returned id takes the form: + * {PREFIX}-{AUTO_ID}.
+ *
PREFIX : String
Ext.data.Model.PREFIX + * (defaults to 'ext-record')
+ *
AUTO_ID : String
Ext.data.Model.AUTO_ID + * (defaults to 1 initially)
+ *
+ * @param {Ext.data.Model} rec The record being created. The record does not exist, it's a {@link #phantom}. + * @return {String} auto-generated string id, "ext-record-i++'; + * @static + */ + id: function(rec) { + var id = [this.PREFIX, '-', this.AUTO_ID++].join(''); + rec.phantom = true; + rec.internalId = id; + return id; + } + }, + + /** + * Internal flag used to track whether or not the model instance is currently being edited. Read-only + * @property editing + * @type Boolean + */ + editing : false, + + /** + * Readonly flag - true if this Record has been modified. + * @type Boolean + */ + dirty : false, + + /** + * @cfg {String} persistanceProperty The property on this Persistable object that its data is saved to. + * Defaults to 'data' (e.g. all persistable data resides in this.data.) + */ + persistanceProperty: 'data', + + evented: false, + isModel: true, + + /** + * true when the record does not yet exist in a server-side database (see + * {@link #setDirty}). Any record which has a real database pk set as its id property + * is NOT a phantom -- it's real. + * @property phantom + * @type {Boolean} + */ + phantom : false, + + /** + * @cfg {String} idProperty The name of the field treated as this Model's unique id (defaults to 'id'). + */ + idProperty: 'id', + + /** + * The string type of the default Model Proxy. Defaults to 'ajax' + * @property defaultProxyType + * @type String + */ + defaultProxyType: 'ajax', + + /** + * An array of the fields defined on this model + * @property fields + * @type {Array} + */ + + // raw not documented intentionally, meant to be used internally. + constructor: function(data, id, raw) { + data = data || {}; + + var me = this, + fields, + length, + field, + name, + i, + isArray = Ext.isArray(data), + newData = isArray ? {} : null; // to hold mapped array data if needed + + /** + * An internal unique ID for each Model instance, used to identify Models that don't have an ID yet + * @property internalId + * @type String + * @private + */ + me.internalId = (id || id === 0) ? id : Ext.data.Model.id(me); + + /** + * The raw data used to create this model if created via a reader. + * @property raw + * @type Object + */ + me.raw = raw; + + Ext.applyIf(me, { + data: {} + }); + + /** + * Key: value pairs of all fields whose values have changed + * @property modified + * @type Object + */ + me.modified = {}; + + me[me.persistanceProperty] = {}; + + me.mixins.observable.constructor.call(me); + + //add default field values if present + fields = me.fields.items; + length = fields.length; + + for (i = 0; i < length; i++) { + field = fields[i]; + name = field.name; + + if (isArray){ + // Have to map array data so the values get assigned to the named fields + // rather than getting set as the field names with undefined values. + newData[name] = data[i]; + } + else if (data[name] === undefined) { + data[name] = field.defaultValue; + } + } + + me.set(newData || data); + // clear any dirty/modified since we're initializing + me.dirty = false; + me.modified = {}; + + if (me.getId()) { + me.phantom = false; + } + + if (typeof me.init == 'function') { + me.init(); + } + + me.id = me.modelName + '-' + me.internalId; + + Ext.ModelManager.register(me); + }, + + /** + * Returns the value of the given field + * @param {String} fieldName The field to fetch the value for + * @return {Mixed} The value + */ + get: function(field) { + return this[this.persistanceProperty][field]; + }, + + /** + * Sets the given field to the given value, marks the instance as dirty + * @param {String|Object} fieldName The field to set, or an object containing key/value pairs + * @param {Mixed} value The value to set + */ + set: function(fieldName, value) { + var me = this, + fields = me.fields, + modified = me.modified, + convertFields = [], + field, key, i, currentValue; + + /* + * If we're passed an object, iterate over that object. NOTE: we pull out fields with a convert function and + * set those last so that all other possible data is set before the convert function is called + */ + if (arguments.length == 1 && Ext.isObject(fieldName)) { + for (key in fieldName) { + if (fieldName.hasOwnProperty(key)) { + + //here we check for the custom convert function. Note that if a field doesn't have a convert function, + //we default it to its type's convert function, so we have to check that here. This feels rather dirty. + field = fields.get(key); + if (field && field.convert !== field.type.convert) { + convertFields.push(key); + continue; + } + + me.set(key, fieldName[key]); + } + } + + for (i = 0; i < convertFields.length; i++) { + field = convertFields[i]; + me.set(field, fieldName[field]); + } + + } else { + if (fields) { + field = fields.get(fieldName); + + if (field && field.convert) { + value = field.convert(value, me); + } + } + currentValue = me.get(fieldName); + me[me.persistanceProperty][fieldName] = value; + + if (field && field.persist && !me.isEqual(currentValue, value)) { + me.dirty = true; + me.modified[fieldName] = currentValue; + } + + if (!me.editing) { + me.afterEdit(); + } + } + }, + + /** + * Checks if two values are equal, taking into account certain + * special factors, for example dates. + * @private + * @param {Object} a The first value + * @param {Object} b The second value + * @return {Boolean} True if the values are equal + */ + isEqual: function(a, b){ + if (Ext.isDate(a) && Ext.isDate(b)) { + return a.getTime() === b.getTime(); + } + return a === b; + }, + + /** + * Begin an edit. While in edit mode, no events (e.g.. the update event) + * are relayed to the containing store. When an edit has begun, it must be followed + * by either {@link #endEdit} or {@link #cancelEdit}. + */ + beginEdit : function(){ + var me = this; + if (!me.editing) { + me.editing = true; + me.dirtySave = me.dirty; + me.dataSave = Ext.apply({}, me[me.persistanceProperty]); + me.modifiedSave = Ext.apply({}, me.modified); + } + }, + + /** + * Cancels all changes made in the current edit operation. + */ + cancelEdit : function(){ + var me = this; + if (me.editing) { + me.editing = false; + // reset the modified state, nothing changed since the edit began + me.modified = me.modifiedSave; + me[me.persistanceProperty] = me.dataSave; + me.dirty = me.dirtySave; + delete me.modifiedSave; + delete me.dataSave; + delete me.dirtySave; + } + }, + + /** + * End an edit. If any data was modified, the containing store is notified + * (ie, the store's update event will fire). + * @param {Boolean} silent True to not notify the store of the change + */ + endEdit : function(silent){ + var me = this; + if (me.editing) { + me.editing = false; + delete me.modifiedSave; + delete me.dataSave; + delete me.dirtySave; + if (silent !== true && me.dirty) { + me.afterEdit(); + } + } + }, + + /** + * Gets a hash of only the fields that have been modified since this Model was created or commited. + * @return Object + */ + getChanges : function(){ + var modified = this.modified, + changes = {}, + field; + + for (field in modified) { + if (modified.hasOwnProperty(field)){ + changes[field] = this.get(field); + } + } + + return changes; + }, + + /** + * Returns true if the passed field name has been {@link #modified} + * since the load or last commit. + * @param {String} fieldName {@link Ext.data.Field#name} + * @return {Boolean} + */ + isModified : function(fieldName) { + return this.modified.hasOwnProperty(fieldName); + }, + + /** + *
Marks this Record as {@link #dirty}. This method + * is used interally when adding {@link #phantom} records to a + * {@link Ext.data.Store#writer writer enabled store}.
+ *
Marking a record {@link #dirty} causes the phantom to + * be returned by {@link Ext.data.Store#getModifiedRecords} where it will + * have a create action composed for it during {@link Ext.data.Store#save store save} + * operations.
+ */ + setDirty : function() { + var me = this, + name; + + me.dirty = true; + + me.fields.each(function(field) { + if (field.persist) { + name = field.name; + me.modified[name] = me.get(name); + } + }, me); + }, + + markDirty : function() { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.data.Model: markDirty has been deprecated. Use setDirty instead.'); + } + return this.setDirty.apply(this, arguments); + }, + + /** + * Usually called by the {@link Ext.data.Store} to which this model instance has been {@link #join joined}. + * Rejects all changes made to the model instance since either creation, or the last commit operation. + * Modified fields are reverted to their original values. + *
Developers should subscribe to the {@link Ext.data.Store#update} event + * to have their code notified of reject operations.
+ * @param {Boolean} silent (optional) True to skip notification of the owning + * store of the change (defaults to false) + */ + reject : function(silent) { + var me = this, + modified = me.modified, + field; + + for (field in modified) { + if (modified.hasOwnProperty(field)) { + if (typeof modified[field] != "function") { + me[me.persistanceProperty][field] = modified[field]; + } + } + } + + me.dirty = false; + me.editing = false; + me.modified = {}; + + if (silent !== true) { + me.afterReject(); + } + }, + + /** + * Usually called by the {@link Ext.data.Store} which owns the model instance. + * Commits all changes made to the instance since either creation or the last commit operation. + *
Developers should subscribe to the {@link Ext.data.Store#update} event + * to have their code notified of commit operations.
+ * @param {Boolean} silent (optional) True to skip notification of the owning + * store of the change (defaults to false) + */ + commit : function(silent) { + var me = this; + + me.dirty = false; + me.editing = false; + + me.modified = {}; + + if (silent !== true) { + me.afterCommit(); + } + }, + + /** + * Creates a copy (clone) of this Model instance. + * @param {String} id (optional) A new id, defaults to the id + * of the instance being copied. See {@link #id}. + * To generate a phantom instance with a new id use:
+var rec = record.copy(); // clone the record +Ext.data.Model.id(rec); // automatically generate a unique sequential id + *
+ * @return {Record} + */ + copy : function(newId) { + var me = this; + + return new me.self(Ext.apply({}, me[me.persistanceProperty]), newId || me.internalId); + }, + + /** + * Sets the Proxy to use for this model. Accepts any options that can be accepted by {@link Ext#createByAlias Ext.createByAlias} + * @param {String/Object/Ext.data.proxy.Proxy} proxy The proxy + * @static + */ + setProxy: function(proxy) { + //make sure we have an Ext.data.proxy.Proxy object + if (!proxy.isProxy) { + if (typeof proxy === "string") { + proxy = { + type: proxy + }; + } + proxy = Ext.createByAlias("proxy." + proxy.type, proxy); + } + proxy.setModel(this.self); + this.proxy = proxy; + + return proxy; + }, + + /** + * Returns the configured Proxy for this Model + * @return {Ext.data.proxy.Proxy} The proxy + */ + getProxy: function() { + return this.proxy; + }, + + /** + * Validates the current data against all of its configured {@link #validations} and returns an + * {@link Ext.data.Errors Errors} object + * @return {Ext.data.Errors} The errors object + */ + validate: function() { + var errors = Ext.create('Ext.data.Errors'), + validations = this.validations, + validators = Ext.data.validations, + length, validation, field, valid, type, i; + + if (validations) { + length = validations.length; + + for (i = 0; i < length; i++) { + validation = validations[i]; + field = validation.field || validation.name; + type = validation.type; + valid = validators[type](validation, this.get(field)); + + if (!valid) { + errors.add({ + field : field, + message: validation.message || validators[type + 'Message'] + }); + } + } + } + + return errors; + }, + + /** + * Checks if the model is valid. See {@link #validate}. + * @return {Boolean} True if the model is valid. + */ + isValid: function(){ + return this.validate().isValid(); + }, + + /** + * Saves the model instance using the configured proxy + * @param {Object} options Options to pass to the proxy + * @return {Ext.data.Model} The Model instance + */ + save: function(options) { + options = Ext.apply({}, options); + + var me = this, + action = me.phantom ? 'create' : 'update', + record = null, + scope = options.scope || me, + operation, + callback; + + Ext.apply(options, { + records: [me], + action : action + }); + + operation = Ext.create('Ext.data.Operation', options); + + callback = function(operation) { + if (operation.wasSuccessful()) { + record = operation.getRecords()[0]; + //we need to make sure we've set the updated data here. Ideally this will be redundant once the + //ModelCache is in place + me.set(record.data); + record.dirty = false; + + Ext.callback(options.success, scope, [record, operation]); + } else { + Ext.callback(options.failure, scope, [record, operation]); + } + + Ext.callback(options.callback, scope, [record, operation]); + }; + + me.getProxy()[action](operation, callback, me); + + return me; + }, + + /** + * Destroys the model using the configured proxy + * @param {Object} options Options to pass to the proxy + * @return {Ext.data.Model} The Model instance + */ + destroy: function(options){ + options = Ext.apply({}, options); + + var me = this, + record = null, + scope = options.scope || me, + operation, + callback; + + Ext.apply(options, { + records: [me], + action : 'destroy' + }); + + operation = Ext.create('Ext.data.Operation', options); + callback = function(operation) { + if (operation.wasSuccessful()) { + Ext.callback(options.success, scope, [record, operation]); + } else { + Ext.callback(options.failure, scope, [record, operation]); + } + Ext.callback(options.callback, scope, [record, operation]); + }; + + me.getProxy().destroy(operation, callback, me); + return me; + }, + + /** + * Returns the unique ID allocated to this model instance as defined by {@link #idProperty} + * @return {Number} The id + */ + getId: function() { + return this.get(this.idProperty); + }, + + /** + * Sets the model instance's id field to the given id + * @param {Number} id The new id + */ + setId: function(id) { + this.set(this.idProperty, id); + }, + + /** + * Tells this model instance that it has been added to a store + * @param {Ext.data.Store} store The store that the model has been added to + */ + join : function(store) { + /** + * The {@link Ext.data.Store} to which this Record belongs. + * @property store + * @type {Ext.data.Store} + */ + this.store = store; + }, + + /** + * Tells this model instance that it has been removed from the store + */ + unjoin: function() { + delete this.store; + }, + + /** + * @private + * If this Model instance has been {@link #join joined} to a {@link Ext.data.Store store}, the store's + * afterEdit method is called + */ + afterEdit : function() { + this.callStore('afterEdit'); + }, + + /** + * @private + * If this Model instance has been {@link #join joined} to a {@link Ext.data.Store store}, the store's + * afterReject method is called + */ + afterReject : function() { + this.callStore("afterReject"); + }, + + /** + * @private + * If this Model instance has been {@link #join joined} to a {@link Ext.data.Store store}, the store's + * afterCommit method is called + */ + afterCommit: function() { + this.callStore('afterCommit'); + }, + + /** + * @private + * Helper function used by afterEdit, afterReject and afterCommit. Calls the given method on the + * {@link Ext.data.Store store} that this instance has {@link #join joined}, if any. The store function + * will always be called with the model instance as its single argument. + * @param {String} fn The function to call on the store + */ + callStore: function(fn) { + var store = this.store; + + if (store !== undefined && typeof store[fn] == "function") { + store[fn](this); + } + }, + + /** + * Gets all of the data from this Models *loaded* associations. + * It does this recursively - for example if we have a User which + * hasMany Orders, and each Order hasMany OrderItems, it will return an object like this: + * { + * orders: [ + * { + * id: 123, + * status: 'shipped', + * orderItems: [ + * ... + * ] + * } + * ] + * } + * @return {Object} The nested data set for the Model's loaded associations + */ + getAssociatedData: function(){ + return this.prepareAssociatedData(this, [], null); + }, + + /** + * @private + * This complex-looking method takes a given Model instance and returns an object containing all data from + * all of that Model's *loaded* associations. See (@link #getAssociatedData} + * @param {Ext.data.Model} record The Model instance + * @param {Array} ids PRIVATE. The set of Model instance internalIds that have already been loaded + * @param {String} associationType (optional) The name of the type of association to limit to. + * @return {Object} The nested data set for the Model's loaded associations + */ + prepareAssociatedData: function(record, ids, associationType) { + //we keep track of all of the internalIds of the models that we have loaded so far in here + var associations = record.associations.items, + associationCount = associations.length, + associationData = {}, + associatedStore, associatedName, associatedRecords, associatedRecord, + associatedRecordCount, association, id, i, j, type, allow; + + for (i = 0; i < associationCount; i++) { + association = associations[i]; + type = association.type; + allow = true; + if (associationType) { + allow = type == associationType; + } + if (allow && type == 'hasMany') { + + //this is the hasMany store filled with the associated data + associatedStore = record[association.storeName]; + + //we will use this to contain each associated record's data + associationData[association.name] = []; + + //if it's loaded, put it into the association data + if (associatedStore && associatedStore.data.length > 0) { + associatedRecords = associatedStore.data.items; + associatedRecordCount = associatedRecords.length; + + //now we're finally iterating over the records in the association. We do this recursively + for (j = 0; j < associatedRecordCount; j++) { + associatedRecord = associatedRecords[j]; + // Use the id, since it is prefixed with the model name, guaranteed to be unique + id = associatedRecord.id; + + //when we load the associations for a specific model instance we add it to the set of loaded ids so that + //we don't load it twice. If we don't do this, we can fall into endless recursive loading failures. + if (Ext.Array.indexOf(ids, id) == -1) { + ids.push(id); + + associationData[association.name][j] = associatedRecord.data; + Ext.apply(associationData[association.name][j], this.prepareAssociatedData(associatedRecord, ids, type)); + } + } + } + } else if (allow && type == 'belongsTo') { + associatedRecord = record[association.instanceName]; + if (associatedRecord !== undefined) { + id = associatedRecord.id; + if (Ext.Array.indexOf(ids, id) == -1) { + ids.push(id); + associationData[association.name] = associatedRecord.data; + Ext.apply(associationData[association.name], this.prepareAssociatedData(associatedRecord, ids, type)); + } + } + } + } + + return associationData; + } +}); + +/** + * @class Ext.Component + * @extends Ext.AbstractComponent + *
Base class for all Ext components. All subclasses of Component may participate in the automated + * Ext component lifecycle of creation, rendering and destruction which is provided by the {@link Ext.container.Container Container} class. + * Components may be added to a Container through the {@link Ext.container.Container#items items} config option at the time the Container is created, + * or they may be added dynamically via the {@link Ext.container.Container#add add} method.
+ *
The Component base class has built-in support for basic hide/show and enable/disable and size control behavior.
+ *
All Components are registered with the {@link Ext.ComponentManager} on construction so that they can be referenced at any time via + * {@link Ext#getCmp Ext.getCmp}, passing the {@link #id}.
+ *
All user-developed visual widgets that are required to participate in automated lifecycle and size management should subclass Component.
+ *
See the Creating new UI controls tutorial for details on how + * and to either extend or augment ExtJs base classes to create custom Components.
+ *
Every component has a specific xtype, which is its Ext-specific type name, along with methods for checking the + * xtype like {@link #getXType} and {@link #isXType}. This is the list of all valid xtypes:
+ *
+xtype Class +------------- ------------------ +button {@link Ext.button.Button} +buttongroup {@link Ext.container.ButtonGroup} +colorpalette {@link Ext.picker.Color} +component {@link Ext.Component} +container {@link Ext.container.Container} +cycle {@link Ext.button.Cycle} +dataview {@link Ext.view.View} +datepicker {@link Ext.picker.Date} +editor {@link Ext.Editor} +editorgrid {@link Ext.grid.plugin.Editing} +grid {@link Ext.grid.Panel} +multislider {@link Ext.slider.Multi} +panel {@link Ext.panel.Panel} +progress {@link Ext.ProgressBar} +slider {@link Ext.slider.Single} +spacer {@link Ext.toolbar.Spacer} +splitbutton {@link Ext.button.Split} +tabpanel {@link Ext.tab.Panel} +treepanel {@link Ext.tree.Panel} +viewport {@link Ext.container.Viewport} +window {@link Ext.window.Window} + +Toolbar components +--------------------------------------- +paging {@link Ext.toolbar.Paging} +toolbar {@link Ext.toolbar.Toolbar} +tbfill {@link Ext.toolbar.Fill} +tbitem {@link Ext.toolbar.Item} +tbseparator {@link Ext.toolbar.Separator} +tbspacer {@link Ext.toolbar.Spacer} +tbtext {@link Ext.toolbar.TextItem} + +Menu components +--------------------------------------- +menu {@link Ext.menu.Menu} +menucheckitem {@link Ext.menu.CheckItem} +menuitem {@link Ext.menu.Item} +menuseparator {@link Ext.menu.Separator} +menutextitem {@link Ext.menu.Item} + +Form components +--------------------------------------- +form {@link Ext.form.Panel} +checkbox {@link Ext.form.field.Checkbox} +combo {@link Ext.form.field.ComboBox} +datefield {@link Ext.form.field.Date} +displayfield {@link Ext.form.field.Display} +field {@link Ext.form.field.Base} +fieldset {@link Ext.form.FieldSet} +hidden {@link Ext.form.field.Hidden} +htmleditor {@link Ext.form.field.HtmlEditor} +label {@link Ext.form.Label} +numberfield {@link Ext.form.field.Number} +radio {@link Ext.form.field.Radio} +radiogroup {@link Ext.form.RadioGroup} +textarea {@link Ext.form.field.TextArea} +textfield {@link Ext.form.field.Text} +timefield {@link Ext.form.field.Time} +trigger {@link Ext.form.field.Trigger} + +Chart components +--------------------------------------- +chart {@link Ext.chart.Chart} +barchart {@link Ext.chart.series.Bar} +columnchart {@link Ext.chart.series.Column} +linechart {@link Ext.chart.series.Line} +piechart {@link Ext.chart.series.Pie} + +
+ * It should not usually be necessary to instantiate a Component because there are provided subclasses which implement specialized Component + * use cases which over most application needs. However it is possible to instantiate a base Component, and it will be renderable, + * or will particpate in layouts as the child item of a Container: +{@img Ext.Component/Ext.Component.png Ext.Component component} +
+ Ext.create('Ext.Component', { + html: 'Hello world!', + width: 300, + height: 200, + padding: 20, + style: { + color: '#FFFFFF', + backgroundColor:'#000000' + }, + renderTo: Ext.getBody() + }); +
+ *
+ *
The Component above creates its encapsulating div upon render, and use the configured HTML as content. More complex + * internal structure may be created using the {@link #renderTpl} configuration, although to display database-derived mass + * data, it is recommended that an ExtJS data-backed Component such as a {Ext.view.DataView DataView}, or {Ext.grid.Panel GridPanel}, + * or {@link Ext.tree.Panel TreePanel} be used.
+ * @constructor + * @param {Ext.core.Element/String/Object} config The configuration options may be specified as either: + *
+ *
an element : + *
it is set as the internal element and its id used as the component id
+ *
a string : + *
it is assumed to be the id of an existing element and is used as the component id
+ *
anything else : + *
it is assumed to be a standard config object and is applied to the component
+ *
+ */ + +Ext.define('Ext.Component', { + + /* Begin Definitions */ + + alias: ['widget.component', 'widget.box'], + + extend: 'Ext.AbstractComponent', + + requires: [ + 'Ext.util.DelayedTask' + ], + + uses: [ + 'Ext.Layer', + 'Ext.resizer.Resizer', + 'Ext.util.ComponentDragger' + ], + + mixins: { + floating: 'Ext.util.Floating' + }, + + statics: { + // Collapse/expand directions + DIRECTION_TOP: 'top', + DIRECTION_RIGHT: 'right', + DIRECTION_BOTTOM: 'bottom', + DIRECTION_LEFT: 'left' + }, + + /* End Definitions */ + + /** + * @cfg {Mixed} resizable + *
Specify as true to apply a {@link Ext.resizer.Resizer Resizer} to this Component + * after rendering.
+ *
May also be specified as a config object to be passed to the constructor of {@link Ext.resizer.Resizer Resizer} + * to override any defaults. By default the Component passes its minimum and maximum size, and uses + * {@link Ext.resizer.Resizer#dynamic}: false
+ */ + + /** + * @cfg {String} resizeHandles + * A valid {@link Ext.resizer.Resizer} handles config string (defaults to 'all'). Only applies when resizable = true. + */ + resizeHandles: 'all', + + /** + * @cfg {Boolean} autoScroll + * true to use overflow:'auto' on the components layout element and show scroll bars automatically when + * necessary, false to clip any overflowing content (defaults to false). + */ + + /** + * @cfg {Boolean} floating + *
Specify as true to float the Component outside of the document flow using CSS absolute positioning.
+ *
Components such as {@link Ext.window.Window Window}s and {@link Ext.menu.Menu Menu}s are floating + * by default.
+ *
Floating Components that are programatically {@link Ext.Component#render rendered} will register themselves with the global + * {@link Ext.WindowManager ZIndexManager}
+ *
Floating Components as child items of a Container
+ *
A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by + * examining the ownerCt chain.
+ *
When configured as floating, Components acquire, at render time, a {@link Ext.ZIndexManager ZIndexManager} which manages a stack + * of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when + * the Component's {@link #toFront} method is called.
+ *
The ZIndexManager is found by traversing up the {@link #ownerCt} chain to find an ancestor which itself is floating. This is so that + * descendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative + * to any siblings, but always above that floating ancestor Container.
+ *
If no floating ancestor is found, a floating Component registers itself with the default {@link Ext.WindowManager ZIndexManager}.
+ *
Floating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly + * {@link #show} them.
+ *
After rendering, the ownerCt reference is deleted, and the {@link #floatParent} property is set to the found floating ancestor Container. + * If no floating ancestor Container was found the {@link #floatParent} property will not be set.
+ */ + floating: false, + + /** + * @cfg {Boolean} toFrontOnShow + *
True to automatically call {@link #toFront} when the {@link #show} method is called + * on an already visible, floating component (default is true).
+ */ + toFrontOnShow: true, + + /** + *
Optional. Only present for {@link #floating} Components after they have been rendered.
+ *
A reference to the ZIndexManager which is managing this Component's z-index.
+ *
The {@link Ext.ZIndexManager ZIndexManager} maintains a stack of floating Component z-indices, and also provides a single modal + * mask which is insert just beneath the topmost visible modal floating Component.
+ *
Floating Components may be {@link #toFront brought to the front} or {@link #toBack sent to the back} of the z-index stack.
+ *
This defaults to the global {@link Ext.WindowManager ZIndexManager} for floating Components that are programatically + * {@link Ext.Component#render rendered}.
+ *
For {@link #floating} Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found + * which is floating, or if not found the global {@link Ext.WindowManager ZIndexManager} is used.
+ *
See {@link #floating} and {@link #floatParent}
+ * @property zIndexManager + * @type Ext.ZIndexManager + */ + + /** + *
Optional. Only present for {@link #floating} Components which were inserted as descendant items of floating Containers.
+ *
Floating Components that are programatically {@link Ext.Component#render rendered} will not have a floatParent property.
+ *
For {@link #floating} Components which are child items of a Container, the floatParent will be the floating ancestor Container which is + * responsible for the base z-index value of all its floating descendants. It provides a {@link Ext.ZIndexManager ZIndexManager} which provides + * z-indexing services for all its descendant floating Components.
+ *
For example, the dropdown {@link Ext.view.BoundList BoundList} of a ComboBox which is in a Window will have the Window as its + * floatParent
+ *
See {@link #floating} and {@link #zIndexManager}
+ * @property floatParent + * @type Ext.Container + */ + + /** + * @cfg {Mixed} draggable + *
Specify as true to make a {@link #floating} Component draggable using the Component's encapsulating element as the drag handle.
+ *
This may also be specified as a config object for the {@link Ext.util.ComponentDragger ComponentDragger} which is instantiated to perform dragging.
+ *
For example to create a Component which may only be dragged around using a certain internal element as the drag handle, + * use the delegate option:
+ * +new Ext.Component({ + constrain: true, + floating:true, + style: { + backgroundColor: '#fff', + border: '1px solid black' + }, + html: '<h1 style="cursor:move">The title</h1><p>The content</p>', + draggable: { + delegate: 'h1' + } +}).show(); + + */ + + /** + * @cfg {Boolean} maintainFlex + *
Only valid when a sibling element of a {@link Ext.resizer.Splitter Splitter} within a {@link Ext.layout.container.VBox VBox} or + * {@link Ext.layout.container.HBox HBox} layout.
+ *
Specifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this + * Component maintains its configured {@link Ext.layout.container.Box#flex flex} value.
+ */ + + hideMode: 'display', + // Deprecate 5.0 + hideParent: false, + + ariaRole: 'presentation', + + bubbleEvents: [], + + actionMode: 'el', + monPropRe: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/, + + //renderTpl: new Ext.XTemplate( + // '
{uiBase}-{ui}" style="{style}">
', { + // compiled: true, + // disableFormats: true + // } + //), + constructor: function(config) { + config = config || {}; + if (config.initialConfig) { + + // Being initialized from an Ext.Action instance... + if (config.isAction) { + this.baseAction = config; + } + config = config.initialConfig; + // component cloning / action set up + } + else if (config.tagName || config.dom || Ext.isString(config)) { + // element object + config = { + applyTo: config, + id: config.id || config + }; + } + + this.callParent([config]); + + // If we were configured from an instance of Ext.Action, (or configured with a baseAction option), + // register this Component as one of its items + if (this.baseAction){ + this.baseAction.addComponent(this); + } + }, + + initComponent: function() { + var me = this; + + if (me.listeners) { + me.on(me.listeners); + delete me.listeners; + } + me.enableBubble(me.bubbleEvents); + me.mons = []; + }, + + // private + afterRender: function() { + var me = this, + resizable = me.resizable; + + if (me.floating) { + me.makeFloating(me.floating); + } else { + me.el.setVisibilityMode(Ext.core.Element[me.hideMode.toUpperCase()]); + } + + if (Ext.isDefined(me.autoScroll)) { + me.setAutoScroll(me.autoScroll); + } + me.callParent(); + + if (!(me.x && me.y) && (me.pageX || me.pageY)) { + me.setPagePosition(me.pageX, me.pageY); + } + + if (resizable) { + me.initResizable(resizable); + } + + if (me.draggable) { + me.initDraggable(); + } + + me.initAria(); + }, + + initAria: function() { + var actionEl = this.getActionEl(), + role = this.ariaRole; + if (role) { + actionEl.dom.setAttribute('role', role); + } + }, + + /** + * Sets the overflow on the content element of the component. + * @param {Boolean} scroll True to allow the Component to auto scroll. + * @return {Ext.Component} this + */ + setAutoScroll : function(scroll){ + var me = this, + targetEl; + scroll = !!scroll; + if (me.rendered) { + targetEl = me.getTargetEl(); + targetEl.setStyle('overflow', scroll ? 'auto' : ''); + if (scroll && (Ext.isIE6 || Ext.isIE7)) { + // The scrollable container element must be non-statically positioned or IE6/7 will make + // positioned children stay in place rather than scrolling with the rest of the content + targetEl.position(); + } + } + me.autoScroll = scroll; + return me; + }, + + // private + makeFloating : function(cfg){ + this.mixins.floating.constructor.call(this, cfg); + }, + + initResizable: function(resizable) { + resizable = Ext.apply({ + target: this, + dynamic: false, + constrainTo: this.constrainTo, + handles: this.resizeHandles + }, resizable); + resizable.target = this; + this.resizer = Ext.create('Ext.resizer.Resizer', resizable); + }, + + getDragEl: function() { + return this.el; + }, + + initDraggable: function() { + var me = this, + ddConfig = Ext.applyIf({ + el: this.getDragEl(), + constrainTo: me.constrainTo || (me.floatParent ? me.floatParent.getTargetEl() : me.el.dom.parentNode) + }, this.draggable); + + // Add extra configs if Component is specified to be constrained + if (me.constrain || me.constrainDelegate) { + ddConfig.constrain = me.constrain; + ddConfig.constrainDelegate = me.constrainDelegate; + } + + this.dd = Ext.create('Ext.util.ComponentDragger', this, ddConfig); + }, + + /** + * Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}. + * This method fires the {@link #move} event. + * @param {Number} left The new left + * @param {Number} top The new top + * @param {Mixed} animate If true, the Component is animated into its new position. You may also pass an animation configuration. + * @return {Ext.Component} this + */ + setPosition: function(x, y, animate) { + var me = this, + el = me.el, + to = {}, + adj, adjX, adjY, xIsNumber, yIsNumber; + + if (Ext.isArray(x)) { + animate = y; + y = x[1]; + x = x[0]; + } + me.x = x; + me.y = y; + + if (!me.rendered) { + return me; + } + + adj = me.adjustPosition(x, y); + adjX = adj.x; + adjY = adj.y; + xIsNumber = Ext.isNumber(adjX); + yIsNumber = Ext.isNumber(adjY); + + if (xIsNumber || yIsNumber) { + if (animate) { + if (xIsNumber) { + to.left = adjX; + } + if (yIsNumber) { + to.top = adjY; + } + + me.stopAnimation(); + me.animate(Ext.apply({ + duration: 1000, + listeners: { + afteranimate: Ext.Function.bind(me.afterSetPosition, me, [adjX, adjY]) + }, + to: to + }, animate)); + } + else { + if (!xIsNumber) { + el.setTop(adjY); + } + else if (!yIsNumber) { + el.setLeft(adjX); + } + else { + el.setLeftTop(adjX, adjY); + } + me.afterSetPosition(adjX, adjY); + } + } + return me; + }, + + /** + * @private Template method called after a Component has been positioned. + */ + afterSetPosition: function(ax, ay) { + this.onPosition(ax, ay); + this.fireEvent('move', this, ax, ay); + }, + + showAt: function(x, y, animate) { + // A floating Component is positioned relative to its ownerCt if any. + if (this.floating) { + this.setPosition(x, y, animate); + } else { + this.setPagePosition(x, y, animate); + } + this.show(); + }, + + /** + * Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}. + * This method fires the {@link #move} event. + * @param {Number} x The new x position + * @param {Number} y The new y position + * @param {Mixed} animate If passed, the Component is animated into its new position. If this parameter + * is a number, it is used as the animation duration in milliseconds. + * @return {Ext.Component} this + */ + setPagePosition: function(x, y, animate) { + var me = this, + p; + + if (Ext.isArray(x)) { + y = x[1]; + x = x[0]; + } + me.pageX = x; + me.pageY = y; + if (me.floating && me.floatParent) { + // Floating Components being positioned in their ownerCt have to be made absolute + p = me.floatParent.getTargetEl().getViewRegion(); + if (Ext.isNumber(x) && Ext.isNumber(p.left)) { + x -= p.left; + } + if (Ext.isNumber(y) && Ext.isNumber(p.top)) { + y -= p.top; + } + me.setPosition(x, y, animate); + } + else { + p = me.el.translatePoints(x, y); + me.setPosition(p.left, p.top, animate); + } + return me; + }, + + /** + * Gets the current box measurements of the component's underlying element. + * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false) + * @return {Object} box An object in the format {x, y, width, height} + */ + getBox : function(local){ + var pos = this.getPosition(local); + var s = this.getSize(); + s.x = pos[0]; + s.y = pos[1]; + return s; + }, + + /** + * Sets the current box measurements of the component's underlying element. + * @param {Object} box An object in the format {x, y, width, height} + * @return {Ext.Component} this + */ + updateBox : function(box){ + this.setSize(box.width, box.height); + this.setPagePosition(box.x, box.y); + return this; + }, + + // Include margins + getOuterSize: function() { + var el = this.el; + return { + width: el.getWidth() + el.getMargin('lr'), + height: el.getHeight() + el.getMargin('tb') + }; + }, + + // private + adjustSize: function(w, h) { + if (this.autoWidth) { + w = 'auto'; + } + + if (this.autoHeight) { + h = 'auto'; + } + + return { + width: w, + height: h + }; + }, + + // private + adjustPosition: function(x, y) { + + // Floating Components being positioned in their ownerCt have to be made absolute + if (this.floating && this.floatParent) { + var o = this.floatParent.getTargetEl().getViewRegion(); + x += o.left; + y += o.top; + } + + return { + x: x, + y: y + }; + }, + + /** + * Gets the current XY position of the component's underlying element. + * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false) + * @return {Array} The XY position of the element (e.g., [100, 200]) + */ + getPosition: function(local) { + var el = this.el, + xy; + + if (local === true) { + return [el.getLeft(true), el.getTop(true)]; + } + xy = this.xy || el.getXY(); + + // Floating Components in an ownerCt have to have their positions made relative + if (this.floating && this.floatParent) { + var o = this.floatParent.getTargetEl().getViewRegion(); + xy[0] -= o.left; + xy[1] -= o.top; + } + return xy; + }, + + // Todo: add in xtype prefix support + getId: function() { + return this.id || (this.id = (this.getXType() || 'ext-comp') + '-' + this.getAutoId()); + }, + + onEnable: function() { + var actionEl = this.getActionEl(); + actionEl.dom.removeAttribute('aria-disabled'); + actionEl.dom.disabled = false; + this.callParent(); + }, + + onDisable: function() { + var actionEl = this.getActionEl(); + actionEl.dom.setAttribute('aria-disabled', true); + actionEl.dom.disabled = true; + this.callParent(); + }, + + /** + *
Shows this Component, rendering it first if {@link #autoRender} or {{@link "floating} are true.
+ *
After being shown, a {@link #floating} Component (such as a {@link Ext.window.Window}), is activated it and brought to the front of + * its {@link #ZIndexManager z-index stack}.
+ * @param {String/Element} animateTarget Optional, and only valid for {@link #floating} Components such as + * {@link Ext.window.Window Window}s or {@link Ext.tip.ToolTip ToolTip}s, or regular Components which have been configured + * with floating: true. The target from which the Component should + * animate from while opening (defaults to null with no animation) + * @param {Function} callback (optional) A callback function to call after the Component is displayed. Only necessary if animation was specified. + * @param {Object} scope (optional) The scope (this reference) in which the callback is executed. Defaults to this Component. + * @return {Component} this + */ + show: function(animateTarget, cb, scope) { + if (this.rendered && this.isVisible()) { + if (this.toFrontOnShow && this.floating) { + this.toFront(); + } + } else if (this.fireEvent('beforeshow', this) !== false) { + this.hidden = false; + + // Render on first show if there is an autoRender config, or if this is a floater (Window, Menu, BoundList etc). + if (!this.rendered && (this.autoRender || this.floating)) { + this.doAutoRender(); + } + if (this.rendered) { + this.beforeShow(); + this.onShow.apply(this, arguments); + + // Notify any owning Container unless it's suspended. + // Floating Components do not participate in layouts. + if (this.ownerCt && !this.floating && !(this.ownerCt.suspendLayout || this.ownerCt.layout.layoutBusy)) { + this.ownerCt.doLayout(); + } + this.afterShow.apply(this, arguments); + } + } + return this; + }, + + beforeShow: Ext.emptyFn, + + // Private. Override in subclasses where more complex behaviour is needed. + onShow: function() { + var me = this; + + me.el.show(); + if (this.floating && this.constrain) { + this.doConstrain(); + } + me.callParent(arguments); + }, + + afterShow: function(animateTarget, cb, scope) { + var me = this, + fromBox, + toBox, + ghostPanel; + + // Default to configured animate target if none passed + animateTarget = animateTarget || me.animateTarget; + + // Need to be able to ghost the Component + if (!me.ghost) { + animateTarget = null; + } + // If we're animating, kick of an animation of the ghost from the target to the *Element* current box + if (animateTarget) { + animateTarget = animateTarget.el ? animateTarget.el : Ext.get(animateTarget); + toBox = me.el.getBox(); + fromBox = animateTarget.getBox(); + fromBox.width += 'px'; + fromBox.height += 'px'; + toBox.width += 'px'; + toBox.height += 'px'; + me.el.addCls(Ext.baseCSSPrefix + 'hide-offsets'); + ghostPanel = me.ghost(); + ghostPanel.el.stopAnimation(); + + ghostPanel.el.animate({ + from: fromBox, + to: toBox, + listeners: { + afteranimate: function() { + delete ghostPanel.componentLayout.lastComponentSize; + me.unghost(); + me.el.removeCls(Ext.baseCSSPrefix + 'hide-offsets'); + if (me.floating) { + me.toFront(); + } + Ext.callback(cb, scope || me); + } + } + }); + } + else { + if (me.floating) { + me.toFront(); + } + Ext.callback(cb, scope || me); + } + me.fireEvent('show', me); + }, + + /** + * Hides this Component, setting it to invisible using the configured {@link #hideMode}. + * @param {String/Element/Component} animateTarget Optional, and only valid for {@link #floating} Components such as + * {@link Ext.window.Window Window}s or {@link Ext.tip.ToolTip ToolTip}s, or regular Components which have been configured + * with floating: true.. + * The target to which the Component should animate while hiding (defaults to null with no animation) + * @param {Function} callback (optional) A callback function to call after the Component is hidden. + * @param {Object} scope (optional) The scope (this reference) in which the callback is executed. Defaults to this Component. + * @return {Ext.Component} this + */ + hide: function() { + + // Clear the flag which is set if a floatParent was hidden while this is visible. + // If a hide operation was subsequently called, that pending show must be hidden. + this.showOnParentShow = false; + + if (!(this.rendered && !this.isVisible()) && this.fireEvent('beforehide', this) !== false) { + this.hidden = true; + if (this.rendered) { + this.onHide.apply(this, arguments); + + // Notify any owning Container unless it's suspended. + // Floating Components do not participate in layouts. + if (this.ownerCt && !this.floating && !(this.ownerCt.suspendLayout || this.ownerCt.layout.layoutBusy)) { + this.ownerCt.doLayout(); + } + } + } + return this; + }, + + // Possibly animate down to a target element. + onHide: function(animateTarget, cb, scope) { + var me = this, + ghostPanel, + toBox; + + // Default to configured animate target if none passed + animateTarget = animateTarget || me.animateTarget; + + // Need to be able to ghost the Component + if (!me.ghost) { + animateTarget = null; + } + // If we're animating, kick off an animation of the ghost down to the target + if (animateTarget) { + animateTarget = animateTarget.el ? animateTarget.el : Ext.get(animateTarget); + ghostPanel = me.ghost(); + ghostPanel.el.stopAnimation(); + toBox = animateTarget.getBox(); + toBox.width += 'px'; + toBox.height += 'px'; + ghostPanel.el.animate({ + to: toBox, + listeners: { + afteranimate: function() { + delete ghostPanel.componentLayout.lastComponentSize; + ghostPanel.el.hide(); + me.afterHide(cb, scope); + } + } + }); + } + me.el.hide(); + if (!animateTarget) { + me.afterHide(cb, scope); + } + }, + + afterHide: function(cb, scope) { + Ext.callback(cb, scope || this); + this.fireEvent('hide', this); + }, + + /** + * @private + * Template method to contribute functionality at destroy time. + */ + onDestroy: function() { + var me = this; + + // Ensure that any ancillary components are destroyed. + if (me.rendered) { + Ext.destroy( + me.proxy, + me.resizer + ); + // Different from AbstractComponent + if (me.actionMode == 'container' || me.removeMode == 'container') { + me.container.remove(); + } + } + delete me.focusTask; + me.callParent(); + }, + + deleteMembers: function() { + var args = arguments, + len = args.length, + i = 0; + for (; i < len; ++i) { + delete this[args[i]]; + } + }, + + /** + * Try to focus this component. + * @param {Boolean} selectText (optional) If applicable, true to also select the text in this component + * @param {Boolean/Number} delay (optional) Delay the focus this number of milliseconds (true for 10 milliseconds). + * @return {Ext.Component} this + */ + focus: function(selectText, delay) { + var me = this, + focusEl; + + if (delay) { + if (!me.focusTask) { + me.focusTask = Ext.create('Ext.util.DelayedTask', me.focus); + } + me.focusTask.delay(Ext.isNumber(delay) ? delay : 10, null, me, [selectText, false]); + return me; + } + + if (me.rendered && !me.isDestroyed) { + // getFocusEl could return a Component. + focusEl = me.getFocusEl(); + focusEl.focus(); + if (focusEl.dom && selectText === true) { + focusEl.dom.select(); + } + + // Focusing a floating Component brings it to the front of its stack. + // this is performed by its zIndexManager. Pass preventFocus true to avoid recursion. + if (me.floating) { + me.toFront(true); + } + } + return me; + }, + + /** + * @private + * Returns the focus holder element associated with this Component. By default, this is the Component's encapsulating + * element. Subclasses which use embedded focusable elements (such as Window and Button) should override this for use + * by the {@link #focus} method. + * @returns {Ext.core.Element} the focus holing element. + */ + getFocusEl: function() { + return this.el; + }, + + // private + blur: function() { + if (this.rendered) { + this.getFocusEl().blur(); + } + return this; + }, + + getEl: function() { + return this.el; + }, + + // Deprecate 5.0 + getResizeEl: function() { + return this.el; + }, + + // Deprecate 5.0 + getPositionEl: function() { + return this.el; + }, + + // Deprecate 5.0 + getActionEl: function() { + return this.el; + }, + + // Deprecate 5.0 + getVisibilityEl: function() { + return this.el; + }, + + // Deprecate 5.0 + onResize: Ext.emptyFn, + + // private + getBubbleTarget: function() { + return this.ownerCt; + }, + + // private + getContentTarget: function() { + return this.el; + }, + + /** + * Clone the current component using the original config values passed into this instance by default. + * @param {Object} overrides A new config containing any properties to override in the cloned version. + * An id property can be passed on this object, otherwise one will be generated to avoid duplicates. + * @return {Ext.Component} clone The cloned copy of this component + */ + cloneConfig: function(overrides) { + overrides = overrides || {}; + var id = overrides.id || Ext.id(); + var cfg = Ext.applyIf(overrides, this.initialConfig); + cfg.id = id; + + var self = Ext.getClass(this); + + // prevent dup id + return new self(cfg); + }, + + /** + * Gets the xtype for this component as registered with {@link Ext.ComponentManager}. For a list of all + * available xtypes, see the {@link Ext.Component} header. Example usage: + *
+var t = new Ext.form.field.Text(); +alert(t.getXType()); // alerts 'textfield' +
+ * @return {String} The xtype + */ + getXType: function() { + return this.self.xtype; + }, + + /** + * Find a container above this component at any level by a custom function. If the passed function returns + * true, the container will be returned. + * @param {Function} fn The custom function to call with the arguments (container, this component). + * @return {Ext.container.Container} The first Container for which the custom function returns true + */ + findParentBy: function(fn) { + var p; + + // Iterate up the ownerCt chain until there's no ownerCt, or we find an ancestor which matches using the selector function. + for (p = this.ownerCt; p && !fn(p, this); p = p.ownerCt); + return p || null; + }, + + /** + *
Find a container above this component at any level by xtype or class
+ *
See also the {@link Ext.Component#up up} method.
+ * @param {String/Class} xtype The xtype string for a component, or the class of the component directly + * @return {Ext.container.Container} The first Container which matches the given xtype or class + */ + findParentByType: function(xtype) { + return Ext.isFunction(xtype) ? + this.findParentBy(function(p) { + return p.constructor === xtype; + }) + : + this.up(xtype); + }, + + /** + * Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of + * function call will be the scope provided or the current component. The arguments to the function + * will be the args provided or the current component. 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 of the function (defaults to current node) + * @param {Array} args (optional) The args to call the function with (default to passing the current component) + * @return {Ext.Component} this + */ + bubble: function(fn, scope, args) { + var p = this; + while (p) { + if (fn.apply(scope || p, args || [p]) === false) { + break; + } + p = p.ownerCt; + } + return this; + }, + + getProxy: function() { + if (!this.proxy) { + this.proxy = this.el.createProxy(Ext.baseCSSPrefix + 'proxy-el', Ext.getBody(), true); + } + return this.proxy; + } + +}); + +/** +* @class Ext.layout.container.Container +* @extends Ext.layout.container.AbstractContainer +* @private +*
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.
+*/ +Ext.define('Ext.layout.container.Container', { + + /* Begin Definitions */ + + extend: 'Ext.layout.container.AbstractContainer', + alternateClassName: 'Ext.layout.ContainerLayout', + + /* End Definitions */ + + layoutItem: function(item, box) { + box = box || {}; + if (item.componentLayout.initialized !== true) { + this.setItemSize(item, box.width || item.width || undefined, box.height || item.height || undefined); + // item.doComponentLayout(box.width || item.width || undefined, box.height || item.height || undefined); + } + }, + + getLayoutTargetSize : function() { + var target = this.getTarget(), + ret; + + if (target) { + ret = target.getViewSize(); + + // IE in will sometimes return a width of 0 on the 1st pass of getViewSize. + // Use getStyleSize to verify the 0 width, the adjustment pass will then work properly + // with getViewSize + if (Ext.isIE && ret.width == 0){ + ret = target.getStyleSize(); + } + + ret.width -= target.getPadding('lr'); + ret.height -= target.getPadding('tb'); + } + return ret; + }, + + beforeLayout: function() { + if (this.owner.beforeLayout(arguments) !== false) { + return this.callParent(arguments); + } + else { + return false; + } + }, + + afterLayout: function() { + this.owner.afterLayout(arguments); + this.callParent(arguments); + }, + + /** + * @protected + * Returns all items that are rendered + * @return {Array} All matching items + */ + getRenderedItems: function() { + var me = this, + target = me.getTarget(), + items = me.getLayoutItems(), + ln = items.length, + renderedItems = [], + i, item; + + for (i = 0; i < ln; i++) { + item = items[i]; + if (item.rendered && me.isValidParent(item, target, i)) { + renderedItems.push(item); + } + } + + return renderedItems; + }, + + /** + * @protected + * Returns all items that are both rendered and visible + * @return {Array} All matching items + */ + getVisibleItems: function() { + var target = this.getTarget(), + items = this.getLayoutItems(), + ln = items.length, + visibleItems = [], + i, item; + + for (i = 0; i < ln; i++) { + item = items[i]; + if (item.rendered && this.isValidParent(item, target, i) && item.hidden !== true) { + visibleItems.push(item); + } + } + + return visibleItems; + } +}); +/** + * @class Ext.layout.container.Auto + * @extends Ext.layout.container.Container + * + *
The AutoLayout is the default layout manager delegated by {@link Ext.container.Container} to + * render any child Components when no {@link Ext.container.Container#layout layout} is configured into + * a {@link Ext.container.Container Container}.. AutoLayout provides only a passthrough of any layout calls + * to any child containers.
+ * {@img Ext.layout.container.Auto/Ext.layout.container.Auto.png Ext.layout.container.Auto container layout} + * Example usage: + Ext.create('Ext.Panel', { + width: 500, + height: 280, + title: "AutoLayout Panel", + layout: 'auto', + renderTo: document.body, + items: [{ + xtype: 'panel', + title: 'Top Inner Panel', + width: '75%', + height: 90 + },{ + xtype: 'panel', + title: 'Bottom Inner Panel', + width: '75%', + height: 90 + }] + }); + */ + +Ext.define('Ext.layout.container.Auto', { + + /* Begin Definitions */ + + alias: ['layout.auto', 'layout.autocontainer'], + + extend: 'Ext.layout.container.Container', + + /* End Definitions */ + + type: 'autocontainer', + + fixedLayout: false, + + bindToOwnerCtComponent: true, + + // @private + onLayout : function(owner, target) { + var me = this, + items = me.getLayoutItems(), + ln = items.length, + i; + + // Ensure the Container is only primed with the clear element if there are child items. + if (ln) { + // Auto 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 = me.getRenderTarget().createChild({ + cls: Ext.baseCSSPrefix + 'clear', + role: 'presentation' + }); + } + + // Auto layout allows CSS to size its child items. + for (i = 0; i < ln; i++) { + me.setItemSize(items[i]); + } + } + } +}); +/** + * @class Ext.container.AbstractContainer + * @extends Ext.Component + *
An abstract base class which provides shared methods for Containers across the Sencha product line.
+ * Please refer to sub class's documentation + */ +Ext.define('Ext.container.AbstractContainer', { + + /* Begin Definitions */ + + extend: 'Ext.Component', + + requires: [ + 'Ext.util.MixedCollection', + 'Ext.layout.container.Auto', + 'Ext.ZIndexManager' + ], + + /* End Definitions */ + /** + * @cfg {String/Object} layout + *
*Important: In order for child items to be correctly sized and + * positioned, typically a layout manager must be specified through + * the layout configuration option.
+ *
The sizing and positioning of child {@link #items} is the responsibility of + * the Container's layout manager which creates and manages the type of layout + * you have in mind. For example:
+ *
If the {@link #layout} configuration is not explicitly specified for + * a general purpose container (e.g. Container or Panel) the + * {@link Ext.layout.container.Auto default layout manager} will be used + * which does nothing but render child components sequentially into the + * Container (no sizing or positioning will be performed in this situation).
+ *
layout may be specified as either as an Object or + * as a String:
+ * + *
Specify as an Object
+ *
+ *
Example usage:
+ *
+layout: { + type: 'vbox', + align: 'left' +} +
+ * + *
type
+ *
The layout type to be used for this container. If not specified, + * a default {@link Ext.layout.container.Auto} will be created and used.
+ *
Valid layout type values are:
+ *
+ *
{@link Ext.layout.container.Auto Auto}     Default
+ *
{@link Ext.layout.container.Card card}
+ *
{@link Ext.layout.container.Fit fit}
+ *
{@link Ext.layout.container.HBox hbox}
+ *
{@link Ext.layout.container.VBox vbox}
+ *
{@link Ext.layout.container.Anchor anchor}
+ *
{@link Ext.layout.container.Table table}
+ *
+ * + *
Layout specific configuration properties
+ *
Additional layout specific configuration properties may also be + * specified. For complete details regarding the valid config options for + * each layout type, see the layout class corresponding to the type + * specified.
+ * + *
+ * + *
Specify as a String
+ *
+ *
Example usage:
+ *
+layout: { + type: 'vbox', + padding: '5', + align: 'left' +} +
+ *
layout
+ *
The layout type to be used for this container (see list + * of valid layout type values above).

+ *
Additional layout specific configuration properties. For complete + * details regarding the valid config options for each layout type, see the + * layout class corresponding to the layout specified.
+ *
+ */ + + /** + * @cfg {String/Number} activeItem + * A string component id or the numeric index of the component that should be initially activated within the + * container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first + * item in the container's collection). activeItem only applies to layout styles that can display + * items one at a time (like {@link Ext.layout.container.Card} and {@link Ext.layout.container.Fit}). + */ + /** + * @cfg {Object/Array} items + *
A single item, or an array of child Components to be added to this container
+ *
Unless configured with a {@link #layout}, a Container simply renders child Components serially into + * its encapsulating element and performs no sizing or positioning upon them.
+ *
Example:
+ *
+// specifying a single item +items: {...}, +layout: 'fit', // The single items is sized to fit + +// specifying multiple items +items: [{...}, {...}], +layout: 'hbox', // The items are arranged horizontally +
+ *
Each item may be:
+ *
+ *
A {@link Ext.Component Component}
+ *
A Component configuration object
+ *
+ *
If a configuration object is specified, the actual type of Component to be + * instantiated my be indicated by using the {@link Ext.Component#xtype xtype} option.
+ *
Every Component class has its own {@link Ext.Component#xtype xtype}.
+ *
If an {@link Ext.Component#xtype xtype} is not explicitly + * specified, the {@link #defaultType} for the Container is used, which by default is usually panel.
+ *
Notes:
+ *
Ext uses lazy rendering. Child Components will only be rendered + * should it become necessary. Items are automatically laid out when they are first + * shown (no sizing is done while hidden), or in response to a {@link #doLayout} call.
+ *
Do not specify {@link Ext.panel.Panel#contentEl contentEl} or + * {@link Ext.panel.Panel#html html} with items.
+ */ + /** + * @cfg {Object|Function} defaults + *
This option is a means of applying default settings to all added items whether added through the {@link #items} + * config or via the {@link #add} or {@link #insert} methods.
+ *
If an added item is a config object, and not an instantiated Component, then the default properties are + * unconditionally applied. If the added item is an instantiated Component, then the default properties are + * applied conditionally so as not to override existing properties in the item.
+ *
If the defaults option is specified as a function, then the function will be called using this Container as the + * scope (this reference) and passing the added item as the first parameter. Any resulting object + * from that call is then applied to the item as default properties.
+ *
For example, to automatically apply padding to the body of each of a set of + * contained {@link Ext.panel.Panel} items, you could pass: defaults: {bodyStyle:'padding:15px'}.
+ *
Usage:
+defaults: { // defaults are applied to items, not the container + autoScroll:true +}, +items: [ + { + xtype: 'panel', // defaults do not have precedence over + id: 'panel1', // options in config objects, so the defaults + autoScroll: false // will not be applied here, panel1 will be autoScroll:false + }, + new Ext.panel.Panel({ // defaults do have precedence over options + id: 'panel2', // options in components, so the defaults + autoScroll: false // will be applied here, panel2 will be autoScroll:true. + }) +]
+ */ + + /** @cfg {Boolean} suspendLayout + * If true, suspend calls to doLayout. Useful when batching multiple adds to a container and not passing them + * as multiple arguments or an array. + */ + suspendLayout : false, + + /** @cfg {Boolean} autoDestroy + * If true the container will automatically destroy any contained component that is removed from it, else + * destruction must be handled manually. + * Defaults to true. + */ + autoDestroy : true, + + /** @cfg {String} defaultType + *
The default {@link Ext.Component xtype} of child Components to create in this Container when + * a child item is specified as a raw configuration object, rather than as an instantiated Component.
+ *
Defaults to 'panel'.
+ */ + defaultType: 'panel', + + isContainer : true, + + baseCls: Ext.baseCSSPrefix + 'container', + + /** + * @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 ['add', 'remove']. + */ + bubbleEvents: ['add', 'remove'], + + // @private + initComponent : function(){ + var me = this; + me.addEvents( + /** + * @event afterlayout + * Fires when the components in this container are arranged by the associated layout manager. + * @param {Ext.container.Container} this + * @param {ContainerLayout} layout The ContainerLayout implementation for this container + */ + 'afterlayout', + /** + * @event beforeadd + * Fires before any {@link Ext.Component} is added or inserted into the container. + * A handler can return false to cancel the add. + * @param {Ext.container.Container} this + * @param {Ext.Component} component The component being added + * @param {Number} index The index at which the component will be added to the container's items collection + */ + 'beforeadd', + /** + * @event beforeremove + * Fires before any {@link Ext.Component} is removed from the container. A handler can return + * false to cancel the remove. + * @param {Ext.container.Container} this + * @param {Ext.Component} component The component being removed + */ + 'beforeremove', + /** + * @event add + * @bubbles + * Fires after any {@link Ext.Component} is added or inserted into the container. + * @param {Ext.container.Container} this + * @param {Ext.Component} component The component that was added + * @param {Number} index The index at which the component was added to the container's items collection + */ + 'add', + /** + * @event remove + * @bubbles + * Fires after any {@link Ext.Component} is removed from the container. + * @param {Ext.container.Container} this + * @param {Ext.Component} component The component that was removed + */ + 'remove', + /** + * @event beforecardswitch + * Fires before this container switches the active card. This event + * is only available if this container uses a CardLayout. Note that + * TabPanel and Carousel both get a CardLayout by default, so both + * will have this event. + * A handler can return false to cancel the card switch. + * @param {Ext.container.Container} this + * @param {Ext.Component} newCard The card that will be switched to + * @param {Ext.Component} oldCard The card that will be switched from + * @param {Number} index The index of the card that will be switched to + * @param {Boolean} animated True if this cardswitch will be animated + */ + 'beforecardswitch', + /** + * @event cardswitch + * Fires after this container switches the active card. If the card + * is switched using an animation, this event will fire after the + * animation has finished. This event is only available if this container + * uses a CardLayout. Note that TabPanel and Carousel both get a CardLayout + * by default, so both will have this event. + * @param {Ext.container.Container} this + * @param {Ext.Component} newCard The card that has been switched to + * @param {Ext.Component} oldCard The card that has been switched from + * @param {Number} index The index of the card that has been switched to + * @param {Boolean} animated True if this cardswitch was animated + */ + 'cardswitch' + ); + + // layoutOnShow stack + me.layoutOnShow = Ext.create('Ext.util.MixedCollection'); + me.callParent(); + me.initItems(); + }, + + // @private + initItems : function() { + var me = this, + items = me.items; + + /** + * The MixedCollection containing all the child items of this container. + * @property items + * @type Ext.util.MixedCollection + */ + me.items = Ext.create('Ext.util.MixedCollection', false, me.getComponentId); + + if (items) { + if (!Ext.isArray(items)) { + items = [items]; + } + + me.add(items); + } + }, + + // @private + afterRender : function() { + this.getLayout(); + this.callParent(); + }, + + // @private + setLayout : function(layout) { + var currentLayout = this.layout; + + if (currentLayout && currentLayout.isLayout && currentLayout != layout) { + currentLayout.setOwner(null); + } + + this.layout = layout; + layout.setOwner(this); + }, + + /** + * Returns the {@link Ext.layout.container.AbstractContainer layout} instance currently associated with this Container. + * If a layout has not been instantiated yet, that is done first + * @return {Ext.layout.container.AbstractContainer} The layout + */ + getLayout : function() { + var me = this; + if (!me.layout || !me.layout.isLayout) { + me.setLayout(Ext.layout.Layout.create(me.layout, 'autocontainer')); + } + + return me.layout; + }, + + /** + * Manually force this container's layout to be recalculated. The framwork uses this internally to refresh layouts + * form most cases. + * @return {Ext.container.Container} this + */ + doLayout : function() { + var me = this, + layout = me.getLayout(); + + if (me.rendered && layout && !me.suspendLayout) { + // If either dimension is being auto-set, then it requires a ComponentLayout to be run. + if ((!Ext.isNumber(me.width) || !Ext.isNumber(me.height)) && me.componentLayout.type !== 'autocomponent') { + // Only run the ComponentLayout if it is not already in progress + if (me.componentLayout.layoutBusy !== true) { + me.doComponentLayout(); + if (me.componentLayout.layoutCancelled === true) { + layout.layout(); + } + } + } + // Both dimensions defined, run a ContainerLayout + else { + // Only run the ContainerLayout if it is not already in progress + if (layout.layoutBusy !== true) { + layout.layout(); + } + } + } + + return me; + }, + + // @private + afterLayout : function(layout) { + this.fireEvent('afterlayout', this, layout); + }, + + // @private + prepareItems : function(items, applyDefaults) { + if (!Ext.isArray(items)) { + items = [items]; + } + + // Make sure defaults are applied and item is initialized + var i = 0, + len = items.length, + item; + + for (; i < len; i++) { + item = items[i]; + if (applyDefaults) { + item = this.applyDefaults(item); + } + items[i] = this.lookupComponent(item); + } + return items; + }, + + // @private + applyDefaults : function(config) { + var defaults = this.defaults; + + if (defaults) { + if (Ext.isFunction(defaults)) { + defaults = defaults.call(this, config); + } + + if (Ext.isString(config)) { + config = Ext.ComponentManager.get(config); + Ext.applyIf(config, defaults); + } else if (!config.isComponent) { + Ext.applyIf(config, defaults); + } else { + Ext.applyIf(config, defaults); + } + } + + return config; + }, + + // @private + lookupComponent : function(comp) { + return Ext.isString(comp) ? Ext.ComponentManager.get(comp) : this.createComponent(comp); + }, + + // @private + createComponent : function(config, defaultType) { + // // add in ownerCt at creation time but then immediately + // // remove so that onBeforeAdd can handle it + // var component = Ext.create(Ext.apply({ownerCt: this}, config), defaultType || this.defaultType); + // + // delete component.initialConfig.ownerCt; + // delete component.ownerCt; + + return Ext.ComponentManager.create(config, defaultType || this.defaultType); + }, + + // @private - used as the key lookup function for the items collection + getComponentId : function(comp) { + return comp.getItemId(); + }, + + /** + +Adds {@link Ext.Component Component}(s) to this Container. + +##Description:## + +- Fires the {@link #beforeadd} event before adding. +- The Container's {@link #defaults default config values} will be applied + accordingly (see `{@link #defaults}` for details). +- Fires the `{@link #add}` event after the component has been added. + +##Notes:## + +If the Container is __already rendered__ when `add` +is called, it will render the newly added Component into its content area. + +__**If**__ the Container was configured with a size-managing {@link #layout} manager, the Container +will recalculate its internal layout at this time too. + +Note that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing. + +If adding multiple new child Components, pass them as an array to the `add` method, so that only one layout recalculation is performed. + + tb = new {@link Ext.toolbar.Toolbar}({ + renderTo: document.body + }); // toolbar is rendered + tb.add([{text:'Button 1'}, {text:'Button 2'}]); // add multiple items. ({@link #defaultType} for {@link Ext.toolbar.Toolbar Toolbar} is 'button') + +##Warning:## + +Components directly managed by the BorderLayout layout manager +may not be removed or added. See the Notes for {@link Ext.layout.container.Border BorderLayout} +for more details. + + * @param {...Object/Array} Component + * Either one or more Components to add or an Array of Components to add. + * See `{@link #items}` for additional information. + * + * @return {Ext.Component/Array} The Components that were added. + * @markdown + */ + add : function() { + var me = this, + args = Array.prototype.slice.call(arguments), + hasMultipleArgs, + items, + results = [], + i, + ln, + item, + index = -1, + cmp; + + if (typeof args[0] == 'number') { + index = args.shift(); + } + + hasMultipleArgs = args.length > 1; + if (hasMultipleArgs || Ext.isArray(args[0])) { + + items = hasMultipleArgs ? args : args[0]; + // Suspend Layouts while we add multiple items to the container + me.suspendLayout = true; + for (i = 0, ln = items.length; i < ln; i++) { + item = items[i]; + + if (!item) { + Ext.Error.raise("Trying to add a null item as a child of Container with itemId/id: " + me.getItemId()); + } + + if (index != -1) { + item = me.add(index + i, item); + } else { + item = me.add(item); + } + results.push(item); + } + // Resume Layouts now that all items have been added and do a single layout for all the items just added + me.suspendLayout = false; + me.doLayout(); + return results; + } + + cmp = me.prepareItems(args[0], true)[0]; + + // Floating Components are not added into the items collection + // But they do get an upward ownerCt link so that they can traverse + // up to their z-index parent. + if (cmp.floating) { + cmp.onAdded(me, index); + } else { + index = (index !== -1) ? index : me.items.length; + if (me.fireEvent('beforeadd', me, cmp, index) !== false && me.onBeforeAdd(cmp) !== false) { + me.items.insert(index, cmp); + cmp.onAdded(me, index); + me.onAdd(cmp, index); + me.fireEvent('add', me, cmp, index); + } + me.doLayout(); + } + return cmp; + }, + + /** + * @private + *
Called by Component#doAutoRender
+ *
Register a Container configured floating: true with this Container's {@link Ext.ZIndexManager ZIndexManager}.
+ *
Components added in ths way will not participate in the layout, but will be rendered + * upon first show in the way that {@link Ext.window.Window Window}s are.
+ *
+ */ + registerFloatingItem: function(cmp) { + var me = this; + if (!me.floatingItems) { + me.floatingItems = Ext.create('Ext.ZIndexManager', me); + } + me.floatingItems.register(cmp); + }, + + onAdd : Ext.emptyFn, + onRemove : Ext.emptyFn, + + /** + * Inserts a Component into this Container at a specified index. Fires the + * {@link #beforeadd} event before inserting, then fires the {@link #add} event after the + * Component has been inserted. + * @param {Number} index The index at which the Component will be inserted + * into the Container's items collection + * @param {Ext.Component} component The child Component to insert.

+ * Ext uses lazy rendering, and will only render the inserted Component should + * it become necessary.

+ * A Component config object may be passed in order to avoid the overhead of + * constructing a real Component object if lazy rendering might mean that the + * inserted Component will not be rendered immediately. To take advantage of + * this 'lazy instantiation', set the {@link Ext.Component#xtype} config + * property to the registered type of the Component wanted.

+ * For a list of all available xtypes, see {@link Ext.Component}. + * @return {Ext.Component} component The Component (or config object) that was + * inserted with the Container's default config values applied. + */ + insert : function(index, comp) { + return this.add(index, comp); + }, + + /** + * Moves a Component within the Container + * @param {Number} fromIdx The index the Component you wish to move is currently at. + * @param {Number} toIdx The new index for the Component. + * @return {Ext.Component} component The Component (or config object) that was moved. + */ + move : function(fromIdx, toIdx) { + var items = this.items, + item; + item = items.removeAt(fromIdx); + if (item === false) { + return false; + } + items.insert(toIdx, item); + this.doLayout(); + return item; + }, + + // @private + onBeforeAdd : function(item) { + var me = this; + + if (item.ownerCt) { + item.ownerCt.remove(item, false); + } + + if (me.border === false || me.border === 0) { + item.border = (item.border === true); + } + }, + + /** + * Removes a component from this container. Fires the {@link #beforeremove} event before removing, then fires + * the {@link #remove} event after the component has been removed. + * @param {Component/String} component The component reference or id to remove. + * @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function. + * Defaults to the value of this Container's {@link #autoDestroy} config. + * @return {Ext.Component} component The Component that was removed. + */ + remove : function(comp, autoDestroy) { + var me = this, + c = me.getComponent(comp); + if (Ext.isDefined(Ext.global.console) && !c) { + console.warn("Attempted to remove a component that does not exist. Ext.container.Container: remove takes an argument of the component to remove. cmp.remove() is incorrect usage."); + } + + if (c && me.fireEvent('beforeremove', me, c) !== false) { + me.doRemove(c, autoDestroy); + me.fireEvent('remove', me, c); + } + + return c; + }, + + // @private + doRemove : function(component, autoDestroy) { + var me = this, + layout = me.layout, + hasLayout = layout && me.rendered; + + me.items.remove(component); + component.onRemoved(); + + if (hasLayout) { + layout.onRemove(component); + } + + me.onRemove(component, autoDestroy); + + if (autoDestroy === true || (autoDestroy !== false && me.autoDestroy)) { + component.destroy(); + } + + if (hasLayout && !autoDestroy) { + layout.afterRemove(component); + } + + if (!me.destroying) { + me.doLayout(); + } + }, + + /** + * Removes all components from this container. + * @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function. + * Defaults to the value of this Container's {@link #autoDestroy} config. + * @return {Array} Array of the destroyed components + */ + removeAll : function(autoDestroy) { + var me = this, + removeItems = me.items.items.slice(), + items = [], + i = 0, + len = removeItems.length, + item; + + // Suspend Layouts while we remove multiple items from the container + me.suspendLayout = true; + for (; i < len; i++) { + item = removeItems[i]; + me.remove(item, autoDestroy); + + if (item.ownerCt !== me) { + items.push(item); + } + } + + // Resume Layouts now that all items have been removed and do a single layout + me.suspendLayout = false; + me.doLayout(); + return items; + }, + + // Used by ComponentQuery to retrieve all of the items + // which can potentially be considered a child of this Container. + // This should be overriden by components which have child items + // that are not contained in items. For example dockedItems, menu, etc + // IMPORTANT note for maintainers: + // Items are returned in tree traversal order. Each item is appended to the result array + // followed by the results of that child's getRefItems call. + // Floating child items are appended after internal child items. + getRefItems : function(deep) { + var me = this, + items = me.items.items, + len = items.length, + i = 0, + item, + result = []; + + for (; i < len; i++) { + item = items[i]; + result.push(item); + if (deep && item.getRefItems) { + result.push.apply(result, item.getRefItems(true)); + } + } + + // Append floating items to the list. + // These will only be present after they are rendered. + if (me.floatingItems && me.floatingItems.accessList) { + result.push.apply(result, me.floatingItems.accessList); + } + + return result; + }, + + /** + * Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with + * each component. The scope (this reference) of the + * function call will be the scope provided or the current component. The arguments to the function + * will be the args provided or the current component. 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 of the function (defaults to current component) + * @param {Array} args (optional) The args to call the function with. The current component always passed as the last argument. + * @return {Ext.Container} this + */ + cascade : function(fn, scope, origArgs){ + var me = this, + cs = me.items ? me.items.items : [], + len = cs.length, + i = 0, + c, + args = origArgs ? origArgs.concat(me) : [me], + componentIndex = args.length - 1; + + if (fn.apply(scope || me, args) !== false) { + for(; i < len; i++){ + c = cs[i]; + if (c.cascade) { + c.cascade(fn, scope, origArgs); + } else { + args[componentIndex] = c; + fn.apply(scope || cs, args); + } + } + } + return this; + }, + + /** + * Examines this container's {@link #items} property + * and gets a direct child component of this container. + * @param {String/Number} comp 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 #items} property
+ *
+ *
For additional information see {@link Ext.util.MixedCollection#get}. + * @return Ext.Component The component (if found). + */ + getComponent : function(comp) { + if (Ext.isObject(comp)) { + comp = comp.getItemId(); + } + + return this.items.get(comp); + }, + + /** + * Retrieves all descendant components which match the passed selector. + * Executes an Ext.ComponentQuery.query using this container as its root. + * @param {String} selector Selector complying to an Ext.ComponentQuery selector + * @return {Array} Ext.Component's which matched the selector + */ + query : function(selector) { + return Ext.ComponentQuery.query(selector, this); + }, + + /** + * Retrieves the first direct child of this container which matches the passed selector. + * The passed in selector must comply with an Ext.ComponentQuery selector. + * @param {String} selector An Ext.ComponentQuery selector + * @return Ext.Component + */ + child : function(selector) { + return this.query('> ' + selector)[0] || null; + }, + + /** + * Retrieves the first descendant of this container which matches the passed selector. + * The passed in selector must comply with an Ext.ComponentQuery selector. + * @param {String} selector An Ext.ComponentQuery selector + * @return Ext.Component + */ + down : function(selector) { + return this.query(selector)[0] || null; + }, + + // inherit docs + show : function() { + this.callParent(arguments); + this.performDeferredLayouts(); + return this; + }, + + // Lay out any descendant containers who queued a layout operation during the time this was hidden + // This is also called by Panel after it expands because descendants of a collapsed Panel allso queue any layout ops. + performDeferredLayouts: function() { + var layoutCollection = this.layoutOnShow, + ln = layoutCollection.getCount(), + i = 0, + needsLayout, + item; + + for (; i < ln; i++) { + item = layoutCollection.get(i); + needsLayout = item.needsLayout; + + if (Ext.isObject(needsLayout)) { + item.doComponentLayout(needsLayout.width, needsLayout.height, needsLayout.isSetSize, needsLayout.ownerCt); + } + } + layoutCollection.clear(); + }, + + //@private + // Enable all immediate children that was previously disabled + onEnable: function() { + Ext.Array.each(this.query('[isFormField]'), function(item) { + if (item.resetDisable) { + item.enable(); + delete item.resetDisable; + } + }); + this.callParent(); + }, + + // @private + // Disable all immediate children that was previously disabled + onDisable: function() { + Ext.Array.each(this.query('[isFormField]'), function(item) { + if (item.resetDisable !== false && !item.disabled) { + item.disable(); + item.resetDisable = true; + } + }); + this.callParent(); + }, + + /** + * Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout + * from being executed. + */ + beforeLayout: function() { + return true; + }, + + // @private + beforeDestroy : function() { + var me = this, + items = me.items, + c; + + if (items) { + while ((c = items.first())) { + me.doRemove(c, true); + } + } + + Ext.destroy( + me.layout, + me.floatingItems + ); + me.callParent(); + } +}); +/** + * @class Ext.container.Container + * @extends Ext.container.AbstractContainer + *
Base class for any {@link Ext.Component} that may contain other Components. Containers handle the + * basic behavior of containing items, namely adding, inserting and removing items.
+ * + *
The most commonly used Container classes are {@link Ext.panel.Panel}, {@link Ext.window.Window} and {@link Ext.tab.Panel}. + * If you do not need the capabilities offered by the aforementioned classes you can create a lightweight + * Container to be encapsulated by an HTML element to your specifications by using the + * {@link Ext.Component#autoEl autoEl} config option.
+ * + * {@img Ext.Container/Ext.Container.png Ext.Container component} + *
The code below illustrates how to explicitly create a Container:
+// explicitly create a Container +Ext.create('Ext.container.Container', { + layout: { + type: 'hbox' + }, + width: 400, + renderTo: Ext.getBody(), + border: 1, + style: {borderColor:'#000000', borderStyle:'solid', borderWidth:'1px'}, + defaults: { + labelWidth: 80, + // implicitly create Container by specifying xtype + xtype: 'datefield', + flex: 1, + style: { + padding: '10px' + } + }, + items: [{ + xtype: 'datefield', + name: 'startDate', + fieldLabel: 'Start date' + },{ + xtype: 'datefield', + name: 'endDate', + fieldLabel: 'End date' + }] +}); +
+ * + *
Layout
+ *
Container classes delegate the rendering of child Components to a layout + * manager class which must be configured into the Container using the + * {@link #layout} configuration property.
+ *
When either specifying child {@link #items} of a Container, + * or dynamically {@link #add adding} Components to a Container, remember to + * consider how you wish the Container to arrange those child elements, and + * whether those child elements need to be sized using one of Ext's built-in + * {@link #layout} schemes. By default, Containers use the + * {@link Ext.layout.container.Auto Auto} scheme which only + * renders child components, appending them one after the other inside the + * Container, and does not apply any sizing at all.
+ *
A common mistake is when a developer neglects to specify a + * {@link #layout} (e.g. widgets like GridPanels or + * TreePanels are added to Containers for which no {@link #layout} + * has been specified). If a Container is left to use the default + * {Ext.layout.container.Auto Auto} scheme, none of its + * child components will be resized, or changed in any way when the Container + * is resized.
+ *
Certain layout managers allow dynamic addition of child components. + * Those that do include {@link Ext.layout.container.Card}, + * {@link Ext.layout.container.Anchor}, {@link Ext.layout.container.VBox}, {@link Ext.layout.container.HBox}, and + * {@link Ext.layout.container.Table}. For example:
+// Create the GridPanel. +var myNewGrid = new Ext.grid.Panel({ + store: myStore, + headers: myHeaders, + title: 'Results', // the title becomes the title of the tab +}); + +myTabPanel.add(myNewGrid); // {@link Ext.tab.Panel} implicitly uses {@link Ext.layout.container.Card Card} +myTabPanel.{@link Ext.tab.Panel#setActiveTab setActiveTab}(myNewGrid); + *
+ *
The example above adds a newly created GridPanel to a TabPanel. Note that + * a TabPanel uses {@link Ext.layout.container.Card} as its layout manager which + * means all its child items are sized to {@link Ext.layout.container.Fit fit} + * exactly into its client area. + *
Overnesting is a common problem. + * An example of overnesting occurs when a GridPanel is added to a TabPanel + * by wrapping the GridPanel inside a wrapping Panel (that has no + * {@link #layout} specified) and then add that wrapping Panel + * to the TabPanel. The point to realize is that a GridPanel is a + * Component which can be added directly to a Container. If the wrapping Panel + * has no {@link #layout} configuration, then the overnested + * GridPanel will not be sized as expected.
+ * + *
Adding via remote configuration
+ * + *
A server side script can be used to add Components which are generated dynamically on the server. + * An example of adding a GridPanel to a TabPanel where the GridPanel is generated by the server + * based on certain parameters: + *
+// execute an Ajax request to invoke server side script: +Ext.Ajax.request({ + url: 'gen-invoice-grid.php', + // send additional parameters to instruct server script + params: { + startDate: Ext.getCmp('start-date').getValue(), + endDate: Ext.getCmp('end-date').getValue() + }, + // process the response object to add it to the TabPanel: + success: function(xhr) { + var newComponent = eval(xhr.responseText); // see discussion below + myTabPanel.add(newComponent); // add the component to the TabPanel + myTabPanel.setActiveTab(newComponent); + }, + failure: function() { + Ext.Msg.alert("Grid create failed", "Server communication failure"); + } +}); +
+ *
The server script needs to return a JSON representation of a configuration object, which, when decoded + * will return a config object with an {@link Ext.Component#xtype xtype}. The server might return the following + * JSON:
+{ + "xtype": 'grid', + "title": 'Invoice Report', + "store": { + "model": 'Invoice', + "proxy": { + "type": 'ajax', + "url": 'get-invoice-data.php', + "reader": { + "type": 'json' + "record": 'transaction', + "idProperty": 'id', + "totalRecords": 'total' + }) + }, + "autoLoad": { + "params": { + "startDate": '01/01/2008', + "endDate": '01/31/2008' + } + } + }, + "headers": [ + {"header": "Customer", "width": 250, "dataIndex": 'customer', "sortable": true}, + {"header": "Invoice Number", "width": 120, "dataIndex": 'invNo', "sortable": true}, + {"header": "Invoice Date", "width": 100, "dataIndex": 'date', "renderer": Ext.util.Format.dateRenderer('M d, y'), "sortable": true}, + {"header": "Value", "width": 120, "dataIndex": 'value', "renderer": 'usMoney', "sortable": true} + ] +} +
+ *
When the above code fragment is passed through the eval function in the success handler + * of the Ajax request, the result will be a config object which, when added to a Container, will cause instantiation + * of a GridPanel. Be sure that the Container is configured with a layout which sizes and positions the child items to your requirements.
+ *
Note: since the code above is generated by a server script, the autoLoad params for + * the Store, the user's preferred date format, the metadata to allow generation of the Model layout, and the ColumnModel + * can all be generated into the code since these are all known on the server.
+ * + * @xtype container + */ +Ext.define('Ext.container.Container', { + extend: 'Ext.container.AbstractContainer', + alias: 'widget.container', + alternateClassName: 'Ext.Container', + + /** + * Return the immediate child Component in which the passed element is located. + * @param el The element to test. + * @return {Component} The child item which contains the passed element. + */ + getChildByElement: function(el) { + var item, + itemEl, + i = 0, + it = this.items.items, + ln = it.length; + + el = Ext.getDom(el); + for (; i < ln; i++) { + item = it[i]; + itemEl = item.getEl(); + if ((itemEl.dom === el) || itemEl.contains(el)) { + return item; + } + } + return null; + } +}); + +/** + * @class Ext.toolbar.Fill + * @extends Ext.Component + * + * A non-rendering placeholder item which instructs the Toolbar's Layout to begin using + * the right-justified button container. + * + * {@img Ext.toolbar.Fill/Ext.toolbar.Fill.png Toolbar Fill} + * + * ## Example + * + * Ext.create('Ext.panel.Panel', { + * title: 'Toolbar Fill Example', + * width: 300, + * height: 200, + * tbar : [ + * 'Item 1', + * {xtype: 'tbfill'}, // or '->' + * 'Item 2' + * ], + * renderTo: Ext.getBody() + * }); + * + * @constructor + * Creates a new Fill + * @xtype tbfill + */ +Ext.define('Ext.toolbar.Fill', { + extend: 'Ext.Component', + alias: 'widget.tbfill', + alternateClassName: 'Ext.Toolbar.Fill', + isFill : true, + flex: 1 +}); +/** + * @class Ext.toolbar.Item + * @extends Ext.Component + * 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 + */ +Ext.define('Ext.toolbar.Item', { + extend: 'Ext.Component', + alias: 'widget.tbitem', + alternateClassName: 'Ext.Toolbar.Item', + enable:Ext.emptyFn, + disable:Ext.emptyFn, + focus:Ext.emptyFn + /** + * @cfg {String} overflowText Text to be used for the menu if the item is overflowed. + */ +}); +/** + * @class Ext.toolbar.Separator + * @extends Ext.toolbar.Item + * A simple class that adds a vertical separator bar between toolbar items + * (css class:'x-toolbar-separator'). + * + * {@img Ext.toolbar.Separator/Ext.toolbar.Separator.png Toolbar Separator} + * + * ## Example + * + * Ext.create('Ext.panel.Panel', { + * title: 'Toolbar Seperator Example', + * width: 300, + * height: 200, + * tbar : [ + * 'Item 1', + * {xtype: 'tbseparator'}, // or '-' + * 'Item 2' + * ], + * renderTo: Ext.getBody() + * }); + * + * @constructor + * Creates a new Separator + * @xtype tbseparator + */ +Ext.define('Ext.toolbar.Separator', { + extend: 'Ext.toolbar.Item', + alias: 'widget.tbseparator', + alternateClassName: 'Ext.Toolbar.Separator', + baseCls: Ext.baseCSSPrefix + 'toolbar-separator', + focusable: false +}); +/** + * @class Ext.menu.Manager + * Provides a common registry of all menus on a page. + * @singleton + */ +Ext.define('Ext.menu.Manager', { + singleton: true, + requires: [ + 'Ext.util.MixedCollection', + 'Ext.util.KeyMap' + ], + alternateClassName: 'Ext.menu.MenuMgr', + + uses: ['Ext.menu.Menu'], + + menus: {}, + groups: {}, + attached: false, + lastShow: new Date(), + + init: function() { + var me = this; + + me.active = Ext.create('Ext.util.MixedCollection'); + Ext.getDoc().addKeyListener(27, function() { + if (me.active.length > 0) { + me.hideAll(); + } + }, me); + }, + + /** + * Hides all menus that are currently visible + * @return {Boolean} success True if any active menus were hidden. + */ + hideAll: function() { + var active = this.active, + c; + if (active && active.length > 0) { + c = active.clone(); + c.each(function(m) { + m.hide(); + }); + return true; + } + return false; + }, + + onHide: function(m) { + var me = this, + active = me.active; + active.remove(m); + if (active.length < 1) { + Ext.getDoc().un('mousedown', me.onMouseDown, me); + me.attached = false; + } + }, + + onShow: function(m) { + var me = this, + active = me.active, + last = active.last(), + attached = me.attached, + menuEl = m.getEl(), + zIndex; + + me.lastShow = new Date(); + active.add(m); + if (!attached) { + Ext.getDoc().on('mousedown', me.onMouseDown, me); + me.attached = true; + } + m.toFront(); + }, + + onBeforeHide: function(m) { + if (m.activeChild) { + m.activeChild.hide(); + } + if (m.autoHideTimer) { + clearTimeout(m.autoHideTimer); + delete m.autoHideTimer; + } + }, + + onBeforeShow: function(m) { + var active = this.active, + parentMenu = m.parentMenu; + + active.remove(m); + if (!parentMenu && !m.allowOtherMenus) { + this.hideAll(); + } + else if (parentMenu && parentMenu.activeChild && m != parentMenu.activeChild) { + parentMenu.activeChild.hide(); + } + }, + + // private + onMouseDown: function(e) { + var me = this, + active = me.active, + lastShow = me.lastShow; + + if (Ext.Date.getElapsed(lastShow) > 50 && active.length > 0 && !e.getTarget('.' + Ext.baseCSSPrefix + 'menu')) { + me.hideAll(); + } + }, + + // private + register: function(menu) { + var me = this; + + if (!me.active) { + me.init(); + } + + if (menu.floating) { + me.menus[menu.id] = menu; + menu.on({ + beforehide: me.onBeforeHide, + hide: me.onHide, + beforeshow: me.onBeforeShow, + show: me.onShow, + scope: me + }); + } + }, + + /** + * 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 this. + * @return {Ext.menu.Menu} The specified menu, or null if none are found + */ + get: function(menu) { + var menus = this.menus; + + if (typeof menu == 'string') { // menu id + if (!menus) { // not initialized, no menus to return + return null; + } + return menus[menu]; + } else if (menu.isMenu) { // menu instance + return menu; + } else if (Ext.isArray(menu)) { // array of menu items + return Ext.create('Ext.menu.Menu', {items:menu}); + } else { // otherwise, must be a config + return Ext.ComponentManager.create(menu, 'menu'); + } + }, + + // private + unregister: function(menu) { + var me = this, + menus = me.menus, + active = me.active; + + delete menus[menu.id]; + active.remove(menu); + menu.un({ + beforehide: me.onBeforeHide, + hide: me.onHide, + beforeshow: me.onBeforeShow, + show: me.onShow, + scope: me + }); + }, + + // private + registerCheckable: function(menuItem) { + var groups = this.groups, + groupId = menuItem.group; + + if (groupId) { + if (!groups[groupId]) { + groups[groupId] = []; + } + + groups[groupId].push(menuItem); + } + }, + + // private + unregisterCheckable: function(menuItem) { + var groups = this.groups, + groupId = menuItem.group; + + if (groupId) { + Ext.Array.remove(groups[groupId], menuItem); + } + }, + + onCheckChange: function(menuItem, state) { + var groups = this.groups, + groupId = menuItem.group, + i = 0, + group, ln, curr; + + if (groupId && state) { + group = groups[groupId]; + ln = group.length; + for (; i < ln; i++) { + curr = group[i]; + if (curr != menuItem) { + curr.setChecked(false); + } + } + } + } +}); +/** + * @class Ext.button.Button + * @extends Ext.Component + +Create simple buttons with this component. Customisations include {@link #config-iconAlign aligned} +{@link #config-iconCls icons}, {@link #config-menu dropdown menus}, {@link #config-tooltip tooltips} +and {@link #config-scale sizing options}. Specify a {@link #config-handler handler} to run code when +a user clicks the button, or use {@link #config-listeners listeners} for other events such as +{@link #events-mouseover mouseover}. + +{@img Ext.button.Button/Ext.button.Button1.png Ext.button.Button component} +Example usage: + + Ext.create('Ext.Button', { + text: 'Click me', + renderTo: Ext.getBody(), + handler: function() { + alert('You clicked the button!') + } + }); + +The {@link #handler} configuration can also be updated dynamically using the {@link #setHandler} method. +Example usage: + + Ext.create('Ext.Button', { + text : 'Dyanmic Handler Button', + renderTo: Ext.getBody(), + handler : function() { + //this button will spit out a different number every time you click it. + //so firstly we must check if that number is already set: + if (this.clickCount) { + //looks like the property is already set, so lets just add 1 to that number and alert the user + this.clickCount++; + alert('You have clicked the button "' + this.clickCount + '" times.\n\nTry clicking it again..'); + } else { + //if the clickCount property is not set, we will set it and alert the user + this.clickCount = 1; + alert('You just clicked the button for the first time!\n\nTry pressing it again..'); + } + } + }); + +A button within a container: + + Ext.create('Ext.Container', { + renderTo: Ext.getBody(), + items : [ + { + xtype: 'button', + text : 'My Button' + } + ] + }); + +A useful option of Button is the {@link #scale} configuration. This configuration has three different options: +* `'small'` +* `'medium'` +* `'large'` + +{@img Ext.button.Button/Ext.button.Button2.png Ext.button.Button component} +Example usage: + + Ext.create('Ext.Button', { + renderTo: document.body, + text : 'Click me', + scale : 'large' + }); + +Buttons can also be toggled. To enable this, you simple set the {@link #enableToggle} property to `true`. +{@img Ext.button.Button/Ext.button.Button3.png Ext.button.Button component} +Example usage: + + Ext.create('Ext.Button', { + renderTo: Ext.getBody(), + text: 'Click Me', + enableToggle: true + }); + +You can assign a menu to a button by using the {@link #menu} configuration. This standard configuration can either be a reference to a {@link Ext.menu.Menu menu} +object, a {@link Ext.menu.Menu menu} id or a {@link Ext.menu.Menu menu} config blob. When assigning a menu to a button, an arrow is automatically added to the button. +You can change the alignment of the arrow using the {@link #arrowAlign} configuration on button. +{@img Ext.button.Button/Ext.button.Button4.png Ext.button.Button component} +Example usage: + + Ext.create('Ext.Button', { + text : 'Menu button', + renderTo : Ext.getBody(), + arrowAlign: 'bottom', + menu : [ + {text: 'Item 1'}, + {text: 'Item 2'}, + {text: 'Item 3'}, + {text: 'Item 4'} + ] + }); + +Using listeners, you can easily listen to events fired by any component, using the {@link #listeners} configuration or using the {@link #addListener} method. +Button has a variety of different listeners: +* `click` +* `toggle` +* `mouseover` +* `mouseout` +* `mouseshow` +* `menuhide` +* `menutriggerover` +* `menutriggerout` + +Example usage: + + Ext.create('Ext.Button', { + text : 'Button', + renderTo : Ext.getBody(), + listeners: { + click: function() { + //this == the button, as we are in the local scope + this.setText('I was clicked!'); + }, + mouseover: function() { + //set a new config which says we moused over, if not already set + if (!this.mousedOver) { + this.mousedOver = true; + alert('You moused over a button!\n\nI wont do this again.'); + } + } + } + }); + + * @constructor + * Create a new button + * @param {Object} config The config object + * @xtype button + * @markdown + * @docauthor Robert Dougan + */ +Ext.define('Ext.button.Button', { + + /* Begin Definitions */ + alias: 'widget.button', + extend: 'Ext.Component', + + requires: [ + 'Ext.menu.Manager', + 'Ext.util.ClickRepeater', + 'Ext.layout.component.Button', + 'Ext.util.TextMetrics', + 'Ext.util.KeyMap' + ], + + alternateClassName: 'Ext.Button', + /* End Definitions */ + + isButton: true, + componentLayout: 'button', + + /** + * 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 {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 : Button
This Button.
+ *
e : EventObject
The 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.Panel}.{@link Ext.panel.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). + */ + + /** + * @cfg {Number} tabIndex Set a DOM tabIndex for this button (defaults to undefined) + */ + + /** + * @cfg {Boolean} allowDepress + * False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when {@link #enableToggle} is true. + */ + + /** + * @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.button.Button
this Button object
+ *
state : Boolean
The 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.core.Element#alignTo} for more details, defaults to 'tl-bl?'). + */ + menuAlign: 'tl-bl?', + + /** + * @cfg {String} overflowText If used in a {@link Ext.toolbar.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', + + /** + * @cfg {String} clickEvent + * The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu). + * Defaults to 'click'. + */ + clickEvent: 'click', + + /** + * @cfg {Boolean} preventDefault + * True to prevent the default action when the {@link #clickEvent} is processed. Defaults to true. + */ + preventDefault: true, + + /** + * @cfg {Boolean} handleMouseEvents + * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) + */ + handleMouseEvents: true, + + /** + * @cfg {String} tooltipType + * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. + */ + tooltipType: 'qtip', + + /** + * @cfg {String} baseCls + * The base CSS class to add to all buttons. (Defaults to 'x-btn') + */ + baseCls: Ext.baseCSSPrefix + 'btn', + + /** + * @cfg {String} pressedCls + * The CSS class to add to a button when it is in the pressed state. (Defaults to 'x-btn-pressed') + */ + pressedCls: 'pressed', + + /** + * @cfg {String} overCls + * The CSS class to add to a button when it is in the over (hovered) state. (Defaults to 'x-btn-over') + */ + overCls: 'over', + + /** + * @cfg {String} focusCls + * The CSS class to add to a button when it is in the focussed state. (Defaults to 'x-btn-focus') + */ + focusCls: 'focus', + + /** + * @cfg {String} menuActiveCls + * The CSS class to add to a button when it's menu is active. (Defaults to 'x-btn-menu-active') + */ + menuActiveCls: 'menu-active', + + /** + * @cfg {Object} baseParams + * An object literal of parameters to pass to the url when the {@link #href} property is specified. + */ + + /** + * @cfg {Object} params + * An object literal of parameters to pass to the url when the {@link #href} property is specified. + * Any params override {@link #baseParams}. New params can be set using the {@link #setParams} method. + */ + + ariaRole: 'button', + + // inherited + renderTpl: + '' + + '' + + ' tabIndex="{tabIndex}" role="link">' + + '{text}' + + '' + + '' + + '' + + '' + + '' + + '' , + + /** + * @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'.
+ */ + scale: 'small', + + /** + * @private An array of allowed scales. + */ + allowedScales: ['small', 'medium', 'large'], + + /** + * @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', + + /** + * @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', + + /** + * @cfg {String} arrowCls + *
(Optional) The className used for the inner arrow element if the button has a menu.
+ */ + arrowCls: 'arrow', + + /** + * @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. + */ + + maskOnDisable: false, + + // inherit docs + initComponent: function() { + var me = this; + me.callParent(arguments); + + me.addEvents( + /** + * @event click + * Fires when this button is clicked + * @param {Button} this + * @param {EventObject} e The click event + */ + 'click', + + /** + * @event toggle + * Fires when the 'pressed' state of this button changes (only if enableToggle = true) + * @param {Button} this + * @param {Boolean} pressed + */ + 'toggle', + + /** + * @event mouseover + * Fires when the mouse hovers over the button + * @param {Button} this + * @param {Event} e The event object + */ + 'mouseover', + + /** + * @event mouseout + * Fires when the mouse exits the button + * @param {Button} this + * @param {Event} e The event object + */ + 'mouseout', + + /** + * @event menushow + * If this button has a menu, this event fires when it is shown + * @param {Button} this + * @param {Menu} menu + */ + 'menushow', + + /** + * @event menuhide + * If this button has a menu, this event fires when it is hidden + * @param {Button} this + * @param {Menu} menu + */ + 'menuhide', + + /** + * @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 + */ + 'menutriggerover', + + /** + * @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 + */ + 'menutriggerout' + ); + + if (me.menu) { + // Flag that we'll have a splitCls + me.split = true; + + // retrieve menu by id or instantiate instance if needed + me.menu = Ext.menu.Manager.get(me.menu); + me.menu.ownerCt = me; + } + + // Accept url as a synonym for href + if (me.url) { + me.href = me.url; + } + + // preventDefault defaults to false for links + if (me.href && !me.hasOwnProperty('preventDefault')) { + me.preventDefault = false; + } + + if (Ext.isString(me.toggleGroup)) { + me.enableToggle = true; + } + + }, + + // private + initAria: function() { + this.callParent(); + var actionEl = this.getActionEl(); + if (this.menu) { + actionEl.dom.setAttribute('aria-haspopup', true); + } + }, + + // inherit docs + getActionEl: function() { + return this.btnEl; + }, + + // inherit docs + getFocusEl: function() { + return this.btnEl; + }, + + // private + setButtonCls: function() { + var me = this, + el = me.el, + cls = []; + + if (me.useSetClass) { + if (!Ext.isEmpty(me.oldCls)) { + me.removeClsWithUI(me.oldCls); + me.removeClsWithUI(me.pressedCls); + } + + // Check whether the button has an icon or not, and if it has an icon, what is th alignment + if (me.iconCls || me.icon) { + if (me.text) { + cls.push('icon-text-' + me.iconAlign); + } else { + cls.push('icon'); + } + } else if (me.text) { + cls.push('noicon'); + } + + me.oldCls = cls; + me.addClsWithUI(cls); + me.addClsWithUI(me.pressed ? me.pressedCls : null); + } + }, + + // private + onRender: function(ct, position) { + // classNames for the button + var me = this, + repeater, btn; + + // Apply the renderData to the template args + Ext.applyIf(me.renderData, me.getTemplateArgs()); + + // Extract the button and the button wrapping element + Ext.applyIf(me.renderSelectors, { + btnEl : me.href ? 'a' : 'button', + btnWrap: 'em', + btnInnerEl: '.' + me.baseCls + '-inner' + }); + + if (me.scale) { + me.ui = me.ui + '-' + me.scale; + } + + // Render internal structure + me.callParent(arguments); + + // If it is a split button + has a toolip for the arrow + if (me.split && me.arrowTooltip) { + me.arrowEl.dom[me.tooltipType] = me.arrowTooltip; + } + + // Add listeners to the focus and blur events on the element + me.mon(me.btnEl, { + scope: me, + focus: me.onFocus, + blur : me.onBlur + }); + + // Set btn as a local variable for easy access + btn = me.el; + + if (me.icon) { + me.setIcon(me.icon); + } + + if (me.iconCls) { + me.setIconCls(me.iconCls); + } + + if (me.tooltip) { + me.setTooltip(me.tooltip, true); + } + + // Add the mouse events to the button + if (me.handleMouseEvents) { + me.mon(btn, { + scope: me, + mouseover: me.onMouseOver, + mouseout: me.onMouseOut, + mousedown: me.onMouseDown + }); + + if (me.split) { + me.mon(btn, { + mousemove: me.onMouseMove, + scope: me + }); + } + } + + // Check if the button has a menu + if (me.menu) { + me.mon(me.menu, { + scope: me, + show: me.onMenuShow, + hide: me.onMenuHide + }); + + me.keyMap = Ext.create('Ext.util.KeyMap', me.el, { + key: Ext.EventObject.DOWN, + handler: me.onDownKey, + scope: me + }); + } + + // Check if it is a repeat button + if (me.repeat) { + repeater = Ext.create('Ext.util.ClickRepeater', btn, Ext.isObject(me.repeat) ? me.repeat: {}); + me.mon(repeater, 'click', me.onRepeatClick, me); + } else { + me.mon(btn, me.clickEvent, me.onClick, me); + } + + // Register the button in the toggle manager + Ext.ButtonToggleManager.register(me); + }, + + /** + *
This method returns an object which provides substitution parameters for the {@link #renderTpl XTemplate} 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 Object containing the + * following properties:
+ *
type : The <button>'s {@link #type}
+ *
splitCls : A CSS class to determine the presence and position of an arrow icon. ('x-btn-arrow' or 'x-btn-arrow-bottom' or '')
+ *
cls : A CSS class name applied to the Button's main <tbody> element which determines the button's scale and icon alignment.
+ *
text : The {@link #text} to display ion the Button.
+ *
tabIndex : The tab index within the input flow.
+ *
+ * @return {Array} Substitution data for a Template. + */ + getTemplateArgs: function() { + var me = this, + persistentPadding = me.getPersistentBtnPadding(), + innerSpanStyle = ''; + + // Create negative margin offsets to counteract persistent button padding if needed + if (Math.max.apply(Math, persistentPadding) > 0) { + innerSpanStyle = 'margin:' + Ext.Array.map(persistentPadding, function(pad) { + return -pad + 'px'; + }).join(' '); + } + + return { + href : me.getHref(), + target : me.target || '_blank', + type : me.type, + splitCls : me.getSplitCls(), + cls : me.cls, + text : me.text || ' ', + tabIndex : me.tabIndex, + innerSpanStyle: innerSpanStyle + }; + }, + + /** + * @private + * If there is a configured href for this Button, returns the href with parameters appended. + * @returns The href string with parameters appended. + */ + getHref: function() { + var me = this, + params = Ext.apply({}, me.baseParams); + + // write baseParams first, then write any params + params = Ext.apply(params, me.params); + return me.href ? Ext.urlAppend(me.href, Ext.Object.toQueryString(params)) : false; + }, + + /** + *
Only valid if the Button was originally configured with a {@link #url}
+ *
Sets the href of the link dynamically according to the params passed, and any {@link #baseParams} configured.
+ * @param {Object} params Parameters to use in the href URL. + */ + setParams: function(params) { + this.params = params; + this.btnEl.dom.href = this.getHref(); + }, + + getSplitCls: function() { + var me = this; + return me.split ? (me.baseCls + '-' + me.arrowCls) + ' ' + (me.baseCls + '-' + me.arrowCls + '-' + me.arrowAlign) : ''; + }, + + // private + afterRender: function() { + var me = this; + me.useSetClass = true; + me.setButtonCls(); + me.doc = Ext.getDoc(); + this.callParent(arguments); + }, + + /** + * 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.Button} this + */ + setIconCls: function(cls) { + var me = this, + btnInnerEl = me.btnInnerEl; + if (btnInnerEl) { + // Remove the previous iconCls from the button + btnInnerEl.removeCls(me.iconCls); + btnInnerEl.addCls(cls || ''); + me.setButtonCls(); + } + me.iconCls = cls; + return me; + }, + + /** + * 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.tip.QuickTipManager#register}.
+ *
+ * @return {Ext.button.Button} this + */ + setTooltip: function(tooltip, initial) { + var me = this; + + if (me.rendered) { + if (!initial) { + me.clearTip(); + } + if (Ext.isObject(tooltip)) { + Ext.tip.QuickTipManager.register(Ext.apply({ + target: me.btnEl.id + }, + tooltip)); + me.tooltip = tooltip; + } else { + me.btnEl.dom.setAttribute('data-' + this.tooltipType, tooltip); + } + } else { + me.tooltip = tooltip; + } + return me; + }, + + // private + getRefItems: function(deep){ + var menu = this.menu, + items; + + if (menu) { + items = menu.getRefItems(deep); + items.unshift(menu); + } + return items || []; + }, + + // private + clearTip: function() { + if (Ext.isObject(this.tooltip)) { + Ext.tip.QuickTipManager.unregister(this.btnEl); + } + }, + + // private + beforeDestroy: function() { + var me = this; + if (me.rendered) { + me.clearTip(); + } + if (me.menu && me.destroyMenu !== false) { + Ext.destroy(me.btnEl, me.btnInnerEl, me.menu); + } + Ext.destroy(me.repeater); + }, + + // private + onDestroy: function() { + var me = this; + if (me.rendered) { + me.doc.un('mouseover', me.monitorMouseOver, me); + me.doc.un('mouseup', me.onMouseUp, me); + delete me.doc; + delete me.btnEl; + delete me.btnInnerEl; + Ext.ButtonToggleManager.unregister(me); + + Ext.destroy(me.keyMap); + delete me.keyMap; + } + me.callParent(); + }, + + /** + * 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.Button} this + */ + setHandler: function(handler, scope) { + this.handler = handler; + this.scope = scope; + return this; + }, + + /** + * Sets this Button's text + * @param {String} text The button text + * @return {Ext.button.Button} this + */ + setText: function(text) { + var me = this; + me.text = text; + if (me.el) { + me.btnInnerEl.update(text || ' '); + me.setButtonCls(); + } + me.doComponentLayout(); + return me; + }, + + /** + * 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.Button} this + */ + setIcon: function(icon) { + var me = this, + btnInnerEl = me.btnInnerEl; + me.icon = icon; + if (btnInnerEl) { + btnInnerEl.setStyle('background-image', icon ? 'url(' + icon + ')': ''); + me.setButtonCls(); + } + return me; + }, + + /** + * Gets the text for this Button + * @return {String} The button text + */ + getText: function() { + return this.text; + }, + + /** + * 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.Button} this + */ + toggle: function(state, suppressEvent) { + var me = this; + state = state === undefined ? !me.pressed: !!state; + if (state !== me.pressed) { + if (me.rendered) { + me[state ? 'addClsWithUI': 'removeClsWithUI'](me.pressedCls); + } + me.btnEl.dom.setAttribute('aria-pressed', state); + me.pressed = state; + if (!suppressEvent) { + me.fireEvent('toggle', me, state); + Ext.callback(me.toggleHandler, me.scope || me, [me, state]); + } + } + return me; + }, + + /** + * Show this button's menu (if it has one) + */ + showMenu: function() { + var me = this; + if (me.rendered && me.menu) { + if (me.tooltip) { + Ext.tip.QuickTipManager.getQuickTip().cancelShow(me.btnEl); + } + if (me.menu.isVisible()) { + me.menu.hide(); + } + + me.menu.showBy(me.el, me.menuAlign); + } + return me; + }, + + /** + * Hide this button's menu (if it has one) + */ + hideMenu: function() { + if (this.hasVisibleMenu()) { + this.menu.hide(); + } + return this; + }, + + /** + * Returns true if the button has a menu and it is visible + * @return {Boolean} + */ + hasVisibleMenu: function() { + var menu = this.menu; + return menu && menu.rendered && menu.isVisible(); + }, + + // private + onRepeatClick: function(repeat, e) { + this.onClick(e); + }, + + // private + onClick: function(e) { + var me = this; + if (me.preventDefault || (me.disabled && me.getHref()) && e) { + e.preventDefault(); + } + if (e.button !== 0) { + return; + } + if (!me.disabled) { + if (me.enableToggle && (me.allowDepress !== false || !me.pressed)) { + me.toggle(); + } + if (me.menu && !me.hasVisibleMenu() && !me.ignoreNextClick) { + me.showMenu(); + } + me.fireEvent('click', me, e); + if (me.handler) { + me.handler.call(me.scope || me, me, e); + } + me.onBlur(); + } + }, + + /** + * @private mouseover handler called when a mouseover event occurs anywhere within the encapsulating element. + * The targets are interrogated to see what is being entered from where. + * @param e + */ + onMouseOver: function(e) { + var me = this; + if (!me.disabled && !e.within(me.el, true, true)) { + me.onMouseEnter(e); + } + }, + + /** + * @private mouseout handler called when a mouseout event occurs anywhere within the encapsulating element - + * or the mouse leaves the encapsulating element. + * The targets are interrogated to see what is being exited to where. + * @param e + */ + onMouseOut: function(e) { + var me = this; + if (!e.within(me.el, true, true)) { + if (me.overMenuTrigger) { + me.onMenuTriggerOut(e); + } + me.onMouseLeave(e); + } + }, + + /** + * @private mousemove handler called when the mouse moves anywhere within the encapsulating element. + * The position is checked to determine if the mouse is entering or leaving the trigger area. Using + * mousemove to check this is more resource intensive than we'd like, but it is necessary because + * the trigger area does not line up exactly with sub-elements so we don't always get mouseover/out + * events when needed. In the future we should consider making the trigger a separate element that + * is absolutely positioned and sized over the trigger area. + */ + onMouseMove: function(e) { + var me = this, + el = me.el, + over = me.overMenuTrigger, + overlap, btnSize; + + if (me.split) { + if (me.arrowAlign === 'right') { + overlap = e.getX() - el.getX(); + btnSize = el.getWidth(); + } else { + overlap = e.getY() - el.getY(); + btnSize = el.getHeight(); + } + + if (overlap > (btnSize - me.getTriggerSize())) { + if (!over) { + me.onMenuTriggerOver(e); + } + } else { + if (over) { + me.onMenuTriggerOut(e); + } + } + } + }, + + /** + * @private Measures the size of the trigger area for menu and split buttons. Will be a width for + * a right-aligned trigger and a height for a bottom-aligned trigger. Cached after first measurement. + */ + getTriggerSize: function() { + var me = this, + size = me.triggerSize, + side, sideFirstLetter, undef; + + if (size === undef) { + side = me.arrowAlign; + sideFirstLetter = side.charAt(0); + size = me.triggerSize = me.el.getFrameWidth(sideFirstLetter) + me.btnWrap.getFrameWidth(sideFirstLetter) + (me.frameSize && me.frameSize[side] || 0); + } + return size; + }, + + /** + * @private virtual mouseenter handler called when it is detected that the mouseout event + * signified the mouse entering the encapsulating element. + * @param e + */ + onMouseEnter: function(e) { + var me = this; + me.addClsWithUI(me.overCls); + me.fireEvent('mouseover', me, e); + }, + + /** + * @private virtual mouseleave handler called when it is detected that the mouseover event + * signified the mouse entering the encapsulating element. + * @param e + */ + onMouseLeave: function(e) { + var me = this; + me.removeClsWithUI(me.overCls); + me.fireEvent('mouseout', me, e); + }, + + /** + * @private virtual mouseenter handler called when it is detected that the mouseover event + * signified the mouse entering the arrow area of the button - the . + * @param e + */ + onMenuTriggerOver: function(e) { + var me = this; + me.overMenuTrigger = true; + me.fireEvent('menutriggerover', me, me.menu, e); + }, + + /** + * @private virtual mouseleave handler called when it is detected that the mouseout event + * signified the mouse leaving the arrow area of the button - the . + * @param e + */ + onMenuTriggerOut: function(e) { + var me = this; + delete me.overMenuTrigger; + me.fireEvent('menutriggerout', me, me.menu, e); + }, + + // inherit docs + enable : function(silent) { + var me = this; + + me.callParent(arguments); + + me.removeClsWithUI('disabled'); + + return me; + }, + + // inherit docs + disable : function(silent) { + var me = this; + + me.callParent(arguments); + + me.addClsWithUI('disabled'); + + return me; + }, + + /** + * Method to change the scale of the button. See {@link #scale} for allowed configurations. + * @param {String} scale The scale to change to. + */ + setScale: function(scale) { + var me = this, + ui = me.ui.replace('-' + me.scale, ''); + + //check if it is an allowed scale + if (!Ext.Array.contains(me.allowedScales, scale)) { + throw('#setScale: scale must be an allowed scale (' + me.allowedScales.join(', ') + ')'); + } + + me.scale = scale; + me.setUI(ui); + }, + + // inherit docs + setUI: function(ui) { + var me = this; + + //we need to append the scale to the UI, if not already done + if (me.scale && !ui.match(me.scale)) { + ui = ui + '-' + me.scale; + } + + me.callParent([ui]); + + // Set all the state classNames, as they need to include the UI + // me.disabledCls += ' ' + me.baseCls + '-' + me.ui + '-disabled'; + }, + + // private + onFocus: function(e) { + var me = this; + if (!me.disabled) { + me.addClsWithUI(me.focusCls); + } + }, + + // private + onBlur: function(e) { + var me = this; + me.removeClsWithUI(me.focusCls); + }, + + // private + onMouseDown: function(e) { + var me = this; + if (!me.disabled && e.button === 0) { + me.addClsWithUI(me.pressedCls); + me.doc.on('mouseup', me.onMouseUp, me); + } + }, + // private + onMouseUp: function(e) { + var me = this; + if (e.button === 0) { + if (!me.pressed) { + me.removeClsWithUI(me.pressedCls); + } + me.doc.un('mouseup', me.onMouseUp, me); + } + }, + // private + onMenuShow: function(e) { + var me = this; + me.ignoreNextClick = 0; + me.addClsWithUI(me.menuActiveCls); + me.fireEvent('menushow', me, me.menu); + }, + + // private + onMenuHide: function(e) { + var me = this; + me.removeClsWithUI(me.menuActiveCls); + me.ignoreNextClick = Ext.defer(me.restoreClick, 250, me); + me.fireEvent('menuhide', me, me.menu); + }, + + // private + restoreClick: function() { + this.ignoreNextClick = 0; + }, + + // private + onDownKey: function() { + var me = this; + + if (!me.disabled) { + if (me.menu) { + me.showMenu(); + } + } + }, + + /** + * @private Some browsers (notably Safari and older Chromes on Windows) add extra "padding" inside the button + * element that cannot be removed. This method returns the size of that padding with a one-time detection. + * @return Array [top, right, bottom, left] + */ + getPersistentBtnPadding: function() { + var cls = Ext.button.Button, + padding = cls.persistentPadding, + btn, leftTop, btnEl, btnInnerEl; + + if (!padding) { + padding = cls.persistentPadding = [0, 0, 0, 0]; //set early to prevent recursion + + if (!Ext.isIE) { //short-circuit IE as it sometimes gives false positive for padding + // Create auto-size button offscreen and measure its insides + btn = Ext.create('Ext.button.Button', { + renderTo: Ext.getBody(), + text: 'test', + style: 'position:absolute;top:-999px;' + }); + btnEl = btn.btnEl; + btnInnerEl = btn.btnInnerEl; + btnEl.setSize(null, null); //clear any hard dimensions on the button el to see what it does naturally + + leftTop = btnInnerEl.getOffsetsTo(btnEl); + padding[0] = leftTop[1]; + padding[1] = btnEl.getWidth() - btnInnerEl.getWidth() - leftTop[0]; + padding[2] = btnEl.getHeight() - btnInnerEl.getHeight() - leftTop[1]; + padding[3] = leftTop[0]; + + btn.destroy(); + } + } + + return padding; + } + +}, function() { + var groups = {}, + g, i, l; + + function toggleGroup(btn, state) { + if (state) { + g = groups[btn.toggleGroup]; + for (i = 0, l = g.length; i < l; i++) { + if (g[i] !== btn) { + g[i].toggle(false); + } + } + } + } + // Private utility class used by Button + Ext.ButtonToggleManager = { + register: function(btn) { + if (!btn.toggleGroup) { + return; + } + var group = groups[btn.toggleGroup]; + if (!group) { + group = groups[btn.toggleGroup] = []; + } + group.push(btn); + btn.on('toggle', toggleGroup); + }, + + unregister: function(btn) { + if (!btn.toggleGroup) { + return; + } + var group = groups[btn.toggleGroup]; + if (group) { + Ext.Array.remove(group, 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], + i = 0, + len; + if (g) { + for (len = g.length; i < len; i++) { + if (g[i].pressed === true) { + return g[i]; + } + } + } + return null; + } + }; +}); + +/** + * @class Ext.layout.container.boxOverflow.Menu + * @extends Ext.layout.container.boxOverflow.None + * @private + */ +Ext.define('Ext.layout.container.boxOverflow.Menu', { + + /* Begin Definitions */ + + extend: 'Ext.layout.container.boxOverflow.None', + requires: ['Ext.toolbar.Separator', 'Ext.button.Button'], + alternateClassName: 'Ext.layout.boxOverflow.Menu', + + /* End Definitions */ + + /** + * @cfg {String} afterCtCls + * CSS class added to the afterCt element. This is the element that holds any special items such as scrollers, + * which must always be present at the rightmost edge of the Container + */ + + /** + * @property noItemsMenuText + * @type String + * HTML fragment to render into the toolbar overflow menu if there are no items to display + */ + noItemsMenuText : '
(None)
', + + constructor: function(layout) { + var me = this; + + me.callParent(arguments); + + // Before layout, we need to re-show all items which we may have hidden due to a previous overflow. + layout.beforeLayout = Ext.Function.createInterceptor(layout.beforeLayout, this.clearOverflow, this); + + me.afterCtCls = me.afterCtCls || Ext.baseCSSPrefix + 'box-menu-' + layout.parallelAfter; + /** + * @property menuItems + * @type Array + * Array of all items that are currently hidden and should go into the dropdown menu + */ + me.menuItems = []; + }, + + onRemove: function(comp){ + Ext.Array.remove(this.menuItems, comp); + }, + + handleOverflow: function(calculations, targetSize) { + var me = this, + layout = me.layout, + methodName = 'get' + layout.parallelPrefixCap, + newSize = {}, + posArgs = [null, null]; + + me.callParent(arguments); + this.createMenu(calculations, targetSize); + newSize[layout.perpendicularPrefix] = targetSize[layout.perpendicularPrefix]; + newSize[layout.parallelPrefix] = targetSize[layout.parallelPrefix] - me.afterCt[methodName](); + + // Center the menuTrigger button. + // TODO: Should we emulate align: 'middle' like this, or should we 'stretchmax' the menuTrigger? + posArgs[layout.perpendicularSizeIndex] = (calculations.meta.maxSize - me.menuTrigger['get' + layout.perpendicularPrefixCap]()) / 2; + me.menuTrigger.setPosition.apply(me.menuTrigger, posArgs); + + return { targetSize: newSize }; + }, + + /** + * @private + * Called by the layout, when it determines that there is no overflow. + * Also called as an interceptor to the layout's onLayout method to reshow + * previously hidden overflowing items. + */ + clearOverflow: function(calculations, targetSize) { + var me = this, + newWidth = targetSize ? targetSize.width + (me.afterCt ? me.afterCt.getWidth() : 0) : 0, + items = me.menuItems, + i = 0, + length = items.length, + item; + + me.hideTrigger(); + for (; i < length; i++) { + items[i].show(); + } + items.length = 0; + + return targetSize ? { + targetSize: { + height: targetSize.height, + width : newWidth + } + } : null; + }, + + /** + * @private + */ + showTrigger: function() { + this.menuTrigger.show(); + }, + + /** + * @private + */ + hideTrigger: function() { + if (this.menuTrigger !== undefined) { + this.menuTrigger.hide(); + } + }, + + /** + * @private + * Called before the overflow menu is shown. This constructs the menu's items, caching them for as long as it can. + */ + beforeMenuShow: function(menu) { + var me = this, + items = me.menuItems, + i = 0, + len = items.length, + item, + prev; + + var needsSep = function(group, prev){ + return group.isXType('buttongroup') && !(prev instanceof Ext.toolbar.Separator); + }; + + me.clearMenu(); + menu.removeAll(); + + for (; i < len; i++) { + item = items[i]; + + // Do not show a separator as a first item + if (!i && (item instanceof Ext.toolbar.Separator)) { + continue; + } + if (prev && (needsSep(item, prev) || needsSep(prev, item))) { + menu.add('-'); + } + + me.addComponentToMenu(menu, item); + prev = item; + } + + // put something so the menu isn't empty if no compatible items found + if (menu.items.length < 1) { + menu.add(me.noItemsMenuText); + } + }, + + /** + * @private + * Returns a menu config for a given component. This config is used to create a menu item + * to be added to the expander menu + * @param {Ext.Component} component The component to create the config for + * @param {Boolean} hideOnClick Passed through to the menu item + */ + createMenuConfig : function(component, hideOnClick) { + var config = Ext.apply({}, component.initialConfig), + group = component.toggleGroup; + + Ext.copyTo(config, component, [ + 'iconCls', 'icon', 'itemId', 'disabled', 'handler', 'scope', 'menu' + ]); + + Ext.apply(config, { + text : component.overflowText || component.text, + hideOnClick: hideOnClick, + destroyMenu: false + }); + + if (group || component.enableToggle) { + Ext.apply(config, { + group : group, + checked: component.pressed, + listeners: { + checkchange: function(item, checked){ + component.toggle(checked); + } + } + }); + } + + delete config.ownerCt; + delete config.xtype; + delete config.id; + return config; + }, + + /** + * @private + * Adds the given Toolbar item to the given menu. Buttons inside a buttongroup are added individually. + * @param {Ext.menu.Menu} menu The menu to add to + * @param {Ext.Component} component The component to add + */ + addComponentToMenu : function(menu, component) { + var me = this; + if (component instanceof Ext.toolbar.Separator) { + menu.add('-'); + } else if (component.isComponent) { + if (component.isXType('splitbutton')) { + menu.add(me.createMenuConfig(component, true)); + + } else if (component.isXType('button')) { + menu.add(me.createMenuConfig(component, !component.menu)); + + } else if (component.isXType('buttongroup')) { + component.items.each(function(item){ + me.addComponentToMenu(menu, item); + }); + } else { + menu.add(Ext.create(Ext.getClassName(component), me.createMenuConfig(component))); + } + } + }, + + /** + * @private + * Deletes the sub-menu of each item in the expander menu. Submenus are created for items such as + * splitbuttons and buttongroups, where the Toolbar item cannot be represented by a single menu item + */ + clearMenu : function() { + var menu = this.moreMenu; + if (menu && menu.items) { + menu.items.each(function(item) { + if (item.menu) { + delete item.menu; + } + }); + } + }, + + /** + * @private + * Creates the overflow trigger and menu used when enableOverflow is set to true and the items + * in the layout are too wide to fit in the space available + */ + createMenu: function(calculations, targetSize) { + var me = this, + layout = me.layout, + startProp = layout.parallelBefore, + sizeProp = layout.parallelPrefix, + available = targetSize[sizeProp], + boxes = calculations.boxes, + i = 0, + len = boxes.length, + box; + + if (!me.menuTrigger) { + me.createInnerElements(); + + /** + * @private + * @property menu + * @type Ext.menu.Menu + * The expand menu - holds items for every item that cannot be shown + * because the container is currently not large enough. + */ + me.menu = Ext.create('Ext.menu.Menu', { + hideMode: 'offsets', + listeners: { + scope: me, + beforeshow: me.beforeMenuShow + } + }); + + /** + * @private + * @property menuTrigger + * @type Ext.button.Button + * The expand button which triggers the overflow menu to be shown + */ + me.menuTrigger = Ext.create('Ext.button.Button', { + ownerCt : me.layout.owner, // To enable the Menu to ascertain a valid zIndexManager owner in the same tree + iconCls : Ext.baseCSSPrefix + layout.owner.getXType() + '-more-icon', + ui : layout.owner instanceof Ext.toolbar.Toolbar ? 'default-toolbar' : 'default', + menu : me.menu, + getSplitCls: function() { return '';}, + renderTo: me.afterCt + }); + } + me.showTrigger(); + available -= me.afterCt.getWidth(); + + // Hide all items which are off the end, and store them to allow them to be restored + // before each layout operation. + me.menuItems.length = 0; + for (; i < len; i++) { + box = boxes[i]; + if (box[startProp] + box[sizeProp] > available) { + me.menuItems.push(box.component); + box.component.hide(); + } + } + }, + + /** + * @private + * Creates the beforeCt, innerCt and afterCt elements if they have not already been created + * @param {Ext.container.Container} container The Container attached to this Layout instance + * @param {Ext.core.Element} target The target Element + */ + createInnerElements: function() { + var me = this, + target = me.layout.getRenderTarget(); + + if (!this.afterCt) { + target.addCls(Ext.baseCSSPrefix + me.layout.direction + '-box-overflow-body'); + this.afterCt = target.insertSibling({cls: Ext.layout.container.Box.prototype.innerCls + ' ' + this.afterCtCls}, 'before'); + } + }, + + /** + * @private + */ + destroy: function() { + Ext.destroy(this.menu, this.menuTrigger); + } +}); +/** + * @class Ext.util.Region + * @extends Object + * + * Represents a rectangular region and provides a number of utility methods + * to compare regions. + */ + +Ext.define('Ext.util.Region', { + + /* Begin Definitions */ + + requires: ['Ext.util.Offset'], + + statics: { + /** + * @static + * @param {Mixed} el A string, DomElement or Ext.core.Element representing an element + * on the page. + * @returns {Ext.util.Region} region + * Retrieves an Ext.util.Region for a particular element. + */ + getRegion: function(el) { + return Ext.fly(el).getPageBox(true); + }, + + /** + * @static + * @param {Object} o An object with top, right, bottom, left properties + * @return {Ext.util.Region} region The region constructed based on the passed object + */ + from: function(o) { + return new this(o.top, o.right, o.bottom, o.left); + } + }, + + /* End Definitions */ + + /** + * @constructor + * @param {Number} top Top + * @param {Number} right Right + * @param {Number} bottom Bottom + * @param {Number} left Left + */ + constructor : function(t, r, b, l) { + var me = this; + me.y = me.top = me[1] = t; + me.right = r; + me.bottom = b; + me.x = me.left = me[0] = l; + }, + + /** + * Checks if this region completely contains the region that is passed in. + * @param {Ext.util.Region} region + */ + contains : function(region) { + var me = this; + return (region.x >= me.x && + region.right <= me.right && + region.y >= me.y && + region.bottom <= me.bottom); + + }, + + /** + * Checks if this region intersects the region passed in. + * @param {Ext.util.Region} region + * @return {Ext.util.Region/Boolean} Returns the intersected region or false if there is no intersection. + */ + intersect : function(region) { + var me = this, + t = Math.max(me.y, region.y), + r = Math.min(me.right, region.right), + b = Math.min(me.bottom, region.bottom), + l = Math.max(me.x, region.x); + + if (b > t && r > l) { + return new this.self(t, r, b, l); + } + else { + return false; + } + }, + + /** + * Returns the smallest region that contains the current AND targetRegion. + * @param {Ext.util.Region} region + */ + union : function(region) { + var me = this, + t = Math.min(me.y, region.y), + r = Math.max(me.right, region.right), + b = Math.max(me.bottom, region.bottom), + l = Math.min(me.x, region.x); + + return new this.self(t, r, b, l); + }, + + /** + * Modifies the current region to be constrained to the targetRegion. + * @param {Ext.util.Region} targetRegion + */ + constrainTo : function(r) { + var me = this, + constrain = Ext.Number.constrain; + me.top = me.y = constrain(me.top, r.y, r.bottom); + me.bottom = constrain(me.bottom, r.y, r.bottom); + me.left = me.x = constrain(me.left, r.x, r.right); + me.right = constrain(me.right, r.x, r.right); + return me; + }, + + /** + * Modifies the current region to be adjusted by offsets. + * @param {Number} top top offset + * @param {Number} right right offset + * @param {Number} bottom bottom offset + * @param {Number} left left offset + */ + adjust : function(t, r, b, l) { + var me = this; + me.top = me.y += t; + me.left = me.x += l; + me.right += r; + me.bottom += b; + return me; + }, + + /** + * Get the offset amount of a point outside the region + * @param {String} axis optional + * @param {Ext.util.Point} p the point + * @return {Ext.util.Offset} + */ + getOutOfBoundOffset: function(axis, p) { + if (!Ext.isObject(axis)) { + if (axis == 'x') { + return this.getOutOfBoundOffsetX(p); + } else { + return this.getOutOfBoundOffsetY(p); + } + } else { + p = axis; + var d = Ext.create('Ext.util.Offset'); + d.x = this.getOutOfBoundOffsetX(p.x); + d.y = this.getOutOfBoundOffsetY(p.y); + return d; + } + + }, + + /** + * Get the offset amount on the x-axis + * @param {Number} p the offset + * @return {Number} + */ + getOutOfBoundOffsetX: function(p) { + if (p <= this.x) { + return this.x - p; + } else if (p >= this.right) { + return this.right - p; + } + + return 0; + }, + + /** + * Get the offset amount on the y-axis + * @param {Number} p the offset + * @return {Number} + */ + getOutOfBoundOffsetY: function(p) { + if (p <= this.y) { + return this.y - p; + } else if (p >= this.bottom) { + return this.bottom - p; + } + + return 0; + }, + + /** + * Check whether the point / offset is out of bound + * @param {String} axis optional + * @param {Ext.util.Point/Number} p the point / offset + * @return {Boolean} + */ + isOutOfBound: function(axis, p) { + if (!Ext.isObject(axis)) { + if (axis == 'x') { + return this.isOutOfBoundX(p); + } else { + return this.isOutOfBoundY(p); + } + } else { + p = axis; + return (this.isOutOfBoundX(p.x) || this.isOutOfBoundY(p.y)); + } + }, + + /** + * Check whether the offset is out of bound in the x-axis + * @param {Number} p the offset + * @return {Boolean} + */ + isOutOfBoundX: function(p) { + return (p < this.x || p > this.right); + }, + + /** + * Check whether the offset is out of bound in the y-axis + * @param {Number} p the offset + * @return {Boolean} + */ + isOutOfBoundY: function(p) { + return (p < this.y || p > this.bottom); + }, + + /* + * Restrict a point within the region by a certain factor. + * @param {String} axis Optional + * @param {Ext.util.Point/Ext.util.Offset/Object} p + * @param {Number} factor + * @return {Ext.util.Point/Ext.util.Offset/Object/Number} + */ + restrict: function(axis, p, factor) { + if (Ext.isObject(axis)) { + var newP; + + factor = p; + p = axis; + + if (p.copy) { + newP = p.copy(); + } + else { + newP = { + x: p.x, + y: p.y + }; + } + + newP.x = this.restrictX(p.x, factor); + newP.y = this.restrictY(p.y, factor); + return newP; + } else { + if (axis == 'x') { + return this.restrictX(p, factor); + } else { + return this.restrictY(p, factor); + } + } + }, + + /* + * Restrict an offset within the region by a certain factor, on the x-axis + * @param {Number} p + * @param {Number} factor The factor, optional, defaults to 1 + * @return + */ + restrictX : function(p, factor) { + if (!factor) { + factor = 1; + } + + if (p <= this.x) { + p -= (p - this.x) * factor; + } + else if (p >= this.right) { + p -= (p - this.right) * factor; + } + return p; + }, + + /* + * Restrict an offset within the region by a certain factor, on the y-axis + * @param {Number} p + * @param {Number} factor The factor, optional, defaults to 1 + */ + restrictY : function(p, factor) { + if (!factor) { + factor = 1; + } + + if (p <= this.y) { + p -= (p - this.y) * factor; + } + else if (p >= this.bottom) { + p -= (p - this.bottom) * factor; + } + return p; + }, + + /* + * Get the width / height of this region + * @return {Object} an object with width and height properties + */ + getSize: function() { + return { + width: this.right - this.x, + height: this.bottom - this.y + }; + }, + + /** + * Copy a new instance + * @return {Ext.util.Region} + */ + copy: function() { + return new this.self(this.y, this.right, this.bottom, this.x); + }, + + /** + * Copy the values of another Region to this Region + * @param {Region} The region to copy from. + * @return {Ext.util.Point} this This point + */ + copyFrom: function(p) { + var me = this; + me.top = me.y = me[1] = p.y; + me.right = p.right; + me.bottom = p.bottom; + me.left = me.x = me[0] = p.x; + + return this; + }, + + /** + * Dump this to an eye-friendly string, great for debugging + * @return {String} + */ + toString: function() { + return "Region[" + this.top + "," + this.right + "," + this.bottom + "," + this.left + "]"; + }, + + + /** + * Translate this region by the given offset amount + * @param {Ext.util.Offset/Object} offset Object containing the x and y properties. + * Or the x value is using the two argument form. + * @param {Number} The y value unless using an Offset object. + * @return {Ext.util.Region} this This Region + */ + translateBy: function(x, y) { + if (arguments.length == 1) { + y = x.y; + x = x.x; + } + var me = this; + me.top = me.y += y; + me.right += x; + me.bottom += y; + me.left = me.x += x; + + return me; + }, + + /** + * Round all the properties of this region + * @return {Ext.util.Region} this This Region + */ + round: function() { + var me = this; + me.top = me.y = Math.round(me.y); + me.right = Math.round(me.right); + me.bottom = Math.round(me.bottom); + me.left = me.x = Math.round(me.x); + + return me; + }, + + /** + * Check whether this region is equivalent to the given region + * @param {Ext.util.Region} region The region to compare with + * @return {Boolean} + */ + equals: function(region) { + return (this.top == region.top && this.right == region.right && this.bottom == region.bottom && this.left == region.left); + } +}); + +/* + * This is a derivative of the similarly named class in the YUI Library. + * The original license: + * Copyright (c) 2006, Yahoo! Inc. All rights reserved. + * Code licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + */ + + +/** + * @class Ext.dd.DragDropManager + * DragDropManager is a singleton that tracks the element interaction for + * all DragDrop items in the window. Generally, you will not call + * this class directly, but it does have helper methods that could + * be useful in your DragDrop implementations. + * @singleton + */ +Ext.define('Ext.dd.DragDropManager', { + singleton: true, + + requires: ['Ext.util.Region'], + + uses: ['Ext.tip.QuickTipManager'], + + // shorter ClassName, to save bytes and use internally + alternateClassName: ['Ext.dd.DragDropMgr', 'Ext.dd.DDM'], + + /** + * Two dimensional Array of registered DragDrop objects. The first + * dimension is the DragDrop item group, the second the DragDrop + * object. + * @property ids + * @type String[] + * @private + * @static + */ + ids: {}, + + /** + * Array of element ids defined as drag handles. Used to determine + * if the element that generated the mousedown event is actually the + * handle and not the html element itself. + * @property handleIds + * @type String[] + * @private + * @static + */ + handleIds: {}, + + /** + * the DragDrop object that is currently being dragged + * @property dragCurrent + * @type DragDrop + * @private + * @static + **/ + dragCurrent: null, + + /** + * the DragDrop object(s) that are being hovered over + * @property dragOvers + * @type Array + * @private + * @static + */ + dragOvers: {}, + + /** + * the X distance between the cursor and the object being dragged + * @property deltaX + * @type int + * @private + * @static + */ + deltaX: 0, + + /** + * the Y distance between the cursor and the object being dragged + * @property deltaY + * @type int + * @private + * @static + */ + deltaY: 0, + + /** + * Flag to determine if we should prevent the default behavior of the + * events we define. By default this is true, but this can be set to + * false if you need the default behavior (not recommended) + * @property preventDefault + * @type boolean + * @static + */ + preventDefault: true, + + /** + * Flag to determine if we should stop the propagation of the events + * we generate. This is true by default but you may want to set it to + * false if the html element contains other features that require the + * mouse click. + * @property stopPropagation + * @type boolean + * @static + */ + stopPropagation: true, + + /** + * Internal flag that is set to true when drag and drop has been + * intialized + * @property initialized + * @private + * @static + */ + initialized: false, + + /** + * All drag and drop can be disabled. + * @property locked + * @private + * @static + */ + locked: false, + + /** + * Called the first time an element is registered. + * @method init + * @private + * @static + */ + init: function() { + this.initialized = true; + }, + + /** + * In point mode, drag and drop interaction is defined by the + * location of the cursor during the drag/drop + * @property POINT + * @type int + * @static + */ + POINT: 0, + + /** + * In intersect mode, drag and drop interaction is defined by the + * overlap of two or more drag and drop objects. + * @property INTERSECT + * @type int + * @static + */ + INTERSECT: 1, + + /** + * The current drag and drop mode. Default: POINT + * @property mode + * @type int + * @static + */ + mode: 0, + + /** + * Runs method on all drag and drop objects + * @method _execOnAll + * @private + * @static + */ + _execOnAll: function(sMethod, args) { + for (var i in this.ids) { + for (var j in this.ids[i]) { + var oDD = this.ids[i][j]; + if (! this.isTypeOfDD(oDD)) { + continue; + } + oDD[sMethod].apply(oDD, args); + } + } + }, + + /** + * Drag and drop initialization. Sets up the global event handlers + * @method _onLoad + * @private + * @static + */ + _onLoad: function() { + + this.init(); + + var Event = Ext.EventManager; + Event.on(document, "mouseup", this.handleMouseUp, this, true); + Event.on(document, "mousemove", this.handleMouseMove, this, true); + Event.on(window, "unload", this._onUnload, this, true); + Event.on(window, "resize", this._onResize, this, true); + // Event.on(window, "mouseout", this._test); + + }, + + /** + * Reset constraints on all drag and drop objs + * @method _onResize + * @private + * @static + */ + _onResize: function(e) { + this._execOnAll("resetConstraints", []); + }, + + /** + * Lock all drag and drop functionality + * @method lock + * @static + */ + lock: function() { this.locked = true; }, + + /** + * Unlock all drag and drop functionality + * @method unlock + * @static + */ + unlock: function() { this.locked = false; }, + + /** + * Is drag and drop locked? + * @method isLocked + * @return {boolean} True if drag and drop is locked, false otherwise. + * @static + */ + isLocked: function() { return this.locked; }, + + /** + * Location cache that is set for all drag drop objects when a drag is + * initiated, cleared when the drag is finished. + * @property locationCache + * @private + * @static + */ + locationCache: {}, + + /** + * Set useCache to false if you want to force object the lookup of each + * drag and drop linked element constantly during a drag. + * @property useCache + * @type boolean + * @static + */ + useCache: true, + + /** + * The number of pixels that the mouse needs to move after the + * mousedown before the drag is initiated. Default=3; + * @property clickPixelThresh + * @type int + * @static + */ + clickPixelThresh: 3, + + /** + * The number of milliseconds after the mousedown event to initiate the + * drag if we don't get a mouseup event. Default=350 + * @property clickTimeThresh + * @type int + * @static + */ + clickTimeThresh: 350, + + /** + * Flag that indicates that either the drag pixel threshold or the + * mousdown time threshold has been met + * @property dragThreshMet + * @type boolean + * @private + * @static + */ + dragThreshMet: false, + + /** + * Timeout used for the click time threshold + * @property clickTimeout + * @type Object + * @private + * @static + */ + clickTimeout: null, + + /** + * The X position of the mousedown event stored for later use when a + * drag threshold is met. + * @property startX + * @type int + * @private + * @static + */ + startX: 0, + + /** + * The Y position of the mousedown event stored for later use when a + * drag threshold is met. + * @property startY + * @type int + * @private + * @static + */ + startY: 0, + + /** + * Each DragDrop instance must be registered with the DragDropManager. + * This is executed in DragDrop.init() + * @method regDragDrop + * @param {DragDrop} oDD the DragDrop object to register + * @param {String} sGroup the name of the group this element belongs to + * @static + */ + regDragDrop: function(oDD, sGroup) { + if (!this.initialized) { this.init(); } + + if (!this.ids[sGroup]) { + this.ids[sGroup] = {}; + } + this.ids[sGroup][oDD.id] = oDD; + }, + + /** + * Removes the supplied dd instance from the supplied group. Executed + * by DragDrop.removeFromGroup, so don't call this function directly. + * @method removeDDFromGroup + * @private + * @static + */ + removeDDFromGroup: function(oDD, sGroup) { + if (!this.ids[sGroup]) { + this.ids[sGroup] = {}; + } + + var obj = this.ids[sGroup]; + if (obj && obj[oDD.id]) { + delete obj[oDD.id]; + } + }, + + /** + * Unregisters a drag and drop item. This is executed in + * DragDrop.unreg, use that method instead of calling this directly. + * @method _remove + * @private + * @static + */ + _remove: function(oDD) { + for (var g in oDD.groups) { + if (g && this.ids[g] && this.ids[g][oDD.id]) { + delete this.ids[g][oDD.id]; + } + } + delete this.handleIds[oDD.id]; + }, + + /** + * Each DragDrop handle element must be registered. This is done + * automatically when executing DragDrop.setHandleElId() + * @method regHandle + * @param {String} sDDId the DragDrop id this element is a handle for + * @param {String} sHandleId the id of the element that is the drag + * handle + * @static + */ + regHandle: function(sDDId, sHandleId) { + if (!this.handleIds[sDDId]) { + this.handleIds[sDDId] = {}; + } + this.handleIds[sDDId][sHandleId] = sHandleId; + }, + + /** + * Utility function to determine if a given element has been + * registered as a drag drop item. + * @method isDragDrop + * @param {String} id the element id to check + * @return {boolean} true if this element is a DragDrop item, + * false otherwise + * @static + */ + isDragDrop: function(id) { + return ( this.getDDById(id) ) ? true : false; + }, + + /** + * Returns the drag and drop instances that are in all groups the + * passed in instance belongs to. + * @method getRelated + * @param {DragDrop} p_oDD the obj to get related data for + * @param {boolean} bTargetsOnly if true, only return targetable objs + * @return {DragDrop[]} the related instances + * @static + */ + getRelated: function(p_oDD, bTargetsOnly) { + var oDDs = []; + for (var i in p_oDD.groups) { + for (var j in this.ids[i]) { + var dd = this.ids[i][j]; + if (! this.isTypeOfDD(dd)) { + continue; + } + if (!bTargetsOnly || dd.isTarget) { + oDDs[oDDs.length] = dd; + } + } + } + + return oDDs; + }, + + /** + * Returns true if the specified dd target is a legal target for + * the specifice drag obj + * @method isLegalTarget + * @param {DragDrop} oDD the drag obj + * @param {DragDrop} oTargetDD the target + * @return {boolean} true if the target is a legal target for the + * dd obj + * @static + */ + isLegalTarget: function (oDD, oTargetDD) { + var targets = this.getRelated(oDD, true); + for (var i=0, len=targets.length;i this.clickPixelThresh || + diffY > this.clickPixelThresh) { + this.startDrag(this.startX, this.startY); + } + } + + if (this.dragThreshMet) { + this.dragCurrent.b4Drag(e); + this.dragCurrent.onDrag(e); + if(!this.dragCurrent.moveOnly){ + this.fireEvents(e, false); + } + } + + this.stopEvent(e); + + return true; + }, + + /** + * Iterates over all of the DragDrop elements to find ones we are + * hovering over or dropping on + * @method fireEvents + * @param {Event} e the event + * @param {boolean} isDrop is this a drop op or a mouseover op? + * @private + * @static + */ + fireEvents: function(e, isDrop) { + var dc = this.dragCurrent; + + // If the user did the mouse up outside of the window, we could + // get here even though we have ended the drag. + if (!dc || dc.isLocked()) { + return; + } + + var pt = e.getPoint(); + + // cache the previous dragOver array + var oldOvers = []; + + var outEvts = []; + var overEvts = []; + var dropEvts = []; + var enterEvts = []; + + // Check to see if the object(s) we were hovering over is no longer + // being hovered over so we can fire the onDragOut event + for (var i in this.dragOvers) { + + var ddo = this.dragOvers[i]; + + if (! this.isTypeOfDD(ddo)) { + continue; + } + + if (! this.isOverTarget(pt, ddo, this.mode)) { + outEvts.push( ddo ); + } + + oldOvers[i] = true; + delete this.dragOvers[i]; + } + + for (var sGroup in dc.groups) { + + if ("string" != typeof sGroup) { + continue; + } + + for (i in this.ids[sGroup]) { + var oDD = this.ids[sGroup][i]; + if (! this.isTypeOfDD(oDD)) { + continue; + } + + if (oDD.isTarget && !oDD.isLocked() && ((oDD != dc) || (dc.ignoreSelf === false))) { + if (this.isOverTarget(pt, oDD, this.mode)) { + // look for drop interactions + if (isDrop) { + dropEvts.push( oDD ); + // look for drag enter and drag over interactions + } else { + + // initial drag over: dragEnter fires + if (!oldOvers[oDD.id]) { + enterEvts.push( oDD ); + // subsequent drag overs: dragOver fires + } else { + overEvts.push( oDD ); + } + + this.dragOvers[oDD.id] = oDD; + } + } + } + } + } + + if (this.mode) { + if (outEvts.length) { + dc.b4DragOut(e, outEvts); + dc.onDragOut(e, outEvts); + } + + if (enterEvts.length) { + dc.onDragEnter(e, enterEvts); + } + + if (overEvts.length) { + dc.b4DragOver(e, overEvts); + dc.onDragOver(e, overEvts); + } + + if (dropEvts.length) { + dc.b4DragDrop(e, dropEvts); + dc.onDragDrop(e, dropEvts); + } + + } else { + // fire dragout events + var len = 0; + for (i=0, len=outEvts.length; i + * Ext.dd.DragDropManager.refreshCache(ddinstance.groups); + * + * Alternatively: + * + * Ext.dd.DragDropManager.refreshCache({group1:true, group2:true}); + * + * @TODO this really should be an indexed array. Alternatively this + * method could accept both. + * @method refreshCache + * @param {Object} groups an associative array of groups to refresh + * @static + */ + refreshCache: function(groups) { + for (var sGroup in groups) { + if ("string" != typeof sGroup) { + continue; + } + for (var i in this.ids[sGroup]) { + var oDD = this.ids[sGroup][i]; + + if (this.isTypeOfDD(oDD)) { + // if (this.isTypeOfDD(oDD) && oDD.isTarget) { + var loc = this.getLocation(oDD); + if (loc) { + this.locationCache[oDD.id] = loc; + } else { + delete this.locationCache[oDD.id]; + // this will unregister the drag and drop object if + // the element is not in a usable state + // oDD.unreg(); + } + } + } + } + }, + + /** + * This checks to make sure an element exists and is in the DOM. The + * main purpose is to handle cases where innerHTML is used to remove + * drag and drop objects from the DOM. IE provides an 'unspecified + * error' when trying to access the offsetParent of such an element + * @method verifyEl + * @param {HTMLElement} el the element to check + * @return {boolean} true if the element looks usable + * @static + */ + verifyEl: function(el) { + if (el) { + var parent; + if(Ext.isIE){ + try{ + parent = el.offsetParent; + }catch(e){} + }else{ + parent = el.offsetParent; + } + if (parent) { + return true; + } + } + + return false; + }, + + /** + * Returns a Region object containing the drag and drop element's position + * and size, including the padding configured for it + * @method getLocation + * @param {DragDrop} oDD the drag and drop object to get the + * location for + * @return {Ext.util.Region} a Region object representing the total area + * the element occupies, including any padding + * the instance is configured for. + * @static + */ + getLocation: function(oDD) { + if (! this.isTypeOfDD(oDD)) { + return null; + } + + //delegate getLocation method to the + //drag and drop target. + if (oDD.getRegion) { + return oDD.getRegion(); + } + + var el = oDD.getEl(), pos, x1, x2, y1, y2, t, r, b, l; + + try { + pos= Ext.core.Element.getXY(el); + } catch (e) { } + + if (!pos) { + return null; + } + + x1 = pos[0]; + x2 = x1 + el.offsetWidth; + y1 = pos[1]; + y2 = y1 + el.offsetHeight; + + t = y1 - oDD.padding[0]; + r = x2 + oDD.padding[1]; + b = y2 + oDD.padding[2]; + l = x1 - oDD.padding[3]; + + return Ext.create('Ext.util.Region', t, r, b, l); + }, + + /** + * Checks the cursor location to see if it over the target + * @method isOverTarget + * @param {Ext.util.Point} pt The point to evaluate + * @param {DragDrop} oTarget the DragDrop object we are inspecting + * @return {boolean} true if the mouse is over the target + * @private + * @static + */ + isOverTarget: function(pt, oTarget, intersect) { + // use cache if available + var loc = this.locationCache[oTarget.id]; + if (!loc || !this.useCache) { + loc = this.getLocation(oTarget); + this.locationCache[oTarget.id] = loc; + + } + + if (!loc) { + return false; + } + + oTarget.cursorIsOver = loc.contains( pt ); + + // DragDrop is using this as a sanity check for the initial mousedown + // in this case we are done. In POINT mode, if the drag obj has no + // contraints, we are also done. Otherwise we need to evaluate the + // location of the target as related to the actual location of the + // dragged element. + var dc = this.dragCurrent; + if (!dc || !dc.getTargetCoord || + (!intersect && !dc.constrainX && !dc.constrainY)) { + return oTarget.cursorIsOver; + } + + oTarget.overlap = null; + + // Get the current location of the drag element, this is the + // location of the mouse event less the delta that represents + // where the original mousedown happened on the element. We + // need to consider constraints and ticks as well. + var pos = dc.getTargetCoord(pt.x, pt.y); + + var el = dc.getDragEl(); + var curRegion = Ext.create('Ext.util.Region', pos.y, + pos.x + el.offsetWidth, + pos.y + el.offsetHeight, + pos.x ); + + var overlap = curRegion.intersect(loc); + + if (overlap) { + oTarget.overlap = overlap; + return (intersect) ? true : oTarget.cursorIsOver; + } else { + return false; + } + }, + + /** + * unload event handler + * @method _onUnload + * @private + * @static + */ + _onUnload: function(e, me) { + Ext.dd.DragDropManager.unregAll(); + }, + + /** + * Cleans up the drag and drop events and objects. + * @method unregAll + * @private + * @static + */ + unregAll: function() { + + if (this.dragCurrent) { + this.stopDrag(); + this.dragCurrent = null; + } + + this._execOnAll("unreg", []); + + for (var i in this.elementCache) { + delete this.elementCache[i]; + } + + this.elementCache = {}; + this.ids = {}; + }, + + /** + * A cache of DOM elements + * @property elementCache + * @private + * @static + */ + elementCache: {}, + + /** + * Get the wrapper for the DOM element specified + * @method getElWrapper + * @param {String} id the id of the element to get + * @return {Ext.dd.DDM.ElementWrapper} the wrapped element + * @private + * @deprecated This wrapper isn't that useful + * @static + */ + getElWrapper: function(id) { + var oWrapper = this.elementCache[id]; + if (!oWrapper || !oWrapper.el) { + oWrapper = this.elementCache[id] = + new this.ElementWrapper(Ext.getDom(id)); + } + return oWrapper; + }, + + /** + * Returns the actual DOM element + * @method getElement + * @param {String} id the id of the elment to get + * @return {Object} The element + * @deprecated use Ext.lib.Ext.getDom instead + * @static + */ + getElement: function(id) { + return Ext.getDom(id); + }, + + /** + * Returns the style property for the DOM element (i.e., + * document.getElById(id).style) + * @method getCss + * @param {String} id the id of the elment to get + * @return {Object} The style property of the element + * @static + */ + getCss: function(id) { + var el = Ext.getDom(id); + return (el) ? el.style : null; + }, + + /** + * Inner class for cached elements + * @class Ext.dd.DragDropManager.ElementWrapper + * @for DragDropManager + * @private + * @deprecated + */ + ElementWrapper: function(el) { + /** + * The element + * @property el + */ + this.el = el || null; + /** + * The element id + * @property id + */ + this.id = this.el && el.id; + /** + * A reference to the style property + * @property css + */ + this.css = this.el && el.style; + }, + + /** + * Returns the X position of an html element + * @method getPosX + * @param el the element for which to get the position + * @return {int} the X coordinate + * @for DragDropManager + * @static + */ + getPosX: function(el) { + return Ext.core.Element.getX(el); + }, + + /** + * Returns the Y position of an html element + * @method getPosY + * @param el the element for which to get the position + * @return {int} the Y coordinate + * @static + */ + getPosY: function(el) { + return Ext.core.Element.getY(el); + }, + + /** + * Swap two nodes. In IE, we use the native method, for others we + * emulate the IE behavior + * @method swapNode + * @param n1 the first node to swap + * @param n2 the other node to swap + * @static + */ + swapNode: function(n1, n2) { + if (n1.swapNode) { + n1.swapNode(n2); + } else { + var p = n2.parentNode; + var s = n2.nextSibling; + + if (s == n1) { + p.insertBefore(n1, n2); + } else if (n2 == n1.nextSibling) { + p.insertBefore(n2, n1); + } else { + n1.parentNode.replaceChild(n2, n1); + p.insertBefore(n1, s); + } + } + }, + + /** + * Returns the current scroll position + * @method getScroll + * @private + * @static + */ + getScroll: function () { + var doc = window.document, + docEl = doc.documentElement, + body = doc.body, + top = 0, + left = 0; + + if (Ext.isGecko4) { + top = window.scrollYOffset; + left = window.scrollXOffset; + } else { + if (docEl && (docEl.scrollTop || docEl.scrollLeft)) { + top = docEl.scrollTop; + left = docEl.scrollLeft; + } else if (body) { + top = body.scrollTop; + left = body.scrollLeft; + } + } + return { + top: top, + left: left + }; + }, + + /** + * Returns the specified element style property + * @method getStyle + * @param {HTMLElement} el the element + * @param {string} styleProp the style property + * @return {string} The value of the style property + * @static + */ + getStyle: function(el, styleProp) { + return Ext.fly(el).getStyle(styleProp); + }, + + /** + * Gets the scrollTop + * @method getScrollTop + * @return {int} the document's scrollTop + * @static + */ + getScrollTop: function () { + return this.getScroll().top; + }, + + /** + * Gets the scrollLeft + * @method getScrollLeft + * @return {int} the document's scrollTop + * @static + */ + getScrollLeft: function () { + return this.getScroll().left; + }, + + /** + * Sets the x/y position of an element to the location of the + * target element. + * @method moveToEl + * @param {HTMLElement} moveEl The element to move + * @param {HTMLElement} targetEl The position reference element + * @static + */ + moveToEl: function (moveEl, targetEl) { + var aCoord = Ext.core.Element.getXY(targetEl); + Ext.core.Element.setXY(moveEl, aCoord); + }, + + /** + * Numeric array sort function + * @method numericSort + * @static + */ + numericSort: function(a, b) { + return (a - b); + }, + + /** + * Internal counter + * @property _timeoutCount + * @private + * @static + */ + _timeoutCount: 0, + + /** + * Trying to make the load order less important. Without this we get + * an error if this file is loaded before the Event Utility. + * @method _addListeners + * @private + * @static + */ + _addListeners: function() { + if ( document ) { + this._onLoad(); + } else { + if (this._timeoutCount > 2000) { + } else { + setTimeout(this._addListeners, 10); + if (document && document.body) { + this._timeoutCount += 1; + } + } + } + }, + + /** + * Recursively searches the immediate parent and all child nodes for + * the handle element in order to determine wheter or not it was + * clicked. + * @method handleWasClicked + * @param node the html element to inspect + * @static + */ + handleWasClicked: function(node, id) { + if (this.isHandle(id, node.id)) { + return true; + } else { + // check to see if this is a text node child of the one we want + var p = node.parentNode; + + while (p) { + if (this.isHandle(id, p.id)) { + return true; + } else { + p = p.parentNode; + } + } + } + + return false; + } +}, function() { + this._addListeners(); +}); + +/** + * @class Ext.layout.container.Box + * @extends Ext.layout.container.Container + *
Base Class for HBoxLayout and VBoxLayout Classes. Generally it should not need to be used directly.
+ */ + +Ext.define('Ext.layout.container.Box', { + + /* Begin Definitions */ + + alias: ['layout.box'], + extend: 'Ext.layout.container.Container', + alternateClassName: 'Ext.layout.BoxLayout', + + requires: [ + 'Ext.layout.container.boxOverflow.None', + 'Ext.layout.container.boxOverflow.Menu', + 'Ext.layout.container.boxOverflow.Scroller', + 'Ext.util.Format', + 'Ext.dd.DragDropManager' + ], + + /* End Definitions */ + + /** + * @cfg {Mixed} animate + *
If truthy, child Component are animated into position whenever the Container + * is layed out. If this option is numeric, it is used as the animation duration in milliseconds.
+ *
May be set as a property at any time.
+ */ + + /** + * @cfg {Object} defaultMargins + *
If the individual contained items do not have a margins + * property specified or margin specified via CSS, the default margins from this property will be + * applied to each item.
+ *
This property may be specified as an object containing margins + * to apply in the format:
+{ + top: (top margin), + right: (right margin), + bottom: (bottom margin), + left: (left margin) +}
+ *
This property may also be specified as a string containing + * space-separated, numeric margin values. The order of the sides associated + * with each value matches the way CSS processes margin values:
+ *
+ *
If there is only one value, it applies to all sides.
+ *
If there are two values, the top and bottom borders are set to the + * first value and the right and left are set to the second.
+ *
If there are three values, the top is set to the first value, the left + * and right are set to the second, and the bottom is set to the third.
+ *
If there are four values, they apply to the top, right, bottom, and + * left, respectively.
+ *
+ *
Defaults to:
+ * {top:0, right:0, bottom:0, left:0} + *
+ */ + defaultMargins: { + top: 0, + right: 0, + bottom: 0, + left: 0 + }, + + /** + * @cfg {String} padding + *
Sets the padding to be applied to all child items managed by this layout.
+ *
This property must be specified as a string containing + * space-separated, numeric padding values. The order of the sides associated + * with each value matches the way CSS processes padding values:
+ *
+ *
If there is only one value, it applies to all sides.
+ *
If there are two values, the top and bottom borders are set to the + * first value and the right and left are set to the second.
+ *
If there are three values, the top is set to the first value, the left + * and right are set to the second, and the bottom is set to the third.
+ *
If there are four values, they apply to the top, right, bottom, and + * left, respectively.
+ *
+ *
Defaults to: "0"
+ */ + padding: '0', + // documented in subclasses + pack: 'start', + + /** + * @cfg {String} pack + * Controls how the child items of the container are packed together. Acceptable configuration values + * for this property are: + *
+ *
start : Default
child items are packed together at + * left side of container
+ *
center :
child items are packed together at + * mid-width of container
+ *
end :
child items are packed together at right + * side of container
+ *
+ */ + /** + * @cfg {Number} flex + * This configuration option is to be applied to child items of the container managed + * by this layout. Each child item with a flex property will be flexed horizontally + * according to each item's relative flex value compared to the sum of all items with + * a flex value specified. Any child items that have either a flex = 0 or + * flex = undefined will not be 'flexed' (the initial size will not be changed). + */ + + type: 'box', + scrollOffset: 0, + itemCls: Ext.baseCSSPrefix + 'box-item', + targetCls: Ext.baseCSSPrefix + 'box-layout-ct', + innerCls: Ext.baseCSSPrefix + 'box-inner', + + bindToOwnerCtContainer: true, + + fixedLayout: false, + + // availableSpaceOffset is used to adjust the availableWidth, typically used + // to reserve space for a scrollbar + availableSpaceOffset: 0, + + // whether or not to reserve the availableSpaceOffset in layout calculations + reserveOffset: true, + + /** + * @cfg {Boolean} clearInnerCtOnLayout + */ + clearInnerCtOnLayout: false, + + flexSortFn: function (a, b) { + var maxParallelPrefix = 'max' + this.parallelPrefixCap, + infiniteValue = Infinity; + a = a.component[maxParallelPrefix] || infiniteValue; + b = b.component[maxParallelPrefix] || infiniteValue; + // IE 6/7 Don't like Infinity - Infinity... + if (!isFinite(a) && !isFinite(b)) { + return false; + } + return a - b; + }, + + // Sort into *descending* order. + minSizeSortFn: function(a, b) { + return b.available - a.available; + }, + + constructor: function(config) { + var me = this; + + me.callParent(arguments); + + // The sort function needs access to properties in this, so must be bound. + me.flexSortFn = Ext.Function.bind(me.flexSortFn, me); + + me.initOverflowHandler(); + }, + + /** + * @private + * Returns the current size and positioning of the passed child item. + * @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. + */ + getChildBox: function(child) { + child = child.el || this.owner.getComponent(child).el; + return { + left: child.getLeft(true), + top: child.getTop(true), + width: child.getWidth(), + height: child.getHeight() + }; + }, + + /** + * @private + * Calculates the size and positioning of the passed child item. + * @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. + */ + calculateChildBox: function(child) { + var me = this, + boxes = me.calculateChildBoxes(me.getVisibleItems(), me.getLayoutTargetSize()).boxes, + ln = boxes.length, + i = 0; + + child = me.owner.getComponent(child); + for (; i < ln; i++) { + if (boxes[i].component === child) { + return boxes[i]; + } + } + }, + + /** + * @private + * Calculates the size and positioning of each item in the box. This iterates over all of the rendered, + * visible items and returns a height, width, top and left for each, as well as a reference to each. Also + * returns meta data such as maxSize which are useful when resizing layout wrappers such as this.innerCt. + * @param {Array} visibleItems The array of all rendered, visible items to be calculated for + * @param {Object} targetSize Object containing target size and height + * @return {Object} Object containing box measurements for each child, plus meta data + */ + calculateChildBoxes: function(visibleItems, targetSize) { + var me = this, + math = Math, + mmax = math.max, + infiniteValue = Infinity, + undefinedValue, + + parallelPrefix = me.parallelPrefix, + parallelPrefixCap = me.parallelPrefixCap, + perpendicularPrefix = me.perpendicularPrefix, + perpendicularPrefixCap = me.perpendicularPrefixCap, + parallelMinString = 'min' + parallelPrefixCap, + perpendicularMinString = 'min' + perpendicularPrefixCap, + perpendicularMaxString = 'max' + perpendicularPrefixCap, + + parallelSize = targetSize[parallelPrefix] - me.scrollOffset, + perpendicularSize = targetSize[perpendicularPrefix], + padding = me.padding, + parallelOffset = padding[me.parallelBefore], + paddingParallel = parallelOffset + padding[me.parallelAfter], + perpendicularOffset = padding[me.perpendicularLeftTop], + paddingPerpendicular = perpendicularOffset + padding[me.perpendicularRightBottom], + availPerpendicularSize = mmax(0, perpendicularSize - paddingPerpendicular), + + isStart = me.pack == 'start', + isCenter = me.pack == 'center', + isEnd = me.pack == 'end', + + constrain = Ext.Number.constrain, + visibleCount = visibleItems.length, + nonFlexSize = 0, + totalFlex = 0, + desiredSize = 0, + minimumSize = 0, + maxSize = 0, + boxes = [], + minSizes = [], + calculatedWidth, + + i, child, childParallel, childPerpendicular, childMargins, childSize, minParallel, tmpObj, shortfall, + tooNarrow, availableSpace, minSize, item, length, itemIndex, box, oldSize, newSize, reduction, diff, + flexedBoxes, remainingSpace, remainingFlex, flexedSize, parallelMargins, calcs, offset, + perpendicularMargins, stretchSize; + + //gather the total flex of all flexed items and the width taken up by fixed width items + for (i = 0; i < visibleCount; i++) { + child = visibleItems[i]; + childPerpendicular = child[perpendicularPrefix]; + me.layoutItem(child); + childMargins = child.margins; + parallelMargins = childMargins[me.parallelBefore] + childMargins[me.parallelAfter]; + + // Create the box description object for this child item. + tmpObj = { + component: child, + margins: childMargins + }; + + // flex and not 'auto' width + if (child.flex) { + totalFlex += child.flex; + childParallel = undefinedValue; + } + // Not flexed or 'auto' width or undefined width + else { + if (!(child[parallelPrefix] && childPerpendicular)) { + childSize = child.getSize(); + } + childParallel = child[parallelPrefix] || childSize[parallelPrefix]; + childPerpendicular = childPerpendicular || childSize[perpendicularPrefix]; + } + + nonFlexSize += parallelMargins + (childParallel || 0); + desiredSize += parallelMargins + (child.flex ? child[parallelMinString] || 0 : childParallel); + minimumSize += parallelMargins + (child[parallelMinString] || childParallel || 0); + + // Max height for align - force layout of non-laid out subcontainers without a numeric height + if (typeof childPerpendicular != 'number') { + // Clear any static sizing and revert to flow so we can get a proper measurement + // child['set' + perpendicularPrefixCap](null); + childPerpendicular = child['get' + perpendicularPrefixCap](); + } + + // Track the maximum perpendicular size for use by the stretch and stretchmax align config values. + maxSize = mmax(maxSize, childPerpendicular + childMargins[me.perpendicularLeftTop] + childMargins[me.perpendicularRightBottom]); + + tmpObj[parallelPrefix] = childParallel || undefinedValue; + tmpObj[perpendicularPrefix] = childPerpendicular || undefinedValue; + boxes.push(tmpObj); + } + shortfall = desiredSize - parallelSize; + tooNarrow = minimumSize > parallelSize; + + //the space available to the flexed items + availableSpace = mmax(0, parallelSize - nonFlexSize - paddingParallel - (me.reserveOffset ? me.availableSpaceOffset : 0)); + + if (tooNarrow) { + for (i = 0; i < visibleCount; i++) { + box = boxes[i]; + minSize = visibleItems[i][parallelMinString] || visibleItems[i][parallelPrefix] || box[parallelPrefix]; + box.dirtySize = box.dirtySize || box[parallelPrefix] != minSize; + box[parallelPrefix] = minSize; + } + } + else { + //all flexed items should be sized to their minimum size, other items should be shrunk down until + //the shortfall has been accounted for + if (shortfall > 0) { + /* + * When we have a shortfall but are not tooNarrow, we need to shrink the width of each non-flexed item. + * Flexed items are immediately reduced to their minWidth and anything already at minWidth is ignored. + * The remaining items are collected into the minWidths array, which is later used to distribute the shortfall. + */ + for (i = 0; i < visibleCount; i++) { + item = visibleItems[i]; + minSize = item[parallelMinString] || 0; + + //shrink each non-flex tab by an equal amount to make them all fit. Flexed items are all + //shrunk to their minSize because they're flexible and should be the first to lose size + if (item.flex) { + box = boxes[i]; + box.dirtySize = box.dirtySize || box[parallelPrefix] != minSize; + box[parallelPrefix] = minSize; + } + else { + minSizes.push({ + minSize: minSize, + available: boxes[i][parallelPrefix] - minSize, + index: i + }); + } + } + + //sort by descending amount of width remaining before minWidth is reached + Ext.Array.sort(minSizes, me.minSizeSortFn); + + /* + * Distribute the shortfall (difference between total desired size of all items and actual size available) + * between the non-flexed items. We try to distribute the shortfall evenly, but apply it to items with the + * smallest difference between their size and minSize first, so that if reducing the size by the average + * amount would make that item less than its minSize, we carry the remainder over to the next item. + */ + for (i = 0, length = minSizes.length; i < length; i++) { + itemIndex = minSizes[i].index; + + if (itemIndex == undefinedValue) { + continue; + } + item = visibleItems[itemIndex]; + minSize = minSizes[i].minSize; + + box = boxes[itemIndex]; + oldSize = box[parallelPrefix]; + newSize = mmax(minSize, oldSize - math.ceil(shortfall / (length - i))); + reduction = oldSize - newSize; + + box.dirtySize = box.dirtySize || box[parallelPrefix] != newSize; + box[parallelPrefix] = newSize; + shortfall -= reduction; + } + } + else { + remainingSpace = availableSpace; + remainingFlex = totalFlex; + flexedBoxes = []; + + // Create an array containing *just the flexed boxes* for allocation of remainingSpace + for (i = 0; i < visibleCount; i++) { + child = visibleItems[i]; + if (isStart && child.flex) { + flexedBoxes.push(boxes[Ext.Array.indexOf(visibleItems, child)]); + } + } + // The flexed boxes need to be sorted in ascending order of maxSize to work properly + // so that unallocated space caused by maxWidth being less than flexed width + // can be reallocated to subsequent flexed boxes. + Ext.Array.sort(flexedBoxes, me.flexSortFn); + + // Calculate the size of each flexed item, and attempt to set it. + for (i = 0; i < flexedBoxes.length; i++) { + calcs = flexedBoxes[i]; + child = calcs.component; + childMargins = calcs.margins; + + flexedSize = math.ceil((child.flex / remainingFlex) * remainingSpace); + + // Implement maxSize and minSize check + flexedSize = Math.max(child['min' + parallelPrefixCap] || 0, math.min(child['max' + parallelPrefixCap] || infiniteValue, flexedSize)); + + // Remaining space has already had all parallel margins subtracted from it, so just subtract consumed size + remainingSpace -= flexedSize; + remainingFlex -= child.flex; + + calcs.dirtySize = calcs.dirtySize || calcs[parallelPrefix] != flexedSize; + calcs[parallelPrefix] = flexedSize; + } + } + } + + if (isCenter) { + parallelOffset += availableSpace / 2; + } + else if (isEnd) { + parallelOffset += availableSpace; + } + + // Fix for left and right docked Components in a dock component layout. This is for docked Headers and docked Toolbars. + // Older Microsoft browsers do not size a position:absolute element's width to match its content. + // So in this case, in the updateInnerCtSize method we may need to adjust the size of the owning Container's element explicitly based upon + // the discovered max width. So here we put a calculatedWidth property in the metadata to facilitate this. + if (me.owner.dock && (Ext.isIE6 || Ext.isIE7 || Ext.isIEQuirks) && !me.owner.width && me.direction == 'vertical') { + + calculatedWidth = maxSize + me.owner.el.getPadding('lr') + me.owner.el.getBorderWidth('lr'); + if (me.owner.frameSize) { + calculatedWidth += me.owner.frameSize.left + me.owner.frameSize.right; + } + // If the owning element is not sized, calculate the available width to center or stretch in based upon maxSize + availPerpendicularSize = Math.min(availPerpendicularSize, targetSize.width = maxSize + padding.left + padding.right); + } + + //finally, calculate the left and top position of each item + for (i = 0; i < visibleCount; i++) { + child = visibleItems[i]; + calcs = boxes[i]; + + childMargins = calcs.margins; + + perpendicularMargins = childMargins[me.perpendicularLeftTop] + childMargins[me.perpendicularRightBottom]; + + // Advance past the "before" margin + parallelOffset += childMargins[me.parallelBefore]; + + calcs[me.parallelBefore] = parallelOffset; + calcs[me.perpendicularLeftTop] = perpendicularOffset + childMargins[me.perpendicularLeftTop]; + + if (me.align == 'stretch') { + stretchSize = constrain(availPerpendicularSize - perpendicularMargins, child[perpendicularMinString] || 0, child[perpendicularMaxString] || infiniteValue); + calcs.dirtySize = calcs.dirtySize || calcs[perpendicularPrefix] != stretchSize; + calcs[perpendicularPrefix] = stretchSize; + } + else if (me.align == 'stretchmax') { + stretchSize = constrain(maxSize - perpendicularMargins, child[perpendicularMinString] || 0, child[perpendicularMaxString] || infiniteValue); + calcs.dirtySize = calcs.dirtySize || calcs[perpendicularPrefix] != stretchSize; + calcs[perpendicularPrefix] = stretchSize; + } + else if (me.align == me.alignCenteringString) { + // When calculating a centered position within the content box of the innerCt, the width of the borders must be subtracted from + // the size to yield the space available to center within. + // The updateInnerCtSize method explicitly adds the border widths to the set size of the innerCt. + diff = mmax(availPerpendicularSize, maxSize) - me.innerCt.getBorderWidth(me.perpendicularLT + me.perpendicularRB) - calcs[perpendicularPrefix]; + if (diff > 0) { + calcs[me.perpendicularLeftTop] = perpendicularOffset + Math.round(diff / 2); + } + } + + // Advance past the box size and the "after" margin + parallelOffset += (calcs[parallelPrefix] || 0) + childMargins[me.parallelAfter]; + } + + return { + boxes: boxes, + meta : { + calculatedWidth: calculatedWidth, + maxSize: maxSize, + nonFlexSize: nonFlexSize, + desiredSize: desiredSize, + minimumSize: minimumSize, + shortfall: shortfall, + tooNarrow: tooNarrow + } + }; + }, + + onRemove: function(comp){ + this.callParent(arguments); + if (this.overflowHandler) { + this.overflowHandler.onRemove(comp); + } + }, + + /** + * @private + */ + initOverflowHandler: function() { + var handler = this.overflowHandler; + + if (typeof handler == 'string') { + handler = { + type: handler + }; + } + + var handlerType = 'None'; + if (handler && handler.type !== undefined) { + handlerType = handler.type; + } + + var constructor = Ext.layout.container.boxOverflow[handlerType]; + if (constructor[this.type]) { + constructor = constructor[this.type]; + } + + this.overflowHandler = Ext.create('Ext.layout.container.boxOverflow.' + handlerType, this, handler); + }, + + /** + * @private + * Runs the child box calculations and caches them in childBoxCache. Subclasses can used these cached values + * when laying out + */ + onLayout: function() { + this.callParent(); + // Clear the innerCt size so it doesn't influence the child items. + if (this.clearInnerCtOnLayout === true && this.adjustmentPass !== true) { + this.innerCt.setSize(null, null); + } + + var me = this, + targetSize = me.getLayoutTargetSize(), + items = me.getVisibleItems(), + calcs = me.calculateChildBoxes(items, targetSize), + boxes = calcs.boxes, + meta = calcs.meta, + handler, method, results; + + if (me.autoSize && calcs.meta.desiredSize) { + targetSize[me.parallelPrefix] = calcs.meta.desiredSize; + } + + //invoke the overflow handler, if one is configured + if (meta.shortfall > 0) { + handler = me.overflowHandler; + method = meta.tooNarrow ? 'handleOverflow': 'clearOverflow'; + + results = handler[method](calcs, targetSize); + + if (results) { + if (results.targetSize) { + targetSize = results.targetSize; + } + + if (results.recalculate) { + items = me.getVisibleItems(owner); + calcs = me.calculateChildBoxes(items, targetSize); + boxes = calcs.boxes; + } + } + } else { + me.overflowHandler.clearOverflow(); + } + + /** + * @private + * @property layoutTargetLastSize + * @type Object + * Private cache of the last measured size of the layout target. This should never be used except by + * BoxLayout subclasses during their onLayout run. + */ + me.layoutTargetLastSize = targetSize; + + /** + * @private + * @property childBoxCache + * @type Array + * Array of the last calculated height, width, top and left positions of each visible rendered component + * within the Box layout. + */ + me.childBoxCache = calcs; + + me.updateInnerCtSize(targetSize, calcs); + me.updateChildBoxes(boxes); + me.handleTargetOverflow(targetSize); + }, + + /** + * Resizes and repositions each child component + * @param {Array} boxes The box measurements + */ + updateChildBoxes: function(boxes) { + var me = this, + i = 0, + length = boxes.length, + animQueue = [], + dd = Ext.dd.DDM.getDDById(me.innerCt.id), // Any DD active on this layout's element (The BoxReorderer plugin does this.) + oldBox, newBox, changed, comp, boxAnim, animCallback; + + for (; i < length; i++) { + newBox = boxes[i]; + comp = newBox.component; + + // If a Component is being drag/dropped, skip positioning it. + // Accomodate the BoxReorderer plugin: Its current dragEl must not be positioned by the layout + if (dd && (dd.getDragEl() === comp.el.dom)) { + continue; + } + + changed = false; + + oldBox = me.getChildBox(comp); + + // If we are animating, we build up an array of Anim config objects, one for each + // child Component which has any changed box properties. Those with unchanged + // properties are not animated. + if (me.animate) { + // Animate may be a config object containing callback. + animCallback = me.animate.callback || me.animate; + boxAnim = { + layoutAnimation: true, // Component Target handler must use set*Calculated*Size + target: comp, + from: {}, + to: {}, + listeners: {} + }; + // Only set from and to properties when there's a change. + // Perform as few Component setter methods as possible. + // Temporarily set the property values that we are not animating + // so that doComponentLayout does not auto-size them. + if (!isNaN(newBox.width) && (newBox.width != oldBox.width)) { + changed = true; + // boxAnim.from.width = oldBox.width; + boxAnim.to.width = newBox.width; + } + if (!isNaN(newBox.height) && (newBox.height != oldBox.height)) { + changed = true; + // boxAnim.from.height = oldBox.height; + boxAnim.to.height = newBox.height; + } + if (!isNaN(newBox.left) && (newBox.left != oldBox.left)) { + changed = true; + // boxAnim.from.left = oldBox.left; + boxAnim.to.left = newBox.left; + } + if (!isNaN(newBox.top) && (newBox.top != oldBox.top)) { + changed = true; + // boxAnim.from.top = oldBox.top; + boxAnim.to.top = newBox.top; + } + if (changed) { + animQueue.push(boxAnim); + } + } else { + if (newBox.dirtySize) { + if (newBox.width !== oldBox.width || newBox.height !== oldBox.height) { + me.setItemSize(comp, newBox.width, newBox.height); + } + } + // Don't set positions to NaN + if (isNaN(newBox.left) || isNaN(newBox.top)) { + continue; + } + comp.setPosition(newBox.left, newBox.top); + } + } + + // Kick off any queued animations + length = animQueue.length; + if (length) { + + // A function which cleans up when a Component's animation is done. + // The last one to finish calls the callback. + var afterAnimate = function(anim) { + // When we've animated all changed boxes into position, clear our busy flag and call the callback. + length -= 1; + if (!length) { + me.layoutBusy = false; + if (Ext.isFunction(animCallback)) { + animCallback(); + } + } + }; + + var beforeAnimate = function() { + me.layoutBusy = true; + }; + + // Start each box animation off + for (i = 0, length = animQueue.length; i < length; i++) { + boxAnim = animQueue[i]; + + // Clean up the Component after. Clean up the *layout* after the last animation finishes + boxAnim.listeners.afteranimate = afterAnimate; + + // The layout is busy during animation, and may not be called, so set the flag when the first animation begins + if (!i) { + boxAnim.listeners.beforeanimate = beforeAnimate; + } + if (me.animate.duration) { + boxAnim.duration = me.animate.duration; + } + comp = boxAnim.target; + delete boxAnim.target; + // Stop any currently running animation + comp.stopAnimation(); + comp.animate(boxAnim); + } + } + }, + + /** + * @private + * Called by onRender just before the child components are sized and positioned. This resizes the innerCt + * to make sure all child items fit within it. We call this before sizing the children because if our child + * items are larger than the previous innerCt size the browser will insert scrollbars and then remove them + * again immediately afterwards, giving a performance hit. + * Subclasses should provide an implementation. + * @param {Object} currentSize The current height and width of the innerCt + * @param {Array} calculations The new box calculations of all items to be laid out + */ + updateInnerCtSize: function(tSize, calcs) { + var me = this, + mmax = Math.max, + align = me.align, + padding = me.padding, + width = tSize.width, + height = tSize.height, + meta = calcs.meta, + innerCtWidth, + innerCtHeight; + + if (me.direction == 'horizontal') { + innerCtWidth = width; + innerCtHeight = meta.maxSize + padding.top + padding.bottom + me.innerCt.getBorderWidth('tb'); + + if (align == 'stretch') { + innerCtHeight = height; + } + else if (align == 'middle') { + innerCtHeight = mmax(height, innerCtHeight); + } + } else { + innerCtHeight = height; + innerCtWidth = meta.maxSize + padding.left + padding.right + me.innerCt.getBorderWidth('lr'); + + if (align == 'stretch') { + innerCtWidth = width; + } + else if (align == 'center') { + innerCtWidth = mmax(width, innerCtWidth); + } + } + me.getRenderTarget().setSize(innerCtWidth || undefined, innerCtHeight || undefined); + + // If a calculated width has been found (and this only happens for auto-width vertical docked Components in old Microsoft browsers) + // then, if the Component has not assumed the size of its content, set it to do so. + if (meta.calculatedWidth && me.owner.el.getWidth() > meta.calculatedWidth) { + me.owner.el.setWidth(meta.calculatedWidth); + } + + if (me.innerCt.dom.scrollTop) { + me.innerCt.dom.scrollTop = 0; + } + }, + + /** + * @private + * This should be called after onLayout of any BoxLayout subclass. If the target's overflow is not set to 'hidden', + * we need to lay out a second time because the scrollbars may have modified the height and width of the layout + * target. Having a Box layout inside such a target is therefore not recommended. + * @param {Object} previousTargetSize The size and height of the layout target before we just laid out + * @param {Ext.container.Container} container The container + * @param {Ext.core.Element} target The target element + * @return True if the layout overflowed, and was reflowed in a secondary onLayout call. + */ + handleTargetOverflow: function(previousTargetSize) { + var target = this.getTarget(), + overflow = target.getStyle('overflow'), + newTargetSize; + + if (overflow && overflow != 'hidden' && !this.adjustmentPass) { + newTargetSize = this.getLayoutTargetSize(); + if (newTargetSize.width != previousTargetSize.width || newTargetSize.height != previousTargetSize.height) { + this.adjustmentPass = true; + this.onLayout(); + return true; + } + } + + delete this.adjustmentPass; + }, + + // private + isValidParent : function(item, target, position) { + // Note: Box layouts do not care about order within the innerCt element because it's an absolutely positioning layout + // We only care whether the item is a direct child of the innerCt element. + var itemEl = item.el ? item.el.dom : Ext.getDom(item); + return (itemEl && this.innerCt && itemEl.parentNode === this.innerCt.dom) || false; + }, + + // Overridden method from AbstractContainer. + // Used in the base AbstractLayout.beforeLayout method to render all items into. + getRenderTarget: function() { + if (!this.innerCt) { + // the innerCt prevents wrapping and shuffling while the container is resizing + this.innerCt = this.getTarget().createChild({ + cls: this.innerCls, + role: 'presentation' + }); + this.padding = Ext.util.Format.parseBox(this.padding); + } + return this.innerCt; + }, + + // private + renderItem: function(item, target) { + this.callParent(arguments); + var me = this, + itemEl = item.getEl(), + style = itemEl.dom.style, + margins = item.margins || item.margin; + + // Parse the item's margin/margins specification + if (margins) { + if (Ext.isString(margins) || Ext.isNumber(margins)) { + margins = Ext.util.Format.parseBox(margins); + } else { + Ext.applyIf(margins, {top: 0, right: 0, bottom: 0, left: 0}); + } + } else { + margins = Ext.apply({}, me.defaultMargins); + } + + // Add any before/after CSS margins to the configured margins, and zero the CSS margins + margins.top += itemEl.getMargin('t'); + margins.right += itemEl.getMargin('r'); + margins.bottom += itemEl.getMargin('b'); + margins.left += itemEl.getMargin('l'); + style.marginTop = style.marginRight = style.marginBottom = style.marginLeft = '0'; + + // Item must reference calculated margins. + item.margins = margins; + }, + + /** + * @private + */ + destroy: function() { + Ext.destroy(this.overflowHandler); + this.callParent(arguments); + } +}); +/** + * @class Ext.layout.container.HBox + * @extends Ext.layout.container.Box + *
A layout that arranges items horizontally across a Container. This layout optionally divides available horizontal + * space between child items containing a numeric flex configuration.
+ * This layout may also be used to set the heights of child items by configuring it with the {@link #align} option. + * {@img Ext.layout.container.HBox/Ext.layout.container.HBox.png Ext.layout.container.HBox container layout} + * Example usage: + Ext.create('Ext.Panel', { + width: 500, + height: 300, + title: "HBoxLayout Panel", + layout: { + type: 'hbox', + align: 'stretch' + }, + renderTo: document.body, + items: [{ + xtype: 'panel', + title: 'Inner Panel One', + flex: 2 + },{ + xtype: 'panel', + title: 'Inner Panel Two', + flex: 1 + },{ + xtype: 'panel', + title: 'Inner Panel Three', + flex: 1 + }] + }); + */ +Ext.define('Ext.layout.container.HBox', { + + /* Begin Definitions */ + + alias: ['layout.hbox'], + extend: 'Ext.layout.container.Box', + alternateClassName: 'Ext.layout.HBoxLayout', + + /* End Definitions */ + + /** + * @cfg {String} align + * Controls how the child items of the container are aligned. Acceptable configuration values for this + * property are: + *
+ *
top : Default
child items are aligned vertically + * at the top of the container
+ *
middle :
child items are aligned vertically in the + * middle of the container
+ *
stretch :
child items are stretched vertically to fill + * the height of the container
+ *
stretchmax :
child items are stretched vertically to + * the height of the largest item.
+ *
+ */ + align: 'top', // top, middle, stretch, strechmax + + //@private + alignCenteringString: 'middle', + + type : 'hbox', + + direction: 'horizontal', + + // When creating an argument list to setSize, use this order + parallelSizeIndex: 0, + perpendicularSizeIndex: 1, + + parallelPrefix: 'width', + parallelPrefixCap: 'Width', + parallelLT: 'l', + parallelRB: 'r', + parallelBefore: 'left', + parallelBeforeCap: 'Left', + parallelAfter: 'right', + parallelPosition: 'x', + + perpendicularPrefix: 'height', + perpendicularPrefixCap: 'Height', + perpendicularLT: 't', + perpendicularRB: 'b', + perpendicularLeftTop: 'top', + perpendicularRightBottom: 'bottom', + perpendicularPosition: 'y' +}); +/** + * @class Ext.layout.container.VBox + * @extends Ext.layout.container.Box + *
A layout that arranges items vertically down a Container. This layout optionally divides available vertical + * space between child items containing a numeric flex configuration.
+ * This layout may also be used to set the widths of child items by configuring it with the {@link #align} option. + * {@img Ext.layout.container.VBox/Ext.layout.container.VBox.png Ext.layout.container.VBox container layout} + * Example usage: + Ext.create('Ext.Panel', { + width: 500, + height: 400, + title: "VBoxLayout Panel", + layout: { + type: 'vbox', + align: 'center' + }, + renderTo: document.body, + items: [{ + xtype: 'panel', + title: 'Inner Panel One', + width: 250, + flex: 2 + },{ + xtype: 'panel', + title: 'Inner Panel Two', + width: 250, + flex: 4 + },{ + xtype: 'panel', + title: 'Inner Panel Three', + width: '50%', + flex: 4 + }] + }); + */ +Ext.define('Ext.layout.container.VBox', { + + /* Begin Definitions */ + + alias: ['layout.vbox'], + extend: 'Ext.layout.container.Box', + alternateClassName: 'Ext.layout.VBoxLayout', + + /* End Definitions */ + + /** + * @cfg {String} align + * Controls how the child items of the container are aligned. Acceptable configuration values for this + * property are: + *
+ *
left : Default
child items are aligned horizontally + * at the left side of the container
+ *
center :
child items are aligned horizontally at the + * mid-width of the container
+ *
stretch :
child items are stretched horizontally to fill + * the width of the container
+ *
stretchmax :
child items are stretched horizontally to + * the size of the largest item.
+ *
+ */ + align : 'left', // left, center, stretch, strechmax + + //@private + alignCenteringString: 'center', + + type: 'vbox', + + direction: 'vertical', + + // When creating an argument list to setSize, use this order + parallelSizeIndex: 1, + perpendicularSizeIndex: 0, + + parallelPrefix: 'height', + parallelPrefixCap: 'Height', + parallelLT: 't', + parallelRB: 'b', + parallelBefore: 'top', + parallelBeforeCap: 'Top', + parallelAfter: 'bottom', + parallelPosition: 'y', + + perpendicularPrefix: 'width', + perpendicularPrefixCap: 'Width', + perpendicularLT: 'l', + perpendicularRB: 'r', + perpendicularLeftTop: 'left', + perpendicularRightBottom: 'right', + perpendicularPosition: 'x' +}); +/** + * @class Ext.FocusManager + +The FocusManager is responsible for globally: + +1. Managing component focus +2. Providing basic keyboard navigation +3. (optional) Provide a visual cue for focused components, in the form of a focus ring/frame. + +To activate the FocusManager, simply call {@link #enable `Ext.FocusManager.enable();`}. In turn, you may +deactivate the FocusManager by subsequently calling {@link #disable `Ext.FocusManager.disable();`}. The +FocusManager is disabled by default. + +To enable the optional focus frame, pass `true` or `{focusFrame: true}` to {@link #enable}. + +Another feature of the FocusManager is to provide basic keyboard focus navigation scoped to any {@link Ext.container.Container} +that would like to have navigation between its child {@link Ext.Component}'s. The {@link Ext.container.Container} can simply +call {@link #subscribe Ext.FocusManager.subscribe} to take advantage of this feature, and can at any time call +{@link #unsubscribe Ext.FocusManager.unsubscribe} to turn the navigation off. + + * @singleton + * @markdown + * @author Jarred Nicholls + * @docauthor Jarred Nicholls + */ +Ext.define('Ext.FocusManager', { + singleton: true, + alternateClassName: 'Ext.FocusMgr', + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: [ + 'Ext.ComponentManager', + 'Ext.ComponentQuery', + 'Ext.util.HashMap', + 'Ext.util.KeyNav' + ], + + /** + * @property {Boolean} enabled + * Whether or not the FocusManager is currently enabled + */ + enabled: false, + + /** + * @property {Ext.Component} focusedCmp + * The currently focused component. Defaults to `undefined`. + * @markdown + */ + + focusElementCls: Ext.baseCSSPrefix + 'focus-element', + + focusFrameCls: Ext.baseCSSPrefix + 'focus-frame', + + /** + * @property {Array} whitelist + * A list of xtypes that should ignore certain navigation input keys and + * allow for the default browser event/behavior. These input keys include: + * + * 1. Backspace + * 2. Delete + * 3. Left + * 4. Right + * 5. Up + * 6. Down + * + * The FocusManager will not attempt to navigate when a component is an xtype (or descendents thereof) + * that belongs to this whitelist. E.g., an {@link Ext.form.field.Text} should allow + * the user to move the input cursor left and right, and to delete characters, etc. + * + * This whitelist currently defaults to `['textfield']`. + * @markdown + */ + whitelist: [ + 'textfield' + ], + + tabIndexWhitelist: [ + 'a', + 'button', + 'embed', + 'frame', + 'iframe', + 'img', + 'input', + 'object', + 'select', + 'textarea' + ], + + constructor: function() { + var me = this, + CQ = Ext.ComponentQuery; + + me.addEvents( + /** + * @event beforecomponentfocus + * Fires before a component becomes focused. Return `false` to prevent + * the component from gaining focus. + * @param {Ext.FocusManager} fm A reference to the FocusManager singleton + * @param {Ext.Component} cmp The component that is being focused + * @param {Ext.Component} previousCmp The component that was previously focused, + * or `undefined` if there was no previously focused component. + * @markdown + */ + 'beforecomponentfocus', + + /** + * @event componentfocus + * Fires after a component becomes focused. + * @param {Ext.FocusManager} fm A reference to the FocusManager singleton + * @param {Ext.Component} cmp The component that has been focused + * @param {Ext.Component} previousCmp The component that was previously focused, + * or `undefined` if there was no previously focused component. + * @markdown + */ + 'componentfocus', + + /** + * @event disable + * Fires when the FocusManager is disabled + * @param {Ext.FocusManager} fm A reference to the FocusManager singleton + */ + 'disable', + + /** + * @event enable + * Fires when the FocusManager is enabled + * @param {Ext.FocusManager} fm A reference to the FocusManager singleton + */ + 'enable' + ); + + // Setup KeyNav that's bound to document to catch all + // unhandled/bubbled key events for navigation + me.keyNav = Ext.create('Ext.util.KeyNav', Ext.getDoc(), { + disabled: true, + scope: me, + + backspace: me.focusLast, + enter: me.navigateIn, + esc: me.navigateOut, + tab: me.navigateSiblings + + //space: me.navigateIn, + //del: me.focusLast, + //left: me.navigateSiblings, + //right: me.navigateSiblings, + //down: me.navigateSiblings, + //up: me.navigateSiblings + }); + + me.focusData = {}; + me.subscribers = Ext.create('Ext.util.HashMap'); + me.focusChain = {}; + + // Setup some ComponentQuery pseudos + Ext.apply(CQ.pseudos, { + focusable: function(cmps) { + var len = cmps.length, + results = [], + i = 0, + c, + + isFocusable = function(x) { + return x && x.focusable !== false && CQ.is(x, '[rendered]:not([destroying]):not([isDestroyed]):not([disabled]){isVisible(true)}{el && c.el.dom && c.el.isVisible()}'); + }; + + for (; i < len; i++) { + c = cmps[i]; + if (isFocusable(c)) { + results.push(c); + } + } + + return results; + }, + + nextFocus: function(cmps, idx, step) { + step = step || 1; + idx = parseInt(idx, 10); + + var len = cmps.length, + i = idx + step, + c; + + for (; i != idx; i += step) { + if (i >= len) { + i = 0; + } else if (i < 0) { + i = len - 1; + } + + c = cmps[i]; + if (CQ.is(c, ':focusable')) { + return [c]; + } else if (c.placeholder && CQ.is(c.placeholder, ':focusable')) { + return [c.placeholder]; + } + } + + return []; + }, + + prevFocus: function(cmps, idx) { + return this.nextFocus(cmps, idx, -1); + }, + + root: function(cmps) { + var len = cmps.length, + results = [], + i = 0, + c; + + for (; i < len; i++) { + c = cmps[i]; + if (!c.ownerCt) { + results.push(c); + } + } + + return results; + } + }); + }, + + /** + * Adds the specified xtype to the {@link #whitelist}. + * @param {String/Array} xtype Adds the xtype(s) to the {@link #whitelist}. + */ + addXTypeToWhitelist: function(xtype) { + var me = this; + + if (Ext.isArray(xtype)) { + Ext.Array.forEach(xtype, me.addXTypeToWhitelist, me); + return; + } + + if (!Ext.Array.contains(me.whitelist, xtype)) { + me.whitelist.push(xtype); + } + }, + + clearComponent: function(cmp) { + clearTimeout(this.cmpFocusDelay); + if (!cmp.isDestroyed) { + cmp.blur(); + } + }, + + /** + * Disables the FocusManager by turning of all automatic focus management and keyboard navigation + */ + disable: function() { + var me = this; + + if (!me.enabled) { + return; + } + + delete me.options; + me.enabled = false; + + Ext.ComponentManager.all.un('add', me.onComponentCreated, me); + + me.removeDOM(); + + // Stop handling key navigation + me.keyNav.disable(); + + // disable focus for all components + me.setFocusAll(false); + + me.fireEvent('disable', me); + }, + + /** + * Enables the FocusManager by turning on all automatic focus management and keyboard navigation + * @param {Boolean/Object} options Either `true`/`false` to turn on the focus frame, or an object of the following options: + - focusFrame : Boolean + `true` to show the focus frame around a component when it is focused. Defaults to `false`. + * @markdown + */ + enable: function(options) { + var me = this; + + if (options === true) { + options = { focusFrame: true }; + } + me.options = options = options || {}; + + if (me.enabled) { + return; + } + + // Handle components that are newly added after we are enabled + Ext.ComponentManager.all.on('add', me.onComponentCreated, me); + + me.initDOM(options); + + // Start handling key navigation + me.keyNav.enable(); + + // enable focus for all components + me.setFocusAll(true, options); + + // Finally, let's focus our global focus el so we start fresh + me.focusEl.focus(); + delete me.focusedCmp; + + me.enabled = true; + me.fireEvent('enable', me); + }, + + focusLast: function(e) { + var me = this; + + if (me.isWhitelisted(me.focusedCmp)) { + return true; + } + + // Go back to last focused item + if (me.previousFocusedCmp) { + me.previousFocusedCmp.focus(); + } + }, + + getRootComponents: function() { + var me = this, + CQ = Ext.ComponentQuery, + inline = CQ.query(':focusable:root:not([floating])'), + floating = CQ.query(':focusable:root[floating]'); + + // Floating items should go to the top of our root stack, and be ordered + // by their z-index (highest first) + floating.sort(function(a, b) { + return a.el.getZIndex() > b.el.getZIndex(); + }); + + return floating.concat(inline); + }, + + initDOM: function(options) { + var me = this, + sp = ' ', + cls = me.focusFrameCls; + + if (!Ext.isReady) { + Ext.onReady(me.initDOM, me); + return; + } + + // Create global focus element + if (!me.focusEl) { + me.focusEl = Ext.getBody().createChild({ + tabIndex: '-1', + cls: me.focusElementCls, + html: sp + }); + } + + // Create global focus frame + if (!me.focusFrame && options.focusFrame) { + me.focusFrame = Ext.getBody().createChild({ + cls: cls, + children: [ + { cls: cls + '-top' }, + { cls: cls + '-bottom' }, + { cls: cls + '-left' }, + { cls: cls + '-right' } + ], + style: 'top: -100px; left: -100px;' + }); + me.focusFrame.setVisibilityMode(Ext.core.Element.DISPLAY); + me.focusFrameWidth = me.focusFrame.child('.' + cls + '-top').getHeight(); + me.focusFrame.hide().setLeftTop(0, 0); + } + }, + + isWhitelisted: function(cmp) { + return cmp && Ext.Array.some(this.whitelist, function(x) { + return cmp.isXType(x); + }); + }, + + navigateIn: function(e) { + var me = this, + focusedCmp = me.focusedCmp, + rootCmps, + firstChild; + + if (!focusedCmp) { + // No focus yet, so focus the first root cmp on the page + rootCmps = me.getRootComponents(); + if (rootCmps.length) { + rootCmps[0].focus(); + } + } else { + // Drill into child ref items of the focused cmp, if applicable. + // This works for any Component with a getRefItems implementation. + firstChild = Ext.ComponentQuery.query('>:focusable', focusedCmp)[0]; + if (firstChild) { + firstChild.focus(); + } else { + // Let's try to fire a click event, as if it came from the mouse + if (Ext.isFunction(focusedCmp.onClick)) { + e.button = 0; + focusedCmp.onClick(e); + focusedCmp.focus(); + } + } + } + }, + + navigateOut: function(e) { + var me = this, + parent; + + if (!me.focusedCmp || !(parent = me.focusedCmp.up(':focusable'))) { + me.focusEl.focus(); + return; + } + + parent.focus(); + }, + + navigateSiblings: function(e, source, parent) { + var me = this, + src = source || me, + key = e.getKey(), + EO = Ext.EventObject, + goBack = e.shiftKey || key == EO.LEFT || key == EO.UP, + checkWhitelist = key == EO.LEFT || key == EO.RIGHT || key == EO.UP || key == EO.DOWN, + nextSelector = goBack ? 'prev' : 'next', + idx, next, focusedCmp; + + focusedCmp = (src.focusedCmp && src.focusedCmp.comp) || src.focusedCmp; + if (!focusedCmp && !parent) { + return; + } + + if (checkWhitelist && me.isWhitelisted(focusedCmp)) { + return true; + } + + parent = parent || focusedCmp.up(); + if (parent) { + idx = focusedCmp ? Ext.Array.indexOf(parent.getRefItems(), focusedCmp) : -1; + next = Ext.ComponentQuery.query('>:' + nextSelector + 'Focus(' + idx + ')', parent)[0]; + if (next && focusedCmp !== next) { + next.focus(); + return next; + } + } + }, + + onComponentBlur: function(cmp, e) { + var me = this; + + if (me.focusedCmp === cmp) { + me.previousFocusedCmp = cmp; + delete me.focusedCmp; + } + + if (me.focusFrame) { + me.focusFrame.hide(); + } + }, + + onComponentCreated: function(hash, id, cmp) { + this.setFocus(cmp, true, this.options); + }, + + onComponentDestroy: function(cmp) { + this.setFocus(cmp, false); + }, + + onComponentFocus: function(cmp, e) { + var me = this, + chain = me.focusChain; + + if (!Ext.ComponentQuery.is(cmp, ':focusable')) { + me.clearComponent(cmp); + + // Check our focus chain, so we don't run into a never ending recursion + // If we've attempted (unsuccessfully) to focus this component before, + // then we're caught in a loop of child->parent->...->child and we + // need to cut the loop off rather than feed into it. + if (chain[cmp.id]) { + return; + } + + // Try to focus the parent instead + var parent = cmp.up(); + if (parent) { + // Add component to our focus chain to detect infinite focus loop + // before we fire off an attempt to focus our parent. + // See the comments above. + chain[cmp.id] = true; + parent.focus(); + } + + return; + } + + // Clear our focus chain when we have a focusable component + me.focusChain = {}; + + // Defer focusing for 90ms so components can do a layout/positioning + // and give us an ability to buffer focuses + clearTimeout(me.cmpFocusDelay); + if (arguments.length !== 2) { + me.cmpFocusDelay = Ext.defer(me.onComponentFocus, 90, me, [cmp, e]); + return; + } + + if (me.fireEvent('beforecomponentfocus', me, cmp, me.previousFocusedCmp) === false) { + me.clearComponent(cmp); + return; + } + + me.focusedCmp = cmp; + + // If we have a focus frame, show it around the focused component + if (me.shouldShowFocusFrame(cmp)) { + var cls = '.' + me.focusFrameCls + '-', + ff = me.focusFrame, + fw = me.focusFrameWidth, + box = cmp.el.getPageBox(), + + // Size the focus frame's t/b/l/r according to the box + // This leaves a hole in the middle of the frame so user + // interaction w/ the mouse can continue + bt = box.top, + bl = box.left, + bw = box.width, + bh = box.height, + ft = ff.child(cls + 'top'), + fb = ff.child(cls + 'bottom'), + fl = ff.child(cls + 'left'), + fr = ff.child(cls + 'right'); + + ft.setWidth(bw - 2).setLeftTop(bl + 1, bt); + fb.setWidth(bw - 2).setLeftTop(bl + 1, bt + bh - fw); + fl.setHeight(bh - 2).setLeftTop(bl, bt + 1); + fr.setHeight(bh - 2).setLeftTop(bl + bw - fw, bt + 1); + + ff.show(); + } + + me.fireEvent('componentfocus', me, cmp, me.previousFocusedCmp); + }, + + onComponentHide: function(cmp) { + var me = this, + CQ = Ext.ComponentQuery, + cmpHadFocus = false, + focusedCmp, + parent; + + if (me.focusedCmp) { + focusedCmp = CQ.query('[id=' + me.focusedCmp.id + ']', cmp)[0]; + cmpHadFocus = me.focusedCmp.id === cmp.id || focusedCmp; + + if (focusedCmp) { + me.clearComponent(focusedCmp); + } + } + + me.clearComponent(cmp); + + if (cmpHadFocus) { + parent = CQ.query('^:focusable', cmp)[0]; + if (parent) { + parent.focus(); + } + } + }, + + removeDOM: function() { + var me = this; + + // If we are still enabled globally, or there are still subscribers + // then we will halt here, since our DOM stuff is still being used + if (me.enabled || me.subscribers.length) { + return; + } + + Ext.destroy( + me.focusEl, + me.focusFrame + ); + delete me.focusEl; + delete me.focusFrame; + delete me.focusFrameWidth; + }, + + /** + * Removes the specified xtype from the {@link #whitelist}. + * @param {String/Array} xtype Removes the xtype(s) from the {@link #whitelist}. + */ + removeXTypeFromWhitelist: function(xtype) { + var me = this; + + if (Ext.isArray(xtype)) { + Ext.Array.forEach(xtype, me.removeXTypeFromWhitelist, me); + return; + } + + Ext.Array.remove(me.whitelist, xtype); + }, + + setFocus: function(cmp, focusable, options) { + var me = this, + el, dom, data, + + needsTabIndex = function(n) { + return !Ext.Array.contains(me.tabIndexWhitelist, n.tagName.toLowerCase()) + && n.tabIndex <= 0; + }; + + options = options || {}; + + // Come back and do this after the component is rendered + if (!cmp.rendered) { + cmp.on('afterrender', Ext.pass(me.setFocus, arguments, me), me, { single: true }); + return; + } + + el = cmp.getFocusEl(); + dom = el.dom; + + // Decorate the component's focus el for focus-ability + if ((focusable && !me.focusData[cmp.id]) || (!focusable && me.focusData[cmp.id])) { + if (focusable) { + data = { + focusFrame: options.focusFrame + }; + + // Only set -1 tabIndex if we need it + // inputs, buttons, and anchor tags do not need it, + // and neither does any DOM that has it set already + // programmatically or in markup. + if (needsTabIndex(dom)) { + data.tabIndex = dom.tabIndex; + dom.tabIndex = -1; + } + + el.on({ + focus: data.focusFn = Ext.bind(me.onComponentFocus, me, [cmp], 0), + blur: data.blurFn = Ext.bind(me.onComponentBlur, me, [cmp], 0), + scope: me + }); + cmp.on({ + hide: me.onComponentHide, + close: me.onComponentHide, + beforedestroy: me.onComponentDestroy, + scope: me + }); + + me.focusData[cmp.id] = data; + } else { + data = me.focusData[cmp.id]; + if ('tabIndex' in data) { + dom.tabIndex = data.tabIndex; + } + el.un('focus', data.focusFn, me); + el.un('blur', data.blurFn, me); + cmp.un('hide', me.onComponentHide, me); + cmp.un('close', me.onComponentHide, me); + cmp.un('beforedestroy', me.onComponentDestroy, me); + + delete me.focusData[cmp.id]; + } + } + }, + + setFocusAll: function(focusable, options) { + var me = this, + cmps = Ext.ComponentManager.all.getArray(), + len = cmps.length, + cmp, + i = 0; + + for (; i < len; i++) { + me.setFocus(cmps[i], focusable, options); + } + }, + + setupSubscriberKeys: function(container, keys) { + var me = this, + el = container.getFocusEl(), + scope = keys.scope, + handlers = { + backspace: me.focusLast, + enter: me.navigateIn, + esc: me.navigateOut, + scope: me + }, + + navSiblings = function(e) { + if (me.focusedCmp === container) { + // Root the sibling navigation to this container, so that we + // can automatically dive into the container, rather than forcing + // the user to hit the enter key to dive in. + return me.navigateSiblings(e, me, container); + } else { + return me.navigateSiblings(e); + } + }; + + Ext.iterate(keys, function(key, cb) { + handlers[key] = function(e) { + var ret = navSiblings(e); + + if (Ext.isFunction(cb) && cb.call(scope || container, e, ret) === true) { + return true; + } + + return ret; + }; + }, me); + + return Ext.create('Ext.util.KeyNav', el, handlers); + }, + + shouldShowFocusFrame: function(cmp) { + var me = this, + opts = me.options || {}; + + if (!me.focusFrame || !cmp) { + return false; + } + + // Global trumps + if (opts.focusFrame) { + return true; + } + + if (me.focusData[cmp.id].focusFrame) { + return true; + } + + return false; + }, + + /** + * Subscribes an {@link Ext.container.Container} to provide basic keyboard focus navigation between its child {@link Ext.Component}'s. + * @param {Ext.container.Container} container A reference to the {@link Ext.container.Container} on which to enable keyboard functionality and focus management. + * @param {Boolean/Object} options An object of the following options: + - keys : Array/Object + An array containing the string names of navigation keys to be supported. The allowed values are: + + - 'left' + - 'right' + - 'up' + - 'down' + + Or, an object containing those key names as keys with `true` or a callback function as their value. A scope may also be passed. E.g.: + + { + left: this.onLeftKey, + right: this.onRightKey, + scope: this + } + + - focusFrame : Boolean (optional) + `true` to show the focus frame around a component when it is focused. Defaults to `false`. + * @markdown + */ + subscribe: function(container, options) { + var me = this, + EA = Ext.Array, + data = {}, + subs = me.subscribers, + + // Recursively add focus ability as long as a descendent container isn't + // itself subscribed to the FocusManager, or else we'd have unwanted side + // effects for subscribing a descendent container twice. + safeSetFocus = function(cmp) { + if (cmp.isContainer && !subs.containsKey(cmp.id)) { + EA.forEach(cmp.query('>'), safeSetFocus); + me.setFocus(cmp, true, options); + cmp.on('add', data.onAdd, me); + } else if (!cmp.isContainer) { + me.setFocus(cmp, true, options); + } + }; + + // We only accept containers + if (!container || !container.isContainer) { + return; + } + + if (!container.rendered) { + container.on('afterrender', Ext.pass(me.subscribe, arguments, me), me, { single: true }); + return; + } + + // Init the DOM, incase this is the first time it will be used + me.initDOM(options); + + // Create key navigation for subscriber based on keys option + data.keyNav = me.setupSubscriberKeys(container, options.keys); + + // We need to keep track of components being added to our subscriber + // and any containers nested deeply within it (omg), so let's do that. + // Components that are removed are globally handled. + // Also keep track of destruction of our container for auto-unsubscribe. + data.onAdd = function(ct, cmp, idx) { + safeSetFocus(cmp); + }; + container.on('beforedestroy', me.unsubscribe, me); + + // Now we setup focusing abilities for the container and all its components + safeSetFocus(container); + + // Add to our subscribers list + subs.add(container.id, data); + }, + + /** + * Unsubscribes an {@link Ext.container.Container} from keyboard focus management. + * @param {Ext.container.Container} container A reference to the {@link Ext.container.Container} to unsubscribe from the FocusManager. + * @markdown + */ + unsubscribe: function(container) { + var me = this, + EA = Ext.Array, + subs = me.subscribers, + data, + + // Recursively remove focus ability as long as a descendent container isn't + // itself subscribed to the FocusManager, or else we'd have unwanted side + // effects for unsubscribing an ancestor container. + safeSetFocus = function(cmp) { + if (cmp.isContainer && !subs.containsKey(cmp.id)) { + EA.forEach(cmp.query('>'), safeSetFocus); + me.setFocus(cmp, false); + cmp.un('add', data.onAdd, me); + } else if (!cmp.isContainer) { + me.setFocus(cmp, false); + } + }; + + if (!container || !subs.containsKey(container.id)) { + return; + } + + data = subs.get(container.id); + data.keyNav.destroy(); + container.un('beforedestroy', me.unsubscribe, me); + subs.removeAtKey(container.id); + safeSetFocus(container); + me.removeDOM(); + } +}); +/** + * @class Ext.toolbar.Toolbar + * @extends Ext.container.Container + +Basic Toolbar class. Although the {@link Ext.container.Container#defaultType defaultType} for Toolbar is {@link Ext.button.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 | +|:---------|:--------------|:------------------------------|:---------------------------------------------------| +| `->` | `tbspacer` | {@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 | + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar1.png Toolbar component} +Example usage: + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 500, + items: [ + { + // xtype: 'button', // default for Toolbars + text: 'Button' + }, + { + xtype: 'splitbutton', + 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' + ] + }); + +Toolbars have {@link #enable} and {@link #disable} methods which when called, will enable/disable all items within your toolbar. + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar2.png Toolbar component} +Example usage: + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 400, + items: [ + { + text: 'Button' + }, + { + xtype: 'splitbutton', + text : 'Split Button' + }, + '->', + { + xtype : 'textfield', + name : 'field1', + emptyText: 'enter search term' + } + ] + }); + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar3.png Toolbar component} +Example usage: + + var enableBtn = Ext.create('Ext.button.Button', { + text : 'Enable All Items', + disabled: true, + scope : this, + handler : function() { + //disable the enable button and enable the disable button + enableBtn.disable(); + disableBtn.enable(); + + //enable the toolbar + toolbar.enable(); + } + }); + + var disableBtn = Ext.create('Ext.button.Button', { + text : 'Disable All Items', + scope : this, + handler : function() { + //enable the enable button and disable button + disableBtn.disable(); + enableBtn.enable(); + + //disable the toolbar + toolbar.disable(); + } + }); + + var toolbar = Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 400, + margin : '5 0 0 0', + items : [enableBtn, disableBtn] + }); + +Adding items to and removing items from a toolbar is as simple as calling the {@link #add} and {@link #remove} methods. There is also a {@link #removeAll} method +which remove all items within the toolbar. + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar4.png Toolbar component} +Example usage: + + var toolbar = Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 700, + items: [ + { + text: 'Example Button' + } + ] + }); + + var addedItems = []; + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 700, + margin : '5 0 0 0', + items : [ + { + text : 'Add a button', + scope : this, + handler: function() { + var text = prompt('Please enter the text for your button:'); + addedItems.push(toolbar.add({ + text: text + })); + } + }, + { + text : 'Add a text item', + scope : this, + handler: function() { + var text = prompt('Please enter the text for your item:'); + addedItems.push(toolbar.add(text)); + } + }, + { + text : 'Add a toolbar seperator', + scope : this, + handler: function() { + addedItems.push(toolbar.add('-')); + } + }, + { + text : 'Add a toolbar spacer', + scope : this, + handler: function() { + addedItems.push(toolbar.add('->')); + } + }, + '->', + { + text : 'Remove last inserted item', + scope : this, + handler: function() { + if (addedItems.length) { + toolbar.remove(addedItems.pop()); + } else if (toolbar.items.length) { + toolbar.remove(toolbar.items.last()); + } else { + alert('No items in the toolbar'); + } + } + }, + { + text : 'Remove all items', + scope : this, + handler: function() { + toolbar.removeAll(); + } + } + ] + }); + + * @constructor + * Creates a new Toolbar + * @param {Object/Array} config A config object or an array of buttons to {@link #add} + * @xtype toolbar + * @docauthor Robert Dougan + * @markdown + */ +Ext.define('Ext.toolbar.Toolbar', { + extend: 'Ext.container.Container', + requires: [ + 'Ext.toolbar.Fill', + 'Ext.layout.container.HBox', + 'Ext.layout.container.VBox', + 'Ext.FocusManager' + ], + uses: [ + 'Ext.toolbar.Separator' + ], + alias: 'widget.toolbar', + alternateClassName: 'Ext.Toolbar', + + isToolbar: true, + baseCls : Ext.baseCSSPrefix + 'toolbar', + ariaRole : 'toolbar', + + defaultType: 'button', + + /** + * @cfg {Boolean} vertical + * Set to `true` to make the toolbar vertical. The layout will become a `vbox`. + * (defaults to `false`) + */ + vertical: false, + + /** + * @cfg {String/Object} layout + * This class assigns a default layout (layout:'hbox'). + * 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.Container#layout} for additional information. + */ + + /** + * @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. + */ + enableOverflow: false, + + // private + trackMenus: true, + + itemCls: Ext.baseCSSPrefix + 'toolbar-item', + + initComponent: function() { + var me = this, + keys; + + // check for simplified (old-style) overflow config: + if (!me.layout && me.enableOverflow) { + me.layout = { overflowHandler: 'Menu' }; + } + + if (me.dock === 'right' || me.dock === 'left') { + me.vertical = true; + } + + me.layout = Ext.applyIf(Ext.isString(me.layout) ? { + type: me.layout + } : me.layout || {}, { + type: me.vertical ? 'vbox' : 'hbox', + align: me.vertical ? 'stretchmax' : 'middle' + }); + + if (me.vertical) { + me.addClsWithUI('vertical'); + } + + // @TODO: remove this hack and implement a more general solution + if (me.ui === 'footer') { + me.ignoreBorderManagement = true; + } + + me.callParent(); + + /** + * @event overflowchange + * Fires after the overflow state has changed. + * @param {Object} c The Container + * @param {Boolean} lastOverflow overflow state + */ + me.addEvents('overflowchange'); + + // Subscribe to Ext.FocusManager for key navigation + keys = me.vertical ? ['up', 'down'] : ['left', 'right']; + Ext.FocusManager.subscribe(me, { + keys: keys + }); + }, + + /** + *
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.Container#add}.
+ * @param {Mixed} arg1 The following types of arguments are all valid:
+ *
+ *
{@link Ext.button.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 + */ + + // private + lookupComponent: function(c) { + if (Ext.isString(c)) { + var shortcut = Ext.toolbar.Toolbar.shortcuts[c]; + if (shortcut) { + c = { + xtype: shortcut + }; + } else { + c = { + xtype: 'tbtext', + text: c + }; + } + this.applyDefaults(c); + } + return this.callParent(arguments); + }, + + // private + applyDefaults: function(c) { + if (!Ext.isString(c)) { + c = this.callParent(arguments); + var d = this.internalDefaults; + if (c.events) { + Ext.applyIf(c.initialConfig, d); + Ext.apply(c, d); + } else { + Ext.applyIf(c, d); + } + } + return c; + }, + + // private + trackMenu: function(item, remove) { + if (this.trackMenus && item.menu) { + var method = remove ? 'mun' : 'mon', + me = this; + + me[method](item, 'menutriggerover', me.onButtonTriggerOver, me); + me[method](item, 'menushow', me.onButtonMenuShow, me); + me[method](item, 'menuhide', me.onButtonMenuHide, me); + } + }, + + // private + constructButton: function(item) { + return item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType); + }, + + // private + onBeforeAdd: function(component) { + if (component.is('field') || (component.is('button') && this.ui != 'footer')) { + component.ui = component.ui + '-toolbar'; + } + + // Any separators needs to know if is vertical or not + if (component instanceof Ext.toolbar.Separator) { + component.setUI((this.vertical) ? 'vertical' : 'horizontal'); + } + + this.callParent(arguments); + }, + + // private + onAdd: function(component) { + this.callParent(arguments); + + this.trackMenu(component); + if (this.disabled) { + component.disable(); + } + }, + + // private + onRemove: function(c) { + this.callParent(arguments); + this.trackMenu(c, true); + }, + + // private + onButtonTriggerOver: function(btn){ + if (this.activeMenuBtn && this.activeMenuBtn != btn) { + this.activeMenuBtn.hideMenu(); + btn.showMenu(); + this.activeMenuBtn = btn; + } + }, + + // private + onButtonMenuShow: function(btn) { + this.activeMenuBtn = btn; + }, + + // private + onButtonMenuHide: function(btn) { + delete this.activeMenuBtn; + } +}, function() { + this.shortcuts = { + '-' : 'tbseparator', + ' ' : 'tbspacer', + '->': 'tbfill' + }; +}); +/** + * @class Ext.panel.AbstractPanel + * @extends Ext.container.Container + *
A base class which provides methods common to Panel classes across the Sencha product range.
+ *
Please refer to sub class's documentation
+ * @constructor + * @param {Object} config The config object + */ +Ext.define('Ext.panel.AbstractPanel', { + + /* Begin Definitions */ + + extend: 'Ext.container.Container', + + requires: ['Ext.util.MixedCollection', 'Ext.core.Element', 'Ext.toolbar.Toolbar'], + + /* End Definitions */ + + /** + * @cfg {String} baseCls + * The base CSS class to apply to this panel's element (defaults to 'x-panel'). + */ + baseCls : Ext.baseCSSPrefix + 'panel', + + /** + * @cfg {Number/String} bodyPadding + * A shortcut for setting a padding style on the body element. The value can either be + * a number to be applied to all sides, or a normal css string describing padding. + * Defaults to undefined. + */ + + /** + * @cfg {Boolean} bodyBorder + * A shortcut to add or remove the border on the body of a panel. This only applies to a panel which has the {@link #frame} configuration set to `true`. + * Defaults to undefined. + */ + + /** + * @cfg {String/Object/Function} bodyStyle + * Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string, + * an object containing style property name/value pairs or a function that returns such a string or object. + * For example, these two formats are interpreted to be equivalent:
+bodyStyle: 'background:#ffc; padding:10px;' + +bodyStyle: { + background: '#ffc', + padding: '10px' +} + *
+ */ + + /** + * @cfg {String/Array} bodyCls + * A CSS class, space-delimited string of classes, or array of classes to be applied to the panel's body element. + * The following examples are all valid:
+bodyCls: 'foo' +bodyCls: 'foo bar' +bodyCls: ['foo', 'bar'] + *
+ */ + + isPanel: true, + + componentLayout: 'dock', + + renderTpl: ['
{bodyCls} {baseCls}-body-{ui} {parent.baseCls}-body-{parent.ui}-{.}" style="{bodyStyle}">
'], + + // TODO: Move code examples into product-specific files. The code snippet below is Touch only. + /** + * @cfg {Object/Array} dockedItems + * A component or series of components to be added as docked items to this panel. + * The docked items can be docked to either the top, right, left or bottom of a panel. + * This is typically used for things like toolbars or tab bars: + *
+var panel = new Ext.panel.Panel({ + fullscreen: true, + dockedItems: [{ + xtype: 'toolbar', + dock: 'top', + items: [{ + text: 'Docked to the top' + }] + }] +});
+ */ + + border: true, + + initComponent : function() { + var me = this; + + me.addEvents( + /** + * @event bodyresize + * Fires after the Panel has been resized. + * @param {Ext.panel.Panel} p the Panel which has been resized. + * @param {Number} width The Panel body's new width. + * @param {Number} height The Panel body's new height. + */ + 'bodyresize' + // // inherited + // 'activate', + // // inherited + // 'deactivate' + ); + + Ext.applyIf(me.renderSelectors, { + body: '.' + me.baseCls + '-body' + }); + + //!frame + //!border + + if (me.frame && me.border && me.bodyBorder === undefined) { + me.bodyBorder = false; + } + if (me.frame && me.border && (me.bodyBorder === false || me.bodyBorder === 0)) { + me.manageBodyBorders = true; + } + + me.callParent(); + }, + + // @private + initItems : function() { + var me = this, + items = me.dockedItems; + + me.callParent(); + me.dockedItems = Ext.create('Ext.util.MixedCollection', false, me.getComponentId); + if (items) { + me.addDocked(items); + } + }, + + /** + * Finds a docked component by id, itemId or position. Also see {@link #getDockedItems} + * @param {String/Number} comp The id, itemId or position of the docked component (see {@link #getComponent} for details) + * @return {Ext.Component} The docked component (if found) + */ + getDockedComponent: function(comp) { + if (Ext.isObject(comp)) { + comp = comp.getItemId(); + } + return this.dockedItems.get(comp); + }, + + /** + * Attempts a default component lookup (see {@link Ext.container.Container#getComponent}). If the component is not found in the normal + * items, the dockedItems are searched and the matched component (if any) returned (see {@loink #getDockedComponent}). Note that docked + * items will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched. + * @param {String/Number} comp The component id, itemId or position to find + * @return {Ext.Component} The component (if found) + */ + getComponent: function(comp) { + var component = this.callParent(arguments); + if (component === undefined && !Ext.isNumber(comp)) { + // If the arg is a numeric index skip docked items + component = this.getDockedComponent(comp); + } + return component; + }, + + /** + * Parses the {@link bodyStyle} config if available to create a style string that will be applied to the body element. + * This also includes {@link bodyPadding} and {@link bodyBorder} if available. + * @return {String} A CSS style string with body styles, padding and border. + * @private + */ + initBodyStyles: function() { + var me = this, + bodyStyle = me.bodyStyle, + styles = [], + Element = Ext.core.Element, + prop; + + if (Ext.isFunction(bodyStyle)) { + bodyStyle = bodyStyle(); + } + if (Ext.isString(bodyStyle)) { + styles = bodyStyle.split(';'); + } else { + for (prop in bodyStyle) { + if (bodyStyle.hasOwnProperty(prop)) { + styles.push(prop + ':' + bodyStyle[prop]); + } + } + } + + if (me.bodyPadding !== undefined) { + styles.push('padding: ' + Element.unitizeBox((me.bodyPadding === true) ? 5 : me.bodyPadding)); + } + if (me.frame && me.bodyBorder) { + if (!Ext.isNumber(me.bodyBorder)) { + me.bodyBorder = 1; + } + styles.push('border-width: ' + Element.unitizeBox(me.bodyBorder)); + } + delete me.bodyStyle; + return styles.length ? styles.join(';') : undefined; + }, + + /** + * Parse the {@link bodyCls} config if available to create a comma-delimited string of + * CSS classes to be applied to the body element. + * @return {String} The CSS class(es) + * @private + */ + initBodyCls: function() { + var me = this, + cls = '', + bodyCls = me.bodyCls; + + if (bodyCls) { + Ext.each(bodyCls, function(v) { + cls += " " + v; + }); + delete me.bodyCls; + } + return cls.length > 0 ? cls : undefined; + }, + + /** + * Initialized the renderData to be used when rendering the renderTpl. + * @return {Object} Object with keys and values that are going to be applied to the renderTpl + * @private + */ + initRenderData: function() { + return Ext.applyIf(this.callParent(), { + bodyStyle: this.initBodyStyles(), + bodyCls: this.initBodyCls() + }); + }, + + /** + * Adds docked item(s) to the panel. + * @param {Object/Array} component The Component or array of components to add. The components + * must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', + * 'bottom', 'left'). + * @param {Number} pos (optional) The index at which the Component will be added + */ + addDocked : function(items, pos) { + var me = this, + i = 0, + item, length; + + items = me.prepareItems(items); + length = items.length; + + for (; i < length; i++) { + item = items[i]; + item.dock = item.dock || 'top'; + + // Allow older browsers to target docked items to style without borders + if (me.border === false) { + // item.cls = item.cls || '' + ' ' + me.baseCls + '-noborder-docked-' + item.dock; + } + + if (pos !== undefined) { + me.dockedItems.insert(pos + i, item); + } + else { + me.dockedItems.add(item); + } + item.onAdded(me, i); + me.onDockedAdd(item); + } + if (me.rendered && !me.suspendLayout) { + me.doComponentLayout(); + } + return items; + }, + + // Placeholder empty functions + onDockedAdd : Ext.emptyFn, + onDockedRemove : Ext.emptyFn, + + /** + * Inserts docked item(s) to the panel at the indicated position. + * @param {Number} pos The index at which the Component will be inserted + * @param {Object/Array} component. The Component or array of components to add. The components + * must include a 'dock' paramater on each component to indicate where it should be docked ('top', 'right', + * 'bottom', 'left'). + */ + insertDocked : function(pos, items) { + this.addDocked(items, pos); + }, + + /** + * Removes the docked item from the panel. + * @param {Ext.Component} item. The Component to remove. + * @param {Boolean} autoDestroy (optional) Destroy the component after removal. + */ + removeDocked : function(item, autoDestroy) { + var me = this, + layout, + hasLayout; + + if (!me.dockedItems.contains(item)) { + return item; + } + + layout = me.componentLayout; + hasLayout = layout && me.rendered; + + if (hasLayout) { + layout.onRemove(item); + } + + me.dockedItems.remove(item); + item.onRemoved(); + me.onDockedRemove(item); + + if (autoDestroy === true || (autoDestroy !== false && me.autoDestroy)) { + item.destroy(); + } + + if (hasLayout && !autoDestroy) { + layout.afterRemove(item); + } + + if (!this.destroying) { + me.doComponentLayout(); + } + + return item; + }, + + /** + * Retrieve an array of all currently docked Components. + * @param {String} cqSelector A {@link Ext.ComponentQuery ComponentQuery} selector string to filter the returned items. + * @return {Array} An array of components. + */ + getDockedItems : function(cqSelector) { + var me = this, + // Start with a weight of 1, so users can provide <= 0 to come before top items + // Odd numbers, so users can provide a weight to come in between if desired + defaultWeight = { top: 1, left: 3, right: 5, bottom: 7 }, + dockedItems; + + if (me.dockedItems && me.dockedItems.items.length) { + // Allow filtering of returned docked items by CQ selector. + if (cqSelector) { + dockedItems = Ext.ComponentQuery.query(cqSelector, me.dockedItems.items); + } else { + dockedItems = me.dockedItems.items.slice(); + } + + Ext.Array.sort(dockedItems, function(a, b) { + // Docked items are ordered by their visual representation by default (t,l,r,b) + // TODO: Enforce position ordering, and have weights be sub-ordering within positions? + var aw = a.weight || defaultWeight[a.dock], + bw = b.weight || defaultWeight[b.dock]; + if (Ext.isNumber(aw) && Ext.isNumber(bw)) { + return aw - bw; + } + return 0; + }); + + return dockedItems; + } + return []; + }, + + // inherit docs + addUIClsToElement: function(cls, force) { + var me = this; + + me.callParent(arguments); + + if (!force && me.rendered) { + me.body.addCls(Ext.baseCSSPrefix + cls); + me.body.addCls(me.baseCls + '-body-' + cls); + me.body.addCls(me.baseCls + '-body-' + me.ui + '-' + cls); + } + }, + + // inherit docs + removeUIClsFromElement: function(cls, force) { + var me = this; + + me.callParent(arguments); + + if (!force && me.rendered) { + me.body.removeCls(Ext.baseCSSPrefix + cls); + me.body.removeCls(me.baseCls + '-body-' + cls); + me.body.removeCls(me.baseCls + '-body-' + me.ui + '-' + cls); + } + }, + + // inherit docs + addUIToElement: function(force) { + var me = this; + + me.callParent(arguments); + + if (!force && me.rendered) { + me.body.addCls(me.baseCls + '-body-' + me.ui); + } + }, + + // inherit docs + removeUIFromElement: function() { + var me = this; + + me.callParent(arguments); + + if (me.rendered) { + me.body.removeCls(me.baseCls + '-body-' + me.ui); + } + }, + + // @private + getTargetEl : function() { + return this.body; + }, + + getRefItems: function(deep) { + var items = this.callParent(arguments), + // deep fetches all docked items, and their descendants using '*' selector and then '* *' + dockedItems = this.getDockedItems(deep ? '*,* *' : undefined), + ln = dockedItems.length, + i = 0, + item; + + // Find the index where we go from top/left docked items to right/bottom docked items + for (; i < ln; i++) { + item = dockedItems[i]; + if (item.dock === 'right' || item.dock === 'bottom') { + break; + } + } + + // Return docked items in the top/left position before our container items, and + // return right/bottom positioned items after our container items. + // See AbstractDock.renderItems() for more information. + return dockedItems.splice(0, i).concat(items).concat(dockedItems); + }, + + beforeDestroy: function(){ + var docked = this.dockedItems, + c; + + if (docked) { + while ((c = docked.first())) { + this.removeDocked(c, true); + } + } + this.callParent(); + }, + + setBorder: function(border) { + var me = this; + me.border = (border !== undefined) ? border : true; + if (me.rendered) { + me.doComponentLayout(); + } + } +}); +/** + * @class Ext.panel.Header + * @extends Ext.container.Container + * Simple header class which is used for on {@link Ext.panel.Panel} and {@link Ext.window.Window} + * @xtype header + */ +Ext.define('Ext.panel.Header', { + extend: 'Ext.container.Container', + uses: ['Ext.panel.Tool', 'Ext.draw.Component', 'Ext.util.CSS'], + alias: 'widget.header', + + isHeader : true, + defaultType : 'tool', + indicateDrag : false, + weight : -1, + + renderTpl: ['
{bodyCls} {parent.baseCls}-body-{parent.ui}-{.}" style="{bodyStyle}">
'], + + initComponent: function() { + var me = this, + rule, + style, + titleTextEl, + ui; + + me.indicateDragCls = me.baseCls + '-draggable'; + me.title = me.title || ' '; + me.tools = me.tools || []; + me.items = me.items || []; + me.orientation = me.orientation || 'horizontal'; + me.dock = (me.dock) ? me.dock : (me.orientation == 'horizontal') ? 'top' : 'left'; + + //add the dock as a ui + //this is so we support top/right/left/bottom headers + me.addClsWithUI(me.orientation); + me.addClsWithUI(me.dock); + + Ext.applyIf(me.renderSelectors, { + body: '.' + me.baseCls + '-body' + }); + + // Add Icon + if (!Ext.isEmpty(me.iconCls)) { + me.initIconCmp(); + me.items.push(me.iconCmp); + } + + // Add Title + if (me.orientation == 'vertical') { + // Hack for IE6/7's inability to display an inline-block + if (Ext.isIE6 || Ext.isIE7) { + me.width = this.width || 24; + } else if (Ext.isIEQuirks) { + me.width = this.width || 25; + } + + me.layout = { + type : 'vbox', + align: 'center', + clearInnerCtOnLayout: true, + bindToOwnerCtContainer: false + }; + me.textConfig = { + cls: me.baseCls + '-text', + type: 'text', + text: me.title, + rotate: { + degrees: 90 + } + }; + ui = me.ui; + if (Ext.isArray(ui)) { + ui = ui[0]; + } + rule = Ext.util.CSS.getRule('.' + me.baseCls + '-text-' + ui); + if (rule) { + style = rule.style; + } + if (style) { + Ext.apply(me.textConfig, { + 'font-family': style.fontFamily, + 'font-weight': style.fontWeight, + 'font-size': style.fontSize, + fill: style.color + }); + } + me.titleCmp = Ext.create('Ext.draw.Component', { + ariaRole : 'heading', + focusable: false, + viewBox: false, + autoSize: true, + margins: '5 0 0 0', + items: [ me.textConfig ], + renderSelectors: { + textEl: '.' + me.baseCls + '-text' + } + }); + } else { + me.layout = { + type : 'hbox', + align: 'middle', + clearInnerCtOnLayout: true, + bindToOwnerCtContainer: false + }; + me.titleCmp = Ext.create('Ext.Component', { + xtype : 'component', + ariaRole : 'heading', + focusable: false, + renderTpl : ['{title}'], + renderData: { + title: me.title, + cls : me.baseCls, + ui : me.ui + }, + renderSelectors: { + textEl: '.' + me.baseCls + '-text' + } + }); + } + me.items.push(me.titleCmp); + + // Spacer -> + me.items.push({ + xtype: 'component', + html : ' ', + flex : 1, + focusable: false + }); + + // Add Tools + me.items = me.items.concat(me.tools); + this.callParent(); + }, + + initIconCmp: function() { + this.iconCmp = Ext.create('Ext.Component', { + focusable: false, + renderTpl : [''], + renderData: { + blank : Ext.BLANK_IMAGE_URL, + cls : this.baseCls, + iconCls: this.iconCls, + orientation: this.orientation + }, + renderSelectors: { + iconEl: '.' + this.baseCls + '-icon' + }, + iconCls: this.iconCls + }); + }, + + afterRender: function() { + var me = this; + + me.el.unselectable(); + if (me.indicateDrag) { + me.el.addCls(me.indicateDragCls); + } + me.mon(me.el, { + click: me.onClick, + scope: me + }); + me.callParent(); + }, + + afterLayout: function() { + var me = this; + me.callParent(arguments); + + // IE7 needs a forced repaint to make the top framing div expand to full width + if (Ext.isIE7) { + me.el.repaint(); + } + }, + + // inherit docs + addUIClsToElement: function(cls, force) { + var me = this; + + me.callParent(arguments); + + if (!force && me.rendered) { + me.body.addCls(me.baseCls + '-body-' + cls); + me.body.addCls(me.baseCls + '-body-' + me.ui + '-' + cls); + } + }, + + // inherit docs + removeUIClsFromElement: function(cls, force) { + var me = this; + + me.callParent(arguments); + + if (!force && me.rendered) { + me.body.removeCls(me.baseCls + '-body-' + cls); + me.body.removeCls(me.baseCls + '-body-' + me.ui + '-' + cls); + } + }, + + // inherit docs + addUIToElement: function(force) { + var me = this; + + me.callParent(arguments); + + if (!force && me.rendered) { + me.body.addCls(me.baseCls + '-body-' + me.ui); + } + + if (!force && me.titleCmp && me.titleCmp.rendered && me.titleCmp.textEl) { + me.titleCmp.textEl.addCls(me.baseCls + '-text-' + me.ui); + } + }, + + // inherit docs + removeUIFromElement: function() { + var me = this; + + me.callParent(arguments); + + if (me.rendered) { + me.body.removeCls(me.baseCls + '-body-' + me.ui); + } + + if (me.titleCmp && me.titleCmp.rendered && me.titleCmp.textEl) { + me.titleCmp.textEl.removeCls(me.baseCls + '-text-' + me.ui); + } + }, + + onClick: function(e) { + if (!e.getTarget(Ext.baseCSSPrefix + 'tool')) { + this.fireEvent('click', e); + } + }, + + getTargetEl: function() { + return this.body || this.frameBody || this.el; + }, + + /** + * Sets the title of the header. + * @param {String} title The title to be set + */ + setTitle: function(title) { + var me = this; + if (me.rendered) { + if (me.titleCmp.rendered) { + if (me.titleCmp.surface) { + me.title = title || ''; + var sprite = me.titleCmp.surface.items.items[0], + surface = me.titleCmp.surface; + + surface.remove(sprite); + me.textConfig.type = 'text'; + me.textConfig.text = title; + sprite = surface.add(me.textConfig); + sprite.setAttributes({ + rotate: { + degrees: 90 + } + }, true); + me.titleCmp.autoSizeSurface(); + } else { + me.title = title || ' '; + me.titleCmp.textEl.update(me.title); + } + } else { + me.titleCmp.on({ + render: function() { + me.setTitle(title); + }, + single: true + }); + } + } else { + me.on({ + render: function() { + me.layout.layout(); + me.setTitle(title); + }, + single: true + }); + } + }, + + /** + * Sets the CSS class that provides the icon image for this panel. This method will replace any existing + * icon class if one has already been set and fire the {@link #iconchange} event after completion. + * @param {String} cls The new CSS class name + */ + setIconCls: function(cls) { + this.iconCls = cls; + if (!this.iconCmp) { + this.initIconCmp(); + this.insert(0, this.iconCmp); + } + else { + if (!cls || !cls.length) { + this.iconCmp.destroy(); + } + else { + var iconCmp = this.iconCmp, + el = iconCmp.iconEl; + + el.removeCls(iconCmp.iconCls); + el.addCls(cls); + iconCmp.iconCls = cls; + } + } + }, + + /** + * Add a tool to the header + * @param {Object} tool + */ + addTool: function(tool) { + this.tools.push(this.add(tool)); + }, + + /** + * @private + * Set up the tools.<tool type> link in the owning Panel. + * Bind the tool to its owning Panel. + * @param component + * @param index + */ + onAdd: function(component, index) { + this.callParent([arguments]); + if (component instanceof Ext.panel.Tool) { + component.bindTo(this.ownerCt); + this.tools[component.type] = component; + } + } +}); + +/** + * @class Ext.fx.target.Element + * @extends Ext.fx.target.Target + * + * This class represents a animation target for an {@link Ext.core.Element}. In general this class will not be + * created directly, the {@link Ext.core.Element} will be passed to the animation and + * and the appropriate target will be created. + */ +Ext.define('Ext.fx.target.Element', { + + /* Begin Definitions */ + + extend: 'Ext.fx.target.Target', + + /* End Definitions */ + + type: 'element', + + getElVal: function(el, attr, val) { + if (val == undefined) { + if (attr === 'x') { + val = el.getX(); + } + else if (attr === 'y') { + val = el.getY(); + } + else if (attr === 'scrollTop') { + val = el.getScroll().top; + } + else if (attr === 'scrollLeft') { + val = el.getScroll().left; + } + else if (attr === 'height') { + val = el.getHeight(); + } + else if (attr === 'width') { + val = el.getWidth(); + } + else { + val = el.getStyle(attr); + } + } + return val; + }, + + getAttr: function(attr, val) { + var el = this.target; + return [[ el, this.getElVal(el, attr, val)]]; + }, + + setAttr: function(targetData) { + var target = this.target, + ln = targetData.length, + attrs, attr, o, i, j, ln2, element, value; + for (i = 0; i < ln; i++) { + attrs = targetData[i].attrs; + for (attr in attrs) { + if (attrs.hasOwnProperty(attr)) { + ln2 = attrs[attr].length; + for (j = 0; j < ln2; j++) { + o = attrs[attr][j]; + element = o[0]; + value = o[1]; + if (attr === 'x') { + element.setX(value); + } + else if (attr === 'y') { + element.setY(value); + } + else if (attr === 'scrollTop') { + element.scrollTo('top', value); + } + else if (attr === 'scrollLeft') { + element.scrollTo('left',value); + } + else { + element.setStyle(attr, value); + } + } + } + } + } + } +}); + +/** + * @class Ext.fx.target.CompositeElement + * @extends Ext.fx.target.Element + * + * This class represents a animation target for a {@link Ext.CompositeElement}. It allows + * each {@link Ext.core.Element} in the group to be animated as a whole. In general this class will not be + * created directly, the {@link Ext.CompositeElement} will be passed to the animation and + * and the appropriate target will be created. + */ +Ext.define('Ext.fx.target.CompositeElement', { + + /* Begin Definitions */ + + extend: 'Ext.fx.target.Element', + + /* End Definitions */ + + isComposite: true, + + constructor: function(target) { + target.id = target.id || Ext.id(null, 'ext-composite-'); + this.callParent([target]); + }, + + getAttr: function(attr, val) { + var out = [], + target = this.target; + target.each(function(el) { + out.push([el, this.getElVal(el, attr, val)]); + }, this); + return out; + } +}); + +/** + * @class Ext.fx.Manager + * Animation Manager which keeps track of all current animations and manages them on a frame by frame basis. + * @private + * @singleton + */ + +Ext.define('Ext.fx.Manager', { + + /* Begin Definitions */ + + singleton: true, + + requires: ['Ext.util.MixedCollection', + 'Ext.fx.target.Element', + 'Ext.fx.target.CompositeElement', + 'Ext.fx.target.Sprite', + 'Ext.fx.target.CompositeSprite', + 'Ext.fx.target.Component'], + + mixins: { + queue: 'Ext.fx.Queue' + }, + + /* End Definitions */ + + constructor: function() { + this.items = Ext.create('Ext.util.MixedCollection'); + this.mixins.queue.constructor.call(this); + + // this.requestAnimFrame = (function() { + // var raf = window.requestAnimationFrame || + // window.webkitRequestAnimationFrame || + // window.mozRequestAnimationFrame || + // window.oRequestAnimationFrame || + // window.msRequestAnimationFrame; + // if (raf) { + // return function(callback, element) { + // raf(callback); + // }; + // } + // else { + // return function(callback, element) { + // window.setTimeout(callback, Ext.fx.Manager.interval); + // }; + // } + // })(); + }, + + /** + * @cfg {Number} interval Default interval in miliseconds to calculate each frame. Defaults to 16ms (~60fps) + */ + interval: 16, + + /** + * @cfg {Boolean} forceJS Turn off to not use CSS3 transitions when they are available + */ + forceJS: true, + + // @private Target factory + createTarget: function(target) { + var me = this, + useCSS3 = !me.forceJS && Ext.supports.Transitions, + targetObj; + + me.useCSS3 = useCSS3; + + // dom id + if (Ext.isString(target)) { + target = Ext.get(target); + } + // dom element + if (target && target.tagName) { + target = Ext.get(target); + targetObj = Ext.create('Ext.fx.target.' + 'Element' + (useCSS3 ? 'CSS' : ''), target); + me.targets.add(targetObj); + return targetObj; + } + if (Ext.isObject(target)) { + // Element + if (target.dom) { + targetObj = Ext.create('Ext.fx.target.' + 'Element' + (useCSS3 ? 'CSS' : ''), target); + } + // Element Composite + else if (target.isComposite) { + targetObj = Ext.create('Ext.fx.target.' + 'CompositeElement' + (useCSS3 ? 'CSS' : ''), target); + } + // Draw Sprite + else if (target.isSprite) { + targetObj = Ext.create('Ext.fx.target.Sprite', target); + } + // Draw Sprite Composite + else if (target.isCompositeSprite) { + targetObj = Ext.create('Ext.fx.target.CompositeSprite', target); + } + // Component + else if (target.isComponent) { + targetObj = Ext.create('Ext.fx.target.Component', target); + } + else if (target.isAnimTarget) { + return target; + } + else { + return null; + } + me.targets.add(targetObj); + return targetObj; + } + else { + return null; + } + }, + + /** + * Add an Anim to the manager. This is done automatically when an Anim instance is created. + * @param {Ext.fx.Anim} anim + */ + addAnim: function(anim) { + var items = this.items, + task = this.task; + // var me = this, + // items = me.items, + // cb = function() { + // if (items.length) { + // me.task = true; + // me.runner(); + // me.requestAnimFrame(cb); + // } + // else { + // me.task = false; + // } + // }; + + items.add(anim); + + // Start the timer if not already running + if (!task && items.length) { + task = this.task = { + run: this.runner, + interval: this.interval, + scope: this + }; + Ext.TaskManager.start(task); + } + + // //Start the timer if not already running + // if (!me.task && items.length) { + // me.requestAnimFrame(cb); + // } + }, + + /** + * Remove an Anim from the manager. This is done automatically when an Anim ends. + * @param {Ext.fx.Anim} anim + */ + removeAnim: function(anim) { + // this.items.remove(anim); + var items = this.items, + task = this.task; + items.remove(anim); + // Stop the timer if there are no more managed Anims + if (task && !items.length) { + Ext.TaskManager.stop(task); + delete this.task; + } + }, + + /** + * @private + * Filter function to determine which animations need to be started + */ + startingFilter: function(o) { + return o.paused === false && o.running === false && o.iterations > 0; + }, + + /** + * @private + * Filter function to determine which animations are still running + */ + runningFilter: function(o) { + return o.paused === false && o.running === true && o.isAnimator !== true; + }, + + /** + * @private + * Runner function being called each frame + */ + runner: function() { + var me = this, + items = me.items; + + me.targetData = {}; + me.targetArr = {}; + + // Single timestamp for all animations this interval + me.timestamp = new Date(); + + // Start any items not current running + items.filterBy(me.startingFilter).each(me.startAnim, me); + + // Build the new attributes to be applied for all targets in this frame + items.filterBy(me.runningFilter).each(me.runAnim, me); + + // Apply all the pending changes to their targets + me.applyPendingAttrs(); + }, + + /** + * @private + * Start the individual animation (initialization) + */ + startAnim: function(anim) { + anim.start(this.timestamp); + }, + + /** + * @private + * Run the individual animation for this frame + */ + runAnim: function(anim) { + if (!anim) { + return; + } + var me = this, + targetId = anim.target.getId(), + useCSS3 = me.useCSS3 && anim.target.type == 'element', + elapsedTime = me.timestamp - anim.startTime, + target, o; + + this.collectTargetData(anim, elapsedTime, useCSS3); + + // For CSS3 animation, we need to immediately set the first frame's attributes without any transition + // to get a good initial state, then add the transition properties and set the final attributes. + if (useCSS3) { + // Flush the collected attributes, without transition + anim.target.setAttr(me.targetData[targetId], true); + + // Add the end frame data + me.targetData[targetId] = []; + me.collectTargetData(anim, anim.duration, useCSS3); + + // Pause the animation so runAnim doesn't keep getting called + anim.paused = true; + + target = anim.target.target; + // We only want to attach an event on the last element in a composite + if (anim.target.isComposite) { + target = anim.target.target.last(); + } + + // Listen for the transitionend event + o = {}; + o[Ext.supports.CSS3TransitionEnd] = anim.lastFrame; + o.scope = anim; + o.single = true; + target.on(o); + } + // For JS animation, trigger the lastFrame handler if this is the final frame + else if (elapsedTime >= anim.duration) { + me.applyPendingAttrs(true); + delete me.targetData[targetId]; + delete me.targetArr[targetId]; + anim.lastFrame(); + } + }, + + /** + * Collect target attributes for the given Anim object at the given timestamp + * @param {Ext.fx.Anim} anim The Anim instance + * @param {Number} timestamp Time after the anim's start time + */ + collectTargetData: function(anim, elapsedTime, useCSS3) { + var targetId = anim.target.getId(), + targetData = this.targetData[targetId], + data; + + if (!targetData) { + targetData = this.targetData[targetId] = []; + this.targetArr[targetId] = anim.target; + } + + data = { + duration: anim.duration, + easing: (useCSS3 && anim.reverse) ? anim.easingFn.reverse().toCSS3() : anim.easing, + attrs: {} + }; + Ext.apply(data.attrs, anim.runAnim(elapsedTime)); + targetData.push(data); + }, + + /** + * @private + * Apply all pending attribute changes to their targets + */ + applyPendingAttrs: function(isLastFrame) { + var targetData = this.targetData, + targetArr = this.targetArr, + targetId; + for (targetId in targetData) { + if (targetData.hasOwnProperty(targetId)) { + targetArr[targetId].setAttr(targetData[targetId], false, isLastFrame); + } + } + } +}); + +/** + * @class Ext.fx.Animator + * Animation instance + +This class is used to run keyframe based animations, which follows the CSS3 based animation structure. +Keyframe animations differ from typical from/to animations in that they offer the ability to specify values +at various points throughout the animation. + +__Using Keyframes__ +The {@link #keyframes} option is the most important part of specifying an animation when using this +class. A key frame is a point in a particular animation. We represent this as a percentage of the +total animation duration. At each key frame, we can specify the target values at that time. Note that +you *must* specify the values at 0% and 100%, the start and ending values. There is also a {@link keyframe} +event that fires after each key frame is reached. + +__Example Usage__ +In the example below, we modify the values of the element at each fifth throughout the animation. + + Ext.create('Ext.fx.Animator', { + target: Ext.getBody().createChild({ + style: { + width: '100px', + height: '100px', + 'background-color': 'red' + } + }), + duration: 10000, // 10 seconds + keyframes: { + 0: { + opacity: 1, + backgroundColor: 'FF0000' + }, + 20: { + x: 30, + opacity: 0.5 + }, + 40: { + x: 130, + backgroundColor: '0000FF' + }, + 60: { + y: 80, + opacity: 0.3 + }, + 80: { + width: 200, + y: 200 + }, + 100: { + opacity: 1, + backgroundColor: '00FF00' + } + } + }); + + * @markdown + */ +Ext.define('Ext.fx.Animator', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: ['Ext.fx.Manager'], + + /* End Definitions */ + + isAnimator: true, + + /** + * @cfg {Number} duration + * Time in milliseconds for the animation to last. Defaults to 250. + */ + duration: 250, + + /** + * @cfg {Number} delay + * Time to delay before starting the animation. Defaults to 0. + */ + delay: 0, + + /* private used to track a delayed starting time */ + delayStart: 0, + + /** + * @cfg {Boolean} dynamic + * Currently only for Component Animation: Only set a component's outer element size bypassing layouts. Set to true to do full layouts for every frame of the animation. Defaults to false. + */ + dynamic: false, + + /** + * @cfg {String} easing + +This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change +speed over its duration. + +- backIn +- backOut +- bounceIn +- bounceOut +- ease +- easeIn +- easeOut +- easeInOut +- elasticIn +- elasticOut +- cubic-bezier(x1, y1, x2, y2) + +Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification `{@link http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag}`. The four values specify points P1 and P2 of the curve +as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid. + + * @markdown + */ + easing: 'ease', + + /** + * Flag to determine if the animation has started + * @property running + * @type boolean + */ + running: false, + + /** + * Flag to determine if the animation is paused. Only set this to true if you need to + * keep the Anim instance around to be unpaused later; otherwise call {@link #end}. + * @property paused + * @type boolean + */ + paused: false, + + /** + * @private + */ + damper: 1, + + /** + * @cfg {Number} iterations + * Number of times to execute the animation. Defaults to 1. + */ + iterations: 1, + + /** + * Current iteration the animation is running. + * @property currentIteration + * @type int + */ + currentIteration: 0, + + /** + * Current keyframe step of the animation. + * @property keyframeStep + * @type Number + */ + keyframeStep: 0, + + /** + * @private + */ + animKeyFramesRE: /^(from|to|\d+%?)$/, + + /** + * @cfg {Ext.fx.target} target + * The Ext.fx.target to apply the animation to. If not specified during initialization, this can be passed to the applyAnimator + * method to apply the same animation to many targets. + */ + + /** + * @cfg {Object} keyframes + * Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to' + * is considered '100%'.Every keyframe declaration must have a keyframe rule for 0% and 100%, possibly defined using + * "from" or "to". A keyframe declaration without these keyframe selectors is invalid and will not be available for + * animation. The keyframe declaration for a keyframe rule consists of properties and values. Properties that are unable to + * be animated are ignored in these rules, with the exception of 'easing' which can be changed at each keyframe. For example: +
+keyframes : { + '0%': { + left: 100 + }, + '40%': { + left: 150 + }, + '60%': { + left: 75 + }, + '100%': { + left: 100 + } +} +
+ */ + constructor: function(config) { + var me = this; + config = Ext.apply(me, config || {}); + me.config = config; + me.id = Ext.id(null, 'ext-animator-'); + me.addEvents( + /** + * @event beforeanimate + * Fires before the animation starts. A handler can return false to cancel the animation. + * @param {Ext.fx.Animator} this + */ + 'beforeanimate', + /** + * @event keyframe + * Fires at each keyframe. + * @param {Ext.fx.Animator} this + * @param {Number} keyframe step number + */ + 'keyframe', + /** + * @event afteranimate + * Fires when the animation is complete. + * @param {Ext.fx.Animator} this + * @param {Date} startTime + */ + 'afteranimate' + ); + me.mixins.observable.constructor.call(me, config); + me.timeline = []; + me.createTimeline(me.keyframes); + if (me.target) { + me.applyAnimator(me.target); + Ext.fx.Manager.addAnim(me); + } + }, + + /** + * @private + */ + sorter: function (a, b) { + return a.pct - b.pct; + }, + + /** + * @private + * Takes the given keyframe configuration object and converts it into an ordered array with the passed attributes per keyframe + * or applying the 'to' configuration to all keyframes. Also calculates the proper animation duration per keyframe. + */ + createTimeline: function(keyframes) { + var me = this, + attrs = [], + to = me.to || {}, + duration = me.duration, + prevMs, ms, i, ln, pct, anim, nextAnim, attr; + + for (pct in keyframes) { + if (keyframes.hasOwnProperty(pct) && me.animKeyFramesRE.test(pct)) { + attr = {attrs: Ext.apply(keyframes[pct], to)}; + // CSS3 spec allow for from/to to be specified. + if (pct == "from") { + pct = 0; + } + else if (pct == "to") { + pct = 100; + } + // convert % values into integers + attr.pct = parseInt(pct, 10); + attrs.push(attr); + } + } + // Sort by pct property + Ext.Array.sort(attrs, me.sorter); + // Only an end + //if (attrs[0].pct) { + // attrs.unshift({pct: 0, attrs: element.attrs}); + //} + + ln = attrs.length; + for (i = 0; i < ln; i++) { + prevMs = (attrs[i - 1]) ? duration * (attrs[i - 1].pct / 100) : 0; + ms = duration * (attrs[i].pct / 100); + me.timeline.push({ + duration: ms - prevMs, + attrs: attrs[i].attrs + }); + } + }, + + /** + * Applies animation to the Ext.fx.target + * @private + * @param target + * @type string/object + */ + applyAnimator: function(target) { + var me = this, + anims = [], + timeline = me.timeline, + reverse = me.reverse, + ln = timeline.length, + anim, easing, damper, initial, attrs, lastAttrs, i; + + if (me.fireEvent('beforeanimate', me) !== false) { + for (i = 0; i < ln; i++) { + anim = timeline[i]; + attrs = anim.attrs; + easing = attrs.easing || me.easing; + damper = attrs.damper || me.damper; + delete attrs.easing; + delete attrs.damper; + anim = Ext.create('Ext.fx.Anim', { + target: target, + easing: easing, + damper: damper, + duration: anim.duration, + paused: true, + to: attrs + }); + anims.push(anim); + } + me.animations = anims; + me.target = anim.target; + for (i = 0; i < ln - 1; i++) { + anim = anims[i]; + anim.nextAnim = anims[i + 1]; + anim.on('afteranimate', function() { + this.nextAnim.paused = false; + }); + anim.on('afteranimate', function() { + this.fireEvent('keyframe', this, ++this.keyframeStep); + }, me); + } + anims[ln - 1].on('afteranimate', function() { + this.lastFrame(); + }, me); + } + }, + + /* + * @private + * Fires beforeanimate and sets the running flag. + */ + start: function(startTime) { + var me = this, + delay = me.delay, + delayStart = me.delayStart, + delayDelta; + if (delay) { + if (!delayStart) { + me.delayStart = startTime; + return; + } + else { + delayDelta = startTime - delayStart; + if (delayDelta < delay) { + return; + } + else { + // Compensate for frame delay; + startTime = new Date(delayStart.getTime() + delay); + } + } + } + if (me.fireEvent('beforeanimate', me) !== false) { + me.startTime = startTime; + me.running = true; + me.animations[me.keyframeStep].paused = false; + } + }, + + /* + * @private + * Perform lastFrame cleanup and handle iterations + * @returns a hash of the new attributes. + */ + lastFrame: function() { + var me = this, + iter = me.iterations, + iterCount = me.currentIteration; + + iterCount++; + if (iterCount < iter) { + me.startTime = new Date(); + me.currentIteration = iterCount; + me.keyframeStep = 0; + me.applyAnimator(me.target); + me.animations[me.keyframeStep].paused = false; + } + else { + me.currentIteration = 0; + me.end(); + } + }, + + /* + * Fire afteranimate event and end the animation. Usually called automatically when the + * animation reaches its final frame, but can also be called manually to pre-emptively + * stop and destroy the running animation. + */ + end: function() { + var me = this; + me.fireEvent('afteranimate', me, me.startTime, new Date() - me.startTime); + } +}); +/** + * @class Ext.fx.Easing + * +This class contains a series of function definitions used to modify values during an animation. +They describe how the intermediate values used during a transition will be calculated. It allows for a transition to change +speed over its duration. The following options are available: + +- linear The default easing type +- backIn +- backOut +- bounceIn +- bounceOut +- ease +- easeIn +- easeOut +- easeInOut +- elasticIn +- elasticOut +- cubic-bezier(x1, y1, x2, y2) + +Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification `{@link http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag}`. The four values specify points P1 and P2 of the curve +as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid. + * @markdown + * @singleton + */ +Ext.ns('Ext.fx'); + +Ext.require('Ext.fx.CubicBezier', function() { + var math = Math, + pi = math.PI, + pow = math.pow, + sin = math.sin, + sqrt = math.sqrt, + abs = math.abs, + backInSeed = 1.70158; + Ext.fx.Easing = { + // ease: Ext.fx.CubicBezier.cubicBezier(0.25, 0.1, 0.25, 1), + // linear: Ext.fx.CubicBezier.cubicBezier(0, 0, 1, 1), + // 'ease-in': Ext.fx.CubicBezier.cubicBezier(0.42, 0, 1, 1), + // 'ease-out': Ext.fx.CubicBezier.cubicBezier(0, 0.58, 1, 1), + // 'ease-in-out': Ext.fx.CubicBezier.cubicBezier(0.42, 0, 0.58, 1), + // 'easeIn': Ext.fx.CubicBezier.cubicBezier(0.42, 0, 1, 1), + // 'easeOut': Ext.fx.CubicBezier.cubicBezier(0, 0.58, 1, 1), + // 'easeInOut': Ext.fx.CubicBezier.cubicBezier(0.42, 0, 0.58, 1) + }; + + Ext.apply(Ext.fx.Easing, { + linear: function(n) { + return n; + }, + ease: function(n) { + var q = 0.07813 - n / 2, + alpha = -0.25, + Q = sqrt(0.0066 + q * q), + x = Q - q, + X = pow(abs(x), 1/3) * (x < 0 ? -1 : 1), + y = -Q - q, + Y = pow(abs(y), 1/3) * (y < 0 ? -1 : 1), + t = X + Y + 0.25; + return pow(1 - t, 2) * 3 * t * 0.1 + (1 - t) * 3 * t * t + t * t * t; + }, + easeIn: function (n) { + return pow(n, 1.7); + }, + easeOut: function (n) { + return pow(n, 0.48); + }, + easeInOut: function(n) { + var q = 0.48 - n / 1.04, + Q = sqrt(0.1734 + q * q), + x = Q - q, + X = pow(abs(x), 1/3) * (x < 0 ? -1 : 1), + y = -Q - q, + Y = pow(abs(y), 1/3) * (y < 0 ? -1 : 1), + t = X + Y + 0.5; + return (1 - t) * 3 * t * t + t * t * t; + }, + backIn: function (n) { + return n * n * ((backInSeed + 1) * n - backInSeed); + }, + backOut: function (n) { + n = n - 1; + return n * n * ((backInSeed + 1) * n + backInSeed) + 1; + }, + elasticIn: function (n) { + if (n === 0 || n === 1) { + return n; + } + var p = 0.3, + s = p / 4; + return pow(2, -10 * n) * sin((n - s) * (2 * pi) / p) + 1; + }, + elasticOut: function (n) { + return 1 - Ext.fx.Easing.elasticIn(1 - n); + }, + bounceIn: function (n) { + return 1 - Ext.fx.Easing.bounceOut(1 - n); + }, + bounceOut: function (n) { + var s = 7.5625, + p = 2.75, + l; + if (n < (1 / p)) { + l = s * n * n; + } else { + if (n < (2 / p)) { + n -= (1.5 / p); + l = s * n * n + 0.75; + } else { + if (n < (2.5 / p)) { + n -= (2.25 / p); + l = s * n * n + 0.9375; + } else { + n -= (2.625 / p); + l = s * n * n + 0.984375; + } + } + } + return l; + } + }); + Ext.apply(Ext.fx.Easing, { + 'back-in': Ext.fx.Easing.backIn, + 'back-out': Ext.fx.Easing.backOut, + 'ease-in': Ext.fx.Easing.easeIn, + 'ease-out': Ext.fx.Easing.easeOut, + 'elastic-in': Ext.fx.Easing.elasticIn, + 'elastic-out': Ext.fx.Easing.elasticIn, + 'bounce-in': Ext.fx.Easing.bounceIn, + 'bounce-out': Ext.fx.Easing.bounceOut, + 'ease-in-out': Ext.fx.Easing.easeInOut + }); +}); +/* + * @class Ext.draw.Draw + * Base Drawing class. Provides base drawing functions. + */ + +Ext.define('Ext.draw.Draw', { + /* Begin Definitions */ + + singleton: true, + + requires: ['Ext.draw.Color'], + + /* End Definitions */ + + pathToStringRE: /,?([achlmqrstvxz]),?/gi, + pathCommandRE: /([achlmqstvz])[\s,]*((-?\d*\.?\d*(?:e[-+]?\d+)?\s*,?\s*)+)/ig, + pathValuesRE: /(-?\d*\.?\d*(?:e[-+]?\d+)?)\s*,?\s*/ig, + stopsRE: /^(\d+%?)$/, + radian: Math.PI / 180, + + availableAnimAttrs: { + along: "along", + blur: null, + "clip-rect": "csv", + cx: null, + cy: null, + fill: "color", + "fill-opacity": null, + "font-size": null, + height: null, + opacity: null, + path: "path", + r: null, + rotation: "csv", + rx: null, + ry: null, + scale: "csv", + stroke: "color", + "stroke-opacity": null, + "stroke-width": null, + translation: "csv", + width: null, + x: null, + y: null + }, + + is: function(o, type) { + type = String(type).toLowerCase(); + return (type == "object" && o === Object(o)) || + (type == "undefined" && typeof o == type) || + (type == "null" && o === null) || + (type == "array" && Array.isArray && Array.isArray(o)) || + (Object.prototype.toString.call(o).toLowerCase().slice(8, -1)) == type; + }, + + ellipsePath: function(sprite) { + var attr = sprite.attr; + return Ext.String.format("M{0},{1}A{2},{3},0,1,1,{0},{4}A{2},{3},0,1,1,{0},{1}z", attr.x, attr.y - attr.ry, attr.rx, attr.ry, attr.y + attr.ry); + }, + + rectPath: function(sprite) { + var attr = sprite.attr; + if (attr.radius) { + return Ext.String.format("M{0},{1}l{2},0a{3},{3},0,0,1,{3},{3}l0,{5}a{3},{3},0,0,1,{4},{3}l{6},0a{3},{3},0,0,1,{4},{4}l0,{7}a{3},{3},0,0,1,{3},{4}z", attr.x + attr.radius, attr.y, attr.width - attr.radius * 2, attr.radius, -attr.radius, attr.height - attr.radius * 2, attr.radius * 2 - attr.width, attr.radius * 2 - attr.height); + } + else { + return Ext.String.format("M{0},{1}l{2},0,0,{3},{4},0z", attr.x, attr.y, attr.width, attr.height, -attr.width); + } + }, + + // To be deprecated, converts itself (an arrayPath) to a proper SVG path string + path2string: function () { + return this.join(",").replace(Ext.draw.Draw.pathToStringRE, "$1"); + }, + + // Convert the passed arrayPath to a proper SVG path string (d attribute) + pathToString: function(arrayPath) { + return arrayPath.join(",").replace(Ext.draw.Draw.pathToStringRE, "$1"); + }, + + parsePathString: function (pathString) { + if (!pathString) { + return null; + } + var paramCounts = {a: 7, c: 6, h: 1, l: 2, m: 2, q: 4, s: 4, t: 2, v: 1, z: 0}, + data = [], + me = this; + if (me.is(pathString, "array") && me.is(pathString[0], "array")) { // rough assumption + data = me.pathClone(pathString); + } + if (!data.length) { + String(pathString).replace(me.pathCommandRE, function (a, b, c) { + var params = [], + name = b.toLowerCase(); + c.replace(me.pathValuesRE, function (a, b) { + b && params.push(+b); + }); + if (name == "m" && params.length > 2) { + data.push([b].concat(params.splice(0, 2))); + name = "l"; + b = (b == "m") ? "l" : "L"; + } + while (params.length >= paramCounts[name]) { + data.push([b].concat(params.splice(0, paramCounts[name]))); + if (!paramCounts[name]) { + break; + } + } + }); + } + data.toString = me.path2string; + return data; + }, + + mapPath: function (path, matrix) { + if (!matrix) { + return path; + } + var x, y, i, ii, j, jj, pathi; + path = this.path2curve(path); + for (i = 0, ii = path.length; i < ii; i++) { + pathi = path[i]; + for (j = 1, jj = pathi.length; j < jj-1; j += 2) { + x = matrix.x(pathi[j], pathi[j + 1]); + y = matrix.y(pathi[j], pathi[j + 1]); + pathi[j] = x; + pathi[j + 1] = y; + } + } + return path; + }, + + pathClone: function(pathArray) { + var res = [], + j, jj, i, ii; + if (!this.is(pathArray, "array") || !this.is(pathArray && pathArray[0], "array")) { // rough assumption + pathArray = this.parsePathString(pathArray); + } + for (i = 0, ii = pathArray.length; i < ii; i++) { + res[i] = []; + for (j = 0, jj = pathArray[i].length; j < jj; j++) { + res[i][j] = pathArray[i][j]; + } + } + res.toString = this.path2string; + return res; + }, + + pathToAbsolute: function (pathArray) { + if (!this.is(pathArray, "array") || !this.is(pathArray && pathArray[0], "array")) { // rough assumption + pathArray = this.parsePathString(pathArray); + } + var res = [], + x = 0, + y = 0, + mx = 0, + my = 0, + i = 0, + ln = pathArray.length, + r, pathSegment, j, ln2; + // MoveTo initial x/y position + if (ln && pathArray[0][0] == "M") { + x = +pathArray[0][1]; + y = +pathArray[0][2]; + mx = x; + my = y; + i++; + res[0] = ["M", x, y]; + } + for (; i < ln; i++) { + r = res[i] = []; + pathSegment = pathArray[i]; + if (pathSegment[0] != pathSegment[0].toUpperCase()) { + r[0] = pathSegment[0].toUpperCase(); + switch (r[0]) { + // Elliptical Arc + case "A": + r[1] = pathSegment[1]; + r[2] = pathSegment[2]; + r[3] = pathSegment[3]; + r[4] = pathSegment[4]; + r[5] = pathSegment[5]; + r[6] = +(pathSegment[6] + x); + r[7] = +(pathSegment[7] + y); + break; + // Vertical LineTo + case "V": + r[1] = +pathSegment[1] + y; + break; + // Horizontal LineTo + case "H": + r[1] = +pathSegment[1] + x; + break; + case "M": + // MoveTo + mx = +pathSegment[1] + x; + my = +pathSegment[2] + y; + default: + j = 1; + ln2 = pathSegment.length; + for (; j < ln2; j++) { + r[j] = +pathSegment[j] + ((j % 2) ? x : y); + } + } + } + else { + j = 0; + ln2 = pathSegment.length; + for (; j < ln2; j++) { + res[i][j] = pathSegment[j]; + } + } + switch (r[0]) { + // ClosePath + case "Z": + x = mx; + y = my; + break; + // Horizontal LineTo + case "H": + x = r[1]; + break; + // Vertical LineTo + case "V": + y = r[1]; + break; + // MoveTo + case "M": + pathSegment = res[i]; + ln2 = pathSegment.length; + mx = pathSegment[ln2 - 2]; + my = pathSegment[ln2 - 1]; + default: + pathSegment = res[i]; + ln2 = pathSegment.length; + x = pathSegment[ln2 - 2]; + y = pathSegment[ln2 - 1]; + } + } + res.toString = this.path2string; + return res; + }, + + // TO BE DEPRECATED + pathToRelative: function (pathArray) { + if (!this.is(pathArray, "array") || !this.is(pathArray && pathArray[0], "array")) { + pathArray = this.parsePathString(pathArray); + } + var res = [], + x = 0, + y = 0, + mx = 0, + my = 0, + start = 0; + if (pathArray[0][0] == "M") { + x = pathArray[0][1]; + y = pathArray[0][2]; + mx = x; + my = y; + start++; + res.push(["M", x, y]); + } + for (var i = start, ii = pathArray.length; i < ii; i++) { + var r = res[i] = [], + pa = pathArray[i]; + if (pa[0] != pa[0].toLowerCase()) { + r[0] = pa[0].toLowerCase(); + switch (r[0]) { + case "a": + r[1] = pa[1]; + r[2] = pa[2]; + r[3] = pa[3]; + r[4] = pa[4]; + r[5] = pa[5]; + r[6] = +(pa[6] - x).toFixed(3); + r[7] = +(pa[7] - y).toFixed(3); + break; + case "v": + r[1] = +(pa[1] - y).toFixed(3); + break; + case "m": + mx = pa[1]; + my = pa[2]; + default: + for (var j = 1, jj = pa.length; j < jj; j++) { + r[j] = +(pa[j] - ((j % 2) ? x : y)).toFixed(3); + } + } + } else { + r = res[i] = []; + if (pa[0] == "m") { + mx = pa[1] + x; + my = pa[2] + y; + } + for (var k = 0, kk = pa.length; k < kk; k++) { + res[i][k] = pa[k]; + } + } + var len = res[i].length; + switch (res[i][0]) { + case "z": + x = mx; + y = my; + break; + case "h": + x += +res[i][len - 1]; + break; + case "v": + y += +res[i][len - 1]; + break; + default: + x += +res[i][len - 2]; + y += +res[i][len - 1]; + } + } + res.toString = this.path2string; + return res; + }, + + // Returns a path converted to a set of curveto commands + path2curve: function (path) { + var me = this, + points = me.pathToAbsolute(path), + ln = points.length, + attrs = {x: 0, y: 0, bx: 0, by: 0, X: 0, Y: 0, qx: null, qy: null}, + i, seg, segLn, point; + + for (i = 0; i < ln; i++) { + points[i] = me.command2curve(points[i], attrs); + if (points[i].length > 7) { + points[i].shift(); + point = points[i]; + while (point.length) { + points.splice(i++, 0, ["C"].concat(point.splice(0, 6))); + } + points.splice(i, 1); + ln = points.length; + } + seg = points[i]; + segLn = seg.length; + attrs.x = seg[segLn - 2]; + attrs.y = seg[segLn - 1]; + attrs.bx = parseFloat(seg[segLn - 4]) || attrs.x; + attrs.by = parseFloat(seg[segLn - 3]) || attrs.y; + } + return points; + }, + + interpolatePaths: function (path, path2) { + var me = this, + p = me.pathToAbsolute(path), + p2 = me.pathToAbsolute(path2), + attrs = {x: 0, y: 0, bx: 0, by: 0, X: 0, Y: 0, qx: null, qy: null}, + attrs2 = {x: 0, y: 0, bx: 0, by: 0, X: 0, Y: 0, qx: null, qy: null}, + fixArc = function (pp, i) { + if (pp[i].length > 7) { + pp[i].shift(); + var pi = pp[i]; + while (pi.length) { + pp.splice(i++, 0, ["C"].concat(pi.splice(0, 6))); + } + pp.splice(i, 1); + ii = Math.max(p.length, p2.length || 0); + } + }, + fixM = function (path1, path2, a1, a2, i) { + if (path1 && path2 && path1[i][0] == "M" && path2[i][0] != "M") { + path2.splice(i, 0, ["M", a2.x, a2.y]); + a1.bx = 0; + a1.by = 0; + a1.x = path1[i][1]; + a1.y = path1[i][2]; + ii = Math.max(p.length, p2.length || 0); + } + }; + for (var i = 0, ii = Math.max(p.length, p2.length || 0); i < ii; i++) { + p[i] = me.command2curve(p[i], attrs); + fixArc(p, i); + (p2[i] = me.command2curve(p2[i], attrs2)); + fixArc(p2, i); + fixM(p, p2, attrs, attrs2, i); + fixM(p2, p, attrs2, attrs, i); + var seg = p[i], + seg2 = p2[i], + seglen = seg.length, + seg2len = seg2.length; + attrs.x = seg[seglen - 2]; + attrs.y = seg[seglen - 1]; + attrs.bx = parseFloat(seg[seglen - 4]) || attrs.x; + attrs.by = parseFloat(seg[seglen - 3]) || attrs.y; + attrs2.bx = (parseFloat(seg2[seg2len - 4]) || attrs2.x); + attrs2.by = (parseFloat(seg2[seg2len - 3]) || attrs2.y); + attrs2.x = seg2[seg2len - 2]; + attrs2.y = seg2[seg2len - 1]; + } + return [p, p2]; + }, + + //Returns any path command as a curveto command based on the attrs passed + command2curve: function (pathCommand, d) { + var me = this; + if (!pathCommand) { + return ["C", d.x, d.y, d.x, d.y, d.x, d.y]; + } + if (pathCommand[0] != "T" && pathCommand[0] != "Q") { + d.qx = d.qy = null; + } + switch (pathCommand[0]) { + case "M": + d.X = pathCommand[1]; + d.Y = pathCommand[2]; + break; + case "A": + pathCommand = ["C"].concat(me.arc2curve.apply(me, [d.x, d.y].concat(pathCommand.slice(1)))); + break; + case "S": + pathCommand = ["C", d.x + (d.x - (d.bx || d.x)), d.y + (d.y - (d.by || d.y))].concat(pathCommand.slice(1)); + break; + case "T": + d.qx = d.x + (d.x - (d.qx || d.x)); + d.qy = d.y + (d.y - (d.qy || d.y)); + pathCommand = ["C"].concat(me.quadratic2curve(d.x, d.y, d.qx, d.qy, pathCommand[1], pathCommand[2])); + break; + case "Q": + d.qx = pathCommand[1]; + d.qy = pathCommand[2]; + pathCommand = ["C"].concat(me.quadratic2curve(d.x, d.y, pathCommand[1], pathCommand[2], pathCommand[3], pathCommand[4])); + break; + case "L": + pathCommand = ["C"].concat(d.x, d.y, pathCommand[1], pathCommand[2], pathCommand[1], pathCommand[2]); + break; + case "H": + pathCommand = ["C"].concat(d.x, d.y, pathCommand[1], d.y, pathCommand[1], d.y); + break; + case "V": + pathCommand = ["C"].concat(d.x, d.y, d.x, pathCommand[1], d.x, pathCommand[1]); + break; + case "Z": + pathCommand = ["C"].concat(d.x, d.y, d.X, d.Y, d.X, d.Y); + break; + } + return pathCommand; + }, + + quadratic2curve: function (x1, y1, ax, ay, x2, y2) { + var _13 = 1 / 3, + _23 = 2 / 3; + return [ + _13 * x1 + _23 * ax, + _13 * y1 + _23 * ay, + _13 * x2 + _23 * ax, + _13 * y2 + _23 * ay, + x2, + y2 + ]; + }, + + rotate: function (x, y, rad) { + var cos = Math.cos(rad), + sin = Math.sin(rad), + X = x * cos - y * sin, + Y = x * sin + y * cos; + return {x: X, y: Y}; + }, + + arc2curve: function (x1, y1, rx, ry, angle, large_arc_flag, sweep_flag, x2, y2, recursive) { + // for more information of where this Math came from visit: + // http://www.w3.org/TR/SVG11/implnote.html#ArcImplementationNotes + var me = this, + PI = Math.PI, + radian = me.radian, + _120 = PI * 120 / 180, + rad = radian * (+angle || 0), + res = [], + math = Math, + mcos = math.cos, + msin = math.sin, + msqrt = math.sqrt, + mabs = math.abs, + masin = math.asin, + xy, cos, sin, x, y, h, rx2, ry2, k, cx, cy, f1, f2, df, c1, s1, c2, s2, + t, hx, hy, m1, m2, m3, m4, newres, i, ln, f2old, x2old, y2old; + if (!recursive) { + xy = me.rotate(x1, y1, -rad); + x1 = xy.x; + y1 = xy.y; + xy = me.rotate(x2, y2, -rad); + x2 = xy.x; + y2 = xy.y; + cos = mcos(radian * angle); + sin = msin(radian * angle); + x = (x1 - x2) / 2; + y = (y1 - y2) / 2; + h = (x * x) / (rx * rx) + (y * y) / (ry * ry); + if (h > 1) { + h = msqrt(h); + rx = h * rx; + ry = h * ry; + } + rx2 = rx * rx; + ry2 = ry * ry; + k = (large_arc_flag == sweep_flag ? -1 : 1) * + msqrt(mabs((rx2 * ry2 - rx2 * y * y - ry2 * x * x) / (rx2 * y * y + ry2 * x * x))); + cx = k * rx * y / ry + (x1 + x2) / 2; + cy = k * -ry * x / rx + (y1 + y2) / 2; + f1 = masin(((y1 - cy) / ry).toFixed(7)); + f2 = masin(((y2 - cy) / ry).toFixed(7)); + + f1 = x1 < cx ? PI - f1 : f1; + f2 = x2 < cx ? PI - f2 : f2; + if (f1 < 0) { + f1 = PI * 2 + f1; + } + if (f2 < 0) { + f2 = PI * 2 + f2; + } + if (sweep_flag && f1 > f2) { + f1 = f1 - PI * 2; + } + if (!sweep_flag && f2 > f1) { + f2 = f2 - PI * 2; + } + } + else { + f1 = recursive[0]; + f2 = recursive[1]; + cx = recursive[2]; + cy = recursive[3]; + } + df = f2 - f1; + if (mabs(df) > _120) { + f2old = f2; + x2old = x2; + y2old = y2; + f2 = f1 + _120 * (sweep_flag && f2 > f1 ? 1 : -1); + x2 = cx + rx * mcos(f2); + y2 = cy + ry * msin(f2); + res = me.arc2curve(x2, y2, rx, ry, angle, 0, sweep_flag, x2old, y2old, [f2, f2old, cx, cy]); + } + df = f2 - f1; + c1 = mcos(f1); + s1 = msin(f1); + c2 = mcos(f2); + s2 = msin(f2); + t = math.tan(df / 4); + hx = 4 / 3 * rx * t; + hy = 4 / 3 * ry * t; + m1 = [x1, y1]; + m2 = [x1 + hx * s1, y1 - hy * c1]; + m3 = [x2 + hx * s2, y2 - hy * c2]; + m4 = [x2, y2]; + m2[0] = 2 * m1[0] - m2[0]; + m2[1] = 2 * m1[1] - m2[1]; + if (recursive) { + return [m2, m3, m4].concat(res); + } + else { + res = [m2, m3, m4].concat(res).join().split(","); + newres = []; + ln = res.length; + for (i = 0; i < ln; i++) { + newres[i] = i % 2 ? me.rotate(res[i - 1], res[i], rad).y : me.rotate(res[i], res[i + 1], rad).x; + } + return newres; + } + }, + + // TO BE DEPRECATED + rotateAndTranslatePath: function (sprite) { + var alpha = sprite.rotation.degrees, + cx = sprite.rotation.x, + cy = sprite.rotation.y, + dx = sprite.translation.x, + dy = sprite.translation.y, + path, + i, + p, + xy, + j, + res = []; + if (!alpha && !dx && !dy) { + return this.pathToAbsolute(sprite.attr.path); + } + dx = dx || 0; + dy = dy || 0; + path = this.pathToAbsolute(sprite.attr.path); + for (i = path.length; i--;) { + p = res[i] = path[i].slice(); + if (p[0] == "A") { + xy = this.rotatePoint(p[6], p[7], alpha, cx, cy); + p[6] = xy.x + dx; + p[7] = xy.y + dy; + } else { + j = 1; + while (p[j + 1] != null) { + xy = this.rotatePoint(p[j], p[j + 1], alpha, cx, cy); + p[j] = xy.x + dx; + p[j + 1] = xy.y + dy; + j += 2; + } + } + } + return res; + }, + + // TO BE DEPRECATED + rotatePoint: function (x, y, alpha, cx, cy) { + if (!alpha) { + return { + x: x, + y: y + }; + } + cx = cx || 0; + cy = cy || 0; + x = x - cx; + y = y - cy; + alpha = alpha * this.radian; + var cos = Math.cos(alpha), + sin = Math.sin(alpha); + return { + x: x * cos - y * sin + cx, + y: x * sin + y * cos + cy + }; + }, + + pathDimensions: function (path) { + if (!path || !(path + "")) { + return {x: 0, y: 0, width: 0, height: 0}; + } + path = this.path2curve(path); + var x = 0, + y = 0, + X = [], + Y = [], + i = 0, + ln = path.length, + p, xmin, ymin, dim; + for (; i < ln; i++) { + p = path[i]; + if (p[0] == "M") { + x = p[1]; + y = p[2]; + X.push(x); + Y.push(y); + } + else { + dim = this.curveDim(x, y, p[1], p[2], p[3], p[4], p[5], p[6]); + X = X.concat(dim.min.x, dim.max.x); + Y = Y.concat(dim.min.y, dim.max.y); + x = p[5]; + y = p[6]; + } + } + xmin = Math.min.apply(0, X); + ymin = Math.min.apply(0, Y); + return { + x: xmin, + y: ymin, + path: path, + width: Math.max.apply(0, X) - xmin, + height: Math.max.apply(0, Y) - ymin + }; + }, + + intersectInside: function(path, cp1, cp2) { + return (cp2[0] - cp1[0]) * (path[1] - cp1[1]) > (cp2[1] - cp1[1]) * (path[0] - cp1[0]); + }, + + intersectIntersection: function(s, e, cp1, cp2) { + var p = [], + dcx = cp1[0] - cp2[0], + dcy = cp1[1] - cp2[1], + dpx = s[0] - e[0], + dpy = s[1] - e[1], + n1 = cp1[0] * cp2[1] - cp1[1] * cp2[0], + n2 = s[0] * e[1] - s[1] * e[0], + n3 = 1 / (dcx * dpy - dcy * dpx); + + p[0] = (n1 * dpx - n2 * dcx) * n3; + p[1] = (n1 * dpy - n2 * dcy) * n3; + return p; + }, + + intersect: function(subjectPolygon, clipPolygon) { + var me = this, + i = 0, + ln = clipPolygon.length, + cp1 = clipPolygon[ln - 1], + outputList = subjectPolygon, + cp2, s, e, point, ln2, inputList, j; + for (; i < ln; ++i) { + cp2 = clipPolygon[i]; + inputList = outputList; + outputList = []; + s = inputList[inputList.length - 1]; + j = 0; + ln2 = inputList.length; + for (; j < ln2; j++) { + e = inputList[j]; + if (me.intersectInside(e, cp1, cp2)) { + if (!me.intersectInside(s, cp1, cp2)) { + outputList.push(me.intersectIntersection(s, e, cp1, cp2)); + } + outputList.push(e); + } + else if (me.intersectInside(s, cp1, cp2)) { + outputList.push(me.intersectIntersection(s, e, cp1, cp2)); + } + s = e; + } + cp1 = cp2; + } + return outputList; + }, + + curveDim: function (p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y) { + var a = (c2x - 2 * c1x + p1x) - (p2x - 2 * c2x + c1x), + b = 2 * (c1x - p1x) - 2 * (c2x - c1x), + c = p1x - c1x, + t1 = (-b + Math.sqrt(b * b - 4 * a * c)) / 2 / a, + t2 = (-b - Math.sqrt(b * b - 4 * a * c)) / 2 / a, + y = [p1y, p2y], + x = [p1x, p2x], + dot; + if (Math.abs(t1) > 1e12) { + t1 = 0.5; + } + if (Math.abs(t2) > 1e12) { + t2 = 0.5; + } + if (t1 > 0 && t1 < 1) { + dot = this.findDotAtSegment(p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t1); + x.push(dot.x); + y.push(dot.y); + } + if (t2 > 0 && t2 < 1) { + dot = this.findDotAtSegment(p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t2); + x.push(dot.x); + y.push(dot.y); + } + a = (c2y - 2 * c1y + p1y) - (p2y - 2 * c2y + c1y); + b = 2 * (c1y - p1y) - 2 * (c2y - c1y); + c = p1y - c1y; + t1 = (-b + Math.sqrt(b * b - 4 * a * c)) / 2 / a; + t2 = (-b - Math.sqrt(b * b - 4 * a * c)) / 2 / a; + if (Math.abs(t1) > 1e12) { + t1 = 0.5; + } + if (Math.abs(t2) > 1e12) { + t2 = 0.5; + } + if (t1 > 0 && t1 < 1) { + dot = this.findDotAtSegment(p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t1); + x.push(dot.x); + y.push(dot.y); + } + if (t2 > 0 && t2 < 1) { + dot = this.findDotAtSegment(p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t2); + x.push(dot.x); + y.push(dot.y); + } + return { + min: {x: Math.min.apply(0, x), y: Math.min.apply(0, y)}, + max: {x: Math.max.apply(0, x), y: Math.max.apply(0, y)} + }; + }, + + getAnchors: function (p1x, p1y, p2x, p2y, p3x, p3y, value) { + value = value || 4; + var l = Math.min(Math.sqrt(Math.pow(p1x - p2x, 2) + Math.pow(p1y - p2y, 2)) / value, Math.sqrt(Math.pow(p3x - p2x, 2) + Math.pow(p3y - p2y, 2)) / value), + a = Math.atan((p2x - p1x) / Math.abs(p2y - p1y)), + b = Math.atan((p3x - p2x) / Math.abs(p2y - p3y)), + pi = Math.PI; + a = p1y < p2y ? pi - a : a; + b = p3y < p2y ? pi - b : b; + var alpha = pi / 2 - ((a + b) % (pi * 2)) / 2; + alpha > pi / 2 && (alpha -= pi); + var dx1 = l * Math.sin(alpha + a), + dy1 = l * Math.cos(alpha + a), + dx2 = l * Math.sin(alpha + b), + dy2 = l * Math.cos(alpha + b), + out = { + x1: p2x - dx1, + y1: p2y + dy1, + x2: p2x + dx2, + y2: p2y + dy2 + }; + return out; + }, + + /* Smoothing function for a path. Converts a path into cubic beziers. Value defines the divider of the distance between points. + * Defaults to a value of 4. + */ + smooth: function (originalPath, value) { + var path = this.path2curve(originalPath), + newp = [path[0]], + x = path[0][1], + y = path[0][2], + j, + points, + i = 1, + ii = path.length, + beg = 1, + mx = x, + my = y, + cx = 0, + cy = 0; + for (; i < ii; i++) { + var pathi = path[i], + pathil = pathi.length, + pathim = path[i - 1], + pathiml = pathim.length, + pathip = path[i + 1], + pathipl = pathip && pathip.length; + if (pathi[0] == "M") { + mx = pathi[1]; + my = pathi[2]; + j = i + 1; + while (path[j][0] != "C") { + j++; + } + cx = path[j][5]; + cy = path[j][6]; + newp.push(["M", mx, my]); + beg = newp.length; + x = mx; + y = my; + continue; + } + if (pathi[pathil - 2] == mx && pathi[pathil - 1] == my && (!pathip || pathip[0] == "M")) { + var begl = newp[beg].length; + points = this.getAnchors(pathim[pathiml - 2], pathim[pathiml - 1], mx, my, newp[beg][begl - 2], newp[beg][begl - 1], value); + newp[beg][1] = points.x2; + newp[beg][2] = points.y2; + } + else if (!pathip || pathip[0] == "M") { + points = { + x1: pathi[pathil - 2], + y1: pathi[pathil - 1] + }; + } else { + points = this.getAnchors(pathim[pathiml - 2], pathim[pathiml - 1], pathi[pathil - 2], pathi[pathil - 1], pathip[pathipl - 2], pathip[pathipl - 1], value); + } + newp.push(["C", x, y, points.x1, points.y1, pathi[pathil - 2], pathi[pathil - 1]]); + x = points.x2; + y = points.y2; + } + return newp; + }, + + findDotAtSegment: function (p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t) { + var t1 = 1 - t; + return { + x: Math.pow(t1, 3) * p1x + Math.pow(t1, 2) * 3 * t * c1x + t1 * 3 * t * t * c2x + Math.pow(t, 3) * p2x, + y: Math.pow(t1, 3) * p1y + Math.pow(t1, 2) * 3 * t * c1y + t1 * 3 * t * t * c2y + Math.pow(t, 3) * p2y + }; + }, + + snapEnds: function (from, to, stepsMax) { + var step = (to - from) / stepsMax, + level = Math.floor(Math.log(step) / Math.LN10) + 1, + m = Math.pow(10, level), + cur, + modulo = Math.round((step % m) * Math.pow(10, 2 - level)), + interval = [[0, 15], [20, 4], [30, 2], [40, 4], [50, 9], [60, 4], [70, 2], [80, 4], [100, 15]], + stepCount = 0, + value, + weight, + i, + topValue, + topWeight = 1e9, + ln = interval.length; + cur = from = Math.floor(from / m) * m; + for (i = 0; i < ln; i++) { + value = interval[i][0]; + weight = (value - modulo) < 0 ? 1e6 : (value - modulo) / interval[i][1]; + if (weight < topWeight) { + topValue = value; + topWeight = weight; + } + } + step = Math.floor(step * Math.pow(10, -level)) * Math.pow(10, level) + topValue * Math.pow(10, level - 2); + while (cur < to) { + cur += step; + stepCount++; + } + to = +cur.toFixed(10); + return { + from: from, + to: to, + power: level, + step: step, + steps: stepCount + }; + }, + + sorter: function (a, b) { + return a.offset - b.offset; + }, + + rad: function(degrees) { + return degrees % 360 * Math.PI / 180; + }, + + degrees: function(radian) { + return radian * 180 / Math.PI % 360; + }, + + withinBox: function(x, y, bbox) { + bbox = bbox || {}; + return (x >= bbox.x && x <= (bbox.x + bbox.width) && y >= bbox.y && y <= (bbox.y + bbox.height)); + }, + + parseGradient: function(gradient) { + var me = this, + type = gradient.type || 'linear', + angle = gradient.angle || 0, + radian = me.radian, + stops = gradient.stops, + stopsArr = [], + stop, + vector, + max, + stopObj; + + if (type == 'linear') { + vector = [0, 0, Math.cos(angle * radian), Math.sin(angle * radian)]; + max = 1 / (Math.max(Math.abs(vector[2]), Math.abs(vector[3])) || 1); + vector[2] *= max; + vector[3] *= max; + if (vector[2] < 0) { + vector[0] = -vector[2]; + vector[2] = 0; + } + if (vector[3] < 0) { + vector[1] = -vector[3]; + vector[3] = 0; + } + } + + for (stop in stops) { + if (stops.hasOwnProperty(stop) && me.stopsRE.test(stop)) { + stopObj = { + offset: parseInt(stop, 10), + color: Ext.draw.Color.toHex(stops[stop].color) || '#ffffff', + opacity: stops[stop].opacity || 1 + }; + stopsArr.push(stopObj); + } + } + // Sort by pct property + Ext.Array.sort(stopsArr, me.sorter); + if (type == 'linear') { + return { + id: gradient.id, + type: type, + vector: vector, + stops: stopsArr + }; + } + else { + return { + id: gradient.id, + type: type, + centerX: gradient.centerX, + centerY: gradient.centerY, + focalX: gradient.focalX, + focalY: gradient.focalY, + radius: gradient.radius, + vector: vector, + stops: stopsArr + }; + } + } +}); + +/** + * @class Ext.fx.PropertyHandler + * @ignore + */ +Ext.define('Ext.fx.PropertyHandler', { + + /* Begin Definitions */ + + requires: ['Ext.draw.Draw'], + + statics: { + defaultHandler: { + pixelDefaults: ['width', 'height', 'top', 'left'], + unitRE: /^(-?\d*\.?\d*){1}(em|ex|px|in|cm|mm|pt|pc|%)*$/, + + computeDelta: function(from, end, damper, initial, attr) { + damper = (typeof damper == 'number') ? damper : 1; + var match = this.unitRE.exec(from), + start, units; + if (match) { + from = match[1]; + units = match[2]; + if (!units && Ext.Array.contains(this.pixelDefaults, attr)) { + units = 'px'; + } + } + from = +from || 0; + + match = this.unitRE.exec(end); + if (match) { + end = match[1]; + units = match[2] || units; + } + end = +end || 0; + start = (initial != null) ? initial : from; + return { + from: from, + delta: (end - start) * damper, + units: units + }; + }, + + get: function(from, end, damper, initialFrom, attr) { + var ln = from.length, + out = [], + i, initial, res, j, len; + for (i = 0; i < ln; i++) { + if (initialFrom) { + initial = initialFrom[i][1].from; + } + if (Ext.isArray(from[i][1]) && Ext.isArray(end)) { + res = []; + j = 0; + len = from[i][1].length; + for (; j < len; j++) { + res.push(this.computeDelta(from[i][1][j], end[j], damper, initial, attr)); + } + out.push([from[i][0], res]); + } + else { + out.push([from[i][0], this.computeDelta(from[i][1], end, damper, initial, attr)]); + } + } + return out; + }, + + set: function(values, easing) { + var ln = values.length, + out = [], + i, val, res, len, j; + for (i = 0; i < ln; i++) { + val = values[i][1]; + if (Ext.isArray(val)) { + res = []; + j = 0; + len = val.length; + for (; j < len; j++) { + res.push(val[j].from + (val[j].delta * easing) + (val[j].units || 0)); + } + out.push([values[i][0], res]); + } else { + out.push([values[i][0], val.from + (val.delta * easing) + (val.units || 0)]); + } + } + return out; + } + }, + color: { + rgbRE: /^rgb$([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)$$/i, + hexRE: /^#?([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})$/i, + hex3RE: /^#?([0-9A-F]{1})([0-9A-F]{1})([0-9A-F]{1})$/i, + + parseColor : function(color, damper) { + damper = (typeof damper == 'number') ? damper : 1; + var base, + out = false, + match; + + Ext.each([this.hexRE, this.rgbRE, this.hex3RE], function(re, idx) { + base = (idx % 2 == 0) ? 16 : 10; + match = re.exec(color); + if (match && match.length == 4) { + if (idx == 2) { + match[1] += match[1]; + match[2] += match[2]; + match[3] += match[3]; + } + out = { + red: parseInt(match[1], base), + green: parseInt(match[2], base), + blue: parseInt(match[3], base) + }; + return false; + } + }); + return out || color; + }, + + computeDelta: function(from, end, damper, initial) { + from = this.parseColor(from); + end = this.parseColor(end, damper); + var start = initial ? initial : from, + tfrom = typeof start, + tend = typeof end; + //Extra check for when the color string is not recognized. + if (tfrom == 'string' || tfrom == 'undefined' + || tend == 'string' || tend == 'undefined') { + return end || start; + } + return { + from: from, + delta: { + red: Math.round((end.red - start.red) * damper), + green: Math.round((end.green - start.green) * damper), + blue: Math.round((end.blue - start.blue) * damper) + } + }; + }, + + get: function(start, end, damper, initialFrom) { + var ln = start.length, + out = [], + i, initial; + for (i = 0; i < ln; i++) { + if (initialFrom) { + initial = initialFrom[i][1].from; + } + out.push([start[i][0], this.computeDelta(start[i][1], end, damper, initial)]); + } + return out; + }, + + set: function(values, easing) { + var ln = values.length, + out = [], + i, val, parsedString, from, delta; + for (i = 0; i < ln; i++) { + val = values[i][1]; + if (val) { + from = val.from; + delta = val.delta; + //multiple checks to reformat the color if it can't recognized by computeDelta. + val = (typeof val == 'object' && 'red' in val)? + 'rgb(' + val.red + ', ' + val.green + ', ' + val.blue + ')' : val; + val = (typeof val == 'object' && val.length)? val[0] : val; + if (typeof val == 'undefined') { + return []; + } + parsedString = typeof val == 'string'? val : + 'rgb(' + [ + (from.red + Math.round(delta.red * easing)) % 256, + (from.green + Math.round(delta.green * easing)) % 256, + (from.blue + Math.round(delta.blue * easing)) % 256 + ].join(',') + ')'; + out.push([ + values[i][0], + parsedString + ]); + } + } + return out; + } + }, + object: { + interpolate: function(prop, damper) { + damper = (typeof damper == 'number') ? damper : 1; + var out = {}, + p; + for(p in prop) { + out[p] = parseInt(prop[p], 10) * damper; + } + return out; + }, + + computeDelta: function(from, end, damper, initial) { + from = this.interpolate(from); + end = this.interpolate(end, damper); + var start = initial ? initial : from, + delta = {}, + p; + + for(p in end) { + delta[p] = end[p] - start[p]; + } + return { + from: from, + delta: delta + }; + }, + + get: function(start, end, damper, initialFrom) { + var ln = start.length, + out = [], + i, initial; + for (i = 0; i < ln; i++) { + if (initialFrom) { + initial = initialFrom[i][1].from; + } + out.push([start[i][0], this.computeDelta(start[i][1], end, damper, initial)]); + } + return out; + }, + + set: function(values, easing) { + var ln = values.length, + out = [], + outObject = {}, + i, from, delta, val, p; + for (i = 0; i < ln; i++) { + val = values[i][1]; + from = val.from; + delta = val.delta; + for (p in from) { + outObject[p] = Math.round(from[p] + delta[p] * easing); + } + out.push([ + values[i][0], + outObject + ]); + } + return out; + } + }, + + path: { + computeDelta: function(from, end, damper, initial) { + damper = (typeof damper == 'number') ? damper : 1; + var start; + from = +from || 0; + end = +end || 0; + start = (initial != null) ? initial : from; + return { + from: from, + delta: (end - start) * damper + }; + }, + + forcePath: function(path) { + if (!Ext.isArray(path) && !Ext.isArray(path[0])) { + path = Ext.draw.Draw.parsePathString(path); + } + return path; + }, + + get: function(start, end, damper, initialFrom) { + var endPath = this.forcePath(end), + out = [], + startLn = start.length, + startPathLn, pointsLn, i, deltaPath, initial, j, k, path, startPath; + for (i = 0; i < startLn; i++) { + startPath = this.forcePath(start[i][1]); + + deltaPath = Ext.draw.Draw.interpolatePaths(startPath, endPath); + startPath = deltaPath[0]; + endPath = deltaPath[1]; + + startPathLn = startPath.length; + path = []; + for (j = 0; j < startPathLn; j++) { + deltaPath = [startPath[j][0]]; + pointsLn = startPath[j].length; + for (k = 1; k < pointsLn; k++) { + initial = initialFrom && initialFrom[0][1][j][k].from; + deltaPath.push(this.computeDelta(startPath[j][k], endPath[j][k], damper, initial)); + } + path.push(deltaPath); + } + out.push([start[i][0], path]); + } + return out; + }, + + set: function(values, easing) { + var ln = values.length, + out = [], + i, j, k, newPath, calcPath, deltaPath, deltaPathLn, pointsLn; + for (i = 0; i < ln; i++) { + deltaPath = values[i][1]; + newPath = []; + deltaPathLn = deltaPath.length; + for (j = 0; j < deltaPathLn; j++) { + calcPath = [deltaPath[j][0]]; + pointsLn = deltaPath[j].length; + for (k = 1; k < pointsLn; k++) { + calcPath.push(deltaPath[j][k].from + deltaPath[j][k].delta * easing); + } + newPath.push(calcPath.join(',')); + } + out.push([values[i][0], newPath.join(',')]); + } + return out; + } + } + /* End Definitions */ + } +}, function() { + Ext.each([ + 'outlineColor', + 'backgroundColor', + 'borderColor', + 'borderTopColor', + 'borderRightColor', + 'borderBottomColor', + 'borderLeftColor', + 'fill', + 'stroke' + ], function(prop) { + this[prop] = this.color; + }, this); +}); +/** + * @class Ext.fx.Anim + * + * This class manages animation for a specific {@link #target}. The animation allows + * animation of various properties on the target, such as size, position, color and others. + * + * ## Starting Conditions + * The starting conditions for the animation are provided by the {@link #from} configuration. + * Any/all of the properties in the {@link #from} configuration can be specified. If a particular + * property is not defined, the starting value for that property will be read directly from the target. + * + * ## End Conditions + * The ending conditions for the animation are provided by the {@link #to} configuration. These mark + * the final values once the animations has finished. The values in the {@link #from} can mirror + * those in the {@link #to} configuration to provide a starting point. + * + * ## Other Options + * - {@link #duration}: Specifies the time period of the animation. + * - {@link #easing}: Specifies the easing of the animation. + * - {@link #iterations}: Allows the animation to repeat a number of times. + * - {@link #alternate}: Used in conjunction with {@link #iterations}, reverses the direction every second iteration. + * + * ## Example Code + * + * var myComponent = Ext.create('Ext.Component', { + * renderTo: document.body, + * width: 200, + * height: 200, + * style: 'border: 1px solid red;' + * }); + * + * new Ext.fx.Anim({ + * target: myComponent, + * duration: 1000, + * from: { + * width: 400 //starting width 400 + * }, + * to: { + * width: 300, //end width 300 + * height: 300 // end width 300 + * } + * }); + */ +Ext.define('Ext.fx.Anim', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: ['Ext.fx.Manager', 'Ext.fx.Animator', 'Ext.fx.Easing', 'Ext.fx.CubicBezier', 'Ext.fx.PropertyHandler'], + + /* End Definitions */ + + isAnimation: true, + /** + * @cfg {Number} duration + * Time in milliseconds for a single animation to last. Defaults to 250. If the {@link #iterations} property is + * specified, then each animate will take the same duration for each iteration. + */ + duration: 250, + + /** + * @cfg {Number} delay + * Time to delay before starting the animation. Defaults to 0. + */ + delay: 0, + + /* private used to track a delayed starting time */ + delayStart: 0, + + /** + * @cfg {Boolean} dynamic + * Currently only for Component Animation: Only set a component's outer element size bypassing layouts. Set to true to do full layouts for every frame of the animation. Defaults to false. + */ + dynamic: false, + + /** + * @cfg {String} easing +This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change +speed over its duration. + + -backIn + -backOut + -bounceIn + -bounceOut + -ease + -easeIn + -easeOut + -easeInOut + -elasticIn + -elasticOut + -cubic-bezier(x1, y1, x2, y2) + +Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification `{@link http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag}`. The four values specify points P1 and P2 of the curve +as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid. + * @markdown + */ + easing: 'ease', + + /** + * @cfg {Object} keyframes + * Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to' + * is considered '100%'.Every keyframe declaration must have a keyframe rule for 0% and 100%, possibly defined using + * "from" or "to". A keyframe declaration without these keyframe selectors is invalid and will not be available for + * animation. The keyframe declaration for a keyframe rule consists of properties and values. Properties that are unable to + * be animated are ignored in these rules, with the exception of 'easing' which can be changed at each keyframe. For example: +
+keyframes : { + '0%': { + left: 100 + }, + '40%': { + left: 150 + }, + '60%': { + left: 75 + }, + '100%': { + left: 100 + } +} +
+ */ + + /** + * @private + */ + damper: 1, + + /** + * @private + */ + bezierRE: /^(?:cubic-)?bezier$([^,]+),([^,]+),([^,]+),([^$]+)\)/, + + /** + * Run the animation from the end to the beginning + * Defaults to false. + * @cfg {Boolean} reverse + */ + reverse: false, + + /** + * Flag to determine if the animation has started + * @property running + * @type boolean + */ + running: false, + + /** + * Flag to determine if the animation is paused. Only set this to true if you need to + * keep the Anim instance around to be unpaused later; otherwise call {@link #end}. + * @property paused + * @type boolean + */ + paused: false, + + /** + * Number of times to execute the animation. Defaults to 1. + * @cfg {int} iterations + */ + iterations: 1, + + /** + * Used in conjunction with iterations to reverse the animation each time an iteration completes. + * @cfg {Boolean} alternate + * Defaults to false. + */ + alternate: false, + + /** + * Current iteration the animation is running. + * @property currentIteration + * @type int + */ + currentIteration: 0, + + /** + * Starting time of the animation. + * @property startTime + * @type Date + */ + startTime: 0, + + /** + * Contains a cache of the interpolators to be used. + * @private + * @property propHandlers + * @type Object + */ + + /** + * @cfg {String/Object} target + * The {@link Ext.fx.target.Target} to apply the animation to. This should only be specified when creating an Ext.fx.Anim directly. + * The target does not need to be a {@link Ext.fx.target.Target} instance, it can be the underlying object. For example, you can + * pass a Component, Element or Sprite as the target and the Anim will create the appropriate {@link Ext.fx.target.Target} object + * automatically. + */ + + /** + * @cfg {Object} from + * An object containing property/value pairs for the beginning of the animation. If not specified, the current state of the + * Ext.fx.target will be used. For example: +
+from : { + opacity: 0, // Transparent + color: '#ffffff', // White + left: 0 +} +
+ */ + + /** + * @cfg {Object} to + * An object containing property/value pairs for the end of the animation. For example: +
+ to : { + opacity: 1, // Opaque + color: '#00ff00', // Green + left: 500 + } +
+ */ + + // @private + constructor: function(config) { + var me = this; + config = config || {}; + // If keyframes are passed, they really want an Animator instead. + if (config.keyframes) { + return Ext.create('Ext.fx.Animator', config); + } + config = Ext.apply(me, config); + if (me.from === undefined) { + me.from = {}; + } + me.propHandlers = {}; + me.config = config; + me.target = Ext.fx.Manager.createTarget(me.target); + me.easingFn = Ext.fx.Easing[me.easing]; + me.target.dynamic = me.dynamic; + + // If not a pre-defined curve, try a cubic-bezier + if (!me.easingFn) { + me.easingFn = String(me.easing).match(me.bezierRE); + if (me.easingFn && me.easingFn.length == 5) { + var curve = me.easingFn; + me.easingFn = Ext.fx.cubicBezier(+curve[1], +curve[2], +curve[3], +curve[4]); + } + } + me.id = Ext.id(null, 'ext-anim-'); + Ext.fx.Manager.addAnim(me); + me.addEvents( + /** + * @event beforeanimate + * Fires before the animation starts. A handler can return false to cancel the animation. + * @param {Ext.fx.Anim} this + */ + 'beforeanimate', + /** + * @event afteranimate + * Fires when the animation is complete. + * @param {Ext.fx.Anim} this + * @param {Date} startTime + */ + 'afteranimate', + /** + * @event lastframe + * Fires when the animation's last frame has been set. + * @param {Ext.fx.Anim} this + * @param {Date} startTime + */ + 'lastframe' + ); + me.mixins.observable.constructor.call(me, config); + if (config.callback) { + me.on('afteranimate', config.callback, config.scope); + } + return me; + }, + + /** + * @private + * Helper to the target + */ + setAttr: function(attr, value) { + return Ext.fx.Manager.items.get(this.id).setAttr(this.target, attr, value); + }, + + /* + * @private + * Set up the initial currentAttrs hash. + */ + initAttrs: function() { + var me = this, + from = me.from, + to = me.to, + initialFrom = me.initialFrom || {}, + out = {}, + start, end, propHandler, attr; + + for (attr in to) { + if (to.hasOwnProperty(attr)) { + start = me.target.getAttr(attr, from[attr]); + end = to[attr]; + // Use default (numeric) property handler + if (!Ext.fx.PropertyHandler[attr]) { + if (Ext.isObject(end)) { + propHandler = me.propHandlers[attr] = Ext.fx.PropertyHandler.object; + } else { + propHandler = me.propHandlers[attr] = Ext.fx.PropertyHandler.defaultHandler; + } + } + // Use custom handler + else { + propHandler = me.propHandlers[attr] = Ext.fx.PropertyHandler[attr]; + } + out[attr] = propHandler.get(start, end, me.damper, initialFrom[attr], attr); + } + } + me.currentAttrs = out; + }, + + /* + * @private + * Fires beforeanimate and sets the running flag. + */ + start: function(startTime) { + var me = this, + delay = me.delay, + delayStart = me.delayStart, + delayDelta; + if (delay) { + if (!delayStart) { + me.delayStart = startTime; + return; + } + else { + delayDelta = startTime - delayStart; + if (delayDelta < delay) { + return; + } + else { + // Compensate for frame delay; + startTime = new Date(delayStart.getTime() + delay); + } + } + } + if (me.fireEvent('beforeanimate', me) !== false) { + me.startTime = startTime; + if (!me.paused && !me.currentAttrs) { + me.initAttrs(); + } + me.running = true; + } + }, + + /* + * @private + * Calculate attribute value at the passed timestamp. + * @returns a hash of the new attributes. + */ + runAnim: function(elapsedTime) { + var me = this, + attrs = me.currentAttrs, + duration = me.duration, + easingFn = me.easingFn, + propHandlers = me.propHandlers, + ret = {}, + easing, values, attr, lastFrame; + + if (elapsedTime >= duration) { + elapsedTime = duration; + lastFrame = true; + } + if (me.reverse) { + elapsedTime = duration - elapsedTime; + } + + for (attr in attrs) { + if (attrs.hasOwnProperty(attr)) { + values = attrs[attr]; + easing = lastFrame ? 1 : easingFn(elapsedTime / duration); + ret[attr] = propHandlers[attr].set(values, easing); + } + } + return ret; + }, + + /* + * @private + * Perform lastFrame cleanup and handle iterations + * @returns a hash of the new attributes. + */ + lastFrame: function() { + var me = this, + iter = me.iterations, + iterCount = me.currentIteration; + + iterCount++; + if (iterCount < iter) { + if (me.alternate) { + me.reverse = !me.reverse; + } + me.startTime = new Date(); + me.currentIteration = iterCount; + // Turn off paused for CSS3 Transitions + me.paused = false; + } + else { + me.currentIteration = 0; + me.end(); + me.fireEvent('lastframe', me, me.startTime); + } + }, + + /* + * Fire afteranimate event and end the animation. Usually called automatically when the + * animation reaches its final frame, but can also be called manually to pre-emptively + * stop and destroy the running animation. + */ + end: function() { + var me = this; + me.startTime = 0; + me.paused = false; + me.running = false; + Ext.fx.Manager.removeAnim(me); + me.fireEvent('afteranimate', me, me.startTime); + } +}); +// Set flag to indicate that Fx is available. Class might not be available immediately. +Ext.enableFx = true; + +/* + * This is a derivative of the similarly named class in the YUI Library. + * The original license: + * Copyright (c) 2006, Yahoo! Inc. All rights reserved. + * Code licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + */ + + +/** + * @class Ext.dd.DragDrop + * Defines the interface and base operation of items that that can be + * dragged or can be drop targets. It was designed to be extended, overriding + * the event handlers for startDrag, onDrag, onDragOver and onDragOut. + * Up to three html elements can be associated with a DragDrop instance: + *
+ *
linked element: the element that is passed into the constructor. + * This is the element which defines the boundaries for interaction with + * other DragDrop objects.
+ *
handle element(s): The drag operation only occurs if the element that + * was clicked matches a handle element. By default this is the linked + * element, but there are times that you will want only a portion of the + * linked element to initiate the drag operation, and the setHandleElId() + * method provides a way to define this.
+ *
drag element: this represents the element that would be moved along + * with the cursor during a drag operation. By default, this is the linked + * element itself as in {@link Ext.dd.DD}. setDragElId() lets you define + * a separate element that would be moved, as in {@link Ext.dd.DDProxy}. + *
+ *
+ * This class should not be instantiated until the onload event to ensure that + * the associated elements are available. + * The following would define a DragDrop obj that would interact with any + * other DragDrop obj in the "group1" group: + *
+ * dd = new Ext.dd.DragDrop("div1", "group1"); + *
+ * Since none of the event handlers have been implemented, nothing would + * actually happen if you were to run the code above. Normally you would + * override this class or one of the default implementations, but you can + * also override the methods you want on an instance of the class... + *
+ * dd.onDragDrop = function(e, id) { + *   alert("dd was dropped on " + id); + * } + *
+ * @constructor + * @param {String} id of the element that is linked to this instance + * @param {String} sGroup the group of related DragDrop objects + * @param {object} config an object containing configurable attributes + * Valid properties for DragDrop: + * padding, isTarget, maintainOffset, primaryButtonOnly + */ + +Ext.define('Ext.dd.DragDrop', { + requires: ['Ext.dd.DragDropManager'], + constructor: function(id, sGroup, config) { + if(id) { + this.init(id, sGroup, config); + } + }, + + /** + * Set to false to enable a DragDrop object to fire drag events while dragging + * over its own Element. Defaults to true - DragDrop objects do not by default + * fire drag events to themselves. + * @property ignoreSelf + * @type Boolean + */ + + /** + * The id of the element associated with this object. This is what we + * refer to as the "linked element" because the size and position of + * this element is used to determine when the drag and drop objects have + * interacted. + * @property id + * @type String + */ + id: null, + + /** + * Configuration attributes passed into the constructor + * @property config + * @type object + */ + config: null, + + /** + * The id of the element that will be dragged. By default this is same + * as the linked element, but could be changed to another element. Ex: + * Ext.dd.DDProxy + * @property dragElId + * @type String + * @private + */ + dragElId: null, + + /** + * The ID of the element that initiates the drag operation. By default + * this is the linked element, but could be changed to be a child of this + * element. This lets us do things like only starting the drag when the + * header element within the linked html element is clicked. + * @property handleElId + * @type String + * @private + */ + handleElId: null, + + /** + * An object who's property names identify HTML tags to be considered invalid as drag handles. + * A non-null property value identifies the tag as invalid. Defaults to the + * following value which prevents drag operations from being initiated by <a> elements:
+{ + A: "A" +}
+ * @property invalidHandleTypes + * @type Object + */ + invalidHandleTypes: null, + + /** + * An object who's property names identify the IDs of elements to be considered invalid as drag handles. + * A non-null property value identifies the ID as invalid. For example, to prevent + * dragging from being initiated on element ID "foo", use:
+{ + foo: true +}
+ * @property invalidHandleIds + * @type Object + */ + invalidHandleIds: null, + + /** + * An Array of CSS class names for elements to be considered in valid as drag handles. + * @property invalidHandleClasses + * @type Array + */ + invalidHandleClasses: null, + + /** + * The linked element's absolute X position at the time the drag was + * started + * @property startPageX + * @type int + * @private + */ + startPageX: 0, + + /** + * The linked element's absolute X position at the time the drag was + * started + * @property startPageY + * @type int + * @private + */ + startPageY: 0, + + /** + * The group defines a logical collection of DragDrop objects that are + * related. Instances only get events when interacting with other + * DragDrop object in the same group. This lets us define multiple + * groups using a single DragDrop subclass if we want. + * @property groups + * @type object An object in the format {'group1':true, 'group2':true} + */ + groups: null, + + /** + * Individual drag/drop instances can be locked. This will prevent + * onmousedown start drag. + * @property locked + * @type boolean + * @private + */ + locked: false, + + /** + * Lock this instance + * @method lock + */ + lock: function() { + this.locked = true; + }, + + /** + * When set to true, other DD objects in cooperating DDGroups do not receive + * notification events when this DD object is dragged over them. Defaults to false. + * @property moveOnly + * @type boolean + */ + moveOnly: false, + + /** + * Unlock this instace + * @method unlock + */ + unlock: function() { + this.locked = false; + }, + + /** + * By default, all instances can be a drop target. This can be disabled by + * setting isTarget to false. + * @property isTarget + * @type boolean + */ + isTarget: true, + + /** + * The padding configured for this drag and drop object for calculating + * the drop zone intersection with this object. + * An array containing the 4 padding values: [top, right, bottom, left] + * @property {[int]} padding + */ + padding: null, + + /** + * Cached reference to the linked element + * @property _domRef + * @private + */ + _domRef: null, + + /** + * Internal typeof flag + * @property __ygDragDrop + * @private + */ + __ygDragDrop: true, + + /** + * Set to true when horizontal contraints are applied + * @property constrainX + * @type boolean + * @private + */ + constrainX: false, + + /** + * Set to true when vertical contraints are applied + * @property constrainY + * @type boolean + * @private + */ + constrainY: false, + + /** + * The left constraint + * @property minX + * @type int + * @private + */ + minX: 0, + + /** + * The right constraint + * @property maxX + * @type int + * @private + */ + maxX: 0, + + /** + * The up constraint + * @property minY + * @type int + * @private + */ + minY: 0, + + /** + * The down constraint + * @property maxY + * @type int + * @private + */ + maxY: 0, + + /** + * Maintain offsets when we resetconstraints. Set to true when you want + * the position of the element relative to its parent to stay the same + * when the page changes + * + * @property maintainOffset + * @type boolean + */ + maintainOffset: false, + + /** + * Array of pixel locations the element will snap to if we specified a + * horizontal graduation/interval. This array is generated automatically + * when you define a tick interval. + * @property {[int]} xTicks + */ + xTicks: null, + + /** + * Array of pixel locations the element will snap to if we specified a + * vertical graduation/interval. This array is generated automatically + * when you define a tick interval. + * @property {[int]} yTicks + */ + yTicks: null, + + /** + * By default the drag and drop instance will only respond to the primary + * button click (left button for a right-handed mouse). Set to true to + * allow drag and drop to start with any mouse click that is propogated + * by the browser + * @property primaryButtonOnly + * @type boolean + */ + primaryButtonOnly: true, + + /** + * The available property is false until the linked dom element is accessible. + * @property available + * @type boolean + */ + available: false, + + /** + * By default, drags can only be initiated if the mousedown occurs in the + * region the linked element is. This is done in part to work around a + * bug in some browsers that mis-report the mousedown if the previous + * mouseup happened outside of the window. This property is set to true + * if outer handles are defined. + * + * @property hasOuterHandles + * @type boolean + * @default false + */ + hasOuterHandles: false, + + /** + * Code that executes immediately before the startDrag event + * @method b4StartDrag + * @private + */ + b4StartDrag: function(x, y) { }, + + /** + * Abstract method called after a drag/drop object is clicked + * and the drag or mousedown time thresholds have beeen met. + * @method startDrag + * @param {int} X click location + * @param {int} Y click location + */ + startDrag: function(x, y) { /* override this */ }, + + /** + * Code that executes immediately before the onDrag event + * @method b4Drag + * @private + */ + b4Drag: function(e) { }, + + /** + * Abstract method called during the onMouseMove event while dragging an + * object. + * @method onDrag + * @param {Event} e the mousemove event + */ + onDrag: function(e) { /* override this */ }, + + /** + * Abstract method called when this element fist begins hovering over + * another DragDrop obj + * @method onDragEnter + * @param {Event} e the mousemove event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this is hovering over. In INTERSECT mode, an array of one or more + * dragdrop items being hovered over. + */ + onDragEnter: function(e, id) { /* override this */ }, + + /** + * Code that executes immediately before the onDragOver event + * @method b4DragOver + * @private + */ + b4DragOver: function(e) { }, + + /** + * Abstract method called when this element is hovering over another + * DragDrop obj + * @method onDragOver + * @param {Event} e the mousemove event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this is hovering over. In INTERSECT mode, an array of dd items + * being hovered over. + */ + onDragOver: function(e, id) { /* override this */ }, + + /** + * Code that executes immediately before the onDragOut event + * @method b4DragOut + * @private + */ + b4DragOut: function(e) { }, + + /** + * Abstract method called when we are no longer hovering over an element + * @method onDragOut + * @param {Event} e the mousemove event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this was hovering over. In INTERSECT mode, an array of dd items + * that the mouse is no longer over. + */ + onDragOut: function(e, id) { /* override this */ }, + + /** + * Code that executes immediately before the onDragDrop event + * @method b4DragDrop + * @private + */ + b4DragDrop: function(e) { }, + + /** + * Abstract method called when this item is dropped on another DragDrop + * obj + * @method onDragDrop + * @param {Event} e the mouseup event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this was dropped on. In INTERSECT mode, an array of dd items this + * was dropped on. + */ + onDragDrop: function(e, id) { /* override this */ }, + + /** + * Abstract method called when this item is dropped on an area with no + * drop target + * @method onInvalidDrop + * @param {Event} e the mouseup event + */ + onInvalidDrop: function(e) { /* override this */ }, + + /** + * Code that executes immediately before the endDrag event + * @method b4EndDrag + * @private + */ + b4EndDrag: function(e) { }, + + /** + * Fired when we are done dragging the object + * @method endDrag + * @param {Event} e the mouseup event + */ + endDrag: function(e) { /* override this */ }, + + /** + * Code executed immediately before the onMouseDown event + * @method b4MouseDown + * @param {Event} e the mousedown event + * @private + */ + b4MouseDown: function(e) { }, + + /** + * Event handler that fires when a drag/drop obj gets a mousedown + * @method onMouseDown + * @param {Event} e the mousedown event + */ + onMouseDown: function(e) { /* override this */ }, + + /** + * Event handler that fires when a drag/drop obj gets a mouseup + * @method onMouseUp + * @param {Event} e the mouseup event + */ + onMouseUp: function(e) { /* override this */ }, + + /** + * Override the onAvailable method to do what is needed after the initial + * position was determined. + * @method onAvailable + */ + onAvailable: function () { + }, + + /** + * Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). + * @type Object + */ + defaultPadding: { + left: 0, + right: 0, + top: 0, + bottom: 0 + }, + + /** + * Initializes the drag drop object's constraints to restrict movement to a certain element. + * + * Usage: +
+ var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest", + { dragElId: "existingProxyDiv" }); + dd.startDrag = function(){ + this.constrainTo("parent-id"); + }; +
+ * Or you can initalize it using the {@link Ext.core.Element} object: +
+ Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, { + startDrag : function(){ + this.constrainTo("parent-id"); + } + }); +
+ * @param {Mixed} constrainTo The element to constrain to. + * @param {Object/Number} pad (optional) Pad provides a way to specify "padding" of the constraints, + * and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or + * an object containing the sides to pad. For example: {right:10, bottom:10} + * @param {Boolean} inContent (optional) Constrain the draggable in the content box of the element (inside padding and borders) + */ + constrainTo : function(constrainTo, pad, inContent){ + if(Ext.isNumber(pad)){ + pad = {left: pad, right:pad, top:pad, bottom:pad}; + } + pad = pad || this.defaultPadding; + var b = Ext.get(this.getEl()).getBox(), + ce = Ext.get(constrainTo), + s = ce.getScroll(), + c, + cd = ce.dom; + if(cd == document.body){ + c = { x: s.left, y: s.top, width: Ext.core.Element.getViewWidth(), height: Ext.core.Element.getViewHeight()}; + }else{ + var xy = ce.getXY(); + c = {x : xy[0], y: xy[1], width: cd.clientWidth, height: cd.clientHeight}; + } + + + var topSpace = b.y - c.y, + leftSpace = b.x - c.x; + + this.resetConstraints(); + this.setXConstraint(leftSpace - (pad.left||0), // left + c.width - leftSpace - b.width - (pad.right||0), //right + this.xTickSize + ); + this.setYConstraint(topSpace - (pad.top||0), //top + c.height - topSpace - b.height - (pad.bottom||0), //bottom + this.yTickSize + ); + }, + + /** + * Returns a reference to the linked element + * @method getEl + * @return {HTMLElement} the html element + */ + getEl: function() { + if (!this._domRef) { + this._domRef = Ext.getDom(this.id); + } + + return this._domRef; + }, + + /** + * Returns a reference to the actual element to drag. By default this is + * the same as the html element, but it can be assigned to another + * element. An example of this can be found in Ext.dd.DDProxy + * @method getDragEl + * @return {HTMLElement} the html element + */ + getDragEl: function() { + return Ext.getDom(this.dragElId); + }, + + /** + * Sets up the DragDrop object. Must be called in the constructor of any + * Ext.dd.DragDrop subclass + * @method init + * @param id the id of the linked element + * @param {String} sGroup the group of related items + * @param {object} config configuration attributes + */ + init: function(id, sGroup, config) { + this.initTarget(id, sGroup, config); + Ext.EventManager.on(this.id, "mousedown", this.handleMouseDown, this); + // Ext.EventManager.on(this.id, "selectstart", Event.preventDefault); + }, + + /** + * Initializes Targeting functionality only... the object does not + * get a mousedown handler. + * @method initTarget + * @param id the id of the linked element + * @param {String} sGroup the group of related items + * @param {object} config configuration attributes + */ + initTarget: function(id, sGroup, config) { + + // configuration attributes + this.config = config || {}; + + // create a local reference to the drag and drop manager + this.DDMInstance = Ext.dd.DragDropManager; + // initialize the groups array + this.groups = {}; + + // assume that we have an element reference instead of an id if the + // parameter is not a string + if (typeof id !== "string") { + id = Ext.id(id); + } + + // set the id + this.id = id; + + // add to an interaction group + this.addToGroup((sGroup) ? sGroup : "default"); + + // We don't want to register this as the handle with the manager + // so we just set the id rather than calling the setter. + this.handleElId = id; + + // the linked element is the element that gets dragged by default + this.setDragElId(id); + + // by default, clicked anchors will not start drag operations. + this.invalidHandleTypes = { A: "A" }; + this.invalidHandleIds = {}; + this.invalidHandleClasses = []; + + this.applyConfig(); + + this.handleOnAvailable(); + }, + + /** + * Applies the configuration parameters that were passed into the constructor. + * This is supposed to happen at each level through the inheritance chain. So + * a DDProxy implentation will execute apply config on DDProxy, DD, and + * DragDrop in order to get all of the parameters that are available in + * each object. + * @method applyConfig + */ + applyConfig: function() { + + // configurable properties: + // padding, isTarget, maintainOffset, primaryButtonOnly + this.padding = this.config.padding || [0, 0, 0, 0]; + this.isTarget = (this.config.isTarget !== false); + this.maintainOffset = (this.config.maintainOffset); + this.primaryButtonOnly = (this.config.primaryButtonOnly !== false); + + }, + + /** + * Executed when the linked element is available + * @method handleOnAvailable + * @private + */ + handleOnAvailable: function() { + this.available = true; + this.resetConstraints(); + this.onAvailable(); + }, + + /** + * Configures the padding for the target zone in px. Effectively expands + * (or reduces) the virtual object size for targeting calculations. + * Supports css-style shorthand; if only one parameter is passed, all sides + * will have that padding, and if only two are passed, the top and bottom + * will have the first param, the left and right the second. + * @method setPadding + * @param {int} iTop Top pad + * @param {int} iRight Right pad + * @param {int} iBot Bot pad + * @param {int} iLeft Left pad + */ + setPadding: function(iTop, iRight, iBot, iLeft) { + // this.padding = [iLeft, iRight, iTop, iBot]; + if (!iRight && 0 !== iRight) { + this.padding = [iTop, iTop, iTop, iTop]; + } else if (!iBot && 0 !== iBot) { + this.padding = [iTop, iRight, iTop, iRight]; + } else { + this.padding = [iTop, iRight, iBot, iLeft]; + } + }, + + /** + * Stores the initial placement of the linked element. + * @method setInitPosition + * @param {int} diffX the X offset, default 0 + * @param {int} diffY the Y offset, default 0 + */ + setInitPosition: function(diffX, diffY) { + var el = this.getEl(); + + if (!this.DDMInstance.verifyEl(el)) { + return; + } + + var dx = diffX || 0; + var dy = diffY || 0; + + var p = Ext.core.Element.getXY( el ); + + this.initPageX = p[0] - dx; + this.initPageY = p[1] - dy; + + this.lastPageX = p[0]; + this.lastPageY = p[1]; + + this.setStartPosition(p); + }, + + /** + * Sets the start position of the element. This is set when the obj + * is initialized, the reset when a drag is started. + * @method setStartPosition + * @param pos current position (from previous lookup) + * @private + */ + setStartPosition: function(pos) { + var p = pos || Ext.core.Element.getXY( this.getEl() ); + this.deltaSetXY = null; + + this.startPageX = p[0]; + this.startPageY = p[1]; + }, + + /** + * Add this instance to a group of related drag/drop objects. All + * instances belong to at least one group, and can belong to as many + * groups as needed. + * @method addToGroup + * @param sGroup {string} the name of the group + */ + addToGroup: function(sGroup) { + this.groups[sGroup] = true; + this.DDMInstance.regDragDrop(this, sGroup); + }, + + /** + * Remove's this instance from the supplied interaction group + * @method removeFromGroup + * @param {string} sGroup The group to drop + */ + removeFromGroup: function(sGroup) { + if (this.groups[sGroup]) { + delete this.groups[sGroup]; + } + + this.DDMInstance.removeDDFromGroup(this, sGroup); + }, + + /** + * Allows you to specify that an element other than the linked element + * will be moved with the cursor during a drag + * @method setDragElId + * @param id {string} the id of the element that will be used to initiate the drag + */ + setDragElId: function(id) { + this.dragElId = id; + }, + + /** + * Allows you to specify a child of the linked element that should be + * used to initiate the drag operation. An example of this would be if + * you have a content div with text and links. Clicking anywhere in the + * content area would normally start the drag operation. Use this method + * to specify that an element inside of the content div is the element + * that starts the drag operation. + * @method setHandleElId + * @param id {string} the id of the element that will be used to + * initiate the drag. + */ + setHandleElId: function(id) { + if (typeof id !== "string") { + id = Ext.id(id); + } + this.handleElId = id; + this.DDMInstance.regHandle(this.id, id); + }, + + /** + * Allows you to set an element outside of the linked element as a drag + * handle + * @method setOuterHandleElId + * @param id the id of the element that will be used to initiate the drag + */ + setOuterHandleElId: function(id) { + if (typeof id !== "string") { + id = Ext.id(id); + } + Ext.EventManager.on(id, "mousedown", this.handleMouseDown, this); + this.setHandleElId(id); + + this.hasOuterHandles = true; + }, + + /** + * Remove all drag and drop hooks for this element + * @method unreg + */ + unreg: function() { + Ext.EventManager.un(this.id, "mousedown", this.handleMouseDown, this); + this._domRef = null; + this.DDMInstance._remove(this); + }, + + destroy : function(){ + this.unreg(); + }, + + /** + * Returns true if this instance is locked, or the drag drop mgr is locked + * (meaning that all drag/drop is disabled on the page.) + * @method isLocked + * @return {boolean} true if this obj or all drag/drop is locked, else + * false + */ + isLocked: function() { + return (this.DDMInstance.isLocked() || this.locked); + }, + + /** + * Fired when this object is clicked + * @method handleMouseDown + * @param {Event} e + * @param {Ext.dd.DragDrop} oDD the clicked dd object (this dd obj) + * @private + */ + handleMouseDown: function(e, oDD){ + if (this.primaryButtonOnly && e.button != 0) { + return; + } + + if (this.isLocked()) { + return; + } + + this.DDMInstance.refreshCache(this.groups); + + var pt = e.getPoint(); + if (!this.hasOuterHandles && !this.DDMInstance.isOverTarget(pt, this) ) { + } else { + if (this.clickValidator(e)) { + // set the initial element position + this.setStartPosition(); + this.b4MouseDown(e); + this.onMouseDown(e); + + this.DDMInstance.handleMouseDown(e, this); + + this.DDMInstance.stopEvent(e); + } else { + + + } + } + }, + + clickValidator: function(e) { + var target = e.getTarget(); + return ( this.isValidHandleChild(target) && + (this.id == this.handleElId || + this.DDMInstance.handleWasClicked(target, this.id)) ); + }, + + /** + * Allows you to specify a tag name that should not start a drag operation + * when clicked. This is designed to facilitate embedding links within a + * drag handle that do something other than start the drag. + * @method addInvalidHandleType + * @param {string} tagName the type of element to exclude + */ + addInvalidHandleType: function(tagName) { + var type = tagName.toUpperCase(); + this.invalidHandleTypes[type] = type; + }, + + /** + * Lets you to specify an element id for a child of a drag handle + * that should not initiate a drag + * @method addInvalidHandleId + * @param {string} id the element id of the element you wish to ignore + */ + addInvalidHandleId: function(id) { + if (typeof id !== "string") { + id = Ext.id(id); + } + this.invalidHandleIds[id] = id; + }, + + /** + * Lets you specify a css class of elements that will not initiate a drag + * @method addInvalidHandleClass + * @param {string} cssClass the class of the elements you wish to ignore + */ + addInvalidHandleClass: function(cssClass) { + this.invalidHandleClasses.push(cssClass); + }, + + /** + * Unsets an excluded tag name set by addInvalidHandleType + * @method removeInvalidHandleType + * @param {string} tagName the type of element to unexclude + */ + removeInvalidHandleType: function(tagName) { + var type = tagName.toUpperCase(); + // this.invalidHandleTypes[type] = null; + delete this.invalidHandleTypes[type]; + }, + + /** + * Unsets an invalid handle id + * @method removeInvalidHandleId + * @param {string} id the id of the element to re-enable + */ + removeInvalidHandleId: function(id) { + if (typeof id !== "string") { + id = Ext.id(id); + } + delete this.invalidHandleIds[id]; + }, + + /** + * Unsets an invalid css class + * @method removeInvalidHandleClass + * @param {string} cssClass the class of the element(s) you wish to + * re-enable + */ + removeInvalidHandleClass: function(cssClass) { + for (var i=0, len=this.invalidHandleClasses.length; i= this.minX; i = i - iTickSize) { + if (!tickMap[i]) { + this.xTicks[this.xTicks.length] = i; + tickMap[i] = true; + } + } + + for (i = this.initPageX; i <= this.maxX; i = i + iTickSize) { + if (!tickMap[i]) { + this.xTicks[this.xTicks.length] = i; + tickMap[i] = true; + } + } + + Ext.Array.sort(this.xTicks, this.DDMInstance.numericSort); + }, + + /** + * Create the array of vertical tick marks if an interval was specified in + * setYConstraint(). + * @method setYTicks + * @private + */ + setYTicks: function(iStartY, iTickSize) { + this.yTicks = []; + this.yTickSize = iTickSize; + + var tickMap = {}; + + for (var i = this.initPageY; i >= this.minY; i = i - iTickSize) { + if (!tickMap[i]) { + this.yTicks[this.yTicks.length] = i; + tickMap[i] = true; + } + } + + for (i = this.initPageY; i <= this.maxY; i = i + iTickSize) { + if (!tickMap[i]) { + this.yTicks[this.yTicks.length] = i; + tickMap[i] = true; + } + } + + Ext.Array.sort(this.yTicks, this.DDMInstance.numericSort); + }, + + /** + * By default, the element can be dragged any place on the screen. Use + * this method to limit the horizontal travel of the element. Pass in + * 0,0 for the parameters if you want to lock the drag to the y axis. + * @method setXConstraint + * @param {int} iLeft the number of pixels the element can move to the left + * @param {int} iRight the number of pixels the element can move to the + * right + * @param {int} iTickSize optional parameter for specifying that the + * element + * should move iTickSize pixels at a time. + */ + setXConstraint: function(iLeft, iRight, iTickSize) { + this.leftConstraint = iLeft; + this.rightConstraint = iRight; + + this.minX = this.initPageX - iLeft; + this.maxX = this.initPageX + iRight; + if (iTickSize) { this.setXTicks(this.initPageX, iTickSize); } + + this.constrainX = true; + }, + + /** + * Clears any constraints applied to this instance. Also clears ticks + * since they can't exist independent of a constraint at this time. + * @method clearConstraints + */ + clearConstraints: function() { + this.constrainX = false; + this.constrainY = false; + this.clearTicks(); + }, + + /** + * Clears any tick interval defined for this instance + * @method clearTicks + */ + clearTicks: function() { + this.xTicks = null; + this.yTicks = null; + this.xTickSize = 0; + this.yTickSize = 0; + }, + + /** + * By default, the element can be dragged any place on the screen. Set + * this to limit the vertical travel of the element. Pass in 0,0 for the + * parameters if you want to lock the drag to the x axis. + * @method setYConstraint + * @param {int} iUp the number of pixels the element can move up + * @param {int} iDown the number of pixels the element can move down + * @param {int} iTickSize optional parameter for specifying that the + * element should move iTickSize pixels at a time. + */ + setYConstraint: function(iUp, iDown, iTickSize) { + this.topConstraint = iUp; + this.bottomConstraint = iDown; + + this.minY = this.initPageY - iUp; + this.maxY = this.initPageY + iDown; + if (iTickSize) { this.setYTicks(this.initPageY, iTickSize); } + + this.constrainY = true; + + }, + + /** + * resetConstraints must be called if you manually reposition a dd element. + * @method resetConstraints + * @param {boolean} maintainOffset + */ + resetConstraints: function() { + // Maintain offsets if necessary + if (this.initPageX || this.initPageX === 0) { + // figure out how much this thing has moved + var dx = (this.maintainOffset) ? this.lastPageX - this.initPageX : 0; + var dy = (this.maintainOffset) ? this.lastPageY - this.initPageY : 0; + + this.setInitPosition(dx, dy); + + // This is the first time we have detected the element's position + } else { + this.setInitPosition(); + } + + if (this.constrainX) { + this.setXConstraint( this.leftConstraint, + this.rightConstraint, + this.xTickSize ); + } + + if (this.constrainY) { + this.setYConstraint( this.topConstraint, + this.bottomConstraint, + this.yTickSize ); + } + }, + + /** + * Normally the drag element is moved pixel by pixel, but we can specify + * that it move a number of pixels at a time. This method resolves the + * location when we have it set up like this. + * @method getTick + * @param {int} val where we want to place the object + * @param {int[]} tickArray sorted array of valid points + * @return {int} the closest tick + * @private + */ + getTick: function(val, tickArray) { + if (!tickArray) { + // If tick interval is not defined, it is effectively 1 pixel, + // so we return the value passed to us. + return val; + } else if (tickArray[0] >= val) { + // The value is lower than the first tick, so we return the first + // tick. + return tickArray[0]; + } else { + for (var i=0, len=tickArray.length; i= val) { + var diff1 = val - tickArray[i]; + var diff2 = tickArray[next] - val; + return (diff2 > diff1) ? tickArray[i] : tickArray[next]; + } + } + + // The value is larger than the last tick, so we return the last + // tick. + return tickArray[tickArray.length - 1]; + } + }, + + /** + * toString method + * @method toString + * @return {string} string representation of the dd obj + */ + toString: function() { + return ("DragDrop " + this.id); + } + +}); +/* + * This is a derivative of the similarly named class in the YUI Library. + * The original license: + * Copyright (c) 2006, Yahoo! Inc. All rights reserved. + * Code licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + */ + + +/** + * @class Ext.dd.DD + * A DragDrop implementation where the linked element follows the + * mouse cursor during a drag. + * @extends Ext.dd.DragDrop + * @constructor + * @param {String} id the id of the linked element + * @param {String} sGroup the group of related DragDrop items + * @param {object} config an object containing configurable attributes + * Valid properties for DD: + * scroll + */ + +Ext.define('Ext.dd.DD', { + extend: 'Ext.dd.DragDrop', + requires: ['Ext.dd.DragDropManager'], + constructor: function(id, sGroup, config) { + if (id) { + this.init(id, sGroup, config); + } + }, + + /** + * When set to true, the utility automatically tries to scroll the browser + * window when a drag and drop element is dragged near the viewport boundary. + * Defaults to true. + * @property scroll + * @type boolean + */ + scroll: true, + + /** + * Sets the pointer offset to the distance between the linked element's top + * left corner and the location the element was clicked + * @method autoOffset + * @param {int} iPageX the X coordinate of the click + * @param {int} iPageY the Y coordinate of the click + */ + autoOffset: function(iPageX, iPageY) { + var x = iPageX - this.startPageX; + var y = iPageY - this.startPageY; + this.setDelta(x, y); + }, + + /** + * Sets the pointer offset. You can call this directly to force the + * offset to be in a particular location (e.g., pass in 0,0 to set it + * to the center of the object) + * @method setDelta + * @param {int} iDeltaX the distance from the left + * @param {int} iDeltaY the distance from the top + */ + setDelta: function(iDeltaX, iDeltaY) { + this.deltaX = iDeltaX; + this.deltaY = iDeltaY; + }, + + /** + * Sets the drag element to the location of the mousedown or click event, + * maintaining the cursor location relative to the location on the element + * that was clicked. Override this if you want to place the element in a + * location other than where the cursor is. + * @method setDragElPos + * @param {int} iPageX the X coordinate of the mousedown or drag event + * @param {int} iPageY the Y coordinate of the mousedown or drag event + */ + setDragElPos: function(iPageX, iPageY) { + // the first time we do this, we are going to check to make sure + // the element has css positioning + + var el = this.getDragEl(); + this.alignElWithMouse(el, iPageX, iPageY); + }, + + /** + * Sets the element to the location of the mousedown or click event, + * maintaining the cursor location relative to the location on the element + * that was clicked. Override this if you want to place the element in a + * location other than where the cursor is. + * @method alignElWithMouse + * @param {HTMLElement} el the element to move + * @param {int} iPageX the X coordinate of the mousedown or drag event + * @param {int} iPageY the Y coordinate of the mousedown or drag event + */ + alignElWithMouse: function(el, iPageX, iPageY) { + var oCoord = this.getTargetCoord(iPageX, iPageY), + fly = el.dom ? el : Ext.fly(el, '_dd'), + elSize = fly.getSize(), + EL = Ext.core.Element, + vpSize; + + if (!this.deltaSetXY) { + vpSize = this.cachedViewportSize = { width: EL.getDocumentWidth(), height: EL.getDocumentHeight() }; + var aCoord = [ + Math.max(0, Math.min(oCoord.x, vpSize.width - elSize.width)), + Math.max(0, Math.min(oCoord.y, vpSize.height - elSize.height)) + ]; + fly.setXY(aCoord); + var newLeft = fly.getLeft(true); + var newTop = fly.getTop(true); + this.deltaSetXY = [newLeft - oCoord.x, newTop - oCoord.y]; + } else { + vpSize = this.cachedViewportSize; + fly.setLeftTop( + Math.max(0, Math.min(oCoord.x + this.deltaSetXY[0], vpSize.width - elSize.width)), + Math.max(0, Math.min(oCoord.y + this.deltaSetXY[1], vpSize.height - elSize.height)) + ); + } + + this.cachePosition(oCoord.x, oCoord.y); + this.autoScroll(oCoord.x, oCoord.y, el.offsetHeight, el.offsetWidth); + return oCoord; + }, + + /** + * Saves the most recent position so that we can reset the constraints and + * tick marks on-demand. We need to know this so that we can calculate the + * number of pixels the element is offset from its original position. + * @method cachePosition + * @param iPageX the current x position (optional, this just makes it so we + * don't have to look it up again) + * @param iPageY the current y position (optional, this just makes it so we + * don't have to look it up again) + */ + cachePosition: function(iPageX, iPageY) { + if (iPageX) { + this.lastPageX = iPageX; + this.lastPageY = iPageY; + } else { + var aCoord = Ext.core.Element.getXY(this.getEl()); + this.lastPageX = aCoord[0]; + this.lastPageY = aCoord[1]; + } + }, + + /** + * Auto-scroll the window if the dragged object has been moved beyond the + * visible window boundary. + * @method autoScroll + * @param {int} x the drag element's x position + * @param {int} y the drag element's y position + * @param {int} h the height of the drag element + * @param {int} w the width of the drag element + * @private + */ + autoScroll: function(x, y, h, w) { + + if (this.scroll) { + // The client height + var clientH = Ext.core.Element.getViewHeight(); + + // The client width + var clientW = Ext.core.Element.getViewWidth(); + + // The amt scrolled down + var st = this.DDMInstance.getScrollTop(); + + // The amt scrolled right + var sl = this.DDMInstance.getScrollLeft(); + + // Location of the bottom of the element + var bot = h + y; + + // Location of the right of the element + var right = w + x; + + // The distance from the cursor to the bottom of the visible area, + // adjusted so that we don't scroll if the cursor is beyond the + // element drag constraints + var toBot = (clientH + st - y - this.deltaY); + + // The distance from the cursor to the right of the visible area + var toRight = (clientW + sl - x - this.deltaX); + + + // How close to the edge the cursor must be before we scroll + // var thresh = (document.all) ? 100 : 40; + var thresh = 40; + + // How many pixels to scroll per autoscroll op. This helps to reduce + // clunky scrolling. IE is more sensitive about this ... it needs this + // value to be higher. + var scrAmt = (document.all) ? 80 : 30; + + // Scroll down if we are near the bottom of the visible page and the + // obj extends below the crease + if ( bot > clientH && toBot < thresh ) { + window.scrollTo(sl, st + scrAmt); + } + + // Scroll up if the window is scrolled down and the top of the object + // goes above the top border + if ( y < st && st > 0 && y - st < thresh ) { + window.scrollTo(sl, st - scrAmt); + } + + // Scroll right if the obj is beyond the right border and the cursor is + // near the border. + if ( right > clientW && toRight < thresh ) { + window.scrollTo(sl + scrAmt, st); + } + + // Scroll left if the window has been scrolled to the right and the obj + // extends past the left border + if ( x < sl && sl > 0 && x - sl < thresh ) { + window.scrollTo(sl - scrAmt, st); + } + } + }, + + /** + * Finds the location the element should be placed if we want to move + * it to where the mouse location less the click offset would place us. + * @method getTargetCoord + * @param {int} iPageX the X coordinate of the click + * @param {int} iPageY the Y coordinate of the click + * @return an object that contains the coordinates (Object.x and Object.y) + * @private + */ + getTargetCoord: function(iPageX, iPageY) { + var x = iPageX - this.deltaX; + var y = iPageY - this.deltaY; + + if (this.constrainX) { + if (x < this.minX) { + x = this.minX; + } + if (x > this.maxX) { + x = this.maxX; + } + } + + if (this.constrainY) { + if (y < this.minY) { + y = this.minY; + } + if (y > this.maxY) { + y = this.maxY; + } + } + + x = this.getTick(x, this.xTicks); + y = this.getTick(y, this.yTicks); + + + return {x: x, y: y}; + }, + + /** + * Sets up config options specific to this class. Overrides + * Ext.dd.DragDrop, but all versions of this method through the + * inheritance chain are called + */ + applyConfig: function() { + this.callParent(); + this.scroll = (this.config.scroll !== false); + }, + + /** + * Event that fires prior to the onMouseDown event. Overrides + * Ext.dd.DragDrop. + */ + b4MouseDown: function(e) { + // this.resetConstraints(); + this.autoOffset(e.getPageX(), e.getPageY()); + }, + + /** + * Event that fires prior to the onDrag event. Overrides + * Ext.dd.DragDrop. + */ + b4Drag: function(e) { + this.setDragElPos(e.getPageX(), e.getPageY()); + }, + + toString: function() { + return ("DD " + this.id); + } + + ////////////////////////////////////////////////////////////////////////// + // Debugging ygDragDrop events that can be overridden + ////////////////////////////////////////////////////////////////////////// + /* + startDrag: function(x, y) { + }, + + onDrag: function(e) { + }, + + onDragEnter: function(e, id) { + }, + + onDragOver: function(e, id) { + }, + + onDragOut: function(e, id) { + }, + + onDragDrop: function(e, id) { + }, + + endDrag: function(e) { + } + + */ + +}); + +/* + * This is a derivative of the similarly named class in the YUI Library. + * The original license: + * Copyright (c) 2006, Yahoo! Inc. All rights reserved. + * Code licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + */ + +/** + * @class Ext.dd.DDProxy + * A DragDrop implementation that inserts an empty, bordered div into + * the document that follows the cursor during drag operations. At the time of + * the click, the frame div is resized to the dimensions of the linked html + * element, and moved to the exact location of the linked element. + * + * References to the "frame" element refer to the single proxy element that + * was created to be dragged in place of all DDProxy elements on the + * page. + * + * @extends Ext.dd.DD + * @constructor + * @param {String} id the id of the linked html element + * @param {String} sGroup the group of related DragDrop objects + * @param {object} config an object containing configurable attributes + * Valid properties for DDProxy in addition to those in DragDrop: + * resizeFrame, centerFrame, dragElId + */ +Ext.define('Ext.dd.DDProxy', { + extend: 'Ext.dd.DD', + + statics: { + /** + * The default drag frame div id + * @property Ext.dd.DDProxy.dragElId + * @type String + * @static + */ + dragElId: "ygddfdiv" + }, + + constructor: function(id, sGroup, config) { + if (id) { + this.init(id, sGroup, config); + this.initFrame(); + } + }, + + /** + * By default we resize the drag frame to be the same size as the element + * we want to drag (this is to get the frame effect). We can turn it off + * if we want a different behavior. + * @property resizeFrame + * @type boolean + */ + resizeFrame: true, + + /** + * By default the frame is positioned exactly where the drag element is, so + * we use the cursor offset provided by Ext.dd.DD. Another option that works only if + * you do not have constraints on the obj is to have the drag frame centered + * around the cursor. Set centerFrame to true for this effect. + * @property centerFrame + * @type boolean + */ + centerFrame: false, + + /** + * Creates the proxy element if it does not yet exist + * @method createFrame + */ + createFrame: function() { + var self = this; + var body = document.body; + + if (!body || !body.firstChild) { + setTimeout( function() { self.createFrame(); }, 50 ); + return; + } + + var div = this.getDragEl(); + + if (!div) { + div = document.createElement("div"); + div.id = this.dragElId; + var s = div.style; + + s.position = "absolute"; + s.visibility = "hidden"; + s.cursor = "move"; + s.border = "2px solid #aaa"; + s.zIndex = 999; + + // appendChild can blow up IE if invoked prior to the window load event + // while rendering a table. It is possible there are other scenarios + // that would cause this to happen as well. + body.insertBefore(div, body.firstChild); + } + }, + + /** + * Initialization for the drag frame element. Must be called in the + * constructor of all subclasses + * @method initFrame + */ + initFrame: function() { + this.createFrame(); + }, + + applyConfig: function() { + this.callParent(); + + this.resizeFrame = (this.config.resizeFrame !== false); + this.centerFrame = (this.config.centerFrame); + this.setDragElId(this.config.dragElId || Ext.dd.DDProxy.dragElId); + }, + + /** + * Resizes the drag frame to the dimensions of the clicked object, positions + * it over the object, and finally displays it + * @method showFrame + * @param {int} iPageX X click position + * @param {int} iPageY Y click position + * @private + */ + showFrame: function(iPageX, iPageY) { + var el = this.getEl(); + var dragEl = this.getDragEl(); + var s = dragEl.style; + + this._resizeProxy(); + + if (this.centerFrame) { + this.setDelta( Math.round(parseInt(s.width, 10)/2), + Math.round(parseInt(s.height, 10)/2) ); + } + + this.setDragElPos(iPageX, iPageY); + + Ext.fly(dragEl).show(); + }, + + /** + * The proxy is automatically resized to the dimensions of the linked + * element when a drag is initiated, unless resizeFrame is set to false + * @method _resizeProxy + * @private + */ + _resizeProxy: function() { + if (this.resizeFrame) { + var el = this.getEl(); + Ext.fly(this.getDragEl()).setSize(el.offsetWidth, el.offsetHeight); + } + }, + + // overrides Ext.dd.DragDrop + b4MouseDown: function(e) { + var x = e.getPageX(); + var y = e.getPageY(); + this.autoOffset(x, y); + this.setDragElPos(x, y); + }, + + // overrides Ext.dd.DragDrop + b4StartDrag: function(x, y) { + // show the drag frame + this.showFrame(x, y); + }, + + // overrides Ext.dd.DragDrop + b4EndDrag: function(e) { + Ext.fly(this.getDragEl()).hide(); + }, + + // overrides Ext.dd.DragDrop + // By default we try to move the element to the last location of the frame. + // This is so that the default behavior mirrors that of Ext.dd.DD. + endDrag: function(e) { + + var lel = this.getEl(); + var del = this.getDragEl(); + + // Show the drag frame briefly so we can get its position + del.style.visibility = ""; + + this.beforeMove(); + // Hide the linked element before the move to get around a Safari + // rendering bug. + lel.style.visibility = "hidden"; + Ext.dd.DDM.moveToEl(lel, del); + del.style.visibility = "hidden"; + lel.style.visibility = ""; + + this.afterDrag(); + }, + + beforeMove : function(){ + + }, + + afterDrag : function(){ + + }, + + toString: function() { + return ("DDProxy " + this.id); + } + +}); + +/** + * @class Ext.dd.DragSource + * @extends Ext.dd.DDProxy + * A simple class that provides the basic implementation needed to make any element draggable. + * @constructor + * @param {Mixed} el The container element + * @param {Object} config + */ +Ext.define('Ext.dd.DragSource', { + extend: 'Ext.dd.DDProxy', + requires: [ + 'Ext.dd.StatusProxy', + 'Ext.dd.DragDropManager' + ], + + /** + * @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 undefined). + */ + + /** + * @cfg {String} dropAllowed + * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). + */ + + dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok', + /** + * @cfg {String} dropNotAllowed + * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). + */ + dropNotAllowed : Ext.baseCSSPrefix + 'dd-drop-nodrop', + + /** + * @cfg {Boolean} animRepair + * Defaults to true. If true, animates the proxy element back to the position of the handle element used to trigger the drag. + */ + animRepair: true, + + /** + * @cfg {String} repairHighlightColor The color to use when visually highlighting the drag source in the afterRepair + * method after a failed drop (defaults to 'c3daf9' - light blue). The color must be a 6 digit hex value, without + * a preceding '#'. + */ + repairHighlightColor: 'c3daf9', + + constructor: function(el, config) { + this.el = Ext.get(el); + if(!this.dragData){ + this.dragData = {}; + } + + Ext.apply(this, config); + + if(!this.proxy){ + this.proxy = Ext.create('Ext.dd.StatusProxy', { + animRepair: this.animRepair + }); + } + this.callParent([this.el.dom, this.ddGroup || this.group, + {dragElId : this.proxy.id, resizeFrame: false, isTarget: false, scroll: this.scroll === true}]); + + this.dragging = false; + }, + + /** + * Returns the data object associated with this drag source + * @return {Object} data An object containing arbitrary data + */ + getDragData : function(e){ + return this.dragData; + }, + + // private + onDragEnter : function(e, id){ + var target = Ext.dd.DragDropManager.getDDById(id); + this.cachedTarget = target; + if (this.beforeDragEnter(target, e, id) !== false) { + if (target.isNotifyTarget) { + var status = target.notifyEnter(this, e, this.dragData); + this.proxy.setStatus(status); + } else { + this.proxy.setStatus(this.dropAllowed); + } + + if (this.afterDragEnter) { + /** + * An empty function by default, but provided so that you can perform a custom action + * when the dragged item enters the drop target by providing an implementation. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @method afterDragEnter + */ + this.afterDragEnter(target, e, id); + } + } + }, + + /** + * An empty function by default, but provided so that you can perform a custom action + * before the dragged item enters the drop target and optionally cancel the onDragEnter. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + beforeDragEnter: function(target, e, id) { + return true; + }, + + // private + alignElWithMouse: function() { + this.callParent(arguments); + this.proxy.sync(); + }, + + // private + onDragOver: function(e, id) { + var target = this.cachedTarget || Ext.dd.DragDropManager.getDDById(id); + if (this.beforeDragOver(target, e, id) !== false) { + if(target.isNotifyTarget){ + var status = target.notifyOver(this, e, this.dragData); + this.proxy.setStatus(status); + } + + if (this.afterDragOver) { + /** + * An empty function by default, but provided so that you can perform a custom action + * while the dragged item is over the drop target by providing an implementation. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @method afterDragOver + */ + this.afterDragOver(target, e, id); + } + } + }, + + /** + * An empty function by default, but provided so that you can perform a custom action + * while the dragged item is over the drop target and optionally cancel the onDragOver. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + beforeDragOver: function(target, e, id) { + return true; + }, + + // private + onDragOut: function(e, id) { + var target = this.cachedTarget || Ext.dd.DragDropManager.getDDById(id); + if (this.beforeDragOut(target, e, id) !== false) { + if (target.isNotifyTarget) { + target.notifyOut(this, e, this.dragData); + } + this.proxy.reset(); + if (this.afterDragOut) { + /** + * An empty function by default, but provided so that you can perform a custom action + * after the dragged item is dragged out of the target without dropping. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @method afterDragOut + */ + this.afterDragOut(target, e, id); + } + } + this.cachedTarget = null; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action before the dragged + * item is dragged out of the target without dropping, and optionally cancel the onDragOut. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + beforeDragOut: function(target, e, id){ + return true; + }, + + // private + onDragDrop: function(e, id){ + var target = this.cachedTarget || Ext.dd.DragDropManager.getDDById(id); + if (this.beforeDragDrop(target, e, id) !== false) { + if (target.isNotifyTarget) { + if (target.notifyDrop(this, e, this.dragData) !== false) { // valid drop? + this.onValidDrop(target, e, id); + } else { + this.onInvalidDrop(target, e, id); + } + } else { + this.onValidDrop(target, e, id); + } + + if (this.afterDragDrop) { + /** + * An empty function by default, but provided so that you can perform a custom action + * after a valid drag drop has occurred by providing an implementation. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dropped element + * @method afterDragDrop + */ + this.afterDragDrop(target, e, id); + } + } + delete this.cachedTarget; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action before the dragged + * item is dropped onto the target and optionally cancel the onDragDrop. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag drop event is valid, else false to cancel + */ + beforeDragDrop: function(target, e, id){ + return true; + }, + + // private + onValidDrop: function(target, e, id){ + this.hideProxy(); + if(this.afterValidDrop){ + /** + * An empty function by default, but provided so that you can perform a custom action + * after a valid drop has occurred by providing an implementation. + * @param {Object} target The target DD + * @param {Event} e The event object + * @param {String} id The id of the dropped element + * @method afterInvalidDrop + */ + this.afterValidDrop(target, e, id); + } + }, + + // private + getRepairXY: function(e, data){ + return this.el.getXY(); + }, + + // private + onInvalidDrop: function(target, e, id) { + this.beforeInvalidDrop(target, e, id); + if (this.cachedTarget) { + if(this.cachedTarget.isNotifyTarget){ + this.cachedTarget.notifyOut(this, e, this.dragData); + } + this.cacheTarget = null; + } + this.proxy.repair(this.getRepairXY(e, this.dragData), this.afterRepair, this); + + if (this.afterInvalidDrop) { + /** + * An empty function by default, but provided so that you can perform a custom action + * after an invalid drop has occurred by providing an implementation. + * @param {Event} e The event object + * @param {String} id The id of the dropped element + * @method afterInvalidDrop + */ + this.afterInvalidDrop(e, id); + } + }, + + // private + afterRepair: function() { + var me = this; + if (Ext.enableFx) { + me.el.highlight(me.repairHighlightColor); + } + me.dragging = false; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action after an invalid + * drop has occurred. + * @param {Ext.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the invalid drop should proceed, else false to cancel + */ + beforeInvalidDrop: function(target, e, id) { + return true; + }, + + // private + handleMouseDown: function(e) { + if (this.dragging) { + return; + } + var data = this.getDragData(e); + if (data && this.onBeforeDrag(data, e) !== false) { + this.dragData = data; + this.proxy.stop(); + this.callParent(arguments); + } + }, + + /** + * An empty function by default, but provided so that you can perform a custom action before the initial + * drag event begins and optionally cancel it. + * @param {Object} data An object containing arbitrary data to be shared with drop targets + * @param {Event} e The event object + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + onBeforeDrag: function(data, e){ + return true; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action once the initial + * drag event has begun. The drag cannot be canceled from this function. + * @param {Number} x The x position of the click on the dragged object + * @param {Number} y The y position of the click on the dragged object + * @method + */ + onStartDrag: Ext.emptyFn, + + // private override + startDrag: function(x, y) { + this.proxy.reset(); + this.dragging = true; + this.proxy.update(""); + this.onInitDrag(x, y); + this.proxy.show(); + }, + + // private + onInitDrag: function(x, y) { + var clone = this.el.dom.cloneNode(true); + clone.id = Ext.id(); // prevent duplicate ids + this.proxy.update(clone); + this.onStartDrag(x, y); + return true; + }, + + /** + * Returns the drag source's underlying {@link Ext.dd.StatusProxy} + * @return {Ext.dd.StatusProxy} proxy The StatusProxy + */ + getProxy: function() { + return this.proxy; + }, + + /** + * Hides the drag source's {@link Ext.dd.StatusProxy} + */ + hideProxy: function() { + this.proxy.hide(); + this.proxy.reset(true); + this.dragging = false; + }, + + // private + triggerCacheRefresh: function() { + Ext.dd.DDM.refreshCache(this.groups); + }, + + // private - override to prevent hiding + b4EndDrag: function(e) { + }, + + // private - override to prevent moving + endDrag : function(e){ + this.onEndDrag(this.dragData, e); + }, + + // private + onEndDrag : function(data, e){ + }, + + // private - pin to cursor + autoOffset : function(x, y) { + this.setDelta(-12, -20); + }, + + destroy: function(){ + this.callParent(); + Ext.destroy(this.proxy); + } +}); + +// private - DD implementation for Panels +Ext.define('Ext.panel.DD', { + extend: 'Ext.dd.DragSource', + requires: ['Ext.panel.Proxy'], + + constructor : function(panel, cfg){ + this.panel = panel; + this.dragData = {panel: panel}; + this.proxy = Ext.create('Ext.panel.Proxy', panel, cfg); + + this.callParent([panel.el, cfg]); + + Ext.defer(function() { + var header = panel.header, + el = panel.body; + + if(header){ + this.setHandleElId(header.id); + el = header.el; + } + el.setStyle('cursor', 'move'); + this.scroll = false; + }, 200, this); + }, + + showFrame: Ext.emptyFn, + startDrag: Ext.emptyFn, + b4StartDrag: function(x, y) { + this.proxy.show(); + }, + b4MouseDown: function(e) { + var x = e.getPageX(), + 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.el.dom; + }, + endDrag : function(e){ + this.proxy.hide(); + this.panel.saveState(); + }, + + autoOffset : function(x, y) { + x -= this.startPageX; + y -= this.startPageY; + this.setDelta(x, y); + } +}); + +/** + * @class Ext.layout.component.Dock + * @extends Ext.layout.component.AbstractDock + * @private + */ +Ext.define('Ext.layout.component.Dock', { + + /* Begin Definitions */ + + alias: ['layout.dock'], + + extend: 'Ext.layout.component.AbstractDock' + + /* End Definitions */ + +}); +/** + * @class Ext.panel.Panel + * @extends Ext.panel.AbstractPanel + *
Panel is a container that has specific functionality and structural components that make + * it the perfect building block for application-oriented user interfaces.
+ *
Panels are, by virtue of their inheritance from {@link Ext.container.Container}, capable + * of being configured with a {@link Ext.container.Container#layout layout}, and containing child Components.
+ *
When either specifying child {@link Ext.Component#items items} of a Panel, or dynamically {@link Ext.container.Container#add adding} Components + * to a Panel, remember to consider how you wish the Panel to arrange those child elements, and whether + * those child elements need to be sized using one of Ext's built-in {@link Ext.container.Container#layout layout} schemes. By + * default, Panels use the {@link Ext.layout.container.Auto Auto} scheme. This simply renders + * child components, appending them one after the other inside the Container, and does not apply any sizing + * at all.
+ * {@img Ext.panel.Panel/panel.png Panel components} + *
A Panel may also contain {@link #bbar bottom} and {@link #tbar top} toolbars, along with separate + * {@link #header}, {@link #footer} and {@link #body} sections (see {@link #frame} for additional + * information).
+ *
Panel also provides built-in {@link #collapsible collapsible, expandable} and {@link #closable} behavior. + * Panels can be easily dropped into any {@link Ext.container.Container Container} or layout, and the + * layout and rendering pipeline is {@link Ext.container.Container#add completely managed by the framework}.
+ *
Note: By default, the {@link #closable close} header tool destroys the Panel resulting in removal of the Panel + * and the destruction of any descendant Components. This makes the Panel object, and all its descendants unusable. To enable the close + * tool to simply hide a Panel for later re-use, configure the Panel with {@link #closeAction closeAction: 'hide'}.
+ *
Usually, Panels are used as constituents within an application, in which case, they would be used as child items of Containers, + * and would themselves use Ext.Components as child {@link #items}. However to illustrate simply rendering a Panel into the document, + * here's how to do it:
+Ext.create('Ext.panel.Panel', { + title: 'Hello', + width: 200, + html: '<p>World!</p>', + renderTo: document.body +}); +
+ *
A more realistic scenario is a Panel created to house input fields which will not be rendered, but used as a constituent part of a Container:
+var filterPanel = Ext.create('Ext.panel.Panel', { + bodyPadding: 5, // Don't want content to crunch against the borders + title: 'Filters', + items: [{ + xtype: 'datefield', + fieldLabel: 'Start date' + }, { + xtype: 'datefield', + fieldLabel: 'End date' + }] +}); +
+ *
Note that the Panel above is not configured to render into the document, nor is it configured with a size or position. In a real world scenario, + * the Container into which the Panel is added will use a {@link #layout} to render, size and position its child Components.
+ *
Panels will often use specific {@link #layout}s to provide an application with shape and structure by containing and arranging child + * Components:
+var resultsPanel = Ext.create('Ext.panel.Panel', { + title: 'Results', + width: 600, + height: 400, + renderTo: document.body, + layout: { + type: 'vbox', // Arrange child items vertically + align: 'stretch', // Each takes up full width + padding: 5 + }, + items: [{ // Results grid specified as a config object with an xtype of 'grid' + xtype: 'grid', + columns: [{header: 'Column One'}], // One header just for show. There's no data, + store: Ext.create('Ext.data.ArrayStore', {}), // A dummy empty data store + flex: 1 // Use 1/3 of Container's height (hint to Box layout) + }, { + xtype: 'splitter' // A splitter between the two child items + }, { // Details Panel specified as a config object (no xtype defaults to 'panel'). + title: 'Details', + bodyPadding: 5, + items: [{ + fieldLabel: 'Data item', + xtype: 'textfield' + }], // An array of form fields + flex: 2 // Use 2/3 of Container's height (hint to Box layout) + }] +}); +
+ * The example illustrates one possible method of displaying search results. The Panel contains a grid with the resulting data arranged + * in rows. Each selected row may be displayed in detail in the Panel below. The {@link Ext.layout.container.VBox vbox} layout is used + * to arrange the two vertically. It is configured to stretch child items horizontally to full width. Child items may either be configured + * with a numeric height, or with a flex value to distribute available space proportionately.
+ *
This Panel itself may be a child item of, for exaple, a {@link Ext.tab.Panel} which will size its child items to fit within its + * content area.
+ *
Using these techniques, as long as the layout is chosen and configured correctly, an application may have any level of + * nested containment, all dynamically sized according to configuration, the user's preference and available browser size.
+ * @constructor + * @param {Object} config The config object + * @xtype panel + */ +Ext.define('Ext.panel.Panel', { + extend: 'Ext.panel.AbstractPanel', + requires: [ + 'Ext.panel.Header', + 'Ext.fx.Anim', + 'Ext.util.KeyMap', + 'Ext.panel.DD', + 'Ext.XTemplate', + 'Ext.layout.component.Dock' + ], + alias: 'widget.panel', + alternateClassName: 'Ext.Panel', + + /** + * @cfg {String} collapsedCls + * A CSS class to add to the panel's element after it has been collapsed (defaults to + * 'collapsed'). + */ + collapsedCls: 'collapsed', + + /** + * @cfg {Boolean} animCollapse + * true to animate the transition when the panel is collapsed, false to skip the + * animation (defaults to true if the {@link Ext.fx.Anim} class is available, otherwise false). + * May also be specified as the animation duration in milliseconds. + */ + animCollapse: Ext.enableFx, + + /** + * @cfg {Number} minButtonWidth + * Minimum width of all footer toolbar buttons in pixels (defaults to 75). If set, this will + * be used as the default value for the {@link Ext.button.Button#minWidth} config of + * each Button added to the footer toolbar via the {@link #fbar} or {@link #buttons} configurations. + * It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config + * object or via the {@link Ext.container.Container#config-defaults defaults} of their parent container. + */ + minButtonWidth: 75, + + /** + * @cfg {Boolean} collapsed + * true to render the panel collapsed, false to render it expanded (defaults to + * false). + */ + collapsed: false, + + /** + * @cfg {Boolean} collapseFirst + * true to make sure the collapse/expand toggle button always renders first (to the left of) + * any other tools in the panel's title bar, false to render it last (defaults to true). + */ + collapseFirst: true, + + /** + * @cfg {Boolean} hideCollapseTool + * true to hide the expand/collapse toggle button when {@link #collapsible} == true, + * false to display it (defaults to false). + */ + hideCollapseTool: false, + + /** + * @cfg {Boolean} titleCollapse + * true to allow expanding and collapsing the panel (when {@link #collapsible} = true) + * by clicking anywhere in the header bar, false) to allow it only by clicking to tool button + * (defaults to false)). + */ + titleCollapse: false, + + /** + * @cfg {String} collapseMode + *
Important: this config is only effective for {@link #collapsible} Panels which are direct child items of a {@link Ext.layout.container.Border border layout}.
+ *
When not a direct child item of a {@link Ext.layout.container.Border border layout}, then the Panel's header remains visible, and the body is collapsed to zero dimensions. + * If the Panel has no header, then a new header (orientated correctly depending on the {@link #collapseDirection}) will be inserted to show a the title and a re-expand tool.
+ *
When a child item of a {@link Ext.layout.container.Border border layout}, this config has two options: + *
+ *
undefined/omitted
When collapsed, a placeholder {@link Ext.panel.Header Header} is injected into the layout to represent the Panel + * and to provide a UI with a Tool to allow the user to re-expand the Panel.
+ *
header :
The Panel collapses to leave its header visible as when not inside a {@link Ext.layout.container.Border border layout}.
+ *
+ */ + + /** + * @cfg {Mixed} placeholder + *
Important: This config is only effective for {@link #collapsible} Panels which are direct child items of a {@link Ext.layout.container.Border border layout} + * when not using the 'header' {@link #collapseMode}.
+ *
Optional. A Component (or config object for a Component) to show in place of this Panel when this Panel is collapsed by a + * {@link Ext.layout.container.Border border layout}. Defaults to a generated {@link Ext.panel.Header Header} + * containing a {@link Ext.panel.Tool Tool} to re-expand the Panel.
+ */ + + /** + * @cfg {Boolean} floatable + *
Important: This config is only effective for {@link #collapsible} Panels which are direct child items of a {@link Ext.layout.container.Border border layout}.
+ * true to allow clicking a collapsed Panel's {@link #placeholder} to display the Panel floated + * above the layout, false to force the user to fully expand a collapsed region by + * clicking the expand button to see it again (defaults to true). + */ + floatable: true, + + /** + * @cfg {Mixed} overlapHeader + * True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and is done automatically for you). Otherwise it is undefined. + * If you manually add rounded corners to a panel header which does not have frame:true, this will need to be set to true. + */ + + /** + * @cfg {Boolean} collapsible + *
True to make the panel collapsible and have an expand/collapse toggle Tool added into + * the header tool button area. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool (defaults to false).
+ * See {@link #collapseMode} and {@link #collapseDirection} + */ + collapsible: false, + + /** + * @cfg {Boolean} collapseDirection + *
The direction to collapse the Panel when the toggle button is clicked.
+ *
Defaults to the {@link #headerPosition}
+ *
Important: This config is ignored for {@link #collapsible} Panels which are direct child items of a {@link Ext.layout.container.Border border layout}.
+ *
Specify as 'top', 'bottom', 'left' or 'right'.
+ */ + + /** + * @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 false).
+ *
By default, when close is requested by clicking the close button in the header, the {@link #close} + * method will be called. This will {@link Ext.Component#destroy destroy} the Panel and its content + * meaning that it may not be reused.
+ *
To make closing a Panel hide the Panel so that it may be reused, set + * {@link #closeAction} to 'hide'.
+ */ + closable: false, + + /** + * @cfg {String} closeAction + *
The action to take when the close header tool is clicked: + *
+ *
'{@link #destroy}' : Default
+ * {@link #destroy 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 behavior has changed! setting *does* affect the {@link #close} method + * which will invoke the approriate closeAction. + */ + closeAction: 'destroy', + + /** + * @cfg {Object/Array} dockedItems + * A component or series of components to be added as docked items to this panel. + * The docked items can be docked to either the top, right, left or bottom of a panel. + * This is typically used for things like toolbars or tab bars: + *
+var panel = new Ext.panel.Panel({ + dockedItems: [{ + xtype: 'toolbar', + dock: 'top', + items: [{ + text: 'Docked to the top' + }] + }] +});
+ */ + + /** + * @cfg {Boolean} preventHeader Prevent a Header from being created and shown. Defaults to false. + */ + preventHeader: false, + + /** + * @cfg {String} headerPosition Specify as 'top', 'bottom', 'left' or 'right'. Defaults to 'top'. + */ + headerPosition: 'top', + + /** + * @cfg {Boolean} frame + * True to apply a frame to the panel. + */ + frame: false, + + /** + * @cfg {Boolean} frameHeader + * True to apply a frame to the panel panels header (if 'frame' is true). + */ + frameHeader: true, + + /** + * @cfg {Array} tools + * An array of {@link Ext.panel.Tool} configs/instances to be added to the header tool area. The tools are stored as child + * components of the header container. They can be accessed using {@link #down} and {#query}, as well as the other + * component methods. The toggle tool is automatically created if {@link #collapsible} is set to true. + *
Note that, apart from the toggle tool which is provided when a panel is collapsible, these + * tools only provide the visual button. Any required functionality must be provided by adding + * handlers that implement the necessary behavior.
+ *
Example usage:
+ *
+tools:[{ + type:'refresh', + qtip: 'Refresh form Data', + // hidden:true, + handler: function(event, toolEl, panel){ + // refresh logic + } +}, +{ + type:'help', + qtip: 'Get Help', + handler: function(event, toolEl, panel){ + // show help here + } +}] +
+ */ + + + initComponent: function() { + var me = this, + cls; + + me.addEvents( + /** + * @event titlechange + * Fires after the Panel title has been set or changed. + * @param {Ext.panel.Panel} p the Panel which has been resized. + * @param {String} newTitle The new title. + * @param {String} oldTitle The previous panel title. + */ + 'titlechange', + /** + * @event iconchange + * Fires after the Panel iconCls has been set or changed. + * @param {Ext.panel.Panel} p the Panel which has been resized. + * @param {String} newIconCls The new iconCls. + * @param {String} oldIconCls The previous panel iconCls. + */ + 'iconchange' + ); + + if (me.unstyled) { + me.setUI('plain'); + } + + if (me.frame) { + me.setUI('default-framed'); + } + + me.callParent(); + + me.collapseDirection = me.collapseDirection || me.headerPosition || Ext.Component.DIRECTION_TOP; + + // Backwards compatibility + me.bridgeToolbars(); + }, + + setBorder: function(border) { + // var me = this, + // method = (border === false || border === 0) ? 'addClsWithUI' : 'removeClsWithUI'; + // + // me.callParent(arguments); + // + // if (me.collapsed) { + // me[method](me.collapsedCls + '-noborder'); + // } + // + // if (me.header) { + // me.header.setBorder(border); + // if (me.collapsed) { + // me.header[method](me.collapsedCls + '-noborder'); + // } + // } + + this.callParent(arguments); + }, + + beforeDestroy: function() { + Ext.destroy( + this.ghostPanel, + this.dd + ); + this.callParent(); + }, + + initAria: function() { + this.callParent(); + this.initHeaderAria(); + }, + + initHeaderAria: function() { + var me = this, + el = me.el, + header = me.header; + if (el && header) { + el.dom.setAttribute('aria-labelledby', header.titleCmp.id); + } + }, + + getHeader: function() { + return this.header; + }, + + /** + * Set a title for the panel's header. See {@link Ext.panel.Header#title}. + * @param {String} newTitle + */ + setTitle: function(newTitle) { + var me = this, + oldTitle = this.title; + + me.title = newTitle; + if (me.header) { + me.header.setTitle(newTitle); + } else { + me.updateHeader(); + } + + if (me.reExpander) { + me.reExpander.setTitle(newTitle); + } + me.fireEvent('titlechange', me, newTitle, oldTitle); + }, + + /** + * Set the iconCls for the panel's header. See {@link Ext.panel.Header#iconCls}. + * @param {String} newIconCls + */ + setIconCls: function(newIconCls) { + var me = this, + oldIconCls = me.iconCls; + + me.iconCls = newIconCls; + var header = me.header; + if (header) { + header.setIconCls(newIconCls); + } + me.fireEvent('iconchange', me, newIconCls, oldIconCls); + }, + + bridgeToolbars: function() { + var me = this, + fbar, + fbarDefaults, + minButtonWidth = me.minButtonWidth; + + function initToolbar (toolbar, pos) { + if (Ext.isArray(toolbar)) { + toolbar = { + xtype: 'toolbar', + items: toolbar + }; + } + else if (!toolbar.xtype) { + toolbar.xtype = 'toolbar'; + } + toolbar.dock = pos; + if (pos == 'left' || pos == 'right') { + toolbar.vertical = true; + } + return toolbar; + } + + // Backwards compatibility + + /** + * @cfg {Object/Array} tbar + +Convenience method. Short for 'Top Bar'. + + tbar: [ + { xtype: 'button', text: 'Button 1' } + ] + +is equivalent to + + dockedItems: [{ + xtype: 'toolbar', + dock: 'top', + items: [ + { xtype: 'button', text: 'Button 1' } + ] + }] + + * @markdown + */ + if (me.tbar) { + me.addDocked(initToolbar(me.tbar, 'top')); + me.tbar = null; + } + + /** + * @cfg {Object/Array} bbar + +Convenience method. Short for 'Bottom Bar'. + + bbar: [ + { xtype: 'button', text: 'Button 1' } + ] + +is equivalent to + + dockedItems: [{ + xtype: 'toolbar', + dock: 'bottom', + items: [ + { xtype: 'button', text: 'Button 1' } + ] + }] + + * @markdown + */ + if (me.bbar) { + me.addDocked(initToolbar(me.bbar, 'bottom')); + me.bbar = null; + } + + /** + * @cfg {Object/Array} buttons + +Convenience method used for adding buttons docked to the bottom right of the panel. This is a +synonym for the {@link #fbar} config. + + buttons: [ + { text: 'Button 1' } + ] + +is equivalent to + + dockedItems: [{ + xtype: 'toolbar', + dock: 'bottom', + defaults: {minWidth: {@link #minButtonWidth}}, + items: [ + { xtype: 'component', flex: 1 }, + { xtype: 'button', text: 'Button 1' } + ] + }] + +The {@link #minButtonWidth} is used as the default {@link Ext.button.Button#minWidth minWidth} for +each of the buttons in the buttons toolbar. + + * @markdown + */ + if (me.buttons) { + me.fbar = me.buttons; + me.buttons = null; + } + + /** + * @cfg {Object/Array} fbar + +Convenience method used for adding items to the bottom right of the panel. Short for Footer Bar. + + fbar: [ + { type: 'button', text: 'Button 1' } + ] + +is equivalent to + + dockedItems: [{ + xtype: 'toolbar', + dock: 'bottom', + defaults: {minWidth: {@link #minButtonWidth}}, + items: [ + { xtype: 'component', flex: 1 }, + { xtype: 'button', text: 'Button 1' } + ] + }] + +The {@link #minButtonWidth} is used as the default {@link Ext.button.Button#minWidth minWidth} for +each of the buttons in the fbar. + + * @markdown + */ + if (me.fbar) { + fbar = initToolbar(me.fbar, 'bottom'); + fbar.ui = 'footer'; + + // Apply the minButtonWidth config to buttons in the toolbar + if (minButtonWidth) { + fbarDefaults = fbar.defaults; + fbar.defaults = function(config) { + var defaults = fbarDefaults || {}; + if ((!config.xtype || config.xtype === 'button' || (config.isComponent && config.isXType('button'))) && + !('minWidth' in defaults)) { + defaults = Ext.apply({minWidth: minButtonWidth}, defaults); + } + return defaults; + }; + } + + fbar = me.addDocked(fbar)[0]; + fbar.insert(0, { + flex: 1, + xtype: 'component', + focusable: false + }); + me.fbar = null; + } + + /** + * @cfg {Object/Array} lbar + * + * Convenience method. Short for 'Left Bar' (left-docked, vertical toolbar). + * + * lbar: [ + * { xtype: 'button', text: 'Button 1' } + * ] + * + * is equivalent to + * + * dockedItems: [{ + * xtype: 'toolbar', + * dock: 'left', + * items: [ + * { xtype: 'button', text: 'Button 1' } + * ] + * }] + * + * @markdown + */ + if (me.lbar) { + me.addDocked(initToolbar(me.lbar, 'left')); + me.lbar = null; + } + + /** + * @cfg {Object/Array} rbar + * + * Convenience method. Short for 'Right Bar' (right-docked, vertical toolbar). + * + * rbar: [ + * { xtype: 'button', text: 'Button 1' } + * ] + * + * is equivalent to + * + * dockedItems: [{ + * xtype: 'toolbar', + * dock: 'right', + * items: [ + * { xtype: 'button', text: 'Button 1' } + * ] + * }] + * + * @markdown + */ + if (me.rbar) { + me.addDocked(initToolbar(me.rbar, 'right')); + me.rbar = null; + } + }, + + /** + * @private + * Tools are a Panel-specific capabilty. + * Panel uses initTools. Subclasses may contribute tools by implementing addTools. + */ + initTools: function() { + var me = this; + + me.tools = me.tools || []; + + // Add a collapse tool unless configured to not show a collapse tool + // or to not even show a header. + if (me.collapsible && !(me.hideCollapseTool || me.header === false)) { + me.collapseDirection = me.collapseDirection || me.headerPosition || 'top'; + me.collapseTool = me.expandTool = me.createComponent({ + xtype: 'tool', + type: 'collapse-' + me.collapseDirection, + expandType: me.getOppositeDirection(me.collapseDirection), + handler: me.toggleCollapse, + scope: me + }); + + // Prepend collapse tool is configured to do so. + if (me.collapseFirst) { + me.tools.unshift(me.collapseTool); + } + } + + // Add subclass-specific tools. + me.addTools(); + + // Make Panel closable. + if (me.closable) { + me.addClsWithUI('closable'); + me.addTool({ + type: 'close', + handler: Ext.Function.bind(me.close, this, []) + }); + } + + // Append collapse tool if needed. + if (me.collapseTool && !me.collapseFirst) { + me.tools.push(me.collapseTool); + } + }, + + /** + * @private + * Template method to be implemented in subclasses to add their tools after the collapsible tool. + */ + addTools: Ext.emptyFn, + + /** + *
Closes the Panel. By default, this method, removes it from the DOM, {@link Ext.Component#destroy destroy}s + * the Panel object and all its descendant Components. The {@link #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 Panel without destroying it, call {@link #hide}.
+ */ + close: function() { + if (this.fireEvent('beforeclose', this) !== false) { + this.doClose(); + } + }, + + // private + doClose: function() { + this.fireEvent('close', this); + this[this.closeAction](); + }, + + onRender: function(ct, position) { + var me = this, + topContainer; + + // Add class-specific header tools. + // Panel adds collapsible and closable. + me.initTools(); + + // Dock the header/title + me.updateHeader(); + + // If initially collapsed, collapsed flag must indicate true current state at this point. + // Do collapse after the first time the Panel's structure has been laid out. + if (me.collapsed) { + me.collapsed = false; + topContainer = me.findLayoutController(); + if (!me.hidden && topContainer) { + topContainer.on({ + afterlayout: function() { + me.collapse(null, false, true); + }, + single: true + }); + } else { + me.afterComponentLayout = function() { + delete me.afterComponentLayout; + Ext.getClass(me).prototype.afterComponentLayout.apply(me, arguments); + me.collapse(null, false, true); + }; + } + } + + // Call to super after adding the header, to prevent an unnecessary re-layout + me.callParent(arguments); + }, + + /** + * Create, hide, or show the header component as appropriate based on the current config. + * @private + * @param {Boolean} force True to force the the header to be created + */ + updateHeader: function(force) { + var me = this, + header = me.header, + title = me.title, + tools = me.tools; + + if (!me.preventHeader && (force || title || (tools && tools.length))) { + if (!header) { + header = me.header = Ext.create('Ext.panel.Header', { + title : title, + orientation : (me.headerPosition == 'left' || me.headerPosition == 'right') ? 'vertical' : 'horizontal', + dock : me.headerPosition || 'top', + textCls : me.headerTextCls, + iconCls : me.iconCls, + baseCls : me.baseCls + '-header', + tools : tools, + ui : me.ui, + indicateDrag: me.draggable, + border : me.border, + frame : me.frame && me.frameHeader, + ignoreParentFrame : me.frame || me.overlapHeader, + ignoreBorderManagement: me.frame || me.ignoreHeaderBorderManagement, + listeners : me.collapsible && me.titleCollapse ? { + click: me.toggleCollapse, + scope: me + } : null + }); + me.addDocked(header, 0); + + // Reference the Header's tool array. + // Header injects named references. + me.tools = header.tools; + } + header.show(); + me.initHeaderAria(); + } else if (header) { + header.hide(); + } + }, + + // inherit docs + setUI: function(ui) { + var me = this; + + me.callParent(arguments); + + if (me.header) { + me.header.setUI(ui); + } + }, + + // private + getContentTarget: function() { + return this.body; + }, + + getTargetEl: function() { + return this.body || this.frameBody || this.el; + }, + + addTool: function(tool) { + this.tools.push(tool); + var header = this.header; + if (header) { + header.addTool(tool); + } + this.updateHeader(); + }, + + getOppositeDirection: function(d) { + var c = Ext.Component; + switch (d) { + case c.DIRECTION_TOP: + return c.DIRECTION_BOTTOM; + case c.DIRECTION_RIGHT: + return c.DIRECTION_LEFT; + case c.DIRECTION_BOTTOM: + return c.DIRECTION_TOP; + case c.DIRECTION_LEFT: + return c.DIRECTION_RIGHT; + } + }, + + /** + * Collapses the panel body so that the body becomes hidden. Docked Components parallel to the + * border towards which the collapse takes place will remain visible. Fires the {@link #beforecollapse} event which will + * cancel the collapse action if it returns false. + * @param {Number} direction. The direction to collapse towards. Must be one of
+ *
Ext.Component.DIRECTION_TOP
+ *
Ext.Component.DIRECTION_RIGHT
+ *
Ext.Component.DIRECTION_BOTTOM
+ *
Ext.Component.DIRECTION_LEFT
+ * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the + * {@link #animCollapse} panel config) + * @return {Ext.panel.Panel} this + */ + collapse: function(direction, animate, /* private - passed if called at render time */ internal) { + var me = this, + c = Ext.Component, + height = me.getHeight(), + width = me.getWidth(), + frameInfo, + newSize = 0, + dockedItems = me.dockedItems.items, + dockedItemCount = dockedItems.length, + i = 0, + comp, + pos, + anim = { + from: { + height: height, + width: width + }, + to: { + height: height, + width: width + }, + listeners: { + afteranimate: me.afterCollapse, + scope: me + }, + duration: Ext.Number.from(animate, Ext.fx.Anim.prototype.duration) + }, + reExpander, + reExpanderOrientation, + reExpanderDock, + getDimension, + setDimension, + collapseDimension; + + if (!direction) { + direction = me.collapseDirection; + } + + // If internal (Called because of initial collapsed state), then no animation, and no events. + if (internal) { + animate = false; + } else if (me.collapsed || me.fireEvent('beforecollapse', me, direction, animate) === false) { + return false; + } + + reExpanderDock = direction; + me.expandDirection = me.getOppositeDirection(direction); + + // Track docked items which we hide during collapsed state + me.hiddenDocked = []; + + switch (direction) { + case c.DIRECTION_TOP: + case c.DIRECTION_BOTTOM: + me.expandedSize = me.getHeight(); + reExpanderOrientation = 'horizontal'; + collapseDimension = 'height'; + getDimension = 'getHeight'; + setDimension = 'setHeight'; + + // Collect the height of the visible header. + // Hide all docked items except the header. + // Hide *ALL* docked items if we're going to end up hiding the whole Panel anyway + for (; i < dockedItemCount; i++) { + comp = dockedItems[i]; + if (comp.isVisible()) { + if (comp.isHeader && (!comp.dock || comp.dock == 'top' || comp.dock == 'bottom')) { + reExpander = comp; + } else { + me.hiddenDocked.push(comp); + } + } + } + + if (direction == Ext.Component.DIRECTION_BOTTOM) { + pos = me.getPosition()[1] - Ext.fly(me.el.dom.offsetParent).getRegion().top; + anim.from.top = pos; + } + break; + + case c.DIRECTION_LEFT: + case c.DIRECTION_RIGHT: + me.expandedSize = me.getWidth(); + reExpanderOrientation = 'vertical'; + collapseDimension = 'width'; + getDimension = 'getWidth'; + setDimension = 'setWidth'; + + // Collect the height of the visible header. + // Hide all docked items except the header. + // Hide *ALL* docked items if we're going to end up hiding the whole Panel anyway + for (; i < dockedItemCount; i++) { + comp = dockedItems[i]; + if (comp.isVisible()) { + if (comp.isHeader && (comp.dock == 'left' || comp.dock == 'right')) { + reExpander = comp; + } else { + me.hiddenDocked.push(comp); + } + } + } + + if (direction == Ext.Component.DIRECTION_RIGHT) { + pos = me.getPosition()[0] - Ext.fly(me.el.dom.offsetParent).getRegion().left; + anim.from.left = pos; + } + break; + + default: + throw('Panel collapse must be passed a valid Component collapse direction'); + } + + // No scrollbars when we shrink this Panel + // And no laying out of any children... we're effectively *hiding* the body + me.setAutoScroll(false); + me.suspendLayout = true; + me.body.setVisibilityMode(Ext.core.Element.DISPLAY); + + // Disable toggle tool during animated collapse + if (animate && me.collapseTool) { + me.collapseTool.disable(); + } + + // Add the collapsed class now, so that collapsed CSS rules are applied before measurements are taken. + me.addClsWithUI(me.collapsedCls); + // if (me.border === false) { + // me.addClsWithUI(me.collapsedCls + '-noborder'); + // } + + // We found a header: Measure it to find the collapse-to size. + if (reExpander) { + //we must add the collapsed cls to the header and then remove to get the proper height + reExpander.addClsWithUI(me.collapsedCls); + reExpander.addClsWithUI(me.collapsedCls + '-' + reExpander.dock); + if (me.border && (!me.frame || (me.frame && Ext.supports.CSS3BorderRadius))) { + reExpander.addClsWithUI(me.collapsedCls + '-border-' + reExpander.dock); + } + + frameInfo = reExpander.getFrameInfo(); + + //get the size + newSize = reExpander[getDimension]() + (frameInfo ? frameInfo[direction] : 0); + + //and remove + reExpander.removeClsWithUI(me.collapsedCls); + reExpander.removeClsWithUI(me.collapsedCls + '-' + reExpander.dock); + if (me.border && (!me.frame || (me.frame && Ext.supports.CSS3BorderRadius))) { + reExpander.removeClsWithUI(me.collapsedCls + '-border-' + reExpander.dock); + } + } + // No header: Render and insert a temporary one, and then measure it. + else { + reExpander = { + hideMode: 'offsets', + temporary: true, + title: me.title, + orientation: reExpanderOrientation, + dock: reExpanderDock, + textCls: me.headerTextCls, + iconCls: me.iconCls, + baseCls: me.baseCls + '-header', + ui: me.ui, + frame: me.frame && me.frameHeader, + ignoreParentFrame: me.frame || me.overlapHeader, + indicateDrag: me.draggable, + cls: me.baseCls + '-collapsed-placeholder ' + ' ' + Ext.baseCSSPrefix + 'docked ' + me.baseCls + '-' + me.ui + '-collapsed', + renderTo: me.el + }; + if (!me.hideCollapseTool) { + reExpander[(reExpander.orientation == 'horizontal') ? 'tools' : 'items'] = [{ + xtype: 'tool', + type: 'expand-' + me.expandDirection, + handler: me.toggleCollapse, + scope: me + }]; + } + + // Capture the size of the re-expander. + // For vertical headers in IE6 and IE7, this will be sized by a CSS rule in _panel.scss + reExpander = me.reExpander = Ext.create('Ext.panel.Header', reExpander); + newSize = reExpander[getDimension]() + ((reExpander.frame) ? reExpander.frameSize[direction] : 0); + reExpander.hide(); + + // Insert the new docked item + me.insertDocked(0, reExpander); + } + + me.reExpander = reExpander; + me.reExpander.addClsWithUI(me.collapsedCls); + me.reExpander.addClsWithUI(me.collapsedCls + '-' + reExpander.dock); + if (me.border && (!me.frame || (me.frame && Ext.supports.CSS3BorderRadius))) { + me.reExpander.addClsWithUI(me.collapsedCls + '-border-' + me.reExpander.dock); + } + + // If collapsing right or down, we'll be also animating the left or top. + if (direction == Ext.Component.DIRECTION_RIGHT) { + anim.to.left = pos + (width - newSize); + } else if (direction == Ext.Component.DIRECTION_BOTTOM) { + anim.to.top = pos + (height - newSize); + } + + // Animate to the new size + anim.to[collapseDimension] = newSize; + + // Remove any flex config before we attempt to collapse. + me.savedFlex = me.flex; + me.savedMinWidth = me.minWidth; + me.savedMinHeight = me.minHeight; + me.minWidth = 0; + me.minHeight = 0; + delete me.flex; + + if (animate) { + me.animate(anim); + } else { + // EXTJSIV-1937 (would like to use setCalculateSize) + // save width/height here, expand puts them back + me.uncollapsedSize = { width: me.width, height: me.height }; + + me.setSize(anim.to.width, anim.to.height); + if (Ext.isDefined(anim.to.left) || Ext.isDefined(anim.to.top)) { + me.setPosition(anim.to.left, anim.to.top); + } + me.afterCollapse(false, internal); + } + return me; + }, + + afterCollapse: function(animated, internal) { + var me = this, + i = 0, + l = me.hiddenDocked.length; + + me.minWidth = me.savedMinWidth; + me.minHeight = me.savedMinHeight; + + me.body.hide(); + for (; i < l; i++) { + me.hiddenDocked[i].hide(); + } + if (me.reExpander) { + me.reExpander.updateFrame(); + me.reExpander.show(); + } + me.collapsed = true; + + if (!internal) { + me.doComponentLayout(); + } + + if (me.resizer) { + me.resizer.disable(); + } + + // If me Panel was configured with a collapse tool in its header, flip it's type + if (me.collapseTool) { + me.collapseTool.setType('expand-' + me.expandDirection); + } + if (!internal) { + me.fireEvent('collapse', me); + } + + // Re-enable the toggle tool after an animated collapse + if (animated && me.collapseTool) { + me.collapseTool.enable(); + } + }, + + /** + * Expands the panel body so that it becomes visible. Fires the {@link #beforeexpand} event which will + * cancel the expand action if it returns false. + * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the + * {@link #animCollapse} panel config) + * @return {Ext.panel.Panel} this + */ + expand: function(animate) { + if (!this.collapsed || this.fireEvent('beforeexpand', this, animate) === false) { + return false; + } + + // EXTJSIV-1937 (would like to use setCalculateSize) + if (this.uncollapsedSize) { + Ext.Object.each(this.uncollapsedSize, function (name, value) { + if (Ext.isDefined(value)) { + this[name] = value; + } else { + delete this[name]; + } + }, this); + delete this.uncollapsedSize; + } + + var me = this, + i = 0, + l = me.hiddenDocked.length, + direction = me.expandDirection, + height = me.getHeight(), + width = me.getWidth(), + pos, anim, satisfyJSLint; + + // Disable toggle tool during animated expand + if (animate && me.collapseTool) { + me.collapseTool.disable(); + } + + // Show any docked items that we hid on collapse + // And hide the injected reExpander Header + for (; i < l; i++) { + me.hiddenDocked[i].hidden = false; + me.hiddenDocked[i].el.show(); + } + if (me.reExpander) { + if (me.reExpander.temporary) { + me.reExpander.hide(); + } else { + me.reExpander.removeClsWithUI(me.collapsedCls); + me.reExpander.removeClsWithUI(me.collapsedCls + '-' + me.reExpander.dock); + if (me.border && (!me.frame || (me.frame && Ext.supports.CSS3BorderRadius))) { + me.reExpander.removeClsWithUI(me.collapsedCls + '-border-' + me.reExpander.dock); + } + me.reExpander.updateFrame(); + } + } + + // If me Panel was configured with a collapse tool in its header, flip it's type + if (me.collapseTool) { + me.collapseTool.setType('collapse-' + me.collapseDirection); + } + + // Unset the flag before the potential call to calculateChildBox to calculate our newly flexed size + me.collapsed = false; + + // Collapsed means body element was hidden + me.body.show(); + + // Remove any collapsed styling before any animation begins + me.removeClsWithUI(me.collapsedCls); + // if (me.border === false) { + // me.removeClsWithUI(me.collapsedCls + '-noborder'); + // } + + anim = { + to: { + }, + from: { + height: height, + width: width + }, + listeners: { + afteranimate: me.afterExpand, + scope: me + } + }; + + if ((direction == Ext.Component.DIRECTION_TOP) || (direction == Ext.Component.DIRECTION_BOTTOM)) { + + // If autoHeight, measure the height now we have shown the body element. + if (me.autoHeight) { + me.setCalculatedSize(me.width, null); + anim.to.height = me.getHeight(); + + // Must size back down to collapsed for the animation. + me.setCalculatedSize(me.width, anim.from.height); + } + // If we were flexed, then we can't just restore to the saved size. + // We must restore to the currently correct, flexed size, so we much ask the Box layout what that is. + else if (me.savedFlex) { + me.flex = me.savedFlex; + anim.to.height = me.ownerCt.layout.calculateChildBox(me).height; + delete me.flex; + } + // Else, restore to saved height + else { + anim.to.height = me.expandedSize; + } + + // top needs animating upwards + if (direction == Ext.Component.DIRECTION_TOP) { + pos = me.getPosition()[1] - Ext.fly(me.el.dom.offsetParent).getRegion().top; + anim.from.top = pos; + anim.to.top = pos - (anim.to.height - height); + } + } else if ((direction == Ext.Component.DIRECTION_LEFT) || (direction == Ext.Component.DIRECTION_RIGHT)) { + + // If autoWidth, measure the width now we have shown the body element. + if (me.autoWidth) { + me.setCalculatedSize(null, me.height); + anim.to.width = me.getWidth(); + + // Must size back down to collapsed for the animation. + me.setCalculatedSize(anim.from.width, me.height); + } + // If we were flexed, then we can't just restore to the saved size. + // We must restore to the currently correct, flexed size, so we much ask the Box layout what that is. + else if (me.savedFlex) { + me.flex = me.savedFlex; + anim.to.width = me.ownerCt.layout.calculateChildBox(me).width; + delete me.flex; + } + // Else, restore to saved width + else { + anim.to.width = me.expandedSize; + } + + // left needs animating leftwards + if (direction == Ext.Component.DIRECTION_LEFT) { + pos = me.getPosition()[0] - Ext.fly(me.el.dom.offsetParent).getRegion().left; + anim.from.left = pos; + anim.to.left = pos - (anim.to.width - width); + } + } + + if (animate) { + me.animate(anim); + } else { + me.setSize(anim.to.width, anim.to.height); + if (anim.to.x) { + me.setLeft(anim.to.x); + } + if (anim.to.y) { + me.setTop(anim.to.y); + } + me.afterExpand(false); + } + + return me; + }, + + afterExpand: function(animated) { + var me = this; + me.setAutoScroll(me.initialConfig.autoScroll); + + // Restored to a calculated flex. Delete the set width and height properties so that flex works from now on. + if (me.savedFlex) { + me.flex = me.savedFlex; + delete me.savedFlex; + delete me.width; + delete me.height; + } + + // Reinstate layout out after Panel has re-expanded + delete me.suspendLayout; + if (animated && me.ownerCt) { + me.ownerCt.doLayout(); + } + + if (me.resizer) { + me.resizer.enable(); + } + + me.fireEvent('expand', me); + + // Re-enable the toggle tool after an animated expand + if (animated && me.collapseTool) { + me.collapseTool.enable(); + } + }, + + /** + * Shortcut for performing an {@link #expand} or {@link #collapse} based on the current state of the panel. + * @return {Ext.panel.Panel} this + */ + toggleCollapse: function() { + if (this.collapsed) { + this.expand(this.animCollapse); + } else { + this.collapse(this.collapseDirection, this.animCollapse); + } + return this; + }, + + // private + getKeyMap : function(){ + if(!this.keyMap){ + this.keyMap = Ext.create('Ext.util.KeyMap', this.el, this.keys); + } + return this.keyMap; + }, + + // private + initDraggable : function(){ + /** + *
If this Panel is configured {@link #draggable}, this property will contain + * an instance of {@link Ext.dd.DragSource} which handles dragging the Panel.
+ * The developer must provide implementations of the abstract methods of {@link Ext.dd.DragSource} + * in order to supply behaviour for each stage of the drag/drop process. See {@link #draggable}. + * @type Ext.dd.DragSource. + * @property dd + */ + this.dd = Ext.create('Ext.panel.DD', this, Ext.isBoolean(this.draggable) ? null : this.draggable); + }, + + // private - helper function for ghost + ghostTools : function() { + var tools = [], + origTools = this.initialConfig.tools; + + if (origTools) { + Ext.each(origTools, function(tool) { + // Some tools can be full components, and copying them into the ghost + // actually removes them from the owning panel. You could also potentially + // end up with duplicate DOM ids as well. To avoid any issues we just make + // a simple bare-minimum clone of each tool for ghosting purposes. + tools.push({ + type: tool.type + }); + }); + } + else { + tools = [{ + type: 'placeholder' + }]; + } + return tools; + }, + + // private - used for dragging + ghost: function(cls) { + var me = this, + ghostPanel = me.ghostPanel, + box = me.getBox(); + + if (!ghostPanel) { + ghostPanel = Ext.create('Ext.panel.Panel', { + renderTo: document.body, + floating: { + shadow: false + }, + frame: Ext.supports.CSS3BorderRadius ? me.frame : false, + title: me.title, + overlapHeader: me.overlapHeader, + headerPosition: me.headerPosition, + width: me.getWidth(), + height: me.getHeight(), + iconCls: me.iconCls, + baseCls: me.baseCls, + tools: me.ghostTools(), + cls: me.baseCls + '-ghost ' + (cls ||'') + }); + me.ghostPanel = ghostPanel; + } + ghostPanel.floatParent = me.floatParent; + if (me.floating) { + ghostPanel.setZIndex(Ext.Number.from(me.el.getStyle('zIndex'), 0)); + } else { + ghostPanel.toFront(); + } + ghostPanel.el.show(); + ghostPanel.setPosition(box.x, box.y); + ghostPanel.setSize(box.width, box.height); + me.el.hide(); + if (me.floatingItems) { + me.floatingItems.hide(); + } + return ghostPanel; + }, + + // private + unghost: function(show, matchPosition) { + var me = this; + if (!me.ghostPanel) { + return; + } + if (show !== false) { + me.el.show(); + if (matchPosition !== false) { + me.setPosition(me.ghostPanel.getPosition()); + } + if (me.floatingItems) { + me.floatingItems.show(); + } + Ext.defer(me.focus, 10, me); + } + me.ghostPanel.el.hide(); + }, + + initResizable: function(resizable) { + if (this.collapsed) { + resizable.disabled = true; + } + this.callParent([resizable]); + } +}); + +/** + * Component layout for Tip/ToolTip/etc. components + * @class Ext.layout.component.Tip + * @extends Ext.layout.component.Dock + * @private + */ + +Ext.define('Ext.layout.component.Tip', { + + /* Begin Definitions */ + + alias: ['layout.tip'], + + extend: 'Ext.layout.component.Dock', + + /* End Definitions */ + + type: 'tip', + + onLayout: function(width, height) { + var me = this, + owner = me.owner, + el = owner.el, + minWidth, + maxWidth, + naturalWidth, + constrainedWidth, + xy = el.getXY(); + + // Position offscreen so the natural width is not affected by the viewport's right edge + el.setXY([-9999,-9999]); + + // Calculate initial layout + this.callParent(arguments); + + // Handle min/maxWidth for auto-width tips + if (!Ext.isNumber(width)) { + minWidth = owner.minWidth; + maxWidth = owner.maxWidth; + // IE6/7 in strict mode have a problem doing an autoWidth + if (Ext.isStrict && (Ext.isIE6 || Ext.isIE7)) { + constrainedWidth = me.doAutoWidth(); + } else { + naturalWidth = el.getWidth(); + } + if (naturalWidth < minWidth) { + constrainedWidth = minWidth; + } + else if (naturalWidth > maxWidth) { + constrainedWidth = maxWidth; + } + if (constrainedWidth) { + this.callParent([constrainedWidth, height]); + } + } + + // Restore position + el.setXY(xy); + }, + + doAutoWidth: function(){ + var me = this, + owner = me.owner, + body = owner.body, + width = body.getTextWidth(); + + if (owner.header) { + width = Math.max(width, owner.header.getWidth()); + } + if (!Ext.isDefined(me.frameWidth)) { + me.frameWidth = owner.el.getWidth() - body.getWidth(); + } + width += me.frameWidth + body.getPadding('lr'); + return width; + } +}); + +/** + * @class Ext.tip.Tip + * @extends Ext.panel.Panel + * This is the base class for {@link Ext.tip.QuickTip} and {@link Ext.tip.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 + * @xtype tip + */ +Ext.define('Ext.tip.Tip', { + extend: 'Ext.panel.Panel', + requires: [ 'Ext.layout.component.Tip' ], + alternateClassName: 'Ext.Tip', + /** + * @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.core.Element#alignTo} anchor position value + * for this tip relative to its element of origin (defaults to "tl-bl?"). + */ + defaultAlign : "tl-bl?", + /** + * @cfg {Boolean} constrainPosition If true, then the tooltip will be automatically constrained to stay within + * the browser viewport. Defaults to false. + */ + constrainPosition : true, + + /** + * @inherited + */ + frame: false, + + // private panel overrides + autoRender: true, + hidden: true, + baseCls: Ext.baseCSSPrefix + 'tip', + floating: { + shadow: true, + shim: true, + constrain: true + }, + focusOnToFront: false, + componentLayout: 'tip', + + closeAction: 'hide', + + ariaRole: 'tooltip', + + initComponent: function() { + this.callParent(arguments); + + // Or in the deprecated config. Floating.doConstrain only constrains if the constrain property is truthy. + this.constrain = this.constrain || this.constrainPosition; + }, + + /** + * 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 + */ + showAt : function(xy){ + var me = this; + this.callParent(); + // Show may have been vetoed. + if (me.isVisible()) { + me.setPagePosition(xy[0], xy[1]); + if (me.constrainPosition || me.constrain) { + me.doConstrain(); + } + me.toFront(true); + } + }, + + /** + * Experimental. Shows this tip at a position relative to another element using a standard {@link Ext.core.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.core.Element or string id of the target element to align to + * @param {String} position (optional) A valid {@link Ext.core.Element#alignTo} anchor position (defaults to 'tl-br?' or + * {@link #defaultAlign} if specified). + */ + showBy : function(el, pos) { + this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign)); + }, + + /** + * @private + * @override + * Set Tip draggable using base Component's draggability + */ + initDraggable : function(){ + var me = this; + me.draggable = { + el: me.getDragEl(), + delegate: me.header.el, + constrain: me, + constrainTo: me.el.dom.parentNode + }; + // Important: Bypass Panel's initDraggable. Call direct to Component's implementation. + Ext.Component.prototype.initDraggable.call(me); + }, + + // Tip does not ghost. Drag is "live" + ghost: undefined, + unghost: undefined +}); + +/** + * @class Ext.tip.ToolTip + * @extends Ext.tip.Tip + * + * ToolTip is a {@link Ext.tip.Tip} implementation that handles the common case of displaying a + * tooltip when hovering over a certain element or elements on the page. It allows fine-grained + * control over the tooltip's alignment relative to the target element or mouse, and the timing + * of when it is automatically shown and hidden. + * + * This implementation does **not** have a built-in method of automatically populating the tooltip's + * text based on the target element; you must either configure a fixed {@link #html} value for each + * ToolTip instance, or implement custom logic (e.g. in a {@link #beforeshow} event listener) to + * generate the appropriate tooltip content on the fly. See {@link Ext.tip.QuickTip} for a more + * convenient way of automatically populating and configuring a tooltip based on specific DOM + * attributes of each target element. + * + * ## Basic Example + * + * var tip = Ext.create('Ext.tip.ToolTip', { + * target: 'clearButton', + * html: 'Press this button to clear the form' + * }); + * + * {@img Ext.tip.ToolTip/Ext.tip.ToolTip1.png Basic Ext.tip.ToolTip} + * + * ## Delegation + * + * In addition to attaching a ToolTip to a single element, you can also use delegation to attach + * one ToolTip to many elements under a common parent. This is more efficient than creating many + * ToolTip instances. To do this, point the {@link #target} config to a common ancestor of all the + * elements, and then set the {@link #delegate} config to a CSS selector that will select all the + * appropriate sub-elements. + * + * When using delegation, it is likely that you will want to programmatically change the content + * of the ToolTip based on each delegate element; you can do this by implementing a custom + * listener for the {@link #beforeshow} event. Example: + * + * var myGrid = Ext.create('Ext.grid.GridPanel', gridConfig); + * myGrid.on('render', function(grid) { + * var view = grid.getView(); // Capture the grid's view. + * grid.tip = Ext.create('Ext.tip.ToolTip', { + * target: view.el, // The overall target element. + * delegate: view.itemSelector, // Each grid row causes its own seperate show and hide. + * trackMouse: true, // Moving within the row should not hide the tip. + * renderTo: Ext.getBody(), // 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) { + * tip.update('Over company "' + view.getRecord(tip.triggerElement).get('company') + '"'); + * } + * } + * }); + * }); + * + * {@img Ext.tip.ToolTip/Ext.tip.ToolTip2.png Ext.tip.ToolTip with delegation} + * + * ## Alignment + * + * The following configuration properties allow control over how the ToolTip is aligned relative to + * the target element and/or mouse pointer: + * + * - {@link #anchor} + * - {@link #anchorToTarget} + * - {@link #anchorOffset} + * - {@link #trackMouse} + * - {@link #mouseOffset} + * + * ## Showing/Hiding + * + * The following configuration properties allow control over how and when the ToolTip is automatically + * shown and hidden: + * + * - {@link #autoHide} + * - {@link #showDelay} + * - {@link #hideDelay} + * - {@link #dismissDelay} + * + * @constructor + * Create a new ToolTip instance + * @param {Object} config The configuration options + * @xtype tooltip + * @markdown + * @docauthor Jason Johnston + */ +Ext.define('Ext.tip.ToolTip', { + extend: 'Ext.tip.Tip', + alias: 'widget.tooltip', + alternateClassName: 'Ext.ToolTip', + /** + * 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 + */ + /** + * @cfg {Mixed} target The target HTMLElement, Ext.core.Element or id to monitor + * for mouseover events to trigger showing this ToolTip. + */ + /** + * @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 {Number} showDelay Delay in milliseconds before the tooltip displays + * after the mouse enters the target element (defaults to 500) + */ + showDelay: 500, + /** + * @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. + */ + hideDelay: 200, + /** + * @cfg {Number} dismissDelay Delay in milliseconds before the tooltip + * automatically hides (defaults to 5000). To disable automatic hiding, set + * dismissDelay = 0. + */ + dismissDelay: 5000, + /** + * @cfg {Array} mouseOffset An XY offset from the mouse position where the + * tooltip should be shown (defaults to [15,18]). + */ + /** + * @cfg {Boolean} trackMouse True to have the tooltip follow the mouse as it + * moves over the target element (defaults to false). + */ + trackMouse: false, + /** + * @cfg {String} anchor If specified, indicates that the tip should be anchored to a + * particular side of the target element or mouse pointer ("top", "right", "bottom", + * or "left"), with an arrow pointing back at the target or mouse pointer. If + * {@link #constrainPosition} is enabled, this will be used as a preferred value + * only and may be flipped as needed. + */ + /** + * @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. + */ + anchorToTarget: true, + /** + * @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. + */ + anchorOffset: 0, + /** + * @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 = Ext.create('Ext.grid.GridPanel', gridConfig); +myGrid.on('render', function(grid) { + var view = grid.getView(); // Capture the grid's view. + grid.tip = Ext.create('Ext.tip.ToolTip', { + target: view.el, // The overall target element. + delegate: view.itemSelector, // Each grid row causes its own seperate show and hide. + trackMouse: true, // Moving within the row should not hide the tip. + renderTo: Ext.getBody(), // 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(tip) { + tip.update('Over Record ID ' + view.getRecord(tip.triggerElement).id); + } + } + }); +}); + *
+ */ + + // private + targetCounter: 0, + quickShowInterval: 250, + + // private + initComponent: function() { + var me = this; + me.callParent(arguments); + me.lastActive = new Date(); + me.setTarget(me.target); + me.origAnchor = me.anchor; + }, + + // private + onRender: function(ct, position) { + var me = this; + me.callParent(arguments); + me.anchorCls = Ext.baseCSSPrefix + 'tip-anchor-' + me.getAnchorPosition(); + me.anchorEl = me.el.createChild({ + cls: Ext.baseCSSPrefix + 'tip-anchor ' + me.anchorCls + }); + }, + + // private + afterRender: function() { + var me = this, + zIndex; + + me.callParent(arguments); + zIndex = parseInt(me.el.getZIndex(), 10) || 0; + me.anchorEl.setStyle('z-index', zIndex + 1).setVisibilityMode(Ext.core.Element.DISPLAY); + }, + + /** + * 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 + */ + setTarget: function(target) { + var me = this, + t = Ext.get(target), + tg; + + if (me.target) { + tg = Ext.get(me.target); + me.mun(tg, 'mouseover', me.onTargetOver, me); + me.mun(tg, 'mouseout', me.onTargetOut, me); + me.mun(tg, 'mousemove', me.onMouseMove, me); + } + + me.target = t; + if (t) { + + me.mon(t, { + // TODO - investigate why IE6/7 seem to fire recursive resize in e.getXY + // breaking QuickTip#onTargetOver (EXTJSIV-1608) + freezeEvent: true, + + mouseover: me.onTargetOver, + mouseout: me.onTargetOut, + mousemove: me.onMouseMove, + scope: me + }); + } + if (me.anchor) { + me.anchorTarget = me.target; + } + }, + + // private + onMouseMove: function(e) { + var me = this, + t = me.delegate ? e.getTarget(me.delegate) : me.triggerElement = true, + xy; + if (t) { + me.targetXY = e.getXY(); + if (t === me.triggerElement) { + if (!me.hidden && me.trackMouse) { + xy = me.getTargetXY(); + if (me.constrainPosition) { + xy = me.el.adjustForConstraints(xy, me.el.dom.parentNode); + } + me.setPagePosition(xy); + } + } else { + me.hide(); + me.lastActive = new Date(0); + me.onTargetOver(e); + } + } else if ((!me.closable && me.isVisible()) && me.autoHide !== false) { + me.hide(); + } + }, + + // private + getTargetXY: function() { + var me = this, + mouseOffset; + if (me.delegate) { + me.anchorTarget = me.triggerElement; + } + if (me.anchor) { + me.targetCounter++; + var offsets = me.getOffsets(), + xy = (me.anchorToTarget && !me.trackMouse) ? me.el.getAlignToXY(me.anchorTarget, me.getAnchorAlign()) : me.targetXY, + dw = Ext.core.Element.getViewWidth() - 5, + dh = Ext.core.Element.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 = me.getSize(), + constrainPosition = me.constrainPosition; + + me.anchorEl.removeCls(me.anchorCls); + + if (me.targetCounter < 2 && constrainPosition) { + if (axy[0] < scrollX) { + if (me.anchorToTarget) { + me.defaultAlign = 'l-r'; + if (me.mouseOffset) { + me.mouseOffset[0] *= -1; + } + } + me.anchor = 'left'; + return me.getTargetXY(); + } + if (axy[0] + sz.width > dw) { + if (me.anchorToTarget) { + me.defaultAlign = 'r-l'; + if (me.mouseOffset) { + me.mouseOffset[0] *= -1; + } + } + me.anchor = 'right'; + return me.getTargetXY(); + } + if (axy[1] < scrollY) { + if (me.anchorToTarget) { + me.defaultAlign = 't-b'; + if (me.mouseOffset) { + me.mouseOffset[1] *= -1; + } + } + me.anchor = 'top'; + return me.getTargetXY(); + } + if (axy[1] + sz.height > dh) { + if (me.anchorToTarget) { + me.defaultAlign = 'b-t'; + if (me.mouseOffset) { + me.mouseOffset[1] *= -1; + } + } + me.anchor = 'bottom'; + return me.getTargetXY(); + } + } + + me.anchorCls = Ext.baseCSSPrefix + 'tip-anchor-' + me.getAnchorPosition(); + me.anchorEl.addCls(me.anchorCls); + me.targetCounter = 0; + return axy; + } else { + mouseOffset = me.getMouseOffset(); + return (me.targetXY) ? [me.targetXY[0] + mouseOffset[0], me.targetXY[1] + mouseOffset[1]] : mouseOffset; + } + }, + + getMouseOffset: function() { + var me = this, + offset = me.anchor ? [0, 0] : [15, 18]; + if (me.mouseOffset) { + offset[0] += me.mouseOffset[0]; + offset[1] += me.mouseOffset[1]; + } + return offset; + }, + + // private + getAnchorPosition: function() { + var me = this, + m; + if (me.anchor) { + me.tipAnchor = me.anchor.charAt(0); + } else { + m = me.defaultAlign.match(/^([a-z]+)-([a-z]+)(\?)?$/); + if (!m) { + Ext.Error.raise('The AnchorTip.defaultAlign value "' + me.defaultAlign + '" is invalid.'); + } + me.tipAnchor = m[1].charAt(0); + } + + switch (me.tipAnchor) { + case 't': + return 'top'; + case 'b': + return 'bottom'; + case 'r': + return 'right'; + } + return 'left'; + }, + + // 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'; + } + }, + + // private + getOffsets: function() { + var me = this, + mouseOffset, + offsets, + ap = me.getAnchorPosition().charAt(0); + if (me.anchorToTarget && !me.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 - me.anchorOffset, 30]; + break; + case 'b': + offsets = [ - 19 - me.anchorOffset, -13 - me.el.dom.offsetHeight]; + break; + case 'r': + offsets = [ - 15 - me.el.dom.offsetWidth, -13 - me.anchorOffset]; + break; + default: + offsets = [25, -13 - me.anchorOffset]; + break; + } + } + mouseOffset = me.getMouseOffset(); + offsets[0] += mouseOffset[0]; + offsets[1] += mouseOffset[1]; + + return offsets; + }, + + // private + onTargetOver: function(e) { + var me = this, + t; + + if (me.disabled || e.within(me.target.dom, true)) { + return; + } + t = e.getTarget(me.delegate); + if (t) { + me.triggerElement = t; + me.clearTimer('hide'); + me.targetXY = e.getXY(); + me.delayShow(); + } + }, + + // private + delayShow: function() { + var me = this; + if (me.hidden && !me.showTimer) { + if (Ext.Date.getElapsed(me.lastActive) < me.quickShowInterval) { + me.show(); + } else { + me.showTimer = Ext.defer(me.show, me.showDelay, me); + } + } + else if (!me.hidden && me.autoHide !== false) { + me.show(); + } + }, + + // private + onTargetOut: function(e) { + var me = this; + if (me.disabled || e.within(me.target.dom, true)) { + return; + } + me.clearTimer('show'); + if (me.autoHide !== false) { + me.delayHide(); + } + }, + + // private + delayHide: function() { + var me = this; + if (!me.hidden && !me.hideTimer) { + me.hideTimer = Ext.defer(me.hide, me.hideDelay, me); + } + }, + + /** + * Hides this tooltip if visible. + */ + hide: function() { + var me = this; + me.clearTimer('dismiss'); + me.lastActive = new Date(); + if (me.anchorEl) { + me.anchorEl.hide(); + } + me.callParent(arguments); + delete me.triggerElement; + }, + + /** + * Shows this tooltip at the current event target XY position. + */ + show: function() { + var me = this; + + // Show this Component first, so that sizing can be calculated + // pre-show it off screen so that the el will have dimensions + this.callParent(); + if (this.hidden === false) { + me.setPagePosition(-10000, -10000); + + if (me.anchor) { + me.anchor = me.origAnchor; + } + me.showAt(me.getTargetXY()); + + if (me.anchor) { + me.syncAnchor(); + me.anchorEl.show(); + } else { + me.anchorEl.hide(); + } + } + }, + + // inherit docs + showAt: function(xy) { + var me = this; + me.lastActive = new Date(); + me.clearTimers(); + + // Only call if this is hidden. May have been called from show above. + if (!me.isVisible()) { + this.callParent(arguments); + } + + // Show may have been vetoed. + if (me.isVisible()) { + me.setPagePosition(xy[0], xy[1]); + if (me.constrainPosition || me.constrain) { + me.doConstrain(); + } + me.toFront(true); + } + + if (me.dismissDelay && me.autoHide !== false) { + me.dismissTimer = Ext.defer(me.hide, me.dismissDelay, me); + } + if (me.anchor) { + me.syncAnchor(); + if (!me.anchorEl.isVisible()) { + me.anchorEl.show(); + } + } else { + me.anchorEl.hide(); + } + }, + + // private + syncAnchor: function() { + var me = this, + anchorPos, + targetPos, + offset; + switch (me.tipAnchor.charAt(0)) { + case 't': + anchorPos = 'b'; + targetPos = 'tl'; + offset = [20 + me.anchorOffset, 1]; + break; + case 'r': + anchorPos = 'l'; + targetPos = 'tr'; + offset = [ - 1, 12 + me.anchorOffset]; + break; + case 'b': + anchorPos = 't'; + targetPos = 'bl'; + offset = [20 + me.anchorOffset, -1]; + break; + default: + anchorPos = 'r'; + targetPos = 'tl'; + offset = [1, 12 + me.anchorOffset]; + break; + } + me.anchorEl.alignTo(me.el, anchorPos + '-' + targetPos, offset); + }, + + // private + setPagePosition: function(x, y) { + var me = this; + me.callParent(arguments); + if (me.anchor) { + me.syncAnchor(); + } + }, + + // private + clearTimer: function(name) { + name = name + 'Timer'; + clearTimeout(this[name]); + delete this[name]; + }, + + // private + clearTimers: function() { + var me = this; + me.clearTimer('show'); + me.clearTimer('dismiss'); + me.clearTimer('hide'); + }, + + // private + onShow: function() { + var me = this; + me.callParent(); + me.mon(Ext.getDoc(), 'mousedown', me.onDocMouseDown, me); + }, + + // private + onHide: function() { + var me = this; + me.callParent(); + me.mun(Ext.getDoc(), 'mousedown', me.onDocMouseDown, me); + }, + + // private + onDocMouseDown: function(e) { + var me = this; + if (me.autoHide !== true && !me.closable && !e.within(me.el.dom)) { + me.disable(); + Ext.defer(me.doEnable, 100, me); + } + }, + + // private + doEnable: function() { + if (!this.isDestroyed) { + this.enable(); + } + }, + + // private + onDisable: function() { + this.callParent(); + this.clearTimers(); + this.hide(); + }, + + beforeDestroy: function() { + var me = this; + me.clearTimers(); + Ext.destroy(me.anchorEl); + delete me.anchorEl; + delete me.target; + delete me.anchorTarget; + delete me.triggerElement; + me.callParent(); + }, + + // private + onDestroy: function() { + Ext.getDoc().un('mousedown', this.onDocMouseDown, this); + this.callParent(); + } +}); + +/** + * @class Ext.tip.QuickTip + * @extends Ext.tip.ToolTip + * A specialized tooltip class for tooltips that can be specified in markup and automatically managed by the global + * {@link Ext.tip.QuickTipManager} instance. See the QuickTipManager class header for additional usage details and examples. + * @constructor + * Create a new Tip + * @param {Object} config The configuration options + * @xtype quicktip + */ +Ext.define('Ext.tip.QuickTip', { + extend: 'Ext.tip.ToolTip', + alternateClassName: 'Ext.QuickTip', + /** + * @cfg {Mixed} target The target HTMLElement, Ext.core.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, + + // Force creation of header Component + title: ' ', + + // private + tagConfig : { + namespace : "data-", + attribute : "qtip", + width : "qwidth", + target : "target", + title : "qtitle", + hide : "hide", + cls : "qclass", + align : "qalign", + anchor : "anchor" + }, + + // private + initComponent : function(){ + var me = this; + + me.target = me.target || Ext.getDoc(); + me.targets = me.targets || {}; + me.callParent(); + }, + + /** + * 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.tip.QuickTipManager} 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 configs = Ext.isArray(config) ? config : arguments, + i = 0, + len = configs.length, + target, j, targetLen; + + for (; i < len; i++) { + config = configs[i]; + target = config.target; + if (target) { + if (Ext.isArray(target)) { + for (j = 0, targetLen = target.length; j < targetLen; j++) { + this.targets[Ext.id(target[j])] = config; + } + } else{ + this.targets[Ext.id(target)] = config; + } + } + } + }, + + /** + * 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 me = this, + activeTarget = me.activeTarget; + + el = Ext.get(el).dom; + if (me.isVisible()) { + if (activeTarget && activeTarget.el == el) { + me.hide(); + } + } else if (activeTarget && activeTarget.el == el) { + me.clearTimer('show'); + } + }, + + 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; + t = e.getTarget('[' + cfg.namespace + cfg.attribute + ']'); + if (t) { + ttp = t.getAttribute(cfg.namespace + cfg.attribute); + } + } + return ttp; + }, + + // private + onTargetOver : function(e){ + var me = this, + target = e.getTarget(), + elTarget, + cfg, + ns, + ttp, + autoHide; + + if (me.disabled) { + return; + } + + // TODO - this causes "e" to be recycled in IE6/7 (EXTJSIV-1608) so ToolTip#setTarget + // was changed to include freezeEvent. The issue seems to be a nested 'resize' event + // that smashed Ext.EventObject. + me.targetXY = e.getXY(); + + if(!target || target.nodeType !== 1 || target == document || target == document.body){ + return; + } + + if (me.activeTarget && ((target == me.activeTarget.el) || Ext.fly(me.activeTarget.el).contains(target))) { + me.clearTimer('hide'); + me.show(); + return; + } + + if (target) { + Ext.Object.each(me.targets, function(key, value) { + var targetEl = Ext.fly(value.target); + if (targetEl && (targetEl.dom === target || targetEl.contains(target))) { + elTarget = targetEl.dom; + return false; + } + }); + if (elTarget) { + me.activeTarget = me.targets[elTarget.id]; + me.activeTarget.el = target; + me.anchor = me.activeTarget.anchor; + if (me.anchor) { + me.anchorTarget = target; + } + me.delayShow(); + return; + } + } + + elTarget = Ext.get(target); + cfg = me.tagConfig; + ns = cfg.namespace; + ttp = me.getTipCfg(e); + + if (ttp) { + autoHide = elTarget.getAttribute(ns + cfg.hide); + + me.activeTarget = { + el: target, + text: ttp, + width: +elTarget.getAttribute(ns + cfg.width) || null, + autoHide: autoHide != "user" && autoHide !== 'false', + title: elTarget.getAttribute(ns + cfg.title), + cls: elTarget.getAttribute(ns + cfg.cls), + align: elTarget.getAttribute(ns + cfg.align) + + }; + me.anchor = elTarget.getAttribute(ns + cfg.anchor); + if (me.anchor) { + me.anchorTarget = target; + } + me.delayShow(); + } + }, + + // private + onTargetOut : function(e){ + var me = this; + + // If moving within the current target, and it does not have a new tip, ignore the mouseout + if (me.activeTarget && e.within(me.activeTarget.el) && !me.getTipCfg(e)) { + return; + } + + me.clearTimer('show'); + if (me.autoHide !== false) { + me.delayHide(); + } + }, + + // inherit docs + showAt : function(xy){ + var me = this, + target = me.activeTarget; + + if (target) { + if (!me.rendered) { + me.render(Ext.getBody()); + me.activeTarget = target; + } + if (target.title) { + me.setTitle(target.title || ''); + me.header.show(); + } else { + me.header.hide(); + } + me.body.update(target.text); + me.autoHide = target.autoHide; + me.dismissDelay = target.dismissDelay || me.dismissDelay; + if (me.lastCls) { + me.el.removeCls(me.lastCls); + delete me.lastCls; + } + if (target.cls) { + me.el.addCls(target.cls); + me.lastCls = target.cls; + } + + me.setWidth(target.width); + + if (me.anchor) { + me.constrainPosition = false; + } else if (target.align) { // TODO: this doesn't seem to work consistently + xy = me.el.getAlignToXY(target.el, target.align); + me.constrainPosition = false; + }else{ + me.constrainPosition = true; + } + } + me.callParent([xy]); + }, + + // inherit docs + hide: function(){ + delete this.activeTarget; + this.callParent(); + } +}); + +/** + * @class Ext.tip.QuickTipManager + * + * 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.Tip} or {@link Ext.tip.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.tip.QuickTip} is available via + * {@link #getQuickTip}, and supports all the methods, and all the all the + * configuration properties of Ext.tip.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 the config options for the {@link Ext.tip.QuickTip QuickTip} class + * + * ## 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: + * + * {@img Ext.tip.QuickTipManager/Ext.tip.QuickTipManager.png Ext.tip.QuickTipManager component} + * + * ## Code + * + * // Init the singleton. Any tag-based quick tips will start working. + * Ext.tip.QuickTipManager.init(); + * + * // Apply a set of config properties to the singleton + * Ext.apply(Ext.tip.QuickTipManager.getQuickTip(), { + * maxWidth: 200, + * minWidth: 100, + * showDelay: 50 // Show 50ms after entering target + * }); + * + * // Create a small panel to add a quick tip to + * Ext.create('Ext.container.Container', { + * id: 'quickTipContainer', + * width: 200, + * height: 150, + * style: { + * backgroundColor:'#000000' + * }, + * renderTo: Ext.getBody() + * }); + * + * + * // Manually register a quick tip for a specific element + * Ext.tip.QuickTipManager.register({ + * target: 'quickTipContainer', + * title: 'My Tooltip', + * text: 'This tooltip was added in code', + * width: 100, + * dismissDelay: 10000 // Hide after 10 seconds hover + * }); + * + * To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with + * the **data-** 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 + * + * + * @singleton + */ +Ext.define('Ext.tip.QuickTipManager', function() { + var tip, + disabled = false; + + return { + requires: ['Ext.tip.QuickTip'], + singleton: true, + alternateClassName: 'Ext.QuickTips', + + /** + * 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) + * @param {Object} config An optional config object for the created QuickTip. By + * default, the {@link Ext.tip.QuickTip QuickTip} class is instantiated, but this can + * be changed by supplying an xtype property or a className property in this object. + * All other properties on this object are configuration for the created component. + */ + init : function (autoRender, config) { + if (!tip) { + if (!Ext.isReady) { + Ext.onReady(function(){ + Ext.tip.QuickTipManager.init(autoRender); + }); + return; + } + + var tipConfig = Ext.apply({ disabled: disabled }, config), + className = tipConfig.className, + xtype = tipConfig.xtype; + + if (className) { + delete tipConfig.className; + } else if (xtype) { + className = 'widget.' + xtype; + delete tipConfig.xtype; + } + + if (autoRender !== false) { + tipConfig.renderTo = document.body; + + if (tipConfig.renderTo.tagName != 'BODY') { // e.g., == 'FRAMESET' + Ext.Error.raise({ + sourceClass: 'Ext.tip.QuickTipManager', + sourceMethod: 'init', + msg: 'Cannot init QuickTipManager: no document body' + }); + } + } + + tip = Ext.create(className || 'Ext.tip.QuickTip', tipConfig); + } + }, + + /** + * Destroy the QuickTips instance. + */ + destroy: function() { + if (tip) { + var undef; + tip.destroy(); + tip = undef; + } + }, + + // Protected method called by the dd classes + ddDisable : function(){ + // don't disable it if we don't need to + if(tip && !disabled){ + tip.disable(); + } + }, + + // Protected method called by the dd classes + ddEnable : function(){ + // only enable it if it hasn't been disabled + if(tip && !disabled){ + tip.enable(); + } + }, + + /** + * Enable quick tips globally. + */ + enable : function(){ + if(tip){ + tip.enable(); + } + disabled = false; + }, + + /** + * Disable quick tips globally. + */ + disable : function(){ + if(tip){ + tip.disable(); + } + disabled = true; + }, + + /** + * Returns true if quick tips are enabled, else false. + * @return {Boolean} + */ + isEnabled : function(){ + return tip !== undefined && !tip.disabled; + }, + + /** + * Gets the single {@link Ext.tip.QuickTip QuickTip} instance used to show tips from all registered elements. + * @return {Ext.tip.QuickTip} + */ + getQuickTip : function(){ + return tip; + }, + + /** + * Configures a new quick tip instance and assigns it to a target element. See + * {@link Ext.tip.QuickTip#register} for details. + * @param {Object} config The config object + */ + register : function(){ + tip.register.apply(tip, arguments); + }, + + /** + * 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); + }, + + /** + * Alias of {@link #register}. + * @param {Object} config The config object + */ + tips : function(){ + tip.register.apply(tip, arguments); + } + }; +}()); +/** + * @class Ext.app.Application + * @extend Ext.app.Controller + * + * Represents an Ext JS 4 application, which is typically a single page app using a {@link Ext.container.Viewport Viewport}. + * A typical Ext.app.Application might look like this: + * + * Ext.application({ + * name: 'MyApp', + * launch: function() { + * Ext.create('Ext.container.Viewport', { + * items: { + * html: 'My App' + * } + * }); + * } + * }); + * + * This does several things. First it creates a global variable called 'MyApp' - all of your Application's classes (such + * as its Models, Views and Controllers) will reside under this single namespace, which drastically lowers the chances + * of colliding global variables. + * + * When the page is ready and all of your JavaScript has loaded, your Application's {@link #launch} function is called, + * at which time you can run the code that starts your app. Usually this consists of creating a Viewport, as we do in + * the example above. + * + * Telling Application about the rest of the app + * + * Because an Ext.app.Application represents an entire app, we should tell it about the other parts of the app - namely + * the Models, Views and Controllers that are bundled with the application. Let's say we have a blog management app; we + * might have Models and Controllers for Posts and Comments, and Views for listing, adding and editing Posts and Comments. + * Here's how we'd tell our Application about all these things: + * + * Ext.application({ + * name: 'Blog', + * models: ['Post', 'Comment'], + * controllers: ['Posts', 'Comments'], + * + * launch: function() { + * ... + * } + * }); + * + * Note that we didn't actually list the Views directly in the Application itself. This is because Views are managed by + * Controllers, so it makes sense to keep those dependencies there. The Application will load each of the specified + * Controllers using the pathing conventions laid out in the application + * architecture guide - in this case expecting the controllers to reside in app/controller/Posts.js and + * app/controller/Comments.js. In turn, each Controller simply needs to list the Views it uses and they will be + * automatically loaded. Here's how our Posts controller like be defined: + * + * Ext.define('MyApp.controller.Posts', { + * extend: 'Ext.app.Controller', + * views: ['posts.List', 'posts.Edit'], + * + * //the rest of the Controller here + * }); + * + * Because we told our Application about our Models and Controllers, and our Controllers about their Views, Ext JS will + * automatically load all of our app files for us. This means we don't have to manually add script tags into our html + * files whenever we add a new class, but more importantly it enables us to create a minimized build of our entire + * application using the Ext JS 4 SDK Tools. + * + * For more information about writing Ext JS 4 applications, please see the + * application architecture guide. + * + * @docauthor Ed Spencer + * @constructor + */ +Ext.define('Ext.app.Application', { + extend: 'Ext.app.Controller', + + requires: [ + 'Ext.ModelManager', + 'Ext.data.Model', + 'Ext.data.StoreManager', + 'Ext.tip.QuickTipManager', + 'Ext.ComponentManager', + 'Ext.app.EventBus' + ], + + /** + * @cfg {String} name The name of your application. This will also be the namespace for your views, controllers + * models and stores. Don't use spaces or special characters in the name. + */ + + /** + * @cfg {Object} scope The scope to execute the {@link #launch} function in. Defaults to the Application + * instance. + */ + scope: undefined, + + /** + * @cfg {Boolean} enableQuickTips True to automatically set up Ext.tip.QuickTip support (defaults to true) + */ + enableQuickTips: true, + + /** + * @cfg {String} defaultUrl When the app is first loaded, this url will be redirected to. Defaults to undefined + */ + + /** + * @cfg {String} appFolder The path to the directory which contains all application's classes. + * This path will be registered via {@link Ext.Loader#setPath} for the namespace specified in the {@link #name name} config. + * Defaults to 'app' + */ + appFolder: 'app', + + /** + * @cfg {Boolean} autoCreateViewport True to automatically load and instantiate AppName.view.Viewport + * before firing the launch function (defaults to false). + */ + autoCreateViewport: false, + + constructor: function(config) { + config = config || {}; + Ext.apply(this, config); + + var requires = config.requires || []; + + Ext.Loader.setPath(this.name, this.appFolder); + + if (this.paths) { + Ext.Object.each(this.paths, function(key, value) { + Ext.Loader.setPath(key, value); + }); + } + + this.callParent(arguments); + + this.eventbus = Ext.create('Ext.app.EventBus'); + + var controllers = Ext.Array.from(this.controllers), + ln = controllers && controllers.length, + i, controller; + + this.controllers = Ext.create('Ext.util.MixedCollection'); + + if (this.autoCreateViewport) { + requires.push(this.getModuleClassName('Viewport', 'view')); + } + + for (i = 0; i < ln; i++) { + requires.push(this.getModuleClassName(controllers[i], 'controller')); + } + + Ext.require(requires); + + Ext.onReady(function() { + for (i = 0; i < ln; i++) { + controller = this.getController(controllers[i]); + controller.init(this); + } + + this.onBeforeLaunch.call(this); + }, this); + }, + + control: function(selectors, listeners, controller) { + this.eventbus.control(selectors, listeners, controller); + }, + + /** + * Called automatically when the page has completely loaded. This is an empty function that should be + * overridden by each application that needs to take action on page load + * @property launch + * @type Function + * @param {String} profile The detected {@link #profiles application profile} + * @return {Boolean} By default, the Application will dispatch to the configured startup controller and + * action immediately after running the launch function. Return false to prevent this behavior. + */ + launch: Ext.emptyFn, + + /** + * @private + */ + onBeforeLaunch: function() { + if (this.enableQuickTips) { + Ext.tip.QuickTipManager.init(); + } + + if (this.autoCreateViewport) { + this.getView('Viewport').create(); + } + + this.launch.call(this.scope || this); + this.launched = true; + this.fireEvent('launch', this); + + this.controllers.each(function(controller) { + controller.onLaunch(this); + }, this); + }, + + getModuleClassName: function(name, type) { + var namespace = Ext.Loader.getPrefix(name); + + if (namespace.length > 0 && namespace !== name) { + return name; + } + + return this.name + '.' + type + '.' + name; + }, + + getController: function(name) { + var controller = this.controllers.get(name); + + if (!controller) { + controller = Ext.create(this.getModuleClassName(name, 'controller'), { + application: this, + id: name + }); + + this.controllers.add(controller); + } + + return controller; + }, + + getStore: function(name) { + var store = Ext.StoreManager.get(name); + + if (!store) { + store = Ext.create(this.getModuleClassName(name, 'store'), { + storeId: name + }); + } + + return store; + }, + + getModel: function(model) { + model = this.getModuleClassName(model, 'model'); + + return Ext.ModelManager.getModel(model); + }, + + getView: function(view) { + view = this.getModuleClassName(view, 'view'); + + return Ext.ClassManager.get(view); + } +}); + +/** + * @class Ext.chart.Callout + * @ignore + */ +Ext.define('Ext.chart.Callout', { + + /* Begin Definitions */ + + /* End Definitions */ + + constructor: function(config) { + if (config.callouts) { + config.callouts.styles = Ext.applyIf(config.callouts.styles || {}, { + color: "#000", + font: "11px Helvetica, sans-serif" + }); + this.callouts = Ext.apply(this.callouts || {}, config.callouts); + this.calloutsArray = []; + } + }, + + renderCallouts: function() { + if (!this.callouts) { + return; + } + + var me = this, + items = me.items, + animate = me.chart.animate, + config = me.callouts, + styles = config.styles, + group = me.calloutsArray, + store = me.chart.store, + len = store.getCount(), + ratio = items.length / len, + previouslyPlacedCallouts = [], + i, + count, + j, + p; + + for (i = 0, count = 0; i < len; i++) { + for (j = 0; j < ratio; j++) { + var item = items[count], + label = group[count], + storeItem = store.getAt(i), + display; + + display = config.filter(storeItem); + + if (!display && !label) { + count++; + continue; + } + + if (!label) { + group[count] = label = me.onCreateCallout(storeItem, item, i, display, j, count); + } + for (p in label) { + if (label[p] && label[p].setAttributes) { + label[p].setAttributes(styles, true); + } + } + if (!display) { + for (p in label) { + if (label[p]) { + if (label[p].setAttributes) { + label[p].setAttributes({ + hidden: true + }, true); + } else if(label[p].setVisible) { + label[p].setVisible(false); + } + } + } + } + config.renderer(label, storeItem); + me.onPlaceCallout(label, storeItem, item, i, display, animate, + j, count, previouslyPlacedCallouts); + previouslyPlacedCallouts.push(label); + count++; + } + } + this.hideCallouts(count); + }, + + onCreateCallout: function(storeItem, item, i, display) { + var me = this, + group = me.calloutsGroup, + config = me.callouts, + styles = config.styles, + width = styles.width, + height = styles.height, + chart = me.chart, + surface = chart.surface, + calloutObj = { + //label: false, + //box: false, + lines: false + }; + + calloutObj.lines = surface.add(Ext.apply({}, + { + type: 'path', + path: 'M0,0', + stroke: me.getLegendColor() || '#555' + }, + styles)); + + if (config.items) { + calloutObj.panel = Ext.create('widget.panel', { + style: "position: absolute;", + width: width, + height: height, + items: config.items, + renderTo: chart.el + }); + } + + return calloutObj; + }, + + hideCallouts: function(index) { + var calloutsArray = this.calloutsArray, + len = calloutsArray.length, + co, + p; + while (len-->index) { + co = calloutsArray[len]; + for (p in co) { + if (co[p]) { + co[p].hide(true); + } + } + } + } +}); + +/** + * @class Ext.draw.CompositeSprite + * @extends Ext.util.MixedCollection + * + * A composite Sprite handles a group of sprites with common methods to a sprite + * such as `hide`, `show`, `setAttributes`. These methods are applied to the set of sprites + * added to the group. + * + * CompositeSprite extends {@link Ext.util.MixedCollection} so you can use the same methods + * in `MixedCollection` to iterate through sprites, add and remove elements, etc. + * + * In order to create a CompositeSprite, one has to provide a handle to the surface where it is + * rendered: + * + * var group = Ext.create('Ext.draw.CompositeSprite', { + * surface: drawComponent.surface + * }); + * + * Then just by using `MixedCollection` methods it's possible to add {@link Ext.draw.Sprite}s: + * + * group.add(sprite1); + * group.add(sprite2); + * group.add(sprite3); + * + * And then apply common Sprite methods to them: + * + * group.setAttributes({ + * fill: '#f00' + * }, true); + */ +Ext.define('Ext.draw.CompositeSprite', { + + /* Begin Definitions */ + + extend: 'Ext.util.MixedCollection', + mixins: { + animate: 'Ext.util.Animate' + }, + + /* End Definitions */ + isCompositeSprite: true, + constructor: function(config) { + var me = this; + + config = config || {}; + Ext.apply(me, config); + + me.addEvents( + 'mousedown', + 'mouseup', + 'mouseover', + 'mouseout', + 'click' + ); + me.id = Ext.id(null, 'ext-sprite-group-'); + me.callParent(); + }, + + // @private + onClick: function(e) { + this.fireEvent('click', e); + }, + + // @private + onMouseUp: function(e) { + this.fireEvent('mouseup', e); + }, + + // @private + onMouseDown: function(e) { + this.fireEvent('mousedown', e); + }, + + // @private + onMouseOver: function(e) { + this.fireEvent('mouseover', e); + }, + + // @private + onMouseOut: function(e) { + this.fireEvent('mouseout', e); + }, + + attachEvents: function(o) { + var me = this; + + o.on({ + scope: me, + mousedown: me.onMouseDown, + mouseup: me.onMouseUp, + mouseover: me.onMouseOver, + mouseout: me.onMouseOut, + click: me.onClick + }); + }, + + /** Add a Sprite to the Group */ + add: function(key, o) { + var result = this.callParent(arguments); + this.attachEvents(result); + return result; + }, + + insert: function(index, key, o) { + return this.callParent(arguments); + }, + + /** Remove a Sprite from the Group */ + remove: function(o) { + var me = this; + + o.un({ + scope: me, + mousedown: me.onMouseDown, + mouseup: me.onMouseUp, + mouseover: me.onMouseOver, + mouseout: me.onMouseOut, + click: me.onClick + }); + me.callParent(arguments); + }, + + /** + * Returns the group bounding box. + * Behaves like {@link Ext.draw.Sprite} getBBox method. + */ + getBBox: function() { + var i = 0, + sprite, + bb, + items = this.items, + len = this.length, + infinity = Infinity, + minX = infinity, + maxHeight = -infinity, + minY = infinity, + maxWidth = -infinity, + maxWidthBBox, maxHeightBBox; + + for (; i < len; i++) { + sprite = items[i]; + if (sprite.el) { + bb = sprite.getBBox(); + minX = Math.min(minX, bb.x); + minY = Math.min(minY, bb.y); + maxHeight = Math.max(maxHeight, bb.height + bb.y); + maxWidth = Math.max(maxWidth, bb.width + bb.x); + } + } + + return { + x: minX, + y: minY, + height: maxHeight - minY, + width: maxWidth - minX + }; + }, + + /** + * Iterates through all sprites calling + * `setAttributes` on each one. For more information + * {@link Ext.draw.Sprite} provides a description of the + * attributes that can be set with this method. + */ + setAttributes: function(attrs, redraw) { + var i = 0, + items = this.items, + len = this.length; + + for (; i < len; i++) { + items[i].setAttributes(attrs, redraw); + } + return this; + }, + + /** + * Hides all sprites. If the first parameter of the method is true + * then a redraw will be forced for each sprite. + */ + hide: function(redraw) { + var i = 0, + items = this.items, + len = this.length; + + for (; i < len; i++) { + items[i].hide(redraw); + } + return this; + }, + + /** + * Shows all sprites. If the first parameter of the method is true + * then a redraw will be forced for each sprite. + */ + show: function(redraw) { + var i = 0, + items = this.items, + len = this.length; + + for (; i < len; i++) { + items[i].show(redraw); + } + return this; + }, + + redraw: function() { + var me = this, + i = 0, + items = me.items, + surface = me.getSurface(), + len = me.length; + + if (surface) { + for (; i < len; i++) { + surface.renderItem(items[i]); + } + } + return me; + }, + + setStyle: function(obj) { + var i = 0, + items = this.items, + len = this.length, + item, el; + + for (; i < len; i++) { + item = items[i]; + el = item.el; + if (el) { + el.setStyle(obj); + } + } + }, + + addCls: function(obj) { + var i = 0, + items = this.items, + surface = this.getSurface(), + len = this.length; + + if (surface) { + for (; i < len; i++) { + surface.addCls(items[i], obj); + } + } + }, + + removeCls: function(obj) { + var i = 0, + items = this.items, + surface = this.getSurface(), + len = this.length; + + if (surface) { + for (; i < len; i++) { + surface.removeCls(items[i], obj); + } + } + }, + + /** + * Grab the surface from the items + * @private + * @return {Ext.draw.Surface} The surface, null if not found + */ + getSurface: function(){ + var first = this.first(); + if (first) { + return first.surface; + } + return null; + }, + + /** + * Destroys the SpriteGroup + */ + destroy: function(){ + var me = this, + surface = me.getSurface(), + item; + + if (surface) { + while (me.getCount() > 0) { + item = me.first(); + me.remove(item); + surface.remove(item); + } + } + me.clearListeners(); + } +}); + +/** + * @class Ext.layout.component.Draw + * @extends Ext.layout.component.Component + * @private + * + */ + +Ext.define('Ext.layout.component.Draw', { + + /* Begin Definitions */ + + alias: 'layout.draw', + + extend: 'Ext.layout.component.Auto', + + /* End Definitions */ + + type: 'draw', + + onLayout : function(width, height) { + this.owner.surface.setSize(width, height); + this.callParent(arguments); + } +}); +/** + * @class Ext.chart.theme.Theme + * @ignore + */ +Ext.define('Ext.chart.theme.Theme', { + + /* Begin Definitions */ + + requires: ['Ext.draw.Color'], + + /* End Definitions */ + + theme: 'Base', + themeAttrs: false, + + initTheme: function(theme) { + var me = this, + themes = Ext.chart.theme, + key, gradients; + if (theme) { + theme = theme.split(':'); + for (key in themes) { + if (key == theme[0]) { + gradients = theme[1] == 'gradients'; + me.themeAttrs = new themes[key]({ + useGradients: gradients + }); + if (gradients) { + me.gradients = me.themeAttrs.gradients; + } + if (me.themeAttrs.background) { + me.background = me.themeAttrs.background; + } + return; + } + } + Ext.Error.raise('No theme found named "' + theme + '"'); + } + } +}, +// This callback is executed right after when the class is created. This scope refers to the newly created class itself +function() { + /* Theme constructor: takes either a complex object with styles like: + + { + axis: { + fill: '#000', + 'stroke-width': 1 + }, + axisLabelTop: { + fill: '#000', + font: '11px Arial' + }, + axisLabelLeft: { + fill: '#000', + font: '11px Arial' + }, + axisLabelRight: { + fill: '#000', + font: '11px Arial' + }, + axisLabelBottom: { + fill: '#000', + font: '11px Arial' + }, + axisTitleTop: { + fill: '#000', + font: '11px Arial' + }, + axisTitleLeft: { + fill: '#000', + font: '11px Arial' + }, + axisTitleRight: { + fill: '#000', + font: '11px Arial' + }, + axisTitleBottom: { + fill: '#000', + font: '11px Arial' + }, + series: { + 'stroke-width': 1 + }, + seriesLabel: { + font: '12px Arial', + fill: '#333' + }, + marker: { + stroke: '#555', + fill: '#000', + radius: 3, + size: 3 + }, + seriesThemes: [{ + fill: '#C6DBEF' + }, { + fill: '#9ECAE1' + }, { + fill: '#6BAED6' + }, { + fill: '#4292C6' + }, { + fill: '#2171B5' + }, { + fill: '#084594' + }], + markerThemes: [{ + fill: '#084594', + type: 'circle' + }, { + fill: '#2171B5', + type: 'cross' + }, { + fill: '#4292C6', + type: 'plus' + }] + } + + ...or also takes just an array of colors and creates the complex object: + + { + colors: ['#aaa', '#bcd', '#eee'] + } + + ...or takes just a base color and makes a theme from it + + { + baseColor: '#bce' + } + + To create a new theme you may add it to the Themes object: + + Ext.chart.theme.MyNewTheme = Ext.extend(Object, { + constructor: function(config) { + Ext.chart.theme.call(this, config, { + baseColor: '#mybasecolor' + }); + } + }); + + //Proposal: + Ext.chart.theme.MyNewTheme = Ext.chart.createTheme('#basecolor'); + + ...and then to use it provide the name of the theme (as a lower case string) in the chart config. + + { + theme: 'mynewtheme' + } + */ + +(function() { + Ext.chart.theme = function(config, base) { + config = config || {}; + var i = 0, l, colors, color, + seriesThemes, markerThemes, + seriesTheme, markerTheme, + key, gradients = [], + midColor, midL; + + if (config.baseColor) { + midColor = Ext.draw.Color.fromString(config.baseColor); + midL = midColor.getHSL()[2]; + if (midL < 0.15) { + midColor = midColor.getLighter(0.3); + } else if (midL < 0.3) { + midColor = midColor.getLighter(0.15); + } else if (midL > 0.85) { + midColor = midColor.getDarker(0.3); + } else if (midL > 0.7) { + midColor = midColor.getDarker(0.15); + } + config.colors = [ midColor.getDarker(0.3).toString(), + midColor.getDarker(0.15).toString(), + midColor.toString(), + midColor.getLighter(0.15).toString(), + midColor.getLighter(0.3).toString()]; + + delete config.baseColor; + } + if (config.colors) { + colors = config.colors.slice(); + markerThemes = base.markerThemes; + seriesThemes = base.seriesThemes; + l = colors.length; + base.colors = colors; + for (; i < l; i++) { + color = colors[i]; + markerTheme = markerThemes[i] || {}; + seriesTheme = seriesThemes[i] || {}; + markerTheme.fill = seriesTheme.fill = markerTheme.stroke = seriesTheme.stroke = color; + markerThemes[i] = markerTheme; + seriesThemes[i] = seriesTheme; + } + base.markerThemes = markerThemes.slice(0, l); + base.seriesThemes = seriesThemes.slice(0, l); + //the user is configuring something in particular (either markers, series or pie slices) + } + for (key in base) { + if (key in config) { + if (Ext.isObject(config[key]) && Ext.isObject(base[key])) { + Ext.apply(base[key], config[key]); + } else { + base[key] = config[key]; + } + } + } + if (config.useGradients) { + colors = base.colors || (function () { + var ans = []; + for (i = 0, seriesThemes = base.seriesThemes, l = seriesThemes.length; i < l; i++) { + ans.push(seriesThemes[i].fill || seriesThemes[i].stroke); + } + return ans; + })(); + for (i = 0, l = colors.length; i < l; i++) { + midColor = Ext.draw.Color.fromString(colors[i]); + if (midColor) { + color = midColor.getDarker(0.1).toString(); + midColor = midColor.toString(); + key = 'theme-' + midColor.substr(1) + '-' + color.substr(1); + gradients.push({ + id: key, + angle: 45, + stops: { + 0: { + color: midColor.toString() + }, + 100: { + color: color.toString() + } + } + }); + colors[i] = 'url(#' + key + ')'; + } + } + base.gradients = gradients; + base.colors = colors; + } + /* + base.axis = Ext.apply(base.axis || {}, config.axis || {}); + base.axisLabel = Ext.apply(base.axisLabel || {}, config.axisLabel || {}); + base.axisTitle = Ext.apply(base.axisTitle || {}, config.axisTitle || {}); + */ + Ext.apply(this, base); + }; +})(); +}); + +/** + * @class Ext.chart.Mask + * + * Defines a mask for a chart's series. + * The 'chart' member must be set prior to rendering. + * + * A Mask can be used to select a certain region in a chart. + * When enabled, the `select` event will be triggered when a + * region is selected by the mask, allowing the user to perform + * other tasks like zooming on that region, etc. + * + * In order to use the mask one has to set the Chart `mask` option to + * `true`, `vertical` or `horizontal`. Then a possible configuration for the + * listener could be: + * + items: { + xtype: 'chart', + animate: true, + store: store1, + mask: 'horizontal', + listeners: { + select: { + fn: function(me, selection) { + me.setZoom(selection); + me.mask.hide(); + } + } + }, + + * In this example we zoom the chart to that particular region. You can also get + * a handle to a mask instance from the chart object. The `chart.mask` element is a + * `Ext.Panel`. + * + * @constructor + */ +Ext.define('Ext.chart.Mask', { + constructor: function(config) { + var me = this; + + me.addEvents('select'); + + if (config) { + Ext.apply(me, config); + } + if (me.mask) { + me.on('afterrender', function() { + //create a mask layer component + var comp = Ext.create('Ext.chart.MaskLayer', { + renderTo: me.el + }); + comp.el.on({ + 'mousemove': function(e) { + me.onMouseMove(e); + }, + 'mouseup': function(e) { + me.resized(e); + } + }); + //create a resize handler for the component + var resizeHandler = Ext.create('Ext.resizer.Resizer', { + el: comp.el, + handles: 'all', + pinned: true + }); + resizeHandler.on({ + 'resize': function(e) { + me.resized(e); + } + }); + comp.initDraggable(); + me.maskType = me.mask; + me.mask = comp; + me.maskSprite = me.surface.add({ + type: 'path', + path: ['M', 0, 0], + zIndex: 1001, + opacity: 0.7, + hidden: true, + stroke: '#444' + }); + }, me, { single: true }); + } + }, + + resized: function(e) { + var me = this, + bbox = me.bbox || me.chartBBox, + x = bbox.x, + y = bbox.y, + width = bbox.width, + height = bbox.height, + box = me.mask.getBox(true), + max = Math.max, + min = Math.min, + staticX = box.x - x, + staticY = box.y - y; + + staticX = max(staticX, x); + staticY = max(staticY, y); + staticX = min(staticX, width); + staticY = min(staticY, height); + box.x = staticX; + box.y = staticY; + me.fireEvent('select', me, box); + }, + + onMouseUp: function(e) { + var me = this, + bbox = me.bbox || me.chartBBox, + sel = me.maskSelection; + me.maskMouseDown = false; + me.mouseDown = false; + if (me.mouseMoved) { + me.onMouseMove(e); + me.mouseMoved = false; + me.fireEvent('select', me, { + x: sel.x - bbox.x, + y: sel.y - bbox.y, + width: sel.width, + height: sel.height + }); + } + }, + + onMouseDown: function(e) { + var me = this; + me.mouseDown = true; + me.mouseMoved = false; + me.maskMouseDown = { + x: e.getPageX() - me.el.getX(), + y: e.getPageY() - me.el.getY() + }; + }, + + onMouseMove: function(e) { + var me = this, + mask = me.maskType, + bbox = me.bbox || me.chartBBox, + x = bbox.x, + y = bbox.y, + math = Math, + floor = math.floor, + abs = math.abs, + min = math.min, + max = math.max, + height = floor(y + bbox.height), + width = floor(x + bbox.width), + posX = e.getPageX(), + posY = e.getPageY(), + staticX = posX - me.el.getX(), + staticY = posY - me.el.getY(), + maskMouseDown = me.maskMouseDown, + path; + + me.mouseMoved = me.mouseDown; + staticX = max(staticX, x); + staticY = max(staticY, y); + staticX = min(staticX, width); + staticY = min(staticY, height); + if (maskMouseDown && me.mouseDown) { + if (mask == 'horizontal') { + staticY = y; + maskMouseDown.y = height; + posY = me.el.getY() + bbox.height + me.insetPadding; + } + else if (mask == 'vertical') { + staticX = x; + maskMouseDown.x = width; + } + width = maskMouseDown.x - staticX; + height = maskMouseDown.y - staticY; + path = ['M', staticX, staticY, 'l', width, 0, 0, height, -width, 0, 'z']; + me.maskSelection = { + x: width > 0 ? staticX : staticX + width, + y: height > 0 ? staticY : staticY + height, + width: abs(width), + height: abs(height) + }; + me.mask.updateBox({ + x: posX - abs(width), + y: posY - abs(height), + width: abs(width), + height: abs(height) + }); + me.mask.show(); + me.maskSprite.setAttributes({ + hidden: true + }, true); + } + else { + if (mask == 'horizontal') { + path = ['M', staticX, y, 'L', staticX, height]; + } + else if (mask == 'vertical') { + path = ['M', x, staticY, 'L', width, staticY]; + } + else { + path = ['M', staticX, y, 'L', staticX, height, 'M', x, staticY, 'L', width, staticY]; + } + me.maskSprite.setAttributes({ + path: path, + fill: me.maskMouseDown ? me.maskSprite.stroke : false, + 'stroke-width': mask === true ? 1 : 3, + hidden: false + }, true); + } + }, + + onMouseLeave: function(e) { + var me = this; + me.mouseMoved = false; + me.mouseDown = false; + me.maskMouseDown = false; + me.mask.hide(); + me.maskSprite.hide(true); + } +}); + +/** + * @class Ext.chart.Navigation + * + * Handles panning and zooming capabilities. + * + * @ignore + */ +Ext.define('Ext.chart.Navigation', { + + constructor: function() { + this.originalStore = this.store; + }, + + //filters the store to the specified interval(s) + setZoom: function(zoomConfig) { + var me = this, + store = me.substore || me.store, + bbox = me.chartBBox, + len = store.getCount(), + from = (zoomConfig.x / bbox.width * len) >> 0, + to = Math.ceil(((zoomConfig.x + zoomConfig.width) / bbox.width * len)), + recFieldsLen, recFields = [], curField, json = [], obj; + + store.each(function(rec, i) { + if (i < from || i > to) { + return; + } + obj = {}; + //get all record field names in a simple array + if (!recFields.length) { + rec.fields.each(function(f) { + recFields.push(f.name); + }); + recFieldsLen = recFields.length; + } + //append record values to an aggregation record + for (i = 0; i < recFieldsLen; i++) { + curField = recFields[i]; + obj[curField] = rec.get(curField); + } + json.push(obj); + }); + me.store = me.substore = Ext.create('Ext.data.JsonStore', { + fields: recFields, + data: json + }); + me.redraw(true); + }, + + restoreZoom: function() { + this.store = this.substore = this.originalStore; + this.redraw(true); + } + +}); +/** + * @class Ext.chart.Shape + * @ignore + */ +Ext.define('Ext.chart.Shape', { + + /* Begin Definitions */ + + singleton: true, + + /* End Definitions */ + + circle: function (surface, opts) { + return surface.add(Ext.apply({ + type: 'circle', + x: opts.x, + y: opts.y, + stroke: null, + radius: opts.radius + }, opts)); + }, + line: function (surface, opts) { + return surface.add(Ext.apply({ + type: 'rect', + x: opts.x - opts.radius, + y: opts.y - opts.radius, + height: 2 * opts.radius, + width: 2 * opts.radius / 5 + }, opts)); + }, + square: function (surface, opts) { + return surface.add(Ext.applyIf({ + type: 'rect', + x: opts.x - opts.radius, + y: opts.y - opts.radius, + height: 2 * opts.radius, + width: 2 * opts.radius, + radius: null + }, opts)); + }, + triangle: function (surface, opts) { + opts.radius *= 1.75; + return surface.add(Ext.apply({ + type: 'path', + stroke: null, + path: "M".concat(opts.x, ",", opts.y, "m0-", opts.radius * 0.58, "l", opts.radius * 0.5, ",", opts.radius * 0.87, "-", opts.radius, ",0z") + }, opts)); + }, + diamond: function (surface, opts) { + var r = opts.radius; + r *= 1.5; + return surface.add(Ext.apply({ + type: 'path', + stroke: null, + path: ["M", opts.x, opts.y - r, "l", r, r, -r, r, -r, -r, r, -r, "z"] + }, opts)); + }, + cross: function (surface, opts) { + var r = opts.radius; + r = r / 1.7; + return surface.add(Ext.apply({ + type: 'path', + stroke: null, + path: "M".concat(opts.x - r, ",", opts.y, "l", [-r, -r, r, -r, r, r, r, -r, r, r, -r, r, r, r, -r, r, -r, -r, -r, r, -r, -r, "z"]) + }, opts)); + }, + plus: function (surface, opts) { + var r = opts.radius / 1.3; + return surface.add(Ext.apply({ + type: 'path', + stroke: null, + path: "M".concat(opts.x - r / 2, ",", opts.y - r / 2, "l", [0, -r, r, 0, 0, r, r, 0, 0, r, -r, 0, 0, r, -r, 0, 0, -r, -r, 0, 0, -r, "z"]) + }, opts)); + }, + arrow: function (surface, opts) { + var r = opts.radius; + return surface.add(Ext.apply({ + type: 'path', + path: "M".concat(opts.x - r * 0.7, ",", opts.y - r * 0.4, "l", [r * 0.6, 0, 0, -r * 0.4, r, r * 0.8, -r, r * 0.8, 0, -r * 0.4, -r * 0.6, 0], "z") + }, opts)); + }, + drop: function (surface, x, y, text, size, angle) { + size = size || 30; + angle = angle || 0; + surface.add({ + type: 'path', + path: ['M', x, y, 'l', size, 0, 'A', size * 0.4, size * 0.4, 0, 1, 0, x + size * 0.7, y - size * 0.7, 'z'], + fill: '#000', + stroke: 'none', + rotate: { + degrees: 22.5 - angle, + x: x, + y: y + } + }); + angle = (angle + 90) * Math.PI / 180; + surface.add({ + type: 'text', + x: x + size * Math.sin(angle) - 10, // Shift here, Not sure why. + y: y + size * Math.cos(angle) + 5, + text: text, + 'font-size': size * 12 / 40, + stroke: 'none', + fill: '#fff' + }); + } +}); +/** + * @class Ext.draw.Surface + * @extends Object + * + * A Surface is an interface to render methods inside a draw {@link Ext.draw.Component}. + * A Surface contains methods to render sprites, get bounding boxes of sprites, add + * sprites to the canvas, initialize other graphic components, etc. One of the most used + * methods for this class is the `add` method, to add Sprites to the surface. + * + * Most of the Surface methods are abstract and they have a concrete implementation + * in VML or SVG engines. + * + * A Surface instance can be accessed as a property of a draw component. For example: + * + * drawComponent.surface.add({ + * type: 'circle', + * fill: '#ffc', + * radius: 100, + * x: 100, + * y: 100 + * }); + * + * The configuration object passed in the `add` method is the same as described in the {@link Ext.draw.Sprite} + * class documentation. + * + * ### Listeners + * + * You can also add event listeners to the surface using the `Observable` listener syntax. Supported events are: + * + * - mousedown + * - mouseup + * - mouseover + * - mouseout + * - mousemove + * - mouseenter + * - mouseleave + * - click + * + * For example: + * + * drawComponent.surface.on({ + * 'mousemove': function() { + * console.log('moving the mouse over the surface'); + * } + * }); + * + * ## Example + * + * drawComponent.surface.add([ + * { + * type: 'circle', + * radius: 10, + * fill: '#f00', + * x: 10, + * y: 10, + * group: 'circles' + * }, + * { + * type: 'circle', + * radius: 10, + * fill: '#0f0', + * x: 50, + * y: 50, + * group: 'circles' + * }, + * { + * type: 'circle', + * radius: 10, + * fill: '#00f', + * x: 100, + * y: 100, + * group: 'circles' + * }, + * { + * type: 'rect', + * radius: 10, + * x: 10, + * y: 10, + * group: 'rectangles' + * }, + * { + * type: 'rect', + * radius: 10, + * x: 50, + * y: 50, + * group: 'rectangles' + * }, + * { + * type: 'rect', + * radius: 10, + * x: 100, + * y: 100, + * group: 'rectangles' + * } + * ]); + * + * // Get references to my groups + * my circles = surface.getGroup('circles'); + * my rectangles = surface.getGroup('rectangles'); + * + * // Animate the circles down + * circles.animate({ + * duration: 1000, + * translate: { + * y: 200 + * } + * }); + * + * // Animate the rectangles across + * rectangles.animate({ + * duration: 1000, + * translate: { + * x: 200 + * } + * }); + */ +Ext.define('Ext.draw.Surface', { + + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: ['Ext.draw.CompositeSprite'], + uses: ['Ext.draw.engine.Svg', 'Ext.draw.engine.Vml'], + + separatorRe: /[, ]+/, + + statics: { + /** + * Create and return a new concrete Surface instance appropriate for the current environment. + * @param {Object} config Initial configuration for the Surface instance + * @param {Array} enginePriority Optional order of implementations to use; the first one that is + * available in the current environment will be used. Defaults to + * ['Svg', 'Vml']. + */ + create: function(config, enginePriority) { + enginePriority = enginePriority || ['Svg', 'Vml']; + + var i = 0, + len = enginePriority.length, + surfaceClass; + + for (; i < len; i++) { + if (Ext.supports[enginePriority[i]]) { + return Ext.create('Ext.draw.engine.' + enginePriority[i], config); + } + } + return false; + } + }, + + /* End Definitions */ + + // @private + availableAttrs: { + blur: 0, + "clip-rect": "0 0 1e9 1e9", + cursor: "default", + cx: 0, + cy: 0, + 'dominant-baseline': 'auto', + fill: "none", + "fill-opacity": 1, + font: '10px "Arial"', + "font-family": '"Arial"', + "font-size": "10", + "font-style": "normal", + "font-weight": 400, + gradient: "", + height: 0, + hidden: false, + href: "http://sencha.com/", + opacity: 1, + path: "M0,0", + radius: 0, + rx: 0, + ry: 0, + scale: "1 1", + src: "", + stroke: "#000", + "stroke-dasharray": "", + "stroke-linecap": "butt", + "stroke-linejoin": "butt", + "stroke-miterlimit": 0, + "stroke-opacity": 1, + "stroke-width": 1, + target: "_blank", + text: "", + "text-anchor": "middle", + title: "Ext Draw", + width: 0, + x: 0, + y: 0, + zIndex: 0 + }, + + /** + * @cfg {Number} height + * The height of this component in pixels (defaults to auto). + * Note to express this dimension as a percentage or offset see {@link Ext.Component#anchor}. + */ + /** + * @cfg {Number} width + * The width of this component in pixels (defaults to auto). + * Note to express this dimension as a percentage or offset see {@link Ext.Component#anchor}. + */ + container: undefined, + height: 352, + width: 512, + x: 0, + y: 0, + + constructor: function(config) { + var me = this; + config = config || {}; + Ext.apply(me, config); + + me.domRef = Ext.getDoc().dom; + + me.customAttributes = {}; + + me.addEvents( + 'mousedown', + 'mouseup', + 'mouseover', + 'mouseout', + 'mousemove', + 'mouseenter', + 'mouseleave', + 'click' + ); + + me.mixins.observable.constructor.call(me); + + me.getId(); + me.initGradients(); + me.initItems(); + if (me.renderTo) { + me.render(me.renderTo); + delete me.renderTo; + } + me.initBackground(config.background); + }, + + // @private called to initialize components in the surface + // this is dependent on the underlying implementation. + initSurface: Ext.emptyFn, + + // @private called to setup the surface to render an item + //this is dependent on the underlying implementation. + renderItem: Ext.emptyFn, + + // @private + renderItems: Ext.emptyFn, + + // @private + setViewBox: Ext.emptyFn, + + /** + * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. + * + * For example: + * + * drawComponent.surface.addCls(sprite, 'x-visible'); + * + * @param {Object} sprite The sprite to add the class to. + * @param {String/Array} className The CSS class to add, or an array of classes + * @method + */ + addCls: Ext.emptyFn, + + /** + * Removes one or more CSS classes from the element. + * + * For example: + * + * drawComponent.surface.removeCls(sprite, 'x-visible'); + * + * @param {Object} sprite The sprite to remove the class from. + * @param {String/Array} className The CSS class to remove, or an array of classes + * @method + */ + removeCls: Ext.emptyFn, + + /** + * Sets CSS style attributes to an element. + * + * For example: + * + * drawComponent.surface.setStyle(sprite, { + * 'cursor': 'pointer' + * }); + * + * @param {Object} sprite The sprite to add, or an array of classes to + * @param {Object} styles An Object with CSS styles. + * @method + */ + setStyle: Ext.emptyFn, + + // @private + initGradients: function() { + var gradients = this.gradients; + if (gradients) { + Ext.each(gradients, this.addGradient, this); + } + }, + + // @private + initItems: function() { + var items = this.items; + this.items = Ext.create('Ext.draw.CompositeSprite'); + this.groups = Ext.create('Ext.draw.CompositeSprite'); + if (items) { + this.add(items); + } + }, + + // @private + initBackground: function(config) { + var me = this, + width = me.width, + height = me.height, + gradientId, gradient, backgroundSprite; + if (config) { + if (config.gradient) { + gradient = config.gradient; + gradientId = gradient.id; + me.addGradient(gradient); + me.background = me.add({ + type: 'rect', + x: 0, + y: 0, + width: width, + height: height, + fill: 'url(#' + gradientId + ')' + }); + } else if (config.fill) { + me.background = me.add({ + type: 'rect', + x: 0, + y: 0, + width: width, + height: height, + fill: config.fill + }); + } else if (config.image) { + me.background = me.add({ + type: 'image', + x: 0, + y: 0, + width: width, + height: height, + src: config.image + }); + } + } + }, + + /** + * Sets the size of the surface. Accomodates the background (if any) to fit the new size too. + * + * For example: + * + * drawComponent.surface.setSize(500, 500); + * + * This method is generally called when also setting the size of the draw Component. + * + * @param {Number} w The new width of the canvas. + * @param {Number} h The new height of the canvas. + */ + setSize: function(w, h) { + if (this.background) { + this.background.setAttributes({ + width: w, + height: h, + hidden: false + }, true); + } + }, + + // @private + scrubAttrs: function(sprite) { + var i, + attrs = {}, + exclude = {}, + sattr = sprite.attr; + for (i in sattr) { + // Narrow down attributes to the main set + if (this.translateAttrs.hasOwnProperty(i)) { + // Translated attr + attrs[this.translateAttrs[i]] = sattr[i]; + exclude[this.translateAttrs[i]] = true; + } + else if (this.availableAttrs.hasOwnProperty(i) && !exclude[i]) { + // Passtrhough attr + attrs[i] = sattr[i]; + } + } + return attrs; + }, + + // @private + onClick: function(e) { + this.processEvent('click', e); + }, + + // @private + onMouseUp: function(e) { + this.processEvent('mouseup', e); + }, + + // @private + onMouseDown: function(e) { + this.processEvent('mousedown', e); + }, + + // @private + onMouseOver: function(e) { + this.processEvent('mouseover', e); + }, + + // @private + onMouseOut: function(e) { + this.processEvent('mouseout', e); + }, + + // @private + onMouseMove: function(e) { + this.fireEvent('mousemove', e); + }, + + // @private + onMouseEnter: Ext.emptyFn, + + // @private + onMouseLeave: Ext.emptyFn, + + /** + * Add a gradient definition to the Surface. Note that in some surface engines, adding + * a gradient via this method will not take effect if the surface has already been rendered. + * Therefore, it is preferred to pass the gradients as an item to the surface config, rather + * than calling this method, especially if the surface is rendered immediately (e.g. due to + * 'renderTo' in its config). For more information on how to create gradients in the Chart + * configuration object please refer to {@link Ext.chart.Chart}. + * + * The gradient object to be passed into this method is composed by: + * + * + * - **id** - string - The unique name of the gradient. + * - **angle** - number, optional - The angle of the gradient in degrees. + * - **stops** - object - An object with numbers as keys (from 0 to 100) and style objects as values. + * + * + For example: + drawComponent.surface.addGradient({ + id: 'gradientId', + angle: 45, + stops: { + 0: { + color: '#555' + }, + 100: { + color: '#ddd' + } + } + }); + * + * @method + */ + addGradient: Ext.emptyFn, + + /** + * Add a Sprite to the surface. See {@link Ext.draw.Sprite} for the configuration object to be passed into this method. + * + * For example: + * + * drawComponent.surface.add({ + * type: 'circle', + * fill: '#ffc', + * radius: 100, + * x: 100, + * y: 100 + * }); + * + */ + add: function() { + var args = Array.prototype.slice.call(arguments), + sprite, + index; + + var hasMultipleArgs = args.length > 1; + if (hasMultipleArgs || Ext.isArray(args[0])) { + var items = hasMultipleArgs ? args : args[0], + results = [], + i, ln, item; + + for (i = 0, ln = items.length; i < ln; i++) { + item = items[i]; + item = this.add(item); + results.push(item); + } + + return results; + } + sprite = this.prepareItems(args[0], true)[0]; + this.normalizeSpriteCollection(sprite); + this.onAdd(sprite); + return sprite; + }, + + /** + * @private + * Insert or move a given sprite into the correct position in the items + * MixedCollection, according to its zIndex. Will be inserted at the end of + * an existing series of sprites with the same or lower zIndex. If the sprite + * is already positioned within an appropriate zIndex group, it will not be moved. + * This ordering can be used by subclasses to assist in rendering the sprites in + * the correct order for proper z-index stacking. + * @param {Ext.draw.Sprite} sprite + * @return {Number} the sprite's new index in the list + */ + normalizeSpriteCollection: function(sprite) { + var items = this.items, + zIndex = sprite.attr.zIndex, + idx = items.indexOf(sprite); + + if (idx < 0 || (idx > 0 && items.getAt(idx - 1).attr.zIndex > zIndex) || + (idx < items.length - 1 && items.getAt(idx + 1).attr.zIndex < zIndex)) { + items.removeAt(idx); + idx = items.findIndexBy(function(otherSprite) { + return otherSprite.attr.zIndex > zIndex; + }); + if (idx < 0) { + idx = items.length; + } + items.insert(idx, sprite); + } + return idx; + }, + + onAdd: function(sprite) { + var group = sprite.group, + draggable = sprite.draggable, + groups, ln, i; + if (group) { + groups = [].concat(group); + ln = groups.length; + for (i = 0; i < ln; i++) { + group = groups[i]; + this.getGroup(group).add(sprite); + } + delete sprite.group; + } + if (draggable) { + sprite.initDraggable(); + } + }, + + /** + * Remove a given sprite from the surface, optionally destroying the sprite in the process. + * You can also call the sprite own `remove` method. + * + * For example: + * + * drawComponent.surface.remove(sprite); + * //or... + * sprite.remove(); + * + * @param {Ext.draw.Sprite} sprite + * @param {Boolean} destroySprite + * @return {Number} the sprite's new index in the list + */ + remove: function(sprite, destroySprite) { + if (sprite) { + this.items.remove(sprite); + this.groups.each(function(item) { + item.remove(sprite); + }); + sprite.onRemove(); + if (destroySprite === true) { + sprite.destroy(); + } + } + }, + + /** + * Remove all sprites from the surface, optionally destroying the sprites in the process. + * + * For example: + * + * drawComponent.surface.removeAll(); + * + * @param {Boolean} destroySprites Whether to destroy all sprites when removing them. + * @return {Number} The sprite's new index in the list. + */ + removeAll: function(destroySprites) { + var items = this.items.items, + ln = items.length, + i; + for (i = ln - 1; i > -1; i--) { + this.remove(items[i], destroySprites); + } + }, + + onRemove: Ext.emptyFn, + + onDestroy: Ext.emptyFn, + + // @private + applyTransformations: function(sprite) { + sprite.bbox.transform = 0; + this.transform(sprite); + + var me = this, + dirty = false, + attr = sprite.attr; + + if (attr.translation.x != null || attr.translation.y != null) { + me.translate(sprite); + dirty = true; + } + if (attr.scaling.x != null || attr.scaling.y != null) { + me.scale(sprite); + dirty = true; + } + if (attr.rotation.degrees != null) { + me.rotate(sprite); + dirty = true; + } + if (dirty) { + sprite.bbox.transform = 0; + this.transform(sprite); + sprite.transformations = []; + } + }, + + // @private + rotate: function (sprite) { + var bbox, + deg = sprite.attr.rotation.degrees, + centerX = sprite.attr.rotation.x, + centerY = sprite.attr.rotation.y; + if (!Ext.isNumber(centerX) || !Ext.isNumber(centerY)) { + bbox = this.getBBox(sprite); + centerX = !Ext.isNumber(centerX) ? bbox.x + bbox.width / 2 : centerX; + centerY = !Ext.isNumber(centerY) ? bbox.y + bbox.height / 2 : centerY; + } + sprite.transformations.push({ + type: "rotate", + degrees: deg, + x: centerX, + y: centerY + }); + }, + + // @private + translate: function(sprite) { + var x = sprite.attr.translation.x || 0, + y = sprite.attr.translation.y || 0; + sprite.transformations.push({ + type: "translate", + x: x, + y: y + }); + }, + + // @private + scale: function(sprite) { + var bbox, + x = sprite.attr.scaling.x || 1, + y = sprite.attr.scaling.y || 1, + centerX = sprite.attr.scaling.centerX, + centerY = sprite.attr.scaling.centerY; + + if (!Ext.isNumber(centerX) || !Ext.isNumber(centerY)) { + bbox = this.getBBox(sprite); + centerX = !Ext.isNumber(centerX) ? bbox.x + bbox.width / 2 : centerX; + centerY = !Ext.isNumber(centerY) ? bbox.y + bbox.height / 2 : centerY; + } + sprite.transformations.push({ + type: "scale", + x: x, + y: y, + centerX: centerX, + centerY: centerY + }); + }, + + // @private + rectPath: function (x, y, w, h, r) { + if (r) { + return [["M", x + r, y], ["l", w - r * 2, 0], ["a", r, r, 0, 0, 1, r, r], ["l", 0, h - r * 2], ["a", r, r, 0, 0, 1, -r, r], ["l", r * 2 - w, 0], ["a", r, r, 0, 0, 1, -r, -r], ["l", 0, r * 2 - h], ["a", r, r, 0, 0, 1, r, -r], ["z"]]; + } + return [["M", x, y], ["l", w, 0], ["l", 0, h], ["l", -w, 0], ["z"]]; + }, + + // @private + ellipsePath: function (x, y, rx, ry) { + if (ry == null) { + ry = rx; + } + return [["M", x, y], ["m", 0, -ry], ["a", rx, ry, 0, 1, 1, 0, 2 * ry], ["a", rx, ry, 0, 1, 1, 0, -2 * ry], ["z"]]; + }, + + // @private + getPathpath: function (el) { + return el.attr.path; + }, + + // @private + getPathcircle: function (el) { + var a = el.attr; + return this.ellipsePath(a.x, a.y, a.radius, a.radius); + }, + + // @private + getPathellipse: function (el) { + var a = el.attr; + return this.ellipsePath(a.x, a.y, + a.radiusX || (a.width / 2) || 0, + a.radiusY || (a.height / 2) || 0); + }, + + // @private + getPathrect: function (el) { + var a = el.attr; + return this.rectPath(a.x, a.y, a.width, a.height, a.r); + }, + + // @private + getPathimage: function (el) { + var a = el.attr; + return this.rectPath(a.x || 0, a.y || 0, a.width, a.height); + }, + + // @private + getPathtext: function (el) { + var bbox = this.getBBoxText(el); + return this.rectPath(bbox.x, bbox.y, bbox.width, bbox.height); + }, + + createGroup: function(id) { + var group = this.groups.get(id); + if (!group) { + group = Ext.create('Ext.draw.CompositeSprite', { + surface: this + }); + group.id = id || Ext.id(null, 'ext-surface-group-'); + this.groups.add(group); + } + return group; + }, + + /** + * Returns a new group or an existent group associated with the current surface. + * The group returned is a {@link Ext.draw.CompositeSprite} group. + * + * For example: + * + * var spriteGroup = drawComponent.surface.getGroup('someGroupId'); + * + * @param {String} id The unique identifier of the group. + * @return {Object} The {@link Ext.draw.CompositeSprite}. + */ + getGroup: function(id) { + if (typeof id == "string") { + var group = this.groups.get(id); + if (!group) { + group = this.createGroup(id); + } + } else { + group = id; + } + return group; + }, + + // @private + prepareItems: function(items, applyDefaults) { + items = [].concat(items); + // Make sure defaults are applied and item is initialized + var item, i, ln; + for (i = 0, ln = items.length; i < ln; i++) { + item = items[i]; + if (!(item instanceof Ext.draw.Sprite)) { + // Temporary, just take in configs... + item.surface = this; + items[i] = this.createItem(item); + } else { + item.surface = this; + } + } + return items; + }, + + /** + * Changes the text in the sprite element. The sprite must be a `text` sprite. + * This method can also be called from {@link Ext.draw.Sprite}. + * + * For example: + * + * var spriteGroup = drawComponent.surface.setText(sprite, 'my new text'); + * + * @param {Object} sprite The Sprite to change the text. + * @param {String} text The new text to be set. + * @method + */ + setText: Ext.emptyFn, + + //@private Creates an item and appends it to the surface. Called + //as an internal method when calling `add`. + createItem: Ext.emptyFn, + + /** + * Retrieves the id of this component. + * Will autogenerate an id if one has not already been set. + */ + getId: function() { + return this.id || (this.id = Ext.id(null, 'ext-surface-')); + }, + + /** + * Destroys the surface. This is done by removing all components from it and + * also removing its reference to a DOM element. + * + * For example: + * + * drawComponent.surface.destroy(); + */ + destroy: function() { + delete this.domRef; + this.removeAll(); + } +}); +/** + * @class Ext.draw.Component + * @extends Ext.Component + * + * The Draw Component is a surface in which sprites can be rendered. The Draw Component + * manages and holds a `Surface` instance: an interface that has + * an SVG or VML implementation depending on the browser capabilities and where + * Sprites can be appended. + * {@img Ext.draw.Component/Ext.draw.Component.png Ext.draw.Component component} + * One way to create a draw component is: + * + * var drawComponent = Ext.create('Ext.draw.Component', { + * viewBox: false, + * items: [{ + * type: 'circle', + * fill: '#79BB3F', + * radius: 100, + * x: 100, + * y: 100 + * }] + * }); + * + * Ext.create('Ext.Window', { + * width: 215, + * height: 235, + * layout: 'fit', + * items: [drawComponent] + * }).show(); + * + * In this case we created a draw component and added a sprite to it. + * The *type* of the sprite is *circle* so if you run this code you'll see a yellow-ish + * circle in a Window. When setting `viewBox` to `false` we are responsible for setting the object's position and + * dimensions accordingly. + * + * You can also add sprites by using the surface's add method: + * + * drawComponent.surface.add({ + * type: 'circle', + * fill: '#79BB3F', + * radius: 100, + * x: 100, + * y: 100 + * }); + * + * For more information on Sprites, the core elements added to a draw component's surface, + * refer to the Ext.draw.Sprite documentation. + */ +Ext.define('Ext.draw.Component', { + + /* Begin Definitions */ + + alias: 'widget.draw', + + extend: 'Ext.Component', + + requires: [ + 'Ext.draw.Surface', + 'Ext.layout.component.Draw' + ], + + /* End Definitions */ + + /** + * @cfg {Array} enginePriority + * Defines the priority order for which Surface implementation to use. The first + * one supported by the current environment will be used. + */ + enginePriority: ['Svg', 'Vml'], + + baseCls: Ext.baseCSSPrefix + 'surface', + + componentLayout: 'draw', + + /** + * @cfg {Boolean} viewBox + * Turn on view box support which will scale and position items in the draw component to fit to the component while + * maintaining aspect ratio. Note that this scaling can override other sizing settings on yor items. Defaults to true. + */ + viewBox: true, + + /** + * @cfg {Boolean} autoSize + * Turn on autoSize support which will set the bounding div's size to the natural size of the contents. Defaults to false. + */ + autoSize: false, + + /** + * @cfg {Array} gradients (optional) Define a set of gradients that can be used as `fill` property in sprites. + * The gradients array is an array of objects with the following properties: + * + *
+ *
id - string - The unique name of the gradient.
+ *
angle - number, optional - The angle of the gradient in degrees.
+ *
stops - object - An object with numbers as keys (from 0 to 100) and style objects + * as values
+ *
+ * + + For example: + +
+ gradients: [{ + id: 'gradientId', + angle: 45, + stops: { + 0: { + color: '#555' + }, + 100: { + color: '#ddd' + } + } + }, { + id: 'gradientId2', + angle: 0, + stops: { + 0: { + color: '#590' + }, + 20: { + color: '#599' + }, + 100: { + color: '#ddd' + } + } + }] +
+ + Then the sprites can use `gradientId` and `gradientId2` by setting the fill attributes to those ids, for example: + +
+ sprite.setAttributes({ + fill: 'url(#gradientId)' + }, true); +
+ + */ + + initComponent: function() { + this.callParent(arguments); + + this.addEvents( + 'mousedown', + 'mouseup', + 'mousemove', + 'mouseenter', + 'mouseleave', + 'click' + ); + }, + + /** + * @private + * + * Create the Surface on initial render + */ + onRender: function() { + var me = this, + viewBox = me.viewBox, + autoSize = me.autoSize, + bbox, items, width, height, x, y; + me.callParent(arguments); + + me.createSurface(); + + items = me.surface.items; + + if (viewBox || autoSize) { + bbox = items.getBBox(); + width = bbox.width; + height = bbox.height; + x = bbox.x; + y = bbox.y; + if (me.viewBox) { + me.surface.setViewBox(x, y, width, height); + } + else { + // AutoSized + me.autoSizeSurface(); + } + } + }, + + //@private + autoSizeSurface: function() { + var me = this, + items = me.surface.items, + bbox = items.getBBox(), + width = bbox.width, + height = bbox.height; + items.setAttributes({ + translate: { + x: -bbox.x, + //Opera has a slight offset in the y axis. + y: -bbox.y + (+Ext.isOpera) + } + }, true); + if (me.rendered) { + me.setSize(width, height); + me.surface.setSize(width, height); + } + else { + me.surface.setSize(width, height); + } + me.el.setSize(width, height); + }, + + /** + * Create the Surface instance. Resolves the correct Surface implementation to + * instantiate based on the 'enginePriority' config. Once the Surface instance is + * created you can use the handle to that instance to add sprites. For example: + * +
+ drawComponent.surface.add(sprite); +
+ */ + createSurface: function() { + var surface = Ext.draw.Surface.create(Ext.apply({}, { + width: this.width, + height: this.height, + renderTo: this.el + }, this.initialConfig)); + this.surface = surface; + + function refire(eventName) { + return function(e) { + this.fireEvent(eventName, e); + }; + } + + surface.on({ + scope: this, + mouseup: refire('mouseup'), + mousedown: refire('mousedown'), + mousemove: refire('mousemove'), + mouseenter: refire('mouseenter'), + mouseleave: refire('mouseleave'), + click: refire('click') + }); + }, + + + /** + * @private + * + * Clean up the Surface instance on component destruction + */ + onDestroy: function() { + var surface = this.surface; + if (surface) { + surface.destroy(); + } + this.callParent(arguments); + } + +}); + +/** + * @class Ext.chart.LegendItem + * @extends Ext.draw.CompositeSprite + * A single item of a legend (marker plus label) + * @constructor + */ +Ext.define('Ext.chart.LegendItem', { + + /* Begin Definitions */ + + extend: 'Ext.draw.CompositeSprite', + + requires: ['Ext.chart.Shape'], + + /* End Definitions */ + + // Position of the item, relative to the upper-left corner of the legend box + x: 0, + y: 0, + zIndex: 500, + + constructor: function(config) { + this.callParent(arguments); + this.createLegend(config); + }, + + /** + * Creates all the individual sprites for this legend item + */ + createLegend: function(config) { + var me = this, + index = config.yFieldIndex, + series = me.series, + seriesType = series.type, + idx = me.yFieldIndex, + legend = me.legend, + surface = me.surface, + refX = legend.x + me.x, + refY = legend.y + me.y, + bbox, z = me.zIndex, + markerConfig, label, mask, + radius, toggle = false, + seriesStyle = Ext.apply(series.seriesStyle, series.style); + + function getSeriesProp(name) { + var val = series[name]; + return (Ext.isArray(val) ? val[idx] : val); + } + + label = me.add('label', surface.add({ + type: 'text', + x: 20, + y: 0, + zIndex: z || 0, + font: legend.labelFont, + text: getSeriesProp('title') || getSeriesProp('yField') + })); + + // Line series - display as short line with optional marker in the middle + if (seriesType === 'line' || seriesType === 'scatter') { + if(seriesType === 'line') { + me.add('line', surface.add({ + type: 'path', + path: 'M0.5,0.5L16.5,0.5', + zIndex: z, + "stroke-width": series.lineWidth, + "stroke-linejoin": "round", + "stroke-dasharray": series.dash, + stroke: seriesStyle.stroke || '#000', + style: { + cursor: 'pointer' + } + })); + } + if (series.showMarkers || seriesType === 'scatter') { + markerConfig = Ext.apply(series.markerStyle, series.markerConfig || {}); + me.add('marker', Ext.chart.Shape[markerConfig.type](surface, { + fill: markerConfig.fill, + x: 8.5, + y: 0.5, + zIndex: z, + radius: markerConfig.radius || markerConfig.size, + style: { + cursor: 'pointer' + } + })); + } + } + // All other series types - display as filled box + else { + me.add('box', surface.add({ + type: 'rect', + zIndex: z, + x: 0, + y: 0, + width: 12, + height: 12, + fill: series.getLegendColor(index), + style: { + cursor: 'pointer' + } + })); + } + + me.setAttributes({ + hidden: false + }, true); + + bbox = me.getBBox(); + + mask = me.add('mask', surface.add({ + type: 'rect', + x: bbox.x, + y: bbox.y, + width: bbox.width || 20, + height: bbox.height || 20, + zIndex: (z || 0) + 1000, + fill: '#f00', + opacity: 0, + style: { + 'cursor': 'pointer' + } + })); + + //add toggle listener + me.on('mouseover', function() { + label.setStyle({ + 'font-weight': 'bold' + }); + mask.setStyle({ + 'cursor': 'pointer' + }); + series._index = index; + series.highlightItem(); + }, me); + + me.on('mouseout', function() { + label.setStyle({ + 'font-weight': 'normal' + }); + series._index = index; + series.unHighlightItem(); + }, me); + + if (!series.visibleInLegend(index)) { + toggle = true; + label.setAttributes({ + opacity: 0.5 + }, true); + } + + me.on('mousedown', function() { + if (!toggle) { + series.hideAll(); + label.setAttributes({ + opacity: 0.5 + }, true); + } else { + series.showAll(); + label.setAttributes({ + opacity: 1 + }, true); + } + toggle = !toggle; + }, me); + me.updatePosition({x:0, y:0}); //Relative to 0,0 at first so that the bbox is calculated correctly + }, + + /** + * Update the positions of all this item's sprites to match the root position + * of the legend box. + * @param {Object} relativeTo (optional) If specified, this object's 'x' and 'y' values will be used + * as the reference point for the relative positioning. Defaults to the Legend. + */ + updatePosition: function(relativeTo) { + var me = this, + items = me.items, + ln = items.length, + i = 0, + item; + if (!relativeTo) { + relativeTo = me.legend; + } + for (; i < ln; i++) { + item = items[i]; + switch (item.type) { + case 'text': + item.setAttributes({ + x: 20 + relativeTo.x + me.x, + y: relativeTo.y + me.y + }, true); + break; + case 'rect': + item.setAttributes({ + translate: { + x: relativeTo.x + me.x, + y: relativeTo.y + me.y - 6 + } + }, true); + break; + default: + item.setAttributes({ + translate: { + x: relativeTo.x + me.x, + y: relativeTo.y + me.y + } + }, true); + } + } + } +}); +/** + * @class Ext.chart.Legend + * + * Defines a legend for a chart's series. + * The 'chart' member must be set prior to rendering. + * The legend class displays a list of legend items each of them related with a + * series being rendered. In order to render the legend item of the proper series + * the series configuration object must have `showInSeries` set to true. + * + * The legend configuration object accepts a `position` as parameter. + * The `position` parameter can be `left`, `right` + * `top` or `bottom`. For example: + * + * legend: { + * position: 'right' + * }, + * + * Full example: +
+ var store = Ext.create('Ext.data.JsonStore', { + fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + data: [ + {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + ] + }); + + Ext.create('Ext.chart.Chart', { + renderTo: Ext.getBody(), + width: 500, + height: 300, + animate: true, + store: store, + shadow: true, + theme: 'Category1', + legend: { + position: 'top' + }, + axes: [{ + type: 'Numeric', + grid: true, + position: 'left', + fields: ['data1', 'data2', 'data3', 'data4', 'data5'], + title: 'Sample Values', + grid: { + odd: { + opacity: 1, + fill: '#ddd', + stroke: '#bbb', + 'stroke-width': 1 + } + }, + minimum: 0, + adjustMinimumByMajorUnit: 0 + }, { + type: 'Category', + position: 'bottom', + fields: ['name'], + title: 'Sample Metrics', + grid: true, + label: { + rotate: { + degrees: 315 + } + } + }], + series: [{ + type: 'area', + highlight: false, + axis: 'left', + xField: 'name', + yField: ['data1', 'data2', 'data3', 'data4', 'data5'], + style: { + opacity: 0.93 + } + }] + }); +
+ * + * @constructor + */ +Ext.define('Ext.chart.Legend', { + + /* Begin Definitions */ + + requires: ['Ext.chart.LegendItem'], + + /* End Definitions */ + + /** + * @cfg {Boolean} visible + * Whether or not the legend should be displayed. + */ + visible: true, + + /** + * @cfg {String} position + * The position of the legend in relation to the chart. One of: "top", + * "bottom", "left", "right", or "float". If set to "float", then the legend + * box will be positioned at the point denoted by the x and y parameters. + */ + position: 'bottom', + + /** + * @cfg {Number} x + * X-position of the legend box. Used directly if position is set to "float", otherwise + * it will be calculated dynamically. + */ + x: 0, + + /** + * @cfg {Number} y + * Y-position of the legend box. Used directly if position is set to "float", otherwise + * it will be calculated dynamically. + */ + y: 0, + + /** + * @cfg {String} labelFont + * Font to be used for the legend labels, eg '12px Helvetica' + */ + labelFont: '12px Helvetica, sans-serif', + + /** + * @cfg {String} boxStroke + * Style of the stroke for the legend box + */ + boxStroke: '#000', + + /** + * @cfg {String} boxStrokeWidth + * Width of the stroke for the legend box + */ + boxStrokeWidth: 1, + + /** + * @cfg {String} boxFill + * Fill style for the legend box + */ + boxFill: '#FFF', + + /** + * @cfg {Number} itemSpacing + * Amount of space between legend items + */ + itemSpacing: 10, + + /** + * @cfg {Number} padding + * Amount of padding between the legend box's border and its items + */ + padding: 5, + + // @private + width: 0, + // @private + height: 0, + + /** + * @cfg {Number} boxZIndex + * Sets the z-index for the legend. Defaults to 100. + */ + boxZIndex: 100, + + constructor: function(config) { + var me = this; + if (config) { + Ext.apply(me, config); + } + me.items = []; + /** + * Whether the legend box is oriented vertically, i.e. if it is on the left or right side or floating. + * @type {Boolean} + */ + me.isVertical = ("left|right|float".indexOf(me.position) !== -1); + + // cache these here since they may get modified later on + me.origX = me.x; + me.origY = me.y; + }, + + /** + * @private Create all the sprites for the legend + */ + create: function() { + var me = this; + me.createItems(); + if (!me.created && me.isDisplayed()) { + me.createBox(); + me.created = true; + + // Listen for changes to series titles to trigger regeneration of the legend + me.chart.series.each(function(series) { + series.on('titlechange', function() { + me.create(); + me.updatePosition(); + }); + }); + } + }, + + /** + * @private Determine whether the legend should be displayed. Looks at the legend's 'visible' config, + * and also the 'showInLegend' config for each of the series. + */ + isDisplayed: function() { + return this.visible && this.chart.series.findIndex('showInLegend', true) !== -1; + }, + + /** + * @private Create the series markers and labels + */ + createItems: function() { + var me = this, + chart = me.chart, + surface = chart.surface, + items = me.items, + padding = me.padding, + itemSpacing = me.itemSpacing, + spacingOffset = 2, + maxWidth = 0, + maxHeight = 0, + totalWidth = 0, + totalHeight = 0, + vertical = me.isVertical, + math = Math, + mfloor = math.floor, + mmax = math.max, + index = 0, + i = 0, + len = items ? items.length : 0, + x, y, spacing, item, bbox, height, width; + + //remove all legend items + if (len) { + for (; i < len; i++) { + items[i].destroy(); + } + } + //empty array + items.length = []; + // Create all the item labels, collecting their dimensions and positioning each one + // properly in relation to the previous item + chart.series.each(function(series, i) { + if (series.showInLegend) { + Ext.each([].concat(series.yField), function(field, j) { + item = Ext.create('Ext.chart.LegendItem', { + legend: this, + series: series, + surface: chart.surface, + yFieldIndex: j + }); + bbox = item.getBBox(); + + //always measure from x=0, since not all markers go all the way to the left + width = bbox.width; + height = bbox.height; + + if (i + j === 0) { + spacing = vertical ? padding + height / 2 : padding; + } + else { + spacing = itemSpacing / (vertical ? 2 : 1); + } + // Set the item's position relative to the legend box + item.x = mfloor(vertical ? padding : totalWidth + spacing); + item.y = mfloor(vertical ? totalHeight + spacing : padding + height / 2); + + // Collect cumulative dimensions + totalWidth += width + spacing; + totalHeight += height + spacing; + maxWidth = mmax(maxWidth, width); + maxHeight = mmax(maxHeight, height); + + items.push(item); + }, this); + } + }, me); + + // Store the collected dimensions for later + me.width = mfloor((vertical ? maxWidth : totalWidth) + padding * 2); + if (vertical && items.length === 1) { + spacingOffset = 1; + } + me.height = mfloor((vertical ? totalHeight - spacingOffset * spacing : maxHeight) + (padding * 2)); + me.itemHeight = maxHeight; + }, + + /** + * @private Get the bounds for the legend's outer box + */ + getBBox: function() { + var me = this; + return { + x: Math.round(me.x) - me.boxStrokeWidth / 2, + y: Math.round(me.y) - me.boxStrokeWidth / 2, + width: me.width, + height: me.height + }; + }, + + /** + * @private Create the box around the legend items + */ + createBox: function() { + var me = this, + box = me.boxSprite = me.chart.surface.add(Ext.apply({ + type: 'rect', + stroke: me.boxStroke, + "stroke-width": me.boxStrokeWidth, + fill: me.boxFill, + zIndex: me.boxZIndex + }, me.getBBox())); + box.redraw(); + }, + + /** + * @private Update the position of all the legend's sprites to match its current x/y values + */ + updatePosition: function() { + var me = this, + x, y, + legendWidth = me.width, + legendHeight = me.height, + padding = me.padding, + chart = me.chart, + chartBBox = chart.chartBBox, + insets = chart.insetPadding, + chartWidth = chartBBox.width - (insets * 2), + chartHeight = chartBBox.height - (insets * 2), + chartX = chartBBox.x + insets, + chartY = chartBBox.y + insets, + surface = chart.surface, + mfloor = Math.floor; + + if (me.isDisplayed()) { + // Find the position based on the dimensions + switch(me.position) { + case "left": + x = insets; + y = mfloor(chartY + chartHeight / 2 - legendHeight / 2); + break; + case "right": + x = mfloor(surface.width - legendWidth) - insets; + y = mfloor(chartY + chartHeight / 2 - legendHeight / 2); + break; + case "top": + x = mfloor(chartX + chartWidth / 2 - legendWidth / 2); + y = insets; + break; + case "bottom": + x = mfloor(chartX + chartWidth / 2 - legendWidth / 2); + y = mfloor(surface.height - legendHeight) - insets; + break; + default: + x = mfloor(me.origX) + insets; + y = mfloor(me.origY) + insets; + } + me.x = x; + me.y = y; + + // Update the position of each item + Ext.each(me.items, function(item) { + item.updatePosition(); + }); + // Update the position of the outer box + me.boxSprite.setAttributes(me.getBBox(), true); + } + } +}); +/** + * @class Ext.chart.Chart + * @extends Ext.draw.Component + * + * The Ext.chart package provides the capability to visualize data. + * Each chart binds directly to an Ext.data.Store enabling automatic updates of the chart. + * A chart configuration object has some overall styling options as well as an array of axes + * and series. A chart instance example could look like: + * +
+ Ext.create('Ext.chart.Chart', { + renderTo: Ext.getBody(), + width: 800, + height: 600, + animate: true, + store: store1, + shadow: true, + theme: 'Category1', + legend: { + position: 'right' + }, + axes: [ ...some axes options... ], + series: [ ...some series options... ] + }); +
+ * + * In this example we set the `width` and `height` of the chart, we decide whether our series are + * animated or not and we select a store to be bound to the chart. We also turn on shadows for all series, + * select a color theme `Category1` for coloring the series, set the legend to the right part of the chart and + * then tell the chart to render itself in the body element of the document. For more information about the axes and + * series configurations please check the documentation of each series (Line, Bar, Pie, etc). + * + * @xtype chart + */ + +Ext.define('Ext.chart.Chart', { + + /* Begin Definitions */ + + alias: 'widget.chart', + + extend: 'Ext.draw.Component', + + mixins: { + themeManager: 'Ext.chart.theme.Theme', + mask: 'Ext.chart.Mask', + navigation: 'Ext.chart.Navigation' + }, + + requires: [ + 'Ext.util.MixedCollection', + 'Ext.data.StoreManager', + 'Ext.chart.Legend', + 'Ext.util.DelayedTask' + ], + + /* End Definitions */ + + // @private + viewBox: false, + + /** + * @cfg {String} theme (optional) The name of the theme to be used. A theme defines the colors and + * other visual displays of tick marks on axis, text, title text, line colors, marker colors and styles, etc. + * Possible theme values are 'Base', 'Green', 'Sky', 'Red', 'Purple', 'Blue', 'Yellow' and also six category themes + * 'Category1' to 'Category6'. Default value is 'Base'. + */ + + /** + * @cfg {Boolean/Object} animate (optional) true for the default animation (easing: 'ease' and duration: 500) + * or a standard animation config object to be used for default chart animations. Defaults to false. + */ + animate: false, + + /** + * @cfg {Boolean/Object} legend (optional) true for the default legend display or a legend config object. Defaults to false. + */ + legend: false, + + /** + * @cfg {integer} insetPadding (optional) Set the amount of inset padding in pixels for the chart. Defaults to 10. + */ + insetPadding: 10, + + /** + * @cfg {Array} enginePriority + * Defines the priority order for which Surface implementation to use. The first + * one supported by the current environment will be used. + */ + enginePriority: ['Svg', 'Vml'], + + /** + * @cfg {Object|Boolean} background (optional) Set the chart background. This can be a gradient object, image, or color. + * Defaults to false for no background. + * + * For example, if `background` were to be a color we could set the object as + * +
+ background: { + //color string + fill: '#ccc' + } +
+ + You can specify an image by using: + +
+ background: { + image: 'http://path.to.image/' + } +
+ + Also you can specify a gradient by using the gradient object syntax: + +
+ background: { + gradient: { + id: 'gradientId', + angle: 45, + stops: { + 0: { + color: '#555' + } + 100: { + color: '#ddd' + } + } + } + } +
+ */ + background: false, + + /** + * @cfg {Array} gradients (optional) Define a set of gradients that can be used as `fill` property in sprites. + * The gradients array is an array of objects with the following properties: + * + *
+ *
id - string - The unique name of the gradient.
+ *
angle - number, optional - The angle of the gradient in degrees.
+ *
stops - object - An object with numbers as keys (from 0 to 100) and style objects + * as values
+ *
+ * + + For example: + +
+ gradients: [{ + id: 'gradientId', + angle: 45, + stops: { + 0: { + color: '#555' + }, + 100: { + color: '#ddd' + } + } + }, { + id: 'gradientId2', + angle: 0, + stops: { + 0: { + color: '#590' + }, + 20: { + color: '#599' + }, + 100: { + color: '#ddd' + } + } + }] +
+ + Then the sprites can use `gradientId` and `gradientId2` by setting the fill attributes to those ids, for example: + +
+ sprite.setAttributes({ + fill: 'url(#gradientId)' + }, true); +
+ + */ + + + constructor: function(config) { + var me = this, + defaultAnim; + me.initTheme(config.theme || me.theme); + if (me.gradients) { + Ext.apply(config, { gradients: me.gradients }); + } + if (me.background) { + Ext.apply(config, { background: me.background }); + } + if (config.animate) { + defaultAnim = { + easing: 'ease', + duration: 500 + }; + if (Ext.isObject(config.animate)) { + config.animate = Ext.applyIf(config.animate, defaultAnim); + } + else { + config.animate = defaultAnim; + } + } + me.mixins.mask.constructor.call(me, config); + me.mixins.navigation.constructor.call(me, config); + me.callParent([config]); + }, + + initComponent: function() { + var me = this, + axes, + series; + me.callParent(); + me.addEvents( + 'itemmousedown', + 'itemmouseup', + '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' + ); + Ext.applyIf(me, { + zoom: { + width: 1, + height: 1, + x: 0, + y: 0 + } + }); + me.maxGutter = [0, 0]; + me.store = Ext.data.StoreManager.lookup(me.store); + axes = me.axes; + me.axes = Ext.create('Ext.util.MixedCollection', false, function(a) { return a.position; }); + if (axes) { + me.axes.addAll(axes); + } + series = me.series; + me.series = Ext.create('Ext.util.MixedCollection', false, function(a) { return a.seriesId || (a.seriesId = Ext.id(null, 'ext-chart-series-')); }); + if (series) { + me.series.addAll(series); + } + if (me.legend !== false) { + me.legend = Ext.create('Ext.chart.Legend', Ext.applyIf({chart:me}, me.legend)); + } + + me.on({ + mousemove: me.onMouseMove, + mouseleave: me.onMouseLeave, + mousedown: me.onMouseDown, + mouseup: me.onMouseUp, + scope: me + }); + }, + + // @private overrides the component method to set the correct dimensions to the chart. + afterComponentLayout: function(width, height) { + var me = this; + if (Ext.isNumber(width) && Ext.isNumber(height)) { + me.curWidth = width; + me.curHeight = height; + me.redraw(true); + } + this.callParent(arguments); + }, + + /** + * Redraw the chart. If animations are set this will animate the chart too. + * @cfg {boolean} resize Optional flag which changes the default origin points of the chart for animations. + */ + redraw: function(resize) { + var me = this, + chartBBox = me.chartBBox = { + x: 0, + y: 0, + height: me.curHeight, + width: me.curWidth + }, + legend = me.legend; + me.surface.setSize(chartBBox.width, chartBBox.height); + // Instantiate Series and Axes + me.series.each(me.initializeSeries, me); + me.axes.each(me.initializeAxis, me); + //process all views (aggregated data etc) on stores + //before rendering. + me.axes.each(function(axis) { + axis.processView(); + }); + me.axes.each(function(axis) { + axis.drawAxis(true); + }); + + // Create legend if not already created + if (legend !== false) { + legend.create(); + } + + // Place axes properly, including influence from each other + me.alignAxes(); + + // Reposition legend based on new axis alignment + if (me.legend !== false) { + legend.updatePosition(); + } + + // Find the max gutter + me.getMaxGutter(); + + // Draw axes and series + me.resizing = !!resize; + + me.axes.each(me.drawAxis, me); + me.series.each(me.drawCharts, me); + me.resizing = false; + }, + + // @private set the store after rendering the chart. + afterRender: function() { + var ref, + me = this; + this.callParent(); + + if (me.categoryNames) { + me.setCategoryNames(me.categoryNames); + } + + if (me.tipRenderer) { + ref = me.getFunctionRef(me.tipRenderer); + me.setTipRenderer(ref.fn, ref.scope); + } + me.bindStore(me.store, true); + me.refresh(); + }, + + // @private get x and y position of the mouse cursor. + getEventXY: function(e) { + var me = this, + box = this.surface.getRegion(), + pageXY = e.getXY(), + x = pageXY[0] - box.left, + y = pageXY[1] - box.top; + return [x, y]; + }, + + // @private wrap the mouse down position to delegate the event to the series. + onClick: function(e) { + var me = this, + position = me.getEventXY(e), + item; + + // Ask each series if it has an item corresponding to (not necessarily exactly + // on top of) the current mouse coords. Fire itemclick event. + me.series.each(function(series) { + if (Ext.draw.Draw.withinBox(position[0], position[1], series.bbox)) { + if (series.getItemForPoint) { + item = series.getItemForPoint(position[0], position[1]); + if (item) { + series.fireEvent('itemclick', item); + } + } + } + }, me); + }, + + // @private wrap the mouse down position to delegate the event to the series. + onMouseDown: function(e) { + var me = this, + position = me.getEventXY(e), + item; + + if (me.mask) { + me.mixins.mask.onMouseDown.call(me, e); + } + // Ask each series if it has an item corresponding to (not necessarily exactly + // on top of) the current mouse coords. Fire mousedown event. + me.series.each(function(series) { + if (Ext.draw.Draw.withinBox(position[0], position[1], series.bbox)) { + if (series.getItemForPoint) { + item = series.getItemForPoint(position[0], position[1]); + if (item) { + series.fireEvent('itemmousedown', item); + } + } + } + }, me); + }, + + // @private wrap the mouse up event to delegate it to the series. + onMouseUp: function(e) { + var me = this, + position = me.getEventXY(e), + item; + + if (me.mask) { + me.mixins.mask.onMouseUp.call(me, e); + } + // Ask each series if it has an item corresponding to (not necessarily exactly + // on top of) the current mouse coords. Fire mousedown event. + me.series.each(function(series) { + if (Ext.draw.Draw.withinBox(position[0], position[1], series.bbox)) { + if (series.getItemForPoint) { + item = series.getItemForPoint(position[0], position[1]); + if (item) { + series.fireEvent('itemmouseup', item); + } + } + } + }, me); + }, + + // @private wrap the mouse move event so it can be delegated to the series. + onMouseMove: function(e) { + var me = this, + position = me.getEventXY(e), + item, last, storeItem, storeField; + + if (me.mask) { + me.mixins.mask.onMouseMove.call(me, e); + } + // Ask each series if it has an item corresponding to (not necessarily exactly + // on top of) the current mouse coords. Fire itemmouseover/out events. + me.series.each(function(series) { + if (Ext.draw.Draw.withinBox(position[0], position[1], series.bbox)) { + if (series.getItemForPoint) { + item = series.getItemForPoint(position[0], position[1]); + last = series._lastItemForPoint; + storeItem = series._lastStoreItem; + storeField = series._lastStoreField; + + + if (item !== last || item && (item.storeItem != storeItem || item.storeField != storeField)) { + if (last) { + series.fireEvent('itemmouseout', last); + delete series._lastItemForPoint; + delete series._lastStoreField; + delete series._lastStoreItem; + } + if (item) { + series.fireEvent('itemmouseover', item); + series._lastItemForPoint = item; + series._lastStoreItem = item.storeItem; + series._lastStoreField = item.storeField; + } + } + } + } else { + last = series._lastItemForPoint; + if (last) { + series.fireEvent('itemmouseout', last); + delete series._lastItemForPoint; + delete series._lastStoreField; + delete series._lastStoreItem; + } + } + }, me); + }, + + // @private handle mouse leave event. + onMouseLeave: function(e) { + var me = this; + if (me.mask) { + me.mixins.mask.onMouseLeave.call(me, e); + } + me.series.each(function(series) { + delete series._lastItemForPoint; + }); + }, + + // @private buffered refresh for when we update the store + delayRefresh: function() { + var me = this; + if (!me.refreshTask) { + me.refreshTask = Ext.create('Ext.util.DelayedTask', me.refresh, me); + } + me.refreshTask.delay(me.refreshBuffer); + }, + + // @private + refresh: function() { + var me = this; + if (me.rendered && me.curWidth != undefined && me.curHeight != undefined) { + if (me.fireEvent('beforerefresh', me) !== false) { + me.redraw(); + me.fireEvent('refresh', me); + } + } + }, + + /** + * Changes the data store bound to this chart and refreshes it. + * @param {Store} store The store to bind to this chart + */ + bindStore: function(store, initial) { + var me = this; + if (!initial && me.store) { + if (store !== me.store && me.store.autoDestroy) { + me.store.destroy(); + } + else { + me.store.un('datachanged', me.refresh, me); + me.store.un('add', me.delayRefresh, me); + me.store.un('remove', me.delayRefresh, me); + me.store.un('update', me.delayRefresh, me); + me.store.un('clear', me.refresh, me); + } + } + if (store) { + store = Ext.data.StoreManager.lookup(store); + store.on({ + scope: me, + datachanged: me.refresh, + add: me.delayRefresh, + remove: me.delayRefresh, + update: me.delayRefresh, + clear: me.refresh + }); + } + me.store = store; + if (store && !initial) { + me.refresh(); + } + }, + + // @private Create Axis + initializeAxis: function(axis) { + var me = this, + chartBBox = me.chartBBox, + w = chartBBox.width, + h = chartBBox.height, + x = chartBBox.x, + y = chartBBox.y, + themeAttrs = me.themeAttrs, + config = { + chart: me + }; + if (themeAttrs) { + config.axisStyle = Ext.apply({}, themeAttrs.axis); + config.axisLabelLeftStyle = Ext.apply({}, themeAttrs.axisLabelLeft); + config.axisLabelRightStyle = Ext.apply({}, themeAttrs.axisLabelRight); + config.axisLabelTopStyle = Ext.apply({}, themeAttrs.axisLabelTop); + config.axisLabelBottomStyle = Ext.apply({}, themeAttrs.axisLabelBottom); + config.axisTitleLeftStyle = Ext.apply({}, themeAttrs.axisTitleLeft); + config.axisTitleRightStyle = Ext.apply({}, themeAttrs.axisTitleRight); + config.axisTitleTopStyle = Ext.apply({}, themeAttrs.axisTitleTop); + config.axisTitleBottomStyle = Ext.apply({}, themeAttrs.axisTitleBottom); + } + switch (axis.position) { + case 'top': + Ext.apply(config, { + length: w, + width: h, + x: x, + y: y + }); + break; + case 'bottom': + Ext.apply(config, { + length: w, + width: h, + x: x, + y: h + }); + break; + case 'left': + Ext.apply(config, { + length: h, + width: w, + x: x, + y: h + }); + break; + case 'right': + Ext.apply(config, { + length: h, + width: w, + x: w, + y: h + }); + break; + } + if (!axis.chart) { + Ext.apply(config, axis); + axis = me.axes.replace(Ext.createByAlias('axis.' + axis.type.toLowerCase(), config)); + } + else { + Ext.apply(axis, config); + } + }, + + + /** + * @private Adjust the dimensions and positions of each axis and the chart body area after accounting + * for the space taken up on each side by the axes and legend. + */ + alignAxes: function() { + var me = this, + axes = me.axes, + legend = me.legend, + edges = ['top', 'right', 'bottom', 'left'], + chartBBox, + insetPadding = me.insetPadding, + insets = { + top: insetPadding, + right: insetPadding, + bottom: insetPadding, + left: insetPadding + }; + + function getAxis(edge) { + var i = axes.findIndex('position', edge); + return (i < 0) ? null : axes.getAt(i); + } + + // Find the space needed by axes and legend as a positive inset from each edge + Ext.each(edges, function(edge) { + var isVertical = (edge === 'left' || edge === 'right'), + axis = getAxis(edge), + bbox; + + // Add legend size if it's on this edge + if (legend !== false) { + if (legend.position === edge) { + bbox = legend.getBBox(); + insets[edge] += (isVertical ? bbox.width : bbox.height) + insets[edge]; + } + } + + // Add axis size if there's one on this edge only if it has been + //drawn before. + if (axis && axis.bbox) { + bbox = axis.bbox; + insets[edge] += (isVertical ? bbox.width : bbox.height); + } + }); + // Build the chart bbox based on the collected inset values + chartBBox = { + x: insets.left, + y: insets.top, + width: me.curWidth - insets.left - insets.right, + height: me.curHeight - insets.top - insets.bottom + }; + me.chartBBox = chartBBox; + + // Go back through each axis and set its length and position based on the + // corresponding edge of the chartBBox + axes.each(function(axis) { + var pos = axis.position, + isVertical = (pos === 'left' || pos === 'right'); + + axis.x = (pos === 'right' ? chartBBox.x + chartBBox.width : chartBBox.x); + axis.y = (pos === 'top' ? chartBBox.y : chartBBox.y + chartBBox.height); + axis.width = (isVertical ? chartBBox.width : chartBBox.height); + axis.length = (isVertical ? chartBBox.height : chartBBox.width); + }); + }, + + // @private initialize the series. + initializeSeries: function(series, idx) { + var me = this, + themeAttrs = me.themeAttrs, + seriesObj, markerObj, seriesThemes, st, + markerThemes, colorArrayStyle = [], + i = 0, l, + config = { + chart: me, + seriesId: series.seriesId + }; + if (themeAttrs) { + seriesThemes = themeAttrs.seriesThemes; + markerThemes = themeAttrs.markerThemes; + seriesObj = Ext.apply({}, themeAttrs.series); + markerObj = Ext.apply({}, themeAttrs.marker); + config.seriesStyle = Ext.apply(seriesObj, seriesThemes[idx % seriesThemes.length]); + config.seriesLabelStyle = Ext.apply({}, themeAttrs.seriesLabel); + config.markerStyle = Ext.apply(markerObj, markerThemes[idx % markerThemes.length]); + if (themeAttrs.colors) { + config.colorArrayStyle = themeAttrs.colors; + } else { + colorArrayStyle = []; + for (l = seriesThemes.length; i < l; i++) { + st = seriesThemes[i]; + if (st.fill || st.stroke) { + colorArrayStyle.push(st.fill || st.stroke); + } + } + if (colorArrayStyle.length) { + config.colorArrayStyle = colorArrayStyle; + } + } + config.seriesIdx = idx; + } + if (series instanceof Ext.chart.series.Series) { + Ext.apply(series, config); + } else { + Ext.applyIf(config, series); + series = me.series.replace(Ext.createByAlias('series.' + series.type.toLowerCase(), config)); + } + if (series.initialize) { + series.initialize(); + } + }, + + // @private + getMaxGutter: function() { + var me = this, + maxGutter = [0, 0]; + me.series.each(function(s) { + var gutter = s.getGutters && s.getGutters() || [0, 0]; + maxGutter[0] = Math.max(maxGutter[0], gutter[0]); + maxGutter[1] = Math.max(maxGutter[1], gutter[1]); + }); + me.maxGutter = maxGutter; + }, + + // @private draw axis. + drawAxis: function(axis) { + axis.drawAxis(); + }, + + // @private draw series. + drawCharts: function(series) { + series.triggerafterrender = false; + series.drawSeries(); + if (!this.animate) { + series.fireEvent('afterrender'); + } + }, + + // @private remove gently. + destroy: function() { + this.surface.destroy(); + this.bindStore(null); + this.callParent(arguments); + } +}); + +/** + * @class Ext.chart.Highlight + * @ignore + */ +Ext.define('Ext.chart.Highlight', { + + /* Begin Definitions */ + + requires: ['Ext.fx.Anim'], + + /* End Definitions */ + + /** + * Highlight the given series item. + * @param {Boolean|Object} Default's false. Can also be an object width style properties (i.e fill, stroke, radius) + * or just use default styles per series by setting highlight = true. + */ + highlight: false, + + highlightCfg : null, + + constructor: function(config) { + if (config.highlight) { + if (config.highlight !== true) { //is an object + this.highlightCfg = Ext.apply({}, config.highlight); + } + else { + this.highlightCfg = { + fill: '#fdd', + radius: 20, + lineWidth: 5, + stroke: '#f55' + }; + } + } + }, + + /** + * Highlight the given series item. + * @param {Object} item Info about the item; same format as returned by #getItemForPoint. + */ + highlightItem: function(item) { + if (!item) { + return; + } + + var me = this, + sprite = item.sprite, + opts = me.highlightCfg, + surface = me.chart.surface, + animate = me.chart.animate, + p, + from, + to, + pi; + + if (!me.highlight || !sprite || sprite._highlighted) { + return; + } + if (sprite._anim) { + sprite._anim.paused = true; + } + sprite._highlighted = true; + if (!sprite._defaults) { + sprite._defaults = Ext.apply(sprite._defaults || {}, + sprite.attr); + from = {}; + to = {}; + for (p in opts) { + if (! (p in sprite._defaults)) { + sprite._defaults[p] = surface.availableAttrs[p]; + } + from[p] = sprite._defaults[p]; + to[p] = opts[p]; + if (Ext.isObject(opts[p])) { + from[p] = {}; + to[p] = {}; + Ext.apply(sprite._defaults[p], sprite.attr[p]); + Ext.apply(from[p], sprite._defaults[p]); + for (pi in sprite._defaults[p]) { + if (! (pi in opts[p])) { + to[p][pi] = from[p][pi]; + } else { + to[p][pi] = opts[p][pi]; + } + } + for (pi in opts[p]) { + if (! (pi in to[p])) { + to[p][pi] = opts[p][pi]; + } + } + } + } + sprite._from = from; + sprite._to = to; + } + if (animate) { + sprite._anim = Ext.create('Ext.fx.Anim', { + target: sprite, + from: sprite._from, + to: sprite._to, + duration: 150 + }); + } else { + sprite.setAttributes(sprite._to, true); + } + }, + + /** + * Un-highlight any existing highlights + */ + unHighlightItem: function() { + if (!this.highlight || !this.items) { + return; + } + + var me = this, + items = me.items, + len = items.length, + opts = me.highlightCfg, + animate = me.chart.animate, + i = 0, + obj, + p, + sprite; + + for (; i < len; i++) { + if (!items[i]) { + continue; + } + sprite = items[i].sprite; + if (sprite && sprite._highlighted) { + if (sprite._anim) { + sprite._anim.paused = true; + } + obj = {}; + for (p in opts) { + if (Ext.isObject(sprite._defaults[p])) { + obj[p] = {}; + Ext.apply(obj[p], sprite._defaults[p]); + } + else { + obj[p] = sprite._defaults[p]; + } + } + if (animate) { + sprite._anim = Ext.create('Ext.fx.Anim', { + target: sprite, + to: obj, + duration: 150 + }); + } + else { + sprite.setAttributes(obj, true); + } + delete sprite._highlighted; + //delete sprite._defaults; + } + } + }, + + cleanHighlights: function() { + if (!this.highlight) { + return; + } + + var group = this.group, + markerGroup = this.markerGroup, + i = 0, + l; + for (l = group.getCount(); i < l; i++) { + delete group.getAt(i)._defaults; + } + if (markerGroup) { + for (l = markerGroup.getCount(); i < l; i++) { + delete markerGroup.getAt(i)._defaults; + } + } + } +}); +/** + * @class Ext.chart.Label + * + * Labels is a mixin whose methods are appended onto the Series class. Labels is an interface with methods implemented + * in each of the Series (Pie, Bar, etc) for label creation and label placement. + * + * The methods implemented by the Series are: + * + * - **`onCreateLabel(storeItem, item, i, display)`** Called each time a new label is created. + * The arguments of the method are: + * - *`storeItem`* The element of the store that is related to the label sprite. + * - *`item`* The item related to the label sprite. An item is an object containing the position of the shape + * used to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc). + * - *`i`* The index of the element created (i.e the first created label, second created label, etc) + * - *`display`* The display type. May be false if the label is hidden + * + * - **`onPlaceLabel(label, storeItem, item, i, display, animate)`** Called for updating the position of the label. + * The arguments of the method are: + * - *`label`* The sprite label. + * - *`storeItem`* The element of the store that is related to the label sprite + * - *`item`* The item related to the label sprite. An item is an object containing the position of the shape + * used to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc). + * - *`i`* The index of the element to be updated (i.e. whether it is the first, second, third from the labelGroup) + * - *`display`* The display type. May be false if the label is hidden. + * - *`animate`* A boolean value to set or unset animations for the labels. + */ +Ext.define('Ext.chart.Label', { + + /* Begin Definitions */ - // branched to use + in gecko and [].join() in others - if(Ext.isGecko){ - body = "tpl.compiled = function(values, parent, xindex, xcount){ return '" + - tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn).replace(this.codeRe, codeFn) + - "';};"; - }else{ - body = ["tpl.compiled = function(values, parent, xindex, xcount){ return ['"]; - body.push(tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn).replace(this.codeRe, codeFn)); - body.push("'].join('');};"); - body = body.join(''); - } - eval(body); - return this; - }, + requires: ['Ext.draw.Color'], + + /* End Definitions */ /** - * Returns an HTML fragment of this template with the specified values applied. - * @param {Object} 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 + * @cfg {String} display + * Specifies the presence and position of labels for each pie slice. Either "rotate", "middle", "insideStart", + * "insideEnd", "outside", "over", "under", or "none" to prevent label rendering. + * Default value: 'none'. */ - applyTemplate : function(values){ - return this.master.compiled.call(this, values, {}, 1, 1); - }, /** - * Compile the template to a function for optimized performance. Recommended if the template will be used frequently. - * @return {Function} The compiled function + * @cfg {String} color + * The color of the label text. + * Default value: '#000' (black). */ - compile : function(){return this;} /** - * @property re - * @hide + * @cfg {String} field + * The name of the field to be displayed in the label. + * Default value: 'name'. */ + /** - * @property disableFormats - * @hide + * @cfg {Number} minMargin + * Specifies the minimum distance from a label to the origin of the visualization. + * This parameter is useful when using PieSeries width variable pie slice lengths. + * Default value: 50. */ + /** - * @method set - * @hide + * @cfg {String} font + * The font used for the labels. + * Defautl value: "11px Helvetica, sans-serif". */ -}); -/** - * 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 your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) - * @return {String} The HTML fragment - * @member Ext.XTemplate - * @method apply - */ -Ext.XTemplate.prototype.apply = Ext.XTemplate.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 - * @return {Ext.Template} The created template - * @static - */ -Ext.XTemplate.from = function(el){ - el = Ext.getDom(el); - return new Ext.XTemplate(el.value || el.innerHTML); -}; -/** - * @class Ext.util.CSS - * Utility class for manipulating CSS rules - * @singleton - */ -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 { - /** - * 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; - var head = doc.getElementsByTagName("head")[0]; - var rules = doc.createElement("style"); - rules.setAttribute("type", "text/css"); - if(id){ - rules.setAttribute("id", id); - } - if(Ext.isIE){ - head.appendChild(rules); - ss = rules.styleSheet; - ss.cssText = cssText; - }else{ - try{ - rules.appendChild(doc.createTextNode(cssText)); - }catch(e){ - rules.cssText = cssText; - } - head.appendChild(rules); - ss = rules.styleSheet ? rules.styleSheet : (rules.sheet || doc.styleSheets[doc.styleSheets.length-1]); - } - this.cacheStyleSheet(ss); - return ss; - }, + /** + * @cfg {String} orientation + * Either "horizontal" or "vertical". + * Dafault value: "horizontal". + */ - /** - * Removes a style or link tag by id - * @param {String} id The id of the tag - */ - removeStyleSheet : function(id){ - var existing = doc.getElementById(id); - if(existing){ - existing.parentNode.removeChild(existing); - } - }, + /** + * @cfg {Function} renderer + * Optional function for formatting the label into a displayable value. + * Default value: function(v) { return v; } + * @param v + */ - /** - * 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){ - 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; - for(var j = ssRules.length-1; j >= 0; --j){ - rules[ssRules[j].selectorText.toLowerCase()] = ssRules[j]; - } - }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; - for(var i =0, len = ds.length; i < len; i++){ - try{ - 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()]; - } - } - 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.ClickRepeater - @extends Ext.util.Observable - - A wrapper class which can be applied to any element. Fires a "click" event while the - mouse is pressed. The interval between firings may be specified in the config but - defaults to 20 milliseconds. - - Optionally, a CSS class may be applied to the element during the time it is pressed. - - @cfg {Mixed} el The element to act as a button. - @cfg {Number} delay The initial delay before the repeating event begins firing. - Similar to an autorepeat key delay. - @cfg {Number} interval The interval between firings of the "click" event. Default 20 ms. - @cfg {String} pressClass A CSS class name to be applied to the element while pressed. - @cfg {Boolean} accelerate True if autorepeating should start slowly and accelerate. - "interval" and "delay" are ignored. - @cfg {Boolean} preventDefault True to prevent the default click event - @cfg {Boolean} stopDefault True to stop the default click event - - @history - 2007-02-02 jvs Original code contributed by Nige "Animal" White - 2007-02-02 jvs Renamed to ClickRepeater - 2007-02-03 jvs Modifications for FF Mac and Safari - - @constructor - @param {Mixed} el The element to listen on - @param {Object} config - */ -Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { + //@private a regex to parse url type colors. + colorStringRe: /url\s*$\s*#([^\/)]+)\s*$/, - constructor : function(el, config){ - this.el = Ext.get(el); - this.el.unselectable(); - - Ext.apply(this, config); - - this.addEvents( - /** - * @event mousedown - * Fires when the mouse button is depressed. - * @param {Ext.util.ClickRepeater} this - * @param {Ext.EventObject} e - */ - "mousedown", - /** - * @event click - * Fires on a specified interval during the time the element is pressed. - * @param {Ext.util.ClickRepeater} this - * @param {Ext.EventObject} e - */ - "click", - /** - * @event mouseup - * Fires when the mouse key is released. - * @param {Ext.util.ClickRepeater} this - * @param {Ext.EventObject} e - */ - "mouseup" - ); + //@private the mixin constructor. Used internally by Series. + constructor: function(config) { + var me = this; + me.label = Ext.applyIf(me.label || {}, + { + display: "none", + color: "#000", + field: "name", + minMargin: 50, + font: "11px Helvetica, sans-serif", + orientation: "horizontal", + renderer: function(v) { + return v; + } + }); - if(!this.disabled){ - this.disabled = true; - this.enable(); + if (me.label.display !== 'none') { + me.labelsGroup = me.chart.surface.getGroup(me.seriesId + '-labels'); } + }, - // allow inline handler - if(this.handler){ - this.on("click", this.handler, this.scope || this); + //@private a method to render all labels in the labelGroup + renderLabels: function() { + var me = this, + chart = me.chart, + gradients = chart.gradients, + gradient, + items = me.items, + animate = chart.animate, + config = me.label, + display = config.display, + color = config.color, + field = [].concat(config.field), + group = me.labelsGroup, + store = me.chart.store, + len = store.getCount(), + ratio = items.length / len, + i, count, index, j, + k, gradientsCount = (gradients || 0) && gradients.length, + colorStopTotal, colorStopIndex, colorStop, + item, label, storeItem, + sprite, spriteColor, spriteBrightness, labelColor, + Color = Ext.draw.Color, + colorString; + + if (display == 'none') { + return; } - Ext.util.ClickRepeater.superclass.constructor.call(this); - }, - - interval : 20, - delay: 250, - preventDefault : true, - stopDefault : false, - timer : 0, + for (i = 0, count = 0; i < len; i++) { + index = 0; + for (j = 0; j < ratio; j++) { + item = items[count]; + label = group.getAt(count); + storeItem = store.getAt(i); + + //check the excludes + while(this.__excludes && this.__excludes[index]) { + index++; + } - /** - * Enables the repeater and allows events to fire. - */ - enable: function(){ - if(this.disabled){ - this.el.on('mousedown', this.handleMouseDown, this); - if (Ext.isIE){ - this.el.on('dblclick', this.handleDblClick, this); - } - if(this.preventDefault || this.stopDefault){ - this.el.on('click', this.eventOptions, this); + if (!item && label) { + label.hide(true); + } + + if (item && field[j]) { + if (!label) { + label = me.onCreateLabel(storeItem, item, i, display, j, index); + } + me.onPlaceLabel(label, storeItem, item, i, display, animate, j, index); + + //set contrast + if (config.contrast && item.sprite) { + sprite = item.sprite; + colorString = sprite._to && sprite._to.fill || sprite.attr.fill; + spriteColor = Color.fromString(colorString); + //color wasn't parsed property maybe because it's a gradient id + if (colorString && !spriteColor) { + colorString = colorString.match(me.colorStringRe)[1]; + for (k = 0; k < gradientsCount; k++) { + gradient = gradients[k]; + if (gradient.id == colorString) { + //avg color stops + colorStop = 0; colorStopTotal = 0; + for (colorStopIndex in gradient.stops) { + colorStop++; + colorStopTotal += Color.fromString(gradient.stops[colorStopIndex].color).getGrayscale(); + } + spriteBrightness = (colorStopTotal / colorStop) / 255; + break; + } + } + } + else { + spriteBrightness = spriteColor.getGrayscale() / 255; + } + labelColor = Color.fromString(label.attr.color || label.attr.fill).getHSL(); + + labelColor[2] = spriteBrightness > 0.5? 0.2 : 0.8; + label.setAttributes({ + fill: String(Color.fromHSL.apply({}, labelColor)) + }, true); + } + } + count++; + index++; } } - this.disabled = false; + me.hideLabels(count); }, - /** - * Disables the repeater and stops events from firing. - */ - disable: function(/* private */ force){ - if(force || !this.disabled){ - clearTimeout(this.timer); - if(this.pressClass){ - this.el.removeClass(this.pressClass); + //@private a method to hide labels. + hideLabels: function(index) { + var labelsGroup = this.labelsGroup, len; + if (labelsGroup) { + len = labelsGroup.getCount(); + while (len-->index) { + labelsGroup.getAt(len).hide(true); } - Ext.getDoc().un('mouseup', this.handleMouseUp, this); - this.el.removeAllListeners(); } - this.disabled = true; + } +}); +Ext.define('Ext.chart.MaskLayer', { + extend: 'Ext.Component', + + constructor: function(config) { + config = Ext.apply(config || {}, { + style: 'position:absolute;background-color:#888;cursor:move;opacity:0.6;border:1px solid #222;' + }); + this.callParent([config]); }, - - /** - * Convenience function for setting disabled/enabled by boolean. - * @param {Boolean} disabled - */ - setDisabled: function(disabled){ - this[disabled ? 'disable' : 'enable'](); + + initComponent: function() { + var me = this; + me.callParent(arguments); + me.addEvents( + 'mousedown', + 'mouseup', + 'mousemove', + 'mouseenter', + 'mouseleave' + ); }, - eventOptions: function(e){ - if(this.preventDefault){ - e.preventDefault(); - } - if(this.stopDefault){ - e.stopEvent(); - } - }, + initDraggable: function() { + this.callParent(arguments); + this.dd.onStart = function (e) { + var me = this, + comp = me.comp; + + // Cache the start [X, Y] array + this.startPosition = comp.getPosition(true); + + // 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(); + } + }; + } +}); +/** + * @class Ext.chart.TipSurface + * @ignore + */ +Ext.define('Ext.chart.TipSurface', { - // private - destroy : function() { - this.disable(true); - Ext.destroy(this.el); - this.purgeListeners(); - }, + /* Begin Definitions */ - handleDblClick : function(e){ - clearTimeout(this.timer); - this.el.blur(); + extend: 'Ext.draw.Component', - this.fireEvent("mousedown", this, e); - this.fireEvent("click", this, e); - }, + /* End Definitions */ - // private - handleMouseDown : function(e){ - clearTimeout(this.timer); - this.el.blur(); - if(this.pressClass){ - this.el.addClass(this.pressClass); + spriteArray: false, + renderFirst: true, + + constructor: function(config) { + this.callParent([config]); + if (config.sprites) { + this.spriteArray = [].concat(config.sprites); + delete config.sprites; } - this.mousedownTime = new Date(); + }, - Ext.getDoc().on("mouseup", this.handleMouseUp, this); - this.el.on("mouseout", this.handleMouseOut, this); + onRender: function() { + var me = this, + i = 0, + l = 0, + sp, + sprites; + this.callParent(arguments); + sprites = me.spriteArray; + if (me.renderFirst && sprites) { + me.renderFirst = false; + for (l = sprites.length; i < l; i++) { + sp = me.surface.add(sprites[i]); + sp.setAttributes({ + hidden: false + }, + true); + } + } + } +}); - this.fireEvent("mousedown", this, e); - this.fireEvent("click", this, e); +/** + * @class Ext.chart.Tip + * @ignore + */ +Ext.define('Ext.chart.Tip', { - // Do not honor delay or interval if acceleration wanted. - if (this.accelerate) { - this.delay = 400; - } - this.timer = this.click.defer(this.delay || this.interval, this, [e]); - }, + /* Begin Definitions */ - // private - click : function(e){ - this.fireEvent("click", this, e); - this.timer = this.click.defer(this.accelerate ? - this.easeOutExpo(this.mousedownTime.getElapsed(), - 400, - -390, - 12000) : - this.interval, this, [e]); - }, + requires: ['Ext.tip.ToolTip', 'Ext.chart.TipSurface'], - easeOutExpo : function (t, b, c, d) { - return (t==d) ? b+c : c * (-Math.pow(2, -10 * t/d) + 1) + b; - }, + /* End Definitions */ - // private - handleMouseOut : function(){ - clearTimeout(this.timer); - if(this.pressClass){ - this.el.removeClass(this.pressClass); + constructor: function(config) { + var me = this, + surface, + sprites, + tipSurface; + if (config.tips) { + me.tipTimeout = null; + me.tipConfig = Ext.apply({}, config.tips, { + renderer: Ext.emptyFn, + constrainPosition: false + }); + me.tooltip = Ext.create('Ext.tip.ToolTip', me.tipConfig); + Ext.getBody().on('mousemove', me.tooltip.onMouseMove, me.tooltip); + if (me.tipConfig.surface) { + //initialize a surface + surface = me.tipConfig.surface; + sprites = surface.sprites; + tipSurface = Ext.create('Ext.chart.TipSurface', { + id: 'tipSurfaceComponent', + sprites: sprites + }); + if (surface.width && surface.height) { + tipSurface.setSize(surface.width, surface.height); + } + me.tooltip.add(tipSurface); + me.spriteTip = tipSurface; + } } - this.el.on("mouseover", this.handleMouseReturn, this); }, - // private - handleMouseReturn : function(){ - this.el.un("mouseover", this.handleMouseReturn, this); - if(this.pressClass){ - this.el.addClass(this.pressClass); + showTip: function(item) { + var me = this; + if (!me.tooltip) { + return; } - this.click(); + clearTimeout(me.tipTimeout); + var tooltip = me.tooltip, + spriteTip = me.spriteTip, + tipConfig = me.tipConfig, + trackMouse = tooltip.trackMouse, + sprite, surface, surfaceExt, pos, x, y; + if (!trackMouse) { + tooltip.trackMouse = true; + sprite = item.sprite; + surface = sprite.surface; + surfaceExt = Ext.get(surface.getId()); + if (surfaceExt) { + pos = surfaceExt.getXY(); + x = pos[0] + (sprite.attr.x || 0) + (sprite.attr.translation && sprite.attr.translation.x || 0); + y = pos[1] + (sprite.attr.y || 0) + (sprite.attr.translation && sprite.attr.translation.y || 0); + tooltip.targetXY = [x, y]; + } + } + if (spriteTip) { + tipConfig.renderer.call(tooltip, item.storeItem, item, spriteTip.surface); + } else { + tipConfig.renderer.call(tooltip, item.storeItem, item); + } + tooltip.show(); + tooltip.trackMouse = trackMouse; }, - // private - handleMouseUp : function(e){ - clearTimeout(this.timer); - this.el.un("mouseover", this.handleMouseReturn, this); - this.el.un("mouseout", this.handleMouseOut, this); - Ext.getDoc().un("mouseup", this.handleMouseUp, this); - this.el.removeClass(this.pressClass); - this.fireEvent("mouseup", this, e); + hideTip: function(item) { + var tooltip = this.tooltip; + if (!tooltip) { + return; + } + clearTimeout(this.tipTimeout); + this.tipTimeout = setTimeout(function() { + tooltip.hide(); + }, 0); } -});/** - * @class Ext.KeyNav - *
Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind - * navigation keys to function calls that will get called when the keys are pressed, providing an easy - * way to implement custom navigation schemes for any UI component.
- *
The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc, - * pageUp, pageDown, del, home, end. Usage:
-
-var nav = new Ext.KeyNav("my-element", { - "left" : function(e){ - this.moveLeft(e.ctrlKey); - }, - "right" : function(e){ - this.moveRight(e.ctrlKey); - }, - "enter" : function(e){ - this.save(); +}); +/** + * @class Ext.chart.axis.Abstract + * @ignore + */ +Ext.define('Ext.chart.axis.Abstract', { + + /* Begin Definitions */ + + requires: ['Ext.chart.Chart'], + + /* End Definitions */ + + constructor: function(config) { + config = config || {}; + + var me = this, + pos = config.position || 'left'; + + pos = pos.charAt(0).toUpperCase() + pos.substring(1); + //axisLabel(Top|Bottom|Right|Left)Style + config.label = Ext.apply(config['axisLabel' + pos + 'Style'] || {}, config.label || {}); + config.axisTitleStyle = Ext.apply(config['axisTitle' + pos + 'Style'] || {}, config.labelTitle || {}); + Ext.apply(me, config); + me.fields = [].concat(me.fields); + this.callParent(); + me.labels = []; + me.getId(); + me.labelGroup = me.chart.surface.getGroup(me.axisId + "-labels"); + }, + + alignment: null, + grid: false, + steps: 10, + x: 0, + y: 0, + minValue: 0, + maxValue: 0, + + getId: function() { + return this.axisId || (this.axisId = Ext.id(null, 'ext-axis-')); }, - scope : this + + /* + Called to process a view i.e to make aggregation and filtering over + a store creating a substore to be used to render the axis. Since many axes + may do different things on the data and we want the final result of all these + operations to be rendered we need to call processView on all axes before drawing + them. + */ + processView: Ext.emptyFn, + + drawAxis: Ext.emptyFn, + addDisplayAndLabels: Ext.emptyFn }); -
- * @constructor - * @param {Mixed} el The element to bind to - * @param {Object} config The config + +/** + * @class Ext.chart.axis.Axis + * @extends Ext.chart.axis.Abstract + * + * Defines axis for charts. The axis position, type, style can be configured. + * The axes are defined in an axes array of configuration objects where the type, + * field, grid and other configuration options can be set. To know more about how + * to create a Chart please check the Chart class documentation. Here's an example for the axes part: + * An example of axis for a series (in this case for an area chart that has multiple layers of yFields) could be: + * + * axes: [{ + * type: 'Numeric', + * grid: true, + * position: 'left', + * fields: ['data1', 'data2', 'data3'], + * title: 'Number of Hits', + * grid: { + * odd: { + * opacity: 1, + * fill: '#ddd', + * stroke: '#bbb', + * 'stroke-width': 1 + * } + * }, + * minimum: 0 + * }, { + * type: 'Category', + * position: 'bottom', + * fields: ['name'], + * title: 'Month of the Year', + * grid: true, + * label: { + * rotate: { + * degrees: 315 + * } + * } + * }] + * + * In this case we use a `Numeric` axis for displaying the values of the Area series and a `Category` axis for displaying the names of + * the store elements. The numeric axis is placed on the left of the screen, while the category axis is placed at the bottom of the chart. + * Both the category and numeric axes have `grid` set, which means that horizontal and vertical lines will cover the chart background. In the + * category axis the labels will be rotated so they can fit the space better. */ -Ext.KeyNav = function(el, config){ - this.el = Ext.get(el); - Ext.apply(this, config); - if(!this.disabled){ - this.disabled = true; - this.enable(); - } -}; +Ext.define('Ext.chart.axis.Axis', { + + /* Begin Definitions */ + + extend: 'Ext.chart.axis.Abstract', + + alternateClassName: 'Ext.chart.Axis', + + requires: ['Ext.draw.Draw'], + + /* End Definitions */ -Ext.KeyNav.prototype = { /** - * @cfg {Boolean} disabled - * True to disable this KeyNav instance (defaults to false) + * @cfg {Number} majorTickSteps + * If `minimum` and `maximum` are specified it forces the number of major ticks to the specified value. */ - disabled : false, + /** - * @cfg {String} defaultEventAction - * The method to call on the {@link Ext.EventObject} after this KeyNav intercepts a key. Valid values are - * {@link Ext.EventObject#stopEvent}, {@link Ext.EventObject#preventDefault} and - * {@link Ext.EventObject#stopPropagation} (defaults to 'stopEvent') + * @cfg {Number} minorTickSteps + * The number of small ticks between two major ticks. Default is zero. */ - defaultEventAction: "stopEvent", + + //@private force min/max values from store + forceMinMax: false, + /** - * @cfg {Boolean} forceKeyDown - * Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since - * IE does not propagate special keys on keypress, but setting this to true will force other browsers to also - * handle keydown instead of keypress. + * @cfg {Number} dashSize + * The size of the dash marker. Default's 3. + */ + dashSize: 3, + + /** + * @cfg {String} position + * Where to set the axis. Available options are `left`, `bottom`, `right`, `top`. Default's `bottom`. + */ + position: 'bottom', + + // @private + skipFirst: false, + + /** + * @cfg {Number} length + * Offset axis position. Default's 0. + */ + length: 0, + + /** + * @cfg {Number} width + * Offset axis width. Default's 0. */ - forceKeyDown : false, + width: 0, + + majorTickSteps: false, - // private - relay : function(e){ - var k = e.getKey(); - var h = this.keyToHandler[k]; - if(h && this[h]){ - if(this.doRelay(e, this[h], h) !== true){ - e[this.defaultEventAction](); + // @private + applyData: Ext.emptyFn, + + // @private creates a structure with start, end and step points. + calcEnds: function() { + var me = this, + math = Math, + mmax = math.max, + mmin = math.min, + store = me.chart.substore || me.chart.store, + series = me.chart.series.items, + fields = me.fields, + ln = fields.length, + min = isNaN(me.minimum) ? Infinity : me.minimum, + max = isNaN(me.maximum) ? -Infinity : me.maximum, + prevMin = me.prevMin, + prevMax = me.prevMax, + aggregate = false, + total = 0, + excludes = [], + outfrom, outto, + i, l, values, rec, out; + + //if one series is stacked I have to aggregate the values + //for the scale. + for (i = 0, l = series.length; !aggregate && i < l; i++) { + aggregate = aggregate || series[i].stacked; + excludes = series[i].__excludes || excludes; + } + store.each(function(record) { + if (aggregate) { + if (!isFinite(min)) { + min = 0; + } + for (values = [0, 0], i = 0; i < ln; i++) { + if (excludes[i]) { + continue; + } + rec = record.get(fields[i]); + values[+(rec > 0)] += math.abs(rec); + } + max = mmax(max, -values[0], values[1]); + min = mmin(min, -values[0], values[1]); + } + else { + for (i = 0; i < ln; i++) { + if (excludes[i]) { + continue; + } + value = record.get(fields[i]); + max = mmax(max, value); + min = mmin(min, value); + } } + }); + if (!isFinite(max)) { + max = me.prevMax || 0; } - }, - - // private - doRelay : function(e, h, hname){ - return h.call(this.scope || this, e); - }, - - // possible handlers - enter : false, - left : false, - right : false, - up : false, - down : false, - tab : false, - esc : false, - pageUp : false, - pageDown : false, - del : false, - home : false, - end : false, - - // quick lookup hash - keyToHandler : { - 37 : "left", - 39 : "right", - 38 : "up", - 40 : "down", - 33 : "pageUp", - 34 : "pageDown", - 46 : "del", - 36 : "home", - 35 : "end", - 13 : "enter", - 27 : "esc", - 9 : "tab" - }, - - stopKeyUp: function(e) { - var k = e.getKey(); - - if (k >= 37 && k <= 40) { - // *** bugfix - safari 2.x fires 2 keyup events on cursor keys - // *** (note: this bugfix sacrifices the "keyup" event originating from keyNav elements in Safari 2) - e.stopEvent(); + if (!isFinite(min)) { + min = me.prevMin || 0; } + //normalize min max for snapEnds. + if (min != max && (max != (max >> 0))) { + max = (max >> 0) + 1; + } + out = Ext.draw.Draw.snapEnds(min, max, me.majorTickSteps !== false ? (me.majorTickSteps +1) : me.steps); + outfrom = out.from; + outto = out.to; + if (me.forceMinMax) { + if (!isNaN(max)) { + out.to = max; + } + if (!isNaN(min)) { + out.from = min; + } + } + if (!isNaN(me.maximum)) { + //TODO(nico) users are responsible for their own minimum/maximum values set. + //Clipping should be added to remove lines in the chart which are below the axis. + out.to = me.maximum; + } + if (!isNaN(me.minimum)) { + //TODO(nico) users are responsible for their own minimum/maximum values set. + //Clipping should be added to remove lines in the chart which are below the axis. + out.from = me.minimum; + } + + //Adjust after adjusting minimum and maximum + out.step = (out.to - out.from) / (outto - outfrom) * out.step; + + if (me.adjustMaximumByMajorUnit) { + out.to += out.step; + } + if (me.adjustMinimumByMajorUnit) { + out.from -= out.step; + } + me.prevMin = min == max? 0 : min; + me.prevMax = max; + return out; }, - + /** - * Destroy this KeyNav (this is the same as calling disable). + * Renders the axis into the screen and updates it's position. */ - destroy: function(){ - this.disable(); - }, + drawAxis: function (init) { + var me = this, + i, j, + x = me.x, + y = me.y, + gutterX = me.chart.maxGutter[0], + gutterY = me.chart.maxGutter[1], + dashSize = me.dashSize, + subDashesX = me.minorTickSteps || 0, + subDashesY = me.minorTickSteps || 0, + length = me.length, + position = me.position, + inflections = [], + calcLabels = false, + stepCalcs = me.applyData(), + step = stepCalcs.step, + steps = stepCalcs.steps, + from = stepCalcs.from, + to = stepCalcs.to, + trueLength, + currentX, + currentY, + path, + prev, + dashesX, + dashesY, + delta; + + //If no steps are specified + //then don't draw the axis. This generally happens + //when an empty store. + if (me.hidden || isNaN(step) || (from == to)) { + return; + } - /** - * Enable this KeyNav - */ - enable: function() { - if (this.disabled) { - if (Ext.isSafari2) { - // call stopKeyUp() on "keyup" event - this.el.on('keyup', this.stopKeyUp, this); + me.from = stepCalcs.from; + me.to = stepCalcs.to; + if (position == 'left' || position == 'right') { + currentX = Math.floor(x) + 0.5; + path = ["M", currentX, y, "l", 0, -length]; + trueLength = length - (gutterY * 2); + } + else { + currentY = Math.floor(y) + 0.5; + path = ["M", x, currentY, "l", length, 0]; + trueLength = length - (gutterX * 2); + } + + delta = trueLength / (steps || 1); + dashesX = Math.max(subDashesX +1, 0); + dashesY = Math.max(subDashesY +1, 0); + if (me.type == 'Numeric') { + calcLabels = true; + me.labels = [stepCalcs.from]; + } + if (position == 'right' || position == 'left') { + currentY = y - gutterY; + currentX = x - ((position == 'left') * dashSize * 2); + while (currentY >= y - gutterY - trueLength) { + path.push("M", currentX, Math.floor(currentY) + 0.5, "l", dashSize * 2 + 1, 0); + if (currentY != y - gutterY) { + for (i = 1; i < dashesY; i++) { + path.push("M", currentX + dashSize, Math.floor(currentY + delta * i / dashesY) + 0.5, "l", dashSize + 1, 0); + } + } + inflections.push([ Math.floor(x), Math.floor(currentY) ]); + currentY -= delta; + if (calcLabels) { + me.labels.push(me.labels[me.labels.length -1] + step); + } + if (delta === 0) { + break; + } + } + if (Math.round(currentY + delta - (y - gutterY - trueLength))) { + path.push("M", currentX, Math.floor(y - length + gutterY) + 0.5, "l", dashSize * 2 + 1, 0); + for (i = 1; i < dashesY; i++) { + path.push("M", currentX + dashSize, Math.floor(y - length + gutterY + delta * i / dashesY) + 0.5, "l", dashSize + 1, 0); + } + inflections.push([ Math.floor(x), Math.floor(currentY) ]); + if (calcLabels) { + me.labels.push(me.labels[me.labels.length -1] + step); + } + } + } else { + currentX = x + gutterX; + currentY = y - ((position == 'top') * dashSize * 2); + while (currentX <= x + gutterX + trueLength) { + path.push("M", Math.floor(currentX) + 0.5, currentY, "l", 0, dashSize * 2 + 1); + if (currentX != x + gutterX) { + for (i = 1; i < dashesX; i++) { + path.push("M", Math.floor(currentX - delta * i / dashesX) + 0.5, currentY, "l", 0, dashSize + 1); + } + } + inflections.push([ Math.floor(currentX), Math.floor(y) ]); + currentX += delta; + if (calcLabels) { + me.labels.push(me.labels[me.labels.length -1] + step); + } + if (delta === 0) { + break; + } + } + if (Math.round(currentX - delta - (x + gutterX + trueLength))) { + path.push("M", Math.floor(x + length - gutterX) + 0.5, currentY, "l", 0, dashSize * 2 + 1); + for (i = 1; i < dashesX; i++) { + path.push("M", Math.floor(x + length - gutterX - delta * i / dashesX) + 0.5, currentY, "l", 0, dashSize + 1); + } + inflections.push([ Math.floor(currentX), Math.floor(y) ]); + if (calcLabels) { + me.labels.push(me.labels[me.labels.length -1] + step); + } } - - this.el.on(this.isKeydown()? 'keydown' : 'keypress', this.relay, this); - this.disabled = false; } + if (!me.axis) { + me.axis = me.chart.surface.add(Ext.apply({ + type: 'path', + path: path + }, me.axisStyle)); + } + me.axis.setAttributes({ + path: path + }, true); + me.inflections = inflections; + if (!init && me.grid) { + me.drawGrid(); + } + me.axisBBox = me.axis.getBBox(); + me.drawLabel(); }, - /** - * Disable this KeyNav - */ - disable: function() { - if (!this.disabled) { - if (Ext.isSafari2) { - // remove "keyup" event handler - this.el.un('keyup', this.stopKeyUp, this); + /** + * Renders an horizontal and/or vertical grid into the Surface. + */ + drawGrid: function() { + var me = this, + surface = me.chart.surface, + grid = me.grid, + odd = grid.odd, + even = grid.even, + inflections = me.inflections, + ln = inflections.length - ((odd || even)? 0 : 1), + position = me.position, + gutter = me.chart.maxGutter, + width = me.width - 2, + vert = false, + point, prevPoint, + i = 1, + path = [], styles, lineWidth, dlineWidth, + oddPath = [], evenPath = []; + + if ((gutter[1] !== 0 && (position == 'left' || position == 'right')) || + (gutter[0] !== 0 && (position == 'top' || position == 'bottom'))) { + i = 0; + ln++; + } + for (; i < ln; i++) { + point = inflections[i]; + prevPoint = inflections[i - 1]; + if (odd || even) { + path = (i % 2)? oddPath : evenPath; + styles = ((i % 2)? odd : even) || {}; + lineWidth = (styles.lineWidth || styles['stroke-width'] || 0) / 2; + dlineWidth = 2 * lineWidth; + if (position == 'left') { + path.push("M", prevPoint[0] + 1 + lineWidth, prevPoint[1] + 0.5 - lineWidth, + "L", prevPoint[0] + 1 + width - lineWidth, prevPoint[1] + 0.5 - lineWidth, + "L", point[0] + 1 + width - lineWidth, point[1] + 0.5 + lineWidth, + "L", point[0] + 1 + lineWidth, point[1] + 0.5 + lineWidth, "Z"); + } + else if (position == 'right') { + path.push("M", prevPoint[0] - lineWidth, prevPoint[1] + 0.5 - lineWidth, + "L", prevPoint[0] - width + lineWidth, prevPoint[1] + 0.5 - lineWidth, + "L", point[0] - width + lineWidth, point[1] + 0.5 + lineWidth, + "L", point[0] - lineWidth, point[1] + 0.5 + lineWidth, "Z"); + } + else if (position == 'top') { + path.push("M", prevPoint[0] + 0.5 + lineWidth, prevPoint[1] + 1 + lineWidth, + "L", prevPoint[0] + 0.5 + lineWidth, prevPoint[1] + 1 + width - lineWidth, + "L", point[0] + 0.5 - lineWidth, point[1] + 1 + width - lineWidth, + "L", point[0] + 0.5 - lineWidth, point[1] + 1 + lineWidth, "Z"); + } + else { + path.push("M", prevPoint[0] + 0.5 + lineWidth, prevPoint[1] - lineWidth, + "L", prevPoint[0] + 0.5 + lineWidth, prevPoint[1] - width + lineWidth, + "L", point[0] + 0.5 - lineWidth, point[1] - width + lineWidth, + "L", point[0] + 0.5 - lineWidth, point[1] - lineWidth, "Z"); + } + } else { + if (position == 'left') { + path = path.concat(["M", point[0] + 0.5, point[1] + 0.5, "l", width, 0]); + } + else if (position == 'right') { + path = path.concat(["M", point[0] - 0.5, point[1] + 0.5, "l", -width, 0]); + } + else if (position == 'top') { + path = path.concat(["M", point[0] + 0.5, point[1] + 0.5, "l", 0, width]); + } + else { + path = path.concat(["M", point[0] + 0.5, point[1] - 0.5, "l", 0, -width]); + } + } + } + if (odd || even) { + if (oddPath.length) { + if (!me.gridOdd && oddPath.length) { + me.gridOdd = surface.add({ + type: 'path', + path: oddPath + }); + } + me.gridOdd.setAttributes(Ext.apply({ + path: oddPath, + hidden: false + }, odd || {}), true); + } + if (evenPath.length) { + if (!me.gridEven) { + me.gridEven = surface.add({ + type: 'path', + path: evenPath + }); + } + me.gridEven.setAttributes(Ext.apply({ + path: evenPath, + hidden: false + }, even || {}), true); + } + } + else { + if (path.length) { + if (!me.gridLines) { + me.gridLines = me.chart.surface.add({ + type: 'path', + path: path, + "stroke-width": me.lineWidth || 1, + stroke: me.gridColor || '#ccc' + }); + } + me.gridLines.setAttributes({ + hidden: false, + path: path + }, true); } + else if (me.gridLines) { + me.gridLines.hide(true); + } + } + }, - this.el.un(this.isKeydown()? 'keydown' : 'keypress', this.relay, this); - this.disabled = true; + //@private + getOrCreateLabel: function(i, text) { + var me = this, + labelGroup = me.labelGroup, + textLabel = labelGroup.getAt(i), + surface = me.chart.surface; + if (textLabel) { + if (text != textLabel.attr.text) { + textLabel.setAttributes(Ext.apply({ + text: text + }, me.label), true); + textLabel._bbox = textLabel.getBBox(); + } } + else { + textLabel = surface.add(Ext.apply({ + group: labelGroup, + type: 'text', + x: 0, + y: 0, + text: text + }, me.label)); + surface.renderItem(textLabel); + textLabel._bbox = textLabel.getBBox(); + } + //get untransformed bounding box + if (me.label.rotation) { + textLabel.setAttributes({ + rotation: { + degrees: 0 + } + }, true); + textLabel._ubbox = textLabel.getBBox(); + textLabel.setAttributes(me.label, true); + } else { + textLabel._ubbox = textLabel._bbox; + } + return textLabel; }, - /** - * Convenience function for setting disabled/enabled by boolean. - * @param {Boolean} disabled - */ - setDisabled : function(disabled){ - this[disabled ? "disable" : "enable"](); + rect2pointArray: function(sprite) { + var surface = this.chart.surface, + rect = surface.getBBox(sprite, true), + p1 = [rect.x, rect.y], + p1p = p1.slice(), + p2 = [rect.x + rect.width, rect.y], + p2p = p2.slice(), + p3 = [rect.x + rect.width, rect.y + rect.height], + p3p = p3.slice(), + p4 = [rect.x, rect.y + rect.height], + p4p = p4.slice(), + matrix = sprite.matrix; + //transform the points + p1[0] = matrix.x.apply(matrix, p1p); + p1[1] = matrix.y.apply(matrix, p1p); + + p2[0] = matrix.x.apply(matrix, p2p); + p2[1] = matrix.y.apply(matrix, p2p); + + p3[0] = matrix.x.apply(matrix, p3p); + p3[1] = matrix.y.apply(matrix, p3p); + + p4[0] = matrix.x.apply(matrix, p4p); + p4[1] = matrix.y.apply(matrix, p4p); + return [p1, p2, p3, p4]; }, - // private - isKeydown: function(){ - return this.forceKeyDown || Ext.EventManager.useKeydown; - } -}; -/** - * @class Ext.KeyMap - * Handles mapping keys to actions for an element. One key map can be used for multiple actions. - * The constructor accepts the same config object as defined by {@link #addBinding}. - * If you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key - * combination it will call the function with this signature (if the match is a multi-key - * combination the callback will still be called only once): (String key, Ext.EventObject e) - * A KeyMap can also handle a string representation of keys.
- * Usage: -
-// map one key by key code -var map = new Ext.KeyMap("my-element", { - key: 13, // or Ext.EventObject.ENTER - fn: myHandler, - scope: myObject -}); - -// map multiple keys to one action by string -var map = new Ext.KeyMap("my-element", { - key: "a\r\n\t", - fn: myHandler, - scope: myObject -}); + intersect: function(l1, l2) { + var r1 = this.rect2pointArray(l1), + r2 = this.rect2pointArray(l2); + return !!Ext.draw.Draw.intersect(r1, r2).length; + }, + + drawHorizontalLabels: function() { + var me = this, + labelConf = me.label, + floor = Math.floor, + max = Math.max, + axes = me.chart.axes, + position = me.position, + inflections = me.inflections, + ln = inflections.length, + labels = me.labels, + labelGroup = me.labelGroup, + maxHeight = 0, + ratio, + gutterY = me.chart.maxGutter[1], + ubbox, bbox, point, prevX, prevLabel, + projectedWidth = 0, + textLabel, attr, textRight, text, + label, last, x, y, i, firstLabel; + + last = ln - 1; + //get a reference to the first text label dimensions + point = inflections[0]; + firstLabel = me.getOrCreateLabel(0, me.label.renderer(labels[0])); + ratio = Math.abs(Math.sin(labelConf.rotate && (labelConf.rotate.degrees * Math.PI / 180) || 0)) >> 0; + + for (i = 0; i < ln; i++) { + point = inflections[i]; + text = me.label.renderer(labels[i]); + textLabel = me.getOrCreateLabel(i, text); + bbox = textLabel._bbox; + maxHeight = max(maxHeight, bbox.height + me.dashSize + me.label.padding); + x = floor(point[0] - (ratio? bbox.height : bbox.width) / 2); + if (me.chart.maxGutter[0] == 0) { + if (i == 0 && axes.findIndex('position', 'left') == -1) { + x = point[0]; + } + else if (i == last && axes.findIndex('position', 'right') == -1) { + x = point[0] - bbox.width; + } + } + if (position == 'top') { + y = point[1] - (me.dashSize * 2) - me.label.padding - (bbox.height / 2); + } + else { + y = point[1] + (me.dashSize * 2) + me.label.padding + (bbox.height / 2); + } + + textLabel.setAttributes({ + hidden: false, + x: x, + y: y + }, true); + + // Skip label if there isn't available minimum space + if (i != 0 && (me.intersect(textLabel, prevLabel) + || me.intersect(textLabel, firstLabel))) { + textLabel.hide(true); + continue; + } + + prevLabel = textLabel; + } -// map multiple keys to multiple actions by strings and array of codes -var map = new Ext.KeyMap("my-element", [ - { - key: [10,13], - fn: function(){ alert("Return was pressed"); } - }, { - key: "abc", - fn: function(){ alert('a, b or c was pressed'); } - }, { - key: "\t", - ctrl:true, - shift:true, - fn: function(){ alert('Control + shift + tab was pressed.'); } - } -]); -
- * Note: A KeyMap starts enabled - * @constructor - * @param {Mixed} el The element to bind to - * @param {Object} config The config (see {@link #addBinding}) - * @param {String} eventName (optional) The event to bind to (defaults to "keydown") - */ -Ext.KeyMap = function(el, config, eventName){ - this.el = Ext.get(el); - this.eventName = eventName || "keydown"; - this.bindings = []; - if(config){ - this.addBinding(config); - } - this.enable(); -}; + return maxHeight; + }, + + drawVerticalLabels: function() { + var me = this, + inflections = me.inflections, + position = me.position, + ln = inflections.length, + labels = me.labels, + maxWidth = 0, + max = Math.max, + floor = Math.floor, + ceil = Math.ceil, + axes = me.chart.axes, + gutterY = me.chart.maxGutter[1], + ubbox, bbox, point, prevLabel, + projectedWidth = 0, + textLabel, attr, textRight, text, + label, last, x, y, i; + + last = ln; + for (i = 0; i < last; i++) { + point = inflections[i]; + text = me.label.renderer(labels[i]); + textLabel = me.getOrCreateLabel(i, text); + bbox = textLabel._bbox; + + maxWidth = max(maxWidth, bbox.width + me.dashSize + me.label.padding); + y = point[1]; + if (gutterY < bbox.height / 2) { + if (i == last - 1 && axes.findIndex('position', 'top') == -1) { + y = me.y - me.length + ceil(bbox.height / 2); + } + else if (i == 0 && axes.findIndex('position', 'bottom') == -1) { + y = me.y - floor(bbox.height / 2); + } + } + if (position == 'left') { + x = point[0] - bbox.width - me.dashSize - me.label.padding - 2; + } + else { + x = point[0] + me.dashSize + me.label.padding + 2; + } + textLabel.setAttributes(Ext.apply({ + hidden: false, + x: x, + y: y + }, me.label), true); + // Skip label if there isn't available minimum space + if (i != 0 && me.intersect(textLabel, prevLabel)) { + textLabel.hide(true); + continue; + } + prevLabel = textLabel; + } + + return maxWidth; + }, -Ext.KeyMap.prototype = { /** - * True to stop the event from bubbling and prevent the default browser action if the - * key was handled by the KeyMap (defaults to false) - * @type Boolean + * Renders the labels in the axes. */ - stopEvent : false, + drawLabel: function() { + var me = this, + position = me.position, + labelGroup = me.labelGroup, + inflections = me.inflections, + maxWidth = 0, + maxHeight = 0, + ln, i; + + if (position == 'left' || position == 'right') { + maxWidth = me.drawVerticalLabels(); + } else { + maxHeight = me.drawHorizontalLabels(); + } - /** - * Add a new binding to this KeyMap. The following config object properties are supported: - *
-Property Type Description ----------- --------------- ---------------------------------------------------------------------- -key String/Array A single keycode or an array of keycodes to handle -shift Boolean True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined) -ctrl Boolean True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined) -alt Boolean True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined) -handler Function The function to call when KeyMap finds the expected key combination -fn Function Alias of handler (for backwards-compatibility) -scope Object The scope of the callback function -stopEvent Boolean True to stop the event from bubbling and prevent the default browser action if the key was handled by the KeyMap (defaults to false) -
- * - * Usage: - *
-// Create a KeyMap -var map = new Ext.KeyMap(document, { - key: Ext.EventObject.ENTER, - fn: handleKey, - scope: this -}); + // Hide unused bars + ln = labelGroup.getCount(); + i = inflections.length; + for (; i < ln; i++) { + labelGroup.getAt(i).hide(true); + } -//Add a new binding to the existing KeyMap later -map.addBinding({ - key: 'abc', - shift: true, - fn: handleKey, - scope: this -}); -
- * @param {Object/Array} config A single KeyMap config or an array of configs - */ - addBinding : function(config){ - if(Ext.isArray(config)){ - Ext.each(config, function(c){ - this.addBinding(c); - }, this); - return; + me.bbox = {}; + Ext.apply(me.bbox, me.axisBBox); + me.bbox.height = maxHeight; + me.bbox.width = maxWidth; + if (Ext.isString(me.title)) { + me.drawTitle(maxWidth, maxHeight); } - var keyCode = config.key, - fn = config.fn || config.handler, - scope = config.scope; - - if (config.stopEvent) { - this.stopEvent = config.stopEvent; - } - - if(typeof keyCode == "string"){ - var ks = []; - var keyString = keyCode.toUpperCase(); - for(var j = 0, len = keyString.length; j < len; j++){ - ks.push(keyString.charCodeAt(j)); - } - keyCode = ks; - } - var keyArray = Ext.isArray(keyCode); - - var handler = function(e){ - if(this.checkModifiers(config, e)){ - var k = e.getKey(); - if(keyArray){ - for(var i = 0, len = keyCode.length; i < len; i++){ - if(keyCode[i] == k){ - if(this.stopEvent){ - e.stopEvent(); - } - fn.call(scope || window, k, e); - return; - } - } - }else{ - if(k == keyCode){ - if(this.stopEvent){ - e.stopEvent(); - } - fn.call(scope || window, k, e); - } + }, + + // @private creates the elipsis for the text. + elipsis: function(sprite, text, desiredWidth, minWidth, center) { + var bbox, + x; + + if (desiredWidth < minWidth) { + sprite.hide(true); + return false; + } + while (text.length > 4) { + text = text.substr(0, text.length - 4) + "..."; + sprite.setAttributes({ + text: text + }, true); + bbox = sprite.getBBox(); + if (bbox.width < desiredWidth) { + if (typeof center == 'number') { + sprite.setAttributes({ + x: Math.floor(center - (bbox.width / 2)) + }, true); } - } - }; - this.bindings.push(handler); - }, - - // private - checkModifiers: function(config, e){ - var val, key, keys = ['shift', 'ctrl', 'alt']; - for (var i = 0, len = keys.length; i < len; ++i){ - key = keys[i]; - val = config[key]; - if(!(val === undefined || (val === e[key + 'Key']))){ - return false; + break; } } return true; }, /** - * Shorthand for adding a single key listener - * @param {Number/Array/Object} key Either the numeric key code, array of key codes or an object with the - * following options: - * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} - * @param {Function} fn The function to call - * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to the browser window. + * Updates the {@link #title} of this axis. + * @param {String} title */ - on : function(key, fn, scope){ - var keyCode, shift, ctrl, alt; - if(typeof key == "object" && !Ext.isArray(key)){ - keyCode = key.key; - shift = key.shift; - ctrl = key.ctrl; - alt = key.alt; - }else{ - keyCode = key; - } - this.addBinding({ - key: keyCode, - shift: shift, - ctrl: ctrl, - alt: alt, - fn: fn, - scope: scope - }); + setTitle: function(title) { + this.title = title; + this.drawLabel(); }, - // private - handleKeyDown : function(e){ - if(this.enabled){ //just in case - var b = this.bindings; - for(var i = 0, len = b.length; i < len; i++){ - b[i].call(this, e); - } - } - }, - - /** - * Returns true if this KeyMap is enabled - * @return {Boolean} - */ - isEnabled : function(){ - return this.enabled; - }, - - /** - * Enables this KeyMap - */ - enable: function(){ - if(!this.enabled){ - this.el.on(this.eventName, this.handleKeyDown, this); - this.enabled = true; - } - }, - - /** - * Disable this KeyMap - */ - disable: function(){ - if(this.enabled){ - this.el.removeListener(this.eventName, this.handleKeyDown, this); - this.enabled = false; - } - }, - - /** - * Convenience function for setting disabled/enabled by boolean. - * @param {Boolean} disabled - */ - setDisabled : function(disabled){ - this[disabled ? "disable" : "enable"](); - } -};/** - * @class Ext.util.TextMetrics - * Provides precise pixel measurements for blocks of text so that you can determine exactly how high and - * wide, in pixels, a given block of text will be. Note that when measuring text, it should be plain text and - * should not contain any HTML, otherwise it may not be measured correctly. - * @singleton - */ -Ext.util.TextMetrics = function(){ - var shared; - return { - /** - * Measures the size of the specified text - * @param {String/HTMLElement} el The element, dom node or id from which to copy existing CSS styles - * that can affect the size of the rendered text - * @param {String} text The text to measure - * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width - * in order to accurately measure the text height - * @return {Object} An object containing the text's size {width: (width), height: (height)} - */ - measure : function(el, text, fixedWidth){ - if(!shared){ - shared = Ext.util.TextMetrics.Instance(el, fixedWidth); - } - shared.bind(el); - shared.setFixedWidth(fixedWidth || 'auto'); - return shared.getSize(text); - }, - - /** - * Return a unique TextMetrics instance that can be bound directly to an element and reused. This reduces - * the overhead of multiple calls to initialize the style properties on each measurement. - * @param {String/HTMLElement} el The element, dom node or id that the instance will be bound to - * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width - * in order to accurately measure the text height - * @return {Ext.util.TextMetrics.Instance} instance The new instance - */ - createInstance : function(el, fixedWidth){ - return Ext.util.TextMetrics.Instance(el, fixedWidth); + // @private draws the title for the axis. + drawTitle: function(maxWidth, maxHeight) { + var me = this, + position = me.position, + surface = me.chart.surface, + displaySprite = me.displaySprite, + title = me.title, + rotate = (position == 'left' || position == 'right'), + x = me.x, + y = me.y, + base, bbox, pad; + + if (displaySprite) { + displaySprite.setAttributes({text: title}, true); + } else { + base = { + type: 'text', + x: 0, + y: 0, + text: title + }; + displaySprite = me.displaySprite = surface.add(Ext.apply(base, me.axisTitleStyle, me.labelTitle)); + surface.renderItem(displaySprite); } - }; -}(); + bbox = displaySprite.getBBox(); + pad = me.dashSize + me.label.padding; -Ext.util.TextMetrics.Instance = function(bindTo, fixedWidth){ - var ml = new Ext.Element(document.createElement('div')); - document.body.appendChild(ml.dom); - ml.position('absolute'); - ml.setLeftTop(-1000, -1000); - ml.hide(); - - if(fixedWidth){ - ml.setWidth(fixedWidth); + if (rotate) { + y -= ((me.length / 2) - (bbox.height / 2)); + if (position == 'left') { + x -= (maxWidth + pad + (bbox.width / 2)); + } + else { + x += (maxWidth + pad + bbox.width - (bbox.width / 2)); + } + me.bbox.width += bbox.width + 10; + } + else { + x += (me.length / 2) - (bbox.width * 0.5); + if (position == 'top') { + y -= (maxHeight + pad + (bbox.height * 0.3)); + } + else { + y += (maxHeight + pad + (bbox.height * 0.8)); + } + me.bbox.height += bbox.height + 10; + } + displaySprite.setAttributes({ + translate: { + x: x, + y: y + } + }, true); } +}); +/** + * @class Ext.chart.axis.Category + * @extends Ext.chart.axis.Axis + * + * A type of axis that displays items in categories. This axis is generally used to + * display categorical information like names of items, month names, quarters, etc. + * but no quantitative values. For that other type of information Number + * axis are more suitable. + * + * As with other axis you can set the position of the axis and its title. For example: + * + * {@img Ext.chart.axis.Category/Ext.chart.axis.Category.png Ext.chart.axis.Category chart axis} + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * store: store, + * axes: [{ + * type: 'Numeric', + * grid: true, + * position: 'left', + * fields: ['data1', 'data2', 'data3', 'data4', 'data5'], + * title: 'Sample Values', + * grid: { + * odd: { + * opacity: 1, + * fill: '#ddd', + * stroke: '#bbb', + * 'stroke-width': 1 + * } + * }, + * minimum: 0, + * adjustMinimumByMajorUnit: 0 + * }, { + * type: 'Category', + * position: 'bottom', + * fields: ['name'], + * title: 'Sample Metrics', + * grid: true, + * label: { + * rotate: { + * degrees: 315 + * } + * } + * }], + * series: [{ + * type: 'area', + * highlight: false, + * axis: 'left', + * xField: 'name', + * yField: ['data1', 'data2', 'data3', 'data4', 'data5'], + * style: { + * opacity: 0.93 + * } + * }] + * }); + * + * In this example with set the category axis to the bottom of the surface, bound the axis to + * the name property and set as title Month of the Year. + */ - var instance = { - /** - *
Only available on the instance returned from {@link #createInstance}, not on the singleton.
- * Returns the size of the specified text based on the internal element's style and width properties - * @param {String} text The text to measure - * @return {Object} An object containing the text's size {width: (width), height: (height)} - */ - getSize : function(text){ - ml.update(text); - var s = ml.getSize(); - ml.update(''); - return s; - }, - - /** - *
Only available on the instance returned from {@link #createInstance}, not on the singleton.
- * Binds this TextMetrics instance to an element from which to copy existing CSS styles - * that can affect the size of the rendered text - * @param {String/HTMLElement} el The element, dom node or id - */ - bind : function(el){ - ml.setStyle( - Ext.fly(el).getStyles('font-size','font-style', 'font-weight', 'font-family','line-height', 'text-transform', 'letter-spacing') - ); - }, +Ext.define('Ext.chart.axis.Category', { - /** - *
Only available on the instance returned from {@link #createInstance}, not on the singleton.
- * Sets a fixed width on the internal measurement element. If the text will be multiline, you have - * to set a fixed width in order to accurately measure the text height. - * @param {Number} width The width to set on the element - */ - setFixedWidth : function(width){ - ml.setWidth(width); - }, + /* Begin Definitions */ - /** - *
Only available on the instance returned from {@link #createInstance}, not on the singleton.
- * Returns the measured width of the specified text - * @param {String} text The text to measure - * @return {Number} width The width in pixels - */ - getWidth : function(text){ - ml.dom.style.width = 'auto'; - return this.getSize(text).width; - }, + extend: 'Ext.chart.axis.Axis', - /** - *
Only available on the instance returned from {@link #createInstance}, not on the singleton.
- * Returns the measured height of the specified text. For multiline text, be sure to call - * {@link #setFixedWidth} if necessary. - * @param {String} text The text to measure - * @return {Number} height The height in pixels - */ - getHeight : function(text){ - return this.getSize(text).height; - } - }; + alternateClassName: 'Ext.chart.CategoryAxis', - instance.bind(bindTo); + alias: 'axis.category', - return instance; -}; + /* End Definitions */ -Ext.Element.addMethods({ - /** - * Returns the width in pixels of the passed text, or the width of the text in this Element. - * @param {String} text The text to measure. Defaults to the innerHTML of the element. - * @param {Number} min (Optional) The minumum value to return. - * @param {Number} max (Optional) The maximum value to return. - * @return {Number} The text width in pixels. - * @member Ext.Element getTextWidth - */ - getTextWidth : function(text, min, max){ - return (Ext.util.TextMetrics.measure(this.dom, Ext.value(text, this.dom.innerHTML, true)).width).constrain(min || 0, max || 1000000); - } -}); -/** - * @class Ext.util.Cookies - * Utility class for managing and interacting with cookies. - * @singleton - */ -Ext.util.Cookies = { /** - * 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, "extjs.com" will create a cookie that can be - * accessed from any subdomain of extjs.com, including www.extjs.com, - * support.extjs.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. + * A list of category names to display along this axis. + * + * @property categoryNames + * @type Array */ - set : function(name, value){ - var argv = arguments; - var argc = arguments.length; - var expires = (argc > 2) ? argv[2] : null; - var path = (argc > 3) ? argv[3] : '/'; - var domain = (argc > 4) ? argv[4] : null; - var 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" : ""); - }, + categoryNames: null, /** - * 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. + * 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 */ - get : function(name){ - var arg = name + "="; - var alen = arg.length; - var clen = document.cookie.length; - var i = 0; - var j = 0; - while(i < clen){ - j = i + alen; - if(document.cookie.substring(i, j) == arg){ - return Ext.util.Cookies.getCookieVal(j); - } - i = document.cookie.indexOf(" ", i) + 1; - if(i === 0){ - break; + calculateCategoryCount: false, + + // @private creates an array of labels to be used when rendering. + setLabels: function() { + var store = this.chart.store, + fields = this.fields, + ln = fields.length, + i; + + this.labels = []; + store.each(function(record) { + for (i = 0; i < ln; i++) { + this.labels.push(record.get(fields[i])); } - } - return null; + }, this); }, - /** - * 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 - */ - clear : function(name){ - if(Ext.util.Cookies.get(name)){ - document.cookie = name + "=" + "; expires=Thu, 01-Jan-70 00:00:01 GMT"; - } - }, - /** - * @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 calculates labels positions and marker positions for rendering. + applyData: function() { + this.callParent(); + this.setLabels(); + var count = this.chart.store.getCount(); + return { + from: 0, + to: count, + power: 1, + step: 1, + steps: count - 1 + }; } -};/** - * Framework-wide error-handler. Developers can override this method to provide - * custom exception-handling. Framework errors will often extend from the base - * Ext.Error class. - * @param {Object/Error} e The thrown exception object. - */ -Ext.handleError = function(e) { - throw e; -}; +}); /** - * @class Ext.Error - * @extends Error - *
A base error class. Future implementations are intended to provide more - * robust error handling throughout the framework (in the debug build only) - * to check for common errors and problems. The messages issued by this class - * will aid error checking. Error checks will be automatically removed in the - * production build so that performance is not negatively impacted.
- *
Some sample messages currently implemented:
-"DataProxy attempted to execute an API-action but found an undefined -url / function. Please review your Proxy url/api-configuration." - *
-"Could not locate your "root" property in your server response. -Please review your JsonReader config to ensure the config-property -"root" matches the property your server-response. See the JsonReader -docs for additional assistance." - *
- *
An example of the code used for generating error messages:
-try { - generateError({ - foo: 'bar' - }); -} -catch (e) { - console.error(e); -} -function generateError(data) { - throw new Ext.Error('foo-error', data); -} - *
- * @param {String} message + * @class Ext.chart.axis.Gauge + * @extends Ext.chart.axis.Abstract + * + * Gauge Axis is the axis to be used with a Gauge series. The Gauge axis + * displays numeric data from an interval defined by the `minimum`, `maximum` and + * `step` configuration properties. The placement of the numeric data can be changed + * by altering the `margin` option that is set to `10` by default. + * + * A possible configuration for this axis would look like: + * + * axes: [{ + * type: 'gauge', + * position: 'gauge', + * minimum: 0, + * maximum: 100, + * steps: 10, + * margin: 7 + * }], */ -Ext.Error = function(message) { - // Try to read the message from Ext.Error.lang - this.message = (this.lang[message]) ? this.lang[message] : message; -}; +Ext.define('Ext.chart.axis.Gauge', { -Ext.Error.prototype = new Error(); -Ext.apply(Ext.Error.prototype, { - // protected. Extensions place their error-strings here. - lang: {}, + /* Begin Definitions */ - name: 'Ext.Error', + extend: 'Ext.chart.axis.Abstract', + + /* End Definitions */ + /** - * getName - * @return {String} + * @cfg {Number} minimum (required) the minimum value of the interval to be displayed in the axis. */ - getName : function() { - return this.name; - }, + /** - * getMessage - * @return {String} + * @cfg {Number} maximum (required) the maximum value of the interval to be displayed in the axis. */ - getMessage : function() { - return this.message; - }, + /** - * toJson - * @return {String} + * @cfg {Number} steps (required) the number of steps and tick marks to add to the interval. */ - toJson : function() { - return Ext.encode(this); - } -}); -/** - * @class Ext.ComponentMgr - *
Provides a registry of all Components (instances of {@link Ext.Component} or any subclass - * thereof) on a page so that they can be easily accessed by {@link Ext.Component component} - * {@link Ext.Component#id id} (see {@link #get}, or the convenience method {@link Ext#getCmp Ext.getCmp}).
- *
This object also provides a registry of available Component classes - * indexed by a mnemonic code known as the Component's {@link Ext.Component#xtype xtype}. - * The {@link Ext.Component#xtype xtype} provides a way to avoid instantiating child Components - * when creating a full, nested config object for a complete Ext page.
- *
A child Component may be specified simply as a config object - * as long as the correct {@link Ext.Component#xtype xtype} is specified so that if and when the Component - * needs rendering, the correct type can be looked up for lazy instantiation.
- *
For a list of all available {@link Ext.Component#xtype xtypes}, see {@link Ext.Component}.
- * @singleton - */ -Ext.ComponentMgr = function(){ - var all = new Ext.util.MixedCollection(); - var types = {}; - var ptypes = {}; - - return { - /** - * Registers a component. - * @param {Ext.Component} c The component - */ - register : function(c){ - all.add(c); - }, - - /** - * Unregisters a component. - * @param {Ext.Component} c The component - */ - unregister : function(c){ - all.remove(c); - }, - /** - * Returns a component by {@link Ext.Component#id id}. - * For additional details see {@link Ext.util.MixedCollection#get}. - * @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. - */ - get : function(id){ - return all.get(id); - }, + /** + * @cfg {Number} margin (optional) the offset positioning of the tick marks and labels in pixels. Default's 10. + */ - /** - * Registers a function that will be called when a Component with the specified id is added to ComponentMgr. This will happen on instantiation. - * @param {String} id The component {@link Ext.Component#id id} - * @param {Function} fn The callback function - * @param {Object} scope The scope (this reference) in which the callback is executed. Defaults to the Component. - */ - onAvailable : function(id, fn, scope){ - all.on("add", function(index, o){ - if(o.id == id){ - fn.call(scope || o, o); - all.un("add", fn, scope); - } - }); - }, + position: 'gauge', - /** - * The MixedCollection used internally for the component cache. An example usage may be subscribing to - * events on the MixedCollection to monitor addition or removal. Read-only. - * @type {MixedCollection} - */ - all : all, - - /** - * The xtypes that have been registered with the component manager. - * @type {Object} - */ - types : types, - - /** - * The ptypes that have been registered with the component manager. - * @type {Object} - */ - ptypes: ptypes, - - /** - * Checks if a Component type is registered. - * @param {Ext.Component} xtype The mnemonic string by which the Component class may be looked up - * @return {Boolean} Whether the type is registered. - */ - isRegistered : function(xtype){ - return types[xtype] !== undefined; - }, - - /** - * Checks if a Plugin type is registered. - * @param {Ext.Component} ptype The mnemonic string by which the Plugin class may be looked up - * @return {Boolean} Whether the type is registered. - */ - isPluginRegistered : function(ptype){ - return ptypes[ptype] !== undefined; - }, - - /** - *
Registers a new Component constructor, keyed by a new - * {@link Ext.Component#xtype}.
- *
Use this method (or its alias {@link Ext#reg Ext.reg}) to register new - * subclasses of {@link Ext.Component} so that lazy instantiation may be used when specifying - * child Components. - * see {@link Ext.Container#items}
- * @param {String} xtype The mnemonic string by which the Component class may be looked up. - * @param {Constructor} cls The new Component class. - */ - registerType : function(xtype, cls){ - types[xtype] = cls; - cls.xtype = xtype; - }, + alias: 'axis.gauge', - /** - * Creates a new Component from the specified config object using the - * config object's {@link Ext.component#xtype xtype} to determine the class to instantiate. - * @param {Object} config A configuration object for the Component you wish to create. - * @param {Constructor} defaultType The constructor to provide the default Component type if - * the config object does not contain a xtype. (Optional if the config contains a xtype). - * @return {Ext.Component} The newly instantiated Component. - */ - create : function(config, defaultType){ - return config.render ? config : new types[config.xtype || defaultType](config); - }, + drawAxis: function(init) { + var chart = this.chart, + surface = chart.surface, + bbox = chart.chartBBox, + centerX = bbox.x + (bbox.width / 2), + centerY = bbox.y + bbox.height, + margin = this.margin || 10, + rho = Math.min(bbox.width, 2 * bbox.height) /2 + margin, + sprites = [], sprite, + steps = this.steps, + i, pi = Math.PI, + cos = Math.cos, + sin = Math.sin; - /** - *
Registers a new Plugin constructor, keyed by a new - * {@link Ext.Component#ptype}.
- *
Use this method (or its alias {@link Ext#preg Ext.preg}) to register new - * plugins for {@link Ext.Component}s so that lazy instantiation may be used when specifying - * Plugins.
- * @param {String} ptype The mnemonic string by which the Plugin class may be looked up. - * @param {Constructor} cls The new Plugin class. - */ - registerPlugin : function(ptype, cls){ - ptypes[ptype] = cls; - cls.ptype = ptype; - }, + if (this.sprites && !chart.resizing) { + this.drawLabel(); + return; + } - /** - * Creates a new Plugin from the specified config object using the - * config object's {@link Ext.component#ptype ptype} to determine the class to instantiate. - * @param {Object} config A configuration object for the Plugin you wish to create. - * @param {Constructor} defaultType The constructor to provide the default Plugin type if - * the config object does not contain a ptype. (Optional if the config contains a ptype). - * @return {Ext.Component} The newly instantiated Plugin. - */ - createPlugin : function(config, defaultType){ - var PluginCls = ptypes[config.ptype || defaultType]; - if (PluginCls.init) { - return PluginCls; + if (this.margin >= 0) { + if (!this.sprites) { + //draw circles + for (i = 0; i <= steps; i++) { + sprite = surface.add({ + type: 'path', + path: ['M', centerX + (rho - margin) * cos(i / steps * pi - pi), + centerY + (rho - margin) * sin(i / steps * pi - pi), + 'L', centerX + rho * cos(i / steps * pi - pi), + centerY + rho * sin(i / steps * pi - pi), 'Z'], + stroke: '#ccc' + }); + sprite.setAttributes({ + hidden: false + }, true); + sprites.push(sprite); + } } else { - return new PluginCls(config); - } + sprites = this.sprites; + //draw circles + for (i = 0; i <= steps; i++) { + sprites[i].setAttributes({ + path: ['M', centerX + (rho - margin) * cos(i / steps * pi - pi), + centerY + (rho - margin) * sin(i / steps * pi - pi), + 'L', centerX + rho * cos(i / steps * pi - pi), + centerY + rho * sin(i / steps * pi - pi), 'Z'], + stroke: '#ccc' + }, true); + } + } } - }; -}(); + this.sprites = sprites; + this.drawLabel(); + if (this.title) { + this.drawTitle(); + } + }, + + drawTitle: function() { + var me = this, + chart = me.chart, + surface = chart.surface, + bbox = chart.chartBBox, + labelSprite = me.titleSprite, + labelBBox; + + if (!labelSprite) { + me.titleSprite = labelSprite = surface.add({ + type: 'text', + zIndex: 2 + }); + } + labelSprite.setAttributes(Ext.apply({ + text: me.title + }, me.label || {}), true); + labelBBox = labelSprite.getBBox(); + labelSprite.setAttributes({ + x: bbox.x + (bbox.width / 2) - (labelBBox.width / 2), + y: bbox.y + bbox.height - (labelBBox.height / 2) - 4 + }, true); + }, + /** + * Updates the {@link #title} of this axis. + * @param {String} title + */ + setTitle: function(title) { + this.title = title; + this.drawTitle(); + }, + + drawLabel: function() { + var chart = this.chart, + surface = chart.surface, + bbox = chart.chartBBox, + centerX = bbox.x + (bbox.width / 2), + centerY = bbox.y + bbox.height, + margin = this.margin || 10, + rho = Math.min(bbox.width, 2 * bbox.height) /2 + 2 * margin, + round = Math.round, + labelArray = [], label, + maxValue = this.maximum || 0, + steps = this.steps, i = 0, + adjY, + pi = Math.PI, + cos = Math.cos, + sin = Math.sin, + labelConf = this.label, + renderer = labelConf.renderer || function(v) { return v; }; + + if (!this.labelArray) { + //draw scale + for (i = 0; i <= steps; i++) { + // TODO Adjust for height of text / 2 instead + adjY = (i === 0 || i === steps) ? 7 : 0; + label = surface.add({ + type: 'text', + text: renderer(round(i / steps * maxValue)), + x: centerX + rho * cos(i / steps * pi - pi), + y: centerY + rho * sin(i / steps * pi - pi) - adjY, + 'text-anchor': 'middle', + 'stroke-width': 0.2, + zIndex: 10, + stroke: '#333' + }); + label.setAttributes({ + hidden: false + }, true); + labelArray.push(label); + } + } + else { + labelArray = this.labelArray; + //draw values + for (i = 0; i <= steps; i++) { + // TODO Adjust for height of text / 2 instead + adjY = (i === 0 || i === steps) ? 7 : 0; + labelArray[i].setAttributes({ + text: renderer(round(i / steps * maxValue)), + x: centerX + rho * cos(i / steps * pi - pi), + y: centerY + rho * sin(i / steps * pi - pi) - adjY + }, true); + } + } + this.labelArray = labelArray; + } +}); /** - * Shorthand for {@link Ext.ComponentMgr#registerType} - * @param {String} xtype The {@link Ext.component#xtype mnemonic string} by which the Component class - * may be looked up. - * @param {Constructor} cls The new Component class. - * @member Ext - * @method reg - */ -Ext.reg = Ext.ComponentMgr.registerType; // this will be called a lot internally, shorthand to keep the bytes down -/** - * Shorthand for {@link Ext.ComponentMgr#registerPlugin} - * @param {String} ptype The {@link Ext.component#ptype mnemonic string} by which the Plugin class - * may be looked up. - * @param {Constructor} cls The new Plugin class. - * @member Ext - * @method preg - */ -Ext.preg = Ext.ComponentMgr.registerPlugin; -/** - * Shorthand for {@link Ext.ComponentMgr#create} - * Creates a new Component from the specified config object using the - * config object's {@link Ext.component#xtype xtype} to determine the class to instantiate. - * @param {Object} config A configuration object for the Component you wish to create. - * @param {Constructor} defaultType The constructor to provide the default Component type if - * the config object does not contain a xtype. (Optional if the config contains a xtype). - * @return {Ext.Component} The newly instantiated Component. - * @member Ext - * @method create - */ -Ext.create = Ext.ComponentMgr.create;/** - * @class Ext.Component - * @extends Ext.util.Observable - *
Base class for all Ext components. All subclasses of Component may participate in the automated - * Ext component lifecycle of creation, rendering and destruction which is provided by the {@link Ext.Container Container} class. - * Components may be added to a Container through the {@link Ext.Container#items items} config option at the time the Container is created, - * or they may be added dynamically via the {@link Ext.Container#add add} method.
- *
The Component base class has built-in support for basic hide/show and enable/disable behavior.
- *
All Components are registered with the {@link Ext.ComponentMgr} on construction so that they can be referenced at any time via - * {@link Ext#getCmp}, passing the {@link #id}.
- *
All user-developed visual widgets that are required to participate in automated lifecycle and size management should subclass Component (or - * {@link Ext.BoxComponent} if managed box model handling is required, ie height and width management).
- *
See the Creating new UI controls tutorial for details on how - * and to either extend or augment ExtJs base classes to create custom Components.
- *
Every component has a specific xtype, which is its Ext-specific type name, along with methods for checking the - * xtype like {@link #getXType} and {@link #isXType}. This is the list of all valid xtypes:
- *
-xtype Class -------------- ------------------ -box {@link Ext.BoxComponent} -button {@link Ext.Button} -buttongroup {@link Ext.ButtonGroup} -colorpalette {@link Ext.ColorPalette} -component {@link Ext.Component} -container {@link Ext.Container} -cycle {@link Ext.CycleButton} -dataview {@link Ext.DataView} -datepicker {@link Ext.DatePicker} -editor {@link Ext.Editor} -editorgrid {@link Ext.grid.EditorGridPanel} -flash {@link Ext.FlashComponent} -grid {@link Ext.grid.GridPanel} -listview {@link Ext.ListView} -panel {@link Ext.Panel} -progress {@link Ext.ProgressBar} -propertygrid {@link Ext.grid.PropertyGrid} -slider {@link Ext.Slider} -spacer {@link Ext.Spacer} -splitbutton {@link Ext.SplitButton} -tabpanel {@link Ext.TabPanel} -treepanel {@link Ext.tree.TreePanel} -viewport {@link Ext.ViewPort} -window {@link Ext.Window} - -Toolbar components ---------------------------------------- -paging {@link Ext.PagingToolbar} -toolbar {@link Ext.Toolbar} -tbbutton {@link Ext.Toolbar.Button} (deprecated; use button) -tbfill {@link Ext.Toolbar.Fill} -tbitem {@link Ext.Toolbar.Item} -tbseparator {@link Ext.Toolbar.Separator} -tbspacer {@link Ext.Toolbar.Spacer} -tbsplit {@link Ext.Toolbar.SplitButton} (deprecated; use splitbutton) -tbtext {@link Ext.Toolbar.TextItem} - -Menu components ---------------------------------------- -menu {@link Ext.menu.Menu} -colormenu {@link Ext.menu.ColorMenu} -datemenu {@link Ext.menu.DateMenu} -menubaseitem {@link Ext.menu.BaseItem} -menucheckitem {@link Ext.menu.CheckItem} -menuitem {@link Ext.menu.Item} -menuseparator {@link Ext.menu.Separator} -menutextitem {@link Ext.menu.TextItem} - -Form components ---------------------------------------- -form {@link Ext.form.FormPanel} -checkbox {@link Ext.form.Checkbox} -checkboxgroup {@link Ext.form.CheckboxGroup} -combo {@link Ext.form.ComboBox} -datefield {@link Ext.form.DateField} -displayfield {@link Ext.form.DisplayField} -field {@link Ext.form.Field} -fieldset {@link Ext.form.FieldSet} -hidden {@link Ext.form.Hidden} -htmleditor {@link Ext.form.HtmlEditor} -label {@link Ext.form.Label} -numberfield {@link Ext.form.NumberField} -radio {@link Ext.form.Radio} -radiogroup {@link Ext.form.RadioGroup} -textarea {@link Ext.form.TextArea} -textfield {@link Ext.form.TextField} -timefield {@link Ext.form.TimeField} -trigger {@link Ext.form.TriggerField} - -Chart components ---------------------------------------- -chart {@link Ext.chart.Chart} -barchart {@link Ext.chart.BarChart} -cartesianchart {@link Ext.chart.CartesianChart} -columnchart {@link Ext.chart.ColumnChart} -linechart {@link Ext.chart.LineChart} -piechart {@link Ext.chart.PieChart} - -Store xtypes ---------------------------------------- -arraystore {@link Ext.data.ArrayStore} -directstore {@link Ext.data.DirectStore} -groupingstore {@link Ext.data.GroupingStore} -jsonstore {@link Ext.data.JsonStore} -simplestore {@link Ext.data.SimpleStore} (deprecated; use arraystore) -store {@link Ext.data.Store} -xmlstore {@link Ext.data.XmlStore} -
+ * @class Ext.chart.axis.Numeric + * @extends Ext.chart.axis.Axis + * + * An axis to handle numeric values. This axis is used for quantitative data as + * opposed to the category axis. You can set mininum and maximum values to the + * axis so that the values are bound to that. If no values are set, then the + * scale will auto-adjust to the values. + * + * {@img Ext.chart.axis.Numeric/Ext.chart.axis.Numeric.png Ext.chart.axis.Numeric chart axis} + * + * For example: + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * store: store, + * axes: [{ + * type: 'Numeric', + * grid: true, + * position: 'left', + * fields: ['data1', 'data2', 'data3', 'data4', 'data5'], + * title: 'Sample Values', + * grid: { + * odd: { + * opacity: 1, + * fill: '#ddd', + * stroke: '#bbb', + * 'stroke-width': 1 + * } + * }, + * minimum: 0, + * adjustMinimumByMajorUnit: 0 + * }, { + * type: 'Category', + * position: 'bottom', + * fields: ['name'], + * title: 'Sample Metrics', + * grid: true, + * label: { + * rotate: { + * degrees: 315 + * } + * } + * }], + * series: [{ + * type: 'area', + * highlight: false, + * axis: 'left', + * xField: 'name', + * yField: ['data1', 'data2', 'data3', 'data4', 'data5'], + * style: { + * opacity: 0.93 + * } + * }] + * }); + * + * In this example we create an axis of Numeric type. We set a minimum value so that + * even if all series have values greater than zero, the grid starts at zero. We bind + * the axis onto the left part of the surface by setting position to left. + * We bind three different store fields to this axis by setting fields to an array. + * We set the title of the axis to Number of Hits by using the title property. + * We use a grid configuration to set odd background rows to a certain style and even rows + * to be transparent/ignored. + * * @constructor - * @param {Ext.Element/String/Object} config The configuration options may be specified as either: - *
- *
an element : - *
it is set as the internal element and its id used as the component id
- *
a string : - *
it is assumed to be the id of an existing element and is used as the component id
- *
anything else : - *
it is assumed to be a standard config object and is applied to the component
- *
*/ -Ext.Component = function(config){ - config = config || {}; - if(config.initialConfig){ - if(config.isAction){ // actions - this.baseAction = config; - } - config = config.initialConfig; // component cloning / action set up - }else if(config.tagName || config.dom || Ext.isString(config)){ // element object - config = {applyTo: config, id: config.id || config}; - } - - /** - * This Component's initial configuration specification. Read-only. - * @type Object - * @property initialConfig - */ - this.initialConfig = config; +Ext.define('Ext.chart.axis.Numeric', { - Ext.apply(this, config); - this.addEvents( - /** - * @event added - * Fires when a component is added to an Ext.Container - * @param {Ext.Component} this - * @param {Ext.Container} ownerCt Container which holds the component - * @param {number} index Position at which the component was added - */ - 'added', - /** - * @event disable - * Fires after the component is disabled. - * @param {Ext.Component} this - */ - 'disable', - /** - * @event enable - * Fires after the component is enabled. - * @param {Ext.Component} this - */ - 'enable', - /** - * @event beforeshow - * Fires before the component is shown by calling the {@link #show} method. - * Return false from an event handler to stop the show. - * @param {Ext.Component} this - */ - 'beforeshow', - /** - * @event show - * Fires after the component is shown when calling the {@link #show} method. - * @param {Ext.Component} this - */ - 'show', - /** - * @event beforehide - * Fires before the component is hidden by calling the {@link #hide} method. - * Return false from an event handler to stop the hide. - * @param {Ext.Component} this - */ - 'beforehide', - /** - * @event hide - * Fires after the component is hidden. - * Fires after the component is hidden when calling the {@link #hide} method. - * @param {Ext.Component} this - */ - 'hide', - /** - * @event removed - * Fires when a component is removed from an Ext.Container - * @param {Ext.Component} this - * @param {Ext.Container} ownerCt Container which holds the component - */ - 'removed', - /** - * @event beforerender - * Fires before the component is {@link #rendered}. Return false from an - * event handler to stop the {@link #render}. - * @param {Ext.Component} this - */ - 'beforerender', - /** - * @event render - * Fires after the component markup is {@link #rendered}. - * @param {Ext.Component} this - */ - 'render', - /** - * @event afterrender - *
Fires after the component rendering is finished.
- *
The afterrender event is fired after this Component has been {@link #rendered}, been postprocesed - * by any afterRender method defined for the Component, and, if {@link #stateful}, after state - * has been restored.
- * @param {Ext.Component} this - */ - 'afterrender', - /** - * @event beforedestroy - * Fires before the component is {@link #destroy}ed. Return false from an event handler to stop the {@link #destroy}. - * @param {Ext.Component} this - */ - 'beforedestroy', - /** - * @event destroy - * Fires after the component is {@link #destroy}ed. - * @param {Ext.Component} this - */ - 'destroy', - /** - * @event beforestaterestore - * Fires before the state of the component is restored. Return false from an event handler to stop the restore. - * @param {Ext.Component} this - * @param {Object} state The hash of state values returned from the StateProvider. If this - * event is not vetoed, then the state object is passed to applyState. By default, - * that simply copies property values into this Component. The method maybe overriden to - * provide custom state restoration. - */ - 'beforestaterestore', - /** - * @event staterestore - * Fires after the state of the component is restored. - * @param {Ext.Component} this - * @param {Object} state The hash of state values returned from the StateProvider. This is passed - * to applyState. By default, that simply copies property values into this - * Component. The method maybe overriden to provide custom state restoration. - */ - 'staterestore', - /** - * @event beforestatesave - * Fires before the state of the component is saved to the configured state provider. Return false to stop the save. - * @param {Ext.Component} this - * @param {Object} state The hash of state values. This is determined by calling - * getState() on the Component. This method must be provided by the - * developer to return whetever representation of state is required, by default, Ext.Component - * has a null implementation. - */ - 'beforestatesave', - /** - * @event statesave - * Fires after the state of the component is saved to the configured state provider. - * @param {Ext.Component} this - * @param {Object} state The hash of state values. This is determined by calling - * getState() on the Component. This method must be provided by the - * developer to return whetever representation of state is required, by default, Ext.Component - * has a null implementation. - */ - 'statesave' - ); - this.getId(); - Ext.ComponentMgr.register(this); - Ext.Component.superclass.constructor.call(this); + /* Begin Definitions */ - if(this.baseAction){ - this.baseAction.addComponent(this); - } + extend: 'Ext.chart.axis.Axis', - this.initComponent(); + alternateClassName: 'Ext.chart.NumericAxis', - if(this.plugins){ - if(Ext.isArray(this.plugins)){ - for(var i = 0, len = this.plugins.length; i < len; i++){ - this.plugins[i] = this.initPlugin(this.plugins[i]); - } - }else{ - this.plugins = this.initPlugin(this.plugins); - } - } + /* End Definitions */ - if(this.stateful !== false){ - this.initState(); - } + type: 'numeric', - if(this.applyTo){ - this.applyToMarkup(this.applyTo); - delete this.applyTo; - }else if(this.renderTo){ - this.render(this.renderTo); - delete this.renderTo; - } -}; + alias: 'axis.numeric', -// private -Ext.Component.AUTO_ID = 1000; - -Ext.extend(Ext.Component, Ext.util.Observable, { - // Configs below are used for all Components when rendered by FormLayout. - /** - * @cfg {String} fieldLabel
The label text to display next to this Component (defaults to '').
- *
Note: this config is only used when this Component is rendered by a Container which - * has been configured to use the {@link Ext.layout.FormLayout FormLayout} layout manager (e.g. - * {@link Ext.form.FormPanel} or specifying layout:'form').

- *
Also see {@link #hideLabel} and - * {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl}.
- * Example use:
-new Ext.FormPanel({ - height: 100, - renderTo: Ext.getBody(), - items: [{ - xtype: 'textfield', - fieldLabel: 'Name' - }] -}); -
- */ - /** - * @cfg {String} labelStyle
A CSS style specification string to apply directly to this field's - * label. Defaults to the container's labelStyle value if set (e.g., - * {@link Ext.layout.FormLayout#labelStyle} , or '').
- *
Note: see the note for {@link #clearCls}.

- *
Also see {@link #hideLabel} and - * {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl}.
- * Example use:
-new Ext.FormPanel({ - height: 100, - renderTo: Ext.getBody(), - items: [{ - xtype: 'textfield', - fieldLabel: 'Name', - labelStyle: 'font-weight:bold;' - }] -}); -
- */ - /** - * @cfg {String} labelSeparator
The separator to display after the text of each - * {@link #fieldLabel}. This property may be configured at various levels. - * The order of precedence is: - *
- *
field / component level
- *
container level
- *
{@link Ext.layout.FormLayout#labelSeparator layout level} (defaults to colon ':')
- *
- * To display no separator for this field's label specify empty string ''.
- *
Note: see the note for {@link #clearCls}.

- *
Also see {@link #hideLabel} and - * {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl}.
- * Example use:
-new Ext.FormPanel({ - height: 100, - renderTo: Ext.getBody(), - layoutConfig: { - labelSeparator: '~' // layout config has lowest priority (defaults to ':') + constructor: function(config) { + var me = this, label, f; + me.callParent([config]); + label = me.label; + if (me.roundToDecimal === false) { + return; + } + if (label.renderer) { + f = label.renderer; + label.renderer = function(v) { + return me.roundToDecimal( f(v), me.decimals ); + }; + } else { + label.renderer = function(v) { + return me.roundToDecimal(v, me.decimals); + }; + } }, - {@link Ext.layout.FormLayout#labelSeparator labelSeparator}: '>>', // config at container level - items: [{ - xtype: 'textfield', - fieldLabel: 'Field 1', - labelSeparator: '...' // field/component level config supersedes others - },{ - xtype: 'textfield', - fieldLabel: 'Field 2' // labelSeparator will be '=' - }] -}); -
- */ - /** - * @cfg {Boolean} hideLabel
true to completely hide the label element - * ({@link #fieldLabel label} and {@link #labelSeparator separator}). Defaults to false. - * By default, even if you do not specify a {@link #fieldLabel} the space will still be - * reserved so that the field will line up with other fields that do have labels. - * Setting this to true will cause the field to not reserve that space.
- *
Note: see the note for {@link #clearCls}.

- * Example use:
-new Ext.FormPanel({ - height: 100, - renderTo: Ext.getBody(), - items: [{ - xtype: 'textfield' - hideLabel: true - }] -}); -
- */ - /** - * @cfg {String} clearCls
The CSS class used to to apply to the special clearing div rendered - * directly after each form field wrapper to provide field clearing (defaults to - * 'x-form-clear-left').
- *
Note: this config is only used when this Component is rendered by a Container - * which has been configured to use the {@link Ext.layout.FormLayout FormLayout} layout - * manager (e.g. {@link Ext.form.FormPanel} or specifying layout:'form') and either a - * {@link #fieldLabel} is specified or isFormField=true is specified.

- *
See {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl} also.
- */ - /** - * @cfg {String} itemCls - *
Note: this config is only used when this Component is rendered by a Container which - * has been configured to use the {@link Ext.layout.FormLayout FormLayout} layout manager (e.g. - * {@link Ext.form.FormPanel} or specifying layout:'form').

- *
An additional CSS class to apply to the div wrapping the form item - * element of this field. If supplied, itemCls at the field level will override - * the default itemCls supplied at the container level. The value specified for - * itemCls will be added to the default class ('x-form-item').
- *
Since it is applied to the item wrapper (see - * {@link Ext.layout.FormLayout}.{@link Ext.layout.FormLayout#fieldTpl fieldTpl}), it allows - * you to write standard CSS rules that can apply to the field, the label (if specified), or - * any other element within the markup for the field.
- *
Note: see the note for {@link #fieldLabel}.

- * Example use:
-// Apply a style to the field's label: -<style> - .required .x-form-item-label {font-weight:bold;color:red;} -</style> - -new Ext.FormPanel({ - height: 100, - renderTo: Ext.getBody(), - items: [{ - xtype: 'textfield', - fieldLabel: 'Name', - itemCls: 'required' //this label will be styled - },{ - xtype: 'textfield', - fieldLabel: 'Favorite Color' - }] -}); -
+ + roundToDecimal: function(v, dec) { + var val = Math.pow(10, dec || 0); + return ((v * val) >> 0) / val; + }, + + /** + * The minimum value drawn by the axis. If not set explicitly, the axis + * minimum will be calculated automatically. + * + * @property minimum + * @type Number */ + minimum: NaN, /** - * @cfg {String} id - *
The unique id of this component (defaults to an {@link #getId auto-assigned id}). - * You should assign an id if you need to be able to access the component later and you do - * not have an object reference available (e.g., using {@link Ext}.{@link Ext#getCmp getCmp}).
- *
Note that this id will also be used as the element id for the containing HTML element - * that is rendered to the page for this component. This allows you to write id-based CSS - * rules to style the specific instance of this component uniquely, and also to select - * sub-elements using this component's id as the parent.
- *
Note: to avoid complications imposed by a unique id also see - * {@link #itemId} and {@link #ref}.
- *
Note: to access the container of an item see {@link #ownerCt}.
+ * The maximum value drawn by the axis. If not set explicitly, the axis + * maximum will be calculated automatically. + * + * @property maximum + * @type Number */ + maximum: NaN, + /** - * @cfg {String} itemId - *
An itemId can be used as an alternative way to get a reference to a component - * when no object reference is available. Instead of using an {@link #id} with - * {@link Ext}.{@link Ext#getCmp getCmp}, use itemId with - * {@link Ext.Container}.{@link Ext.Container#getComponent getComponent} which will retrieve - * itemId's or {@link #id}'s. Since itemId's are an index to the - * container's internal MixedCollection, the itemId is scoped locally to the container -- - * avoiding potential conflicts with {@link Ext.ComponentMgr} which requires a unique - * {@link #id}.
- *
-var c = new Ext.Panel({ // - {@link Ext.BoxComponent#height height}: 300, - {@link #renderTo}: document.body, - {@link Ext.Container#layout layout}: 'auto', - {@link Ext.Container#items items}: [ - { - itemId: 'p1', - {@link Ext.Panel#title title}: 'Panel 1', - {@link Ext.BoxComponent#height height}: 150 - }, - { - itemId: 'p2', - {@link Ext.Panel#title title}: 'Panel 2', - {@link Ext.BoxComponent#height height}: 150 - } - ] -}) -p1 = c.{@link Ext.Container#getComponent getComponent}('p1'); // not the same as {@link Ext#getCmp Ext.getCmp()} -p2 = p1.{@link #ownerCt}.{@link Ext.Container#getComponent getComponent}('p2'); // reference via a sibling - *
- *
Also see {@link #id} and {@link #ref}.
- *
Note: to access the container of an item see {@link #ownerCt}.
+ * The number of decimals to round the value to. + * Default's 2. + * + * @property decimals + * @type Number */ + decimals: 2, + /** - * @cfg {String} xtype - * The registered xtype to create. This config option is not used when passing - * a config object into a constructor. This config option is used only when - * lazy instantiation is being used, and a child item of a Container is being - * specified not as a fully instantiated Component, but as a Component config - * object. The xtype will be looked up at render time up to determine what - * type of child Component to create.

- * The predefined xtypes are listed {@link Ext.Component here}. - *

- * If you subclass Components to create your own Components, you may register - * them using {@link Ext.ComponentMgr#registerType} in order to be able to - * take advantage of lazy instantiation and rendering. - */ - /** - * @cfg {String} ptype - * The registered ptype to create. This config option is not used when passing - * a config object into a constructor. This config option is used only when - * lazy instantiation is being used, and a Plugin is being - * specified not as a fully instantiated Component, but as a Component config - * object. The ptype will be looked up at render time up to determine what - * type of Plugin to create.

- * If you create your own Plugins, you may register them using - * {@link Ext.ComponentMgr#registerPlugin} in order to be able to - * take advantage of lazy instantiation and rendering. + * The scaling algorithm to use on this axis. May be "linear" or + * "logarithmic". + * + * @property scale + * @type String */ + scale: "linear", + /** - * @cfg {String} cls - * An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be - * useful for adding customized styles to the component or any of its children using standard CSS rules. + * Indicates the position of the axis relative to the chart + * + * @property position + * @type String */ + position: 'left', + /** - * @cfg {String} overCls - * An optional extra CSS class that will be added to this component's Element when the mouse moves - * over the Element, and removed when the mouse moves out. (defaults to ''). This can be - * useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. + * Indicates whether to extend maximum beyond data's maximum to the nearest + * majorUnit. + * + * @property adjustMaximumByMajorUnit + * @type Boolean */ + adjustMaximumByMajorUnit: false, + /** - * @cfg {String} style - * A custom style specification to be applied to this component's Element. Should be a valid argument to - * {@link Ext.Element#applyStyles}. - *
-new Ext.Panel({ - title: 'Some Title', - renderTo: Ext.getBody(), - width: 400, height: 300, - layout: 'form', - items: [{ - xtype: 'textarea', - style: { - width: '95%', - marginBottom: '10px' + * Indicates whether to extend the minimum beyond data's minimum to the + * nearest majorUnit. + * + * @property adjustMinimumByMajorUnit + * @type Boolean + */ + adjustMinimumByMajorUnit: false, + + // @private apply data. + applyData: function() { + this.callParent(); + return this.calcEnds(); + } +}); + +/** + * @class Ext.chart.axis.Radial + * @extends Ext.chart.axis.Abstract + * @ignore + */ +Ext.define('Ext.chart.axis.Radial', { + + /* Begin Definitions */ + + extend: 'Ext.chart.axis.Abstract', + + /* End Definitions */ + + position: 'radial', + + alias: 'axis.radial', + + drawAxis: function(init) { + var chart = this.chart, + surface = chart.surface, + bbox = chart.chartBBox, + store = chart.store, + l = store.getCount(), + centerX = bbox.x + (bbox.width / 2), + centerY = bbox.y + (bbox.height / 2), + rho = Math.min(bbox.width, bbox.height) /2, + sprites = [], sprite, + steps = this.steps, + i, j, pi2 = Math.PI * 2, + cos = Math.cos, sin = Math.sin; + + if (this.sprites && !chart.resizing) { + this.drawLabel(); + return; } - }, - new Ext.Button({ - text: 'Send', - minWidth: '100', - style: { - marginBottom: '10px' + + if (!this.sprites) { + //draw circles + for (i = 1; i <= steps; i++) { + sprite = surface.add({ + type: 'circle', + x: centerX, + y: centerY, + radius: Math.max(rho * i / steps, 0), + stroke: '#ccc' + }); + sprite.setAttributes({ + hidden: false + }, true); + sprites.push(sprite); + } + //draw lines + store.each(function(rec, i) { + sprite = surface.add({ + type: 'path', + path: ['M', centerX, centerY, 'L', centerX + rho * cos(i / l * pi2), centerY + rho * sin(i / l * pi2), 'Z'], + stroke: '#ccc' + }); + sprite.setAttributes({ + hidden: false + }, true); + sprites.push(sprite); + }); + } else { + sprites = this.sprites; + //draw circles + for (i = 0; i < steps; i++) { + sprites[i].setAttributes({ + x: centerX, + y: centerY, + radius: Math.max(rho * (i + 1) / steps, 0), + stroke: '#ccc' + }, true); + } + //draw lines + store.each(function(rec, j) { + sprites[i + j].setAttributes({ + path: ['M', centerX, centerY, 'L', centerX + rho * cos(j / l * pi2), centerY + rho * sin(j / l * pi2), 'Z'], + stroke: '#ccc' + }, true); + }); + } + this.sprites = sprites; + + this.drawLabel(); + }, + + drawLabel: function() { + var chart = this.chart, + surface = chart.surface, + bbox = chart.chartBBox, + store = chart.store, + centerX = bbox.x + (bbox.width / 2), + centerY = bbox.y + (bbox.height / 2), + rho = Math.min(bbox.width, bbox.height) /2, + max = Math.max, round = Math.round, + labelArray = [], label, + fields = [], nfields, + categories = [], xField, + aggregate = !this.maximum, + maxValue = this.maximum || 0, + steps = this.steps, i = 0, j, dx, dy, + pi2 = Math.PI * 2, + cos = Math.cos, sin = Math.sin, + display = this.label.display, + draw = display !== 'none', + margin = 10; + + if (!draw) { + return; + } + + //get all rendered fields + chart.series.each(function(series) { + fields.push(series.yField); + xField = series.xField; + }); + + //get maxValue to interpolate + store.each(function(record, i) { + if (aggregate) { + for (i = 0, nfields = fields.length; i < nfields; i++) { + maxValue = max(+record.get(fields[i]), maxValue); + } } - }) - ] + categories.push(record.get(xField)); + }); + if (!this.labelArray) { + if (display != 'categories') { + //draw scale + for (i = 1; i <= steps; i++) { + label = surface.add({ + type: 'text', + text: round(i / steps * maxValue), + x: centerX, + y: centerY - rho * i / steps, + 'text-anchor': 'middle', + 'stroke-width': 0.1, + stroke: '#333' + }); + label.setAttributes({ + hidden: false + }, true); + labelArray.push(label); + } + } + if (display != 'scale') { + //draw text + for (j = 0, steps = categories.length; j < steps; j++) { + dx = cos(j / steps * pi2) * (rho + margin); + dy = sin(j / steps * pi2) * (rho + margin); + label = surface.add({ + type: 'text', + text: categories[j], + x: centerX + dx, + y: centerY + dy, + 'text-anchor': dx * dx <= 0.001? 'middle' : (dx < 0? 'end' : 'start') + }); + label.setAttributes({ + hidden: false + }, true); + labelArray.push(label); + } + } + } + else { + labelArray = this.labelArray; + if (display != 'categories') { + //draw values + for (i = 0; i < steps; i++) { + labelArray[i].setAttributes({ + text: round((i + 1) / steps * maxValue), + x: centerX, + y: centerY - rho * (i + 1) / steps, + 'text-anchor': 'middle', + 'stroke-width': 0.1, + stroke: '#333' + }, true); + } + } + if (display != 'scale') { + //draw text + for (j = 0, steps = categories.length; j < steps; j++) { + dx = cos(j / steps * pi2) * (rho + margin); + dy = sin(j / steps * pi2) * (rho + margin); + if (labelArray[i + j]) { + labelArray[i + j].setAttributes({ + type: 'text', + text: categories[j], + x: centerX + dx, + y: centerY + dy, + 'text-anchor': dx * dx <= 0.001? 'middle' : (dx < 0? 'end' : 'start') + }, true); + } + } + } + } + this.labelArray = labelArray; + } }); - *
- */ - /** - * @cfg {String} ctCls - *
An optional extra CSS class that will be added to this component's container. This can be useful for - * adding customized styles to the container or any of its children using standard CSS rules. See - * {@link Ext.layout.ContainerLayout}.{@link Ext.layout.ContainerLayout#extraCls extraCls} also.
- *
Note: ctCls defaults to '' except for the following class - * which assigns a value by default: - *
- *
{@link Ext.layout.Box Box Layout} : 'x-box-layout-ct'
- *
- * To configure the above Class with an extra CSS class append to the default. For example, - * for BoxLayout (Hbox and Vbox):
- * ctCls: 'x-box-layout-ct custom-class' - *
- *
- */ - /** - * @cfg {Boolean} disabled - * Render this component disabled (default is false). - */ - disabled : false, +/** + * @author Ed Spencer + * @class Ext.data.AbstractStore + * + *
AbstractStore is a superclass of {@link Ext.data.Store} and {@link Ext.data.TreeStore}. It's never used directly, + * but offers a set of methods used by both of those subclasses.
+ * + *
We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what + * you're probably looking for is {@link Ext.data.Store}. If you're still interested, here's a brief description of what + * AbstractStore is and is not.
+ * + *
AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be + * given a {@link Ext.data.Model Model} that represents the type of data in the Store. It also expects to be given a + * {@link Ext.data.proxy.Proxy Proxy} that handles the loading of data into the Store.
+ * + *
AbstractStore provides a few helpful methods such as {@link #load} and {@link #sync}, which load and save data + * respectively, passing the requests through the configured {@link #proxy}. Both built-in Store subclasses add extra + * behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - + * in {@link Ext.data.Store} the data is saved as a flat {@link Ext.util.MixedCollection MixedCollection}, whereas in + * {@link Ext.data.TreeStore TreeStore} we use a {@link Ext.data.Tree} to maintain the data's hierarchy.
+ * + * TODO: Update these docs to explain about the sortable and filterable mixins. + *
Finally, AbstractStore provides an API for sorting and filtering data via its {@link #sorters} and {@link #filters} + * {@link Ext.util.MixedCollection MixedCollections}. Although this functionality is provided by AbstractStore, there's a + * good description of how to use it in the introduction of {@link Ext.data.Store}. + * + */ +Ext.define('Ext.data.AbstractStore', { + requires: ['Ext.util.MixedCollection', 'Ext.data.Operation', 'Ext.util.Filter'], + + mixins: { + observable: 'Ext.util.Observable', + sortable: 'Ext.util.Sortable' + }, + + statics: { + create: function(store){ + if (!store.isStore) { + if (!store.type) { + store.type = 'store'; + } + store = Ext.createByAlias('store.' + store.type, store); + } + return store; + } + }, + + remoteSort : false, + remoteFilter: false, + /** - * @cfg {Boolean} hidden - * Render this component hidden (default is false). If true, the - * {@link #hide} method will be called internally. + * @cfg {String/Ext.data.proxy.Proxy/Object} proxy The Proxy to use for this Store. This can be either a string, a config + * object or a Proxy instance - see {@link #setProxy} for details. */ - hidden : false, + /** - * @cfg {Object/Array} plugins - * An object or array of objects that will provide custom functionality for this component. The only - * requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. - * When a component is created, if any plugins are available, the component will call the init method on each - * plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the - * component as needed to provide its functionality. + * @cfg {Boolean/Object} autoLoad If data is not specified, and if autoLoad is true or an Object, this store's load method + * is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's + * load method. Defaults to false. */ + autoLoad: false, + /** - * @cfg {Mixed} applyTo - *
Specify the id of the element, a DOM element or an existing Element corresponding to a DIV - * that is already present in the document that specifies some structural markup for this - * component.
- *
Description :
- *
When applyTo is used, constituent parts of the component can also be specified - * by id or CSS class name within the main element, and the component being created may attempt - * to create its subcomponents from that markup if applicable.
- *
- *
Notes :
- *
When using this config, a call to render() is not required.
- *
If applyTo is specified, any value passed for {@link #renderTo} will be ignored and the target - * element's parent node will automatically be used as the component's container.
- *
- *
+ * @cfg {Boolean} autoSync True to automatically sync the Store with its Proxy after every edit to one of its Records. + * Defaults to false. */ + autoSync: false, + /** - * @cfg {Mixed} renderTo - *
Specify the id of the element, a DOM element or an existing Element that this component - * will be rendered into.
- *
Notes :
- *
Do not use this option if the Component is to be a child item of - * a {@link Ext.Container Container}. It is the responsibility of the - * {@link Ext.Container Container}'s {@link Ext.Container#layout layout manager} - * to render and manage its child items.
- *
When using this config, a call to render() is not required.
- *
- *
- *
See {@link #render} also.
+ * Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's + * internal representation of the data after each operation of the batch has completed, 'complete' will wait until + * the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local + * storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency. + * @property batchUpdateMode + * @type String */ + batchUpdateMode: 'operation', + /** - * @cfg {Boolean} stateful - *
A flag which causes the Component to attempt to restore the state of - * internal properties from a saved state on startup. The component must have - * either a {@link #stateId} or {@link #id} assigned - * for state to be managed. Auto-generated ids are not guaranteed to be stable - * across page loads and cannot be relied upon to save and restore the same - * state for a component.
- *
For state saving to work, the state manager's provider must have been - * set to an implementation of {@link Ext.state.Provider} which overrides the - * {@link Ext.state.Provider#set set} and {@link Ext.state.Provider#get get} - * methods to save and recall name/value pairs. A built-in implementation, - * {@link Ext.state.CookieProvider} is available.
- *
To set the state provider for the current page:
- *
-Ext.state.Manager.setProvider(new Ext.state.CookieProvider({ - expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now -})); - *
- *
A stateful Component attempts to save state when one of the events - * listed in the {@link #stateEvents} configuration fires.
- *
To save state, a stateful Component first serializes its state by - * calling getState. By default, this function does - * nothing. The developer must provide an implementation which returns an - * object hash which represents the Component's restorable state.
- *
The value yielded by getState is passed to {@link Ext.state.Manager#set} - * which uses the configured {@link Ext.state.Provider} to save the object - * keyed by the Component's {@link stateId}, or, if that is not - * specified, its {@link #id}.
- *
During construction, a stateful Component attempts to restore - * its state by calling {@link Ext.state.Manager#get} passing the - * {@link #stateId}, or, if that is not specified, the - * {@link #id}.
- *
The resulting object is passed to applyState. - * The default implementation of applyState simply copies - * properties into the object, but a developer may override this to support - * more behaviour.
- *
You can perform extra processing on state save and restore by attaching - * handlers to the {@link #beforestaterestore}, {@link #staterestore}, - * {@link #beforestatesave} and {@link #statesave} events.
+ * If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. + * Defaults to true, ignored if {@link #remoteFilter} is true + * @property filterOnLoad + * @type Boolean */ + filterOnLoad: true, + /** - * @cfg {String} stateId - * The unique id for this component to use for state management purposes - * (defaults to the component id if one was set, otherwise null if the - * component is using a generated id). - *
See {@link #stateful} for an explanation of saving and - * restoring Component state.
+ * If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. + * Defaults to true, igored if {@link #remoteSort} is true + * @property sortOnLoad + * @type Boolean */ + sortOnLoad: true, + /** - * @cfg {Array} stateEvents - *
An array of events that, when fired, should trigger this component to - * save its state (defaults to none). stateEvents may be any type - * of event supported by this component, including browser or custom events - * (e.g., ['click', 'customerchange']).
- *
See {@link #stateful} for an explanation of saving and - * restoring Component state.
+ * True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's constructor + * instead of a model constructor or name. + * @property implicitModel + * @type Boolean + * @private */ + implicitModel: false, + /** - * @cfg {Mixed} autoEl - *
A tag name or {@link Ext.DomHelper DomHelper} spec used to create the {@link #getEl Element} which will - * encapsulate this Component.
- *
You do not normally need to specify this. For the base classes {@link Ext.Component}, {@link Ext.BoxComponent}, - * and {@link Ext.Container}, this defaults to 'div'. The more complex Ext classes use a more complex - * DOM structure created by their own onRender methods.
- *
This is intended to allow the developer to create application-specific utility Components encapsulated by - * different DOM elements. Example usage:
-{ - xtype: 'box', - autoEl: { - tag: 'img', - src: 'http://www.example.com/example.jpg' - } -}, { - xtype: 'box', - autoEl: { - tag: 'blockquote', - html: 'autoEl is cool!' - } -}, { - xtype: 'container', - autoEl: 'ul', - cls: 'ux-unordered-list', - items: { - xtype: 'box', - autoEl: 'li', - html: 'First list item' - } -} -
+ * The string type of the Proxy to create if none is specified. This defaults to creating a {@link Ext.data.proxy.Memory memory proxy}. + * @property defaultProxyType + * @type String */ - autoEl : 'div', + defaultProxyType: 'memory', /** - * @cfg {String} disabledClass - * CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). + * True if the Store has already been destroyed via {@link #destroyStore}. If this is true, the reference to Store should be deleted + * as it will not function correctly any more. + * @property isDestroyed + * @type Boolean */ - disabledClass : 'x-item-disabled', + isDestroyed: false, + + isStore: true, + /** - * @cfg {Boolean} allowDomMove - * Whether the component can move the Dom node when rendering (defaults to true). + * @cfg {String} storeId Optional unique identifier for this store. If present, this Store will be registered with + * the {@link Ext.data.StoreManager}, making it easy to reuse elsewhere. Defaults to undefined. */ - allowDomMove : true, + /** - * @cfg {Boolean} autoShow - * True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove - * them on render (defaults to false). + * @cfg {Array} fields + * This may be used in place of specifying a {@link #model} configuration. The fields should be a + * set of {@link Ext.data.Field} configuration objects. The store will automatically create a {@link Ext.data.Model} + * with these fields. In general this configuration option should be avoided, it exists for the purposes of + * backwards compatibility. For anything more complicated, such as specifying a particular id property or + * assocations, a {@link Ext.data.Model} should be defined and specified for the {@link #model} config. */ - autoShow : false, + + sortRoot: 'data', + + //documented above + constructor: function(config) { + var me = this, + filters; + + me.addEvents( + /** + * @event add + * Fired when a Model instance has been added to this Store + * @param {Ext.data.Store} store The store + * @param {Array} records The Model instances that were added + * @param {Number} index The index at which the instances were inserted + */ + 'add', + + /** + * @event remove + * Fired when a Model instance has been removed from this Store + * @param {Ext.data.Store} store The Store object + * @param {Ext.data.Model} record The record that was removed + * @param {Number} index The index of the record that was removed + */ + 'remove', + + /** + * @event update + * Fires when a Record has been updated + * @param {Store} this + * @param {Ext.data.Model} record The Model instance that was updated + * @param {String} operation The update operation being performed. Value may be one of: + *
+ Ext.data.Model.EDIT + Ext.data.Model.REJECT + Ext.data.Model.COMMIT + *
+ */ + 'update', + + /** + * @event datachanged + * Fires whenever the records in the Store have changed in some way - this could include adding or removing records, + * or updating the data in existing records + * @param {Ext.data.Store} this The data store + */ + 'datachanged', + + /** + * @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', + + /** + * @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', + + /** + * @event beforesync + * Called before a call to {@link #sync} is executed. Return false from any listener to cancel the synv + * @param {Object} options Hash of all records to be synchronized, broken down into create, update and destroy + */ + 'beforesync', + /** + * @event clear + * Fired after the {@link #removeAll} method is called. + * @param {Ext.data.Store} this + */ + 'clear' + ); + + Ext.apply(me, config); + // don't use *config* anymore from here on... use *me* instead... + + /** + * Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, + * at which point this is cleared. + * @private + * @property removed + * @type Array + */ + me.removed = []; + + me.mixins.observable.constructor.apply(me, arguments); + me.model = Ext.ModelManager.getModel(me.model); + + /** + * @property modelDefaults + * @type Object + * @private + * A set of default values to be applied to every model instance added via {@link #insert} or created via {@link #create}. + * This is used internally by associations to set foreign keys and other fields. See the Association classes source code + * for examples. This should not need to be used by application developers. + */ + Ext.applyIf(me, { + modelDefaults: {} + }); + + //Supports the 3.x style of simply passing an array of fields to the store, implicitly creating a model + if (!me.model && me.fields) { + me.model = Ext.define('Ext.data.Store.ImplicitModel-' + (me.storeId || Ext.id()), { + extend: 'Ext.data.Model', + fields: me.fields, + proxy: me.proxy || me.defaultProxyType + }); + + delete me.fields; + + me.implicitModel = true; + } + + //ensures that the Proxy is instantiated correctly + me.setProxy(me.proxy || me.model.getProxy()); + + if (me.id && !me.storeId) { + me.storeId = me.id; + delete me.id; + } + + if (me.storeId) { + Ext.data.StoreManager.register(me); + } + + me.mixins.sortable.initSortable.call(me); + + /** + * The collection of {@link Ext.util.Filter Filters} currently applied to this Store + * @property filters + * @type Ext.util.MixedCollection + */ + filters = me.decodeFilters(me.filters); + me.filters = Ext.create('Ext.util.MixedCollection'); + me.filters.addAll(filters); + }, + /** - * @cfg {String} hideMode - *
How this component should be hidden. Supported values are 'visibility' - * (css visibility), 'offsets' (negative offset position) and 'display' - * (css display).
- *
Note: the default of 'display' is generally preferred - * since items are automatically laid out when they are first shown (no sizing - * is done while hidden).
- */ - hideMode : 'display', - /** - * @cfg {Boolean} hideParent - * True to hide and show the component's container when hide/show is called on the component, false to hide - * and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide - * button on a window by setting hide:true on the button when adding it to its parent container. - */ - hideParent : false, - /** - *
The {@link Ext.Element} which encapsulates this Component. Read-only.
- *
This will usually be a <DIV> element created by the class's onRender method, but - * that may be overridden using the {@link #autoEl} config.
- *
Note: this element will not be available until this Component has been rendered.

- *
To add listeners for DOM events to this Component (as opposed to listeners - * for this Component's own Observable events), see the {@link Ext.util.Observable#listeners listeners} - * config for a suggestion, or use a render listener directly:
-new Ext.Panel({ - title: 'The Clickable Panel', - listeners: { - render: function(p) { - // Append the Panel to the click handler's argument list. - p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true)); - }, - single: true // Remove the listener after first invocation - } -}); -
- *
See also {@link #getEl getEl}
- * @type Ext.Element - * @property el + * Sets the Store's Proxy by string, config object or Proxy instance + * @param {String|Object|Ext.data.proxy.Proxy} proxy The new Proxy, which can be either a type string, a configuration object + * or an Ext.data.proxy.Proxy instance + * @return {Ext.data.proxy.Proxy} The attached Proxy object */ + setProxy: function(proxy) { + var me = this; + + if (proxy instanceof Ext.data.proxy.Proxy) { + proxy.setModel(me.model); + } else { + if (Ext.isString(proxy)) { + proxy = { + type: proxy + }; + } + Ext.applyIf(proxy, { + model: me.model + }); + + proxy = Ext.createByAlias('proxy.' + proxy.type, proxy); + } + + me.proxy = proxy; + + return me.proxy; + }, + /** - * This Component's owner {@link Ext.Container Container} (defaults to undefined, and is set automatically when - * this Component is added to a Container). Read-only. - * Note: to access items within the Container see {@link #itemId}. - * @type Ext.Container - * @property ownerCt + * Returns the proxy currently attached to this proxy instance + * @return {Ext.data.proxy.Proxy} The Proxy instance */ + getProxy: function() { + return this.proxy; + }, + + //saves any phantom records + create: function(data, options) { + var me = this, + instance = Ext.ModelManager.create(Ext.applyIf(data, me.modelDefaults), me.model.modelName), + operation; + + options = options || {}; + + Ext.applyIf(options, { + action : 'create', + records: [instance] + }); + + operation = Ext.create('Ext.data.Operation', options); + + me.proxy.create(operation, me.onProxyWrite, me); + + return instance; + }, + + read: function() { + return this.load.apply(this, arguments); + }, + + onProxyRead: Ext.emptyFn, + + update: function(options) { + var me = this, + operation; + options = options || {}; + + Ext.applyIf(options, { + action : 'update', + records: me.getUpdatedRecords() + }); + + operation = Ext.create('Ext.data.Operation', options); + + return me.proxy.update(operation, me.onProxyWrite, me); + }, + /** - * True if this component is hidden. Read-only. - * @type Boolean - * @property hidden + * @private + * Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect + * the updates provided by the Proxy */ + onProxyWrite: function(operation) { + var me = this, + success = operation.wasSuccessful(), + records = operation.getRecords(); + + switch (operation.action) { + case 'create': + me.onCreateRecords(records, operation, success); + break; + case 'update': + me.onUpdateRecords(records, operation, success); + break; + case 'destroy': + me.onDestroyRecords(records, operation, success); + break; + } + + if (success) { + me.fireEvent('write', me, operation); + me.fireEvent('datachanged', me); + } + //this is a callback that would have been passed to the 'create', 'update' or 'destroy' function and is optional + Ext.callback(operation.callback, operation.scope || me, [records, operation, success]); + }, + + + //tells the attached proxy to destroy the given records + destroy: function(options) { + var me = this, + operation; + + options = options || {}; + + Ext.applyIf(options, { + action : 'destroy', + records: me.getRemovedRecords() + }); + + operation = Ext.create('Ext.data.Operation', options); + + return me.proxy.destroy(operation, me.onProxyWrite, me); + }, + /** - * True if this component is disabled. Read-only. - * @type Boolean - * @property disabled + * @private + * Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through + * to onProxyWrite. */ + onBatchOperationComplete: function(batch, operation) { + return this.onProxyWrite(operation); + }, + /** - * True if this component has been rendered. Read-only. - * @type Boolean - * @property rendered + * @private + * Attached as the 'complete' event listener to a proxy's Batch object. Iterates over the batch operations + * and updates the Store's internal data MixedCollection. */ - rendered : false, + onBatchComplete: function(batch, operation) { + var me = this, + operations = batch.operations, + length = operations.length, + i; + + me.suspendEvents(); + + for (i = 0; i < length; i++) { + me.onProxyWrite(operations[i]); + } + + me.resumeEvents(); + + me.fireEvent('datachanged', me); + }, + + onBatchException: function(batch, operation) { + // //decide what to do... could continue with the next operation + // batch.start(); + // + // //or retry the last operation + // batch.retry(); + }, /** - * @cfg {String} contentEl - * Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content - * for this component. - * - * Description : - * This config option is used to take an existing HTML element and place it in the layout element - * of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content. - * Notes : - * The specified HTML element is appended to the layout element of the component after any configured - * {@link #html HTML} has been inserted, and so the document will not contain this element at the time the {@link #render} event is fired. - * The specified HTML element used will not participate in any {@link Ext.Container#layout layout} - * scheme that the Component may use. It is just HTML. Layouts operate on child {@link Ext.Container#items items}. - * Add either the x-hidden or the x-hide-display CSS class to - * prevent a brief flicker of the content before it is rendered to the panel. - * + * @private + * Filter function for new records. */ + filterNew: function(item) { + // only want phantom records that are valid + return item.phantom === true && item.isValid(); + }, + /** - * @cfg {String/Object} html - * An HTML fragment, or a {@link Ext.DomHelper DomHelper} specification to use as the layout element - * content (defaults to ''). The HTML content is added after the component is rendered, - * so the document will not contain this HTML at the time the {@link #render} event is fired. - * This content is inserted into the body before any configured {@link #contentEl} is appended. + * Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not + * yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one) + * @return {Array} The Model instances */ + getNewRecords: function() { + return []; + }, /** - * @cfg {Mixed} tpl - * An {@link Ext.Template}, {@link Ext.XTemplate} - * or an array of strings to form an Ext.XTemplate. - * Used in conjunction with the {@link #data} and - * {@link #tplWriteMode} configurations. + * Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy + * @return {Array} The updated Model instances */ + getUpdatedRecords: function() { + return []; + }, /** - * @cfg {String} tplWriteMode The Ext.(X)Template method to use when - * updating the content area of the Component. Defaults to 'overwrite' - * (see {@link Ext.XTemplate#overwrite}). + * @private + * Filter function for updated records. */ - tplWriteMode : 'overwrite', + filterUpdated: function(item) { + // only want dirty records, not phantoms that are valid + return item.dirty === true && item.phantom !== true && item.isValid(); + }, /** - * @cfg {Mixed} data - * The initial set of data to apply to the {@link #tpl} to - * update the content area of the Component. + * Returns any records that have been removed from the store but not yet destroyed on the proxy. + * @return {Array} The removed Model instances */ - + getRemovedRecords: function() { + return this.removed; + }, + + filter: function(filters, value) { + + }, + /** - * @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 []. - */ - bubbleEvents: [], + * @private + * Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances + * @param {Array} filters The filters array + * @return {Array} Array of Ext.util.Filter objects + */ + decodeFilters: function(filters) { + if (!Ext.isArray(filters)) { + if (filters === undefined) { + filters = []; + } else { + filters = [filters]; + } + } + var length = filters.length, + Filter = Ext.util.Filter, + config, i; - // private - ctype : 'Ext.Component', + for (i = 0; i < length; i++) { + config = filters[i]; - // private - actionMode : 'el', + if (!(config instanceof Filter)) { + Ext.apply(config, { + root: 'data' + }); - // private - getActionEl : function(){ - return this[this.actionMode]; - }, + //support for 3.x style filters where a function can be defined as 'fn' + if (config.fn) { + config.filterFn = config.fn; + } - initPlugin : function(p){ - if(p.ptype && !Ext.isFunction(p.init)){ - p = Ext.ComponentMgr.createPlugin(p); - }else if(Ext.isString(p)){ - p = Ext.ComponentMgr.createPlugin({ - ptype: p - }); + //support a function to be passed as a filter definition + if (typeof config == 'function') { + config = { + filterFn: config + }; + } + + filters[i] = new Filter(config); + } } - p.init(this); - return p; + + return filters; }, - /* // protected - * Function to be implemented by Component subclasses to be part of standard component initialization flow (it is empty by default). - * -// Traditional constructor: -Ext.Foo = function(config){ - // call superclass constructor: - Ext.Foo.superclass.constructor.call(this, config); + clearFilter: function(supressEvent) { - this.addEvents({ - // add events - }); -}; -Ext.extend(Ext.Foo, Ext.Bar, { - // class body -} + }, -// initComponent replaces the constructor: -Ext.Foo = Ext.extend(Ext.Bar, { - initComponent : function(){ - // call superclass initComponent - Ext.Container.superclass.initComponent.call(this); + isFiltered: function() { - this.addEvents({ - // add events - }); - } -} - - */ - initComponent : function(){ - /* - * this is double processing, however it allows people to be able to do - * Ext.apply(this, { - * listeners: { - * //here - * } - * }); - * MyClass.superclass.initComponent.call(this); - */ - if(this.listeners){ - this.on(this.listeners); - delete this.listeners; - } - this.enableBubble(this.bubbleEvents); - }, - - /** - * Render this Component into the passed HTML element. - * If you are using a {@link Ext.Container Container} object to house this Component, then - * do not use the render method. - * A Container's child Components are rendered by that Container's - * {@link Ext.Container#layout layout} manager when the Container is first rendered. - * Certain layout managers allow dynamic addition of child components. Those that do - * include {@link Ext.layout.CardLayout}, {@link Ext.layout.AnchorLayout}, - * {@link Ext.layout.FormLayout}, {@link Ext.layout.TableLayout}. - * If the Container is already rendered when a new child Component is added, you may need to call - * the Container's {@link Ext.Container#doLayout doLayout} to refresh the view which causes any - * unrendered child Components to be rendered. This is required so that you can add multiple - * child components if needed while only refreshing the layout once. - * When creating complex UIs, it is important to remember that sizing and positioning - * of child items is the responsibility of the Container's {@link Ext.Container#layout layout} manager. - * If you expect child items to be sized in response to user interactions, you must - * configure the Container with a layout manager which creates and manages the type of layout you - * have in mind. - * Omitting the Container's {@link Ext.Container#layout layout} config means that a basic - * layout manager is used which does nothing but render child components sequentially into the - * Container. No sizing or positioning will be performed in this situation. - * @param {Element/HTMLElement/String} container (optional) The element this Component should be - * rendered into. If it is being created from existing markup, this should be omitted. - * @param {String/Number} position (optional) The element ID or DOM node index within the container before - * which this component will be inserted (defaults to appending to the end of the container) - */ - render : function(container, position){ - if(!this.rendered && this.fireEvent('beforerender', this) !== false){ - if(!container && this.el){ - this.el = Ext.get(this.el); - container = this.el.dom.parentNode; - this.allowDomMove = false; - } - this.container = Ext.get(container); - if(this.ctCls){ - this.container.addClass(this.ctCls); - } - this.rendered = true; - if(position !== undefined){ - if(Ext.isNumber(position)){ - position = this.container.dom.childNodes[position]; - }else{ - position = Ext.getDom(position); - } - } - this.onRender(this.container, position || null); - if(this.autoShow){ - this.el.removeClass(['x-hidden','x-hide-' + this.hideMode]); - } - if(this.cls){ - this.el.addClass(this.cls); - delete this.cls; - } - if(this.style){ - this.el.applyStyles(this.style); - delete this.style; - } - if(this.overCls){ - this.el.addClassOnOver(this.overCls); - } - this.fireEvent('render', this); + }, + filterBy: function(fn, scope) { - // Populate content of the component with html, contentEl or - // a tpl. - var contentTarget = this.getContentTarget(); - if (this.html){ - contentTarget.update(Ext.DomHelper.markup(this.html)); - delete this.html; - } - if (this.contentEl){ - var ce = Ext.getDom(this.contentEl); - Ext.fly(ce).removeClass(['x-hidden', 'x-hide-display']); - contentTarget.appendChild(ce); - } - if (this.tpl) { - if (!this.tpl.compile) { - this.tpl = new Ext.XTemplate(this.tpl); - } - if (this.data) { - this.tpl[this.tplWriteMode](contentTarget, this.data); - delete this.data; - } - } - this.afterRender(this.container); + }, + + /** + * Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated + * and deleted records in the store, updating the Store's internal representation of the records + * as each operation completes. + */ + sync: function() { + var me = this, + options = {}, + toCreate = me.getNewRecords(), + toUpdate = me.getUpdatedRecords(), + toDestroy = me.getRemovedRecords(), + needsSync = false; + + if (toCreate.length > 0) { + options.create = toCreate; + needsSync = true; + } + if (toUpdate.length > 0) { + options.update = toUpdate; + needsSync = true; + } - if(this.hidden){ - // call this so we don't fire initial hide events. - this.doHide(); - } - if(this.disabled){ - // pass silent so the event doesn't fire the first time. - this.disable(true); - } + if (toDestroy.length > 0) { + options.destroy = toDestroy; + needsSync = true; + } - if(this.stateful !== false){ - this.initStateEvents(); - } - this.fireEvent('afterrender', this); + if (needsSync && me.fireEvent('beforesync', options) !== false) { + me.proxy.batch(options, me.getBatchListeners()); } - return this; }, /** - * Update the content area of a component. - * @param {Mixed} htmlOrData - * If this component has been configured with a template via the tpl config - * then it will use this argument as data to populate the template. - * If this component was not configured with a template, the components - * content area will be updated via Ext.Element update - * @param {Boolean} loadScripts - * (optional) Only legitimate when using the html configuration. Defaults to false - * @param {Function} callback - * (optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading + * @private + * Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. + * This is broken out into a separate function to allow for customisation of the listeners + * @return {Object} The listeners object */ - update: function(htmlOrData, loadScripts, cb) { - var contentTarget = this.getContentTarget(); - if (this.tpl && typeof htmlOrData !== "string") { - this.tpl[this.tplWriteMode](contentTarget, htmlOrData || {}); + getBatchListeners: function() { + var me = this, + listeners = { + scope: me, + exception: me.onBatchException + }; + + if (me.batchUpdateMode == 'operation') { + listeners.operationcomplete = me.onBatchOperationComplete; } else { - var html = Ext.isObject(htmlOrData) ? Ext.DomHelper.markup(htmlOrData) : htmlOrData; - contentTarget.update(html, loadScripts, cb); + listeners.complete = me.onBatchComplete; } + + return listeners; }, + //deprecated, will be removed in 5.0 + save: function() { + return this.sync.apply(this, arguments); + }, /** - * @private - * Method to manage awareness of when components are added to their - * respective Container, firing an added event. - * References are established at add time rather than at render time. - * @param {Ext.Container} container Container which holds the component - * @param {number} pos Position at which the component was added + * Loads the Store using its configured {@link #proxy}. + * @param {Object} options Optional config object. This is passed into the {@link Ext.data.Operation Operation} + * object that is created and then sent to the proxy's {@link Ext.data.proxy.Proxy#read} function */ - onAdded : function(container, pos) { - this.ownerCt = container; - this.initRef(); - this.fireEvent('added', this, container, pos); + load: function(options) { + var me = this, + operation; + + options = options || {}; + + Ext.applyIf(options, { + action : 'read', + filters: me.filters.items, + sorters: me.getSorters() + }); + + operation = Ext.create('Ext.data.Operation', options); + + if (me.fireEvent('beforeload', me, operation) !== false) { + me.loading = true; + me.proxy.read(operation, me.onProxyLoad, me); + } + + return me; }, /** * @private - * Method to manage awareness of when components are removed from their - * respective Container, firing an removed event. References are properly - * cleaned up after removing a component from its owning container. + * A model instance should call this method on the Store it has been {@link Ext.data.Model#join joined} to. + * @param {Ext.data.Model} record The model instance that was edited */ - onRemoved : function() { - this.removeRef(); - this.fireEvent('removed', this, this.ownerCt); - delete this.ownerCt; + afterEdit : function(record) { + var me = this; + + if (me.autoSync) { + me.sync(); + } + + me.fireEvent('update', me, record, Ext.data.Model.EDIT); }, /** * @private - * Method to establish a reference to a component. + * A model instance should call this method on the Store it has been {@link Ext.data.Model#join joined} to.. + * @param {Ext.data.Model} record The model instance that was edited */ - initRef : function() { - /** - * @cfg {String} ref - * A path specification, relative to the Component's {@link #ownerCt} - * specifying into which ancestor Container to place a named reference to this Component. - * The ancestor axis can be traversed by using '/' characters in the path. - * For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar: -var myGrid = new Ext.grid.EditorGridPanel({ - title: 'My EditorGridPanel', - store: myStore, - colModel: myColModel, - tbar: [{ - text: 'Save', - handler: saveChanges, - disabled: true, - ref: '../saveButton' - }], - listeners: { - afteredit: function() { -// The button reference is in the GridPanel - myGrid.saveButton.enable(); - } - } -}); - - * In the code above, if the ref had been 'saveButton' - * the reference would have been placed into the Toolbar. Each '/' in the ref - * moves up one level from the Component's {@link #ownerCt}. - * Also see the {@link #added} and {@link #removed} events. - */ - if(this.ref && !this.refOwner){ - var levels = this.ref.split('/'), - last = levels.length, - i = 0, - t = this; - - while(t && i < last){ - t = t.ownerCt; - ++i; - } - if(t){ - t[this.refName = levels[--i]] = this; - /** - * @type Ext.Container - * @property refOwner - * The ancestor Container into which the {@link #ref} reference was inserted if this Component - * is a child of a Container, and has been configured with a ref. - */ - this.refOwner = t; - } - } + afterReject : function(record) { + this.fireEvent('update', this, record, Ext.data.Model.REJECT); }, - removeRef : function() { - if (this.refOwner && this.refName) { - delete this.refOwner[this.refName]; - delete this.refOwner; - } + /** + * @private + * A model instance should call this method on the Store it has been {@link Ext.data.Model#join joined} to. + * @param {Ext.data.Model} record The model instance that was edited + */ + afterCommit : function(record) { + this.fireEvent('update', this, record, Ext.data.Model.COMMIT); }, - // private - initState : function(){ - if(Ext.state.Manager){ - var id = this.getStateId(); - if(id){ - var state = Ext.state.Manager.get(id); - if(state){ - if(this.fireEvent('beforestaterestore', this, state) !== false){ - this.applyState(Ext.apply({}, state)); - this.fireEvent('staterestore', this, state); - } - } - } - } - }, + clearData: Ext.emptyFn, - // private - getStateId : function(){ - return this.stateId || ((/^(ext-comp-|ext-gen)/).test(String(this.id)) ? null : this.id); - }, + destroyStore: function() { + var me = this; + + if (!me.isDestroyed) { + if (me.storeId) { + Ext.data.StoreManager.unregister(me); + } + me.clearData(); + me.data = null; + me.tree = null; + // Ext.destroy(this.proxy); + me.reader = me.writer = null; + me.clearListeners(); + me.isDestroyed = true; - // private - initStateEvents : function(){ - if(this.stateEvents){ - for(var i = 0, e; e = this.stateEvents[i]; i++){ - this.on(e, this.saveState, this, {delay:100}); + if (me.implicitModel) { + Ext.destroy(me.model); } } }, - - // private - applyState : function(state){ - if(state){ - Ext.apply(this, state); + + doSort: function(sorterFn) { + var me = this; + if (me.remoteSort) { + //the load function will pick up the new sorters and request the sorted data from the proxy + me.load(); + } else { + me.data.sortBy(sorterFn); + me.fireEvent('datachanged', me); } }, - // private - getState : function(){ - return null; - }, - - // private - saveState : function(){ - if(Ext.state.Manager && this.stateful !== false){ - var id = this.getStateId(); - if(id){ - var state = this.getState(); - if(this.fireEvent('beforestatesave', this, state) !== false){ - Ext.state.Manager.set(id, state); - this.fireEvent('statesave', this, state); - } - } - } - }, + getCount: Ext.emptyFn, + getById: Ext.emptyFn, + /** - * Apply this component to existing markup that is valid. With this function, no call to render() is required. - * @param {String/HTMLElement} el + * Removes all records from the store. This method does a "fast remove", + * individual remove events are not called. The {@link #clear} event is + * fired upon completion. + * @method */ - applyToMarkup : function(el){ - this.allowDomMove = false; - this.el = Ext.get(el); - this.render(this.el.dom.parentNode); - }, + removeAll: Ext.emptyFn, + // individual substores should implement a "fast" remove + // and fire a clear event afterwards /** - * Adds a CSS class to the component's underlying element. - * @param {string} cls The CSS class name to add - * @return {Ext.Component} this + * Returns true if the Store is currently performing a load operation + * @return {Boolean} True if the Store is currently loading */ - addClass : function(cls){ - if(this.el){ - this.el.addClass(cls); - }else{ - this.cls = this.cls ? this.cls + ' ' + cls : cls; - } - return this; - }, + isLoading: function() { + return this.loading; + } +}); + +/** + * @class Ext.util.Grouper + * @extends Ext.util.Sorter + */ + +Ext.define('Ext.util.Grouper', { + + /* Begin Definitions */ + + extend: 'Ext.util.Sorter', + + /* End Definitions */ /** - * Removes a CSS class from the component's underlying element. - * @param {string} cls The CSS class name to remove - * @return {Ext.Component} this + * Function description + * @param {Ext.data.Model} instance The Model instance + * @return {String} The group string for this model */ - removeClass : function(cls){ - if(this.el){ - this.el.removeClass(cls); - }else if(this.cls){ - this.cls = this.cls.split(' ').remove(cls).join(' '); + getGroupString: function(instance) { + return instance.get(this.property); + } +}); +/** + * @author Ed Spencer + * @class Ext.data.Store + * @extends Ext.data.AbstractStore + * + * The Store class encapsulates a client side cache of {@link Ext.data.Model Model} objects. Stores load + * data via a {@link Ext.data.proxy.Proxy Proxy}, and also provide functions for {@link #sort sorting}, + * {@link #filter filtering} and querying the {@link Ext.data.Model model} instances contained within it. + * + * Creating a Store is easy - we just tell it the Model and the Proxy to use to load and save its data: + * + +// Set up a {@link Ext.data.Model model} to use in our Store +Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + {name: 'firstName', type: 'string'}, + {name: 'lastName', type: 'string'}, + {name: 'age', type: 'int'}, + {name: 'eyeColor', type: 'string'} + ] +}); + +var myStore = new Ext.data.Store({ + model: 'User', + proxy: { + type: 'ajax', + url : '/users.json', + reader: { + type: 'json', + root: 'users' } - return this; }, + autoLoad: true +}); + - // private - // default function is not really useful - onRender : function(ct, position){ - if(!this.el && this.autoEl){ - if(Ext.isString(this.autoEl)){ - this.el = document.createElement(this.autoEl); - }else{ - var div = document.createElement('div'); - Ext.DomHelper.overwrite(div, this.autoEl); - this.el = div.firstChild; - } - if (!this.el.id) { - this.el.id = this.getId(); - } + * In the example above we configured an AJAX proxy to load data from the url '/users.json'. We told our Proxy + * to use a {@link Ext.data.reader.Json JsonReader} to parse the response from the server into Model object - + * {@link Ext.data.reader.Json see the docs on JsonReader} for details. + * + * Inline data + * + * Stores can also load data inline. Internally, Store converts each of the objects we pass in as {@link #data} + * into Model instances: + * + +new Ext.data.Store({ + model: 'User', + data : [ + {firstName: 'Ed', lastName: 'Spencer'}, + {firstName: 'Tommy', lastName: 'Maintz'}, + {firstName: 'Aaron', lastName: 'Conran'}, + {firstName: 'Jamie', lastName: 'Avins'} + ] +}); + + * + * Loading inline data using the method above is great if the data is in the correct format already (e.g. it doesn't need + * to be processed by a {@link Ext.data.reader.Reader reader}). If your inline data requires processing to decode the data structure, + * use a {@link Ext.data.proxy.Memory MemoryProxy} instead (see the {@link Ext.data.proxy.Memory MemoryProxy} docs for an example). + * + * Additional data can also be loaded locally using {@link #add}. + * + * Loading Nested Data + * + * Applications often need to load sets of associated data - for example a CRM system might load a User and her Orders. + * Instead of issuing an AJAX request for the User and a series of additional AJAX requests for each Order, we can load a nested dataset + * and allow the Reader to automatically populate the associated models. Below is a brief example, see the {@link Ext.data.reader.Reader} intro + * docs for a full explanation: + * + +var store = new Ext.data.Store({ + autoLoad: true, + model: "User", + proxy: { + type: 'ajax', + url : 'users.json', + reader: { + type: 'json', + root: 'users' } - if(this.el){ - this.el = Ext.get(this.el); - if(this.allowDomMove !== false){ - ct.dom.insertBefore(this.el.dom, position); - if (div) { - Ext.removeNode(div); - div = null; + } +}); + + * + * Which would consume a response like this: + * + +{ + "users": [ + { + "id": 1, + "name": "Ed", + "orders": [ + { + "id": 10, + "total": 10.76, + "status": "invoiced" + }, + { + "id": 11, + "total": 13.45, + "status": "shipped" } - } + ] } - }, + ] +} + + * + * See the {@link Ext.data.reader.Reader} intro docs for a full explanation. + * + * Filtering and Sorting + * + * Stores can be sorted and filtered - in both cases either remotely or locally. The {@link #sorters} and {@link #filters} are + * held inside {@link Ext.util.MixedCollection MixedCollection} instances to make them easy to manage. Usually it is sufficient to + * either just specify sorters and filters in the Store configuration or call {@link #sort} or {@link #filter}: + * + +var store = new Ext.data.Store({ + model: 'User', + sorters: [ + { + property : 'age', + direction: 'DESC' + }, + { + property : 'firstName', + direction: 'ASC' + } + ], - // private - getAutoCreate : function(){ - var cfg = Ext.isObject(this.autoCreate) ? - this.autoCreate : Ext.apply({}, this.defaultAutoCreate); - if(this.id && !cfg.id){ - cfg.id = this.id; + filters: [ + { + property: 'firstName', + value : /Ed/ } - return cfg; - }, + ] +}); + + * + * The new Store will keep the configured sorters and filters in the MixedCollection instances mentioned above. By default, sorting + * and filtering are both performed locally by the Store - see {@link #remoteSort} and {@link #remoteFilter} to allow the server to + * perform these operations instead. + * + * Filtering and sorting after the Store has been instantiated is also easy. Calling {@link #filter} adds another filter to the Store + * and automatically filters the dataset (calling {@link #filter} with no arguments simply re-applies all existing filters). Note that by + * default {@link #sortOnFilter} is set to true, which means that your sorters are automatically reapplied if using local sorting. + * + +store.filter('eyeColor', 'Brown'); + + * + * Change the sorting at any time by calling {@link #sort}: + * + +store.sort('height', 'ASC'); + + * + * Note that all existing sorters will be removed in favor of the new sorter data (if {@link #sort} is called with no arguments, + * the existing sorters are just reapplied instead of being removed). To keep existing sorters and add new ones, just add them + * to the MixedCollection: + * + +store.sorters.add(new Ext.util.Sorter({ + property : 'shoeSize', + direction: 'ASC' +})); - // private - afterRender : Ext.emptyFn, +store.sort(); + + * + * Registering with StoreManager + * + * Any Store that is instantiated with a {@link #storeId} will automatically be registed with the {@link Ext.data.StoreManager StoreManager}. + * This makes it easy to reuse the same store in multiple views: + * +
+//this store can be used several times +new Ext.data.Store({ + model: 'User', + storeId: 'usersStore' +}); - /** - * Destroys this component by purging any event listeners, removing the component's element from the DOM, - * removing the component from its {@link Ext.Container} (if applicable) and unregistering it from - * {@link Ext.ComponentMgr}. Destruction is generally handled automatically by the framework and this method - * should usually not need to be called directly. - * - */ - destroy : function(){ - if(!this.isDestroyed){ - if(this.fireEvent('beforedestroy', this) !== false){ - this.destroying = true; - this.beforeDestroy(); - if(this.ownerCt && this.ownerCt.remove){ - this.ownerCt.remove(this, false); - } - if(this.rendered){ - this.el.remove(); - if(this.actionMode == 'container' || this.removeMode == 'container'){ - this.container.remove(); - } - } - // Stop any buffered tasks - if(this.focusTask && this.focusTask.cancel){ - this.focusTask.cancel(); - } - this.onDestroy(); - Ext.ComponentMgr.unregister(this); - this.fireEvent('destroy', this); - this.purgeListeners(); - this.destroying = false; - this.isDestroyed = true; - } - } - }, +new Ext.List({ + store: 'usersStore', - deleteMembers : function(){ - var args = arguments; - for(var i = 0, len = args.length; i < len; ++i){ - delete this[args[i]]; - } - }, + //other config goes here +}); - // private - beforeDestroy : Ext.emptyFn, +new Ext.view.View({ + store: 'usersStore', - // private - onDestroy : Ext.emptyFn, - - /** - * Returns the {@link Ext.Element} which encapsulates this Component. - * This will usually be a <DIV> element created by the class's onRender method, but - * that may be overridden using the {@link #autoEl} config. - * Note: this element will not be available until this Component has been rendered. - * To add listeners for DOM events to this Component (as opposed to listeners - * for this Component's own Observable events), see the {@link #listeners} config for a suggestion, - * or use a render listener directly: -new Ext.Panel({ - title: 'The Clickable Panel', - listeners: { - render: function(p) { - // Append the Panel to the click handler's argument list. - p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true)); - }, - single: true // Remove the listener after first invocation - } + //other config goes here }); - * @return {Ext.Element} The Element which encapsulates this Component. + * + * Further Reading + * + * Stores are backed up by an ecosystem of classes that enables their operation. To gain a full understanding of these + * pieces and how they fit together, see: + * + * + * {@link Ext.data.proxy.Proxy Proxy} - overview of what Proxies are and how they are used + * {@link Ext.data.Model Model} - the core class in the data package + * {@link Ext.data.reader.Reader Reader} - used by any subclass of {@link Ext.data.proxy.Server ServerProxy} to read a response + * + * + * @constructor + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.Store', { + extend: 'Ext.data.AbstractStore', + + alias: 'store.store', + + requires: ['Ext.ModelManager', 'Ext.data.Model', 'Ext.util.Grouper'], + uses: ['Ext.data.proxy.Memory'], + + /** + * @cfg {Boolean} remoteSort + * True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to false. */ - getEl : function(){ - return this.el; - }, + remoteSort: false, - // private - getContentTarget : function(){ - return this.el; - }, + /** + * @cfg {Boolean} remoteFilter + * True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to false. + */ + remoteFilter: false, + + /** + * @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 information to the server. + */ + remoteGroup : false, /** - * Returns the id of this component or automatically generates and - * returns an id if an id is not defined yet: - * 'ext-comp-' + (++Ext.Component.AUTO_ID) - * - * @return {String} id + * @cfg {String/Ext.data.proxy.Proxy/Object} proxy The Proxy to use for this Store. This can be either a string, a config + * object or a Proxy instance - see {@link #setProxy} for details. */ - getId : function(){ - return this.id || (this.id = 'ext-comp-' + (++Ext.Component.AUTO_ID)); - }, /** - * Returns the {@link #itemId} of this component. If an - * {@link #itemId} was not assigned through configuration the - * id is returned using {@link #getId}. - * @return {String} + * @cfg {Array} data Optional array of Model instances or data objects to load locally. See "Inline data" above for details. */ - getItemId : function(){ - return this.itemId || this.getId(); - }, /** - * Try to focus this component. - * @param {Boolean} selectText (optional) If applicable, true to also select the text in this component - * @param {Boolean/Number} delay (optional) Delay the focus this number of milliseconds (true for 10 milliseconds) - * @return {Ext.Component} this + * @cfg {String} model The {@link Ext.data.Model} associated with this store */ - focus : function(selectText, delay){ - if(delay){ - this.focusTask = new Ext.util.DelayedTask(this.focus, this, [selectText, false]); - this.focusTask.delay(Ext.isNumber(delay) ? delay : 10); - return; - } - if(this.rendered && !this.isDestroyed){ - this.el.focus(); - if(selectText === true){ - this.el.dom.select(); - } - } - return this; - }, - // private - blur : function(){ - if(this.rendered){ - this.el.blur(); - } - return this; - }, + /** + * The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the + * groupField and {@link #groupDir} are injected as the first sorter (see {@link #sort}). Stores support a single + * level of grouping, and groups can be fetched via the {@link #getGroups} method. + * @property groupField + * @type String + */ + groupField: undefined, /** - * Disable this component and fire the 'disable' event. - * @return {Ext.Component} this + * The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC" + * @property groupDir + * @type String */ - disable : function(/* private */ silent){ - if(this.rendered){ - this.onDisable(); - } - this.disabled = true; - if(silent !== true){ - this.fireEvent('disable', this); - } - return this; - }, + groupDir: "ASC", - // private - onDisable : function(){ - this.getActionEl().addClass(this.disabledClass); - this.el.dom.disabled = true; - }, + /** + * @cfg {Number} pageSize + * The number of records considered to form a 'page'. This is used to power the built-in + * paging using the nextPage and previousPage functions. Defaults to 25. + */ + pageSize: 25, /** - * Enable this component and fire the 'enable' event. - * @return {Ext.Component} this + * The page that the Store has most recently loaded (see {@link #loadPage}) + * @property currentPage + * @type Number */ - enable : function(){ - if(this.rendered){ - this.onEnable(); - } - this.disabled = false; - this.fireEvent('enable', this); - return this; - }, + currentPage: 1, - // private - onEnable : function(){ - this.getActionEl().removeClass(this.disabledClass); - this.el.dom.disabled = false; - }, + /** + * @cfg {Boolean} clearOnPageLoad True to empty the store when loading another page via {@link #loadPage}, + * {@link #nextPage} or {@link #previousPage} (defaults to true). Setting to false keeps existing records, allowing + * large data sets to be loaded one page at a time but rendered all together. + */ + clearOnPageLoad: true, /** - * Convenience function for setting disabled/enabled by boolean. - * @param {Boolean} disabled - * @return {Ext.Component} this + * True if the Store is currently loading via its Proxy + * @property loading + * @type Boolean + * @private */ - setDisabled : function(disabled){ - return this[disabled ? 'disable' : 'enable'](); - }, + loading: false, /** - * Show this component. Listen to the '{@link #beforeshow}' event and return - * false to cancel showing the component. Fires the '{@link #show}' - * event after showing the component. - * @return {Ext.Component} this + * @cfg {Boolean} sortOnFilter For local filtering only, causes {@link #sort} to be called whenever {@link #filter} is called, + * causing the sorters to be reapplied after filtering. Defaults to true */ - show : function(){ - if(this.fireEvent('beforeshow', this) !== false){ - this.hidden = false; - if(this.autoRender){ - this.render(Ext.isBoolean(this.autoRender) ? Ext.getBody() : this.autoRender); - } - if(this.rendered){ - this.onShow(); + sortOnFilter: true, + + /** + * @cfg {Boolean} buffered + * Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will + * tell the store to pre-fetch records ahead of a time. + */ + buffered: false, + + /** + * @cfg {Number} purgePageCount + * The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the prefetched data. + * This option is only relevant when the {@link #buffered} option is set to true. + */ + purgePageCount: 5, + + isStore: true, + + //documented above + constructor: function(config) { + config = config || {}; + + var me = this, + groupers = config.groupers || me.groupers, + groupField = config.groupField || me.groupField, + proxy, + data; + + if (config.buffered || me.buffered) { + me.prefetchData = Ext.create('Ext.util.MixedCollection', false, function(record) { + return record.index; + }); + me.pendingRequests = []; + me.pagesRequested = []; + + me.sortOnLoad = false; + me.filterOnLoad = false; + } + + me.addEvents( + /** + * @event beforeprefetch + * Fires before a prefetch occurs. Return false to cancel. + * @param {Ext.data.store} this + * @param {Ext.data.Operation} operation The associated operation + */ + 'beforeprefetch', + /** + * @event groupchange + * Fired whenever the grouping in the grid changes + * @param {Ext.data.Store} store The store + * @param {Array} groupers The array of grouper objects + */ + 'groupchange', + /** + * @event load + * Fires whenever records have been prefetched + * @param {Ext.data.store} this + * @param {Array} records An array of records + * @param {Boolean} successful True if the operation was successful. + * @param {Ext.data.Operation} operation The associated operation + */ + 'prefetch' + ); + data = config.data || me.data; + + /** + * The MixedCollection that holds this store's local cache of records + * @property data + * @type Ext.util.MixedCollection + */ + me.data = Ext.create('Ext.util.MixedCollection', false, function(record) { + return record.internalId; + }); + + if (data) { + me.inlineData = data; + delete config.data; + } + + if (!groupers && groupField) { + groupers = [{ + property : groupField, + direction: config.groupDir || me.groupDir + }]; + } + delete config.groupers; + + /** + * The collection of {@link Ext.util.Grouper Groupers} currently applied to this Store + * @property groupers + * @type Ext.util.MixedCollection + */ + me.groupers = Ext.create('Ext.util.MixedCollection'); + me.groupers.addAll(me.decodeGroupers(groupers)); + + this.callParent([config]); + // don't use *config* anymore from here on... use *me* instead... + + if (me.groupers.items.length) { + me.sort(me.groupers.items, 'prepend', false); + } + + proxy = me.proxy; + data = me.inlineData; + + if (data) { + if (proxy instanceof Ext.data.proxy.Memory) { + proxy.data = data; + me.read(); + } else { + me.add.apply(me, data); } - this.fireEvent('show', this); + + me.sort(); + delete me.inlineData; + } else if (me.autoLoad) { + Ext.defer(me.load, 10, me, [typeof me.autoLoad === 'object' ? me.autoLoad: undefined]); + // Remove the defer call, we may need reinstate this at some point, but currently it's not obvious why it's here. + // this.load(typeof this.autoLoad == 'object' ? this.autoLoad : undefined); } - return this; }, - - // private - onShow : function(){ - this.getVisibilityEl().removeClass('x-hide-' + this.hideMode); + + onBeforeSort: function() { + this.sort(this.groupers.items, 'prepend', false); }, - + /** - * Hide this component. Listen to the '{@link #beforehide}' event and return - * false to cancel hiding the component. Fires the '{@link #hide}' - * event after hiding the component. Note this method is called internally if - * the component is configured to be {@link #hidden}. - * @return {Ext.Component} this - */ - hide : function(){ - if(this.fireEvent('beforehide', this) !== false){ - this.doHide(); - this.fireEvent('hide', this); + * @private + * Normalizes an array of grouper objects, ensuring that they are all Ext.util.Grouper instances + * @param {Array} groupers The groupers array + * @return {Array} Array of Ext.util.Grouper objects + */ + decodeGroupers: function(groupers) { + if (!Ext.isArray(groupers)) { + if (groupers === undefined) { + groupers = []; + } else { + groupers = [groupers]; + } } - return this; - }, - // private - doHide: function(){ - this.hidden = true; - if(this.rendered){ - this.onHide(); + var length = groupers.length, + Grouper = Ext.util.Grouper, + config, i; + + for (i = 0; i < length; i++) { + config = groupers[i]; + + if (!(config instanceof Grouper)) { + if (Ext.isString(config)) { + config = { + property: config + }; + } + + Ext.applyIf(config, { + root : 'data', + direction: "ASC" + }); + + //support for 3.x style sorters where a function can be defined as 'fn' + if (config.fn) { + config.sorterFn = config.fn; + } + + //support a function to be passed as a sorter definition + if (typeof config == 'function') { + config = { + sorterFn: config + }; + } + + groupers[i] = new Grouper(config); + } } - }, - // private - onHide : function(){ - this.getVisibilityEl().addClass('x-hide-' + this.hideMode); + return groupers; }, - - // private - getVisibilityEl : function(){ - return this.hideParent ? this.container : this.getActionEl(); + + /** + * Group data in the store + * @param {String|Array} groupers Either a string name of one of the fields in this Store's configured {@link Ext.data.Model Model}, + * or an Array of grouper configurations. + * @param {String} direction The overall direction to group the data by. Defaults to "ASC". + */ + group: function(groupers, direction) { + var me = this, + grouper, + newGroupers; + + if (Ext.isArray(groupers)) { + newGroupers = groupers; + } else if (Ext.isObject(groupers)) { + newGroupers = [groupers]; + } else if (Ext.isString(groupers)) { + grouper = me.groupers.get(groupers); + + if (!grouper) { + grouper = { + property : groupers, + direction: direction + }; + newGroupers = [grouper]; + } else if (direction === undefined) { + grouper.toggle(); + } else { + grouper.setDirection(direction); + } + } + + if (newGroupers && newGroupers.length) { + newGroupers = me.decodeGroupers(newGroupers); + me.groupers.clear(); + me.groupers.addAll(newGroupers); + } + + if (me.remoteGroup) { + me.load({ + scope: me, + callback: me.fireGroupChange + }); + } else { + me.sort(); + me.fireEvent('groupchange', me, me.groupers); + } }, - + /** - * Convenience function to hide or show this component by boolean. - * @param {Boolean} visible True to show, false to hide - * @return {Ext.Component} this + * Clear any groupers in the store */ - setVisible : function(visible){ - return this[visible ? 'show' : 'hide'](); + clearGrouping: function(){ + var me = this; + // Clear any groupers we pushed on to the sorters + me.groupers.each(function(grouper){ + me.sorters.remove(grouper); + }); + me.groupers.clear(); + if (me.remoteGroup) { + me.load({ + scope: me, + callback: me.fireGroupChange + }); + } else { + me.sort(); + me.fireEvent('groupchange', me, me.groupers); + } }, - + /** - * Returns true if this component is visible. - * @return {Boolean} True if this component is visible, false otherwise. + * Checks if the store is currently grouped + * @return {Boolean} True if the store is grouped. */ - isVisible : function(){ - return this.rendered && this.getVisibilityEl().isVisible(); + isGrouped: function() { + return this.groupers.getCount() > 0; }, - + /** - * Clone the current component using the original config values passed into this instance by default. - * @param {Object} overrides A new config containing any properties to override in the cloned version. - * An id property can be passed on this object, otherwise one will be generated to avoid duplicates. - * @return {Ext.Component} clone The cloned copy of this component + * Fires the groupchange event. Abstracted out so we can use it + * as a callback + * @private */ - cloneConfig : function(overrides){ - overrides = overrides || {}; - var id = overrides.id || Ext.id(); - var cfg = Ext.applyIf(overrides, this.initialConfig); - cfg.id = id; // prevent dup id - return new this.constructor(cfg); + fireGroupChange: function(){ + this.fireEvent('groupchange', this, this.groupers); }, /** - * Gets the xtype for this component as registered with {@link Ext.ComponentMgr}. For a list of all - * available xtypes, see the {@link Ext.Component} header. Example usage: - *
-var t = new Ext.form.TextField(); -alert(t.getXType()); // alerts 'textfield' + * Returns an object containing the result of applying grouping to the records in this store. See {@link #groupField}, + * {@link #groupDir} and {@link #getGroupString}. Example for a store containing records with a color field: + +var myStore = new Ext.data.Store({ + groupField: 'color', + groupDir : 'DESC' +}); + +myStore.getGroups(); //returns: +[ + { + name: 'yellow', + children: [ + //all records where the color field is 'yellow' + ] + }, + { + name: 'red', + children: [ + //all records where the color field is 'red' + ] + } +] - * @return {String} The xtype + * @param {String} groupName (Optional) Pass in an optional groupName argument to access a specific group as defined by {@link #getGroupString} + * @return {Array} The grouped data */ - getXType : function(){ - return this.constructor.xtype; + getGroups: function(requestGroupString) { + var records = this.data.items, + length = records.length, + groups = [], + pointers = {}, + record, + groupStr, + group, + i; + + for (i = 0; i < length; i++) { + record = records[i]; + groupStr = this.getGroupString(record); + group = pointers[groupStr]; + + if (group === undefined) { + group = { + name: groupStr, + children: [] + }; + + groups.push(group); + pointers[groupStr] = group; + } + + group.children.push(record); + } + + return requestGroupString ? pointers[requestGroupString] : groups; }, /** - * Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended - * from the xtype (default) or whether it is directly of the xtype specified (shallow = true). - * If using your own subclasses, be aware that a Component must register its own xtype - * to participate in determination of inherited xtypes. - * For a list of all available xtypes, see the {@link Ext.Component} header. - * Example usage: - * -var t = new Ext.form.TextField(); -var isText = t.isXType('textfield'); // true -var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent -var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance - - * @param {String} xtype The xtype to check for this Component - * @param {Boolean} shallow (optional) False to check whether this Component is descended from the xtype (this is - * the default), or true to check whether this Component is directly of the specified xtype. - * @return {Boolean} True if this component descends from the specified xtype, false otherwise. + * @private + * For a given set of records and a Grouper, returns an array of arrays - each of which is the set of records + * matching a certain group. */ - isXType : function(xtype, shallow){ - //assume a string by default - if (Ext.isFunction(xtype)){ - xtype = xtype.xtype; //handle being passed the class, e.g. Ext.Component - }else if (Ext.isObject(xtype)){ - xtype = xtype.constructor.xtype; //handle being passed an instance + getGroupsForGrouper: function(records, grouper) { + var length = records.length, + groups = [], + oldValue, + newValue, + record, + group, + i; + + for (i = 0; i < length; i++) { + record = records[i]; + newValue = grouper.getGroupString(record); + + if (newValue !== oldValue) { + group = { + name: newValue, + grouper: grouper, + records: [] + }; + groups.push(group); + } + + group.records.push(record); + + oldValue = newValue; } - return !shallow ? ('/' + this.getXTypes() + '/').indexOf('/' + xtype + '/') != -1 : this.constructor.xtype == xtype; + return groups; }, /** - * Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all - * available xtypes, see the {@link Ext.Component} header. - * If using your own subclasses, be aware that a Component must register its own xtype - * to participate in determination of inherited xtypes. - * Example usage: - * -var t = new Ext.form.TextField(); -alert(t.getXTypes()); // alerts 'component/box/field/textfield' - - * @return {String} The xtype hierarchy string - */ - getXTypes : function(){ - var tc = this.constructor; - if(!tc.xtypes){ - var c = [], sc = this; - while(sc && sc.constructor.xtype){ - c.unshift(sc.constructor.xtype); - sc = sc.constructor.superclass; + * @private + * This is used recursively to gather the records into the configured Groupers. The data MUST have been sorted for + * this to work properly (see {@link #getGroupData} and {@link #getGroupsForGrouper}) Most of the work is done by + * {@link #getGroupsForGrouper} - this function largely just handles the recursion. + * @param {Array} records The set or subset of records to group + * @param {Number} grouperIndex The grouper index to retrieve + * @return {Array} The grouped records + */ + getGroupsForGrouperIndex: function(records, grouperIndex) { + var me = this, + groupers = me.groupers, + grouper = groupers.getAt(grouperIndex), + groups = me.getGroupsForGrouper(records, grouper), + length = groups.length, + i; + + if (grouperIndex + 1 < groupers.length) { + for (i = 0; i < length; i++) { + groups[i].children = me.getGroupsForGrouperIndex(groups[i].records, grouperIndex + 1); } - tc.xtypeChain = c; - tc.xtypes = c.join('/'); } - return tc.xtypes; + + for (i = 0; i < length; i++) { + groups[i].depth = grouperIndex; + } + + return groups; }, /** - * Find a container above this component at any level by a custom function. If the passed function returns - * true, the container will be returned. - * @param {Function} fn The custom function to call with the arguments (container, this component). - * @return {Ext.Container} The first Container for which the custom function returns true + * @private + * Returns records grouped by the configured {@link #groupers grouper} configuration. Sample return value (in + * this case grouping by genre and then author in a fictional books dataset): + +[ + { + name: 'Fantasy', + depth: 0, + records: [ + //book1, book2, book3, book4 + ], + children: [ + { + name: 'Rowling', + depth: 1, + records: [ + //book1, book2 + ] + }, + { + name: 'Tolkein', + depth: 1, + records: [ + //book3, book4 + ] + } + ] + } +] + + * @param {Boolean} sort True to call {@link #sort} before finding groups. Sorting is required to make grouping + * function correctly so this should only be set to false if the Store is known to already be sorted correctly + * (defaults to true) + * @return {Array} The group data */ - findParentBy : function(fn) { - for (var p = this.ownerCt; (p != null) && !fn(p, this); p = p.ownerCt); - return p || null; + getGroupData: function(sort) { + var me = this; + if (sort !== false) { + me.sort(); + } + + return me.getGroupsForGrouperIndex(me.data.items, 0); }, /** - * Find a container above this component at any level by xtype or class - * @param {String/Class} xtype The xtype string for a component, or the class of the component directly - * @return {Ext.Container} The first Container which matches the given xtype or class + * Returns the string to group on for a given model instance. The default implementation of this method returns + * the model's {@link #groupField}, but this can be overridden to group by an arbitrary string. For example, to + * group by the first letter of a model's 'name' field, use the following code: + +new Ext.data.Store({ + groupDir: 'ASC', + getGroupString: function(instance) { + return instance.get('name')[0]; + } +}); + + * @param {Ext.data.Model} instance The model instance + * @return {String} The string to compare when forming groups */ - findParentByType : function(xtype) { - return Ext.isFunction(xtype) ? - this.findParentBy(function(p){ - return p.constructor === xtype; - }) : - this.findParentBy(function(p){ - return p.constructor.xtype === xtype; - }); + getGroupString: function(instance) { + var group = this.groupers.first(); + if (group) { + return instance.get(group.property); + } + return ''; }, + /** + * Inserts Model instances into the Store at the given index and fires the {@link #add} event. + * See also {@link #add}. + * @param {Number} index The start index at which to insert the passed Records. + * @param {Ext.data.Model[]} records An Array of Ext.data.Model objects to add to the cache. + */ + insert: function(index, records) { + var me = this, + sync = false, + i, + record, + len; - // protected - getPositionEl : function(){ - return this.positionEl || this.el; - }, + records = [].concat(records); + for (i = 0, len = records.length; i < len; i++) { + record = me.createModel(records[i]); + record.set(me.modelDefaults); + // reassign the model in the array in case it wasn't created yet + records[i] = record; + + me.data.insert(index + i, record); + record.join(me); - // private - purgeListeners : function(){ - Ext.Component.superclass.purgeListeners.call(this); - if(this.mons){ - this.on('beforedestroy', this.clearMons, this, {single: true}); + sync = sync || record.phantom === true; } - }, - // private - clearMons : function(){ - Ext.each(this.mons, function(m){ - m.item.un(m.ename, m.fn, m.scope); - }, this); - this.mons = []; - }, + if (me.snapshot) { + me.snapshot.addAll(records); + } - // private - createMons: function(){ - if(!this.mons){ - this.mons = []; - this.on('beforedestroy', this.clearMons, this, {single: true}); + me.fireEvent('add', me, records, index); + me.fireEvent('datachanged', me); + if (me.autoSync && sync) { + me.sync(); } }, /** - * Adds listeners to any Observable object (or Elements) which are automatically removed when this Component - * is destroyed. Usage: -myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50}); - - * or: -myGridPanel.mon(myGridPanel.getSelectionModel(), { - selectionchange: handleSelectionChange, - buffer: 50 -}); - - * @param {Observable|Element} item The item to which to add a listener/listeners. - * @param {Object|String} ename The event name, or an object containing event name properties. - * @param {Function} fn Optional. If the ename parameter was an event name, this - * is the handler function. - * @param {Object} scope Optional. If the ename parameter was an event name, this - * is the scope (this reference) in which the handler function is executed. - * @param {Object} opt Optional. If the ename parameter was an event name, this - * is the {@link Ext.util.Observable#addListener addListener} options. + * Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already- + * instantiated Models, use {@link #insert} instead. The instances will be added at the end of the existing collection. + * This method accepts either a single argument array of Model instances or any number of model instance arguments. + * Sample usage: + * + +myStore.add({some: 'data'}, {some: 'other data'}); + + * + * @param {Object} data The data for each model + * @return {Array} The array of newly created model instances */ - mon : function(item, ename, fn, scope, opt){ - this.createMons(); - if(Ext.isObject(ename)){ - var propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/; + add: function(records) { + //accept both a single-argument array of records, or any number of record arguments + if (!Ext.isArray(records)) { + records = Array.prototype.slice.apply(arguments); + } - var o = ename; - for(var e in o){ - if(propRe.test(e)){ - continue; - } - if(Ext.isFunction(o[e])){ - // shared options - this.mons.push({ - item: item, ename: e, fn: o[e], scope: o.scope - }); - item.on(e, o[e], o.scope, o); - }else{ - // individual options - this.mons.push({ - item: item, ename: e, fn: o[e], scope: o.scope - }); - item.on(e, o[e]); - } - } - return; + var me = this, + i = 0, + length = records.length, + record; + + for (; i < length; i++) { + record = me.createModel(records[i]); + // reassign the model in the array in case it wasn't created yet + records[i] = record; } - this.mons.push({ - item: item, ename: ename, fn: fn, scope: scope - }); - item.on(ename, fn, scope, opt); + me.insert(me.data.length, records); + + return records; }, /** - * Removes listeners that were added by the {@link #mon} method. - * @param {Observable|Element} item The item from which to remove a listener/listeners. - * @param {Object|String} ename The event name, or an object containing event name properties. - * @param {Function} fn Optional. If the ename parameter was an event name, this - * is the handler function. - * @param {Object} scope Optional. If the ename parameter was an event name, this - * is the scope (this reference) in which the handler function is executed. + * Converts a literal to a model, if it's not a model already + * @private + * @param record {Ext.data.Model/Object} The record to create + * @return {Ext.data.Model} */ - mun : function(item, ename, fn, scope){ - var found, mon; - this.createMons(); - for(var i = 0, len = this.mons.length; i < len; ++i){ - mon = this.mons[i]; - if(item === mon.item && ename == mon.ename && fn === mon.fn && scope === mon.scope){ - this.mons.splice(i, 1); - item.un(ename, fn, scope); - found = true; - break; - } + createModel: function(record) { + if (!record.isModel) { + record = Ext.ModelManager.create(record, this.model); } - return found; + + return record; }, /** - * Returns the next component in the owning container - * @return Ext.Component + * Calls the specified function for each of the {@link Ext.data.Model Records} in the cache. + * @param {Function} fn The function to call. The {@link Ext.data.Model Record} is passed as the first parameter. + * Returning false aborts and exits the iteration. + * @param {Object} scope (optional) The scope (this reference) in which the function is executed. + * Defaults to the current {@link Ext.data.Model Record} in the iteration. */ - nextSibling : function(){ - if(this.ownerCt){ - var index = this.ownerCt.items.indexOf(this); - if(index != -1 && index+1 < this.ownerCt.items.getCount()){ - return this.ownerCt.items.itemAt(index+1); - } - } - return null; + each: function(fn, scope) { + this.data.each(fn, scope); }, /** - * Returns the previous component in the owning container - * @return Ext.Component + * Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single + * 'datachanged' event after removal. + * @param {Ext.data.Model/Array} records The Ext.data.Model instance or array of instances to remove */ - previousSibling : function(){ - if(this.ownerCt){ - var index = this.ownerCt.items.indexOf(this); - if(index > 0){ - return this.ownerCt.items.itemAt(index-1); + remove: function(records, /* private */ isMove) { + if (!Ext.isArray(records)) { + records = [records]; + } + + /* + * Pass the isMove parameter if we know we're going to be re-inserting this record + */ + isMove = isMove === true; + var me = this, + sync = false, + i = 0, + length = records.length, + isPhantom, + index, + record; + + for (; i < length; i++) { + record = records[i]; + index = me.data.indexOf(record); + + if (me.snapshot) { + me.snapshot.remove(record); + } + + if (index > -1) { + isPhantom = record.phantom === true; + if (!isMove && !isPhantom) { + // don't push phantom records onto removed + me.removed.push(record); + } + + record.unjoin(me); + me.data.remove(record); + sync = sync || !isPhantom; + + me.fireEvent('remove', me, record, index); } } - return null; + + me.fireEvent('datachanged', me); + if (!isMove && me.autoSync && sync) { + me.sync(); + } }, /** - * Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. - * @return {Ext.Container} the Container which owns this Component. + * Removes the model instance at the given index + * @param {Number} index The record index */ - getBubbleTarget : function(){ - return this.ownerCt; - } -}); + removeAt: function(index) { + var record = this.getAt(index); -Ext.reg('component', Ext.Component);/** - * @class Ext.Action - * An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it - * can be usefully shared among multiple components. Actions let you share handlers, configuration options and UI - * updates across any components that support the Action interface (primarily {@link Ext.Toolbar}, {@link Ext.Button} - * and {@link Ext.menu.Menu} components). - * Aside from supporting the config object interface, any component that needs to use Actions must also support - * the following method list, as these will be called as needed by the Action class: setText(string), setIconCls(string), - * setDisabled(boolean), setVisible(boolean) and setHandler(function). - * Example usage: - * -// Define the shared action. Each component below will have the same -// display text and icon, and will display the same message on click. -var action = new Ext.Action({ - {@link #text}: 'Do something', - {@link #handler}: function(){ - Ext.Msg.alert('Click', 'You did something.'); + if (record) { + this.remove(record); + } }, - {@link #iconCls}: 'do-something', - {@link #itemId}: 'myAction' + + /** + * Loads data into the Store via the configured {@link #proxy}. This uses the Proxy to make an + * asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved + * instances into the Store and calling an optional callback if required. Example usage: + * + +store.load({ + scope : this, + callback: function(records, operation, success) { + //the {@link Ext.data.Operation operation} object contains all of the details of the load operation + console.log(records); + } +}); + + * + * If the callback scope does not need to be set, a function can simply be passed: + * + +store.load(function(records, operation, success) { + console.log('loaded records'); }); + + * + * @param {Object/Function} options Optional config object, passed into the Ext.data.Operation object before loading. + */ + load: function(options) { + var me = this; + + options = options || {}; -var panel = new Ext.Panel({ - title: 'Actions', - width: 500, - height: 300, - tbar: [ - // Add the action directly to a toolbar as a menu button - action, - { - text: 'Action Menu', - // Add the action to a menu as a text item - menu: [action] + if (Ext.isFunction(options)) { + options = { + callback: options + }; } - ], - items: [ - // Add the action to the panel body as a standard button - new Ext.Button(action) - ], - renderTo: Ext.getBody() -}); -// Change the text for all components using the action -action.setText('Something else'); + Ext.applyIf(options, { + groupers: me.groupers.items, + page: me.currentPage, + start: (me.currentPage - 1) * me.pageSize, + limit: me.pageSize, + addRecords: false + }); -// Reference an action through a container using the itemId -var btn = panel.getComponent('myAction'); -var aRef = btn.baseAction; -aRef.setText('New text'); - - * @constructor - * @param {Object} config The configuration options - */ -Ext.Action = Ext.extend(Object, { - /** - * @cfg {String} text The text to set for all components using this action (defaults to ''). - */ - /** - * @cfg {String} iconCls - * The CSS class selector that specifies a background image to be used as the header icon for - * all components using this action (defaults to ''). - * An example of specifying a custom icon class would be something like: - * -// specify the property in the config for the class: - ... - iconCls: 'do-something' + return me.callParent([options]); + }, -// css class that specifies background image to be used as the icon image: -.do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; } - - */ - /** - * @cfg {Boolean} disabled True to disable all components using this action, false to enable them (defaults to false). - */ - /** - * @cfg {Boolean} hidden True to hide all components using this action, false to show them (defaults to false). - */ /** - * @cfg {Function} handler The function that will be invoked by each component tied to this action - * when the component's primary event is triggered (defaults to undefined). - */ - /** - * @cfg {String} itemId - * See {@link Ext.Component}.{@link Ext.Component#itemId itemId}. - */ - /** - * @cfg {Object} scope The scope (this reference) in which the - * {@link #handler} is executed. Defaults to this Button. + * @private + * Called internally when a Proxy has completed a load request */ + onProxyLoad: function(operation) { + var me = this, + resultSet = operation.getResultSet(), + records = operation.getRecords(), + successful = operation.wasSuccessful(); - constructor : function(config){ - this.initialConfig = config; - this.itemId = config.itemId = (config.itemId || config.id || Ext.id()); - this.items = []; + if (resultSet) { + me.totalCount = resultSet.total; + } + + if (successful) { + me.loadRecords(records, operation); + } + + me.loading = false; + me.fireEvent('load', me, records, successful); + + //TODO: deprecate this event, it should always have been 'load' instead. 'load' is now documented, 'read' is not. + //People are definitely using this so can't deprecate safely until 2.x + me.fireEvent('read', me, records, operation.wasSuccessful()); + + //this is a callback that would have been passed to the 'read' function and is optional + Ext.callback(operation.callback, operation.scope || me, [records, operation, successful]); }, - // private - isAction : true, - /** - * Sets the text to be displayed by all components using this action. - * @param {String} text The text to display - */ - setText : function(text){ - this.initialConfig.text = text; - this.callEach('setText', [text]); + * Create any new records when a write is returned from the server. + * @private + * @param {Array} records The array of new records + * @param {Ext.data.Operation} operation The operation that just completed + * @param {Boolean} success True if the operation was successful + */ + onCreateRecords: function(records, operation, success) { + if (success) { + var i = 0, + data = this.data, + snapshot = this.snapshot, + length = records.length, + originalRecords = operation.records, + record, + original, + index; + + /* + * Loop over each record returned from the server. Assume they are + * returned in order of how they were sent. If we find a matching + * record, replace it with the newly created one. + */ + for (; i < length; ++i) { + record = records[i]; + original = originalRecords[i]; + if (original) { + index = data.indexOf(original); + if (index > -1) { + data.removeAt(index); + data.insert(index, record); + } + if (snapshot) { + index = snapshot.indexOf(original); + if (index > -1) { + snapshot.removeAt(index); + snapshot.insert(index, record); + } + } + record.phantom = false; + record.join(this); + } + } + } }, /** - * Gets the text currently displayed by all components using this action. - */ - getText : function(){ - return this.initialConfig.text; + * Update any records when a write is returned from the server. + * @private + * @param {Array} records The array of updated records + * @param {Ext.data.Operation} operation The operation that just completed + * @param {Boolean} success True if the operation was successful + */ + onUpdateRecords: function(records, operation, success){ + if (success) { + var i = 0, + length = records.length, + data = this.data, + snapshot = this.snapshot, + record; + + for (; i < length; ++i) { + record = records[i]; + data.replace(record); + if (snapshot) { + snapshot.replace(record); + } + record.join(this); + } + } }, /** - * Sets the icon CSS class for all components using this action. The class should supply - * a background image that will be used as the icon image. - * @param {String} cls The CSS class supplying the icon image + * Remove any records when a write is returned from the server. + * @private + * @param {Array} records The array of removed records + * @param {Ext.data.Operation} operation The operation that just completed + * @param {Boolean} success True if the operation was successful */ - setIconClass : function(cls){ - this.initialConfig.iconCls = cls; - this.callEach('setIconClass', [cls]); + onDestroyRecords: function(records, operation, success){ + if (success) { + var me = this, + i = 0, + length = records.length, + data = me.data, + snapshot = me.snapshot, + record; + + for (; i < length; ++i) { + record = records[i]; + record.unjoin(me); + data.remove(record); + if (snapshot) { + snapshot.remove(record); + } + } + me.removed = []; + } }, - /** - * Gets the icon CSS class currently used by all components using this action. - */ - getIconClass : function(){ - return this.initialConfig.iconCls; + //inherit docs + getNewRecords: function() { + return this.data.filterBy(this.filterNew).items; }, - /** - * Sets the disabled state of all components using this action. Shortcut method - * for {@link #enable} and {@link #disable}. - * @param {Boolean} disabled True to disable the component, false to enable it - */ - setDisabled : function(v){ - this.initialConfig.disabled = v; - this.callEach('setDisabled', [v]); + //inherit docs + getUpdatedRecords: function() { + return this.data.filterBy(this.filterUpdated).items; }, /** - * Enables all components using this action. + * Filters the loaded set of records by a given set of filters. + * @param {Mixed} filters The set of filters to apply to the data. These are stored internally on the store, + * but the filtering itself is done on the Store's {@link Ext.util.MixedCollection MixedCollection}. See + * MixedCollection's {@link Ext.util.MixedCollection#filter filter} method for filter syntax. Alternatively, + * pass in a property string + * @param {String} value Optional value to filter by (only if using a property string as the first argument) */ - enable : function(){ - this.setDisabled(false); + filter: function(filters, value) { + if (Ext.isString(filters)) { + filters = { + property: filters, + value: value + }; + } + + var me = this, + decoded = me.decodeFilters(filters), + i = 0, + doLocalSort = me.sortOnFilter && !me.remoteSort, + length = decoded.length; + + for (; i < length; i++) { + me.filters.replace(decoded[i]); + } + + if (me.remoteFilter) { + //the load function will pick up the new filters and request the filtered data from the proxy + me.load(); + } else { + /** + * A pristine (unfiltered) collection of the records in this store. This is used to reinstate + * records when a filter is removed or changed + * @property snapshot + * @type Ext.util.MixedCollection + */ + if (me.filters.getCount()) { + me.snapshot = me.snapshot || me.data.clone(); + me.data = me.data.filter(me.filters.items); + + if (doLocalSort) { + me.sort(); + } + // fire datachanged event if it hasn't already been fired by doSort + if (!doLocalSort || me.sorters.length < 1) { + me.fireEvent('datachanged', me); + } + } + } }, /** - * Disables all components using this action. + * Revert to a view of the Record cache with no filtering applied. + * @param {Boolean} suppressEvent If true the filter is cleared silently without firing the + * {@link #datachanged} event. */ - disable : function(){ - this.setDisabled(true); + clearFilter: function(suppressEvent) { + var me = this; + + me.filters.clear(); + + if (me.remoteFilter) { + me.load(); + } else if (me.isFiltered()) { + me.data = me.snapshot.clone(); + delete me.snapshot; + + if (suppressEvent !== true) { + me.fireEvent('datachanged', me); + } + } }, /** - * Returns true if the components using this action are currently disabled, else returns false. + * Returns true if this store is currently filtered + * @return {Boolean} */ - isDisabled : function(){ - return this.initialConfig.disabled; + isFiltered: function() { + var snapshot = this.snapshot; + return !! snapshot && snapshot !== this.data; }, /** - * Sets the hidden state of all components using this action. Shortcut method - * for {@link #hide} and {@link #show}. - * @param {Boolean} hidden True to hide the component, false to show it + * Filter by a function. The specified function will be called for each + * Record in this Store. If the function returns true the Record is included, + * otherwise it is filtered out. + * @param {Function} fn The function to be called. It will be passed the following parameters: + * record : Ext.data.ModelThe {@link Ext.data.Model record} + * to test for filtering. Access field values using {@link Ext.data.Model#get}. + * id : ObjectThe ID of the Record passed. + * + * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to this Store. */ - setHidden : function(v){ - this.initialConfig.hidden = v; - this.callEach('setVisible', [!v]); + filterBy: function(fn, scope) { + var me = this; + + me.snapshot = me.snapshot || me.data.clone(); + me.data = me.queryBy(fn, scope || me); + me.fireEvent('datachanged', me); }, /** - * Shows all components using this action. - */ - show : function(){ - this.setHidden(false); + * Query the cached records in this Store using a filtering function. The specified function + * will be called with each record in this Store. If the function returns true the record is + * included in the results. + * @param {Function} fn The function to be called. It will be passed the following parameters: + * record : Ext.data.ModelThe {@link Ext.data.Model record} + * to test for filtering. Access field values using {@link Ext.data.Model#get}. + * id : ObjectThe ID of the Record passed. + * + * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to this Store. + * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records + **/ + queryBy: function(fn, scope) { + var me = this, + data = me.snapshot || me.data; + return data.filterBy(fn, scope || me); }, /** - * Hides all components using this action. + * Loads an array of data straight into the Store + * @param {Array} data Array of data to load. Any non-model instances will be cast into model instances first + * @param {Boolean} append True to add the records to the existing records in the store, false to remove the old ones first */ - hide : function(){ - this.setHidden(true); + loadData: function(data, append) { + var model = this.model, + length = data.length, + i, + record; + + //make sure each data element is an Ext.data.Model instance + for (i = 0; i < length; i++) { + record = data[i]; + + if (! (record instanceof Ext.data.Model)) { + data[i] = Ext.ModelManager.create(record, model); + } + } + + this.loadRecords(data, {addRecords: append}); }, /** - * Returns true if the components using this action are currently hidden, else returns false. + * Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usually + * be called internally when loading from the {@link Ext.data.proxy.Proxy Proxy}, when adding records manually use {@link #add} instead + * @param {Array} records The array of records to load + * @param {Object} options {addRecords: true} to add these records to the existing records, false to remove the Store's existing records first */ - isHidden : function(){ - return this.initialConfig.hidden; + loadRecords: function(records, options) { + var me = this, + i = 0, + length = records.length; + + options = options || {}; + + + if (!options.addRecords) { + delete me.snapshot; + me.data.clear(); + } + + me.data.addAll(records); + + //FIXME: this is not a good solution. Ed Spencer is totally responsible for this and should be forced to fix it immediately. + for (; i < length; i++) { + if (options.start !== undefined) { + records[i].index = options.start + i; + + } + records[i].join(me); + } + + /* + * this rather inelegant suspension and resumption of events is required because both the filter and sort functions + * fire an additional datachanged event, which is not wanted. Ideally we would do this a different way. The first + * datachanged event is fired by the call to this.add, above. + */ + me.suspendEvents(); + + if (me.filterOnLoad && !me.remoteFilter) { + me.filter(); + } + + if (me.sortOnLoad && !me.remoteSort) { + me.sort(); + } + + me.resumeEvents(); + me.fireEvent('datachanged', me, records); }, + // PAGING METHODS /** - * Sets the function that will be called by each Component using this action when its primary event is triggered. - * @param {Function} fn The function that will be invoked by the action's components. The function - * will be called with no arguments. - * @param {Object} scope The scope (this reference) in which the function is executed. Defaults to the Component firing the event. + * Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal + * load operation, passing in calculated 'start' and 'limit' params + * @param {Number} page The number of the page to load */ - setHandler : function(fn, scope){ - this.initialConfig.handler = fn; - this.initialConfig.scope = scope; - this.callEach('setHandler', [fn, scope]); + loadPage: function(page) { + var me = this; + + me.currentPage = page; + + me.read({ + page: page, + start: (page - 1) * me.pageSize, + limit: me.pageSize, + addRecords: !me.clearOnPageLoad + }); }, /** - * Executes the specified function once for each Component currently tied to this action. The function passed - * in should accept a single argument that will be an object that supports the basic Action config/method interface. - * @param {Function} fn The function to execute for each component - * @param {Object} scope The scope (this reference) in which the function is executed. Defaults to the Component. + * Loads the next 'page' in the current data set */ - each : function(fn, scope){ - Ext.each(this.items, fn, scope); + nextPage: function() { + this.loadPage(this.currentPage + 1); }, - // private - callEach : function(fnName, args){ - var cs = this.items; - for(var i = 0, len = cs.length; i < len; i++){ - cs[i][fnName].apply(cs[i], args); - } + /** + * Loads the previous 'page' in the current data set + */ + previousPage: function() { + this.loadPage(this.currentPage - 1); }, // private - addComponent : function(comp){ - this.items.push(comp); - comp.on('destroy', this.removeComponent, this); - }, + clearData: function() { + this.data.each(function(record) { + record.unjoin(); + }); - // private - removeComponent : function(comp){ - this.items.remove(comp); + this.data.clear(); }, - + + // Buffering /** - * Executes this action manually using the handler function specified in the original config object - * or the handler function set with {@link #setHandler}. Any arguments passed to this - * function will be passed on to the handler function. - * @param {Mixed} arg1 (optional) Variable number of arguments passed to the handler function - * @param {Mixed} arg2 (optional) - * @param {Mixed} etc... (optional) + * Prefetches data the Store using its configured {@link #proxy}. + * @param {Object} options Optional config object, passed into the Ext.data.Operation object before loading. + * See {@link #load} */ - execute : function(){ - this.initialConfig.handler.apply(this.initialConfig.scope || window, arguments); - } -}); -/** - * @class Ext.Layer - * @extends Ext.Element - * An extended {@link Ext.Element} object that supports a shadow and shim, constrain to viewport and - * automatic maintaining of shadow/shim positions. - * @cfg {Boolean} shim False to disable the iframe shim in browsers which need one (defaults to true) - * @cfg {String/Boolean} shadow True to automatically create an {@link Ext.Shadow}, or a string indicating the - * shadow's display {@link Ext.Shadow#mode}. False to disable the shadow. (defaults to false) - * @cfg {Object} dh DomHelper object config to create element with (defaults to {tag: 'div', cls: 'x-layer'}). - * @cfg {Boolean} constrain False to disable constrain to viewport (defaults to true) - * @cfg {String} cls CSS class to add to the element - * @cfg {Number} zindex Starting z-index (defaults to 11000) - * @cfg {Number} shadowOffset Number of pixels to offset the shadow (defaults to 4) - * @cfg {Boolean} useDisplay - * Defaults to use css offsets to hide the Layer. Specify true - * to use css style 'display:none;' to hide the Layer. - * @constructor - * @param {Object} config An object with config options. - * @param {String/HTMLElement} existingEl (optional) Uses an existing DOM element. If the element is not found it creates it. - */ -(function(){ -Ext.Layer = function(config, existingEl){ - config = config || {}; - var dh = Ext.DomHelper; - var cp = config.parentEl, pel = cp ? Ext.getDom(cp) : document.body; - if(existingEl){ - this.dom = Ext.getDom(existingEl); - } - if(!this.dom){ - var o = config.dh || {tag: 'div', cls: 'x-layer'}; - this.dom = dh.append(pel, o); - } - if(config.cls){ - this.addClass(config.cls); - } - this.constrain = config.constrain !== false; - this.setVisibilityMode(Ext.Element.VISIBILITY); - if(config.id){ - this.id = this.dom.id = config.id; - }else{ - this.id = Ext.id(this.dom); - } - this.zindex = config.zindex || this.getZIndex(); - this.position('absolute', this.zindex); - if(config.shadow){ - this.shadowOffset = config.shadowOffset || 4; - this.shadow = new Ext.Shadow({ - offset : this.shadowOffset, - mode : config.shadow - }); - }else{ - this.shadowOffset = 0; - } - this.useShim = config.shim !== false && Ext.useShims; - this.useDisplay = config.useDisplay; - this.hide(); -}; + prefetch: function(options) { + var me = this, + operation, + requestId = me.getRequestId(); -var supr = Ext.Element.prototype; + options = options || {}; -// shims are shared among layer to keep from having 100 iframes -var shims = []; + Ext.applyIf(options, { + action : 'read', + filters: me.filters.items, + sorters: me.sorters.items, + requestId: requestId + }); + me.pendingRequests.push(requestId); -Ext.extend(Ext.Layer, Ext.Element, { + operation = Ext.create('Ext.data.Operation', options); - getZIndex : function(){ - return this.zindex || parseInt((this.getShim() || this).getStyle('z-index'), 10) || 11000; + // HACK to implement loadMask support. + //if (operation.blocking) { + // me.fireEvent('beforeload', me, operation); + //} + if (me.fireEvent('beforeprefetch', me, operation) !== false) { + me.loading = true; + me.proxy.read(operation, me.onProxyPrefetch, me); + } + + return me; }, - - getShim : function(){ - if(!this.useShim){ - return null; + + /** + * Prefetches a page of data. + * @param {Number} page The page to prefetch + * @param {Object} options Optional config object, passed into the Ext.data.Operation object before loading. + * See {@link #load} + * @param + */ + prefetchPage: function(page, options) { + var me = this, + pageSize = me.pageSize, + start = (page - 1) * me.pageSize, + end = start + pageSize; + + // Currently not requesting this page and range isn't already satisified + if (Ext.Array.indexOf(me.pagesRequested, page) === -1 && !me.rangeSatisfied(start, end)) { + options = options || {}; + me.pagesRequested.push(page); + Ext.applyIf(options, { + page : page, + start: start, + limit: pageSize, + callback: me.onWaitForGuarantee, + scope: me + }); + + me.prefetch(options); } - if(this.shim){ - return this.shim; + + }, + + /** + * Returns a unique requestId to track requests. + * @private + */ + getRequestId: function() { + this.requestSeed = this.requestSeed || 1; + return this.requestSeed++; + }, + + /** + * Handles a success pre-fetch + * @private + * @param {Ext.data.Operation} operation The operation that completed + */ + onProxyPrefetch: function(operation) { + var me = this, + resultSet = operation.getResultSet(), + records = operation.getRecords(), + + successful = operation.wasSuccessful(); + + if (resultSet) { + me.totalCount = resultSet.total; + me.fireEvent('totalcountchange', me.totalCount); } - var shim = shims.shift(); - if(!shim){ - shim = this.createShim(); - shim.enableDisplayMode('block'); - shim.dom.style.display = 'none'; - shim.dom.style.visibility = 'visible'; + + if (successful) { + me.cacheRecords(records, operation); } - var pn = this.dom.parentNode; - if(shim.dom.parentNode != pn){ - pn.insertBefore(shim.dom, this.dom); + Ext.Array.remove(me.pendingRequests, operation.requestId); + if (operation.page) { + Ext.Array.remove(me.pagesRequested, operation.page); } - shim.setStyle('z-index', this.getZIndex()-2); - this.shim = shim; - return shim; - }, - - hideShim : function(){ - if(this.shim){ - this.shim.setDisplayed(false); - shims.push(this.shim); - delete this.shim; + + me.loading = false; + me.fireEvent('prefetch', me, records, successful, operation); + + // HACK to support loadMask + if (operation.blocking) { + me.fireEvent('load', me, records, successful); } - }, - disableShadow : function(){ - if(this.shadow){ - this.shadowDisabled = true; - this.shadow.hide(); - this.lastShadowOffset = this.shadowOffset; - this.shadowOffset = 0; - } + //this is a callback that would have been passed to the 'read' function and is optional + Ext.callback(operation.callback, operation.scope || me, [records, operation, successful]); }, - - enableShadow : function(show){ - if(this.shadow){ - this.shadowDisabled = false; - this.shadowOffset = this.lastShadowOffset; - delete this.lastShadowOffset; - if(show){ - this.sync(true); - } + + /** + * Caches the records in the prefetch and stripes them with their server-side + * index. + * @private + * @param {Array} records The records to cache + * @param {Ext.data.Operation} The associated operation + */ + cacheRecords: function(records, operation) { + var me = this, + i = 0, + length = records.length, + start = operation ? operation.start : 0; + + if (!Ext.isDefined(me.totalCount)) { + me.totalCount = records.length; + me.fireEvent('totalcountchange', me.totalCount); } - }, - - // private - // this code can execute repeatedly in milliseconds (i.e. during a drag) so - // code size was sacrificed for effeciency (e.g. no getBox/setBox, no XY calls) - sync : function(doShow){ - var shadow = this.shadow; - if(!this.updating && this.isVisible() && (shadow || this.useShim)){ - var shim = this.getShim(), - w = this.getWidth(), - h = this.getHeight(), - l = this.getLeft(true), - t = this.getTop(true); - - if(shadow && !this.shadowDisabled){ - if(doShow && !shadow.isVisible()){ - shadow.show(this); - }else{ - shadow.realign(l, t, w, h); - } - if(shim){ - if(doShow){ - shim.show(); - } - // fit the shim behind the shadow, so it is shimmed too - var shadowAdj = shadow.el.getXY(), shimStyle = shim.dom.style, - shadowSize = shadow.el.getSize(); - shimStyle.left = (shadowAdj[0])+'px'; - shimStyle.top = (shadowAdj[1])+'px'; - shimStyle.width = (shadowSize.width)+'px'; - shimStyle.height = (shadowSize.height)+'px'; - } - }else if(shim){ - if(doShow){ - shim.show(); - } - shim.setSize(w, h); - shim.setLeftTop(l, t); - } + + for (; i < length; i++) { + // this is the true index, not the viewIndex + records[i].index = start + i; } - }, - - // private - destroy : function(){ - this.hideShim(); - if(this.shadow){ - this.shadow.hide(); + + me.prefetchData.addAll(records); + if (me.purgePageCount) { + me.purgeRecords(); } - this.removeAllListeners(); - Ext.removeNode(this.dom); - delete this.dom; - }, - - remove : function(){ - this.destroy(); - }, - - // private - beginUpdate : function(){ - this.updating = true; - }, - - // private - endUpdate : function(){ - this.updating = false; - this.sync(true); + }, + + + /** + * Purge the least recently used records in the prefetch if the purgeCount + * has been exceeded. + */ + purgeRecords: function() { + var me = this, + prefetchCount = me.prefetchData.getCount(), + purgeCount = me.purgePageCount * me.pageSize, + numRecordsToPurge = prefetchCount - purgeCount - 1, + i = 0; - // private - hideUnders : function(negOffset){ - if(this.shadow){ - this.shadow.hide(); + for (; i <= numRecordsToPurge; i++) { + me.prefetchData.removeAt(0); } - this.hideShim(); }, - - // private - constrainXY : function(){ - if(this.constrain){ - var vw = Ext.lib.Dom.getViewWidth(), - vh = Ext.lib.Dom.getViewHeight(); - var s = Ext.getDoc().getScroll(); - - var xy = this.getXY(); - var x = xy[0], y = xy[1]; - var so = this.shadowOffset; - var w = this.dom.offsetWidth+so, h = this.dom.offsetHeight+so; - // only move it if it needs it - var moved = false; - // first validate right/bottom - if((x + w) > vw+s.left){ - x = vw - w - so; - moved = true; - } - if((y + h) > vh+s.top){ - y = vh - h - so; - moved = true; - } - // then make sure top/left isn't negative - if(x < s.left){ - x = s.left; - moved = true; - } - if(y < s.top){ - y = s.top; - moved = true; - } - if(moved){ - if(this.avoidY){ - var ay = this.avoidY; - if(y <= ay && (y+h) >= ay){ - y = ay-h-5; - } + + /** + * Determines if the range has already been satisfied in the prefetchData. + * @private + * @param {Number} start The start index + * @param {Number} end The end index in the range + */ + rangeSatisfied: function(start, end) { + var me = this, + i = start, + satisfied = true; + + for (; i < end; i++) { + if (!me.prefetchData.getByKey(i)) { + satisfied = false; + if (end - i > me.pageSize) { + Ext.Error.raise("A single page prefetch could never satisfy this request."); } - xy = [x, y]; - this.storeXY(xy); - supr.setXY.call(this, xy); - this.sync(); + break; } } - return this; + return satisfied; }, - getConstrainOffset : function(){ - return this.shadowOffset; + /** + * Determines the page from a record index + * @param {Number} index The record index + * @return {Number} The page the record belongs to + */ + getPageFromRecordIndex: function(index) { + return Math.floor(index / this.pageSize) + 1; }, - - isVisible : function(){ - return this.visible; + + /** + * Handles a guaranteed range being loaded + * @private + */ + onGuaranteedRange: function() { + var me = this, + totalCount = me.getTotalCount(), + start = me.requestStart, + end = ((totalCount - 1) < me.requestEnd) ? totalCount - 1 : me.requestEnd, + range = [], + record, + i = start; + + if (start > end) { + Ext.Error.raise("Start (" + start + ") was greater than end (" + end + ")"); + } + + if (start !== me.guaranteedStart && end !== me.guaranteedEnd) { + me.guaranteedStart = start; + me.guaranteedEnd = end; + + for (; i <= end; i++) { + record = me.prefetchData.getByKey(i); + if (!record) { + Ext.Error.raise("Record was not found and store said it was guaranteed"); + } + range.push(record); + } + me.fireEvent('guaranteedrange', range, start, end); + if (me.cb) { + me.cb.call(me.scope || me, range); + } + } + + me.unmask(); }, - - // private - showAction : function(){ - this.visible = true; // track visibility to prevent getStyle calls - if(this.useDisplay === true){ - this.setDisplayed(''); - }else if(this.lastXY){ - supr.setXY.call(this, this.lastXY); - }else if(this.lastLT){ - supr.setLeftTop.call(this, this.lastLT[0], this.lastLT[1]); + + // hack to support loadmask + mask: function() { + this.masked = true; + this.fireEvent('beforeload'); + }, + + // hack to support loadmask + unmask: function() { + if (this.masked) { + this.fireEvent('load'); } }, - - // private - hideAction : function(){ - this.visible = false; - if(this.useDisplay === true){ - this.setDisplayed(false); - }else{ - this.setLeftTop(-10000,-10000); + + /** + * Returns the number of pending requests out. + */ + hasPendingRequests: function() { + return this.pendingRequests.length; + }, + + + // wait until all requests finish, until guaranteeing the range. + onWaitForGuarantee: function() { + if (!this.hasPendingRequests()) { + this.onGuaranteedRange(); } }, - - // overridden Element method - setVisible : function(v, a, d, c, e){ - if(v){ - this.showAction(); + + /** + * Guarantee a specific range, this will load the store with a range (that + * must be the pageSize or smaller) and take care of any loading that may + * be necessary. + */ + guaranteeRange: function(start, end, cb, scope) { + if (start && end) { + if (end - start > this.pageSize) { + Ext.Error.raise({ + start: start, + end: end, + pageSize: this.pageSize, + msg: "Requested a bigger range than the specified pageSize" + }); + } } - if(a && v){ - var cb = function(){ - this.sync(true); - if(c){ - c(); + + end = (end > this.totalCount) ? this.totalCount - 1 : end; + + var me = this, + i = start, + prefetchData = me.prefetchData, + range = [], + startLoaded = !!prefetchData.getByKey(start), + endLoaded = !!prefetchData.getByKey(end), + startPage = me.getPageFromRecordIndex(start), + endPage = me.getPageFromRecordIndex(end); + + me.cb = cb; + me.scope = scope; + + me.requestStart = start; + me.requestEnd = end; + // neither beginning or end are loaded + if (!startLoaded || !endLoaded) { + // same page, lets load it + if (startPage === endPage) { + me.mask(); + me.prefetchPage(startPage, { + //blocking: true, + callback: me.onWaitForGuarantee, + scope: me + }); + // need to load two pages + } else { + me.mask(); + me.prefetchPage(startPage, { + //blocking: true, + callback: me.onWaitForGuarantee, + scope: me + }); + me.prefetchPage(endPage, { + //blocking: true, + callback: me.onWaitForGuarantee, + scope: me + }); + } + // Request was already satisfied via the prefetch + } else { + me.onGuaranteedRange(); + } + }, + + // because prefetchData is stored by index + // this invalidates all of the prefetchedData + sort: function() { + var me = this, + prefetchData = me.prefetchData, + sorters, + start, + end, + range; + + if (me.buffered) { + if (me.remoteSort) { + prefetchData.clear(); + me.callParent(arguments); + } else { + sorters = me.getSorters(); + start = me.guaranteedStart; + end = me.guaranteedEnd; + + if (sorters.length) { + prefetchData.sort(sorters); + range = prefetchData.getRange(); + prefetchData.clear(); + me.cacheRecords(range); + delete me.guaranteedStart; + delete me.guaranteedEnd; + me.guaranteeRange(start, end); } - }.createDelegate(this); - supr.setVisible.call(this, true, true, d, cb, e); - }else{ - if(!v){ - this.hideUnders(true); - } - var cb = c; - if(a){ - cb = function(){ - this.hideAction(); - if(c){ - c(); - } - }.createDelegate(this); + me.callParent(arguments); } - supr.setVisible.call(this, v, a, d, cb, e); - if(v){ - this.sync(true); - }else if(!a){ - this.hideAction(); + } else { + me.callParent(arguments); + } + }, + + // overriden to provide striping of the indexes as sorting occurs. + // this cannot be done inside of sort because datachanged has already + // fired and will trigger a repaint of the bound view. + doSort: function(sorterFn) { + var me = this; + if (me.remoteSort) { + //the load function will pick up the new sorters and request the sorted data from the proxy + me.load(); + } else { + me.data.sortBy(sorterFn); + if (!me.buffered) { + var range = me.getRange(), + ln = range.length, + i = 0; + for (; i < ln; i++) { + range[i].index = i; + } } + me.fireEvent('datachanged', me); } - return this; + }, + + /** + * Finds the index of the first matching Record in this store by a specific field value. + * @param {String} fieldName The name of the Record field to test. + * @param {String/RegExp} value Either a string that the field value + * should begin with, or a RegExp to test against the field. + * @param {Number} startIndex (optional) The index to start searching at + * @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 + * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. + * @return {Number} The matched index or -1 + */ + find: function(property, value, start, anyMatch, caseSensitive, exactMatch) { + var fn = this.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch); + return fn ? this.data.findIndexBy(fn, null, start) : -1; }, - storeXY : function(xy){ - delete this.lastLT; - this.lastXY = xy; + /** + * Finds the first matching Record in this store by a specific field value. + * @param {String} fieldName The name of the Record field to test. + * @param {String/RegExp} value Either a string that the field value + * should begin with, or a RegExp to test against the field. + * @param {Number} startIndex (optional) The index to start searching at + * @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 + * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. + * @return {Ext.data.Model} The matched record or null + */ + findRecord: function() { + var me = this, + index = me.find.apply(me, arguments); + return index !== -1 ? me.getAt(index) : null; }, - storeLeftTop : function(left, top){ - delete this.lastXY; - this.lastLT = [left, top]; + /** + * @private + * Returns a filter function used to test a the given property's value. Defers most of the work to + * Ext.util.MixedCollection's createValueMatcher function + * @param {String} property The property to create the filter function for + * @param {String/RegExp} value The string/regex to compare the property value to + * @param {Boolean} anyMatch True if we don't care if the filter value is not the full value (defaults to false) + * @param {Boolean} caseSensitive True to create a case-sensitive 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. + */ + createFilterFn: function(property, value, anyMatch, caseSensitive, exactMatch) { + if (Ext.isEmpty(value)) { + return false; + } + value = this.data.createValueMatcher(value, anyMatch, caseSensitive, exactMatch); + return function(r) { + return value.test(r.data[property]); + }; }, - // private - beforeFx : function(){ - this.beforeAction(); - return Ext.Layer.superclass.beforeFx.apply(this, arguments); + /** + * Finds the index of the first matching Record in this store by a specific field value. + * @param {String} fieldName The name of the Record field to test. + * @param {Mixed} value The value to match the field against. + * @param {Number} startIndex (optional) The index to start searching at + * @return {Number} The matched index or -1 + */ + findExact: function(property, value, start) { + return this.data.findIndexBy(function(rec) { + return rec.get(property) === value; + }, + this, start); }, - // private - afterFx : function(){ - Ext.Layer.superclass.afterFx.apply(this, arguments); - this.sync(this.isVisible()); + /** + * Find the index of the first matching Record in this Store by a function. + * If the function returns true it is considered a match. + * @param {Function} fn The function to be called. It will be passed the following parameters: + * record : Ext.data.ModelThe {@link Ext.data.Model record} + * to test for filtering. Access field values using {@link Ext.data.Model#get}. + * id : ObjectThe ID of the Record passed. + * + * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to this Store. + * @param {Number} startIndex (optional) The index to start searching at + * @return {Number} The matched index or -1 + */ + findBy: function(fn, scope, start) { + return this.data.findIndexBy(fn, scope, start); }, - // private - beforeAction : function(){ - if(!this.updating && this.shadow){ - this.shadow.hide(); - } + /** + * Collects unique values for a particular dataIndex from this store. + * @param {String} dataIndex The property to collect + * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values + * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered + * @return {Array} An array of the unique values + **/ + collect: function(dataIndex, allowNull, bypassFilter) { + var me = this, + data = (bypassFilter === true && me.snapshot) ? me.snapshot: me.data; + + return data.collect(dataIndex, 'data', allowNull); }, - // overridden Element method - setLeft : function(left){ - this.storeLeftTop(left, this.getTop(true)); - supr.setLeft.apply(this, arguments); - this.sync(); - return this; + /** + * Gets the number of cached records. + * If using paging, this may not be the total size of the dataset. If the data object + * used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns + * the dataset size. Note: see the Important note in {@link #load}. + * @return {Number} The number of Records in the Store's cache. + */ + getCount: function() { + return this.data.length || 0; }, - setTop : function(top){ - this.storeLeftTop(this.getLeft(true), top); - supr.setTop.apply(this, arguments); - this.sync(); - return this; + /** + * Returns the total number of {@link Ext.data.Model Model} instances that the {@link Ext.data.proxy.Proxy Proxy} + * indicates exist. This will usually differ from {@link #getCount} when using paging - getCount returns the + * number of records loaded into the Store at the moment, getTotalCount returns the number of records that + * could be loaded into the Store if the Store contained all data + * @return {Number} The total number of Model instances available via the Proxy + */ + getTotalCount: function() { + return this.totalCount; }, - setLeftTop : function(left, top){ - this.storeLeftTop(left, top); - supr.setLeftTop.apply(this, arguments); - this.sync(); - return this; + /** + * Get the Record at the specified index. + * @param {Number} index The index of the Record to find. + * @return {Ext.data.Model} The Record at the passed index. Returns undefined if not found. + */ + getAt: function(index) { + return this.data.getAt(index); }, - setXY : function(xy, a, d, c, e){ - this.fixDisplay(); - this.beforeAction(); - this.storeXY(xy); - var cb = this.createCB(c); - supr.setXY.call(this, xy, a, d, cb, e); - if(!a){ - cb(); - } - return this; + /** + * Returns a range of Records between specified indices. + * @param {Number} startIndex (optional) The starting index (defaults to 0) + * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store) + * @return {Ext.data.Model[]} An array of Records + */ + getRange: function(start, end) { + return this.data.getRange(start, end); }, - // private - createCB : function(c){ - var el = this; - return function(){ - el.constrainXY(); - el.sync(true); - if(c){ - c(); - } - }; + /** + * Get the Record with the specified id. + * @param {String} id The id of the Record to find. + * @return {Ext.data.Model} The Record with the passed id. Returns undefined if not found. + */ + getById: function(id) { + return (this.snapshot || this.data).findBy(function(record) { + return record.getId() === id; + }); }, - // overridden Element method - setX : function(x, a, d, c, e){ - this.setXY([x, this.getY()], a, d, c, e); - return this; + /** + * Get the index within the cache of the passed Record. + * @param {Ext.data.Model} record The Ext.data.Model object to find. + * @return {Number} The index of the passed Record. Returns -1 if not found. + */ + indexOf: function(record) { + return this.data.indexOf(record); }, - // overridden Element method - setY : function(y, a, d, c, e){ - this.setXY([this.getX(), y], a, d, c, e); - return this; + + /** + * Get the index within the entire dataset. From 0 to the totalCount. + * @param {Ext.data.Model} record The Ext.data.Model object to find. + * @return {Number} The index of the passed Record. Returns -1 if not found. + */ + indexOfTotal: function(record) { + return record.index || this.indexOf(record); }, - // overridden Element method - setSize : function(w, h, a, d, c, e){ - this.beforeAction(); - var cb = this.createCB(c); - supr.setSize.call(this, w, h, a, d, cb, e); - if(!a){ - cb(); - } - return this; + /** + * Get the index within the cache of the Record with the passed id. + * @param {String} id The id of the Record to find. + * @return {Number} The index of the Record. Returns -1 if not found. + */ + indexOfId: function(id) { + return this.data.indexOfKey(id); }, + + /** + * Remove all items from the store. + * @param {Boolean} silent Prevent the `clear` event from being fired. + */ + removeAll: function(silent) { + var me = this; - // overridden Element method - setWidth : function(w, a, d, c, e){ - this.beforeAction(); - var cb = this.createCB(c); - supr.setWidth.call(this, w, a, d, cb, e); - if(!a){ - cb(); + me.clearData(); + if (me.snapshot) { + me.snapshot.clear(); + } + if (silent !== true) { + me.fireEvent('clear', me); } - return this; }, - // overridden Element method - setHeight : function(h, a, d, c, e){ - this.beforeAction(); - var cb = this.createCB(c); - supr.setHeight.call(this, h, a, d, cb, e); - if(!a){ - cb(); + /* + * Aggregation methods + */ + + /** + * Convenience function for getting the first model instance in the store + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the first record being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Ext.data.Model/undefined} The first model instance in the store, or undefined + */ + first: function(grouped) { + var me = this; + + if (grouped && me.isGrouped()) { + return me.aggregate(function(records) { + return records.length ? records[0] : undefined; + }, me, true); + } else { + return me.data.first(); } - return this; }, - // overridden Element method - setBounds : function(x, y, w, h, a, d, c, e){ - this.beforeAction(); - var cb = this.createCB(c); - if(!a){ - this.storeXY([x, y]); - supr.setXY.call(this, [x, y]); - supr.setSize.call(this, w, h, a, d, cb, e); - cb(); - }else{ - supr.setBounds.call(this, x, y, w, h, a, d, cb, e); + /** + * Convenience function for getting the last model instance in the store + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the last record being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Ext.data.Model/undefined} The last model instance in the store, or undefined + */ + last: function(grouped) { + var me = this; + + if (grouped && me.isGrouped()) { + return me.aggregate(function(records) { + var len = records.length; + return len ? records[len - 1] : undefined; + }, me, true); + } else { + return me.data.last(); } - return this; }, /** - * Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically - * incremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow - * element, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index). - * @param {Number} zindex The new z-index to set - * @return {this} The Layer + * Sums the value of property for each {@link Ext.data.Model record} between start + * and end and returns the result. + * @param {String} field A field in each record + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the sum for that group being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Number} The sum */ - setZIndex : function(zindex){ - this.zindex = zindex; - this.setStyle('z-index', zindex + 2); - if(this.shadow){ - this.shadow.setZIndex(zindex + 1); + sum: function(field, grouped) { + var me = this; + + if (grouped && me.isGrouped()) { + return me.aggregate(me.getSum, me, true, [field]); + } else { + return me.getSum(me.data.items, field); } - if(this.shim){ - this.shim.setStyle('z-index', zindex); + }, + + // @private, see sum + getSum: function(records, field) { + var total = 0, + i = 0, + len = records.length; + + for (; i < len; ++i) { + total += records[i].get(field); } - return this; - } -}); -})(); -/** - * @class Ext.Shadow - * Simple class that can provide a shadow effect for any element. Note that the element MUST be absolutely positioned, - * and the shadow does not provide any shimming. This should be used only in simple cases -- for more advanced - * functionality that can also provide the same shadow effect, see the {@link Ext.Layer} class. - * @constructor - * Create a new Shadow - * @param {Object} config The config object - */ -Ext.Shadow = function(config){ - Ext.apply(this, config); - if(typeof this.mode != "string"){ - this.mode = this.defaultMode; - } - var o = this.offset, a = {h: 0}; - var rad = Math.floor(this.offset/2); - switch(this.mode.toLowerCase()){ // all this hideous nonsense calculates the various offsets for shadows - case "drop": - a.w = 0; - a.l = a.t = o; - a.t -= 1; - if(Ext.isIE){ - a.l -= this.offset + rad; - a.t -= this.offset + rad; - a.w -= rad; - a.h -= rad; - a.t += 1; - } - break; - case "sides": - a.w = (o*2); - a.l = -o; - a.t = o-1; - if(Ext.isIE){ - a.l -= (this.offset - rad); - a.t -= this.offset + rad; - a.l += 1; - a.w -= (this.offset - rad)*2; - a.w -= rad + 1; - a.h -= 1; - } - break; - case "frame": - a.w = a.h = (o*2); - a.l = a.t = -o; - a.t += 1; - a.h -= 2; - if(Ext.isIE){ - a.l -= (this.offset - rad); - a.t -= (this.offset - rad); - a.l += 1; - a.w -= (this.offset + rad + 1); - a.h -= (this.offset + rad); - a.h += 1; - } - break; - }; - this.adjusts = a; -}; + return total; + }, -Ext.Shadow.prototype = { - /** - * @cfg {String} mode - * The shadow display mode. Supports the following options: - * sides : Shadow displays on both sides and bottom only - * frame : Shadow displays equally on all four sides - * drop : Traditional bottom-right drop shadow - * - */ /** - * @cfg {String} offset - * The number of pixels to offset the shadow from the element (defaults to 4) + * Gets the count of items in the store. + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the count for each group being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Number} the count */ - offset: 4, + count: function(grouped) { + var me = this; - // private - defaultMode: "drop", + if (grouped && me.isGrouped()) { + return me.aggregate(function(records) { + return records.length; + }, me, true); + } else { + return me.getCount(); + } + }, /** - * Displays the shadow under the target element - * @param {Mixed} targetEl The id or element under which the shadow should display + * Gets the minimum value in the store. + * @param {String} field The field in each record + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the minimum in the group being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Mixed/undefined} The minimum value, if no items exist, undefined. */ - show : function(target){ - target = Ext.get(target); - if(!this.el){ - this.el = Ext.Shadow.Pool.pull(); - if(this.el.dom.nextSibling != target.dom){ - this.el.insertBefore(target); - } + min: function(field, grouped) { + var me = this; + + if (grouped && me.isGrouped()) { + return me.aggregate(me.getMin, me, true, [field]); + } else { + return me.getMin(me.data.items, field); + } + }, + + // @private, see min + getMin: function(records, field){ + var i = 1, + len = records.length, + value, min; + + if (len > 0) { + min = records[0].get(field); } - this.el.setStyle("z-index", this.zIndex || parseInt(target.getStyle("z-index"), 10)-1); - if(Ext.isIE){ - this.el.dom.style.filter="progid:DXImageTransform.Microsoft.alpha(opacity=50) progid:DXImageTransform.Microsoft.Blur(pixelradius="+(this.offset)+")"; + + for (; i < len; ++i) { + value = records[i].get(field); + if (value < min) { + min = value; + } } - this.realign( - target.getLeft(true), - target.getTop(true), - target.getWidth(), - target.getHeight() - ); - this.el.dom.style.display = "block"; + return min; }, /** - * Returns true if the shadow is visible, else false + * Gets the maximum value in the store. + * @param {String} field The field in each record + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the maximum in the group being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Mixed/undefined} The maximum value, if no items exist, undefined. */ - isVisible : function(){ - return this.el ? true : false; + max: function(field, grouped) { + var me = this; + + if (grouped && me.isGrouped()) { + return me.aggregate(me.getMax, me, true, [field]); + } else { + return me.getMax(me.data.items, field); + } }, - /** - * Direct alignment when values are already available. Show must be called at least once before - * calling this method to ensure it is initialized. - * @param {Number} left The target element left position - * @param {Number} top The target element top position - * @param {Number} width The target element width - * @param {Number} height The target element height - */ - realign : function(l, t, w, h){ - if(!this.el){ - return; + // @private, see max + getMax: function(records, field) { + var i = 1, + len = records.length, + value, + max; + + if (len > 0) { + max = records[0].get(field); } - var a = this.adjusts, d = this.el.dom, s = d.style; - var iea = 0; - s.left = (l+a.l)+"px"; - s.top = (t+a.t)+"px"; - var sw = (w+a.w), sh = (h+a.h), sws = sw +"px", shs = sh + "px"; - if(s.width != sws || s.height != shs){ - s.width = sws; - s.height = shs; - if(!Ext.isIE){ - var cn = d.childNodes; - var sww = Math.max(0, (sw-12))+"px"; - cn[0].childNodes[1].style.width = sww; - cn[1].childNodes[1].style.width = sww; - cn[2].childNodes[1].style.width = sww; - cn[1].style.height = Math.max(0, (sh-12))+"px"; + + for (; i < len; ++i) { + value = records[i].get(field); + if (value > max) { + max = value; } } + return max; }, /** - * Hides this shadow + * Gets the average value in the store. + * @param {String} field The field in each record + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the group average being the value. The grouped parameter is only honored if + * the store has a groupField. + * @return {Mixed/undefined} The average value, if no items exist, 0. */ - hide : function(){ - if(this.el){ - this.el.dom.style.display = "none"; - Ext.Shadow.Pool.push(this.el); - delete this.el; + average: function(field, grouped) { + var me = this; + if (grouped && me.isGrouped()) { + return me.aggregate(me.getAverage, me, true, [field]); + } else { + return me.getAverage(me.data.items, field); } }, + // @private, see average + getAverage: function(records, field) { + var i = 0, + len = records.length, + sum = 0; + + if (records.length > 0) { + for (; i < len; ++i) { + sum += records[i].get(field); + } + return sum / len; + } + return 0; + }, + /** - * Adjust the z-index of this shadow - * @param {Number} zindex The new z-index + * Runs the aggregate function for all the records in the store. + * @param {Function} fn The function to execute. The function is called with a single parameter, + * an array of records for that group. + * @param {Object} scope (optional) The scope to execute the function in. Defaults to the store. + * @param {Boolean} grouped (Optional) True to perform the operation for each group + * in the store. The value returned will be an object literal with the key being the group + * name and the group average being the value. The grouped parameter is only honored if + * the store has a groupField. + * @param {Array} args (optional) Any arguments to append to the function call + * @return {Object} An object literal with the group names and their appropriate values. */ - setZIndex : function(z){ - this.zIndex = z; - if(this.el){ - this.el.setStyle("z-index", z); + aggregate: function(fn, scope, grouped, args) { + args = args || []; + if (grouped && this.isGrouped()) { + var groups = this.getGroups(), + i = 0, + len = groups.length, + out = {}, + group; + + for (; i < len; ++i) { + group = groups[i]; + out[group.name] = fn.apply(scope || this, [group.children].concat(args)); + } + return out; + } else { + return fn.apply(scope || this, [this.data.items].concat(args)); } } -}; +}); -// Private utility class that manages the internal Shadow cache -Ext.Shadow.Pool = function(){ - var p = []; - var markup = Ext.isIE ? - '' : - ' '; - return { - pull : function(){ - var sh = p.shift(); - if(!sh){ - sh = Ext.get(Ext.DomHelper.insertHtml("beforeBegin", document.body.firstChild, markup)); - sh.autoBoxAdjust = false; - } - return sh; - }, +/** + * @author Ed Spencer + * @class Ext.data.JsonStore + * @extends Ext.data.Store + * @ignore + * + * 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.reader.Json}. + * + * A store configuration would be something like: + * + +var store = new Ext.data.JsonStore({ + // store configs + autoDestroy: true, + storeId: 'myStore' - push : function(sh){ - p.push(sh); + proxy: { + type: 'ajax', + url: 'get-images.php', + reader: { + type: 'json', + root: 'images', + idProperty: 'name' } - }; -}();/** - * @class Ext.BoxComponent - * @extends Ext.Component - * Base class for any {@link Ext.Component Component} that is to be sized as a box, using width and height. - * BoxComponent provides automatic box model adjustments for sizing and positioning and will work correctly - * within the Component rendering model. - * A BoxComponent may be created as a custom Component which encapsulates any HTML element, either a pre-existing - * element, or one that is created to your specifications at render time. Usually, to participate in layouts, - * a Component will need to be a BoxComponent in order to have its width and height managed. - * To use a pre-existing element as a BoxComponent, configure it so that you preset the el property to the - * element to reference: -var pageHeader = new Ext.BoxComponent({ - el: 'my-header-div' -}); - * This may then be {@link Ext.Container#add added} to a {@link Ext.Container Container} as a child item. - * To create a BoxComponent based around a HTML element to be created at render time, use the - * {@link Ext.Component#autoEl autoEl} config option which takes the form of a - * {@link Ext.DomHelper DomHelper} specification: -var myImage = new Ext.BoxComponent({ - autoEl: { - tag: 'img', - src: '/images/my-image.jpg' - } -}); + }, + + //alternatively, a {@link Ext.data.Model} name can be given (see {@link Ext.data.Store} for an example) + 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. + * * @constructor - * @param {Ext.Element/String/Object} config The configuration options. - * @xtype box + * @param {Object} config + * @xtype jsonstore */ -Ext.BoxComponent = Ext.extend(Ext.Component, { +Ext.define('Ext.data.JsonStore', { + extend: 'Ext.data.Store', + alias: 'store.json', - // Configs below are used for all Components when rendered by BoxLayout. - /** - * @cfg {Number} flex - * Note: this config is only used when this Component is rendered - * by a Container which has been configured to use a {@link Ext.layout.BoxLayout BoxLayout}. - * Each child Component with a flex property will be flexed either vertically (by a VBoxLayout) - * or horizontally (by an HBoxLayout) according to the item's relative flex value - * compared to the sum of all Components with flex value specified. Any child items that have - * either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). - */ - // Configs below are used for all Components when rendered by AnchorLayout. - /** - * @cfg {String} anchor Note: this config is only used when this Component is rendered - * by a Container which has been configured to use an {@link Ext.layout.AnchorLayout AnchorLayout} (or subclass thereof). - * based layout manager, for example: - * {@link Ext.form.FormPanel} - * specifying layout: 'anchor' // or 'form', or 'absolute' - * - * See {@link Ext.layout.AnchorLayout}.{@link Ext.layout.AnchorLayout#anchor anchor} also. - */ - // tabTip config is used when a BoxComponent is a child of a TabPanel - /** - * @cfg {String} tabTip - * Note: this config is only used when this BoxComponent is a child item of a TabPanel. - * A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over - * the associated tab selector element. {@link Ext.QuickTips}.init() - * must be called in order for the tips to render. - */ - // Configs below are used for all Components when rendered by BorderLayout. - /** - * @cfg {String} region Note: this config is only used when this BoxComponent is rendered - * by a Container which has been configured to use the {@link Ext.layout.BorderLayout BorderLayout} - * layout manager (e.g. specifying layout:'border'). - * See {@link Ext.layout.BorderLayout} also. - */ - // margins config is used when a BoxComponent is rendered by BorderLayout or BoxLayout. - /** - * @cfg {Object} margins Note: this config is only used when this BoxComponent is rendered - * by a Container which has been configured to use the {@link Ext.layout.BorderLayout BorderLayout} - * or one of the two {@link Ext.layout.BoxLayout BoxLayout} subclasses. - * An object containing margins to apply to this BoxComponent in the - * format: -{ - top: (top margin), - right: (right margin), - bottom: (bottom margin), - left: (left margin) -} - * May also be a string containing space-separated, numeric margin values. The order of the - * sides associated with each value matches the way CSS processes margin values: - * - * If there is only one value, it applies to all sides. - * If there are two values, the top and bottom borders are set to the first value and the - * right and left are set to the second. - * If there are three values, the top is set to the first value, the left and right are set - * to the second, and the bottom is set to the third. - * If there are four values, they apply to the top, right, bottom, and left, respectively. - * - * Defaults to: - * {top:0, right:0, bottom:0, left:0} - * - */ - /** - * @cfg {Number} x - * The local x (left) coordinate for this component if contained within a positioning container. - */ - /** - * @cfg {Number} y - * The local y (top) coordinate for this component if contained within a positioning container. - */ /** - * @cfg {Number} pageX - * The page level x coordinate for this component if contained within a positioning container. - */ - /** - * @cfg {Number} pageY - * The page level y coordinate for this component if contained within a positioning container. + * @cfg {Ext.data.DataReader} reader @hide */ - /** - * @cfg {Number} height - * The height of this component in pixels (defaults to auto). - * Note to express this dimension as a percentage or offset see {@link Ext.Component#anchor}. + constructor: function(config) { + config = config || {}; + + Ext.applyIf(config, { + proxy: { + type : 'ajax', + reader: 'json', + writer: 'json' + } + }); + + this.callParent([config]); + } +}); + +/** + * @class Ext.chart.axis.Time + * @extends Ext.chart.axis.Axis + * + * A type of axis whose units are measured in time values. Use this axis + * for listing dates that you will want to group or dynamically change. + * If you just want to display dates as categories then use the + * Category class for axis instead. + * + * For example: + * + * axes: [{ + * type: 'Time', + * position: 'bottom', + * fields: 'date', + * title: 'Day', + * dateFormat: 'M d', + * groupBy: 'year,month,day', + * aggregateOp: 'sum', + * + * constrain: true, + * fromDate: new Date('1/1/11'), + * toDate: new Date('1/7/11') + * }] + * + * In this example we're creating a time axis that has as title *Day*. + * The field the axis is bound to is `date`. + * The date format to use to display the text for the axis labels is `M d` + * which is a three letter month abbreviation followed by the day number. + * The time axis will show values for dates between `fromDate` and `toDate`. + * Since `constrain` is set to true all other values for other dates not between + * the fromDate and toDate will not be displayed. + * + * @constructor + */ +Ext.define('Ext.chart.axis.Time', { + + /* Begin Definitions */ + + extend: 'Ext.chart.axis.Category', + + alternateClassName: 'Ext.chart.TimeAxis', + + alias: 'axis.time', + + requires: ['Ext.data.Store', 'Ext.data.JsonStore'], + + /* End Definitions */ + + /** + * The minimum value drawn by the axis. If not set explicitly, the axis + * minimum will be calculated automatically. + * @property calculateByLabelSize + * @type Boolean + */ + calculateByLabelSize: true, + + /** + * Indicates the format the date will be rendered on. + * For example: 'M d' will render the dates as 'Jan 30', etc. + * + * @property dateFormat + * @type {String|Boolean} + */ + dateFormat: false, + + /** + * Indicates the time unit to use for each step. Can be 'day', 'month', 'year' or a comma-separated combination of all of them. + * Default's 'year,month,day'. + * + * @property timeUnit + * @type {String} */ + groupBy: 'year,month,day', + /** - * @cfg {Number} width - * The width of this component in pixels (defaults to auto). - * Note to express this dimension as a percentage or offset see {@link Ext.Component#anchor}. - */ + * Aggregation operation when grouping. Possible options are 'sum', 'avg', 'max', 'min'. Default's 'sum'. + * + * @property aggregateOp + * @type {String} + */ + aggregateOp: 'sum', + /** - * @cfg {Number} boxMinHeight - * The minimum value in pixels which this BoxComponent will set its height to. - * Warning: This will override any size management applied by layout managers. + * The starting date for the time axis. + * @property fromDate + * @type Date */ + fromDate: false, + /** - * @cfg {Number} boxMinWidth - * The minimum value in pixels which this BoxComponent will set its width to. - * Warning: This will override any size management applied by layout managers. + * The ending date for the time axis. + * @property toDate + * @type Date */ + toDate: false, + /** - * @cfg {Number} boxMaxHeight - * The maximum value in pixels which this BoxComponent will set its height to. - * Warning: This will override any size management applied by layout managers. + * An array with two components: The first is the unit of the step (day, month, year, etc). The second one is the number of units for the step (1, 2, etc.). + * Default's [Ext.Date.DAY, 1]. + * + * @property step + * @type Array */ + step: [Ext.Date.DAY, 1], + /** - * @cfg {Number} boxMaxWidth - * The maximum value in pixels which this BoxComponent will set its width to. - * Warning: This will override any size management applied by layout managers. + * If true, the values of the chart will be rendered only if they belong between the fromDate and toDate. + * If false, the time axis will adapt to the new values by adding/removing steps. + * Default's [Ext.Date.DAY, 1]. + * + * @property constrain + * @type Boolean */ - /** - * @cfg {Boolean} autoHeight - * True to use height:'auto', false to use fixed height (or allow it to be managed by its parent - * Container's {@link Ext.Container#layout layout manager}. Defaults to false. - * Note: Although many components inherit this config option, not all will - * function as expected with a height of 'auto'. Setting autoHeight:true means that the - * browser will manage height based on the element's contents, and that Ext will not manage it at all. - * If the browser is managing the height, be aware that resizes performed by the browser in response - * to changes within the structure of the Component cannot be detected. Therefore changes to the height might - * result in elements needing to be synchronized with the new height. Example: -var w = new Ext.Window({ - title: 'Window', - width: 600, - autoHeight: true, - items: { - title: 'Collapse Me', - height: 400, - collapsible: true, - border: false, - listeners: { - beforecollapse: function() { - w.el.shadow.hide(); + constrain: false, + + // @private a wrapper for date methods. + dateMethods: { + 'year': function(date) { + return date.getFullYear(); + }, + 'month': function(date) { + return date.getMonth() + 1; + }, + 'day': function(date) { + return date.getDate(); + }, + 'hour': function(date) { + return date.getHours(); + }, + 'minute': function(date) { + return date.getMinutes(); + }, + 'second': function(date) { + return date.getSeconds(); + }, + 'millisecond': function(date) { + return date.getMilliseconds(); + } + }, + + // @private holds aggregate functions. + aggregateFn: (function() { + var etype = (function() { + var rgxp = /^\[object\s(.*)\]$/, + toString = Object.prototype.toString; + return function(e) { + return toString.call(e).match(rgxp)[1]; + }; + })(); + return { + 'sum': function(list) { + var i = 0, l = list.length, acum = 0; + if (!list.length || etype(list[0]) != 'Number') { + return list[0]; + } + for (; i < l; i++) { + acum += list[i]; + } + return acum; }, - beforeexpand: function() { - w.el.shadow.hide(); + 'max': function(list) { + if (!list.length || etype(list[0]) != 'Number') { + return list[0]; + } + return Math.max.apply(Math, list); }, - collapse: function() { - w.syncShadow(); + 'min': function(list) { + if (!list.length || etype(list[0]) != 'Number') { + return list[0]; + } + return Math.min.apply(Math, list); }, - expand: function() { - w.syncShadow(); + 'avg': function(list) { + var i = 0, l = list.length, acum = 0; + if (!list.length || etype(list[0]) != 'Number') { + return list[0]; + } + for (; i < l; i++) { + acum += list[i]; + } + return acum / l; + } + }; + })(), + + // @private normalized the store to fill date gaps in the time interval. + constrainDates: function() { + var fromDate = Ext.Date.clone(this.fromDate), + toDate = Ext.Date.clone(this.toDate), + step = this.step, + field = this.fields, + store = this.chart.store, + record, recObj, fieldNames = [], + newStore = Ext.create('Ext.data.Store', { + model: store.model + }); + + var getRecordByDate = (function() { + var index = 0, l = store.getCount(); + return function(date) { + var rec, recDate; + for (; index < l; index++) { + rec = store.getAt(index); + recDate = rec.get(field); + if (+recDate > +date) { + return false; + } else if (+recDate == +date) { + return rec; + } + } + return false; + }; + })(); + + if (!this.constrain) { + this.chart.filteredStore = this.chart.store; + return; + } + + while(+fromDate <= +toDate) { + record = getRecordByDate(fromDate); + recObj = {}; + if (record) { + newStore.add(record.data); + } else { + newStore.model.prototype.fields.each(function(f) { + recObj[f.name] = false; + }); + recObj.date = fromDate; + newStore.add(recObj); } + fromDate = Ext.Date.add(fromDate, step[0], step[1]); } - } -}).show(); - - */ - /** - * @cfg {Boolean} autoWidth - * True to use width:'auto', false to use fixed width (or allow it to be managed by its parent - * Container's {@link Ext.Container#layout layout manager}. Defaults to false. - * Note: Although many components inherit this config option, not all will - * function as expected with a width of 'auto'. Setting autoWidth:true means that the - * browser will manage width based on the element's contents, and that Ext will not manage it at all. - * If the browser is managing the width, be aware that resizes performed by the browser in response - * to changes within the structure of the Component cannot be detected. Therefore changes to the width might - * result in elements needing to be synchronized with the new width. For example, where the target element is: -<div id='grid-container' style='margin-left:25%;width:50%'></div> - - * A Panel rendered into that target element must listen for browser window resize in order to relay its - * child items when the browser changes its width: -var myPanel = new Ext.Panel({ - renderTo: 'grid-container', - monitorResize: true, // relay on browser resize - title: 'Panel', - height: 400, - autoWidth: true, - layout: 'hbox', - layoutConfig: { - align: 'stretch' + + this.chart.filteredStore = newStore; }, - defaults: { - flex: 1 + + // @private aggregates values if multiple store elements belong to the same time step. + aggregate: function() { + var aggStore = {}, + aggKeys = [], key, value, + op = this.aggregateOp, + field = this.fields, i, + fields = this.groupBy.split(','), + curField, + recFields = [], + recFieldsLen = 0, + obj, + dates = [], + json = [], + l = fields.length, + dateMethods = this.dateMethods, + aggregateFn = this.aggregateFn, + store = this.chart.filteredStore || this.chart.store; + + store.each(function(rec) { + //get all record field names in a simple array + if (!recFields.length) { + rec.fields.each(function(f) { + recFields.push(f.name); + }); + recFieldsLen = recFields.length; + } + //get record date value + value = rec.get(field); + //generate key for grouping records + for (i = 0; i < l; i++) { + if (i == 0) { + key = String(dateMethods[fields[i]](value)); + } else { + key += '||' + dateMethods[fields[i]](value); + } + } + //get aggregation record from hash + if (key in aggStore) { + obj = aggStore[key]; + } else { + obj = aggStore[key] = {}; + aggKeys.push(key); + dates.push(value); + } + //append record values to an aggregation record + for (i = 0; i < recFieldsLen; i++) { + curField = recFields[i]; + if (!obj[curField]) { + obj[curField] = []; + } + if (rec.get(curField) !== undefined) { + obj[curField].push(rec.get(curField)); + } + } + }); + //perform aggregation operations on fields + for (key in aggStore) { + obj = aggStore[key]; + for (i = 0; i < recFieldsLen; i++) { + curField = recFields[i]; + obj[curField] = aggregateFn[op](obj[curField]); + } + json.push(obj); + } + this.chart.substore = Ext.create('Ext.data.JsonStore', { + fields: recFields, + data: json + }); + + this.dates = dates; }, - items: [{ - title: 'Box 1', - }, { - title: 'Box 2' - }, { - title: 'Box 3' - }], -}); - - */ - /** - * @cfg {Boolean} autoScroll - * true to use overflow:'auto' on the components layout element and show scroll bars automatically when - * necessary, false to clip any overflowing content (defaults to false). - */ - - /* // private internal config - * {Boolean} deferHeight - * True to defer height calculations to an external component, false to allow this component to set its own - * height (defaults to false). - */ + + // @private creates a label array to be used as the axis labels. + setLabels: function() { + var store = this.chart.substore, + fields = this.fields, + format = this.dateFormat, + labels, i, dates = this.dates, + formatFn = Ext.Date.format; + this.labels = labels = []; + store.each(function(record, i) { + if (!format) { + labels.push(record.get(fields)); + } else { + labels.push(formatFn(dates[i], format)); + } + }, this); + }, - // private - initComponent : function(){ - Ext.BoxComponent.superclass.initComponent.call(this); - this.addEvents( - /** - * @event resize - * Fires after the component is resized. - * @param {Ext.Component} this - * @param {Number} adjWidth The box-adjusted width that was set - * @param {Number} adjHeight The box-adjusted height that was set - * @param {Number} rawWidth The width that was originally specified - * @param {Number} rawHeight The height that was originally specified - */ - 'resize', - /** - * @event move - * Fires after the component is moved. - * @param {Ext.Component} this - * @param {Number} x The new x position - * @param {Number} y The new y position - */ - 'move' - ); + processView: function() { + //TODO(nico): fix this eventually... + if (this.constrain) { + this.constrainDates(); + this.aggregate(); + this.chart.substore = this.chart.filteredStore; + } else { + this.aggregate(); + } }, - // private, set in afterRender to signify that the component has been rendered - boxReady : false, - // private, used to defer height settings to subclasses - deferHeight: false, + // @private modifies the store and creates the labels for the axes. + applyData: function() { + this.setLabels(); + var count = this.chart.substore.getCount(); + return { + from: 0, + to: count, + steps: count - 1, + step: 1 + }; + } + }); - /** - * Sets the width and height of this BoxComponent. This method fires the {@link #resize} event. This method can accept - * either width and height as separate arguments, or you can pass a size object like {width:10, height:20}. - * @param {Mixed} width The new width to set. This may be one of: - * A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels). - * A String used to set the CSS width style. - * A size object in the format {width: widthValue, height: heightValue}. - * undefined to leave the width unchanged. - * - * @param {Mixed} height The new height to set (not required if a size object is passed as the first arg). - * This may be one of: - * A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels). - * A String used to set the CSS height style. Animation may not be used. - * undefined to leave the height unchanged. - * - * @return {Ext.BoxComponent} this - */ - setSize : function(w, h){ - // support for standard size objects - if(typeof w == 'object'){ - h = w.height; - w = w.width; - } - if (Ext.isDefined(w) && Ext.isDefined(this.boxMinWidth) && (w < this.boxMinWidth)) { - w = this.boxMinWidth; - } - if (Ext.isDefined(h) && Ext.isDefined(this.boxMinHeight) && (h < this.boxMinHeight)) { - h = this.boxMinHeight; - } - if (Ext.isDefined(w) && Ext.isDefined(this.boxMaxWidth) && (w > this.boxMaxWidth)) { - w = this.boxMaxWidth; - } - if (Ext.isDefined(h) && Ext.isDefined(this.boxMaxHeight) && (h > this.boxMaxHeight)) { - h = this.boxMaxHeight; - } - // not rendered - if(!this.boxReady){ - this.width = w; - this.height = h; - return this; - } +/** + * @class Ext.chart.series.Series + * + * Series is the abstract class containing the common logic to all chart series. Series includes + * methods from Labels, Highlights, Tips and Callouts mixins. This class implements the logic of handling + * mouse events, animating, hiding, showing all elements and returning the color of the series to be used as a legend item. + * + * ## Listeners + * + * The series class supports listeners via the Observable syntax. Some of these listeners are: + * + * - `itemmouseup` When the user interacts with a marker. + * - `itemmousedown` When the user interacts with a marker. + * - `itemmousemove` When the user iteracts with a marker. + * - `afterrender` Will be triggered when the animation ends or when the series has been rendered completely. + * + * For example: + * + * series: [{ + * type: 'column', + * axis: 'left', + * listeners: { + * 'afterrender': function() { + * console('afterrender'); + * } + * }, + * xField: 'category', + * yField: 'data1' + * }] + * + */ +Ext.define('Ext.chart.series.Series', { - // prevent recalcs when not needed - if(this.cacheSizes !== false && this.lastSize && this.lastSize.width == w && this.lastSize.height == h){ - return this; - } - this.lastSize = {width: w, height: h}; - var adj = this.adjustSize(w, h), - aw = adj.width, - ah = adj.height, - rz; - if(aw !== undefined || ah !== undefined){ // this code is nasty but performs better with floaters - rz = this.getResizeEl(); - if(!this.deferHeight && aw !== undefined && ah !== undefined){ - rz.setSize(aw, ah); - }else if(!this.deferHeight && ah !== undefined){ - rz.setHeight(ah); - }else if(aw !== undefined){ - rz.setWidth(aw); - } - this.onResize(aw, ah, w, h); - this.fireEvent('resize', this, aw, ah, w, h); - } - return this; + /* Begin Definitions */ + + mixins: { + observable: 'Ext.util.Observable', + labels: 'Ext.chart.Label', + highlights: 'Ext.chart.Highlight', + tips: 'Ext.chart.Tip', + callouts: 'Ext.chart.Callout' }, + /* End Definitions */ + /** - * Sets the width of the component. This method fires the {@link #resize} event. - * @param {Mixed} width The new width to set. This may be one of: - * A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit defaultUnit}s (by default, pixels). - * A String used to set the CSS width style. - * - * @return {Ext.BoxComponent} this + * @cfg {Boolean|Object} highlight + * If set to `true` it will highlight the markers or the series when hovering + * with the mouse. This parameter can also be an object with the same style + * properties you would apply to a {@link Ext.draw.Sprite} to apply custom + * styles to markers and series. */ - setWidth : function(width){ - return this.setSize(width); - }, /** - * Sets the height of the component. This method fires the {@link #resize} event. - * @param {Mixed} height The new height to set. This may be one of: - * A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit defaultUnit}s (by default, pixels). - * A String used to set the CSS height style. - * undefined to leave the height unchanged. - * - * @return {Ext.BoxComponent} this + * @cfg {Object} tips + * Add tooltips to the visualization's markers. The options for the tips are the + * same configuration used with {@link Ext.tip.ToolTip}. For example: + * + * tips: { + * trackMouse: true, + * width: 140, + * height: 28, + * renderer: function(storeItem, item) { + * this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views'); + * } + * }, */ - setHeight : function(height){ - return this.setSize(undefined, height); - }, /** - * Gets the current size of the component's underlying element. - * @return {Object} An object containing the element's size {width: (element width), height: (element height)} + * @cfg {String} type + * The type of series. Set in subclasses. */ - getSize : function(){ - return this.getResizeEl().getSize(); - }, + type: null, /** - * Gets the current width of the component's underlying element. - * @return {Number} + * @cfg {String} title + * The human-readable name of the series. */ - getWidth : function(){ - return this.getResizeEl().getWidth(); - }, + title: null, /** - * Gets the current height of the component's underlying element. - * @return {Number} + * @cfg {Boolean} showInLegend + * Whether to show this series in the legend. */ - getHeight : function(){ - return this.getResizeEl().getHeight(); - }, + showInLegend: true, /** - * Gets the current size of the component's underlying element, including space taken by its margins. - * @return {Object} An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)} + * @cfg {Function} renderer + * A function that can be overridden to set custom styling properties to each rendered element. + * Passes in (sprite, record, attributes, index, store) to the function. */ - getOuterSize : function(){ - var el = this.getResizeEl(); - return {width: el.getWidth() + el.getMargins('lr'), - height: el.getHeight() + el.getMargins('tb')}; + renderer: function(sprite, record, attributes, index, store) { + return attributes; }, /** - * Gets the current XY position of the component's underlying element. - * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false) - * @return {Array} The XY position of the element (e.g., [100, 200]) + * @cfg {Array} shadowAttributes + * An array with shadow attributes */ - getPosition : function(local){ - var el = this.getPositionEl(); - if(local === true){ - return [el.getLeft(true), el.getTop(true)]; + shadowAttributes: null, + + //@private triggerdrawlistener flag + triggerAfterDraw: false, + + /** + * @cfg {Object} listeners + * An (optional) object with event callbacks. All event callbacks get the target *item* as first parameter. The callback functions are: + * + * + * itemmouseover + * itemmouseout + * itemmousedown + * itemmouseup + * + */ + + constructor: function(config) { + var me = this; + if (config) { + Ext.apply(me, config); } - return this.xy || el.getXY(); - }, + + me.shadowGroups = []; + + me.mixins.labels.constructor.call(me, config); + me.mixins.highlights.constructor.call(me, config); + me.mixins.tips.constructor.call(me, config); + me.mixins.callouts.constructor.call(me, config); + + me.addEvents({ + scope: me, + itemmouseover: true, + itemmouseout: true, + itemmousedown: true, + itemmouseup: true, + mouseleave: true, + afterdraw: true, - /** - * Gets the current box measurements of the component's underlying element. - * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false) - * @return {Object} box An object in the format {x, y, width, height} - */ - getBox : function(local){ - var pos = this.getPosition(local); - var s = this.getSize(); - s.x = pos[0]; - s.y = pos[1]; - return s; - }, + /** + * @event titlechange + * Fires when the series title is changed via {@link #setTitle}. + * @param {String} title The new title value + * @param {Number} index The index in the collection of titles + */ + titlechange: true + }); - /** - * Sets the current box measurements of the component's underlying element. - * @param {Object} box An object in the format {x, y, width, height} - * @return {Ext.BoxComponent} this - */ - updateBox : function(box){ - this.setSize(box.width, box.height); - this.setPagePosition(box.x, box.y); - return this; + me.mixins.observable.constructor.call(me, config); + + me.on({ + scope: me, + itemmouseover: me.onItemMouseOver, + itemmouseout: me.onItemMouseOut, + mouseleave: me.onMouseLeave + }); }, - /** - * Returns the outermost Element of this Component which defines the Components overall size. - * Usually this will return the same Element as {@link #getEl}, - * but in some cases, a Component may have some more wrapping Elements around its main - * active Element. - * An example is a ComboBox. It is encased in a wrapping Element which - * contains both the <input> Element (which is what would be returned - * by its {@link #getEl} method, and the trigger button Element. - * This Element is returned as the resizeEl. - * @return {Ext.Element} The Element which is to be resized by size managing layouts. - */ - getResizeEl : function(){ - return this.resizeEl || this.el; + // @private set the bbox and clipBox for the series + setBBox: function(noGutter) { + var me = this, + chart = me.chart, + chartBBox = chart.chartBBox, + gutterX = noGutter ? 0 : chart.maxGutter[0], + gutterY = noGutter ? 0 : chart.maxGutter[1], + clipBox, bbox; + + clipBox = { + x: chartBBox.x, + y: chartBBox.y, + width: chartBBox.width, + height: chartBBox.height + }; + me.clipBox = clipBox; + + bbox = { + x: (clipBox.x + gutterX) - (chart.zoom.x * chart.zoom.width), + y: (clipBox.y + gutterY) - (chart.zoom.y * chart.zoom.height), + width: (clipBox.width - (gutterX * 2)) * chart.zoom.width, + height: (clipBox.height - (gutterY * 2)) * chart.zoom.height + }; + me.bbox = bbox; }, - /** - * Sets the overflow on the content element of the component. - * @param {Boolean} scroll True to allow the Component to auto scroll. - * @return {Ext.BoxComponent} this - */ - setAutoScroll : function(scroll){ - if(this.rendered){ - this.getContentTarget().setOverflow(scroll ? 'auto' : ''); + // @private set the animation for the sprite + onAnimate: function(sprite, attr) { + var me = this; + sprite.stopAnimation(); + if (me.triggerAfterDraw) { + return sprite.animate(Ext.applyIf(attr, me.chart.animate)); + } else { + me.triggerAfterDraw = true; + return sprite.animate(Ext.apply(Ext.applyIf(attr, me.chart.animate), { + listeners: { + 'afteranimate': function() { + me.triggerAfterDraw = false; + me.fireEvent('afterrender'); + } + } + })); } - this.autoScroll = scroll; - return this; + }, + + // @private return the gutter. + getGutters: function() { + return [0, 0]; }, - /** - * Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}. - * This method fires the {@link #move} event. - * @param {Number} left The new left - * @param {Number} top The new top - * @return {Ext.BoxComponent} this - */ - setPosition : function(x, y){ - if(x && typeof x[1] == 'number'){ - y = x[1]; - x = x[0]; - } - this.x = x; - this.y = y; - if(!this.boxReady){ - return this; + // @private wrapper for the itemmouseover event. + onItemMouseOver: function(item) { + var me = this; + if (item.series === me) { + if (me.highlight) { + me.highlightItem(item); + } + if (me.tooltip) { + me.showTip(item); + } } - var adj = this.adjustPosition(x, y); - var ax = adj.x, ay = adj.y; + }, - var el = this.getPositionEl(); - if(ax !== undefined || ay !== undefined){ - if(ax !== undefined && ay !== undefined){ - el.setLeftTop(ax, ay); - }else if(ax !== undefined){ - el.setLeft(ax); - }else if(ay !== undefined){ - el.setTop(ay); + // @private wrapper for the itemmouseout event. + onItemMouseOut: function(item) { + var me = this; + if (item.series === me) { + me.unHighlightItem(); + if (me.tooltip) { + me.hideTip(item); } - this.onPosition(ax, ay); - this.fireEvent('move', this, ax, ay); } - return this; }, - /** - * Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}. - * This method fires the {@link #move} event. - * @param {Number} x The new x position - * @param {Number} y The new y position - * @return {Ext.BoxComponent} this - */ - setPagePosition : function(x, y){ - if(x && typeof x[1] == 'number'){ - y = x[1]; - x = x[0]; + // @private wrapper for the mouseleave event. + onMouseLeave: function() { + var me = this; + me.unHighlightItem(); + if (me.tooltip) { + me.hideTip(); + } + }, + + /** + * For a given x/y point relative to the Surface, find a corresponding item from this + * series, if any. + * @param {Number} x + * @param {Number} y + * @return {Object} An object describing the item, or null if there is no matching item. The exact contents of + * this object will vary by series type, but should always contain at least the following: + * + * {Ext.chart.series.Series} series - the Series object to which the item belongs + * {Object} value - the value(s) of the item's data point + * {Array} point - the x/y coordinates relative to the chart box of a single point + * for this data item, which can be used as e.g. a tooltip anchor point. + * {Ext.draw.Sprite} sprite - the item's rendering Sprite. + * + */ + getItemForPoint: function(x, y) { + //if there are no items to query just return null. + if (!this.items || !this.items.length || this.seriesIsHidden) { + return null; } - this.pageX = x; - this.pageY = y; - if(!this.boxReady){ - return; + var me = this, + items = me.items, + bbox = me.bbox, + item, i, ln; + // Check bounds + if (!Ext.draw.Draw.withinBox(x, y, bbox)) { + return null; } - if(x === undefined || y === undefined){ // cannot translate undefined points - return; + for (i = 0, ln = items.length; i < ln; i++) { + if (items[i] && this.isItemInPoint(x, y, items[i], i)) { + return items[i]; + } } - var p = this.getPositionEl().translatePoints(x, y); - this.setPosition(p.left, p.top); - return this; + + return null; + }, + + isItemInPoint: function(x, y, item, i) { + return false; }, - // private - afterRender : function(){ - Ext.BoxComponent.superclass.afterRender.call(this); - if(this.resizeEl){ - this.resizeEl = Ext.get(this.resizeEl); - } - if(this.positionEl){ - this.positionEl = Ext.get(this.positionEl); - } - this.boxReady = true; - Ext.isDefined(this.autoScroll) && this.setAutoScroll(this.autoScroll); - this.setSize(this.width, this.height); - if(this.x || this.y){ - this.setPosition(this.x, this.y); - }else if(this.pageX || this.pageY){ - this.setPagePosition(this.pageX, this.pageY); + /** + * Hides all the elements in the series. + */ + hideAll: function() { + var me = this, + items = me.items, + item, len, i, sprite; + + me.seriesIsHidden = true; + me._prevShowMarkers = me.showMarkers; + + me.showMarkers = false; + //hide all labels + me.hideLabels(0); + //hide all sprites + for (i = 0, len = items.length; i < len; i++) { + item = items[i]; + sprite = item.sprite; + if (sprite) { + sprite.setAttributes({ + hidden: true + }, true); + } } }, /** - * Force the component's size to recalculate based on the underlying element's current height and width. - * @return {Ext.BoxComponent} this + * Shows all the elements in the series. */ - syncSize : function(){ - delete this.lastSize; - this.setSize(this.autoWidth ? undefined : this.getResizeEl().getWidth(), this.autoHeight ? undefined : this.getResizeEl().getHeight()); - return this; + showAll: function() { + var me = this, + prevAnimate = me.chart.animate; + me.chart.animate = false; + me.seriesIsHidden = false; + me.showMarkers = me._prevShowMarkers; + me.drawSeries(); + me.chart.animate = prevAnimate; }, - - /* // protected - * Called after the component is resized, this method is empty by default but can be implemented by any - * subclass that needs to perform custom logic after a resize occurs. - * @param {Number} adjWidth The box-adjusted width that was set - * @param {Number} adjHeight The box-adjusted height that was set - * @param {Number} rawWidth The width that was originally specified - * @param {Number} rawHeight The height that was originally specified + + /** + * Returns a string with the color to be used for the series legend item. */ - onResize : function(adjWidth, adjHeight, rawWidth, rawHeight){ + getLegendColor: function(index) { + var me = this, fill, stroke; + if (me.seriesStyle) { + fill = me.seriesStyle.fill; + stroke = me.seriesStyle.stroke; + if (fill && fill != 'none') { + return fill; + } + return stroke; + } + return '#000'; }, - - /* // protected - * Called after the component is moved, this method is empty by default but can be implemented by any - * subclass that needs to perform custom logic after a move occurs. - * @param {Number} x The new x position - * @param {Number} y The new y position + + /** + * Checks whether the data field should be visible in the legend + * @private + * @param {Number} index The index of the current item */ - onPosition : function(x, y){ - + visibleInLegend: function(index){ + var excludes = this.__excludes; + if (excludes) { + return !excludes[index]; + } + return !this.seriesIsHidden; }, - // private - adjustSize : function(w, h){ - if(this.autoWidth){ - w = 'auto'; + /** + * Changes the value of the {@link #title} for the series. + * Arguments can take two forms: + * + * A single String value: this will be used as the new single title for the series (applies + * to series with only one yField) + * A numeric index and a String value: this will set the title for a single indexed yField. + * + * @param {Number} index + * @param {String} title + */ + setTitle: function(index, title) { + var me = this, + oldTitle = me.title; + + if (Ext.isString(index)) { + title = index; + index = 0; } - if(this.autoHeight){ - h = 'auto'; + + if (Ext.isArray(oldTitle)) { + oldTitle[index] = title; + } else { + me.title = title; } - return {width : w, height: h}; - }, - // private - adjustPosition : function(x, y){ - return {x : x, y: y}; + me.fireEvent('titlechange', title, index); } }); -Ext.reg('box', Ext.BoxComponent); - /** - * @class Ext.Spacer - * @extends Ext.BoxComponent - * Used to provide a sizable space in a layout. - * @constructor - * @param {Object} config - */ -Ext.Spacer = Ext.extend(Ext.BoxComponent, { - autoEl:'div' -}); -Ext.reg('spacer', Ext.Spacer);/** - * @class Ext.SplitBar - * @extends Ext.util.Observable - * Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized). - * - * Usage: - * -var split = new Ext.SplitBar("elementToDrag", "elementToSize", - Ext.SplitBar.HORIZONTAL, Ext.SplitBar.LEFT); -split.setAdapter(new Ext.SplitBar.AbsoluteLayoutAdapter("container")); -split.minSize = 100; -split.maxSize = 600; -split.animate = true; -split.on('moved', splitterMoved); - + * @class Ext.chart.series.Cartesian + * @extends Ext.chart.series.Series + * + * Common base class for series implementations which plot values using x/y coordinates. + * * @constructor - * Create a new SplitBar - * @param {Mixed} dragElement The element to be dragged and act as the SplitBar. - * @param {Mixed} resizingElement The element to be resized based on where the SplitBar element is dragged - * @param {Number} orientation (optional) Either Ext.SplitBar.HORIZONTAL or Ext.SplitBar.VERTICAL. (Defaults to HORIZONTAL) - * @param {Number} placement (optional) Either Ext.SplitBar.LEFT or Ext.SplitBar.RIGHT for horizontal or - Ext.SplitBar.TOP or Ext.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial - position of the SplitBar). */ -Ext.SplitBar = function(dragElement, resizingElement, orientation, placement, existingProxy){ +Ext.define('Ext.chart.series.Cartesian', { - /** @private */ - this.el = Ext.get(dragElement, true); - this.el.dom.unselectable = "on"; - /** @private */ - this.resizingEl = Ext.get(resizingElement, true); + /* Begin Definitions */ - /** - * @private - * The orientation of the split. Either Ext.SplitBar.HORIZONTAL or Ext.SplitBar.VERTICAL. (Defaults to HORIZONTAL) - * Note: If this is changed after creating the SplitBar, the placement property must be manually updated - * @type Number - */ - this.orientation = orientation || Ext.SplitBar.HORIZONTAL; + extend: 'Ext.chart.series.Series', - /** - * The increment, in pixels by which to move this SplitBar. When undefined, the SplitBar moves smoothly. - * @type Number - * @property tickSize - */ - /** - * The minimum size of the resizing element. (Defaults to 0) - * @type Number - */ - this.minSize = 0; + alternateClassName: ['Ext.chart.CartesianSeries', 'Ext.chart.CartesianChart'], + + /* End Definitions */ /** - * The maximum size of the resizing element. (Defaults to 2000) - * @type Number + * The field used to access the x axis value from the items from the data + * source. + * + * @cfg xField + * @type String */ - this.maxSize = 2000; + xField: null, /** - * Whether to animate the transition to the new size - * @type Boolean + * The field used to access the y-axis value from the items from the data + * source. + * + * @cfg yField + * @type String */ - this.animate = false; + yField: null, /** - * Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes. - * @type Boolean + * Indicates which axis the series will bind to + * + * @property axis + * @type String */ - this.useShim = false; + axis: 'left' +}); + +/** + * @class Ext.chart.series.Area + * @extends Ext.chart.series.Cartesian + * + + Creates a Stacked Area Chart. The stacked area chart is useful when displaying multiple aggregated layers of information. + As with all other series, the Area Series must be appended in the *series* Chart array configuration. See the Chart + documentation for more information. A typical configuration object for the area series could be: + +{@img Ext.chart.series.Area/Ext.chart.series.Area.png Ext.chart.series.Area chart series} + + var store = Ext.create('Ext.data.JsonStore', { + fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + data: [ + {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + ] + }); + + Ext.create('Ext.chart.Chart', { + renderTo: Ext.getBody(), + width: 500, + height: 300, + store: store, + axes: [{ + type: 'Numeric', + grid: true, + position: 'left', + fields: ['data1', 'data2', 'data3', 'data4', 'data5'], + title: 'Sample Values', + grid: { + odd: { + opacity: 1, + fill: '#ddd', + stroke: '#bbb', + 'stroke-width': 1 + } + }, + minimum: 0, + adjustMinimumByMajorUnit: 0 + }, { + type: 'Category', + position: 'bottom', + fields: ['name'], + title: 'Sample Metrics', + grid: true, + label: { + rotate: { + degrees: 315 + } + } + }], + series: [{ + type: 'area', + highlight: false, + axis: 'left', + xField: 'name', + yField: ['data1', 'data2', 'data3', 'data4', 'data5'], + style: { + opacity: 0.93 + } + }] + }); + + + + + In this configuration we set `area` as the type for the series, set highlighting options to true for highlighting elements on hover, + take the left axis to measure the data in the area series, set as xField (x values) the name field of each element in the store, + and as yFields (aggregated layers) seven data fields from the same store. Then we override some theming styles by adding some opacity + to the style object. + + + * @xtype area + * + */ +Ext.define('Ext.chart.series.Area', { - /** @private */ - this.shim = null; + /* Begin Definitions */ - if(!existingProxy){ - /** @private */ - this.proxy = Ext.SplitBar.createProxy(this.orientation); - }else{ - this.proxy = Ext.get(existingProxy).dom; - } - /** @private */ - this.dd = new Ext.dd.DDProxy(this.el.dom.id, "XSplitBars", {dragElId : this.proxy.id}); + extend: 'Ext.chart.series.Cartesian', + + alias: 'series.area', - /** @private */ - this.dd.b4StartDrag = this.onStartProxyDrag.createDelegate(this); + requires: ['Ext.chart.axis.Axis', 'Ext.draw.Color', 'Ext.fx.Anim'], - /** @private */ - this.dd.endDrag = this.onEndProxyDrag.createDelegate(this); + /* End Definitions */ - /** @private */ - this.dragSpecs = {}; + type: 'area', + + // @private Area charts are alyways stacked + stacked: true, /** - * @private The adapter to use to positon and resize elements + * @cfg {Object} style + * Append styling properties to this object for it to override theme properties. */ - this.adapter = new Ext.SplitBar.BasicLayoutAdapter(); - this.adapter.init(this); + style: {}, - if(this.orientation == Ext.SplitBar.HORIZONTAL){ - /** @private */ - this.placement = placement || (this.el.getX() > this.resizingEl.getX() ? Ext.SplitBar.LEFT : Ext.SplitBar.RIGHT); - this.el.addClass("x-splitbar-h"); - }else{ - /** @private */ - this.placement = placement || (this.el.getY() > this.resizingEl.getY() ? Ext.SplitBar.TOP : Ext.SplitBar.BOTTOM); - this.el.addClass("x-splitbar-v"); - } + constructor: function(config) { + this.callParent(arguments); + var me = this, + surface = me.chart.surface, + i, l; + Ext.apply(me, config, { + __excludes: [], + highlightCfg: { + lineWidth: 3, + stroke: '#55c', + opacity: 0.8, + color: '#f00' + } + }); + if (me.highlight) { + me.highlightSprite = surface.add({ + type: 'path', + path: ['M', 0, 0], + zIndex: 1000, + opacity: 0.3, + lineWidth: 5, + hidden: true, + stroke: '#444' + }); + } + me.group = surface.getGroup(me.seriesId); + }, + + // @private Shrinks dataSets down to a smaller size + shrink: function(xValues, yValues, size) { + var len = xValues.length, + ratio = Math.floor(len / size), + i, j, + xSum = 0, + yCompLen = this.areas.length, + ySum = [], + xRes = [], + yRes = []; + //initialize array + for (j = 0; j < yCompLen; ++j) { + ySum[j] = 0; + } + for (i = 0; i < len; ++i) { + xSum += xValues[i]; + for (j = 0; j < yCompLen; ++j) { + ySum[j] += yValues[i][j]; + } + if (i % ratio == 0) { + //push averages + xRes.push(xSum/ratio); + for (j = 0; j < yCompLen; ++j) { + ySum[j] /= ratio; + } + yRes.push(ySum); + //reset sum accumulators + xSum = 0; + for (j = 0, ySum = []; j < yCompLen; ++j) { + ySum[j] = 0; + } + } + } + return { + x: xRes, + y: yRes + }; + }, - this.addEvents( - /** - * @event resize - * Fires when the splitter is moved (alias for {@link #moved}) - * @param {Ext.SplitBar} this - * @param {Number} newSize the new width or height - */ - "resize", - /** - * @event moved - * Fires when the splitter is moved - * @param {Ext.SplitBar} this - * @param {Number} newSize the new width or height - */ - "moved", - /** - * @event beforeresize - * Fires before the splitter is dragged - * @param {Ext.SplitBar} this - */ - "beforeresize", + // @private Get chart and data boundaries + getBounds: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + areas = [].concat(me.yField), + areasLen = areas.length, + xValues = [], + yValues = [], + infinity = Infinity, + minX = infinity, + minY = infinity, + maxX = -infinity, + maxY = -infinity, + math = Math, + mmin = math.min, + mmax = math.max, + bbox, xScale, yScale, xValue, yValue, areaIndex, acumY, ln, sumValues, clipBox, areaElem; + + me.setBBox(); + bbox = me.bbox; + + // Run through the axis + if (me.axis) { + axis = chart.axes.get(me.axis); + if (axis) { + out = axis.calcEnds(); + minY = out.from || axis.prevMin; + maxY = mmax(out.to || axis.prevMax, 0); + } + } + + if (me.yField && !Ext.isNumber(minY)) { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.yField) + }); + out = axis.calcEnds(); + minY = out.from || axis.prevMin; + maxY = mmax(out.to || axis.prevMax, 0); + } - "beforeapply" - ); + if (!Ext.isNumber(minY)) { + minY = 0; + } + if (!Ext.isNumber(maxY)) { + maxY = 0; + } - Ext.SplitBar.superclass.constructor.call(this); -}; + store.each(function(record, i) { + xValue = record.get(me.xField); + yValue = []; + if (typeof xValue != 'number') { + xValue = i; + } + xValues.push(xValue); + acumY = 0; + for (areaIndex = 0; areaIndex < areasLen; areaIndex++) { + areaElem = record.get(areas[areaIndex]); + if (typeof areaElem == 'number') { + minY = mmin(minY, areaElem); + yValue.push(areaElem); + acumY += areaElem; + } + } + minX = mmin(minX, xValue); + maxX = mmax(maxX, xValue); + maxY = mmax(maxY, acumY); + yValues.push(yValue); + }, me); -Ext.extend(Ext.SplitBar, Ext.util.Observable, { - onStartProxyDrag : function(x, y){ - this.fireEvent("beforeresize", this); - this.overlay = Ext.DomHelper.append(document.body, {cls: "x-drag-overlay", html: " "}, true); - this.overlay.unselectable(); - this.overlay.setSize(Ext.lib.Dom.getViewWidth(true), Ext.lib.Dom.getViewHeight(true)); - this.overlay.show(); - Ext.get(this.proxy).setDisplayed("block"); - var size = this.adapter.getElementSize(this); - this.activeMinSize = this.getMinimumSize(); - this.activeMaxSize = this.getMaximumSize(); - var c1 = size - this.activeMinSize; - var c2 = Math.max(this.activeMaxSize - size, 0); - if(this.orientation == Ext.SplitBar.HORIZONTAL){ - this.dd.resetConstraints(); - this.dd.setXConstraint( - this.placement == Ext.SplitBar.LEFT ? c1 : c2, - this.placement == Ext.SplitBar.LEFT ? c2 : c1, - this.tickSize - ); - this.dd.setYConstraint(0, 0); - }else{ - this.dd.resetConstraints(); - this.dd.setXConstraint(0, 0); - this.dd.setYConstraint( - this.placement == Ext.SplitBar.TOP ? c1 : c2, - this.placement == Ext.SplitBar.TOP ? c2 : c1, - this.tickSize - ); - } - this.dragSpecs.startSize = size; - this.dragSpecs.startPoint = [x, y]; - Ext.dd.DDProxy.prototype.b4StartDrag.call(this.dd, x, y); - }, + xScale = bbox.width / (maxX - minX); + yScale = bbox.height / (maxY - minY); - /** - * @private Called after the drag operation by the DDProxy - */ - onEndProxyDrag : function(e){ - Ext.get(this.proxy).setDisplayed(false); - var endPoint = Ext.lib.Event.getXY(e); - if(this.overlay){ - Ext.destroy(this.overlay); - delete this.overlay; + ln = xValues.length; + if ((ln > bbox.width) && me.areas) { + sumValues = me.shrink(xValues, yValues, bbox.width); + xValues = sumValues.x; + yValues = sumValues.y; } - var newSize; - if(this.orientation == Ext.SplitBar.HORIZONTAL){ - newSize = this.dragSpecs.startSize + - (this.placement == Ext.SplitBar.LEFT ? - endPoint[0] - this.dragSpecs.startPoint[0] : - this.dragSpecs.startPoint[0] - endPoint[0] - ); - }else{ - newSize = this.dragSpecs.startSize + - (this.placement == Ext.SplitBar.TOP ? - endPoint[1] - this.dragSpecs.startPoint[1] : - this.dragSpecs.startPoint[1] - endPoint[1] - ); + + return { + bbox: bbox, + minX: minX, + minY: minY, + xValues: xValues, + yValues: yValues, + xScale: xScale, + yScale: yScale, + areasLen: areasLen + }; + }, + + // @private Build an array of paths for the chart + getPaths: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + first = true, + bounds = me.getBounds(), + bbox = bounds.bbox, + items = me.items = [], + componentPaths = [], + componentPath, + paths = [], + i, ln, x, y, xValue, yValue, acumY, areaIndex, prevAreaIndex, areaElem, path; + + ln = bounds.xValues.length; + // Start the path + for (i = 0; i < ln; i++) { + xValue = bounds.xValues[i]; + yValue = bounds.yValues[i]; + x = bbox.x + (xValue - bounds.minX) * bounds.xScale; + acumY = 0; + for (areaIndex = 0; areaIndex < bounds.areasLen; areaIndex++) { + // Excluded series + if (me.__excludes[areaIndex]) { + continue; + } + if (!componentPaths[areaIndex]) { + componentPaths[areaIndex] = []; + } + areaElem = yValue[areaIndex]; + acumY += areaElem; + y = bbox.y + bbox.height - (acumY - bounds.minY) * bounds.yScale; + if (!paths[areaIndex]) { + paths[areaIndex] = ['M', x, y]; + componentPaths[areaIndex].push(['L', x, y]); + } else { + paths[areaIndex].push('L', x, y); + componentPaths[areaIndex].push(['L', x, y]); + } + if (!items[areaIndex]) { + items[areaIndex] = { + pointsUp: [], + pointsDown: [], + series: me + }; + } + items[areaIndex].pointsUp.push([x, y]); + } } - newSize = Math.min(Math.max(newSize, this.activeMinSize), this.activeMaxSize); - if(newSize != this.dragSpecs.startSize){ - if(this.fireEvent('beforeapply', this, newSize) !== false){ - this.adapter.setElementSize(this, newSize); - this.fireEvent("moved", this, newSize); - this.fireEvent("resize", this, newSize); + + // Close the paths + for (areaIndex = 0; areaIndex < bounds.areasLen; areaIndex++) { + // Excluded series + if (me.__excludes[areaIndex]) { + continue; + } + path = paths[areaIndex]; + // Close bottom path to the axis + if (areaIndex == 0 || first) { + first = false; + path.push('L', x, bbox.y + bbox.height, + 'L', bbox.x, bbox.y + bbox.height, + 'Z'); } + // Close other paths to the one before them + else { + componentPath = componentPaths[prevAreaIndex]; + componentPath.reverse(); + path.push('L', x, componentPath[0][2]); + for (i = 0; i < ln; i++) { + path.push(componentPath[i][0], + componentPath[i][1], + componentPath[i][2]); + items[areaIndex].pointsDown[ln -i -1] = [componentPath[i][1], componentPath[i][2]]; + } + path.push('L', bbox.x, path[2], 'Z'); + } + prevAreaIndex = areaIndex; } + return { + paths: paths, + areasLen: bounds.areasLen + }; }, /** - * Get the adapter this SplitBar uses - * @return The adapter object + * Draws the series for the current chart. */ - getAdapter : function(){ - return this.adapter; - }, + drawSeries: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + surface = chart.surface, + animate = chart.animate, + group = me.group, + endLineStyle = Ext.apply(me.seriesStyle, me.style), + colorArrayStyle = me.colorArrayStyle, + colorArrayLength = colorArrayStyle && colorArrayStyle.length || 0, + areaIndex, areaElem, paths, path, rendererAttributes; + + me.unHighlightItem(); + me.cleanHighlights(); + + if (!store || !store.getCount()) { + return; + } + + paths = me.getPaths(); - /** - * Set the adapter this SplitBar uses - * @param {Object} adapter A SplitBar adapter object - */ - setAdapter : function(adapter){ - this.adapter = adapter; - this.adapter.init(this); - }, + if (!me.areas) { + me.areas = []; + } - /** - * Gets the minimum size for the resizing element - * @return {Number} The minimum size - */ - getMinimumSize : function(){ - return this.minSize; + for (areaIndex = 0; areaIndex < paths.areasLen; areaIndex++) { + // Excluded series + if (me.__excludes[areaIndex]) { + continue; + } + if (!me.areas[areaIndex]) { + me.items[areaIndex].sprite = me.areas[areaIndex] = surface.add(Ext.apply({}, { + type: 'path', + group: group, + // 'clip-rect': me.clipBox, + path: paths.paths[areaIndex], + stroke: endLineStyle.stroke || colorArrayStyle[areaIndex % colorArrayLength], + fill: colorArrayStyle[areaIndex % colorArrayLength] + }, endLineStyle || {})); + } + areaElem = me.areas[areaIndex]; + path = paths.paths[areaIndex]; + if (animate) { + //Add renderer to line. There is not a unique record associated with this. + rendererAttributes = me.renderer(areaElem, false, { + path: path, + // 'clip-rect': me.clipBox, + fill: colorArrayStyle[areaIndex % colorArrayLength], + stroke: endLineStyle.stroke || colorArrayStyle[areaIndex % colorArrayLength] + }, areaIndex, store); + //fill should not be used here but when drawing the special fill path object + me.animation = me.onAnimate(areaElem, { + to: rendererAttributes + }); + } else { + rendererAttributes = me.renderer(areaElem, false, { + path: path, + // 'clip-rect': me.clipBox, + hidden: false, + fill: colorArrayStyle[areaIndex % colorArrayLength], + stroke: endLineStyle.stroke || colorArrayStyle[areaIndex % colorArrayLength] + }, areaIndex, store); + me.areas[areaIndex].setAttributes(rendererAttributes, true); + } + } + me.renderLabels(); + me.renderCallouts(); }, - /** - * Sets the minimum size for the resizing element - * @param {Number} minSize The minimum size - */ - setMinimumSize : function(minSize){ - this.minSize = minSize; + // @private + onAnimate: function(sprite, attr) { + sprite.show(); + return this.callParent(arguments); }, - /** - * Gets the maximum size for the resizing element - * @return {Number} The maximum size - */ - getMaximumSize : function(){ - return this.maxSize; + // @private + onCreateLabel: function(storeItem, item, i, display) { + var me = this, + group = me.labelsGroup, + config = me.label, + bbox = me.bbox, + endLabelStyle = Ext.apply(config, me.seriesLabelStyle); + + return me.chart.surface.add(Ext.apply({ + 'type': 'text', + 'text-anchor': 'middle', + 'group': group, + 'x': item.point[0], + 'y': bbox.y + bbox.height / 2 + }, endLabelStyle || {})); + }, + + // @private + onPlaceLabel: function(label, storeItem, item, i, display, animate, index) { + var me = this, + chart = me.chart, + resizing = chart.resizing, + config = me.label, + format = config.renderer, + field = config.field, + bbox = me.bbox, + x = item.point[0], + y = item.point[1], + bb, width, height; + + label.setAttributes({ + text: format(storeItem.get(field[index])), + hidden: true + }, true); + + bb = label.getBBox(); + width = bb.width / 2; + height = bb.height / 2; + + x = x - width < bbox.x? bbox.x + width : x; + x = (x + width > bbox.x + bbox.width) ? (x - (x + width - bbox.x - bbox.width)) : x; + y = y - height < bbox.y? bbox.y + height : y; + y = (y + height > bbox.y + bbox.height) ? (y - (y + height - bbox.y - bbox.height)) : y; + + if (me.chart.animate && !me.chart.resizing) { + label.show(true); + me.onAnimate(label, { + to: { + x: x, + y: y + } + }); + } else { + label.setAttributes({ + x: x, + y: y + }, true); + if (resizing) { + me.animation.on('afteranimate', function() { + label.show(true); + }); + } else { + label.show(true); + } + } }, - /** - * Sets the maximum size for the resizing element - * @param {Number} maxSize The maximum size - */ - setMaximumSize : function(maxSize){ - this.maxSize = maxSize; + // @private + onPlaceCallout : function(callout, storeItem, item, i, display, animate, index) { + var me = this, + chart = me.chart, + surface = chart.surface, + resizing = chart.resizing, + config = me.callouts, + items = me.items, + prev = (i == 0) ? false : items[i -1].point, + next = (i == items.length -1) ? false : items[i +1].point, + cur = item.point, + dir, norm, normal, a, aprev, anext, + bbox = callout.label.getBBox(), + offsetFromViz = 30, + offsetToSide = 10, + offsetBox = 3, + boxx, boxy, boxw, boxh, + p, clipRect = me.clipRect, + x, y; + + //get the right two points + if (!prev) { + prev = cur; + } + if (!next) { + next = cur; + } + a = (next[1] - prev[1]) / (next[0] - prev[0]); + aprev = (cur[1] - prev[1]) / (cur[0] - prev[0]); + anext = (next[1] - cur[1]) / (next[0] - cur[0]); + + norm = Math.sqrt(1 + a * a); + dir = [1 / norm, a / norm]; + normal = [-dir[1], dir[0]]; + + //keep the label always on the outer part of the "elbow" + if (aprev > 0 && anext < 0 && normal[1] < 0 || aprev < 0 && anext > 0 && normal[1] > 0) { + normal[0] *= -1; + normal[1] *= -1; + } else if (Math.abs(aprev) < Math.abs(anext) && normal[0] < 0 || Math.abs(aprev) > Math.abs(anext) && normal[0] > 0) { + normal[0] *= -1; + normal[1] *= -1; + } + + //position + x = cur[0] + normal[0] * offsetFromViz; + y = cur[1] + normal[1] * offsetFromViz; + + //box position and dimensions + boxx = x + (normal[0] > 0? 0 : -(bbox.width + 2 * offsetBox)); + boxy = y - bbox.height /2 - offsetBox; + boxw = bbox.width + 2 * offsetBox; + boxh = bbox.height + 2 * offsetBox; + + //now check if we're out of bounds and invert the normal vector correspondingly + //this may add new overlaps between labels (but labels won't be out of bounds). + if (boxx < clipRect[0] || (boxx + boxw) > (clipRect[0] + clipRect[2])) { + normal[0] *= -1; + } + if (boxy < clipRect[1] || (boxy + boxh) > (clipRect[1] + clipRect[3])) { + normal[1] *= -1; + } + + //update positions + x = cur[0] + normal[0] * offsetFromViz; + y = cur[1] + normal[1] * offsetFromViz; + + //update box position and dimensions + boxx = x + (normal[0] > 0? 0 : -(bbox.width + 2 * offsetBox)); + boxy = y - bbox.height /2 - offsetBox; + boxw = bbox.width + 2 * offsetBox; + boxh = bbox.height + 2 * offsetBox; + + //set the line from the middle of the pie to the box. + callout.lines.setAttributes({ + path: ["M", cur[0], cur[1], "L", x, y, "Z"] + }, true); + //set box position + callout.box.setAttributes({ + x: boxx, + y: boxy, + width: boxw, + height: boxh + }, true); + //set text position + callout.label.setAttributes({ + x: x + (normal[0] > 0? offsetBox : -(bbox.width + offsetBox)), + y: y + }, true); + for (p in callout) { + callout[p].show(true); + } + }, + + isItemInPoint: function(x, y, item, i) { + var me = this, + pointsUp = item.pointsUp, + pointsDown = item.pointsDown, + abs = Math.abs, + dist = Infinity, p, pln, point; + + for (p = 0, pln = pointsUp.length; p < pln; p++) { + point = [pointsUp[p][0], pointsUp[p][1]]; + if (dist > abs(x - point[0])) { + dist = abs(x - point[0]); + } else { + point = pointsUp[p -1]; + if (y >= point[1] && (!pointsDown.length || y <= (pointsDown[p -1][1]))) { + item.storeIndex = p -1; + item.storeField = me.yField[i]; + item.storeItem = me.chart.store.getAt(p -1); + item._points = pointsDown.length? [point, pointsDown[p -1]] : [point]; + return true; + } else { + break; + } + } + } + return false; }, /** - * Sets the initialize size for the resizing element - * @param {Number} size The initial size + * Highlight this entire series. + * @param {Object} item Info about the item; same format as returned by #getItemForPoint. */ - setCurrentSize : function(size){ - var oldAnimate = this.animate; - this.animate = false; - this.adapter.setElementSize(this, size); - this.animate = oldAnimate; + highlightSeries: function() { + var area, to, fillColor; + if (this._index !== undefined) { + area = this.areas[this._index]; + if (area.__highlightAnim) { + area.__highlightAnim.paused = true; + } + area.__highlighted = true; + area.__prevOpacity = area.__prevOpacity || area.attr.opacity || 1; + area.__prevFill = area.__prevFill || area.attr.fill; + area.__prevLineWidth = area.__prevLineWidth || area.attr.lineWidth; + fillColor = Ext.draw.Color.fromString(area.__prevFill); + to = { + lineWidth: (area.__prevLineWidth || 0) + 2 + }; + if (fillColor) { + to.fill = fillColor.getLighter(0.2).toString(); + } + else { + to.opacity = Math.max(area.__prevOpacity - 0.3, 0); + } + if (this.chart.animate) { + area.__highlightAnim = Ext.create('Ext.fx.Anim', Ext.apply({ + target: area, + to: to + }, this.chart.animate)); + } + else { + area.setAttributes(to, true); + } + } }, /** - * Destroy this splitbar. - * @param {Boolean} removeEl True to remove the element + * UnHighlight this entire series. + * @param {Object} item Info about the item; same format as returned by #getItemForPoint. */ - destroy : function(removeEl){ - Ext.destroy(this.shim, Ext.get(this.proxy)); - this.dd.unreg(); - if(removeEl){ - this.el.remove(); + unHighlightSeries: function() { + var area; + if (this._index !== undefined) { + area = this.areas[this._index]; + if (area.__highlightAnim) { + area.__highlightAnim.paused = true; + } + if (area.__highlighted) { + area.__highlighted = false; + area.__highlightAnim = Ext.create('Ext.fx.Anim', { + target: area, + to: { + fill: area.__prevFill, + opacity: area.__prevOpacity, + lineWidth: area.__prevLineWidth + } + }); + } } - this.purgeListeners(); - } -}); - -/** - * @private static Create our own proxy element element. So it will be the same same size on all browsers, we won't use borders. Instead we use a background color. - */ -Ext.SplitBar.createProxy = function(dir){ - var proxy = new Ext.Element(document.createElement("div")); - document.body.appendChild(proxy.dom); - proxy.unselectable(); - var cls = 'x-splitbar-proxy'; - proxy.addClass(cls + ' ' + (dir == Ext.SplitBar.HORIZONTAL ? cls +'-h' : cls + '-v')); - return proxy.dom; -}; - -/** - * @class Ext.SplitBar.BasicLayoutAdapter - * Default Adapter. It assumes the splitter and resizing element are not positioned - * elements and only gets/sets the width of the element. Generally used for table based layouts. - */ -Ext.SplitBar.BasicLayoutAdapter = function(){ -}; - -Ext.SplitBar.BasicLayoutAdapter.prototype = { - // do nothing for now - init : function(s){ - }, + /** - * Called before drag operations to get the current size of the resizing element. - * @param {Ext.SplitBar} s The SplitBar using this adapter + * Highlight the specified item. If no item is provided the whole series will be highlighted. + * @param item {Object} Info about the item; same format as returned by #getItemForPoint */ - getElementSize : function(s){ - if(s.orientation == Ext.SplitBar.HORIZONTAL){ - return s.resizingEl.getWidth(); - }else{ - return s.resizingEl.getHeight(); + highlightItem: function(item) { + var me = this, + points, path; + if (!item) { + this.highlightSeries(); + return; } + points = item._points; + path = points.length == 2? ['M', points[0][0], points[0][1], 'L', points[1][0], points[1][1]] + : ['M', points[0][0], points[0][1], 'L', points[0][0], me.bbox.y + me.bbox.height]; + me.highlightSprite.setAttributes({ + path: path, + hidden: false + }, true); }, /** - * Called after drag operations to set the size of the resizing element. - * @param {Ext.SplitBar} s The SplitBar using this adapter - * @param {Number} newSize The new size to set - * @param {Function} onComplete A function to be invoked when resizing is complete + * un-highlights the specified item. If no item is provided it will un-highlight the entire series. + * @param item {Object} Info about the item; same format as returned by #getItemForPoint */ - setElementSize : function(s, newSize, onComplete){ - if(s.orientation == Ext.SplitBar.HORIZONTAL){ - if(!s.animate){ - s.resizingEl.setWidth(newSize); - if(onComplete){ - onComplete(s, newSize); - } - }else{ - s.resizingEl.setWidth(newSize, true, .1, onComplete, 'easeOut'); - } - }else{ - - if(!s.animate){ - s.resizingEl.setHeight(newSize); - if(onComplete){ - onComplete(s, newSize); - } - }else{ - s.resizingEl.setHeight(newSize, true, .1, onComplete, 'easeOut'); - } - } - } -}; - -/** - *@class Ext.SplitBar.AbsoluteLayoutAdapter - * @extends Ext.SplitBar.BasicLayoutAdapter - * Adapter that moves the splitter element to align with the resized sizing element. - * Used with an absolute positioned SplitBar. - * @param {Mixed} container The container that wraps around the absolute positioned content. If it's - * document.body, make sure you assign an id to the body element. - */ -Ext.SplitBar.AbsoluteLayoutAdapter = function(container){ - this.basic = new Ext.SplitBar.BasicLayoutAdapter(); - this.container = Ext.get(container); -}; + unHighlightItem: function(item) { + if (!item) { + this.unHighlightSeries(); + } -Ext.SplitBar.AbsoluteLayoutAdapter.prototype = { - init : function(s){ - this.basic.init(s); + if (this.highlightSprite) { + this.highlightSprite.hide(true); + } }, - getElementSize : function(s){ - return this.basic.getElementSize(s); + // @private + hideAll: function() { + if (!isNaN(this._index)) { + this.__excludes[this._index] = true; + this.areas[this._index].hide(true); + this.drawSeries(); + } }, - setElementSize : function(s, newSize, onComplete){ - this.basic.setElementSize(s, newSize, this.moveSplitter.createDelegate(this, [s])); + // @private + showAll: function() { + if (!isNaN(this._index)) { + this.__excludes[this._index] = false; + this.areas[this._index].show(true); + this.drawSeries(); + } }, - moveSplitter : function(s){ - var yes = Ext.SplitBar; - switch(s.placement){ - case yes.LEFT: - s.el.setX(s.resizingEl.getRight()); - break; - case yes.RIGHT: - s.el.setStyle("right", (this.container.getWidth() - s.resizingEl.getLeft()) + "px"); - break; - case yes.TOP: - s.el.setY(s.resizingEl.getBottom()); - break; - case yes.BOTTOM: - s.el.setY(s.resizingEl.getTop() - s.el.getHeight()); - break; - } + /** + * Returns the color of the series (to be displayed as color for the series legend item). + * @param item {Object} Info about the item; same format as returned by #getItemForPoint + */ + getLegendColor: function(index) { + var me = this; + return me.colorArrayStyle[index % me.colorArrayStyle.length]; } -}; - -/** - * Orientation constant - Create a vertical SplitBar - * @static - * @type Number - */ -Ext.SplitBar.VERTICAL = 1; +}); /** - * Orientation constant - Create a horizontal SplitBar - * @static - * @type Number + * Creates a Bar Chart. A Bar Chart is a useful visualization technique to display quantitative information for + * different categories that can show some progression (or regression) in the dataset. As with all other series, the Bar + * Series must be appended in the *series* Chart array configuration. See the Chart documentation for more information. + * A typical configuration object for the bar series could be: + * + * {@img Ext.chart.series.Bar/Ext.chart.series.Bar.png Ext.chart.series.Bar chart series} + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * animate: true, + * store: store, + * axes: [{ + * type: 'Numeric', + * position: 'bottom', + * fields: ['data1'], + * label: { + * renderer: Ext.util.Format.numberRenderer('0,0') + * }, + * title: 'Sample Values', + * grid: true, + * minimum: 0 + * }, { + * type: 'Category', + * position: 'left', + * fields: ['name'], + * title: 'Sample Metrics' + * }], + * series: [{ + * type: 'bar', + * axis: 'bottom', + * highlight: true, + * tips: { + * trackMouse: true, + * width: 140, + * height: 28, + * renderer: function(storeItem, item) { + * this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views'); + * } + * }, + * label: { + * display: 'insideEnd', + * field: 'data1', + * renderer: Ext.util.Format.numberRenderer('0'), + * orientation: 'horizontal', + * color: '#333', + * 'text-anchor': 'middle' + * }, + * xField: 'name', + * yField: ['data1'] + * }] + * }); + * + * In this configuration we set `bar` as the series type, bind the values of the bar to the bottom axis and set the + * xField or category field to the `name` parameter of the store. We also set `highlight` to true which enables smooth + * animations when bars are hovered. We also set some configuration for the bar labels to be displayed inside the bar, + * to display the information found in the `data1` property of each element store, to render a formated text with the + * `Ext.util.Format` we pass in, to have an `horizontal` orientation (as opposed to a vertical one) and we also set + * other styles like `color`, `text-anchor`, etc. */ -Ext.SplitBar.HORIZONTAL = 2; +Ext.define('Ext.chart.series.Bar', { -/** - * Placement constant - The resizing element is to the left of the splitter element - * @static - * @type Number - */ -Ext.SplitBar.LEFT = 1; + /* Begin Definitions */ -/** - * Placement constant - The resizing element is to the right of the splitter element - * @static - * @type Number - */ -Ext.SplitBar.RIGHT = 2; + extend: 'Ext.chart.series.Cartesian', -/** - * Placement constant - The resizing element is positioned above the splitter element - * @static - * @type Number - */ -Ext.SplitBar.TOP = 3; + alternateClassName: ['Ext.chart.BarSeries', 'Ext.chart.BarChart', 'Ext.chart.StackedBarChart'], -/** - * Placement constant - The resizing element is positioned under splitter element - * @static - * @type Number - */ -Ext.SplitBar.BOTTOM = 4; -/** - * @class Ext.Container - * @extends Ext.BoxComponent - * Base class for any {@link Ext.BoxComponent} that may contain other Components. Containers handle the - * basic behavior of containing items, namely adding, inserting and removing items. - * - * The most commonly used Container classes are {@link Ext.Panel}, {@link Ext.Window} and {@link Ext.TabPanel}. - * If you do not need the capabilities offered by the aforementioned classes you can create a lightweight - * Container to be encapsulated by an HTML element to your specifications by using the - * {@link Ext.Component#autoEl autoEl} config option. This is a useful technique when creating - * embedded {@link Ext.layout.ColumnLayout column} layouts inside {@link Ext.form.FormPanel FormPanels} - * for example. - * - * The code below illustrates both how to explicitly create a Container, and how to implicitly - * create one using the 'container' xtype: -// explicitly create a Container -var embeddedColumns = new Ext.Container({ - autoEl: 'div', // This is the default - layout: 'column', - defaults: { - // implicitly create Container by specifying xtype - xtype: 'container', - autoEl: 'div', // This is the default. - layout: 'form', - columnWidth: 0.5, - style: { - padding: '10px' - } - }, -// The two items below will be Ext.Containers, each encapsulated by a <DIV> element. - items: [{ - items: { - xtype: 'datefield', - name: 'startDate', - fieldLabel: 'Start date' - } - }, { - items: { - xtype: 'datefield', - name: 'endDate', - fieldLabel: 'End date' - } - }] -}); - * - * Layout - * Container classes delegate the rendering of child Components to a layout - * manager class which must be configured into the Container using the - * {@link #layout} configuration property. - * When either specifying child {@link #items} of a Container, - * or dynamically {@link #add adding} Components to a Container, remember to - * consider how you wish the Container to arrange those child elements, and - * whether those child elements need to be sized using one of Ext's built-in - * {@link #layout} schemes. By default, Containers use the - * {@link Ext.layout.ContainerLayout ContainerLayout} scheme which only - * renders child components, appending them one after the other inside the - * Container, and does not apply any sizing at all. - * A common mistake is when a developer neglects to specify a - * {@link #layout} (e.g. widgets like GridPanels or - * TreePanels are added to Containers for which no {@link #layout} - * has been specified). If a Container is left to use the default - * {@link Ext.layout.ContainerLayout ContainerLayout} scheme, none of its - * child components will be resized, or changed in any way when the Container - * is resized. - * Certain layout managers allow dynamic addition of child components. - * Those that do include {@link Ext.layout.CardLayout}, - * {@link Ext.layout.AnchorLayout}, {@link Ext.layout.FormLayout}, and - * {@link Ext.layout.TableLayout}. For example: -// Create the GridPanel. -var myNewGrid = new Ext.grid.GridPanel({ - store: myStore, - columns: myColumnModel, - title: 'Results', // the title becomes the title of the tab -}); + requires: ['Ext.chart.axis.Axis', 'Ext.fx.Anim'], -myTabPanel.add(myNewGrid); // {@link Ext.TabPanel} implicitly uses {@link Ext.layout.CardLayout CardLayout} -myTabPanel.{@link Ext.TabPanel#setActiveTab setActiveTab}(myNewGrid); - * - * The example above adds a newly created GridPanel to a TabPanel. Note that - * a TabPanel uses {@link Ext.layout.CardLayout} as its layout manager which - * means all its child items are sized to {@link Ext.layout.FitLayout fit} - * exactly into its client area. - * Overnesting is a common problem. - * An example of overnesting occurs when a GridPanel is added to a TabPanel - * by wrapping the GridPanel inside a wrapping Panel (that has no - * {@link #layout} specified) and then add that wrapping Panel - * to the TabPanel. The point to realize is that a GridPanel is a - * Component which can be added directly to a Container. If the wrapping Panel - * has no {@link #layout} configuration, then the overnested - * GridPanel will not be sized as expected. - * - * Adding via remote configuration - * - * A server side script can be used to add Components which are generated dynamically on the server. - * An example of adding a GridPanel to a TabPanel where the GridPanel is generated by the server - * based on certain parameters: - * -// execute an Ajax request to invoke server side script: -Ext.Ajax.request({ - url: 'gen-invoice-grid.php', - // send additional parameters to instruct server script - params: { - startDate: Ext.getCmp('start-date').getValue(), - endDate: Ext.getCmp('end-date').getValue() - }, - // process the response object to add it to the TabPanel: - success: function(xhr) { - var newComponent = eval(xhr.responseText); // see discussion below - myTabPanel.add(newComponent); // add the component to the TabPanel - myTabPanel.setActiveTab(newComponent); - }, - failure: function() { - Ext.Msg.alert("Grid create failed", "Server communication failure"); - } -}); - - * The server script needs to return an executable Javascript statement which, when processed - * using eval(), will return either a config object with an {@link Ext.Component#xtype xtype}, - * or an instantiated Component. The server might return this for example: -(function() { - function formatDate(value){ - return value ? value.dateFormat('M d, Y') : ''; - }; + /* End Definitions */ - var store = new Ext.data.Store({ - url: 'get-invoice-data.php', - baseParams: { - startDate: '01/01/2008', - endDate: '01/31/2008' - }, - reader: new Ext.data.JsonReader({ - record: 'transaction', - idProperty: 'id', - totalRecords: 'total' - }, [ - 'customer', - 'invNo', - {name: 'date', type: 'date', dateFormat: 'm/d/Y'}, - {name: 'value', type: 'float'} - ]) - }); + type: 'bar', - var grid = new Ext.grid.GridPanel({ - title: 'Invoice Report', - bbar: new Ext.PagingToolbar(store), - store: store, - columns: [ - {header: "Customer", width: 250, dataIndex: 'customer', sortable: true}, - {header: "Invoice Number", width: 120, dataIndex: 'invNo', sortable: true}, - {header: "Invoice Date", width: 100, dataIndex: 'date', renderer: formatDate, sortable: true}, - {header: "Value", width: 120, dataIndex: 'value', renderer: 'usMoney', sortable: true} - ], - }); - store.load(); - return grid; // return instantiated component -})(); - - * When the above code fragment is passed through the eval function in the success handler - * of the Ajax request, the code is executed by the Javascript processor, and the anonymous function - * runs, and returns the instantiated grid component. - * Note: since the code above is generated by a server script, the baseParams for - * the Store, the metadata to allow generation of the Record layout, and the ColumnModel - * can all be generated into the code since these are all known on the server. - * - * @xtype container - */ -Ext.Container = Ext.extend(Ext.BoxComponent, { - /** - * @cfg {Boolean} monitorResize - * True to automatically monitor window resize events to handle anything that is sensitive to the current size - * of the viewport. This value is typically managed by the chosen {@link #layout} and should not need - * to be set manually. - */ + alias: 'series.bar', /** - * @cfg {String/Object} layout - * *Important: In order for child items to be correctly sized and - * positioned, typically a layout manager must be specified through - * the layout configuration option. - * The sizing and positioning of child {@link items} is the responsibility of - * the Container's layout manager which creates and manages the type of layout - * you have in mind. For example: -new Ext.Window({ - width:300, height: 300, - layout: 'fit', // explicitly set layout manager: override the default (layout:'auto') - items: [{ - title: 'Panel inside a Window' - }] -}).show(); - * - * If the {@link #layout} configuration is not explicitly specified for - * a general purpose container (e.g. Container or Panel) the - * {@link Ext.layout.ContainerLayout default layout manager} will be used - * which does nothing but render child components sequentially into the - * Container (no sizing or positioning will be performed in this situation). - * Some container classes implicitly specify a default layout - * (e.g. FormPanel specifies layout:'form'). Other specific - * purpose classes internally specify/manage their internal layout (e.g. - * GridPanel, TabPanel, TreePanel, Toolbar, Menu, etc.). - * layout may be specified as either as an Object or - * as a String: - * - * Specify as an Object - * - * Example usage: - -layout: { - type: 'vbox', - padding: '5', - align: 'left' -} - - * - * type - * The layout type to be used for this container. If not specified, - * a default {@link Ext.layout.ContainerLayout} will be created and used. - * Valid layout type values are: - * - * {@link Ext.layout.AbsoluteLayout absolute} - * {@link Ext.layout.AccordionLayout accordion} - * {@link Ext.layout.AnchorLayout anchor} - * {@link Ext.layout.ContainerLayout auto}     Default - * {@link Ext.layout.BorderLayout border} - * {@link Ext.layout.CardLayout card} - * {@link Ext.layout.ColumnLayout column} - * {@link Ext.layout.FitLayout fit} - * {@link Ext.layout.FormLayout form} - * {@link Ext.layout.HBoxLayout hbox} - * {@link Ext.layout.MenuLayout menu} - * {@link Ext.layout.TableLayout table} - * {@link Ext.layout.ToolbarLayout toolbar} - * {@link Ext.layout.VBoxLayout vbox} - * - * - * Layout specific configuration properties - * Additional layout specific configuration properties may also be - * specified. For complete details regarding the valid config options for - * each layout type, see the layout class corresponding to the type - * specified. - * - * - * - * Specify as a String - * - * Example usage: - -layout: 'vbox', -layoutConfig: { - padding: '5', - align: 'left' -} - - * layout - * The layout type to be used for this container (see list - * of valid layout type values above). - * {@link #layoutConfig} - * Additional layout specific configuration properties. For complete - * details regarding the valid config options for each layout type, see the - * layout class corresponding to the layout specified. - * + * @cfg {Boolean} column Whether to set the visualization as column chart or horizontal bar chart. */ + column: false, + /** - * @cfg {Object} layoutConfig - * This is a config object containing properties specific to the chosen - * {@link #layout} if {@link #layout} - * has been specified as a string. + * @cfg style Style properties that will override the theming series styles. */ + style: {}, + /** - * @cfg {Boolean/Number} bufferResize - * When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer - * the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers - * with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50. + * @cfg {Number} gutter The gutter space between single bars, as a percentage of the bar width */ - bufferResize: 50, + gutter: 38.2, /** - * @cfg {String/Number} activeItem - * A string component id or the numeric index of the component that should be initially activated within the - * container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first - * item in the container's collection). activeItem only applies to layout styles that can display - * items one at a time (like {@link Ext.layout.AccordionLayout}, {@link Ext.layout.CardLayout} and - * {@link Ext.layout.FitLayout}). Related to {@link Ext.layout.ContainerLayout#activeItem}. + * @cfg {Number} groupGutter The gutter space between groups of bars, as a percentage of the bar width */ - /** - * @cfg {Object/Array} items - * ** IMPORTANT: be sure to {@link #layout specify a layout} if needed ! ** - * A single item, or an array of child Components to be added to this container, - * for example: - * -// specifying a single item -items: {...}, -layout: 'fit', // specify a layout! + groupGutter: 38.2, -// specifying multiple items -items: [{...}, {...}], -layout: 'anchor', // specify a layout! - * - * Each item may be: - * - * any type of object based on {@link Ext.Component} - * a fully instanciated object or - * an object literal that: - * - * has a specified {@link Ext.Component#xtype xtype} - * the {@link Ext.Component#xtype} specified is associated with the Component - * desired and should be chosen from one of the available xtypes as listed - * in {@link Ext.Component}. - * If an {@link Ext.Component#xtype xtype} is not explicitly - * specified, the {@link #defaultType} for that Container is used. - * will be "lazily instanciated", avoiding the overhead of constructing a fully - * instanciated Component object - * - * Notes: - * - * Ext uses lazy rendering. Child Components will only be rendered - * should it become necessary. Items are automatically laid out when they are first - * shown (no sizing is done while hidden), or in response to a {@link #doLayout} call. - * Do not specify {@link Ext.Panel#contentEl contentEl}/ - * {@link Ext.Panel#html html} with items. - * - */ /** - * @cfg {Object|Function} defaults - * This option is a means of applying default settings to all added items whether added through the {@link #items} - * config or via the {@link #add} or {@link #insert} methods. - * If an added item is a config object, and not an instantiated Component, then the default properties are - * unconditionally applied. If the added item is an instantiated Component, then the default properties are - * applied conditionally so as not to override existing properties in the item. - * If the defaults option is specified as a function, then the function will be called using this Container as the - * scope (this reference) and passing the added item as the first parameter. Any resulting object - * from that call is then applied to the item as default properties. - * For example, to automatically apply padding to the body of each of a set of - * contained {@link Ext.Panel} items, you could pass: defaults: {bodyStyle:'padding:15px'}. - * Usage: -defaults: { // defaults are applied to items, not the container - autoScroll:true -}, -items: [ - { - xtype: 'panel', // defaults do not have precedence over - id: 'panel1', // options in config objects, so the defaults - autoScroll: false // will not be applied here, panel1 will be autoScroll:false - }, - new Ext.Panel({ // defaults do have precedence over options - id: 'panel2', // options in components, so the defaults - autoScroll: false // will be applied here, panel2 will be autoScroll:true. - }) -] - * - */ - - - /** @cfg {Boolean} autoDestroy - * If true the container will automatically destroy any contained component that is removed from it, else - * destruction must be handled manually (defaults to true). - */ - autoDestroy : true, - - /** @cfg {Boolean} forceLayout - * If true the container will force a layout initially even if hidden or collapsed. This option - * is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). - */ - forceLayout: false, - - /** @cfg {Boolean} hideBorders - * True to hide the borders of each contained component, false to defer to the component's existing - * border settings (defaults to false). - */ - /** @cfg {String} defaultType - * The default {@link Ext.Component xtype} of child Components to create in this Container when - * a child item is specified as a raw configuration object, rather than as an instantiated Component. - * Defaults to 'panel', except {@link Ext.menu.Menu} which defaults to 'menuitem', - * and {@link Ext.Toolbar} and {@link Ext.ButtonGroup} which default to 'button'. - */ - defaultType : 'panel', - - /** @cfg {String} resizeEvent - * The event to listen to for resizing in layouts. Defaults to 'resize'. + * @cfg {Number} xPadding Padding between the left/right axes and the bars */ - resizeEvent: 'resize', + xPadding: 0, /** - * @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 ['add', 'remove']. + * @cfg {Number} yPadding Padding between the top/bottom axes and the bars */ - bubbleEvents: ['add', 'remove'], - - // private - initComponent : function(){ - Ext.Container.superclass.initComponent.call(this); - - this.addEvents( - /** - * @event afterlayout - * Fires when the components in this container are arranged by the associated layout manager. - * @param {Ext.Container} this - * @param {ContainerLayout} layout The ContainerLayout implementation for this container - */ - 'afterlayout', - /** - * @event beforeadd - * Fires before any {@link Ext.Component} is added or inserted into the container. - * A handler can return false to cancel the add. - * @param {Ext.Container} this - * @param {Ext.Component} component The component being added - * @param {Number} index The index at which the component will be added to the container's items collection - */ - 'beforeadd', - /** - * @event beforeremove - * Fires before any {@link Ext.Component} is removed from the container. A handler can return - * false to cancel the remove. - * @param {Ext.Container} this - * @param {Ext.Component} component The component being removed - */ - 'beforeremove', - /** - * @event add - * @bubbles - * Fires after any {@link Ext.Component} is added or inserted into the container. - * @param {Ext.Container} this - * @param {Ext.Component} component The component that was added - * @param {Number} index The index at which the component was added to the container's items collection - */ - 'add', - /** - * @event remove - * @bubbles - * Fires after any {@link Ext.Component} is removed from the container. - * @param {Ext.Container} this - * @param {Ext.Component} component The component that was removed - */ - 'remove' - ); + yPadding: 10, - /** - * The collection of components in this container as a {@link Ext.util.MixedCollection} - * @type MixedCollection - * @property items - */ - var items = this.items; - if(items){ - delete this.items; - this.add(items); + constructor: function(config) { + this.callParent(arguments); + var me = this, + surface = me.chart.surface, + shadow = me.chart.shadow, + i, l; + Ext.apply(me, config, { + highlightCfg: { + lineWidth: 3, + stroke: '#55c', + opacity: 0.8, + color: '#f00' + }, + + shadowAttributes: [{ + "stroke-width": 6, + "stroke-opacity": 0.05, + stroke: 'rgb(200, 200, 200)', + translate: { + x: 1.2, + y: 1.2 + } + }, { + "stroke-width": 4, + "stroke-opacity": 0.1, + stroke: 'rgb(150, 150, 150)', + translate: { + x: 0.9, + y: 0.9 + } + }, { + "stroke-width": 2, + "stroke-opacity": 0.15, + stroke: 'rgb(100, 100, 100)', + translate: { + x: 0.6, + y: 0.6 + } + }] + }); + me.group = surface.getGroup(me.seriesId + '-bars'); + if (shadow) { + for (i = 0, l = me.shadowAttributes.length; i < l; i++) { + me.shadowGroups.push(surface.getGroup(me.seriesId + '-shadows' + i)); + } } }, - // private - initItems : function(){ - if(!this.items){ - this.items = new Ext.util.MixedCollection(false, this.getComponentId); - this.getLayout(); // initialize the layout - } + // @private sets the bar girth. + getBarGirth: function() { + var me = this, + store = me.chart.store, + column = me.column, + ln = store.getCount(), + gutter = me.gutter / 100; + + return (me.chart.chartBBox[column ? 'width' : 'height'] - me[column ? 'xPadding' : 'yPadding'] * 2) / (ln * (gutter + 1) - gutter); }, - // private - setLayout : function(layout){ - if(this.layout && this.layout != layout){ - this.layout.setContainer(null); - } - this.layout = layout; - this.initItems(); - layout.setContainer(this); + // @private returns the gutters. + getGutters: function() { + var me = this, + column = me.column, + gutter = Math.ceil(me[column ? 'xPadding' : 'yPadding'] + me.getBarGirth() / 2); + return me.column ? [gutter, 0] : [0, gutter]; }, - afterRender: function(){ - // Render this Container, this should be done before setLayout is called which - // will hook onResize - Ext.Container.superclass.afterRender.call(this); - if(!this.layout){ - this.layout = 'auto'; - } - if(Ext.isObject(this.layout) && !this.layout.layout){ - this.layoutConfig = this.layout; - this.layout = this.layoutConfig.type; + // @private Get chart and data boundaries + getBounds: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + bars = [].concat(me.yField), + barsLen = bars.length, + groupBarsLen = barsLen, + groupGutter = me.groupGutter / 100, + column = me.column, + xPadding = me.xPadding, + yPadding = me.yPadding, + stacked = me.stacked, + barWidth = me.getBarGirth(), + math = Math, + mmax = math.max, + mabs = math.abs, + groupBarWidth, bbox, minY, maxY, axis, out, + scale, zero, total, rec, j, plus, minus; + + me.setBBox(true); + bbox = me.bbox; + + //Skip excluded series + if (me.__excludes) { + for (j = 0, total = me.__excludes.length; j < total; j++) { + if (me.__excludes[j]) { + groupBarsLen--; + } + } } - if(Ext.isString(this.layout)){ - this.layout = new Ext.Container.LAYOUTS[this.layout.toLowerCase()](this.layoutConfig); + + if (me.axis) { + axis = chart.axes.get(me.axis); + if (axis) { + out = axis.calcEnds(); + minY = out.from || axis.prevMin; + maxY = mmax(out.to || axis.prevMax, 0); + } } - this.setLayout(this.layout); - // If a CardLayout, the active item set - if(this.activeItem !== undefined){ - var item = this.activeItem; - delete this.activeItem; - this.layout.setActiveItem(item); + if (me.yField && !Ext.isNumber(minY)) { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.yField) + }); + out = axis.calcEnds(); + minY = out.from || axis.prevMin; + maxY = mmax(out.to || axis.prevMax, 0); } - // If we have no ownerCt, render and size all children - if(!this.ownerCt){ - this.doLayout(false, true); + if (!Ext.isNumber(minY)) { + minY = 0; } + if (!Ext.isNumber(maxY)) { + maxY = 0; + } + scale = (column ? bbox.height - yPadding * 2 : bbox.width - xPadding * 2) / (maxY - minY); + groupBarWidth = barWidth / ((stacked ? 1 : groupBarsLen) * (groupGutter + 1) - groupGutter); + zero = (column) ? bbox.y + bbox.height - yPadding : bbox.x + xPadding; - // This is a manually configured flag set by users in conjunction with renderTo. - // Not to be confused with the flag by the same name used in Layouts. - if(this.monitorResize === true){ - Ext.EventManager.onWindowResize(this.doLayout, this, [false]); + if (stacked) { + total = [[], []]; + store.each(function(record, i) { + total[0][i] = total[0][i] || 0; + total[1][i] = total[1][i] || 0; + for (j = 0; j < barsLen; j++) { + if (me.__excludes && me.__excludes[j]) { + continue; + } + rec = record.get(bars[j]); + total[+(rec > 0)][i] += mabs(rec); + } + }); + total[+(maxY > 0)].push(mabs(maxY)); + total[+(minY > 0)].push(mabs(minY)); + minus = mmax.apply(math, total[0]); + plus = mmax.apply(math, total[1]); + scale = (column ? bbox.height - yPadding * 2 : bbox.width - xPadding * 2) / (plus + minus); + zero = zero + minus * scale * (column ? -1 : 1); + } + else if (minY / maxY < 0) { + zero = zero - minY * scale * (column ? -1 : 1); } + return { + bars: bars, + bbox: bbox, + barsLen: barsLen, + groupBarsLen: groupBarsLen, + barWidth: barWidth, + groupBarWidth: groupBarWidth, + scale: scale, + zero: zero, + xPadding: xPadding, + yPadding: yPadding, + signed: minY / maxY < 0, + minY: minY, + maxY: maxY + }; }, - /** - * Returns the Element to be used to contain the child Components of this Container. - * An implementation is provided which returns the Container's {@link #getEl Element}, but - * if there is a more complex structure to a Container, this may be overridden to return - * the element into which the {@link #layout layout} renders child Components. - * @return {Ext.Element} The Element to render child Components into. - */ - getLayoutTarget : function(){ - return this.el; + // @private Build an array of paths for the chart + getPaths: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + bounds = me.bounds = me.getBounds(), + items = me.items = [], + gutter = me.gutter / 100, + groupGutter = me.groupGutter / 100, + animate = chart.animate, + column = me.column, + group = me.group, + enableShadows = chart.shadow, + shadowGroups = me.shadowGroups, + shadowAttributes = me.shadowAttributes, + shadowGroupsLn = shadowGroups.length, + bbox = bounds.bbox, + xPadding = me.xPadding, + yPadding = me.yPadding, + stacked = me.stacked, + barsLen = bounds.barsLen, + colors = me.colorArrayStyle, + colorLength = colors && colors.length || 0, + math = Math, + mmax = math.max, + mmin = math.min, + mabs = math.abs, + j, yValue, height, totalDim, totalNegDim, bottom, top, hasShadow, barAttr, attrs, counter, + shadowIndex, shadow, sprite, offset, floorY; + + store.each(function(record, i, total) { + bottom = bounds.zero; + top = bounds.zero; + totalDim = 0; + totalNegDim = 0; + hasShadow = false; + for (j = 0, counter = 0; j < barsLen; j++) { + // Excluded series + if (me.__excludes && me.__excludes[j]) { + continue; + } + yValue = record.get(bounds.bars[j]); + height = Math.round((yValue - ((bounds.minY < 0) ? 0 : bounds.minY)) * bounds.scale); + barAttr = { + fill: colors[(barsLen > 1 ? j : 0) % colorLength] + }; + if (column) { + Ext.apply(barAttr, { + height: height, + width: mmax(bounds.groupBarWidth, 0), + x: (bbox.x + xPadding + i * bounds.barWidth * (1 + gutter) + counter * bounds.groupBarWidth * (1 + groupGutter) * !stacked), + y: bottom - height + }); + } + else { + // draw in reverse order + offset = (total - 1) - i; + Ext.apply(barAttr, { + height: mmax(bounds.groupBarWidth, 0), + width: height + (bottom == bounds.zero), + x: bottom + (bottom != bounds.zero), + y: (bbox.y + yPadding + offset * bounds.barWidth * (1 + gutter) + counter * bounds.groupBarWidth * (1 + groupGutter) * !stacked + 1) + }); + } + if (height < 0) { + if (column) { + barAttr.y = top; + barAttr.height = mabs(height); + } else { + barAttr.x = top + height; + barAttr.width = mabs(height); + } + } + if (stacked) { + if (height < 0) { + top += height * (column ? -1 : 1); + } else { + bottom += height * (column ? -1 : 1); + } + totalDim += mabs(height); + if (height < 0) { + totalNegDim += mabs(height); + } + } + barAttr.x = Math.floor(barAttr.x) + 1; + floorY = Math.floor(barAttr.y); + if (!Ext.isIE9 && barAttr.y > floorY) { + floorY--; + } + barAttr.y = floorY; + barAttr.width = Math.floor(barAttr.width); + barAttr.height = Math.floor(barAttr.height); + items.push({ + series: me, + storeItem: record, + value: [record.get(me.xField), yValue], + attr: barAttr, + point: column ? [barAttr.x + barAttr.width / 2, yValue >= 0 ? barAttr.y : barAttr.y + barAttr.height] : + [yValue >= 0 ? barAttr.x + barAttr.width : barAttr.x, barAttr.y + barAttr.height / 2] + }); + // When resizing, reset before animating + if (animate && chart.resizing) { + attrs = column ? { + x: barAttr.x, + y: bounds.zero, + width: barAttr.width, + height: 0 + } : { + x: bounds.zero, + y: barAttr.y, + width: 0, + height: barAttr.height + }; + if (enableShadows && (stacked && !hasShadow || !stacked)) { + hasShadow = true; + //update shadows + for (shadowIndex = 0; shadowIndex < shadowGroupsLn; shadowIndex++) { + shadow = shadowGroups[shadowIndex].getAt(stacked ? i : (i * barsLen + j)); + if (shadow) { + shadow.setAttributes(attrs, true); + } + } + } + //update sprite position and width/height + sprite = group.getAt(i * barsLen + j); + if (sprite) { + sprite.setAttributes(attrs, true); + } + } + counter++; + } + if (stacked && items.length) { + items[i * counter].totalDim = totalDim; + items[i * counter].totalNegDim = totalNegDim; + } + }, me); }, - // private - used as the key lookup function for the items collection - getComponentId : function(comp){ - return comp.getItemId(); + // @private render/setAttributes on the shadows + renderShadows: function(i, barAttr, baseAttrs, bounds) { + var me = this, + chart = me.chart, + surface = chart.surface, + animate = chart.animate, + stacked = me.stacked, + shadowGroups = me.shadowGroups, + shadowAttributes = me.shadowAttributes, + shadowGroupsLn = shadowGroups.length, + store = chart.substore || chart.store, + column = me.column, + items = me.items, + shadows = [], + zero = bounds.zero, + shadowIndex, shadowBarAttr, shadow, totalDim, totalNegDim, j, rendererAttributes; + + if ((stacked && (i % bounds.groupBarsLen === 0)) || !stacked) { + j = i / bounds.groupBarsLen; + //create shadows + for (shadowIndex = 0; shadowIndex < shadowGroupsLn; shadowIndex++) { + shadowBarAttr = Ext.apply({}, shadowAttributes[shadowIndex]); + shadow = shadowGroups[shadowIndex].getAt(stacked ? j : i); + Ext.copyTo(shadowBarAttr, barAttr, 'x,y,width,height'); + if (!shadow) { + shadow = surface.add(Ext.apply({ + type: 'rect', + group: shadowGroups[shadowIndex] + }, Ext.apply({}, baseAttrs, shadowBarAttr))); + } + if (stacked) { + totalDim = items[i].totalDim; + totalNegDim = items[i].totalNegDim; + if (column) { + shadowBarAttr.y = zero - totalNegDim; + shadowBarAttr.height = totalDim; + } + else { + shadowBarAttr.x = zero - totalNegDim; + shadowBarAttr.width = totalDim; + } + } + if (animate) { + if (!stacked) { + rendererAttributes = me.renderer(shadow, store.getAt(j), shadowBarAttr, i, store); + me.onAnimate(shadow, { to: rendererAttributes }); + } + else { + rendererAttributes = me.renderer(shadow, store.getAt(j), Ext.apply(shadowBarAttr, { hidden: true }), i, store); + shadow.setAttributes(rendererAttributes, true); + } + } + else { + rendererAttributes = me.renderer(shadow, store.getAt(j), Ext.apply(shadowBarAttr, { hidden: false }), i, store); + shadow.setAttributes(rendererAttributes, true); + } + shadows.push(shadow); + } + } + return shadows; }, /** - * Adds {@link Ext.Component Component}(s) to this Container. - * Description : - * - * Fires the {@link #beforeadd} event before adding - * The Container's {@link #defaults default config values} will be applied - * accordingly (see {@link #defaults} for details). - * Fires the {@link #add} event after the component has been added. - * - * Notes : - * - * If the Container is already rendered when add - * is called, you may need to call {@link #doLayout} to refresh the view which causes - * any unrendered child Components to be rendered. This is required so that you can - * add multiple child components if needed while only refreshing the layout - * once. For example: -var tb = new {@link Ext.Toolbar}(); -tb.render(document.body); // toolbar is rendered -tb.add({text:'Button 1'}); // add multiple items ({@link #defaultType} for {@link Ext.Toolbar Toolbar} is 'button') -tb.add({text:'Button 2'}); -tb.{@link #doLayout}(); // refresh the layout - * - * Warning: Containers directly managed by the BorderLayout layout manager - * may not be removed or added. See the Notes for {@link Ext.layout.BorderLayout BorderLayout} - * for more details. - * - * @param {...Object/Array} component - * Either one or more Components to add or an Array of Components to add. See - * {@link #items} for additional information. - * @return {Ext.Component/Array} The Components that were added. + * Draws the series for the current chart. */ - add : function(comp){ - this.initItems(); - var args = arguments.length > 1; - if(args || Ext.isArray(comp)){ - var result = []; - Ext.each(args ? arguments : comp, function(c){ - result.push(this.add(c)); - }, this); - return result; + drawSeries: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + surface = chart.surface, + animate = chart.animate, + stacked = me.stacked, + column = me.column, + enableShadows = chart.shadow, + shadowGroups = me.shadowGroups, + shadowGroupsLn = shadowGroups.length, + group = me.group, + seriesStyle = me.seriesStyle, + items, ln, i, j, baseAttrs, sprite, rendererAttributes, shadowIndex, shadowGroup, + bounds, endSeriesStyle, barAttr, attrs, anim; + + if (!store || !store.getCount()) { + return; } - var c = this.lookupComponent(this.applyDefaults(comp)); - var index = this.items.length; - if(this.fireEvent('beforeadd', this, c, index) !== false && this.onBeforeAdd(c) !== false){ - this.items.add(c); - // *onAdded - c.onAdded(this, index); - this.onAdd(c); - this.fireEvent('add', this, c, index); + + //fill colors are taken from the colors array. + delete seriesStyle.fill; + endSeriesStyle = Ext.apply(seriesStyle, this.style); + me.unHighlightItem(); + me.cleanHighlights(); + + me.getPaths(); + bounds = me.bounds; + items = me.items; + + baseAttrs = column ? { + y: bounds.zero, + height: 0 + } : { + x: bounds.zero, + width: 0 + }; + ln = items.length; + // Create new or reuse sprites and animate/display + for (i = 0; i < ln; i++) { + sprite = group.getAt(i); + barAttr = items[i].attr; + + if (enableShadows) { + items[i].shadows = me.renderShadows(i, barAttr, baseAttrs, bounds); + } + + // Create a new sprite if needed (no height) + if (!sprite) { + attrs = Ext.apply({}, baseAttrs, barAttr); + attrs = Ext.apply(attrs, endSeriesStyle || {}); + sprite = surface.add(Ext.apply({}, { + type: 'rect', + group: group + }, attrs)); + } + if (animate) { + rendererAttributes = me.renderer(sprite, store.getAt(i), barAttr, i, store); + sprite._to = rendererAttributes; + anim = me.onAnimate(sprite, { to: Ext.apply(rendererAttributes, endSeriesStyle) }); + if (enableShadows && stacked && (i % bounds.barsLen === 0)) { + j = i / bounds.barsLen; + for (shadowIndex = 0; shadowIndex < shadowGroupsLn; shadowIndex++) { + anim.on('afteranimate', function() { + this.show(true); + }, shadowGroups[shadowIndex].getAt(j)); + } + } + } + else { + rendererAttributes = me.renderer(sprite, store.getAt(i), Ext.apply(barAttr, { hidden: false }), i, store); + sprite.setAttributes(Ext.apply(rendererAttributes, endSeriesStyle), true); + } + items[i].sprite = sprite; } - return c; - }, - onAdd : function(c){ - // Empty template method + // Hide unused sprites + ln = group.getCount(); + for (j = i; j < ln; j++) { + group.getAt(j).hide(true); + } + // Hide unused shadows + if (enableShadows) { + for (shadowIndex = 0; shadowIndex < shadowGroupsLn; shadowIndex++) { + shadowGroup = shadowGroups[shadowIndex]; + ln = shadowGroup.getCount(); + for (j = i; j < ln; j++) { + shadowGroup.getAt(j).hide(true); + } + } + } + me.renderLabels(); }, - - // private - onAdded : function(container, pos) { - //overridden here so we can cascade down, not worth creating a template method. - this.ownerCt = container; - this.initRef(); - //initialize references for child items - this.cascade(function(c){ - c.initRef(); - }); - this.fireEvent('added', this, container, pos); + + // @private handled when creating a label. + onCreateLabel: function(storeItem, item, i, display) { + var me = this, + surface = me.chart.surface, + group = me.labelsGroup, + config = me.label, + endLabelStyle = Ext.apply({}, config, me.seriesLabelStyle || {}), + sprite; + return surface.add(Ext.apply({ + type: 'text', + group: group + }, endLabelStyle || {})); }, + + // @private callback used when placing a label. + onPlaceLabel: function(label, storeItem, item, i, display, animate, j, index) { + // Determine the label's final position. Starts with the configured preferred value but + // may get flipped from inside to outside or vice-versa depending on space. + var me = this, + opt = me.bounds, + groupBarWidth = opt.groupBarWidth, + column = me.column, + chart = me.chart, + chartBBox = chart.chartBBox, + resizing = chart.resizing, + xValue = item.value[0], + yValue = item.value[1], + attr = item.attr, + config = me.label, + rotate = config.orientation == 'vertical', + field = [].concat(config.field), + format = config.renderer, + text = format(storeItem.get(field[index])), + size = me.getLabelSize(text), + width = size.width, + height = size.height, + zero = opt.zero, + outside = 'outside', + insideStart = 'insideStart', + insideEnd = 'insideEnd', + offsetX = 10, + offsetY = 6, + signed = opt.signed, + x, y, finalAttr; + + label.setAttributes({ + text: text + }); - /** - * Inserts a Component into this Container at a specified index. Fires the - * {@link #beforeadd} event before inserting, then fires the {@link #add} event after the - * Component has been inserted. - * @param {Number} index The index at which the Component will be inserted - * into the Container's items collection - * @param {Ext.Component} component The child Component to insert. - * Ext uses lazy rendering, and will only render the inserted Component should - * it become necessary. - * A Component config object may be passed in order to avoid the overhead of - * constructing a real Component object if lazy rendering might mean that the - * inserted Component will not be rendered immediately. To take advantage of - * this 'lazy instantiation', set the {@link Ext.Component#xtype} config - * property to the registered type of the Component wanted. - * For a list of all available xtypes, see {@link Ext.Component}. - * @return {Ext.Component} component The Component (or config object) that was - * inserted with the Container's default config values applied. - */ - insert : function(index, comp){ - this.initItems(); - var a = arguments, len = a.length; - if(len > 2){ - var result = []; - for(var i = len-1; i >= 1; --i) { - result.push(this.insert(index, a[i])); + if (column) { + if (display == outside) { + if (height + offsetY + attr.height > (yValue >= 0 ? zero - chartBBox.y : chartBBox.y + chartBBox.height - zero)) { + display = insideEnd; + } + } else { + if (height + offsetY > attr.height) { + display = outside; + } } - return result; + x = attr.x + groupBarWidth / 2; + y = display == insideStart ? + (zero + ((height / 2 + 3) * (yValue >= 0 ? -1 : 1))) : + (yValue >= 0 ? (attr.y + ((height / 2 + 3) * (display == outside ? -1 : 1))) : + (attr.y + attr.height + ((height / 2 + 3) * (display === outside ? 1 : -1)))); + } + else { + if (display == outside) { + if (width + offsetX + attr.width > (yValue >= 0 ? chartBBox.x + chartBBox.width - zero : zero - chartBBox.x)) { + display = insideEnd; + } + } + else { + if (width + offsetX > attr.width) { + display = outside; + } + } + x = display == insideStart ? + (zero + ((width / 2 + 5) * (yValue >= 0 ? 1 : -1))) : + (yValue >= 0 ? (attr.x + attr.width + ((width / 2 + 5) * (display === outside ? 1 : -1))) : + (attr.x + ((width / 2 + 5) * (display === outside ? -1 : 1)))); + y = attr.y + groupBarWidth / 2; } - var c = this.lookupComponent(this.applyDefaults(comp)); - index = Math.min(index, this.items.length); - if(this.fireEvent('beforeadd', this, c, index) !== false && this.onBeforeAdd(c) !== false){ - if(c.ownerCt == this){ - this.items.remove(c); + //set position + finalAttr = { + x: x, + y: y + }; + //rotate + if (rotate) { + finalAttr.rotate = { + x: x, + y: y, + degrees: 270 + }; + } + //check for resizing + if (animate && resizing) { + if (column) { + x = attr.x + attr.width / 2; + y = zero; + } else { + x = zero; + y = attr.y + attr.height / 2; + } + label.setAttributes({ + x: x, + y: y + }, true); + if (rotate) { + label.setAttributes({ + rotate: { + x: x, + y: y, + degrees: 270 + } + }, true); } - this.items.insert(index, c); - c.onAdded(this, index); - this.onAdd(c); - this.fireEvent('add', this, c, index); } - return c; + //handle animation + if (animate) { + me.onAnimate(label, { to: finalAttr }); + } + else { + label.setAttributes(Ext.apply(finalAttr, { + hidden: false + }), true); + } + }, + + /* @private + * Gets the dimensions of a given bar label. Uses a single hidden sprite to avoid + * changing visible sprites. + * @param value + */ + getLabelSize: function(value) { + var tester = this.testerLabel, + config = this.label, + endLabelStyle = Ext.apply({}, config, this.seriesLabelStyle || {}), + rotated = config.orientation === 'vertical', + bbox, w, h, + undef; + if (!tester) { + tester = this.testerLabel = this.chart.surface.add(Ext.apply({ + type: 'text', + opacity: 0 + }, endLabelStyle)); + } + tester.setAttributes({ + text: value + }, true); + + // Flip the width/height if rotated, as getBBox returns the pre-rotated dimensions + bbox = tester.getBBox(); + w = bbox.width; + h = bbox.height; + return { + width: rotated ? h : w, + height: rotated ? w : h + }; }, - // private - applyDefaults : function(c){ - var d = this.defaults; - if(d){ - if(Ext.isFunction(d)){ - d = d.call(this, c); - } - if(Ext.isString(c)){ - c = Ext.ComponentMgr.get(c); - Ext.apply(c, d); - }else if(!c.events){ - Ext.applyIf(c, d); - }else{ - Ext.apply(c, d); - } - } - return c; - }, + // @private used to animate label, markers and other sprites. + onAnimate: function(sprite, attr) { + sprite.show(); + return this.callParent(arguments); + }, + + isItemInPoint: function(x, y, item) { + var bbox = item.sprite.getBBox(); + return bbox.x <= x && bbox.y <= y + && (bbox.x + bbox.width) >= x + && (bbox.y + bbox.height) >= y; + }, + + // @private hide all markers + hideAll: function() { + var axes = this.chart.axes; + if (!isNaN(this._index)) { + if (!this.__excludes) { + this.__excludes = []; + } + this.__excludes[this._index] = true; + this.drawSeries(); + axes.each(function(axis) { + axis.drawAxis(); + }); + } + }, + + // @private show all markers + showAll: function() { + var axes = this.chart.axes; + if (!isNaN(this._index)) { + if (!this.__excludes) { + this.__excludes = []; + } + this.__excludes[this._index] = false; + this.drawSeries(); + axes.each(function(axis) { + axis.drawAxis(); + }); + } + }, + + /** + * Returns a string with the color to be used for the series legend item. + * @param index + */ + getLegendColor: function(index) { + var me = this; + return me.colorArrayStyle[index % me.colorArrayStyle.length]; + } +}); +/** + * @class Ext.chart.series.Column + * @extends Ext.chart.series.Bar + * + * Creates a Column Chart. Much of the methods are inherited from Bar. A Column Chart is a useful visualization technique to display quantitative information for different + * categories that can show some progression (or regression) in the data set. + * As with all other series, the Column Series must be appended in the *series* Chart array configuration. See the Chart + * documentation for more information. A typical configuration object for the column series could be: + * + * {@img Ext.chart.series.Column/Ext.chart.series.Column.png Ext.chart.series.Column chart series} + * + * ## Example + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * animate: true, + * store: store, + * axes: [{ + * type: 'Numeric', + * position: 'bottom', + * fields: ['data1'], + * label: { + * renderer: Ext.util.Format.numberRenderer('0,0') + * }, + * title: 'Sample Values', + * grid: true, + * minimum: 0 + * }, { + * type: 'Category', + * position: 'left', + * fields: ['name'], + * title: 'Sample Metrics' + * }], + * axes: [{ + * type: 'Numeric', + * position: 'left', + * fields: ['data1'], + * label: { + * renderer: Ext.util.Format.numberRenderer('0,0') + * }, + * title: 'Sample Values', + * grid: true, + * minimum: 0 + * }, { + * type: 'Category', + * position: 'bottom', + * fields: ['name'], + * title: 'Sample Metrics' + * }], + * series: [{ + * type: 'column', + * axis: 'left', + * highlight: true, + * tips: { + * trackMouse: true, + * width: 140, + * height: 28, + * renderer: function(storeItem, item) { + * this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' $'); + * } + * }, + * label: { + * display: 'insideEnd', + * 'text-anchor': 'middle', + * field: 'data1', + * renderer: Ext.util.Format.numberRenderer('0'), + * orientation: 'vertical', + * color: '#333' + * }, + * xField: 'name', + * yField: 'data1' + * }] + * }); + * + * In this configuration we set `column` as the series type, bind the values of the bars to the bottom axis, set `highlight` to true so that bars are smoothly highlighted + * when hovered and bind the `xField` or category field to the data store `name` property and the `yField` as the data1 property of a store element. + */ +Ext.define('Ext.chart.series.Column', { + + /* Begin Definitions */ + + alternateClassName: ['Ext.chart.ColumnSeries', 'Ext.chart.ColumnChart', 'Ext.chart.StackedColumnChart'], + + extend: 'Ext.chart.series.Bar', + + /* End Definitions */ + + type: 'column', + alias: 'series.column', + + column: true, + + /** + * @cfg {Number} xPadding + * Padding between the left/right axes and the bars + */ + xPadding: 10, + + /** + * @cfg {Number} yPadding + * Padding between the top/bottom axes and the bars + */ + yPadding: 0 +}); +/** + * @class Ext.chart.series.Gauge + * @extends Ext.chart.series.Series + * + * Creates a Gauge Chart. Gauge Charts are used to show progress in a certain variable. There are two ways of using the Gauge chart. + * One is setting a store element into the Gauge and selecting the field to be used from that store. Another one is instanciating the + * visualization and using the `setValue` method to adjust the value you want. + * + * A chart/series configuration for the Gauge visualization could look like this: + * + * { + * xtype: 'chart', + * store: store, + * axes: [{ + * type: 'gauge', + * position: 'gauge', + * minimum: 0, + * maximum: 100, + * steps: 10, + * margin: -10 + * }], + * series: [{ + * type: 'gauge', + * field: 'data1', + * donut: false, + * colorSet: ['#F49D10', '#ddd'] + * }] + * } + * + * In this configuration we create a special Gauge axis to be used with the gauge visualization (describing half-circle markers), and also we're + * setting a maximum, minimum and steps configuration options into the axis. The Gauge series configuration contains the store field to be bound to + * the visual display and the color set to be used with the visualization. + * + * @xtype gauge + */ +Ext.define('Ext.chart.series.Gauge', { + + /* Begin Definitions */ + + extend: 'Ext.chart.series.Series', - // private - onBeforeAdd : function(item){ - if(item.ownerCt){ - item.ownerCt.remove(item, false); - } - if(this.hideBorders === true){ - item.border = (item.border === true); - } - }, + /* End Definitions */ + + type: "gauge", + alias: 'series.gauge', + + rad: Math.PI / 180, /** - * Removes a component from this container. Fires the {@link #beforeremove} event before removing, then fires - * the {@link #remove} event after the component has been removed. - * @param {Component/String} component The component reference or id to remove. - * @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function. - * Defaults to the value of this Container's {@link #autoDestroy} config. - * @return {Ext.Component} component The Component that was removed. + * @cfg {Number} highlightDuration + * The duration for the pie slice highlight effect. */ - remove : function(comp, autoDestroy){ - this.initItems(); - var c = this.getComponent(comp); - if(c && this.fireEvent('beforeremove', this, c) !== false){ - this.doRemove(c, autoDestroy); - this.fireEvent('remove', this, c); - } - return c; - }, - - onRemove: function(c){ - // Empty template method - }, + highlightDuration: 150, - // private - doRemove: function(c, autoDestroy){ - var l = this.layout, - hasLayout = l && this.rendered; + /** + * @cfg {String} angleField + * The store record field name to be used for the pie angles. + * The values bound to this field name must be positive real numbers. + * This parameter is required. + */ + angleField: false, - if(hasLayout){ - l.onRemove(c); - } - this.items.remove(c); - c.onRemoved(); - this.onRemove(c); - if(autoDestroy === true || (autoDestroy !== false && this.autoDestroy)){ - c.destroy(); - } - if(hasLayout){ - l.afterRemove(c); - } - }, + /** + * @cfg {Boolean} needle + * Use the Gauge Series as an area series or add a needle to it. Default's false. + */ + needle: false, + + /** + * @cfg {Boolean|Number} donut + * Use the entire disk or just a fraction of it for the gauge. Default's false. + */ + donut: false, /** - * Removes all components from this container. - * @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function. - * Defaults to the value of this Container's {@link #autoDestroy} config. - * @return {Array} Array of the destroyed components + * @cfg {Boolean} showInLegend + * Whether to add the pie chart elements as legend items. Default's false. */ - removeAll: function(autoDestroy){ - this.initItems(); - var item, rem = [], items = []; - this.items.each(function(i){ - rem.push(i); - }); - for (var i = 0, len = rem.length; i < len; ++i){ - item = rem[i]; - this.remove(item, autoDestroy); - if(item.ownerCt !== this){ - items.push(item); - } - } - return items; - }, + showInLegend: false, /** - * Examines this container's {@link #items} property - * and gets a direct child component of this container. - * @param {String/Number} comp 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 #items} property - * - * For additional information see {@link Ext.util.MixedCollection#get}. - * @return Ext.Component The component (if found). + * @cfg {Object} style + * An object containing styles for overriding series styles from Theming. */ - getComponent : function(comp){ - if(Ext.isObject(comp)){ - comp = comp.getItemId(); + style: {}, + + constructor: function(config) { + this.callParent(arguments); + var me = this, + chart = me.chart, + surface = chart.surface, + store = chart.store, + shadow = chart.shadow, i, l, cfg; + Ext.apply(me, config, { + shadowAttributes: [{ + "stroke-width": 6, + "stroke-opacity": 1, + stroke: 'rgb(200, 200, 200)', + translate: { + x: 1.2, + y: 2 + } + }, + { + "stroke-width": 4, + "stroke-opacity": 1, + stroke: 'rgb(150, 150, 150)', + translate: { + x: 0.9, + y: 1.5 + } + }, + { + "stroke-width": 2, + "stroke-opacity": 1, + stroke: 'rgb(100, 100, 100)', + translate: { + x: 0.6, + y: 1 + } + }] + }); + me.group = surface.getGroup(me.seriesId); + if (shadow) { + for (i = 0, l = me.shadowAttributes.length; i < l; i++) { + me.shadowGroups.push(surface.getGroup(me.seriesId + '-shadows' + i)); + } } - return this.items.get(comp); + surface.customAttributes.segment = function(opt) { + return me.getSegment(opt); + }; }, - - // private - lookupComponent : function(comp){ - if(Ext.isString(comp)){ - return Ext.ComponentMgr.get(comp); - }else if(!comp.events){ - return this.createComponent(comp); + + //@private updates some onbefore render parameters. + initialize: function() { + var me = this, + store = me.chart.substore || me.chart.store; + //Add yFields to be used in Legend.js + me.yField = []; + if (me.label.field) { + store.each(function(rec) { + me.yField.push(rec.get(me.label.field)); + }); } - return comp; }, - // private - createComponent : function(config, defaultType){ - if (config.render) { - return config; + // @private returns an object with properties for a Slice + getSegment: function(opt) { + var me = this, + rad = me.rad, + cos = Math.cos, + sin = Math.sin, + abs = Math.abs, + x = me.centerX, + y = me.centerY, + x1 = 0, x2 = 0, x3 = 0, x4 = 0, + y1 = 0, y2 = 0, y3 = 0, y4 = 0, + delta = 1e-2, + r = opt.endRho - opt.startRho, + startAngle = opt.startAngle, + endAngle = opt.endAngle, + midAngle = (startAngle + endAngle) / 2 * rad, + margin = opt.margin || 0, + flag = abs(endAngle - startAngle) > 180, + a1 = Math.min(startAngle, endAngle) * rad, + a2 = Math.max(startAngle, endAngle) * rad, + singleSlice = false; + + x += margin * cos(midAngle); + y += margin * sin(midAngle); + + x1 = x + opt.startRho * cos(a1); + y1 = y + opt.startRho * sin(a1); + + x2 = x + opt.endRho * cos(a1); + y2 = y + opt.endRho * sin(a1); + + x3 = x + opt.startRho * cos(a2); + y3 = y + opt.startRho * sin(a2); + + x4 = x + opt.endRho * cos(a2); + y4 = y + opt.endRho * sin(a2); + + if (abs(x1 - x3) <= delta && abs(y1 - y3) <= delta) { + singleSlice = true; + } + //Solves mysterious clipping bug with IE + if (singleSlice) { + return { + path: [ + ["M", x1, y1], + ["L", x2, y2], + ["A", opt.endRho, opt.endRho, 0, +flag, 1, x4, y4], + ["Z"]] + }; + } else { + return { + path: [ + ["M", x1, y1], + ["L", x2, y2], + ["A", opt.endRho, opt.endRho, 0, +flag, 1, x4, y4], + ["L", x3, y3], + ["A", opt.startRho, opt.startRho, 0, +flag, 0, x1, y1], + ["Z"]] + }; } - // add in ownerCt at creation time but then immediately - // remove so that onBeforeAdd can handle it - var c = Ext.create(Ext.apply({ - ownerCt: this - }, config), defaultType || this.defaultType); - delete c.initialConfig.ownerCt; - delete c.ownerCt; - return c; }, - /** - * @private - * We can only lay out if there is a view area in which to layout. - * display:none on the layout target, *or any of its parent elements* will mean it has no view area. - */ - canLayout : function() { - var el = this.getVisibilityEl(); - return el && el.dom && !el.isStyle("display", "none"); + // @private utility function to calculate the middle point of a pie slice. + calcMiddle: function(item) { + var me = this, + rad = me.rad, + slice = item.slice, + x = me.centerX, + y = me.centerY, + startAngle = slice.startAngle, + endAngle = slice.endAngle, + radius = Math.max(('rho' in slice) ? slice.rho: me.radius, me.label.minMargin), + donut = +me.donut, + a1 = Math.min(startAngle, endAngle) * rad, + a2 = Math.max(startAngle, endAngle) * rad, + midAngle = -(a1 + (a2 - a1) / 2), + xm = x + (item.endRho + item.startRho) / 2 * Math.cos(midAngle), + ym = y - (item.endRho + item.startRho) / 2 * Math.sin(midAngle); + + item.middle = { + x: xm, + y: ym + }; }, /** - * Force this container's layout to be recalculated. A call to this function is required after adding a new component - * to an already rendered container, or possibly after changing sizing/position properties of child components. - * @param {Boolean} shallow (optional) True to only calc the layout of this component, and let child components auto - * calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer) - * @param {Boolean} force (optional) True to force a layout to occur, even if the item is hidden. - * @return {Ext.Container} this + * Draws the series for the current chart. */ + drawSeries: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + group = me.group, + animate = me.chart.animate, + axis = me.chart.axes.get(0), + minimum = axis && axis.minimum || me.minimum || 0, + maximum = axis && axis.maximum || me.maximum || 0, + field = me.angleField || me.field || me.xField, + surface = chart.surface, + chartBBox = chart.chartBBox, + rad = me.rad, + donut = +me.donut, + values = {}, + items = [], + seriesStyle = me.seriesStyle, + seriesLabelStyle = me.seriesLabelStyle, + colorArrayStyle = me.colorArrayStyle, + colorArrayLength = colorArrayStyle && colorArrayStyle.length || 0, + gutterX = chart.maxGutter[0], + gutterY = chart.maxGutter[1], + cos = Math.cos, + sin = Math.sin, + rendererAttributes, centerX, centerY, slice, slices, sprite, value, + item, ln, record, i, j, startAngle, endAngle, middleAngle, sliceLength, path, + p, spriteOptions, bbox, splitAngle, sliceA, sliceB; + + Ext.apply(seriesStyle, me.style || {}); - doLayout : function(shallow, force){ - var rendered = this.rendered, - forceLayout = force || this.forceLayout; + me.setBBox(); + bbox = me.bbox; - if(this.collapsed || !this.canLayout()){ - this.deferLayout = this.deferLayout || !shallow; - if(!forceLayout){ - return; - } - shallow = shallow && !this.deferLayout; + //override theme colors + if (me.colorSet) { + colorArrayStyle = me.colorSet; + colorArrayLength = colorArrayStyle.length; + } + + //if not store or store is empty then there's nothing to draw + if (!store || !store.getCount()) { + return; + } + + centerX = me.centerX = chartBBox.x + (chartBBox.width / 2); + centerY = me.centerY = chartBBox.y + chartBBox.height; + me.radius = Math.min(centerX - chartBBox.x, centerY - chartBBox.y); + me.slices = slices = []; + me.items = items = []; + + if (!me.value) { + record = store.getAt(0); + me.value = record.get(field); + } + + value = me.value; + if (me.needle) { + sliceA = { + series: me, + value: value, + startAngle: -180, + endAngle: 0, + rho: me.radius + }; + splitAngle = -180 * (1 - (value - minimum) / (maximum - minimum)); + slices.push(sliceA); } else { - delete this.deferLayout; + splitAngle = -180 * (1 - (value - minimum) / (maximum - minimum)); + sliceA = { + series: me, + value: value, + startAngle: -180, + endAngle: splitAngle, + rho: me.radius + }; + sliceB = { + series: me, + value: me.maximum - value, + startAngle: splitAngle, + endAngle: 0, + rho: me.radius + }; + slices.push(sliceA, sliceB); } - if(rendered && this.layout){ - this.layout.layout(); + + //do pie slices after. + for (i = 0, ln = slices.length; i < ln; i++) { + slice = slices[i]; + sprite = group.getAt(i); + //set pie slice properties + rendererAttributes = Ext.apply({ + segment: { + startAngle: slice.startAngle, + endAngle: slice.endAngle, + margin: 0, + rho: slice.rho, + startRho: slice.rho * +donut / 100, + endRho: slice.rho + } + }, Ext.apply(seriesStyle, colorArrayStyle && { fill: colorArrayStyle[i % colorArrayLength] } || {})); + + item = Ext.apply({}, + rendererAttributes.segment, { + slice: slice, + series: me, + storeItem: record, + index: i + }); + items[i] = item; + // Create a new sprite if needed (no height) + if (!sprite) { + spriteOptions = Ext.apply({ + type: "path", + group: group + }, Ext.apply(seriesStyle, colorArrayStyle && { fill: colorArrayStyle[i % colorArrayLength] } || {})); + sprite = surface.add(Ext.apply(spriteOptions, rendererAttributes)); + } + slice.sprite = slice.sprite || []; + item.sprite = sprite; + slice.sprite.push(sprite); + if (animate) { + rendererAttributes = me.renderer(sprite, record, rendererAttributes, i, store); + sprite._to = rendererAttributes; + me.onAnimate(sprite, { + to: rendererAttributes + }); + } else { + rendererAttributes = me.renderer(sprite, record, Ext.apply(rendererAttributes, { + hidden: false + }), i, store); + sprite.setAttributes(rendererAttributes, true); + } } - if(shallow !== true && this.items){ - var cs = this.items.items; - for(var i = 0, len = cs.length; i < len; i++){ - var c = cs[i]; - if(c.doLayout){ - c.doLayout(false, forceLayout); + + if (me.needle) { + splitAngle = splitAngle * Math.PI / 180; + + if (!me.needleSprite) { + me.needleSprite = me.chart.surface.add({ + type: 'path', + path: ['M', centerX + (me.radius * +donut / 100) * cos(splitAngle), + centerY + -Math.abs((me.radius * +donut / 100) * sin(splitAngle)), + 'L', centerX + me.radius * cos(splitAngle), + centerY + -Math.abs(me.radius * sin(splitAngle))], + 'stroke-width': 4, + 'stroke': '#222' + }); + } else { + if (animate) { + me.onAnimate(me.needleSprite, { + to: { + path: ['M', centerX + (me.radius * +donut / 100) * cos(splitAngle), + centerY + -Math.abs((me.radius * +donut / 100) * sin(splitAngle)), + 'L', centerX + me.radius * cos(splitAngle), + centerY + -Math.abs(me.radius * sin(splitAngle))] + } + }); + } else { + me.needleSprite.setAttributes({ + type: 'path', + path: ['M', centerX + (me.radius * +donut / 100) * cos(splitAngle), + centerY + -Math.abs((me.radius * +donut / 100) * sin(splitAngle)), + 'L', centerX + me.radius * cos(splitAngle), + centerY + -Math.abs(me.radius * sin(splitAngle))] + }); } } + me.needleSprite.setAttributes({ + hidden: false + }, true); } - if(rendered){ - this.onLayout(shallow, forceLayout); - } - // Initial layout completed - this.hasLayout = true; - delete this.forceLayout; + + delete me.value; + }, + + /** + * Sets the Gauge chart to the current specified value. + */ + setValue: function (value) { + this.value = value; + this.drawSeries(); }, - onLayout : Ext.emptyFn, + // @private callback for when creating a label sprite. + onCreateLabel: function(storeItem, item, i, display) {}, - // private - shouldBufferLayout: function(){ - /* - * Returns true if the container should buffer a layout. - * This is true only if the container has previously been laid out - * and has a parent container that is pending a layout. - */ - var hl = this.hasLayout; - if(this.ownerCt){ - // Only ever buffer if we've laid out the first time and we have one pending. - return hl ? !this.hasLayoutPending() : false; - } - // Never buffer initial layout - return hl; - }, + // @private callback for when placing a label sprite. + onPlaceLabel: function(label, storeItem, item, i, display, animate, index) {}, - // private - hasLayoutPending: function(){ - // Traverse hierarchy to see if any parent container has a pending layout. - var pending = false; - this.ownerCt.bubble(function(c){ - if(c.layoutPending){ - pending = true; - return false; - } - }); - return pending; - }, + // @private callback for when placing a callout. + onPlaceCallout: function() {}, - onShow : function(){ - // removes css classes that were added to hide - Ext.Container.superclass.onShow.call(this); - // If we were sized during the time we were hidden, layout. - if(Ext.isDefined(this.deferLayout)){ - delete this.deferLayout; - this.doLayout(true); - } + // @private handles sprite animation for the series. + onAnimate: function(sprite, attr) { + sprite.show(); + return this.callParent(arguments); }, - /** - * Returns the layout currently in use by the container. If the container does not currently have a layout - * set, a default {@link Ext.layout.ContainerLayout} will be created and set as the container's layout. - * @return {ContainerLayout} layout The container's layout - */ - getLayout : function(){ - if(!this.layout){ - var layout = new Ext.layout.AutoLayout(this.layoutConfig); - this.setLayout(layout); - } - return this.layout; + isItemInPoint: function(x, y, item, i) { + return false; }, - - // private - beforeDestroy : function(){ - var c; - if(this.items){ - while(c = this.items.first()){ - this.doRemove(c, true); - } - } - if(this.monitorResize){ - Ext.EventManager.removeResizeListener(this.doLayout, this); + + // @private shows all elements in the series. + showAll: function() { + if (!isNaN(this._index)) { + this.__excludes[this._index] = false; + this.drawSeries(); } - Ext.destroy(this.layout); - Ext.Container.superclass.beforeDestroy.call(this); }, - + /** - * Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of - * function call will be the scope provided or the current component. The arguments to the function - * will be the args provided or the current component. 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 of the function (defaults to current node) - * @param {Array} args (optional) The args to call the function with (default to passing the current component) - * @return {Ext.Container} this + * Returns the color of the series (to be displayed as color for the series legend item). + * @param item {Object} Info about the item; same format as returned by #getItemForPoint */ - bubble : function(fn, scope, args){ - var p = this; - while(p){ - if(fn.apply(scope || p, args || [p]) === false){ - break; - } - p = p.ownerCt; - } - return this; - }, + getLegendColor: function(index) { + var me = this; + return me.colorArrayStyle[index % me.colorArrayStyle.length]; + } +}); - /** - * Cascades down the component/container heirarchy from this component (called first), calling the specified function with - * each component. The scope (this) of - * function call will be the scope provided or the current component. The arguments to the function - * will be the args provided or the current component. 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 of the function (defaults to current component) - * @param {Array} args (optional) The args to call the function with (defaults to passing the current component) - * @return {Ext.Container} this - */ - cascade : function(fn, scope, args){ - if(fn.apply(scope || this, args || [this]) !== false){ - if(this.items){ - var cs = this.items.items; - for(var i = 0, len = cs.length; i < len; i++){ - if(cs[i].cascade){ - cs[i].cascade(fn, scope, args); - }else{ - fn.apply(scope || cs[i], args || [cs[i]]); - } - } - } - } - return this; - }, - /** - * Find a component under this container at any level by id - * @param {String} id - * @return Ext.Component - */ - findById : function(id){ - var m, ct = this; - this.cascade(function(c){ - if(ct != c && c.id === id){ - m = c; - return false; - } - }); - return m || null; - }, +/** + * @class Ext.chart.series.Line + * @extends Ext.chart.series.Cartesian + * + * Creates a Line Chart. A Line Chart is a useful visualization technique to display quantitative information for different + * categories or other real values (as opposed to the bar chart), that can show some progression (or regression) in the dataset. + * As with all other series, the Line Series must be appended in the *series* Chart array configuration. See the Chart + * documentation for more information. A typical configuration object for the line series could be: + * + * {@img Ext.chart.series.Line/Ext.chart.series.Line.png Ext.chart.series.Line chart series} + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * animate: true, + * store: store, + * axes: [{ + * type: 'Numeric', + * position: 'bottom', + * fields: ['data1'], + * label: { + * renderer: Ext.util.Format.numberRenderer('0,0') + * }, + * title: 'Sample Values', + * grid: true, + * minimum: 0 + * }, { + * type: 'Category', + * position: 'left', + * fields: ['name'], + * title: 'Sample Metrics' + * }], + * series: [{ + * type: 'line', + * highlight: { + * size: 7, + * radius: 7 + * }, + * axis: 'left', + * xField: 'name', + * yField: 'data1', + * markerCfg: { + * type: 'cross', + * size: 4, + * radius: 4, + * 'stroke-width': 0 + * } + * }, { + * type: 'line', + * highlight: { + * size: 7, + * radius: 7 + * }, + * axis: 'left', + * fill: true, + * xField: 'name', + * yField: 'data3', + * markerCfg: { + * type: 'circle', + * size: 4, + * radius: 4, + * 'stroke-width': 0 + * } + * }] + * }); + * + * In this configuration we're adding two series (or lines), one bound to the `data1` + * property of the store and the other to `data3`. The type for both configurations is + * `line`. The `xField` for both series is the same, the name propert of the store. + * Both line series share the same axis, the left axis. You can set particular marker + * configuration by adding properties onto the markerConfig object. Both series have + * an object as highlight so that markers animate smoothly to the properties in highlight + * when hovered. The second series has `fill=true` which means that the line will also + * have an area below it of the same color. + * + * **Note:** In the series definition remember to explicitly set the axis to bind the + * values of the line series to. This can be done by using the `axis` configuration property. + */ +Ext.define('Ext.chart.series.Line', { + + /* Begin Definitions */ + + extend: 'Ext.chart.series.Cartesian', + + alternateClassName: ['Ext.chart.LineSeries', 'Ext.chart.LineChart'], + requires: ['Ext.chart.axis.Axis', 'Ext.chart.Shape', 'Ext.draw.Draw', 'Ext.fx.Anim'], + + /* End Definitions */ + + type: 'line', + + alias: 'series.line', + /** - * Find a component under this container at any level by xtype or class - * @param {String/Class} xtype The xtype string for a component, or the class of the component directly - * @param {Boolean} shallow (optional) False to check whether this Component is descended from the xtype (this is - * the default), or true to check whether this Component is directly of the specified xtype. - * @return {Array} Array of Ext.Components + * @cfg {String} axis + * The position of the axis to bind the values to. Possible values are 'left', 'bottom', 'top' and 'right'. + * You must explicitly set this value to bind the values of the line series to the ones in the axis, otherwise a + * relative scale will be used. */ - findByType : function(xtype, shallow){ - return this.findBy(function(c){ - return c.isXType(xtype, shallow); - }); - }, /** - * Find a component under this container at any level by property - * @param {String} prop - * @param {String} value - * @return {Array} Array of Ext.Components + * @cfg {Number} selectionTolerance + * The offset distance from the cursor position to the line series to trigger events (then used for highlighting series, etc). */ - find : function(prop, value){ - return this.findBy(function(c){ - return c[prop] === value; - }); - }, - + selectionTolerance: 20, + /** - * Find a component under this container at any level by a custom function. If the passed function returns - * true, the component will be included in the results. The passed function is called with the arguments (component, this container). - * @param {Function} fn The function to call - * @param {Object} scope (optional) - * @return {Array} Array of Ext.Components + * @cfg {Boolean} showMarkers + * Whether markers should be displayed at the data points along the line. If true, + * then the {@link #markerConfig} config item will determine the markers' styling. */ - findBy : function(fn, scope){ - var m = [], ct = this; - this.cascade(function(c){ - if(ct != c && fn.call(scope || c, c, ct) === true){ - m.push(c); - } - }); - return m; - }, + showMarkers: true, /** - * Get a component contained by this container (alias for items.get(key)) - * @param {String/Number} key The index or id of the component - * @return {Ext.Component} Ext.Component + * @cfg {Object} markerConfig + * The display style for the markers. Only used if {@link #showMarkers} is true. + * The markerConfig is a configuration object containing the same set of properties defined in + * the Sprite class. For example, if we were to set red circles as markers to the line series we could + * pass the object: + * + + markerConfig: { + type: 'circle', + radius: 4, + 'fill': '#f00' + } + + */ - get : function(key){ - return this.items.get(key); - } -}); + markerConfig: {}, -Ext.Container.LAYOUTS = {}; -Ext.reg('container', Ext.Container); -/** - * @class Ext.layout.ContainerLayout - * This class is intended to be extended or created via the {@link Ext.Container#layout layout} - * configuration property. See {@link Ext.Container#layout} for additional details. - */ -Ext.layout.ContainerLayout = Ext.extend(Object, { /** - * @cfg {String} extraCls - * An optional extra CSS class that will be added to the container. This can be useful for adding - * customized styles to the container or any of its children using standard CSS rules. See - * {@link Ext.Component}.{@link Ext.Component#ctCls ctCls} also. - * Note: extraCls defaults to '' except for the following classes - * which assign a value by default: - * - * {@link Ext.layout.AbsoluteLayout Absolute Layout} : 'x-abs-layout-item' - * {@link Ext.layout.Box Box Layout} : 'x-box-item' - * {@link Ext.layout.ColumnLayout Column Layout} : 'x-column' - * - * To configure the above Classes with an extra CSS class append to the default. For example, - * for ColumnLayout: - * extraCls: 'x-column custom-class' - * - * + * @cfg {Object} style + * An object containing styles for the visualization lines. These styles will override the theme styles. + * Some options contained within the style object will are described next. */ + style: {}, + /** - * @cfg {Boolean} renderHidden - * True to hide each contained item on render (defaults to false). + * @cfg {Boolean} smooth + * If true, the line will be smoothed/rounded around its points, otherwise straight line + * segments will be drawn. Defaults to false. */ + smooth: false, /** - * A reference to the {@link Ext.Component} that is active. For example, - * if(myPanel.layout.activeItem.id == 'item-1') { ... } - * - * activeItem only applies to layout styles that can display items one at a time - * (like {@link Ext.layout.AccordionLayout}, {@link Ext.layout.CardLayout} - * and {@link Ext.layout.FitLayout}). Read-only. Related to {@link Ext.Container#activeItem}. - * @type {Ext.Component} - * @property activeItem + * @cfg {Boolean} fill + * If true, the area below the line will be filled in using the {@link #style.eefill} and + * {@link #style.opacity} config properties. Defaults to false. */ + fill: false, - // private - monitorResize:false, - // private - activeItem : null, - - constructor : function(config){ - this.id = Ext.id(null, 'ext-layout-'); - Ext.apply(this, config); - }, - - type: 'container', - - /* Workaround for how IE measures autoWidth elements. It prefers bottom-up measurements - whereas other browser prefer top-down. We will hide all target child elements before we measure and - put them back to get an accurate measurement. - */ - IEMeasureHack : function(target, viewFlag) { - var tChildren = target.dom.childNodes, tLen = tChildren.length, c, d = [], e, i, ret; - for (i = 0 ; i < tLen ; i++) { - c = tChildren[i]; - e = Ext.get(c); - if (e) { - d[i] = e.getStyle('display'); - e.setStyle({display: 'none'}); - } + constructor: function(config) { + this.callParent(arguments); + var me = this, + surface = me.chart.surface, + shadow = me.chart.shadow, + i, l; + Ext.apply(me, config, { + highlightCfg: { + 'stroke-width': 3 + }, + shadowAttributes: [{ + "stroke-width": 6, + "stroke-opacity": 0.05, + stroke: 'rgb(0, 0, 0)', + translate: { + x: 1, + y: 1 + } + }, { + "stroke-width": 4, + "stroke-opacity": 0.1, + stroke: 'rgb(0, 0, 0)', + translate: { + x: 1, + y: 1 + } + }, { + "stroke-width": 2, + "stroke-opacity": 0.15, + stroke: 'rgb(0, 0, 0)', + translate: { + x: 1, + y: 1 + } + }] + }); + me.group = surface.getGroup(me.seriesId); + if (me.showMarkers) { + me.markerGroup = surface.getGroup(me.seriesId + '-markers'); } - ret = target ? target.getViewSize(viewFlag) : {}; - for (i = 0 ; i < tLen ; i++) { - c = tChildren[i]; - e = Ext.get(c); - if (e) { - e.setStyle({display: d[i]}); + if (shadow) { + for (i = 0, l = this.shadowAttributes.length; i < l; i++) { + me.shadowGroups.push(surface.getGroup(me.seriesId + '-shadows' + i)); } } - return ret; - }, - - // Placeholder for the derived layouts - getLayoutTargetSize : Ext.EmptyFn, - - // private - layout : function(){ - var ct = this.container, target = ct.getLayoutTarget(); - if(!(this.hasLayout || Ext.isEmpty(this.targetCls))){ - target.addClass(this.targetCls); - } - this.onLayout(ct, target); - ct.fireEvent('afterlayout', ct, this); - }, - - // private - onLayout : function(ct, target){ - this.renderAll(ct, target); - }, - - // private - isValidParent : function(c, target){ - return target && c.getPositionEl().dom.parentNode == (target.dom || target); }, - - // private - renderAll : function(ct, target){ - var items = ct.items.items, i, c, len = items.length; - for(i = 0; i < len; i++) { - c = items[i]; - if(c && (!c.rendered || !this.isValidParent(c, target))){ - this.renderItem(c, i, target); + + // @private makes an average of points when there are more data points than pixels to be rendered. + shrink: function(xValues, yValues, size) { + // Start at the 2nd point... + var len = xValues.length, + ratio = Math.floor(len / size), + i = 1, + xSum = 0, + ySum = 0, + xRes = [xValues[0]], + yRes = [yValues[0]]; + + for (; i < len; ++i) { + xSum += xValues[i] || 0; + ySum += yValues[i] || 0; + if (i % ratio == 0) { + xRes.push(xSum/ratio); + yRes.push(ySum/ratio); + xSum = 0; + ySum = 0; } } + return { + x: xRes, + y: yRes + }; }, /** - * @private - * Renders the given Component into the target Element. If the Component is already rendered, - * it is moved to the provided target instead. - * @param {Ext.Component} c The Component to render - * @param {Number} position The position within the target to render the item to - * @param {Ext.Element} target The target Element + * Draws the series for the current chart. */ - renderItem : function(c, position, target){ - if (c) { - if (!c.rendered) { - c.render(target, position); - this.configureItem(c, position); - } else if (!this.isValidParent(c, target)) { - if (Ext.isNumber(position)) { - position = target.dom.childNodes[position]; + drawSeries: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + surface = chart.surface, + chartBBox = chart.chartBBox, + bbox = {}, + group = me.group, + gutterX = chart.maxGutter[0], + gutterY = chart.maxGutter[1], + showMarkers = me.showMarkers, + markerGroup = me.markerGroup, + enableShadows = chart.shadow, + shadowGroups = me.shadowGroups, + shadowAttributes = this.shadowAttributes, + lnsh = shadowGroups.length, + dummyPath = ["M"], + path = ["M"], + markerIndex = chart.markerIndex, + axes = [].concat(me.axis), + shadowGroup, + shadowBarAttr, + xValues = [], + yValues = [], + numericAxis = true, + axisCount = 0, + onbreak = false, + markerStyle = me.markerStyle, + seriesStyle = me.seriesStyle, + seriesLabelStyle = me.seriesLabelStyle, + colorArrayStyle = me.colorArrayStyle, + colorArrayLength = colorArrayStyle && colorArrayStyle.length || 0, + posHash = { + 'left': 'right', + 'right': 'left', + 'top': 'bottom', + 'bottom': 'top' + }, + seriesIdx = me.seriesIdx, shadows, shadow, shindex, fromPath, fill, fillPath, rendererAttributes, + x, y, prevX, prevY, firstY, markerCount, i, j, ln, axis, ends, marker, markerAux, item, xValue, + yValue, coords, xScale, yScale, minX, maxX, minY, maxY, line, animation, endMarkerStyle, + endLineStyle, type, props, firstMarker, count; + + //if store is empty then there's nothing to draw. + if (!store || !store.getCount()) { + return; + } + + //prepare style objects for line and markers + endMarkerStyle = Ext.apply(markerStyle, me.markerConfig); + type = endMarkerStyle.type; + delete endMarkerStyle.type; + endLineStyle = Ext.apply(seriesStyle, me.style); + //if no stroke with is specified force it to 0.5 because this is + //about making *lines* + if (!endLineStyle['stroke-width']) { + endLineStyle['stroke-width'] = 0.5; + } + //If we're using a time axis and we need to translate the points, + //then reuse the first markers as the last markers. + if (markerIndex && markerGroup && markerGroup.getCount()) { + for (i = 0; i < markerIndex; i++) { + marker = markerGroup.getAt(i); + markerGroup.remove(marker); + markerGroup.add(marker); + markerAux = markerGroup.getAt(markerGroup.getCount() - 2); + marker.setAttributes({ + x: 0, + y: 0, + translate: { + x: markerAux.attr.translation.x, + y: markerAux.attr.translation.y + } + }, true); + } + } + + me.unHighlightItem(); + me.cleanHighlights(); + + me.setBBox(); + bbox = me.bbox; + + me.clipRect = [bbox.x, bbox.y, bbox.width, bbox.height]; + + chart.axes.each(function(axis) { + //only apply position calculations to axes that affect this series + //this means the axis in the position referred by this series and also + //the axis in the other coordinate for this series. For example: (left, top|bottom), + //or (top, left|right), etc. + if (axis.position == me.axis || axis.position != posHash[me.axis]) { + axisCount++; + if (axis.type != 'Numeric') { + numericAxis = false; + return; + } + numericAxis = (numericAxis && axis.type == 'Numeric'); + if (axis) { + ends = axis.calcEnds(); + if (axis.position == 'top' || axis.position == 'bottom') { + minX = ends.from; + maxX = ends.to; + } + else { + minY = ends.from; + maxY = ends.to; + } } - - target.dom.insertBefore(c.getPositionEl().dom, position || null); - c.container = target; - this.configureItem(c, position); } + }); + + //If there's only one axis specified for a series, then we set the default type of the other + //axis to a category axis. So in this case numericAxis, which would be true if both axes affecting + //the series are numeric should be false. + if (numericAxis && axisCount == 1) { + numericAxis = false; } - }, - - // private. - // Get all rendered items to lay out. - getRenderedItems: function(ct){ - var t = ct.getLayoutTarget(), cti = ct.items.items, len = cti.length, i, c, items = []; - for (i = 0; i < len; i++) { - if((c = cti[i]).rendered && this.isValidParent(c, t)){ - items.push(c); + + // If a field was specified without a corresponding axis, create one to get bounds + //only do this for the axis where real values are bound (that's why we check for + //me.axis) + if (me.xField && !Ext.isNumber(minX)) { + if (me.axis == 'bottom' || me.axis == 'top') { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.xField) + }).calcEnds(); + minX = axis.from; + maxX = axis.to; + } else if (numericAxis) { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.xField), + forceMinMax: true + }).calcEnds(); + minX = axis.from; + maxX = axis.to; } - }; - return items; - }, - - /** - * @private - * Applies extraCls and hides the item if renderHidden is true - */ - configureItem: function(c, position){ - if (this.extraCls) { - var t = c.getPositionEl ? c.getPositionEl() : c; - t.addClass(this.extraCls); } - // If we are forcing a layout, do so *before* we hide so elements have height/width - if (c.doLayout && this.forceLayout) { - c.doLayout(); + if (me.yField && !Ext.isNumber(minY)) { + if (me.axis == 'right' || me.axis == 'left') { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.yField) + }).calcEnds(); + minY = axis.from; + maxY = axis.to; + } else if (numericAxis) { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.yField), + forceMinMax: true + }).calcEnds(); + minY = axis.from; + maxY = axis.to; + } } - if (this.renderHidden && c != this.activeItem) { - c.hide(); + + if (isNaN(minX)) { + minX = 0; + xScale = bbox.width / (store.getCount() - 1); + } + else { + xScale = bbox.width / (maxX - minX); } - }, - onRemove: function(c){ - if(this.activeItem == c){ - delete this.activeItem; + if (isNaN(minY)) { + minY = 0; + yScale = bbox.height / (store.getCount() - 1); + } + else { + yScale = bbox.height / (maxY - minY); + } + + store.each(function(record, i) { + xValue = record.get(me.xField); + yValue = record.get(me.yField); + //skip undefined values + if (typeof yValue == 'undefined' || (typeof yValue == 'string' && !yValue)) { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn("[Ext.chart.series.Line] Skipping a store element with an undefined value at ", record, xValue, yValue); + } + return; + } + // Ensure a value + if (typeof xValue == 'string' || typeof xValue == 'object' + //set as uniform distribution if the axis is a category axis. + || (me.axis != 'top' && me.axis != 'bottom' && !numericAxis)) { + xValue = i; + } + if (typeof yValue == 'string' || typeof yValue == 'object' + //set as uniform distribution if the axis is a category axis. + || (me.axis != 'left' && me.axis != 'right' && !numericAxis)) { + yValue = i; + } + xValues.push(xValue); + yValues.push(yValue); + }, me); + + ln = xValues.length; + if (ln > bbox.width) { + coords = me.shrink(xValues, yValues, bbox.width); + xValues = coords.x; + yValues = coords.y; + } + + me.items = []; + + count = 0; + ln = xValues.length; + for (i = 0; i < ln; i++) { + xValue = xValues[i]; + yValue = yValues[i]; + if (yValue === false) { + if (path.length == 1) { + path = []; + } + onbreak = true; + me.items.push(false); + continue; + } else { + x = (bbox.x + (xValue - minX) * xScale).toFixed(2); + y = ((bbox.y + bbox.height) - (yValue - minY) * yScale).toFixed(2); + if (onbreak) { + onbreak = false; + path.push('M'); + } + path = path.concat([x, y]); + } + if ((typeof firstY == 'undefined') && (typeof y != 'undefined')) { + firstY = y; + } + // If this is the first line, create a dummypath to animate in from. + if (!me.line || chart.resizing) { + dummyPath = dummyPath.concat([x, bbox.y + bbox.height / 2]); + } + + // When resizing, reset before animating + if (chart.animate && chart.resizing && me.line) { + me.line.setAttributes({ + path: dummyPath + }, true); + if (me.fillPath) { + me.fillPath.setAttributes({ + path: dummyPath, + opacity: 0.2 + }, true); + } + if (me.line.shadows) { + shadows = me.line.shadows; + for (j = 0, lnsh = shadows.length; j < lnsh; j++) { + shadow = shadows[j]; + shadow.setAttributes({ + path: dummyPath + }, true); + } + } + } + if (showMarkers) { + marker = markerGroup.getAt(count++); + if (!marker) { + marker = Ext.chart.Shape[type](surface, Ext.apply({ + group: [group, markerGroup], + x: 0, y: 0, + translate: { + x: prevX || x, + y: prevY || (bbox.y + bbox.height / 2) + }, + value: '"' + xValue + ', ' + yValue + '"' + }, endMarkerStyle)); + marker._to = { + translate: { + x: x, + y: y + } + }; + } else { + marker.setAttributes({ + value: '"' + xValue + ', ' + yValue + '"', + x: 0, y: 0, + hidden: false + }, true); + marker._to = { + translate: { + x: x, y: y + } + }; + } + } + me.items.push({ + series: me, + value: [xValue, yValue], + point: [x, y], + sprite: marker, + storeItem: store.getAt(i) + }); + prevX = x; + prevY = y; } - if(c.rendered && this.extraCls){ - var t = c.getPositionEl ? c.getPositionEl() : c; - t.removeClass(this.extraCls); + + if (path.length <= 1) { + //nothing to be rendered + return; + } + + if (me.smooth) { + path = Ext.draw.Draw.smooth(path, 6); + } + + //Correct path if we're animating timeAxis intervals + if (chart.markerIndex && me.previousPath) { + fromPath = me.previousPath; + fromPath.splice(1, 2); + } else { + fromPath = path; + } + + // Only create a line if one doesn't exist. + if (!me.line) { + me.line = surface.add(Ext.apply({ + type: 'path', + group: group, + path: dummyPath, + stroke: endLineStyle.stroke || endLineStyle.fill + }, endLineStyle || {})); + //unset fill here (there's always a default fill withing the themes). + me.line.setAttributes({ + fill: 'none' + }); + if (!endLineStyle.stroke && colorArrayLength) { + me.line.setAttributes({ + stroke: colorArrayStyle[seriesIdx % colorArrayLength] + }, true); + } + if (enableShadows) { + //create shadows + shadows = me.line.shadows = []; + for (shindex = 0; shindex < lnsh; shindex++) { + shadowBarAttr = shadowAttributes[shindex]; + shadowBarAttr = Ext.apply({}, shadowBarAttr, { path: dummyPath }); + shadow = chart.surface.add(Ext.apply({}, { + type: 'path', + group: shadowGroups[shindex] + }, shadowBarAttr)); + shadows.push(shadow); + } + } + } + if (me.fill) { + fillPath = path.concat([ + ["L", x, bbox.y + bbox.height], + ["L", bbox.x, bbox.y + bbox.height], + ["L", bbox.x, firstY] + ]); + if (!me.fillPath) { + me.fillPath = surface.add({ + group: group, + type: 'path', + opacity: endLineStyle.opacity || 0.3, + fill: colorArrayStyle[seriesIdx % colorArrayLength] || endLineStyle.fill, + path: dummyPath + }); + } + } + markerCount = showMarkers && markerGroup.getCount(); + if (chart.animate) { + fill = me.fill; + line = me.line; + //Add renderer to line. There is not unique record associated with this. + rendererAttributes = me.renderer(line, false, { path: path }, i, store); + Ext.apply(rendererAttributes, endLineStyle || {}, { + stroke: endLineStyle.stroke || endLineStyle.fill + }); + //fill should not be used here but when drawing the special fill path object + delete rendererAttributes.fill; + if (chart.markerIndex && me.previousPath) { + me.animation = animation = me.onAnimate(line, { + to: rendererAttributes, + from: { + path: fromPath + } + }); + } else { + me.animation = animation = me.onAnimate(line, { + to: rendererAttributes + }); + } + //animate shadows + if (enableShadows) { + shadows = line.shadows; + for(j = 0; j < lnsh; j++) { + if (chart.markerIndex && me.previousPath) { + me.onAnimate(shadows[j], { + to: { path: path }, + from: { path: fromPath } + }); + } else { + me.onAnimate(shadows[j], { + to: { path: path } + }); + } + } + } + //animate fill path + if (fill) { + me.onAnimate(me.fillPath, { + to: Ext.apply({}, { + path: fillPath, + fill: colorArrayStyle[seriesIdx % colorArrayLength] || endLineStyle.fill + }, endLineStyle || {}) + }); + } + //animate markers + if (showMarkers) { + count = 0; + for(i = 0; i < ln; i++) { + if (me.items[i]) { + item = markerGroup.getAt(count++); + if (item) { + rendererAttributes = me.renderer(item, store.getAt(i), item._to, i, store); + me.onAnimate(item, { + to: Ext.apply(rendererAttributes, endMarkerStyle || {}) + }); + } + } + } + for(; count < markerCount; count++) { + item = markerGroup.getAt(count); + item.hide(true); + } + } + } else { + rendererAttributes = me.renderer(me.line, false, { path: path, hidden: false }, i, store); + Ext.apply(rendererAttributes, endLineStyle || {}, { + stroke: endLineStyle.stroke || endLineStyle.fill + }); + //fill should not be used here but when drawing the special fill path object + delete rendererAttributes.fill; + me.line.setAttributes(rendererAttributes, true); + //set path for shadows + if (enableShadows) { + shadows = me.line.shadows; + for(j = 0; j < lnsh; j++) { + shadows[j].setAttributes({ + path: path + }, true); + } + } + if (me.fill) { + me.fillPath.setAttributes({ + path: fillPath + }, true); + } + if (showMarkers) { + count = 0; + for(i = 0; i < ln; i++) { + if (me.items[i]) { + item = markerGroup.getAt(count++); + if (item) { + rendererAttributes = me.renderer(item, store.getAt(i), item._to, i, store); + item.setAttributes(Ext.apply(endMarkerStyle || {}, rendererAttributes || {}), true); + } + } + } + for(; count < markerCount; count++) { + item = markerGroup.getAt(count); + item.hide(true); + } + } } - }, - afterRemove: function(c){ - if(c.removeRestore){ - c.removeMode = 'container'; - delete c.removeRestore; + if (chart.markerIndex) { + path.splice(1, 0, path[1], path[2]); + me.previousPath = path; } + me.renderLabels(); + me.renderCallouts(); }, - - // private - onResize: function(){ - var ct = this.container, - b; - if(ct.collapsed){ - return; + + // @private called when a label is to be created. + onCreateLabel: function(storeItem, item, i, display) { + var me = this, + group = me.labelsGroup, + config = me.label, + bbox = me.bbox, + endLabelStyle = Ext.apply(config, me.seriesLabelStyle); + + return me.chart.surface.add(Ext.apply({ + 'type': 'text', + 'text-anchor': 'middle', + 'group': group, + 'x': item.point[0], + 'y': bbox.y + bbox.height / 2 + }, endLabelStyle || {})); + }, + + // @private called when a label is to be created. + onPlaceLabel: function(label, storeItem, item, i, display, animate) { + var me = this, + chart = me.chart, + resizing = chart.resizing, + config = me.label, + format = config.renderer, + field = config.field, + bbox = me.bbox, + x = item.point[0], + y = item.point[1], + radius = item.sprite.attr.radius, + bb, width, height; + + label.setAttributes({ + text: format(storeItem.get(field)), + hidden: true + }, true); + + if (display == 'rotate') { + label.setAttributes({ + 'text-anchor': 'start', + 'rotation': { + x: x, + y: y, + degrees: -45 + } + }, true); + //correct label position to fit into the box + bb = label.getBBox(); + width = bb.width; + height = bb.height; + x = x < bbox.x? bbox.x : x; + x = (x + width > bbox.x + bbox.width)? (x - (x + width - bbox.x - bbox.width)) : x; + y = (y - height < bbox.y)? bbox.y + height : y; + + } else if (display == 'under' || display == 'over') { + //TODO(nicolas): find out why width/height values in circle bounding boxes are undefined. + bb = item.sprite.getBBox(); + bb.width = bb.width || (radius * 2); + bb.height = bb.height || (radius * 2); + y = y + (display == 'over'? -bb.height : bb.height); + //correct label position to fit into the box + bb = label.getBBox(); + width = bb.width/2; + height = bb.height/2; + x = x - width < bbox.x? bbox.x + width : x; + x = (x + width > bbox.x + bbox.width) ? (x - (x + width - bbox.x - bbox.width)) : x; + y = y - height < bbox.y? bbox.y + height : y; + y = (y + height > bbox.y + bbox.height) ? (y - (y + height - bbox.y - bbox.height)) : y; } - if(b = ct.bufferResize && ct.shouldBufferLayout()){ - if(!this.resizeTask){ - this.resizeTask = new Ext.util.DelayedTask(this.runLayout, this); - this.resizeBuffer = Ext.isNumber(b) ? b : 50; + + if (me.chart.animate && !me.chart.resizing) { + label.show(true); + me.onAnimate(label, { + to: { + x: x, + y: y + } + }); + } else { + label.setAttributes({ + x: x, + y: y + }, true); + if (resizing) { + me.animation.on('afteranimate', function() { + label.show(true); + }); + } else { + label.show(true); } - ct.layoutPending = true; - this.resizeTask.delay(this.resizeBuffer); - }else{ - this.runLayout(); } }, - runLayout: function(){ - var ct = this.container; - this.layout(); - ct.onLayout(); - delete ct.layoutPending; + //@private Overriding highlights.js highlightItem method. + highlightItem: function() { + var me = this; + me.callParent(arguments); + if (this.line && !this.highlighted) { + if (!('__strokeWidth' in this.line)) { + this.line.__strokeWidth = this.line.attr['stroke-width'] || 0; + } + if (this.line.__anim) { + this.line.__anim.paused = true; + } + this.line.__anim = Ext.create('Ext.fx.Anim', { + target: this.line, + to: { + 'stroke-width': this.line.__strokeWidth + 3 + } + }); + this.highlighted = true; + } }, - // private - setContainer : function(ct){ - /** - * This monitorResize flag will be renamed soon as to avoid confusion - * with the Container version which hooks onWindowResize to doLayout - * - * monitorResize flag in this context attaches the resize event between - * a container and it's layout - */ - if(this.monitorResize && ct != this.container){ - var old = this.container; - if(old){ - old.un(old.resizeEvent, this.onResize, this); - } - if(ct){ - ct.on(ct.resizeEvent, this.onResize, this); - } + //@private Overriding highlights.js unHighlightItem method. + unHighlightItem: function() { + var me = this; + me.callParent(arguments); + if (this.line && this.highlighted) { + this.line.__anim = Ext.create('Ext.fx.Anim', { + target: this.line, + to: { + 'stroke-width': this.line.__strokeWidth + } + }); + this.highlighted = false; } - this.container = ct; }, - /** - * Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations - * (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result) - * @param {Number|String} v The encoded margins - * @return {Object} An object with margin sizes for top, right, bottom and left - */ - parseMargins : function(v){ - if (Ext.isNumber(v)) { - v = v.toString(); - } - var ms = v.split(' '), - len = ms.length; - - if (len == 1) { - ms[1] = ms[2] = ms[3] = ms[0]; - } else if(len == 2) { - ms[2] = ms[0]; - ms[3] = ms[1]; - } else if(len == 3) { - ms[3] = ms[1]; + //@private called when a callout needs to be placed. + onPlaceCallout : function(callout, storeItem, item, i, display, animate, index) { + if (!display) { + return; } - return { - top :parseInt(ms[0], 10) || 0, - right :parseInt(ms[1], 10) || 0, - bottom:parseInt(ms[2], 10) || 0, - left :parseInt(ms[3], 10) || 0 - }; - }, + var me = this, + chart = me.chart, + surface = chart.surface, + resizing = chart.resizing, + config = me.callouts, + items = me.items, + prev = i == 0? false : items[i -1].point, + next = (i == items.length -1)? false : items[i +1].point, + cur = [+item.point[0], +item.point[1]], + dir, norm, normal, a, aprev, anext, + offsetFromViz = config.offsetFromViz || 30, + offsetToSide = config.offsetToSide || 10, + offsetBox = config.offsetBox || 3, + boxx, boxy, boxw, boxh, + p, clipRect = me.clipRect, + bbox = { + width: config.styles.width || 10, + height: config.styles.height || 10 + }, + x, y; - /** - * The {@link Ext.Template Ext.Template} used by Field rendering layout classes (such as - * {@link Ext.layout.FormLayout}) to create the DOM structure of a fully wrapped, - * labeled and styled form Field. A default Template is supplied, but this may be - * overriden to create custom field structures. The template processes values returned from - * {@link Ext.layout.FormLayout#getTemplateArgs}. - * @property fieldTpl - * @type Ext.Template - */ - fieldTpl: (function() { - var t = new Ext.Template( - '', - '{label}{labelSeparator}', - '', - ' ', - '' - ); - t.disableFormats = true; - return t.compile(); - })(), + //get the right two points + if (!prev) { + prev = cur; + } + if (!next) { + next = cur; + } + a = (next[1] - prev[1]) / (next[0] - prev[0]); + aprev = (cur[1] - prev[1]) / (cur[0] - prev[0]); + anext = (next[1] - cur[1]) / (next[0] - cur[0]); + + norm = Math.sqrt(1 + a * a); + dir = [1 / norm, a / norm]; + normal = [-dir[1], dir[0]]; + + //keep the label always on the outer part of the "elbow" + if (aprev > 0 && anext < 0 && normal[1] < 0 + || aprev < 0 && anext > 0 && normal[1] > 0) { + normal[0] *= -1; + normal[1] *= -1; + } else if (Math.abs(aprev) < Math.abs(anext) && normal[0] < 0 + || Math.abs(aprev) > Math.abs(anext) && normal[0] > 0) { + normal[0] *= -1; + normal[1] *= -1; + } + //position + x = cur[0] + normal[0] * offsetFromViz; + y = cur[1] + normal[1] * offsetFromViz; + + //box position and dimensions + boxx = x + (normal[0] > 0? 0 : -(bbox.width + 2 * offsetBox)); + boxy = y - bbox.height /2 - offsetBox; + boxw = bbox.width + 2 * offsetBox; + boxh = bbox.height + 2 * offsetBox; + + //now check if we're out of bounds and invert the normal vector correspondingly + //this may add new overlaps between labels (but labels won't be out of bounds). + if (boxx < clipRect[0] || (boxx + boxw) > (clipRect[0] + clipRect[2])) { + normal[0] *= -1; + } + if (boxy < clipRect[1] || (boxy + boxh) > (clipRect[1] + clipRect[3])) { + normal[1] *= -1; + } - /* - * Destroys this layout. This is a template method that is empty by default, but should be implemented - * by subclasses that require explicit destruction to purge event handlers or remove DOM nodes. - * @protected - */ - destroy : function(){ - // Stop any buffered layout tasks - if(this.resizeTask && this.resizeTask.cancel){ - this.resizeTask.cancel(); + //update positions + x = cur[0] + normal[0] * offsetFromViz; + y = cur[1] + normal[1] * offsetFromViz; + + //update box position and dimensions + boxx = x + (normal[0] > 0? 0 : -(bbox.width + 2 * offsetBox)); + boxy = y - bbox.height /2 - offsetBox; + boxw = bbox.width + 2 * offsetBox; + boxh = bbox.height + 2 * offsetBox; + + if (chart.animate) { + //set the line from the middle of the pie to the box. + me.onAnimate(callout.lines, { + to: { + path: ["M", cur[0], cur[1], "L", x, y, "Z"] + } + }); + //set component position + if (callout.panel) { + callout.panel.setPosition(boxx, boxy, true); + } } - if(!Ext.isEmpty(this.targetCls)){ - var target = this.container.getLayoutTarget(); - if(target){ - target.removeClass(this.targetCls); + else { + //set the line from the middle of the pie to the box. + callout.lines.setAttributes({ + path: ["M", cur[0], cur[1], "L", x, y, "Z"] + }, true); + //set component position + if (callout.panel) { + callout.panel.setPosition(boxx, boxy); } } - } -});/** - * @class Ext.layout.AutoLayout - *The AutoLayout is the default layout manager delegated by {@link Ext.Container} to - * render any child Components when no {@link Ext.Container#layout layout} is configured into - * a {@link Ext.Container Container}.. AutoLayout provides only a passthrough of any layout calls - * to any child containers. - */ -Ext.layout.AutoLayout = Ext.extend(Ext.layout.ContainerLayout, { - type: 'auto', - - monitorResize: true, - - onLayout : function(ct, target){ - Ext.layout.AutoLayout.superclass.onLayout.call(this, ct, target); - var cs = this.getRenderedItems(ct), len = cs.length, i, c; - for(i = 0; i < len; i++){ - c = cs[i]; - if (c.doLayout){ - // Shallow layout children - c.doLayout(true); + for (p in callout) { + callout[p].show(true); + } + }, + + isItemInPoint: function(x, y, item, i) { + var me = this, + items = me.items, + tolerance = me.selectionTolerance, + result = null, + prevItem, + nextItem, + prevPoint, + nextPoint, + ln, + x1, + y1, + x2, + y2, + xIntersect, + yIntersect, + dist1, dist2, dist, midx, midy, + sqrt = Math.sqrt, abs = Math.abs; + + nextItem = items[i]; + prevItem = i && items[i - 1]; + + if (i >= ln) { + prevItem = items[ln - 1]; + } + prevPoint = prevItem && prevItem.point; + nextPoint = nextItem && nextItem.point; + x1 = prevItem ? prevPoint[0] : nextPoint[0] - tolerance; + y1 = prevItem ? prevPoint[1] : nextPoint[1]; + x2 = nextItem ? nextPoint[0] : prevPoint[0] + tolerance; + y2 = nextItem ? nextPoint[1] : prevPoint[1]; + dist1 = sqrt((x - x1) * (x - x1) + (y - y1) * (y - y1)); + dist2 = sqrt((x - x2) * (x - x2) + (y - y2) * (y - y2)); + dist = Math.min(dist1, dist2); + + if (dist <= tolerance) { + return dist == dist1? prevItem : nextItem; + } + return false; + }, + + // @private toggle visibility of all series elements (markers, sprites). + toggleAll: function(show) { + var me = this, + i, ln, shadow, shadows; + if (!show) { + Ext.chart.series.Line.superclass.hideAll.call(me); + } + else { + Ext.chart.series.Line.superclass.showAll.call(me); + } + if (me.line) { + me.line.setAttributes({ + hidden: !show + }, true); + //hide shadows too + if (me.line.shadows) { + for (i = 0, shadows = me.line.shadows, ln = shadows.length; i < ln; i++) { + shadow = shadows[i]; + shadow.setAttributes({ + hidden: !show + }, true); + } } } + if (me.fillPath) { + me.fillPath.setAttributes({ + hidden: !show + }, true); + } + }, + + // @private hide all series elements (markers, sprites). + hideAll: function() { + this.toggleAll(false); + }, + + // @private hide all series elements (markers, sprites). + showAll: function() { + this.toggleAll(true); } }); - -Ext.Container.LAYOUTS['auto'] = Ext.layout.AutoLayout; /** - * @class Ext.layout.FitLayout - * @extends Ext.layout.ContainerLayout - * This is a base class for layouts that contain a single item that automatically expands to fill the layout's - * container. This class is intended to be extended or created via the layout:'fit' {@link Ext.Container#layout} - * config, and should generally not need to be created directly via the new keyword. - * FitLayout does not have any direct config options (other than inherited ones). To fit a panel to a container - * using FitLayout, simply set layout:'fit' on the container and add a single panel to it. If the container has - * multiple panels, only the first one will be displayed. Example usage: - * -var p = new Ext.Panel({ - title: 'Fit Layout', - layout:'fit', - items: { - title: 'Inner Panel', - html: '<p>This is the inner panel content</p>', - border: false - } -}); - + * @class Ext.chart.series.Pie + * @extends Ext.chart.series.Series + * + * Creates a Pie Chart. A Pie Chart is a useful visualization technique to display quantitative information for different + * categories that also have a meaning as a whole. + * As with all other series, the Pie Series must be appended in the *series* Chart array configuration. See the Chart + * documentation for more information. A typical configuration object for the pie series could be: + * + * {@img Ext.chart.series.Pie/Ext.chart.series.Pie.png Ext.chart.series.Pie chart series} + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * animate: true, + * store: store, + * theme: 'Base:gradients', + * series: [{ + * type: 'pie', + * field: 'data1', + * showInLegend: true, + * tips: { + * trackMouse: true, + * width: 140, + * height: 28, + * renderer: function(storeItem, item) { + * //calculate and display percentage on hover + * var total = 0; + * store.each(function(rec) { + * total += rec.get('data1'); + * }); + * this.setTitle(storeItem.get('name') + ': ' + Math.round(storeItem.get('data1') / total * 100) + '%'); + * } + * }, + * highlight: { + * segment: { + * margin: 20 + * } + * }, + * label: { + * field: 'name', + * display: 'rotate', + * contrast: true, + * font: '18px Arial' + * } + * }] + * }); + * + * In this configuration we set `pie` as the type for the series, set an object with specific style properties for highlighting options + * (triggered when hovering elements). We also set true to `showInLegend` so all the pie slices can be represented by a legend item. + * We set `data1` as the value of the field to determine the angle span for each pie slice. We also set a label configuration object + * where we set the field name of the store field to be renderer as text for the label. The labels will also be displayed rotated. + * We set `contrast` to `true` to flip the color of the label if it is to similar to the background color. Finally, we set the font family + * and size through the `font` parameter. + * + * @xtype pie */ -Ext.layout.FitLayout = Ext.extend(Ext.layout.ContainerLayout, { - // private - monitorResize:true, +Ext.define('Ext.chart.series.Pie', { + + /* Begin Definitions */ + + alternateClassName: ['Ext.chart.PieSeries', 'Ext.chart.PieChart'], - type: 'fit', + extend: 'Ext.chart.series.Series', - getLayoutTargetSize : function() { - var target = this.container.getLayoutTarget(); - if (!target) { - return {}; - } - // Style Sized (scrollbars not included) - return target.getStyleSize(); - }, + /* End Definitions */ - // private - onLayout : function(ct, target){ - Ext.layout.FitLayout.superclass.onLayout.call(this, ct, target); - if(!ct.collapsed){ - this.setItemSize(this.activeItem || ct.items.itemAt(0), this.getLayoutTargetSize()); - } - }, + type: "pie", + + alias: 'series.pie', - // private - setItemSize : function(item, size){ - if(item && size.height > 0){ // display none? - item.setSize(size); - } - } -}); -Ext.Container.LAYOUTS['fit'] = Ext.layout.FitLayout;/** - * @class Ext.layout.CardLayout - * @extends Ext.layout.FitLayout - * 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#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. 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. -}; + rad: Math.PI / 180, -var card = new Ext.Panel({ - title: 'Example Wizard', - 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.createDelegate(this, [-1]), - disabled: true - }, - '->', // greedy spacer so that the buttons are aligned to each side - { - id: 'move-next', - text: 'Next', - handler: navHandler.createDelegate(this, [1]) - } - ], - // the panels (or "cards") within the layout - items: [{ - id: 'card-0', - html: '<h1>Welcome to the Wizard!</h1><p>Step 1 of 3</p>' - },{ - id: 'card-1', - html: '<p>Step 2 of 3</p>' - },{ - id: 'card-2', - html: '<h1>Congratulations!</h1><p>Step 3 of 3 - Complete</p>' - }] -}); - - */ -Ext.layout.CardLayout = Ext.extend(Ext.layout.FitLayout, { /** - * @cfg {Boolean} deferredRender - * True to render each contained item at the time it becomes active, false to render all contained items - * as soon as the layout is rendered (defaults to false). If there is a significant amount of content or - * a lot of heavy controls being rendered into panels that are not displayed by default, setting this to - * true might improve performance. + * @cfg {Number} highlightDuration + * The duration for the pie slice highlight effect. */ - deferredRender : false, + highlightDuration: 150, /** - * @cfg {Boolean} layoutOnCardChange - * True to force a layout of the active item when the active card is changed. Defaults to false. + * @cfg {String} angleField + * The store record field name to be used for the pie angles. + * The values bound to this field name must be positive real numbers. + * This parameter is required. */ - layoutOnCardChange : false, + angleField: false, /** - * @cfg {Boolean} renderHidden @hide + * @cfg {String} lengthField + * The store record field name to be used for the pie slice lengths. + * The values bound to this field name must be positive real numbers. + * This parameter is optional. */ - // private - renderHidden : true, - - type: 'card', + lengthField: false, /** - * Sets the active (visible) item in the layout. - * @param {String/Number} item The string component id or numeric index of the item to activate + * @cfg {Boolean|Number} donut + * Whether to set the pie chart as donut chart. + * Default's false. Can be set to a particular percentage to set the radius + * of the donut chart. */ - setActiveItem : function(item){ - var ai = this.activeItem, - ct = this.container; - item = ct.getComponent(item); + donut: false, - // Is this a valid, different card? - if(item && ai != item){ + /** + * @cfg {Boolean} showInLegend + * Whether to add the pie chart elements as legend items. Default's false. + */ + showInLegend: false, - // Changing cards, hide the current one - if(ai){ - ai.hide(); - if (ai.hidden !== true) { - return false; + /** + * @cfg {Array} colorSet + * An array of color values which will be used, in order, as the pie slice fill colors. + */ + + /** + * @cfg {Object} style + * An object containing styles for overriding series styles from Theming. + */ + style: {}, + + constructor: function(config) { + this.callParent(arguments); + var me = this, + chart = me.chart, + surface = chart.surface, + store = chart.store, + shadow = chart.shadow, i, l, cfg; + Ext.applyIf(me, { + highlightCfg: { + segment: { + margin: 20 } - ai.fireEvent('deactivate', ai); } - - var layout = item.doLayout && (this.layoutOnCardChange || !item.rendered); - - // Change activeItem reference - this.activeItem = item; - - // The container is about to get a recursive layout, remove any deferLayout reference - // because it will trigger a redundant layout. - delete item.deferLayout; - - // Show the new component - item.show(); - - this.layout(); - - if(layout){ - item.doLayout(); + }); + Ext.apply(me, config, { + shadowAttributes: [{ + "stroke-width": 6, + "stroke-opacity": 1, + stroke: 'rgb(200, 200, 200)', + translate: { + x: 1.2, + y: 2 + } + }, + { + "stroke-width": 4, + "stroke-opacity": 1, + stroke: 'rgb(150, 150, 150)', + translate: { + x: 0.9, + y: 1.5 + } + }, + { + "stroke-width": 2, + "stroke-opacity": 1, + stroke: 'rgb(100, 100, 100)', + translate: { + x: 0.6, + y: 1 + } + }] + }); + me.group = surface.getGroup(me.seriesId); + if (shadow) { + for (i = 0, l = me.shadowAttributes.length; i < l; i++) { + me.shadowGroups.push(surface.getGroup(me.seriesId + '-shadows' + i)); } - item.fireEvent('activate', item); } + surface.customAttributes.segment = function(opt) { + return me.getSegment(opt); + }; }, - - // private - renderAll : function(ct, target){ - if(this.deferredRender){ - this.renderItem(this.activeItem, undefined, target); - }else{ - Ext.layout.CardLayout.superclass.renderAll.call(this, ct, target); + + //@private updates some onbefore render parameters. + initialize: function() { + var me = this, + store = me.chart.substore || me.chart.store; + //Add yFields to be used in Legend.js + me.yField = []; + if (me.label.field) { + store.each(function(rec) { + me.yField.push(rec.get(me.label.field)); + }); } - } -}); -Ext.Container.LAYOUTS['card'] = Ext.layout.CardLayout; -/** - * @class Ext.layout.AnchorLayout - * @extends Ext.layout.ContainerLayout - * 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.Container#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. For example: - * -var viewport = new Ext.Viewport({ - layout:'anchor', - anchorSize: {width:800, height:600}, - items:[{ - title:'Item 1', - html:'Content 1', - width:800, - anchor:'right 20%' - },{ - title:'Item 2', - html:'Content 2', - width:300, - anchor:'50% 30%' - },{ - title:'Item 3', - html:'Content 3', - width:600, - anchor:'-100 50%' - }] -}); - * - */ -Ext.layout.AnchorLayout = Ext.extend(Ext.layout.ContainerLayout, { - /** - * @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%' - * - * - * - * - */ + }, - // private - monitorResize : true, + // @private returns an object with properties for a PieSlice. + getSegment: function(opt) { + var me = this, + rad = me.rad, + cos = Math.cos, + sin = Math.sin, + abs = Math.abs, + x = me.centerX, + y = me.centerY, + x1 = 0, x2 = 0, x3 = 0, x4 = 0, + y1 = 0, y2 = 0, y3 = 0, y4 = 0, + delta = 1e-2, + r = opt.endRho - opt.startRho, + startAngle = opt.startAngle, + endAngle = opt.endAngle, + midAngle = (startAngle + endAngle) / 2 * rad, + margin = opt.margin || 0, + flag = abs(endAngle - startAngle) > 180, + a1 = Math.min(startAngle, endAngle) * rad, + a2 = Math.max(startAngle, endAngle) * rad, + singleSlice = false; + + x += margin * cos(midAngle); + y += margin * sin(midAngle); + + x1 = x + opt.startRho * cos(a1); + y1 = y + opt.startRho * sin(a1); + + x2 = x + opt.endRho * cos(a1); + y2 = y + opt.endRho * sin(a1); + + x3 = x + opt.startRho * cos(a2); + y3 = y + opt.startRho * sin(a2); + + x4 = x + opt.endRho * cos(a2); + y4 = y + opt.endRho * sin(a2); + + if (abs(x1 - x3) <= delta && abs(y1 - y3) <= delta) { + singleSlice = true; + } + //Solves mysterious clipping bug with IE + if (singleSlice) { + return { + path: [ + ["M", x1, y1], + ["L", x2, y2], + ["A", opt.endRho, opt.endRho, 0, +flag, 1, x4, y4], + ["Z"]] + }; + } else { + return { + path: [ + ["M", x1, y1], + ["L", x2, y2], + ["A", opt.endRho, opt.endRho, 0, +flag, 1, x4, y4], + ["L", x3, y3], + ["A", opt.startRho, opt.startRho, 0, +flag, 0, x1, y1], + ["Z"]] + }; + } + }, - type : 'anchor', + // @private utility function to calculate the middle point of a pie slice. + calcMiddle: function(item) { + var me = this, + rad = me.rad, + slice = item.slice, + x = me.centerX, + y = me.centerY, + startAngle = slice.startAngle, + endAngle = slice.endAngle, + donut = +me.donut, + a1 = Math.min(startAngle, endAngle) * rad, + a2 = Math.max(startAngle, endAngle) * rad, + midAngle = -(a1 + (a2 - a1) / 2), + xm = x + (item.endRho + item.startRho) / 2 * Math.cos(midAngle), + ym = y - (item.endRho + item.startRho) / 2 * Math.sin(midAngle); + + item.middle = { + x: xm, + y: ym + }; + }, /** - * @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%'. - * + * Draws the series for the current chart. */ - defaultAnchor : '100%', + drawSeries: function() { + var me = this, + store = me.chart.substore || me.chart.store, + group = me.group, + animate = me.chart.animate, + field = me.angleField || me.field || me.xField, + lenField = [].concat(me.lengthField), + totalLenField = 0, + colors = me.colorSet, + chart = me.chart, + surface = chart.surface, + chartBBox = chart.chartBBox, + enableShadows = chart.shadow, + shadowGroups = me.shadowGroups, + shadowAttributes = me.shadowAttributes, + lnsh = shadowGroups.length, + rad = me.rad, + layers = lenField.length, + rhoAcum = 0, + donut = +me.donut, + layerTotals = [], + values = {}, + fieldLength, + items = [], + passed = false, + totalField = 0, + maxLenField = 0, + cut = 9, + defcut = true, + angle = 0, + seriesStyle = me.seriesStyle, + seriesLabelStyle = me.seriesLabelStyle, + colorArrayStyle = me.colorArrayStyle, + colorArrayLength = colorArrayStyle && colorArrayStyle.length || 0, + gutterX = chart.maxGutter[0], + gutterY = chart.maxGutter[1], + rendererAttributes, + shadowGroup, + shadowAttr, + shadows, + shadow, + shindex, + centerX, + centerY, + deltaRho, + first = 0, + slice, + slices, + sprite, + value, + item, + lenValue, + ln, + record, + i, + j, + startAngle, + endAngle, + middleAngle, + sliceLength, + path, + p, + spriteOptions, bbox; + + Ext.apply(seriesStyle, me.style || {}); - parseAnchorRE : /^(r|right|b|bottom)$/i, + me.setBBox(); + bbox = me.bbox; - getLayoutTargetSize : function() { - var target = this.container.getLayoutTarget(); - if (!target) { - return {}; + //override theme colors + if (me.colorSet) { + colorArrayStyle = me.colorSet; + colorArrayLength = colorArrayStyle.length; } - // Style Sized (scrollbars not included) - return target.getStyleSize(); - }, - - // private - onLayout : function(ct, target){ - Ext.layout.AnchorLayout.superclass.onLayout.call(this, ct, target); - var size = this.getLayoutTargetSize(); - - var w = size.width, h = size.height; - - if(w < 20 && h < 20){ + + //if not store or store is empty then there's nothing to draw + if (!store || !store.getCount()) { return; } - - // find the container anchoring size - var aw, ah; - if(ct.anchorSize){ - if(typeof ct.anchorSize == 'number'){ - aw = ct.anchorSize; - }else{ - aw = ct.anchorSize.width; - ah = ct.anchorSize.height; + + me.unHighlightItem(); + me.cleanHighlights(); + + centerX = me.centerX = chartBBox.x + (chartBBox.width / 2); + centerY = me.centerY = chartBBox.y + (chartBBox.height / 2); + me.radius = Math.min(centerX - chartBBox.x, centerY - chartBBox.y); + me.slices = slices = []; + me.items = items = []; + + store.each(function(record, i) { + if (this.__excludes && this.__excludes[i]) { + //hidden series + return; } - }else{ - aw = ct.initialConfig.width; - ah = ct.initialConfig.height; - } - - var cs = this.getRenderedItems(ct), len = cs.length, i, c, a, cw, ch, el, vs, boxes = []; - for(i = 0; i < len; i++){ - c = cs[i]; - el = c.getPositionEl(); - - // If a child container item has no anchor and no specific width, set the child to the default anchor size - if (!c.anchor && c.items && !Ext.isNumber(c.width) && !(Ext.isIE6 && Ext.isStrict)){ - c.anchor = this.defaultAnchor; + totalField += +record.get(field); + if (lenField[0]) { + for (j = 0, totalLenField = 0; j < layers; j++) { + totalLenField += +record.get(lenField[j]); + } + layerTotals[i] = totalLenField; + maxLenField = Math.max(maxLenField, totalLenField); } + }, this); - if(c.anchor){ - a = c.anchorSpec; - if(!a){ // cache all anchor values - vs = c.anchor.split(' '); - c.anchorSpec = a = { - right: this.parseAnchor(vs[0], c.initialConfig.width, aw), - bottom: this.parseAnchor(vs[1], c.initialConfig.height, ah) - }; + store.each(function(record, i) { + if (this.__excludes && this.__excludes[i]) { + //hidden series + return; + } + value = record.get(field); + middleAngle = angle - 360 * value / totalField / 2; + // TODO - Put up an empty circle + if (isNaN(middleAngle)) { + middleAngle = 360; + value = 1; + totalField = 1; + } + // First slice + if (!i || first == 0) { + angle = 360 - middleAngle; + me.firstAngle = angle; + middleAngle = angle - 360 * value / totalField / 2; + } + endAngle = angle - 360 * value / totalField; + slice = { + series: me, + value: value, + startAngle: angle, + endAngle: endAngle, + storeItem: record + }; + if (lenField[0]) { + lenValue = layerTotals[i]; + slice.rho = me.radius * (lenValue / maxLenField); + } else { + slice.rho = me.radius; + } + slices[i] = slice; + if((slice.startAngle % 360) == (slice.endAngle % 360)) { + slice.startAngle -= 0.0001; + } + angle = endAngle; + first++; + }, me); + + //do all shadows first. + if (enableShadows) { + for (i = 0, ln = slices.length; i < ln; i++) { + if (this.__excludes && this.__excludes[i]) { + //hidden series + continue; } - cw = a.right ? this.adjustWidthAnchor(a.right(w) - el.getMargins('lr'), c) : undefined; - ch = a.bottom ? this.adjustHeightAnchor(a.bottom(h) - el.getMargins('tb'), c) : undefined; - - if(cw || ch){ - boxes.push({ - comp: c, - width: cw || undefined, - height: ch || undefined - }); + slice = slices[i]; + slice.shadowAttrs = []; + for (j = 0, rhoAcum = 0, shadows = []; j < layers; j++) { + sprite = group.getAt(i * layers + j); + deltaRho = lenField[j] ? store.getAt(i).get(lenField[j]) / layerTotals[i] * slice.rho: slice.rho; + //set pie slice properties + rendererAttributes = { + segment: { + startAngle: slice.startAngle, + endAngle: slice.endAngle, + margin: 0, + rho: slice.rho, + startRho: rhoAcum + (deltaRho * donut / 100), + endRho: rhoAcum + deltaRho + } + }; + //create shadows + for (shindex = 0, shadows = []; shindex < lnsh; shindex++) { + shadowAttr = shadowAttributes[shindex]; + shadow = shadowGroups[shindex].getAt(i); + if (!shadow) { + shadow = chart.surface.add(Ext.apply({}, { + type: 'path', + group: shadowGroups[shindex], + strokeLinejoin: "round" + }, rendererAttributes, shadowAttr)); + } + if (animate) { + shadowAttr = me.renderer(shadow, store.getAt(i), Ext.apply({}, rendererAttributes, shadowAttr), i, store); + me.onAnimate(shadow, { + to: shadowAttr + }); + } else { + shadowAttr = me.renderer(shadow, store.getAt(i), Ext.apply(shadowAttr, { + hidden: false + }), i, store); + shadow.setAttributes(shadowAttr, true); + } + shadows.push(shadow); + } + slice.shadowAttrs[j] = shadows; } } } - for (i = 0, len = boxes.length; i < len; i++) { - c = boxes[i]; - c.comp.setSize(c.width, c.height); - } - }, - - // private - parseAnchor : function(a, start, cstart){ - if(a && a != 'none'){ - var last; - // standard anchor - if(this.parseAnchorRE.test(a)){ - var diff = cstart - start; - return function(v){ - if(v !== last){ - last = v; - return v - diff; - } + //do pie slices after. + for (i = 0, ln = slices.length; i < ln; i++) { + if (this.__excludes && this.__excludes[i]) { + //hidden series + continue; + } + slice = slices[i]; + for (j = 0, rhoAcum = 0; j < layers; j++) { + sprite = group.getAt(i * layers + j); + deltaRho = lenField[j] ? store.getAt(i).get(lenField[j]) / layerTotals[i] * slice.rho: slice.rho; + //set pie slice properties + rendererAttributes = Ext.apply({ + segment: { + startAngle: slice.startAngle, + endAngle: slice.endAngle, + margin: 0, + rho: slice.rho, + startRho: rhoAcum + (deltaRho * donut / 100), + endRho: rhoAcum + deltaRho + } + }, Ext.apply(seriesStyle, colorArrayStyle && { fill: colorArrayStyle[(layers > 1? j : i) % colorArrayLength] } || {})); + item = Ext.apply({}, + rendererAttributes.segment, { + slice: slice, + series: me, + storeItem: slice.storeItem, + index: i + }); + me.calcMiddle(item); + if (enableShadows) { + item.shadows = slice.shadowAttrs[j]; } - // percentage - }else if(a.indexOf('%') != -1){ - var ratio = parseFloat(a.replace('%', ''))*.01; - return function(v){ - if(v !== last){ - last = v; - return Math.floor(v*ratio); - } + items[i] = item; + // Create a new sprite if needed (no height) + if (!sprite) { + spriteOptions = Ext.apply({ + type: "path", + group: group, + middle: item.middle + }, Ext.apply(seriesStyle, colorArrayStyle && { fill: colorArrayStyle[(layers > 1? j : i) % colorArrayLength] } || {})); + sprite = surface.add(Ext.apply(spriteOptions, rendererAttributes)); } - // simple offset adjustment - }else{ - a = parseInt(a, 10); - if(!isNaN(a)){ - return function(v){ - if(v !== last){ - last = v; - return v + a; + slice.sprite = slice.sprite || []; + item.sprite = sprite; + slice.sprite.push(sprite); + slice.point = [item.middle.x, item.middle.y]; + if (animate) { + rendererAttributes = me.renderer(sprite, store.getAt(i), rendererAttributes, i, store); + sprite._to = rendererAttributes; + sprite._animating = true; + me.onAnimate(sprite, { + to: rendererAttributes, + listeners: { + afteranimate: { + fn: function() { + this._animating = false; + }, + scope: sprite + } + } + }); + } else { + rendererAttributes = me.renderer(sprite, store.getAt(i), Ext.apply(rendererAttributes, { + hidden: false + }), i, store); + sprite.setAttributes(rendererAttributes, true); + } + rhoAcum += deltaRho; + } + } + + // Hide unused bars + ln = group.getCount(); + for (i = 0; i < ln; i++) { + if (!slices[(i / layers) >> 0] && group.getAt(i)) { + group.getAt(i).hide(true); + } + } + if (enableShadows) { + lnsh = shadowGroups.length; + for (shindex = 0; shindex < ln; shindex++) { + if (!slices[(shindex / layers) >> 0]) { + for (j = 0; j < lnsh; j++) { + if (shadowGroups[j].getAt(shindex)) { + shadowGroups[j].getAt(shindex).hide(true); } } } } } - return false; + me.renderLabels(); + me.renderCallouts(); }, - // private - adjustWidthAnchor : function(value, comp){ - return value; + // @private callback for when creating a label sprite. + onCreateLabel: function(storeItem, item, i, display) { + var me = this, + group = me.labelsGroup, + config = me.label, + centerX = me.centerX, + centerY = me.centerY, + middle = item.middle, + endLabelStyle = Ext.apply(me.seriesLabelStyle || {}, config || {}); + + return me.chart.surface.add(Ext.apply({ + 'type': 'text', + 'text-anchor': 'middle', + 'group': group, + 'x': middle.x, + 'y': middle.y + }, endLabelStyle)); }, - // private - adjustHeightAnchor : function(value, comp){ - return value; - } - - /** - * @property activeItem - * @hide - */ -}); -Ext.Container.LAYOUTS['anchor'] = Ext.layout.AnchorLayout; -/** - * @class Ext.layout.ColumnLayout - * @extends Ext.layout.ContainerLayout - * 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#layout} config, - * and should generally not need to be created directly via the new keyword. - * ColumnLayout does not have any direct config options (other than inherited ones), but it does support a - * specific config property of columnWidth that can be included in the config of any panel added to it. The - * layout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel. - * If width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto). - * The width property is always evaluated as pixels, and must be a number greater than or equal to 1. - * The columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and - * less than 1 (e.g., .25). - * The basic rules for specifying column widths are pretty simple. The logic makes two passes through the - * set of contained panels. During the first layout pass, all panels that either have a fixed width or none - * specified (auto) are skipped, but their widths are subtracted from the overall container width. During the second - * pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on - * the total remaining container width. In other words, percentage width panels are designed to fill the space - * left over by all the fixed-width and/or auto-width panels. Because of this, while you can specify any number of columns - * with different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your - * layout may not render as expected. Example usage: - * -// All columns are percentages -- they must add up to 1 -var p = new Ext.Panel({ - title: 'Column Layout - Percentage Only', - layout:'column', - items: [{ - title: 'Column 1', - columnWidth: .25 - },{ - title: 'Column 2', - columnWidth: .6 - },{ - title: 'Column 3', - columnWidth: .15 - }] -}); - -// 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. -var p = new Ext.Panel({ - title: 'Column Layout - Mixed', - layout:'column', - items: [{ - title: 'Column 1', - width: 120 - },{ - title: 'Column 2', - columnWidth: .8 - },{ - title: 'Column 3', - columnWidth: .2 - }] -}); - - */ -Ext.layout.ColumnLayout = Ext.extend(Ext.layout.ContainerLayout, { - // private - monitorResize:true, - - type: 'column', - - extraCls: 'x-column', - - scrollOffset : 0, - - // private + // @private callback for when placing a label sprite. + onPlaceLabel: function(label, storeItem, item, i, display, animate, index) { + var me = this, + chart = me.chart, + resizing = chart.resizing, + config = me.label, + format = config.renderer, + field = [].concat(config.field), + centerX = me.centerX, + centerY = me.centerY, + middle = item.middle, + opt = { + x: middle.x, + y: middle.y + }, + x = middle.x - centerX, + y = middle.y - centerY, + from = {}, + rho = 1, + theta = Math.atan2(y, x || 1), + dg = theta * 180 / Math.PI, + prevDg; + + function fixAngle(a) { + if (a < 0) a += 360; + return a % 360; + } - targetCls: 'x-column-layout-ct', + label.setAttributes({ + text: format(storeItem.get(field[index])) + }, true); - isValidParent : function(c, target){ - return this.innerCt && c.getPositionEl().dom.parentNode == this.innerCt.dom; - }, + switch (display) { + case 'outside': + rho = Math.sqrt(x * x + y * y) * 2; + //update positions + opt.x = rho * Math.cos(theta) + centerX; + opt.y = rho * Math.sin(theta) + centerY; + break; - getLayoutTargetSize : function() { - var target = this.container.getLayoutTarget(), ret; - if (target) { - ret = target.getViewSize(); + case 'rotate': + dg = fixAngle(dg); + dg = (dg > 90 && dg < 270) ? dg + 180: dg; - // IE in strict mode will return a width of 0 on the 1st pass of getViewSize. - // Use getStyleSize to verify the 0 width, the adjustment pass will then work properly - // with getViewSize - if (Ext.isIE && Ext.isStrict && ret.width == 0){ - ret = target.getStyleSize(); + prevDg = label.attr.rotation.degrees; + if (prevDg != null && Math.abs(prevDg - dg) > 180) { + if (dg > prevDg) { + dg -= 360; + } else { + dg += 360; + } + dg = dg % 360; + } else { + dg = fixAngle(dg); } + //update rotation angle + opt.rotate = { + degrees: dg, + x: opt.x, + y: opt.y + }; + break; - ret.width -= target.getPadding('lr'); - ret.height -= target.getPadding('tb'); + default: + break; } - return ret; - }, - - renderAll : function(ct, target) { - if(!this.innerCt){ - // the innerCt prevents wrapping and shuffling while - // the container is resizing - this.innerCt = target.createChild({cls:'x-column-inner'}); - this.innerCt.createChild({cls:'x-clear'}); + //ensure the object has zero translation + opt.translate = { + x: 0, y: 0 + }; + if (animate && !resizing && (display != 'rotate' || prevDg != null)) { + me.onAnimate(label, { + to: opt + }); + } else { + label.setAttributes(opt, true); } - Ext.layout.ColumnLayout.superclass.renderAll.call(this, ct, this.innerCt); + label._from = from; }, - // private - onLayout : function(ct, target){ - var cs = ct.items.items, - len = cs.length, - c, - i, - m, - margins = []; - - this.renderAll(ct, target); - - var size = this.getLayoutTargetSize(); - - if(size.width < 1 && size.height < 1){ // display none? - return; + // @private callback for when placing a callout sprite. + onPlaceCallout: function(callout, storeItem, item, i, display, animate, index) { + var me = this, + chart = me.chart, + resizing = chart.resizing, + config = me.callouts, + centerX = me.centerX, + centerY = me.centerY, + middle = item.middle, + opt = { + x: middle.x, + y: middle.y + }, + x = middle.x - centerX, + y = middle.y - centerY, + rho = 1, + rhoCenter, + theta = Math.atan2(y, x || 1), + bbox = callout.label.getBBox(), + offsetFromViz = 20, + offsetToSide = 10, + offsetBox = 10, + p; + + //should be able to config this. + rho = item.endRho + offsetFromViz; + rhoCenter = (item.endRho + item.startRho) / 2 + (item.endRho - item.startRho) / 3; + //update positions + opt.x = rho * Math.cos(theta) + centerX; + opt.y = rho * Math.sin(theta) + centerY; + + x = rhoCenter * Math.cos(theta); + y = rhoCenter * Math.sin(theta); + + if (chart.animate) { + //set the line from the middle of the pie to the box. + me.onAnimate(callout.lines, { + to: { + path: ["M", x + centerX, y + centerY, "L", opt.x, opt.y, "Z", "M", opt.x, opt.y, "l", x > 0 ? offsetToSide: -offsetToSide, 0, "z"] + } + }); + //set box position + me.onAnimate(callout.box, { + to: { + x: opt.x + (x > 0 ? offsetToSide: -(offsetToSide + bbox.width + 2 * offsetBox)), + y: opt.y + (y > 0 ? ( - bbox.height - offsetBox / 2) : ( - bbox.height - offsetBox / 2)), + width: bbox.width + 2 * offsetBox, + height: bbox.height + 2 * offsetBox + } + }); + //set text position + me.onAnimate(callout.label, { + to: { + x: opt.x + (x > 0 ? (offsetToSide + offsetBox) : -(offsetToSide + bbox.width + offsetBox)), + y: opt.y + (y > 0 ? -bbox.height / 4: -bbox.height / 4) + } + }); + } else { + //set the line from the middle of the pie to the box. + callout.lines.setAttributes({ + path: ["M", x + centerX, y + centerY, "L", opt.x, opt.y, "Z", "M", opt.x, opt.y, "l", x > 0 ? offsetToSide: -offsetToSide, 0, "z"] + }, + true); + //set box position + callout.box.setAttributes({ + x: opt.x + (x > 0 ? offsetToSide: -(offsetToSide + bbox.width + 2 * offsetBox)), + y: opt.y + (y > 0 ? ( - bbox.height - offsetBox / 2) : ( - bbox.height - offsetBox / 2)), + width: bbox.width + 2 * offsetBox, + height: bbox.height + 2 * offsetBox + }, + true); + //set text position + callout.label.setAttributes({ + x: opt.x + (x > 0 ? (offsetToSide + offsetBox) : -(offsetToSide + bbox.width + offsetBox)), + y: opt.y + (y > 0 ? -bbox.height / 4: -bbox.height / 4) + }, + true); } - - var w = size.width - this.scrollOffset, - h = size.height, - pw = w; - - this.innerCt.setWidth(w); - - // some columns can be percentages while others are fixed - // so we need to make 2 passes - - for(i = 0; i < len; i++){ - c = cs[i]; - m = c.getPositionEl().getMargins('lr'); - margins[i] = m; - if(!c.columnWidth){ - pw -= (c.getWidth() + m); - } + for (p in callout) { + callout[p].show(true); } + }, - pw = pw < 0 ? 0 : pw; + // @private handles sprite animation for the series. + onAnimate: function(sprite, attr) { + sprite.show(); + return this.callParent(arguments); + }, - for(i = 0; i < len; i++){ - c = cs[i]; - m = margins[i]; - if(c.columnWidth){ - c.setSize(Math.floor(c.columnWidth * pw) - m); - } + isItemInPoint: function(x, y, item, i) { + var me = this, + cx = me.centerX, + cy = me.centerY, + abs = Math.abs, + dx = abs(x - cx), + dy = abs(y - cy), + startAngle = item.startAngle, + endAngle = item.endAngle, + rho = Math.sqrt(dx * dx + dy * dy), + angle = Math.atan2(y - cy, x - cx) / me.rad + 360; + + // normalize to the same range of angles created by drawSeries + if (angle > me.firstAngle) { + angle -= 360; } - - // Browsers differ as to when they account for scrollbars. We need to re-measure to see if the scrollbar - // spaces were accounted for properly. If not, re-layout. - if (Ext.isIE) { - if (i = target.getStyle('overflow') && i != 'hidden' && !this.adjustmentPass) { - var ts = this.getLayoutTargetSize(); - if (ts.width != size.width){ - this.adjustmentPass = true; - this.onLayout(ct, target); + return (angle <= startAngle && angle > endAngle + && rho >= item.startRho && rho <= item.endRho); + }, + + // @private hides all elements in the series. + hideAll: function() { + var i, l, shadow, shadows, sh, lsh, sprite; + if (!isNaN(this._index)) { + this.__excludes = this.__excludes || []; + this.__excludes[this._index] = true; + sprite = this.slices[this._index].sprite; + for (sh = 0, lsh = sprite.length; sh < lsh; sh++) { + sprite[sh].setAttributes({ + hidden: true + }, true); + } + if (this.slices[this._index].shadowAttrs) { + for (i = 0, shadows = this.slices[this._index].shadowAttrs, l = shadows.length; i < l; i++) { + shadow = shadows[i]; + for (sh = 0, lsh = shadow.length; sh < lsh; sh++) { + shadow[sh].setAttributes({ + hidden: true + }, true); + } } } + this.drawSeries(); } - delete this.adjustmentPass; - } + }, + + // @private shows all elements in the series. + showAll: function() { + if (!isNaN(this._index)) { + this.__excludes[this._index] = false; + this.drawSeries(); + } + }, /** - * @property activeItem - * @hide + * Highlight the specified item. If no item is provided the whole series will be highlighted. + * @param item {Object} Info about the item; same format as returned by #getItemForPoint */ -}); - -Ext.Container.LAYOUTS['column'] = Ext.layout.ColumnLayout; -/** - * @class Ext.layout.BorderLayout - * @extends Ext.layout.ContainerLayout - * This is a multi-pane, application-oriented UI layout style that supports multiple - * nested panels, automatic {@link Ext.layout.BorderLayout.Region#split split} bars between - * {@link Ext.layout.BorderLayout.Region#BorderLayout.Region regions} and built-in - * {@link Ext.layout.BorderLayout.Region#collapsible expanding and collapsing} of regions. - * This class is intended to be extended or created via the layout:'border' - * {@link Ext.Container#layout} config, and should generally not need to be created directly - * via the new keyword. - * BorderLayout does not have any direct config options (other than inherited ones). - * All configuration options available for customizing the BorderLayout are at the - * {@link Ext.layout.BorderLayout.Region} and {@link Ext.layout.BorderLayout.SplitRegion} - * levels. - * Example usage: - * -var myBorderPanel = new Ext.Panel({ - {@link Ext.Component#renderTo renderTo}: document.body, - {@link Ext.BoxComponent#width width}: 700, - {@link Ext.BoxComponent#height height}: 500, - {@link Ext.Panel#title title}: 'Border Layout', - {@link Ext.Container#layout layout}: 'border', - {@link Ext.Container#items items}: [{ - {@link Ext.Panel#title title}: 'South Region is resizable', - {@link Ext.layout.BorderLayout.Region#BorderLayout.Region region}: 'south', // position for region - {@link Ext.BoxComponent#height height}: 100, - {@link Ext.layout.BorderLayout.Region#split split}: true, // enable resizing - {@link Ext.SplitBar#minSize minSize}: 75, // defaults to {@link Ext.layout.BorderLayout.Region#minHeight 50} - {@link Ext.SplitBar#maxSize maxSize}: 150, - {@link Ext.layout.BorderLayout.Region#margins margins}: '0 5 5 5' - },{ - // xtype: 'panel' implied by default - {@link Ext.Panel#title title}: 'West Region is collapsible', - {@link Ext.layout.BorderLayout.Region#BorderLayout.Region region}:'west', - {@link Ext.layout.BorderLayout.Region#margins margins}: '5 0 0 5', - {@link Ext.BoxComponent#width width}: 200, - {@link Ext.layout.BorderLayout.Region#collapsible collapsible}: true, // make collapsible - {@link Ext.layout.BorderLayout.Region#cmargins cmargins}: '5 5 0 5', // adjust top margin when collapsed - {@link Ext.Component#id id}: 'west-region-container', - {@link Ext.Container#layout layout}: 'fit', - {@link Ext.Panel#unstyled unstyled}: true - },{ - {@link Ext.Panel#title title}: 'Center Region', - {@link Ext.layout.BorderLayout.Region#BorderLayout.Region region}: 'center', // center region is required, no width/height specified - {@link Ext.Component#xtype xtype}: 'container', - {@link Ext.Container#layout layout}: 'fit', - {@link Ext.layout.BorderLayout.Region#margins margins}: '5 5 0 0' - }] -}); - - * Notes: - * Any container using the BorderLayout 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 must have width defined - * (an integer representing the number of pixels that the region should take up). - * Any child items with a region of north or south must have height defined. - * 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) - * is added to the west region: - * -wrc = {@link Ext#getCmp Ext.getCmp}('west-region-container'); -wrc.{@link Ext.Panel#removeAll removeAll}(); -wrc.{@link Ext.Container#add add}({ - title: 'Added Panel', - html: 'Some content' -}); -wrc.{@link Ext.Container#doLayout doLayout}(); - * - * - * To reference a {@link Ext.layout.BorderLayout.Region Region}: - * -wr = myBorderPanel.layout.west; - * - * - * - */ -Ext.layout.BorderLayout = Ext.extend(Ext.layout.ContainerLayout, { - // private - monitorResize:true, - // private - rendered : false, - - type: 'border', - - targetCls: 'x-border-layout-ct', - - getLayoutTargetSize : function() { - var target = this.container.getLayoutTarget(); - return target ? target.getViewSize() : {}; - }, - - // private - onLayout : function(ct, target){ - var collapsed, i, c, pos, items = ct.items.items, len = items.length; - if(!this.rendered){ - collapsed = []; - for(i = 0; i < len; i++) { - c = items[i]; - pos = c.region; - if(c.collapsed){ - collapsed.push(c); - } - c.collapsed = false; - if(!c.rendered){ - c.render(target, i); - c.getPositionEl().addClass('x-border-panel'); - } - this[pos] = pos != 'center' && c.split ? - new Ext.layout.BorderLayout.SplitRegion(this, c.initialConfig, pos) : - new Ext.layout.BorderLayout.Region(this, c.initialConfig, pos); - this[pos].render(target, c); - } - this.rendered = true; - } - - var size = this.getLayoutTargetSize(); - if(size.width < 20 || size.height < 20){ // display none? - if(collapsed){ - this.restoreCollapsed = collapsed; - } + highlightItem: function(item) { + var me = this, + rad = me.rad; + item = item || this.items[this._index]; + + //TODO(nico): sometimes in IE itemmouseover is triggered + //twice without triggering itemmouseout in between. This + //fixes the highlighting bug. Eventually, events should be + //changed to trigger one itemmouseout between two itemmouseovers. + this.unHighlightItem(); + + if (!item || item.sprite && item.sprite._animating) { return; - }else if(this.restoreCollapsed){ - collapsed = this.restoreCollapsed; - delete this.restoreCollapsed; - } - - var w = size.width, h = size.height, - centerW = w, centerH = h, centerY = 0, centerX = 0, - n = this.north, s = this.south, west = this.west, e = this.east, c = this.center, - b, m, totalWidth, totalHeight; - if(!c && Ext.layout.BorderLayout.WARN !== false){ - throw 'No center region defined in BorderLayout ' + ct.id; - } - - if(n && n.isVisible()){ - b = n.getSize(); - m = n.getMargins(); - b.width = w - (m.left+m.right); - b.x = m.left; - b.y = m.top; - centerY = b.height + b.y + m.bottom; - centerH -= centerY; - n.applyLayout(b); - } - if(s && s.isVisible()){ - b = s.getSize(); - m = s.getMargins(); - b.width = w - (m.left+m.right); - b.x = m.left; - totalHeight = (b.height + m.top + m.bottom); - b.y = h - totalHeight + m.top; - centerH -= totalHeight; - s.applyLayout(b); - } - if(west && west.isVisible()){ - b = west.getSize(); - m = west.getMargins(); - b.height = centerH - (m.top+m.bottom); - b.x = m.left; - b.y = centerY + m.top; - totalWidth = (b.width + m.left + m.right); - centerX += totalWidth; - centerW -= totalWidth; - west.applyLayout(b); - } - if(e && e.isVisible()){ - b = e.getSize(); - m = e.getMargins(); - b.height = centerH - (m.top+m.bottom); - totalWidth = (b.width + m.left + m.right); - b.x = w - totalWidth + m.left; - b.y = centerY + m.top; - centerW -= totalWidth; - e.applyLayout(b); } - if(c){ - m = c.getMargins(); - var centerBox = { - x: centerX + m.left, - y: centerY + m.top, - width: centerW - (m.left+m.right), - height: centerH - (m.top+m.bottom) - }; - c.applyLayout(centerBox); - } - if(collapsed){ - for(i = 0, len = collapsed.length; i < len; i++){ - collapsed[i].collapse(false); - } - } - if(Ext.isIE && Ext.isStrict){ // workaround IE strict repainting issue - target.repaint(); + me.callParent([item]); + if (!me.highlight) { + return; } - // Putting a border layout into an overflowed container is NOT correct and will make a second layout pass necessary. - if (i = target.getStyle('overflow') && i != 'hidden' && !this.adjustmentPass) { - var ts = this.getLayoutTargetSize(); - if (ts.width != size.width || ts.height != size.height){ - this.adjustmentPass = true; - this.onLayout(ct, target); + if ('segment' in me.highlightCfg) { + var highlightSegment = me.highlightCfg.segment, + animate = me.chart.animate, + attrs, i, shadows, shadow, ln, to, itemHighlightSegment, prop; + //animate labels + if (me.labelsGroup) { + var group = me.labelsGroup, + display = me.label.display, + label = group.getAt(item.index), + middle = (item.startAngle + item.endAngle) / 2 * rad, + r = highlightSegment.margin || 0, + x = r * Math.cos(middle), + y = r * Math.sin(middle); + + //TODO(nico): rounding to 1e-10 + //gives the right translation. Translation + //was buggy for very small numbers. In this + //case we're not looking to translate to very small + //numbers but not to translate at all. + if (Math.abs(x) < 1e-10) { + x = 0; + } + if (Math.abs(y) < 1e-10) { + y = 0; + } + + if (animate) { + label.stopAnimation(); + label.animate({ + to: { + translate: { + x: x, + y: y + } + }, + duration: me.highlightDuration + }); + } + else { + label.setAttributes({ + translate: { + x: x, + y: y + } + }, true); + } } - } - delete this.adjustmentPass; - }, - - destroy: function() { - var r = ['north', 'south', 'east', 'west'], i, region; - for (i = 0; i < r.length; i++) { - region = this[r[i]]; - if(region){ - if(region.destroy){ - region.destroy(); - }else if (region.split){ - region.split.destroy(true); + //animate shadows + if (me.chart.shadow && item.shadows) { + i = 0; + shadows = item.shadows; + ln = shadows.length; + for (; i < ln; i++) { + shadow = shadows[i]; + to = {}; + itemHighlightSegment = item.sprite._from.segment; + for (prop in itemHighlightSegment) { + if (! (prop in highlightSegment)) { + to[prop] = itemHighlightSegment[prop]; + } + } + attrs = { + segment: Ext.applyIf(to, me.highlightCfg.segment) + }; + if (animate) { + shadow.stopAnimation(); + shadow.animate({ + to: attrs, + duration: me.highlightDuration + }); + } + else { + shadow.setAttributes(attrs, true); + } } } } - Ext.layout.BorderLayout.superclass.destroy.call(this); - } + }, /** - * @property activeItem - * @hide + * un-highlights the specified item. If no item is provided it will un-highlight the entire series. + * @param item {Object} Info about the item; same format as returned by #getItemForPoint */ -}); - -/** - * @class Ext.layout.BorderLayout.Region - * This is a region of a {@link Ext.layout.BorderLayout BorderLayout} that acts as a subcontainer - * within the layout. Each region has its own {@link Ext.layout.ContainerLayout layout} that is - * independent of other regions and the containing BorderLayout, and can be any of the - * {@link Ext.layout.ContainerLayout valid Ext layout types}. - * Region size is managed automatically and cannot be changed by the user -- for - * {@link #split resizable regions}, see {@link Ext.layout.BorderLayout.SplitRegion}. - * @constructor - * Create a new Region. - * @param {Layout} layout The {@link Ext.layout.BorderLayout BorderLayout} instance that is managing this Region. - * @param {Object} config The configuration options - * @param {String} position The region position. Valid values are: north, south, - * east, west and center. Every {@link Ext.layout.BorderLayout BorderLayout} - * must have a center region for the primary content -- all other regions are optional. - */ -Ext.layout.BorderLayout.Region = function(layout, config, pos){ - Ext.apply(this, config); - this.layout = layout; - this.position = pos; - this.state = {}; - if(typeof this.margins == 'string'){ - this.margins = this.layout.parseMargins(this.margins); - } - this.margins = Ext.applyIf(this.margins || {}, this.defaultMargins); - if(this.collapsible){ - if(typeof this.cmargins == 'string'){ - this.cmargins = this.layout.parseMargins(this.cmargins); - } - if(this.collapseMode == 'mini' && !this.cmargins){ - this.cmargins = {left:0,top:0,right:0,bottom:0}; - }else{ - this.cmargins = Ext.applyIf(this.cmargins || {}, - pos == 'north' || pos == 'south' ? this.defaultNSCMargins : this.defaultEWCMargins); + unHighlightItem: function() { + var me = this; + if (!me.highlight) { + return; } - } -}; -Ext.layout.BorderLayout.Region.prototype = { - /** - * @cfg {Boolean} animFloat - * When a collapsed region's bar is clicked, the region's panel will be displayed as a floated - * panel that will close again once the user mouses out of that panel (or clicks out if - * {@link #autoHide} = false). Setting {@link #animFloat} = false will - * prevent the open and close of these floated panels from being animated (defaults to true). - */ - /** - * @cfg {Boolean} autoHide - * When a collapsed region's bar is clicked, the region's panel will be displayed as a floated - * panel. If autoHide = true, the panel will automatically hide after the user mouses - * out of the panel. If autoHide = false, the panel will continue to display until the - * user clicks outside of the panel (defaults to true). - */ - /** - * @cfg {String} collapseMode - * collapseMode supports two configuration values: - * undefined (default)By default, {@link #collapsible} - * regions are collapsed by clicking the expand/collapse tool button that renders into the region's - * title bar. - * 'mini'Optionally, when collapseMode is set to - * 'mini' the region's split bar will also display a small collapse button in the center of - * the bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode. - * - * - * Note: if a collapsible region does not have a title bar, then set collapseMode = - * 'mini' and {@link #split} = true in order for the region to be {@link #collapsible} - * by the user as the expand/collapse tool button (that would go in the title bar) will not be rendered. - * See also {@link #cmargins}. - */ - /** - * @cfg {Object} margins - * An object containing margins to apply to the region when in the expanded state in the - * format: -{ - top: (top margin), - right: (right margin), - bottom: (bottom margin), - left: (left margin) -} - * May also be a string containing space-separated, numeric margin values. The order of the - * sides associated with each value matches the way CSS processes margin values: - * - * If there is only one value, it applies to all sides. - * If there are two values, the top and bottom borders are set to the first value and the - * right and left are set to the second. - * If there are three values, the top is set to the first value, the left and right are set - * to the second, and the bottom is set to the third. - * If there are four values, they apply to the top, right, bottom, and left, respectively. - * - * Defaults to: - * {top:0, right:0, bottom:0, left:0} - * - */ - /** - * @cfg {Object} cmargins - * An object containing margins to apply to the region when in the collapsed state in the - * format: -{ - top: (top margin), - right: (right margin), - bottom: (bottom margin), - left: (left margin) -} - * May also be a string containing space-separated, numeric margin values. The order of the - * sides associated with each value matches the way CSS processes margin values. - * - * If there is only one value, it applies to all sides. - * If there are two values, the top and bottom borders are set to the first value and the - * right and left are set to the second. - * If there are three values, the top is set to the first value, the left and right are set - * to the second, and the bottom is set to the third. - * If there are four values, they apply to the top, right, bottom, and left, respectively. - * - */ - /** - * @cfg {Boolean} collapsible - * true to allow the user to collapse this region (defaults to false). If - * true, an expand/collapse tool button will automatically be rendered into the title - * bar of the region, otherwise the button will not be shown. - * Note: that a title bar is required to display the collapse/expand toggle button -- if - * no title is specified for the region's panel, the region will only be collapsible if - * {@link #collapseMode} = 'mini' and {@link #split} = true. - */ - collapsible : false, - /** - * @cfg {Boolean} split - * true to create a {@link Ext.layout.BorderLayout.SplitRegion SplitRegion} and - * display a 5px wide {@link Ext.SplitBar} between this region and its neighbor, allowing the user to - * resize the regions dynamically. Defaults to false creating a - * {@link Ext.layout.BorderLayout.Region Region}. - * Notes: - * this configuration option is ignored if region='center' - * when split == true, it is common to specify a - * {@link Ext.SplitBar#minSize minSize} and {@link Ext.SplitBar#maxSize maxSize} - * for the {@link Ext.BoxComponent BoxComponent} representing the region. These are not native - * configs of {@link Ext.BoxComponent BoxComponent}, and are used only by this class. - * if {@link #collapseMode} = 'mini' requires split = true to reserve space - * for the collapse tool - * - */ - split:false, - /** - * @cfg {Boolean} floatable - * true to allow clicking a collapsed region's bar to display the region's panel floated - * above the layout, false to force the user to fully expand a collapsed region by - * clicking the expand button to see it again (defaults to true). - */ - floatable: true, - /** - * @cfg {Number} minWidth - * The minimum allowable width in pixels for this region (defaults to 50). - * maxWidth may also be specified. - * Note: setting the {@link Ext.SplitBar#minSize minSize} / - * {@link Ext.SplitBar#maxSize maxSize} supersedes any specified - * minWidth / maxWidth. - */ - minWidth:50, + if (('segment' in me.highlightCfg) && me.items) { + var items = me.items, + animate = me.chart.animate, + shadowsEnabled = !!me.chart.shadow, + group = me.labelsGroup, + len = items.length, + i = 0, + j = 0, + display = me.label.display, + shadowLen, p, to, ihs, hs, sprite, shadows, shadow, item, label, attrs; + + for (; i < len; i++) { + item = items[i]; + if (!item) { + continue; + } + sprite = item.sprite; + if (sprite && sprite._highlighted) { + //animate labels + if (group) { + label = group.getAt(item.index); + attrs = Ext.apply({ + translate: { + x: 0, + y: 0 + } + }, + display == 'rotate' ? { + rotate: { + x: label.attr.x, + y: label.attr.y, + degrees: label.attr.rotation.degrees + } + }: {}); + if (animate) { + label.stopAnimation(); + label.animate({ + to: attrs, + duration: me.highlightDuration + }); + } + else { + label.setAttributes(attrs, true); + } + } + if (shadowsEnabled) { + shadows = item.shadows; + shadowLen = shadows.length; + for (; j < shadowLen; j++) { + to = {}; + ihs = item.sprite._to.segment; + hs = item.sprite._from.segment; + Ext.apply(to, hs); + for (p in ihs) { + if (! (p in hs)) { + to[p] = ihs[p]; + } + } + shadow = shadows[j]; + if (animate) { + shadow.stopAnimation(); + shadow.animate({ + to: { + segment: to + }, + duration: me.highlightDuration + }); + } + else { + shadow.setAttributes({ segment: to }, true); + } + } + } + } + } + } + me.callParent(arguments); + }, + /** - * @cfg {Number} minHeight - * The minimum allowable height in pixels for this region (defaults to 50) - * maxHeight may also be specified. - * Note: setting the {@link Ext.SplitBar#minSize minSize} / - * {@link Ext.SplitBar#maxSize maxSize} supersedes any specified - * minHeight / maxHeight. + * Returns the color of the series (to be displayed as color for the series legend item). + * @param item {Object} Info about the item; same format as returned by #getItemForPoint */ - minHeight:50, + getLegendColor: function(index) { + var me = this; + return me.colorArrayStyle[index % me.colorArrayStyle.length]; + } +}); - // private - defaultMargins : {left:0,top:0,right:0,bottom:0}, - // private - defaultNSCMargins : {left:5,top:5,right:5,bottom:5}, - // private - defaultEWCMargins : {left:5,top:0,right:5,bottom:0}, - floatingZIndex: 100, - /** - * True if this region is collapsed. Read-only. - * @type Boolean - * @property - */ - isCollapsed : false, +/** + * @class Ext.chart.series.Radar + * @extends Ext.chart.series.Series + * + * Creates a Radar Chart. A Radar Chart is a useful visualization technique for comparing different quantitative values for + * a constrained number of categories. + * As with all other series, the Radar series must be appended in the *series* Chart array configuration. See the Chart + * documentation for more information. A typical configuration object for the radar series could be: + * + * {@img Ext.chart.series.Radar/Ext.chart.series.Radar.png Ext.chart.series.Radar chart series} + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * animate: true, + * theme:'Category2', + * store: store, + * axes: [{ + * type: 'Radial', + * position: 'radial', + * label: { + * display: true + * } + * }], + * series: [{ + * type: 'radar', + * xField: 'name', + * yField: 'data3', + * showInLegend: true, + * showMarkers: true, + * markerConfig: { + * radius: 5, + * size: 5 + * }, + * style: { + * 'stroke-width': 2, + * fill: 'none' + * } + * },{ + * type: 'radar', + * xField: 'name', + * yField: 'data2', + * showMarkers: true, + * showInLegend: true, + * markerConfig: { + * radius: 5, + * size: 5 + * }, + * style: { + * 'stroke-width': 2, + * fill: 'none' + * } + * },{ + * type: 'radar', + * xField: 'name', + * yField: 'data5', + * showMarkers: true, + * showInLegend: true, + * markerConfig: { + * radius: 5, + * size: 5 + * }, + * style: { + * 'stroke-width': 2, + * fill: 'none' + * } + * }] + * }); + * + * In this configuration we add three series to the chart. Each of these series is bound to the same categories field, `name` but bound to different properties for each category, + * `data1`, `data2` and `data3` respectively. All series display markers by having `showMarkers` enabled. The configuration for the markers of each series can be set by adding properties onto + * the markerConfig object. Finally we override some theme styling properties by adding properties to the `style` object. + * + * @xtype radar + */ +Ext.define('Ext.chart.series.Radar', { + + /* Begin Definitions */ + + extend: 'Ext.chart.series.Series', + + requires: ['Ext.chart.Shape', 'Ext.fx.Anim'], + + /* End Definitions */ + + type: "radar", + alias: 'series.radar', + + + rad: Math.PI / 180, + + showInLegend: false, /** - * This region's panel. Read-only. - * @type Ext.Panel - * @property panel - */ - /** - * This region's layout. Read-only. - * @type Layout - * @property layout + * @cfg {Object} style + * An object containing styles for overriding series styles from Theming. */ + style: {}, + + constructor: function(config) { + this.callParent(arguments); + var me = this, + surface = me.chart.surface, i, l; + me.group = surface.getGroup(me.seriesId); + if (me.showMarkers) { + me.markerGroup = surface.getGroup(me.seriesId + '-markers'); + } + }, + /** - * This region's layout position (north, south, east, west or center). Read-only. - * @type String - * @property position + * Draws the series for the current chart. */ + drawSeries: function() { + var me = this, + store = me.chart.substore || me.chart.store, + group = me.group, + sprite, + chart = me.chart, + animate = chart.animate, + field = me.field || me.yField, + surface = chart.surface, + chartBBox = chart.chartBBox, + rendererAttributes, + centerX, centerY, + items, + radius, + maxValue = 0, + fields = [], + max = Math.max, + cos = Math.cos, + sin = Math.sin, + pi2 = Math.PI * 2, + l = store.getCount(), + startPath, path, x, y, rho, + i, nfields, + seriesStyle = me.seriesStyle, + seriesLabelStyle = me.seriesLabelStyle, + first = chart.resizing || !me.radar, + axis = chart.axes && chart.axes.get(0), + aggregate = !(axis && axis.maximum); + + me.setBBox(); - // private - render : function(ct, p){ - this.panel = p; - p.el.enableDisplayMode(); - this.targetEl = ct; - this.el = p.el; - - var gs = p.getState, ps = this.position; - p.getState = function(){ - return Ext.apply(gs.call(p) || {}, this.state); - }.createDelegate(this); - - if(ps != 'center'){ - p.allowQueuedExpand = false; - p.on({ - beforecollapse: this.beforeCollapse, - collapse: this.onCollapse, - beforeexpand: this.beforeExpand, - expand: this.onExpand, - hide: this.onHide, - show: this.onShow, - scope: this + maxValue = aggregate? 0 : (axis.maximum || 0); + + Ext.apply(seriesStyle, me.style || {}); + + //if the store is empty then there's nothing to draw + if (!store || !store.getCount()) { + return; + } + + me.unHighlightItem(); + me.cleanHighlights(); + + centerX = me.centerX = chartBBox.x + (chartBBox.width / 2); + centerY = me.centerY = chartBBox.y + (chartBBox.height / 2); + me.radius = radius = Math.min(chartBBox.width, chartBBox.height) /2; + me.items = items = []; + + if (aggregate) { + //get all renderer fields + chart.series.each(function(series) { + fields.push(series.yField); }); - if(this.collapsible || this.floatable){ - p.collapseEl = 'el'; - p.slideAnchor = this.getSlideAnchor(); - } - if(p.tools && p.tools.toggle){ - p.tools.toggle.addClass('x-tool-collapse-'+ps); - p.tools.toggle.addClassOnOver('x-tool-collapse-'+ps+'-over'); + //get maxValue to interpolate + store.each(function(record, i) { + for (i = 0, nfields = fields.length; i < nfields; i++) { + maxValue = max(+record.get(fields[i]), maxValue); + } + }); + } + //ensure non-zero value. + maxValue = maxValue || 1; + //create path and items + startPath = []; path = []; + store.each(function(record, i) { + rho = radius * record.get(field) / maxValue; + x = rho * cos(i / l * pi2); + y = rho * sin(i / l * pi2); + if (i == 0) { + path.push('M', x + centerX, y + centerY); + startPath.push('M', 0.01 * x + centerX, 0.01 * y + centerY); + } else { + path.push('L', x + centerX, y + centerY); + startPath.push('L', 0.01 * x + centerX, 0.01 * y + centerY); } + items.push({ + sprite: false, //TODO(nico): add markers + point: [centerX + x, centerY + y], + series: me + }); + }); + path.push('Z'); + //create path sprite + if (!me.radar) { + me.radar = surface.add(Ext.apply({ + type: 'path', + group: group, + path: startPath + }, seriesStyle || {})); + } + //reset on resizing + if (chart.resizing) { + me.radar.setAttributes({ + path: startPath + }, true); + } + //render/animate + if (chart.animate) { + me.onAnimate(me.radar, { + to: Ext.apply({ + path: path + }, seriesStyle || {}) + }); + } else { + me.radar.setAttributes(Ext.apply({ + path: path + }, seriesStyle || {}), true); } + //render markers, labels and callouts + if (me.showMarkers) { + me.drawMarkers(); + } + me.renderLabels(); + me.renderCallouts(); }, - - // private - getCollapsedEl : function(){ - if(!this.collapsedEl){ - if(!this.toolTemplate){ - var tt = new Ext.Template( - ' ' - ); - tt.disableFormats = true; - tt.compile(); - Ext.layout.BorderLayout.Region.prototype.toolTemplate = tt; + + // @private draws the markers for the lines (if any). + drawMarkers: function() { + var me = this, + chart = me.chart, + surface = chart.surface, + markerStyle = Ext.apply({}, me.markerStyle || {}), + endMarkerStyle = Ext.apply(markerStyle, me.markerConfig), + items = me.items, + type = endMarkerStyle.type, + markerGroup = me.markerGroup, + centerX = me.centerX, + centerY = me.centerY, + item, i, l, marker; + + delete endMarkerStyle.type; + + for (i = 0, l = items.length; i < l; i++) { + item = items[i]; + marker = markerGroup.getAt(i); + if (!marker) { + marker = Ext.chart.Shape[type](surface, Ext.apply({ + group: markerGroup, + x: 0, + y: 0, + translate: { + x: centerX, + y: centerY + } + }, endMarkerStyle)); } - this.collapsedEl = this.targetEl.createChild({ - cls: "x-layout-collapsed x-layout-collapsed-"+this.position, - id: this.panel.id + '-xcollapsed' - }); - this.collapsedEl.enableDisplayMode('block'); - - if(this.collapseMode == 'mini'){ - this.collapsedEl.addClass('x-layout-cmini-'+this.position); - this.miniCollapsedEl = this.collapsedEl.createChild({ - cls: "x-layout-mini x-layout-mini-"+this.position, html: " " - }); - this.miniCollapsedEl.addClassOnOver('x-layout-mini-over'); - this.collapsedEl.addClassOnOver("x-layout-collapsed-over"); - this.collapsedEl.on('click', this.onExpandClick, this, {stopEvent:true}); - }else { - if(this.collapsible !== false && !this.hideCollapseTool) { - var t = this.expandToolEl = this.toolTemplate.append( - this.collapsedEl.dom, - {id:'expand-'+this.position}, true); - t.addClassOnOver('x-tool-expand-'+this.position+'-over'); - t.on('click', this.onExpandClick, this, {stopEvent:true}); - } - if(this.floatable !== false || this.titleCollapse){ - this.collapsedEl.addClassOnOver("x-layout-collapsed-over"); - this.collapsedEl.on("click", this[this.floatable ? 'collapseClick' : 'onExpandClick'], this); + else { + marker.show(); + } + if (chart.resizing) { + marker.setAttributes({ + x: 0, + y: 0, + translate: { + x: centerX, + y: centerY + } + }, true); + } + marker._to = { + translate: { + x: item.point[0], + y: item.point[1] } + }; + //render/animate + if (chart.animate) { + me.onAnimate(marker, { + to: marker._to + }); + } + else { + marker.setAttributes(Ext.apply(marker._to, endMarkerStyle || {}), true); } } - return this.collapsedEl; }, - - // private - onExpandClick : function(e){ - if(this.isSlid){ - this.panel.expand(false); - }else{ - this.panel.expand(); - } + + isItemInPoint: function(x, y, item) { + var point, + tolerance = 10, + abs = Math.abs; + point = item.point; + return (abs(point[0] - x) <= tolerance && + abs(point[1] - y) <= tolerance); }, - // private - onCollapseClick : function(e){ - this.panel.collapse(); + // @private callback for when creating a label sprite. + onCreateLabel: function(storeItem, item, i, display) { + var me = this, + group = me.labelsGroup, + config = me.label, + centerX = me.centerX, + centerY = me.centerY, + point = item.point, + endLabelStyle = Ext.apply(me.seriesLabelStyle || {}, config); + + return me.chart.surface.add(Ext.apply({ + 'type': 'text', + 'text-anchor': 'middle', + 'group': group, + 'x': centerX, + 'y': centerY + }, config || {})); }, - // private - beforeCollapse : function(p, animate){ - this.lastAnim = animate; - if(this.splitEl){ - this.splitEl.hide(); - } - this.getCollapsedEl().show(); - var el = this.panel.getEl(); - this.originalZIndex = el.getStyle('z-index'); - el.setStyle('z-index', 100); - this.isCollapsed = true; - this.layout.layout(); - }, + // @private callback for when placing a label sprite. + onPlaceLabel: function(label, storeItem, item, i, display, animate) { + var me = this, + chart = me.chart, + resizing = chart.resizing, + config = me.label, + format = config.renderer, + field = config.field, + centerX = me.centerX, + centerY = me.centerY, + opt = { + x: item.point[0], + y: item.point[1] + }, + x = opt.x - centerX, + y = opt.y - centerY; - // private - onCollapse : function(animate){ - this.panel.el.setStyle('z-index', 1); - if(this.lastAnim === false || this.panel.animCollapse === false){ - this.getCollapsedEl().dom.style.visibility = 'visible'; - }else{ - this.getCollapsedEl().slideIn(this.panel.slideAnchor, {duration:.2}); + label.setAttributes({ + text: format(storeItem.get(field)), + hidden: true + }, + true); + + if (resizing) { + label.setAttributes({ + x: centerX, + y: centerY + }, true); + } + + if (animate) { + label.show(true); + me.onAnimate(label, { + to: opt + }); + } else { + label.setAttributes(opt, true); + label.show(true); } - this.state.collapsed = true; - this.panel.saveState(); }, - // private - beforeExpand : function(animate){ - if(this.isSlid){ - this.afterSlideIn(); + // @private for toggling (show/hide) series. + toggleAll: function(show) { + var me = this, + i, ln, shadow, shadows; + if (!show) { + Ext.chart.series.Radar.superclass.hideAll.call(me); } - var c = this.getCollapsedEl(); - this.el.show(); - if(this.position == 'east' || this.position == 'west'){ - this.panel.setSize(undefined, c.getHeight()); - }else{ - this.panel.setSize(c.getWidth(), undefined); + else { + Ext.chart.series.Radar.superclass.showAll.call(me); + } + if (me.radar) { + me.radar.setAttributes({ + hidden: !show + }, true); + //hide shadows too + if (me.radar.shadows) { + for (i = 0, shadows = me.radar.shadows, ln = shadows.length; i < ln; i++) { + shadow = shadows[i]; + shadow.setAttributes({ + hidden: !show + }, true); + } + } } - c.hide(); - c.dom.style.visibility = 'hidden'; - this.panel.el.setStyle('z-index', this.floatingZIndex); }, - - // private - onExpand : function(){ - this.isCollapsed = false; - if(this.splitEl){ - this.splitEl.show(); - } - this.layout.layout(); - this.panel.el.setStyle('z-index', this.originalZIndex); - this.state.collapsed = false; - this.panel.saveState(); + + // @private hide all elements in the series. + hideAll: function() { + this.toggleAll(false); + this.hideMarkers(0); }, - - // private - collapseClick : function(e){ - if(this.isSlid){ - e.stopPropagation(); - this.slideIn(); - }else{ - e.stopPropagation(); - this.slideOut(); - } + + // @private show all elements in the series. + showAll: function() { + this.toggleAll(true); }, - - // private - onHide : function(){ - if(this.isCollapsed){ - this.getCollapsedEl().hide(); - }else if(this.splitEl){ - this.splitEl.hide(); + + // @private hide all markers that belong to `markerGroup` + hideMarkers: function(index) { + var me = this, + count = me.markerGroup && me.markerGroup.getCount() || 0, + i = index || 0; + for (; i < count; i++) { + me.markerGroup.getAt(i).hide(true); } - }, + } +}); - // private - onShow : function(){ - if(this.isCollapsed){ - this.getCollapsedEl().show(); - }else if(this.splitEl){ - this.splitEl.show(); - } - }, - /** - * True if this region is currently visible, else false. - * @return {Boolean} - */ - isVisible : function(){ - return !this.panel.hidden; - }, +/** + * @class Ext.chart.series.Scatter + * @extends Ext.chart.series.Cartesian + * + * Creates a Scatter Chart. The scatter plot is useful when trying to display more than two variables in the same visualization. + * These variables can be mapped into x, y coordinates and also to an element's radius/size, color, etc. + * As with all other series, the Scatter Series must be appended in the *series* Chart array configuration. See the Chart + * documentation for more information on creating charts. A typical configuration object for the scatter could be: + * + * {@img Ext.chart.series.Scatter/Ext.chart.series.Scatter.png Ext.chart.series.Scatter chart series} + * + * var store = Ext.create('Ext.data.JsonStore', { + * fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'], + * data: [ + * {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13}, + * {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3}, + * {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7}, + * {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23}, + * {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} + * ] + * }); + * + * Ext.create('Ext.chart.Chart', { + * renderTo: Ext.getBody(), + * width: 500, + * height: 300, + * animate: true, + * theme:'Category2', + * store: store, + * axes: [{ + * type: 'Numeric', + * position: 'bottom', + * fields: ['data1', 'data2', 'data3'], + * title: 'Sample Values', + * grid: true, + * minimum: 0 + * }, { + * type: 'Category', + * position: 'left', + * fields: ['name'], + * title: 'Sample Metrics' + * }], + * series: [{ + * type: 'scatter', + * markerConfig: { + * radius: 5, + * size: 5 + * }, + * axis: 'left', + * xField: 'name', + * yField: 'data2' + * }, { + * type: 'scatter', + * markerConfig: { + * radius: 5, + * size: 5 + * }, + * axis: 'left', + * xField: 'name', + * yField: 'data3' + * }] + * }); + * + * In this configuration we add three different categories of scatter series. Each of them is bound to a different field of the same data store, + * `data1`, `data2` and `data3` respectively. All x-fields for the series must be the same field, in this case `name`. + * Each scatter series has a different styling configuration for markers, specified by the `markerConfig` object. Finally we set the left axis as + * axis to show the current values of the elements. + * + * @xtype scatter + */ +Ext.define('Ext.chart.series.Scatter', { - /** - * Returns the current margins for this region. If the region is collapsed, the - * {@link #cmargins} (collapsed margins) value will be returned, otherwise the - * {@link #margins} value will be returned. - * @return {Object} An object containing the element's margins: {left: (left - * margin), top: (top margin), right: (right margin), bottom: (bottom margin)} - */ - getMargins : function(){ - return this.isCollapsed && this.cmargins ? this.cmargins : this.margins; - }, + /* Begin Definitions */ - /** - * Returns the current size of this region. If the region is collapsed, the size of the - * collapsedEl will be returned, otherwise the size of the region's panel will be returned. - * @return {Object} An object containing the element's size: {width: (element width), - * height: (element height)} - */ - getSize : function(){ - return this.isCollapsed ? this.getCollapsedEl().getSize() : this.panel.getSize(); - }, + extend: 'Ext.chart.series.Cartesian', - /** - * Sets the specified panel as the container element for this region. - * @param {Ext.Panel} panel The new panel - */ - setPanel : function(panel){ - this.panel = panel; - }, + requires: ['Ext.chart.axis.Axis', 'Ext.chart.Shape', 'Ext.fx.Anim'], + + /* End Definitions */ + + type: 'scatter', + alias: 'series.scatter', /** - * Returns the minimum allowable width for this region. - * @return {Number} The minimum width + * @cfg {Object} markerConfig + * The display style for the scatter series markers. */ - getMinWidth: function(){ - return this.minWidth; - }, - + /** - * Returns the minimum allowable height for this region. - * @return {Number} The minimum height + * @cfg {Object} style + * Append styling properties to this object for it to override theme properties. */ - getMinHeight: function(){ - return this.minHeight; - }, - // private - applyLayoutCollapsed : function(box){ - var ce = this.getCollapsedEl(); - ce.setLeftTop(box.x, box.y); - ce.setSize(box.width, box.height); + constructor: function(config) { + this.callParent(arguments); + var me = this, + shadow = me.chart.shadow, + surface = me.chart.surface, i, l; + Ext.apply(me, config, { + style: {}, + markerConfig: {}, + shadowAttributes: [{ + "stroke-width": 6, + "stroke-opacity": 0.05, + stroke: 'rgb(0, 0, 0)' + }, { + "stroke-width": 4, + "stroke-opacity": 0.1, + stroke: 'rgb(0, 0, 0)' + }, { + "stroke-width": 2, + "stroke-opacity": 0.15, + stroke: 'rgb(0, 0, 0)' + }] + }); + me.group = surface.getGroup(me.seriesId); + if (shadow) { + for (i = 0, l = me.shadowAttributes.length; i < l; i++) { + me.shadowGroups.push(surface.getGroup(me.seriesId + '-shadows' + i)); + } + } }, - // private - applyLayout : function(box){ - if(this.isCollapsed){ - this.applyLayoutCollapsed(box); - }else{ - this.panel.setPosition(box.x, box.y); - this.panel.setSize(box.width, box.height); + // @private Get chart and data boundaries + getBounds: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + axes = [].concat(me.axis), + bbox, xScale, yScale, ln, minX, minY, maxX, maxY, i, axis, ends; + + me.setBBox(); + bbox = me.bbox; + + for (i = 0, ln = axes.length; i < ln; i++) { + axis = chart.axes.get(axes[i]); + if (axis) { + ends = axis.calcEnds(); + if (axis.position == 'top' || axis.position == 'bottom') { + minX = ends.from; + maxX = ends.to; + } + else { + minY = ends.from; + maxY = ends.to; + } + } + } + // If a field was specified without a corresponding axis, create one to get bounds + if (me.xField && !Ext.isNumber(minX)) { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.xField) + }).calcEnds(); + minX = axis.from; + maxX = axis.to; + } + if (me.yField && !Ext.isNumber(minY)) { + axis = Ext.create('Ext.chart.axis.Axis', { + chart: chart, + fields: [].concat(me.yField) + }).calcEnds(); + minY = axis.from; + maxY = axis.to; + } + + if (isNaN(minX)) { + minX = 0; + maxX = store.getCount() - 1; + xScale = bbox.width / (store.getCount() - 1); + } + else { + xScale = bbox.width / (maxX - minX); } + + if (isNaN(minY)) { + minY = 0; + maxY = store.getCount() - 1; + yScale = bbox.height / (store.getCount() - 1); + } + else { + yScale = bbox.height / (maxY - minY); + } + + return { + bbox: bbox, + minX: minX, + minY: minY, + xScale: xScale, + yScale: yScale + }; }, - // private - beforeSlide: function(){ - this.panel.beforeEffect(); + // @private Build an array of paths for the chart + getPaths: function() { + var me = this, + chart = me.chart, + enableShadows = chart.shadow, + store = chart.substore || chart.store, + group = me.group, + bounds = me.bounds = me.getBounds(), + bbox = me.bbox, + xScale = bounds.xScale, + yScale = bounds.yScale, + minX = bounds.minX, + minY = bounds.minY, + boxX = bbox.x, + boxY = bbox.y, + boxHeight = bbox.height, + items = me.items = [], + attrs = [], + x, y, xValue, yValue, sprite; + + store.each(function(record, i) { + xValue = record.get(me.xField); + yValue = record.get(me.yField); + //skip undefined values + if (typeof yValue == 'undefined' || (typeof yValue == 'string' && !yValue)) { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn("[Ext.chart.series.Scatter] Skipping a store element with an undefined value at ", record, xValue, yValue); + } + return; + } + // Ensure a value + if (typeof xValue == 'string' || typeof xValue == 'object') { + xValue = i; + } + if (typeof yValue == 'string' || typeof yValue == 'object') { + yValue = i; + } + x = boxX + (xValue - minX) * xScale; + y = boxY + boxHeight - (yValue - minY) * yScale; + attrs.push({ + x: x, + y: y + }); + + me.items.push({ + series: me, + value: [xValue, yValue], + point: [x, y], + storeItem: record + }); + + // When resizing, reset before animating + if (chart.animate && chart.resizing) { + sprite = group.getAt(i); + if (sprite) { + me.resetPoint(sprite); + if (enableShadows) { + me.resetShadow(sprite); + } + } + } + }); + return attrs; }, - // private - afterSlide : function(){ - this.panel.afterEffect(); + // @private translate point to the center + resetPoint: function(sprite) { + var bbox = this.bbox; + sprite.setAttributes({ + translate: { + x: (bbox.x + bbox.width) / 2, + y: (bbox.y + bbox.height) / 2 + } + }, true); }, - // private - initAutoHide : function(){ - if(this.autoHide !== false){ - if(!this.autoHideHd){ - this.autoHideSlideTask = new Ext.util.DelayedTask(this.slideIn, this); - this.autoHideHd = { - "mouseout": function(e){ - if(!e.within(this.el, true)){ - this.autoHideSlideTask.delay(500); - } - }, - "mouseover" : function(e){ - this.autoHideSlideTask.cancel(); - }, - scope : this + // @private translate shadows of a sprite to the center + resetShadow: function(sprite) { + var me = this, + shadows = sprite.shadows, + shadowAttributes = me.shadowAttributes, + ln = me.shadowGroups.length, + bbox = me.bbox, + i, attr; + for (i = 0; i < ln; i++) { + attr = Ext.apply({}, shadowAttributes[i]); + if (attr.translate) { + attr.translate.x += (bbox.x + bbox.width) / 2; + attr.translate.y += (bbox.y + bbox.height) / 2; + } + else { + attr.translate = { + x: (bbox.x + bbox.width) / 2, + y: (bbox.y + bbox.height) / 2 }; } - this.el.on(this.autoHideHd); - this.collapsedEl.on(this.autoHideHd); + shadows[i].setAttributes(attr, true); } }, - // private - clearAutoHide : function(){ - if(this.autoHide !== false){ - this.el.un("mouseout", this.autoHideHd.mouseout); - this.el.un("mouseover", this.autoHideHd.mouseover); - this.collapsedEl.un("mouseout", this.autoHideHd.mouseout); - this.collapsedEl.un("mouseover", this.autoHideHd.mouseover); - } + // @private create a new point + createPoint: function(attr, type) { + var me = this, + chart = me.chart, + group = me.group, + bbox = me.bbox; + + return Ext.chart.Shape[type](chart.surface, Ext.apply({}, { + x: 0, + y: 0, + group: group, + translate: { + x: (bbox.x + bbox.width) / 2, + y: (bbox.y + bbox.height) / 2 + } + }, attr)); }, - // private - clearMonitor : function(){ - Ext.getDoc().un("click", this.slideInIf, this); + // @private create a new set of shadows for a sprite + createShadow: function(sprite, endMarkerStyle, type) { + var me = this, + chart = me.chart, + shadowGroups = me.shadowGroups, + shadowAttributes = me.shadowAttributes, + lnsh = shadowGroups.length, + bbox = me.bbox, + i, shadow, shadows, attr; + + sprite.shadows = shadows = []; + + for (i = 0; i < lnsh; i++) { + attr = Ext.apply({}, shadowAttributes[i]); + if (attr.translate) { + attr.translate.x += (bbox.x + bbox.width) / 2; + attr.translate.y += (bbox.y + bbox.height) / 2; + } + else { + Ext.apply(attr, { + translate: { + x: (bbox.x + bbox.width) / 2, + y: (bbox.y + bbox.height) / 2 + } + }); + } + Ext.apply(attr, endMarkerStyle); + shadow = Ext.chart.Shape[type](chart.surface, Ext.apply({}, { + x: 0, + y: 0, + group: shadowGroups[i] + }, attr)); + shadows.push(shadow); + } }, /** - * If this Region is {@link #floatable}, this method slides this Region into full visibility over the top - * of the center Region where it floats until either {@link #slideIn} is called, or other regions of the layout - * are clicked, or the mouse exits the Region. + * Draws the series for the current chart. */ - slideOut : function(){ - if(this.isSlid || this.el.hasActiveFx()){ + drawSeries: function() { + var me = this, + chart = me.chart, + store = chart.substore || chart.store, + group = me.group, + enableShadows = chart.shadow, + shadowGroups = me.shadowGroups, + shadowAttributes = me.shadowAttributes, + lnsh = shadowGroups.length, + sprite, attrs, attr, ln, i, endMarkerStyle, shindex, type, shadows, + rendererAttributes, shadowAttribute; + + endMarkerStyle = Ext.apply(me.markerStyle, me.markerConfig); + type = endMarkerStyle.type; + delete endMarkerStyle.type; + + //if the store is empty then there's nothing to be rendered + if (!store || !store.getCount()) { return; } - this.isSlid = true; - var ts = this.panel.tools, dh, pc; - if(ts && ts.toggle){ - ts.toggle.hide(); - } - this.el.show(); - // Temporarily clear the collapsed flag so we can onResize the panel on the slide - pc = this.panel.collapsed; - this.panel.collapsed = false; + me.unHighlightItem(); + me.cleanHighlights(); - if(this.position == 'east' || this.position == 'west'){ - // Temporarily clear the deferHeight flag so we can size the height on the slide - dh = this.panel.deferHeight; - this.panel.deferHeight = false; + attrs = me.getPaths(); + ln = attrs.length; + for (i = 0; i < ln; i++) { + attr = attrs[i]; + sprite = group.getAt(i); + Ext.apply(attr, endMarkerStyle); - this.panel.setSize(undefined, this.collapsedEl.getHeight()); + // Create a new sprite if needed (no height) + if (!sprite) { + sprite = me.createPoint(attr, type); + if (enableShadows) { + me.createShadow(sprite, endMarkerStyle, type); + } + } - // Put the deferHeight flag back after setSize - this.panel.deferHeight = dh; - }else{ - this.panel.setSize(this.collapsedEl.getWidth(), undefined); - } - - // Put the collapsed flag back after onResize - this.panel.collapsed = pc; - - this.restoreLT = [this.el.dom.style.left, this.el.dom.style.top]; - this.el.alignTo(this.collapsedEl, this.getCollapseAnchor()); - this.el.setStyle("z-index", this.floatingZIndex+2); - this.panel.el.replaceClass('x-panel-collapsed', 'x-panel-floating'); - if(this.animFloat !== false){ - this.beforeSlide(); - this.el.slideIn(this.getSlideAnchor(), { - callback: function(){ - this.afterSlide(); - this.initAutoHide(); - Ext.getDoc().on("click", this.slideInIf, this); - }, - scope: this, - block: true - }); - }else{ - this.initAutoHide(); - Ext.getDoc().on("click", this.slideInIf, this); + shadows = sprite.shadows; + if (chart.animate) { + rendererAttributes = me.renderer(sprite, store.getAt(i), { translate: attr }, i, store); + sprite._to = rendererAttributes; + me.onAnimate(sprite, { + to: rendererAttributes + }); + //animate shadows + for (shindex = 0; shindex < lnsh; shindex++) { + shadowAttribute = Ext.apply({}, shadowAttributes[shindex]); + rendererAttributes = me.renderer(shadows[shindex], store.getAt(i), Ext.apply({}, { + translate: { + x: attr.x + (shadowAttribute.translate? shadowAttribute.translate.x : 0), + y: attr.y + (shadowAttribute.translate? shadowAttribute.translate.y : 0) + } + }, shadowAttribute), i, store); + me.onAnimate(shadows[shindex], { to: rendererAttributes }); + } + } + else { + rendererAttributes = me.renderer(sprite, store.getAt(i), Ext.apply({ translate: attr }, { hidden: false }), i, store); + sprite.setAttributes(rendererAttributes, true); + //update shadows + for (shindex = 0; shindex < lnsh; shindex++) { + shadowAttribute = shadowAttributes[shindex]; + rendererAttributes = me.renderer(shadows[shindex], store.getAt(i), Ext.apply({ + x: attr.x, + y: attr.y + }, shadowAttribute), i, store); + shadows[shindex].setAttributes(rendererAttributes, true); + } + } + me.items[i].sprite = sprite; } - }, - - // private - afterSlideIn : function(){ - this.clearAutoHide(); - this.isSlid = false; - this.clearMonitor(); - this.el.setStyle("z-index", ""); - this.panel.el.replaceClass('x-panel-floating', 'x-panel-collapsed'); - this.el.dom.style.left = this.restoreLT[0]; - this.el.dom.style.top = this.restoreLT[1]; - var ts = this.panel.tools; - if(ts && ts.toggle){ - ts.toggle.show(); + // Hide unused sprites + ln = group.getCount(); + for (i = attrs.length; i < ln; i++) { + group.getAt(i).hide(true); + } + me.renderLabels(); + me.renderCallouts(); + }, + + // @private callback for when creating a label sprite. + onCreateLabel: function(storeItem, item, i, display) { + var me = this, + group = me.labelsGroup, + config = me.label, + endLabelStyle = Ext.apply({}, config, me.seriesLabelStyle), + bbox = me.bbox; + + return me.chart.surface.add(Ext.apply({ + type: 'text', + group: group, + x: item.point[0], + y: bbox.y + bbox.height / 2 + }, endLabelStyle)); + }, + + // @private callback for when placing a label sprite. + onPlaceLabel: function(label, storeItem, item, i, display, animate) { + var me = this, + chart = me.chart, + resizing = chart.resizing, + config = me.label, + format = config.renderer, + field = config.field, + bbox = me.bbox, + x = item.point[0], + y = item.point[1], + radius = item.sprite.attr.radius, + bb, width, height, anim; + + label.setAttributes({ + text: format(storeItem.get(field)), + hidden: true + }, true); + + if (display == 'rotate') { + label.setAttributes({ + 'text-anchor': 'start', + 'rotation': { + x: x, + y: y, + degrees: -45 + } + }, true); + //correct label position to fit into the box + bb = label.getBBox(); + width = bb.width; + height = bb.height; + x = x < bbox.x? bbox.x : x; + x = (x + width > bbox.x + bbox.width)? (x - (x + width - bbox.x - bbox.width)) : x; + y = (y - height < bbox.y)? bbox.y + height : y; + + } else if (display == 'under' || display == 'over') { + //TODO(nicolas): find out why width/height values in circle bounding boxes are undefined. + bb = item.sprite.getBBox(); + bb.width = bb.width || (radius * 2); + bb.height = bb.height || (radius * 2); + y = y + (display == 'over'? -bb.height : bb.height); + //correct label position to fit into the box + bb = label.getBBox(); + width = bb.width/2; + height = bb.height/2; + x = x - width < bbox.x ? bbox.x + width : x; + x = (x + width > bbox.x + bbox.width) ? (x - (x + width - bbox.x - bbox.width)) : x; + y = y - height < bbox.y? bbox.y + height : y; + y = (y + height > bbox.y + bbox.height) ? (y - (y + height - bbox.y - bbox.height)) : y; + } + + if (!chart.animate) { + label.setAttributes({ + x: x, + y: y + }, true); + label.show(true); + } + else { + if (resizing) { + anim = item.sprite.getActiveAnimation(); + if (anim) { + anim.on('afteranimate', function() { + label.setAttributes({ + x: x, + y: y + }, true); + label.show(true); + }); + } + else { + label.show(true); + } + } + else { + me.onAnimate(label, { + to: { + x: x, + y: y + } + }); + } } }, + + // @private callback for when placing a callout sprite. + onPlaceCallout: function(callout, storeItem, item, i, display, animate, index) { + var me = this, + chart = me.chart, + surface = chart.surface, + resizing = chart.resizing, + config = me.callouts, + items = me.items, + cur = item.point, + normal, + bbox = callout.label.getBBox(), + offsetFromViz = 30, + offsetToSide = 10, + offsetBox = 3, + boxx, boxy, boxw, boxh, + p, clipRect = me.bbox, + x, y; + + //position + normal = [Math.cos(Math.PI /4), -Math.sin(Math.PI /4)]; + x = cur[0] + normal[0] * offsetFromViz; + y = cur[1] + normal[1] * offsetFromViz; + + //box position and dimensions + boxx = x + (normal[0] > 0? 0 : -(bbox.width + 2 * offsetBox)); + boxy = y - bbox.height /2 - offsetBox; + boxw = bbox.width + 2 * offsetBox; + boxh = bbox.height + 2 * offsetBox; + + //now check if we're out of bounds and invert the normal vector correspondingly + //this may add new overlaps between labels (but labels won't be out of bounds). + if (boxx < clipRect[0] || (boxx + boxw) > (clipRect[0] + clipRect[2])) { + normal[0] *= -1; + } + if (boxy < clipRect[1] || (boxy + boxh) > (clipRect[1] + clipRect[3])) { + normal[1] *= -1; + } + + //update positions + x = cur[0] + normal[0] * offsetFromViz; + y = cur[1] + normal[1] * offsetFromViz; + + //update box position and dimensions + boxx = x + (normal[0] > 0? 0 : -(bbox.width + 2 * offsetBox)); + boxy = y - bbox.height /2 - offsetBox; + boxw = bbox.width + 2 * offsetBox; + boxh = bbox.height + 2 * offsetBox; + + if (chart.animate) { + //set the line from the middle of the pie to the box. + me.onAnimate(callout.lines, { + to: { + path: ["M", cur[0], cur[1], "L", x, y, "Z"] + } + }, true); + //set box position + me.onAnimate(callout.box, { + to: { + x: boxx, + y: boxy, + width: boxw, + height: boxh + } + }, true); + //set text position + me.onAnimate(callout.label, { + to: { + x: x + (normal[0] > 0? offsetBox : -(bbox.width + offsetBox)), + y: y + } + }, true); + } else { + //set the line from the middle of the pie to the box. + callout.lines.setAttributes({ + path: ["M", cur[0], cur[1], "L", x, y, "Z"] + }, true); + //set box position + callout.box.setAttributes({ + x: boxx, + y: boxy, + width: boxw, + height: boxh + }, true); + //set text position + callout.label.setAttributes({ + x: x + (normal[0] > 0? offsetBox : -(bbox.width + offsetBox)), + y: y + }, true); + } + for (p in callout) { + callout[p].show(true); + } + }, + + // @private handles sprite animation for the series. + onAnimate: function(sprite, attr) { + sprite.show(); + return this.callParent(arguments); + }, + + isItemInPoint: function(x, y, item) { + var point, + tolerance = 10, + abs = Math.abs; + + function dist(point) { + var dx = abs(point[0] - x), + dy = abs(point[1] - y); + return Math.sqrt(dx * dx + dy * dy); + } + point = item.point; + return (point[0] - tolerance <= x && point[0] + tolerance >= x && + point[1] - tolerance <= y && point[1] + tolerance >= y); + } +}); + + +/** + * @class Ext.chart.theme.Base + * Provides default colors for non-specified things. Should be sub-classed when creating new themes. + * @ignore + */ +Ext.define('Ext.chart.theme.Base', { + + /* Begin Definitions */ + + requires: ['Ext.chart.theme.Theme'], + + /* End Definitions */ + + constructor: function(config) { + Ext.chart.theme.call(this, config, { + background: false, + axis: { + stroke: '#444', + 'stroke-width': 1 + }, + axisLabelTop: { + fill: '#444', + font: '12px Arial, Helvetica, sans-serif', + spacing: 2, + padding: 5, + renderer: function(v) { return v; } + }, + axisLabelRight: { + fill: '#444', + font: '12px Arial, Helvetica, sans-serif', + spacing: 2, + padding: 5, + renderer: function(v) { return v; } + }, + axisLabelBottom: { + fill: '#444', + font: '12px Arial, Helvetica, sans-serif', + spacing: 2, + padding: 5, + renderer: function(v) { return v; } + }, + axisLabelLeft: { + fill: '#444', + font: '12px Arial, Helvetica, sans-serif', + spacing: 2, + padding: 5, + renderer: function(v) { return v; } + }, + axisTitleTop: { + font: 'bold 18px Arial', + fill: '#444' + }, + axisTitleRight: { + font: 'bold 18px Arial', + fill: '#444', + rotate: { + x:0, y:0, + degrees: 270 + } + }, + axisTitleBottom: { + font: 'bold 18px Arial', + fill: '#444' + }, + axisTitleLeft: { + font: 'bold 18px Arial', + fill: '#444', + rotate: { + x:0, y:0, + degrees: 270 + } + }, + series: { + 'stroke-width': 0 + }, + seriesLabel: { + font: '12px Arial', + fill: '#333' + }, + marker: { + stroke: '#555', + fill: '#000', + radius: 3, + size: 3 + }, + colors: [ "#94ae0a", "#115fa6","#a61120", "#ff8809", "#ffd13e", "#a61187", "#24ad9a", "#7c7474", "#a66111"], + seriesThemes: [{ + fill: "#115fa6" + }, { + fill: "#94ae0a" + }, { + fill: "#a61120" + }, { + fill: "#ff8809" + }, { + fill: "#ffd13e" + }, { + fill: "#a61187" + }, { + fill: "#24ad9a" + }, { + fill: "#7c7474" + }, { + fill: "#a66111" + }], + markerThemes: [{ + fill: "#115fa6", + type: 'circle' + }, { + fill: "#94ae0a", + type: 'cross' + }, { + fill: "#a61120", + type: 'plus' + }] + }); + } +}, function() { + var palette = ['#b1da5a', '#4ce0e7', '#e84b67', '#da5abd', '#4d7fe6', '#fec935'], + names = ['Green', 'Sky', 'Red', 'Purple', 'Blue', 'Yellow'], + i = 0, j = 0, l = palette.length, themes = Ext.chart.theme, + categories = [['#f0a50a', '#c20024', '#2044ba', '#810065', '#7eae29'], + ['#6d9824', '#87146e', '#2a9196', '#d39006', '#1e40ac'], + ['#fbbc29', '#ce2e4e', '#7e0062', '#158b90', '#57880e'], + ['#ef5773', '#fcbd2a', '#4f770d', '#1d3eaa', '#9b001f'], + ['#7eae29', '#fdbe2a', '#910019', '#27b4bc', '#d74dbc'], + ['#44dce1', '#0b2592', '#996e05', '#7fb325', '#b821a1']], + cats = categories.length; + + //Create themes from base colors + for (; i < l; i++) { + themes[names[i]] = (function(color) { + return Ext.extend(themes.Base, { + constructor: function(config) { + themes.Base.prototype.constructor.call(this, Ext.apply({ + baseColor: color + }, config)); + } + }); + })(palette[i]); + } + + //Create theme from color array + for (i = 0; i < cats; i++) { + themes['Category' + (i + 1)] = (function(category) { + return Ext.extend(themes.Base, { + constructor: function(config) { + themes.Base.prototype.constructor.call(this, Ext.apply({ + colors: category + }, config)); + } + }); + })(categories[i]); + } +}); + +/** + * @author Ed Spencer + * @class Ext.data.ArrayStore + * @extends Ext.data.Store + * @ignore + * + * 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.reader.Array}. + * + * 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.reader.Array ArrayReader}. + * + * @constructor + * @param {Object} config + * @xtype arraystore + */ +Ext.define('Ext.data.ArrayStore', { + extend: 'Ext.data.Store', + alias: 'store.array', + uses: ['Ext.data.reader.Array'], /** - * If this Region is {@link #floatable}, and this Region has been slid into floating visibility, then this method slides - * this region back into its collapsed state. + * @cfg {Ext.data.DataReader} reader @hide */ - slideIn : function(cb){ - if(!this.isSlid || this.el.hasActiveFx()){ - Ext.callback(cb); - return; - } - this.isSlid = false; - if(this.animFloat !== false){ - this.beforeSlide(); - this.el.slideOut(this.getSlideAnchor(), { - callback: function(){ - this.el.hide(); - this.afterSlide(); - this.afterSlideIn(); - Ext.callback(cb); - }, - scope: this, - block: true - }); - }else{ - this.el.hide(); - this.afterSlideIn(); - } + constructor: function(config) { + config = config || {}; + + Ext.applyIf(config, { + proxy: { + type: 'memory', + reader: 'array' + } + }); + + this.callParent([config]); }, - // private - slideInIf : function(e){ - if(!e.within(this.el)){ - this.slideIn(); + loadData: function(data, append) { + if (this.expandData === true) { + var r = [], + i = 0, + ln = data.length; + + for (; i < ln; i++) { + r[r.length] = [data[i]]; + } + + data = r; } - }, - // private - anchors : { - "west" : "left", - "east" : "right", - "north" : "top", - "south" : "bottom" - }, + this.callParent([data, append]); + } +}, function() { + // backwards compat + Ext.data.SimpleStore = Ext.data.ArrayStore; + // Ext.reg('simplestore', Ext.data.SimpleStore); +}); - // private - sanchors : { - "west" : "l", - "east" : "r", - "north" : "t", - "south" : "b" +/** + * @author Ed Spencer + * @class Ext.data.Batch + * + * Provides a mechanism to run one or more {@link Ext.data.Operation operations} in a given order. Fires the 'operationcomplete' event + * after the completion of each Operation, and the 'complete' event when all Operations have been successfully executed. Fires an 'exception' + * event if any of the Operations encounter an exception. + * + * Usually these are only used internally by {@link Ext.data.proxy.Proxy} classes + * + * @constructor + * @param {Object} config Optional config object + */ +Ext.define('Ext.data.Batch', { + mixins: { + observable: 'Ext.util.Observable' }, - - // private - canchors : { - "west" : "tl-tr", - "east" : "tr-tl", - "north" : "tl-bl", - "south" : "bl-tl" + + /** + * True to immediately start processing the batch as soon as it is constructed (defaults to false) + * @property autoStart + * @type Boolean + */ + autoStart: false, + + /** + * The index of the current operation being executed + * @property current + * @type Number + */ + current: -1, + + /** + * The total number of operations in this batch. Read only + * @property total + * @type Number + */ + total: 0, + + /** + * True if the batch is currently running + * @property isRunning + * @type Boolean + */ + isRunning: false, + + /** + * True if this batch has been executed completely + * @property isComplete + * @type Boolean + */ + isComplete: false, + + /** + * True if this batch has encountered an exception. This is cleared at the start of each operation + * @property hasException + * @type Boolean + */ + hasException: false, + + /** + * True to automatically pause the execution of the batch if any operation encounters an exception (defaults to true) + * @property pauseOnException + * @type Boolean + */ + pauseOnException: true, + + constructor: function(config) { + var me = this; + + me.addEvents( + /** + * @event complete + * Fired when all operations of this batch have been completed + * @param {Ext.data.Batch} batch The batch object + * @param {Object} operation The last operation that was executed + */ + 'complete', + + /** + * @event exception + * Fired when a operation encountered an exception + * @param {Ext.data.Batch} batch The batch object + * @param {Object} operation The operation that encountered the exception + */ + 'exception', + + /** + * @event operationcomplete + * Fired when each operation of the batch completes + * @param {Ext.data.Batch} batch The batch object + * @param {Object} operation The operation that just completed + */ + 'operationcomplete' + ); + + me.mixins.observable.constructor.call(me, config); + + /** + * Ordered array of operations that will be executed by this batch + * @property operations + * @type Array + */ + me.operations = []; }, - - // private - getAnchor : function(){ - return this.anchors[this.position]; + + /** + * Adds a new operation to this batch + * @param {Object} operation The {@link Ext.data.Operation Operation} object + */ + add: function(operation) { + this.total++; + + operation.setBatch(this); + + this.operations.push(operation); }, - - // private - getCollapseAnchor : function(){ - return this.canchors[this.position]; + + /** + * Kicks off the execution of the batch, continuing from the next operation if the previous + * operation encountered an exception, or if execution was paused + */ + start: function() { + this.hasException = false; + this.isRunning = true; + + this.runNextOperation(); }, - - // private - getSlideAnchor : function(){ - return this.sanchors[this.position]; + + /** + * @private + * Runs the next operation, relative to this.current. + */ + runNextOperation: function() { + this.runOperation(this.current + 1); + }, + + /** + * Pauses execution of the batch, but does not cancel the current operation + */ + pause: function() { + this.isRunning = false; }, + + /** + * Executes a operation by its numeric index + * @param {Number} index The operation index to run + */ + runOperation: function(index) { + var me = this, + operations = me.operations, + operation = operations[index], + onProxyReturn; + + if (operation === undefined) { + me.isRunning = false; + me.isComplete = true; + me.fireEvent('complete', me, operations[operations.length - 1]); + } else { + me.current = index; + + onProxyReturn = function(operation) { + var hasException = operation.hasException(); + + if (hasException) { + me.hasException = true; + me.fireEvent('exception', me, operation); + } else { + me.fireEvent('operationcomplete', me, operation); + } - // private - getAlignAdj : function(){ - var cm = this.cmargins; - switch(this.position){ - case "west": - return [0, 0]; - break; - case "east": - return [0, 0]; - break; - case "north": - return [0, 0]; - break; - case "south": - return [0, 0]; - break; + if (hasException && me.pauseOnException) { + me.pause(); + } else { + operation.setCompleted(); + me.runNextOperation(); + } + }; + + operation.setStarted(); + + me.proxy[operation.action](operation, onProxyReturn, me); } - }, + } +}); +/** + * @author Ed Spencer + * @class Ext.data.BelongsToAssociation + * @extends Ext.data.Association + * + * Represents a many to one association with another model. The owner model is expected to have + * a foreign key which references the primary key of the associated model: + * + +Ext.define('Category', { + extend: 'Ext.data.Model', + fields: [ + {name: 'id', type: 'int'}, + {name: 'name', type: 'string'} + ] +}); + +Ext.define('Product', { + extend: 'Ext.data.Model', + fields: [ + {name: 'id', type: 'int'}, + {name: 'category_id', type: 'int'}, + {name: 'name', type: 'string'} + ], + // we can use the belongsTo shortcut on the model to create a belongsTo association + belongsTo: {type: 'belongsTo', model: 'Category'} +}); + + * In the example above we have created models for Products and Categories, and linked them together + * by saying that each Product belongs to a Category. This automatically links each Product to a Category + * based on the Product's category_id, and provides new functions on the Product model: + * + * Generated getter function + * + * The first function that is added to the owner model is a getter function: + * + +var product = new Product({ + id: 100, + category_id: 20, + name: 'Sneakers' +}); + +product.getCategory(function(category, operation) { + //do something with the category object + alert(category.get('id')); //alerts 20 +}, this); + +* + * The getCategory function was created on the Product model when we defined the association. This uses the + * Category's configured {@link Ext.data.proxy.Proxy proxy} to load the Category asynchronously, calling the provided + * callback when it has loaded. + * + * The new getCategory function will also accept an object containing success, failure and callback properties + * - callback will always be called, success will only be called if the associated model was loaded successfully + * and failure will only be called if the associatied model could not be loaded: + * + +product.getCategory({ + callback: function(category, operation) {}, //a function that will always be called + success : function(category, operation) {}, //a function that will only be called if the load succeeded + failure : function(category, operation) {}, //a function that will only be called if the load did not succeed + scope : this //optionally pass in a scope object to execute the callbacks in +}); + + * + * In each case above the callbacks are called with two arguments - the associated model instance and the + * {@link Ext.data.Operation operation} object that was executed to load that instance. The Operation object is + * useful when the instance could not be loaded. + * + * Generated setter function + * + * The second generated function sets the associated model instance - if only a single argument is passed to + * the setter then the following two calls are identical: + * + +//this call +product.setCategory(10); - // private - getExpandAdj : function(){ - var c = this.collapsedEl, cm = this.cmargins; - switch(this.position){ - case "west": - return [-(cm.right+c.getWidth()+cm.left), 0]; - break; - case "east": - return [cm.right+c.getWidth()+cm.left, 0]; - break; - case "north": - return [0, -(cm.top+cm.bottom+c.getHeight())]; - break; - case "south": - return [0, cm.top+cm.bottom+c.getHeight()]; - break; - } - }, +//is equivalent to this call: +product.set('category_id', 10); + + * If we pass in a second argument, the model will be automatically saved and the second argument passed to + * the owner model's {@link Ext.data.Model#save save} method: + +product.setCategory(10, function(product, operation) { + //the product has been saved + alert(product.get('category_id')); //now alerts 10 +}); - destroy : function(){ - if (this.autoHideSlideTask && this.autoHideSlideTask.cancel){ - this.autoHideSlideTask.cancel(); - } - Ext.destroyMembers(this, 'miniCollapsedEl', 'collapsedEl', 'expandToolEl'); - } -}; +//alternative syntax: +product.setCategory(10, { + callback: function(product, operation), //a function that will always be called + success : function(product, operation), //a function that will only be called if the load succeeded + failure : function(product, operation), //a function that will only be called if the load did not succeed + scope : this //optionally pass in a scope object to execute the callbacks in +}) + +* + * Customisation + * + * Associations reflect on the models they are linking to automatically set up properties such as the + * {@link #primaryKey} and {@link #foreignKey}. These can alternatively be specified: + * + +Ext.define('Product', { + fields: [...], -/** - * @class Ext.layout.BorderLayout.SplitRegion - * @extends Ext.layout.BorderLayout.Region - * This is a specialized type of {@link Ext.layout.BorderLayout.Region BorderLayout region} that - * has a built-in {@link Ext.SplitBar} for user resizing of regions. The movement of the split bar - * is configurable to move either {@link #tickSize smooth or incrementally}. - * @constructor - * Create a new SplitRegion. - * @param {Layout} layout The {@link Ext.layout.BorderLayout BorderLayout} instance that is managing this Region. - * @param {Object} config The configuration options - * @param {String} position The region position. Valid values are: north, south, east, west and center. Every - * BorderLayout must have a center region for the primary content -- all other regions are optional. + associations: [ + {type: 'belongsTo', model: 'Category', primaryKey: 'unique_id', foreignKey: 'cat_id'} + ] +}); + + * + * Here we replaced the default primary key (defaults to 'id') and foreign key (calculated as 'category_id') + * with our own settings. Usually this will not be needed. */ -Ext.layout.BorderLayout.SplitRegion = function(layout, config, pos){ - Ext.layout.BorderLayout.SplitRegion.superclass.constructor.call(this, layout, config, pos); - // prevent switch - this.applyLayout = this.applyFns[pos]; -}; +Ext.define('Ext.data.BelongsToAssociation', { + extend: 'Ext.data.Association', + + alias: 'association.belongsto', -Ext.extend(Ext.layout.BorderLayout.SplitRegion, Ext.layout.BorderLayout.Region, { /** - * @cfg {Number} tickSize - * The increment, in pixels by which to move this Region's {@link Ext.SplitBar SplitBar}. - * By default, the {@link Ext.SplitBar SplitBar} moves smoothly. + * @cfg {String} foreignKey The name of the foreign key on the owner model that links it to the associated + * model. Defaults to the lowercased name of the associated model plus "_id", e.g. an association with a + * model called Product would set up a product_id foreign key. + * +Ext.define('Order', { + extend: 'Ext.data.Model', + fields: ['id', 'date'], + hasMany: 'Product' +}); + +Ext.define('Product', { + extend: 'Ext.data.Model', + fields: ['id', 'name', 'order_id'], // refers to the id of the order that this product belongs to + belongsTo: 'Group' +}); +var product = new Product({ + id: 1, + name: 'Product 1', + order_id: 22 +}, 1); +product.getOrder(); // Will make a call to the server asking for order_id 22 + + * */ + /** - * @cfg {String} splitTip - * The tooltip to display when the user hovers over a - * {@link Ext.layout.BorderLayout.Region#collapsible non-collapsible} region's split bar - * (defaults to "Drag to resize."). Only applies if - * {@link #useSplitTips} = true. + * @cfg {String} getterName The name of the getter function that will be added to the local model's prototype. + * Defaults to 'get' + the name of the foreign model, e.g. getCategory */ - splitTip : "Drag to resize.", + /** - * @cfg {String} collapsibleSplitTip - * The tooltip to display when the user hovers over a - * {@link Ext.layout.BorderLayout.Region#collapsible collapsible} region's split bar - * (defaults to "Drag to resize. Double click to hide."). Only applies if - * {@link #useSplitTips} = true. + * @cfg {String} setterName The name of the setter function that will be added to the local model's prototype. + * Defaults to 'set' + the name of the foreign model, e.g. setCategory */ - collapsibleSplitTip : "Drag to resize. Double click to hide.", + /** - * @cfg {Boolean} useSplitTips - * true to display a tooltip when the user hovers over a region's split bar - * (defaults to false). The tooltip text will be the value of either - * {@link #splitTip} or {@link #collapsibleSplitTip} as appropriate. + * @cfg {String} type The type configuration can be used when creating associations using a configuration object. + * Use 'belongsTo' to create a HasManyAssocation + * +associations: [{ + type: 'belongsTo', + model: 'User' +}] + * */ - useSplitTips : false, - - // private - splitSettings : { - north : { - orientation: Ext.SplitBar.VERTICAL, - placement: Ext.SplitBar.TOP, - maxFn : 'getVMaxSize', - minProp: 'minHeight', - maxProp: 'maxHeight' - }, - south : { - orientation: Ext.SplitBar.VERTICAL, - placement: Ext.SplitBar.BOTTOM, - maxFn : 'getVMaxSize', - minProp: 'minHeight', - maxProp: 'maxHeight' - }, - east : { - orientation: Ext.SplitBar.HORIZONTAL, - placement: Ext.SplitBar.RIGHT, - maxFn : 'getHMaxSize', - minProp: 'minWidth', - maxProp: 'maxWidth' - }, - west : { - orientation: Ext.SplitBar.HORIZONTAL, - placement: Ext.SplitBar.LEFT, - maxFn : 'getHMaxSize', - minProp: 'minWidth', - maxProp: 'maxWidth' - } - }, - - // private - applyFns : { - west : function(box){ - if(this.isCollapsed){ - return this.applyLayoutCollapsed(box); - } - var sd = this.splitEl.dom, s = sd.style; - this.panel.setPosition(box.x, box.y); - var sw = sd.offsetWidth; - s.left = (box.x+box.width-sw)+'px'; - s.top = (box.y)+'px'; - s.height = Math.max(0, box.height)+'px'; - this.panel.setSize(box.width-sw, box.height); - }, - east : function(box){ - if(this.isCollapsed){ - return this.applyLayoutCollapsed(box); - } - var sd = this.splitEl.dom, s = sd.style; - var sw = sd.offsetWidth; - this.panel.setPosition(box.x+sw, box.y); - s.left = (box.x)+'px'; - s.top = (box.y)+'px'; - s.height = Math.max(0, box.height)+'px'; - this.panel.setSize(box.width-sw, box.height); - }, - north : function(box){ - if(this.isCollapsed){ - return this.applyLayoutCollapsed(box); - } - var sd = this.splitEl.dom, s = sd.style; - var sh = sd.offsetHeight; - this.panel.setPosition(box.x, box.y); - s.left = (box.x)+'px'; - s.top = (box.y+box.height-sh)+'px'; - s.width = Math.max(0, box.width)+'px'; - this.panel.setSize(box.width, box.height-sh); - }, - south : function(box){ - if(this.isCollapsed){ - return this.applyLayoutCollapsed(box); - } - var sd = this.splitEl.dom, s = sd.style; - var sh = sd.offsetHeight; - this.panel.setPosition(box.x, box.y+sh); - s.left = (box.x)+'px'; - s.top = (box.y)+'px'; - s.width = Math.max(0, box.width)+'px'; - this.panel.setSize(box.width, box.height-sh); - } - }, - - // private - render : function(ct, p){ - Ext.layout.BorderLayout.SplitRegion.superclass.render.call(this, ct, p); - - var ps = this.position; - this.splitEl = ct.createChild({ - cls: "x-layout-split x-layout-split-"+ps, html: " ", - id: this.panel.id + '-xsplit' + constructor: function(config) { + this.callParent(arguments); + + var me = this, + ownerProto = me.ownerModel.prototype, + associatedName = me.associatedName, + getterName = me.getterName || 'get' + associatedName, + setterName = me.setterName || 'set' + associatedName; + + Ext.applyIf(me, { + name : associatedName, + foreignKey : associatedName.toLowerCase() + "_id", + instanceName: associatedName + 'BelongsToInstance', + associationKey: associatedName.toLowerCase() }); - if(this.collapseMode == 'mini'){ - this.miniSplitEl = this.splitEl.createChild({ - cls: "x-layout-mini x-layout-mini-"+ps, html: " " - }); - this.miniSplitEl.addClassOnOver('x-layout-mini-over'); - this.miniSplitEl.on('click', this.onCollapseClick, this, {stopEvent:true}); - } + ownerProto[getterName] = me.createGetter(); + ownerProto[setterName] = me.createSetter(); + }, - var s = this.splitSettings[ps]; + /** + * @private + * Returns a setter function to be placed on the owner model's prototype + * @return {Function} The setter function + */ + createSetter: function() { + var me = this, + ownerModel = me.ownerModel, + associatedModel = me.associatedModel, + foreignKey = me.foreignKey, + primaryKey = me.primaryKey; + + //'this' refers to the Model instance inside this function + return function(value, options, scope) { + this.set(foreignKey, value); + + if (typeof options == 'function') { + options = { + callback: options, + scope: scope || this + }; + } - this.split = new Ext.SplitBar(this.splitEl.dom, p.el, s.orientation); - this.split.tickSize = this.tickSize; - this.split.placement = s.placement; - this.split.getMaximumSize = this[s.maxFn].createDelegate(this); - this.split.minSize = this.minSize || this[s.minProp]; - this.split.on("beforeapply", this.onSplitMove, this); - this.split.useShim = this.useShim === true; - this.maxSize = this.maxSize || this[s.maxProp]; + if (Ext.isObject(options)) { + return this.save(options); + } + }; + }, - if(p.hidden){ - this.splitEl.hide(); - } + /** + * @private + * Returns a getter function to be placed on the owner model's prototype. We cache the loaded instance + * the first time it is loaded so that subsequent calls to the getter always receive the same reference. + * @return {Function} The getter function + */ + createGetter: function() { + var me = this, + ownerModel = me.ownerModel, + associatedName = me.associatedName, + associatedModel = me.associatedModel, + foreignKey = me.foreignKey, + primaryKey = me.primaryKey, + instanceName = me.instanceName; + + //'this' refers to the Model instance inside this function + return function(options, scope) { + options = options || {}; + + var foreignKeyId = this.get(foreignKey), + instance, callbackFn; + + if (this[instanceName] === undefined) { + instance = Ext.ModelManager.create({}, associatedName); + instance.set(primaryKey, foreignKeyId); + + if (typeof options == 'function') { + options = { + callback: options, + scope: scope || this + }; + } - if(this.useSplitTips){ - this.splitEl.dom.title = this.collapsible ? this.collapsibleSplitTip : this.splitTip; - } - if(this.collapsible){ - this.splitEl.on("dblclick", this.onCollapseClick, this); - } - }, + associatedModel.load(foreignKeyId, options); + } else { + instance = this[instanceName]; - //docs inherit from superclass - getSize : function(){ - if(this.isCollapsed){ - return this.collapsedEl.getSize(); - } - var s = this.panel.getSize(); - if(this.position == 'north' || this.position == 'south'){ - s.height += this.splitEl.dom.offsetHeight; - }else{ - s.width += this.splitEl.dom.offsetWidth; - } - return s; - }, + //TODO: We're duplicating the callback invokation code that the instance.load() call above + //makes here - ought to be able to normalize this - perhaps by caching at the Model.load layer + //instead of the association layer. + if (typeof options == 'function') { + options.call(scope || this, instance); + } - // private - getHMaxSize : function(){ - var cmax = this.maxSize || 10000; - var center = this.layout.center; - return Math.min(cmax, (this.el.getWidth()+center.el.getWidth())-center.getMinWidth()); - }, + if (options.success) { + options.success.call(scope || this, instance); + } - // private - getVMaxSize : function(){ - var cmax = this.maxSize || 10000; - var center = this.layout.center; - return Math.min(cmax, (this.el.getHeight()+center.el.getHeight())-center.getMinHeight()); - }, + if (options.callback) { + options.callback.call(scope || this, instance); + } - // private - onSplitMove : function(split, newSize){ - var s = this.panel.getSize(); - this.lastSplitSize = newSize; - if(this.position == 'north' || this.position == 'south'){ - this.panel.setSize(s.width, newSize); - this.state.height = newSize; - }else{ - this.panel.setSize(newSize, s.height); - this.state.width = newSize; - } - this.layout.layout(); - this.panel.saveState(); - return false; + return instance; + } + }; }, /** - * Returns a reference to the split bar in use by this region. - * @return {Ext.SplitBar} The split bar + * Read associated data + * @private + * @param {Ext.data.Model} record The record we're writing to + * @param {Ext.data.reader.Reader} reader The reader for the associated model + * @param {Object} associationData The raw associated data */ - getSplitBar : function(){ - return this.split; - }, - - // inherit docs - destroy : function() { - Ext.destroy(this.miniSplitEl, this.split, this.splitEl); - Ext.layout.BorderLayout.SplitRegion.superclass.destroy.call(this); + read: function(record, reader, associationData){ + record[this.instanceName] = reader.read([associationData]).records[0]; } }); -Ext.Container.LAYOUTS['border'] = Ext.layout.BorderLayout; /** - * @class Ext.layout.FormLayout - * @extends Ext.layout.AnchorLayout - * This layout manager is specifically designed for rendering and managing child Components of - * {@link Ext.form.FormPanel forms}. It is responsible for rendering the labels of - * {@link Ext.form.Field Field}s. + * @class Ext.data.BufferStore + * @extends Ext.data.Store + * @ignore + */ +Ext.define('Ext.data.BufferStore', { + extend: 'Ext.data.Store', + alias: 'store.buffer', + sortOnLoad: false, + filterOnLoad: false, + + constructor: function() { + Ext.Error.raise('The BufferStore class has been deprecated. Instead, specify the buffered config option on Ext.data.Store'); + } +}); +/** + * @class Ext.direct.Manager + * Overview * - * This layout manager is used when a Container is configured with the layout:'form' - * {@link Ext.Container#layout layout} config option, and should generally not need to be created directly - * via the new keyword. See {@link Ext.Container#layout} for additional details. + * 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). * - * In an application, it will usually be preferrable to use a {@link Ext.form.FormPanel FormPanel} - * (which is configured with FormLayout as its layout class by default) since it also provides built-in - * functionality for {@link Ext.form.BasicForm#doAction loading, validating and submitting} the form. + * 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. * - * A {@link Ext.Container Container} using the FormLayout layout manager (e.g. - * {@link Ext.form.FormPanel} or specifying layout:'form') can also accept the following - * layout-specific config properties: - * {@link Ext.form.FormPanel#hideLabels hideLabels} - * {@link Ext.form.FormPanel#labelAlign labelAlign} - * {@link Ext.form.FormPanel#labelPad labelPad} - * {@link Ext.form.FormPanel#labelSeparator labelSeparator} - * {@link Ext.form.FormPanel#labelWidth labelWidth} - * + * Specification * - * Any Component (including Fields) managed by FormLayout accepts the following as a config option: - * - * {@link Ext.Component#anchor anchor} - * + * For additional information consult the + * Ext.Direct Specification. * - * Any Component managed by FormLayout may be rendered as a form field (with an associated label) by - * configuring it with a non-null {@link Ext.Component#fieldLabel fieldLabel}. Components configured - * in this way may be configured with the following options which affect the way the FormLayout renders them: - * - * {@link Ext.Component#clearCls clearCls} - * {@link Ext.Component#fieldLabel fieldLabel} - * {@link Ext.Component#hideLabel hideLabel} - * {@link Ext.Component#itemCls itemCls} - * {@link Ext.Component#labelSeparator labelSeparator} - * {@link Ext.Component#labelStyle labelStyle} - * + * Providers * - * Example usage: + * 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.Manager}.{@link Ext.direct.Manager#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: * -// Required if showing validation messages -Ext.QuickTips.init(); - -// While you can create a basic Panel with layout:'form', practically -// you should usually use a FormPanel to also get its form functionality -// since it already creates a FormLayout internally. -var form = new Ext.form.FormPanel({ - title: 'Form Layout', - bodyStyle: 'padding:15px', - width: 350, - defaultType: 'textfield', - defaults: { - // applied to each contained item - width: 230, - msgTarget: 'side' - }, - items: [{ - fieldLabel: 'First Name', - name: 'first', - allowBlank: false, - {@link Ext.Component#labelSeparator labelSeparator}: ':' // override labelSeparator layout config - },{ - fieldLabel: 'Last Name', - name: 'last' - },{ - fieldLabel: 'Email', - name: 'email', - vtype:'email' - }, { - xtype: 'textarea', - hideLabel: true, // override hideLabels layout config - name: 'msg', - anchor: '100% -53' - } - ], - buttons: [ - {text: 'Save'}, - {text: 'Cancel'} - ], - layoutConfig: { - {@link #labelSeparator}: '~' // superseded by assignment below - }, - // config options applicable to container when layout='form': - hideLabels: false, - labelAlign: 'left', // or 'right' or 'top' - {@link Ext.form.FormPanel#labelSeparator labelSeparator}: '>>', // takes precedence over layoutConfig value - labelWidth: 65, // defaults to 100 - labelPad: 8 // defaults to 5, must specify labelWidth to be honored +{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"} + +// add a handler for a 'message' event sent by the server +Ext.direct.Manager.on('message', function(e){ + out.append(String.format('<p><i>{0}</i></p>', e.data)); + out.el.scrollTo('t', 100000, true); }); - + *
+ * @singleton */ -Ext.layout.FormLayout = Ext.extend(Ext.layout.AnchorLayout, { - - /** - * @cfg {String} labelSeparator - * See {@link Ext.form.FormPanel}.{@link Ext.form.FormPanel#labelSeparator labelSeparator}. Configuration - * of this property at the container level takes precedence. - */ - labelSeparator : ':', +Ext.define('Ext.direct.Manager', { + + /* Begin Definitions */ + singleton: true, + + mixins: { + observable: 'Ext.util.Observable' + }, + + requires: ['Ext.util.MixedCollection'], + + statics: { + exceptions: { + TRANSPORT: 'xhr', + PARSE: 'parse', + LOGIN: 'login', + SERVER: 'exception' + } + }, + + /* End Definitions */ + + constructor: function(){ + var me = this; + + me.addEvents( + /** + * @event event + * Fires after an event. + * @param {event} e The Ext.direct.Event type that occurred. + * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. + */ + 'event', + /** + * @event exception + * Fires after an event exception. + * @param {event} e The Ext.direct.Event type that occurred. + */ + 'exception' + ); + me.transactions = Ext.create('Ext.util.MixedCollection'); + me.providers = Ext.create('Ext.util.MixedCollection'); + + me.mixins.observable.constructor.call(me); + }, + /** - * Read only. The CSS style specification string added to field labels in this layout if not - * otherwise {@link Ext.Component#labelStyle specified by each contained field}. - * @type String - * @property labelStyle - */ + * 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' +}); - /** - * @cfg {Boolean} trackLabels - * True to show/hide the field label when the field is hidden. Defaults to false. +Ext.direct.Manager.addProvider({ + "type":"remoting", // create a {@link Ext.direct.RemotingProvider} + "url":"php\/router.php", // url to connect to the Ext.Direct server-side router. + "actions":{ // each property within the actions object represents a Class + "TestAction":[ // array of methods within each server side Class + { + "name":"doEcho", // name of method + "len":1 + },{ + "name":"multiply", + "len":1 + },{ + "name":"doForm", + "formHandler":true, // handle form on server with Ext.Direct.Transaction + "len":1 + }] + }, + "namespace":"myApplication",// namespace to create the Remoting Provider in +},{ + type: 'polling', // create a {@link Ext.direct.PollingProvider} + url: 'php/poll.php' +}, pollProv); // reference to previously created instance + * + * @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. */ - trackLabels: false, - - type: 'form', - - onRemove: function(c){ - Ext.layout.FormLayout.superclass.onRemove.call(this, c); - if(this.trackLabels){ - c.un('show', this.onFieldShow, this); - c.un('hide', this.onFieldHide, this); - } - // check for itemCt, since we may be removing a fieldset or something similar - var el = c.getPositionEl(), - ct = c.getItemCt && c.getItemCt(); - if (c.rendered && ct) { - if (el && el.dom) { - el.insertAfter(ct); - } - Ext.destroy(ct); - Ext.destroyMembers(c, 'label', 'itemCt'); - if (c.customItemCt) { - Ext.destroyMembers(c, 'getItemCt', 'customItemCt'); + addProvider : function(provider){ + var me = this, + args = arguments, + i = 0, + len; + + if (args.length > 1) { + for (len = args.length; i < len; ++i) { + me.addProvider(args[i]); } - } - }, - - // private - setContainer : function(ct){ - Ext.layout.FormLayout.superclass.setContainer.call(this, ct); - if(ct.labelAlign){ - ct.addClass('x-form-label-'+ct.labelAlign); + return; } - if(ct.hideLabels){ - Ext.apply(this, { - labelStyle: 'display:none', - elementStyle: 'padding-left:0;', - labelAdjust: 0 - }); - }else{ - this.labelSeparator = Ext.isDefined(ct.labelSeparator) ? ct.labelSeparator : this.labelSeparator; - ct.labelWidth = ct.labelWidth || 100; - if(Ext.isNumber(ct.labelWidth)){ - var pad = Ext.isNumber(ct.labelPad) ? ct.labelPad : 5; - Ext.apply(this, { - labelAdjust: ct.labelWidth + pad, - labelStyle: 'width:' + ct.labelWidth + 'px;', - elementStyle: 'padding-left:' + (ct.labelWidth + pad) + 'px' - }); - } - if(ct.labelAlign == 'top'){ - Ext.apply(this, { - labelStyle: 'width:auto;', - labelAdjust: 0, - elementStyle: 'padding-left:0;' - }); - } + // if provider has not already been instantiated + if (!provider.isProvider) { + provider = Ext.create('direct.' + provider.type + 'provider', provider); } - }, - - // private - isHide: function(c){ - return c.hideLabel || this.container.hideLabels; - }, + me.providers.add(provider); + provider.on('data', me.onProviderData, me); - onFieldShow: function(c){ - c.getItemCt().removeClass('x-hide-' + c.hideMode); - // Composite fields will need to layout after the container is made visible - if (c.isComposite) { - c.doLayout(); + if (!provider.isConnected()) { + provider.connect(); } - }, - onFieldHide: function(c){ - c.getItemCt().addClass('x-hide-' + c.hideMode); + return provider; }, - - //private - getLabelStyle: function(s){ - var ls = '', items = [this.labelStyle, s]; - for (var i = 0, len = items.length; i < len; ++i){ - if (items[i]){ - ls += items[i]; - if (ls.substr(-1, 1) != ';'){ - ls += ';'; - } - } + + /** + * 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/Ext.data.Provider} id The id of the provider, or the provider instance. + */ + getProvider : function(id){ + return id.isProvider ? id : this.providers.get(id); + }, + + /** + * Removes the provider. + * @param {String/Ext.direct.Provider} provider The provider instance or the id of the provider. + * @return {Ext.direct.Provider} The provider, null if not found. + */ + removeProvider : function(provider){ + var me = this, + providers = me.providers, + provider = provider.isProvider ? provider : providers.get(provider); + + if (provider) { + provider.un('data', me.onProviderData, me); + providers.remove(provider); + return provider; } - return ls; + return null; + }, + + /** + * Add a transaction to the manager. + * @private + * @param {Ext.direct.Transaction} transaction The transaction to add + * @return {Ext.direct.Transaction} transaction + */ + addTransaction: function(transaction){ + this.transactions.add(transaction); + return transaction; }, /** - * @cfg {Ext.Template} fieldTpl - * A {@link Ext.Template#compile compile}d {@link Ext.Template} for rendering - * the fully wrapped, labeled and styled form Field. Defaults to: -new Ext.Template( - '<div class="x-form-item {itemCls}" tabIndex="-1">', - '<label for="{id}" style="{labelStyle}" class="x-form-item-label">{label}{labelSeparator}</label>', - '<div class="x-form-element" id="x-form-el-{id}" style="{elementStyle}">', - '</div><div class="{clearCls}"></div>', - '</div>' -); - - * This may be specified to produce a different DOM structure when rendering form Fields. - * A description of the properties within the template follows: - * itemCls : StringThe CSS class applied to the outermost div wrapper - * that contains this field label and field element (the default class is 'x-form-item' and itemCls - * will be added to that). If supplied, itemCls at the field level will override the default itemCls - * supplied at the container level. - * id : StringThe id of the Field - * {@link #labelStyle} : String - * A CSS style specification string to add to the field label for this field (defaults to '' or the - * {@link #labelStyle layout's value for labelStyle}). - * label : StringThe text to display as the label for this - * field (defaults to '') - * {@link #labelSeparator} : StringThe separator to display after - * the text of the label for this field (defaults to a colon ':' or the - * {@link #labelSeparator layout's value for labelSeparator}). To hide the separator use empty string ''. - * elementStyle : StringThe styles text for the input element's wrapper. - * clearCls : StringThe CSS class to apply to the special clearing div - * rendered directly after each form field wrapper (defaults to 'x-form-clear-left') - * - * Also see {@link #getTemplateArgs} + * Remove a transaction from the manager. + * @private + * @param {String/Ext.direct.Transaction} transaction The transaction/id of transaction to remove + * @return {Ext.direct.Transaction} transaction */ + removeTransaction: function(transaction){ + transaction = this.getTransaction(transaction); + this.transactions.remove(transaction); + return transaction; + }, /** + * Gets a transaction * @private - * + * @param {String/Ext.direct.Transaction} transaction The transaction/id of transaction to get + * @return {Ext.direct.Transaction} */ - renderItem : function(c, position, target){ - if(c && (c.isFormField || c.fieldLabel) && c.inputType != 'hidden'){ - var args = this.getTemplateArgs(c); - if(Ext.isNumber(position)){ - position = target.dom.childNodes[position] || null; - } - if(position){ - c.itemCt = this.fieldTpl.insertBefore(position, args, true); - }else{ - c.itemCt = this.fieldTpl.append(target, args, true); - } - if(!c.getItemCt){ - // Non form fields don't have getItemCt, apply it here - // This will get cleaned up in onRemove - Ext.apply(c, { - getItemCt: function(){ - return c.itemCt; - }, - customItemCt: true - }); - } - c.label = c.getItemCt().child('label.x-form-item-label'); - if(!c.rendered){ - c.render('x-form-el-' + c.id); - }else if(!this.isValidParent(c, target)){ - Ext.fly('x-form-el-' + c.id).appendChild(c.getPositionEl()); - } - if(this.trackLabels){ - if(c.hidden){ - this.onFieldHide(c); - } - c.on({ - scope: this, - show: this.onFieldShow, - hide: this.onFieldHide - }); + getTransaction: function(transaction){ + return transaction.isTransaction ? transaction : this.transactions.get(transaction); + }, + + onProviderData : function(provider, event){ + var me = this, + i = 0, + len; + + if (Ext.isArray(event)) { + for (len = event.length; i < len; ++i) { + me.onProviderData(provider, event[i]); } - this.configureItem(c); - }else { - Ext.layout.FormLayout.superclass.renderItem.apply(this, arguments); - } - }, - - /** - * Provides template arguments for rendering the fully wrapped, labeled and styled form Field. - * This method returns an object hash containing properties used by the layout's {@link #fieldTpl} - * to create a correctly wrapped, labeled and styled form Field. This may be overriden to - * create custom layouts. The properties which must be returned are: - * itemCls : StringThe CSS class applied to the outermost div wrapper - * that contains this field label and field element (the default class is 'x-form-item' and itemCls - * will be added to that). If supplied, itemCls at the field level will override the default itemCls - * supplied at the container level. - * id : StringThe id of the Field - * {@link #labelStyle} : String - * A CSS style specification string to add to the field label for this field (defaults to '' or the - * {@link #labelStyle layout's value for labelStyle}). - * label : StringThe text to display as the label for this - * field (defaults to the field's configured fieldLabel property) - * {@link #labelSeparator} : StringThe separator to display after - * the text of the label for this field (defaults to a colon ':' or the - * {@link #labelSeparator layout's value for labelSeparator}). To hide the separator use empty string ''. - * elementStyle : StringThe styles text for the input element's wrapper. - * clearCls : StringThe CSS class to apply to the special clearing div - * rendered directly after each form field wrapper (defaults to 'x-form-clear-left') - * - * @param (Ext.form.Field} field The {@link Ext.form.Field Field} being rendered. - * @return {Object} An object hash containing the properties required to render the Field. + return; + } + if (event.name && event.name != 'event' && event.name != 'exception') { + me.fireEvent(event.name, event); + } else if (event.type == 'exception') { + me.fireEvent('exception', event); + } + me.fireEvent('event', event, provider); + } +}, function(){ + // Backwards compatibility + Ext.Direct = Ext.direct.Manager; +}); + +/** + * @class Ext.data.proxy.Direct + * @extends Ext.data.proxy.Server + * + * This class is used to send requests to the server using {@link Ext.direct}. When a request is made, + * the transport mechanism is handed off to the appropriate {@link Ext.direct.RemotingProvider Provider} + * to complete the call. + * + * ## Specifying the function + * This proxy expects a Direct remoting method to be passed in order to be able to complete requests. + * This can be done by specifying the {@link #directFn} configuration. This will use the same direct + * method for all requests. Alternatively, you can provide an {@link #api} configuration. This + * allows you to specify a different remoting method for each CRUD action. + * + * ## Paramaters + * This proxy provides options to help configure which parameters will be sent to the server. + * By specifying the {@link #paramsAsHash} option, it will send an object literal containing each + * of the passed parameters. The {@link #paramOrder} option can be used to specify the order in which + * the remoting method parameters are passed. + * + * ## Example Usage + * + * Ext.define('User', { + * extend: 'Ext.data.Model', + * fields: ['firstName', 'lastName'], + * proxy: { + * type: 'direct', + * directFn: MyApp.getUsers, + * paramOrder: 'id' // Tells the proxy to pass the id as the first parameter to the remoting method. + * } + * }); + * User.load(1); + */ +Ext.define('Ext.data.proxy.Direct', { + /* Begin Definitions */ + + extend: 'Ext.data.proxy.Server', + alternateClassName: 'Ext.data.DirectProxy', + + alias: 'proxy.direct', + + requires: ['Ext.direct.Manager'], + + /* End Definitions */ + + /** + * @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' + */ - getTemplateArgs: function(field) { - var noLabelSep = !field.fieldLabel || field.hideLabel; + paramOrder: undefined, - return { - id : field.id, - label : field.fieldLabel, - itemCls : (field.itemCls || this.container.itemCls || '') + (field.hideLabel ? ' x-hide-label' : ''), - clearCls : field.clearCls || 'x-form-clear-left', - labelStyle : this.getLabelStyle(field.labelStyle), - elementStyle : this.elementStyle || '', - labelSeparator: noLabelSep ? '' : (Ext.isDefined(field.labelSeparator) ? field.labelSeparator : this.labelSeparator) - }; - }, + /** + * @cfg {Boolean} paramsAsHash + * Send parameters as a collection of named arguments (defaults to true). Providing a + * {@link #paramOrder} nullifies this configuration. + */ + 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. + */ + directFn : undefined, + + /** + * @cfg {Object} api The same as {@link Ext.data.proxy.Server#api}, however instead of providing urls, you should provide a direct + * function call. + */ + + /** + * @cfg {Object} extraParams Extra parameters that will be included on every read request. Individual requests with params + * of the same name will override these params when they are in conflict. + */ + // private - adjustWidthAnchor: function(value, c){ - if(c.label && !this.isHide(c) && (this.container.labelAlign != 'top')){ - var adjust = Ext.isIE6 || (Ext.isIE && !Ext.isStrict); - return value - this.labelAdjust + (adjust ? -3 : 0); + paramOrderRe: /[\s,|]/, + + constructor: function(config){ + var me = this; + + Ext.apply(me, config); + if (Ext.isString(me.paramOrder)) { + me.paramOrder = me.paramOrder.split(me.paramOrderRe); } - return value; + me.callParent(arguments); }, - - adjustHeightAnchor : function(value, c){ - if(c.label && !this.isHide(c) && (this.container.labelAlign == 'top')){ - return value - c.label.getHeight(); + + doRequest: function(operation, callback, scope) { + var me = this, + writer = me.getWriter(), + request = me.buildRequest(operation, callback, scope), + fn = me.api[request.action] || me.directFn, + args = [], + params = request.params, + paramOrder = me.paramOrder, + method, + i = 0, + len; + + if (!fn) { + Ext.Error.raise('No direct function specified for this proxy'); + } + + if (operation.allowWrite()) { + request = writer.write(request); + } + + if (operation.action == 'read') { + // We need to pass params + method = fn.directCfg.method; + + if (method.ordered) { + if (method.len > 0) { + if (paramOrder) { + for (len = paramOrder.length; i < len; ++i) { + args.push(params[paramOrder[i]]); + } + } else if (me.paramsAsHash) { + args.push(params); + } + } + } else { + args.push(params); + } + } else { + args.push(request.jsonData); } + + Ext.apply(request, { + args: args, + directFn: fn + }); + args.push(me.createRequestCallback(request, operation, callback, scope), me); + fn.apply(window, args); + }, + + /* + * Inherit docs. We don't apply any encoding here because + * all of the direct requests go out as jsonData + */ + applyEncoding: function(value){ return value; }, - - // private - isValidParent : function(c, target){ - return target && this.container.getEl().contains(c.getPositionEl()); + + createRequestCallback: function(request, operation, callback, scope){ + var me = this; + + return function(data, event){ + me.processResponse(event.status, operation, request, event, callback, scope); + }; + }, + + // inherit docs + extractResponseData: function(response){ + return Ext.isDefined(response.result) ? response.result : response.data; + }, + + // inherit docs + setException: function(operation, response) { + operation.setException(response.message); + }, + + // inherit docs + buildUrl: function(){ + return ''; } - - /** - * @property activeItem - * @hide - */ }); -Ext.Container.LAYOUTS['form'] = Ext.layout.FormLayout; /** - * @class Ext.layout.AccordionLayout - * @extends Ext.layout.FitLayout - * 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 may be used in an accordion layout Container. - * This class is intended to be extended or created via the {@link Ext.Container#layout layout} - * configuration property. See {@link Ext.Container#layout} for additional details. - * Example usage: - * -var accordion = new Ext.Panel({ - title: 'Accordion Layout', - layout:'accordion', - defaults: { - // applied to each contained panel - bodyStyle: 'padding:15px' - }, - layoutConfig: { - // layout-specific configs go here - titleCollapse: false, - animate: true, - activeOnTop: true - }, - items: [{ - title: 'Panel 1', - html: '<p>Panel content!</p>' - },{ - title: 'Panel 2', - html: '<p>Panel content!</p>' - },{ - title: 'Panel 3', - html: '<p>Panel content!</p>' - }] + * @class Ext.data.DirectStore + * @extends Ext.data.Store + * Small helper class to create an {@link Ext.data.Store} configured with an + * {@link Ext.data.proxy.Direct} and {@link Ext.data.reader.Json} 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.reader.Json JsonReader} + * + * {@link Ext.data.reader.Json#root root} + * {@link Ext.data.reader.Json#idProperty idProperty} + * {@link Ext.data.reader.Json#totalProperty totalProperty} + * + * + * {@link Ext.data.proxy.Direct DirectProxy} + * + * {@link Ext.data.proxy.Direct#directFn directFn} + * {@link Ext.data.proxy.Direct#paramOrder paramOrder} + * {@link Ext.data.proxy.Direct#paramsAsHash paramsAsHash} + * + * + * + * @constructor + * @param {Object} config + */ + +Ext.define('Ext.data.DirectStore', { + /* Begin Definitions */ + + extend: 'Ext.data.Store', + + alias: 'store.direct', + + requires: ['Ext.data.proxy.Direct'], + + /* End Definitions */ + + constructor : function(config){ + config = Ext.apply({}, config); + if (!config.proxy) { + var proxy = { + type: 'direct', + reader: { + type: 'json' + } + }; + Ext.copyTo(proxy, config, 'paramOrder,paramsAsHash,directFn,api,simpleSortMode'); + Ext.copyTo(proxy.reader, config, 'totalProperty,root,idProperty'); + config.proxy = proxy; + } + this.callParent([config]); + } }); + +/** + * @class Ext.util.Inflector + * @extends Object + * General purpose inflector class that {@link #pluralize pluralizes}, {@link #singularize singularizes} and + * {@link #ordinalize ordinalizes} words. Sample usage: + * + +//turning singular words into plurals +Ext.util.Inflector.pluralize('word'); //'words' +Ext.util.Inflector.pluralize('person'); //'people' +Ext.util.Inflector.pluralize('sheep'); //'sheep' + +//turning plurals into singulars +Ext.util.Inflector.singularize('words'); //'word' +Ext.util.Inflector.singularize('people'); //'person' +Ext.util.Inflector.singularize('sheep'); //'sheep' + +//ordinalizing numbers +Ext.util.Inflector.ordinalize(11); //"11th" +Ext.util.Inflector.ordinalize(21); //"21th" +Ext.util.Inflector.ordinalize(1043); //"1043rd" + + * + * Customization + * + * The Inflector comes with a default set of US English pluralization rules. These can be augmented with additional + * rules if the default rules do not meet your application's requirements, or swapped out entirely for other languages. + * Here is how we might add a rule that pluralizes "ox" to "oxen": + * + +Ext.util.Inflector.plural(/^(ox)$/i, "$1en"); + + * + * Each rule consists of two items - a regular expression that matches one or more rules, and a replacement string. + * In this case, the regular expression will only match the string "ox", and will replace that match with "oxen". + * Here's how we could add the inverse rule: + * + +Ext.util.Inflector.singular(/^(ox)en$/i, "$1"); + * + * Note that the ox/oxen rules are present by default. + * + * @singleton */ -Ext.layout.AccordionLayout = Ext.extend(Ext.layout.FitLayout, { + +Ext.define('Ext.util.Inflector', { + + /* Begin Definitions */ + + singleton: true, + + /* End Definitions */ + /** - * @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). + * @private + * The registered plural tuples. Each item in the array should contain two items - the first must be a regular + * expression that matchers the singular form of a word, the second must be a String that replaces the matched + * part of the regular expression. This is managed by the {@link #plural} method. + * @property plurals + * @type Array */ - fill : true, + plurals: [ + [(/(quiz)$/i), "$1zes" ], + [(/^(ox)$/i), "$1en" ], + [(/([m|l])ouse$/i), "$1ice" ], + [(/(matr|vert|ind)ix|ex$/i), "$1ices" ], + [(/(x|ch|ss|sh)$/i), "$1es" ], + [(/([^aeiouy]|qu)y$/i), "$1ies" ], + [(/(hive)$/i), "$1s" ], + [(/(?:([^f])fe|([lr])f)$/i), "$1$2ves"], + [(/sis$/i), "ses" ], + [(/([ti])um$/i), "$1a" ], + [(/(buffal|tomat|potat)o$/i), "$1oes" ], + [(/(bu)s$/i), "$1ses" ], + [(/(alias|status|sex)$/i), "$1es" ], + [(/(octop|vir)us$/i), "$1i" ], + [(/(ax|test)is$/i), "$1es" ], + [(/^person$/), "people" ], + [(/^man$/), "men" ], + [(/^(child)$/), "$1ren" ], + [(/s$/i), "s" ], + [(/$/), "s" ] + ], + /** - * @cfg {Boolean} autoWidth - * True to set each contained item's width to 'auto', false to use the item's current width (defaults to true). - * Note that some components, in particular the {@link Ext.grid.GridPanel grid}, will not function properly within - * layouts if they have auto width, so in such cases this config should be set to false. + * @private + * The set of registered singular matchers. Each item in the array should contain two items - the first must be a + * regular expression that matches the plural form of a word, the second must be a String that replaces the + * matched part of the regular expression. This is managed by the {@link #singular} method. + * @property singulars + * @type Array */ - autoWidth : true, + singulars: [ + [(/(quiz)zes$/i), "$1" ], + [(/(matr)ices$/i), "$1ix" ], + [(/(vert|ind)ices$/i), "$1ex" ], + [(/^(ox)en/i), "$1" ], + [(/(alias|status)es$/i), "$1" ], + [(/(octop|vir)i$/i), "$1us" ], + [(/(cris|ax|test)es$/i), "$1is" ], + [(/(shoe)s$/i), "$1" ], + [(/(o)es$/i), "$1" ], + [(/(bus)es$/i), "$1" ], + [(/([m|l])ice$/i), "$1ouse" ], + [(/(x|ch|ss|sh)es$/i), "$1" ], + [(/(m)ovies$/i), "$1ovie" ], + [(/(s)eries$/i), "$1eries"], + [(/([^aeiouy]|qu)ies$/i), "$1y" ], + [(/([lr])ves$/i), "$1f" ], + [(/(tive)s$/i), "$1" ], + [(/(hive)s$/i), "$1" ], + [(/([^f])ves$/i), "$1fe" ], + [(/(^analy)ses$/i), "$1sis" ], + [(/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i), "$1$2sis"], + [(/([ti])a$/i), "$1um" ], + [(/(n)ews$/i), "$1ews" ], + [(/people$/i), "person" ], + [(/s$/i), "" ] + ], + /** - * @cfg {Boolean} titleCollapse - * True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow - * expand/collapse only when the toggle tool button is clicked (defaults to true). When set to false, - * {@link #hideCollapseTool} should be false also. + * @private + * The registered uncountable words + * @property uncountable + * @type Array */ - titleCollapse : true, + uncountable: [ + "sheep", + "fish", + "series", + "species", + "money", + "rice", + "information", + "equipment", + "grass", + "mud", + "offspring", + "deer", + "means" + ], + /** - * @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} should be true also. + * Adds a new singularization rule to the Inflector. See the intro docs for more information + * @param {RegExp} matcher The matcher regex + * @param {String} replacer The replacement string, which can reference matches from the matcher argument */ - hideCollapseTool : false, + singular: function(matcher, replacer) { + this.singulars.unshift([matcher, replacer]); + }, + /** - * @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). + * Adds a new pluralization rule to the Inflector. See the intro docs for more information + * @param {RegExp} matcher The matcher regex + * @param {String} replacer The replacement string, which can reference matches from the matcher argument */ - collapseFirst : false, + plural: function(matcher, replacer) { + this.plurals.unshift([matcher, replacer]); + }, + /** - * @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 false). Note: to defer to the specific config setting of each - * contained panel for this property, set this to undefined at the layout level. + * Removes all registered singularization rules */ - animate : false, + clearSingulars: function() { + this.singulars = []; + }, + /** - * @cfg {Boolean} sequence - * Experimental. If animate is set to true, this will result in each animation running in sequence. + * Removes all registered pluralization rules */ - sequence : false, + clearPlurals: function() { + this.plurals = []; + }, + /** - * @cfg {Boolean} activeOnTop - * 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). + * Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish) + * @param {String} word The word to test + * @return {Boolean} True if the word is transnumeral */ - activeOnTop : false, - - type: 'accordion', - - renderItem : function(c){ - if(this.animate === false){ - c.animCollapse = false; - } - c.collapsible = true; - if(this.autoWidth){ - c.autoWidth = true; - } - if(this.titleCollapse){ - c.titleCollapse = true; - } - if(this.hideCollapseTool){ - c.hideCollapseTool = true; - } - if(this.collapseFirst !== undefined){ - c.collapseFirst = this.collapseFirst; - } - if(!this.activeItem && !c.collapsed){ - this.setActiveItem(c, true); - }else if(this.activeItem && this.activeItem != c){ - c.collapsed = true; - } - Ext.layout.AccordionLayout.superclass.renderItem.apply(this, arguments); - c.header.addClass('x-accordion-hd'); - c.on('beforeexpand', this.beforeExpand, this); + isTransnumeral: function(word) { + return Ext.Array.indexOf(this.uncountable, word) != -1; }, - onRemove: function(c){ - Ext.layout.AccordionLayout.superclass.onRemove.call(this, c); - if(c.rendered){ - c.header.removeClass('x-accordion-hd'); + /** + * Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words') + * @param {String} word The word to pluralize + * @return {String} The pluralized form of the word + */ + pluralize: function(word) { + if (this.isTransnumeral(word)) { + return word; } - c.un('beforeexpand', this.beforeExpand, this); - }, - // private - beforeExpand : function(p, anim){ - var ai = this.activeItem; - if(ai){ - if(this.sequence){ - delete this.activeItem; - if (!ai.collapsed){ - ai.collapse({callback:function(){ - p.expand(anim || true); - }, scope: this}); - return false; - } - }else{ - ai.collapse(this.animate); + var plurals = this.plurals, + length = plurals.length, + tuple, regex, i; + + for (i = 0; i < length; i++) { + tuple = plurals[i]; + regex = tuple[0]; + + if (regex == word || (regex.test && regex.test(word))) { + return word.replace(regex, tuple[1]); } } - this.setActive(p); - if(this.activeOnTop){ - p.el.dom.parentNode.insertBefore(p.el.dom, p.el.dom.parentNode.firstChild); - } - // Items have been hidden an possibly rearranged, we need to get the container size again. - this.layout(); - }, - - // private - setItemSize : function(item, size){ - if(this.fill && item){ - var hh = 0, i, ct = this.getRenderedItems(this.container), len = ct.length, p; - // Add up all the header heights - for (i = 0; i < len; i++) { - if((p = ct[i]) != item && !p.hidden){ - hh += p.header.getHeight(); - } - }; - // Subtract the header heights from the container size - size.height -= hh; - // Call setSize on the container to set the correct height. For Panels, deferedHeight - // will simply store this size for when the expansion is done. - item.setSize(size); - } + + return word; }, - + /** - * Sets the active (expanded) item in the layout. - * @param {String/Number} item The string component id or numeric index of the item to activate + * Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word') + * @param {String} word The word to singularize + * @return {String} The singularized form of the word */ - setActiveItem : function(item){ - this.setActive(item, true); - }, + singularize: function(word) { + if (this.isTransnumeral(word)) { + return word; + } - // private - setActive : function(item, expand){ - var ai = this.activeItem; - item = this.container.getComponent(item); - if(ai != item){ - if(item.rendered && item.collapsed && expand){ - item.expand(); - }else{ - if(ai){ - ai.fireEvent('deactivate', ai); - } - this.activeItem = item; - item.fireEvent('activate', item); + var singulars = this.singulars, + length = singulars.length, + tuple, regex, i; + + for (i = 0; i < length; i++) { + tuple = singulars[i]; + regex = tuple[0]; + + if (regex == word || (regex.test && regex.test(word))) { + return word.replace(regex, tuple[1]); } } - } -}); -Ext.Container.LAYOUTS.accordion = Ext.layout.AccordionLayout; - -//backwards compat -Ext.layout.Accordion = Ext.layout.AccordionLayout;/** - * @class Ext.layout.TableLayout - * @extends Ext.layout.ContainerLayout - * 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:'table' {@link Ext.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#layoutConfig} object which will then be applied internally to the layout. In the - * case of TableLayout, the only valid layout config property is {@link #columns}. 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: - * -// 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 | -// +--------+--------+--------+ -var table = new Ext.Panel({ - title: 'Table Layout', - layout:'table', - defaults: { - // applied to each contained panel - bodyStyle:'padding:20px' - }, - layoutConfig: { - // The total column count must be specified here - columns: 3 + + return word; }, - items: [{ - html: '<p>Cell A content</p>', - rowspan: 2 - },{ - html: '<p>Cell B content</p>', - colspan: 2 - },{ - html: '<p>Cell C content</p>', - cellCls: 'highlight' - },{ - html: '<p>Cell D content</p>' - }] -}); - - */ -Ext.layout.TableLayout = Ext.extend(Ext.layout.ContainerLayout, { + /** - * @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. + * Returns the correct {@link Ext.data.Model Model} name for a given string. Mostly used internally by the data + * package + * @param {String} word The word to classify + * @return {String} The classified version of the word */ - - // private - monitorResize:false, - - type: 'table', - - targetCls: 'x-table-layout-ct', - + classify: function(word) { + return Ext.String.capitalize(this.singularize(word)); + }, + /** - * @cfg {Object} tableAttrs - * An object containing properties which are added to the {@link Ext.DomHelper DomHelper} specification - * used to create the layout's <table> element. Example: -{ - xtype: 'panel', - layout: 'table', - layoutConfig: { - tableAttrs: { - style: { - width: '100%' + * Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the + * number. 21 -> 21st, 22 -> 22nd, 23 -> 23rd, 24 -> 24th etc + * @param {Number} number The number to ordinalize + * @return {String} The ordinalized number + */ + ordinalize: function(number) { + var parsed = parseInt(number, 10), + mod10 = parsed % 10, + mod100 = parsed % 100; + + //11 through 13 are a special case + if (11 <= mod100 && mod100 <= 13) { + return number + "th"; + } else { + switch(mod10) { + case 1 : return number + "st"; + case 2 : return number + "nd"; + case 3 : return number + "rd"; + default: return number + "th"; } - }, - columns: 3 + } } -} - */ - tableAttrs:null, - - // private - setContainer : function(ct){ - Ext.layout.TableLayout.superclass.setContainer.call(this, ct); - - this.currentRow = 0; - this.currentColumn = 0; - this.cells = []; - }, +}, function() { + //aside from the rules above, there are a number of words that have irregular pluralization so we add them here + var irregulars = { + alumnus: 'alumni', + cactus : 'cacti', + focus : 'foci', + nucleus: 'nuclei', + radius: 'radii', + stimulus: 'stimuli', + ellipsis: 'ellipses', + paralysis: 'paralyses', + oasis: 'oases', + appendix: 'appendices', + index: 'indexes', + beau: 'beaux', + bureau: 'bureaux', + tableau: 'tableaux', + woman: 'women', + child: 'children', + man: 'men', + corpus: 'corpora', + criterion: 'criteria', + curriculum: 'curricula', + genus: 'genera', + memorandum: 'memoranda', + phenomenon: 'phenomena', + foot: 'feet', + goose: 'geese', + tooth: 'teeth', + antenna: 'antennae', + formula: 'formulae', + nebula: 'nebulae', + vertebra: 'vertebrae', + vita: 'vitae' + }, + singular; - // private - onLayout : function(ct, target){ - var cs = ct.items.items, len = cs.length, c, i; - - if(!this.table){ - target.addClass('x-table-layout-ct'); - - this.table = target.createChild( - Ext.apply({tag:'table', cls:'x-table-layout', cellspacing: 0, cn: {tag: 'tbody'}}, this.tableAttrs), null, true); - } - this.renderAll(ct, target); - }, + for (singular in irregulars) { + this.plural(singular, irregulars[singular]); + this.singular(irregulars[singular], singular); + } +}); +/** + * @author Ed Spencer + * @class Ext.data.HasManyAssociation + * @extends Ext.data.Association + * + * Represents a one-to-many relationship between two models. Usually created indirectly via a model definition: + * + +Ext.define('Product', { + extend: 'Ext.data.Model', + fields: [ + {name: 'id', type: 'int'}, + {name: 'user_id', type: 'int'}, + {name: 'name', type: 'string'} + ] +}); - // private - getRow : function(index){ - var row = this.table.tBodies[0].childNodes[index]; - if(!row){ - row = document.createElement('tr'); - this.table.tBodies[0].appendChild(row); - } - return row; - }, +Ext.define('User', { + extend: 'Ext.data.Model', + fields: [ + {name: 'id', type: 'int'}, + {name: 'name', type: 'string'} + ], + // we can use the hasMany shortcut on the model to create a hasMany association + hasMany: {model: 'Product', name: 'products'} +}); + +* + * Above we created Product and User models, and linked them by saying that a User hasMany Products. This gives + * us a new function on every User instance, in this case the function is called 'products' because that is the name + * we specified in the association configuration above. + * + * This new function returns a specialized {@link Ext.data.Store Store} which is automatically filtered to load + * only Products for the given model instance: + * + +//first, we load up a User with id of 1 +var user = Ext.ModelManager.create({id: 1, name: 'Ed'}, 'User'); - // private - getNextCell : function(c){ - var cell = this.getNextNonSpan(this.currentColumn, this.currentRow); - var curCol = this.currentColumn = cell[0], curRow = this.currentRow = cell[1]; - for(var rowIndex = curRow; rowIndex < curRow + (c.rowspan || 1); rowIndex++){ - if(!this.cells[rowIndex]){ - this.cells[rowIndex] = []; - } - for(var colIndex = curCol; colIndex < curCol + (c.colspan || 1); colIndex++){ - this.cells[rowIndex][colIndex] = true; - } - } - var td = document.createElement('td'); - if(c.cellId){ - td.id = c.cellId; - } - var cls = 'x-table-layout-cell'; - if(c.cellCls){ - cls += ' ' + c.cellCls; - } - td.className = cls; - if(c.colspan){ - td.colSpan = c.colspan; - } - if(c.rowspan){ - td.rowSpan = c.rowspan; - } - this.getRow(curRow).appendChild(td); - return td; - }, +//the user.products function was created automatically by the association and returns a {@link Ext.data.Store Store} +//the created store is automatically scoped to the set of Products for the User with id of 1 +var products = user.products(); - // private - getNextNonSpan: function(colIndex, rowIndex){ - var cols = this.columns; - while((cols && colIndex >= cols) || (this.cells[rowIndex] && this.cells[rowIndex][colIndex])) { - if(cols && colIndex >= cols){ - rowIndex++; - colIndex = 0; - }else{ - colIndex++; - } - } - return [colIndex, rowIndex]; - }, +//we still have all of the usual Store functions, for example it's easy to add a Product for this User +products.add({ + name: 'Another Product' +}); - // private - renderItem : function(c, position, target){ - // Ensure we have our inner table to get cells to render into. - if(!this.table){ - this.table = target.createChild( - Ext.apply({tag:'table', cls:'x-table-layout', cellspacing: 0, cn: {tag: 'tbody'}}, this.tableAttrs), null, true); - } - if(c && !c.rendered){ - c.render(this.getNextCell(c)); - this.configureItem(c, position); - }else if(c && !this.isValidParent(c, target)){ - var container = this.getNextCell(c); - container.insertBefore(c.getPositionEl().dom, null); - c.container = Ext.get(container); - this.configureItem(c, position); - } - }, +//saves the changes to the store - this automatically sets the new Product's user_id to 1 before saving +products.sync(); + + * + * The new Store is only instantiated the first time you call products() to conserve memory and processing time, + * though calling products() a second time returns the same store instance. + * + * Custom filtering + * + * The Store is automatically furnished with a filter - by default this filter tells the store to only return + * records where the associated model's foreign key matches the owner model's primary key. For example, if a User + * with ID = 100 hasMany Products, the filter loads only Products with user_id == 100. + * + * Sometimes we want to filter by another field - for example in the case of a Twitter search application we may + * have models for Search and Tweet: + * + +Ext.define('Search', { + extend: 'Ext.data.Model', + fields: [ + 'id', 'query' + ], - // private - isValidParent : function(c, target){ - return c.getPositionEl().up('table', 5).dom.parentNode === (target.dom || target); - }, - - destroy: function(){ - delete this.table; - Ext.layout.TableLayout.superclass.destroy.call(this); + hasMany: { + model: 'Tweet', + name : 'tweets', + filterProperty: 'query' } +}); - /** - * @property activeItem - * @hide - */ +Ext.define('Tweet', { + extend: 'Ext.data.Model', + fields: [ + 'id', 'text', 'from_user' + ] }); -Ext.Container.LAYOUTS['table'] = Ext.layout.TableLayout;/** - * @class Ext.layout.AbsoluteLayout - * @extends Ext.layout.AnchorLayout - * This is a layout that inherits the anchoring of {@link Ext.layout.AnchorLayout} 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#layout layout} - * configuration property. See {@link Ext.Container#layout} for additional details. - * Example usage: - * -var form = new Ext.form.FormPanel({ - title: 'Absolute Layout', - layout:'absolute', - layoutConfig: { - // layout-specific configs go here - extraCls: 'x-abs-layout-item', - }, - baseCls: 'x-plain', - url:'save-form.php', - defaultType: 'textfield', - items: [{ - x: 0, - y: 5, - xtype:'label', - text: 'Send To:' - },{ - x: 60, - y: 0, - name: 'to', - anchor:'100%' // anchor width by percentage - },{ - x: 0, - y: 35, - xtype:'label', - text: 'Subject:' - },{ - x: 60, - y: 30, - name: 'subject', - anchor: '100%' // anchor width by percentage - },{ - x:0, - y: 60, - xtype: 'textarea', - name: 'msg', - anchor: '100% 100%' // anchor width and height - }] +//returns a Store filtered by the filterProperty +var store = new Search({query: 'Sencha Touch'}).tweets(); + + * + * The tweets association above is filtered by the query property by setting the {@link #filterProperty}, and is + * equivalent to this: + * + +var store = new Ext.data.Store({ + model: 'Tweet', + filters: [ + { + property: 'query', + value : 'Sencha Touch' + } + ] }); */ -Ext.layout.AbsoluteLayout = Ext.extend(Ext.layout.AnchorLayout, { +Ext.define('Ext.data.HasManyAssociation', { + extend: 'Ext.data.Association', + requires: ['Ext.util.Inflector'], - extraCls: 'x-abs-layout-item', + alias: 'association.hasmany', - type: 'absolute', + /** + * @cfg {String} foreignKey The name of the foreign key on the associated model that links it to the owner + * model. Defaults to the lowercased name of the owner model plus "_id", e.g. an association with a where a + * model called Group hasMany Users would create 'group_id' as the foreign key. When the remote store is loaded, + * the store is automatically filtered so that only records with a matching foreign key are included in the + * resulting child store. This can be overridden by specifying the {@link #filterProperty}. + * +Ext.define('Group', { + extend: 'Ext.data.Model', + fields: ['id', 'name'], + hasMany: 'User' +}); - onLayout : function(ct, target){ - target.position(); - this.paddingLeft = target.getPadding('l'); - this.paddingTop = target.getPadding('t'); - Ext.layout.AbsoluteLayout.superclass.onLayout.call(this, ct, target); +Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id', 'name', 'group_id'], // refers to the id of the group that this user belongs to + belongsTo: 'Group' +}); + * + */ + + /** + * @cfg {String} name The name of the function to create on the owner model to retrieve the child store. + * If not specified, the pluralized name of the child model is used. + * +// This will create a users() method on any Group model instance +Ext.define('Group', { + extend: 'Ext.data.Model', + fields: ['id', 'name'], + hasMany: 'User' +}); +var group = new Group(); +console.log(group.users()); + +// The method to retrieve the users will now be getUserList +Ext.define('Group', { + extend: 'Ext.data.Model', + fields: ['id', 'name'], + hasMany: {model: 'User', name: 'getUserList'} +}); +var group = new Group(); +console.log(group.getUserList()); + * + */ + + /** + * @cfg {Object} storeConfig Optional configuration object that will be passed to the generated Store. Defaults to + * undefined. + */ + + /** + * @cfg {String} filterProperty Optionally overrides the default filter that is set up on the associated Store. If + * this is not set, a filter is automatically created which filters the association based on the configured + * {@link #foreignKey}. See intro docs for more details. Defaults to undefined + */ + + /** + * @cfg {Boolean} autoLoad True to automatically load the related store from a remote source when instantiated. + * Defaults to false. + */ + + /** + * @cfg {String} type The type configuration can be used when creating associations using a configuration object. + * Use 'hasMany' to create a HasManyAssocation + * +associations: [{ + type: 'hasMany', + model: 'User' +}] + * + */ + + constructor: function(config) { + var me = this, + ownerProto, + name; + + me.callParent(arguments); + + me.name = me.name || Ext.util.Inflector.pluralize(me.associatedName.toLowerCase()); + + ownerProto = me.ownerModel.prototype; + name = me.name; + + Ext.applyIf(me, { + storeName : name + "Store", + foreignKey: me.ownerName.toLowerCase() + "_id" + }); + + ownerProto[name] = me.createStore(); }, - - // private - adjustWidthAnchor : function(value, comp){ - return value ? value - comp.getPosition(true)[0] + this.paddingLeft : value; + + /** + * @private + * Creates a function that returns an Ext.data.Store which is configured to load a set of data filtered + * by the owner model's primary key - e.g. in a hasMany association where Group hasMany Users, this function + * returns a Store configured to return the filtered set of a single Group's Users. + * @return {Function} The store-generating function + */ + createStore: function() { + var that = this, + associatedModel = that.associatedModel, + storeName = that.storeName, + foreignKey = that.foreignKey, + primaryKey = that.primaryKey, + filterProperty = that.filterProperty, + autoLoad = that.autoLoad, + storeConfig = that.storeConfig || {}; + + return function() { + var me = this, + config, filter, + modelDefaults = {}; + + if (me[storeName] === undefined) { + if (filterProperty) { + filter = { + property : filterProperty, + value : me.get(filterProperty), + exactMatch: true + }; + } else { + filter = { + property : foreignKey, + value : me.get(primaryKey), + exactMatch: true + }; + } + + modelDefaults[foreignKey] = me.get(primaryKey); + + config = Ext.apply({}, storeConfig, { + model : associatedModel, + filters : [filter], + remoteFilter : false, + modelDefaults: modelDefaults + }); + + me[storeName] = Ext.create('Ext.data.Store', config); + if (autoLoad) { + me[storeName].load(); + } + } + + return me[storeName]; + }; }, - - // private - adjustHeightAnchor : function(value, comp){ - return value ? value - comp.getPosition(true)[1] + this.paddingTop : value; - } + /** - * @property activeItem - * @hide + * Read associated data + * @private + * @param {Ext.data.Model} record The record we're writing to + * @param {Ext.data.reader.Reader} reader The reader for the associated model + * @param {Object} associationData The raw associated data */ + read: function(record, reader, associationData){ + var store = record[this.name](), + inverse; + + store.add(reader.read(associationData).records); + + //now that we've added the related records to the hasMany association, set the inverse belongsTo + //association on each of them if it exists + inverse = this.associatedModel.prototype.associations.findBy(function(assoc){ + return assoc.type === 'belongsTo' && assoc.associatedName === record.$className; + }); + + //if the inverse association was found, set it now on each record we've just created + if (inverse) { + store.data.each(function(associatedRecord){ + associatedRecord[inverse.instanceName] = record; + }); + } + } }); -Ext.Container.LAYOUTS['absolute'] = Ext.layout.AbsoluteLayout; /** - * @class Ext.layout.BoxLayout - * @extends Ext.layout.ContainerLayout - * Base Class for HBoxLayout and VBoxLayout Classes. Generally it should not need to be used directly. + * @class Ext.data.JsonP + * @singleton + * This class is used to create JSONP requests. JSONP is a mechanism that allows for making + * requests for data cross domain. More information is available here: + * http://en.wikipedia.org/wiki/JSONP */ -Ext.layout.BoxLayout = Ext.extend(Ext.layout.ContainerLayout, { +Ext.define('Ext.data.JsonP', { + + /* Begin Definitions */ + + singleton: true, + + statics: { + requestCount: 0, + requests: {} + }, + + /* End Definitions */ + /** - * @cfg {Object} defaultMargins - * If the individual contained items do not have a margins - * property specified, the default margins from this property will be - * applied to each item. - * This property may be specified as an object containing margins - * to apply in the format: -{ - top: (top margin), - right: (right margin), - bottom: (bottom margin), - left: (left margin) -} - * This property may also be specified as a string containing - * space-separated, numeric margin values. The order of the sides associated - * with each value matches the way CSS processes margin values: - * - * If there is only one value, it applies to all sides. - * If there are two values, the top and bottom borders are set to the - * first value and the right and left are set to the second. - * If there are three values, the top is set to the first value, the left - * and right are set to the second, and the bottom is set to the third. - * If there are four values, they apply to the top, right, bottom, and - * left, respectively. - * - * Defaults to: - * {top:0, right:0, bottom:0, left:0} - * + * @property timeout + * @type Number + * A default timeout for any JsonP requests. If the request has not completed in this time the + * failure callback will be fired. The timeout is in ms. Defaults to 30000. */ - defaultMargins : {left:0,top:0,right:0,bottom:0}, + timeout: 30000, + /** - * @cfg {String} padding - * Sets the padding to be applied to all child items managed by this layout. - * This property must be specified as a string containing - * space-separated, numeric padding values. The order of the sides associated - * with each value matches the way CSS processes padding values: - * - * If there is only one value, it applies to all sides. - * If there are two values, the top and bottom borders are set to the - * first value and the right and left are set to the second. - * If there are three values, the top is set to the first value, the left - * and right are set to the second, and the bottom is set to the third. - * If there are four values, they apply to the top, right, bottom, and - * left, respectively. - * - * Defaults to: "0" + * @property disableCaching + * @type Boolean + * True to add a unique cache-buster param to requests. Defaults to true. */ - padding : '0', - // documented in subclasses - pack : 'start', - - // private - monitorResize : true, - type: 'box', - scrollOffset : 0, - extraCls : 'x-box-item', - targetCls : 'x-box-layout-ct', - innerCls : 'x-box-inner', - - constructor : function(config){ - Ext.layout.BoxLayout.superclass.constructor.call(this, config); - - if (Ext.isString(this.defaultMargins)) { - this.defaultMargins = this.parseMargins(this.defaultMargins); - } - }, - + disableCaching: true, + /** - * @private - * Runs the child box calculations and caches them in childBoxCache. Subclasses can used these cached values - * when laying out + * @property disableCachingParam + * @type String + * Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc'. */ - onLayout: function(container, target) { - Ext.layout.BoxLayout.superclass.onLayout.call(this, container, target); - - var items = this.getVisibleItems(container), - tSize = this.getLayoutTargetSize(); - - /** - * @private - * @property layoutTargetLastSize - * @type Object - * Private cache of the last measured size of the layout target. This should never be used except by - * BoxLayout subclasses during their onLayout run. - */ - this.layoutTargetLastSize = tSize; - - /** - * @private - * @property childBoxCache - * @type Array - * Array of the last calculated height, width, top and left positions of each visible rendered component - * within the Box layout. - */ - this.childBoxCache = this.calculateChildBoxes(items, tSize); - - this.updateInnerCtSize(tSize, this.childBoxCache); - this.updateChildBoxes(this.childBoxCache.boxes); - - // Putting a box layout into an overflowed container is NOT correct and will make a second layout pass necessary. - this.handleTargetOverflow(tSize, container, target); + disableCachingParam: '_dc', + + /** + * @property callbackKey + * @type String + * Specifies the GET parameter that will be sent to the server containing the function name to be executed when + * the request completes. Defaults to callback. Thus, a common request will be in the form of + * url?callback=Ext.data.JsonP.callback1 + */ + callbackKey: 'callback', + + /** + * Makes a JSONP request. + * @param {Object} options An object which may contain the following properties. Note that options will + * take priority over any defaults that are specified in the class. + * + * url : String The URL to request. + * params : Object (Optional)An object containing a series of + * key value pairs that will be sent along with the request. + * timeout : Number (Optional) See {@link #timeout} + * callbackKey : String (Optional) See {@link #callbackKey} + * callbackName : String (Optional) The function name to use for this request. + * By default this name will be auto-generated: Ext.data.JsonP.callback1, Ext.data.JsonP.callback2, etc. + * Setting this option to "my_name" will force the function name to be Ext.data.JsonP.my_name. + * Use this if you want deterministic behavior, but be careful - the callbackName should be different + * in each JsonP request that you make. + * disableCaching : Boolean (Optional) See {@link #disableCaching} + * disableCachingParam : String (Optional) See {@link #disableCachingParam} + * success : Function (Optional) A function to execute if the request succeeds. + * failure : Function (Optional) A function to execute if the request fails. + * callback : Function (Optional) A function to execute when the request + * completes, whether it is a success or failure. + * scope : Object (Optional)The scope in + * which to execute the callbacks: The "this" object for the callback function. Defaults to the browser window. + * + * @return {Object} request An object containing the request details. + */ + request: function(options){ + options = Ext.apply({}, options); + + if (!options.url) { + Ext.Error.raise('A url must be specified for a JSONP request.'); + } + + var me = this, + disableCaching = Ext.isDefined(options.disableCaching) ? options.disableCaching : me.disableCaching, + cacheParam = options.disableCachingParam || me.disableCachingParam, + id = ++me.statics().requestCount, + callbackName = options.callbackName || 'callback' + id, + callbackKey = options.callbackKey || me.callbackKey, + timeout = Ext.isDefined(options.timeout) ? options.timeout : me.timeout, + params = Ext.apply({}, options.params), + url = options.url, + request, + script; + + params[callbackKey] = 'Ext.data.JsonP.' + callbackName; + if (disableCaching) { + params[cacheParam] = new Date().getTime(); + } + + script = me.createScript(url, params); + + me.statics().requests[id] = request = { + url: url, + params: params, + script: script, + id: id, + scope: options.scope, + success: options.success, + failure: options.failure, + callback: options.callback, + callbackName: callbackName + }; + + if (timeout > 0) { + request.timeout = setTimeout(Ext.bind(me.handleTimeout, me, [request]), timeout); + } + + me.setupErrorHandling(request); + me[callbackName] = Ext.bind(me.handleResponse, me, [request], true); + Ext.getHead().appendChild(script); + return request; }, - + /** - * Resizes and repositions each child component - * @param {Array} boxes The box measurements + * Abort a request. If the request parameter is not specified all open requests will + * be aborted. + * @param {Object/String} request (Optional) The request to abort */ - updateChildBoxes: function(boxes) { - for (var i = 0, length = boxes.length; i < length; i++) { - var box = boxes[i], - comp = box.component; - - if (box.dirtySize) { - comp.setSize(box.width, box.height); + abort: function(request){ + var requests = this.statics().requests, + key; + + if (request) { + if (!request.id) { + request = requests[request]; } - // Don't set positions to NaN - if (isNaN(box.left) || isNaN(box.top)) { - continue; + this.abort(request); + } else { + for (key in requests) { + if (requests.hasOwnProperty(key)) { + this.abort(requests[key]); + } } - comp.setPosition(box.left, box.top); } }, - + /** + * Sets up error handling for the script * @private - * Called by onRender just before the child components are sized and positioned. This resizes the innerCt - * to make sure all child items fit within it. We call this before sizing the children because if our child - * items are larger than the previous innerCt size the browser will insert scrollbars and then remove them - * again immediately afterwards, giving a performance hit. - * Subclasses should provide an implementation. - * @param {Object} currentSize The current height and width of the innerCt - * @param {Array} calculations The new box calculations of all items to be laid out + * @param {Object} request The request */ - updateInnerCtSize: Ext.emptyFn, - + setupErrorHandling: function(request){ + request.script.onerror = Ext.bind(this.handleError, this, [request]); + }, + /** + * Handles any aborts when loading the script * @private - * This should be called after onLayout of any BoxLayout subclass. If the target's overflow is not set to 'hidden', - * we need to lay out a second time because the scrollbars may have modified the height and width of the layout - * target. Having a Box layout inside such a target is therefore not recommended. - * @param {Object} previousTargetSize The size and height of the layout target before we just laid out - * @param {Ext.Container} container The container - * @param {Ext.Element} target The target element + * @param {Object} request The request */ - handleTargetOverflow: function(previousTargetSize, container, target) { - var overflow = target.getStyle('overflow'); - - if (overflow && overflow != 'hidden' &&!this.adjustmentPass) { - var newTargetSize = this.getLayoutTargetSize(); - if (newTargetSize.width != previousTargetSize.width || newTargetSize.height != previousTargetSize.height){ - this.adjustmentPass = true; - this.onLayout(container, target); - } - } - - delete this.adjustmentPass; - }, - - // private - isValidParent : function(c, target){ - return this.innerCt && c.getPositionEl().dom.parentNode == this.innerCt.dom; + handleAbort: function(request){ + request.errorType = 'abort'; + this.handleResponse(null, request); }, - + /** + * Handles any script errors when loading the script * @private - * Returns all items that are both rendered and visible - * @return {Array} All matching items + * @param {Object} request The request */ - getVisibleItems: function(ct) { - var ct = ct || this.container, - t = ct.getLayoutTarget(), - cti = ct.items.items, - len = cti.length, - - i, c, items = []; - - for (i = 0; i < len; i++) { - if((c = cti[i]).rendered && this.isValidParent(c, t) && c.hidden !== true && c.collapsed !== true){ - items.push(c); - } - } - - return items; - }, - - // private - renderAll : function(ct, target){ - if(!this.innerCt){ - // the innerCt prevents wrapping and shuffling while - // the container is resizing - this.innerCt = target.createChild({cls:this.innerCls}); - this.padding = this.parseMargins(this.padding); - } - Ext.layout.BoxLayout.superclass.renderAll.call(this, ct, this.innerCt); - }, - - getLayoutTargetSize : function(){ - var target = this.container.getLayoutTarget(), ret; - if (target) { - ret = target.getViewSize(); - - // IE in strict mode will return a width of 0 on the 1st pass of getViewSize. - // Use getStyleSize to verify the 0 width, the adjustment pass will then work properly - // with getViewSize - if (Ext.isIE && Ext.isStrict && ret.width == 0){ - ret = target.getStyleSize(); - } - - ret.width -= target.getPadding('lr'); - ret.height -= target.getPadding('tb'); - } - return ret; + handleError: function(request){ + request.errorType = 'error'; + this.handleResponse(null, request); }, - - // private - renderItem : function(c){ - if(Ext.isString(c.margins)){ - c.margins = this.parseMargins(c.margins); - }else if(!c.margins){ - c.margins = this.defaultMargins; - } - Ext.layout.BoxLayout.superclass.renderItem.apply(this, arguments); - } -}); - -/** - * @class Ext.layout.VBoxLayout - * @extends Ext.layout.BoxLayout - * A layout that arranges items vertically down a Container. This layout optionally divides available vertical - * space between child items containing a numeric flex configuration. - * This layout may also be used to set the widths of child items by configuring it with the {@link #align} option. - */ -Ext.layout.VBoxLayout = Ext.extend(Ext.layout.BoxLayout, { - /** - * @cfg {String} align - * Controls how the child items of the container are aligned. Acceptable configuration values for this - * property are: - * - * left : Defaultchild items are aligned horizontally - * at the left side of the container - * center : child items are aligned horizontally at the - * mid-width of the container - * stretch : child items are stretched horizontally to fill - * the width of the container - * stretchmax : child items are stretched horizontally to - * the size of the largest item. - * - */ - align : 'left', // left, center, stretch, strechmax - type: 'vbox', - + /** - * @cfg {String} pack - * Controls how the child items of the container are packed together. Acceptable configuration values - * for this property are: - * - * start : Defaultchild items are packed together at - * top side of container - * center : child items are packed together at - * mid-height of container - * end : child items are packed together at bottom - * side of container - * + * Cleans up anu script handling errors + * @private + * @param {Object} request The request */ - - /** - * @cfg {Number} flex - * This configuation option is to be applied to child items of the container managed - * by this layout. Each child item with a flex property will be flexed vertically - * according to each item's relative flex value compared to the sum of all items with - * a flex value specified. Any child items that have either a flex = 0 or - * flex = undefined will not be 'flexed' (the initial size will not be changed). + cleanupErrorHandling: function(request){ + request.script.onerror = null; + }, + + /** + * Handle any script timeouts + * @private + * @param {Object} request The request */ - + handleTimeout: function(request){ + request.errorType = 'timeout'; + this.handleResponse(null, request); + }, + /** + * Handle a successful response * @private - * See parent documentation + * @param {Object} result The result from the request + * @param {Object} request The request */ - updateInnerCtSize: function(tSize, calcs) { - var innerCtHeight = tSize.height, - innerCtWidth = calcs.meta.maxWidth + this.padding.left + this.padding.right; - - if (this.align == 'stretch') { - innerCtWidth = tSize.width; - } else if (this.align == 'center') { - innerCtWidth = Math.max(tSize.width, innerCtWidth); + handleResponse: function(result, request){ + + var success = true; + + if (request.timeout) { + clearTimeout(request.timeout); } - - //we set the innerCt size first because if our child items are larger than the previous innerCt size - //the browser will insert scrollbars and then remove them again immediately afterwards - this.innerCt.setSize(innerCtWidth || undefined, innerCtHeight || undefined); + delete this[request.callbackName]; + delete this.statics()[request.id]; + this.cleanupErrorHandling(request); + Ext.fly(request.script).remove(); + + if (request.errorType) { + success = false; + Ext.callback(request.failure, request.scope, [request.errorType]); + } else { + Ext.callback(request.success, request.scope, [result]); + } + Ext.callback(request.callback, request.scope, [success, result, request.errorType]); }, - + /** + * Create the script tag * @private - * Calculates the size and positioning of each item in the VBox. This iterates over all of the rendered, - * visible items and returns a height, width, top and left for each, as well as a reference to each. Also - * returns meta data such as maxHeight which are useful when resizing layout wrappers such as this.innerCt. - * @param {Array} visibleItems The array of all rendered, visible items to be calculated for - * @param {Object} targetSize Object containing target size and height - * @return {Object} Object containing box measurements for each child, plus meta data + * @param {String} url The url of the request + * @param {Object} params Any extra params to be sent */ - calculateChildBoxes: function(visibleItems, targetSize) { - var visibleCount = visibleItems.length, - - padding = this.padding, - topOffset = padding.top, - leftOffset = padding.left, - paddingVert = topOffset + padding.bottom, - paddingHoriz = leftOffset + padding.right, - - width = targetSize.width - this.scrollOffset, - height = targetSize.height, - availWidth = Math.max(0, width - paddingHoriz), - - isStart = this.pack == 'start', - isCenter = this.pack == 'center', - isEnd = this.pack == 'end', - - nonFlexHeight= 0, - maxWidth = 0, - totalFlex = 0, - - //used to cache the calculated size and position values for each child item - boxes = [], - - //used in the for loops below, just declared here for brevity - child, childWidth, childHeight, childSize, childMargins, canLayout, i, calcs, flexedHeight, horizMargins, stretchWidth; + createScript: function(url, params) { + var script = document.createElement('script'); + script.setAttribute("src", Ext.urlAppend(url, Ext.Object.toQueryString(params))); + script.setAttribute("async", true); + script.setAttribute("type", "text/javascript"); + return script; + } +}); - //gather the total flex of all flexed items and the width taken up by fixed width items - for (i = 0; i < visibleCount; i++) { - child = visibleItems[i]; - childHeight = child.height; - childWidth = child.width; - canLayout = !child.hasLayout && Ext.isFunction(child.doLayout); +/** + * @class Ext.data.JsonPStore + * @extends Ext.data.Store + * @ignore + * @private + * NOTE: This class is in need of migration to the new API. + * Small helper class to make creating {@link Ext.data.Store}s from different domain JSON data easier. + * A JsonPStore will be automatically configured with a {@link Ext.data.reader.Json} and a {@link Ext.data.proxy.JsonP JsonPProxy}. + * A store configuration would be something like: +var store = new Ext.data.JsonPStore({ + // store configs + autoDestroy: true, + storeId: 'myStore', + // proxy configs + url: 'get-images.php', - // Static height (numeric) requires no calcs - if (!Ext.isNumber(childHeight)) { + // 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: +stcCallback({ + 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)} + ] +}) + * + * Where stcCallback is the callback name passed in the request to the remote domain. See {@link Ext.data.proxy.JsonP JsonPProxy} + * for details of how this works. + * 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.reader.Json JsonReader} and {@link Ext.data.proxy.JsonP JsonPProxy}. + * @constructor + * @param {Object} config + * @xtype jsonpstore + */ +Ext.define('Ext.data.JsonPStore', { + extend: 'Ext.data.Store', + alias : 'store.jsonp', - // flex and not 'auto' height - if (child.flex && !childHeight) { - totalFlex += child.flex; + /** + * @cfg {Ext.data.DataReader} reader @hide + */ + constructor: function(config) { + this.callParent(Ext.apply(config, { + reader: Ext.create('Ext.data.reader.Json', config), + proxy : Ext.create('Ext.data.proxy.JsonP', config) + })); + } +}); - // Not flexed or 'auto' height or undefined height - } else { - //Render and layout sub-containers without a flex or width defined, as otherwise we - //don't know how wide the sub-container should be and cannot calculate flexed widths - if (!childHeight && canLayout) { - child.doLayout(); +/** + * @class Ext.data.NodeInterface + * This class is meant to be used as a set of methods that are applied to the prototype of a + * Record to decorate it with a Node API. This means that models used in conjunction with a tree + * will have all of the tree related methods available on the model. In general this class will + * not be used directly by the developer. + */ +Ext.define('Ext.data.NodeInterface', { + requires: ['Ext.data.Field'], + + statics: { + /** + * This method allows you to decorate a Record's prototype to implement the NodeInterface. + * This adds a set of methods, new events, new properties and new fields on every Record + * with the same Model as the passed Record. + * @param {Ext.data.Record} record The Record you want to decorate the prototype of. + * @static + */ + decorate: function(record) { + if (!record.isNode) { + // Apply the methods and fields to the prototype + // @TODO: clean this up to use proper class system stuff + var mgr = Ext.ModelManager, + modelName = record.modelName, + modelClass = mgr.getModel(modelName), + idName = modelClass.prototype.idProperty, + instances = Ext.Array.filter(mgr.all.getArray(), function(item) { + return item.modelName == modelName; + }), + iln = instances.length, + newFields = [], + i, instance, jln, j, newField; + + // Start by adding the NodeInterface methods to the Model's prototype + modelClass.override(this.getPrototypeBody()); + newFields = this.applyFields(modelClass, [ + {name: idName, type: 'string', defaultValue: null}, + {name: 'parentId', type: 'string', defaultValue: null}, + {name: 'index', type: 'int', defaultValue: null}, + {name: 'depth', type: 'int', defaultValue: 0}, + {name: 'expanded', type: 'bool', defaultValue: false, persist: false}, + {name: 'checked', type: 'auto', defaultValue: null}, + {name: 'leaf', type: 'bool', defaultValue: false, persist: false}, + {name: 'cls', type: 'string', defaultValue: null, persist: false}, + {name: 'iconCls', type: 'string', defaultValue: null, persist: false}, + {name: 'root', type: 'boolean', defaultValue: false, persist: false}, + {name: 'isLast', type: 'boolean', defaultValue: false, persist: false}, + {name: 'isFirst', type: 'boolean', defaultValue: false, persist: false}, + {name: 'allowDrop', type: 'boolean', defaultValue: true, persist: false}, + {name: 'allowDrag', type: 'boolean', defaultValue: true, persist: false}, + {name: 'loaded', type: 'boolean', defaultValue: false, persist: false}, + {name: 'loading', type: 'boolean', defaultValue: false, persist: false}, + {name: 'href', type: 'string', defaultValue: null, persist: false}, + {name: 'hrefTarget',type: 'string', defaultValue: null, persist: false}, + {name: 'qtip', type: 'string', defaultValue: null, persist: false}, + {name: 'qtitle', type: 'string', defaultValue: null, persist: false} + ]); + + jln = newFields.length; + // Set default values to all instances already out there + for (i = 0; i < iln; i++) { + instance = instances[i]; + for (j = 0; j < jln; j++) { + newField = newFields[j]; + if (instance.get(newField.name) === undefined) { + instance.data[newField.name] = newField.defaultValue; } - - childSize = child.getSize(); - childWidth = childSize.width; - childHeight = childSize.height; } } - - childMargins = child.margins; - - nonFlexHeight += (childHeight || 0) + childMargins.top + childMargins.bottom; - - // Max width for align - force layout of non-layed out subcontainers without a numeric width - if (!Ext.isNumber(childWidth)) { - if (canLayout) { - child.doLayout(); - } - childWidth = child.getWidth(); - } - - maxWidth = Math.max(maxWidth, childWidth + childMargins.left + childMargins.right); - - //cache the size of each child component - boxes.push({ - component: child, - height : childHeight || undefined, - width : childWidth || undefined - }); - } - - //the height available to the flexed items - var availableHeight = Math.max(0, (height - nonFlexHeight - paddingVert)); - - if (isCenter) { - topOffset += availableHeight / 2; - } else if (isEnd) { - topOffset += availableHeight; } + + Ext.applyIf(record, { + firstChild: null, + lastChild: null, + parentNode: null, + previousSibling: null, + nextSibling: null, + childNodes: [] + }); + // Commit any fields so the record doesn't show as dirty initially + record.commit(true); + + record.enableBubble([ + /** + * @event append + * Fires when a new child node is appended + * @param {Node} this This node + * @param {Node} node The newly appended node + * @param {Number} index The index of the newly appended node + */ + "append", - //temporary variables used in the flex height calculations below - var remainingHeight = availableHeight, - remainingFlex = totalFlex; - - //calculate the height of each flexed item, and the left + top positions of every item - for (i = 0; i < visibleCount; i++) { - child = visibleItems[i]; - calcs = boxes[i]; - - childMargins = child.margins; - horizMargins = childMargins.left + childMargins.right; + /** + * @event remove + * Fires when a child node is removed + * @param {Node} this This node + * @param {Node} node The removed node + */ + "remove", - topOffset += childMargins.top; + /** + * @event move + * Fires when this node is moved to a new location in the 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", - if (isStart && child.flex && !child.height) { - flexedHeight = Math.ceil((child.flex / remainingFlex) * remainingHeight); - remainingHeight -= flexedHeight; - remainingFlex -= child.flex; + /** + * @event insert + * Fires when a new child node is inserted. + * @param {Node} this This node + * @param {Node} node The child node inserted + * @param {Node} refNode The child node the node was inserted before + */ + "insert", - calcs.height = flexedHeight; - calcs.dirtySize = true; - } + /** + * @event beforeappend + * Fires before a new child is appended, return false to cancel the append. + * @param {Node} this This node + * @param {Node} node The child node to be appended + */ + "beforeappend", - calcs.left = leftOffset + childMargins.left; - calcs.top = topOffset; + /** + * @event beforeremove + * Fires before a child is removed, return false to cancel the remove. + * @param {Node} this This node + * @param {Node} node The child node to be removed + */ + "beforeremove", - switch (this.align) { - case 'stretch': - stretchWidth = availWidth - horizMargins; - calcs.width = stretchWidth.constrain(child.minWidth || 0, child.maxWidth || 1000000); - calcs.dirtySize = true; - break; - case 'stretchmax': - stretchWidth = maxWidth - horizMargins; - calcs.width = stretchWidth.constrain(child.minWidth || 0, child.maxWidth || 1000000); - calcs.dirtySize = true; - break; - case 'center': - var diff = availWidth - calcs.width - horizMargins; - if (diff > 0) { - calcs.left = leftOffset + horizMargins + (diff / 2); - } + /** + * @event beforemove + * Fires before this node is moved to a new location in the tree. Return false to cancel the move. + * @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", + + /** + * @event beforeinsert + * Fires before a new child is inserted, return false to cancel the insert. + * @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", + + /** + * @event expand + * Fires when this node is expanded. + * @param {Node} this The expanding node + */ + "expand", + + /** + * @event collapse + * Fires when this node is collapsed. + * @param {Node} this The collapsing node + */ + "collapse", + + /** + * @event beforeexpand + * Fires before this node is expanded. + * @param {Node} this The expanding node + */ + "beforeexpand", + + /** + * @event beforecollapse + * Fires before this node is collapsed. + * @param {Node} this The collapsing node + */ + "beforecollapse", + + /** + * @event beforecollapse + * Fires before this node is collapsed. + * @param {Node} this The collapsing node + */ + "sort" + ]); + + return record; + }, + + applyFields: function(modelClass, addFields) { + var modelPrototype = modelClass.prototype, + fields = modelPrototype.fields, + keys = fields.keys, + ln = addFields.length, + addField, i, name, + newFields = []; + + for (i = 0; i < ln; i++) { + addField = addFields[i]; + if (!Ext.Array.contains(keys, addField.name)) { + addField = Ext.create('data.field', addField); + + newFields.push(addField); + fields.add(addField); } - - topOffset += calcs.height + childMargins.bottom; - } - - return { - boxes: boxes, - meta : { - maxWidth: maxWidth } - }; - } -}); - -Ext.Container.LAYOUTS.vbox = Ext.layout.VBoxLayout; - -/** - * @class Ext.layout.HBoxLayout - * @extends Ext.layout.BoxLayout - * A layout that arranges items horizontally across a Container. This layout optionally divides available horizontal - * space between child items containing a numeric flex configuration. - * This layout may also be used to set the heights of child items by configuring it with the {@link #align} option. - */ -Ext.layout.HBoxLayout = Ext.extend(Ext.layout.BoxLayout, { - /** - * @cfg {String} align - * Controls how the child items of the container are aligned. Acceptable configuration values for this - * property are: - * - * top : Defaultchild items are aligned vertically - * at the top of the container - * middle : child items are aligned vertically in the - * middle of the container - * stretch : child items are stretched vertically to fill - * the height of the container - * stretchmax : child items are stretched vertically to - * the height of the largest item. - */ - align: 'top', // top, middle, stretch, strechmax - - type : 'hbox', + + return newFields; + }, + + getPrototypeBody: function() { + return { + isNode: true, - /** - * @private - * See parent documentation - */ - updateInnerCtSize: function(tSize, calcs) { - var innerCtWidth = tSize.width, - innerCtHeight = calcs.meta.maxHeight + this.padding.top + this.padding.bottom; + /** + * Ensures that the passed object is an instance of a Record with the NodeInterface applied + * @return {Boolean} + */ + createNode: function(node) { + if (Ext.isObject(node) && !node.isModel) { + node = Ext.ModelManager.create(node, this.modelName); + } + // Make sure the node implements the node interface + return Ext.data.NodeInterface.decorate(node); + }, + + /** + * Returns true if this node is a leaf + * @return {Boolean} + */ + isLeaf : function() { + return this.get('leaf') === true; + }, - if (this.align == 'stretch') { - innerCtHeight = tSize.height; - } else if (this.align == 'middle') { - innerCtHeight = Math.max(tSize.height, innerCtHeight); - } + /** + * Sets the first child of this node + * @private + * @param {Ext.data.NodeInterface} node + */ + setFirstChild : function(node) { + this.firstChild = node; + }, - this.innerCt.setSize(innerCtWidth || undefined, innerCtHeight || undefined); - }, + /** + * Sets the last child of this node + * @private + * @param {Ext.data.NodeInterface} node + */ + setLastChild : function(node) { + this.lastChild = node; + }, - /** - * @cfg {String} pack - * Controls how the child items of the container are packed together. Acceptable configuration values - * for this property are: - * - * start : Defaultchild items are packed together at - * left side of container - * center : child items are packed together at - * mid-width of container - * end : child items are packed together at right - * side of container - * - */ - /** - * @cfg {Number} flex - * This configuation option is to be applied to child items of the container managed - * by this layout. Each child item with a flex property will be flexed horizontally - * according to each item's relative flex value compared to the sum of all items with - * a flex value specified. Any child items that have either a flex = 0 or - * flex = undefined will not be 'flexed' (the initial size will not be changed). - */ + /** + * Updates general data of this node like isFirst, isLast, depth. This + * method is internally called after a node is moved. This shouldn't + * have to be called by the developer unless they are creating custom + * Tree plugins. + * @return {Boolean} + */ + updateInfo: function(silent) { + var me = this, + isRoot = me.isRoot(), + parentNode = me.parentNode, + isFirst = (!parentNode ? true : parentNode.firstChild == me), + isLast = (!parentNode ? true : parentNode.lastChild == me), + depth = 0, + parent = me, + children = me.childNodes, + len = children.length, + i = 0; + + while (parent.parentNode) { + ++depth; + parent = parent.parentNode; + } + + me.beginEdit(); + me.set({ + isFirst: isFirst, + isLast: isLast, + depth: depth, + index: parentNode ? parentNode.indexOf(me) : 0, + parentId: parentNode ? parentNode.getId() : null + }); + me.endEdit(silent); + if (silent) { + me.commit(); + } + + for (i = 0; i < len; i++) { + children[i].updateInfo(silent); + } + }, - /** - * @private - * Calculates the size and positioning of each item in the HBox. This iterates over all of the rendered, - * visible items and returns a height, width, top and left for each, as well as a reference to each. Also - * returns meta data such as maxHeight which are useful when resizing layout wrappers such as this.innerCt. - * @param {Array} visibleItems The array of all rendered, visible items to be calculated for - * @param {Object} targetSize Object containing target size and height - * @return {Object} Object containing box measurements for each child, plus meta data - */ - calculateChildBoxes: function(visibleItems, targetSize) { - var visibleCount = visibleItems.length, + /** + * Returns true if this node is the last child of its parent + * @return {Boolean} + */ + isLast : function() { + return this.get('isLast'); + }, - padding = this.padding, - topOffset = padding.top, - leftOffset = padding.left, - paddingVert = topOffset + padding.bottom, - paddingHoriz = leftOffset + padding.right, + /** + * Returns true if this node is the first child of its parent + * @return {Boolean} + */ + isFirst : function() { + return this.get('isFirst'); + }, - width = targetSize.width - this.scrollOffset, - height = targetSize.height, - availHeight = Math.max(0, height - paddingVert), + /** + * Returns true if this node has one or more child nodes, else false. + * @return {Boolean} + */ + hasChildNodes : function() { + return !this.isLeaf() && this.childNodes.length > 0; + }, - isStart = this.pack == 'start', - isCenter = this.pack == 'center', - isEnd = this.pack == 'end', - // isRestore = ['stretch', 'stretchmax'].indexOf(this.align) == -1, + /** + * 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} + */ + isExpandable : function() { + return this.get('expandable') || this.hasChildNodes(); + }, - nonFlexWidth = 0, - maxHeight = 0, - totalFlex = 0, + /** + * Insert node(s) as the last child node of this node. + * If the node was previously a child node of another parent node, it will be removed from that node first. + * @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 + */ + appendChild : function(node, suppressEvents, suppressNodeUpdate) { + var me = this, + i, ln, + index, + oldParent, + ps; + + // if passed an array or multiple args do them one by one + if (Ext.isArray(node)) { + for (i = 0, ln = node.length; i < ln; i++) { + me.appendChild(node[i]); + } + } else { + // Make sure it is a record + node = me.createNode(node); + + if (suppressEvents !== true && me.fireEvent("beforeappend", me, node) === false) { + return false; + } - //used to cache the calculated size and position values for each child item - boxes = [], + index = me.childNodes.length; + oldParent = node.parentNode; - //used in the for loops below, just declared here for brevity - child, childWidth, childHeight, childSize, childMargins, canLayout, i, calcs, flexedWidth, vertMargins, stretchHeight; + // it's a move, make sure we move it cleanly + if (oldParent) { + if (suppressEvents !== true && node.fireEvent("beforemove", node, oldParent, me, index) === false) { + return false; + } + oldParent.removeChild(node, null, false, true); + } - //gather the total flex of all flexed items and the width taken up by fixed width items - for (i = 0; i < visibleCount; i++) { - child = visibleItems[i]; - childHeight = child.height; - childWidth = child.width; - canLayout = !child.hasLayout && Ext.isFunction(child.doLayout); + index = me.childNodes.length; + if (index === 0) { + me.setFirstChild(node); + } - // Static width (numeric) requires no calcs - if (!Ext.isNumber(childWidth)) { + me.childNodes.push(node); + node.parentNode = me; + node.nextSibling = null; + + me.setLastChild(node); + + ps = me.childNodes[index - 1]; + if (ps) { + node.previousSibling = ps; + ps.nextSibling = node; + ps.updateInfo(suppressNodeUpdate); + } else { + node.previousSibling = null; + } - // flex and not 'auto' width - if (child.flex && !childWidth) { - totalFlex += child.flex; + node.updateInfo(suppressNodeUpdate); + + // As soon as we append a child to this node, we are loaded + if (!me.isLoaded()) { + me.set('loaded', true); + } + // If this node didnt have any childnodes before, update myself + else if (me.childNodes.length === 1) { + me.set('loaded', me.isLoaded()); + } + + if (suppressEvents !== true) { + me.fireEvent("append", me, node, index); - // Not flexed or 'auto' width or undefined width - } else { - //Render and layout sub-containers without a flex or width defined, as otherwise we - //don't know how wide the sub-container should be and cannot calculate flexed widths - if (!childWidth && canLayout) { - child.doLayout(); + if (oldParent) { + node.fireEvent("move", node, oldParent, me, index); + } } - childSize = child.getSize(); - childWidth = childSize.width; - childHeight = childSize.height; + return node; } - } - - childMargins = child.margins; - - nonFlexWidth += (childWidth || 0) + childMargins.left + childMargins.right; + }, + + /** + * Returns the bubble target for this node + * @private + * @return {Object} The bubble target + */ + getBubbleTarget: function() { + return this.parentNode; + }, - // Max height for align - force layout of non-layed out subcontainers without a numeric height - if (!Ext.isNumber(childHeight)) { - if (canLayout) { - child.doLayout(); + /** + * 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 + */ + removeChild : function(node, destroy, suppressEvents, suppressNodeUpdate) { + var me = this, + index = me.indexOf(node); + + if (index == -1 || (suppressEvents !== true && me.fireEvent("beforeremove", me, node) === false)) { + return false; } - childHeight = child.getHeight(); - } - - maxHeight = Math.max(maxHeight, childHeight + childMargins.top + childMargins.bottom); - - //cache the size of each child component - boxes.push({ - component: child, - height : childHeight || undefined, - width : childWidth || undefined - }); - } - //the width available to the flexed items - var availableWidth = Math.max(0, (width - nonFlexWidth - paddingHoriz)); + // remove it from childNodes collection + me.childNodes.splice(index, 1); - if (isCenter) { - leftOffset += availableWidth / 2; - } else if (isEnd) { - leftOffset += availableWidth; - } + // update child refs + if (me.firstChild == node) { + me.setFirstChild(node.nextSibling); + } + if (me.lastChild == node) { + me.setLastChild(node.previousSibling); + } + + // update siblings + if (node.previousSibling) { + node.previousSibling.nextSibling = node.nextSibling; + node.previousSibling.updateInfo(suppressNodeUpdate); + } + if (node.nextSibling) { + node.nextSibling.previousSibling = node.previousSibling; + node.nextSibling.updateInfo(suppressNodeUpdate); + } - //temporary variables used in the flex width calculations below - var remainingWidth = availableWidth, - remainingFlex = totalFlex; + if (suppressEvents !== true) { + me.fireEvent("remove", me, node); + } + + + // If this node suddenly doesnt have childnodes anymore, update myself + if (!me.childNodes.length) { + me.set('loaded', me.isLoaded()); + } + + if (destroy) { + node.destroy(true); + } else { + node.clear(); + } - //calculate the widths of each flexed item, and the left + top positions of every item - for (i = 0; i < visibleCount; i++) { - child = visibleItems[i]; - calcs = boxes[i]; + return node; + }, - childMargins = child.margins; - vertMargins = childMargins.top + childMargins.bottom; + /** + * Creates a copy (clone) of this Node. + * @param {String} id (optional) A new id, defaults to this Node's id. See {@link #id}. + * @param {Boolean} deep (optional) If passed as true, all child Nodes are recursively copied into the new Node. + * If omitted or false, the copy will have no child Nodes. + * @return {Node} A copy of this Node. + */ + copy: function(newId, deep) { + var me = this, + result = me.callOverridden(arguments), + len = me.childNodes ? me.childNodes.length : 0, + i; + + // Move child nodes across to the copy if required + if (deep) { + for (i = 0; i < len; i++) { + result.appendChild(me.childNodes[i].copy(true)); + } + } + return result; + }, - leftOffset += childMargins.left; + /** + * Clear the node. + * @private + * @param {Boolean} destroy True to destroy the node. + */ + clear : function(destroy) { + var me = this; + + // clear any references from the node + me.parentNode = me.previousSibling = me.nextSibling = null; + if (destroy) { + me.firstChild = me.lastChild = null; + } + }, - if (isStart && child.flex && !child.width) { - flexedWidth = Math.ceil((child.flex / remainingFlex) * remainingWidth); - remainingWidth -= flexedWidth; - remainingFlex -= child.flex; + /** + * Destroys the node. + */ + destroy : function(silent) { + /* + * Silent is to be used in a number of cases + * 1) When setRoot is called. + * 2) When destroy on the tree is called + * 3) For destroying child nodes on a node + */ + var me = this, + options = me.destroyOptions; + + if (silent === true) { + me.clear(true); + Ext.each(me.childNodes, function(n) { + n.destroy(true); + }); + me.childNodes = null; + delete me.destroyOptions; + me.callOverridden([options]); + } else { + me.destroyOptions = silent; + // overridden method will be called, since remove will end up calling destroy(true); + me.remove(true); + } + }, - calcs.width = flexedWidth; - calcs.dirtySize = true; - } + /** + * 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, suppressEvents) { + var me = this, + index = me.indexOf(refNode), + oldParent = node.parentNode, + refIndex = index, + ps; + + if (!refNode) { // like standard Dom, refNode can be null for append + return me.appendChild(node); + } + + // nothing to do + if (node == refNode) { + return false; + } - calcs.left = leftOffset; - calcs.top = topOffset + childMargins.top; + // Make sure it is a record with the NodeInterface + node = me.createNode(node); + + if (suppressEvents !== true && me.fireEvent("beforeinsert", me, node, refNode) === false) { + return false; + } + + // when moving internally, indexes will change after remove + if (oldParent == me && me.indexOf(node) < index) { + refIndex--; + } - switch (this.align) { - case 'stretch': - stretchHeight = availHeight - vertMargins; - calcs.height = stretchHeight.constrain(child.minHeight || 0, child.maxHeight || 1000000); - calcs.dirtySize = true; - break; - case 'stretchmax': - stretchHeight = maxHeight - vertMargins; - calcs.height = stretchHeight.constrain(child.minHeight || 0, child.maxHeight || 1000000); - calcs.dirtySize = true; - break; - case 'middle': - var diff = availHeight - calcs.height - vertMargins; - if (diff > 0) { - calcs.top = topOffset + vertMargins + (diff / 2); + // it's a move, make sure we move it cleanly + if (oldParent) { + if (suppressEvents !== true && node.fireEvent("beforemove", node, oldParent, me, index, refNode) === false) { + return false; } - } - leftOffset += calcs.width + childMargins.right; - } - - return { - boxes: boxes, - meta : { - maxHeight: maxHeight - } - }; - } -}); - -Ext.Container.LAYOUTS.hbox = Ext.layout.HBoxLayout; -/** - * @class Ext.layout.ToolbarLayout - * @extends Ext.layout.ContainerLayout - * Layout manager used by Ext.Toolbar. This is highly specialised for use by Toolbars and would not - * usually be used by any other class. - */ -Ext.layout.ToolbarLayout = Ext.extend(Ext.layout.ContainerLayout, { - monitorResize : true, - - type: 'toolbar', + oldParent.removeChild(node); + } - /** - * @property triggerWidth - * @type Number - * The width allocated for the menu trigger at the extreme right end of the Toolbar - */ - triggerWidth: 18, + if (refIndex === 0) { + me.setFirstChild(node); + } - /** - * @property noItemsMenuText - * @type String - * HTML fragment to render into the toolbar overflow menu if there are no items to display - */ - noItemsMenuText : '(None)', + me.childNodes.splice(refIndex, 0, node); + node.parentNode = me; + + node.nextSibling = refNode; + refNode.previousSibling = node; + + ps = me.childNodes[refIndex - 1]; + if (ps) { + node.previousSibling = ps; + ps.nextSibling = node; + ps.updateInfo(); + } else { + node.previousSibling = null; + } + + node.updateInfo(); + + if (!me.isLoaded()) { + me.set('loaded', true); + } + // If this node didnt have any childnodes before, update myself + else if (me.childNodes.length === 1) { + me.set('loaded', me.isLoaded()); + } - /** - * @private - * @property lastOverflow - * @type Boolean - * Used internally to record whether the last layout caused an overflow or not - */ - lastOverflow: false, + if (suppressEvents !== true) { + me.fireEvent("insert", me, node, refNode); - /** - * @private - * @property tableHTML - * @type String - * String used to build the HTML injected to support the Toolbar's layout. The align property is - * injected into this string inside the td.x-toolbar-left element during onLayout. - */ - tableHTML: [ - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - ' ', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - ' ', - '', - '', - '', - '', - '', - '', - '' - ].join(""), + if (oldParent) { + node.fireEvent("move", node, oldParent, me, refIndex, refNode); + } + } - /** - * @private - * Create the wrapping Toolbar HTML and render/move all the items into the correct places - */ - onLayout : function(ct, target) { - //render the Toolbar HTML if it's not already present - if (!this.leftTr) { - var align = ct.buttonAlign == 'center' ? 'center' : 'left'; + return node; + }, + + /** + * Insert a node into this node + * @param {Number} index The zero-based index to insert the node at + * @param {Ext.data.Model} node The node to insert + * @return {Ext.data.Record} The record you just inserted + */ + insertChild: function(index, node) { + var sibling = this.childNodes[index]; + if (sibling) { + return this.insertBefore(node, sibling); + } + else { + return this.appendChild(node); + } + }, - target.addClass('x-toolbar-layout-ct'); - target.insertHtml('beforeEnd', String.format(this.tableHTML, align)); + /** + * 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, suppressEvents) { + var parentNode = this.parentNode; - this.leftTr = target.child('tr.x-toolbar-left-row', true); - this.rightTr = target.child('tr.x-toolbar-right-row', true); - this.extrasTr = target.child('tr.x-toolbar-extras-row', true); + if (parentNode) { + parentNode.removeChild(this, destroy, suppressEvents, true); + } + return this; + }, - if (this.hiddenItem == undefined) { /** - * @property hiddenItems - * @type Array - * Holds all items that are currently hidden due to there not being enough space to render them - * These items will appear on the expand menu. + * Removes all child nodes from this node. + * @param {Boolean} destroy true to destroy the node upon removal. Defaults to false. + * @return {Node} this */ - this.hiddenItems = []; - } - } - - var side = ct.buttonAlign == 'right' ? this.rightTr : this.leftTr, - items = ct.items.items, - position = 0; + removeAll : function(destroy, suppressEvents) { + var cn = this.childNodes, + n; - //render each item if not already rendered, place it into the correct (left or right) target - for (var i = 0, len = items.length, c; i < len; i++, position++) { - c = items[i]; + while ((n = cn[0])) { + this.removeChild(n, destroy, suppressEvents); + } + return this; + }, - if (c.isFill) { - side = this.rightTr; - position = -1; - } else if (!c.rendered) { - c.render(this.insertCell(c, side, position)); - } else { - if (!c.xtbHidden && !this.isValidParent(c, side.childNodes[position])) { - var td = this.insertCell(c, side, position); - td.appendChild(c.getPositionEl().dom); - c.container = Ext.get(td); - } - } - } + /** + * Returns the child node at the specified index. + * @param {Number} index + * @return {Node} + */ + getChildAt : function(index) { + return this.childNodes[index]; + }, - //strip extra empty cells - this.cleanup(this.leftTr); - this.cleanup(this.rightTr); - this.cleanup(this.extrasTr); - this.fitToSize(target); - }, + /** + * 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, suppressEvents) { + var s = oldChild ? oldChild.nextSibling : null; + + this.removeChild(oldChild, suppressEvents); + this.insertBefore(newChild, s, suppressEvents); + return oldChild; + }, - /** - * @private - * Removes any empty nodes from the given element - * @param {Ext.Element} el The element to clean up - */ - cleanup : function(el) { - var cn = el.childNodes, i, c; + /** + * Returns the index of a child node + * @param {Node} node + * @return {Number} The index of the node or -1 if it was not found + */ + indexOf : function(child) { + return Ext.Array.indexOf(this.childNodes, child); + }, - for (i = cn.length-1; i >= 0 && (c = cn[i]); i--) { - if (!c.firstChild) { - el.removeChild(c); - } - } - }, + /** + * Returns depth of this node (the root node has a depth of 0) + * @return {Number} + */ + getDepth : function() { + return this.get('depth'); + }, - /** - * @private - * Inserts the given Toolbar item into the given element - * @param {Ext.Component} c The component to add - * @param {Ext.Element} target The target to add the component to - * @param {Number} position The position to add the component at - */ - insertCell : function(c, target, position) { - var td = document.createElement('td'); - td.className = 'x-toolbar-cell'; + /** + * 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; + } + p = p.parentNode; + } + }, - target.insertBefore(td, target.childNodes[position] || null); + cascade: function() { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.data.Node: cascade has been deprecated. Please use cascadeBy instead.'); + } + return this.cascadeBy.apply(this, arguments); + }, - return td; - }, + /** + * 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) + */ + cascadeBy : function(fn, scope, args) { + if (fn.apply(scope || this, args || [this]) !== false) { + var childNodes = this.childNodes, + length = childNodes.length, + i; + + for (i = 0; i < length; i++) { + childNodes[i].cascadeBy(fn, scope, args); + } + } + }, - /** - * @private - * Hides an item because it will not fit in the available width. The item will be unhidden again - * if the Toolbar is resized to be large enough to show it - * @param {Ext.Component} item The item to hide - */ - hideItem : function(item) { - this.hiddenItems.push(item); + /** + * 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) + */ + eachChild : function(fn, scope, args) { + var childNodes = this.childNodes, + length = childNodes.length, + i; - item.xtbHidden = true; - item.xtbWidth = item.getPositionEl().dom.parentNode.offsetWidth; - item.hide(); - }, + for (i = 0; i < length; i++) { + if (fn.apply(scope || this, args || [childNodes[i]]) === false) { + break; + } + } + }, - /** - * @private - * Unhides an item that was previously hidden due to there not being enough space left on the Toolbar - * @param {Ext.Component} item The item to show - */ - unhideItem : function(item) { - item.show(); - item.xtbHidden = false; - this.hiddenItems.remove(item); - }, + /** + * 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 + */ + findChild : function(attribute, value, deep) { + return this.findChildBy(function() { + return this.get(attribute) == value; + }, null, deep); + }, - /** - * @private - * Returns the width of the given toolbar item. If the item is currently hidden because there - * is not enough room to render it, its previous width is returned - * @param {Ext.Component} c The component to measure - * @return {Number} The width of the item - */ - getItemWidth : function(c) { - return c.hidden ? (c.xtbWidth || 0) : c.getPositionEl().dom.parentNode.offsetWidth; - }, + /** + * 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 - * Called at the end of onLayout. At this point the Toolbar has already been resized, so we need - * to fit the items into the available width. We add up the width required by all of the items in - * the toolbar - if we don't have enough space we hide the extra items and render the expand menu - * trigger. - * @param {Ext.Element} target The Element the Toolbar is currently laid out within - */ - fitToSize : function(target) { - if (this.container.enableOverflow === false) { - return; - } + return null; + }, - var width = target.dom.clientWidth, - tableWidth = target.dom.firstChild.offsetWidth, - clipWidth = width - this.triggerWidth, - lastWidth = this.lastWidth || 0, + /** + * Returns true if this node is an ancestor (at any point) of the passed node. + * @param {Node} node + * @return {Boolean} + */ + contains : function(node) { + return node.isAncestor(this); + }, - hiddenItems = this.hiddenItems, - hasHiddens = hiddenItems.length != 0, - isLarger = width >= lastWidth; + /** + * Returns true if the passed node is an ancestor (at any point) of this node. + * @param {Node} node + * @return {Boolean} + */ + isAncestor : function(node) { + var p = this.parentNode; + while (p) { + if (p == node) { + return true; + } + p = p.parentNode; + } + return false; + }, - this.lastWidth = width; + /** + * 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 {Boolean} recursive Whether or not to apply this sort recursively + * @param {Boolean} suppressEvent Set to true to not fire a sort event. + */ + sort : function(sortFn, recursive, suppressEvent) { + var cs = this.childNodes, + ln = cs.length, + i, n; + + if (ln > 0) { + Ext.Array.sort(cs, sortFn); + for (i = 0; i < ln; i++) { + n = cs[i]; + n.previousSibling = cs[i-1]; + n.nextSibling = cs[i+1]; + + if (i === 0) { + this.setFirstChild(n); + n.updateInfo(); + } + if (i == ln - 1) { + this.setLastChild(n); + n.updateInfo(); + } + if (recursive && !n.isLeaf()) { + n.sort(sortFn, true, true); + } + } + + if (suppressEvent !== true) { + this.fireEvent('sort', this, cs); + } + } + }, + + /** + * Returns true if this node is expaned + * @return {Boolean} + */ + isExpanded: function() { + return this.get('expanded'); + }, + + /** + * Returns true if this node is loaded + * @return {Boolean} + */ + isLoaded: function() { + return this.get('loaded'); + }, - if (tableWidth > width || (hasHiddens && isLarger)) { - var items = this.container.items.items, - len = items.length, - loopWidth = 0, - item; + /** + * Returns true if this node is loading + * @return {Boolean} + */ + isLoading: function() { + return this.get('loading'); + }, + + /** + * Returns true if this node is the root node + * @return {Boolean} + */ + isRoot: function() { + return !this.parentNode; + }, + + /** + * Returns true if this node is visible + * @return {Boolean} + */ + isVisible: function() { + var parent = this.parentNode; + while (parent) { + if (!parent.isExpanded()) { + return false; + } + parent = parent.parentNode; + } + return true; + }, + + /** + * Expand this node. + * @param {Function} recursive (Optional) True to recursively expand all the children + * @param {Function} callback (Optional) The function to execute once the expand completes + * @param {Object} scope (Optional) The scope to run the callback in + */ + expand: function(recursive, callback, scope) { + var me = this; + + // all paths must call the callback (eventually) or things like + // selectPath fail + + // First we start by checking if this node is a parent + if (!me.isLeaf()) { + // Now we check if this record is already expanding or expanded + if (!me.isLoading() && !me.isExpanded()) { + // The TreeStore actually listens for the beforeexpand method and checks + // whether we have to asynchronously load the children from the server + // first. Thats why we pass a callback function to the event that the + // store can call once it has loaded and parsed all the children. + me.fireEvent('beforeexpand', me, function(records) { + me.set('expanded', true); + me.fireEvent('expand', me, me.childNodes, false); + + // Call the expandChildren method if recursive was set to true + if (recursive) { + me.expandChildren(true, callback, scope); + } + else { + Ext.callback(callback, scope || me, [me.childNodes]); + } + }, me); + } + // If it is is already expanded but we want to recursively expand then call expandChildren + else if (recursive) { + me.expandChildren(true, callback, scope); + } + else { + Ext.callback(callback, scope || me, [me.childNodes]); + } - for (var i = 0; i < len; i++) { - item = items[i]; + // TODO - if the node isLoading, we probably need to defer the + // callback until it is loaded (e.g., selectPath would need us + // to not make the callback until the childNodes exist). + } + // If it's not then we fire the callback right away + else { + Ext.callback(callback, scope || me); // leaf = no childNodes + } + }, + + /** + * Expand all the children of this node. + * @param {Function} recursive (Optional) True to recursively expand all the children + * @param {Function} callback (Optional) The function to execute once all the children are expanded + * @param {Object} scope (Optional) The scope to run the callback in + */ + expandChildren: function(recursive, callback, scope) { + var me = this, + i = 0, + nodes = me.childNodes, + ln = nodes.length, + node, + expanding = 0; + + for (; i < ln; ++i) { + node = nodes[i]; + if (!node.isLeaf() && !node.isExpanded()) { + expanding++; + nodes[i].expand(recursive, function () { + expanding--; + if (callback && !expanding) { + Ext.callback(callback, scope || me, me.childNodes); + } + }); + } + } + + if (!expanding && callback) { + Ext.callback(callback, scope || me, me.childNodes); + } + }, - if (!item.isFill) { - loopWidth += this.getItemWidth(item); - if (loopWidth > clipWidth) { - if (!(item.hidden || item.xtbHidden)) { - this.hideItem(item); + /** + * Collapse this node. + * @param {Function} recursive (Optional) True to recursively collapse all the children + * @param {Function} callback (Optional) The function to execute once the collapse completes + * @param {Object} scope (Optional) The scope to run the callback in + */ + collapse: function(recursive, callback, scope) { + var me = this; + + // First we start by checking if this node is a parent + if (!me.isLeaf()) { + // Now we check if this record is already collapsing or collapsed + if (!me.collapsing && me.isExpanded()) { + me.fireEvent('beforecollapse', me, function(records) { + me.set('expanded', false); + me.fireEvent('collapse', me, me.childNodes, false); + + // Call the collapseChildren method if recursive was set to true + if (recursive) { + me.collapseChildren(true, callback, scope); + } + else { + Ext.callback(callback, scope || me, [me.childNodes]); + } + }, me); + } + // If it is is already collapsed but we want to recursively collapse then call collapseChildren + else if (recursive) { + me.collapseChildren(true, callback, scope); + } + } + // If it's not then we fire the callback right away + else { + Ext.callback(callback, scope || me, me.childNodes); + } + }, + + /** + * Collapse all the children of this node. + * @param {Function} recursive (Optional) True to recursively collapse all the children + * @param {Function} callback (Optional) The function to execute once all the children are collapsed + * @param {Object} scope (Optional) The scope to run the callback in + */ + collapseChildren: function(recursive, callback, scope) { + var me = this, + i = 0, + nodes = me.childNodes, + ln = nodes.length, + node, + collapsing = 0; + + for (; i < ln; ++i) { + node = nodes[i]; + if (!node.isLeaf() && node.isExpanded()) { + collapsing++; + nodes[i].collapse(recursive, function () { + collapsing--; + if (callback && !collapsing) { + Ext.callback(callback, scope || me, me.childNodes); + } + }); } - } else if (item.xtbHidden) { - this.unhideItem(item); + } + + if (!collapsing && callback) { + Ext.callback(callback, scope || me, me.childNodes); } } - } - } - - //test for number of hidden items again here because they may have changed above - hasHiddens = hiddenItems.length != 0; - - if (hasHiddens) { - this.initMore(); - - if (!this.lastOverflow) { - this.container.fireEvent('overflowchange', this.container, true); - this.lastOverflow = true; - } - } else if (this.more) { - this.clearMenu(); - this.more.destroy(); - delete this.more; - - if (this.lastOverflow) { - this.container.fireEvent('overflowchange', this.container, false); - this.lastOverflow = false; - } + }; } - }, - + } +}); +/** + * @class Ext.data.NodeStore + * @extends Ext.data.AbstractStore + * Node Store + * @ignore + */ +Ext.define('Ext.data.NodeStore', { + extend: 'Ext.data.Store', + alias: 'store.node', + requires: ['Ext.data.NodeInterface'], + /** - * @private - * Returns a menu config for a given component. This config is used to create a menu item - * to be added to the expander menu - * @param {Ext.Component} component The component to create the config for - * @param {Boolean} hideOnClick Passed through to the menu item + * @cfg {Ext.data.Record} node The Record you want to bind this Store to. Note that + * this record will be decorated with the Ext.data.NodeInterface if this is not the + * case yet. */ - createMenuConfig : function(component, hideOnClick){ - var config = Ext.apply({}, component.initialConfig), - group = component.toggleGroup; - - Ext.copyTo(config, component, [ - 'iconCls', 'icon', 'itemId', 'disabled', 'handler', 'scope', 'menu' - ]); - - Ext.apply(config, { - text : component.overflowText || component.text, - hideOnClick: hideOnClick - }); - - if (group || component.enableToggle) { - Ext.apply(config, { - group : group, - checked: component.pressed, - listeners: { - checkchange: function(item, checked){ - component.toggle(checked); - } - } - }); - } - - delete config.ownerCt; - delete config.xtype; - delete config.id; - - return config; - }, - + node: null, + /** - * @private - * Adds the given Toolbar item to the given menu. Buttons inside a buttongroup are added individually. - * @param {Ext.menu.Menu} menu The menu to add to - * @param {Ext.Component} component The component to add + * @cfg {Boolean} recursive Set this to true if you want this NodeStore to represent + * all the descendents of the node in its flat data collection. This is useful for + * rendering a tree structure to a DataView and is being used internally by + * the TreeView. Any records that are moved, removed, inserted or appended to the + * node at any depth below the node this store is bound to will be automatically + * updated in this Store's internal flat data structure. */ - addComponentToMenu : function(menu, component) { - if (component instanceof Ext.Toolbar.Separator) { - menu.add('-'); - - } else if (Ext.isFunction(component.isXType)) { - if (component.isXType('splitbutton')) { - menu.add(this.createMenuConfig(component, true)); + recursive: false, + + /** + * @cfg {Boolean} rootVisible false to not include the root node in this Stores collection (defaults to true) + */ + rootVisible: false, + + constructor: function(config) { + var me = this, + node; + + config = config || {}; + Ext.apply(me, config); + + if (Ext.isDefined(me.proxy)) { + Ext.Error.raise("A NodeStore cannot be bound to a proxy. Instead bind it to a record " + + "decorated with the NodeInterface by setting the node config."); + } - } else if (component.isXType('button')) { - menu.add(this.createMenuConfig(component, !component.menu)); + config.proxy = {type: 'proxy'}; + me.callParent([config]); - } else if (component.isXType('buttongroup')) { - component.items.each(function(item){ - this.addComponentToMenu(menu, item); - }, this); - } + me.addEvents('expand', 'collapse', 'beforeexpand', 'beforecollapse'); + + node = me.node; + if (node) { + me.node = null; + me.setNode(node); } }, - - /** - * @private - * Deletes the sub-menu of each item in the expander menu. Submenus are created for items such as - * splitbuttons and buttongroups, where the Toolbar item cannot be represented by a single menu item - */ - clearMenu : function(){ - var menu = this.moreMenu; - if (menu && menu.items) { - menu.items.each(function(item){ - delete item.menu; + + setNode: function(node) { + var me = this; + + if (me.node && me.node != node) { + // We want to unbind our listeners on the old node + me.mun(me.node, { + expand: me.onNodeExpand, + collapse: me.onNodeCollapse, + append: me.onNodeAppend, + insert: me.onNodeInsert, + remove: me.onNodeRemove, + sort: me.onNodeSort, + scope: me }); + me.node = null; } - }, - - /** - * @private - * Called before the expand menu is shown, this rebuilds the menu since it was last shown because - * it is possible that the items hidden due to space limitations on the Toolbar have changed since. - * @param {Ext.menu.Menu} m The menu - */ - beforeMoreShow : function(menu) { - var items = this.container.items.items, - len = items.length, - item, - prev; - - var needsSep = function(group, item){ - return group.isXType('buttongroup') && !(item instanceof Ext.Toolbar.Separator); - }; - - this.clearMenu(); - menu.removeAll(); - for (var i = 0; i < len; i++) { - item = items[i]; - if (item.xtbHidden) { - if (prev && (needsSep(item, prev) || needsSep(prev, item))) { - menu.add('-'); - } - this.addComponentToMenu(menu, item); - prev = item; + + if (node) { + Ext.data.NodeInterface.decorate(node); + me.removeAll(); + if (me.rootVisible) { + me.add(node); + } + me.mon(node, { + expand: me.onNodeExpand, + collapse: me.onNodeCollapse, + append: me.onNodeAppend, + insert: me.onNodeInsert, + remove: me.onNodeRemove, + sort: me.onNodeSort, + scope: me + }); + me.node = node; + if (node.isExpanded() && node.isLoaded()) { + me.onNodeExpand(node, node.childNodes, true); } } - - // put something so the menu isn't empty if no compatible items found - if (menu.items.length < 1) { - menu.add(this.noItemsMenuText); + }, + + onNodeSort: function(node, childNodes) { + var me = this; + + if ((me.indexOf(node) !== -1 || (node === me.node && !me.rootVisible) && node.isExpanded())) { + me.onNodeCollapse(node, childNodes, true); + me.onNodeExpand(node, childNodes, true); } }, + + onNodeExpand: function(parent, records, suppressEvent) { + var me = this, + insertIndex = me.indexOf(parent) + 1, + ln = records ? records.length : 0, + i, record; + + if (!me.recursive && parent !== me.node) { + return; + } + + if (!me.isVisible(parent)) { + return; + } - /** - * @private - * Creates the expand trigger and menu, adding them to the at the extreme right of the - * Toolbar table - */ - initMore : function(){ - if (!this.more) { - /** - * @private - * @property moreMenu - * @type Ext.menu.Menu - * The expand menu - holds items for every Toolbar item that cannot be shown - * because the Toolbar is currently not wide enough. - */ - this.moreMenu = new Ext.menu.Menu({ - ownerCt : this.container, - listeners: { - beforeshow: this.beforeMoreShow, - scope: this + if (!suppressEvent && me.fireEvent('beforeexpand', parent, records, insertIndex) === false) { + return; + } + + if (ln) { + me.insert(insertIndex, records); + for (i = 0; i < ln; i++) { + record = records[i]; + if (record.isExpanded()) { + if (record.isLoaded()) { + // Take a shortcut + me.onNodeExpand(record, record.childNodes, true); + } + else { + record.set('expanded', false); + record.expand(); + } } - }); - - /** - * @private - * @property more - * @type Ext.Button - * The expand button which triggers the overflow menu to be shown - */ - this.more = new Ext.Button({ - iconCls: 'x-toolbar-more-icon', - cls : 'x-toolbar-more', - menu : this.moreMenu, - ownerCt: this.container - }); - - var td = this.insertCell(this.more, this.extrasTr, 100); - this.more.render(td); + } } - }, - - destroy : function(){ - Ext.destroy(this.more, this.moreMenu); - delete this.leftTr; - delete this.rightTr; - delete this.extrasTr; - Ext.layout.ToolbarLayout.superclass.destroy.call(this); - } -}); - -Ext.Container.LAYOUTS.toolbar = Ext.layout.ToolbarLayout; -/** - * @class Ext.layout.MenuLayout - * @extends Ext.layout.ContainerLayout - * Layout manager used by {@link Ext.menu.Menu}. Generally this class should not need to be used directly. - */ - Ext.layout.MenuLayout = Ext.extend(Ext.layout.ContainerLayout, { - monitorResize : true, - type: 'menu', - - setContainer : function(ct){ - this.monitorResize = !ct.floating; - // This event is only fired by the menu in IE, used so we don't couple - // the menu with the layout. - ct.on('autosize', this.doAutoSize, this); - Ext.layout.MenuLayout.superclass.setContainer.call(this, ct); + if (!suppressEvent) { + me.fireEvent('expand', parent, records); + } }, - renderItem : function(c, position, target){ - if (!this.itemTpl) { - this.itemTpl = Ext.layout.MenuLayout.prototype.itemTpl = new Ext.XTemplate( - '', - '', - '', - '', - '' - ); + onNodeCollapse: function(parent, records, suppressEvent) { + var me = this, + ln = records.length, + collapseIndex = me.indexOf(parent) + 1, + i, record; + + if (!me.recursive && parent !== me.node) { + return; + } + + if (!suppressEvent && me.fireEvent('beforecollapse', parent, records, collapseIndex) === false) { + return; } - if(c && !c.rendered){ - if(Ext.isNumber(position)){ - position = target.dom.childNodes[position]; - } - var a = this.getItemArgs(c); - -// The Component's positionEl is the it is rendered into - c.render(c.positionEl = position ? - this.itemTpl.insertBefore(position, a, true) : - this.itemTpl.append(target, a, true)); - -// Link the containing to the item. - c.positionEl.menuItemId = c.getItemId(); - -// If rendering a regular Component, and it needs an icon, -// move the Component rightwards. - if (!a.isMenuItem && a.needsIcon) { - c.positionEl.addClass('x-menu-list-item-indent'); + for (i = 0; i < ln; i++) { + record = records[i]; + me.remove(record); + if (record.isExpanded()) { + me.onNodeCollapse(record, record.childNodes, true); } - this.configureItem(c, position); - }else if(c && !this.isValidParent(c, target)){ - if(Ext.isNumber(position)){ - position = target.dom.childNodes[position]; - } - target.dom.insertBefore(c.getActionEl().dom, position || null); + } + + if (!suppressEvent) { + me.fireEvent('collapse', parent, records, collapseIndex); } }, + + onNodeAppend: function(parent, node, index) { + var me = this, + refNode, sibling; - getItemArgs : function(c) { - var isMenuItem = c instanceof Ext.menu.Item; - return { - isMenuItem: isMenuItem, - needsIcon: !isMenuItem && (c.icon || c.iconCls), - icon: c.icon || Ext.BLANK_IMAGE_URL, - iconCls: 'x-menu-item-icon ' + (c.iconCls || ''), - itemId: 'x-menu-el-' + c.id, - itemCls: 'x-menu-list-item ' - }; + if (me.isVisible(node)) { + if (index === 0) { + refNode = parent; + } else { + sibling = node.previousSibling; + while (sibling.isExpanded() && sibling.lastChild) { + sibling = sibling.lastChild; + } + refNode = sibling; + } + me.insert(me.indexOf(refNode) + 1, node); + if (!node.isLeaf() && node.isExpanded()) { + if (node.isLoaded()) { + // Take a shortcut + me.onNodeExpand(node, node.childNodes, true); + } + else { + node.set('expanded', false); + node.expand(); + } + } + } }, - - // Valid if the Component is in a which is part of our target - isValidParent : function(c, target) { - return c.el.up('li.x-menu-list-item', 5).dom.parentNode === (target.dom || target); + + onNodeInsert: function(parent, node, refNode) { + var me = this, + index = this.indexOf(refNode); + + if (index != -1 && me.isVisible(node)) { + me.insert(index, node); + if (!node.isLeaf() && node.isExpanded()) { + if (node.isLoaded()) { + // Take a shortcut + me.onNodeExpand(node, node.childNodes, true); + } + else { + node.set('expanded', false); + node.expand(); + } + } + } }, - - onLayout : function(ct, target){ - Ext.layout.MenuLayout.superclass.onLayout.call(this, ct, target); - this.doAutoSize(); + + onNodeRemove: function(parent, node, index) { + var me = this; + if (me.indexOf(node) != -1) { + if (!node.isLeaf() && node.isExpanded()) { + me.onNodeCollapse(node, node.childNodes, true); + } + me.remove(node); + } }, - - doAutoSize : function(){ - var ct = this.container, w = ct.width; - if(ct.floating){ - if(w){ - ct.setWidth(w); - }else if(Ext.isIE){ - ct.setWidth(Ext.isStrict && (Ext.isIE7 || Ext.isIE8) ? 'auto' : ct.minWidth); - var el = ct.getEl(), t = el.dom.offsetWidth; // force recalc - ct.setWidth(ct.getLayoutTarget().getWidth() + el.getFrameWidth('lr')); + + isVisible: function(node) { + var parent = node.parentNode; + while (parent) { + if (parent === this.node && !this.rootVisible && parent.isExpanded()) { + return true; } + + if (this.indexOf(parent) === -1 || !parent.isExpanded()) { + return false; + } + + parent = parent.parentNode; } + return true; } }); -Ext.Container.LAYOUTS['menu'] = Ext.layout.MenuLayout; /** - * @class Ext.Viewport - * @extends Ext.Container - * A specialized container representing the viewable application area (the browser viewport). - * The Viewport renders itself to the document body, and automatically sizes itself to the size of - * the browser viewport and manages window resizing. There may only be one Viewport created - * in a page. Inner layouts are available by virtue of the fact that all {@link Ext.Panel Panel}s - * added to the Viewport, either through its {@link #items}, or through the items, or the {@link #add} - * method of any of its child Panels may themselves have a layout. - * The Viewport does not provide scrolling, so child Panels within the Viewport should provide - * for scrolling if needed using the {@link #autoScroll} config. - * An example showing a classic application border layout: -new Ext.Viewport({ - layout: 'border', - items: [{ - region: 'north', - html: '<h1 class="x-panel-header">Page Title</h1>', - autoHeight: true, - border: false, - margins: '0 0 5 0' - }, { - region: 'west', - collapsible: true, - title: 'Navigation', - width: 200 - // the west region might typically utilize a {@link Ext.tree.TreePanel TreePanel} or a Panel with {@link Ext.layout.AccordionLayout Accordion layout} - }, { - region: 'south', - title: 'Title for Panel', - collapsible: true, - html: 'Information goes here', - split: true, - height: 100, - minHeight: 100 - }, { - region: 'east', - title: 'Title for the Grid Panel', - collapsible: true, - split: true, - width: 200, - xtype: 'grid', - // remaining grid configuration not shown ... - // notice that the GridPanel is added directly as the region - // it is not "overnested" inside another Panel - }, { - region: 'center', - xtype: 'tabpanel', // TabPanel itself has no title - items: { - title: 'Default Tab', - html: 'The first tab\'s content. Others may be added dynamically' - } - }] -}); - + * @author Ed Spencer + * @class Ext.data.Request + * @extends Object + * + * Simple class that represents a Request that will be made by any {@link Ext.data.proxy.Server} subclass. + * All this class does is standardize the representation of a Request as used by any ServerProxy subclass, + * it does not contain any actual logic or perform the request itself. + * * @constructor - * Create a new Viewport - * @param {Object} config The config object - * @xtype viewport + * @param {Object} config Optional config object */ -Ext.Viewport = Ext.extend(Ext.Container, { - /* - * Privatize config options which, if used, would interfere with the - * correct operation of the Viewport as the sole manager of the - * layout of the document body. - */ - /** - * @cfg {Mixed} applyTo @hide - */ - /** - * @cfg {Boolean} allowDomMove @hide - */ - /** - * @cfg {Boolean} hideParent @hide - */ - /** - * @cfg {Mixed} renderTo @hide - */ - /** - * @cfg {Boolean} hideParent @hide - */ - /** - * @cfg {Number} height @hide - */ +Ext.define('Ext.data.Request', { /** - * @cfg {Number} width @hide - */ - /** - * @cfg {Boolean} autoHeight @hide + * @cfg {String} action The name of the action this Request represents. Usually one of 'create', 'read', 'update' or 'destroy' */ + action: undefined, + /** - * @cfg {Boolean} autoWidth @hide + * @cfg {Object} params HTTP request params. The Proxy and its Writer have access to and can modify this object. */ + params: undefined, + /** - * @cfg {Boolean} deferHeight @hide + * @cfg {String} method The HTTP method to use on this Request (defaults to 'GET'). Should be one of 'GET', 'POST', 'PUT' or 'DELETE' */ + method: 'GET', + /** - * @cfg {Boolean} monitorResize @hide + * @cfg {String} url The url to access on this Request */ + url: undefined, - initComponent : function() { - Ext.Viewport.superclass.initComponent.call(this); - document.getElementsByTagName('html')[0].className += ' x-viewport'; - this.el = Ext.getBody(); - this.el.setHeight = Ext.emptyFn; - this.el.setWidth = Ext.emptyFn; - this.el.setSize = Ext.emptyFn; - this.el.dom.scroll = 'no'; - this.allowDomMove = false; - this.autoWidth = true; - this.autoHeight = true; - Ext.EventManager.onWindowResize(this.fireResize, this); - this.renderTo = this.el; - }, - - fireResize : function(w, h){ - this.fireEvent('resize', this, w, h, w, h); + constructor: function(config) { + Ext.apply(this, config); } }); -Ext.reg('viewport', Ext.Viewport); /** - * @class Ext.Panel - * @extends Ext.Container - * Panel is a container that has specific functionality and structural components that make - * it the perfect building block for application-oriented user interfaces. - * Panels are, by virtue of their inheritance from {@link Ext.Container}, capable - * of being configured with a {@link Ext.Container#layout layout}, and containing child Components. - * When either specifying child {@link Ext.Component#items items} of a Panel, or dynamically {@link Ext.Container#add adding} Components - * to a Panel, remember to consider how you wish the Panel to arrange those child elements, and whether - * those child elements need to be sized using one of Ext's built-in {@link Ext.Container#layout layout} schemes. By - * default, Panels use the {@link Ext.layout.ContainerLayout ContainerLayout} scheme. This simply renders - * child components, appending them one after the other inside the Container, and does not apply any sizing - * at all. - * A Panel may also contain {@link #bbar bottom} and {@link #tbar top} toolbars, along with separate - * {@link #header}, {@link #footer} and {@link #body} sections (see {@link #frame} for additional - * information). - * Panel also provides built-in {@link #collapsible expandable and collapsible behavior}, along with - * a variety of {@link #tools prebuilt tool buttons} that can be wired up to provide other customized - * behavior. Panels can be easily dropped into any {@link Ext.Container Container} or layout, and the - * layout and rendering pipeline is {@link Ext.Container#add completely managed by the framework}. + * @class Ext.data.Tree + * + * This class is used as a container for a series of nodes. The nodes themselves maintain + * the relationship between parent/child. The tree itself acts as a manager. It gives functionality + * to retrieve a node by its identifier: {@link #getNodeById}. + * + * The tree also relays events from any of it's child nodes, allowing them to be handled in a + * centralized fashion. In general this class is not used directly, rather used internally + * by other parts of the framework. + * * @constructor - * @param {Object} config The config object - * @xtype panel + * @param {Node} root (optional) The root node */ -Ext.Panel = Ext.extend(Ext.Container, { - /** - * The Panel's header {@link Ext.Element Element}. Read-only. - * This Element is used to house the {@link #title} and {@link #tools} - * Note: see the Note for {@link Ext.Component#el el} also. - * @type Ext.Element - * @property header - */ - /** - * The Panel's body {@link Ext.Element Element} which may be used to contain HTML content. - * The content may be specified in the {@link #html} config, or it may be loaded using the - * {@link autoLoad} config, or through the Panel's {@link #getUpdater Updater}. Read-only. - * If this is used to load visible HTML elements in either way, then - * the Panel may not be used as a Layout for hosting nested Panels. - * If this Panel is intended to be used as the host of a Layout (See {@link #layout} - * then the body Element must not be loaded or changed - it is under the control - * of the Panel's Layout. - * Note: see the Note for {@link Ext.Component#el el} also. - * @type Ext.Element - * @property body - */ - /** - * The Panel's bwrap {@link Ext.Element Element} used to contain other Panel elements - * (tbar, body, bbar, footer). See {@link #bodyCfg}. Read-only. - * @type Ext.Element - * @property bwrap - */ - /** - * True if this panel is collapsed. Read-only. - * @type Boolean - * @property collapsed - */ - /** - * @cfg {Object} bodyCfg - * A {@link Ext.DomHelper DomHelper} element specification object may be specified for any - * Panel Element. - * By default, the Default element in the table below will be used for the html markup to - * create a child element with the commensurate Default class name (baseCls will be - * replaced by {@link #baseCls}): - * - * Panel Default Default Custom Additional Additional - * Element element class element class style - * ======== ========================== ========= ============== =========== - * {@link #header} div {@link #baseCls}+'-header' {@link #headerCfg} headerCssClass headerStyle - * {@link #bwrap} div {@link #baseCls}+'-bwrap' {@link #bwrapCfg} bwrapCssClass bwrapStyle - * + tbar div {@link #baseCls}+'-tbar' {@link #tbarCfg} tbarCssClass tbarStyle - * + {@link #body} div {@link #baseCls}+'-body' {@link #bodyCfg} {@link #bodyCssClass} {@link #bodyStyle} - * + bbar div {@link #baseCls}+'-bbar' {@link #bbarCfg} bbarCssClass bbarStyle - * + {@link #footer} div {@link #baseCls}+'-footer' {@link #footerCfg} footerCssClass footerStyle - * - * Configuring a Custom element may be used, for example, to force the {@link #body} Element - * to use a different form of markup than is created by default. An example of this might be - * to {@link Ext.Element#createChild create a child} Panel containing a custom content, such as - * a header, or forcing centering of all Panel content by having the body be a <center> - * element: - * -new Ext.Panel({ - title: 'Message Title', - renderTo: Ext.getBody(), - width: 200, height: 130, - bodyCfg: { - tag: 'center', - cls: 'x-panel-body', // Default class not applied if Custom element specified - html: 'Message' - }, - footerCfg: { - tag: 'h2', - cls: 'x-panel-footer', // same as the Default class - html: 'footer html' +Ext.define('Ext.data.Tree', { + alias: 'data.tree', + + mixins: { + observable: "Ext.util.Observable" }, - footerCssClass: 'custom-footer', // additional css class, see {@link Ext.element#addClass addClass} - footerStyle: 'background-color:red' // see {@link #bodyStyle} -}); - * - * The example above also explicitly creates a {@link #footer} with custom markup and - * styling applied. - */ - /** - * @cfg {Object} headerCfg - * A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure - * of this Panel's {@link #header} Element. See {@link #bodyCfg} also. - */ - /** - * @cfg {Object} bwrapCfg - * A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure - * of this Panel's {@link #bwrap} Element. See {@link #bodyCfg} also. - */ - /** - * @cfg {Object} tbarCfg - * A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure - * of this Panel's {@link #tbar} Element. See {@link #bodyCfg} also. - */ - /** - * @cfg {Object} bbarCfg - * A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure - * of this Panel's {@link #bbar} Element. See {@link #bodyCfg} also. - */ - /** - * @cfg {Object} footerCfg - * A {@link Ext.DomHelper DomHelper} element specification object specifying the element structure - * of this Panel's {@link #footer} Element. See {@link #bodyCfg} also. - */ - /** - * @cfg {Boolean} closable - * Panels themselves do not directly support being closed, but some Panel subclasses do (like - * {@link Ext.Window}) or a Panel Class within an {@link Ext.TabPanel}. Specify true - * to enable closing in such situations. Defaults to false. - */ - /** - * The Panel's footer {@link Ext.Element Element}. Read-only. - * This Element is used to house the Panel's {@link #buttons} or {@link #fbar}. - * Note: see the Note for {@link Ext.Component#el el} also. - * @type Ext.Element - * @property footer - */ - /** - * @cfg {Mixed} applyTo - * The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in - * the document that specifies some panel-specific structural markup. When applyTo is used, - * constituent parts of the panel can be specified by CSS class name within the main element, and the panel - * will automatically create those components from that markup. Any required components not specified in the - * markup will be autogenerated if necessary. - * The following class names are supported (baseCls will be replaced by {@link #baseCls}): - * baseCls + '-header' - * baseCls + '-header-text' - * baseCls + '-bwrap' - * baseCls + '-tbar' - * baseCls + '-body' - * baseCls + '-bbar' - * baseCls + '-footer' - * Using this config, a call to render() is not required. If applyTo is specified, any value passed for - * {@link #renderTo} will be ignored and the target element's parent node will automatically be used as the - * panel's container. - */ - /** - * @cfg {Object/Array} tbar - * The top toolbar of the panel. This can be a {@link Ext.Toolbar} object, a toolbar config, or an array of - * buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. - * To access the top toolbar after render, use {@link #getTopToolbar}. - * Note: Although a Toolbar may contain Field components, these will not be updated by a load - * of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and - * so are not scanned to collect form items. However, the values will be submitted because form - * submission parameters are collected from the DOM tree. - */ - /** - * @cfg {Object/Array} bbar - * The bottom toolbar of the panel. This can be a {@link Ext.Toolbar} object, a toolbar config, or an array of - * buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. - * To access the bottom toolbar after render, use {@link #getBottomToolbar}. - * Note: Although a Toolbar may contain Field components, these will not be updated by a load - * of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and - * so are not scanned to collect form items. However, the values will be submitted because form - * submission parameters are collected from the DOM tree. - */ - /** @cfg {Object/Array} fbar - * A {@link Ext.Toolbar Toolbar} object, a Toolbar config, or an array of - * {@link Ext.Button Button}s/{@link Ext.Button Button} configs, describing a {@link Ext.Toolbar Toolbar} to be rendered into this Panel's footer element. - * After render, the fbar property will be an {@link Ext.Toolbar Toolbar} instance. - * If {@link #buttons} are specified, they will supersede the fbar configuration property. - * The Panel's {@link #buttonAlign} configuration affects the layout of these items, for example: - * -var w = new Ext.Window({ - height: 250, - width: 500, - bbar: new Ext.Toolbar({ - items: [{ - text: 'bbar Left' - },'->',{ - text: 'bbar Right' - }] - }), - {@link #buttonAlign}: 'left', // anything but 'center' or 'right' and you can use '-', and '->' - // to control the alignment of fbar items - fbar: [{ - text: 'fbar Left' - },'->',{ - text: 'fbar Right' - }] -}).show(); - * - * Note: Although a Toolbar may contain Field components, these will not be updated by a load - * of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and - * so are not scanned to collect form items. However, the values will be submitted because form - * submission parameters are collected from the DOM tree. - */ - /** - * @cfg {Boolean} header - * true to create the Panel's header element explicitly, false to skip creating - * it. If a {@link #title} is set the header will be created automatically, otherwise it will not. - * If a {@link #title} is set but header is explicitly set to false, the header - * will not be rendered. - */ - /** - * @cfg {Boolean} footer - * true to create the footer element explicitly, false to skip creating it. The footer - * will be created automatically if {@link #buttons} or a {@link #fbar} have - * been configured. See {@link #bodyCfg} for an example. - */ + /** - * @cfg {String} title - * The title text to be used as innerHTML (html tags are accepted) to display in the panel - * {@link #header} (defaults to ''). When a title is specified the - * {@link #header} element will automatically be created and displayed unless - * {@link #header} is explicitly set to false. If you do not want to specify a - * title at config time, but you may want one later, you must either specify a non-empty - * title (a blank space ' ' will do) or header:true so that the container - * element will get created. + * The root node for this tree + * @type Node */ + root: null, + + constructor: function(root) { + var me = this; + + me.nodeHash = {}; + + me.mixins.observable.constructor.call(me); + + if (root) { + me.setRootNode(root); + } + }, + /** - * @cfg {Array} buttons - * buttons will be used as {@link Ext.Container#items items} for the toolbar in - * the footer ({@link #fbar}). Typically the value of this configuration property will be - * an array of {@link Ext.Button}s or {@link Ext.Button} configuration objects. - * If an item is configured with minWidth or the Panel is configured with minButtonWidth, - * that width will be applied to the item. + * Returns the root node for this tree. + * @return {Ext.data.NodeInterface} */ + getRootNode : function() { + return this.root; + }, + /** - * @cfg {Object/String/Function} autoLoad - * A valid url spec according to the Updater {@link Ext.Updater#update} method. - * If autoLoad is not null, the panel will attempt to load its contents - * immediately upon render. - * The URL will become the default URL for this panel's {@link #body} element, - * so it may be {@link Ext.Element#refresh refresh}ed at any time. + * Sets the root node for this tree. + * @param {Ext.data.NodeInterface} node + * @return {Ext.data.NodeInterface} The root node */ - /** - * @cfg {Boolean} frame - * false by default to render with plain 1px square borders. true to render with - * 9 elements, complete with custom rounded corners (also see {@link Ext.Element#boxWrap}). - * The template generated for each condition is depicted below: - * -// frame = false -<div id="developer-specified-id-goes-here" class="x-panel"> + setRootNode : function(node) { + var me = this; + + me.root = node; + Ext.data.NodeInterface.decorate(node); + + if (me.fireEvent('beforeappend', null, node) !== false) { + node.set('root', true); + node.updateInfo(); + + me.relayEvents(node, [ + /** + * @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", - <div class="x-panel-header"><span class="x-panel-header-text">Title: (frame:false)</span></div> + /** + * @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", - <div class="x-panel-bwrap"> - <div class="x-panel-body"><p>html value goes here</p></div> - </div> -</div> + /** + * @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", -// frame = true (create 9 elements) -<div id="developer-specified-id-goes-here" class="x-panel"> - <div class="x-panel-tl"><div class="x-panel-tr"><div class="x-panel-tc"> - <div class="x-panel-header"><span class="x-panel-header-text">Title: (frame:true)</span></div> - </div></div></div> + /** + * @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", - <div class="x-panel-bwrap"> - <div class="x-panel-ml"><div class="x-panel-mr"><div class="x-panel-mc"> - <div class="x-panel-body"><p>html value goes here</p></div> - </div></div></div> + /** + * @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", - <div class="x-panel-bl"><div class="x-panel-br"><div class="x-panel-bc"/> - </div></div></div> -</div> - * - */ - /** - * @cfg {Boolean} border - * True to display the borders of the panel's body element, false to hide them (defaults to true). By default, - * the border is a 2px wide inset border, but this can be further altered by setting {@link #bodyBorder} to false. - */ - /** - * @cfg {Boolean} bodyBorder - * True to display an interior border on the body element of the panel, false to hide it (defaults to true). - * This only applies when {@link #border} == true. If border == true and bodyBorder == false, the border will display - * as a 1px wide inset border, giving the entire body element an inset appearance. - */ - /** - * @cfg {String/Object/Function} bodyCssClass - * Additional css class selector to be applied to the {@link #body} element in the format expected by - * {@link Ext.Element#addClass} (defaults to null). See {@link #bodyCfg}. - */ - /** - * @cfg {String/Object/Function} bodyStyle - * Custom CSS styles to be applied to the {@link #body} element in the format expected by - * {@link Ext.Element#applyStyles} (defaults to null). See {@link #bodyCfg}. - */ - /** - * @cfg {String} iconCls - * The CSS class selector that specifies a background image to be used as the header icon (defaults to ''). - * An example of specifying a custom icon class would be something like: - * -// specify the property in the config for the class: - ... - iconCls: 'my-icon' + /** + * @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", -// css class that specifies background image to be used as the icon image: -.my-icon { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; } - - */ - /** - * @cfg {Boolean} collapsible - * True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into - * the header tool button area, false to keep the panel statically sized with no button (defaults to false). - */ - /** - * @cfg {Array} tools - * An array of tool button configs to be added to the header tool area. When rendered, each tool is - * stored as an {@link Ext.Element Element} referenced by a public property called tools.<tool-type> - * Each tool config may contain the following properties: - * - * id : StringRequired. The type - * of tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the - * resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below. - * The developer may implement custom tools by supplying alternate CSS rules and background images: - * - * toggle (Created by default when {@link #collapsible} is true) - * close - * minimize - * maximize - * restore - * gear - * pin - * unpin - * right - * left - * up - * down - * refresh - * minus - * plus - * help - * search - * save - * print - * - * handler : FunctionRequired. The function to - * call when clicked. Arguments passed are: - * event : Ext.EventObjectThe click event. - * toolEl : Ext.ElementThe tool Element. - * panel : Ext.PanelThe host Panel - * tc : ObjectThe tool configuration object - * - * stopEvent : BooleanDefaults to true. Specify as false to allow click event to propagate. - * scope : ObjectThe scope in which to call the handler. - * qtip : String/ObjectA tip string, or - * a config argument to {@link Ext.QuickTip#register} - * hidden : BooleanTrue to initially render hidden. - * on : ObjectA listener config object specifiying - * event listeners in the format of an argument to {@link #addListener} - * - * Note that, apart from the toggle tool which is provided when a panel is collapsible, these - * tools only provide the visual button. Any required functionality must be provided by adding - * handlers that implement the necessary behavior. - * Example usage: - * -tools:[{ - id:'refresh', - qtip: 'Refresh form Data', - // hidden:true, - handler: function(event, toolEl, panel){ - // refresh logic - } -}, -{ - id:'help', - qtip: 'Get Help', - handler: function(event, toolEl, panel){ - // whatever - } -}] - - * For the custom id of 'help' define two relevant css classes with a link to - * a 15x15 image: - * -.x-tool-help {background-image: url(images/help.png);} -.x-tool-help-over {background-image: url(images/help_over.png);} -// if using an image sprite: -.x-tool-help {background-image: url(images/help.png) no-repeat 0 0;} -.x-tool-help-over {background-position:-15px 0;} - - */ - /** - * @cfg {Ext.Template/Ext.XTemplate} toolTemplate - * A Template used to create {@link #tools} in the {@link #header} Element. Defaults to: -new Ext.Template('<div class="x-tool x-tool-{id}"> </div>') - * This may may be overridden to provide a custom DOM structure for tools based upon a more - * complex XTemplate. The template's data is a single tool configuration object (Not the entire Array) - * as specified in {@link #tools}. In the following example an <a> tag is used to provide a - * visual indication when hovering over the tool: -var win = new Ext.Window({ - tools: [{ - id: 'download', - href: '/MyPdfDoc.pdf' - }], - toolTemplate: new Ext.XTemplate( - '<tpl if="id==\'download\'">', - '<a class="x-tool x-tool-pdf" href="{href}"></a>', - '</tpl>', - '<tpl if="id!=\'download\'">', - '<div class="x-tool x-tool-{id}"> </div>', - '</tpl>' - ), - width:500, - height:300, - closeAction:'hide' -}); - * Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an - * appropriate background image, something like: - - a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;} - - */ - /** - * @cfg {Boolean} hideCollapseTool - * true to hide the expand/collapse toggle button when {@link #collapsible} == true, - * false to display it (defaults to false). - */ - /** - * @cfg {Boolean} titleCollapse - * true to allow expanding and collapsing the panel (when {@link #collapsible} = true) - * by clicking anywhere in the header bar, false) to allow it only by clicking to tool button - * (defaults to false)). If this panel is a child item of a border layout also see the - * {@link Ext.layout.BorderLayout.Region BorderLayout.Region} - * {@link Ext.layout.BorderLayout.Region#floatable floatable} config option. - */ - - /** - * @cfg {Mixed} floating - * This property is used to configure the underlying {@link Ext.Layer}. Acceptable values for this - * configuration property are: - * false : Default.Display the panel inline where it is - * rendered. - * true : Float the panel (absolute position it with automatic - * shimming and shadow). - * Setting floating to true will create an Ext.Layer for this panel and display the - * panel at negative offsets so that it is hidden. - * Since the panel will be absolute positioned, the position must be set explicitly - * after render (e.g., myPanel.setPosition(100,100);). - * Note: when floating a panel you should always assign a fixed width, - * otherwise it will be auto width and will expand to fill to the right edge of the viewport. - * - * {@link Ext.Layer object} : The specified object will be used - * as the configuration object for the {@link Ext.Layer} that will be created. - * - */ - /** - * @cfg {Boolean/String} shadow - * true (or a valid Ext.Shadow {@link Ext.Shadow#mode} value) to display a shadow behind the - * panel, false to display no shadow (defaults to 'sides'). Note that this option - * only applies when {@link #floating} = true. - */ - /** - * @cfg {Number} shadowOffset - * The number of pixels to offset the shadow if displayed (defaults to 4). Note that this - * option only applies when {@link #floating} = true. - */ - /** - * @cfg {Boolean} shim - * false to disable the iframe shim in browsers which need one (defaults to true). - * Note that this option only applies when {@link #floating} = true. - */ + /** + * @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", + + /** + * @event expand + * Fires when this node is expanded. + * @param {Node} this The expanding node + */ + "expand", + + /** + * @event collapse + * Fires when this node is collapsed. + * @param {Node} this The collapsing node + */ + "collapse", + + /** + * @event beforeexpand + * Fires before this node is expanded. + * @param {Node} this The expanding node + */ + "beforeexpand", + + /** + * @event beforecollapse + * Fires before this node is collapsed. + * @param {Node} this The collapsing node + */ + "beforecollapse" , + + /** + * @event rootchange + * Fires whenever the root node is changed in the tree. + * @param {Ext.data.Model} root The new root + */ + "rootchange" + ]); + + node.on({ + scope: me, + insert: me.onNodeInsert, + append: me.onNodeAppend, + remove: me.onNodeRemove + }); + + me.registerNode(node); + me.fireEvent('append', null, node); + me.fireEvent('rootchange', node); + } + + return node; + }, + /** - * @cfg {Object/Array} keys - * A {@link Ext.KeyMap} config object (in the format expected by {@link Ext.KeyMap#addBinding} - * used to assign custom key handling to this panel (defaults to null). + * Flattens all the nodes in the tree into an array. + * @private + * @return {Array} The flattened nodes. */ - /** - * @cfg {Boolean/Object} draggable - * true to enable dragging of this Panel (defaults to false). - * For custom drag/drop implementations, an Ext.Panel.DD config could also be passed - * in this config instead of true. Ext.Panel.DD is an internal, undocumented class which - * moves a proxy Element around in place of the Panel's element, but provides no other behaviour - * during dragging or on drop. It is a subclass of {@link Ext.dd.DragSource}, so behaviour may be - * added by implementing the interface methods of {@link Ext.dd.DragDrop} e.g.: - * -new Ext.Panel({ - title: 'Drag me', - x: 100, - y: 100, - renderTo: Ext.getBody(), - floating: true, - frame: true, - width: 400, - height: 200, - draggable: { -// Config option of Ext.Panel.DD class. -// It's a floating Panel, so do not show a placeholder proxy in the original position. - insertProxy: false, - -// Called for each mousemove event while dragging the DD object. - onDrag : function(e){ -// Record the x,y position of the drag proxy so that we can -// position the Panel at end of drag. - var pel = this.proxy.getEl(); - this.x = pel.getLeft(true); - this.y = pel.getTop(true); - -// Keep the Shadow aligned if there is one. - var s = this.panel.getEl().shadow; - if (s) { - s.realign(this.x, this.y, pel.getWidth(), pel.getHeight()); + flatten: function(){ + var nodes = [], + hash = this.nodeHash, + key; + + for (key in hash) { + if (hash.hasOwnProperty(key)) { + nodes.push(hash[key]); } - }, - -// Called on the mouseup event. - endDrag : function(e){ - this.panel.setPosition(this.x, this.y); } - } -}).show(); - - */ + return nodes; + }, + /** - * @cfg {Boolean} disabled - * Render this panel disabled (default is false). An important note when using the disabled - * config on panels is that IE will often fail to initialize the disabled mask element correectly if - * the panel's layout has not yet completed by the time the Panel is disabled during the render process. - * If you experience this issue, you may need to instead use the {@link #afterlayout} event to initialize - * the disabled state: - * -new Ext.Panel({ - ... - listeners: { - 'afterlayout': { - fn: function(p){ - p.disable(); - }, - single: true // important, as many layouts can occur - } - } -}); - + * Fired when a node is inserted into the root or one of it's children + * @private + * @param {Ext.data.NodeInterface} parent The parent node + * @param {Ext.data.NodeInterface} node The inserted node */ + onNodeInsert: function(parent, node) { + this.registerNode(node); + }, + /** - * @cfg {Boolean} autoHeight - * true to use height:'auto', false to use fixed height (defaults to false). - * Note: Setting autoHeight: true means that the browser will manage the panel's height - * based on its contents, and that Ext will not manage it at all. If the panel is within a layout that - * manages dimensions (fit, border, etc.) then setting autoHeight: true - * can cause issues with scrolling and will not generally work as expected since the panel will take - * on the height of its contents rather than the height required by the Ext layout. + * Fired when a node is appended into the root or one of it's children + * @private + * @param {Ext.data.NodeInterface} parent The parent node + * @param {Ext.data.NodeInterface} node The appended node */ - - + onNodeAppend: function(parent, node) { + this.registerNode(node); + }, + /** - * @cfg {String} baseCls - * The base CSS class to apply to this panel's element (defaults to 'x-panel'). - * Another option available by default is to specify 'x-plain' which strips all styling - * except for required attributes for Ext layouts to function (e.g. overflow:hidden). - * See {@link #unstyled} also. + * Fired when a node is removed from the root or one of it's children + * @private + * @param {Ext.data.NodeInterface} parent The parent node + * @param {Ext.data.NodeInterface} node The removed node */ - baseCls : 'x-panel', + onNodeRemove: function(parent, node) { + this.unregisterNode(node); + }, + /** - * @cfg {String} collapsedCls - * A CSS class to add to the panel's element after it has been collapsed (defaults to - * 'x-panel-collapsed'). + * Gets a node in this tree by its id. + * @param {String} id + * @return {Ext.data.NodeInterface} The match node. */ - collapsedCls : 'x-panel-collapsed', + getNodeById : function(id) { + return this.nodeHash[id]; + }, + /** - * @cfg {Boolean} maskDisabled - * true to mask the panel when it is {@link #disabled}, false to not mask it (defaults - * to true). Either way, the panel will always tell its contained elements to disable themselves - * when it is disabled, but masking the panel can provide an additional visual cue that the panel is - * disabled. + * Registers a node with the tree + * @private + * @param {Ext.data.NodeInterface} The node to register */ - maskDisabled : true, + registerNode : function(node) { + this.nodeHash[node.getId() || node.internalId] = node; + }, + /** - * @cfg {Boolean} animCollapse - * true to animate the transition when the panel is collapsed, false to skip the - * animation (defaults to true if the {@link Ext.Fx} class is available, otherwise false). + * Unregisters a node with the tree + * @private + * @param {Ext.data.NodeInterface} The node to unregister */ - animCollapse : Ext.enableFx, + unregisterNode : function(node) { + delete this.nodeHash[node.getId() || node.internalId]; + }, + /** - * @cfg {Boolean} headerAsText - * true to display the panel {@link #title} in the {@link #header}, - * false to hide it (defaults to true). + * Sorts this tree + * @private + * @param {Function} sorterFn The function to use for sorting + * @param {Boolean} recursive True to perform recursive sorting */ - headerAsText : true, - /** - * @cfg {String} buttonAlign - * The alignment of any {@link #buttons} added to this panel. Valid values are 'right', - * 'left' and 'center' (defaults to 'right'). + sort: function(sorterFn, recursive) { + this.getRootNode().sort(sorterFn, recursive); + }, + + /** + * Filters this tree + * @private + * @param {Function} sorterFn The function to use for filtering + * @param {Boolean} recursive True to perform recursive filtering */ - buttonAlign : 'right', + filter: function(filters, recursive) { + this.getRootNode().filter(filters, recursive); + } +}); +/** + * @class Ext.data.TreeStore + * @extends Ext.data.AbstractStore + * + * The TreeStore is a store implementation that is backed by by an {@link Ext.data.Tree}. + * It provides convenience methods for loading nodes, as well as the ability to use + * the hierarchical tree structure combined with a store. This class is generally used + * in conjunction with {@link Ext.tree.Panel}. This class also relays many events from + * the Tree for convenience. + * + * ## Using Models + * If no Model is specified, an implicit model will be created that implements {@link Ext.data.NodeInterface}. + * The standard Tree fields will also be copied onto the Model for maintaining their state. + * + * ## Reading Nested Data + * For the tree to read nested data, the {@link Ext.data.Reader} must be configured with a root property, + * so the reader can find nested data for each node. If a root is not specified, it will default to + * 'children'. + */ +Ext.define('Ext.data.TreeStore', { + extend: 'Ext.data.AbstractStore', + alias: 'store.tree', + requires: ['Ext.data.Tree', 'Ext.data.NodeInterface', 'Ext.data.NodeStore'], + /** - * @cfg {Boolean} collapsed - * true to render the panel collapsed, false to render it expanded (defaults to - * false). + * @cfg {Boolean} clearOnLoad (optional) Default to true. Remove previously existing + * child nodes before loading. */ - collapsed : false, + clearOnLoad : true, + /** - * @cfg {Boolean} collapseFirst - * true to make sure the collapse/expand toggle button always renders first (to the left of) - * any other tools in the panel's title bar, false to render it last (defaults to true). + * @cfg {String} nodeParam The name of the parameter sent to the server which contains + * the identifier of the node. Defaults to 'node'. */ - collapseFirst : true, + nodeParam: 'node', + /** - * @cfg {Number} minButtonWidth - * Minimum width in pixels of all {@link #buttons} in this panel (defaults to 75) - */ - minButtonWidth : 75, - /** - * @cfg {Boolean} unstyled - * Overrides the {@link #baseCls} setting to {@link #baseCls} = 'x-plain' which renders - * the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden). - */ - /** - * @cfg {String} elements - * A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be - * generated automatically based on the items added to the panel at config time, but sometimes it might be useful to - * make sure a structural element is rendered even if not specified at config time (for example, you may want - * to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this - * list will allocate the required placeholders in the panel when it is rendered. Valid values are - * header - * tbar (top bar) - * body - * bbar (bottom bar) - * footer - * - * Defaults to 'body'. + * @cfg {String} defaultRootId + * The default root id. Defaults to 'root' */ - elements : 'body', + defaultRootId: 'root', + /** - * @cfg {Boolean} preventBodyReset - * Defaults to false. When set to true, an extra css class 'x-panel-normal' - * will be added to the panel's element, effectively applying css styles suggested by the W3C - * (see http://www.w3.org/TR/CSS21/sample.html) to the Panel's body element (not the header, - * footer, etc.). + * @cfg {String} defaultRootProperty + * The root property to specify on the reader if one is not explicitly defined. */ - preventBodyReset : false, + defaultRootProperty: 'children', /** - * @cfg {Number/String} padding - * A shortcut for setting a padding style on the body element. The value can either be - * a number to be applied to all sides, or a normal css string describing padding. - * Defaults to undefined. - * - */ - padding: undefined, - - /** @cfg {String} resizeEvent - * The event to listen to for resizing in layouts. Defaults to 'bodyresize'. + * @cfg {Boolean} folderSort Set to true to automatically prepend a leaf sorter (defaults to undefined) */ - resizeEvent: 'bodyresize', - - // protected - these could be used to customize the behavior of the window, - // but changing them would not be useful without further mofifications and - // could lead to unexpected or undesirable results. - toolTarget : 'header', - collapseEl : 'bwrap', - slideAnchor : 't', - disabledClass : '', + folderSort: false, + + constructor: function(config) { + var me = this, + root, + fields; + + + config = Ext.apply({}, config); + + /** + * If we have no fields declare for the store, add some defaults. + * These will be ignored if a model is explicitly specified. + */ + fields = config.fields || me.fields; + if (!fields) { + config.fields = [{name: 'text', type: 'string'}]; + } - // private, notify box this class will handle heights - deferHeight : true, - // private - expandDefaults: { - duration : 0.25 - }, - // private - collapseDefaults : { - duration : 0.25 - }, + me.callParent([config]); + + // We create our data tree. + me.tree = Ext.create('Ext.data.Tree'); + + me.tree.on({ + scope: me, + remove: me.onNodeRemove, + beforeexpand: me.onBeforeNodeExpand, + beforecollapse: me.onBeforeNodeCollapse, + append: me.onNodeAdded, + insert: me.onNodeAdded + }); - // private - initComponent : function(){ - Ext.Panel.superclass.initComponent.call(this); + me.onBeforeSort(); + + root = me.root; + if (root) { + delete me.root; + me.setRootNode(root); + } - this.addEvents( + me.relayEvents(me.tree, [ /** - * @event bodyresize - * Fires after the Panel has been resized. - * @param {Ext.Panel} p the Panel which has been resized. - * @param {Number} width The Panel body's new width. - * @param {Number} height The Panel body's new height. - */ - 'bodyresize', - /** - * @event titlechange - * Fires after the Panel title has been {@link #title set} or {@link #setTitle changed}. - * @param {Ext.Panel} p the Panel which has had its title changed. - * @param {String} The new title. - */ - 'titlechange', - /** - * @event iconchange - * Fires after the Panel icon class has been {@link #iconCls set} or {@link #setIconClass changed}. - * @param {Ext.Panel} p the Panel which has had its {@link #iconCls icon class} changed. - * @param {String} The new icon class. - * @param {String} The old icon class. + * @event append + * Fires when a new child node is appended to a node in this store's 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 */ - 'iconchange', + "append", + /** - * @event collapse - * Fires after the Panel has been collapsed. - * @param {Ext.Panel} p the Panel that has been collapsed. + * @event remove + * Fires when a child node is removed from a node in this store's tree. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The child node removed */ - 'collapse', + "remove", + /** - * @event expand - * Fires after the Panel has been expanded. - * @param {Ext.Panel} p The Panel that has been expanded. + * @event move + * Fires when a node is moved to a new location in the store's 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 */ - 'expand', + "move", + /** - * @event beforecollapse - * Fires before the Panel is collapsed. A handler can return false to cancel the collapse. - * @param {Ext.Panel} p the Panel being collapsed. - * @param {Boolean} animate True if the collapse is animated, else false. + * @event insert + * Fires when a new child node is inserted in a node in this store's 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 */ - 'beforecollapse', + "insert", + /** - * @event beforeexpand - * Fires before the Panel is expanded. A handler can return false to cancel the expand. - * @param {Ext.Panel} p The Panel being expanded. - * @param {Boolean} animate True if the expand is animated, else false. + * @event beforeappend + * Fires before a new child is appended to a node in this store's 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 */ - 'beforeexpand', + "beforeappend", + /** - * @event beforeclose - * Fires before the Panel is closed. Note that Panels do not directly support being closed, but some - * Panel subclasses do (like {@link Ext.Window}) or a Panel within a Ext.TabPanel. This event only - * applies to such subclasses. - * A handler can return false to cancel the close. - * @param {Ext.Panel} p The Panel being closed. + * @event beforeremove + * Fires before a child is removed from a node in this store's 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 */ - 'beforeclose', + "beforeremove", + /** - * @event close - * Fires after the Panel is closed. Note that Panels do not directly support being closed, but some - * Panel subclasses do (like {@link Ext.Window}) or a Panel within a Ext.TabPanel. - * @param {Ext.Panel} p The Panel that has been closed. + * @event beforemove + * Fires before a node is moved to a new location in the store's 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 */ - 'close', + "beforemove", + /** - * @event activate - * Fires after the Panel has been visually activated. - * Note that Panels do not directly support being activated, but some Panel subclasses - * do (like {@link Ext.Window}). Panels which are child Components of a TabPanel fire the - * activate and deactivate events under the control of the TabPanel. - * @param {Ext.Panel} p The Panel that has been activated. + * @event beforeinsert + * Fires before a new child is inserted in a node in this store's 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 */ - 'activate', + "beforeinsert", + + /** + * @event expand + * Fires when this node is expanded. + * @param {Node} this The expanding node + */ + "expand", + + /** + * @event collapse + * Fires when this node is collapsed. + * @param {Node} this The collapsing node + */ + "collapse", + + /** + * @event beforeexpand + * Fires before this node is expanded. + * @param {Node} this The expanding node + */ + "beforeexpand", + + /** + * @event beforecollapse + * Fires before this node is collapsed. + * @param {Node} this The collapsing node + */ + "beforecollapse", + + /** + * @event sort + * Fires when this TreeStore is sorted. + * @param {Node} node The node that is sorted. + */ + "sort", + + /** + * @event rootchange + * Fires whenever the root node is changed in the tree. + * @param {Ext.data.Model} root The new root + */ + "rootchange" + ]); + + me.addEvents( /** - * @event deactivate - * Fires after the Panel has been visually deactivated. - * Note that Panels do not directly support being deactivated, but some Panel subclasses - * do (like {@link Ext.Window}). Panels which are child Components of a TabPanel fire the - * activate and deactivate events under the control of the TabPanel. - * @param {Ext.Panel} p The Panel that has been deactivated. + * @event rootchange + * Fires when the root node on this TreeStore is changed. + * @param {Ext.data.TreeStore} store This TreeStore + * @param {Node} The new root node. */ - 'deactivate' + 'rootchange' ); - - if(this.unstyled){ - this.baseCls = 'x-plain'; - } - - - this.toolbars = []; - // shortcuts - if(this.tbar){ - this.elements += ',tbar'; - this.topToolbar = this.createToolbar(this.tbar); - this.tbar = null; - + + if (Ext.isDefined(me.nodeParameter)) { + if (Ext.isDefined(Ext.global.console)) { + Ext.global.console.warn('Ext.data.TreeStore: nodeParameter has been deprecated. Please use nodeParam instead.'); + } + me.nodeParam = me.nodeParameter; + delete me.nodeParameter; } - if(this.bbar){ - this.elements += ',bbar'; - this.bottomToolbar = this.createToolbar(this.bbar); - this.bbar = null; + }, + + // inherit docs + setProxy: function(proxy) { + var reader, + needsRoot; + + if (proxy instanceof Ext.data.proxy.Proxy) { + // proxy instance, check if a root was set + needsRoot = Ext.isEmpty(proxy.getReader().root); + } else if (Ext.isString(proxy)) { + // string type, means a reader can't be set + needsRoot = true; + } else { + // object, check if a reader and a root were specified. + reader = proxy.reader; + needsRoot = !(reader && !Ext.isEmpty(reader.root)); } - - if(this.header === true){ - this.elements += ',header'; - this.header = null; - }else if(this.headerCfg || (this.title && this.header !== false)){ - this.elements += ',header'; + proxy = this.callParent(arguments); + if (needsRoot) { + reader = proxy.getReader(); + reader.root = this.defaultRootProperty; + // force rebuild + reader.buildExtractors(true); } - - if(this.footerCfg || this.footer === true){ - this.elements += ',footer'; - this.footer = null; + }, + + // inherit docs + onBeforeSort: function() { + if (this.folderSort) { + this.sort({ + property: 'leaf', + direction: 'ASC' + }, 'prepend', false); } - - if(this.buttons){ - this.fbar = this.buttons; - this.buttons = null; + }, + + /** + * Called before a node is expanded. + * @private + * @param {Ext.data.NodeInterface} node The node being expanded. + * @param {Function} callback The function to run after the expand finishes + * @param {Object} scope The scope in which to run the callback function + */ + onBeforeNodeExpand: function(node, callback, scope) { + if (node.isLoaded()) { + Ext.callback(callback, scope || node, [node.childNodes]); } - if(this.fbar){ - this.createFbar(this.fbar); + else if (node.isLoading()) { + this.on('load', function() { + Ext.callback(callback, scope || node, [node.childNodes]); + }, this, {single: true}); } - if(this.autoLoad){ - this.on('render', this.doAutoLoad, this, {delay:10}); + else { + this.read({ + node: node, + callback: function() { + Ext.callback(callback, scope || node, [node.childNodes]); + } + }); } }, - - // private - createFbar : function(fbar){ - var min = this.minButtonWidth; - this.elements += ',footer'; - this.fbar = this.createToolbar(fbar, { - buttonAlign: this.buttonAlign, - toolbarCls: 'x-panel-fbar', - enableOverflow: false, - defaults: function(c){ - return { - minWidth: c.minWidth || min - }; - } - }); - // @compat addButton and buttons could possibly be removed - // @target 4.0 - /** - * This Panel's Array of buttons as created from the {@link #buttons} - * config property. Read only. - * @type Array - * @property buttons - */ - this.fbar.items.each(function(c){ - c.minWidth = c.minWidth || this.minButtonWidth; - }, this); - this.buttons = this.fbar.items.items; + + //inherit docs + getNewRecords: function() { + return Ext.Array.filter(this.tree.flatten(), this.filterNew); }, - // private - createToolbar: function(tb, options){ - var result; - // Convert array to proper toolbar config - if(Ext.isArray(tb)){ - tb = { - items: tb - }; - } - result = tb.events ? Ext.apply(tb, options) : this.createComponent(Ext.apply({}, tb, options), 'toolbar'); - this.toolbars.push(result); - return result; + //inherit docs + getUpdatedRecords: function() { + return Ext.Array.filter(this.tree.flatten(), this.filterUpdated); }, - - // private - createElement : function(name, pnode){ - if(this[name]){ - pnode.appendChild(this[name].dom); - return; + + /** + * Called before a node is collapsed. + * @private + * @param {Ext.data.NodeInterface} node The node being collapsed. + * @param {Function} callback The function to run after the collapse finishes + * @param {Object} scope The scope in which to run the callback function + */ + onBeforeNodeCollapse: function(node, callback, scope) { + callback.call(scope || node, node.childNodes); + }, + + onNodeRemove: function(parent, node) { + var removed = this.removed; + + if (!node.isReplace && Ext.Array.indexOf(removed, node) == -1) { + removed.push(node); } - - if(name === 'bwrap' || this.elements.indexOf(name) != -1){ - if(this[name+'Cfg']){ - this[name] = Ext.fly(pnode).createChild(this[name+'Cfg']); - }else{ - var el = document.createElement('div'); - el.className = this[name+'Cls']; - this[name] = Ext.get(pnode.appendChild(el)); - } - if(this[name+'CssClass']){ - this[name].addClass(this[name+'CssClass']); - } - if(this[name+'Style']){ - this[name].applyStyles(this[name+'Style']); + }, + + onNodeAdded: function(parent, node) { + var proxy = this.getProxy(), + reader = proxy.getReader(), + data = node.raw || node.data, + dataRoot, children; + + Ext.Array.remove(this.removed, node); + + if (!node.isLeaf() && !node.isLoaded()) { + dataRoot = reader.getRoot(data); + if (dataRoot) { + this.fillNode(node, reader.extractData(dataRoot)); + delete data[reader.root]; } } }, + + /** + * Sets the root node for this store + * @param {Ext.data.Model/Ext.data.NodeInterface} root + * @return {Ext.data.NodeInterface} The new root + */ + setRootNode: function(root) { + var me = this; - // private - onRender : function(ct, position){ - Ext.Panel.superclass.onRender.call(this, ct, position); - this.createClasses(); - - var el = this.el, - d = el.dom, - bw, - ts; - - - if(this.collapsible && !this.hideCollapseTool){ - this.tools = this.tools ? this.tools.slice(0) : []; - this.tools[this.collapseFirst?'unshift':'push']({ - id: 'toggle', - handler : this.toggleCollapse, - scope: this + root = root || {}; + if (!root.isNode) { + // create a default rootNode and create internal data struct. + Ext.applyIf(root, { + id: me.defaultRootId, + text: 'Root', + allowDrag: false }); + root = Ext.ModelManager.create(root, me.model); } + Ext.data.NodeInterface.decorate(root); - if(this.tools){ - ts = this.tools; - this.elements += (this.header !== false) ? ',header' : ''; - } - this.tools = {}; - - el.addClass(this.baseCls); - if(d.firstChild){ // existing markup - this.header = el.down('.'+this.headerCls); - this.bwrap = el.down('.'+this.bwrapCls); - var cp = this.bwrap ? this.bwrap : el; - this.tbar = cp.down('.'+this.tbarCls); - this.body = cp.down('.'+this.bodyCls); - this.bbar = cp.down('.'+this.bbarCls); - this.footer = cp.down('.'+this.footerCls); - this.fromMarkup = true; - } - if (this.preventBodyReset === true) { - el.addClass('x-panel-reset'); - } - if(this.cls){ - el.addClass(this.cls); - } - - if(this.buttons){ - this.elements += ',footer'; - } - - // This block allows for maximum flexibility and performance when using existing markup - - // framing requires special markup - if(this.frame){ - el.insertHtml('afterBegin', String.format(Ext.Element.boxMarkup, this.baseCls)); - - this.createElement('header', d.firstChild.firstChild.firstChild); - this.createElement('bwrap', d); - - // append the mid and bottom frame to the bwrap - bw = this.bwrap.dom; - var ml = d.childNodes[1], bl = d.childNodes[2]; - bw.appendChild(ml); - bw.appendChild(bl); - - var mc = bw.firstChild.firstChild.firstChild; - this.createElement('tbar', mc); - this.createElement('body', mc); - this.createElement('bbar', mc); - this.createElement('footer', bw.lastChild.firstChild.firstChild); - - if(!this.footer){ - this.bwrap.dom.lastChild.className += ' x-panel-nofooter'; - } - /* - * Store a reference to this element so: - * a) We aren't looking it up all the time - * b) The last element is reported incorrectly when using a loadmask - */ - this.ft = Ext.get(this.bwrap.dom.lastChild); - this.mc = Ext.get(mc); - }else{ - this.createElement('header', d); - this.createElement('bwrap', d); - - // append the mid and bottom frame to the bwrap - bw = this.bwrap.dom; - this.createElement('tbar', bw); - this.createElement('body', bw); - this.createElement('bbar', bw); - this.createElement('footer', bw); - - if(!this.header){ - this.body.addClass(this.bodyCls + '-noheader'); - if(this.tbar){ - this.tbar.addClass(this.tbarCls + '-noheader'); - } - } - } - - if(Ext.isDefined(this.padding)){ - this.body.setStyle('padding', this.body.addUnits(this.padding)); - } - - if(this.border === false){ - this.el.addClass(this.baseCls + '-noborder'); - this.body.addClass(this.bodyCls + '-noborder'); - if(this.header){ - this.header.addClass(this.headerCls + '-noborder'); - } - if(this.footer){ - this.footer.addClass(this.footerCls + '-noborder'); - } - if(this.tbar){ - this.tbar.addClass(this.tbarCls + '-noborder'); - } - if(this.bbar){ - this.bbar.addClass(this.bbarCls + '-noborder'); - } - } - - if(this.bodyBorder === false){ - this.body.addClass(this.bodyCls + '-noborder'); - } - - this.bwrap.enableDisplayMode('block'); - - if(this.header){ - this.header.unselectable(); - - // for tools, we need to wrap any existing header markup - if(this.headerAsText){ - this.header.dom.innerHTML = - ''+this.header.dom.innerHTML+''; - - if(this.iconCls){ - this.setIconClass(this.iconCls); - } - } - } - - if(this.floating){ - this.makeFloating(this.floating); - } - - if(this.collapsible && this.titleCollapse && this.header){ - this.mon(this.header, 'click', this.toggleCollapse, this); - this.header.setStyle('cursor', 'pointer'); - } - if(ts){ - this.addTool.apply(this, ts); - } - - // Render Toolbars. - if(this.fbar){ - this.footer.addClass('x-panel-btns'); - this.fbar.ownerCt = this; - this.fbar.render(this.footer); - this.footer.createChild({cls:'x-clear'}); - } - if(this.tbar && this.topToolbar){ - this.topToolbar.ownerCt = this; - this.topToolbar.render(this.tbar); - } - if(this.bbar && this.bottomToolbar){ - this.bottomToolbar.ownerCt = this; - this.bottomToolbar.render(this.bbar); + // Because we have decorated the model with new fields, + // we need to build new extactor functions on the reader. + me.getProxy().getReader().buildExtractors(true); + + // When we add the root to the tree, it will automaticaly get the NodeInterface + me.tree.setRootNode(root); + + // If the user has set expanded: true on the root, we want to call the expand function + if (!root.isLoaded() && root.isExpanded()) { + me.load({ + node: root + }); } + + return root; }, - + /** - * Sets the CSS class that provides the icon image for this panel. This method will replace any existing - * icon class if one has already been set and fire the {@link #iconchange} event after completion. - * @param {String} cls The new CSS class name + * Returns the root node for this tree. + * @return {Ext.data.NodeInterface} */ - setIconClass : function(cls){ - var old = this.iconCls; - this.iconCls = cls; - if(this.rendered && this.header){ - if(this.frame){ - this.header.addClass('x-panel-icon'); - this.header.replaceClass(old, this.iconCls); - }else{ - var hd = this.header, - img = hd.child('img.x-panel-inline-icon'); - if(img){ - Ext.fly(img).replaceClass(old, this.iconCls); - }else{ - var hdspan = hd.child('span.' + this.headerTextCls); - if (hdspan) { - Ext.DomHelper.insertBefore(hdspan.dom, { - tag:'img', src: Ext.BLANK_IMAGE_URL, cls:'x-panel-inline-icon '+this.iconCls - }); - } - } - } - } - this.fireEvent('iconchange', this, cls, old); - }, - - // private - makeFloating : function(cfg){ - this.floating = true; - this.el = new Ext.Layer(Ext.apply({}, cfg, { - shadow: Ext.isDefined(this.shadow) ? this.shadow : 'sides', - shadowOffset: this.shadowOffset, - constrain:false, - shim: this.shim === false ? false : undefined - }), this.el); + getRootNode: function() { + return this.tree.getRootNode(); }, /** - * Returns the {@link Ext.Toolbar toolbar} from the top ({@link #tbar}) section of the panel. - * @return {Ext.Toolbar} The toolbar + * Returns the record node by id + * @return {Ext.data.NodeInterface} */ - getTopToolbar : function(){ - return this.topToolbar; + getNodeById: function(id) { + return this.tree.getNodeById(id); }, /** - * Returns the {@link Ext.Toolbar toolbar} from the bottom ({@link #bbar}) section of the panel. - * @return {Ext.Toolbar} The toolbar + * Loads the Store using its configured {@link #proxy}. + * @param {Object} options Optional config object. This is passed into the {@link Ext.data.Operation Operation} + * object that is created and then sent to the proxy's {@link Ext.data.proxy.Proxy#read} function. + * The options can also contain a node, which indicates which node is to be loaded. If not specified, it will + * default to the root node. */ - getBottomToolbar : function(){ - return this.bottomToolbar; + load: function(options) { + options = options || {}; + options.params = options.params || {}; + + var me = this, + node = options.node || me.tree.getRootNode(), + root; + + // If there is not a node it means the user hasnt defined a rootnode yet. In this case lets just + // create one for them. + if (!node) { + node = me.setRootNode({ + expanded: true + }); + } + + if (me.clearOnLoad) { + node.removeAll(); + } + + Ext.applyIf(options, { + node: node + }); + options.params[me.nodeParam] = node ? node.getId() : 'root'; + + if (node) { + node.set('loading', true); + } + + return me.callParent([options]); }, + /** - * Returns the {@link Ext.Toolbar toolbar} from the footer ({@link #fbar}) section of the panel. - * @return {Ext.Toolbar} The toolbar + * Fills a node with a series of child records. + * @private + * @param {Ext.data.NodeInterface} node The node to fill + * @param {Array} records The records to add */ - getFooterToolbar : function() { - return this.fbar; - }, + fillNode: function(node, records) { + var me = this, + ln = records ? records.length : 0, + i = 0, sortCollection; - /** - * Adds a button to this panel. Note that this method must be called prior to rendering. The preferred - * approach is to add buttons via the {@link #buttons} config. - * @param {String/Object} config A valid {@link Ext.Button} config. A string will become the text for a default - * button config, an object will be treated as a button config object. - * @param {Function} handler The function to be called on button {@link Ext.Button#click} - * @param {Object} scope The scope (this reference) in which the button handler function is executed. Defaults to the Button. - * @return {Ext.Button} The button that was added - */ - addButton : function(config, handler, scope){ - if(!this.fbar){ - this.createFbar([]); + if (ln && me.sortOnLoad && !me.remoteSort && me.sorters && me.sorters.items) { + sortCollection = Ext.create('Ext.util.MixedCollection'); + sortCollection.addAll(records); + sortCollection.sort(me.sorters.items); + records = sortCollection.items; } - if(handler){ - if(Ext.isString(config)){ - config = {text: config}; - } - config = Ext.apply({ - handler: handler, - scope: scope - }, config); + + node.set('loaded', true); + for (; i < ln; i++) { + node.appendChild(records[i], undefined, true); } - return this.fbar.add(config); + + return records; }, - // private - addTool : function(){ - if(!this.rendered){ - if(!this.tools){ - this.tools = []; - } - Ext.each(arguments, function(arg){ - this.tools.push(arg); - }, this); - return; - } - // nowhere to render tools! - if(!this[this.toolTarget]){ - return; + // inherit docs + onProxyLoad: function(operation) { + var me = this, + successful = operation.wasSuccessful(), + records = operation.getRecords(), + node = operation.node; + + node.set('loading', false); + if (successful) { + records = me.fillNode(node, records); } - if(!this.toolTemplate){ - // initialize the global tool template on first use - var tt = new Ext.Template( - ' ' - ); - tt.disableFormats = true; - tt.compile(); - Ext.Panel.prototype.toolTemplate = tt; - } - for(var i = 0, a = arguments, len = a.length; i < len; i++) { - var tc = a[i]; - if(!this.tools[tc.id]){ - var overCls = 'x-tool-'+tc.id+'-over'; - var t = this.toolTemplate.insertFirst(this[this.toolTarget], tc, true); - this.tools[tc.id] = t; - t.enableDisplayMode('block'); - this.mon(t, 'click', this.createToolHandler(t, tc, overCls, this)); - if(tc.on){ - this.mon(t, tc.on); - } - if(tc.hidden){ - t.hide(); - } - if(tc.qtip){ - if(Ext.isObject(tc.qtip)){ - Ext.QuickTips.register(Ext.apply({ - target: t.id - }, tc.qtip)); - } else { - t.dom.qtip = tc.qtip; + // deprecate read? + me.fireEvent('read', me, operation.node, records, successful); + me.fireEvent('load', me, operation.node, records, successful); + //this is a callback that would have been passed to the 'read' function and is optional + Ext.callback(operation.callback, operation.scope || me, [records, operation, successful]); + }, + + /** + * Create any new records when a write is returned from the server. + * @private + * @param {Array} records The array of new records + * @param {Ext.data.Operation} operation The operation that just completed + * @param {Boolean} success True if the operation was successful + */ + onCreateRecords: function(records, operation, success) { + if (success) { + var i = 0, + length = records.length, + originalRecords = operation.records, + parentNode, + record, + original, + index; + + /* + * Loop over each record returned from the server. Assume they are + * returned in order of how they were sent. If we find a matching + * record, replace it with the newly created one. + */ + for (; i < length; ++i) { + record = records[i]; + original = originalRecords[i]; + if (original) { + parentNode = original.parentNode; + if (parentNode) { + // prevent being added to the removed cache + original.isReplace = true; + parentNode.replaceChild(record, original); + delete original.isReplace; } + record.phantom = false; } - t.addClassOnOver(overCls); } } }, - onLayout : function(shallow, force){ - Ext.Panel.superclass.onLayout.apply(this, arguments); - if(this.hasLayout && this.toolbars.length > 0){ - Ext.each(this.toolbars, function(tb){ - tb.doLayout(undefined, force); - }); - this.syncHeight(); + /** + * Update any records when a write is returned from the server. + * @private + * @param {Array} records The array of updated records + * @param {Ext.data.Operation} operation The operation that just completed + * @param {Boolean} success True if the operation was successful + */ + onUpdateRecords: function(records, operation, success){ + if (success) { + var me = this, + i = 0, + length = records.length, + data = me.data, + original, + parentNode, + record; + + for (; i < length; ++i) { + record = records[i]; + original = me.tree.getNodeById(record.getId()); + parentNode = original.parentNode; + if (parentNode) { + // prevent being added to the removed cache + original.isReplace = true; + parentNode.replaceChild(record, original); + original.isReplace = false; + } + } } }, - syncHeight : function(){ - var h = this.toolbarHeight, - bd = this.body, - lsh = this.lastSize.height, - sz; - - if(this.autoHeight || !Ext.isDefined(lsh) || lsh == 'auto'){ - return; - } - - - if(h != this.getToolbarHeight()){ - h = Math.max(0, lsh - this.getFrameHeight()); - bd.setHeight(h); - sz = bd.getSize(); - this.toolbarHeight = this.getToolbarHeight(); - this.onBodyResize(sz.width, sz.height); + /** + * Remove any records when a write is returned from the server. + * @private + * @param {Array} records The array of removed records + * @param {Ext.data.Operation} operation The operation that just completed + * @param {Boolean} success True if the operation was successful + */ + onDestroyRecords: function(records, operation, success){ + if (success) { + this.removed = []; } }, - // private - onShow : function(){ - if(this.floating){ - return this.el.show(); - } - Ext.Panel.superclass.onShow.call(this); + // inherit docs + removeAll: function() { + this.getRootNode().destroy(true); + this.fireEvent('clear', this); }, - // private - onHide : function(){ - if(this.floating){ - return this.el.hide(); - } - Ext.Panel.superclass.onHide.call(this); - }, + // inherit docs + doSort: function(sorterFn) { + var me = this; + if (me.remoteSort) { + //the load function will pick up the new sorters and request the sorted data from the proxy + me.load(); + } else { + me.tree.sort(sorterFn, true); + me.fireEvent('datachanged', me); + } + me.fireEvent('sort', me); + } +}); +/** + * @author Ed Spencer + * @class Ext.data.XmlStore + * @extends Ext.data.Store + * @private + * @ignore + * 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.reader.Xml}. + * A store configuration would be something like: +var store = new Ext.data.XmlStore({ + // store configs + autoDestroy: true, + storeId: 'myStore', + url: 'sheldon.xml', // automatically configures a HttpProxy + // reader configs + record: 'Item', // records will have an "Item" tag + idPath: 'ASIN', + totalRecords: '@TotalResults' + fields: [ + // set up the fields mapping into the xml doc + // The first needs mapping, the others are very basic + {name: 'Author', mapping: 'ItemAttributes > Author'}, + 'Title', 'Manufacturer', 'ProductGroup' + ] +}); + * + * This store is configured to consume a returned object of the form: +<?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.reader.Xml XmlReader}. + * @constructor + * @param {Object} config + * @xtype xmlstore + */ +Ext.define('Ext.data.XmlStore', { + extend: 'Ext.data.Store', + alternateClassName: 'Ext.data.XmlStore', + alias: 'store.xml', - // private - createToolHandler : function(t, tc, overCls, panel){ - return function(e){ - t.removeClass(overCls); - if(tc.stopEvent !== false){ - e.stopEvent(); - } - if(tc.handler){ - tc.handler.call(tc.scope || t, e, t, panel, tc); + /** + * @cfg {Ext.data.DataReader} reader @hide + */ + constructor: function(config){ + config = config || {}; + config = config || {}; + + Ext.applyIf(config, { + proxy: { + type: 'ajax', + reader: 'xml', + writer: 'xml' } - }; - }, + }); - // private - afterRender : function(){ - if(this.floating && !this.hidden){ - this.el.show(); - } - if(this.title){ - this.setTitle(this.title); - } - Ext.Panel.superclass.afterRender.call(this); // do sizing calcs last - if (this.collapsed) { - this.collapsed = false; - this.collapse(false); - } - this.initEvents(); - }, + this.callParent([config]); + } +}); - // private - getKeyMap : function(){ - if(!this.keyMap){ - this.keyMap = new Ext.KeyMap(this.el, this.keys); +/** + * @author Ed Spencer + * @class Ext.data.proxy.Client + * @extends Ext.data.proxy.Proxy + * + * Base class for any client-side storage. Used as a superclass for {@link Ext.data.proxy.Memory Memory} and + * {@link Ext.data.proxy.WebStorage Web Storage} proxies. Do not use directly, use one of the subclasses instead. + */ +Ext.define('Ext.data.proxy.Client', { + extend: 'Ext.data.proxy.Proxy', + alternateClassName: 'Ext.data.ClientProxy', + + /** + * Abstract function that must be implemented by each ClientProxy subclass. This should purge all record data + * from the client side storage, as well as removing any supporting data (such as lists of record IDs) + */ + clear: function() { + Ext.Error.raise("The Ext.data.proxy.Client subclass that you are using has not defined a 'clear' function. See src/data/ClientProxy.js for details."); + } +}); +/** + * @author Ed Spencer + * @class Ext.data.proxy.JsonP + * @extends Ext.data.proxy.Server + * + * JsonPProxy is useful when you need to load data from a domain other than the one your application is running + * on. If your application is running on http://domainA.com it cannot use {@link Ext.data.proxy.Ajax Ajax} to load its + * data from http://domainB.com because cross-domain ajax requests are prohibited by the browser. + * + * We can get around this using a JsonPProxy. JsonPProxy injects a <script> tag into the DOM whenever + * an AJAX request would usually be made. Let's say we want to load data from http://domainB.com/users - the script tag + * that would be injected might look like this: + * + +<script src="http://domainB.com/users?callback=someCallback"></script> + + * + * When we inject the tag above, the browser makes a request to that url and includes the response as if it was any + * other type of JavaScript include. By passing a callback in the url above, we're telling domainB's server that we + * want to be notified when the result comes in and that it should call our callback function with the data it sends + * back. So long as the server formats the response to look like this, everything will work: + * + +someCallback({ + users: [ + { + id: 1, + name: "Ed Spencer", + email: "ed@sencha.com" } - return this.keyMap; - }, + ] +}); + + * + * As soon as the script finishes loading, the 'someCallback' function that we passed in the url is called with the + * JSON object that the server returned. + * + * JsonPProxy takes care of all of this automatically. It formats the url you pass, adding the callback + * parameter automatically. It even creates a temporary callback function, waits for it to be called and then puts + * the data into the Proxy making it look just like you loaded it through a normal {@link Ext.data.proxy.Ajax AjaxProxy}. + * Here's how we might set that up: + * + +Ext.define('User', { + extend: 'Ext.data.Model', + fields: ['id', 'name', 'email'] +}); - // private - initEvents : function(){ - if(this.keys){ - this.getKeyMap(); - } - if(this.draggable){ - this.initDraggable(); - } - if(this.toolbars.length > 0){ - Ext.each(this.toolbars, function(tb){ - tb.doLayout(); - tb.on({ - scope: this, - afterlayout: this.syncHeight, - remove: this.syncHeight - }); - }, this); - this.syncHeight(); - } +var store = new Ext.data.Store({ + model: 'User', + proxy: { + type: 'jsonp', + url : 'http://domainB.com/users' + } +}); - }, +store.load(); + + * + * That's all we need to do - JsonPProxy takes care of the rest. In this case the Proxy will have injected a + * script tag like this: + * + +<script src="http://domainB.com/users?callback=stcCallback001" id="stcScript001"></script> + + * + * Customization + * + * Most parts of this script tag can be customized using the {@link #callbackParam}, {@link #callbackPrefix} and + * {@link #scriptIdPrefix} configurations. For example: + * + +var store = new Ext.data.Store({ + model: 'User', + proxy: { + type: 'jsonp', + url : 'http://domainB.com/users', + callbackParam: 'theCallbackFunction', + callbackPrefix: 'ABC', + scriptIdPrefix: 'injectedScript' + } +}); - // private - initDraggable : function(){ - /** - * If this Panel is configured {@link #draggable}, this property will contain - * an instance of {@link Ext.dd.DragSource} which handles dragging the Panel. - * The developer must provide implementations of the abstract methods of {@link Ext.dd.DragSource} - * in order to supply behaviour for each stage of the drag/drop process. See {@link #draggable}. - * @type Ext.dd.DragSource. - * @property dd - */ - this.dd = new Ext.Panel.DD(this, Ext.isBoolean(this.draggable) ? null : this.draggable); - }, +store.load(); + + * + * Would inject a script tag like this: + * + +<script src="http://domainB.com/users?theCallbackFunction=ABC001" id="injectedScript001"></script> + + * + * Implementing on the server side + * + * The remote server side needs to be configured to return data in this format. Here are suggestions for how you + * might achieve this using Java, PHP and ASP.net: + * + * Java: + * + +boolean jsonP = false; +String cb = request.getParameter("callback"); +if (cb != null) { + jsonP = true; + response.setContentType("text/javascript"); +} else { + response.setContentType("application/x-json"); +} +Writer out = response.getWriter(); +if (jsonP) { + out.write(cb + "("); +} +out.print(dataBlock.toJsonString()); +if (jsonP) { + out.write(");"); +} + + * + * PHP: + * + +$callback = $_REQUEST['callback']; + +// Create the output object. +$output = array('a' => 'Apple', 'b' => 'Banana'); + +//start output +if ($callback) { + header('Content-Type: text/javascript'); + echo $callback . '(' . json_encode($output) . ');'; +} else { + header('Content-Type: application/x-json'); + echo json_encode($output); +} + + * + * ASP.net: + * + +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); + + * + */ +Ext.define('Ext.data.proxy.JsonP', { + extend: 'Ext.data.proxy.Server', + alternateClassName: 'Ext.data.ScriptTagProxy', + alias: ['proxy.jsonp', 'proxy.scripttag'], + requires: ['Ext.data.JsonP'], - // private - beforeEffect : function(anim){ - if(this.floating){ - this.el.beforeAction(); - } - if(anim !== false){ - this.el.addClass('x-panel-animated'); - } - }, + defaultWriterType: 'base', - // private - afterEffect : function(anim){ - this.syncShadow(); - this.el.removeClass('x-panel-animated'); - }, + /** + * @cfg {String} callbackKey (Optional) See {@link Ext.data.JsonP#callbackKey}. + */ + callbackKey : 'callback', - // private - wraps up an animation param with internal callbacks - createEffect : function(a, cb, scope){ - var o = { - scope:scope, - block:true - }; - if(a === true){ - o.callback = cb; - return o; - }else if(!a.callback){ - o.callback = cb; - }else { // wrap it up - o.callback = function(){ - cb.call(scope); - Ext.callback(a.callback, a.scope); - }; - } - return Ext.applyIf(o, a); - }, + /** + * @cfg {String} recordParam + * The param name to use when passing records to the server (e.g. 'records=someEncodedRecordString'). + * Defaults to 'records' + */ + recordParam: 'records', /** - * Collapses the panel body so that it becomes hidden. Fires the {@link #beforecollapse} event which will - * cancel the collapse action if it returns false. - * @param {Boolean} animate True to animate the transition, else false (defaults to the value of the - * {@link #animCollapse} panel config) - * @return {Ext.Panel} this + * @cfg {Boolean} autoAppendParams True to automatically append the request's params to the generated url. Defaults to true */ - collapse : function(animate){ - if(this.collapsed || this.el.hasFxBlock() || this.fireEvent('beforecollapse', this, animate) === false){ - return; - } - var doAnim = animate === true || (animate !== false && this.animCollapse); - this.beforeEffect(doAnim); - this.onCollapse(doAnim, animate); - return this; - }, + autoAppendParams: true, - // private - onCollapse : function(doAnim, animArg){ - if(doAnim){ - this[this.collapseEl].slideOut(this.slideAnchor, - Ext.apply(this.createEffect(animArg||true, this.afterCollapse, this), - this.collapseDefaults)); - }else{ - this[this.collapseEl].hide(this.hideMode); - this.afterCollapse(false); - } + constructor: function(){ + this.addEvents( + /** + * @event exception + * Fires when the server returns an exception + * @param {Ext.data.proxy.Proxy} this + * @param {Ext.data.Request} request The request that was sent + * @param {Ext.data.Operation} operation The operation that triggered the request + */ + 'exception' + ); + this.callParent(arguments); }, - // private - afterCollapse : function(anim){ - this.collapsed = true; - this.el.addClass(this.collapsedCls); - if(anim !== false){ - this[this.collapseEl].hide(this.hideMode); + /** + * @private + * Performs the read request to the remote domain. JsonPProxy does not actually create an Ajax request, + * instead we write out a + * + * ## 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 + */ +Ext.define('Ext.flash.Component', { + extend: 'Ext.Component', + alternateClassName: 'Ext.FlashComponent', + alias: 'widget.flash', - // @protected onDestroyRecords proxy callback for destroy action - onDestroyRecords : function(success, rs, data) { - // splice each rec out of this.removed - rs = (rs instanceof Ext.data.Record) ? [rs] : [].concat(rs); - for (var i=0,len=rs.length;i=0;i--) { - this.insert(rs[i].lastIndex, rs[i]); // <-- lastIndex set in Store#destroyRecord - } - } - }, + /** + * @cfg {String} flashVersion + * Indicates the version the flash content was published for. Defaults to '9.0.115'. + */ + flashVersion : '9.0.115', - // protected handleException. Possibly temporary until Ext framework has an exception-handler. - handleException : function(e) { - // @see core/Error.js - Ext.handleError(e); - }, + /** + * @cfg {String} backgroundColor + * The background color of the SWF movie. Defaults to '#ffffff'. + */ + backgroundColor: '#ffffff', /** - * Reloads the Record cache from the configured Proxy using the configured - * {@link Ext.data.Reader Reader} and the options from the last load operation - * performed. - * Note: see the Important note in {@link #load}. - * @param {Object} options (optional) An Object containing - * {@link #load loading options} which may override the {@link #lastOptions options} - * used in the last {@link #load} operation. See {@link #load} for details - * (defaults to null, in which case the {@link #lastOptions} are - * used). - * To add new params to the existing params: -lastOptions = myStore.lastOptions; -Ext.apply(lastOptions.params, { - myNewParam: true -}); -myStore.reload(lastOptions); - * + * @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. */ - reload : function(options){ - this.load(Ext.applyIf(options||{}, this.lastOptions)); - }, + wmode: 'opaque', - // private - // Called as a callback by the Reader during a load operation. - loadRecords : function(o, options, success){ - if (this.isDestroyed === true) { - return; - } - if(!o || success === false){ - if(success !== false){ - this.fireEvent('load', this, [], options); - } - if(options.callback){ - options.callback.call(options.scope || this, [], options, false, o); - } - return; - } - var r = o.records, t = o.totalRecords || r.length; - if(!options || options.add !== true){ - if(this.pruneModifiedRecords){ - this.modified = []; - } - for(var i = 0, len = r.length; i < len; i++){ - r[i].join(this); - } - if(this.snapshot){ - this.data = this.snapshot; - delete this.snapshot; - } - this.clearData(); - this.data.addAll(r); - this.totalLength = t; - this.applySort(); - this.fireEvent('datachanged', this); - }else{ - this.totalLength = Math.max(t, this.data.length+r.length); - this.add(r); - } - this.fireEvent('load', this, r, options); - if(options.callback){ - options.callback.call(options.scope || this, r, options, true); - } - }, + /** + * @cfg {Object} flashVars + * A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined. + */ /** - * Loads data from a passed data block and fires the {@link #load} event. A {@link Ext.data.Reader Reader} - * which understands the format of the data must have been configured in the constructor. - * @param {Object} data The data block from which to read the Records. The format of the data expected - * is dependent on the type of {@link Ext.data.Reader Reader} that is configured and should correspond to - * that {@link Ext.data.Reader Reader}'s {@link Ext.data.Reader#readRecords} parameter. - * @param {Boolean} append (Optional) true to append the new Records rather the default to replace - * the existing cache. - * Note: that Records in a Store are keyed by their {@link Ext.data.Record#id id}, so added Records - * with ids which are already present in the Store will replace existing Records. Only Records with - * new, unique ids will be added. + * @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. */ - loadData : function(o, append){ - var r = this.reader.readRecords(o); - this.loadRecords(r, {add: append}, true); - }, /** - * Gets the number of cached records. - * If using paging, this may not be the total size of the dataset. If the data object - * used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns - * the dataset size. Note: see the Important note in {@link #load}. - * @return {Number} The number of Records in the Store's cache. + * @cfg {Object} flashAttributes + * A set of key value pairs to be passed to the flash object as attributes. Defaults to undefined. + */ + + /** + * @cfg {String} url + * The URL of the SWF file to include. Required. */ - getCount : function(){ - return this.data.length || 0; - }, /** - * Gets the total number of records in the dataset as returned by the server. - * If using paging, for this to be accurate, the data object used by the {@link #reader Reader} - * must contain the dataset size. For remote data sources, the value for this property - * (totalProperty for {@link Ext.data.JsonReader JsonReader}, - * totalRecords for {@link Ext.data.XmlReader XmlReader}) shall be returned by a query on the server. - * Note: see the Important note in {@link #load}. - * @return {Number} The number of Records as specified in the data object passed to the Reader - * by the Proxy. - * Note: this value is not updated when changing the contents of the Store locally. + * @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. */ - getTotalCount : function(){ - return this.totalLength || 0; - }, + swfWidth: '100%', /** - * Returns an object describing the current sort state of this Store. - * @return {Object} The sort state of the Store. An object with two properties: - * field : StringThe name of the field by which the Records are sorted. - * direction : StringThe sort order, 'ASC' or 'DESC' (case-sensitive). - * - * See {@link #sortInfo} for additional details. + * @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. */ - getSortState : function(){ - return this.sortInfo; - }, + swfHeight: '100%', /** - * @private - * Invokes sortData if we have sortInfo to sort on and are not sorting remotely + * @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. */ - applySort : function(){ - if ((this.sortInfo || this.multiSortInfo) && !this.remoteSort) { - this.sortData(); - } - }, + expressInstall: false, /** - * @private - * Performs the actual sorting of data. This checks to see if we currently have a multi sort or not. It applies - * each sorter field/direction pair in turn by building an OR'ed master sorting function and running it against - * the full dataset + * @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. */ - sortData : function() { - var sortInfo = this.hasMultiSort ? this.multiSortInfo : this.sortInfo, - direction = sortInfo.direction || "ASC", - sorters = sortInfo.sorters, - sortFns = []; - //if we just have a single sorter, pretend it's the first in an array - if (!this.hasMultiSort) { - sorters = [{direction: direction, field: sortInfo.field}]; - } + // Have to create a placeholder div with the swfId, which SWFObject will replace with the object/embed element. + renderTpl: [''], - //create a sorter function for each sorter field/direction combo - for (var i=0, j = sorters.length; i < j; i++) { - sortFns.push(this.createSortFunction(sorters[i].field, sorters[i].direction)); + 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/'); } - - if (sortFns.length == 0) { - return; + if (!this.url) { + Ext.Error.raise('The "url" config is required for Ext.flash.Component'); } - //the direction modifier is multiplied with the result of the sorting functions to provide overall sort direction - //(as opposed to direction per field) - var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1; - - //create a function which ORs each sorter together to enable multi-sort - var fn = function(r1, r2) { - var result = sortFns[0].call(this, r1, r2); - - //if we have more than one sorter, OR any additional sorter functions together - if (sortFns.length > 1) { - for (var i=1, j = sortFns.length; i < j; i++) { - result = result || sortFns[i].call(this, r1, r2); - } - } - - return directionModifier * result; - }; + this.callParent(); + this.addEvents( + /** + * @event success + * Fired when the Flash movie has been successfully embedded + * @param {Ext.flash.Component} this + */ + 'success', - //sort the data - this.data.sort(direction, fn); - if (this.snapshot && this.snapshot != this.data) { - this.snapshot.sort(direction, fn); - } + /** + * @event failure + * Fired when the Flash movie embedding fails + * @param {Ext.flash.Component} this + */ + 'failure' + ); }, - /** - * @private - * Creates and returns a function which sorts an array by the given field and direction - * @param {String} field The field to create the sorter for - * @param {String} direction The direction to sort by (defaults to "ASC") - * @return {Function} A function which sorts by the field/direction combination provided - */ - createSortFunction: function(field, direction) { - direction = direction || "ASC"; - var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1; + onRender: function() { + var me = this, + params, vars, undef, + swfId = me.getSwfId(); - var sortType = this.fields.get(field).sortType; + me.renderData.swfId = swfId; - //create a comparison function. Takes 2 records, returns 1 if record 1 is greater, - //-1 if record 2 is greater or 0 if they are equal - return function(r1, r2) { - var v1 = sortType(r1.data[field]), - v2 = sortType(r2.data[field]); + me.callParent(arguments); - return directionModifier * (v1 > v2 ? 1 : (v1 < v2 ? -1 : 0)); - }; + 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) + ); }, /** - * Sets the default sort column and order to be used by the next {@link #load} operation. - * @param {String} fieldName The name of the field to sort by. - * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') - */ - setDefaultSort : function(field, dir) { - dir = dir ? dir.toUpperCase() : 'ASC'; - this.sortInfo = {field: field, direction: dir}; - this.sortToggle[field] = dir; - }, - - /** - * Sort the Records. - * If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local - * sorting is used, the cache is sorted internally. See also {@link #remoteSort} and {@link #paramNames}. - * This function accepts two call signatures - pass in a field name as the first argument to sort on a single - * field, or pass in an array of sort configuration objects to sort by multiple fields. - * Single sort example: - * store.sort('name', 'ASC'); - * Multi sort example: - * store.sort([ - * { - * field : 'name', - * direction: 'ASC' - * }, - * { - * field : 'salary', - * direction: 'DESC' - * } - * ], 'ASC'); - * In this second form, the sort configs are applied in order, with later sorters sorting within earlier sorters' results. - * For example, if two records with the same name are present they will also be sorted by salary if given the sort configs - * above. Any number of sort configs can be added. - * @param {String/Array} fieldName The name of the field to sort by, or an array of ordered sort configs - * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') - */ - sort : function(fieldName, dir) { - if (Ext.isArray(arguments[0])) { - return this.multiSort.call(this, fieldName, dir); + * @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 + */ + swfCallback: function(e) { + var me = this; + if (e.success) { + me.swf = Ext.get(e.ref); + me.onSuccess(); + me.fireEvent('success', me); } else { - return this.singleSort(fieldName, dir); + me.onFailure(); + me.fireEvent('failure', me); } }, /** - * Sorts the store contents by a single field and direction. This is called internally by {@link sort} and would - * not usually be called manually - * @param {String} fieldName The name of the field to sort by. - * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') + * Retrieve the id of the SWF object/embed element */ - singleSort: function(fieldName, dir) { - 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; + getSwfId: function() { + return this.swfId || (this.swfId = "extswf" + this.getAutoId()); + }, - if (!dir) { - if (sortInfo && sortInfo.field == name) { // toggle sort dir - dir = (this.sortToggle[name] || 'ASC').toggle('ASC', 'DESC'); - } else { - dir = field.sortDir; - } - } + 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'); + }, - this.sortToggle[name] = dir; - this.sortInfo = {field: name, direction: dir}; - this.hasMultiSort = false; + onFailure: Ext.emptyFn, - if (this.remoteSort) { - if (!this.load(this.lastOptions)) { - if (sortToggle) { - this.sortToggle[name] = sortToggle; - } - if (sortInfo) { - this.sortInfo = sortInfo; - } - } - } else { - this.applySort(); - this.fireEvent('datachanged', this); + 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.define('Ext.form.action.Action', { + alternateClassName: 'Ext.form.Action', + /** - * Sorts the contents of this store by multiple field/direction sorters. This is called internally by {@link sort} - * and would not usually be called manually. - * Multi sorting only currently applies to local datasets - multiple sort data is not currently sent to a proxy - * if remoteSort is used. - * @param {Array} sorters Array of sorter objects (field and direction) - * @param {String} direction Overall direction to sort the ordered results by (defaults to "ASC") + * @cfg {Ext.form.Basic} form The {@link Ext.form.Basic BasicForm} instance that + * is invoking this Action. Required. */ - multiSort: function(sorters, direction) { - this.hasMultiSort = true; - direction = direction || "ASC"; - //toggle sort direction - if (this.multiSortInfo && direction == this.multiSortInfo.direction) { - direction = direction.toggle("ASC", "DESC"); - } + /** + * @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}. + */ - /** - * Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields - * @property multiSortInfo - * @type Object - */ - this.multiSortInfo = { - sorters : sorters, - direction: direction - }; - - if (this.remoteSort) { - this.singleSort(sorters[0].field, sorters[0].direction); + /** + * @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. + */ - } else { - this.applySort(); - this.fireEvent('datachanged', this); - } - }, + /** + * @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. + */ /** - * Calls the specified function for each of the {@link Ext.data.Record Records} in the cache. - * @param {Function} fn The function to call. The {@link Ext.data.Record Record} is passed as the first parameter. - * Returning false aborts and exits the iteration. - * @param {Object} scope (optional) The scope (this reference) in which the function is executed. - * Defaults to the current {@link Ext.data.Record Record} in the iteration. + * @cfg {Object/String} params Extra 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}. */ - each : function(fn, scope){ - this.data.each(fn, scope); - }, /** - * Gets all {@link Ext.data.Record records} modified since the last commit. Modified records are - * persisted across load operations (e.g., during paging). Note: deleted records are not - * included. See also {@link #pruneModifiedRecords} and - * {@link Ext.data.Record}{@link Ext.data.Record#markDirty markDirty}.. - * @return {Ext.data.Record[]} An array of {@link Ext.data.Record Records} containing outstanding - * modifications. To obtain modified fields within a modified record see - *{@link Ext.data.Record}{@link Ext.data.Record#modified modified}.. + * @cfg {Object} headers Extra headers to be sent in the AJAX request for submit and load actions. See + * {@link Ext.data.Connection#headers}. */ - getModifiedRecords : function(){ - return this.modified; - }, /** - * Sums the value of property for each {@link Ext.data.Record record} between start - * and end and returns the result. - * @param {String} property A field in each record - * @param {Number} start (optional) The record index to start at (defaults to 0) - * @param {Number} end (optional) The last record index to include (defaults to length - 1) - * @return {Number} The sum + * @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}. */ - sum : function(property, start, end){ - var rs = this.data.items, v = 0; - start = start || 0; - end = (end || end === 0) ? end : rs.length-1; - for(var i = start; i <= end; i++){ - v += (rs[i].data[property] || 0); - } - return v; - }, + /** + * @cfg {Function} success The function to call when a valid success return packet is received. + * The function is passed the following parameters: + * form : Ext.form.BasicThe form that requested the action + * action : Ext.form.action.ActionThe Action class. The {@link #result} + * property of this object may be examined to perform custom postprocessing. + * + */ /** - * @private - * Returns a filter function used to test a the given property's value. Defers most of the work to - * Ext.util.MixedCollection's createValueMatcher function - * @param {String} property The property to create the filter function for - * @param {String/RegExp} value The string/regex to compare the property value to - * @param {Boolean} anyMatch True if we don't care if the filter value is not the full value (defaults to false) - * @param {Boolean} caseSensitive True to create a case-sensitive 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. + * @cfg {Function} failure The function to call when a failure packet was received, or when an + * error ocurred in the Ajax communication. + * The function is passed the following parameters: + * form : Ext.form.BasicThe form that requested the action + * action : Ext.form.action.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. + * */ - createFilterFn : function(property, value, anyMatch, caseSensitive, exactMatch){ - if(Ext.isEmpty(value, false)){ - return false; - } - value = this.data.createValueMatcher(value, anyMatch, caseSensitive, exactMatch); - return function(r) { - return value.test(r.data[property]); - }; - }, /** - * @private - * Given an array of filter functions (each with optional scope), constructs and returns a single function that returns - * the result of all of the filters ANDed together - * @param {Array} filters The array of filter objects (each object should contain an 'fn' and optional scope) - * @return {Function} The multiple filter function + * @cfg {Object} scope The scope in which to call the configured success and failure + * callback functions (the this reference for the callback functions). */ - createMultipleFilterFn: function(filters) { - return function(record) { - var isMatch = true; - for (var i=0, j = filters.length; i < j; i++) { - var filter = filters[i], - fn = filter.fn, - scope = filter.scope; + /** + * @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. + */ - isMatch = isMatch && fn.call(scope, record); - } + /** + * @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. + */ - return isMatch; - }; - }, + /** + * @cfg {Boolean} submitEmptyText If set to true, the emptyText value will be sent with the form + * when it is submitted. Defaults to true. + */ + + /** + * @property type + * The type of action this Action instance performs. + * Currently only "submit" and "load" are supported. + * @type {String} + */ /** - * Filter the {@link Ext.data.Record records} by a specified property. Alternatively, pass an array of filter - * options to filter by more than one property. - * Single filter example: - * store.filter('name', 'Ed', true, true); //finds all records containing the substring 'Ed' - * Multiple filter example: + * 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: * - * store.filter([ - * { - * property : 'name', - * value : 'Ed', - * anyMatch : true, //optional, defaults to true - * caseSensitive: true //optional, defaults to true - * }, - * - * //filter functions can also be passed - * { - * fn : function(record) { - * return record.get('age') == 24 - * }, - * scope: this - * } - * ]); +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(); + } +}] * - * @param {String|Array} field A field on your records, or an array containing multiple filter options - * @param {String/RegExp} value Either a string that the field should begin with, or a RegExp to test - * against the field. - * @param {Boolean} anyMatch (optional) true to match any part not just the beginning - * @param {Boolean} caseSensitive (optional) true for case sensitive comparison - * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true. + * @property failureType + * @type {String} */ - filter : function(property, value, anyMatch, caseSensitive, exactMatch){ - //we can accept an array of filter objects, or a single filter object - normalize them here - if (Ext.isObject(property)) { - property = [property]; - } - if (Ext.isArray(property)) { - var filters = []; + /** + * The raw XMLHttpRequest object used to perform the action. + * @property response + * @type {Object} + */ - //normalize the filters passed into an array of filter functions - for (var i=0, j = property.length; i < j; i++) { - var filter = property[i], - func = filter.fn, - scope = filter.scope || this; + /** + * The decoded response object containing a boolean success property and + * other, action-specific properties. + * @property result + * @type {Object} + */ - //if we weren't given a filter function, construct one now - if (!Ext.isFunction(func)) { - func = this.createFilterFn(filter.property, filter.value, filter.anyMatch, filter.caseSensitive, filter.exactMatch); - } - filters.push({fn: func, scope: scope}); - } - var fn = this.createMultipleFilterFn(filters); - } else { - //classic single property filter - var fn = this.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch); + constructor: function(config) { + if (config) { + Ext.apply(this, config); } - return fn ? this.filterBy(fn) : this.clearFilter(); + // Normalize the params option to an Object + var params = config.params; + if (Ext.isString(params)) { + this.params = Ext.Object.fromQueryString(params); + } }, /** - * Filter by a function. The specified function will be called for each - * Record in this Store. If the function returns true the Record is included, - * otherwise it is filtered out. - * @param {Function} fn The function to be called. It will be passed the following parameters: - * record : Ext.data.RecordThe {@link Ext.data.Record record} - * to test for filtering. Access field values using {@link Ext.data.Record#get}. - * id : ObjectThe ID of the Record passed. - * - * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to this Store. + * Invokes this action using the current configuration. */ - filterBy : function(fn, scope){ - this.snapshot = this.snapshot || this.data; - this.data = this.queryBy(fn, scope||this); - this.fireEvent('datachanged', this); - }, + run: Ext.emptyFn, /** - * Revert to a view of the Record cache with no filtering applied. - * @param {Boolean} suppressEvent If true the filter is cleared silently without firing the - * {@link #datachanged} event. + * @private + * @method onSuccess + * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses. + * @param {Object} response */ - clearFilter : function(suppressEvent){ - if(this.isFiltered()){ - this.data = this.snapshot; - delete this.snapshot; - if(suppressEvent !== true){ - this.fireEvent('datachanged', this); - } - } - }, /** - * Returns true if this store is currently filtered - * @return {Boolean} + * @private + * @method handleResponse + * Handles the raw response and builds a result object from it. Must be implemented by subclasses. + * @param {Object} response */ - isFiltered : function(){ - return !!this.snapshot && this.snapshot != this.data; - }, /** - * Query the records by a specified property. - * @param {String} field A field on your records - * @param {String/RegExp} value Either a string that the field - * should begin with, or a RegExp to test against the field. - * @param {Boolean} anyMatch (optional) True to match any part not just the beginning - * @param {Boolean} caseSensitive (optional) True for case sensitive comparison - * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records + * @private + * Handles a failure response. + * @param {Object} response */ - query : function(property, value, anyMatch, caseSensitive){ - var fn = this.createFilterFn(property, value, anyMatch, caseSensitive); - return fn ? this.queryBy(fn) : this.data.clone(); + onFailure : function(response){ + this.response = response; + this.failureType = Ext.form.action.Action.CONNECT_FAILURE; + this.form.afterAction(this, false); }, /** - * Query the cached records in this Store using a filtering function. The specified function - * will be called with each record in this Store. If the function returns true the record is - * included in the results. - * @param {Function} fn The function to be called. It will be passed the following parameters: - * record : Ext.data.RecordThe {@link Ext.data.Record record} - * to test for filtering. Access field values using {@link Ext.data.Record#get}. - * id : ObjectThe ID of the Record passed. - * - * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to this Store. - * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records - **/ - queryBy : function(fn, scope){ - var data = this.snapshot || this.data; - return data.filterBy(fn, scope||this); + * @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. + */ + processResponse : function(response){ + this.response = response; + if (!response.responseText && !response.responseXML) { + return true; + } + return (this.result = this.handleResponse(response)); }, /** - * Finds the index of the first matching Record in this store by a specific field value. - * @param {String} fieldName The name of the Record field to test. - * @param {String/RegExp} value Either a string that the field value - * should begin with, or a RegExp to test against the field. - * @param {Number} startIndex (optional) The index to start searching at - * @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 + * @private + * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions. + * @return {String} The URL. */ - find : function(property, value, start, anyMatch, caseSensitive){ - var fn = this.createFilterFn(property, value, anyMatch, caseSensitive); - return fn ? this.data.findIndexBy(fn, null, start) : -1; + getUrl: function() { + return this.url || this.form.url; }, /** - * Finds the index of the first matching Record in this store by a specific field value. - * @param {String} fieldName The name of the Record field to test. - * @param {Mixed} value The value to match the field against. - * @param {Number} startIndex (optional) The index to start searching at - * @return {Number} The matched index or -1 + * @private + * Determine the HTTP method to be used for the request. + * @return {String} The HTTP method */ - findExact: function(property, value, start){ - return this.data.findIndexBy(function(rec){ - return rec.get(property) === value; - }, this, start); + getMethod: function() { + return (this.method || this.form.method || 'POST').toUpperCase(); }, /** - * Find the index of the first matching Record in this Store by a function. - * If the function returns true it is considered a match. - * @param {Function} fn The function to be called. It will be passed the following parameters: - * record : Ext.data.RecordThe {@link Ext.data.Record record} - * to test for filtering. Access field values using {@link Ext.data.Record#get}. - * id : ObjectThe ID of the Record passed. - * - * @param {Object} scope (optional) The scope (this reference) in which the function is executed. Defaults to this Store. - * @param {Number} startIndex (optional) The index to start searching at - * @return {Number} The matched index or -1 + * @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 */ - findBy : function(fn, scope, start){ - return this.data.findIndexBy(fn, scope, start); + getParams: function() { + return Ext.apply({}, this.params, this.form.baseParams); }, /** - * Collects unique values for a particular dataIndex from this store. - * @param {String} dataIndex The property to collect - * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values - * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered - * @return {Array} An array of the unique values - **/ - collect : function(dataIndex, allowNull, bypassFilter){ - var d = (bypassFilter === true && this.snapshot) ? - this.snapshot.items : this.data.items; - var v, sv, r = [], l = {}; - for(var i = 0, len = d.length; i < len; i++){ - v = d[i].data[dataIndex]; - sv = String(v); - if((allowNull || !Ext.isEmpty(v)) && !l[sv]){ - l[sv] = true; - r[r.length] = v; - } - } - return r; + * @private + * Creates a callback object. + */ + 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 + }; }, - // private - afterEdit : function(record){ - if(this.modified.indexOf(record) == -1){ - this.modified.push(record); - } - this.fireEvent('update', this, record, Ext.data.Record.EDIT); - }, + 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', - // private - afterReject : function(record){ - this.modified.remove(record); - this.fireEvent('update', this, record, Ext.data.Record.REJECT); - }, + /** + * @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', - // private - afterCommit : function(record){ - this.modified.remove(record); - this.fireEvent('update', this, record, Ext.data.Record.COMMIT); - }, + /** + * @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' + ] + ) + + * 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.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.define('Ext.form.action.Submit', { + extend:'Ext.form.action.Action', + alternateClassName: 'Ext.form.Action.Submit', + alias: 'formaction.submit', + + type: 'submit', /** - * Commit all Records with {@link #getModifiedRecords outstanding changes}. To handle updates for changes, - * subscribe to the Store's {@link #update update event}, and perform updating when the third parameter is - * Ext.data.Record.COMMIT. + * @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. */ - commitChanges : function(){ - var m = this.modified.slice(0); - this.modified = []; - for(var i = 0, len = m.length; i < len; i++){ - m[i].commit(); + + // 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); } }, /** - * {@link Ext.data.Record#reject Reject} outstanding changes on all {@link #getModifiedRecords modified records}. - */ - rejectChanges : function(){ - var m = this.modified.slice(0); - this.modified = []; - for(var i = 0, len = m.length; i < len; i++){ - m[i].reject(); - } - var m = this.removed.slice(0).reverse(); - this.removed = []; - for(var i = 0, len = m.length; i < len; i++){ - this.insert(m[i].lastIndex||0, m[i]); - m[i].reject(); - } - }, + * @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 + }); - // private - onMetaChange : function(meta){ - this.recordType = this.reader.recordType; - this.fields = this.recordType.prototype.fields; - delete this.snapshot; - if(this.reader.meta.sortInfo){ - this.sortInfo = this.reader.meta.sortInfo; - }else if(this.sortInfo && !this.fields.get(this.sortInfo.field)){ - delete this.sortInfo; + // 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(); } - if(this.writer){ - this.writer.meta = this.reader.meta; + + Ext.Ajax.request(ajaxOptions); + + if (formEl) { + Ext.removeNode(formEl); } - this.modified = []; - this.fireEvent('metachange', this, this.reader.meta); }, - // private - findInsertIndex : function(record){ - this.suspendEvents(); - var data = this.data.clone(); - this.data.add(record); - this.applySort(); - var index = this.data.indexOf(record); - this.data = data; - this.resumeEvents(); - return index; + /** + * @private + * Build the full set of parameters from the field values plus any additional configured params. + */ + getParams: function() { + var nope = false, + configParams = this.callParent(), + fieldParams = this.form.getValues(nope, nope, this.submitEmptyText !== nope); + return Ext.apply({}, fieldParams, configParams); }, /** - * Set the value for a property name in this store's {@link #baseParams}. Usage: -myStore.setBaseParam('foo', {bar:3}); - - * @param {String} name Name of the property to assign - * @param {Mixed} value Value to assign the named property - **/ - setBaseParam : function (name, value){ - this.baseParams = this.baseParams || {}; - this.baseParams[name] = value; - } -}); - -Ext.reg('store', Ext.data.Store); + * @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); + } + }); -/** - * @class Ext.data.Store.Error - * @extends Ext.Error - * Store Error extension. - * @param {String} name - */ -Ext.data.Store.Error = Ext.extend(Ext.Error, { - name: 'Ext.data.Store' -}); -Ext.apply(Ext.data.Store.Error.prototype, { - lang: { - 'writer-undefined' : 'Attempted to execute a write-action without a DataWriter installed.' - } -}); -/** - * @class Ext.data.Field - * This class encapsulates the field definition information specified in the field definition objects - * passed to {@link Ext.data.Record#create}. - * Developers do not need to instantiate this class. Instances are created by {@link Ext.data.Record.create} - * and cached in the {@link Ext.data.Record#fields fields} property of the created Record constructor's prototype. - */ -Ext.data.Field = Ext.extend(Object, { - - constructor : function(config){ - if(Ext.isString(config)){ - config = {name: config}; + function addField(name, val) { + fieldsSpec.push({ + tag: 'input', + type: 'hidden', + name: name, + value: Ext.String.htmlEncode(val) + }); } - Ext.apply(this, config); - - var types = Ext.data.Types, - st = this.sortType, - t; - if(this.type){ - if(Ext.isString(this.type)){ - this.type = Ext.data.Types[this.type.toUpperCase()] || types.AUTO; + // 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); } - }else{ - this.type = types.AUTO; - } + }); - // named sortTypes are supported, here we look them up - if(Ext.isString(st)){ - this.sortType = Ext.data.SortTypes[st]; - }else if(Ext.isEmpty(st)){ - this.sortType = this.type.sortType; + formSpec = { + tag: 'form', + action: this.getUrl(), + method: this.getMethod(), + target: this.target || '_self', + style: 'display:none', + cn: fieldsSpec + }; + + // Set the proper encoding for file uploads + if (uploadFields.length) { + formSpec.encoding = formSpec.enctype = 'multipart/form-data'; } - if(!this.convert){ - this.convert = this.type.convert; + // Create the form + formEl = Ext.core.DomHelper.append(Ext.getBody(), formSpec); + + // Special handling for file upload fields: since browser security measures prevent setting + // their values programatically, and prevent carrying their selected values over when cloning, + // we have to move the actual field instances out of their components and into the form. + Ext.Array.each(uploadFields, function(field) { + if (field.rendered) { // can only have a selected file value after being rendered + formEl.appendChild(field.extractFileInput()); + } + }); + + return formEl; + }, + + + + /** + * @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); }, - + /** - * @cfg {String} name - * The name by which the field is referenced within the Record. This is referenced by, for example, - * the 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. + * @private */ + 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 + }; + } + 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', { + /** - * @cfg {Mixed} type - * (Optional) The data type for automatic conversion from received data to the stored value if {@link Ext.data.Field#convert convert} - * has not been specified. This may be specified as a string value. Possible values are - * - * auto (Default, implies no conversion) - * string - * int - * float - * boolean - * date - * 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 {Boolean} constrain + * Specify as true to constrain the Component to within the bounds of the {@link #constrainTo} region. */ + /** - * @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: - * 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}). - * - * -// example of convert function -function fullName(v, record){ - return record.name.last + ', ' + record.name.first; -} + * @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. + */ -function location(v, record){ - return !record.city ? '' : (record.city + ', ' + record.state); -} + /** + * @cfg {Boolean} constrainDelegate + * Specify as true to constrain the drag handles within the {@link constrainTo} region. + */ -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} -]); + extend: 'Ext.dd.DragTracker', -// create the data store -var store = new Ext.data.Store({ - reader: new Ext.data.JsonReader( - { - idProperty: 'key', - root: 'daRoot', - totalProperty: 'total' - }, - Dude // recordType - ) -}); + autoStart: 500, -var myData = [ - { key: 1, - name: { first: 'Fat', last: 'Albert' } - // notice no city, state provided in data object + constructor: function(comp, config) { + this.comp = comp; + this.initialConstrainTo = config.constrainTo; + this.callParent([ config ]); }, - { key: 2, - name: { first: 'Barney', last: 'Rubble' }, - city: 'Bedrock', state: 'Stoneridge' + + 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(); + } }, - { key: 3, - name: { first: 'Cliff', last: 'Claven' }, - city: 'Boston', state: 'MA' + + 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; + }, + + // Move either the ghost Component or the target Component to its new position on drag + onDrag: function(e) { + var me = this, + comp = (me.proxy && !me.comp.liveDrag) ? me.proxy : me.comp, + offset = me.getOffset(me.constrain || me.constrainDelegate ? 'dragTarget' : null); + + comp.setPosition(me.startPosition[0] + offset[0], me.startPosition[1] + offset[1]); + }, + + onEnd: function(e) { + if (this.proxy && !this.comp.liveDrag) { + this.comp.unghost(); + } } -]; - * +}); +/** + * @class Ext.form.Labelable + +A mixin which allows a component to be configured and decorated with a label and/or error message as is +common for form fields. This is used by e.g. {@link Ext.form.field.Base} and {@link Ext.form.FieldContainer} +to let them be managed by the Field layout. + +**NOTE**: This mixin is mainly for internal library use and most users should not need to use it directly. It +is more likely you will want to use one of the component classes that import this mixin, such as +{@link Ext.form.field.Base} or {@link Ext.form.FieldContainer}. + +Use of this mixin does not make a component a field in the logical sense, meaning it does not provide any +logic or state related to values or validation; that is handled by the related {@link Ext.form.field.Field} +mixin. These two mixins may be used separately (for example {@link Ext.form.FieldContainer} is Labelable but not a +Field), or in combination (for example {@link Ext.form.field.Base} implements both and has logic for connecting the +two.) + +Component classes which use this mixin should use the Field layout +or a derivation thereof to properly size and position the label and message according to the component config. +They must also call the {@link #initLabelable} method during component initialization to ensure the mixin gets +set up correctly. + + * @markdown + * @docauthor Jason Johnston + */ +Ext.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: [ + '', + ' for="{inputId}" class="{labelCls}" style="{labelStyle}">', + '{fieldLabel}{labelSeparator}', + '', + '', + ' id="{baseBodyCls}-{inputId}" role="presentation">{subTplMarkup}', + '', + '', + { + compiled: true, + disableFormats: true + } + ], + + /** + * @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. + */ + activeErrorsTpl: [ + '', + ' class="last">{.}', + '' + ], + + /** + * @property isFieldLabelable + * @type Boolean + * Flag denoting that this object is labelable as a field. Always true. */ + isFieldLabelable: true, + /** - * @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} + * @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'. */ - dateFormat: null, + formItemCls: Ext.baseCSSPrefix + 'form-item', + /** - * @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 "") + * @cfg {String} labelCls + * The CSS class to be applied to the label element. Defaults to 'x-form-item-label'. */ - defaultValue: "", + labelCls: Ext.baseCSSPrefix + 'form-item-label', + /** - * @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. - * - * {@link Ext.data.JsonReader}The mapping is a string containing the javascript - * expression to reference the data from an element of the data item's {@link Ext.data.JsonReader#root root} Array. Defaults to the field name. - * {@link Ext.data.XmlReader}The mapping is an {@link Ext.DomQuery} path to the data - * item relative to the DOM element that represents the {@link Ext.data.XmlReader#record record}. Defaults to the field name. - * {@link Ext.data.ArrayReader}The mapping is a number indicating the Array index - * of the field's value. Defaults to the field specification's Array position. - * - * 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} errorMsgCls + * The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'. */ - mapping: null, + errorMsgCls: Ext.baseCSSPrefix + 'form-error-msg', + /** - * @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 | -// +-+------+ +-+------+ + * @cfg {String} baseBodyCls + * The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'. + */ + baseBodyCls: Ext.baseCSSPrefix + 'form-item-body', -sortType: function(value) { - switch (value.toLowerCase()) // native toLowerCase(): - { - case 'first': return 1; - case 'second': return 2; - default: return 3; - } -} - * + /** + * @cfg {String} fieldBodyCls + * An extra CSS class to be applied to the body content element in addition to {@link #fieldBodyCls}. + * Defaults to empty. */ - sortType : null, + fieldBodyCls: '', + /** - * @cfg {String} sortDir - * (Optional) Initial direction to sort ("ASC" or "DESC"). Defaults to - * "ASC". + * @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'). */ - sortDir : "ASC", + clearCls: Ext.baseCSSPrefix + 'clear', + /** - * @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. + * @cfg {String} invalidCls + * The CSS class to use when marking the component invalid (defaults to 'x-form-invalid') */ - 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){ + invalidCls : Ext.baseCSSPrefix + 'form-invalid', + /** - * This DataReader's configured metadata as passed to the constructor. - * @type Mixed - * @property meta + * @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. */ - this.meta = meta; + fieldLabel: undefined, + /** - * @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} 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. + * */ - this.recordType = Ext.isArray(recordType) ? - Ext.data.Record.create(recordType) : recordType; + labelAlign : 'left', - // if recordType defined make sure extraction functions are defined - if (this.recordType){ - this.buildExtractors(); - } -}; + /** + * @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, -Ext.data.DataReader.prototype = { /** - * @cfg {String} messageProperty [undefined] Optional name of a property within a server-response that represents a user-feedback message. + * @cfg {Number} labelPad + * The amount of space in pixels between the {@link #fieldLabel} and the input field. Defaults to 5. */ + labelPad : 5, + /** - * Abstract method created in extension's buildExtractors impl. + * @cfg {String} labelSeparator + * Character(s) to be inserted at the end of the {@link #fieldLabel label text}. */ - getTotal: Ext.emptyFn, + labelSeparator : ':', + /** - * Abstract method created in extension's buildExtractors impl. + * @cfg {String} labelStyle + * A CSS style specification string to apply directly to this field's label. Defaults to undefined. */ - getRoot: Ext.emptyFn, + /** - * Abstract method created in extension's buildExtractors impl. + * @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. */ - getMessage: Ext.emptyFn, + hideLabel: false, + /** - * Abstract method created in extension's buildExtractors impl. + * @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. */ - getSuccess: Ext.emptyFn, + hideEmptyLabel: true, + /** - * Abstract method created in extension's buildExtractors impl. + * @cfg {Boolean} preventMark + * true to disable displaying any {@link #setActiveError error message} set on this object. + * Defaults to false. */ - getId: Ext.emptyFn, + preventMark: false, + /** - * Abstract method, overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader} + * @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. */ - buildExtractors : Ext.emptyFn, + autoFitErrors: true, + /** - * Abstract method overridden in DataReader extensions such as {@link Ext.data.JsonReader} and {@link Ext.data.XmlReader} + * @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. + * */ - extractValues : Ext.emptyFn, + msgTarget: 'qtip', /** - * 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. + * @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. */ - 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(); - } - }, /** - * 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 + * Performs initialization of this mixin. Component classes using this mixin should call this method + * during their own initialization. */ - 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); - } - } - } - 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(); - } + initLabelable: function() { + this.addCls(this.formItemCls); + + this.addEvents( + /** + * @event errorchange + * Fires when the active error message is changed via {@link #setActiveError}. + * @param {Ext.form.Labelable} this + * @param {String} error The active error message + */ + 'errorchange' + ); }, /** - * returns 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 + * 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 */ - 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'; - - var rs = []; + getFieldLabel: function() { + return this.fieldLabel || ''; + }, - // 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); + /** + * @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;'; } } - return rs; + + 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 + ); }, /** - * 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} + * @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. */ - 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" - } - } -}); - * - * 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. + 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, -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 -}); + /** + * @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, -var urec = store.getAt(0); -urec.set('email', 'foo@bar.com'); + /** + * @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 + }; + }, -var drec = store.getAt(1); -store.remove(drec); + /** + * @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 ''; + }, -// 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}. - */ -Ext.data.DataWriter = function(config){ - Ext.apply(this, config); -}; -Ext.data.DataWriter.prototype = { + /** + * Get the input id, if any, for this component. This is used as the "for" attribute on the label element. + * Implementing subclasses may also use this as e.g. the id for their own input element. + * @return {String} The input id + */ + getInputId: function() { + return ''; + }, /** - * @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. + * 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. */ - writeAllFields : false, + getActiveError : function() { + return this.activeError || ''; + }, + /** - * @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. + * 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} */ - listful : false, // <-- listful is actually not used internally here in DataWriter. @see Ext.data.Store#execute. + hasActiveError: function() { + return !!this.getActiveError(); + }, /** - * 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. + * 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 */ - 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); + setActiveError: function(msg) { + this.activeError = msg; + this.activeErrors = [msg]; + this.renderActiveError(); }, /** - * 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. + * 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. */ - render : Ext.emptyFn, + getActiveErrors: function() { + return this.activeErrors || []; + }, /** - * @cfg {Function} updateRecord Abstract method that should be implemented in all subclasses - * (e.g.: {@link Ext.data.JsonWriter#updateRecord JsonWriter.updateRecord} + * 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 */ - updateRecord : Ext.emptyFn, + setActiveErrors: function(errors) { + this.activeErrors = errors; + this.activeError = this.getTpl('activeErrorsTpl').apply({errors: errors}); + this.renderActiveError(); + }, /** - * @cfg {Function} createRecord Abstract method that should be implemented in all subclasses - * (e.g.: {@link Ext.data.JsonWriter#createRecord JsonWriter.createRecord}) + * Clears the active error. */ - createRecord : Ext.emptyFn, + unsetActiveError: function() { + delete this.activeError; + delete this.activeErrors; + this.renderActiveError(); + }, /** - * @cfg {Function} destroyRecord Abstract method that should be implemented in all subclasses - * (e.g.: {@link Ext.data.JsonWriter#destroyRecord JsonWriter.destroyRecord}) + * @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. */ - destroyRecord : Ext.emptyFn, + renderActiveError: function() { + var me = this, + activeError = me.getActiveError(), + hasError = !!activeError; + + if (activeError !== me.lastActiveError) { + me.fireEvent('errorchange', me, activeError); + me.lastActiveError = activeError; + } + + if (me.rendered && !me.isDestroyed && !me.preventMark) { + // Add/remove invalid class + me.el[hasError ? 'addCls' : 'removeCls'](me.invalidCls); + + // Update the aria-invalid attribute + me.getActionEl().dom.setAttribute('aria-invalid', hasError); + + // Update the errorEl with the error message text + me.errorEl.dom.innerHTML = activeError; + } + }, /** - * 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? + * 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. */ - toHash : function(rec, config) { - var map = rec.fields.map, - data = {}, - raw = (this.writeAllFields === false && rec.phantom === false) ? rec.getChanges() : rec.data, - m; - Ext.iterate(raw, function(prop, value){ - if((m = map[prop])){ - data[m.mapping ? m.mapping : m.name] = value; + setFieldDefaults: function(defaults) { + var me = this; + Ext.iterate(defaults, function(key, val) { + if (!me.hasOwnProperty(key)) { + me[key] = val; } }); - // we don't want to write Ext auto-generated id to hash. Careful not to remove it on Models not having auto-increment pk though. - // We can tell its not auto-increment if the user defined a DataReader field for it *and* that field's value is non-empty. - // we could also do a RegExp here for the Ext.data.Record AUTO_ID prefix. - if (rec.phantom) { - if (rec.fields.containsKey(this.meta.idProperty) && Ext.isEmpty(rec.data[this.meta.idProperty])) { - delete data[this.meta.idProperty]; - } - } else { - data[this.meta.idProperty] = rec.id - } - return data; }, /** - * Converts a {@link Ext.data.DataWriter#toHash Hashed} {@link Ext.data.Record} to fields-array array suitable - * for encoding to xml via XTemplate, eg: -<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 + * @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. */ - toArray : function(data) { - var fields = []; - Ext.iterate(data, function(k, v) {fields.push({name: k, value: v});},this); - return fields; - } -};/** - * @class Ext.data.DataProxy - * @extends Ext.util.Observable - * 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' + getBodyNaturalWidth: function() { + return this.bodyEl.getWidth(); } -}), - * - * 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 || {}; - - // 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); - - this.api = conn.api; - this.url = conn.url; - this.restful = conn.restful; - this.listeners = conn.listeners; +/** + * @class Ext.form.field.Field - // deprecated - this.prettyUrls = conn.prettyUrls; +This mixin provides a common interface for the logical behavior and state of form fields, including: - /** - * @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' -} +- Getter and setter methods for field values +- Events and methods for tracking value and validity changes +- Methods for triggering validation -// 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: - * -// 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' - }); - } - } -}); - * - * - */ +**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. - 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: - * - * remote-request failed : - * The server did not return status === 200. - * - * remote-request succeeded : - * The remote-request 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 response. In this case, this event will be - * raised and the caught error will be passed along into this event. - * - * - * 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'. - * - * 'response' : - * 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). - * - * 'remote' : - * 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. - * - * - * @param {String} action Name of the action (see {@link Ext.data.Api#actions}. - * @param {Object} options The options for the action that were specified in the {@link #request}. - * @param {Object} response - * The value of this parameter depends on the value of the type parameter: - * - * 'response' : - * The raw browser response object (e.g.: XMLHttpRequest) - * - * 'remote' : - * The decoded response object sent from the server. - * - * - * @param {Mixed} arg - * The type and value of this parameter depends on the value of the type parameter: - * - * 'response' : Error - * 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. - * - * 'remote' : Record/Record[] - * This parameter will only exist if the action was a write action - * (Ext.data.Api.actions.create|update|destroy). - * - * - */ - 'exception', - /** - * @event beforeload - * Fires before a request to retrieve a data object. - * @param {DataProxy} this The proxy for the request - * @param {Object} params The params object passed to the {@link #request} function - */ - 'beforeload', - /** - * @event load - * Fires before the load method's callback is called. - * @param {DataProxy} this The proxy for the request - * @param {Object} o The request transaction object - * @param {Object} options The callback's options property as passed to the {@link #request} function - */ - 'load', - /** - * @event loadexception - * 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 request params 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); +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. - // 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']); -}; + * @markdown + * @docauthor Jason Johnston + */ +Ext.define('Ext.form.field.Field', { -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: - * The first segment : represents the controller class that should be invoked. - * The second segment : represents the class function, or method, that should be called. - * The third segment : represents the ID (a variable typically passed to the method). - * - * Refer to {@link Ext.data.DataProxy#api} for additional information. + * @property isFormField + * @type {Boolean} + * Flag denoting that this component is a Field. Always true. */ - restful: false, + isFormField : true, /** - * 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. + * @cfg {Mixed} value A value to initialize this field with (defaults to undefined). */ - 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); - } - } - 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]; - } - 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} + * @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. */ - isApiAction : function(action) { - return (this.api[action]) ? true : false; - }, /** - * 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}. + * @cfg {Boolean} disabled True to disable the field (defaults to false). Disabled Fields will not be + * {@link Ext.form.Basic#submit submitted}. */ - 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); - } - }, - + disabled : 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 + * @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. */ - load : null, + submitValue: true, /** - * @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}). + * @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. */ - 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); - }, + validateOnChange: true, /** - * @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 */ - buildUrl : function(action, record) { - record = record || null; + suspendCheckChange: 0, - // 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); - } + /** + * Initializes this Field mixin on the current instance. Components using this mixin should call + * this method during their own initialization process. + */ + initField: function() { + this.addEvents( + /** + * @event change + * Fires when a user-initiated change is detected in the value of the field. + * @param {Ext.form.field.Field} this + * @param {Mixed} newValue The new value + * @param {Mixed} oldValue The original value + */ + 'change', + /** + * @event validitychange + * Fires when a change in the field's validity is detected. + * @param {Ext.form.field.Field} this + * @param {Boolean} isValid Whether or not the field is now valid + */ + 'validitychange', + /** + * @event dirtychange + * Fires when a change in the field's {@link #isDirty} state is detected. + * @param {Ext.form.field.Field} this + * @param {Boolean} isDirty Whether or not the field is now dirty + */ + 'dirtychange' + ); - // 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; - } - return (provides === null) ? url : url + provides; + this.initValue(); }, /** - * Destroys the proxy by purging any event listeners and cancelling any active requests. + * @protected + * Initializes the field's value based on the initial config. */ - destroy: function(){ - this.purgeListeners(); - } -}); + initValue: function() { + var me = this; -// 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); + /** + * @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; -/** - * @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); + // Set the initial value - prevent validation on initial set + me.suspendCheckChange++; + me.setValue(me.value); + me.suspendCheckChange--; }, - 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.' - } -}); + /** + * Returns the {@link Ext.form.field.Field#name name} attribute of the field. This is used as the parameter + * name when including the field value in a {@link Ext.form.Basic#submit form submit()}. + * @return {String} name The field {@link Ext.form.field.Field#name name} + */ + getName: function() { + return this.name; + }, -/** - * @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 + * 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; + }, + + /** + * 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 */ - action : undefined, + setValue: function(value) { + var me = this; + me.value = value; + me.checkChange(); + return me; + }, + /** - * @cfg {Ext.data.Record[]/Ext.data.Record} rs The Store recordset associated with the request. + * 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. */ - rs : undefined, + isEqual: function(value1, value2) { + return String(value1) === String(value2); + }, + /** - * @cfg {Object} params HTTP request params + * 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. */ - params: undefined, + getSubmitData: function() { + var me = this, + data = null; + if (!me.disabled && me.submitValue && !me.isFileUpload()) { + data = {}; + data[me.getName()] = '' + me.getValue(); + } + return data; + }, + /** - * @cfg {Function} callback The function to call when request is complete + * 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. */ - callback : Ext.emptyFn, + getModelData: function() { + var me = this, + data = null; + if (!me.disabled && !me.isFileUpload()) { + data = {}; + data[me.getName()] = me.getValue(); + } + return data; + }, + /** - * @cfg {Object} scope The scope of the callback funtion + * 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} */ - scope : undefined, + reset : function(){ + var me = this; + + me.setValue(me.originalValue); + me.clearInvalid(); + // delete here so we reset back to the original state + delete me.wasValid; + }, + /** - * @cfg {Ext.data.DataReader} reader The DataReader instance which will parse the received response + * 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. */ - 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 = { + resetOriginalValue: function() { + this.originalValue = this.getValue(); + this.checkDirty(); + }, + /** - * @cfg {String} action {@link Ext.data.Api#actions} + * 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. + * */ - action: undefined, + checkChange: function() { + if (!this.suspendCheckChange) { + var me = this, + newVal = me.getValue(), + oldVal = me.lastValue; + if (!me.isEqual(newVal, oldVal) && !me.isDestroyed) { + me.lastValue = newVal; + me.fireEvent('change', me, newVal, oldVal); + me.onChange(newVal, oldVal); + } + } + }, + /** - * @cfg {Boolean} success + * @private + * Called when the field's value changes. Performs validation if the {@link #validateOnChange} + * config is enabled, and invokes the dirty check. */ - success : undefined, + onChange: function(newVal, oldVal) { + if (this.validateOnChange) { + this.validate(); + } + this.checkDirty(); + }, + /** - * @cfg {String} message + * 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. */ - message : undefined, + isDirty : function() { + var me = this; + return !me.disabled && !me.isEqual(me.getValue(), me.originalValue); + }, + /** - * @cfg {Array/Object} data + * 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. */ - data: undefined, + checkDirty: function() { + var me = this, + isDirty = me.isDirty(); + if (isDirty !== me.wasDirty) { + me.fireEvent('dirtychange', me, isDirty); + me.onDirtyChange(isDirty); + me.wasDirty = isDirty; + } + }, + /** - * @cfg {Object} raw The raw response returned from server-code + * @private Called when the field's dirty state changes. + * @param {Boolean} isDirty */ - raw: undefined, + onDirtyChange: Ext.emptyFn, + /** - * @cfg {Ext.data.Record/Ext.data.Record[]} records related to the Request action + * 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. */ - 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']; + getErrors: function(value) { + return []; + }, -// Create the output object. -$output = array('a' => 'Apple', 'b' => 'Banana'); + /** + * 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()); + }, -//start output -if ($callback) { - header('Content-Type: text/javascript'); - echo $callback . '(' . json_encode($output) . ');'; -} else { - header('Content-Type: application/x-json'); - echo json_encode($output); -} - - * Below is the ASP.Net code to do the same thing: -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); - - * - * @constructor - * @param {Object} config A configuration object. - */ -Ext.data.ScriptTagProxy = function(config){ - Ext.apply(this, config); - - Ext.data.ScriptTagProxy.superclass.constructor.call(this, config); - - this.head = document.getElementsByTagName("head")[0]; - - /** - * @event loadexception - * Deprecated in favor of 'exception' event. - * Fires if an exception occurs in the Proxy during data loading. This event can be fired for one of two reasons: - * 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. + /** + * Returns whether or not the field value is currently valid by {@link #getErrors validating} the + * field's current value, and fires the {@link #validitychange} event if the field's validity has + * changed since the last validation. Note: {@link #disabled} fields are always treated as valid. + * Custom implementations of this method are allowed to have side-effects such as triggering error + * message display. To validate without side-effects, use {@link #isValid}. + * @return {Boolean} True if the value is valid, else false */ -}; + validate : function() { + var me = this, + isValid = me.isValid(); + if (isValid !== me.wasValid) { + me.wasValid = isValid; + me.fireEvent('validitychange', me, isValid); + } + return isValid; + }, -Ext.data.ScriptTagProxy.TRANS_ID = 1000; + /** + * 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(); + }, -Ext.extend(Ext.data.ScriptTagProxy, Ext.data.DataProxy, { /** - * @cfg {String} url The URL from which to request the data object. + * Returns whether this Field is a file upload field; if it returns true, forms will use + * special techniques for {@link Ext.form.Basic#submit submitting the form} via AJAX. See + * {@link Ext.form.Basic#hasUpload} for details. If this returns true, the {@link #extractFileInput} + * method must also be implemented to return the corresponding file input element. + * @return {Boolean} */ + isFileUpload: function() { + return false; + }, + /** - * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds. + * 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} */ - timeout : 30000, + extractFileInput: function() { + return null; + }, + /** - * @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. + * 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. + * @method */ - callbackParam : "callback", + markInvalid: Ext.emptyFn, + /** - * @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. + * 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. + * @method */ - doRequest : function(action, rs, params, reader, callback, scope, arg) { - var p = Ext.urlEncode(Ext.apply(params, this.extraParams)); + clearInvalid: Ext.emptyFn - var url = this.buildUrl(action, rs); - if (!url) { - throw new Ext.data.Api.Error('invalid-url', url); - } - 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 - }; - window[trans.cb] = this.createCallback(action, rs, trans); - url += String.format("&{0}={1}", this.callbackParam, trans.cb); - if(this.autoAbort !== false){ - this.abort(); - } +/** + * @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', { - trans.timeoutId = this.handleFailure.defer(this.timeout, this, [trans]); + /* Begin Definitions */ - var script = document.createElement("script"); - script.setAttribute("src", url); - script.setAttribute("type", "text/javascript"); - script.setAttribute("id", trans.scriptId); - this.head.appendChild(script); + alias: ['layout.field'], + + extend: 'Ext.layout.component.Component', + + uses: ['Ext.tip.QuickTip', 'Ext.util.TextMetrics'], - this.trans = trans; + /* End Definitions */ + + type: 'field', + + beforeLayout: function(width, height) { + var me = this; + return me.callParent(arguments) || (!me.owner.preventMark && me.activeError !== me.owner.getActiveError()); }, - // @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); + onLayout: function(width, height) { + var me = this, + owner = me.owner, + labelStrategy = me.getLabelStrategy(), + errorStrategy = me.getErrorStrategy(), + isDefined = Ext.isDefined, + isNumber = Ext.isNumber, + lastSize, autoWidth, autoHeight, info, undef; + + lastSize = me.lastComponentSize || {}; + if (!isDefined(width)) { + width = lastSize.width; + if (width < 0) { //first pass lastComponentSize.width is -Infinity + width = undef; + } + } + if (!isDefined(height)) { + height = lastSize.height; + if (height < 0) { //first pass lastComponentSize.height is -Infinity + height = undef; + } + } + autoWidth = !isNumber(width); + autoHeight = !isNumber(height); + + info = { + autoWidth: autoWidth, + autoHeight: autoHeight, + width: autoWidth ? owner.getBodyNaturalWidth() : width, //always give a pixel width + height: height, + setOuterWidth: false, //whether the outer el width should be set to the calculated width + + // insets for the bodyEl from each side of the component layout area + insets: { + top: 0, + right: 0, + bottom: 0, + left: 0 } }; - }, - /** - * Callback for read actions - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} trans The request transaction object - * @param {Object} res The server response - * @protected - */ - onRead : function(action, trans, res) { - var result; - try { - result = trans.reader.readRecords(res); - }catch(e){ - // @deprecated: fire loadexception - this.fireEvent("loadexception", this, trans, res, e); - this.fireEvent('exception', this, 'response', action, trans, res, e); - trans.callback.call(trans.scope||window, null, trans.arg, false); - return; - } - if (result.success === false) { - // @deprecated: fire old loadexception for backwards-compat. - this.fireEvent('loadexception', this, trans, res); + // 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. - 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 - */ - 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); - }, + // perform preparation on the label and error (setting css classes, qtips, etc.) + labelStrategy.prepare(owner, info); + errorStrategy.prepare(owner, info); - // private - isLoading : function(){ - return this.trans ? true : false; - }, + // calculate the horizontal insets for the label and error + labelStrategy.adjustHorizInsets(owner, info); + errorStrategy.adjustHorizInsets(owner, info); - /** - * Abort the current server request. - */ - abort : function(){ - if(this.isLoading()){ - this.destroyTrans(this.trans); - } - }, + // set horizontal styles for label and error based on the current insets + labelStrategy.layoutHoriz(owner, info); + errorStrategy.layoutHoriz(owner, info); - // 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){} - }; - } - }, + // calculate the vertical insets for the label and error + labelStrategy.adjustVertInsets(owner, info); + errorStrategy.adjustVertInsets(owner, info); - // 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); + // set vertical styles for label and error based on the current insets + labelStrategy.layoutVert(owner, info); + errorStrategy.layoutVert(owner, info); + + // perform sizing of the elements based on the final dimensions and insets + if (autoWidth && autoHeight) { + // Don't use setTargetSize if auto-sized, so the calculated size is not reused next time + me.setElementSize(owner.el, (info.setOuterWidth ? info.width : undef), info.height); + } else { + me.setTargetSize((!autoWidth || info.setOuterWidth ? info.width : undef), info.height); } + me.sizeBody(info); - this.fireEvent('exception', this, 'response', trans.action, { - response: null, - options: trans.arg - }); - trans.callback.call(trans.scope||window, null, trans.arg, false); + me.activeError = owner.getActiveError(); }, - // inherit docs - destroy: function(){ - this.abort(); - Ext.data.ScriptTagProxy.superclass.destroy.call(this); - } -});/** - * @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); /** - * 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 + * Perform sizing and alignment of the bodyEl (and children) to match the calculated insets. */ - this.conn = conn; + 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; - // 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; + // size the bodyEl + me.setElementSize(owner.bodyEl, width, height); - this.useAjax = !conn || !conn.events; + // 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, - // 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; - } -}; -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. + * 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. */ - getConnection : function() { - return this.useAjax ? Ext.Ajax : this.conn; + getLabelStrategy: function() { + var me = this, + strategies = me.labelStrategies, + labelAlign = me.owner.labelAlign; + return strategies[labelAlign] || strategies.base; }, /** - * 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). + * 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. */ - setUrl : function(url, makePermanent) { - this.conn.url = url; - if (makePermanent === true) { - this.url = url; - this.api = null; - Ext.data.Api.prepare(this); - } + 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; }, + + /** - * 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 + * 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. */ - 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 + 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 }, - reader: reader, - callback : this.createCallback(action, rs), - scope: this - }; + left = applyIf({ + prepare: function(owner, info) { + base.prepare(owner, info); + // If auto width, add the label width to the body's natural width. + if (info.autoWidth) { + info.width += (!owner.labelEl ? 0 : owner.labelWidth + owner.labelPad); + } + // Must set outer width to prevent field from wrapping below floated label + info.setOuterWidth = true; + }, + adjustHorizInsets: function(owner, info) { + if (owner.labelEl) { + info.insets.left += owner.labelWidth + owner.labelPad; + } + }, + layoutHoriz: function(owner, info) { + // For content-box browsers we can't rely on Labelable.js#getLabelableRenderData + // setting the width style because it needs to account for the final calculated + // padding/border styles for the label. So we set the width programmatically here to + // normalize content-box sizing, while letting border-box browsers use the original + // width style. + var labelEl = owner.labelEl; + if (labelEl && !owner.isLabelSized && !Ext.isBorderBox) { + labelEl.setWidth(owner.labelWidth); + owner.isLabelSized = true; + } + } + }, base); - // 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){ + return { + base: base, - Ext.applyIf(o, this.conn); + /** + * 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), - // 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; - }, + /** + * Label displayed to the left of the bodyEl + */ + left: left, - /** - * 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 - */ - 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); - } + /** + * Same as left, only difference is text-align in CSS + */ + right: left }; - }, + })(), + - /** - * 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 - */ - onRead : function(action, o, response) { - var result; - try { - result = o.reader.read(response); - }catch(e){ - // @deprecated: fire old loadexception for backwards-compat. - // TODO remove - this.fireEvent('loadexception', this, o, response, e); - - this.fireEvent('exception', this, 'response', action, o, response, e); - o.request.callback.call(o.request.scope, null, o.request.arg, false); - return; - } - if (result.success === false) { - // @deprecated: fire old loadexception for backwards-compat. - // TODO remove - this.fireEvent('loadexception', this, o, response); - // Get DataReader read-back a response-object to pass along to exception event - var res = o.reader.readResponse(action, response); - this.fireEvent('exception', this, 'remote', action, o, res, null); - } - else { - this.fireEvent('load', this, o, o.request.arg); - } - // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance - // the calls to request.callback(...) in each will have to be made identical. - // NOTE reader.readResponse does not currently return Ext.data.Response - o.request.callback.call(o.request.scope, result, o.request.arg, result.success); - }, /** - * Callback for write actions - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} trans The request transaction object - * @param {Object} res The server response - * @fires exception - * @fires write - * @protected + * 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. */ - 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); + errorStrategies: (function() { + function setDisplayed(el, displayed) { + var wasDisplayed = el.getStyle('display') !== 'none'; + if (displayed !== wasDisplayed) { + el.setDisplayed(displayed); + } } - // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance - // the calls to request.callback(...) in each will have to be made similar. - // NOTE reader.readResponse does not currently return Ext.data.Response - o.request.callback.call(o.request.scope, res.data, res, res.success); - }, - // inherit docs - destroy: function(){ - if(!this.useAjax){ - this.conn.abort(); - }else if(this.activeRequest){ - var actions = Ext.data.Api.actions; - for (var verb in actions) { - if(this.activeRequest[actions[verb]]){ - Ext.Ajax.abort(this.activeRequest[actions[verb]]); - } + function setStyle(el, name, value) { + if (el.getStyle(name) !== value) { + el.setStyle(name, value); } } - 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; -}; -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 - */ + var applyIf = Ext.applyIf, + emptyFn = Ext.emptyFn, + base = { + prepare: function(owner) { + setDisplayed(owner.errorEl, false); + }, + adjustHorizInsets: emptyFn, + adjustVertInsets: emptyFn, + layoutHoriz: emptyFn, + layoutVert: emptyFn + }; - /** - * 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 - * - * @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); + return { + none: base, - this.fireEvent('exception', this, 'response', action, arg, null, e); - callback.call(scope, null, arg, false); - return; + /** + * 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; + } } - 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); + +}); + +/** + * @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); }, - sortType: function(v) { - return v.Latitude; // When sorting, order by latitude + // 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.field.VTypes, { + IPAddress: function(v) { + return /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(v); }, - 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 } -]); - + IPAddressText: 'Must be a numeric IP address', + IPAddressMask: /[\d\.]/i +}); + * * @singleton */ -Ext.data.Types = new function(){ - var st = Ext.data.SortTypes; - Ext.apply(this, { +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', + /** - * @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. + * 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. */ - stripRe: /[\$,%]/g, - + 'email' : function(v){ + return email.test(v); + }, /** - * @type Object. - * @property AUTO - * This data type means that no conversion is applied to the raw data before it is placed into a Record. + * 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 */ - AUTO: { - convert: function(v){ return v; }, - sortType: st.none, - type: 'auto' - }, - + 'emailText' : 'This field should be an e-mail address in the format "user@example.com"', /** - * @type Object. - * @property STRING - * This data type means that the raw data is converted into a String before it is placed into a Record. + * 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 */ - STRING: { - convert: function(v){ return (v === undefined || v === null) ? '' : String(v); }, - sortType: st.asUCString, - type: 'string' - }, + 'emailMask' : /[a-z0-9_\.\-@\+]/i, /** - * @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. + * The function used to validate URLs + * @param {String} value The URL + * @return {Boolean} true if the RegExp test passed, and false if not. */ - 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' + 'url' : function(v){ + return url.test(v); }, - /** - * @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. + * 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 */ - 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' - }, - + 'urlText' : 'This field should be a URL in the format "http:/'+'/www.example.com"', + /** - * @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. + * The function used to validate alpha values + * @param {String} value The value + * @return {Boolean} true if the RegExp test passed, and false if not. */ - BOOL: { - convert: function(v){ return v === true || v === 'true' || v == 1; }, - sortType: st.none, - type: 'bool' + 'alpha' : function(v){ + return alpha.test(v); }, - /** - * @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. + * The error text to display when the alpha validation function returns false. Defaults to: + * 'This field should only contain letters and _' + * @type String */ - 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, { + 'alphaText' : 'This field should only contain letters and _', /** - * @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. + * The keystroke filter mask to be applied on alpha input. Defaults to: + * /[a-z_]/i + * @type RegExp */ - BOOLEAN: this.BOOL, + 'alphaMask' : /[a-z_]/i, + /** - * @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. + * The function used to validate alphanumeric values + * @param {String} value The value + * @return {Boolean} true if the RegExp test passed, and false if not. */ - INTEGER: this.INT, + 'alphanum' : function(v){ + return alphanum.test(v); + }, /** - * @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. + * The error text to display when the alphanumeric validation function returns false. Defaults to: + * 'This field should only contain letters, numbers and _' + * @type String */ - 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. + '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.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); - }, +Ext.define('Ext.layout.component.field.Text', { + extend: 'Ext.layout.component.field.Field', + alias: 'layout.textfield', + requires: ['Ext.util.TextMetrics'], + + type: 'textfield', + /** - * 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. + * Allow layout to proceed if the {@link Ext.form.field.Text#grow} config is enabled and the value has + * changed since the last layout. */ - 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; - } + 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); }, + + /** - * Implements abstract Ext.data.DataWriter#createRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Object} + * 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 */ - createRecord : function(rec) { - return this.toHash(rec); + sizeBodyContents: function(width, height) { + var size = this.adjustForGrow(width, height); + this.setElementSize(this.owner.inputEl, size[0], size[1]); }, - /** - * Implements abstract Ext.data.DataWriter#updateRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Object} - */ - updateRecord : function(rec) { - return this.toHash(rec); - }, + /** - * Implements abstract Ext.data.DataWriter#destroyRecord - * @protected - * @param {Ext.data.Record} rec - * @return {Object} + * Given the target bodyEl dimensions, adjust them if necessary to return the correct final + * size based on the text field's {@link Ext.form.field.Text#grow grow config}. + * @param {Number} width The bodyEl width + * @param {Number} height The bodyEl height + * @return {Array} [inputElWidth, inputElHeight] */ - destroyRecord : function(rec){ - if(this.encodeDelete){ - var data = {}; - data[this.meta.idProperty] = rec.id; - return data; - }else{ - return rec.id; + adjustForGrow: function(width, height) { + var me = this, + owner = me.owner, + inputEl, value, calcWidth, + result = [width, height]; + + if (owner.grow) { + inputEl = owner.inputEl; + + // Find the width that contains the whole text value + value = (inputEl.dom.value || (owner.hasFocus ? '' : owner.emptyText) || '') + owner.growAppend; + calcWidth = inputEl.getTextWidth(value) + inputEl.getBorderWidth("lr") + inputEl.getPadding("lr"); + + // Constrain + result[0] = Ext.Number.constrain(calcWidth, owner.growMin, + Math.max(owner.growMin, Math.min(owner.growMax, Ext.isNumber(width) ? width : Infinity))); } + + return result; } -});/** - * @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 || {}; - /** - * @cfg {String} idProperty [id] Name of the property within a row object - * that contains a record identifier value. Defaults to id - */ - /** - * @cfg {String} successProperty [success] Name of the property from which to - * retrieve the success attribute. Defaults to success. See - * {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception} - * for additional information. - */ - /** - * @cfg {String} totalProperty [total] Name of the property from which to - * retrieve the total number of records in the dataset. This is only needed - * if the whole dataset is not passed in one go, but is being paged from - * the remote server. Defaults to total. - */ + +/** + * @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', + + /** - * @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. + * 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] */ - Ext.applyIf(meta, { - idProperty: 'id', - successProperty: 'success', - totalProperty: 'total' - }); + adjustForGrow: function(width, height) { + var me = this, + owner = me.owner, + inputEl, value, max, + curWidth, curHeight, calcHeight, + result = [width, height]; + + if (owner.grow) { + inputEl = owner.inputEl; + curWidth = inputEl.getWidth(true); //subtract border/padding to get the available width for the text + curHeight = inputEl.getHeight(); + + // Get and normalize the field value for measurement + value = inputEl.dom.value || ' '; + value += owner.growAppend; + + // Translate newlines to tags + value = value.replace(/\n/g, ' '); + + // Find the height that contains the whole text value + calcHeight = Ext.util.TextMetrics.measure(inputEl, value, curWidth).height + + inputEl.getBorderWidth("tb") + inputEl.getPadding("tb"); + + // Constrain + max = owner.growMax; + if (Ext.isNumber(height)) { + max = Math.min(max, height); + } + result[1] = Ext.Number.constrain(calcHeight, owner.growMin, max); + } + + return result; + } + +}); +/** + * @class Ext.layout.container.Anchor + * @extends Ext.layout.container.Container + * + * This is a layout that enables anchoring of contained elements relative to the container's dimensions. + * If the container is resized, all anchored items are automatically rerendered according to their + * {@link #anchor} rules. + * + * This class is intended to be extended or created via the layout: 'anchor' {@link Ext.layout.container.AbstractContainer#layout} + * config, and should generally not need to be created directly via the new keyword. + * + * AnchorLayout does not have any direct config options (other than inherited ones). By default, + * AnchorLayout will calculate anchor measurements based on the size of the container itself. However, the + * container using the AnchorLayout can supply an anchoring-specific config property of anchorSize. + * If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating + * anchor measurements based on it instead, allowing the container to be sized independently of the anchoring + * logic if necessary. + * + * {@img Ext.layout.container.Anchor/Ext.layout.container.Anchor.png Ext.layout.container.Anchor container layout} + * + * For example: + * Ext.create('Ext.Panel', { + * width: 500, + * height: 400, + * title: "AnchorLayout Panel", + * layout: 'anchor', + * renderTo: Ext.getBody(), + * items: [{ + * xtype: 'panel', + * title: '75% Width and 20% Height', + * anchor: '75% 20%' + * },{ + * xtype: 'panel', + * title: 'Offset -300 Width & -200 Height', + * anchor: '-300 -200' + * },{ + * xtype: 'panel', + * title: 'Mixed Offset and Percent', + * anchor: '-250 20%' + * }] + * }); + */ + +Ext.define('Ext.layout.container.Anchor', { + + /* Begin Definitions */ + + alias: 'layout.anchor', + extend: 'Ext.layout.container.Container', + alternateClassName: 'Ext.layout.AnchorLayout', + + /* End Definitions */ - 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} 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%' + * + * + * + * */ + + type: 'anchor', + /** - * This method is only used by a DataProxy which has retrieved data from a remote server. - * @param {Object} response The XHR object which contains the JSON data in its responseText. - * @return {Object} data A data block which is used by an Ext.data.Store object as - * a cache of Ext.data.Records. + * @cfg {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%'. + * */ - read : function(response){ - var json = response.responseText; - var o = Ext.decode(json); - if(!o) { - throw {message: 'JsonReader.read: Json object not found'}; + defaultAnchor: '100%', + + parseAnchorRE: /^(r|right|b|bottom)$/i, + + // private + onLayout: function() { + this.callParent(arguments); + + var me = this, + size = me.getLayoutTargetSize(), + owner = me.owner, + target = me.getTarget(), + ownerWidth = size.width, + ownerHeight = size.height, + overflow = target.getStyle('overflow'), + components = me.getVisibleItems(owner), + len = components.length, + boxes = [], + box, newTargetSize, anchorWidth, anchorHeight, component, anchorSpec, calcWidth, calcHeight, + anchorsArray, anchor, i, el, cleaner; + + if (ownerWidth < 20 && ownerHeight < 20) { + return; } - return this.readRecords(o); - }, - /* - * TODO: refactor code between JsonReader#readRecords, #readResponse into 1 method. - * there's ugly duplication going on due to maintaining backwards compat. with 2.0. It's time to do this. - */ - /** - * Decode a JSON response from server. - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Object} response The XHR object returned through an Ajax server request. - * @return {Response} A {@link Ext.data.Response Response} object containing the data response, and also status information. - */ - readResponse : function(action, response) { - var o = (response.responseText !== undefined) ? Ext.decode(response.responseText) : response; - if(!o) { - throw new Ext.data.JsonReader.Error('response'); + // 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' + }); } - 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); + // find the container anchoring size + if (owner.anchorSize) { + if (typeof owner.anchorSize == 'number') { + anchorWidth = owner.anchorSize; } - else if (!def) { - throw new Ext.data.JsonReader.Error('root-undefined-response', this.meta.root); + else { + anchorWidth = owner.anchorSize.width; + anchorHeight = owner.anchorSize.height; } } + else { + anchorWidth = owner.initialConfig.width; + anchorHeight = owner.initialConfig.height; + } - // 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 - }); + // Work around WebKit RightMargin bug. We're going to inline-block all the children only ONCE and remove it when we're done + if (!Ext.supports.RightMargin) { + cleaner = Ext.core.Element.getRightMarginFixCleaner(target); + target.addCls(Ext.baseCSSPrefix + 'inline-children'); + } + + 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; - // blow up if no successProperty - if (Ext.isEmpty(res.success)) { - throw new Ext.data.JsonReader.Error('successProperty-response', this.meta.successProperty); + boxes.push({ + component: component, + anchor: true, + width: calcWidth || undefined, + height: calcHeight || undefined + }); + } else { + boxes.push({ + component: component, + anchor: false + }); + } } - return res; - }, - /** - * Create a data block containing Ext.data.Records from a JSON object. - * @param {Object} o An object which contains an Array of row objects in the property specified - * in the config as 'root, and optionally a property, specified in the config as 'totalProperty' - * which contains the total size of the dataset. - * @return {Object} data A data block which is used by an Ext.data.Store object as - * a cache of Ext.data.Records. - */ - 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); + // Work around WebKit RightMargin bug. We're going to inline-block all the children only ONCE and remove it when we're done + if (!Ext.supports.RightMargin) { + target.removeCls(Ext.baseCSSPrefix + 'inline-children'); + cleaner(); } - var s = this.meta, Record = this.recordType, - f = Record.prototype.fields, fi = f.items, fl = f.length, v; - 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; - } + for (i = 0; i < len; i++) { + box = boxes[i]; + me.setItemSize(box.component, box.width, box.height); } - if(s.successProperty){ - v = this.getSuccess(o); - if(v === false || v === 'false'){ - success = false; + + if (overflow && overflow != 'hidden' && !me.adjustmentPass) { + newTargetSize = me.getLayoutTargetSize(); + if (newTargetSize.width != size.width || newTargetSize.height != size.height) { + me.adjustmentPass = true; + me.onLayout(); } } - // 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 - }; + delete me.adjustmentPass; }, // private - buildExtractors : function() { - if(this.ef){ - return; + 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; + }; + } + } } - var s = this.meta, Record = this.recordType, - f = Record.prototype.fields, fi = f.items, fl = f.length; + return null; + }, - 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; + // private + adjustWidthAnchor: function(value, comp) { + return value; }, - /** - * @ignore - * TODO This isn't used anywhere?? Don't we want to use this where possible instead of complex #createAccessor? - */ - simpleAccess : function(obj, subsc) { - return obj[subsc]; + // private + adjustHeightAnchor: function(value, comp) { + return value; + } + +}); +/** + * @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', /** - * @ignore + * @private */ - 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); + run: function() { + Ext.Ajax.request(Ext.apply( + this.createCallback(), + { + method: this.getMethod(), + url: this.getUrl(), + headers: this.headers, + params: this.getParams() } - return function(obj){ - return obj[expr]; - }; + )); + }, - }; - }(), + /** + * @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); + }, /** - * type-casts a single row of raw-data from server - * @param {Object} data - * @param {Array} items - * @param {Integer} len * @private */ - extractValues : function(data, items, len) { - var f, values = {}; - for(var j = 0; j < len; j++){ - f = items[j]; - var v = this.ef[j](data); - values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue, data); + 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 values; + return Ext.decode(response.responseText); } }); + /** - * @class Ext.data.JsonReader.Error - * Error class for JsonReader - */ -Ext.data.JsonReader.Error = Ext.extend(Ext.Error, { - constructor : function(message, arg) { - this.arg = arg; - Ext.Error.call(this, message); - }, - name : 'Ext.data.JsonReader' -}); -Ext.apply(Ext.data.JsonReader.Error.prototype, { - lang: { - 'response': 'An error occurred while json-decoding your server response', - 'successProperty-response': 'Could not locate your "successProperty" in your server response. Please review your JsonReader config to ensure the config-property "successProperty" matches the property in your server-response. See the JsonReader docs.', - 'root-undefined-config': 'Your JsonReader was configured without a "root" property. Please review your JsonReader config and make sure to define the root property. See the JsonReader docs.', - 'idProperty-undefined' : 'Your JsonReader was configured without an "idProperty" Please review your JsonReader configuration and ensure the "idProperty" is set (e.g.: "id"). See the JsonReader docs.', - 'root-empty': 'Data was expected to be returned by the server in the "root" property of the response. Please review your JsonReader configuration to ensure the "root" property matches that returned in the server-response. See JsonReader docs.' + * @class Ext.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 } -}); -/** - * @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'] ] - * +}).show(); + * @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}. + * @param {Object} config The config object + * @xtype window */ -Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, { +Ext.define('Ext.window.Window', { + extend: 'Ext.panel.Panel', + + alternateClassName: 'Ext.Window', + + requires: ['Ext.util.ComponentDragger', 'Ext.util.Region', 'Ext.EventManager'], + + alias: 'widget.window', + /** - * @cfg {String} successProperty - * @hide + * @cfg {Number} x + * The X position of the left edge of the window on initial showing. Defaults to centering the Window within + * the width of the Window's container {@link Ext.core.Element Element) (The Element that the Window is rendered to). + */ + /** + * @cfg {Number} 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 {Number} id (optional) The subscript within row Array that provides an ID for the Record. - * Deprecated. Use {@link #idIndex} instead. + * @cfg {Boolean} modal + * True to make the window modal and mask everything behind it when displayed, false to display it without + * restricting access to other UI elements (defaults to false). */ /** - * @cfg {Number} idIndex (optional) The subscript within row Array that provides an ID for the Record. + * @cfg {String/Element} animateTarget + * Id or element from which the window should animate while opening (defaults to null with no animation). */ /** - * 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. + * @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). */ - 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; - - var root = this.getRoot(o); - - 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; - } - var totalRecords = records.length; + /** + * @cfg {String} baseCls + * The base CSS class to apply to this panel's element (defaults to 'x-window'). + */ + baseCls: Ext.baseCSSPrefix + 'window', - 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; - } - } + /** + * @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 + */ + resizable: true, - 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 + * @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);). */ - constructor: function(config){ - Ext.data.ArrayStore.superclass.constructor.call(this, Ext.apply(config, { - reader: new Ext.data.ArrayReader(config) - })); - }, + draggable: true, - loadData : function(data, append){ - if(this.expandData === true){ - var r = []; - for(var i = 0, len = data.length; i < len; i++){ - r[r.length] = [data[i]]; - } - data = r; - } - Ext.data.ArrayStore.superclass.loadData.call(this, data, append); - } -}); -Ext.reg('arraystore', Ext.data.ArrayStore); + /** + * @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, -// 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 + * @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}. */ - constructor: function(config){ - Ext.data.JsonStore.superclass.constructor.call(this, Ext.apply(config, { - reader: new Ext.data.JsonReader(config) - })); - } -}); -Ext.reg('jsonstore', Ext.data.JsonStore);/** - * @class Ext.data.XmlWriter - * @extends Ext.data.DataWriter - * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action via XML. - * XmlWriter uses an instance of {@link Ext.XTemplate} for maximum flexibility in defining your own custom XML schema if the default schema is not appropriate for your needs. - * See the {@link #tpl} configuration-property. - */ -Ext.data.XmlWriter = function(params) { - Ext.data.XmlWriter.superclass.constructor.apply(this, arguments); - // compile the XTemplate for rendering XML documents. - this.tpl = (typeof(this.tpl) === 'string') ? new Ext.XTemplate(this.tpl).compile() : this.tpl.compile(); -}; -Ext.extend(Ext.data.XmlWriter, Ext.data.DataWriter, { + constrainHeader: false, + /** - * @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. + * @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). */ - documentRoot: 'xrequest', + plain: false, + /** - * @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 {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. */ - forceDocumentRoot: false, + minimizable: 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 {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. */ - root: 'records', + maximizable: false, + + // inherit docs + minHeight: 100, + + // inherit docs + minWidth: 200, + /** - * @cfg {String} xmlVersion [1.0] The version written to header of xml documents. -<?xml version="1.0" encoding="ISO-8859-15"?> + * @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). */ - xmlVersion : '1.0', + expandOnShow: true, + + // inherited docs, same default + collapsible: 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} 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'. */ - xmlEncoding: 'ISO-8859-15', + closable: 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} hidden + * Render this Window hidden (default is true). If true, the + * {@link #hide} method will be called internally. */ - // 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}<{root}><{parent.record}><{name}>{value}', + 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 + initComponent: function() { + var me = this; + me.callParent(); + me.addEvents( + /** + * @event activate + * Fires after the window has been visually activated via {@link #setActive}. + * @param {Ext.window.Window} this + */ + /** + * @event deactivate + * Fires after the window has been visually deactivated via {@link #setActive}. + * @param {Ext.window.Window} this + */ + /** + * @event resize + * Fires after the window has been resized. + * @param {Ext.window.Window} this + * @param {Number} width The window's new width + * @param {Number} height The window's new height + */ + 'resize', + /** + * @event maximize + * Fires after the window has been maximized. + * @param {Ext.window.Window} this + */ + 'maximize', + /** + * @event minimize + * Fires after the window has been minimized. + * @param {Ext.window.Window} this + */ + 'minimize', + /** + * @event restore + * Fires after the window has been restored to its original size after being maximized. + * @param {Ext.window.Window} this + */ + 'restore' + ); + + if (me.plain) { + me.addClsWithUI('plain'); + } + + if (me.modal) { + me.ariaRole = 'dialog'; + } + }, + // State Management + // private - /** - * 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. - */ - 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] + 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(); }, - /** - * 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}. - */ - createRecord : function(rec) { - return this.toArray(this.toHash(rec)); + 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; }, - /** - * 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}. - */ - updateRecord : function(rec) { - return this.toArray(this.toHash(rec)); + 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] + }); + } + } }, - /** - * 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}. - */ - 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 || {}; - // backwards compat, convert idPath or id / success - Ext.applyIf(meta, { - idProperty: meta.idProperty || meta.idPath || meta.id, - successProperty: meta.successProperty || meta.success - }); + // private + onMouseDown: function () { + if (this.floating) { + this.toFront(); + } + }, - 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. - */ - read : function(response){ - var doc = response.responseXML; - if(!doc) { - throw {message: "XmlReader.read: XML Document not available"}; + // 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 + } + }); } - return this.readRecords(doc); }, - /** - * 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. - */ - readRecords : function(doc){ - /** - * After any data loads/reads, the raw XML Document is available for further custom processing. - * @type XMLDocument - */ - this.xmlData = doc; + // private + afterRender: function() { + var me = this, + hidden = me.hidden, + keyMap; - var root = doc.documentElement || doc, - q = Ext.DomQuery, - totalRecords = 0, - success = true; + me.hidden = false; + // Component's afterRender sizes and positions the Component + me.callParent(); + me.hidden = hidden; - if(this.meta.totalProperty){ - totalRecords = this.getTotal(root, 0); - } - if(this.meta.successProperty){ - success = this.getSuccess(root); + // Create the proxy after the size has been applied in Component.afterRender + me.proxy = me.getProxy(); + + // clickToRaise + me.mon(me.el, 'mousedown', me.onMouseDown, me); + + // Initialize + if (me.maximized) { + me.maximized = false; + me.maximize(); } - var records = this.extractData(q.select(this.meta.record, root), true); // <-- true to return Ext.data.Record[] + if (me.closable) { + keyMap = me.getKeyMap(); + keyMap.on(27, me.onEsc, me); - // TODO return Ext.data.Response instance. @see #readResponse - return { - success : success, - records : records, - totalRecords : totalRecords || records.length - }; + //if (hidden) { ? would be consistent w/before/afterShow... + keyMap.disable(); + //} + } + + if (!hidden) { + me.syncMonitorWindowResize(); + me.doConstrain(); + } }, /** - * 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 + * @override + * Override Component.initDraggable. + * Window uses the header element as the delegate. */ - readResponse : function(action, response) { - var q = Ext.DomQuery, - doc = response.responseXML, - root = doc.documentElement || doc; - - // 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 - }); + initDraggable: function() { + var me = this, + ddConfig; - if (Ext.isEmpty(res.success)) { - throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty); + if (!me.header) { + me.updateHeader(true); } + + /* + * Check the header here again. If for whatever reason it wasn't created in + * updateHeader (preventHeader) then we'll just ignore the rest since the + * header acts as the drag handle. + */ + if (me.header) { + ddConfig = Ext.applyIf({ + el: me.el, + delegate: '#' + me.header.id + }, me.draggable); - // 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); + // 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']); } - return res; }, - getSuccess : function() { - return true; + // private + onEsc: function(k, e) { + e.stopEvent(); + this[this.closeAction](); + }, + + // private + beforeDestroy: function() { + var me = this; + if (me.rendered) { + delete this.animateTarget; + me.hide(); + Ext.destroy( + me.keyMap + ); + } + me.callParent(); }, /** - * build response-data extractor functions. * @private - * @ignore + * @override + * Contribute class-specific tools to the header. + * Called by Panel's initTools. */ - buildExtractors : function() { - if(this.ef){ - return; - } - var s = this.meta, - Record = this.recordType, - f = Record.prototype.fields, - fi = f.items, - fl = f.length; + addTools: function() { + var me = this; - 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]; - }; - if (s.idPath || s.idProperty) { - var g = this.createAccessor(s.idPath || s.idProperty); - this.getId = function(rec) { - var id = g(rec) || rec.id; - return (id === undefined || id === '') ? null : id; - }; - } else { - this.getId = function(){return null;}; + // Call Panel's initTools + me.callParent(); + + if (me.minimizable) { + me.addTool({ + type: 'minimize', + handler: Ext.Function.bind(me.minimize, me, []) + }); } - var ef = []; - for(var i = 0; i < fl; i++){ - f = fi[i]; - var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name; - ef.push(this.createAccessor(map)); + if (me.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 + }); } - this.ef = ef; }, /** - * Creates a function to return some particular key of data from a response. - * @param {String} key - * @return {Function} - * @private - * @ignore + * Gets the configured default focus item. If a {@link #defaultFocus} is set, it will receive focus, otherwise the + * Container itself will receive focus. */ - 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; - } - }; - }(), + getFocusEl: function() { + var me = this, + f = me.focusEl, + defaultComp = me.defaultButton || me.defaultFocus, + t = typeof db, + el, + ct; - /** - * 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 - */ - 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); + 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 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' - ] -}); - * - * 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 - */ -Ext.data.XmlStore = Ext.extend(Ext.data.Store, { - /** - * @cfg {Ext.data.DataReader} reader @hide - */ - 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, { + return f || me.focusEl; + }, - //inherit docs - constructor: function(config) { - config = config || {}; + // private + beforeShow: function() { + this.callParent(); - //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 - }); + if (this.expandOnShow) { + this.expand(false); } + }, + + // private + afterShow: function(animateTarget) { + var me = this; - //add the sorting sorter object if it is present - if (sortInfo) { - sorters.push(sortInfo); + // Perform superclass's afterShow tasks + // Which might include animating a proxy from an animTarget + me.callParent(arguments); + + if (me.maximized) { + me.fitContainer(); } - Ext.data.GroupingStore.superclass.constructor.call(this, config); + me.syncMonitorWindowResize(); + me.doConstrain(); - 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' - ); + if (me.keyMap) { + me.keyMap.enable(); + } + }, + + // private + doClose: function() { + var me = this; - this.applyGroupField(); + // immediate close + if (me.hidden) { + me.fireEvent('close', me); + me[me.closeAction](); + } else { + // close after hiding + me.hide(me.animTarget, me.doClose, me); + } }, - /** - * @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). - */ - groupOnSort:false, + // private + afterHide: function() { + var me = this; - groupDir : 'ASC', + // No longer subscribe to resizing now that we're hidden + me.syncMonitorWindowResize(); - /** - * Clears any existing grouping and refreshes the data using the default sort. - */ - clearGrouping : function(){ - this.groupField = false; + // Turn off keyboard handling once window is hidden + if (me.keyMap) { + me.keyMap.disable(); + } - 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; - } + // Perform superclass's afterHide tasks. + me.callParent(arguments); + }, - this.reload(); - }else{ - this.sort(); - this.fireEvent('datachanged', this); + // private + onWindowResize: function() { + if (this.maximized) { + this.fitContainer(); } + this.doConstrain(); }, /** - * 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) + * 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 */ - groupBy : function(field, forceRegroup, direction) { - direction = direction ? (String(direction).toUpperCase() == 'DESC' ? 'DESC' : 'ASC') : this.groupDir; + minimize: function() { + this.fireEvent('minimize', this); + return this; + }, - if (this.groupField == field && this.groupDir == direction && !forceRegroup) { - return; // already grouped by this field - } + afterCollapse: function() { + var me = this; - //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(); + if (me.maximizable) { + me.tools.maximize.hide(); + me.tools.restore.hide(); } + if (me.resizer) { + me.resizer.disable(); + } + me.callParent(arguments); + }, - this.groupField = field; - this.groupDir = direction; - this.applyGroupField(); - - var fireGroupEvent = function() { - this.fireEvent('groupchange', this, this.getGroupState()); - }; + afterExpand: function() { + var me = this; - if (this.groupOnSort) { - this.sort(field, direction); - fireGroupEvent.call(this); - return; + if (me.maximized) { + me.tools.restore.show(); + } else if (me.maximizable) { + me.tools.maximize.show(); } - - if (this.remoteGroup) { - this.on('load', fireGroupEvent, this, {single: true}); - this.reload(); - } else { - this.sort(sorters); - fireGroupEvent.call(this); + if (me.resizer) { + me.resizer.enable(); } + me.callParent(arguments); }, - //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); - } - - var sorters = []; + /** + * Fits the window within its current container and automatically replaces + * the {@link #maximizable 'maximize' tool button} with the 'restore' tool button. + * Also see {@link #toggleMaximize}. + * @return {Ext.window.Window} this + */ + maximize: function() { + var me = this; - //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; - } + 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(); - this.sortToggle[name] = dir; - this.sortInfo = {field: name, direction: dir}; - - sorters = [this.sortInfo]; - } + 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'); - //add the grouping sorter object as the first multisort sorter - if (this.groupField) { - sorters.unshift({direction: this.groupDir, field: this.groupField}); + me.syncMonitorWindowResize(); + me.setPosition(0, 0); + me.fitContainer(); + me.fireEvent('maximize', me); } - - return this.multiSort.call(this, sorters, dir); + return me; }, /** - * @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 + * 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 */ - applyGroupField: function(){ - if (this.remoteGroup) { - if(!this.baseParams){ - this.baseParams = {}; + 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(); } - Ext.apply(this.baseParams, { - groupBy : this.groupField, - groupDir: this.groupDir - }); + // Restore the position/sizing + me.setPosition(me.restorePos); + me.setSize(me.restoreSize); + + // Unset old position/sizing + delete me.restorePos; + delete me.restoreSize; - var lo = this.lastOptions; - if (lo && lo.params) { - lo.params.groupDir = this.groupDir; + me.maximized = false; - //this is deleted because of a bug reported at http://www.extjs.com/forum/showthread.php?t=82907 - delete lo.params.groupBy; + 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.syncMonitorWindowResize(); + me.doConstrain(); + me.fireEvent('restore', me); } + return me; }, /** + * Synchronizes the presence of our listener for window resize events. This method + * should be called whenever this status might change. * @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); + syncMonitorWindowResize: function () { + var me = this, + currentlyMonitoring = me._monitoringResize, + // all the states where we should be listening to window resize: + yes = me.monitorResize || me.constrain || me.constrainHeader || me.maximized, + // all the states where we veto this: + veto = me.hidden || me.destroying || me.isDestroyed; + + if (yes && !veto) { + // we should be listening... + if (!currentlyMonitoring) { + // but we aren't, so set it up + Ext.EventManager.onWindowResize(me.onWindowResize, me); + me._monitoringResize = true; } - return false; + } else if (currentlyMonitoring) { + // we should not be listening, but we are, so tear it down + Ext.EventManager.removeResizeListener(me.onWindowResize, me); + me._monitoringResize = false; } }, /** - * @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 + * 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 */ - getGroupState : function(){ - return this.groupOnSort && this.groupField !== false ? - (this.sortInfo ? this.sortInfo.field : undefined) : this.groupField; + toggleMaximize: function() { + return this[this.maximized ? 'restore': 'maximize'](); } + + /** + * @cfg {Boolean} autoWidth @hide + * Absolute positioned element and therefore cannot support autoWidth. + * A width is a required configuration. + **/ }); -Ext.reg('groupingstore', Ext.data.GroupingStore); /** - * @class Ext.data.DirectProxy - * @extends Ext.data.DataProxy + * @class Ext.form.field.Base + * @extends Ext.Component + +Base class for form fields that provides default event handling, rendering, and other common functionality +needed by all form field types. Utilizes the {@link Ext.form.field.Field} mixin for value handling and validation, +and the {@link Ext.form.Labelable} mixin to provide label and error message display. + +In most cases you will want to use a subclass, such as {@link Ext.form.field.Text} or {@link Ext.form.field.Checkbox}, +rather than creating instances of this class directly. However if you are implementing a custom form field, +using this as the parent class is recommended. + +__Values and Conversions__ + +Because BaseField implements the Field mixin, it has a main value that can be initialized with the +{@link #value} config and manipulated via the {@link #getValue} and {@link #setValue} methods. This main +value can be one of many data types appropriate to the current field, for instance a {@link Ext.form.field.Date Date} +field would use a JavaScript Date object as its value type. However, because the field is rendered as a HTML +input, this value data type can not always be directly used in the rendered field. + +Therefore BaseField introduces the concept of a "raw value". This is the value of the rendered HTML input field, +and is normally a String. The {@link #getRawValue} and {@link #setRawValue} methods can be used to directly +work with the raw value, though it is recommended to use getValue and setValue in most cases. + +Conversion back and forth between the main value and the raw value is handled by the {@link #valueToRaw} and +{@link #rawToValue} methods. If you are implementing a subclass that uses a non-String value data type, you +should override these methods to handle the conversion. + +__Rendering__ + +The content of the field body is defined by the {@link #fieldSubTpl} XTemplate, with its argument data +created by the {@link #getSubTplData} method. Override this template and/or method to create custom +field renderings. +{@img Ext.form.BaseField/Ext.form.BaseField.png Ext.form.BaseField BaseField component} +__Example usage:__ + + // A simple subclass of BaseField that creates a HTML5 search field. Redirects to the + // searchUrl when the Enter key is pressed. + Ext.define('Ext.form.SearchField', { + extend: 'Ext.form.field.Base', + alias: 'widget.searchfield', + + inputType: 'search', + + // Config defining the search URL + searchUrl: 'http://www.google.com/search?q={0}', + + // Add specialkey listener + initComponent: function() { + this.callParent(); + this.on('specialkey', this.checkEnterKey, this); + }, + + // Handle enter key presses, execute the search if the field has a value + checkEnterKey: function(field, e) { + var value = this.getValue(); + if (e.getKey() === e.ENTER && !Ext.isEmpty(value)) { + location.href = Ext.String.format(this.searchUrl, value); + } + } + }); + + Ext.create('Ext.form.Panel', { + title: 'BaseField Example', + bodyPadding: 5, + width: 250, + + // Fields will be arranged vertically, stretched to full width + layout: 'anchor', + defaults: { + anchor: '100%' + }, + items: [{ + xtype: 'searchfield', + fieldLabel: 'Search', + name: 'query' + }] + renderTo: Ext.getBody() + }); + + * @constructor + * Creates a new Field + * @param {Object} config Configuration options + * + * @xtype field + * @markdown + * @docauthor Jason Johnston */ -Ext.data.DirectProxy = function(config){ - Ext.apply(this, config); - if(typeof this.paramOrder == 'string'){ - this.paramOrder = this.paramOrder.split(/[\s,|]/); - } - Ext.data.DirectProxy.superclass.constructor.call(this, config); -}; +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 + } + ], -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 {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. */ - paramOrder: undefined, /** - * @cfg {Boolean} paramsAsHash - * Send parameters as a collection of named arguments (defaults to true). Providing a - * {@link #paramOrder} nullifies this configuration. + * @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'. */ - paramsAsHash: true, + inputType: 'text', /** - * @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 {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). */ - directFn : undefined, /** - * 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 {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') */ - doRequest : function(action, rs, params, reader, callback, scope, options) { - var args = [], - directFn = this.api[action] || this.directFn; + invalidText : 'The value in this field is invalid', - 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 {String} fieldCls The default CSS class for the field input (defaults to 'x-form-field') + */ + fieldCls : Ext.baseCSSPrefix + 'form-field', - var trans = { - params : params || {}, - request: { - callback : callback, - scope : scope, - arg : options - }, - reader: reader - }; + /** + * @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. + */ - args.push(this.createCallback(action, rs, trans), this); - directFn.apply(window, args); - }, + /** + * @cfg {String} focusCls The CSS class to use when the field receives focus (defaults to 'x-form-focus') + */ + focusCls : Ext.baseCSSPrefix + 'form-focus', - // 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 {String} dirtyCls The CSS class to use when the field value {@link #isDirty is dirty}. + */ + dirtyCls : Ext.baseCSSPrefix + 'form-dirty', /** - * 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 {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. */ - 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); + checkChangeEvents: Ext.isIE && (!document.documentMode || document.documentMode < 9) ? + ['change', 'propertychange'] : + ['change', 'input', 'textInput', 'keyup', 'dragdrop'], - 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 {Number} checkChangeBuffer + * Defines a timeout in milliseconds for buffering {@link #checkChangeEvents} that fire in rapid succession. + * Defaults to 50 milliseconds. */ - 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"} + checkChangeBuffer: 50, + + componentLayout: 'field', -// 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} 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, /** - * 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 {String} readOnlyCls The CSS class applied to the component's main element when it is {@link #readOnly}. */ - exceptions: { - TRANSPORT: 'xhr', - PARSE: 'parse', - LOGIN: 'login', - SERVER: 'exception' - }, + 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 + hasFocus : false, + + baseCls: Ext.baseCSSPrefix + 'field', + + maskOnDisable: false, // private - constructor: function(){ - this.addEvents( + initComponent : function() { + var me = this; + + me.callParent(); + + me.subTplData = me.subTplData || {}; + + 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 focus + * Fires when this field receives input focus. + * @param {Ext.form.field.Base} this */ - 'event', + 'focus', /** - * @event exception - * Fires after an event exception. - * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred. + * @event blur + * Fires when this field loses input focus. + * @param {Ext.form.field.Base} this */ - 'exception' + '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' ); - this.transactions = {}; - this.providers = {}; + + // Init mixins + me.initLabelable(); + me.initField(); + + // Default name to inputId + if (!me.name) { + me.name = me.getInputId(); + } }, /** - * 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' -}); + * 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()); + }, -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' + /** + * @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) + }); }, - 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. + + /** + * @protected + * Gets the markup to be inserted into the outer template's bodyEl. For fields this is the + * actual input element. */ - addProvider : function(provider){ - var a = arguments; - if(a.length > 1){ - for(var i = 0, len = a.length; i < len; i++){ - this.addProvider(a[i]); - } - return; + getSubTplMarkup: function() { + return this.getTpl('fieldSubTpl').apply(this.getSubTplData()); + }, + + initRenderTpl: function() { + var me = this; + if (!me.hasOwnProperty('renderTpl')) { + me.renderTpl = me.getTpl('labelableRenderTpl'); } + return me.callParent(); + }, - // if provider has not already been instantiated - if(!provider.events){ - provider = new Ext.Direct.PROVIDERS[provider.type](provider); + initRenderData: function() { + return Ext.applyIf(this.callParent(), this.getLabelableRenderData()); + }, + + /** + * 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); } - provider.id = provider.id || Ext.id(); - this.providers[provider.id] = provider; + me.fieldStyle = style; + }, - provider.on('data', this.onProviderData, this); - provider.on('exception', this.onProviderException, this); + // private + onRender : function() { + var me = this, + fieldStyle = me.fieldStyle, + renderSelectors = me.renderSelectors; + Ext.applyIf(renderSelectors, me.getLabelableSelectors()); - if(!provider.isConnected()){ - provider.connect(); + Ext.applyIf(renderSelectors, { + /** + * @property inputEl + * @type Ext.core.Element + * The input Element for this Field. Only available after the field has been rendered. + */ + inputEl: '.' + me.fieldCls + }); + + me.callParent(arguments); + + // Make the stored rawValue get set as the input element's value + me.setRawValue(me.rawValue); + + if (me.readOnly) { + me.setReadOnly(true); + } + if (me.disabled) { + me.disable(); + } + if (fieldStyle) { + me.setFieldStyle(fieldStyle); } - return provider; + me.renderActiveError(); }, - /** - * Retrieve a {@link Ext.direct.Provider provider} by the - * {@link Ext.direct.Provider#id id} specified when the provider is - * {@link #addProvider added}. - * @param {String} id Unique identifier assigned to the provider when calling {@link #addProvider} - */ - getProvider : function(id){ - return this.providers[id]; - }, + initAria: function() { + var me = this; + me.callParent(); - 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; + // Associate the field to the error message element + me.getActionEl().dom.setAttribute('aria-describedby', Ext.id(me.errorEl)); }, - addTransaction: function(t){ - this.transactions[t.tid] = t; - return t; + getFocusEl: function() { + return this.inputEl; }, - removeTransaction: function(t){ - delete this.transactions[t.tid || t]; - return t; + isFileUpload: function() { + return this.inputType === 'file'; }, - getTransaction: function(tid){ - return this.transactions[tid.tid || tid]; + extractFileInput: function() { + var me = this, + fileInput = me.isFileUpload() ? me.inputEl.dom : null, + clone; + if (fileInput) { + clone = fileInput.cloneNode(true); + fileInput.parentNode.replaceChild(clone, fileInput); + me.inputEl = Ext.get(clone); + } + return fileInput; }, - onProviderData : function(provider, e){ - if(Ext.isArray(e)){ - for(var i = 0, len = e.length; i < len; i++){ - this.onProviderData(provider, e[i]); + // 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; } - 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 data; }, - 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(); - -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); + /** + * 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()); }, - retry: function(){ - this.retryCount++; - this.send(); + /** + * 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; }, - getProvider: function(){ - return this.provider; - } -};Ext.Direct.Event = function(config){ - Ext.apply(this, config); -}; - -Ext.Direct.Event.prototype = { - status: true, - getData: function(){ - return this.data; - } -}; - -Ext.Direct.RemotingEvent = Ext.extend(Ext.Direct.Event, { - type: 'rpc', - getTransaction: function(){ - return this.transaction || Ext.Direct.getTransaction(this.tid); - } -}); + /** + * 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; -Ext.Direct.ExceptionEvent = Ext.extend(Ext.Direct.RemotingEvent, { - status: false, - type: 'exception' -}); + // Some Field subclasses may not render an inputEl + if (me.inputEl) { + me.inputEl.dom.value = value; + } + return value; + }, -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(); - * + * 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. */ - - /** - * @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, + valueToRaw: function(value) { + return '' + Ext.value(value, ''); + }, /** - * @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); + * 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; }, /** - * Returns whether or not the server-side is currently connected. - * Abstract method for subclasses to implement. + * 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 */ - isConnected: function(){ - return false; + processRawValue: function(value) { + return value; }, /** - * Abstract methods for subclasses to implement. + * 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 */ - connect: Ext.emptyFn, - + getValue: function() { + var me = this, + val = me.rawToValue(me.processRawValue(me.getRawValue())); + me.value = val; + return val; + }, + /** - * Abstract methods for subclasses to implement. + * 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 */ - disconnect: Ext.emptyFn -}); -/** - * @class Ext.direct.JsonProvider - * @extends Ext.direct.Provider - */ -Ext.direct.JsonProvider = Ext.extend(Ext.direct.Provider, { - parseResponse: function(xhr){ - if(!Ext.isEmpty(xhr.responseText)){ - if(typeof xhr.responseText == 'object'){ - return xhr.responseText; - } - return Ext.decode(xhr.responseText); - } - return null; + setValue: function(value) { + var me = this; + me.setRawValue(me.valueToRaw(value)); + return me.mixins.field.setValue.call(me, value); }, - 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]; + + //private + onDisable: function() { + var me = this, + inputEl = me.inputEl; + me.callParent(); + if (inputEl) { + inputEl.dom.disabled = true; } - 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)); + }, + + //private + onEnable: function() { + var me = this, + inputEl = me.inputEl; + me.callParent(); + if (inputEl) { + inputEl.dom.disabled = false; } - 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(); + }, -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}. + * Sets the read only state of this field. + * @param {Boolean} readOnly Whether the field should be read only. */ - // override default priority - priority: 3, - + setReadOnly: function(readOnly) { + var me = this, + inputEl = me.inputEl; + if (inputEl) { + inputEl.dom.readOnly = readOnly; + inputEl.dom.setAttribute('aria-readonly', readOnly); + } + me[readOnly ? 'addCls' : 'removeCls'](me.readOnlyCls); + me.readOnly = readOnly; + }, + + // private + fireKey: function(e){ + if(e.isSpecialKey()){ + this.fireEvent('specialkey', this, Ext.create('Ext.EventObjectImpl', e)); + } + }, + + // 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(); + }, + + doComponentLayout: function() { + var me = this, + inputEl = me.inputEl, + usesPropertychange = me.usesPropertychange, + ename = 'propertychange', + onChangeEvent = me.onChangeEvent; + + // In IE if propertychange is one of the checkChangeEvents, we need to remove + // the listener prior to layout and re-add it after, to prevent it from firing + // needlessly for attribute and style changes applied to the inputEl. + if (usesPropertychange) { + me.mun(inputEl, ename, onChangeEvent); + } + me.callParent(arguments); + if (usesPropertychange) { + me.mon(inputEl, ename, onChangeEvent); + } + }, + + // 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); + } + }, + + // private + beforeBlur : Ext.emptyFn, + + // private + onBlur : function(){ + var me = this, + focusCls = me.focusCls, + inputEl = me.inputEl; + me.beforeBlur(); + if (focusCls && inputEl) { + inputEl.removeCls(focusCls); + } + if (me.validateOnBlur) { + me.validate(); + } + me.hasFocus = false; + me.fireEvent('blur', me); + me.postBlur(); + }, + + // private + postBlur : Ext.emptyFn, + + /** - * @cfg {Number} interval - * How often to poll the server-side in milliseconds (defaults to 3000 - every - * 3 seconds). + * @private Called when the field's dirty state changes. Adds/removes the {@link #dirtyCls} on the main element. + * @param {Boolean} isDirty */ - interval: 3000, + onDirtyChange: function(isDirty) { + this[isDirty ? 'addCls' : 'removeCls'](this.dirtyCls); + }, + /** - * @cfg {Object} baseParams An object containing properties which are to be sent as parameters - * on every polling request + * 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 */ - + isValid : function() { + var me = this; + return me.disabled || me.validateValue(me.processRawValue(me.getRawValue())); + }, + + /** - * @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. + * 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); + } + } - // 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' - ); + return isValid; }, - // inherited - isConnected: function(){ - return !!this.pollTask; + /** + * 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. + */ + 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(); + } }, /** - * Connect to the server-side and begin the polling process. To handle each - * response subscribe to the data event. + * 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. */ - 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.'; + clearInvalid : function() { + // Clear the message and fire the 'valid' event + var me = this, + hadError = me.hasActiveError(); + me.unsetActiveError(); + if (hadError) { + me.doComponentLayout(); } }, /** - * Disconnect from the server-side and stop the polling process. The disconnect - * event will be fired on a successful disconnect. + * @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) */ - disconnect: function(){ - if(this.pollTask){ - Ext.TaskMgr.stop(this.pollTask); - delete this.pollTask; - this.fireEvent('disconnect', this); + renderActiveError: function() { + var me = this, + hasError = me.hasActiveError(); + if (me.inputEl) { + // Add/remove invalid class + me.inputEl[hasError ? 'addCls' : 'removeCls'](me.invalidCls + '-field'); } + me.mixins.labelable.renderActiveError.call(me); }, - // private - 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); - } + + getActionEl: function() { + return this.inputEl || this.el; } + }); -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. +/** + * @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.direct.RemotingProvider = Ext.extend(Ext.direct.JsonProvider, { +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 {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 {String} vtypeText A custom error message to display in place of the default message provided + * for the {@link #vtype} currently set for this field (defaults to undefined). + * Note: only applies if {@link #vtype} is set, else ignored. + */ + + /** + * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value + * before validation (defaults to undefined). + */ + + /** + * @cfg {Number} size An initial value for the 'size' attribute on the text input element. This is only + * used if the field has no configured {@link #width} and is not given a width by its container's layout. + * Defaults to 20. + */ + size: 20, + + /** + * @cfg {Boolean} grow true if this field should automatically grow and shrink to its content + * (defaults to false) + */ + + /** + * @cfg {Number} growMin The minimum width to allow when {@link #grow} = true (defaults + * to 30) + */ + growMin : 30, - }else{ - var msg = e.message; // failure message - } - } -); - * - * 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 {Number} growMax The maximum width to allow when {@link #grow} = true (defaults + * to 800) */ + growMax : 800, + + /** + * @cfg {String} growAppend + * A string that will be appended to the field's current value for the purposes of calculating the target + * field size. Only used when the {@link #grow} config is true. Defaults to a single capital "W" + * (the widest character in common fonts) to leave enough space for the next typed character and avoid the + * field value shifting before the width is adjusted. + */ + growAppend: 'W', /** - * @cfg {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} vtype A validation type name as defined in {@link Ext.form.field.VTypes} (defaults to undefined) + */ + + /** + * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do + * not match (defaults to undefined) + */ + + /** + * @cfg {Boolean} disableKeyFilter Specify true to disable input keystroke filtering (defaults + * to false) + */ + + /** + * @cfg {Boolean} allowBlank Specify false to validate that the value's length is > 0 (defaults to + * true) */ + allowBlank : true, /** - * @cfg {String} url - * Required. The url to connect to the {@link Ext.Direct} server-side router. + * @cfg {Number} minLength Minimum input field length required (defaults to 0) */ + minLength : 0, /** - * @cfg {String} enableUrlEncode - * Specify which param will hold the arguments for the method. - * Defaults to 'data'. + * @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. */ + maxLength : Number.MAX_VALUE, /** - * @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 {Boolean} enforceMaxLength True to set the maxLength property on the underlying input field. Defaults to false */ - enableBuffer: 10, + + /** + * @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 {Number} maxRetries - * Number of times to re-attempt delivery on failure of a call. Defaults to 1. + * @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}') */ - maxRetries: 1, + maxLengthText : 'The maximum length for this field is {0}', /** - * @cfg {Number} timeout - * The timeout to use for each request. Defaults to undefined. + * @cfg {Boolean} selectOnFocus true to automatically select any existing field text when the field + * receives input focus (defaults to 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 #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 + * */ - timeout: undefined, - constructor : function(config){ - Ext.direct.RemotingProvider.superclass.constructor.call(this, config); + /** + * @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}. + */ + + /** + * @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 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} 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', + + /** + * @cfg {Boolean} enableKeyEvents true to enable the proxying of key events for the HTML input field (defaults to false) + */ + + componentLayout: 'textfield', + + initComponent : function(){ + this.callParent(); 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 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', + /** - * @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' + * @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' ); - this.namespace = (Ext.isString(this.namespace)) ? Ext.ns(this.namespace) : this.namespace || window; - this.transactions = {}; - this.callBuffer = []; }, // 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); - } + 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 + }); } }, - // inherited - isConnected: function(){ - return !!this.connected; + /** + * @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, '')); }, - connect: function(){ - if(this.url){ - this.initAPI(); - this.connected = true; - this.fireEvent('connect', this); - }else if(!this.url){ - throw 'Error initializing RemotingProvider, no url configured.'; + /** + * @private + * 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(); }, - disconnect: function(){ - if(this.connected){ - this.connected = false; - this.fireEvent('disconnect', this); + onMouseDown: function(e){ + var me = this; + if(!me.hasFocus){ + me.mon(me.inputEl, 'mouseup', Ext.emptyFn, me, { single: true, preventDefault: true }); } }, - onData: function(opt, success, xhr){ - if(success){ - var events = this.getEvents(xhr); - for(var i = 0, len = events.length; i < len; i++){ - var e = events[i], - t = this.getTransaction(e); - this.fireEvent('data', this, e); - if(t){ - this.doCallback(t, e, true); - Ext.Direct.removeTransaction(t); - } - } - }else{ - var ts = [].concat(opt.ts); - for(var i = 0, len = ts.length; i < len; i++){ - var t = this.getTransaction(ts[i]); - if(t && t.retryCount < this.maxRetries){ - t.retry(); - }else{ - var e = new Ext.Direct.ExceptionEvent({ - data: e, - transaction: t, - code: Ext.Direct.exceptions.TRANSPORT, - message: 'Unable to connect to the server.', - xhr: xhr - }); - this.fireEvent('data', this, e); - if(t){ - this.doCallback(t, e, false); - Ext.Direct.removeTransaction(t); - } - } + /** + * Performs any necessary manipulation of a raw String value to prepare it for {@link #stringToValue conversion} + * and/or {@link #validate validation}. For text fields this applies the configured {@link #stripCharsRe} to the + * raw value. + * @param {String} value The unprocessed string value + * @return {String} The processed string value + */ + processRawValue: function(value) { + var me = this, + stripRe = me.stripCharsRe, + newValue; + + if (stripRe) { + newValue = value.replace(stripRe, ''); + if (newValue !== value) { + me.setRawValue(newValue); + value = newValue; } } + return value; }, - getCallData: function(t){ - return { - action: t.action, - method: t.method, - data: t.data, - type: 'rpc', - tid: t.tid - }; + //private + onDisable: function(){ + this.callParent(); + if (Ext.isIE) { + this.inputEl.dom.unselectable = 'on'; + } }, - doSend : function(data){ - var o = { - url: this.url, - callback: this.onData, - scope: this, - ts: data, - timeout: this.timeout - }, callData; - - 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); + //private + onEnable: function(){ + this.callParent(); + if (Ext.isIE) { + this.inputEl.dom.unselectable = ''; } + }, - if(this.enableUrlEncode){ - var params = {}; - params[Ext.isString(this.enableUrlEncode) ? this.enableUrlEncode : 'data'] = Ext.encode(callData); - o.params = params; - }else{ - o.jsonData = callData; - } - Ext.Ajax.request(o); + onKeyDown: function(e) { + this.fireEvent('keydown', this, e); }, - combineAndSend : function(){ - var len = this.callBuffer.length; - if(len > 0){ - this.doSend(len == 1 ? this.callBuffer[0] : this.callBuffer); - this.callBuffer = []; - } + onKeyUp: function(e) { + this.fireEvent('keyup', this, e); }, - 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); + onKeyPress: function(e) { + this.fireEvent('keypress', this, e); + }, + + /** + * 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.callTask.delay(Ext.isNumber(this.enableBuffer) ? this.enableBuffer : 10); - }else{ - this.combineAndSend(); + + //all browsers need this because of a styling issue with chrome + placeholders. + //the text isnt vertically aligned when empty (and using the placeholder) + if (isEmpty) { + me.inputEl.addCls(me.emptyCls); + } + + me.autoSize(); } }, - doCall : function(c, m, args){ - var data = null, hs = args[m.len], scope = args[m.len+1]; + // private + preFocus : function(){ + var me = this, + inputEl = me.inputEl, + emptyText = me.emptyText, + isEmpty; - if(m.len !== 0){ - data = args.slice(0, m.len); + 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(); + } + }, - 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 - }); - - if(this.fireEvent('beforecall', this, t, m) !== false){ - Ext.Direct.addTransaction(t); - this.queueTransaction(t); - this.fireEvent('call', this, t, m); + onFocus: function() { + var me = this; + me.callParent(arguments); + if (me.emptyText) { + me.autoSize(); } }, - 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 - }); + // private + postBlur : function(){ + this.applyEmptyText(); + }, - 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) - }; + // private + filterKeys : function(e){ + if(e.ctrlKey){ + return; + } + var key = e.getKey(), + charCode = String.fromCharCode(e.getCharCode()); - // 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(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(); } - }, - - 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 - }); }, - 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); + /** + * 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 + */ + getRawValue: function() { + var me = this, + v = me.callParent(); + if (v === me.emptyText) { + v = ''; } - f.directCfg = { - action: c, - method: m - }; - return f; + return v; }, - getTransaction: function(opt){ - return opt && opt.tid ? Ext.Direct.getTransaction(opt.tid) : null; + /** + * 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 + */ + 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; }, - 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]); - } - } - } -}); -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, { + /** +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: - 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'; - } - } +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). - /** - * 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'); +2. **Basic Validation** - Ext.apply(this, config); + 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(this.pinned){ - this.disableTrackOver = true; - this.el.addClass('x-resizable-pinned'); - } - // if the element isn't positioned, make it relative - var position = this.el.getStyle('position'); - if(position != 'absolute' && position != 'fixed'){ - this.el.setStyle('position', 'relative'); - } - if(!this.handles){ // no handles passed, must be legacy style - this.handles = 's,e,se'; - if(this.multiDirectional){ - this.handles += ',n,w'; + 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(this.handles == 'all'){ - this.handles = 'n s e w ne nw se sw'; - } - var hs = this.handles.split(/\s*?[,;]\s*?| /); - var ps = Ext.Resizable.positions; - for(var i = 0, len = hs.length; i < len; i++){ - if(hs[i] && ps[hs[i]]){ - var pos = ps[hs[i]]; - this[pos] = new Ext.Resizable.Handle(this, pos, this.disableTrackOver, this.transparent, this.handleCls); + + if (value.length < 1 || value === emptyText) { + if (!allowBlank) { + errors.push(me.blankText); } + //if value is blank, there cannot be any additional errors + return errors; } - // legacy - this.corner = this.southeast; - if(this.handles.indexOf('n') != -1 || this.handles.indexOf('w') != -1){ - this.updateBox = true; + if (value.length < me.minLength) { + errors.push(format(me.minLengthText, me.minLength)); } - this.activeHandle = null; - - 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); - } + if (value.length > me.maxLength) { + errors.push(format(me.maxLengthText, me.maxLength)); } - 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); + if (vtype) { + if(!vtypes[vtype](value, me)){ + errors.push(me.vtypeText || vtypes[vtype +'Text']); } - this.adjustments = [ - (he ? -he.el.getWidth() : 0) + (hw ? -hw.el.getWidth() : 0), - (hn ? -hn.el.getHeight() : 0) + (hs ? -hs.el.getHeight() : 0) -1 - ]; } - 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); - } + if (regex && !regex.test(value)) { + errors.push(me.regexText || me.invalidText); } - 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' - ); + return errors; + }, - if(this.width !== null && this.height !== null){ - this.resizeTo(this.width, this.height); - }else{ - this.updateChildSize(); + /** + * 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; } - if(Ext.isIE){ - this.el.dom.style.zoom = 1; + if (doFocus) { + me.focus(); } - Ext.Resizable.superclass.constructor.call(this); }, /** - * @cfg {Array/String} adjustments String 'auto' or an array [width, height] with values to be added to the - * resize operation's new size (defaults to [0, 0]) - */ - adjustments : [0, 0], - /** - * @cfg {Boolean} animate True to animate the resize (not compatible with dynamic sizing, defaults to false) - */ - animate : false, - /** - * @cfg {Mixed} constrainTo Constrain the resize to a particular element - */ - /** - * @cfg {Boolean} disableTrackOver True to disable mouse tracking. This is only applied at config time. (defaults to false) - */ - disableTrackOver : false, - /** - * @cfg {Boolean} draggable Convenience to initialize drag drop (defaults to false) + * 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. */ - draggable: false, + 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; + } + } + }, + + initAria: function() { + this.callParent(); + this.getActionEl().dom.setAttribute('aria-required', this.allowBlank === false); + }, + /** - * @cfg {Number} duration Animation duration if animate = true (defaults to 0.35) + * @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. */ - duration : 0.35, + getBodyNaturalWidth: function() { + return Math.round(this.size * 6.5) + 20; + } + +}); + +/** + * @class Ext.form.field.TextArea + * @extends Ext.form.field.Text + +This class creates a multiline text field, which can be used as a direct replacement for traditional +textarea fields. In addition, it supports automatically {@link #grow growing} the height of the textarea to +fit its content. + +All of the configuration options from {@link Ext.form.field.Text} can be used on TextArea. +{@img Ext.form.TextArea/Ext.form.TextArea.png Ext.form.TextArea component} +Example usage: + + Ext.create('Ext.form.FormPanel', { + title : 'Sample TextArea', + width : 400, + bodyPadding: 10, + renderTo : Ext.getBody(), + items: [{ + xtype : 'textareafield', + grow : true, + name : 'message', + fieldLabel: 'Message', + anchor : '100%' + }] + }); + +Some other useful configuration options when using {@link #grow} are {@link #growMin} and {@link #growMax}. These +allow you to set the minimum and maximum grow heights for the textarea. + + * @constructor + * Creates a new TextArea + * @param {Object} config Configuration options + * @xtype textareafield + * @docauthor Robert Dougan + */ +Ext.define('Ext.form.field.TextArea', { + extend:'Ext.form.field.Text', + alias: ['widget.textareafield', 'widget.textarea'], + alternateClassName: 'Ext.form.TextArea', + requires: ['Ext.XTemplate', 'Ext.layout.component.field.TextArea'], + + fieldSubTpl: [ + 'name="{name}" </tpl>', + '<tpl if="rows">rows="{rows}" </tpl>', + '<tpl if="cols">cols="{cols}" </tpl>', + '<tpl if="tabIdx">tabIndex="{tabIdx}" </tpl>', + 'class="{fieldCls} {typeCls}" ', + 'autocomplete="off">', + '', + { + compiled: true, + disableFormats: true + } + ], + /** - * @cfg {Boolean} dynamic True to resize the element while dragging instead of using a proxy (defaults to false) + * @cfg {Number} growMin The minimum height to allow when {@link Ext.form.field.Text#grow grow}=true + * (defaults to 60) */ - dynamic : false, + growMin: 60, + /** - * @cfg {String} easing Animation easing if animate = true (defaults to 'easingOutStrong') + * @cfg {Number} growMax The maximum height to allow when {@link Ext.form.field.Text#grow grow}=true + * (defaults to 1000) */ - easing : 'easeOutStrong', + growMax: 1000, + /** - * @cfg {Boolean} enabled False to disable resizing (defaults to true) + * @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. */ - enabled : true, + growAppend: '\n-', + /** - * @property enabled Writable. False if resizing is disabled. - * @type Boolean + * @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} 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} 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. */ - handles : false, + rows: 4, + /** - * @cfg {Boolean} multiDirectional Deprecated. Deprecated style of adding multi-direction resize handles. + * @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) */ - multiDirectional : false, + enterIsSpecial: false, + /** - * @cfg {Number} height The height of the element in pixels (defaults to null) + * @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. */ - height : null, + 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 {Number} width The width of the element in pixels (defaults to null) + * 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. */ - width : null, + 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 {Number} heightIncrement The increment to snap the height resize in pixels - * (only applies if {@link #dynamic}==true). Defaults to 0. + * @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. */ - heightIncrement : 0, + 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 {Number} widthIncrement The increment to snap the width resize in pixels - * (only applies if {@link #dynamic}==true). Defaults to 0. + * Button config that displays a single OK button + * @type Number */ - widthIncrement : 0, + OK : 1, /** - * @cfg {Number} minHeight The minimum height for the element (defaults to 5) + * Button config that displays a single Yes button + * @type Number */ - minHeight : 5, + YES : 2, /** - * @cfg {Number} minWidth The minimum width for the element (defaults to 5) + * Button config that displays a single No button + * @type Number */ - minWidth : 5, + NO : 4, /** - * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000) + * Button config that displays a single Cancel button + * @type Number */ - maxHeight : 10000, + CANCEL : 8, /** - * @cfg {Number} maxWidth The maximum width for the element (defaults to 10000) + * Button config that displays OK and Cancel buttons + * @type Number */ - maxWidth : 10000, + OKCANCEL : 9, /** - * @cfg {Number} minX The minimum x for the element (defaults to 0) + * Button config that displays Yes and No buttons + * @type Number */ - minX: 0, + YESNO : 6, /** - * @cfg {Number} minY The minimum x for the element (defaults to 0) + * Button config that displays Yes, No and Cancel buttons + * @type Number */ - minY: 0, + YESNOCANCEL : 14, /** - * @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) + * The CSS class that provides the INFO icon image + * @type String */ - pinned : false, + INFO : 'ext-mb-info', /** - * @cfg {Boolean} preserveRatio True to preserve the original ratio between height - * and width during resize (defaults to false) + * The CSS class that provides the WARNING icon image + * @type String */ - preserveRatio : false, + WARNING : 'ext-mb-warning', /** - * @cfg {Boolean/String/Element} resizeChild True to resize the first child, or id/element to resize (defaults to false) + * The CSS class that provides the QUESTION icon image + * @type String */ - resizeChild : false, + QUESTION : 'ext-mb-question', /** - * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false) + * The CSS class that provides the ERROR icon image + * @type String */ - transparent: false, + ERROR : 'ext-mb-error', + + // hide it by offsets. Windows are hidden on render by default. + hideMode: 'offsets', + closeAction: 'hide', + resizable: false, + title: ' ', + + width: 600, + height: 500, + minWidth: 250, + maxWidth: 600, + minHeight: 110, + maxHeight: 500, + constrain: true, + + cls: Ext.baseCSSPrefix + 'message-box', + + layout: { + type: 'anchor' + }, + /** - * @cfg {Ext.lib.Region} resizeRegion Constrain the resize to a particular region + * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) + * @type Number */ + defaultTextHeight : 75, /** - * @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) + * 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, /** - * @cfg {String} handleCls A css class to add to each handle. Defaults to ''. + * 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, /** - * Perform a manual resize and fires the 'resize' event. - * @param {Number} width - * @param {Number} height + * 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 */ - resizeTo : function(width, height){ - this.el.setSize(width, height); - this.updateChildSize(); - this.fireEvent('resize', this, width, height, null); + buttonText: { + ok: 'OK', + yes: 'Yes', + no: 'No', + cancel: 'Cancel' }, - // 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')); + buttonIds: [ + 'ok', 'yes', 'no', 'cancel' + ], + + titleText: { + confirm: 'Confirm', + prompt: 'Prompt', + wait: 'Loading...', + alert: 'Attention' + }, - 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]]; + iconHeight: 35, - this.overlay.setSize(Ext.lib.Dom.getViewWidth(true), Ext.lib.Dom.getViewHeight(true)); - this.overlay.show(); + 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 + }); + }, - 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') - ); - } + btnCallback: function(btn) { + var me = this, + value, + field; - this.proxy.setStyle('visibility', 'hidden'); // workaround display none - this.proxy.show(); - this.proxy.setBox(this.startBox); - if(!this.dynamic){ - this.proxy.setStyle('visibility', 'visible'); + if (me.cfg.prompt || me.cfg.multiline) { + if (me.cfg.multiline) { + field = me.textArea; + } else { + field = me.textField; } + value = field.getValue(); + field.reset(); } - }, - // private - onMouseDown : function(handle, e){ - if(this.enabled){ - e.stopEvent(); - this.activeHandle = handle; - this.startSizing(e, handle); - } + // Important not to have focus remain in the hidden Window; Interferes with DnD. + btn.blur(); + me.hide(); + me.userCallback(btn.itemId, value, me.cfg); }, - // private - 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); + hide: function() { + var me = this; + me.dd.endDrag(); + me.progressBar.reset(); + me.removeCls(me.cfg.cls); + me.callParent(); }, - // 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]); + initComponent: function() { + var me = this, + i, button; + + me.title = ' '; + + me.topContainer = Ext.create('Ext.container.Container', { + anchor: '100%', + style: { + padding: '10px', + overflow: 'hidden' + }, + items: [ + me.iconComponent = Ext.create('Ext.Component', { + cls: 'ext-mb-icon', + width: 50, + height: me.iconHeight, + style: { + 'float': 'left' } - }, 10); - } + }), + me.promptContainer = Ext.create('Ext.container.Container', { + layout: { + type: 'anchor' + }, + items: [ + me.msg = Ext.create('Ext.Component', { + autoEl: { tag: 'span' }, + cls: 'ext-mb-text' + }), + me.textField = Ext.create('Ext.form.field.Text', { + anchor: '100%', + enableKeyEvents: true, + listeners: { + keydown: me.onPromptKey, + scope: me + } + }), + me.textArea = Ext.create('Ext.form.field.TextArea', { + anchor: '100%', + height: 75 + }) + ] + }) + ] + }); + me.progressBar = Ext.create('Ext.ProgressBar', { + anchor: '-10', + style: 'margin-left:10px' + }); + + me.items = [me.topContainer, me.progressBar]; + + // Create the buttons based upon passed bitwise config + me.msgButtons = []; + for (i = 0; i < 4; i++) { + button = me.makeButton(i); + me.msgButtons[button.itemId] = button; + me.msgButtons.push(button); } + me.bottomTb = Ext.create('Ext.toolbar.Toolbar', { + ui: 'footer', + dock: 'bottom', + layout: { + pack: 'center' + }, + items: [ + me.msgButtons[0], + me.msgButtons[1], + me.msgButtons[2], + me.msgButtons[3] + ] + }); + me.dockedItems = [me.bottomTb]; + + me.callParent(); }, - // 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; + 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(); } } - 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(); - - */ - 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); + 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; } - this.updateChildSize(); - if(!this.dynamic){ - this.proxy.hide(); + + // Default to allowing the Window to take focus. + delete me.defaultFocus; + + // clear any old animateTarget + me.animateTarget = cfg.animateTarget || undefined; + + // Defaults to modal + me.modal = cfg.modal !== false; + + // Show the title + if (cfg.title) { + me.setTitle(cfg.title||' '); + } + + if (!me.rendered) { + me.width = initialWidth; + me.render(Ext.getBody()); + } else { + me.hidden = false; + me.setSize(initialWidth, me.maxHeight); } - if(this.draggable && this.constrainTo){ - this.dd.resetConstraints(); - this.dd.constrainTo(this.constrainTo); + 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(); } - return box; - }, - // private - constrain : function(v, diff, m, mx){ - if(v - diff < m){ - diff = v - m; - }else if(v - diff > mx){ - diff = v - mx; + // Hide or show the header + if (!cfg.title && !me.closable) { + me.header.hide(); + } else { + me.header.show(); } - 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 + // Default to dynamic drag: drag the window, not a ghost + me.liveDrag = !cfg.proxyDrag; - if(this.resizeRegion && !this.resizeRegion.contains(e.getPoint())) { - return; + // 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(); + } - //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; + // 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(); + } - 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; + // 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(); } - this.proxy.setBounds(x, y, w, h); - if(this.dynamic){ - this.resizeElement(); - } - }catch(ex){} } + + // 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 : StringValue of the input field if either prompt + * or multiline is true + * 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); + } + return me; }, - // private - handleOver : function(){ - if(this.enabled){ - this.el.addClass('x-resizable-over'); + afterShow: function(){ + if (this.animateTarget) { + this.center(); } + this.callParent(arguments); }, - // private - handleOut : function(){ - if(!this.resizing){ - this.el.removeClass('x-resizable-over'); + 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; + }, + + updateText: function(text) { + this.msg.update(text); + return this.doAutoSize(true); }, /** - * Returns the element this component is bound to. - * @return {Ext.Element} - */ - getEl : function(){ - return this.el; + * 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; }, /** - * Returns the resizeChild element (or null). - * @return {Ext.Element} + * 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 */ - getResizeChild : function(){ - return this.resizeChild; + updateProgress : function(value, progressText, msg){ + this.progressBar.updateProgress(value, progressText); + if (msg){ + this.updateText(msg); + } + return this; + }, + + onEsc: function() { + if (this.closable !== false) { + this.callParent(arguments); + } }, /** - * 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 + * 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 */ - destroy : function(removeEl){ - Ext.destroy(this.dd, this.overlay, this.proxy); - this.overlay = null; - this.proxy = null; + confirm: function(cfg, msg, fn, scope) { + if (Ext.isString(cfg)) { + cfg = { + title: cfg, + icon: 'ext-mb-question', + msg: msg, + buttons: this.YESNO, + callback: fn, + scope: scope + }; + } + return this.show(cfg); + }, - var ps = Ext.Resizable.positions; - for(var k in ps){ - if(typeof ps[k] != 'function' && this[ps[k]]){ - this[ps[k]].destroy(); - } + /** + * 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 + */ + 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 + }; } - if(removeEl){ - this.el.update(''); - Ext.destroy(this.el); - this.el = null; + return this.show(cfg); + }, + + /** + * 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 + }; } - this.purgeListeners(); + return this.show(cfg); }, - syncHandleHeight : function(){ - var h = this.el.getHeight(true); - if(this.west){ - this.west.el.setHeight(h); + /** + * 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 + */ + 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 + }; } - if(this.east){ - this.east.el.setHeight(h); + return this.show(cfg); + }, + + /** + * 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 -// 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' -}; +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.) -Ext.Resizable.Handle = Ext.extend(Object, { - constructor : function(rz, pos, disableTrackOver, transparent, cls){ - if(!this.tpl){ - // only initialize the template if resizable is used - var tpl = Ext.DomHelper.createTemplate( - {tag: 'div', cls: 'x-resizable-handle x-resizable-handle-{0}'} - ); - tpl.compile(); - Ext.Resizable.Handle.prototype.tpl = tpl; - } - this.position = pos; - this.rz = rz; - this.el = this.tpl.append(rz.el.dom, [this.position], true); - this.el.unselectable(); - if(transparent){ - this.el.setOpacity(0); - } - if(!Ext.isEmpty(cls)){ - this.el.addClass(cls); - } - this.el.on('mousedown', this.onMouseDown, this); - if(!disableTrackOver){ - this.el.on({ - scope: this, - mouseover: this.onMouseOver, - mouseout: this.onMouseOut - }); +#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', 'Ext.util.DelayedTask'], + + 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,|]/); } - }, - // private - afterResize : function(rz){ - // do nothing - }, - // private - onMouseDown : function(e){ - this.rz.onMouseDown(this, e); - }, - // private - onMouseOver : function(e){ - this.rz.handleOver(this, e); + me.checkValidityTask = Ext.create('Ext.util.DelayedTask', me.checkValidity, me); + + 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 - onMouseOut : function(e){ - this.rz.handleOut(this, e); + + /** + * Do any post constructor initialization + * @private + */ + initialize: function(){ + this.initialized = true; + this.onValidityChange(!this.hasInvalidField()); }, - // private - destroy : function(){ - Ext.destroy(this.el); - this.el = null; - } -}); -/** - * @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'}. - * @constructor - * @param {Object} config The config object - * @xtype window - */ -Ext.Window = Ext.extend(Ext.Panel, { + /** - * @cfg {Number} x - * The X position of the left edge of the window on initial showing. Defaults to centering the Window within - * the width of the Window's container {@link Ext.Element Element) (The Element that the Window is rendered to). + * @cfg {String} method + * The request method to use (GET or POST) for form actions if one isn't supplied in the action options. */ /** - * @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 {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 {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 {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/Element} animateTarget - * Id or element from which the window should animate while opening (defaults to null with no animation). + * @cfg {String} url + * The URL to use for form actions if one isn't supplied in the + * {@link #doAction doAction} options. */ + /** - * @cfg {String} resizeHandles - * A valid {@link Ext.Resizable} handles config string (defaults to 'all'). Only applies when resizable = true. + * @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 {Ext.WindowGroup} manager - * A reference to the WindowGroup that should manage this window (defaults to {@link Ext.WindowMgr}). + * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds). */ + timeout: 30, + /** - * @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 {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 {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 {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} 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} 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 {Boolean} maximized - * True to initially display the window in a maximized state. (Defaults to false). + * @cfg {String} waitTitle + * The default title to show for the waiting message box (defaults to 'Please Wait...') */ + waitTitle: 'Please Wait...', /** - * @cfg {String} baseCls - * The base CSS class to apply to this panel's element (defaults to 'x-window'). - */ - baseCls : 'x-window', + * @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} resizable - * True to allow user resizing at each edge and corner of the window, false to disable resizing (defaults to true). + * @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. */ - resizable : true, + /** - * @cfg {Boolean} draggable - * True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note - * that by default the window will be centered in the viewport, so if dragging is disabled the window may need - * to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);). + * @cfg {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. */ - draggable : true, + + + // Private + wasDirty: false, + + /** - * @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'. + * Destroys this object. */ - closable : true, + destroy: function() { + this.clearListeners(); + this.checkValidityTask.cancel(); + }, + /** - * @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}. + * @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. */ - closeAction : 'close', + onItemAddOrRemove: function(parent, child) { + var me = this, + isAdding = !!child.ownerCt, + isContainer = child.isContainer; + + function handleField(field) { + // Listen for state change events on fields + me[isAdding ? 'mon' : 'mun'](field, { + validitychange: me.checkValidity, + dirtychange: me.checkDirty, + scope: me, + buffer: 100 //batch up sequential calls to avoid excessive full-form validation + }); + // Flush the cached list of fields + delete me._fields; + } + + if (child.isFormField) { + handleField(child); + } + else if (isContainer) { + // Walk down + Ext.Array.forEach(child.query('[isFormField]'), handleField); + } + + // Flush the cached list of formBind components + delete this._boundItems; + + // Check form bind, but only after initial add. Batch it to prevent excessive validation + // calls when many fields are being added at once. + if (me.initialized) { + me.checkValidityTask.delay(10); + } + }, + /** - * @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}. + * Return all the {@link Ext.form.field.Field} components in the owner container. + * @return {Ext.util.MixedCollection} Collection of the Field objects */ - constrain : false, + getFields: function() { + var fields = this._fields; + if (!fields) { + fields = this._fields = Ext.create('Ext.util.MixedCollection'); + fields.addAll(this.owner.query('[isFormField]')); + } + return fields; + }, + + getBoundItems: function() { + var boundItems = this._boundItems; + if (!boundItems) { + boundItems = this._boundItems = Ext.create('Ext.util.MixedCollection'); + boundItems.addAll(this.owner.query('[formBind]')); + } + return boundItems; + }, + /** - * @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}. + * 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. */ - constrainHeader : false, + hasInvalidField: function() { + return !!this.getFields().findBy(function(field) { + var preventMark = field.preventMark, + isValid; + field.preventMark = true; + isValid = field.isValid(); + field.preventMark = preventMark; + return !isValid; + }); + }, + /** - * @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). + * 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 */ - plain : false, + isValid: function() { + var me = this, + invalid; + me.batchLayouts(function() { + invalid = me.getFields().filterBy(function(field) { + return !field.validate(); + }); + }); + return invalid.length < 1; + }, + /** - * @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. + * 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; + } + }, + + /** + * @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); + } + }); + } + }, + + /** + * 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(); + }); + }, + + /** + * 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; + } + }, + + /** + * 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 */ - minimizable : false, + hasUpload: function() { + return !!this.getFields().findBy(function(f) { + return f.isFileUpload(); + }); + }, + /** - * @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. + * 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/ObjectThe 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 */ - maximizable : false, + doAction: function(action, options) { + if (Ext.isString(action)) { + action = Ext.ClassManager.instantiateByAlias('formaction.' + action, Ext.apply({}, options, {form: this})); + } + if (this.fireEvent('beforeaction', this, action) !== false) { + this.beforeAction(action); + Ext.defer(action.run, 100, action); + } + return this; + }, + /** - * @cfg {Number} minHeight - * The minimum height in pixels allowed for this window (defaults to 100). Only applies when resizable = true. + * Shortcut to {@link #doAction do} a {@link Ext.form.action.Submit submit action}. This will use the + * {@link Ext.form.action.Submit AJAX submit action} by default. If the {@link #standardsubmit} config is + * enabled it will use a standard form element to submit, or if the {@link #api} config is present it will + * use the {@link Ext.form.action.DirectLoad Ext.direct.Direct submit action}. + * @param {Object} options The options to pass to the action (see {@link #doAction} for details). + * 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 */ - minHeight : 100, + submit: function(options) { + return this.doAction(this.standardSubmit ? 'standardsubmit' : this.api ? 'directsubmit' : 'submit', options); + }, + /** - * @cfg {Number} minWidth - * The minimum width in pixels allowed for this window (defaults to 200). Only applies when resizable = true. + * 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 */ - minWidth : 200, + load: function(options) { + return this.doAction(this.api ? 'directload' : 'load', options); + }, + /** - * @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). + * 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 */ - expandOnShow : true, + updateRecord: function(record) { + var fields = record.fields, + values = this.getFieldValues(), + name, + obj = {}; - // inherited docs, same default - collapsible : false, + fields.each(function(f) { + name = f.name; + if (name in values) { + obj[name] = values[name]; + } + }); + + record.beginEdit(); + record.set(obj); + record.endEdit(); + + return this; + }, /** - * @cfg {Boolean} initHidden - * True to hide the window until show() is explicitly called (defaults to true). - * @deprecated + * 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 */ - initHidden : undefined, + getRecord: function() { + return this._record; + }, /** - * @cfg {Boolean} hidden - * Render this component hidden (default is true). If true, the - * {@link #hide} method will be called internally. + * @private + * Called before an action is performed via {@link #doAction}. + * @param {Ext.form.action.Action} action The Action instance that was invoked */ - hidden : true, + beforeAction: function(action) { + var waitMsg = action.waitMsg, + maskCls = Ext.baseCSSPrefix + 'mask-loading', + waitMsgTarget; - // 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, + // Call HtmlEditor's syncValue before actions + this.getFields().each(function(f) { + if (f.isFormField && f.syncValue) { + f.syncValue(); + } + }); - // 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(); + 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); + } } }, - // private - getState : function(){ - return Ext.apply(Ext.Window.superclass.getState.call(this) || {}, this.getBox(true)); + /** + * @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 (success) { + if (action.reset) { + this.reset(); + } + Ext.callback(action.success, action.scope || action, [this, action]); + this.fireEvent('actioncomplete', this, action); + } else { + Ext.callback(action.failure, action.scope || action, [this, action]); + this.fireEvent('actionfailed', this, action); + } }, - // private - onRender : function(ct, position){ - Ext.Window.superclass.onRender.call(this, ct, position); - if(this.plain){ - this.el.addClass('x-window-plain'); - } + /** + * Find a specific {@link Ext.form.field.Field} in this form by id or name. + * @param {String} id The value to search for (specify either a {@link Ext.Component#id id} or + * {@link Ext.form.field.Field#getName name or hiddenName}). + * @return Ext.form.field.Field The first matching field, or null if none was found. + */ + findField: function(id) { + return this.getFields().findBy(function(f) { + return f.id === id || f.getName() === id; + }); + }, - // 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); - this.proxy = this.el.createProxy('x-window-proxy'); - this.proxy.enableDisplayMode('block'); + /** + * 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.modal){ - this.mask = this.container.createChild({cls:'ext-el-mask'}, this.el.dom); - this.mask.enableDisplayMode('block'); - this.mask.hide(); - this.mon(this.mask, 'click', this.focus, this); - } - if(this.maximizable){ - this.mon(this.header, 'dblclick', this.toggleMaximize, this); + function mark(fieldId, msg) { + var field = me.findField(fieldId); + if (field) { + field.markInvalid(msg); + } } - }, - // 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' + if (Ext.isArray(errors)) { + Ext.each(errors, function(err) { + mark(err.id, err.msg); }); - this.resizer.window = this; - this.mon(this.resizer, 'beforeresize', this.beforeResize, this); - } - - if(this.draggable){ - this.header.addClass('x-window-draggable'); } - 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(); + else if (errors instanceof Ext.data.Errors) { + errors.each(function(err) { + mark(err.field, err.message); + }); } - if(this.closable){ - var km = this.getKeyMap(); - km.on(27, this.onEsc, this); - km.disable(); + else { + Ext.iterate(errors, mark); } + return this; }, - 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); - }, + /** + * 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 + */ + setValues: function(values) { + var me = this; - // private - onEsc : function(k, e){ - e.stopEvent(); - this[this.closeAction](); - }, + function setVal(fieldId, val) { + var field = me.findField(fieldId); + if (field) { + field.setValue(val); + if (me.trackResetOnLoad) { + field.resetOriginalValue(); + } + } + } - // private - beforeDestroy : function(){ - if(this.rendered){ - this.hide(); - this.clearAnchor(); - Ext.destroy( - this.focusEl, - this.resizer, - this.dd, - this.proxy, - this.mask - ); + if (Ext.isArray(values)) { + // array of objects + Ext.each(values, function(val) { + setVal(val.id, val.value); + }); + } else { + // object hash + Ext.iterate(values, setVal); } - Ext.Window.superclass.beforeDestroy.call(this); + return this; }, - // private - onDestroy : function(){ - if(this.manager){ - this.manager.unregister(this); + /** + * Retrieves the fields in the form as a set of key/value pairs, using their + * {@link Ext.form.field.Field#getSubmitData getSubmitData()} method to collect the values. + * If multiple fields return values under the same name those values will be combined into an Array. + * This is similar to {@link #getFieldValues} except that this method collects only String values for + * submission, while getFieldValues collects type-specific data values (e.g. Date objects for date fields.) + * @param {Boolean} asString (optional) If true, will return the key/value collection as a single + * URL-encoded param string. Defaults to false. + * @param {Boolean} dirtyOnly (optional) If true, only fields that are dirty will be included in the result. + * Defaults to false. + * @param {Boolean} includeEmptyText (optional) If true, the configured emptyText of empty fields will be used. + * Defaults to false. + * @return {String/Object} + */ + getValues: function(asString, dirtyOnly, includeEmptyText, useDataValues) { + var values = {}; + + 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); } - Ext.Window.superclass.onDestroy.call(this); + return values; }, - // private - initTools : function(){ - if(this.minimizable){ - this.addTool({ - id: 'minimize', - handler: this.minimize.createDelegate(this, []) - }); - } - if(this.maximizable){ - this.addTool({ - id: 'maximize', - handler: this.maximize.createDelegate(this, []) - }); - this.addTool({ - id: 'restore', - handler: this.restore.createDelegate(this, []), - hidden:true - }); - } - if(this.closable){ - this.addTool({ - id: 'close', - handler: this[this.closeAction].createDelegate(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} + */ + getFieldValues: function(dirtyOnly) { + return this.getValues(false, dirtyOnly, false, true); }, - // private - resizerAction : function(){ - var box = this.proxy.getBox(); - this.proxy.hide(); - this.window.handleResize(box); - return box; + /** + * Clears all invalid field messages in this form. + * @return {Ext.form.Basic} this + */ + clearInvalid: function() { + var me = this; + me.batchLayouts(function() { + me.getFields().each(function(f) { + f.clearInvalid(); + }); + }); + return me; }, - // 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(); + /** + * Resets all fields in this form. + * @return {Ext.form.Basic} this + */ + reset: function() { + var me = this; + me.batchLayouts(function() { + me.getFields().each(function(f) { + f.reset(); + }); + }); + return me; }, - // private - updateHandles : function(){ - if(Ext.isIE && this.resizer){ - this.resizer.syncHandleHeight(); - this.el.repaint(); - } + /** + * 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 + */ + applyToFields: function(obj) { + this.getFields().each(function(f) { + Ext.apply(f, obj); + }); + 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(); - } - } - this.focus(); - this.updateHandles(); - this.saveState(); + /** + * 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 + */ + applyIfToFields: function(obj) { + this.getFields().each(function(f) { + Ext.applyIf(f, obj); + }); + return this; }, /** - * Focuses the window. If a defaultButton is set, it will receive focus, otherwise the - * window itself will receive focus. + * @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 */ - 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; - } + batchLayouts: function(fn) { + var me = this, + suspended = new Ext.util.HashMap(); + + // 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; } - } - f = f || this.focusEl; - f.focus.defer(10, f); + }); + + // Invoke the function + fn(); + + // Un-suspend the container layouts + suspended.each(function(id, ct) { + ct.suspendLayout = ct.oldSuspendLayout; + delete ct.oldSuspendLayout; + }); + + // Trigger a single layout + me.owner.doComponentLayout(); + } +}); + +/** + * @class Ext.form.FieldAncestor + +A mixin for {@link Ext.container.Container} components that are likely to have form fields in their +items subtree. Adds the following capabilities: + +- 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. + +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. + + * @markdown + * @docauthor Jason Johnston + */ +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. + */ + /** - * Sets the target element from which the window should animate while opening. - * @param {String/Element} el The target element or id + * @protected Initializes the FieldAncestor's state; this must be called from the initComponent method + * of any components importing this mixin. */ - setAnimateTarget : function(el){ - el = Ext.get(el); - this.animateTarget = el; - }, + initFieldAncestor: function() { + var me = this, + onSubtreeChange = me.onFieldAncestorSubtreeChange; - // 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); - } + 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', - 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(); - } + /** + * @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(); }, /** - * 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 + * @private Initialize the {@link #fieldDefaults} object */ - 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(); + initFieldDefaults: function() { + if (!this.fieldDefaults) { + this.fieldDefaults = {}; } - return this; }, - // private - afterShow : function(isAnim){ - if (this.isDestroyed){ - return false; - } - this.proxy.hide(); - this.el.setStyle('display', 'block'); - this.el.show(); - if(this.maximized){ - this.fitContainer(); - } - if(Ext.isMac && Ext.isGecko2){ // work around stupid FF 2.0/Mac scroll bar bug - this.cascade(this.setAutoScroll); + /** + * @private + * Handle the addition and removal of components in the FieldAncestor component's child tree. + */ + onFieldAncestorSubtreeChange: function(parent, child) { + var me = this, + isAdding = !!child.ownerCt; + + function handleCmp(cmp) { + var isLabelable = cmp.isFieldLabelable, + isField = cmp.isFormField; + if (isLabelable || isField) { + if (isLabelable) { + me['onLabelable' + (isAdding ? 'Added' : 'Removed')](cmp); + } + if (isField) { + me['onField' + (isAdding ? 'Added' : 'Removed')](cmp); + } + } + else if (cmp.isContainer) { + Ext.Array.forEach(cmp.getRefItems(), handleCmp); + } } + handleCmp(child); + }, - 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); - } - this.onShow(); - this.fireEvent('show', this); + /** + * @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; + + // buffer slightly to avoid excessive firing while sub-fields are changing en masse + me.mon(labelable, 'errorchange', me.handleFieldErrorChange, me, {buffer: 10}); + + labelable.setFieldDefaults(me.fieldDefaults); }, - // 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 - })); + /** + * @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); }, /** - * 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 + * @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 */ - hide : function(animateTarget, cb, scope){ - if(this.hidden || this.fireEvent('beforehide', this) === false){ - return this; - } - if(cb){ - this.on('hide', cb, scope, {single:true}); - } - this.hidden = true; - if(animateTarget !== undefined){ - this.setAnimateTarget(animateTarget); - } - if(this.modal){ - this.mask.hide(); - Ext.getBody().removeClass('x-body-masked'); - } - if(this.animateTarget){ - this.animHide(); - }else{ - this.el.hide(); - this.afterHide(); - } - return this; + onLabelableRemoved: function(labelable) { + var me = this; + me.mun(labelable, 'errorchange', me.handleFieldErrorChange, me); }, - // 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(); - } - this.onHide(); - this.fireEvent('hide', this); + /** + * @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 + */ + onFieldRemoved: function(field) { + var me = this; + me.mun(field, 'validitychange', me.handleFieldValidityChange, me); }, - // 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 - })); + /** + * @private Handle validitychange events on sub-fields; invoke the aggregated event and method + */ + handleFieldValidityChange: function(field, isValid) { + var me = this; + me.fireEvent('fieldvaliditychange', me, field, isValid); + me.onFieldValidityChange(); }, /** - * Method that is called immediately before the show event is fired. - * Defaults to Ext.emptyFn. + * @private Handle errorchange events on sub-fields; invoke the aggregated event and method */ - onShow : Ext.emptyFn, + handleFieldErrorChange: function(labelable, activeError) { + var me = this; + me.fireEvent('fielderrorchange', me, labelable, activeError); + me.onFieldErrorChange(); + }, /** - * Method that is called immediately before the hide event is fired. - * Defaults to Ext.emptyFn. + * @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 */ - onHide : Ext.emptyFn, + onFieldValidityChange: Ext.emptyFn, - // private - onWindowResize : function(){ - if(this.maximized){ - this.fitContainer(); + /** + * @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.layout.container.CheckboxGroup + * @extends Ext.layout.container.Container + * This layout implements the column arrangement for {@link Ext.form.CheckboxGroup} and {@link Ext.form.RadioGroup}. + * It groups the component's sub-items into columns based on the component's + * {@link Ext.form.CheckboxGroup#columns columns} and {@link Ext.form.CheckboxGroup#vertical} config properties. + * + */ +Ext.define('Ext.layout.container.CheckboxGroup', { + extend: 'Ext.layout.container.Container', + alias: ['layout.checkboxgroup'], + + + onLayout: function() { + var numCols = this.getColCount(), + shadowCt = this.getShadowCt(), + owner = this.owner, + items = owner.items, + shadowItems = shadowCt.items, + numItems = items.length, + colIndex = 0, + i, numRows; + + // Distribute the items into the appropriate column containers. We add directly to the + // containers' items collection rather than calling container.add(), because we need the + // checkboxes to maintain their original ownerCt. The distribution is done on each layout + // in case items have been added, removed, or reordered. + + shadowItems.each(function(col) { + col.items.clear(); + }); + + // 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()); } - 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)); + while (shadowItems.length < numCols) { + shadowCt.add({ + xtype: 'container', + cls: owner.groupCls, + flex: 1 + }); } - 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) - }; + 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)); } - - var xy = this.el.getConstrainToXY(this.container, true, offsets); - if(xy){ - this.setPosition(xy[0], xy[1]); + } else { + for (i = 0; i < numItems; i++) { + colIndex = i % numCols; + shadowItems.getAt(colIndex).items.add(items.getAt(i)); } } - }, - - // private - used for dragging - ghost : function(cls){ - var ghost = this.createGhost(cls); - var box = this.getBox(true); - ghost.setLeftTop(box.x, box.y); - ghost.setWidth(box.width); - this.el.hide(); - this.activeGhost = ghost; - return ghost; - }, - // private - unghost : function(show, matchPosition){ - if(!this.activeGhost) { - return; - } - 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); - } - } - if(matchPosition !== false){ - this.setPosition(this.activeGhost.getLeft(true), this.activeGhost.getTop(true)); + 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.activeGhost.hide(); - this.activeGhost.remove(); - delete this.activeGhost; - }, - /** - * 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 - */ - minimize : function(){ - this.fireEvent('minimize', this); - return this; + shadowCt.doComponentLayout(); }, + + // We don't want to render any items to the owner directly, that gets handled by each column's own layout + renderItems: Ext.emptyFn, + + /** - * 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}. + * @private + * Creates and returns the shadow hbox container that will be used to arrange the owner's items + * into columns. */ - close : function(){ - if(this.fireEvent('beforeclose', this) !== false){ - if(this.hidden){ - this.doClose(); - }else{ - this.hide(null, this.doClose, this); + getShadowCt: function() { + var me = this, + shadowCt = me.shadowCt, + owner, items, item, columns, columnsIsArray, numCols, i; + + if (!shadowCt) { + // Create the column containers based on the owner's 'columns' config + owner = me.owner; + columns = owner.columns; + columnsIsArray = Ext.isArray(columns); + numCols = me.getColCount(); + items = []; + for(i = 0; i < numCols; i++) { + item = { + xtype: 'container', + cls: owner.groupCls + }; + if (columnsIsArray) { + // Array can contain mixture of whole numbers, used as fixed pixel widths, and fractional + // numbers, used as relative flex values. + if (columns[i] < 1) { + item.flex = columns[i]; + } else { + item.width = columns[i]; + } + } + else { + // All columns the same width + item.flex = 1; + } + items.push(item); } + + // Create the shadow container; delay rendering until after items are added to the columns + shadowCt = me.shadowCt = Ext.createWidget('container', { + layout: 'hbox', + items: items, + ownerCt: owner + }); } + + return shadowCt; }, - // private - doClose : function(){ - this.fireEvent('close', this); - this.destroy(); - }, /** - * 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 Get the number of columns in the checkbox group */ - 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(); + getColCount: function() { + var owner = this.owner, + colsCfg = owner.columns; + return Ext.isArray(colsCfg) ? colsCfg.length : (Ext.isNumber(colsCfg) ? colsCfg : owner.items.length); + } + +}); + +/** + * @class Ext.form.FieldContainer + * @extends Ext.container.Container + +FieldContainer is a derivation of {@link Ext.container.Container Container} that implements the +{@link Ext.form.Labelable Labelable} mixin. This allows it to be configured so that it is rendered with +a {@link #fieldLabel field label} and optional {@link #msgTarget error message} around its sub-items. +This is useful for arranging a group of fields or other components within a single item in a form, so +that it lines up nicely with other fields. A common use is for grouping a set of related fields under +a single label in a form. + +The container's configured {@link #items} will be layed out within the field body area according to the +configured {@link #layout} type. The default layout is `'autocontainer'`. + +Like regular fields, FieldContainer can inherit its decoration configuration from the +{@link Ext.form.Panel#fieldDefaults fieldDefaults} of an enclosing FormPanel. In addition, +FieldContainer itself can pass {@link #fieldDefaults} to any {@link Ext.form.Labelable fields} +it may itself contain. + +If you are grouping a set of {@link Ext.form.field.Checkbox Checkbox} or {@link Ext.form.field.Radio Radio} +fields in a single labeled container, consider using a {@link Ext.form.CheckboxGroup} +or {@link Ext.form.RadioGroup} instead as they are specialized for handling those types. +{@img Ext.form.FieldContainer/Ext.form.FieldContainer1.png Ext.form.FieldContainer component} +__Example usage:__ + + Ext.create('Ext.form.Panel', { + title: 'FieldContainer Example', + width: 550, + bodyPadding: 10, + + items: [{ + xtype: 'fieldcontainer', + fieldLabel: 'Last Three Jobs', + labelWidth: 100, + + // The body area will contain three text fields, arranged + // horizontally, separated by draggable splitters. + layout: 'hbox', + items: [{ + xtype: 'textfield', + flex: 1 + }, { + xtype: 'splitter' + }, { + xtype: 'textfield', + flex: 1 + }, { + xtype: 'splitter' + }, { + xtype: 'textfield', + flex: 1 + }] + }], + renderTo: Ext.getBody() + }); + +__Usage of {@link #fieldDefaults}:__ +{@img Ext.form.FieldContainer/Ext.form.FieldContainer2.png Ext.form.FieldContainer component} + + Ext.create('Ext.form.Panel', { + title: 'FieldContainer Example', + width: 350, + bodyPadding: 10, + + items: [{ + xtype: 'fieldcontainer', + fieldLabel: 'Your Name', + labelWidth: 75, + defaultType: 'textfield', + + // Arrange fields vertically, stretched to full width + layout: 'anchor', + defaults: { + layout: '100%' + }, + + // These config values will be applied to both sub-fields, except + // for Last Name which will use its own msgTarget. + fieldDefaults: { + msgTarget: 'under', + labelAlign: 'top' + }, + + items: [{ + fieldLabel: 'First Name', + name: 'firstName' + }, { + fieldLabel: 'Last Name', + name: 'lastName', + msgTarget: 'under' + }] + }], + renderTo: Ext.getBody() + }); - if(this.dd){ - this.dd.lock(); - } - if(this.collapsible){ - this.tools.toggle.hide(); - } - this.el.addClass('x-window-maximized'); - this.container.addClass('x-window-maximized-ct'); - this.setPosition(0, 0); - this.fitContainer(); - this.fireEvent('maximize', this); - } - return this; + * @constructor + * Creates a new Ext.form.FieldContainer instance. + * @param {Object} config The component configuration. + * + * @xtype fieldcontainer + * @markdown + * @docauthor Jason Johnston + */ +Ext.define('Ext.form.FieldContainer', { + extend: 'Ext.container.Container', + mixins: { + labelable: 'Ext.form.Labelable', + fieldAncestor: 'Ext.form.FieldAncestor' }, + alias: 'widget.fieldcontainer', + + componentLayout: 'field', /** - * 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 + * @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. */ - 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(); - } - if(this.collapsible && t.toggle){ - t.toggle.show(); - } - this.container.removeClass('x-window-maximized-ct'); - - this.doConstrain(); - this.fireEvent('restore', this); - } - return this; - }, + combineLabels: false, /** - * A shortcut method for toggling between {@link #maximize} and {@link #restore} based on the current maximized - * state of the window. - * @return {Ext.Window} this + * @cfg {String} labelConnector + * The string to use when joining the labels of individual sub-fields, when {@link #combineLabels} is + * set to true. Defaults to ', '. */ - toggleMaximize : function(){ - return this[this.maximized ? 'restore' : 'maximize'](); - }, + labelConnector: ', ', - // private - fitContainer : function(){ - var vs = this.container.getViewSize(false); - this.setSize(vs.width, vs.height); - }, + /** + * @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. + */ + combineErrors: false, + + maskOnDisable: false, - // 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; + initComponent: function() { + var me = this, + onSubCmpAddOrRemove = me.onSubCmpAddOrRemove; - if(this.resizer){ - this.resizer.proxy.setStyle('z-index', ++index); - } + // Init mixins + me.initLabelable(); + me.initFieldAncestor(); - this.lastZIndex = index; + me.callParent(); }, /** - * 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 + * @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 */ - alignTo : function(element, position, offsets){ - var xy = this.el.getAlignToXY(element, position, offsets); - this.setPagePosition(xy[0], xy[1]); - return this; + onLabelableAdded: function(labelable) { + var me = this; + me.mixins.fieldAncestor.onLabelableAdded.call(this, labelable); + me.updateLabel(); }, /** - * Anchors this window to another element and realigns it when the window is resized or scrolled. - * @param {Mixed} element The element to align to. - * @param {String} position The position to align to (see {@link Ext.Element#alignTo} for more details) - * @param {Array} offsets (optional) Offset the positioning by [x, y] - * @param {Boolean/Number} monitorScroll (optional) true to monitor body scroll and reposition. If this parameter - * is a number, it is used as the buffer delay (defaults to 50ms). - * @return {Ext.Window} this - */ - anchorTo : function(el, alignment, offsets, monitorScroll){ - this.clearAnchor(); - this.anchorTarget = { - el: el, - alignment: alignment, - offsets: offsets - }; - - Ext.EventManager.onWindowResize(this.doAnchor, this); - var tm = typeof monitorScroll; - if(tm != 'undefined'){ - Ext.EventManager.on(window, 'scroll', this.doAnchor, this, - {buffer: tm == 'number' ? monitorScroll : 50}); - } - return this.doAnchor(); + * @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(); }, - /** - * Performs the anchor, using the saved anchorTarget property. - * @return {Ext.Window} this - * @private - */ - doAnchor : function(){ - var o = this.anchorTarget; - this.alignTo(o.el, o.alignment, o.offsets); - return this; + onRender: function() { + var me = this, + renderSelectors = me.renderSelectors, + applyIf = Ext.applyIf; + + applyIf(renderSelectors, me.getLabelableSelectors()); + + me.callParent(arguments); }, - /** - * Removes any existing anchor from this window. See {@link #anchorTo}. - * @return {Ext.Window} this - */ - clearAnchor : function(){ - if(this.anchorTarget){ - Ext.EventManager.removeResizeListener(this.doAnchor, this); - Ext.EventManager.un(window, 'scroll', this.doAnchor, this); - delete this.anchorTarget; + initRenderTpl: function() { + var me = this; + if (!me.hasOwnProperty('renderTpl')) { + me.renderTpl = me.getTpl('labelableRenderTpl'); } - return this; + return me.callParent(); }, - /** - * 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 - */ - toFront : function(e){ - if(this.manager.bringToFront(this)){ - if(!e || !e.getTarget().focus){ - this.focus(); - } - } - return this; + initRenderData: function() { + return Ext.applyIf(this.callParent(), this.getLabelableRenderData()); }, /** - * 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) + * 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. */ - setActive : function(active){ - if(active){ - if(!this.maximized){ - this.el.enableShadow(true); - } - this.fireEvent('activate', this); - }else{ - this.el.disableShadow(); - this.fireEvent('deactivate', this); + 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; }, /** - * Sends this window to the back of (lower z-index than) any other visible windows - * @return {Ext.Window} this + * @private Updates the content of the labelEl if it is rendered */ - toBack : function(){ - this.manager.sendToBack(this); - return this; + updateLabel: function() { + var me = this, + label = me.labelEl; + if (label) { + label.update(me.getFieldLabel()); + } }, - /** - * Centers this window in the viewport - * @return {Ext.Window} this - */ - center : function(){ - var xy = this.el.getAlignToXY(this.container, 'c-c'); - this.setPagePosition(xy[0], xy[1]); - return this; - } /** - * @cfg {Boolean} autoWidth @hide - **/ -}); -Ext.reg('window', Ext.Window); + * @private 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); -// 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; -}; + if (newErrors) { + me.setActiveErrors(newErrors); + } else { + me.unsetActiveError(); + } -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])}); + if (oldError !== me.getActiveError()) { + me.doComponentLayout(); + } } }, - b4Drag : Ext.emptyFn, - onDrag : function(e){ - this.alignElWithMouse(this.proxy, e.getPageX(), e.getPageY()); + /** + * 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; }, - endDrag : function(e){ - this.win.unghost(); - this.win.saveState(); + getTargetEl: function() { + return this.bodyEl || this.callParent(); } }); + /** - * @class Ext.WindowGroup - * An object that manages a group of {@link Ext.Window} instances and provides z-order management - * and window activation behavior. + * @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.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); - } - } - }; +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'], - // 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); - }; + /** + * @cfg {String} name + * @hide + */ - return { - /** - * The starting z-index for windows in this WindowGroup (defaults to 9000) - * @type Number The z-index value - */ - zseed : 9000, + /** + * @cfg {Array} items An Array of {@link Ext.form.field.Checkbox Checkbox}es or Checkbox config objects + * to arrange in the group. + */ - /** - * 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; + /** + * @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. + */ + columns : 'auto', - list[win.id] = win; - accessList.push(win); - win.on('hide', activateLast); - }, + /** + * @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, - /** - * 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); - }, + /** + * @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, - /** - * 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]; - }, + /** + * @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", - /** - * 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; - }, + // private + defaultType : 'checkboxfield', - /** - * 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; - }, + // private + groupCls : Ext.baseCSSPrefix + 'form-check-group', - /** - * 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(); - } - } - }, + /** + * @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', - /** - * Gets the currently-active window in this WindowGroup. - * @return {Ext.Window} The active window - */ - getActive : function(){ - return front; - }, + // private + layout: 'checkboxgroup', - /** - * 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; - }, + initComponent: function() { + var me = this; + me.callParent(); + me.initField(); + }, - /** - * 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; - } - } - } + /** + * @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); } - }; -}; - - -/** - * @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); + /** + * @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); } - }; + me.callParent(arguments); + }, - // private - var handleHide = function(){ - if(opt && opt.cls){ - dlg.el.removeClass(opt.cls); + onFieldRemoved: function(field) { + var me = this; + if (field.isCheckbox) { + me.mun(field, 'change', me.checkChange, me); } - progressBar.reset(); - }; + me.callParent(arguments); + }, - // private - var handleEsc = function(d, k, e){ - if(opt && opt.closable !== false){ - dlg.hide(); - handleHide(); - } - if(e){ - e.stopEvent(); - } - }; + // 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); + }, - // private - var updateButtons = function(b){ - var width = 0, - cfg; - if(!b){ - Ext.each(buttonNames, function(name){ - buttons[name].hide(); - }); - return width; + /** + * Runs CheckboxGroup's validations and returns an array of any errors. The only error by default + * is if allowBlank is set to true and no items are checked. + * @return {Array} Array of all validation errors + */ + getErrors: function() { + var errors = []; + if (!this.allowBlank && Ext.isEmpty(this.getChecked())) { + errors.push(this.blankText); } - dlg.footer.dom.style.display = ''; - Ext.iterate(buttons, function(name, btn){ - cfg = b[name]; - if(cfg){ - btn.show(); - btn.setText(Ext.isString(cfg) ? cfg : Ext.MessageBox.buttonText[name]); - width += btn.getEl().getWidth() + 15; - }else{ - btn.hide(); - } - }); - return width; - }; - - return { - /** - * Returns a reference to the underlying {@link Ext.Window} element - * @return {Ext.Window} The window - */ - getDialog : function(titleText){ - if(!dlg){ - var btns = []; - - buttons = {}; - Ext.each(buttonNames, function(name){ - btns.push(buttons[name] = new Ext.Button({ - text: this.buttonText[name], - handler: handleButton.createCallback(name), - hideMode: 'offsets' - })); - }, this); - dlg = new Ext.Window({ - autoCreate : true, - title:titleText, - resizable:false, - constrain:true, - constrainHeader:true, - minimizable : false, - maximizable : false, - stateful: false, - modal: true, - shim:true, - buttonAlign:"center", - width:400, - height:100, - minHeight: 80, - plain:true, - footer:true, - closable:true, - close : function(){ - if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){ - handleButton("no"); - }else{ - handleButton("cancel"); - } - }, - fbar: new Ext.Toolbar({ - items: btns, - enableOverflow: false - }) - }); - dlg.render(document.body); - dlg.getEl().addClass('x-window-dlg'); - mask = dlg.mask; - bodyEl = dlg.body.createChild({ - html:' ' - }); - 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(); - }, - - /** - * 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; - }, - - /** - * 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 : StringValue of the input field if either prompt - * or multiline is true - * 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 -}); - - * @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; - }, + return errors; + }, - /** - * 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; - }, + /** + * @private Returns all checkbox components within the container + */ + getBoxes: function() { + return this.query('[isCheckbox]'); + }, - /** - * 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; - }, + /** + * @private Convenience function which calls the given function for every checkbox in the group + * @param {Function} fn The function to call + * @param {Object} scope Optional scope object + */ + eachBox: function(fn, scope) { + Ext.Array.forEach(this.getBoxes(), fn, scope || this); + }, - /** - * 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; - }, + /** + * Returns an Array of all checkboxes in the container which are currently checked + * @return {Array} Array of Ext.form.field.Checkbox components + */ + getChecked: function() { + return Ext.Array.filter(this.getBoxes(), function(cb) { + return cb.getValue(); + }); + }, - /** - * 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; - }, + // private override + isDirty: function(){ + return Ext.Array.some(this.getBoxes(), function(cb) { + return cb.isDirty(); + }); + }, - /** - * 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; - }, + // private override + setReadOnly: function(readOnly) { + this.eachBox(function(cb) { + cb.setReadOnly(readOnly); + }); + this.readOnly = readOnly; + }, - /** - * 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 + /** + * Resets the checked state of all {@link Ext.form.field.Checkbox checkboxes} in the group to their + * originally loaded values and clears any validation messages. + * See {@link Ext.form.Basic}.{@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} + */ + reset: function() { + var me = this, + hadError = me.hasActiveError(), + preventMark = me.preventMark; + me.preventMark = true; + me.batchChanges(function() { + me.eachBox(function(cb) { + cb.reset(); }); - return this; - }, - - /** - * 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', - - /** - * 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" + }); + me.preventMark = preventMark; + me.unsetActiveError(); + if (hadError) { + me.doComponentLayout(); } - }; -}(); - -/** - * Shorthand for {@link Ext.MessageBox} - */ -Ext.Msg = Ext.MessageBox;/** - * @class Ext.dd.PanelProxy - * A custom drag proxy implementation specific to {@link Ext.Panel}s. This class is primarily used internally - * for the Panel's drag drop implementation, and should never need to be created directly. - * @constructor - * @param panel The {@link Ext.Panel} to proxy for - * @param config Configuration options - */ -Ext.dd.PanelProxy = function(panel, config){ - this.panel = panel; - this.id = this.panel.id +'-ddproxy'; - Ext.apply(this, config); -}; + }, -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). - */ - insertProxy : true, + // 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); + }, - // 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 + * 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 */ - getEl : function(){ - return this.ghost; + 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; }, - /** - * Gets the proxy's ghost element - * @return {Element} The proxy's ghost element - */ - getGhost : function(){ - return this.ghost; - }, /** - * Gets the proxy's element - * @return {Element} The proxy's element + * 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. */ - getProxy : function(){ - return this.proxy; + 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; }, - /** - * Hides the proxy + /* + * Don't return any data for submit; the form will get the info from the individual checkboxes themselves. */ - 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; - } + getSubmitData: function() { + return null; }, - /** - * Shows the proxy + /* + * Don't return any data for the model; the form will get the info from the individual checkboxes themselves. */ - show : function(){ - if(!this.ghost){ - this.ghost = this.panel.createGhost(undefined, undefined, Ext.getBody()); - this.ghost.setXY(this.panel.el.getXY()); - if(this.insertProxy){ - this.proxy = this.panel.el.insertSibling({cls:'x-panel-dd-spacer'}); - this.proxy.setSize(this.panel.getSize()); - } - this.panel.el.dom.style.display = 'none'; - } + getModelData: function() { + return null; }, - // private - repair : function(xy, callback, scope){ - this.hide(); - if(typeof callback == "function"){ - callback.call(scope || this); - } - }, + validate: function() { + var me = this, + errors = me.getErrors(), + isValid = Ext.isEmpty(errors), + wasValid = !me.hasActiveError(); - /** - * 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) - */ - moveProxy : function(parentNode, before){ - if(this.proxy){ - parentNode.insertBefore(this.proxy.dom, before); + if (isValid) { + me.unsetActiveError(); + } else { + me.setActiveError(errors); + } + if (isValid !== wasValid) { + me.fireEvent('validitychange', me, isValid); + me.doComponentLayout(); } - } -}; -// 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); + return isValid; } - (h ? h : this.panel.body).setStyle('cursor', 'move'); - this.scroll = false; -}; -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; +}, function() { + + this.borrow(Ext.form.field.Base, ['markInvalid', 'clearInvalid']); + +}); + + +/** + * @private + * Private utility class for managing all {@link Ext.form.field.Checkbox} fields grouped by name. + */ +Ext.define('Ext.form.CheckboxManager', { + extend: 'Ext.util.MixedCollection', + singleton: true, + + getByName: function(name) { + return this.filterBy(function(item) { + return item.name == name; + }); }, - endDrag : function(e){ - this.proxy.hide(); - this.panel.saveState(); + + getWithValue: function(name, value) { + return this.filterBy(function(item) { + return item.name == name && item.inputValue == value; + }); }, - autoOffset : function(x, y) { - x -= this.startPageX; - y -= this.startPageY; - this.setDelta(x, y); + getChecked: function(name) { + return this.filterBy(function(item) { + return item.name == name && item.checked; + }); } -});/** - * @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. +}); + +/** + * @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 + * Create a new FieldSet + * @param {Object} config Configuration options + * @xtype fieldset + * @docauthor Jason Johnston */ -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); - }, - +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'], + /** - * 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 + * @cfg {String} title + * A title to be displayed in the fieldset's legend. May contain HTML markup. */ - get : function(name, defaultValue){ - return typeof this.state[name] == "undefined" ? - defaultValue : this.state[name]; - }, /** - * Clears a value from the state - * @param {String} name The key name + * @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}. */ - clear : function(name){ - delete this.state[name]; - this.fireEvent("statechange", this, name, null); - }, /** - * Sets the value for a key - * @param {String} name The key name - * @param {Mixed} value The value to set + * @cfg {String} checkboxName + * The name to assign to the fieldset's checkbox if {@link #checkboxToggle} = true + * (defaults to '[fieldset id]-checkbox'). */ - set : function(name, value){ - this.state[name] = value; - this.fireEvent("statechange", this, name, value); - }, /** - * Decodes a string previously encoded with {@link #encodeValue}. - * @param {String} value The value to decode - * @return {Mixed} The decoded value + * @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. */ - 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; - } - }, /** - * Encodes a value including type information. Decode with {@link #decodeValue}. - * @param {Mixed} value The value to encode - * @return {String} The encoded value + * @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. */ - 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); - } -}); -/** - * @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 - */ -Ext.state.Manager = function(){ - var provider = new Ext.state.Provider(); + collapsed: false, - return { - /** - * Configures the default state provider for your application - * @param {Provider} stateProvider The state provider to set - */ - setProvider : function(stateProvider){ - provider = stateProvider; - }, + /** + * @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. + */ - /** - * 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); - }, + /** + * @cfg {String} baseCls The base CSS class applied to the fieldset (defaults to 'x-fieldset'). + */ + baseCls: Ext.baseCSSPrefix + 'fieldset', - /** - * 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); - }, + /** + * @cfg {String} layout The {@link Ext.container.Container#layout} for the fieldset's immediate child items. + * Defaults to 'anchor'. + */ + layout: 'anchor', - /** - * Clears a value from the state - * @param {String} name The key name - */ - clear : function(key){ - provider.clear(key); - }, + componentLayout: 'fieldset', - /** - * Gets the currently configured state provider - * @return {Provider} The state provider - */ - getProvider : function(){ - return provider; - } - }; -}(); -/** - * @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, { + // No aria role necessary as fieldset has its own recognized semantics + ariaRole: '', + + renderTpl: [''], - 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(); + maskOnDisable: false, + + getElConfig: function(){ + return {tag: 'fieldset', id: this.id}; }, - - // private - set : function(name, value){ - if(typeof value == "undefined" || value === null){ - this.clear(name); - return; + + initComponent: function() { + var me = this, + baseCls = me.baseCls; + + me.callParent(); + + // Create the Legend component if needed + me.initLegend(); + + // Add body el selector + Ext.applyIf(me.renderSelectors, { + body: '.' + baseCls + '-body' + }); + + if (me.collapsed) { + me.addCls(baseCls + '-collapsed'); + me.collapse(); } - 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); + onRender: function(container, position) { + this.callParent(arguments); + // Make sure the legend is created and rendered + this.initLegend(); }, - // 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); + /** + * @private + * Initialize and render the legend component if necessary + */ + initLegend: function() { + var me = this, + legendItems, + legend = me.legend; + + // Create the legend component if needed and it hasn't been already + if (!legend && (me.title || me.checkboxToggle || me.collapsible)) { + legendItems = []; + + // Checkbox + if (me.checkboxToggle) { + legendItems.push(me.createCheckboxCmp()); } + // Toggle button + else if (me.collapsible) { + legendItems.push(me.createToggleCmp()); + } + + // 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 + }); } - return cookies; - }, - // private - setCookie : function(name, value){ - document.cookie = "ys-"+ name + "=" + this.encodeValue(value) + - ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) + - ((this.path == null) ? "" : ("; path=" + this.path)) + - ((this.domain == null) ? "" : ("; domain=" + this.domain)) + - ((this.secure == true) ? "; secure" : ""); + // 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 + } }, - // private - clearCookie : function(name){ - document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" + - ((this.path == null) ? "" : ("; path=" + this.path)) + - ((this.domain == null) ? "" : ("; domain=" + this.domain)) + - ((this.secure == true) ? "; secure" : ""); - } -});/** - * @class Ext.DataView - * @extends Ext.BoxComponent - * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate} - * as its internal templating mechanism, and is bound to an {@link Ext.data.Store} - * so that as the data in the store changes the view is automatically updated to reflect the changes. The view also - * provides built-in behavior for many common events that can occur for its contained items including click, doubleclick, - * mouseover, mouseout, etc. as well as a built-in selection model. In order to use these features, an {@link #itemSelector} - * config must be provided for the DataView to determine what nodes it will be working with. - * - * 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>' -); + /** + * @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; + + }, -var panel = new Ext.Panel({ - id:'images-view', - frame:true, - width:535, - autoHeight:true, - collapsible:true, - layout:'fit', - title:'Simple DataView', + /** + * @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. + */ - 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 - */ -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}. + * @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 me.checkboxCmp; + }, + /** - * @cfg {Ext.data.Store} store - * The {@link Ext.data.Store} to bind this DataView to. + * @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. */ + /** - * @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. + * @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 */ + createToggleCmp: function() { + var me = this; + me.toggleCmp = Ext.create('Ext.panel.Tool', { + type: 'toggle', + handler: me.toggle, + scope: me + }); + return me.toggleCmp; + }, + /** - * @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). + * 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 {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. + * @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 {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). + * Expands the fieldset. + * @return {Ext.form.FieldSet} this */ + expand : function(){ + return this.setExpanded(true); + }, + /** - * @cfg {String} overClass - * A CSS class to apply to each item in the view on mouseover (defaults to undefined). + * Collapses the fieldset. + * @return {Ext.form.FieldSet} this */ + collapse : function() { + return this.setExpanded(false); + }, + /** - * @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. + * @private Collapse or expand the fieldset */ + setExpanded: function(expanded) { + var me = this, + checkboxCmp = me.checkboxCmp; + + expanded = !!expanded; + + if (checkboxCmp) { + checkboxCmp.setValue(expanded); + } + + if (expanded) { + me.removeCls(me.baseCls + '-collapsed'); + } else { + me.addCls(me.baseCls + '-collapsed'); + } + me.collapsed = !expanded; + if (expanded) { + // ensure subitems will get rendered and layed out when expanding + me.getComponentLayout().childrenChanged = true; + } + me.doComponentLayout(); + return me; + }, + /** - * @cfg {String} selectedClass - * A CSS class to apply to each selected item in the view (defaults to 'x-view-selected'). + * Toggle the fieldset's collapsed state to the opposite of what it is currently */ - selectedClass : "x-view-selected", + toggle: function() { + this.setExpanded(!!this.collapsed); + }, + /** - * @cfg {String} emptyText - * The text to display in the view when there is no data to display (defaults to ''). + * @private Handle changes in the checkbox checked state */ - emptyText : "", + onCheckChange: function(cmp, checked) { + this.setExpanded(checked); + }, + + beforeDestroy : function() { + var legend = this.legend; + if (legend) { + legend.destroy(); + } + this.callParent(); + } +}); + +/** + * @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.define('Ext.form.Label', { + extend:'Ext.Component', + alias: 'widget.label', + requires: ['Ext.util.Format'], /** - * @cfg {Boolean} deferEmptyText True to defer emptyText being applied until the store's first load + * @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. */ - deferEmptyText: true, /** - * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events + * @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. + */ + /** + * @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. */ - trackOver: false, + 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 || '') + }; + }, + /** - * @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) + * 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 */ - blockRefresh: false, + setText : function(text, encode){ + var me = this; + + encode = encode !== false; + if(encode) { + me.text = text; + delete me.html; + } else { + me.html = text; + delete me.text; + } + + if(me.rendered){ + me.el.dom.innerHTML = encode !== false ? Ext.util.Format.htmlEncode(text) : text; + } + return this; + } +}); - //private - last: 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); - } +/** + * @class Ext.form.Panel + * @extends Ext.panel.Panel - 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", +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. - /** - * @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" - ); +__Layout__ - this.store = Ext.StoreMgr.lookup(this.store); - this.all = new Ext.CompositeElementLite(); - this.selected = new Ext.CompositeElementLite(); - }, +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}. - // private - afterRender : function(){ - Ext.DataView.superclass.afterRender.call(this); +__BasicForm__ - this.mon(this.getTemplateTarget(), { - "click": this.onClick, - "dblclick": this.onDblClick, - "contextmenu": this.onContextMenu, - scope:this - }); +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. - if(this.overClass || this.trackOver){ - this.mon(this.getTemplateTarget(), { - "mouseover": this.onMouseOver, - "mouseout": this.onMouseOut, - scope:this - }); - } +**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} + +__Field Defaults__ + +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. + +__Form Validation__ + +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}. + +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. + +For more information on form validation see the following: + +- {@link Ext.form.field.Field#validateOnChange} +- {@link #pollForChanges} and {@link #pollInterval} +- {@link Ext.form.field.VTypes} +- {@link Ext.form.Basic#doAction BasicForm.doAction clientValidation notes} - if(this.store){ - this.bindStore(this.store, true); - } - }, +__Form Submission__ - /** - * 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); +By default, Ext Forms are submitted through Ajax, using {@link Ext.form.action.Action}. See the documentation for +{@link Ext.form.Basic} for details. +{@img Ext.form.FormPanel/Ext.form.FormPanel.png Ext.form.FormPanel FormPanel component} +__Example usage:__ + + Ext.create('Ext.form.Panel', { + title: 'Simple Form', + bodyPadding: 5, + width: 350, + + // The form will submit an AJAX request to this URL when submitted + url: 'save-form.php', + + // Fields will be arranged vertically, stretched to full width + layout: 'anchor', + defaults: { + anchor: '100%' + }, + + // The fields + defaultType: 'textfield', + items: [{ + fieldLabel: 'First Name', + name: 'first', + allowBlank: false + },{ + fieldLabel: 'Last Name', + name: 'last', + allowBlank: false + }], + + // Reset and Submit buttons + buttons: [{ + text: 'Reset', + handler: function() { + this.up('form').getForm().reset(); } - this.all.clear(); - }else{ - this.tpl.overwrite(el, this.collectData(records, 0)); - this.all.fill(Ext.query(this.itemSelector, el.dom)); - this.updateIndexes(0); - } - this.hasSkippedEmptyText = true; - }, + }, { + 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() + }); - getTemplateTarget: function(){ - return this.el; + * @constructor + * @param {Object} config Configuration options + * @xtype form + * + * @markdown + * @docauthor Jason Johnston + */ +Ext.define('Ext.form.Panel', { + extend:'Ext.panel.Panel', + mixins: { + fieldAncestor: 'Ext.form.FieldAncestor' }, + alias: 'widget.form', + alternateClassName: ['Ext.FormPanel', 'Ext.form.FormPanel'], + requires: ['Ext.form.Basic', 'Ext.util.TaskRunner'], /** - * 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'})) + * @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. */ - prepareData : function(data){ - return data; - }, /** - * 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. + * @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. */ - 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]); - } - return r; - }, - // private - bufferRender : function(records){ - var div = document.createElement('div'); - this.tpl.overwrite(div, this.collectData(records)); - return Ext.query(this.itemSelector, div); - }, + /** + * @cfg {String} layout The {@link Ext.container.Container#layout} for the form panel's immediate child items. + * Defaults to 'anchor'. + */ + layout: 'anchor', - // 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]; + ariaRole: 'form', - this.all.replaceElement(index, node, true); - if(sel){ - this.selected.replaceElement(original, node); - this.all.item(index).addClass(this.selectedClass); - } - this.updateIndexes(index, index); + initComponent: function() { + var me = this; + + if (me.frame) { + me.border = false; } - }, + + me.initFieldAncestor(); + me.callParent(); - // 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); + me.relayEvents(me.form, [ + 'beforeaction', + 'actionfailed', + 'actioncomplete', + 'validitychange', + 'dirtychange' + ]); + + // Start polling if configured + if (me.pollForChanges) { + me.startPolling(me.pollInterval || 500); } - this.updateIndexes(index); }, - // private - onRemove : function(ds, record, index){ - this.deselect(index); - this.all.removeElement(index, true); - this.updateIndexes(index); - if (this.store.getCount() === 0){ - this.refresh(); - } + initItems: function() { + // Create the BasicForm + var me = this; + + me.form = me.createForm(); + me.callParent(); + me.form.initialize(); }, /** - * Refreshes an individual node's data from the store. - * @param {Number} index The item's data index in the store + * @private */ - refreshNode : function(index){ - this.onUpdate(this.store, this.store.getAt(index)); + createForm: function() { + return Ext.create('Ext.form.Basic', this, Ext.applyIf({listeners: {}}, this.initialConfig)); }, - // 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 + * 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. */ - getStore : function(){ - return this.store; + getForm: function() { + return this.form; }, - + /** - * Changes the data store bound to this view and refreshes it. - * @param {Store} store The store to bind to this view + * 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 */ - 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(); - } + loadRecord: function(record) { + return this.getForm().loadRecord(record); }, /** - * @private - * Calls this.refresh if this.blockRefresh is not true + * Returns the currently loaded Ext.data.Model instance if one was loaded via {@link #loadRecord}. + * @return {Ext.data.Model} The loaded instance */ - onDataChanged: function() { - if (this.blockRefresh !== true) { - this.refresh.apply(this, arguments); - } + getRecord: function() { + return this.getForm().getRecord(); }, - + /** - * 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 + * 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 */ - findItemFromChild : function(node){ - return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget()); - }, - - // 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(); - }, - - // 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); - } - }, - - // private - onDblClick : function(e){ - var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); - if(item){ - this.fireEvent("dblclick", this, this.indexOf(item), item, e); - } - }, - - // 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); - } + getValues: function() { + return this.getForm().getValues(); }, - // 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; - } - } + beforeDestroy: function() { + this.stopPolling(); + this.form.destroy(); + this.callParent(); }, - // 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(); - } - return true; + /** + * 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) + */ + load: function(options) { + this.form.load(options); }, - // private - doSingleSelection : function(item, index, e){ - if(e.ctrlKey && this.isSelected(index)){ - this.deselect(index); - }else{ - this.select(index, 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) + */ + submit: function(options) { + this.form.submit(options); }, - // 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); - } - } + /* + * Inherit docs, not using onDisable because it only gets fired + * when the component is rendered. + */ + disable: function(silent) { + this.callParent(arguments); + this.form.getFields().each(function(field) { + field.disable(); + }); }, - /** - * Gets the number of selected nodes. - * @return {Number} The node count + /* + * Inherit docs, not using onEnable because it only gets fired + * when the component is rendered. */ - getSelectionCount : function(){ - return this.selected.getCount(); + enable: function(silent) { + this.callParent(arguments); + this.form.getFields().each(function(field) { + field.enable(); + }); }, /** - * Gets the currently selected nodes. - * @return {Array} An array of HTMLElements + * 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. */ - getSelectedNodes : function(){ - return this.selected.elements; + 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; }, /** - * Gets the indexes of the selected nodes. - * @return {Array} An array of numeric indexes + * Stop a running interval task that was started by {@link #startPolling}. */ - getSelectedIndexes : function(){ - var indexes = [], s = this.selected.elements; - for(var i = 0, len = s.length; i < len; i++){ - indexes.push(s[i].viewIndex); + stopPolling: function() { + var task = this.pollTask; + if (task) { + task.stopAll(); + delete this.pollTask; } - return indexes; }, /** - * Gets an array of the selected records - * @return {Array} An array of {@link Ext.data.Record} objects + * Forces each field within the form panel to + * {@link Ext.form.field.Field#checkChange check if its value has changed}. */ - 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; - }, + checkChange: function() { + this.form.getFields().each(function(field) { + field.checkChange(); + }); + } +}); + +/** + * @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', /** - * Gets an array of the records from an array of nodes - * @param {Array} nodes The nodes to evaluate - * @return {Array} records The {@link Ext.data.Record} objects + * @cfg {Array} items An Array of {@link Ext.form.field.Radio Radio}s or Radio config objects + * to arrange in the group. */ - 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; - }, - /** - * Gets a record from a node - * @param {HTMLElement} node The node to evaluate - * @return {Record} record The {@link Ext.data.Record} object + * @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. */ - getRecord : function(node){ - return this.store.getAt(node.viewIndex); - }, - + allowBlank : true, /** - * Clears all selections. - * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event + * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails + * (defaults to 'You must select one item in this group') */ - 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); - } - } + blankText : 'You must select one item in this group', + + // private + defaultType : 'radiofield', + + // private + groupCls : Ext.baseCSSPrefix + 'form-radio-group', + + getBoxes: function() { + return this.query('[isRadio]'); + } + +}); + +/** + * @private + * Private utility class for managing all {@link Ext.form.field.Radio} fields grouped by name. + */ +Ext.define('Ext.form.RadioManager', { + extend: 'Ext.util.MixedCollection', + singleton: true, + + getByName: function(name) { + return this.filterBy(function(item) { + return item.name == name; + }); }, - /** - * 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)); + getWithValue: function(name, value) { + return this.filterBy(function(item) { + return item.name == name && item.inputValue == value; + }); }, - /** - * Deselects a node. - * @param {HTMLElement/Number/Record} node The node, node index or record to deselect - */ - deselect : function(node){ - if(this.isSelected(node)){ - node = this.getNode(node); - this.selected.removeElement(node); - if(this.last == node.viewIndex){ - this.last = false; + getChecked: function(name) { + return this.findBy(function(item) { + return item.name == name && item.checked; + }); + } +}); + +/** + * @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, + + // 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'] +}); + +// 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" } - Ext.fly(node).removeClass(this.selectedClass); - this.fireEvent("selectionchange", this, this.selected.elements); } + } +] + * + */ +Ext.define('Ext.form.action.DirectLoad', { + extend:'Ext.form.action.Load', + requires: ['Ext.direct.Manager'], + alternateClassName: 'Ext.form.Action.DirectLoad', + alias: 'formaction.directload', + + type: 'directload', + + run: function() { + this.form.api.load.apply(window, this.getArgs()); }, /** - * 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 + * @private + * Build the arguments to be sent to the Direct call. + * @return Array */ - 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); - } - } + 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]]); } } + // 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; }, - /** - * 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 - */ - selectRange : function(start, end, keepExisting){ - if(!keepExisting){ - this.clearSelections(true); - } - this.select(this.getNodes(start, end), 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); }, - /** - * 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 - */ - 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]; + onSuccess: function(result, trans) { + if (trans.type == Ext.direct.Manager.self.exceptions.SERVER) { + result = {}; } - return nodeInfo; - }, + this.callParent([result]); + } +}); - /** - * 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]); - } + + +/** + * @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 + } + }); } - return nodes; + }], + + // configs apply to child items + defaults: {anchor: '100%'}, + defaultType: 'textfield', + items: [{ + fieldLabel: 'Name', + name: 'name' + },{ + fieldLabel: 'Email', + name: 'email' + },{ + fieldLabel: 'Company', + name: 'company' + }], + + // configs for BasicForm + api: { + // The server-side method to call for load() requests + load: Profile.getBasicInfo, + // The server-side must mark the submit handler as a 'formHandler' + submit: Profile.updateBasicInfo }, + // specify the order for the passed params + paramOrder: ['uid', 'foo'] +}); + * + * The 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." + } + } +} + * + * 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 + } + } +] - /** - * 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; +// sample failure packet (one request) +{ + "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6", + "result":{ + "errors":{ + "email":"already taken" + }, + "success":false, + "foo":"bar" } - return this.all.indexOf(node); +} + * + * Also see the discussion in {@link Ext.form.action.DirectLoad}. + */ +Ext.define('Ext.form.action.DirectSubmit', { + extend:'Ext.form.action.Submit', + requires: ['Ext.direct.Manager'], + alternateClassName: 'Ext.form.Action.DirectSubmit', + alias: 'formaction.directsubmit', + + type: 'directsubmit', + + doSubmit: function() { + var me = this, + callback = Ext.Function.bind(me.onSuccess, me), + formEl = me.buildForm(); + me.form.api.submit(formEl, callback, me); + Ext.removeNode(formEl); }, - // private - onBeforeLoad : function(){ - if(this.loadingText){ - this.clearSelections(false, true); - this.getTemplateTarget().update(''+this.loadingText+''); - this.all.clear(); - } + // 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); }, - onDestroy : function(){ - this.all.clear(); - this.selected.clear(); - Ext.DataView.superclass.onDestroy.call(this); - this.bindStore(null); + onSuccess: function(response, trans) { + if (trans.type === Ext.direct.Manager.self.exceptions.SERVER) { + response = {}; + } + this.callParent([response]); } }); /** - * 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 + * @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.DataView.prototype.setStore = Ext.DataView.prototype.bindStore; +Ext.define('Ext.form.action.StandardSubmit', { + extend:'Ext.form.action.Submit', + alias: 'formaction.standardsubmit', -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(); + /** + * @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. + */ -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' - }] -}); + /** + * @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); + } -// put it in a Panel so it looks pretty -var panel = new Ext.Panel({ - id:'images-view', - width:425, - height:250, - collapsible:true, - layout:'fit', - title:'Simple ListView (0 items selected)', - items: listView }); -panel.render(document.body); -// 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.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() + }); + * @constructor - * @param {Object} config - * @xtype listview + * Creates a new Checkbox + * @param {Object} config Configuration options + * @xtype checkboxfield + * @docauthor Robert Dougan + * @markdown */ -Ext.list.ListView = Ext.extend(Ext.DataView, { +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: [ + '', + '{boxLabel}', + '', + // 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" />', + '', + '{boxLabel}', + '', + { + disableFormats: true, + compiled: true + } + ], + + isCheckbox: true, + /** - * Set this property to true to disable the header click handler disabling sort - * (defaults to false). - * @type Boolean - * @property disableHeaders + * @cfg {String} focusCls The CSS class to use when the checkbox receives focus + * (defaults to 'x-form-cb-focus') */ + focusCls: Ext.baseCSSPrefix + 'form-cb-focus', + /** - * @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} fieldCls The default CSS class for the checkbox (defaults to 'x-form-field') */ + /** - * @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. + * @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. */ - itemSelector: 'dl', + fieldBodyCls: Ext.baseCSSPrefix + 'form-cb-wrap', + /** - * @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 + * @cfg {Boolean} checked true if the checkbox should render initially checked (defaults to false) */ - selectedClass:'x-list-selected', + checked: false, + /** - * @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} checkedCls The CSS class added to the component's main element when it is in the checked state. */ - overClass:'x-list-over', + checkedCls: Ext.baseCSSPrefix + 'form-cb-checked', + /** - * @cfg {Boolean} reserveScrollOffset - * By default will defer accounting for the configured {@link #scrollOffset} - * for 10 milliseconds. Specify true to account for the configured - * {@link #scrollOffset} immediately. + * @cfg {String} 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). */ + /** - * @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} boxLabelCls The CSS class to be applied to the {@link #boxLabel} element */ - scrollOffset : undefined, + boxLabelCls: Ext.baseCSSPrefix + 'form-cb-label', + /** - * @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 {String} boxLabelAlign The position relative to the checkbox where the {@link #boxLabel} should + * appear. Recognized values are 'before' and 'after'. Defaults to 'after'. */ - columnResize: true, + boxLabelAlign: 'after', + /** - * @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 {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". */ + inputValue: 'on', + /** - * @cfg {Boolean/Object} columnSort - * Specify true or specify a configuration object for {@link Ext.list.ListView.Sorter} - * to enable the columns to be sortable (defaults to true). + * @cfg {String} 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). */ - columnSort: true, + /** - * @cfg {String/Array} internalTpl - * The template to be used for the header row. See {@link #tpl} for more details. + * @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. + * */ - /* - * IE has issues when setting percentage based widths to 100%. Default to 99. + /** + * @cfg {Object} scope An object to use as the scope ('this' reference) of the {@link #handler} function + * (defaults to this Checkbox). */ - 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)]}', - '', - '', - '', - '', - '' - ); - }; - - var cs = this.columns, - allocatedWidth = 0, - colsWithWidth = 0, - len = cs.length, - columns = []; - - 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); - } - - cs = this.columns = columns; - - // 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); - }, - onRender : function(){ - this.autoEl = { - cls: 'x-list-wrap' - }; - Ext.list.ListView.superclass.onRender.apply(this, arguments); - - this.internalTpl.overwrite(this.el, {columns: this.columns}); + // private overrides + checkChangeEvents: [], + inputType: 'checkbox', + ariaRole: 'checkbox', - this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild); - this.innerHd = Ext.get(this.el.dom.firstChild.firstChild); + // private + onRe: /^on$/i, - if(this.hideHeaders){ - this.el.dom.firstChild.style.display = 'none'; - } + initComponent: function(){ + this.callParent(arguments); + this.getManager().add(this); }, - getTemplateTarget : function(){ - return this.innerBody; - }, + initValue: function() { + var me = this, + checked = !!me.checked; - /** - * 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. - */ - collectData : function(){ - var rs = Ext.list.ListView.superclass.collectData.apply(this, arguments); - return { - columns: this.columns, - rows: rs - } - }, + /** + * 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; - verifyInternalSize : function(){ - if(this.lastSize){ - this.onResize(this.lastSize.width, this.lastSize.height); - } + // Set the initial checked state + me.setValue(checked); }, // 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); - } - } - if(Ext.isNumber(h)){ - bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px'; - } - }, + 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 + }); - updateIndexes : function(){ - Ext.list.ListView.superclass.updateIndexes.apply(this, arguments); - this.verifyInternalSize(); + me.callParent(arguments); }, - findHeaderIndex : function(hd){ - hd = hd.dom || hd; - var pn = hd.parentNode, cs = pn.parentNode.childNodes; - for(var i = 0, c; c = cs[i]; i++){ - if(c == pn){ - return i; - } - } - return -1; + initEvents: function() { + var me = this; + me.callParent(); + me.mon(me.inputEl, 'click', me.onBoxClick, me); }, - 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); - -// 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. + * @private Handle click on the checkbox button */ - isColumn: true, - - /** - * @cfg {String} align - * Set the CSS text-align property of the column. Defaults to 'left'. - */ - align: 'left', - /** - * @cfg {String} header Optional. The header text to be used as innerHTML - * (html tags are accepted) to display in the ListView. Note: to - * have a clickable header with no text displayed use ' '. - */ - header: '', - - /** - * @cfg {Number} width Optional. Percentage of the container width - * this column should be allocated. Columns that have no width specified will be - * allocated with an equal percentage to fill 100% of the container width. To easily take - * advantage of the full container width, leave the width of at least one column undefined. - * Note that if you do not want to take up the full width of the container, the width of - * every column needs to be explicitly defined. - */ - width: null, + onBoxClick: function(e) { + var me = this; + if (!me.disabled && !me.readOnly) { + this.setValue(!this.checked); + } + }, /** - * @cfg {String} cls Optional. This option can be used to add a CSS class to the cell of each - * row for this column. + * Returns the checked state of the checkbox. + * @return {Boolean} True if checked, else false */ - cls: '', - + getRawValue: function() { + return this.checked; + }, + /** - * @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. + * Returns the checked state of the checkbox. + * @return {Boolean} True if checked, else false */ + getValue: function() { + return this.checked; + }, /** - * @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. + * 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. */ - - constructor : function(c){ - if(!c.tpl){ - c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}'); - } - else if(Ext.isString(c.tpl)){ - c.tpl = new Ext.XTemplate(c.tpl); - } - - Ext.apply(this, c); - } -}); - -Ext.reg('lvcolumn', Ext.list.Column); + getSubmitValue: function() { + var unchecked = this.uncheckedValue, + uncheckedVal = Ext.isDefined(unchecked) ? unchecked : null; + return this.checked ? this.inputValue : uncheckedVal; + }, -/** - * @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); - } -}); + * Sets the checked state of the checkbox. + * @param {Boolean/String} value The following values will check the checkbox: + * true, 'true', '1', or 'on', as well as a String that matches the {@link #inputValue}. + * Any other value will uncheck the checkbox. + * @return {Boolean} the new checked state of the checkbox + */ + setRawValue: function(value) { + var me = this, + inputEl = me.inputEl, + inputValue = me.inputValue, + checked = (value === true || value === 'true' || value === '1' || + ((Ext.isString(value) && inputValue) ? value == inputValue : me.onRe.test(value))); -Ext.reg('lvnumbercolumn', Ext.list.NumberColumn); + if (inputEl) { + inputEl.dom.setAttribute('aria-checked', checked); + me[checked ? 'addCls' : 'removeCls'](me.checkedCls); + } -/** - * @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); - } -}); -Ext.reg('lvdatecolumn', Ext.list.DateColumn); + me.checked = me.rawValue = checked; + return checked; + }, -/** - * @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. - */ -Ext.list.BooleanColumn = Ext.extend(Ext.list.Column, { - /** - * @cfg {String} trueText - * The string returned by the renderer when the column value is not falsey (defaults to 'true'). - */ - trueText: 'true', - /** - * @cfg {String} falseText - * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to - * 'false'). - */ - falseText: 'false', /** - * @cfg {String} undefinedText - * The string returned by the renderer when the column value is undefined (defaults to ' '). + * 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 */ - undefinedText: ' ', - - constructor : function(c) { - c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':this.format}'); - - var t = this.trueText, f = this.falseText, u = this.undefinedText; - c.tpl.format = function(v){ - if(v === undefined){ - return u; - } - if(!v || v === 'false'){ - return f; - } - return t; - }; - - Ext.list.DateColumn.superclass.constructor.call(this, c); - } -}); + setValue: function(checked) { + var me = 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, + // 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); + } - constructor: function(config){ - Ext.apply(this, config); - Ext.list.ColumnResizer.superclass.constructor.call(this); + return me; }, - init : function(listView){ - this.view = listView; - listView.on('render', this.initEvents, this); + + // private + valueToRaw: function(value) { + // No extra conversion for checkboxes + return value; }, - 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 = ''; - } + /** + * @private + * Called when the checkbox's checked state changes. Invokes the {@link #handler} callback + * function if specified. + */ + onChange: function(newVal, oldVal) { + var me = this, + handler = me.handler; + if (handler) { + handler.call(me.scope || me, me, newVal); } + me.callParent(arguments); }, - onBeforeStart : function(e){ - this.dragHd = this.activeHd; - return !!this.dragHd; + // inherit docs + getManager: function() { + return Ext.form.CheckboxManager; }, - onStart: function(e){ - this.view.disableHeaders = true; - this.proxy = this.view.el.createChild({cls:'x-list-resizer'}); - this.proxy.setHeight(this.view.el.getHeight()); - - var x = this.tracker.getXY()[0], - w = this.view.innerHd.getWidth(); - - this.hdX = this.dragHd.getX(); - this.hdIndex = this.view.findHeaderIndex(this.dragHd); - - this.proxy.setX(this.hdX); - this.proxy.setWidth(x-this.hdX); - - this.minWidth = w*this.minPct; - this.maxWidth = w - (this.minWidth*(this.view.columns.length-1-this.hdIndex)); + 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; + } }, - onDrag: function(e){ - var cursorX = this.tracker.getXY()[0]; - this.proxy.setWidth((cursorX-this.hdX).constrain(this.minWidth, this.maxWidth)); + 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; }, - onEnd: function(e){ - /* calculate desired width by measuring proxy and then remove it */ - var nw = this.proxy.getWidth(); - this.proxy.remove(); - - 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); + /** + * @protected Calculate and return the natural width of the bodyEl. It's possible that the initial + * rendering will cause the boxLabel to wrap and give us a bad width, so we must prevent wrapping + * while measuring. + */ + getBodyNaturalWidth: function() { + var me = this, + bodyEl = me.bodyEl, + ws = 'white-space', + width; + bodyEl.setStyle(ws, 'nowrap'); + width = bodyEl.getWidth(); + bodyEl.setStyle(ws, ''); + return width; } + }); -// 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 +/** + * @private + * @class Ext.layout.component.field.Trigger + * @extends Ext.layout.component.field.Field + * Layout class for {@link Ext.form.field.Trigger} fields. Adjusts the input field size to accommodate + * the trigger button(s). + * @private */ -Ext.list.Sorter = Ext.extend(Ext.util.Observable, { - /** - * @cfg {Array} sortClasses - * The CSS classes applied to a header when it is sorted. (defaults to ["sort-asc", "sort-desc"]) - */ - sortClasses : ["sort-asc", "sort-desc"], - constructor: function(config){ - Ext.apply(this, config); - Ext.list.Sorter.superclass.constructor.call(this); - }, +Ext.define('Ext.layout.component.field.Trigger', { - init : function(listView){ - this.view = listView; - listView.on('render', this.initEvents, this); - }, + /* Begin Definitions */ - 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]); - }, + alias: ['layout.triggerfield'], - 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); - } - }, + extend: 'Ext.layout.component.field.Field', - 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]); - }, + /* End Definitions */ - 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); + 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); } } }); - -// 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'}. +/** + * @class Ext.view.View + * @extends Ext.view.AbstractView * - * 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. - * + * 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. * - * 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). - * + * The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.panel.Panel}. * - * 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'} - ] -}); - -// 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. - * + * {@img Ext.DataView/Ext.DataView.png Ext.DataView component} * - * + * Ext.regModel('Image', { + * Fields: [ + * {name:'src', type:'string'}, + * {name:'caption', type:'string'} + * ] + * }); + * + * Ext.create('Ext.data.Store', { + * id:'imagesStore', + * model: 'Image', + * data: [ + * {src:'http://www.sencha.com/img/20110215-feat-drawing.png', caption:'Drawing & Charts'}, + * {src:'http://www.sencha.com/img/20110215-feat-data.png', caption:'Advanced Data'}, + * {src:'http://www.sencha.com/img/20110215-feat-html5.png', caption:'Overhauled Theme'}, + * {src:'http://www.sencha.com/img/20110215-feat-perf.png', caption:'Performance Tuned'} + * ] + * }); + * + * var imageTpl = new Ext.XTemplate( + * '<tpl for=".">', + * '<div style="thumb-wrap">', + * '<img src="{src}" />', + * '<br/><span>{caption}</span>', + * '</div>', + * '</tpl>' + * ); + * + * Ext.create('Ext.DataView', { + * store: Ext.data.StoreManager.lookup('imagesStore'), + * tpl: imageTpl, + * itemSelector: 'div.thumb-wrap', + * emptyText: 'No images available', + * renderTo: Ext.getBody() + * }); * - * @extends Ext.Panel - * @constructor - * @param {Object} config The configuration options - * @xtype tabpanel + * @xtype dataview */ -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}. - */ - /** - * @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. - */ - /** - * @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}. - */ - deferredRender : true, - /** - * @cfg {Number} tabWidth The initial width in pixels of each new tab (defaults to 120). - */ - tabWidth : 120, - /** - * @cfg {Number} minTabWidth The minimum width in pixels for each tab when {@link #resizeTabs} = true (defaults to 30). - */ - minTabWidth : 30, - /** - * @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). - */ - resizeTabs : false, - /** - * @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). - */ - 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. - */ - scrollIncrement : 0, - /** - * @cfg {Number} scrollRepeatInterval Number of milliseconds between each scroll while a tab scroll button is - * continuously pressed (defaults to 400). - */ - scrollRepeatInterval : 400, - /** - * @cfg {Float} scrollDuration The number of milliseconds that each scroll animation should last (defaults - * to .35). Only applies when {@link #animScroll} = true. - */ - scrollDuration : 0.35, - /** - * @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. - */ - animScroll : true, - /** - * @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'. - */ - 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 -}); - -// 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, - /** - * @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) - */ - tabMargin : 2, - /** - * @cfg {Boolean} plain true to render the tab strip without a background container image - * (defaults to false). - */ - plain : false, - /** - * @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. - */ - idDelimiter : '__', - - // private - itemCls : 'x-tab-item', - - // private config overrides - elements : 'body', - headerAsText : false, - frame : false, - hideBorders :true, - - // private - initComponent : function(){ - this.frame = false; - Ext.TabPanel.superclass.initComponent.call(this); +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 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 + * @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 */ - 'beforetabchange', + 'beforeitemmousedown', /** - * @event tabchange - * Fires after the active tab has changed. - * @param {TabPanel} this - * @param {Panel} tab The new active tab + * @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 */ - 'tabchange', + 'beforeitemmouseup', /** - * @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 + * @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 */ - '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))); + '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 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. + */ + 'containerkeydown', - 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(); + /** + * @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' + ); }, - // 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'); - } - - 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); - - // 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); - - /** - * @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 || '' - }); - }, - 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; - } + 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 + }; - this.items.each(this.initTab, this); - }, + me.mon(me.getTargetEl(), listeners); - // 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); + if (me.store) { + me.bindStore(me.store, true); } }, - // private - initEvents : function(){ - Ext.TabPanel.superclass.initEvents.call(this); - this.mon(this.strip, { - scope: this, - mousedown: this.onStripMouseDown, - contextmenu: this.onStripContextMenu - }); - if(this.enableTabScroll){ - this.mon(this.strip, 'mousewheel', this.onWheel, this); + handleEvent: function(e) { + if (this.processUIEvent(e) !== false) { + this.processSpecialEvent(e); } }, - // private - findTargets : function(e){ - var item = null, - itemEl = e.getTarget('li:not(.x-tab-edge)', this.strip); + // Private template method + processItemEvent: Ext.emptyFn, + processContainerEvent: Ext.emptyFn, + processSpecialEvent: Ext.emptyFn, - if(itemEl){ - item = this.getComponent(itemEl.id.split(this.idDelimiter)[1]); - if(item.disabled){ - return { - close : null, - item : null, - el : null - }; - } + /* + * Returns true if this mouseover/out event is still over the overItem. + */ + stillOverItem: function (event, overItem) { + var nowOver; + + // There is this weird bug when you hover over the border of a cell it is saying + // the target is the table. + // BrowserBug: IE6 & 7. If me.mouseOverItem has been removed and is no longer + // in the DOM then accessing .offsetParent will throw an "Unspecified error." exception. + // typeof'ng and checking to make sure the offsetParent is an object will NOT throw + // this hard exception. + if (overItem && typeof(overItem.offsetParent) === "object") { + // mouseout : relatedTarget == nowOver, target == wasOver + // mouseover: relatedTarget == wasOver, target == nowOver + nowOver = (event.type == 'mouseout') ? event.getRelatedTarget() : event.getTarget(); + return Ext.fly(overItem).contains(nowOver); } - return { - close : e.getTarget('.x-tab-strip-close', this.strip), - item : item, - el : itemEl - }; + + return false; }, - // private - onStripMouseDown : function(e){ - if(e.button !== 0){ - return; + processUIEvent: function(e) { + var me = this, + item = e.getTarget(me.getItemSelector(), me.getTargetEl()), + map = this.statics().EventMap, + index, record, + type = e.type, + overItem = me.mouseOverItem, + newType; + + if (!item) { + if (type == 'mouseover' && me.stillOverItem(e, overItem)) { + item = overItem; + } + + // Try to get the selected item to handle the keydown event, otherwise we'll just fire a container keydown event + if (type == 'keydown') { + record = me.getSelectionModel().getLastSelected(); + if (record) { + item = me.getNode(record); + } + } } - 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); + + if (item) { + index = me.indexOf(item); + if (!record) { + record = me.getRecord(item); } - return; + + if (me.processItemEvent(record, item, index, e) === false) { + return false; + } + + newType = me.isNewItemEvent(item, e); + if (newType === false) { + return false; + } + + if ( + (me['onBeforeItem' + map[newType]](record, item, index, e) === false) || + (me.fireEvent('beforeitem' + newType, me, record, item, index, e) === false) || + (me['onItem' + map[newType]](record, item, index, e) === false) + ) { + return false; + } + + me.fireEvent('item' + newType, me, record, item, index, e); } - if(t.item && t.item != this.activeTab){ - this.setActiveTab(t.item); + else { + if ( + (me.processContainerEvent(e) === false) || + (me['onBeforeContainer' + map[type]](e) === false) || + (me.fireEvent('beforecontainer' + type, me, e) === false) || + (me['onContainer' + map[type]](e) === false) + ) { + return false; + } + + me.fireEvent('container' + type, me, e); } + + return true; }, - // private - onStripContextMenu : function(e){ - e.preventDefault(); - var t = this.findTargets(e); - if(t.item){ - this.fireEvent('contextmenu', this, t.item, e); + isNewItemEvent: function (item, e) { + var me = this, + overItem = me.mouseOverItem, + type = e.type; + + switch (type) { + case 'mouseover': + if (item === overItem) { + return false; + } + me.mouseOverItem = item; + return 'mouseenter'; + + case 'mouseout': + // If the currently mouseovered item contains the mouseover target, it's *NOT* a mouseleave + if (me.stillOverItem(e, overItem)) { + return false; + } + me.mouseOverItem = null; + return 'mouseleave'; } + return type; }, - /** - * True to scan the markup in this tab panel for {@link #autoTabs} using the - * {@link #autoTabSelector} - * @param {Boolean} removeExisting True to remove existing tabs - */ - readTabs : function(removeExisting){ - if(removeExisting === true){ - this.items.each(function(item){ - this.remove(item); - }, this); - } - var tabs = this.el.query(this.autoTabSelector); - for(var i = 0, len = tabs.length; i < len; i++){ - var tab = tabs[i], - title = tab.getAttribute('title'); - tab.removeAttribute('title'); - this.add({ - title: title, - contentEl: tab - }); + // private + onItemMouseEnter: function(record, item, index, e) { + if (this.trackOver) { + this.highlightItem(item); } }, // 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); - }); - - if(item.tabTip){ - tabEl.child('span.x-tab-strip-text', true).qtip = item.tabTip; + onItemMouseLeave : function(record, item, index, e) { + if (this.trackOver) { + this.clearHighlight(); } - item.tabEl = el; - - // 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 - }); }, + // @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, /** - * 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. + * 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 */ - getTemplateArgs : function(item) { - var cls = item.closable ? 'x-tab-strip-closable' : ''; - if(item.disabled){ - cls += ' x-item-disabled'; - } - if(item.iconCls){ - cls += ' x-tab-with-icon'; - } - if(item.tabCls){ - cls += ' ' + item.tabCls; - } - - return { - id: this.id + this.idDelimiter + item.getItemId(), - text: item.title, - cls: cls, - iconCls: item.iconCls || '' - }; + highlightItem: function(item) { + var me = this; + me.clearHighlight(); + me.highlightedItem = item; + Ext.fly(item).addCls(me.overItemCls); }, - // 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(); + /** + * 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; } }, - // 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); + 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 - 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); + 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); + } } } - if(!this.destroying){ - this.delegateUpdates(); + // 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); + } + } } - }, - // private - onBeforeShowItem : function(item){ - if(item != this.activeTab){ - this.setActiveTab(item); - return false; + if (floating) { + // Restore position + el.setXY(xy); } }, - // private - onItemDisabled : function(item){ - var el = this.getTabEl(item); - if(el){ - Ext.fly(el).addClass('x-item-disabled'); + afterLayout: function() { + var me = this, + toolbar = me.owner.pagingToolbar; + me.callParent(); + if (toolbar) { + toolbar.doComponentLayout(); } - this.stack.remove(item); }, - // private - onItemEnabled : function(item){ - var el = this.getTabEl(item); - if(el){ - Ext.fly(el).removeClass('x-item-disabled'); + 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', + + /** + * @cfg {String} text The text to be used as innerHTML (html tags are accepted) + */ + text: '', + + renderTpl: '{text}', + // + baseCls: Ext.baseCSSPrefix + 'toolbar-text', + + onRender : function() { + Ext.apply(this.renderData, { + text: this.text + }); + this.callParent(arguments); }, - // private - onItemTitleChanged : function(item){ - var el = this.getTabEl(item); - if(el){ - Ext.fly(el).child('span.x-tab-strip-text', true).innerHTML = item.title; + /** + * 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); + this.ownerCt.doLayout(); // In case an empty text item (centered at zero height) receives new text. + } else { + this.text = t; } - }, + } +}); +/** + * @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!'); + } +}); - //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'); +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 } - }, + ], /** - * 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} 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. */ - 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(); - }, + /** + * @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. + */ + triggerBaseCls: Ext.baseCSSPrefix + 'form-trigger', /** - * Suspends any internal calculations or scrolling while doing a bulk operation. See {@link #endUpdate} + * @cfg {String} triggerWrapCls + * The CSS class that is added to the div wrapping the trigger button(s). */ - beginUpdate : function(){ - this.suspendUpdates = true; - }, + triggerWrapCls: Ext.baseCSSPrefix + 'form-trigger-wrap', /** - * Resumes calculations and scrolling at the end of a bulk operation. See {@link #beginUpdate} + * @cfg {Boolean} hideTrigger true to hide the trigger element and display only the base + * text field (defaults to false) */ - endUpdate : function(){ - this.suspendUpdates = false; - this.delegateUpdates(); - }, + hideTrigger: false, /** - * Hides the tab strip item for the passed tab - * @param {Number/String/Panel} item The tab index, id or item + * @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). */ - hideTabStripItem : function(item){ - item = this.getComponent(item); - var el = this.getTabEl(item); - if(el){ - el.style.display = 'none'; - this.delegateUpdates(); - } - this.stack.remove(item); - }, + editable: true, + + /** + * @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, /** - * Unhides the tab strip item for the passed tab - * @param {Number/String/Panel} item The tab index, id or item + * @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). */ - unhideTabStripItem : function(item){ - item = this.getComponent(item); - var el = this.getTabEl(item); - if(el){ - el.style.display = ''; - this.delegateUpdates(); - } - }, + /** + * @cfg {Boolean} repeatTriggerClick true to attach a {@link Ext.util.ClickRepeater click repeater} + * to the trigger. Defaults to false. + */ + repeatTriggerClick: false, + + + /** + * @hide + * @method autoSize + */ + autoSize: Ext.emptyFn, // private - delegateUpdates : function(){ - if(this.suspendUpdates){ - return; - } - if(this.resizeTabs && this.rendered){ - this.autoSizeTabs(); - } - if(this.enableTabScroll && this.rendered){ - this.autoScrollTabs(); - } + monitorTab: true, + // private + mimicing: false, + // private + triggerIndexRe: /trigger-index-(\d+)/, + + componentLayout: 'triggerfield', + + initComponent: function() { + this.wrapFocusCls = this.triggerWrapCls + '-focus'; + this.callParent(arguments); }, // private - autoSizeTabs : function(){ - var count = this.items.length, - ce = this.tabPosition != 'bottom' ? 'header' : 'footer', - ow = this[ce].dom.offsetWidth, - aw = this[ce].dom.clientWidth; + onRender: function(ct, position) { + var me = this, + triggerCls, + triggerBaseCls = me.triggerBaseCls, + triggerWrapCls = me.triggerWrapCls, + triggerConfigs = [], + i; - if(!this.resizeTabs || count < 1 || !aw){ // !aw for display:none - return; + // 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; } - 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'; + // 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'; + + 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 - adjustBodyWidth : function(w){ - if(this.header){ - this.header.setWidth(w); - } - if(this.footer){ - this.footer.setWidth(w); + onEnable: function() { + this.callParent(); + this.triggerWrap.unmask(); + }, + + onDisable: function() { + this.callParent(); + this.triggerWrap.mask(); + }, + + afterRender: function() { + this.callParent(); + this.updateEditState(); + }, + + updateEditState: function() { + var me = this, + inputEl = me.inputEl, + triggerWrap = me.triggerWrap, + noeditCls = Ext.baseCSSPrefix + 'trigger-noedit', + displayed, + readOnly; + + if (me.rendered) { + if (me.readOnly) { + inputEl.addCls(noeditCls); + readOnly = true; + displayed = false; + } else { + if (me.editable) { + inputEl.removeCls(noeditCls); + readOnly = false; + } else { + inputEl.addCls(noeditCls); + readOnly = true; + } + displayed = !me.hideTrigger; + } + + triggerWrap.setDisplayed(displayed); + inputEl.dom.readOnly = readOnly; + me.doComponentLayout(); } - return w; }, /** - * Sets the specified tab as the active tab. This method fires the {@link #beforetabchange} event which - * can return false to cancel the tab change. - * @param {String/Number} item - * The id or tab Panel to activate. This parameter may be any of the following: - * - * 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}. + * Get the total width of the trigger button area. Only useful after the field has been rendered. + * @return {Number} The trigger width */ - setActiveTab : function(item){ - item = this.getComponent(item); - if(this.fireEvent('beforetabchange', this, item, this.activeTab) === false){ - return; - } - if(!this.rendered){ - this.activeTab = item; - return; + 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'); } - 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); + return totalTriggerWidth; + }, - this.layout.setActiveItem(item); - if(this.scrolling){ - this.scrollToTab(item, this.animScroll); - } - } - this.fireEvent('tabchange', this, item); + setHideTrigger: function(hideTrigger) { + if (hideTrigger != this.hideTrigger) { + this.hideTrigger = hideTrigger; + this.updateEditState(); } }, /** - * 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. + * @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. */ - getActiveTab : function(){ - return this.activeTab || null; + setEditable: function(editable) { + if (editable != this.editable) { + this.editable = editable; + this.updateEditState(); + } }, /** - * Gets the specified tab by id. - * @param {String} id The tab id - * @return {Panel} The tab + * @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. */ - getItem : function(item){ - return this.getComponent(item); + setReadOnly: function(readOnly) { + if (readOnly != this.readOnly) { + this.readOnly = readOnly; + this.updateEditState(); + } }, // 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(); + 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); } - } - 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(); + }); + } else { + me.mon(me.triggerWrap, 'click', me.onTriggerWrapClick, me); } - }, - - // private - createScrollers : function(){ - this.pos.addClass('x-tab-scrolling-' + this.tabPosition); - var h = this.stripWrap.dom.offsetHeight; - - // 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' + triggerEl.addClsOnOver(me.triggerBaseCls + '-over'); + triggerEl.each(function(el, c, i) { + el.addClsOnOver(me['trigger' + (i + 1) + 'Cls'] + '-over'); }); - 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 + triggerEl.addClsOnClick(me.triggerBaseCls + '-click'); + triggerEl.each(function(el, c, i) { + el.addClsOnClick(me['trigger' + (i + 1) + 'Cls'] + '-click'); }); - this.scrollRight = sr; }, // private - getScrollWidth : function(){ - return this.edge.getOffsetsTo(this.stripWrap)[0] + this.getScrollPos(); + onDestroy: function() { + var me = this; + Ext.destroyMembers(me, 'triggerRepeater', 'triggerWrap', 'triggerEl'); + delete me.doc; + me.callParent(); }, // private - getScrollPos : function(){ - return parseInt(this.stripWrap.dom.scrollLeft, 10) || 0; + 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 - getScrollArea : function(){ - return parseInt(this.stripWrap.dom.clientWidth, 10) || 0; + checkTab: function(me, e) { + if (!this.ignoreMonitorTab && e.getKey() == e.TAB) { + this.triggerBlur(); + } }, // private - getScrollAnim : function(){ - return {duration:this.scrollDuration, callback: this.updateScrollButtons, scope: this}; - }, + onBlur: Ext.emptyFn, // private - getScrollIncrement : function(){ - return this.scrollIncrement || (this.resizeTabs ? this.lastTabWidth+2 : 100); - }, - - /** - * 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 - */ - - 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); + mimicBlur: function(e) { + if (!this.isDestroyed && !this.bodyEl.contains(e.target) && this.validateBlur(e)) { + this.triggerBlur(); } }, // private - scrollTo : function(pos, animate){ - this.stripWrap.scrollTo('left', pos, animate ? this.getScrollAnim() : false); - if(!animate){ - this.updateScrollButtons(); + 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); } - }, - - 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); + Ext.form.field.Trigger.superclass.onBlur.call(me); + if (me.bodyEl) { + me.bodyEl.removeCls(me.wrapFocusCls); } }, - // 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); - } - }, + beforeBlur: Ext.emptyFn, // private - onScrollLeft : function(){ - var pos = this.getScrollPos(), - s = Math.max(0, pos - this.getScrollIncrement()); - if(s != pos){ - this.scrollTo(s, this.animScroll); - } + // 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 - 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'); - }, + // 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; - // 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); - } + if (match && !me.readOnly) { + idx = parseInt(match[1], 10); + triggerClickMethod = me['onTrigger' + (idx + 1) + 'Click'] || me.onTriggerClick; + if (triggerClickMethod) { + triggerClickMethod.call(me, e); + } + } + }, /** - * @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 + * 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 {Boolean} collapsed - * @hide + * @cfg {Boolean} grow @hide */ /** - * @cfg {String} layout - * @hide + * @cfg {Number} growMin @hide */ /** - * @cfg {Boolean} preventBodyReset - * @hide + * @cfg {Number} growMax @hide */ }); -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; - }, - next : function(){ - return items.pop(); - } - }; -}; /** - * @class Ext.Button - * @extends Ext.BoxComponent - * Simple Button class - * @cfg {String} text The button text to be used as innerHTML (html tags are accepted) - * @cfg {String} icon The path to an image to display in the button (the image will be set as the background-image - * CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon') - * @cfg {Function} handler A function called when the button is clicked (can be used instead of click event). - * The handler is passed the following parameters: - * 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). + * @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 button - * @param {Object} config The config object - * @xtype button + * Create a new picker field + * @param {Object} config */ -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) - */ - - /** - * @cfg {Boolean} allowDepress - * False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when {@link #enableToggle} is true. - */ - - /** - * @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?', - - /** - * @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', - - // private - menuClassTarget : 'tr:nth(2)', - - /** - * @cfg {String} clickEvent - * The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu). - * Defaults to 'click'. - */ - clickEvent : 'click', - - /** - * @cfg {Boolean} handleMouseEvents - * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) - */ - handleMouseEvents : true, - - /** - * @cfg {String} tooltipType - * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. - */ - tooltipType : 'qtip', - - /** - * @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', - - /** - * @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'. - */ - scale : 'small', - - /** - * @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', +Ext.define('Ext.form.field.Picker', { + extend: 'Ext.form.field.Trigger', + alias: 'widget.pickerfield', + alternateClassName: 'Ext.form.Picker', + requires: ['Ext.util.KeyNav'], /** - * @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'. + * @cfg {Boolean} matchFieldWidth + * Whether the picker dropdown's width should be explicitly set to match the width of the field. + * Defaults to true. */ - arrowAlign : 'right', - - /** - * @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 + matchFieldWidth: true, + + /** + * @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} cls - * A CSS class string to apply to the button's main element. + * @cfg {Array} pickerOffset + * An offset [x,y] to use in addition to the {@link #pickerAlign} when positioning the picker. + * Defaults to undefined. */ + /** - * @property menu - * @type Menu - * The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option. + * @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', + /** - * @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. + * @property isExpanded + * @type Boolean + * True if the picker is currently expanded, false if not. */ - initComponent : function(){ - Ext.Button.superclass.initComponent.call(this); + /** + * @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, + + initComponent: function() { + this.callParent(); + + // Custom events this.addEvents( /** - * @event click - * Fires when this button is clicked - * @param {Button} this - * @param {EventObject} e The click event - */ - 'click', - /** - * @event toggle - * Fires when the 'pressed' state of this button changes (only if enableToggle = true) - * @param {Button} this - * @param {Boolean} pressed - */ - 'toggle', - /** - * @event mouseover - * Fires when the mouse hovers over the button - * @param {Button} this - * @param {Event} e The event object - */ - 'mouseover', - /** - * @event mouseout - * Fires when the mouse exits the button - * @param {Button} this - * @param {Event} e The event object - */ - 'mouseout', - /** - * @event menushow - * If this button has a menu, this event fires when it is shown - * @param {Button} this - * @param {Menu} menu - */ - 'menushow', - /** - * @event menuhide - * If this button has a menu, this event fires when it is hidden - * @param {Button} this - * @param {Menu} menu + * @event expand + * Fires when the field's picker is expanded. + * @param {Ext.form.field.Picker} field This field instance */ - 'menuhide', + 'expand', /** - * @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 collapse + * Fires when the field's picker is collapsed. + * @param {Ext.form.field.Picker} field This field instance */ - 'menutriggerover', + 'collapse', /** - * @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 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. */ - 'menutriggerout' + 'select' ); - 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]); - } - }, + 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 + }); - // protected - getMenuClass : function(){ - return this.menu ? (this.arrowAlign != 'bottom' ? 'x-btn-arrow' : 'x-btn-arrow-bottom') : ''; - }, + // Non-editable allows opening the picker by clicking the field + if (!me.editable) { + me.mon(me.inputEl, 'click', me.onTriggerClick, me); + } - // 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(); - } - this.template = Ext.Button.buttonTemplate; + // Disable native browser autocomplete + if (Ext.isGecko) { + me.inputEl.dom.setAttribute('autocomplete', 'off'); } + }, - var btn, targs = this.getTemplateArgs(); - if(position){ - btn = this.template.insertBefore(position, targs, true); - }else{ - btn = this.template.append(ct, targs, true); + /** + * Expand this field's picker dropdown. + */ + expand: function() { + var me = this, + bodyEl, picker, collapseIf; + + if (me.rendered && !me.isExpanded && !me.isDestroyed) { + bodyEl = me.bodyEl; + picker = me.getPicker(); + collapseIf = me.collapseIf; + + // show the picker and set isExpanded flag + picker.show(); + me.isExpanded = true; + me.alignPicker(); + bodyEl.addCls(me.openCls); + + // monitor clicking and mousewheel + me.mon(Ext.getDoc(), { + mousewheel: collapseIf, + mousedown: collapseIf, + scope: me + }); + Ext.EventManager.onWindowResize(me.alignPicker, me); + me.fireEvent('expand', me); + me.onExpand(); } - /** - * 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); + onExpand: Ext.emptyFn, - Ext.ButtonToggleMgr.register(this); - }, + /** + * @protected + * Aligns the picker to the + */ + alignPicker: function() { + var me = this, + picker, isAbove, + aboveSfx = '-above'; - // 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.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); + } } + }, - if(this.handleMouseEvents){ - this.mon(btn, { - scope: this, - mouseover: this.onMouseOver, - mousedown: this.onMouseDown - }); + /** + * 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'; - // new functionality for monitoring on the document level - //this.mon(btn, 'mouseout', this.onMouseOut, this); - } + // hide the picker and set isExpanded flag + picker.hide(); + me.isExpanded = false; - if(this.menu){ - this.mon(this.menu, { - scope: this, - show: this.onMenuShow, - hide: this.onMenuHide - }); - } + // remove the openCls + me.bodyEl.removeCls([openCls, openCls + aboveSfx]); + picker.el.removeCls(picker.baseCls + aboveSfx); - 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); + // remove event listeners + doc.un('mousewheel', collapseIf, me); + doc.un('mousedown', collapseIf, me); + Ext.EventManager.removeResizeListener(me.alignPicker, me); + me.fireEvent('collapse', me); + me.onCollapse(); } }, - // private - afterRender : function(){ - Ext.Button.superclass.afterRender.call(this); - this.useSetClass = true; - this.setButtonClass(); - this.doc = Ext.getDoc(); - this.doAutoWidth(); - }, + onCollapse: 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 + * @private + * Runs on mousewheel and mousedown of doc to check to see if we should collapse the picker */ - setIconClass : function(cls){ - this.iconCls = cls; - if(this.el){ - this.btnEl.dom.className = ''; - this.btnEl.addClass(['x-btn-text', cls || '']); - this.setButtonClass(); + collapseIf: function(e) { + var me = this; + if (!me.isDestroyed && !e.within(me.bodyEl, false, true) && !e.within(me.picker.el, false, true)) { + me.collapse(); } - return this; }, /** - * 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; - } - return this; + * Return a reference to the picker component for this field, creating it if necessary by + * calling {@link #createPicker}. + * @return {Ext.Component} The picker component + */ + getPicker: function() { + var me = this; + return me.picker || (me.picker = me.createPicker()); }, - // private - clearTip : function(){ - if(Ext.isObject(this.tooltip)){ - Ext.QuickTips.unregister(this.btnEl); + /** + * Create and return the component to be used as this field's picker. Must be implemented + * by subclasses of Picker. + * @return {Ext.Component} The picker component + */ + createPicker: Ext.emptyFn, + + /** + * Handles the trigger click; by default toggles between expanding and collapsing the + * picker component. + */ + onTriggerClick: function() { + var me = this; + if (!me.readOnly && !me.disabled) { + if (me.isExpanded) { + me.collapse(); + } else { + me.expand(); + } + me.inputEl.focus(); } }, - // private - beforeDestroy : function(){ - if(this.rendered){ - this.clearTip(); - } - if(this.menu && this.destroyMenu !== false) { - Ext.destroy(this.btnEl, this.menu); + 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); } - 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); - } - Ext.Button.superclass.onDestroy.call(this); - }, + var me = this; + Ext.EventManager.removeResizeListener(me.alignPicker, me); + Ext.destroy(me.picker, me.keyNav); + me.callParent(); + } - // 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')); - } +}); + + +/** + * @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'); } - if(this.minWidth){ - if(this.el.getWidth() < this.minWidth){ - this.el.setWidth(this.minWidth); - } + }, + + // 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 + * Creates a new Spinner field + * @param {Object} config Configuration options + * @xtype spinnerfield + */ +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', /** - * 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 {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. */ - setHandler : function(handler, scope){ - this.handler = handler; - this.scope = scope; - return this; - }, + spinUpEnabled: true, /** - * Sets this Button's text - * @param {String} text The button text - * @return {Ext.Button} this + * @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. */ - setText : function(text){ - this.text = text; - if(this.el){ - this.btnEl.update(text || ' '); - this.setButtonClass(); - } - this.doAutoWidth(); - return this; - }, + spinDownEnabled: 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 {Boolean} keyNavEnabled + * Specifies whether the up and down arrow keys should trigger spinning up and down. + * Defaults to true. */ - setIcon : function(icon){ - this.icon = icon; - if(this.el){ - this.btnEl.setStyle('background-image', icon ? 'url(' + icon + ')' : ''); - this.setButtonClass(); - } - return this; - }, + keyNavEnabled: true, /** - * Gets the text for this Button - * @return {String} The button text + * @cfg {Boolean} mouseWheelEnabled + * Specifies whether the mouse wheel should trigger spinning up and down while the field has + * focus. Defaults to true. */ - getText : function(){ - return this.text; + mouseWheelEnabled: true, + + /** + * @cfg {Boolean} repeatTriggerClick Whether a {@link Ext.util.ClickRepeater click repeater} should be + * attached to the spinner buttons. Defaults to true. + */ + repeatTriggerClick: true, + + /** + * 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, + + /** + * 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' + ); }, /** - * 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 + * @private override */ - 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); - } - } + 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 + }); + } + + // Init mouse wheel + if (me.mouseWheelEnabled) { + me.mon(me.bodyEl, 'mousewheel', me.onMouseWheel, me); } - return this; }, - // private - onDisable : function(){ - this.onDisableChange(true); + /** + * @private override + * Since the triggers are stacked, only measure the width of one of them. + */ + getTriggerWidth: function() { + return this.hideTrigger || this.readOnly ? 0 : this.spinUpEl.getWidth() + this.triggerWrap.getFrameWidth('lr'); }, - // private - onEnable : function(){ - this.onDisableChange(false); + /** + * @private Handles the spinner up button clicks. + */ + onTrigger1Click: function() { + this.spinUp(); }, - 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; + /** + * @private Handles the spinner down button clicks. + */ + onTrigger2Click: function() { + this.spinDown(); }, /** - * Show this button's menu (if it has one) + * 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. */ - 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); + spinUp: function() { + var me = this; + if (me.spinUpEnabled && !me.disabled) { + me.fireEvent('spin', me, 'up'); + me.fireEvent('spinup', me); + me.onSpinUp(); } - return this; }, /** - * Hide this button's menu (if it has one) + * 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. */ - hideMenu : function(){ - if(this.hasVisibleMenu()){ - this.menu.hide(); + spinDown: function() { + var me = this; + if (me.spinDownEnabled && !me.disabled) { + me.fireEvent('spin', me, 'down'); + me.fireEvent('spindown', me); + me.onSpinDown(); } - return this; }, /** - * Returns true if the button has a menu and it is visible - * @return {Boolean} + * Sets whether the spinner up button is enabled. + * @param {Boolean} enabled true to enable the button, false to disable it. */ - hasVisibleMenu : function(){ - return this.menu && this.menu.ownerCt == this && this.menu.isVisible(); - }, - - // private - onRepeatClick : function(repeat, e){ - this.onClick(e); + 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 - onClick : function(e){ - if(e){ - e.preventDefault(); - } - if(e.button !== 0){ - return; + /** + * 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'); } - if(!this.disabled){ - if(this.enableToggle && (this.allowDepress !== false || !this.pressed)){ - this.toggle(); - } - if(this.menu && !this.hasVisibleMenu() && !this.ignoreNextClick){ - this.showMenu(); + }, + + /** + * @private + * Handles mousewheel events on the field + */ + onMouseWheel: function(e) { + var me = this, + delta; + if (me.hasFocus) { + delta = e.getWheelDelta(); + if (delta > 0) { + me.spinUp(); } - this.fireEvent('click', this, e); - if(this.handler){ - //this.el.removeClass('x-btn-over'); - this.handler.call(this.scope || this, this, e); + else if (delta < 0) { + me.spinDown(); } + e.stopEvent(); } }, - // private - isMenuTriggerOver : function(e, internal){ - return this.menu && !internal; - }, + onDestroy: function() { + Ext.destroyMembers(this, 'spinnerKeyNav', 'spinUpEl', 'spinDownEl'); + this.callParent(); + } - // private - isMenuTriggerOut : function(e, internal){ - return this.menu && !internal; - }, +}); +/** + * @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(); + } + }] + }); - // 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; +#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 + }] + }); + +#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', + + // Set step so it skips every other number + step: 2, + value: 0, + + // Add change handler to force user-entered numbers to evens + listeners: { + change: function(field, value) { + value = parseInt(value, 10); + field.setValue(value + value % 2); } - this.fireEvent('mouseover', this, e); } - if(this.isMenuTriggerOver(e, internal)){ - this.fireEvent('menutriggerover', this, this.menu, e); - } - } - }, + }] + }); - // 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); - } - }, - // 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); - } - }, + * @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'], - focus : function() { - this.btnEl.focus(); - }, + /** + * @cfg {RegExp} stripCharsRe @hide + */ + /** + * @cfg {RegExp} maskRe @hide + */ - blur : function() { - this.btnEl.blur(); - }, + /** + * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true) + */ + allowDecimals : true, - // private - onFocus : function(e){ - if(!this.disabled){ - this.el.addClass('x-btn-focus'); - } - }, - // private - onBlur : function(e){ - this.el.removeClass('x-btn-focus'); - }, + /** + * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.') + */ + decimalSeparator : '.', - // private - getClickEl : function(e, isUp){ - return this.el; - }, + /** + * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2) + */ + decimalPrecision : 2, - // private - onMouseDown : function(e){ - if(!this.disabled && e.button === 0){ - this.getClickEl(e).addClass('x-btn-click'); - this.doc.on('mouseup', this.onMouseUp, this); - } - }, - // private - onMouseUp : function(e){ - if(e.button === 0){ - this.getClickEl(e, true).removeClass('x-btn-click'); - this.doc.un('mouseup', this.onMouseUp, this); - } - }, - // 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); - } - }, - // 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; - } - }, + /** + * @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}. + */ + minValue: Number.NEGATIVE_INFINITY, - // private - restoreClick : function(){ - this.ignoreNextClick = 0; - } + /** + * @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}. + */ + maxValue: Number.MAX_VALUE, /** - * @cfg {String} autoEl @hide + * @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. */ + step: 1, + /** - * @cfg {String/Object} html @hide + * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to 'The minimum + * value for this field is {minValue}') */ + minText : 'The minimum value for this field is {0}', + /** - * @cfg {String} contentEl @hide + * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to 'The maximum + * value for this field is {maxValue}') */ + maxText : 'The maximum value for this field is {0}', + /** - * @cfg {Mixed} data @hide + * @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') */ + nanText : '{0} is not a valid number', + /** - * @cfg {Mixed} tpl @hide + * @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. */ + negativeText : 'The value cannot be negative', + /** - * @cfg {String} tplWriteMode @hide + * @cfg {String} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789'). */ -}); -Ext.reg('button', Ext.Button); + baseChars : '0123456789', -// Private utility class used by Button -Ext.ButtonToggleMgr = function(){ - var groups = {}; + /** + * @cfg {Boolean} autoStripChars True to automatically strip not allowed characters from the field. Defaults to false + */ + autoStripChars: false, - 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); - } - } - } - } + initComponent: function() { + var me = this, + allowed; - 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); - }, + me.callParent(); - unregister : function(btn){ - if(!btn.toggleGroup){ - return; - } - var g = groups[btn.toggleGroup]; - if(g){ - g.remove(btn); - btn.un('toggle', toggleGroup); - } - }, + me.setMinValue(me.minValue); + me.setMaxValue(me.maxValue); - /** - * 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} - ] - }) -}); + // Build regexes for masking and stripping based on the configured options + if (me.disableKeyFilter !== true) { + allowed = me.baseChars + ''; + if (me.allowDecimals) { + allowed += me.decimalSeparator; + } + if (me.minValue < 0) { + allowed += '-'; + } + allowed = Ext.String.escapeRegex(allowed); + me.maskRe = new RegExp('[' + allowed + ']'); + if (me.autoStripChars) { + me.stripCharsRe = new RegExp('[^' + allowed + ']', 'gi'); + } + } + }, -// 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, + /** + * Runs all of Number's validations and returns an array of any errors. Note that this first + * runs Text's validations, so the returned array is an amalgamation of all field errors. + * The additional validations run test that the value is a number, and that it is within the + * configured min and max values. + * @param {Mixed} value The value to get errors for (defaults to the current field value) + * @return {Array} All validation errors for this field + */ + getErrors: function(value) { + var me = this, + errors = me.callParent(arguments), + format = Ext.String.format, + num; - // 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"); + 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; + } + + value = String(value).replace(me.decimalSeparator, '.'); + + if(isNaN(value)){ + errors.push(format(me.nanText, value)); + } + + num = me.parseValue(value); + + if (me.minValue === 0 && num < 0) { + errors.push(this.negativeText); + } + else if (num < me.minValue) { + errors.push(format(me.minText, me.minValue)); + } + + if (num > me.maxValue) { + errors.push(format(me.maxText, me.maxValue)); + } + + + return errors; + }, + + rawToValue: function(rawValue) { + return this.fixPrecision(this.parseValue(rawValue)) || rawValue || null; + }, + + 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; + }, + + onChange: function() { + var me = this, + value = me.getValue(), + valueIsNull = value === null; + + me.callParent(arguments); + + // Update the spinner buttons + me.setSpinUpEnabled(valueIsNull || value < me.maxValue); + me.setSpinDownEnabled(valueIsNull || value > me.minValue); + }, + + /** + * 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); + }, + + /** + * Replaces any existing {@link #maxValue} with the new value. + * @param {Number} value The maximum value + */ + setMaxValue: function(value) { + this.maxValue = Ext.Number.from(value, Number.MAX_VALUE); }, // private - onRender : function(){ - Ext.SplitButton.superclass.onRender.apply(this, arguments); - if(this.arrowTooltip){ - this.el.child(this.arrowSelector).dom[this.tooltipType] = this.arrowTooltip; - } + parseValue : function(value) { + value = parseFloat(String(value).replace(this.decimalSeparator, '.')); + return isNaN(value) ? null : value; }, /** - * 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 + * */ - setArrowHandler : function(handler, scope){ - this.arrowHandler = handler; - this.scope = scope; - }, + fixPrecision : function(value) { + var me = this, + nan = isNaN(value), + precision = me.decimalPrecision; - getMenuClass : function(){ - return 'x-btn-split' + (this.arrowAlign == 'bottom' ? '-bottom' : ''); - }, + if (nan || !value) { + return nan ? '' : value; + } else if (!me.allowDecimals || precision <= 0) { + precision = 0; + } - isClickOnArrow : function(e){ - if (this.arrowAlign != 'bottom') { - var visBtn = this.el.child('em.x-btn-split'); - var right = visBtn.getRegion().right - visBtn.getPadding('r'); - return e.getPageX() > right; - } else { - return e.getPageY() > this.btnEl.getRegion().bottom; - } + return parseFloat(Ext.Number.toFixed(parseFloat(value), precision)); }, - // 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); - } - } + beforeBlur : function() { + var me = this, + v = me.parseValue(me.getRawValue()); + + if (!Ext.isEmpty(v)) { + me.setValue(v); } }, - // private - isMenuTriggerOver : function(e){ - return this.menu && e.target.tagName == this.arrowSelector; + onSpinUp: function() { + var me = this; + if (!me.readOnly) { + me.setValue(Ext.Number.constrain(me.getValue() + me.step, me.minValue, me.maxValue)); + } }, - // private - isMenuTriggerOut : function(e, internal){ - return this.menu && e.target.tagName != this.arrowSelector; + onSpinDown: function() { + var me = this; + if (!me.readOnly) { + me.setValue(Ext.Number.constrain(me.getValue() - me.step, me.minValue, me.maxValue)); + } } }); -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: +/** + * @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 + * 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: * -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); + * 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. + * +store.load({ + params: { + // specify params for the first page load if using paging + start: 0, + limit: myPageSize, + // other params + foo: 'bar' } }); - - * @constructor - * Create a new split button + * + * + * If using {@link Ext.data.Store#autoLoad store's autoLoad} configuration: + * +var myStore = new Ext.data.Store({ + {@link Ext.data.Store#autoLoad autoLoad}: {start: 0, limit: 25}, + ... +}); + * + * + * The packet sent back from the server would have this form: + * +{ + "success": true, + "results": 2000, + "rows": [ // *Note: this must be an Array + { "id": 1, "name": "Bill", "occupation": "Gardener" }, + { "id": 2, "name": "Ben", "occupation": "Horticulturalist" }, + ... + { "id": 25, "name": "Sue", "occupation": "Botanist" } + ] +} + * + * Paging with Local Data + * Paging can also be accomplished with local data using extensions: + * + * Ext.ux.data.PagingStore + * Paging Memory Proxy (examples/ux/PagingMemoryProxy.js) + * + * @constructor Create a new PagingToolbar * @param {Object} config The config object - * @xtype cycle + * @xtype pagingtoolbar */ -Ext.CycleButton = Ext.extend(Ext.SplitButton, { +Ext.define('Ext.toolbar.Paging', { + extend: 'Ext.toolbar.Toolbar', + alias: 'widget.pagingtoolbar', + alternateClassName: 'Ext.PagingToolbar', + requires: ['Ext.toolbar.TextItem', 'Ext.form.field.Number'], /** - * @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 {Ext.data.Store} store + * The {@link Ext.data.Store} the paging toolbar should use as its data source (required). */ /** - * @cfg {Boolean} showText True to display the active item's text as the button text (defaults to false) + * @cfg {Boolean} displayInfo + * true to display the displayMsg (defaults to false) */ + displayInfo: false, /** - * @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} prependButtons + * true to insert any configured items before the paging buttons. + * Defaults to false. */ + prependButtons: false, /** - * @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 {String} displayMsg + * The paging status message to display (defaults to 'Displaying {0} - {1} of {2}'). + * Note that this string is formatted using the braced numbers {0}-{2} as tokens + * that are replaced by the values for start, end and total respectively. These tokens should + * be preserved when overriding this string if showing those values is desired. */ + displayMsg : 'Displaying {0} - {1} of {2}', /** - * @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 {String} emptyMsg + * The message to display when no records are found (defaults to 'No data to display') */ + emptyMsg : 'No data to display', /** - * @property menu - * @type Menu - * The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices. + * @cfg {String} beforePageText + * The text displayed before the input item (defaults to 'Page'). */ - - // private - getItemText : function(item){ - if(item && this.showText === true){ - var text = ''; - if(this.prependText){ - text += this.prependText; - } - text += item.text; - return text; - } - return undefined; - }, - + beforePageText : 'Page', /** - * 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) + * @cfg {String} afterPageText + * Customizable piece of the default paging text (defaults to 'of {0}'). Note that + * this string is formatted using {0} as a token that is replaced by the number of + * total pages. This token should be preserved when overriding this string if showing the + * total page count is desired. */ - setActiveItem : function(item, suppressEvent){ - if(!Ext.isObject(item)){ - item = this.menu.getComponent(item); - } - 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); - } - } - }, - + afterPageText : 'of {0}', /** - * Gets the currently active menu item. - * @return {Ext.menu.CheckItem} The active item + * @cfg {String} firstText + * The quicktip text displayed for the first page button (defaults to 'First Page'). + * Note: quick tips must be initialized for the quicktip to show. */ - getActiveItem : function(){ - return this.activeItem; + firstText : 'First Page', + /** + * @cfg {String} prevText + * The quicktip text displayed for the previous page button (defaults to 'Previous Page'). + * Note: quick tips must be initialized for the quicktip to show. + */ + prevText : 'Previous Page', + /** + * @cfg {String} nextText + * The quicktip text displayed for the next page button (defaults to 'Next Page'). + * Note: quick tips must be initialized for the quicktip to show. + */ + nextText : 'Next Page', + /** + * @cfg {String} lastText + * The quicktip text displayed for the last page button (defaults to 'Last Page'). + * Note: quick tips must be initialized for the quicktip to show. + */ + lastText : 'Last Page', + /** + * @cfg {String} refreshText + * The quicktip text displayed for the Refresh button (defaults to 'Refresh'). + * Note: quick tips must be initialized for the quicktip to show. + */ + refreshText : 'Refresh', + /** + * @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, + + /** + * Gets the standard paging items in the toolbar + * @private + */ + getPagingItems: function() { + var me = this; + + return [{ + itemId: 'first', + tooltip: me.firstText, + overflowText: me.firstText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-first', + disabled: true, + handler: me.moveFirst, + scope: me + },{ + itemId: 'prev', + tooltip: me.prevText, + overflowText: me.prevText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-prev', + disabled: true, + handler: me.movePrevious, + scope: me + }, + '-', + me.beforePageText, + { + xtype: 'numberfield', + itemId: 'inputItem', + name: 'inputItem', + cls: Ext.baseCSSPrefix + 'tbar-page-number', + allowDecimals: false, + minValue: 1, + hideTrigger: true, + enableKeyEvents: true, + selectOnFocus: true, + submitValue: false, + width: me.inputItemWidth, + margins: '-1 2 3 2', + listeners: { + 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: me.moveNext, + scope: me + },{ + itemId: 'last', + tooltip: me.lastText, + overflowText: me.lastText, + iconCls: Ext.baseCSSPrefix + 'tbar-page-last', + disabled: true, + handler: me.moveLast, + scope: me + }, + '-', + { + itemId: 'refresh', + tooltip: me.refreshText, + overflowText: me.refreshText, + iconCls: Ext.baseCSSPrefix + 'tbar-loading', + handler: me.doRefresh, + scope: me + }]; }, - // private initComponent : function(){ - this.addEvents( + 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 me.buttons; + + if (me.displayInfo) { + me.items.push('->'); + me.items.push({xtype: 'tbtext', itemId: 'displayItem'}); + } + + me.callParent(); + + me.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 + * Fires after the active page has been changed. + * @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 + * 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" + 'change', + /** + * @event beforechange + * Fires just before the active page is changed. + * Return false to prevent the active page from being changed. + * @param {Ext.toolbar.Paging} this + * @param {Number} page The page number that will be loaded on change + */ + 'beforechange' ); + me.on('afterlayout', me.onLoad, me, {single: true}); - if(this.changeHandler){ - this.on('change', this.changeHandler, this.scope||this); - delete this.changeHandler; - } - - this.itemCount = this.items.length; - - 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); + me.bindStore(me.store, true); }, - // private - checkHandler : function(item, pressed){ - if(pressed){ - this.setActiveItem(item); - } - }, - - /** - * 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. - */ - 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; + updateInfo : function(){ + 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 + ); } + displayItem.setText(msg); + me.doComponentLayout(); } - } -}); -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 - ] -}); -// add a Button with the menu -tb.add({ - text:'Button w/ Menu', - menu: menu // assign menu by instance - }); -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; + // private + onLoad : function(){ + var me = this, + pageData, + currPage, + pageCount, + afterText; + + if (!me.rendered) { + return; } - } - Ext.Toolbar.superclass.constructor.call(this, config); -}; - -(function(){ - -var T = Ext.Toolbar; -Ext.extend(T, Ext.Container, { - - defaultType: 'button', + pageData = me.getPageData(); + currPage = pageData.currentPage; + pageCount = pageData.pageCount; + afterText = Ext.String.format(me.afterPageText, isNaN(pageCount) ? 1 : pageCount); - /** - * @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. - */ + 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); + }, - enableOverflow : false, + // private + getPageData : function(){ + var store = this.store, + totalCount = store.getTotalCount(); + + return { + 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) + + }; + }, - /** - * @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 {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. - */ + // private + onLoadError : function(){ + if (!this.rendered) { + return; + } + this.child('#refresh').enable(); + }, - trackMenus : true, - internalDefaults: {removeMode: 'container', hideParent: true}, - toolbarCls: 'x-toolbar', + // private + 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; + }, - initComponent : function(){ - T.superclass.initComponent.call(this); + onPagingFocus : function(){ + this.child('#inputItem').select(); + }, - /** - * @event overflowchange - * Fires after the overflow state has changed. - * @param {Object} c The Container - * @param {Boolean} lastOverflow overflow state - */ - this.addEvents('overflowchange'); + //private + onPagingBlur : function(e){ + var curPage = this.getPageData().currentPage; + this.child('#inputItem').setValue(curPage); }, // private - onRender : function(ct, position){ - if(!this.el){ - if(!this.autoCreate){ - this.autoCreate = { - cls: this.toolbarCls + ' x-small-editor' - }; + onPagingKeyDown : function(field, e){ + var k = e.getKey(), + pageData = this.getPageData(), + increment = e.shiftKey ? 10 : 1, + pageNum, + me = this; + + if (k == e.RETURN) { + e.stopEvent(); + 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) { + e.stopEvent(); + pageNum = k == e.HOME ? 1 : pageData.pageCount; + field.setValue(pageNum); + } else if (k == e.UP || k == e.PAGEUP || k == e.DOWN || k == e.PAGEDOWN) { + e.stopEvent(); + pageNum = me.readPageFromInput(pageData); + if (pageNum) { + if (k == e.DOWN || k == e.PAGEDOWN) { + increment *= -1; + } + pageNum += increment; + if (pageNum >= 1 && pageNum <= pageData.pages) { + field.setValue(pageNum); + } } - 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 - */ - // 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); - } + beforeLoad : function(){ + if(this.rendered && this.refresh){ + this.refresh.disable(); } - return c; }, // private - applyDefaults : function(c){ - if(!Ext.isString(c)){ - c = Ext.Toolbar.superclass.applyDefaults.call(this, c); - var d = this.internalDefaults; - if(c.events){ - Ext.applyIf(c.initialConfig, d); - Ext.apply(c, d); - }else{ - Ext.applyIf(c, d); - } + doLoad : function(start){ + if(this.fireEvent('beforechange', this, o) !== false){ + this.store.load(); } - return c; }, /** - * Adds a separator - * Note: See the notes within {@link Ext.Container#add}. - * @return {Ext.Toolbar.Item} The separator {@link Ext.Toolbar.Item item} + * Move to the first page, has the same effect as clicking the 'first' button. */ - addSeparator : function(){ - return this.add(new T.Separator()); + moveFirst : function(){ + var me = this; + if(me.fireEvent('beforechange', me, 1) !== false){ + me.store.loadPage(1); + } }, /** - * Adds a spacer element - * Note: See the notes within {@link Ext.Container#add}. - * @return {Ext.Toolbar.Spacer} The spacer item + * Move to the previous page, has the same effect as clicking the 'previous' button. */ - addSpacer : function(){ - return this.add(new T.Spacer()); + movePrevious : function(){ + var me = this, + prev = me.store.currentPage - 1; + + if(me.fireEvent('beforechange', me, prev) !== false){ + me.store.previousPage(); + } }, /** - * Forces subsequent additions into the float:right toolbar - * Note: See the notes within {@link Ext.Container#add}. + * Move to the next page, has the same effect as clicking the 'next' button. */ - addFill : function(){ - this.add(new T.Fill()); + moveNext : function(){ + var me = this; + if(me.fireEvent('beforechange', me, me.store.currentPage + 1) !== false){ + me.store.nextPage(); + } }, /** - * 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 + * Move to the last page, has the same effect as clicking the 'last' button. */ - addElement : function(el){ - return this.addItem(new T.Item({el:el})); + moveLast : function(){ + var me = this, + last = this.getPageData().pageCount; + + if(me.fireEvent('beforechange', me, last) !== false){ + me.store.loadPage(last); + } }, /** - * 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 + * Refresh the current page, has the same effect as clicking the 'refresh' button. */ - addItem : function(item){ - return this.add.apply(this, arguments); + doRefresh : function(){ + var me = this, + current = me.store.currentPage; + + if(me.fireEvent('beforechange', me, current) !== false){ + me.store.loadPage(current); + } }, /** - * 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} + * Binds the paging toolbar to the specified {@link Ext.data.Store} + * @param {Store} store The store to bind to this toolbar + * @param {Boolean} initial (Optional) true to not remove listeners */ - 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])); + bindStore : function(store, initial){ + var me = this; + + if (!initial && me.store) { + if(store !== me.store && me.store.autoDestroy){ + me.store.destroy(); + }else{ + me.store.un('beforeload', me.beforeLoad, me); + me.store.un('load', me.onLoad, me); + me.store.un('exception', me.onLoadError, me); + } + if(!store){ + me.store = null; } - return buttons; } - return this.add(this.constructButton(config)); + if (store) { + store = Ext.data.StoreManager.lookup(store); + store.on({ + scope: me, + beforeload: me.beforeLoad, + load: me.onLoad, + exception: me.onLoadError + }); + } + me.store = store; }, /** - * 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 + * Unbinds the paging toolbar from the specified {@link Ext.data.Store} (deprecated) + * @param {Ext.data.Store} store The data store to unbind */ - addText : function(text){ - return this.addItem(new T.TextItem(text)); + unbind : function(store){ + this.bindStore(null); }, /** - * 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 + * Binds the paging toolbar to the specified {@link Ext.data.Store} (deprecated) + * @param {Ext.data.Store} store The data store to bind */ - addDom : function(config){ - return this.add(new T.Item({autoEl: config})); + bind : function(store){ + this.bindStore(store); }, + // private + onDestroy : function(){ + this.bindStore(null); + this.callParent(); + } +}); + +/** + * @class Ext.view.BoundList + * @extends Ext.view.View + * An internal used DataView for ComboBox, MultiSelect and ItemSelector. + */ +Ext.define('Ext.view.BoundList', { + extend: 'Ext.view.View', + alias: 'widget.boundlist', + alternateClassName: 'Ext.BoundList', + requires: ['Ext.layout.component.BoundList', 'Ext.toolbar.Paging'], + /** - * 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 {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. */ - addField : function(field){ - return this.add(field); - }, + pageSize: 0, /** - * 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} + * @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. */ - 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; - } - 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); - } - }, + // private overrides + autoScroll: true, + baseCls: Ext.baseCSSPrefix + 'boundlist', + listItemCls: '', + shadow: false, + trackOver: true, + refreshed: 0, - // private - constructButton : function(item){ - var b = item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType); - return b; - }, + ariaRole: 'listbox', - // private - onAdd : function(c){ - Ext.Toolbar.superclass.onAdd.call(this); - this.trackMenu(c); - if(this.disabled){ - c.disable(); + componentLayout: 'boundlist', + + renderTpl: [''], + + initComponent: function() { + var me = this, + baseCls = me.baseCls, + itemCls = baseCls + '-item'; + me.itemCls = itemCls; + me.selectedItemCls = baseCls + '-selected'; + me.overItemCls = baseCls + '-item-over'; + me.itemSelector = "." + itemCls; + + if (me.floating) { + me.addCls(baseCls + '-floating'); + } + + // should be setting aria-posinset based on entire set of data + // not filtered set + me.tpl = Ext.create('Ext.XTemplate', + '', + '' + me.getInnerTpl(me.displayField) + '', + '' + ); + + if (me.pageSize) { + me.pagingToolbar = me.createPagingToolbar(); } - }, - // private - onRemove : function(c){ - Ext.Toolbar.superclass.onRemove.call(this); - this.trackMenu(c, true); - }, + me.callParent(); - // private - onDisable : function(){ - this.items.each(function(item){ - if(item.disable){ - item.disable(); - } + Ext.applyIf(me.renderSelectors, { + listEl: '.list-ct' }); }, - // private - onEnable : function(){ - this.items.each(function(item){ - if(item.enable){ - item.enable(); - } + createPagingToolbar: function() { + return Ext.widget('pagingtoolbar', { + pageSize: this.pageSize, + store: this.store, + border: false }); }, - // private - onButtonTriggerOver : function(btn){ - if(this.activeMenuBtn && this.activeMenuBtn != btn){ - this.activeMenuBtn.hideMenu(); - btn.showMenu(); - this.activeMenuBtn = btn; + onRender: function() { + var me = this, + toolbar = me.pagingToolbar; + me.callParent(arguments); + if (toolbar) { + toolbar.render(me.el); } }, - // private - onButtonMenuShow : function(btn){ - this.activeMenuBtn = btn; + bindStore : function(store, initial) { + var me = this, + toolbar = me.pagingToolbar; + me.callParent(arguments); + if (toolbar) { + toolbar.bindStore(store, initial); + } }, - // private - onButtonMenuHide : function(btn){ - delete this.activeMenuBtn; - } -}); -Ext.reg('toolbar', Ext.Toolbar); + getTargetEl: function() { + return this.listEl || this.el; + }, -/** - * @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); + getInnerTpl: function(displayField) { + return '{' + displayField + '}'; + }, + + 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); + } + }, -/** - * @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); + onDestroy: function() { + Ext.destroyMembers(this, 'pagingToolbar', 'listEl'); + this.callParent(); } }); -Ext.reg('tbseparator', T.Separator); /** - * @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 + * @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. */ -T.Spacer = Ext.extend(T.Item, { +Ext.define('Ext.view.BoundListKeyNav', { + extend: 'Ext.util.KeyNav', + requires: 'Ext.view.BoundList', + /** - * @cfg {Number} width - * The width of the spacer in pixels (defaults to 2px via css style .x-toolbar .xtb-spacer). + * @cfg {Ext.view.BoundList} boundList + * @required + * The {@link Ext.view.BoundList} instance for which key navigation will be managed. This is required. */ - 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); + constructor: function(el, config) { + var me = this; + me.boundList = config.boundList; + me.callParent([el, Ext.apply({}, config, me.defaultHandlers)]); + }, -/** - * @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); + 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); + }, -/** - * @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) - */ + 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); + }, - constructor: function(config){ - T.TextItem.superclass.constructor.call(this, Ext.isString(config) ? {text: config} : config); + pageup: function() { + //TODO + }, + + pagedown: function() { + //TODO + }, + + home: function() { + this.highlightAt(0); + }, + + end: function() { + var me = this; + me.highlightAt(me.boundList.all.getCount() - 1); + }, + + enter: function(e) { + this.selectHighlighted(e); + } }, - // private - onRender : function(ct, position) { - this.autoEl = {cls: 'xtb-text', html: this.text || ''}; - T.TextItem.superclass.onRender.call(this, ct, position); + /** + * Highlights the item at the given index. + * @param {Number} index + */ + highlightAt: function(index) { + var boundList = this.boundList, + item = boundList.all.item(index); + if (item) { + item = item.dom; + boundList.highlightItem(item); + boundList.getTargetEl().scrollChildIntoView(item, false); + } }, /** - * Updates this item's text, setting the text to be used as innerHTML. - * @param {String} t The text to display (html accepted). + * Triggers selection of the currently highlighted item according to the behavior of + * the configured SelectionModel. */ - setText : function(t) { - if(this.rendered){ - this.el.update(t); - }else{ - this.text = t; + selectHighlighted: function(e) { + var me = this, + boundList = me.boundList, + highlighted = boundList.highlightedItem, + selModel = boundList.getSelectionModel(); + if (highlighted) { + selModel.selectWithEvent(boundList.getRecord(highlighted), e); } } -}); -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' - }] - }] }); - * +/** + * @class Ext.form.field.ComboBox + * @extends Ext.form.field.Picker + * + * A combobox control with support for autocomplete, remote loading, and many other features. + * + * A ComboBox is like a combination of a traditional HTML text `` field and a `', + '', + { + compiled: true, + disableFormats: true + } + ], + /** - * @cfg {Mixed} data @hide + * @cfg {Boolean} enableFormat Enable the bold, italic and underline buttons (defaults to true) */ + enableFormat : true, /** - * @cfg {Mixed} tpl @hide + * @cfg {Boolean} enableFontSize Enable the increase/decrease font size buttons (defaults to true) */ + enableFontSize : true, /** - * @cfg {String} tplWriteMode @hide + * @cfg {Boolean} enableColors Enable the fore/highlight color buttons (defaults to true) */ + enableColors : true, /** - * @cfg {String} disabledClass @hide + * @cfg {Boolean} enableAlignments Enable the left, center, right alignment buttons (defaults to true) */ + enableAlignments : true, /** - * @cfg {String} elements @hide + * @cfg {Boolean} enableLists Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true) */ + enableLists : true, /** - * @cfg {String} html @hide + * @cfg {Boolean} enableSourceEdit Enable the switch to source edit button. Not available in Safari. (defaults to true) */ + enableSourceEdit : true, /** - * @cfg {Boolean} preventBodyReset - * @hide + * @cfg {Boolean} enableLinks Enable the create link button. Not available in Safari. (defaults to true) */ + enableLinks : true, /** - * @property disabled - * @hide + * @cfg {Boolean} enableFont Enable font selection. Not available in Safari. (defaults to true) */ + enableFont : true, /** - * @method applyToMarkup - * @hide + * @cfg {String} createLinkText The default text for the create link prompt */ + createLinkText : 'Please enter the URL for the link:', /** - * @method enable - * @hide + * @cfg {String} defaultLinkValue The default value for the create link prompt (defaults to http:/ /) */ + defaultLinkValue : 'http:/'+'/', /** - * @method disable - * @hide + * @cfg {Array} fontFamilies An array of available font families */ + fontFamilies : [ + 'Arial', + 'Courier New', + 'Tahoma', + 'Times New Roman', + 'Verdana' + ], + defaultFont: 'tahoma', /** - * @method setDisabled - * @hide + * @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) ? ' ' : '', -Ext.tree.TreePanel.nodeTypes = {}; + fieldBodyCls: Ext.baseCSSPrefix + 'html-editor-wrap', -Ext.reg('treepanel', Ext.tree.TreePanel);Ext.tree.TreeEventModel = function(tree){ - this.tree = tree; - this.tree.on('render', this.initEvents, this); -}; + componentLayout: 'htmleditor', -Ext.tree.TreeEventModel.prototype = { - initEvents : function(){ - var t = this.tree; + // private properties + initialized : false, + activated : false, + sourceEditMode : false, + iframePad:3, + hideMode:'offsets', - 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 - }); - }, + maskOnDisable: true, + + // private + initComponent : function(){ + var me = this; - 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; - }, + 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' + ); - 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.callParent(arguments); + + // Init mixins + me.initLabelable(); + me.initField(); }, - 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)); + /* + * 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 + }; } - }, - delegateOver : function(e, t){ - if(!this.beforeEvent(e)){ - return; + + 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); + } + }); + + items.push( + fontSelectItem, + '-' + ); } - if(Ext.isGecko && !this.trackingDoc){ // prevent hanging in FF - Ext.getBody().on('mouseover', this.trackExit, this); - this.trackingDoc = true; + + if (me.enableFormat) { + items.push( + btn('bold'), + btn('italic'), + btn('underline') + ); } - if(this.lastEcOver){ // prevent hung highlight - this.onIconOut(e, this.lastEcOver); - delete this.lastEcOver; + + if (me.enableFontSize) { + items.push( + '-', + btn('increasefontsize', false, me.adjustFont), + btn('decreasefontsize', false, me.adjustFont) + ); } - if(e.getTarget('.x-tree-ec-icon', 1)){ - this.lastEcOver = this.getNode(e); - this.onIconOver(e, this.lastEcOver); + + 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(); + } + }] + }) + } + ); } - if(t = this.getNodeTarget(e)){ - this.onNodeOver(e, this.getNode(e)); + + if (me.enableAlignments) { + items.push( + '-', + btn('justifyleft'), + btn('justifycenter'), + btn('justifyright') + ); } - }, - trackExit : function(e){ - if(this.lastOverNode){ - if(this.lastOverNode.ui && !e.within(this.lastOverNode.ui.getEl())){ - this.onNodeOut(e, this.lastOverNode); + 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); + }) + ); } - delete this.lastOverNode; - Ext.getBody().un('mouseover', this.trackExit, this); - this.trackingDoc = false; } - }, + // build the toolbar + toolbar = Ext.widget('toolbar', { + renderTo: me.toolbarWrap, + enableOverflow: true, + items: items + }); - 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)); - } - }else{ - this.checkContainerEvent(e, 'click'); + if (fontSelectItem) { + me.fontSelect = fontSelectItem.selectEl; + + me.mon(me.fontSelect, 'change', function(){ + me.relayCmd('fontname', me.fontSelect.dom.value); + me.deferFocus(); + }); } + + // stop form submits + me.mon(toolbar.el, 'click', function(e){ + e.preventDefault(); + }); + + me.toolbar = toolbar; }, - delegateDblClick : function(e, t){ - if(this.beforeEvent(e)){ - if(this.getNodeTarget(e)){ - this.onNodeDblClick(e, this.getNode(e)); - } - }else{ - this.checkContainerEvent(e, 'dblclick'); - } + onDisable: function() { + this.bodyEl.mask(); + this.callParent(arguments); }, - delegateContextMenu : function(e, t){ - if(this.beforeEvent(e)){ - if(this.getNodeTarget(e)){ - this.onNodeContextMenu(e, this.getNode(e)); - } - }else{ - this.checkContainerEvent(e, 'contextmenu'); - } + onEnable: function() { + this.bodyEl.unmask(); + this.callParent(arguments); }, - - checkContainerEvent: function(e, type){ - if(this.disabled){ - e.stopEvent(); - return false; + + /** + * Sets the read only state of this field. + * @param {Boolean} readOnly Whether the field should be read only. + */ + setReadOnly: function(readOnly) { + var me = this, + textareaEl = me.textareaEl, + iframeEl = me.iframeEl, + body; + + me.readOnly = readOnly; + + if (textareaEl) { + textareaEl.dom.readOnly = readOnly; } - this.onContainerEvent(e, type); - }, - onContainerEvent: function(e, type){ - this.tree.fireEvent('container' + type, this.tree, e); + if (me.initialized) { + body = me.getEditorBody(); + if (Ext.isIE) { + // Hide the iframe while setting contentEditable so it doesn't grab focus + iframeEl.setDisplayed(false); + body.contentEditable = !readOnly; + iframeEl.setDisplayed(true); + } else { + me.setDesignMode(!readOnly); + } + if (body) { + body.style.cursor = readOnly ? 'default' : 'text'; + } + me.disableItems(readOnly); + } }, - onNodeClick : function(e, node){ - node.ui.onClick(e); + /** + * 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); }, - onNodeOver : function(e, node){ - this.lastOverNode = node; - node.ui.onOver(e); + // private + getEditorBody: function() { + var doc = this.getDoc(); + return doc.body || doc.documentElement; }, - onNodeOut : function(e, node){ - node.ui.onOut(e); + // private + getDoc: function() { + return (!Ext.isIE && this.iframeEl.dom.contentDocument) || this.getWin().document; }, - onIconOver : function(e, node){ - node.ui.addClass('x-tree-ec-over'); + // private + getWin: function() { + return Ext.isIE ? this.iframeEl.dom.contentWindow : window.frames[this.iframeEl.dom.name]; }, - onIconOut : function(e, node){ - node.ui.removeClass('x-tree-ec-over'); - }, + // private + onRender: function() { + var me = this, + renderSelectors = me.renderSelectors; + + Ext.applyIf(renderSelectors, me.getLabelableSelectors()); + + Ext.applyIf(renderSelectors, { + toolbarWrap: 'div.' + Ext.baseCSSPrefix + 'html-editor-tb', + iframeEl: 'iframe', + textareaEl: 'textarea' + }); + + me.callParent(arguments); - onIconClick : function(e, node){ - node.ui.ecClick(e); + me.textareaEl.dom.value = me.value || ''; + + // Start polling for when the iframe document is ready to be manipulated + me.monitorTask = Ext.TaskManager.start({ + run: me.checkDesignMode, + scope: me, + interval:100 + }); + + me.createToolbar(me); + me.disableItems(true); }, - onCheckboxClick : function(e, node){ - node.ui.onCheckChange(e); + initRenderTpl: function() { + var me = this; + if (!me.hasOwnProperty('renderTpl')) { + me.renderTpl = me.getTpl('labelableRenderTpl'); + } + return me.callParent(); }, - onNodeDblClick : function(e, node){ - node.ui.onDblClick(e); + initRenderData: function() { + return Ext.applyIf(this.callParent(), this.getLabelableRenderData()); }, - onNodeContextMenu : function(e, node){ - node.ui.onContextMenu(e); + 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;' + }; }, - beforeEvent : function(e){ - var node = this.getNode(e); - if(this.disabled || !node || !node.ui){ - e.stopEvent(); - return false; - } - return true; + getSubTplMarkup: function() { + return this.getTpl('fieldSubTpl').apply(this.getSubTplData()); }, - disable: function(){ - this.disabled = true; + getBodyNaturalWidth: function() { + return 565; }, - 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', + initFrameDoc: function() { + var me = this, + doc, task; - /** - * @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' - ); + Ext.TaskManager.stop(me.monitorTask); - 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); + doc = me.getDoc(); + me.win = me.getWin(); + + doc.open(); + doc.write(me.getDocMarkup()); + doc.close(); + + task = { // must defer to wait for browser to be ready + run: function() { + var doc = me.getDoc(); + if (doc.body || doc.readyState === 'complete') { + Ext.TaskManager.stop(task); + me.setDesignMode(true); + Ext.defer(me.initEditor, 10, me); + } + }, + interval : 10, + duration:10000, + scope: me + }; + Ext.TaskManager.start(task); }, - - /** - * Select a node. - * @param {TreeNode} node The node to select - * @return {TreeNode} The selected node - */ - 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); - } - this.selNode = node; - node.ui.onSelectedChange(true); - this.fireEvent('selectionchange', this, node, last); + + checkDesignMode: function() { + var me = this, + doc = me.getDoc(); + if (doc && (!doc.editorInitialized || me.getDesignMode() !== 'on')) { + me.initFrameDoc(); } - return node; - }, - - /** - * Deselect a node. - * @param {TreeNode} node The node to unselect - * @param {Boolean} silent True to stop the selectionchange event from firing. - */ - unselect : function(node, silent){ - if(this.selNode == node){ - this.clearSelections(silent); - } }, - - /** - * Clear all selections - * @param {Boolean} silent True to stop the selectionchange event from firing. + + /* private + * set current design mode. To enable, mode can be true or 'on', off otherwise */ - clearSelections : function(silent){ - var n = this.selNode; - if(n){ - n.ui.onSelectedChange(false); - this.selNode = null; - if(silent !== true){ - this.fireEvent('selectionchange', this, null); + 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'; } - return n; }, - - /** - * Get the selected node - * @return {TreeNode} The selected node - */ - getSelectedNode : function(){ - return this.selNode; + + // private + getDesignMode: function() { + var doc = this.getDoc(); + return !doc ? '' : String(doc.designMode).toLowerCase(); }, - - /** - * Returns true if the node is selected - * @param {TreeNode} node The node to check - * @return {Boolean} - */ - isSelected : function(node){ - return this.selNode == node; + + disableItems: function(disabled) { + this.getToolbar().items.each(function(item){ + if(item.getItemId() !== 'sourceedit'){ + item.setDisabled(disabled); + } + }); }, /** - * Selects the node above the selected node in the tree, intelligently walking the nodes - * @return TreeNode The new selection + * Toggles the editor between standard and source edit mode. + * @param {Boolean} sourceEditMode (optional) True for source edit, false for standard */ - selectPrevious : function(/* private */ s){ - if(!(s = s || this.selNode || this.lastSelNode)){ - return null; + 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; } - // 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); + me.sourceEditMode = sourceEditMode; + + if (btn.pressed !== sourceEditMode) { + btn.toggle(sourceEditMode); + } + if (sourceEditMode) { + me.disableItems(true); + me.syncValue(); + iframe.addCls(hiddenCls); + textarea.removeCls(hiddenCls); + textarea.dom.removeAttribute('tabIndex'); + textarea.focus(); + } + else { + if (me.initialized) { + me.disableItems(me.readOnly); } - } else if(s.parentNode && (this.tree.rootVisible || !s.parentNode.isRoot)){ - return this.select(s.parentNode, this.selectPrevious); + me.pushValue(); + iframe.removeCls(hiddenCls); + textarea.addCls(hiddenCls); + textarea.dom.setAttribute('tabIndex', -1); + me.deferFocus(); } - return null; + me.fireEvent('editmodechange', me, sourceEditMode); + me.doComponentLayout(); }, - /** - * Selects the node above the selected node in the tree, intelligently walking the nodes - * @return TreeNode The new selection - */ - selectNext : function(/* private */ s){ - if(!(s = s || this.selNode || this.lastSelNode)){ - return null; + // private used internally + createLink : function() { + var url = prompt(this.createLinkText, this.defaultLinkValue); + if (url && url !== 'http:/'+'/') { + this.relayCmd('createlink', url); } - // 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; }, - 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; - }; - } -}); + clearInvalid: Ext.emptyFn, -/** - * @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 - */ - select : function(node, e, keepExisting){ - if(keepExisting !== true){ - this.clearSelections(true); + // 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 = ''; } - if(this.isSelected(node)){ - this.lastSelNode = node; - return node; + if (textarea) { + textarea.dom.value = value; } - this.selNodes.push(node); - this.selMap[node.id] = node; - this.lastSelNode = node; - node.ui.onSelectedChange(true); - this.fireEvent('selectionchange', this, this.selNodes); - return node; + me.pushValue(); + return this; }, - + /** - * Deselect a node. - * @param {TreeNode} node The node to unselect + * 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 */ - 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); + cleanHtml: function(html) { + html = String(html); + if (Ext.isWebKit) { // strip safari nonsense + html = html.replace(/\sclass="(?:Apple-style-span|khtml-block-placeholder)"/gi, ''); + } + + /* + * Neat little hack. Strips out all the non-digit characters from the default + * value and compares it to the character code of the first character in the string + * because it can cause encoding issues when posted to the server. + */ + if (html.charCodeAt(0) === this.defaultValue.replace(/\D/g, '')) { + html = html.substring(1); } + return html; }, - + /** - * Clear all selections + * @protected method that will not generally be called directly. Syncs the contents + * of the editor iframe with the textarea. */ - 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); + 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.selNodes = []; - this.selMap = {}; - if(suppressEvent !== true){ - this.fireEvent('selectionchange', this, this.selNodes); + html = me.cleanHtml(html); + if (me.fireEvent('beforesync', me, html) !== false) { + me.textareaEl.dom.value = html; + me.fireEvent('sync', me, html); } } }, - - /** - * Returns true if the node is selected - * @param {TreeNode} node The node to check - * @return {Boolean} - */ - isSelected : function(node){ - return this.selMap[node.id] ? true : false; - }, - - /** - * Returns an array of the selected nodes - * @return {Array} - */ - getSelectedNodes : function(){ - return this.selNodes.concat([]); - }, - - 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 '/'). - */ - pathSeparator: "/", - // private - proxyNodeEvent : function(){ - return this.fireEvent.apply(this, arguments); + //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; }, /** - * Returns the root node for this tree. - * @return {Node} + * @protected method that will not generally be called directly. Pushes the value of the textarea + * into the iframe editor. */ - getRootNode : function(){ - return this.root; + 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); + } + } }, - /** - * Sets the root node for this tree. - * @param {Node} node - * @return {Node} - */ - setRootNode : function(node){ - this.root = node; - node.ownerTree = this; - node.isRoot = true; - this.registerNode(node); - return node; + // private + deferFocus : function(){ + this.focus(false, true); }, - /** - * Gets a node in this tree by its id. - * @param {String} id - * @return {Node} - */ - getNodeById : function(id){ - return this.nodeHash[id]; + getFocusEl: function() { + var me = this, + win = me.win; + return win && !me.sourceEditMode ? win : me.textareaEl; }, // private - registerNode : function(node){ - this.nodeHash[node.id] = node; - }, + 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 - unregisterNode : function(node){ - delete this.nodeHash[node.id]; - }, + ss['background-attachment'] = 'fixed'; // w3c + dbody.bgProperties = 'fixed'; // ie - toString : function(){ - return "[Tree"+(this.id?" "+this.id:"")+"]"; - } -}); + Ext.core.DomHelper.applyStyles(dbody, ss); -/** - * @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. - * @constructor - * @param {Object} attributes The attributes/config for the node - */ -Ext.data.Node = function(attributes){ - /** - * The attributes supplied for the node. You can use this property to access any custom attributes you supplied. - * @type {Object} - */ - this.attributes = attributes || {}; - this.leaf = this.attributes.leaf; - /** - * The node id. @type String - */ - this.id = this.attributes.id; - if(!this.id){ - this.id = Ext.id(null, "xnode-"); - this.attributes.id = this.id; - } - /** - * All child nodes of this node. @type Array - */ - 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; - } + doc = me.getDoc(); + + if (doc) { + try { + Ext.EventManager.removeAll(doc); + } catch(e) {} + } + + /* + * We need to use createDelegate here, because when using buffer, the delayed task is added + * as a property to the function. When the listener is removed, the task is deleted from the function. + * Since onEditorEvent is shared on the prototype, if we have multiple html editors, the first time one of the editors + * is destroyed, it causes the fn to be deleted from the prototype, which causes errors. Essentially, we're just anonymizing the function. + */ + fn = Ext.Function.bind(me.onEditorEvent, me); + Ext.EventManager.on(doc, { + mousedown: fn, + dblclick: fn, + click: fn, + keyup: fn, + buffer:100 + }); + + // These events need to be relayed from the inner document (where they stop + // bubbling) up to the outer document. This has to be done at the DOM level so + // the event reaches listeners on elements like the document body. The effected + // mechanisms that depend on this bubbling behavior are listed to the right + // of the event. + fn = me.onRelayedEvent; + Ext.EventManager.on(doc, { + mousedown: fn, // menu dismisal (MenuManager) and Window onMouseDown (toFront) + mousemove: fn, // window resize drag detection + mouseup: fn, // window resize termination + click: fn, // not sure, but just to be safe + dblclick: fn, // not sure again + scope: me + }); + + if (Ext.isGecko) { + Ext.EventManager.on(doc, 'keypress', me.applyCommand, me); + } + if (me.fixKeys) { + Ext.EventManager.on(doc, 'keydown', me.fixKeys, me); } - return -1; - }; - } - /** - * The parent node for this node. @type Node - */ - this.parentNode = null; - /** - * The first direct child node of this node, or null if this node has no child nodes. @type Node - */ - this.firstChild = null; - /** - * The last direct child node of this node, or null if this node has no child nodes. @type Node - */ - this.lastChild = null; - /** - * The node immediately preceding this node in the tree, or null if there is no sibling node. @type Node - */ - this.previousSibling = null; - /** - * The node immediately following this node in the tree, or null if there is no sibling node. @type Node - */ - 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); -}; + // 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?) + } + }, -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; + beforeDestroy : function(){ + var me = this, + monitorTask = me.monitorTask, + doc, prop; + + if (monitorTask) { + Ext.TaskManager.stop(monitorTask); } - // 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; + 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'); } - return true; - }, - - /** - * Returns true if this node is a leaf - * @return {Boolean} - */ - isLeaf : function(){ - return this.leaf === true; + me.callParent(); }, // private - setFirstChild : function(node){ - this.firstChild = node; - }, - - //private - setLastChild : function(node){ - this.lastChild = node; - }, + 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(); - /** - * Returns true if this node is the last child of its parent - * @return {Boolean} - */ - isLast : function(){ - return (!this.parentNode ? true : this.parentNode.lastChild == this); - }, + // 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]]; - /** - * Returns true if this node is the first child of its parent - * @return {Boolean} - */ - isFirst : function(){ - return (!this.parentNode ? true : this.parentNode.firstChild == this); - }, + event.injectEvent(iframeEl); // blame the iframe for the event... - /** - * Returns true if this node has one or more child nodes, else false. - * @return {Boolean} - */ - hasChildNodes : function(){ - return !this.isLeaf() && this.childNodes.length > 0; + event.xy = eventXY; // restore the original XY (just for safety) }, - /** - * 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} - */ - isExpandable : function(){ - return this.attributes.expandable || this.hasChildNodes(); + // private + onFirstFocus : function(){ + var me = this, + selection, range; + me.activated = true; + me.disableItems(me.readOnly); + if (Ext.isGecko) { // prevent silly gecko errors + me.win.focus(); + selection = me.win.getSelection(); + if (!selection.focusNode || selection.focusNode.nodeType !== 3) { + range = selection.getRangeAt(0); + range.selectNodeContents(me.getEditorBody()); + range.collapse(true); + me.deferFocus(); + } + try { + me.execCmd('useCSS', true); + me.execCmd('styleWithCSS', false); + } catch(e) { + // ignore (why?) + } + } + me.fireEvent('activate', me); }, - /** - * 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 - */ - 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]); + // private + adjustFont: function(btn) { + var adjust = btn.getItemId() === 'increasefontsize' ? 1 : -1, + size = this.getDoc().queryCommandValue('FontSize') || '2', + isPxSize = Ext.isString(size) && size.indexOf('px') !== -1, + isSafari; + size = parseInt(size, 10); + if (isPxSize) { + // Safari 3 values + // 1 = 10px, 2 = 13px, 3 = 16px, 4 = 18px, 5 = 24px, 6 = 32px + if (size <= 10) { + size = 1 + adjust; } - }else{ - if(this.fireEvent("beforeappend", this.ownerTree, this, node) === false){ - return false; + else if (size <= 13) { + size = 2 + adjust; } - 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); + else if (size <= 16) { + size = 3 + adjust; } - index = this.childNodes.length; - if(index === 0){ - this.setFirstChild(node); + else if (size <= 18) { + size = 4 + adjust; } - 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; + else if (size <= 24) { + size = 5 + adjust; } - 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); + else { + size = 6 + adjust; } - return node; - } - }, - - /** - * 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 - */ - 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); - - // update siblings - if(node.previousSibling){ - node.previousSibling.nextSibling = node.nextSibling; - } - if(node.nextSibling){ - node.nextSibling.previousSibling = node.previousSibling; - } - - // update child refs - if(this.firstChild == node){ - this.setFirstChild(node.nextSibling); - } - if(this.lastChild == node){ - this.setLastChild(node.previousSibling); - } - - this.fireEvent("remove", this.ownerTree, this, node); - if(destroy){ - node.destroy(true); - }else{ - node.clear(); + 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); } - return node; + this.execCmd('FontSize', size); }, // 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; - } + onEditorEvent: function(e) { + this.updateToolbar(); }, /** - * Destroys the node. + * 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. */ - 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); - } - }, + updateToolbar: function() { + var me = this, + btns, doc, name, fontSelect; - /** - * 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 (me.readOnly) { + return; } - if(this.fireEvent("beforeinsert", this.ownerTree, this, node, refNode) === false){ - return false; + if (!me.activated) { + me.onFirstFocus(); + return; } - 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--; - } + btns = me.getToolbar().items.map; + doc = me.getDoc(); - // 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; + if (me.enableFont && !Ext.isSafari2) { + name = (doc.queryCommandValue('FontName') || me.defaultFont).toLowerCase(); + fontSelect = me.fontSelect.dom; + if (name !== fontSelect.value) { + fontSelect.value = name; } - oldParent.removeChild(node); } - if(refIndex === 0){ - this.setFirstChild(node); + + function updateButtons() { + Ext.Array.forEach(Ext.Array.toArray(arguments), function(name) { + btns[name].toggle(doc.queryCommandState(name)); + }); } - 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; + if(me.enableFormat){ + updateButtons('bold', 'italic', 'underline'); } - 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); + if(me.enableAlignments){ + updateButtons('justifyleft', 'justifycenter', 'justifyright'); } - return node; - }, - - /** - * 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); + if(!Ext.isSafari2 && me.enableLists){ + updateButtons('insertorderedlist', 'insertunorderedlist'); } - return this; - }, - /** - * 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; + Ext.menu.Manager.hideAll(); + + me.syncValue(); }, - /** - * Returns the child node at the specified index. - * @param {Number} index - * @return {Node} - */ - item : function(index){ - return this.childNodes[index]; + // private + relayBtnCmd: function(btn) { + this.relayCmd(btn.getItemId()); }, /** - * 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 + * 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) */ - replaceChild : function(newChild, oldChild){ - var s = oldChild ? oldChild.nextSibling : null; - this.removeChild(oldChild); - this.insertBefore(newChild, s); - return oldChild; + relayCmd: function(cmd, value) { + Ext.defer(function() { + var me = this; + me.focus(); + me.execCmd(cmd, value); + me.updateToolbar(); + }, 10, this); }, /** - * Returns the index of a child node - * @param {Node} node - * @return {Number} The index of the node or -1 if it was not found + * 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) */ - indexOf : function(child){ - return this.childNodes.indexOf(child); + execCmd : function(cmd, value){ + var me = this, + doc = me.getDoc(), + undef; + doc.execCommand(cmd, false, value === undef ? null : value); + me.syncValue(); }, - /** - * Returns the tree this node is in. - * @return {Tree} - */ - 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; + // 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; } - p = p.parentNode; + if (cmd) { + me.win.focus(); + me.execCmd(cmd); + me.deferFocus(); + e.preventDefault(); + } } } - return this.ownerTree; }, /** - * Returns depth of this node (the root node has a depth of 0) - * @return {Number} + * Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated + * to insert text. + * @param {String} text */ - getDepth : function(){ - var depth = 0; - var p = this; - while(p.parentNode){ - ++depth; - p = p.parentNode; - } - return depth; - }, + insertAtCursor : function(text){ + var me = this, + range; - // 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); + if (me.activated) { + me.win.focus(); + if (Ext.isIE) { + range = me.getDoc().selection.createRange(); + if (range) { + range.pasteHTML(text); + me.syncValue(); + me.deferFocus(); + } + }else{ + me.execCmd('InsertHTML', text); + me.deferFocus(); } } }, - /** - * 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); - } - this.onIdChange(id); + // 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 (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(); + } + } + } + }; } - }, - // private - onIdChange: Ext.emptyFn, + if (Ext.isOpera) { + return function(e){ + var me = this; + if (e.getKey() === e.TAB) { + e.stopEvent(); + me.win.focus(); + me.execCmd('InsertHTML','    '); + me.deferFocus(); + } + }; + } - /** - * 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; + if (Ext.isWebKit) { + return function(e){ + var me = this, + k = e.getKey(); + if (k === e.TAB) { + e.stopEvent(); + me.execCmd('InsertText','\t'); + me.deferFocus(); + } + else if (k === e.ENTER) { + e.stopEvent(); + me.execCmd('InsertHtml',' '); + me.deferFocus(); + } + }; } - var sep = this.getOwnerTree().pathSeparator; - return sep + b.join(sep); - }, + + return null; // not needed, so null + }(), /** - * 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) + * Returns the editor's toolbar. This is only available after the editor has been rendered. + * @return {Ext.toolbar.Toolbar} */ - bubble : function(fn, scope, args){ - var p = this; - while(p){ - if(fn.apply(scope || p, args || [p]) === false){ - break; - } - p = p.parentNode; - } + getToolbar : function(){ + return this.toolbar; }, /** - * 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) + * 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 */ - 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); - } + buttonTips : { + bold : { + title: 'Bold (Ctrl+B)', + text: 'Make the selected text bold.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + italic : { + title: 'Italic (Ctrl+I)', + text: 'Make the selected text italic.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + underline : { + title: 'Underline (Ctrl+U)', + text: 'Underline the selected text.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + increasefontsize : { + title: 'Grow Text', + text: 'Increase the font size.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + decreasefontsize : { + title: 'Shrink Text', + text: 'Decrease the font size.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + backcolor : { + title: 'Text Highlight Color', + text: 'Change the background color of the selected text.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + forecolor : { + title: 'Font Color', + text: 'Change the color of the selected text.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + justifyleft : { + title: 'Align Text Left', + text: 'Align text to the left.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + justifycenter : { + title: 'Center Text', + text: 'Center text in the editor.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + justifyright : { + title: 'Align Text Right', + text: 'Align text to the right.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + insertunorderedlist : { + title: 'Bullet List', + text: 'Start a bulleted list.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + insertorderedlist : { + title: 'Numbered List', + text: 'Start a numbered list.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + createlink : { + title: 'Hyperlink', + text: 'Make the selected text a hyperlink.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' + }, + sourceedit : { + title: 'Source Edit', + text: 'Switch to source editing mode.', + cls: Ext.baseCSSPrefix + 'html-editor-tip' } - }, + } + // hide stuff that is not compatible /** - * 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) + * @event blur + * @hide */ - 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; - } - } - }, - /** - * 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 + * @event change + * @hide */ - findChild : function(attribute, value, deep){ - return this.findChildBy(function(){ - return this.attributes[attribute] == value; - }, null, deep); - }, - /** - * 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 + * @event focus + * @hide */ - 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; - } - } - - } - 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. + * @event specialkey + * @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 {String} fieldCls @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 {String} focusCls @hide */ - isAncestor : function(node){ - var p = this.parentNode; - while(p){ - if(p == node){ - return true; - } - p = p.parentNode; - } - return false; - }, - - 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 - */ -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; - /** - * Read-only. The text for this node. To change it use {@link #setText}. - * @type String + * @cfg {String} autoCreate @hide */ - this.text = attributes.text; /** - * True if this node is disabled. - * @type Boolean + * @cfg {String} inputType @hide */ - this.disabled = attributes.disabled === true; /** - * True if this node is hidden. - * @type Boolean + * @cfg {String} invalidCls @hide */ - this.hidden = attributes.hidden === true; - - 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' - ); - - var uiClass = this.attributes.uiProvider || this.defaultUI || Ext.tree.TreeNodeUI; - /** - * Read-only. The UI for this node - * @type TreeNodeUI + * @cfg {String} invalidText @hide */ - this.ui = new uiClass(this); -}; -Ext.extend(Ext.tree.TreeNode, Ext.data.Node, { - preventHScroll : true, /** - * Returns true if this node is expanded - * @return {Boolean} + * @cfg {String} msgFx @hide */ - isExpanded : function(){ - return this.expanded; - }, - -/** - * 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; - }, - - getLoader : function(){ - var owner; - return this.loader || ((owner = this.getOwnerTree()) && owner.loader ? owner.loader : (this.loader = new Ext.tree.TreeLoader())); - }, - - // 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); - } - }, - - // 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); - } - }, - - // 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 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; - } - } - 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; - }, - /** - * Sets the text for this node - * @param {String} text + * @cfg {Boolean} allowDomMove @hide */ - 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); - }, - /** - * Triggers selection of this node + * @cfg {String} applyTo @hide */ - select : function(){ - var t = this.getOwnerTree(); - if(t){ - t.getSelectionModel().select(this); - } - }, - /** - * Triggers deselection of this node - * @param {Boolean} silent (optional) True to stop selection change events from firing. + * @cfg {String} readOnly @hide */ - unselect : function(silent){ - var t = this.getOwnerTree(); - if(t){ - t.getSelectionModel().unselect(this, silent); - } - }, - /** - * Returns true if this node is selected - * @return {Boolean} + * @cfg {String} tabIndex @hide */ - 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. + * @method validate + * @hide */ - 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); +}); + +/** + * @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' } - }.createDelegate(this)); - return; - }else{ - this.ui.expand(); - this.fireEvent('expand', this); - this.runCallback(callback, scope || this, [this]); + ] + }, + { + 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' + } + ] } - }else{ - this.runCallback(callback, scope || this, [this]); - } - if(deep === true){ - this.expandChildNodes(true); - } - }, + ], + 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; + } - runCallback : function(cb, scope, args){ - if(Ext.isFunction(cb)){ - cb.apply(scope, args); - } - }, + //if XL is selected, change to L + if (radio3.getValue()) { + radio2.setValue(true); + return; + } - isHiddenRoot : function(){ - return this.isRoot && !this.getOwnerTree().rootVisible; - }, + //if nothing is set, set size to S + radio1.setValue(true); + } + }, + { + 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; + } - /** - * 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. - */ - 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); + //if L is selected, change to XL + if (radio2.getValue()) { + radio3.setValue(true); + return; } - }.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); - } - } - }, - // private - delayedExpand : function(delay){ - if(!this.expandProcId){ - this.expandProcId = this.expand.defer(delay, this); - } - }, + //if nothing is set, set size to XL + radio3.setValue(true); + } + }, + '-', + { + 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); + } + } + ] + } + } + ] + }); + - // private - cancelExpand : function(){ - if(this.expandProcId){ - clearTimeout(this.expandProcId); - } - this.expandProcId = false; - }, + * @constructor + * Creates a new Radio + * @param {Object} config Configuration options + * @xtype radio + * @docauthor Robert Dougan + * @markdown + */ +Ext.define('Ext.form.field.Radio', { + extend:'Ext.form.field.Checkbox', + alias: ['widget.radiofield', 'widget.radio'], + alternateClassName: 'Ext.form.Radio', + requires: ['Ext.form.RadioManager'], - /** - * Toggles expanded/collapsed state of the node - */ - toggle : function(){ - if(this.expanded){ - this.collapse(); - }else{ - this.expand(); - } - }, + isRadio: true, /** - * 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. + * @cfg {String} uncheckedValue @hide */ - 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)); - }, - /** - * Expand all child nodes - * @param {Boolean} deep (optional) true if the child nodes should also expand their child nodes - */ - expandChildNodes : function(deep){ - var cs = this.childNodes; - for(var i = 0, len = cs.length; i < len; i++) { - cs[i].expand(deep); - } - }, + // private + inputType: 'radio', + ariaRole: 'radio', /** - * Collapse all child nodes - * @param {Boolean} deep (optional) true if the child nodes should also collapse their child nodes + * If this radio is part of a group, it will return the selected value + * @return {String} */ - collapseChildNodes : function(deep){ - var cs = this.childNodes; - for(var i = 0, len = cs.length; i < len; i++) { - cs[i].collapse(deep); - } + getGroupValue: function() { + var selected = this.getManager().getChecked(this.name); + return selected ? selected.inputValue : null; }, /** - * Disables this node + * @private Handle click on the radio button */ - disable : function(){ - this.disabled = true; - this.unselect(); - if(this.rendered && this.ui.onDisableChange){ // event without subscribing - this.ui.onDisableChange(this, true); + onBoxClick: function(e) { + var me = this; + if (!me.disabled && !me.readOnly) { + this.setValue(true); } - this.fireEvent('disabledchange', this, true); }, /** - * Enables this node + * 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 */ - enable : function(){ - this.disabled = false; - if(this.rendered && this.ui.onDisableChange){ // event without subscribing - this.ui.onDisableChange(this, false); - } - this.fireEvent('disabledchange', this, false); - }, - - // 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; - }, + setValue: function(v) { + var me = this, + active; - // 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); + if (Ext.isBoolean(v)) { + me.callParent(arguments); + } else { + active = me.getManager().getWithValue(me.name, v).getAt(0); + if (active) { + active.setValue(true); } } + return me; }, - // 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); - } - } + /** + * 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; }, - // 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); - } - } + getModelData: function() { + return this.getSubmitData(); }, - beginUpdate : function(){ - this.childrenRendered = false; - }, + // inherit docs + onChange: function(newVal, oldVal) { + var me = this; + me.callParent(arguments); - endUpdate : function(){ - if(this.expanded && this.rendered){ - this.renderChildren(); + if (newVal) { + this.getManager().getByName(me.name).each(function(item){ + if (item !== me) { + item.setValue(false); + } + }, me); } }, - //inherit docs - destroy : function(silent){ - if(silent === true){ - this.unselect(true); - } - Ext.tree.TreeNode.superclass.destroy.call(this, silent); - Ext.destroy(this.ui, this.loader); - this.ui = this.loader = null; + // inherit docs + beforeDestroy: function(){ + this.callParent(); + this.getManager().removeAtKey(this.id); }, - // private - onIdChange : function(id){ - this.ui.onIdChange(id); + // inherit docs + getManager: function() { + return Ext.form.RadioManager; } }); -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) +/** + * @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 - * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node + * Create a new TimePicker + * @param {Object} config The config object + * + * @xtype timepicker */ - 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'); +Ext.define('Ext.picker.Time', { + extend: 'Ext.view.BoundList', + alias: 'widget.timepicker', + requires: ['Ext.data.Store', 'Ext.Date'], + /** - * @event load - * Fires when this node is loaded - * @param {Node} this This node - */ + * @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. + */ + /** - * The loader used by this node (defaults to using the tree's defined loader) - * @type TreeLoader - * @property loader + * @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. */ -}; -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); - }, - + /** - * Returns true if this node is currently loading - * @return {Boolean} + * @cfg {Number} increment + * The number of minutes between each time value in the list (defaults to 15). */ - 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); - }, - + increment: 15, + /** - * Returns true if this node has been loaded - * @return {Boolean} + * @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. */ - isLoaded : function(){ - return this.loaded; - }, - - hasChildNodes : function(){ - if(!this.isLeaf() && !this.loaded){ - return true; - }else{ - return Ext.tree.AsyncTreeNode.superclass.hasChildNodes.call(this); - } - }, + format : "g:i A", /** - * 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. + * @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. */ - 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); - } -}); + displayField: 'disp', -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; -}; + /** + * @private + * Year, month, and day that all times will be normalized into internally. + */ + initDate: [2008,1,1], -Ext.tree.TreeNodeUI.prototype = { - // private - removeChild : function(node){ - if(this.rendered){ - this.ctNode.removeChild(node.ui.getEl()); - } - }, + componentCls: Ext.baseCSSPrefix + 'timepicker', - // private - beforeLoad : function(){ - this.addClass("x-tree-node-loading"); - }, + /** + * @hide + */ + loadingText: '', - // private - afterLoad : function(){ - this.removeClass("x-tree-node-loading"); - }, + initComponent: function() { + var me = this, + dateUtil = Ext.Date, + clearTime = dateUtil.clearTime, + initDate = me.initDate.join('/'); - // private - onTextChange : function(node, text, oldText){ - if(this.rendered){ - this.textNode.innerHTML = text; - } - }, + // 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); - // 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"); - } - }, + me.store = me.createStore(); + me.updateList(); - // private - onSelectedChange : function(state){ - if(state){ - this.focus(); - this.addClass("x-tree-selected"); - }else{ - //this.blur(); - this.removeClass("x-tree-selected"); - } + this.callParent(); }, - // 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); - } + /** + * Set the {@link #minValue} and update the list of available times. This must be a Date + * object (only the time fields will be used); no parsing of String values will be done. + * @param {Date} value + */ + setMinValue: function(value) { + this.minValue = value; + this.updateList(); }, -/** - * 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); - } + /** + * Set the {@link #maxValue} and update the list of available times. This must be a Date + * object (only the time fields will be used); no parsing of String values will be done. + * @param {Date} value + */ + setMaxValue: function(value) { + this.maxValue = value; + this.updateList(); }, -/** - * 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 - */ - removeClass : function(cls){ - if(this.elNode){ - Ext.fly(this.elNode).removeClass(cls); - } + /** + * @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; }, - // private - remove : function(){ - if(this.rendered){ - this.holder = document.createElement("div"); - this.holder.appendChild(this.wrap); - } - }, + /** + * 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); - // private - fireEvent : function(){ - return this.node.fireEvent.apply(this.node, arguments); + me.store.filterBy(function(record) { + var date = record.get('date'); + return date >= min && date <= max; + }); }, - // private - initEvents : function(){ - this.node.on("move", this.onMove, this); + /** + * @private + * Creates the internal {@link Ext.data.Store} that contains the available times. The store + * is loaded with all possible times, and it is later filtered to hide those times outside + * the minValue/maxValue. + */ + createStore: function() { + var me = this, + utilDate = Ext.Date, + times = [], + min = me.absMin, + max = me.absMax; - 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 + while(min <= max){ + times.push({ + disp: utilDate.dateFormat(min, me.format), + date: min }); + min = utilDate.add(min, 'mi', me.increment); } - }, - // private - getDDHandles : function(){ - return [this.iconNode, this.textNode, this.elNode]; - }, + return Ext.create('Ext.data.Store', { + fields: ['disp', 'date'], + data: times + }); + } -/** - * Hides this node. - */ - hide : function(){ - this.node.hidden = true; - if(this.wrap){ - this.wrap.style.display = "none"; - } - }, +}); /** - * Shows this node. + * @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 */ - show : function(){ - this.node.hidden = false; - if(this.wrap){ - this.wrap.style.display = ""; - } - }, - - // private - onContextMenu : function(e){ - if (this.node.hasListener("contextmenu") || this.node.getOwnerTree().hasListener("contextmenu")) { - e.preventDefault(); - this.focus(); - this.fireEvent("contextmenu", this.node, e); - } - }, +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'], - // 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; - } + /** + * @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', - if(this.node.attributes.singleClickExpand && !this.animating && this.node.isExpandable()){ - this.node.toggle(); - } + /** + * @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). + */ - this.fireEvent("click", this.node, e); - }else{ - e.stopEvent(); - } - }, + /** + * @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). + */ - // 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); - } - }, + /** + * @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}", - onOver : function(e){ - this.addClass('x-tree-node-over'); - }, + /** + * @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}", - onOut : function(e){ - this.removeClass('x-tree-node-over'); - }, + /** + * @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 - 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); - }, + /** + * @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 - ecClick : function(e){ - if(!this.animating && this.node.isExpandable()){ - this.node.toggle(); - } - }, + /** + * @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}). + */ - // private - startDrop : function(){ - this.dropping = true; - }, + /** + * @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", - // delayed drop so the click event doesn't get fired on a drop - endDrop : function(){ - setTimeout(function(){ - this.dropping = false; - }.createDelegate(this), 50); - }, + /** + * @cfg {Number} increment + * The number of minutes between each time value in the list (defaults to 15). + */ + increment: 15, - // private - expand : function(){ - this.updateExpandIcon(); - this.ctNode.style.display = ""; - }, + /** + * @cfg {Number} pickerMaxHeight + * The maximum height of the {@link Ext.picker.Time} dropdown. Defaults to 300. + */ + pickerMaxHeight: 300, - // 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){} - } - }, + /** + * @cfg {Boolean} selectOnTab + * Whether the Tab key should select the currently highlighted item. Defaults to true. + */ + selectOnTab: true, -/** - * 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(); - } - }, + /** + * @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', - // private - blur : function(){ - try{ - this.anchor.blur(); - }catch(e){} - }, - // 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; + initComponent: function() { + var me = this, + min = me.minValue, + max = me.maxValue; + if (min) { + me.setMinValue(min); } - this.animating = true; - this.updateExpandIcon(); - - ct.slideIn('t', { - callback : function(){ - this.animating = false; - Ext.callback(callback); - }, - scope: this, - duration: this.node.ownerTree.duration || .25 - }); + if (max) { + me.setMaxValue(max); + } + this.callParent(); }, - // private - highlight : function(){ - var tree = this.node.getOwnerTree(); - Ext.fly(this.wrap).highlight( - tree.hlColor || "C3DAF9", - {endColor: tree.hlBaseColor} - ); - }, + initValue: function() { + var me = this, + value = me.value; - // private - collapse : function(){ - this.updateExpandIcon(); - this.ctNode.style.display = "none"; - }, + // If a String value was supplied, try to convert it to a proper Date object + if (Ext.isString(value)) { + me.value = me.rawToValue(value); + } - // 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 - }); + me.callParent(); }, - // private - getContainer : function(){ - return this.ctNode; + /** + * 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); + } }, -/** - * Returns the element which encapsulates this node. - * @return {HtmlElement} The DOM element. The default implementation uses a <li>. - */ - getEl : function(){ - return this.wrap; + /** + * Replaces any existing {@link #maxValue} with the new time and refreshes the picker's range. + * @param {Date/String} value The maximum time that can be selected + */ + setMaxValue: function(value) { + var me = this, + picker = me.picker; + me.setLimit(value, false); + if (picker) { + picker.setMaxValue(me.maxValue); + } }, - // private - appendDDGhost : function(ghostNode){ - ghostNode.appendChild(this.elNode.cloneNode(true)); + /** + * @private + * Updates either the min or max value. Converts the user's value into a Date object whose + * year/month/day is set to the {@link #initDate} so that only the time fields are significant. + */ + setLimit: function(value, isMin) { + var me = this, + d, val; + if (Ext.isString(value)) { + d = me.parseDate(value); + } + else if (Ext.isDate(value)) { + d = value; + } + if (d) { + val = Ext.Date.clearTime(new Date(me.initDate)); + val.setHours(d.getHours(), d.getMinutes(), d.getSeconds(), d.getMilliseconds()); + me[isMin ? 'minValue' : 'maxValue'] = val; + } }, - // private - getDDRepairXY : function(){ - return Ext.lib.Dom.getXY(this.iconNode); + rawToValue: function(rawValue) { + return this.parseDate(rawValue) || rawValue || null; }, - // private - onRender : function(){ - this.render(); + valueToRaw: function(value) { + return this.formatDate(this.parseDate(value)); }, - // private - render : function(bulkRender){ - var n = this.node, a = n.attributes; - var targetNode = n.parentNode ? - n.parentNode.ui.getContainer() : n.ownerTree.innerCt.dom; - - if(!this.rendered){ - this.rendered = true; + /** + * 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 + */ + getErrors: function(value) { + var me = this, + format = Ext.String.format, + errors = me.callParent(arguments), + minValue = me.minValue, + maxValue = me.maxValue, + date; - this.renderElements(n, a, targetNode, bulkRender); + value = me.formatDate(value || me.processRawValue(me.getRawValue())); - 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); - } - }else{ - if(bulkRender === true) { - targetNode.appendChild(this.wrap); - } + if (value === null || value.length < 1) { // if it's blank and textfield didn't flag it then it's valid + return errors; } - }, - // 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++; + date = me.parseDate(value); + if (!date) { + errors.push(format(me.invalidText, value, me.format)); + return errors; } - 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; - }, + if (minValue && date < minValue) { + errors.push(format(me.minText, me.formatDate(minValue))); + } -/** - * Returns the text node. - * @return {HtmlNode} The DOM text node. - */ - getTextEl : function(){ - return this.textNode; - }, + if (maxValue && date > maxValue) { + errors.push(format(me.maxText, me.formatDate(maxValue))); + } -/** - * Returns the icon <img> element. - * @return {HtmlElement} The DOM image element. - */ - getIconEl : function(){ - return this.iconNode; + return errors; }, -/** - * 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; + formatDate: function() { + return Ext.form.field.Date.prototype.formatDate.apply(this, arguments); }, - // 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; - } + /** + * @private + * Parses an input value into a valid Date object. + * @param {String/Date} value + */ + parseDate: function(value) { + if (!value || Ext.isDate(value)) { + return value; } - }, - // private - onIdChange: function(id){ - if(this.rendered){ - this.elNode.setAttribute('ext:tree-node-id', id); - } - }, + var me = this, + val = me.safeParse(value, me.format), + altFormats = me.altFormats, + altFormatsArray = me.altFormatsArray, + i = 0, + len; - // 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; + if (!val && altFormats) { + altFormatsArray = altFormatsArray || altFormats.split('|'); + len = altFormatsArray.length; + for (; i < len && !val; ++i) { + val = me.safeParse(value, altFormatsArray[i]); } - this.childIndent = buf.join(""); } - return this.childIndent; + return val; }, - // 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; + safeParse: function(value, format){ + var me = this, + utilDate = Ext.Date, + parsedDate, + result = null; + + if (utilDate.formatContainsDateInfo(format)) { + // assume we've been given a full date + result = utilDate.parse(value, format); + } else { + // Use our initial safe date + parsedDate = utilDate.parse(me.initDate + ' ' + value, me.initDateFormat + ' ' + format); + if (parsedDate) { + result = parsedDate; } - this.updateExpandIcon(); } + return result; }, - destroy : function(){ - if(this.elNode){ - Ext.dd.Registry.unregister(this.elNode.id); - } - - 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; - } -}; - -/** - * @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); + // @private + getSubmitValue: function() { + var me = this, + format = me.submitFormat || me.format, + value = me.getValue(); - 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,|]/); - } -}; + return value ? Ext.Date.format(value, format) : null; + }, -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. + * @private + * Creates the {@link Ext.picker.Time} */ - /** - * @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 : {}, + 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 + }); - /** - * @cfg {Boolean} clearOnLoad (optional) Default to true. Remove previously existing - * child nodes before loading. - */ - clearOnLoad : true, + me.mon(picker.getSelectionModel(), { + selectionchange: me.onListSelect, + scope: me + }); + + return picker; + }, /** - * @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' - + * @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. */ - paramOrder: undefined, + 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); + } + } + }, /** - * @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. + * @private + * Disables the key nav for the Time picker when it is collapsed. */ - paramsAsHash: false, + onCollapse: function() { + var me = this, + keyNav = me.pickerKeyNav; + if (keyNav) { + keyNav.disable(); + me.ignoreMonitorTab = false; + } + }, /** - * @cfg {String} nodeParameter The name of the parameter sent to the server which contains - * the identifier of the node. Defaults to 'node'. + * @private + * Handles a time being selected from the Time picker. */ - nodeParameter: 'node', + 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.grid.CellEditor + * @extends Ext.Editor + * Internal utility class that provides default configuration for cell editing. + * @ignore + */ +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); + }, + /** - * @cfg {Function} directFn - * Function to call when executing a request. + * @private + * Hide the grid cell when editor is shown. */ - directFn : undefined, - + onShow: function() { + var first = this.boundEl.first(); + if (first) { + first.hide(); + } + this.callParent(arguments); + }, + /** - * 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. + * @private + * Show grid cell when editor is hidden. */ - load : function(node, callback, scope){ - if(this.clearOnLoad){ - while(node.firstChild){ - node.removeChild(node.firstChild); - } + onHide: function() { + var first = this.boundEl.first(); + if (first) { + first.show(); } - 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); + this.callParent(arguments); + }, + + /** + * @private + * Fix checkbox blur when it is clicked. + */ + 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); } }, + + /** + * @private + * Because when checkbox is clicked it loses focus completeEdit is bypassed. + */ + onCheckBoxMouseDown: function() { + this.completeEdit = Ext.emptyFn; + }, + + /** + * @private + * Restore checkbox focus and completeEdit method. + */ + onCheckBoxClick: function() { + delete this.completeEdit; + this.field.focus(false, 10); + }, + + 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', - 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; + // Height-stretched innerCt must be able to revert back to unstretched height + clearInnerCtOnLayout: false, + + constructor: function() { + var me = this; + me.callParent(arguments); + if (!Ext.isDefined(me.availableSpaceOffset)) { + me.availableSpaceOffset = (Ext.getScrollBarWidth() - 2); } - return false; }, - getParams: function(node){ - var bp = Ext.apply({}, this.baseParams), - np = this.nodeParameter, - po = this.paramOrder; + beforeLayout: function() { + var me = this, + i = 0, + items = me.getLayoutItems(), + len = items.length, + item, returnValue; - np && (bp[ np ] = node.id); + returnValue = me.callParent(arguments); - 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 = []; - } + // Size to a sane minimum height before possibly being stretched to accommodate grouped headers + me.innerCt.setHeight(23); - for(var i = 0, len = po.length; i < len; i++){ - buf.push(bp[ po[i] ]); + // 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; } - }else if(this.paramsAsHash){ - buf = [bp]; } - return buf; - }else{ - return bp; } + return returnValue; }, - 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, []); - } - }, + // 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; - 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 - }); - } - }, + if (targetSize.width && !me.isColumn) { + // If configured forceFit then all columns will be flexed + if (me.owner.forceFit) { - // private - runCallback: function(cb, scope, args){ - if(Ext.isFunction(cb)){ - cb.apply(scope, args); - } - }, + for (; i < len; i++) { + box = boxes[i]; + item = box.component; - isLoading : function(){ - return !!this.transId; - }, + // 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; - abort : function(){ - if(this.isLoading()){ - Ext.Ajax.abort(this.transId); - } - }, + // 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; + } - /** - * 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; + // Recalculate based upon all columns now being flexed instead of sized. + calculations = me.callParent(arguments); } - 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; - } - if(Ext.isString(attr.uiProvider)){ - attr.uiProvider = this.uiProviders[attr.uiProvider] || eval(attr.uiProvider); - } - 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); - } - }, - - 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 (metaData.tooNarrow) { + targetSize.width = metaData.desiredSize; } - node.endUpdate(); - this.runCallback(callback, scope || node, [node]); - }catch(e){ - this.handleFailure(response); } - }, - - 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]); + return calculations; }, - 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); -}; + afterLayout: function() { + var me = this, + i = 0, + items = me.getLayoutItems(), + len = items.length; -Ext.tree.TreeFilter.prototype = { - clearBlank:false, - reverse:false, - autoClear:false, - remove:false, + me.callParent(arguments); - /** - * 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; + // Set up padding in items + if (me.align == 'stretchmax') { + for (; i < len; i++) { + items[i].setPadding(); } - 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'; } - this.filterBy(f, null, startNode); - }, + }, - /** - * 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. - */ - filterBy : function(fn, scope, startNode){ - startNode = startNode || this.tree.root; - if(this.autoClear){ - this.clear(); - } - 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; + // 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; } - 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); - } - } - } + + // 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); }, - /** - * Clears the current filter. Note: with the "remove" option - * set a filter cannot be cleared. - */ - 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(); - } - } + doOwnerCtLayouts: function() { + var ownerCt = this.owner.ownerCt; + if (!ownerCt.componentLayout.layoutBusy) { + ownerCt.doComponentLayout(); } - 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 +/** + * @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.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; +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); } - if(!n1.attributes[leafAttr] && n2.attributes[leafAttr]){ - return -1; + } + 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); } - 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; + }, + + onItemMouseLeave: function(view, record){ + var me = this, + locked = me.lockedView, + other = me.normalView; + + if (view.trackOver) { + if (view !== locked) { + other = locked; + } + other.clearHighlight(); } - }; -}; - -Ext.tree.TreeSorter.prototype = { - doSort : function(node){ - node.sort(this.sortFn); }, - - compareNodes : function(n1, n2){ - return (n1.text.toUpperCase() > n2.text.toUpperCase() ? 1 : -1); + + relayFn: function(name, args){ + args = args || []; + + var view = this.lockedView; + view[name].apply(view, args || []); + view = this.normalView; + view[name].apply(view, args || []); }, - - updateSort : function(tree, node){ - if(node.childrenRendered){ - this.doSort.defer(1, this, [node]); + + 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()); }, - - updateSortParent : function(node){ - var p = node.parentNode; - if(p && p.childrenRendered){ - this.doSort.defer(1, this, [p]); + + getRecord: function(node){ + var result = this.lockedView.getRecord(node); + if (!node) { + result = this.normalView.getRecord(node); } + return result; + }, + + addElListener: function(eventName, fn, scope){ + this.relayFn('addElListener', arguments); + }, + + refreshNode: function(){ + this.relayFn('refreshNode', arguments); + }, + + refresh: function(){ + this.relayFn('refresh', arguments); + }, + + bindStore: function(){ + this.relayFn('bindStore', arguments); + }, + + addRowCls: function(){ + this.relayFn('addRowCls', arguments); + }, + + removeRowCls: function(){ + this.relayFn('removeRowCls', arguments); } -};/** - * @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 + +}); +/** + * @class Ext.grid.Lockable + * @private + * + * Lockable is a private mixin which injects lockable behavior into any + * TablePanel subclass such as GridPanel or TreePanel. TablePanel will + * automatically inject the Ext.grid.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. */ -if(Ext.dd.DropZone){ +Ext.define('Ext.grid.Lockable', { + + requires: ['Ext.grid.LockingView'], -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) + * @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. */ - this.allowContainerDrop = config.allowContainerDrop || false; + syncRowHeight: true, + /** - * @cfg {String} appendOnly - * True if the tree should only allow append drops (use for trees which are sorted, defaults to false) + * @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. */ - 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'). + * @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. */ - 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) + * @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. */ - 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 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; - // private - cancelExpand : function(){ - if(this.expandProcId){ - clearTimeout(this.expandProcId); - this.expandProcId = 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; + } } + + 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 - 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; + 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]]; } - if(dropNode && (targetNode == dropNode || dropNode.contains(targetNode))){ - return false; + for (i = 0; i < me.lockedCfgCopy.length; i++) { + delete me[me.lockedCfgCopy[i]]; } - // 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; - }, + + me.lockedHeights = []; + me.normalHeights = []; + + columns = me.processColumns(me.columns); - // 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"; + 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 + }); } - }, + + 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]; - // private - onNodeEnter : function(n, dd, e, data){ - this.cancelExpand(); + me.layout = { + type: 'hbox', + align: 'stretch' + }; }, - 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; + 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); + } } - return this.dropNotAllowed; + return { + lockedWidth: lockedWidth, + locked: lockedHeaders, + normal: normalHeaders + }; }, - - // 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; + + // 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 + }); }, - - // private - onNodeOut : function(n, dd, e, data){ - this.cancelExpand(); - this.removeDropIndicators(n); + + // trigger a pseudo refresh on the normal side + onLockedHeaderMove: function() { + if (this.syncRowHeight) { + this.onNormalGridAfterRefresh(); + } }, - - // 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; + + // trigger a pseudo refresh on the locked side + onNormalHeaderMove: function() { + if (this.syncRowHeight) { + this.onLockedGridAfterRefresh(); } - // 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); + // 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; } - 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; + // 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(); + }, - target = dropEvent.target; - if(point == 'append' && !target.isExpanded()){ - target.expand(false, null, function(){ - this.completeDrop(dropEvent); - }.createDelegate(this)); - }else{ - this.completeDrop(dropEvent); + // 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; } - return true; + 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]); + } + } + } - // 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); + // 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 = []; } - n.ui.focus(); - if(Ext.enableFx && this.tree.hlDrop){ - n.ui.highlight(); + }, + + // track when scroller is shown + onScrollerShow: function(scroller, direction) { + if (direction === 'horizontal') { + this.spacerHidden = false; + this.spacerEl.removeCls(Ext.baseCSSPrefix + 'hidden'); } - 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(); + + // track when scroller is hidden + onScrollerHide: function(scroller, direction) { + if (direction === 'horizontal') { + this.spacerHidden = true; + this.spacerEl.addCls(Ext.baseCSSPrefix + 'hidden'); } - this.tree.fireEvent("nodedrop", this.tree, targetNode, data, dd, e); }, - // private - getTree : function(){ - return this.tree; + + // inject Lock and Unlock text + modifyHeaderCt: function() { + var me = this; + me.lockedGrid.headerCt.getMenuItems = me.getMenuItems(true); + me.normalGrid.headerCt.getMenuItems = me.getMenuItems(false); }, - - // 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"; - } + + onUnlockMenuClick: function() { + this.unlock(); }, - - // private - beforeDragDrop : function(target, e, id){ - this.cancelExpand(); - return true; + + onLockMenuClick: function() { + this.lock(); }, - - // private - afterRepair : function(data){ - if(data && Ext.enableFx){ - data.node.ui.highlight(); - } - this.hideProxy(); - } -}); - -}/** - * @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; -}; - -Ext.extend(Ext.tree.TreeDragZone, Ext.dd.DragZone, { + + 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 /** - * @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'). + * 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 */ - ddGroup : "TreeDD", - - // private - onBeforeDrag : function(data, e){ - var n = data.node; - return n && n.draggable && !n.disabled; + 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(); }, - - // 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); + + syncLockedSection: function() { + var me = this; + me.syncLockedWidth(); + me.lockedGrid.getView().refresh(); + me.normalGrid.getView().refresh(); }, - - // private - getRepairXY : function(e, data){ - return data.node.ui.getDDRepairXY(); + + // 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); }, - - // private - onEndDrag : function(data, e){ - this.tree.eventModel.enable.defer(100, this.tree.eventModel); - this.tree.fireEvent("enddrag", this.tree, data.node, e); + + onLockedHeaderResize: function() { + this.syncLockedWidth(); }, - - // private - onValidDrop : function(dd, e, id){ - this.tree.fireEvent("dragdrop", this.tree, this.dragData.node, dd, e); - this.hideProxy(); + + onLockedHeaderHide: function() { + this.syncLockedWidth(); }, - - // 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); + + onLockedHeaderShow: function() { + this.syncLockedWidth(); }, - // private - afterRepair : function(){ - if (Ext.enableFx && this.tree.hlDrop) { - Ext.Element.fly(this.dragData.ddel).highlight(this.hlColor || "c3daf9"); + 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); } - 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, + onNormalHeaderSortChange: function(headerCt, header, sortState) { + if (sortState) { + // no real header, and silence the event so we dont get into an + // infinite loop + this.lockedGrid.headerCt.clearOtherSortStates(null, true); + } + }, + + // going from locked section to unlocked /** - * @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. + * 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 */ - editDelay : 350, + unlock: function(activeHd, toIdx) { + var me = this, + normalGrid = me.normalGrid, + lockedGrid = me.lockedGrid, + normalHCt = normalGrid.headerCt, + lockedHCt = lockedGrid.headerCt; + + if (!Ext.isDefined(toIdx)) { + toIdx = 0; + } + 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(); + } + } +}); - initEditor : function(tree){ - tree.on({ - scope : this, - beforeclick: this.beforeNodeClick, - dblclick : this.onNodeDblClick - }); +/** + * @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; - this.on({ - scope : this, - complete : this.updateNode, - beforestartedit: this.fitToTree, - specialkey : this.onSpecialKey - }); + me.cls += (' ' + cls); - this.on('startedit', this.bindScroll, this, {delay:10}); + Ext.applyIf(me.renderSelectors, { + stretchEl: '.' + Ext.baseCSSPrefix + 'stretcher' + }); + me.callParent(); }, - - // 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; - } + + + 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; }, - - // private - bindScroll : function(){ - this.tree.getTreeEl().on('scroll', this.cancelEdit, this); + + 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; + } + if (isNaN(width)) { + width = 1; + } + if (isNaN(height)) { + height = 1; + } + return { + width: width, + height: height + }; }, - - // private - beforeNodeClick : function(node, e){ - clearTimeout(this.autoEditTimer); - if(this.tree.getSelectionModel().isSelected(node)){ - e.stopEvent(); - return this.triggerEdit(node); + + 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; } }, - onNodeDblClick : function(node, e){ - clearTimeout(this.autoEditTimer); + onOwnerAfterLayout: function(owner, layout) { + this.invalidate(); }, - // private - updateNode : function(ed, value){ - this.tree.getTreeEl().un('scroll', this.cancelEdit, this); - this.editNode.setText(value); + /** + * Sets the scrollTop and constrains the value between 0 and max. + * @param {Number} scrollTop + * @return {Number} The resulting scrollTop value after being constrained + */ + setScrollTop: function(scrollTop) { + if (this.el) { + var elDom = this.el.dom; + return elDom.scrollTop = Ext.Number.constrain(scrollTop, 0, elDom.scrollHeight - elDom.clientHeight); + } }, - // private - onHide : function(){ - Ext.tree.TreeEditor.superclass.onHide.call(this); - if(this.editNode){ - this.editNode.ui.focus.defer(50, this.editNode.ui); + /** + * Sets the scrollLeft and constrains the value between 0 and max. + * @param {Number} scrollLeft + * @return {Number} The resulting scrollLeft value after being constrained + */ + setScrollLeft: function(scrollLeft) { + if (this.el) { + var elDom = this.el.dom; + return elDom.scrollLeft = Ext.Number.constrain(scrollLeft, 0, elDom.scrollWidth - elDom.clientWidth); } }, - // 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(); + /** + * 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); } }, - - 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)]; - } - } - } - catch(e) {} + /** + * 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); } - 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 (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](); - } - } + /** + * Scroll to the top. + */ + scrollToTop : function(){ + this.setScrollTop(0); + }, - function addDomLoadEvent(fn) { - if (isDomLoaded) { - fn(); - } - else { - domLoadFnArr[domLoadFnArr.length] = fn; // Array.push() is only available in IE5.5+ + // synchronize the scroller with the bound gridviews + onElScroll: function(event, target) { + this.fireEvent('bodyscroll', event, target); + }, + + 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, - /* 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 + /** + * @cfg {Number} scrollToLoadBuffer This is the time in milliseconds to buffer load requests + * when scrolling the PagingScrollbar. */ - 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; - } - } + scrollToLoadBuffer: 200, - /* Main function - - Will preferably execute onDomLoad, otherwise onload (as a fallback) - */ - function main() { - if (plugin) { - testPlayerVersion(); - } - else { - matchVersions(); - } - } + activePrefetch: true, - /* 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; - } - b.removeChild(o); - t = null; - matchVersions(); - })(); - } - else { - matchVersions(); - } - } + chunkSize: 50, + snapIncrement: 25, - /* 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); } - } - } - } - 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; - } - cb(cbObj); - } - } - } - } - } + syncScroll: true, - 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; - } + initComponent: function() { + var me = this, + ds = me.store; + + ds.on('guaranteedrange', this.onGuaranteedRange, this); + this.callParent(arguments); + }, - /* 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); - } - })(); + 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); + + if (!me.firstLoad) { + if (me.rendered) { + me.invalidate(); + } else { + me.on('afterrender', this.invalidate, this, {single: true}); } - createSWF(att, par, replaceElemIdStr); + me.firstLoad = true; + } else { + // adjust to visible + me.syncTo(); } - } + }, - /* 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); + 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; } - } - 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)); - } - } - } - } - } - return ac; - } + // 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); + }, - /* 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]); - } - } + 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; } - 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]); - } + 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); } - el.parentNode.replaceChild(o, el); - r = o; + // 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 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); - } + if (me.syncScroll) { + me.syncTo(); } - } + }, - function removeObjectInIE(id) { - var obj = getElementById(id); - if (obj) { - for (var i in obj) { - if (typeof obj[i] == "function") { - obj[i] = null; - } - } - obj.parentNode.removeChild(obj); + 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); } - } - - /* Functions to optimize JavaScript compression - */ - function getElementById(id) { - var el = null; - try { - el = doc.getElementById(id); + + height = store.getTotalCount() * this.rowHeight; + + if (isNaN(width)) { + width = 1; } - catch (e) {} - return el; - } + if (isNaN(height)) { + height = 1; + } + return { + width: width, + height: height + }; + }, - function createElement(el) { - return doc.createElement(el); - } + 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]); + }, - /* 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]; - } + cancelLoad: function() { + if (this.loadTask) { + this.loadTask.cancel(); + } + }, - /* 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; - } + doAttemptLoad: function(start, end) { + var store = this.getPanel().store; + store.guaranteeRange(start, end); + }, - /* 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 + "}")); - } + 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; } - } - - function setVisibility(id, isVisible) { - if (!autoHideShow) { return; } - var v = isVisible ? "visible" : "hidden"; - if (isDomLoaded && getElementById(id)) { - getElementById(id).style.visibility = v; + if (calcScrollTop > maxScrollTop) { + //Ext.Error.raise("Calculated scrollTop was larger than maxScrollTop"); + return; + // calcScrollTop = maxScrollTop; } - else { - createCSS("#" + id, "visibility:" + v); + for (; i < len; i++) { + items[i].el.dom.scrollTop = calcScrollTop; } } +}); + - /* 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}); - } - }, - - getObjectById: function(objectIdStr) { - if (ua.w3) { - return getObjectById(objectIdStr); - } - }, - - 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); } - }, - - switchOffAutoHideShow: function() { - autoHideShow = false; - }, - - ua: ua, - - getFlashPlayerVersion: function() { - return { major:ua.pv[0], minor:ua.pv[1], release:ua.pv[2] }; - }, - - hasFlashPlayerVersion: hasPlayerVersion, - - createSWF: function(attObj, parObj, replaceElemIdStr) { - if (ua.w3) { - return createSWF(attObj, parObj, replaceElemIdStr); - } - else { - return undefined; - } - }, - - showExpressInstall: function(att, par, replaceElemIdStr, callbackFn) { - if (ua.w3 && canExpressInstall()) { - showExpressInstall(att, par, replaceElemIdStr, callbackFn); - } - }, - - removeSWF: function(objElemIdStr) { - if (ua.w3) { - removeSWF(objElemIdStr); - } - }, - - createCSS: function(selStr, declStr, mediaStr, newStyleBoolean) { - if (ua.w3) { - createCSS(selStr, declStr, mediaStr, newStyleBoolean); - } - }, - - 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))); - } - } - } - 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"; } - } - if (storedCallbackFn) { storedCallbackFn(storedCallbackObj); } - } - isExpressInstallActive = false; - } - } - }; -}(); /** - * @class Ext.FlashComponent - * @extends Ext.BoxComponent - * @constructor - * @xtype flash + * @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.FlashComponent = Ext.extend(Ext.BoxComponent, { +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', /** - * @cfg {String} flashVersion - * Indicates the version the flash content was published for. Defaults to '9.0.115'. + * Boolean to indicate that a view has been injected into the panel. + * @property hasView */ - flashVersion : '9.0.115', + hasView: false, + + // each panel should dictate what viewType and selType to use + viewType: null, + selType: 'rowmodel', /** - * @cfg {String} backgroundColor - * The background color of the chart. Defaults to '#ffffff'. + * @cfg {Number} scrollDelta + * Number of pixels to scroll when scrolling with mousewheel. + * Defaults to 40. */ - backgroundColor: '#ffffff', + scrollDelta: 40, /** - * @cfg {String} wmode - * The wmode of the flash object. This can be used to control layering. Defaults to 'opaque'. + * @cfg {String/Boolean} scroll + * Valid values are 'both', 'horizontal' or 'vertical'. true implies 'both'. false implies 'none'. + * Defaults to true. */ - wmode: 'opaque', + scroll: true, /** - * @cfg {Object} flashVars - * A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined. + * @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. */ - flashVars: undefined, /** - * @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. + * @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.. */ - flashParams: undefined, /** - * @cfg {String} url - * The URL of the chart to include. Defaults to undefined. + * @cfg {Boolean} hideHeaders + * Specify as true to hide the headers. */ - url: undefined, - swfId : undefined, - swfWidth: '100%', - swfHeight: '100%', /** - * @cfg {Boolean} expressInstall - * True to prompt the user to install flash if not installed. Note that this uses - * Ext.FlashComponent.EXPRESS_INSTALL_URL, which should be set to the local resource. Defaults to false. + * @cfg {Boolean} sortableColumns + * Defaults to true. Set to false to disable column sorting via clicking the + * header and via the Sorting menu items. */ - expressInstall: false, + sortableColumns: true, - initComponent : function(){ - Ext.FlashComponent.superclass.initComponent.call(this); + verticalScrollDock: 'right', + verticalScrollerType: 'gridscroller', - this.addEvents( - /** - * @event initialize - * - * @param {Chart} this - */ - 'initialize' - ); - }, + horizontalScrollerPresentCls: Ext.baseCSSPrefix + 'horizontal-scroller-present', + verticalScrollerPresentCls: Ext.baseCSSPrefix + 'vertical-scroller-present', - onRender : function(){ - Ext.FlashComponent.superclass.onRender.apply(this, arguments); + // private property used to determine where to go down to find views + // this is here to support locking. + scrollerOwner: true, - 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); + invalidateScrollerOnRefresh: true, + + enableColumnMove: true, + enableColumnResize: true, - new swfobject.embedSWF(this.url, this.id, this.swfWidth, this.swfHeight, this.flashVersion, - this.expressInstall ? Ext.FlashComponent.EXPRESS_INSTALL_URL : undefined, vars, params); - this.swf = Ext.getDom(this.id); - this.el = Ext.get(this.swf); - }, + 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."); + } - getSwfId : function(){ - return this.swfId || (this.swfId = "extswf" + (++Ext.Component.AUTO_ID)); - }, + var me = this, + scroll = me.scroll, + vertical = false, + horizontal = false, + headerCtCfg = me.columns || me.colModel, + i = 0, + view, + border = me.border; - getId : function(){ - return this.id || (this.id = "extflashcmp" + (++Ext.Component.AUTO_ID)); - }, + // 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.invalidateScroller = Ext.Function.createBuffered(me.invalidateScroller, 30); + me.injectView = Ext.Function.createBuffered(me.injectView, 30); - onFlashEvent : function(e){ - switch(e.type){ - case "swfReady": - this.initSwf(); - return; - case "log": - return; + if (me.hideHeaders) { + border = false; } - e.component = this; - this.fireEvent(e.type.toLowerCase().replace(/event$/, ''), e); - }, - initSwf : function(){ - this.onSwfReady(!!this.isInitialized); - this.isInitialized = true; - this.fireEvent('initialize', this); - }, + // 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; - beforeDestroy: function(){ - if(this.rendered){ - swfobject.removeSWF(this.swf.id); + // 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(); + } } - Ext.FlashComponent.superclass.beforeDestroy.call(this); - }, - onSwfReady : Ext.emptyFn -}); + 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' + ); -/** - * 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'; + me.bodyCls = me.bodyCls || ''; + me.bodyCls += (' ' + me.extraBodyCls); -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. - * @constructor - * @xtype chart - */ + // autoScroll is not a valid configuration + delete me.autoScroll; - Ext.chart.Chart = Ext.extend(Ext.FlashComponent, { - refreshBuffer: 100, + // 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) { - /** - * @cfg {String} backgroundColor - * @hide - */ + // 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); + } - /** - * @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. - */ - 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 + // Extract the array of Column objects + me.columns = me.headerCt.items.items; + + 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' + }; + } } - } - }, - /** - * @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". - * - * - */ - extraStyle: null, + // 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; + } - /** - * @cfg {Object} seriesStyles - * Contains styles to apply to the series after a refresh. Defaults to null. - */ - seriesStyles: 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 + }); + } - /** - * @cfg {Boolean} disableCaching - * True to add a "cache buster" to the end of the chart url. Defaults to true for Opera and IE. - */ - disableCaching: Ext.isIE || Ext.isOpera, - disableCacheParam: '_dc', + 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 + }); + } - 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); - }, + 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; - /** - * 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. - */ - setStyle: function(name, value){ - this.swf.setStyle(name, Ext.encode(value)); - }, + // AbstractDataView will look up a Store configured as an object + // getView converts viewConfig into a View instance + view = me.getView(); - /** - * Resets all styles on the Chart instance. - * - * @param styles {Object} Initializer for all Chart styles. - */ - setStyles: function(styles){ - this.swf.setStyles(Ext.encode(styles)); + 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(); }, - /** - * Sets the styles on all series in the Chart. - * - * @param styles {Array} Initializer for all Chart series styles. - */ - setSeriesStyles: function(styles){ - this.seriesStyles = styles; - var s = []; - Ext.each(styles, function(style){ - s.push(Ext.encode(style)); + 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 + }); }); - this.swf.setSeriesStyles(s); - }, - setCategoryNames : function(names){ - this.swf.setCategoryNames(names); + if (sorter) { + state.sort = { + property: sorter.property, + direction: sorter.direction + }; + } + return state; }, - 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); - }, + 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; + } - 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); - }); - chart.swf.setDataTipFunction(chart.tipFnName); + 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); + } + } }, - setSeries : function(series){ - this.series = series; - this.refresh(); + /** + * Returns the store associated with this Panel. + * @return {Ext.data.Store} The store + */ + getStore: function(){ + return this.store; }, /** - * Changes the data store bound to this chart and refreshes it. - * @param {Store} store The store to bind to this chart + * Gets the view for this panel. + * @return {Ext.view.Table} */ - 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 + 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']); } - this.store = store; - if(store && !initial){ - this.refresh(); - } + return me.view; }, - onSwfReady : function(isReset){ - Ext.chart.Chart.superclass.onSwfReady.call(this, isReset); - var ref; - this.swf.setType(this.type); + /** + * @private + * @override + * autoScroll is never valid for all classes which extend TablePanel. + */ + setAutoScroll: Ext.emptyFn, - if(this.chartStyle){ - this.setStyles(Ext.apply({}, this.extraStyle, this.chartStyle)); - } + // 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(this.categoryNames){ - this.setCategoryNames(this.categoryNames); + if (direction === "up" || direction === "left") { + distance = -distance; } - if(this.tipRenderer){ - ref = this.getFunctionRef(this.tipRenderer); - this.setTipRenderer(ref.fn, ref.scope); + if (direction === "down" || direction === "up") { + scroller = me.getVerticalScroller(); + scroller.scrollByDeltaY(distance); + } else { + scroller = me.getHorizontalScroller(); + scroller.scrollByDeltaX(distance); } - if(this.legendRenderer){ - ref = this.getFunctionRef(this.legendRenderer); - this.setLegendRenderer(ref.fn, ref.scope); + }, + + afterLayout: function() { + this.callParent(arguments); + this.injectView(); + }, + + + /** + * @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 + }); } - if(!isReset){ - this.bindStore(this.store, true); + }, + + afterExpand: function() { + this.callParent(arguments); + if (!this.hasView) { + this.injectView(); } - this.refresh.defer(10, this); }, - delayRefresh : function(){ - if(!this.refreshTask){ - this.refreshTask = new Ext.util.DelayedTask(this.refresh, this); + /** + * @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); } - this.refreshTask.delay(this.refreshBuffer); }, - 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; + /** + * Request a recalculation of scrollbars and put them in if they are needed. + */ + 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; } - //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); - } + + clientHeight = viewElDom.clientHeight; + + me.suspendLayout = true; + me.scrollbarChanged = false; + if (!me.collapsed && scrollHeight > clientHeight) { + me.showVerticalScroller(); + } else { + me.hideVerticalScroller(); } - 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}); + if (!me.collapsed && centerScrollWidth > (centerClientWidth + Ext.getScrollBarWidth() - 2)) { + me.showHorizontalScroller(); + } else { + me.hideHorizontalScroller(); } - this.swf.setDataProvider(dataProvider); - if(this.seriesStyles){ - this.setSeriesStyles(this.seriesStyles); + me.suspendLayout = false; + if (me.scrollbarChanged) { + me.doComponentLayout(); } - this.fireEvent('refresh', this); } }, - // 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; - }, - - // private - removeFnProxy : function(fn){ - if(!Ext.isEmpty(fn)){ - fn = fn.replace('Ext.chart.Chart.proxyFunction.', ''); - delete Ext.chart.Chart.proxyFunction[fn]; + onHeaderResize: function() { + if (this.view && this.view.rendered) { + this.determineScrollbars(); + this.invalidateScroller(); } }, - // private - getFunctionRef : function(val){ - if(Ext.isFunction(val)){ - return { - fn: val, - scope: this - }; - }else{ - return { - fn: val.fn, - scope: val.scope || this - } - } - }, + /** + * Hide the verticalScroller and remove the horizontalScrollerPresentCls. + */ + hideHorizontalScroller: function() { + var me = this; - // private - onDestroy: function(){ - if (this.refreshTask && this.refreshTask.cancel){ - this.refreshTask.cancel(); + if (me.horizontalScroller && me.horizontalScroller.ownerCt === me) { + me.scrollbarChanged = true; + me.verticalScroller.offsets.bottom = 0; + me.removeDocked(me.horizontalScroller, false); + me.removeCls(me.horizontalScrollerPresentCls); + me.fireEvent('scrollerhide', me.horizontalScroller, 'horizontal'); } - 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 = {}; - -/** - * 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'; - -/** - * @class Ext.chart.PieChart - * @extends Ext.chart.Chart - * @constructor - * @xtype piechart - */ -Ext.chart.PieChart = Ext.extend(Ext.chart.Chart, { - type: 'pie', - - onSwfReady : function(isReset){ - Ext.chart.PieChart.superclass.onSwfReady.call(this, isReset); - this.setDataField(this.dataField); - this.setCategoryField(this.categoryField); }, - setDataField : function(field){ - this.dataField = field; - this.swf.setDataField(field); - }, - - setCategoryField : function(field){ - this.categoryField = field; - this.swf.setCategoryField(field); - } -}); -Ext.reg('piechart', Ext.chart.PieChart); + /** + * Show the horizontalScroller and add the horizontalScrollerPresentCls. + */ + showHorizontalScroller: function() { + var me = this; -/** - * @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 (me.verticalScroller) { + me.verticalScroller.offsets.bottom = Ext.getScrollBarWidth() - 2; } - if(this.yField){ - this.setYField(this.yField); + if (me.horizontalScroller && me.horizontalScroller.ownerCt !== me) { + me.scrollbarChanged = true; + me.addDocked(me.horizontalScroller); + me.addCls(me.horizontalScrollerPresentCls); + me.fireEvent('scrollershow', me.horizontalScroller, 'horizontal'); } - if(this.xAxis){ - this.setXAxis(this.xAxis); - } - if(this.xAxes){ - this.setXAxes(this.xAxes); + }, + + /** + * Hide the verticalScroller and remove the verticalScrollerPresentCls. + */ + 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(this.yAxis){ - this.setYAxis(this.yAxis); + if (me.verticalScroller && me.verticalScroller.ownerCt === me) { + me.scrollbarChanged = true; + me.removeDocked(me.verticalScroller, false); + me.removeCls(me.verticalScrollerPresentCls); + me.fireEvent('scrollerhide', me.verticalScroller, 'vertical'); } - if(this.yAxes){ - this.setYAxes(this.yAxes); + }, + + /** + * 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(Ext.isDefined(this.constrainViewport)){ - this.swf.setConstrainViewport(this.constrainViewport); + if (me.verticalScroller && me.verticalScroller.ownerCt !== me) { + me.scrollbarChanged = true; + me.addDocked(me.verticalScroller); + me.addCls(me.verticalScrollerPresentCls); + me.fireEvent('scrollershow', me.verticalScroller, 'vertical'); } }, - setXField : function(value){ - this.xField = value; - this.swf.setHorizontalField(value); - }, + /** + * 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; - setYField : function(value){ - this.yField = value; - this.swf.setVerticalField(value); + if (vScroll) { + vScroll.invalidate(); + } + if (hScroll) { + hScroll.invalidate(); + } }, - setXAxis : function(value){ - this.xAxis = this.createAxis('xAxis', value); - this.swf.setHorizontalAxis(this.xAxis); + // refresh the view when a header moves + onHeaderMove: function(headerCt, header, fromIdx, toIdx) { + this.view.refresh(); }, - setXAxes : function(value){ - var axis; - for(var i = 0; i < value.length; i++) { - axis = this.createAxis('xAxis' + i, value[i]); - this.swf.setHorizontalAxis(axis); - } + // Section onHeaderHide is invoked after view. + onHeaderHide: function(headerCt, header) { + this.invalidateScroller(); }, - setYAxis : function(value){ - this.yAxis = this.createAxis('yAxis', value); - this.swf.setVerticalAxis(this.yAxis); + onHeaderShow: function(headerCt, header) { + this.invalidateScroller(); }, - setYAxes : function(value){ - var axis; - for(var i = 0; i < value.length; i++) { - axis = this.createAxis('yAxis' + i, value[i]); - this.swf.setVerticalAxis(axis); - } + getVerticalScroller: function() { + return this.getScrollerOwner().down('gridscroller[dock=' + this.verticalScrollDock + ']'); }, - createAxis : function(axis, value){ - var o = Ext.apply({}, value), - ref, - old; + getHorizontalScroller: function() { + return this.getScrollerOwner().down('gridscroller[dock=bottom]'); + }, - if(this[axis]){ - old = this[axis].labelFunction; - this.removeFnProxy(old); - this.labelFn.remove(old); + onMouseWheel: function(e) { + var me = this, + browserEvent = e.browserEvent, + vertScroller = me.getVerticalScroller(), + horizScroller = me.getHorizontalScroller(), + scrollDelta = me.scrollDelta, + deltaY, deltaX, + vertScrollerEl, horizScrollerEl, + vertScrollerElDom, horizScrollerElDom, + horizontalCanScrollLeft, horizontalCanScrollRight, + verticalCanScrollDown, verticalCanScrollUp; + + // calculate whether or not both scrollbars can scroll right/left and up/down + if (horizScroller) { + horizScrollerEl = horizScroller.el; + if (horizScrollerEl) { + horizScrollerElDom = horizScrollerEl.dom; + horizontalCanScrollRight = horizScrollerElDom.scrollLeft !== horizScrollerElDom.scrollWidth - horizScrollerElDom.clientWidth; + horizontalCanScrollLeft = horizScrollerElDom.scrollLeft !== 0; + } + } + if (vertScroller) { + vertScrollerEl = vertScroller.el; + if (vertScrollerEl) { + vertScrollerElDom = vertScrollerEl.dom; + verticalCanScrollDown = vertScrollerElDom.scrollTop !== vertScrollerElDom.scrollHeight - vertScrollerElDom.clientHeight; + verticalCanScrollUp = vertScrollerElDom.scrollTop !== 0; + } + } + + // Webkit Horizontal Axis + if (browserEvent.wheelDeltaX || browserEvent.wheelDeltaY) { + deltaX = -browserEvent.wheelDeltaX / 120 * scrollDelta / 3; + deltaY = -browserEvent.wheelDeltaY / 120 * scrollDelta / 3; + } else { + // Gecko Horizontal Axis + if (browserEvent.axis && browserEvent.axis === 1) { + deltaX = -(scrollDelta * e.getWheelDelta()) / 3; + } else { + deltaY = -(scrollDelta * e.getWheelDelta() / 3); + } } - 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); + + if (horizScroller) { + if ((deltaX < 0 && horizontalCanScrollLeft) || (deltaX > 0 && horizontalCanScrollRight)) { + e.stopEvent(); + horizScroller.scrollByDeltaX(deltaX); + } } - if(axis.indexOf('xAxis') > -1 && o.position == 'left'){ - o.position = 'bottom'; + if (vertScroller) { + if ((deltaY < 0 && verticalCanScrollUp) || (deltaY > 0 && verticalCanScrollDown)) { + e.stopEvent(); + vertScroller.scrollByDeltaY(deltaY); + } } - 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); - - - -/** - * @class Ext.chart.Axis - * Defines a CartesianChart's vertical or horizontal axis. - * @constructor - */ -Ext.chart.Axis = function(config){ - Ext.apply(this, config); -}; - -Ext.chart.Axis.prototype = -{ /** - * The type of axis. - * - * @property type - * @type String + * @private + * Determine and invalidate scrollers on view refresh */ - type: null, + onViewRefresh: function() { + if (Ext.isIE) { + this.syncCellHeight(); + } + this.determineScrollbars(); + if (this.invalidateScrollerOnRefresh) { + this.invalidateScroller(); + } + }, - /** - * The direction in which the axis is drawn. May be "horizontal" or "vertical". - * - * @property orientation - * @type String - */ - orientation: "horizontal", + onViewItemUpdate: function(record, index, tr) { + if (Ext.isIE) { + this.syncCellHeight([tr]); + } + }, - /** - * If true, the items on the axis will be drawn in opposite direction. - * - * @property reverse - * @type Boolean - */ - reverse: false, + // 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'); - /** - * 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, + 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]); + } + } + + } + } + }, /** - * If true, labels that overlap previously drawn labels on the axis will be hidden. - * - * @property hideOverlappingLabels - * @type Boolean + * Sets the scrollTop of the TablePanel. + * @param {Number} deltaY */ - hideOverlappingLabels: true, + setScrollTop: function(top) { + var me = this, + rootCmp = me.getScrollerOwner(), + verticalScroller = me.getVerticalScroller(); - /** - * The space, in pixels, between labels on an axis. - * - * @property labelSpacing - * @type Number - */ - labelSpacing: 2 -}; + rootCmp.virtualScrollTop = top; + if (verticalScroller) { + verticalScroller.setScrollTop(top); + } -/** - * @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", + }, - /** - * The minimum value drawn by the axis. If not set explicitly, the axis - * minimum will be calculated automatically. - * - * @property minimum - * @type Number - */ - minimum: NaN, + getScrollerOwner: function() { + var rootCmp = this; + if (!this.scrollerOwner) { + rootCmp = this.up('[scrollerOwner]'); + } + return rootCmp; + }, /** - * The maximum value drawn by the axis. If not set explicitly, the axis - * maximum will be calculated automatically. - * - * @property maximum - * @type Number + * Scrolls the TablePanel by deltaY + * @param {Number} deltaY */ - maximum: NaN, + scrollByDeltaY: function(deltaY) { + var rootCmp = this.getScrollerOwner(), + scrollerRight; + scrollerRight = rootCmp.down('gridscroller[dock=' + this.verticalScrollDock + ']'); + if (scrollerRight) { + scrollerRight.scrollByDeltaY(deltaY); + } + }, - /** - * The spacing between major intervals on this axis. - * - * @property majorUnit - * @type Number - */ - majorUnit: NaN, /** - * The spacing between minor intervals on this axis. - * - * @property minorUnit - * @type Number + * Scrolls the TablePanel by deltaX + * @param {Number} deltaY */ - minorUnit: NaN, + scrollByDeltaX: function(deltaX) { + this.horizontalScroller.scrollByDeltaX(deltaX); + }, /** - * 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 + * Get left hand side marker for header resizing. + * @private */ - snapToUnits: true, + getLhsMarker: function() { + var me = this; - /** - * 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 (!me.lhsMarker) { + me.lhsMarker = Ext.core.DomHelper.append(me.el, { + cls: Ext.baseCSSPrefix + 'grid-resize-marker' + }, true); + } + return me.lhsMarker; + }, /** - * The scaling algorithm to use on this axis. May be "linear" or - * "logarithmic". - * - * @property scale - * @type String + * Get right hand side marker for header resizing. + * @private */ - scale: "linear", + getRhsMarker: function() { + var me = this; - /** - * Indicates whether to round the major unit. - * - * @property roundMajorUnit - * @type Boolean - */ - roundMajorUnit: true, + if (!me.rhsMarker) { + me.rhsMarker = Ext.core.DomHelper.append(me.el, { + cls: Ext.baseCSSPrefix + 'grid-resize-marker' + }, true); + } + return me.rhsMarker; + }, /** - * Indicates whether to factor in the size of the labels when calculating a - * major unit. - * - * @property calculateByLabelSize - * @type Boolean + * Returns the selection model being used and creates it via the configuration + * if it has not been created already. + * @return {Ext.selection.Model} selModel */ - calculateByLabelSize: true, + getSelectionModel: function(){ + if (!this.selModel) { + this.selModel = {}; + } - /** - * Indicates the position of the axis relative to the chart - * - * @property position - * @type String - */ - position: 'left', + var mode = 'SINGLE', + type; + if (this.simpleSelect) { + mode = 'SIMPLE'; + } else if (this.multiSelect) { + mode = 'MULTI'; + } - /** - * Indicates whether to extend maximum beyond data's maximum to the nearest - * majorUnit. - * - * @property adjustMaximumByMajorUnit - * @type Boolean - */ - adjustMaximumByMajorUnit: true, + Ext.applyIf(this.selModel, { + allowDeselect: this.allowDeselect, + mode: mode + }); - /** - * Indicates whether to extend the minimum beyond data's minimum to the - * nearest majorUnit. - * - * @property adjustMinimumByMajorUnit - * @type Boolean - */ - adjustMinimumByMajorUnit: true + 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; + } -/** - * @class Ext.chart.TimeAxis - * @extends Ext.chart.Axis - * A type of axis whose units are measured in time-based values. - * @constructor - */ -Ext.chart.TimeAxis = Ext.extend(Ext.chart.Axis, { - type: "time", + // lock the selection model if user + // has disabled selection + if (this.disableSelection) { + this.selModel.locked = true; + } + return this.selModel; + }, - /** - * The minimum value drawn by the axis. If not set explicitly, the axis - * minimum will be calculated automatically. - * - * @property minimum - * @type Date - */ - minimum: null, + onVerticalScroll: function(event, target) { + var owner = this.getScrollerOwner(), + items = owner.query('tableview'), + i = 0, + len = items.length; - /** - * The maximum value drawn by the axis. If not set explicitly, the axis - * maximum will be calculated automatically. - * - * @property maximum - * @type Number - */ - maximum: null, + for (; i < len; i++) { + items[i].el.dom.scrollTop = target.scrollTop; + } + }, - /** - * The spacing between major intervals on this axis. - * - * @property majorUnit - * @type Number - */ - majorUnit: NaN, + onHorizontalScroll: function(event, target) { + var owner = this.getScrollerOwner(), + items = owner.query('tableview'), + i = 0, + len = items.length, + center, + centerEl, + centerScrollWidth, + centerClientWidth, + width; - /** - * The time unit used by the majorUnit. - * - * @property majorTimeUnit - * @type String - */ - majorTimeUnit: null, + center = items[1] || items[0]; + centerEl = center.el.dom; + centerScrollWidth = centerEl.scrollWidth; + centerClientWidth = centerEl.offsetWidth; + width = this.horizontalScroller.getWidth(); - /** - * The spacing between minor intervals on this axis. - * - * @property majorUnit - * @type Number - */ - minorUnit: NaN, + centerEl.scrollLeft = target.scrollLeft; + this.headerCt.el.dom.scrollLeft = target.scrollLeft; + }, - /** - * The time unit used by the minorUnit. - * - * @property majorTimeUnit - * @type String - */ - minorTimeUnit: null, + // template method meant to be overriden + onStoreLoad: Ext.emptyFn, - /** - * 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, + getEditorParent: function() { + return this.body; + }, - /** - * Series that are stackable will only stack when this value is set to true. - * - * @property stackingEnabled - * @type Boolean - */ - stackingEnabled: false, + bindStore: function(store) { + var me = this; + me.store = store; + me.getView().bindStore(store); + }, - /** - * Indicates whether to factor in the size of the labels when calculating a - * major unit. - * - * @property calculateByLabelSize - * @type Boolean - */ - calculateByLabelSize: true + 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(); + } + }, + + afterComponentLayout: function() { + var me = this; + me.callParent(arguments); + me.determineScrollbars(); + me.invalidateScroller(); + } +}); /** - * @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", + * @class Ext.view.Table + * @extends Ext.view.View - /** - * A list of category names to display along this axis. - * - * @property categoryNames - * @type Array - */ - categoryNames: null, +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. - /** - * 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 +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. -/** - * @class Ext.chart.Series - * Series class for the charts widget. - * @constructor + * @markdown + * @abstract + * @xtype tableview + * @author Nicolas Ferrero */ -Ext.chart.Series = function(config) { Ext.apply(this, config); }; - -Ext.chart.Series.prototype = -{ - /** - * The type of series. - * - * @property type - * @type String - */ - type: null, +Ext.define('Ext.view.Table', { + extend: 'Ext.view.View', + alias: 'widget.tableview', + uses: [ + 'Ext.view.TableChunker', + 'Ext.util.DelayedTask', + 'Ext.util.MixedCollection' + ], - /** - * The human-readable name of the series. - * - * @property displayName - * @type String - */ - displayName: null -}; + cls: Ext.baseCSSPrefix + 'grid-view', -/** - * @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, + // row + itemSelector: '.' + Ext.baseCSSPrefix + 'grid-row', + // cell + cellSelector: '.' + Ext.baseCSSPrefix + 'grid-cell', - /** - * The field used to access the y-axis value from the items from the data - * source. - * - * @property yField - * @type String - */ - yField: null, + 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]+) ', ''), - /** - * False to not show this series in the legend. Defaults to true. - * - * @property showInLegend - * @type Boolean - */ - showInLegend: true, + // cfg docs inherited + trackOver: true, /** - * Indicates which axis the series will bind to - * - * @property axis - * @type String + * 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. */ - axis: 'primary' -}); - -/** - * @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" -}); + getRowClass: null, -/** - * @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" -}); + initComponent: function() { + var me = this; + + me.scrollState = {}; + me.selModel.view = me; + me.headerCt.view = me; + me.initFeatures(); + me.tpl = ''; + me.callParent(); + me.mon(me.store, { + load: me.onStoreLoad, + scope: me + }); -/** - * @class Ext.chart.BarSeries - * @extends Ext.chart.CartesianSeries - * BarSeries class for the charts widget. - * @constructor - */ -Ext.chart.BarSeries = Ext.extend(Ext.chart.CartesianSeries, { - type: "bar" -}); + // 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(){ + var me = this; + + if (me.invalidateScrollerOnRefresh) { + if (Ext.isGecko) { + if (!me.scrollToTopTask) { + me.scrollToTopTask = Ext.create('Ext.util.DelayedTask', me.scrollToTop, me); + } + me.scrollToTopTask.delay(1); + } else { + me .scrollToTop(); + } + } + }, -/** - * @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. - * - * @xtype menu - */ -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, + // scroll the view to the top + scrollToTop: Ext.emptyFn, + /** - * @cfg {Boolean} showSeparator True to show the icon separator. (defaults to true). + * Add a listener to the main view element. It will be destroyed with the view. + * @private */ - showSeparator : true, + addElListener: function(eventName, fn, scope){ + this.mon(this, eventName, fn, scope, { + element: 'el' + }); + }, + /** - * @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]. + * Get the columns used for generating a template via TableChunker. + * See {@link Ext.grid.header.Container#getGridColumns}. + * @private */ - defaultOffsets : [0, 0], - + getGridColumns: function() { + return this.headerCt.getGridColumns(); + }, + /** - * @cfg {Boolean} plain - * True to remove the incised line down the left side of the menu. Defaults to false. + * Get a leaf level header by index regardless of what the nesting + * structure is. + * @private + * @param {Number} index The index */ - plain : false, - + getHeaderAtIndex: function(index) { + return this.headerCt.getHeaderAtIndex(index); + }, + /** - * @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}. + * Get the cell (td) for a particular record and column. + * @param {Ext.data.Model} record + * @param {Ext.grid.column.Colunm} column + * @private */ - floating : true, - + getCell: function(record, column) { + var row = this.getNode(record); + return Ext.fly(row).down(column.getCellSelector()); + }, /** - * @cfg {Number} zIndex - * zIndex to use when the menu is floating. + * 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 */ - zIndex: 15000, - - // private - hidden : true, + getFeature: function(id) { + var features = this.featuresMC; + if (features) { + return features.get(id); + } + }, /** - * @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. + * Initializes each feature and bind it to this view. + * @private */ - layout : 'menu', - hideMode : 'offsets', // Important for laying out Components - scrollerHeight : 8, - autoLayout : true, // Provided for backwards compat - defaultType : 'menuitem', - bufferResize : false, + initFeatures: function() { + var me = this, + i = 0, + features, + len; + + me.features = me.features || []; + features = me.features; + len = features.length; - 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; + me.featuresMC = Ext.create('Ext.util.MixedCollection'); + for (; i < len; i++) { + // ensure feature hasnt already been instantiated + if (!features[i].isFeature) { + features[i] = Ext.create('feature.' + features[i].ftype, features[i]); } - 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 - }); + // inject a reference to view + features[i].view = me; + me.featuresMC.add(features[i]); } }, - //private - getLayoutTarget : function() { - return this.ul; - }, + /** + * Gives features an injection point to attach events to the markup that + * has been created for this view. + * @private + */ + attachEventsForFeatures: function() { + var features = this.features, + ln = features.length, + i = 0; - // 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 - }); - }else{ - this.el = ct.createChild(dh); + for (; i < ln; i++) { + if (features[i].isFeature) { + features[i].attachEvents(); + } } - Ext.menu.Menu.superclass.onRender.call(this, ct, position); + }, - if(!this.keyNav){ - this.keyNav = new Ext.menu.MenuNav(this); - } - // 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 + afterRender: function() { + var me = this; + + me.callParent(); + me.mon(me.el, { + scroll: me.fireBodyScroll, + scope: me }); - if(this.enableScrolling){ - this.mon(this.el, { - scope: this, - delegate: '.x-menu-scroller', - click: this.onScroll, - mouseover: this.deactivateActive - }); - } + me.el.unselectable(); + me.attachEventsForFeatures(); }, - // 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); - } + fireBodyScroll: function(e, t) { + this.fireEvent('bodyscroll', e, t); }, - // 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); - } - } - } - }, + // 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 me = this, + orig = me.headerCt.prepareData(data, idx, record, me, me.ownerCt), + features = me.features, + ln = features.length, + i = 0, + node, feature; - // private - setActiveItem : function(item, autoExpand){ - if(item != this.activeItem){ - this.deactivateActive(); - if((this.activeItem = item).isFormField){ - item.focus(); - }else{ - item.activate(autoExpand); + for (; i < ln; i++) { + feature = features[i]; + if (feature.isFeature) { + Ext.apply(orig, feature.getAdditionalData(data, idx, record, orig, me)); } - }else if(autoExpand){ - item.expandMenu(); } + + return orig; }, - deactivateActive : function(){ - var a = this.activeItem; - if(a){ - if(a.isFormField){ - //Fields cannot deactivate, but Combos must collapse - if(a.collapse){ - a.collapse(); + // 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."); } - }else{ - a.deactivate(); } - delete this.activeItem; } - }, - - // 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; + // 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; } } - return false; + return o; }, - // private - onMouseOver : function(e){ - var t = this.findTargetItem(e); - if(t){ - if(t.canActivate && !t.disabled){ - this.setActiveItem(t, true); + // 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 me = this, + el = me.el; + if (el) { + me.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(me.headerCt.getFullWidth()); + me.restoreScrollState(); + me.setNewTemplate(); + if (!suppressFocus) { + me.el.focus(); } } - this.over = true; - this.fireEvent('mouseover', this, e, t); }, - // 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; - } + /** + * 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); } - this.over = false; - this.fireEvent('mouseout', this, e, t); + this.setNewTemplate(); }, - // private - onScroll : function(e, t){ - if(e){ - e.stopEvent(); - } - 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); - } + /** + * When the header hides treat it as a resize to 0. + * @private + */ + onHeaderHide: function(headerCt, header, suppressFocus) { + this.onHeaderResize(header, 0, suppressFocus); }, - // 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']); - } + /** + * Set a new template based on the current columns displayed in the + * grid. + * @private + */ + setNewTemplate: function() { + var me = this, + columns = me.headerCt.getColumnsForTpl(true); + + me.tpl = me.getTableChunker().getTableTpl({ + columns: columns, + features: me.features + }); }, - // private - onScrollerOut : function(e, t){ - Ext.fly(t).removeClass(['x-menu-item-active', 'x-menu-scroller-active']); + /** + * Get the configured chunker or default of Ext.view.TableChunker + */ + getTableChunker: function() { + return this.chunker || Ext.view.TableChunker; }, /** - * 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) + * 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 */ - 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); + addRowCls: function(rowInfo, cls) { + var row = this.getNode(rowInfo); + if (row) { + Ext.fly(row).addCls(cls); } }, /** - * 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) + * 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 */ - 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); + removeRowCls: function(rowInfo, cls) { + var row = this.getNode(rowInfo); + if (row) { + Ext.fly(row).removeCls(cls); } }, - 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'); - } - this.ul.dom.scrollTop = 0; - return returnY; + // GridSelectionModel invokes onRowSelect as selection changes + onRowSelect : function(rowIdx) { + this.addRowCls(rowIdx, this.selectedItemCls); }, - 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) - } - }); + // GridSelectionModel invokes onRowDeselect as selection changes + onRowDeselect : function(rowIdx) { + var me = this; + + me.removeRowCls(rowIdx, me.selectedItemCls); + me.removeRowCls(rowIdx, me.focusedItemCls); + }, + + onCellSelect: function(position) { + var cell = this.getCellByPosition(position); + if (cell) { + cell.addCls(this.selectedCellCls); } }, - - onLayout : function(){ - if(this.isVisible()){ - if(this.enableScrolling){ - this.constrainScroll(this.el.getTop()); - } - if(this.floating){ - this.el.sync(); - } + + onCellDeselect: function(position) { + var cell = this.getCellByPosition(position); + if (cell) { + cell.removeCls(this.selectedCellCls); } + }, - - focus : function(){ - if(!this.hidden){ - this.doFocus.defer(50, this); + + 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 && node) { + cellSelector = header.getCellSelector(); + cell = Ext.fly(node).down(cellSelector); } + return cell; }, - doFocus : function(){ - if(!this.hidden){ - this.focusEl.focus(); + // GridSelectionModel invokes onRowFocus to 'highlight' + // the last row focused + onRowFocus: function(rowIdx, highlight, supressFocus) { + var me = this, + row = me.getNode(rowIdx); + + if (highlight) { + me.addRowCls(rowIdx, me.focusedItemCls); + if (!supressFocus) { + me.focusRow(rowIdx); + } + //this.el.dom.setAttribute('aria-activedescendant', row.id); + } else { + me.removeRowCls(rowIdx, me.focusedItemCls); } }, /** - * Hides this menu and optionally all parent menus - * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to 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. */ - hide : function(deep){ - if (!this.isDestroyed) { - this.deepHide = deep; - Ext.menu.Menu.superclass.hide.call(this); - delete this.deepHide; - } - }, + focusRow: function(rowIdx) { + var me = this, + row = me.getNode(rowIdx), + el = me.el, + adjustment = 0, + panel = me.ownerCt, + rowRegion, + elRegion, + record; + + if (row && 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 = me.getRecord(row); + rowIdx = me.store.indexOf(record); + + if (adjustment) { + // scroll the grid itself, so that all gridview's update. + panel.scrollByDeltaY(adjustment); + } + me.fireEvent('rowfocus', record, row, rowIdx); + } + }, + + focusCell: function(position) { + var me = this, + cell = me.getCellByPosition(position), + el = me.el, + adjustmentY = 0, + adjustmentX = 0, + elRegion = el.getRegion(), + panel = me.ownerCt, + cellRegion, + record; - // 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 (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; } - } - }, - // 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 - }); + // 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; } - } - return c; - }, - 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); - } + if (adjustmentY) { + // scroll the grid itself, so that all gridview's update. + panel.scrollByDeltaY(adjustmentY); } - } - return c; - }, - - // private - getMenuItem : function(config){ - if(!config.isXType){ - if(!config.xtype && Ext.isBoolean(config.checked)){ - return new Ext.menu.CheckItem(config) + if (adjustmentX) { + panel.scrollByDeltaX(adjustmentX); } - return Ext.create(config, this.defaultType); + el.focus(); + me.fireEvent('cellfocus', record, cell, position); } - return config; }, /** - * Adds a separator bar to the menu - * @return {Ext.menu.Item} The menu item that was added + * 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 */ - addSeparator : function(){ - return this.add(new Ext.menu.Separator()); + scrollByDelta: function(delta, dir) { + dir = dir || 'scrollTop'; + var elDom = this.el.dom; + elDom[dir] = (elDom[dir] += delta); }, - /** - * 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 - */ - addElement : function(el){ - return this.add(new Ext.menu.BaseItem({ - el: el - })); + onUpdate: function(ds, index) { + this.callParent(arguments); }, /** - * 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 + * Save the scrollState in a private variable. + * Must be used in conjunction with restoreScrollState */ - addItem : function(item){ - return this.add(item); + saveScrollState: function() { + var dom = this.el.dom, + state = this.scrollState; + + state.left = dom.scrollLeft; + state.top = dom.scrollTop; }, /** - * 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 + * Restore the scrollState. + * Must be used in conjunction with saveScrollState + * @private */ - addMenuItem : function(config){ - return this.add(this.getMenuItem(config)); + 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; }, /** - * 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 + * 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. */ - addText : function(text){ - return this.add(new Ext.menu.TextItem(text)); + refresh: function(firstPass) { + var me = this, + table; + + //this.saveScrollState(); + me.setNewTemplate(); + + me.callParent(arguments); + + //this.restoreScrollState(); + + if (me.rendered && !firstPass) { + // give focus back to gridview + //me.el.focus(); + } }, - //private - onDestroy : function(){ - Ext.EventManager.removeResizeListener(this.hide, this); - var pm = this.parentMenu; - if(pm && pm.activeChild == this){ - delete pm.activeChild; + processItemEvent: function(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(), + type = e.type, + 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; + } } - delete this.parentMenu; - Ext.menu.Menu.superclass.onDestroy.call(this); - Ext.menu.MenuMgr.unregister(this); - if(this.keyNav) { - this.keyNav.disable(); + + result = me.fireEvent('uievent', type, me, cell, rowIndex, cellIndex, e); + + if (result === false || me.callParent(arguments) === false) { + return false; } - var s = this.scroller; - if(s){ - Ext.destroy(s.topRepeater, s.bottomRepeater, s.top, s.bottom); + + // Don't handle cellmouseenter and cellmouseleave events for now + if (type == 'mouseover' || type == 'mouseout') { + return true; } - Ext.destroy( - this.el, - this.focusEl, - this.ul + + 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) ); - } -}); + }, -Ext.reg('menu', Ext.menu.Menu); + processSpecialEvent: function(e) { + var me = this, + map = me.statics().EventMap, + features = me.features, + ln = features.length, + type = e.type, + i, feature, prefix, featureTarget, + beforeArgs, args, + panel = me.ownerCt; -// 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); + me.callParent(arguments); + + if (type == 'mouseover' || type == 'mouseout') { + return; } - } - return { - constructor : function(menu){ - Ext.menu.MenuNav.superclass.constructor.call(this, menu.el); - this.scope = this.menu = menu; - }, - 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; + for (i = 0; i < ln; i++) { + feature = features[i]; + if (feature.hasFeatureEvent) { + featureTarget = e.getTarget(feature.eventSelector, me.getTargetEl()); + if (featureTarget) { + prefix = feature.eventPrefix; + // allows features to implement getFireEventArgs to change the + // fireEvent signature + beforeArgs = feature.getFireEventArgs('before' + prefix + type, me, featureTarget, e); + args = feature.getFireEventArgs(prefix + type, me, featureTarget, e); + + if ( + // before view event + (me.fireEvent.apply(me, beforeArgs) === false) || + // panel grid event + (panel.fireEvent.apply(panel, beforeArgs) === false) || + // view event + (me.fireEvent.apply(me, args) === false) || + // panel event + (panel.fireEvent.apply(panel, args) === false) + ) { + return false; + } + } } - return h.call(this.scope || this, e, this.menu); - }, + } + return true; + }, - tab: function(e, m) { - e.stopEvent(); - if (e.shiftKey) { - up(e, m); - } else { - down(e, m); - } - }, + 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, - up : up, + /** + * Expand a particular header to fit the max content width. + * This will ONLY expand, not contract. + * @private + */ + expandToFit: function(header) { + var maxWidth = this.getMaxContentWidth(header); + delete header.flex; + header.setWidth(maxWidth); + }, - down : down, + /** + * Get the max contentWidth of the header's text and all cells + * in the grid under this header. + * @private + */ + getMaxContentWidth: function(header) { + var cellSelector = header.getCellInnerSelector(), + cells = this.el.query(cellSelector), + i = 0, + ln = cells.length, + maxWidth = header.el.dom.scrollWidth, + scrollWidth; - right : function(e, m){ - if(m.activeItem){ - m.activeItem.expandMenu(true); + for (; i < ln; i++) { + scrollWidth = cells[i].scrollWidth; + if (scrollWidth > maxWidth) { + maxWidth = scrollWidth; } - }, + } + return maxWidth; + }, - left : function(e, m){ - m.hide(); - if(m.parentMenu && m.parentMenu.activeItem){ - m.parentMenu.activeItem.activate(); - } - }, + getPositionByEvent: function(e) { + var me = this, + cellNode = e.getTarget(me.cellSelector), + rowNode = e.getTarget(me.itemSelector), + record = me.getRecord(rowNode), + header = me.getHeaderByCell(cellNode); - enter : function(e, m){ - if(m.activeItem){ - e.stopPropagation(); - m.activeItem.onClick(e); - m.fireEvent('click', this, m.activeItem); - return true; + return me.getPosition(record, header); + }, + + getHeaderByCell: function(cell) { + if (cell) { + var m = cell.className.match(this.cellRe); + if (m && m[1]) { + return Ext.getCmp(m[1]); } } - }; -}()); -/** - * @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(); - } - }); - } + return false; + }, - // private - function hideAll(){ - if(active && active.length > 0){ - var c = active.clone(); - c.each(function(m){ - m.hide(); - }); - return true; - } - return false; - } + /** + * @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 + */ + walkCells: function(pos, direction, e, preventWrap, verifierFn, scope) { + var me = this, + row = pos.row, + column = pos.column, + rowCount = me.store.getCount(), + firstCol = me.getFirstVisibleColumnIndex(), + lastCol = me.getLastVisibleColumnIndex(), + newPos = {row: row, column: column}, + activeHeader = me.headerCt.getHeaderAtIndex(column); + + // no active header or its currently hidden + if (!activeHeader || activeHeader.hidden) { + return false; + } - // private - function onHide(m){ - active.remove(m); - if(active.length < 1){ - Ext.getDoc().un("mousedown", onMouseDown); - attached = false; - } - } + e = e || {}; + direction = direction.toLowerCase(); + switch (direction) { + case 'right': + // has the potential to wrap if its last + if (column === lastCol) { + // if bottom row and last column, deny right + if (preventWrap || row === rowCount - 1) { + return false; + } + if (!e.ctrlKey) { + // otherwise wrap to nextRow and firstCol + newPos.row = row + 1; + newPos.column = firstCol; + } + // go right + } else { + if (!e.ctrlKey) { + newPos.column = column + me.getRightGap(activeHeader); + } else { + newPos.column = lastCol; + } + } + break; - // 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); - } - } + 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 + me.getLeftGap(activeHeader); + } else { + newPos.column = firstCol; + } + } + break; - // private - function onBeforeHide(m){ - if(m.activeChild){ - m.activeChild.hide(); - } - if(m.autoHideTimer){ - clearTimeout(m.autoHideTimer); - delete m.autoHideTimer; - } - } + 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; - // private - function onBeforeShow(m){ - var pm = m.parentMenu; - if(!pm && !m.allowOtherMenus){ - hideAll(); - }else if(pm && pm.activeChild){ - pm.activeChild.hide(); - } - } + 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; + } - // private - function onMouseDown(e){ - if(lastShow.getElapsed() > 50 && active.length > 0 && !e.getTarget(".x-menu")){ - hideAll(); - } - } + if (verifierFn && verifierFn.call(scope || window, newPos) !== true) { + return false; + } else { + return newPos; + } + }, + getFirstVisibleColumnIndex: function() { + var headerCt = this.getHeaderCt(), + allColumns = headerCt.getGridColumns(), + visHeaders = Ext.ComponentQuery.query(':not([hidden])', allColumns), + firstHeader = visHeaders[0]; - // 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); - } - } - } - } + return headerCt.getHeaderIndex(firstHeader); + }, - return { + getLastVisibleColumnIndex: function() { + var headerCt = this.getHeaderCt(), + allColumns = headerCt.getGridColumns(), + visHeaders = Ext.ComponentQuery.query(':not([hidden])', allColumns), + lastHeader = visHeaders[visHeaders.length - 1]; - /** - * Hides all menus that are currently visible - * @return {Boolean} success True if any active menus were hidden. - */ - hideAll : function(){ - return hideAll(); - }, + return headerCt.getHeaderIndex(lastHeader); + }, - // private - register : function(menu){ - if(!menus){ - init(); - } - menus[menu.id] = menu; - menu.on({ - beforehide: onBeforeHide, - hide: onHide, - beforeshow: onBeforeShow, - show: onShow - }); - }, + getHeaderCt: function() { + return this.headerCt; + }, - /** - * 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'); - } - }, + getPosition: function(record, header) { + var me = this, + store = me.store, + gridCols = me.headerCt.getGridColumns(); - // private - unregister : function(menu){ - delete menus[menu.id]; - menu.un("beforehide", onBeforeHide); - menu.un("hide", onHide); - menu.un("beforeshow", onBeforeShow); - menu.un("show", onShow); - }, + return { + row: store.indexOf(record), + column: Ext.Array.indexOf(gridCols, header) + }; + }, - // private - registerCheckable : function(menuItem){ - var g = menuItem.group; - if(g){ - if(!groups[g]){ - groups[g] = []; - } - groups[g].push(menuItem); - menuItem.on("beforecheckchange", onBeforeCheck); - } - }, + /** + * 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; - // private - unregisterCheckable : function(menuItem){ - var g = menuItem.group; - if(g){ - groups[g].remove(menuItem); - menuItem.un("beforecheckchange", onBeforeCheck); - } - }, + for (; i <= headers.length; i++) { + if (!headers[i].hidden) { + nextIdx = i; + break; + } + } - 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; - }, + return nextIdx - activeHeaderIdx; + }, + + beforeDestroy: function() { + if (this.rendered) { + this.el.removeAllListeners(); + } + this.callParent(arguments); + }, - 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. + * 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 + +The grid View class provides extra {@link Ext.grid.Panel} specific functionality to the +{@link Ext.view.Table}. In general, this class is not instanced directly, instead a viewConfig +option is passed to the grid: + + Ext.create('Ext.grid.Panel', { + // other options + viewConfig: { + stripeRows: false + } + }); + +__Drag Drop__ +Drag and drop functionality can be achieved in the grid by attaching a {@link Ext.grid.plugin.DragDrop} plugin +when creating the view. + + Ext.create('Ext.grid.Panel', { + // other options + viewConfig: { + plugins: { + ddGroup: 'people-group', + ptype: 'gridviewdragdrop', + enableDrop: false + } + } + }); + + * @markdown + */ +Ext.define('Ext.grid.View', { + extend: 'Ext.view.Table', + alias: 'widget.gridview', + /** - * @cfg {Boolean} canActivate True if this item can be visually activated (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. */ - canActivate : false, + stripeRows: true, + + invalidateScrollerOnRefresh: true, + /** - * @cfg {String} activeClass The CSS class to use when the item becomes activated (defaults to "x-menu-item-active") + * Scroll the GridView to the top by scrolling the scroller. + * @private */ - activeClass : "x-menu-item-active", + 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); + }, + + onUpdate: function(ds, record, operation) { + var index = ds.indexOf(record); + this.callParent(arguments); + this.doStripeRows(index, index); + }, + /** - * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to true) + * Stripe rows from a particular row index + * @param {Number} startRow + * @param {Number} endRow Optional argument specifying the last row to process. By default process up to the last row. + * @private */ - hideOnClick : true, + doStripeRows: function(startRow, endRow) { + // ensure stripeRows configuration is turned on + if (this.stripeRows) { + var rows = this.getNodes(startRow, endRow), + 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, ' '); + startRow++; + // Every odd row will get an additional cls + if (startRow % 2 === 0) { + 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(); + } + } +}); + +/** + * @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 {Number} clickHideDelay Length of time in milliseconds to wait before hiding after a click (defaults to 1) + * @cfg {Boolean} columnLines Adds column line styling */ - clickHideDelay : 1, + + initComponent: function() { + var me = this; + + 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) - // private - ctype : "Ext.menu.BaseItem", +/** + * @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' + ], - // private - actionMode : "container", + saveBtnText : 'Update', + cancelBtnText: 'Cancel', + errorsText: 'Errors', + dirtyText: 'You need to commit or cancel your changes', - 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); - } - }, + lastScrollLeft: 0, + lastScrollTop: 0, - // 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 - }); + border: false, + + // Change the hideMode to offsets so that we get accurate measurements when + // the roweditor is hidden for laying out things like a TriggerField. + hideMode: 'offsets', + + initComponent: function() { + var me = this, + 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; } + + form = me.getForm(); + form.trackResetOnLoad = true; }, - /** - * 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); + onFieldChange: function() { + var me = this, + form = me.getForm(), + valid = form.isValid(); + if (me.errorSummary && me.isVisible()) { + me[valid ? 'hideToolTip' : 'showToolTip'](); + } + if (me.floatingButtons) { + me.floatingButtons.child('#update').setDisabled(!valid); } - this.on("click", this.handler = handler, this.scope = scope); + me.isValid = valid; }, - // 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(); - } + 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 + }); }, - // private - activate : function(){ - if(this.disabled){ - return false; + onBeforeViewRefresh: function(view) { + var me = this, + viewDom = view.el.dom; + + if (me.el.dom.parentNode === viewDom) { + viewDom.removeChild(me.el.dom); } - 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); - }, + onViewRefresh: function(view) { + var me = this, + viewDom = view.el.dom, + context = me.context, + idx; - // private - shouldDeactivate : function(e){ - return !this.region || !this.region.contains(e.getPoint()); - }, + viewDom.appendChild(me.el.dom); - // private - handleClick : function(e){ - var pm = this.parentMenu; - if(this.hideOnClick){ - if(pm.floating){ - pm.hide.defer(this.clickHideDelay, pm, [true]); - }else{ - pm.deactivateActive(); + // 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(); } }, - // private. Do nothing - expandMenu : Ext.emptyFn, + onCtScroll: function(e, target) { + var me = this, + scrollTop = target.scrollTop, + scrollLeft = target.scrollLeft; - // 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) - */ - hideOnClick : false, - /** - * @cfg {String} itemCls The default CSS class to use for text items (defaults to "x-menu-text") - */ - itemCls : "x-menu-text", - - constructor : function(config){ - if(typeof config == 'string'){ - config = {text: config} + 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(); } - Ext.menu.TextItem.superclass.constructor.call(this, config); }, - // 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) - */ - hideOnClick : false, - - /** - * @cfg {String} activeClass - * @hide - */ - activeClass: '', + onColumnAdd: function(column) { + this.setField(column); + }, - // 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', - /** - * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to true) - */ - canActivate : true, - /** - * @cfg {Number} showDelay Length of time in milliseconds to wait before showing this item (defaults to 200) - */ - showDelay: 200, - // doc'd in BaseItem - hideDelay: 200, + onColumnRemove: function(column) { + this.columns.remove(column); + }, - // private - ctype: 'Ext.menu.Item', + onColumnResize: function(column, width) { + column.getEditor().setWidth(width - 2); + if (this.isVisible()) { + this.reposition(); + } + }, - initComponent : function(){ - Ext.menu.Item.superclass.initComponent.call(this); - if(this.menu){ - this.menu = Ext.menu.MenuMgr.get(this.menu); - this.menu.ownerCt = this; + onColumnHide: function(column) { + column.getEditor().hide(); + if (this.isVisible()) { + this.reposition(); } }, - // private - onRender : function(container, position){ - if (!this.itemTpl) { - this.itemTpl = Ext.menu.Item.prototype.itemTpl = new Ext.XTemplate( - '', - ' target="{hrefTarget}"', - '', - '>', - '', - '{text}', - '' - ); + onColumnShow: function(column) { + var field = column.getEditor(); + field.setWidth(column.getWidth() - 2).show(); + if (this.isVisible()) { + this.reposition(); } - 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 }); + }, + + onColumnMove: function(column, fromIdx, toIdx) { + var field = column.getEditor(); + if (this.items.indexOf(field) != toIdx) { + this.move(fromIdx, toIdx); } - 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||' ' - }; + onFieldAdd: function(map, fieldId, column) { + var me = this, + colIdx = me.editingPlugin.grid.headerCt.getHeaderIndex(column), + field = column.getEditor({ xtype: 'displayfield' }); + + me.insert(colIdx, field); }, - /** - * Sets the text to display in this menu item - * @param {String} text The text to display - */ - setText : function(text){ - this.text = text||' '; - if(this.rendered){ - this.textEl.update(this.text); - this.parentMenu.layout.doAutoSize(); + onFieldRemove: function(map, fieldId, column) { + var me = this, + field = column.getEditor(), + fieldEl = field.el; + me.remove(field, false); + if (fieldEl) { + fieldEl.remove(); } }, - /** - * Sets the CSS class to apply to the item's icon element - * @param {String} cls The CSS class to apply - */ - setIconClass : function(cls){ - var oldCls = this.iconCls; - this.iconCls = cls; - if(this.rendered){ - this.iconEl.replaceClass(oldCls, this.iconCls); - } + onFieldReplace: function(map, fieldId, column, oldColumn) { + var me = this; + me.onFieldRemove(map, fieldId, oldColumn); }, - //private - beforeDestroy: function(){ - if (this.menu){ - delete this.menu.ownerCt; - this.menu.destroy(); - } - Ext.menu.Item.superclass.beforeDestroy.call(this); + clearFields: function() { + var me = this, + map = me.columns; + map.each(function(fieldId) { + map.removeAtKey(fieldId); + }); }, - // private - handleClick : function(e){ - if(!this.href){ // if no link defined, stop the event automatically - e.stopEvent(); + 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 + }); } - Ext.menu.Item.superclass.handleClick.apply(this, arguments); + return me.floatingButtons; }, - // private - activate : function(autoExpand){ - if(Ext.menu.Item.superclass.activate.apply(this, arguments)){ - this.focus(); - if(autoExpand){ - this.expandMenu(); + 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(); } } - return true; + if (me.getWidth() != mainBodyWidth) { + me.setWidth(mainBodyWidth); + } + btnEl.setLeft(left); }, - // 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; + getEditor: function(fieldInfo) { + var me = this; + + if (Ext.isNumber(fieldInfo)) { + // Query only form fields. This just future-proofs us in case we add + // other components to RowEditor later on. Don't want to mess with + // indices. + return me.query('>[isFormField]')[fieldInfo]; + } else if (fieldInfo instanceof Ext.grid.column.Column) { + return fieldInfo.getEditor(); } - return false; }, - // private - deactivate : function(){ - Ext.menu.Item.superclass.deactivate.apply(this, arguments); - this.hideMenu(); + 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); }, - // 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); + setField: function(column) { + var me = this, + field; + + if (Ext.isArray(column)) { + Ext.Array.forEach(column, me.setField, me); + return; + } + + // Get a default display field if necessary + field = column.getEditor(null, { + xtype: 'displayfield', + // Default display fields will not return values. This is done because + // the display field will pick up column renderers from the grid. + getModelData: function() { + return null; } + }); + field.margins = '0 0 0 2'; + field.setWidth(column.getDesiredWidth() - 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); + + if (me.isVisible() && me.context) { + me.renderColumnData(field, me.context.record); } }, - // 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); + loadRecord: function(record) { + var me = this, + form = me.getForm(); + form.loadRecord(record); + if (form.isValid()) { + me.hideToolTip(); + } else { + me.showToolTip(); } + + // render display fields so they honor the column renderer/template + Ext.Array.forEach(me.query('>displayfield'), function(field) { + me.renderColumnData(field, record); + }, me); }, - // 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); + 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 = record.get(column.dataIndex); + + // 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(); }, - // private - deferHide : function(){ - delete this.hideTimer; - if(this.menu.over){ - this.parentMenu.setActiveItem(this, false); - }else{ - this.menu.hide(); + beforeEdit: function() { + var me = this; + + if (me.isVisible() && !me.autoCancel && me.isDirty()) { + me.showToolTip(); + return false; } - } -}); -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. + * 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. */ - checked: false, + 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 + }); - // 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); - }, + // make sure our row is selected before editing + context.grid.getSelectionModel().select(record); - // private - onRender : function(c){ - Ext.menu.CheckItem.superclass.onRender.apply(this, arguments); - if(this.group){ - this.el.addClass(this.groupClass); + // Reload the record data + me.loadRecord(record); + + if (!me.isVisible()) { + me.show(); + me.focusContextCell(); + } else { + me.reposition({ + callback: this.focusContextCell + }); } - if(this.checked){ - this.checked = false; - this.setChecked(true, true); + }, + + // 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(); } }, - // private - destroy : function(){ - Ext.menu.MenuMgr.unregisterCheckable(this); - Ext.menu.CheckItem.superclass.destroy.apply(this, arguments); + cancelEdit: function() { + var me = this, + form = me.getForm(); + + me.hide(); + form.clearInvalid(); + form.reset(); }, - /** - * 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) - */ - 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); - } + completeEdit: function() { + var me = this, + form = me.getForm(); + + if (!form.isValid()) { + return; } + + form.updateRecord(me.context.record); + me.hide(); + return true; }, - // 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 - */ - /** - * The {@link Ext.DatePicker} instance for this DateMenu - * @property picker - * @type DatePicker - */ - cls : 'x-date-menu', - - /** - * @event click - * @hide - */ - - /** - * @event itemclick - * @hide - */ + onShow: function() { + var me = this; + me.callParent(arguments); + me.reposition(); + }, - 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}); - } - 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)) - }); - 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); + onHide: function() { + var me = this; + me.callParent(arguments); + me.hideToolTip(); + me.invalidateScroller(); + if (me.context) { + me.context.view.focus(); + me.context = null; } }, - menuHide : function() { - if(this.hideOnClick){ - this.hide(true); + 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; }, - onBeforeShow : function(){ - if(this.picker){ - this.picker.hideMonthPicker(true); + hideToolTip: function() { + var me = this, + tip = me.getToolTip(); + if (tip.rendered) { + tip.disable(); } + me.hiddenTip = false; }, - onShow : function(){ - var el = this.picker.getEl(); - el.setWidth(el.getWidth()); //nasty hack for IE7 strict mode - } - }); - 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 - */ - 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). - * - */ - /** - * @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. - */ - paletteId : null, - - /** - * @cfg {Number} maxHeight - * @hide - */ - /** - * @cfg {Number} scrollIncrement - * @hide - */ - /** - * @property palette - * @type ColorPalette - * The {@link Ext.ColorPalette} instance for this ColorMenu - */ - - - /** - * @event click - * @hide - */ - - /** - * @event itemclick - * @hide - */ - - 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); + 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; } }, - menuHide : function(){ - if(this.hideOnClick){ - this.hide(true); + 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(); } } }); -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 + * @class Ext.grid.header.Container + * @extends Ext.container.Container + * @private + * + * 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. + * + * @xtype headercontainer */ -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 ''). - */ +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 {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}. + * @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. */ - readOnly : false, + weight: 100, + defaultType: 'gridcolumn', /** - * @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}. + * @cfg {Number} defaultWidth + * Width of the header if no width or flex is specified. Defaults to 100. */ - disabled : 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 {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post. - * Defaults to true. + * true if this HeaderContainer is in fact a group header which contains sub headers. + * @type Boolean + * @property isGroupHeader */ - submitValue: true, - // private - isFormField : true, + /** + * @cfg {Boolean} sortable + * Provides the default sortable state for all Headers within this HeaderContainer. + * Also turns on or off the menus in the HeaderContainer. Note that the menu is + * shared across every header and therefore turning it off will remove the menu + * items for every header. + */ + sortable: true, + + 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); + } - // private - msgDisplay: '', + // 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', - // private - hasFocus : false, + /** + * @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', - // 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 + * @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 */ - 'focus', + 'headertriggerclick', + /** - * @event blur - * Fires when this field loses input focus. - * @param {Ext.form.Field} this + * @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 */ - 'blur', + 'columnmove', /** - * @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(); - } - } - } - } - ], - ... -}); - * - * @param {Ext.form.Field} this - * @param {Ext.EventObject} e The event object + * @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 */ - 'specialkey', + 'columnhide', /** - * @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 + * @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 */ - 'change', + 'columnshow', /** - * @event invalid - * Fires after the field has been marked as invalid. - * @param {Ext.form.Field} this - * @param {String} msg The validation message + * @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 */ - 'invalid', + 'sortchange', /** - * @event valid - * Fires after the field has been validated with no errors. - * @param {Ext.form.Field} this + * @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 */ - 'valid' + 'menucreate' ); }, - /** - * 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} - */ - getName : function(){ - return this.rendered && this.el.dom.name ? this.el.dom.name : this.name || this.id || ''; + onDestroy: function() { + Ext.destroy(this.resizer, this.reorderer); + this.callParent(); }, - // private - onRender : function(ct, position){ - if(!this.el){ - var cfg = this.getAutoCreate(); + // 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(); + }, - if(!cfg.name){ - cfg.name = this.name || this.id; - } - if(this.inputType){ - cfg.type = this.inputType; + // 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(); + }, + + 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.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'; + }, + + afterLayout: function() { + if (!this.isHeader) { + var me = this, + topHeaders = me.query('>gridcolumn:not([hidden])'), + viewEl, + firstHeaderEl, + lastHeaderEl; + + me.callParent(arguments); + + if (topHeaders.length) { + firstHeaderEl = topHeaders[0].el; + if (firstHeaderEl !== me.pastFirstHeaderEl) { + if (me.pastFirstHeaderEl) { + me.pastFirstHeaderEl.removeCls(me.firstHeaderCls); + } + firstHeaderEl.addCls(me.firstHeaderCls); + me.pastFirstHeaderEl = firstHeaderEl; + } + + lastHeaderEl = topHeaders[topHeaders.length - 1].el; + if (lastHeaderEl !== me.pastLastHeaderEl) { + if (me.pastLastHeaderEl) { + me.pastLastHeaderEl.removeCls(me.lastHeaderCls); + } + lastHeaderEl.addCls(me.lastHeaderCls); + me.pastLastHeaderEl = lastHeaderEl + } } - this.el.addClass('x-form-'+type); } - if(this.readOnly){ - this.setReadOnly(true); + + }, + + 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 { + me.disabledMenuItems = []; + } + } } - if(this.tabIndex !== undefined){ - this.el.dom.setAttribute('tabIndex', this.tabIndex); + + // 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); - this.el.addClass([this.fieldClass, this.cls]); + // The header's own hide suppresses cascading layouts, so lay the headers out now + me.doLayout(); }, - // private - getItemCt : function(){ - return this.itemCt; - }, + onHeaderHide: function(header, suppressLayout) { + // Pass up to the GridSection + var me = this, + gridSection = me.ownerCt, + menu = me.getMenu(), + colCheckItem; - // 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); + 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(); } - /** - * 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(); + + // 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); }, - /** - * 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. - */ - isDirty : function() { - if(this.disabled || !this.rendered) { - return false; + 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); + } + } } - return String(this.getValue()) !== String(this.originalValue); }, /** - * Sets the read only state of this field. - * @param {Boolean} readOnly Whether the field should be read only. + * 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(this.rendered){ - this.el.dom.readOnly = readOnly; + tempLock: function() { + this.ddLock = true; + Ext.Function.defer(function() { + this.ddLock = false; + }, 200, this); + }, + + onHeaderResize: function(header, w, suppressFocus) { + this.tempLock(); + if (this.view && this.view.rendered) { + this.view.onHeaderResize(header, w, suppressFocus); } - this.readOnly = readOnly; + this.fireEvent('columnresize', this, header, w); }, - // private - afterRender : function(){ - Ext.form.Field.superclass.afterRender.call(this); - this.initEvents(); - this.initValue(); + onHeaderClick: function(header, e, t) { + this.fireEvent("headerclick", this, header, e, t); }, - // private - fireKey : function(e){ - if(e.isSpecialKey()){ - this.fireEvent('specialkey', this, e); + 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); } }, - /** - * 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} - */ - reset : function(){ - this.setValue(this.originalValue); - this.clearInvalid(); - }, + showMenuBy: function(t, header) { + var menu = this.getMenu(), + ascItem = menu.down('#ascItem'), + descItem = menu.down('#descItem'), + sortableMth; - // private - initEvents : function(){ - this.mon(this.el, Ext.EventManager.useKeydown ? 'keydown' : 'keypress', this.fireKey, this); - this.mon(this.el, 'focus', this.onFocus, this); + menu.activeHeader = menu.ownerCt = header; + menu.setFloatParent(header); + // TODO: remove coupling to Header's titleContainer el + header.titleContainer.addCls(this.headerOpenCls); - // 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); + // 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 - preFocus: Ext.emptyFn, + // 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 - 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); - } + moveHeader: function(fromIdx, toIdx) { + + // An automatically expiring lock + this.tempLock(); + this.onHeaderMoved(this.move(fromIdx, toIdx), fromIdx, toIdx); }, - // private - beforeBlur : Ext.emptyFn, + purgeCache: function() { + var me = this; + // Delete column cache - column order has changed. + delete me.gridDataColumns; - // private - onBlur : function(){ - this.beforeBlur(); - if(this.focusClass){ - this.el.removeClass(this.focusClass); + // Menu changes when columns are moved. It will be recreated. + if (me.menu) { + me.menu.destroy(); + delete me.menu; } - this.hasFocus = false; - if(this.validationEvent !== false && (this.validateOnBlur || this.validationEvent == 'blur')){ - this.validate(); - } - var v = this.getValue(); - if(String(v) !== String(this.startValue)){ - this.fireEvent('change', this, v, this.startValue); - } - this.fireEvent('blur', this); - this.postBlur(); }, - // private - postBlur : Ext.emptyFn, + onHeaderMoved: function(header, fromIdx, toIdx) { + var me = this, + gridSection = me.ownerCt; - /** - * 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 (gridSection) { + gridSection.onHeaderMove(me, header, fromIdx, toIdx); } - var restore = this.preventMark; - this.preventMark = preventMark === true; - var v = this.validateValue(this.processValue(this.getRawValue())); - this.preventMark = restore; - return v; + me.fireEvent("columnmove", me, header, fromIdx, toIdx); }, /** - * Validates the field value - * @return {Boolean} True if the value is valid, else false + * Gets the menu (and will create it if it doesn't already exist) + * @private */ - validate : function(){ - if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){ - this.clearInvalid(); - return true; + getMenu: function() { + var me = this; + + 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 false; + return me.menu; }, /** - * 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 + * Returns an array of menu items to be placed into the shared menu + * across all headers in this header container. + * @returns {Array} menuItems */ - processValue : function(value){ - return value; + 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; }, - /** - * 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]; + // sort asc when clicking on item in menu + onSortAscClick: function() { + var menu = this.getMenu(), + activeHeader = menu.activeHeader; - 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 - */ - getErrors: function() { - return []; + activeHeader.setSortState('ASC'); }, - /** - * 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. - */ - getActiveError : function(){ - return this.activeError || ''; + // sort desc when clicking on item in menu + onSortDescClick: function() { + var menu = this.getMenu(), + activeHeader = menu.activeHeader; + + activeHeader.setSortState('DESC'); }, /** - * 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}) + * Returns an array of menu CheckItems corresponding to all immediate children of the passed Container which have been configured as hideable. */ - 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; + getColumnMenu: function(headerContainer) { + var menuItems = [], + i = 0, + item, + items = headerContainer.query('>gridcolumn[hideable]'), + itemsLn = items.length, + menuItem; - 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; - } + 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) + }); } - - this.setActiveError(msg); + return menuItems; }, - + + onColumnCheckChange: function(checkItem, checked) { + var header = Ext.getCmp(checkItem.headerId); + header[checked ? 'show' : 'hide'](); + }, + /** - * Clear any invalid styles/messages for this field + * 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 */ - 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'; - } - } + 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() + }); } - - this.unsetActiveError(); + return cols; }, /** - * 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 + * Returns the number of grid columns descended from this HeaderContainer. + * Group Columns are HeaderContainers. All grid columns are returned, including hidden ones. */ - setActiveError: function(msg, suppressEvent) { - this.activeError = msg; - if (suppressEvent !== true) this.fireEvent('invalid', this, msg); + getColumnCount: function() { + return this.getGridColumns().length; }, - + /** - * 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 + * Gets the full width of all columns that are visible. */ - unsetActiveError: function(suppressEvent) { - delete this.activeError; - if (suppressEvent !== true) this.fireEvent('valid', this); - }, + getFullWidth: function(flushCache) { + var fullWidth = 0, + headers = this.getVisibleGridColumns(flushCache), + headersLn = headers.length, + i = 0; - // private - getMessageHandler : function(){ - return Ext.form.MessageTargets[this.msgTarget]; - }, - - // 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 + 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(); + } + } + } + return fullWidth; }, - // Alignment for 'under' target - alignErrorEl : function(){ - this.errorEl.setWidth(this.getErrorCt().getWidth(true) - 20); - }, + // invoked internally by a header when not using triStateSorting + clearOtherSortStates: function(activeHeader) { + var headers = this.getGridColumns(), + headersLn = headers.length, + i = 0, + oldSortState; - // Alignment for 'side' target - alignErrorIcon : function(){ - this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]); + 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); + //} + } + } }, /** - * 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 + * 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} */ - getRawValue : function(){ - var v = this.rendered ? this.el.getValue() : Ext.value(this.value, ''); - if(v === this.emptyText){ - v = ''; - } - return v; + getVisibleGridColumns: function(refreshCache) { + return Ext.ComponentQuery.query(':not([hidden])', this.getGridColumns(refreshCache)); }, /** - * 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 + * 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} */ - getValue : function(){ - if(!this.rendered) { - return this.value; - } - var v = this.el.getValue(); - if(v === this.emptyText || v === undefined){ - v = ''; + 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 v; - }, - /** - * 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 result; }, /** - * 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 + * Get the index of a leaf level header regardless of what the nesting + * structure is. */ - setValue : function(v){ - this.value = v; - if(this.rendered){ - this.el.dom.value = (Ext.isEmpty(v) ? '' : v); - this.validate(); - } - return this; + getHeaderIndex: function(header) { + var columns = this.getGridColumns(); + return Ext.Array.indexOf(columns, header); }, - // private, does not work for all fields - append : function(v){ - this.setValue([this.getValue(), v].join('')); - } - - /** - * @cfg {Boolean} autoWidth @hide - */ /** - * @cfg {Boolean} autoHeight @hide + * Get a leaf level header by index regardless of what the nesting + * structure is. */ + getHeaderAtIndex: function(index) { + var columns = this.getGridColumns(); + return columns[index]; + }, /** - * @cfg {String} autoEl @hide + * 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, panel) { + var obj = {}, + headers = this.gridDataColumns || this.getGridColumns(), + headersLn = headers.length, + colIdx = 0, + header, + headerId, + renderer, + value, + metaData, + store = panel.store; + for (; colIdx < headersLn; colIdx++) { + metaData = { + tdCls: '', + style: '' + }; + header = headers[colIdx]; + headerId = header.id; + renderer = header.renderer; + value = data[header.dataIndex]; -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(); - } - }, - 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 = ''; - } - }, - '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); + // When specifying a renderer as a string, it always resolves + // to Ext.util.Format + if (typeof renderer === "string") { + header.renderer = renderer = Ext.util.Format[renderer]; } - 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 = ''; + + if (typeof renderer === "function") { + value = 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 + ); } - } - }, - '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); + + if (metaData.css) { + // This warning attribute is used by the compat layer + obj.cssWarning = true; + metaData.tdCls = metaData.css; + delete metaData.css; } - 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 = ''; + + obj[headerId+'-modified'] = record.modified[header.dataIndex] ? Ext.baseCSSPrefix + 'grid-dirty-cell' : ''; + obj[headerId+'-tdCls'] = metaData.tdCls; + obj[headerId+'-tdAttr'] = metaData.tdAttr; + obj[headerId+'-style'] = metaData.style; + if (value === undefined || value === null || value === '') { + value = ' '; } + obj[headerId] = value; } - } -}; - -// anything other than normal should be considered experimental -Ext.form.Field.msgFx = { - normal : { - show: function(msgEl, f){ - msgEl.setDisplayed('block'); - }, - - hide : function(msgEl, f){ - msgEl.setDisplayed(false).update(''); - } - }, - - slide : { - show: function(msgEl, f){ - msgEl.slideIn('t', {stopFx:true}); - }, - - hide : function(msgEl, f){ - msgEl.slideOut('t', {stopFx:true,useDisplay:true}); - } + return obj; }, - 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}); + expandToFit: function(header) { + if (this.view) { + this.view.expandToFit(header); } } -}; -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 - * + * @class Ext.grid.column.Column + * @extends Ext.grid.header.Container * - * @constructor Creates a new TextField - * @param {Object} config Configuration options + * 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: * - * @xtype textfield + * {@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.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.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 {Boolean} disableKeyFilter Specify true to disable input keystroke filtering (defaults - * to false) + * @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. */ - disableKeyFilter : false, + /** - * @cfg {Boolean} allowBlank Specify false to validate that the value's length is > 0 (defaults to - * true) + * @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. */ - allowBlank : true, + dataIndex: null, + /** - * @cfg {Number} minLength Minimum input field length required (defaults to 0) + * @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 ' '. */ - minLength : 0, + text: ' ', + /** - * @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'} -}); - + * @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}. */ - maxLength : Number.MAX_VALUE, + sortable: true, + /** - * @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}') + * @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. */ - 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}') + * @cfg {Boolean} hideable Optional. Specify as false to prevent the user from hiding this column + * (defaults to true). */ - maxLengthText : 'The maximum length for this field is {0}', + hideable: true, + /** - * @cfg {Boolean} selectOnFocus true to automatically select any existing field text when the field - * receives input focus (defaults to false) + * @cfg {Boolean} menuDisabled + * True to disabled the column header menu containing sort/hide options. Defaults to false. */ - selectOnFocus : false, + menuDisabled: false, + /** - * @cfg {String} blankText The error text to display if the {@link #allowBlank} validation - * fails (defaults to 'This field is required') + * @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 */ - blankText : 'This field is required', + renderer: false, + /** - * @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 - * + * @cfg {String} align Sets the alignment of the header and rendered columns. + * Defaults to 'left'. */ - validator : null, + align: 'left', + /** - * @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}. + * @cfg {Boolean} draggable Indicates whether or not the header can be drag and drop re-ordered. + * Defaults to true. */ - regex : null, + 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} regexText The error text to display if {@link #regex} is used and the - * test fails during validation (defaults to '') + * @cfg {String} tdCls Optional. A CSS class names to apply to the table cells for this column. */ - 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}. + * @property {Ext.core.Element} triggerEl */ - 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. + * @property {Ext.core.Element} textEl */ - emptyClass : 'x-form-empty-field', /** - * @cfg {Boolean} enableKeyEvents true to enable the proxying of key events for the HTML input - * field (defaults to false) + * @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. */ + isHeader: true, - 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', + initComponent: function() { + var me = this, + i, + len; + + if (Ext.isDefined(me.header)) { + me.text = me.header; + delete me.header; + } - /** - * @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' - ); + // 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; + } + // 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 (!me.triStateSort) { + me.possibleSortStates.length = 2; + } + + // 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); + }, + + onAdd: function(childHeader) { + childHeader.isSubHeader = true; + childHeader.addCls(Ext.baseCSSPrefix + 'group-sub-header'); + }, + + onRemove: function(childHeader) { + childHeader.isSubHeader = false; + childHeader.removeCls(Ext.baseCSSPrefix + 'group-sub-header'); + }, + + 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); + } }, - // 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(); - } - } - 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); - } - if(this.enableKeyEvents){ - this.mon(this.el, { - scope: this, - keyup: this.onKeyUp, - keydown: this.onKeyDown, - keypress: this.onKeyPress + // Find the topmost HeaderContainer: An ancestor which is NOT a Header. + // Group Headers are themselves HeaderContainers + getOwnerHeaderCt: function() { + return this.up(':not([isHeader])'); + }, + + /** + * 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 + */ + getIndex: function() { + return this.isGroupColumn ? false : this.getOwnerHeaderCt().getHeaderIndex(this); + }, + + afterRender: function() { + var me = this, + el = me.el; + + 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 }); } + + 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 + }); }, - - onMouseDown: function(e){ - if(!this.hasFocus){ - this.mon(this.el, 'mouseup', Ext.emptyFn, this, { single: true, preventDefault: true }); - } - }, - processValue : function(value){ - if(this.stripCharsRe){ - var newValue = value.replace(this.stripCharsRe, ''); - if(newValue !== value){ - this.setRawValue(newValue); - return newValue; + setSize: function(width, height) { + var me = this, + headerCt = me.ownerCt, + ownerHeaderCt = me.getOwnerHeaderCt(), + siblings, + len, i, + oldWidth = me.getWidth(), + newWidth = 0; + + if (width !== oldWidth) { + + // Bubble size changes upwards to group headers + if (headerCt.isGroupHeader) { + + siblings = headerCt.items.items; + len = siblings.length; + + // Size the owning group to the size of its sub headers + if (siblings[len - 1].rendered) { + + for (i = 0; i < len; i++) { + newWidth += (siblings[i] === me) ? width : siblings[i].getWidth(); + } + headerCt.minWidth = newWidth; + headerCt.setWidth(newWidth); + } } + me.callParent(arguments); } - return value; }, - filterValidation : function(e){ - if(!e.isNavKeyPress()){ - this.validationTask.delay(this.validationDelay); + afterComponentLayout: function(width, height) { + var me = this, + ownerHeaderCt = this.getOwnerHeaderCt(); + + 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); } }, - - //private - onDisable: function(){ - Ext.form.TextField.superclass.onDisable.call(this); - if(Ext.isIE){ - this.el.dom.unselectable = 'on'; + + // 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'; + } } - }, - - //private - onEnable: function(){ - Ext.form.TextField.superclass.onEnable.call(this); - if(Ext.isIE){ - this.el.dom.unselectable = ''; + 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' + }); } - }, - // private - onKeyUpBuffered : function(e){ - if(this.doAutoSize(e)){ - this.autoSize(); + // Only IE needs this + if (Ext.isIE && me.triggerEl) { + me.triggerEl.setHeight(headerHeight); } }, - - // private - doAutoSize : function(e){ - return !e.isNavKeyPress(); + + onDestroy: function() { + var me = this; + Ext.destroy(me.keyNav); + delete me.keyNav; + me.callParent(arguments); }, - // private - onKeyUp : function(e){ - this.fireEvent('keyup', this, e); + onTitleMouseOver: function() { + this.titleContainer.addCls(this.hoverCls); }, - // private - onKeyDown : function(e){ - this.fireEvent('keydown', this, e); + onTitleMouseOut: function() { + this.titleContainer.removeCls(this.hoverCls); }, - // private - onKeyPress : function(e){ - this.fireEvent('keypress', this, e); + onDownKey: function(e) { + if (this.triggerEl) { + this.onElClick(e, this.triggerEl.dom || this.el.dom); + } }, - /** - * 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(); + onEnterKey: function(e) { + this.onElClick(e, this.el.dom); }, - applyEmptyText : function(){ - if(this.rendered && this.emptyText && this.getRawValue().length < 1 && !this.hasFocus){ - this.setRawValue(this.emptyText); - this.el.addClass(this.emptyClass); + /** + * @private + * Double click + * @param e + * @param t + */ + 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')); } }, - // private - preFocus : function(){ - var el = this.el; - if(this.emptyText){ - if(el.dom.value == this.emptyText){ - this.setRawValue(''); + 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); } - el.removeClass(this.emptyClass); - } - if(this.selectOnFocus){ - el.dom.select(); } }, - // private - postBlur : function(){ - this.applyEmptyText(); + /** + * @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); }, - // private - filterKeys : function(e){ - if(e.ctrlKey){ - return; - } - var k = e.getKey(); - if(Ext.isGecko && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){ - return; - } - var cc = String.fromCharCode(e.getCharCode()); - if(!Ext.isGecko && e.isSpecialKey() && !cc){ - return; - } - if(!this.maskRe.test(cc)){ - e.stopEvent(); + 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]); } }, - setValue : function(v){ - if(this.emptyText && this.el && !Ext.isEmpty(v)){ - this.el.removeClass(this.emptyClass); - } - Ext.form.TextField.superclass.setValue.apply(this, arguments); - this.applyEmptyText(); - this.autoSize(); - return this; + doSort: function(state) { + var ds = this.up('tablepanel').store; + ds.sort({ + property: this.getSortParam(), + direction: state + }); }, /** - * 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 + * 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.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); + getSortParam: function() { + return this.dataIndex; + }, + + //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); } - - 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); + }, + + 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; } - - if (!this.allowBlank && (value.length < 1 || value === this.emptyText)) { // if it's blank - errors.push(this.blankText); + + // 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 (value.length < this.minLength) { - errors.push(String.format(this.minLengthText, this.minLength)); + }, + + 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 (value.length > this.maxLength) { - errors.push(String.format(this.maxLengthText, this.maxLength)); + + // 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(); + } } - - if (this.vtype) { - var vt = Ext.form.VTypes; - if(!vt[this.vtype](value, this)){ - errors.push(this.vtypeText || vt[this.vtype +'Text']); + + // 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); } - - if (this.regex && !this.regex.test(value)) { - errors.push(this.regexText); + + // Notify owning HeaderContainer + if (ownerCt) { + ownerCt.onHeaderShow(me); } - - 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 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; + 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; } - if(doFocus){ - this.focus(); + else { + return me.width; } }, + getCellSelector: function() { + return '.' + Ext.baseCSSPrefix + 'grid-cell-' + this.getItemId(); + }, + + getCellInnerSelector: function() { + return this.getCellSelector() + ' .' + Ext.baseCSSPrefix + 'grid-cell-inner'; + }, + + isOnLeftEdge: function(e) { + return (e.getXY()[0] - this.el.getLeft() <= this.handleWidth); + }, + + isOnRightEdge: function(e) { + return (this.el.getRight() - e.getXY()[0] <= this.handleWidth); + } + /** - * 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. + * 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 + + + /** + * 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 */ - autoSize : function(){ - if(!this.grow || !this.rendered){ - return; - } - if(!this.metrics){ - this.metrics = Ext.util.TextMetrics.createInstance(this.el); - } - 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); +}); /** - * @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'); - - * - * 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. - * + * @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 - * 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 + * @param {Object} config The configuration options */ -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, - /** - * @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). - */ - editable: true, +Ext.define('Ext.grid.RowNumberer', { + extend: 'Ext.grid.column.Column', + alias: 'widget.rownumberer', /** - * @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 {String} text Any valid text or HTML fragment to display in the header cell for the row + * number column (defaults to ' '). */ - readOnly: false, + text: " ", + /** - * @cfg {String} wrapFocusClass The class added to the to the wrap of the trigger element. Defaults to - * x-trigger-wrap-focus. + * @cfg {Number} width The default width in pixels of the row number column (defaults to 23). */ - wrapFocusClass: 'x-trigger-wrap-focus', + width: 23, + /** + * @cfg {Boolean} sortable True if the row number column is sortable (defaults to false). * @hide - * @method autoSize */ - autoSize: Ext.emptyFn, - // private - monitorTab : true, - // private - deferHeight : true, - // private - mimicing : false, - - actionMode: 'wrap', + sortable: false, - defaultTriggerWidth: 17, + align: 'right', - // 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); + constructor : function(config){ + this.callParent(arguments); + if (this.rowspan) { + this.renderer = Ext.Function.bind(this.renderer, this); } - this.wrap.setWidth(this.el.getWidth() + tw); }, - getTriggerWidth: function(){ - var tw = this.trigger.getWidth(); - if(!this.hideTrigger && !this.readOnly && tw === 0){ - tw = this.defaultTriggerWidth; - } - return tw; - }, + // private + fixed: true, + hideable: false, + menuDisabled: true, + dataIndex: '', + cls: Ext.baseCSSPrefix + 'row-numberer', + rowspan: undefined, // private - alignErrorIcon : function(){ - if(this.wrap){ - this.errorIcon.alignTo(this.wrap, 'tl-tr', [2, 0]); + renderer: function(value, metaData, record, rowIdx, colIdx, store) { + if (this.rowspan){ + metaData.cellAttr = 'rowspan="'+this.rowspan+'"'; } - }, - // private - onRender : function(ct, position){ - this.doc = Ext.isIE ? Ext.getBody() : Ext.getDoc(); - Ext.form.TriggerField.superclass.onRender.call(this, ct, position); + 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', + + constructor: function(config) { + var me = this; + Ext.apply(me, config); - 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()); + // 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; } - this.resizeEl = this.positionEl = this.wrap; + + // 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]); }, - getWidth: function() { - return(this.el.getWidth() + this.trigger.getWidth()); +// 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; }, - 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); - } else { - this.el.dom.readOnly = false; - this.el.removeClass('x-trigger-noedit'); - this.mun(this.el, 'click', this.onTriggerClick, this); + 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.trigger.setDisplayed(!this.hideTrigger); } - this.onResize(this.width || this.wrap.getWidth()); } + return node; }, - setHideTrigger: function(hideTrigger){ - if(hideTrigger != this.hideTrigger){ - this.hideTrigger = hideTrigger; - this.updateEditState(); + getIndicator: function() { + var me = this; + + if (!me.indicator) { + me.indicator = Ext.createWidget('component', { + html: me.indicatorHtml, + cls: me.indicatorCls, + ownerCt: me.view, + floating: true, + shadow: false + }); } + return me.indicator; }, - /** - * @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(); + getPosition: function(e, node) { + var y = e.getXY()[1], + region = Ext.fly(node).getRegion(), + pos; + + if ((region.bottom - y) >= (region.bottom - region.top) / 2) { + pos = "before"; + } else { + pos = "after"; } + return pos; }, /** - * @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. + * @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 */ - setReadOnly: function(readOnly){ - if(readOnly != this.readOnly){ - this.readOnly = readOnly; - this.updateEditState(); + 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; - afterRender : function(){ - Ext.form.TriggerField.superclass.afterRender.call(this); - this.updateEditState(); + return recordBefore && Ext.Array.contains(records, recordBefore); }, - // 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'); + 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); + + // Cache the overRecord and the 'before' or 'after' indicator. + me.overRecord = overRecord; + me.currentPosition = pos; + } + } else { + me.invalidateDrop(); + } }, - // private - onDestroy : function(){ - Ext.destroy(this.trigger, this.wrap); - if (this.mimicing){ - this.doc.un('mousedown', this.mimicBlur, this); + invalidateDrop: function() { + if (this.valid) { + this.valid = false; + this.getIndicator().hide(); } - 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); - } + // 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; }, - // private - checkTab : function(me, e){ - if(e.getKey() == e.TAB){ - this.triggerBlur(); + // 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(); } }, - // private - onBlur : Ext.emptyFn, + // 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(); - // private - mimicBlur : function(e){ - if(!this.isDestroyed && !this.wrap.contains(e.target) && this.validateBlur(e)){ - this.triggerBlur(); + // 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.dropAllowed; }, - // private - triggerBlur : function(){ - this.mimicing = false; - this.doc.un('mousedown', this.mimicBlur, this); - if(this.monitorTab && this.el){ - this.un('specialkey', this.checkTab, this); + onContainerDrop : function(dd, e, data) { + return this.onNodeDrop(dd, null, e, data); + }, + + 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; + } + } +}); + +Ext.define('Ext.grid.ViewDropZone', { + extend: 'Ext.view.DropZone', + + indicatorHtml: ' ', + indicatorCls: 'x-grid-drop-indicator', + + handleNodeDrop : function(data, record, position) { + var view = this.view, + store = view.getStore(), + index, records, i, len; + + // If the copy flag is set, create a copy of the Models 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); } - Ext.form.TriggerField.superclass.onBlur.call(this); - if(this.wrap){ - this.wrap.removeClass(this.wrapFocusClass); + + 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. + * + * {@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.define('Ext.grid.column.Action', { + extend: 'Ext.grid.column.Column', + alias: ['widget.actioncolumn'], + alternateClassName: 'Ext.grid.ActionColumn', + + /** + * @cfg {String} icon + * The URL of an image to display as the clickable element in the column. + * Optional - defaults to {@link Ext#BLANK_IMAGE_URL Ext.BLANK_IMAGE_URL}. + */ + /** + * @cfg {String} iconCls + * A CSS class to apply to the icon image. To determine the class dynamically, configure the Column with a {@link #getClass} function. + */ + /** + * @cfg {Function} handler A function called when the icon is clicked. + * 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. + * + */ + /** + * @cfg {Object} scope The scope (this reference) in which the {@link #handler} + * and {@link #getClass} fuctions are executed. Defaults to this Column. + */ + /** + * @cfg {String} tooltip A tooltip message to be displayed on hover. {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must have + * been initialized. + */ + /** + * @cfg {Boolean} stopSelection Defaults to true. Prevent grid row selection upon mousedown. + */ + /** + * @cfg {Function} getClass A function which returns the CSS class to apply to the icon image. + * The function is passed the following parameters: + * v : ObjectThe value of the column's configured field (if any). + * metadata : ObjectAn object in which you may set the following attributes: + * css : StringA CSS class name to add to the cell's TD element. + * attr : StringAn HTML attribute definition string to apply to the data container element within the table cell + * (e.g. 'style="color:red;"'). + * + * r : Ext.data.RecordThe Record providing the data. + * rowIndex : NumberThe row index.. + * colIndex : NumberThe column index. + * store : Ext.data.StoreThe Store which is providing the data Model. + * + */ + /** + * @cfg {Array} items An Array which may contain multiple icon definitions, each element of which may contain: + * + * 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 : ObjectThe value of the column's configured field (if any). + * metadata : ObjectAn object in which you may set the following attributes: + * css : StringA CSS class name to add to the cell's TD element. + * attr : StringAn HTML attribute definition string to apply to the data container element within the table cell + * (e.g. 'style="color:red;"'). + * + * r : Ext.data.RecordThe Record providing the data. + * rowIndex : NumberThe row index.. + * colIndex : NumberThe column index. + * store : Ext.data.StoreThe 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. + * + */ + header: ' ', + + actionIdRe: /x-action-col-(\d+)/, + + /** + * @cfg {String} altText The alt text to use for the image element. Defaults to ''. + */ + 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; + me.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; + }; }, - beforeBlur : Ext.emptyFn, + destroy: function() { + delete this.items; + delete this.renderer; + return this.callParent(arguments); + }, - // 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; + /** + * @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 me = this, + match = e.getTarget().className.match(me.actionIdRe), + item, fn; + if (match) { + item = me.items[parseInt(match[1], 10)]; + if (item) { + if (type == 'click') { + fn = item.handler || me.handler; + if (fn) { + fn.call(item.scope || me.scope || me, view, recordIndex, cellIndex, item, e); + } + } else if (type == 'mousedown' && item.stopSelection !== false) { + return false; + } + } + } + return me.callParent(arguments); }, + cascade: function(fn, scope) { + fn.call(scope||this, this); + }, + + // Private override because this cannot function as a Container, and it has an items property which is an Array, NOT a MixedCollection. + getRefItems: function() { + return []; + } +}); +/** + * @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', + /** - * 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 + * @cfg {String} trueText + * The string returned by the renderer when the column value is not falsey (defaults to 'true'). */ - onTriggerClick : Ext.emptyFn + trueText: 'true', /** - * @cfg {Boolean} grow @hide + * @cfg {String} falseText + * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to + * 'false'). */ + falseText: 'false', + /** - * @cfg {Number} growMin @hide + * @cfg {String} undefinedText + * The string returned by the renderer when the column value is undefined (defaults to ' '). + */ + 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 {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. */ + 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 {Number} growMax @hide + * @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(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/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. */ + 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.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 + * @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.form.TwinTriggerField = Ext.extend(Ext.form.TriggerField, { +Ext.define('Ext.grid.feature.Feature', { + extend: 'Ext.util.Observable', + alias: 'feature.feature', + + isFeature: true, + disabled: false, + + /** + * @property {Boolean} + * Most features will expose additional events, some may not and will + * need to change this to false. + */ + hasFeatureEvent: true, + + /** + * @property {String} + * Prefix to use when firing events on the view. + * For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick". + */ + eventPrefix: null, + + /** + * @property {String} + * Selector used to determine when to fire the event with the eventPrefix. + */ + eventSelector: null, + + /** + * @property {Ext.view.Table} + * Reference to the TableView. + */ + view: null, + /** - * @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. + * @property {Ext.grid.Panel} + * Reference to the grid panel */ + grid: null, + /** - * @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. + * Most features will not modify the data returned to the view. + * This is limited to one feature that manipulates the data per grid view. */ + collectData: false, + + getFeatureTpl: function() { + return ''; + }, + /** - * @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. + * 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. */ - - 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} - ]}; + getFireEventArgs: function(eventName, view, featureTarget, e) { + return [eventName, view, featureTarget, e]; }, - - getTrigger : function(index){ - return this.triggers[index]; + + /** + * Approriate place to attach events to the view, selectionmodel, headerCt, etc + */ + attachEvents: function() { + }, - 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(); - } - - } + getFragmentTpl: function() { + return; }, - - 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; + + /** + * 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) { + }, - - 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; + + /** + * 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. + */ + getMetaRowTplFragments: function() { + return {}; }, - // private - onDestroy : function() { - Ext.destroy(this.triggers); - Ext.form.TwinTriggerField.superclass.onDestroy.call(this); + getTableFragments: function() { + return {}; }, - + /** - * 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 + * 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. */ - onTrigger1Click : Ext.emptyFn, + getAdditionalData: function(data, idx, record, orig) { + return {}; + }, + /** - * 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 + * Enable a feature + */ + enable: function() { + this.disabled = false; + }, + + /** + * Disable a feature */ - onTrigger2Click : Ext.emptyFn + disable: function() { + this.disabled = true; + } + }); -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 + * 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.form.TextArea = Ext.extend(Ext.form.TextField, { +Ext.define('Ext.grid.feature.AbstractSummary', { + + /* 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, + /** - * @cfg {Number} growMin The minimum height to allow when {@link Ext.form.TextField#grow grow}=true - * (defaults to 60) + * Toggle whether or not to show the summary row. + * @param {Boolan} visible True to show the summary row */ - growMin : 60, + toggleSummaryRow: function(visible){ + this.showSummaryRow = !!visible; + }, + /** - * @cfg {Number} growMax The maximum height to allow when {@link Ext.form.TextField#grow grow}=true - * (defaults to 1000) + * Gets any fragments to be used in the tpl + * @private + * @return {Object} The fragments */ - growMax: 1000, - growAppend : ' \n ', - - enterIsSpecial : false, - + getSummaryFragments: function(){ + var fragments = {}; + if (this.showSummaryRow) { + Ext.apply(fragments, { + printSummaryRow: Ext.bind(this.printSummaryRow, this) + }); + } + return fragments; + }, + /** - * @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. + * Prints a summary row + * @private + * @param {Object} index The index in the template + * @return {String} The value of the summary row */ - preventScrollbars: false, + 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) + }); + }, + /** - * @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"} - */ - - // private - onRender : function(ct, position){ - if(!this.el){ - this.defaultAutoCreate = { - tag: "textarea", - style:"width:100px;height:60px;", - autocomplete: "off" - }; + * 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 + */ + getColumnValue: function(column, summaryData){ + var comp = Ext.getCmp(column.id), + value = summaryData[column.dataIndex], + renderer = comp.summaryRenderer; + + if (renderer) { + value = renderer.call( + comp.scope || this, + value, + summaryData, + column.dataIndex + ); } - 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 value; + }, + + /** + * 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); + } + + 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 ? {} : ''; + } - this.el.setHeight(this.growMin); } - }, + } + +}); - onDestroy : function(){ - Ext.removeNode(this.textSizeEl); - Ext.form.TextArea.superclass.onDestroy.call(this); +/** + * @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}); }, - - fireKey : function(e){ - if(e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() != e.ENTER || e.hasModifier()))){ - this.fireEvent("specialkey", this, e); + + 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; } }, - // private - doAutoSize : function(e){ - return !e.isNavKeyPress() || e.getKey() == e.ENTER; - }, - - /** - * 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. - */ - autoSize: function(){ - if(!this.grow || !this.textSizeEl){ - return; - } - var el = this.el, - v = Ext.util.Format.htmlEncode(el.dom.value), - ts = this.textSizeEl, - h; + 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; + } - Ext.fly(ts).setWidth(this.el.getWidth()); - if(v.length < 1){ - v = "  "; - }else{ - v += this.growAppend; - if(Ext.isIE){ - v = v.replace(/\n/g, ' '); + 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 + }); } - 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 o; + }, + + getTableFragments: function() { + return { + openTableWrap: function() { + return ''; + }, + closeTableWrap: function() { + return ''; + } + }; } }); -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.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.form.NumberField = Ext.extend(Ext.form.TextField, { +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); + }, + /** - * @cfg {RegExp} stripCharsRe @hide + * @event groupclick + * @param {Ext.view.Table} view + * @param {HTMLElement} node + * @param {String} group The name of the group + * @param {Ext.EventObject} e */ + /** - * @cfg {RegExp} maskRe @hide + * @event groupdblclick + * @param {Ext.view.Table} view + * @param {HTMLElement} node + * @param {String} group The name of the group + * @param {Ext.EventObject} e */ + /** - * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-field x-form-num-field") + * @event groupcontextmenu + * @param {Ext.view.Table} view + * @param {HTMLElement} node + * @param {String} group The name of the group + * @param {Ext.EventObject} e */ - fieldClass: "x-form-field x-form-num-field", + /** - * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true) + * @event groupcollapse + * @param {Ext.view.Table} view + * @param {HTMLElement} node + * @param {String} group The name of the group + * @param {Ext.EventObject} e */ - allowDecimals : true, + /** - * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.') + * @event groupexpand + * @param {Ext.view.Table} view + * @param {HTMLElement} node + * @param {String} group The name of the group + * @param {Ext.EventObject} e */ - decimalSeparator : ".", + /** - * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2) + * @cfg {String} groupHeaderTpl + * Template snippet, this cannot be an actual template. {name} will be replaced with the current group. + * Defaults to 'Group: {name}' */ - decimalPrecision : 2, + groupHeaderTpl: 'Group: {name}', + /** - * @cfg {Boolean} allowNegative False to prevent entering a negative sign (defaults to true) + * @cfg {Number} depthToIndent + * Number of pixels to indent per grouping level */ - allowNegative : true, + depthToIndent: 17, + + collapsedCls: Ext.baseCSSPrefix + 'grid-group-collapsed', + hdCollapsedCls: Ext.baseCSSPrefix + 'grid-group-hd-collapsed', + /** - * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY) + * @cfg {String} groupByText Text displayed in the grid header menu for grouping by header + * (defaults to 'Group By This Field'). */ - minValue : Number.NEGATIVE_INFINITY, + groupByText : 'Group By This Field', /** - * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE) + * @cfg {String} showGroupsText Text displayed in the grid header for enabling/disabling grouping + * (defaults to 'Show in Groups'). */ - maxValue : Number.MAX_VALUE, + showGroupsText : 'Show in Groups', + /** - * @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} hideGroupedHeadertrue to hide the header that is currently grouped (defaults to false) */ - minText : "The minimum value for this field is {0}", + hideGroupedHeader : false, + /** - * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}") + * @cfg {Boolean} startCollapsed true to start all groups collapsed (defaults to false) */ - maxText : "The maximum value for this field is {0}", + startCollapsed : false, + /** - * @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") + * @cfg {Boolean} enableGroupingMenu true to enable the grouping control in the header menu (defaults to true) */ - nanText : "{0} is not a valid number", + enableGroupingMenu : true, + /** - * @cfg {String} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789'). + * @cfg {Boolean} enableNoGroups true to allow the user to turn off grouping (defaults to true) */ - baseChars : "0123456789", - - // private - initEvents : function(){ - var allowed = this.baseChars + ''; - if (this.allowDecimals) { - allowed += this.decimalSeparator; - } - if (this.allowNegative) { - allowed += '-'; + enableNoGroups : true, + + enable: function() { + var me = this, + view = me.view, + store = view.store, + groupToggleMenuItem; + + if (me.lastGroupIndex) { + store.group(me.lastGroupIndex); } - this.maskRe = new RegExp('[' + Ext.escapeRe(allowed) + ']'); - Ext.form.NumberField.superclass.initEvents.call(this); + me.callParent(); + groupToggleMenuItem = me.view.headerCt.getMenu().down('#groupToggleMenuItem'); + groupToggleMenuItem.setChecked(true, true); + view.refresh(); }, - - /** - * 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 - */ - getErrors: function(value) { - var errors = Ext.form.NumberField.superclass.getErrors.apply(this, arguments); - - value = value || this.processValue(this.getRawValue()); - - if (value.length < 1) { // if it's blank and textfield didn't flag it then it's valid - return errors; + + 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(); } - value = String(value).replace(this.decimalSeparator, "."); - - if(isNaN(value)){ - errors.push(String.format(this.nanText, value)); - } + me.callParent(); + groupToggleMenuItem = me.view.headerCt.getMenu().down('#groupToggleMenuItem'); + groupToggleMenuItem.setChecked(true, true); + groupToggleMenuItem.setChecked(false, true); + view.refresh(); + }, + + getFeatureTpl: function(values, parent, x, xcount) { + var me = this; - var num = this.parseValue(value); + return [ + '', + // group row tpl + '', + // this is the rowbody + '', + '' + ].join(''); + }, + + getFragmentTpl: function() { + return { + indentByDepth: this.indentByDepth, + depthToIndent: this.depthToIndent + }; + }, + + indentByDepth: function(values) { + var depth = values.depth || 0; + return 'style="padding-left:'+ depth * this.depthToIndent + 'px;"'; + }, + + // Containers holding these components are responsible for + // destroying them, we are just deleting references. + destroy: function() { + var me = this; - if(num < this.minValue){ - errors.push(String.format(this.minText, this.minValue)); + delete me.view; + delete me.prunedHeader; + }, + + // perhaps rename to afterViewRender + attachEvents: function() { + var me = this, + view = me.view, + header, headerId, menu, menuItem; + + view.on({ + scope: me, + groupclick: me.onGroupClick, + rowfocus: me.onRowFocus + }); + view.store.on('groupchange', me.onGroupChange, me); + + me.pruneGroupedHeader(); + + if (me.enableGroupingMenu) { + me.injectGroupingMenu(); } - - if(num > this.maxValue){ - errors.push(String.format(this.maxText, this.maxValue)); + + 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); + } } - - return errors; }, - - getValue : function(){ - return this.fixPrecision(this.parseValue(Ext.form.NumberField.superclass.getValue.call(this))); + + injectGroupingMenu: function() { + var me = this, + view = me.view, + headerCt = view.headerCt; + headerCt.showMenuBy = me.showMenuBy; + headerCt.getMenuItems = me.getMenuItems(); }, - - 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); + + 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; + }; + }, + + /** - * Replaces any existing {@link #minValue} with the new value. - * @param {Number} value The minimum value + * Group by the header the user has clicked on. + * @private */ - setMinValue : function(value){ - this.minValue = Ext.num(value, Number.NEGATIVE_INFINITY); + 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(); + }, - + /** - * Replaces any existing {@link #maxValue} with the new value. - * @param {Number} value The maximum value + * Turn on and off grouping via the menu + * @private */ - setMaxValue : function(value){ - this.maxValue = Ext.num(value, Number.MAX_VALUE); + onGroupToggleMenuItemClick: function(menuItem, checked) { + this[checked ? 'enable' : 'disable'](); }, - // private - parseValue : function(value){ - value = parseFloat(String(value).replace(this.decimalSeparator, ".")); - return isNaN(value) ? '' : value; - }, + /** + * Prunes the grouped header from the header container + * @private + */ + pruneGroupedHeader: function() { + var me = this, + view = me.view, + store = view.store, + groupField = me.getGroupField(), + headerCt = view.headerCt, + header = headerCt.down('header[dataIndex=' + groupField + ']'); - // private - fixPrecision : function(value){ - var nan = isNaN(value); - if(!this.allowDecimals || this.decimalPrecision == -1 || nan || !value){ - return nan ? '' : value; + if (header) { + if (me.prunedHeader) { + me.prunedHeader.show(); + } + me.prunedHeader = header; + header.hide(); } - return parseFloat(parseFloat(value).toFixed(this.decimalPrecision)); }, - beforeBlur : function(){ - var v = this.parseValue(this.getRawValue()); - if(!Ext.isEmpty(v)){ - this.setValue(v); + getGroupField: function(){ + var group = this.view.store.groupers.first(); + if (group) { + return group.property; } - } -}); -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). - */ + return ''; + }, + /** - * @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). + * 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); + + if (groupBd) { + // for multiple level groups, should expand every groupBd + // above + this.expand(groupBd); + } + }, + /** - * @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] - * + * 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; + + groupBd.removeCls(me.collapsedCls); + groupBd.prev().removeCls(me.hdCollapsedCls); + + grid.determineScrollbars(); + grid.invalidateScroller(); + view.fireEvent('groupexpand'); + }, + /** - * @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"]. + * Collapse a group by the groupBody + * @param {Ext.core.Element} groupBd + * @private */ + collapse: function(groupBd) { + var me = this, + view = me.view, + grid = view.up('gridpanel'), + groupBdDom = Ext.getDom(groupBd); + + me.collapsedState[groupBdDom.id] = true; + + groupBd.addCls(me.collapsedCls); + groupBd.prev().addCls(me.hdCollapsedCls); + + grid.determineScrollbars(); + grid.invalidateScroller(); + view.fireEvent('groupcollapse'); + }, + + onGroupChange: function(){ + this.view.refresh(); + }, + /** - * @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"} - * + * Toggle between expanded/collapsed state when clicking on + * the group. + * @private */ + onGroupClick: function(view, group, idx, foo, e) { + var me = this, + toggleCls = me.toggleCls, + groupBd = Ext.fly(group.nextSibling, '_grouping'); - // private - defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"}, + if (groupBd.hasCls(me.collapsedCls)) { + me.expand(groupBd); + } else { + me.collapse(groupBd); + } + }, - // 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 + // Injects isRow and closeRow into the metaRowTpl. + getMetaRowTplFragments: function() { + return { + isRow: this.isRow, + closeRow: this.closeRow + }; + }, - initTimeFormat: 'H', + // injected into rowtpl and wrapped around metaRowTpl + // becomes part of the standard tpl + isRow: function() { + return ''; + }, - // 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); + // injected into rowtpl and wrapped around metaRowTpl + // becomes part of the standard tpl + closeRow: function() { + return ''; + }, + + // isRow and closeRow are injected via getMetaRowTplFragments + mutateMetaRowTpl: function(metaRowTpl) { + metaRowTpl.unshift('{[this.isRow()]}'); + metaRowTpl.push('{[this.closeRow()]}'); + }, + + // 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'; - if (parsedDate) return parsedDate.clearTime(); + // maintain the current tdAttr that a user may ahve set. + o[tdAttrKey] = this.indentByDepth(data) + " " + (orig[tdAttrKey] ? orig[tdAttrKey] : ''); + o.collapsed = 'true'; + return o; + }, + + // 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; }, - initComponent : function(){ - Ext.form.DateField.superclass.initComponent.call(this); + // 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 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, e) { + 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, e); + + return returnArray; + } +}); - 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' - ); +/** + * @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. + * - summaryData {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 */ - if(Ext.isString(this.minValue)){ - this.minValue = this.parseDate(this.minValue); + + /** + * 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; + }, + + /** + * Gets any fragments needed for the template. + * @private + * @return {Object} The fragments + */ + 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(); + } + return fragments; + }, + + /** + * 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; + }, + + /** + * 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 = {}, + 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] = {}; + } + + /** + * @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); } - if(Ext.isString(this.maxValue)){ - this.maxValue = this.parseDate(this.maxValue); + + 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]; + } + } + } } - this.disabledDatesRE = null; - this.initDisabledDays(); + return data; + } +}); + +/** + * @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 [ + '', + '', + '' + ].join(''); + }, + + // injects getRowBody into the metaRowTpl. + getMetaRowTplFragments: function() { + return { + getRowBody: this.getRowBody, + rowBodyTrCls: this.rowBodyTrCls, + rowBodyTdCls: this.rowBodyTdCls, + rowBodyDivCls: this.rowBodyDivCls + }; }, - 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 - }); + mutateMetaRowTpl: function(metaRowTpl) { + metaRowTpl.push('{[this.getRowBody(values)]}'); }, + /** + * 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. + */ + getAdditionalData: function(data, idx, record, orig) { + var headerCt = this.view.headerCt, + colspan = headerCt.getColumnCount(); - // private - initDisabledDays : function(){ - if(this.disabledDates){ - var dd = this.disabledDates, - len = dd.length - 1, - re = "(?:"; + 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', - 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 + ')'); - } + // 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('{collapsed}' + me.groupHeaderTpl + ' {[this.recurse(values)]} ', + '{rowBody}', + ' '); + // 1 + metaRowTpl.unshift(''); + + // 3 + metaRowTpl.push(' '); + // 4 + metaRowTpl.push('

- * {@link Ext.form.TextField} - * {@link Ext.form.VTypes} - * {@link Ext.form.BasicForm#doAction BasicForm.doAction clientValidation notes} - * {@link Ext.form.FormPanel#monitorValid monitorValid} + * @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+ * - * - * 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 */ -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.container.Border', { + alias: ['layout.border'], + extend: 'Ext.layout.container.Container', + requires: ['Ext.resizer.Splitter', 'Ext.container.Container', 'Ext.fx.Anim'], + alternateClassName: 'Ext.layout.BorderLayout', - /** - * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to 75). - */ - minButtonWidth : 75, + targetCls: Ext.baseCSSPrefix + 'border-layout-ct', - /** - * @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', + itemCls: Ext.baseCSSPrefix + 'border-item', + + bindToOwnerCtContainer: true, + + fixedLayout: false, + + percentageRe: /(\d+)%/, + + slideDirection: { + north: 't', + south: 'b', + west: 'l', + east: 'r' + }, + + constructor: function(config) { + this.initialConfig = config; + this.callParent(arguments); + }, + + onLayout: function() { + var me = this; + if (!me.borderLayoutInitialized) { + me.initializeBorderLayout(); + } + + // Delegate this operation to the shadow "V" or "H" box layout, and then down to any embedded layout. + me.fixHeightConstraints(); + me.shadowLayout.onLayout(); + if (me.embeddedContainer) { + me.embeddedContainer.layout.onLayout(); + } + + // 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; + } + }, + + isValidParent : function(item, target, position) { + if (!this.borderLayoutInitialized) { + this.initializeBorderLayout(); + } + + // Delegate this operation to the shadow "V" or "H" box layout. + return this.shadowLayout.isValidParent(item, target, position); + }, + + beforeLayout: function() { + if (!this.borderLayoutInitialized) { + this.initializeBorderLayout(); + } + + // Delegate this operation to the shadow "V" or "H" box layout. + this.shadowLayout.beforeLayout(); + }, + + renderItems: function(items, target) { + Ext.Error.raise('This should not be called'); + }, + + renderItem: function(item) { + Ext.Error.raise('This should not be called'); + }, + + 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); + + // 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); + + // 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; + } - /** - * @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, + // These spliiters need to be constrained by components one-level below + // the component in their vobx. We update the min/maxHeight on the helper + // (embeddedContainer) prior to starting the split/drag. This has to be + // done on-the-fly to allow min/maxHeight of the E/C/W regions to be set + // dynamically. + Ext.each([me.splitters.north, me.splitters.south], function (splitter) { + if (splitter) { + splitter.on('beforedragstart', me.fixHeightConstraints, me); + } + }); - /** - * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200) - */ - monitorPoll : 200, + // 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); - /** - * @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', + // Allow the Splitters to orientate themselves + if (me.splitters.east) { + me.splitters.east.ownerCt = me.shadowContainer; + } + if (me.splitters.west) { + me.splitters.west.ownerCt = me.shadowContainer; + } - // private - initComponent : function(){ - this.form = this.createForm(); - Ext.FormPanel.superclass.initComponent.call(this); + // The east or west region wanted a percentage + if (horizontalFlex) { + regions.center.flex -= verticalFlex; + } + } - 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'; + // 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; + } } - this.initItems(); - 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' - ); + // This is the layout that we delegate all operations to + me.shadowLayout = me.shadowContainer.getLayout(); - this.relayEvents(this.form, ['beforeaction', 'actionfailed', 'actioncomplete']); + me.borderLayoutInitialized = true; }, - // private - createForm : function(){ - var config = Ext.applyIf({listeners: {}}, this.initialConfig); - return new Ext.form.BasicForm(null, config); - }, + setupState: function(comp){ + var getState = comp.getState; + comp.getState = function(){ + // call the original getState + var state = getState.call(comp) || {}, + region = comp.region; - // 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); - } + state.collapsed = !!comp.collapsed; + if (region == 'west' || region == 'east') { + state.width = comp.getWidth(); + } else { + state.height = comp.getHeight(); } + return state; }; - this.items.each(fn, this); - }, - - // private - applySettings: function(c){ - var ct = c.ownerCt; - Ext.applyIf(c, { - labelAlign: ct.labelAlign, - labelWidth: ct.labelWidth, - itemCls: ct.itemCls - }); - }, - - // private - getLayoutTarget : function(){ - return this.form.el; + comp.addStateEvents(['collapse', 'expand', 'resize']); }, /** - * 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. + * Create the items collection for our shadow/embedded containers + * @private */ - getForm : function(){ - return this.form; - }, - - // private - onRender : function(ct, position){ - this.initFields(); - Ext.FormPanel.superclass.onRender.call(this, ct, position); - this.form.initEl(this.body); + 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); }, - // private - beforeDestroy : function(){ - this.stopMonitoring(); - this.form.destroy(true); - Ext.FormPanel.superclass.beforeDestroy.call(this); - }, + // 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 + }); - // Determine if a Component is usable as a form Field. - isField : function(c) { - return !!c.setValue && !!c.getValue && !!c.markInvalid && !!c.clearInvalid; - }, + // Mini collapse means that the splitter is the placeholder Component + if (comp.collapseMode == 'mini') { + comp.placeholder = resizer; + } - // 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 + // 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 }); - if(this.monitorValid){ // initialize after render - this.startMonitoring(); - } + return resizer; }, - // private - onAdd: function(c){ - Ext.FormPanel.superclass.onAdd.call(this, c); - this.processAdd(c); - }, + // Private + // Propogates the min/maxHeight values from the inner hbox items to its container. + fixHeightConstraints: function () { + var me = this, + ct = me.embeddedContainer, + maxHeight = 1e99, minHeight = -1; - // private - onAddEvent: function(ct, c){ - if(ct !== this){ - this.processAdd(c); + if (!ct) { + return; } - }, - // 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)); - } + ct.items.each(function (item) { + if (Ext.isNumber(item.maxHeight)) { + maxHeight = Math.max(maxHeight, item.maxHeight); + } + if (Ext.isNumber(item.minHeight)) { + minHeight = Math.max(minHeight, item.minHeight); + } + }); + + ct.maxHeight = maxHeight; + ct.minHeight = minHeight; }, - // private - onRemove: function(c){ - Ext.FormPanel.superclass.onRemove.call(this, c); - this.processRemove(c); + // 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(); }, - onRemoveEvent: function(ct, c){ - if(ct !== this){ - this.processRemove(c); + // 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(); } }, - // 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(); + /** + * 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. + */ + 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; + } + + // 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; } + if (!comp.hideCollapseTool) { + 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 + }); } } + + // The collapsed Component holds a reference to its placeholder and vice versa + comp.placeholder = placeholder; + placeholder.comp = comp; + + return placeholder; }, /** - * Starts monitoring of the valid state of this form. Usually this is done by passing the config - * option "monitorValid" + * @private + * Update the placeholder title when panel title has been set or changed. */ - startMonitoring : function(){ - if(!this.validTask){ - this.validTask = new Ext.util.TaskRunner(); - this.validTask.start({ - run : this.bindHandler, - interval : this.monitorPoll || 200, - scope: this - }); - } + onRegionTitleChange: function(comp, newTitle) { + comp.placeholder.setTitle(newTitle); }, /** - * Stops monitoring of the valid state of this form + * @private + * Update the placeholder iconCls when panel iconCls has been set or changed. */ - stopMonitoring : function(){ - if(this.validTask){ - this.validTask.stopAll(); - this.validTask = null; - } + onRegionIconChange: function(comp, newIconCls) { + comp.placeholder.setIconCls(newIconCls); }, /** - * 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) + * @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. */ - load : function(){ - this.form.load.apply(this.form, arguments); + 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); + } }, - // private - onDisable : function(){ - Ext.FormPanel.superclass.onDisable.call(this); - if(this.form){ - this.form.items.each(function(){ - this.disable(); + /** + * @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, + width, + miniCollapse = comp.collapseMode == 'mini', + shadowContainer = comp.shadowOwnerCt, + shadowLayout = shadowContainer.layout, + placeholder = comp.placeholder, + 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); + + // The inserted placeholder does not have the proper size, so copy the width + // for N/S or the height for E/W from the component. This fixes EXTJSIV-1562 + // without recursive layouts. This is only an issue initially. After this time, + // placeholder will have the correct width/height set by the layout (which has + // already happened when we get here initially). + if (comp.region == 'north' || comp.region == 'south') { + placeholder.setCalculatedSize(comp.getWidth()); + } else { + placeholder.setCalculatedSize(undefined, comp.getHeight()); + } + } + + // 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); + } + + /* + * 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 (comp.animCollapse && me.initialCollapsedComplete) { + shadowLayout.layout(); + compEl.dom.style.zIndex = 100; + + // If we're mini-collapsing, the placholder is a Splitter. We don't want it to "bounce in" + if (!miniCollapse) { + placeholder.el.hide(); + } + 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(); } + + return false; }, - // private - onEnable : function(){ - Ext.FormPanel.superclass.onEnable.call(this); - if(this.form){ - this.form.items.each(function(){ - this.enable(); + // 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; + }, + + // 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(); + } + } }); + } else { + shadowLayout.onLayout(); + afterExpand(); } }, - // 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); - } - } + floatCollapsedPanel: function(e, comp) { + + if (comp.floatable === false) { + return; } - this.fireEvent('clientvalidation', this, valid); - } -}); -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}. - * -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, - defaults: { - anchor: '-20' // leave room for error icon - }, - 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 - */ -Ext.form.FieldSet = Ext.extend(Ext.Panel, { - /** - * @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 {String} checkboxName The name to assign to the fieldset's checkbox if {@link #checkboxToggle} = true - * (defaults to '[checkbox id]-checkbox'). - */ - /** - * @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 {Number} labelWidth The width of labels. This property cascades to child containers. - */ - /** - * @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 {String} baseCls The base CSS class applied to the fieldset (defaults to 'x-fieldset'). - */ - baseCls : 'x-fieldset', - /** - * @cfg {String} layout The {@link Ext.Container#layout} to use inside the fieldset (defaults to 'form'). - */ - layout : 'form', - /** - * @cfg {Boolean} animCollapse - * true to animate the transition when the panel is collapsed, false to skip the - * animation (defaults to false). - */ - animCollapse : false, + 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; + } - // 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'; - } + // It's *being* animated, ignore the click. + // Possible future enhancement: Stop and *reverse* the current active Fx. + if (compEl.getActiveAnimation()) { + return; } - Ext.form.FieldSet.superclass.onRender.call(this, ct, position); + // 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; + } - 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); + // 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); + } } - }, - // private - onCollapse : function(doAnim, animArg){ - if(this.checkbox){ - this.checkbox.dom.checked = false; + // 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(); } - Ext.form.FieldSet.superclass.onCollapse.call(this, doAnim, animArg); - }, + // Set flags so that the layout will calculate the boxes for what we want + comp.hidden = false; + comp.collapsed = false; + placeholder.hidden = true; - // private - onExpand : function(doAnim, animArg){ - if(this.checkbox){ - this.checkbox.dom.checked = 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); } - Ext.form.FieldSet.superclass.onExpand.call(this, doAnim, animArg); - }, + compEl.setStyle('visibility', 'hidden'); + compEl.setLeftTop(toCompBox.left, toCompBox.top); - /** - * 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'](); - } + // 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); + } - /** - * @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 -}); + // 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 + }; -// 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 - */ + // Give the element the correct class which places it at a high z-index + compEl.addCls(Ext.baseCSSPrefix + 'border-region-slide-in'); -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) ? ' ' : '', + // 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 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" }, - // 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' - ); + 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; }, - // 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( - '' - ); + /* + * @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(); } - 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 - */ - createToolbar : function(editor){ - var items = []; - var tipsEnabled = Ext.QuickTips && Ext.QuickTips.isEnabled(); + /* + * @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; + + 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: '<h1>Welcome to the Wizard!</h1><p>Step 1 of 3</p>' + },{ + id: 'card-1', + html: '<p>Step 2 of 3</p>' + },{ + id: 'card-2', + html: '<h1>Congratulations!</h1><p>Step 3 of 3 - Complete</p>' + }], + renderTo: Ext.getBody() + }); + + */ +Ext.define('Ext.layout.container.Card', { + + /* Begin Definitions */ + alias: ['layout.card'], + alternateClassName: 'Ext.layout.CardLayout', - 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 - }; - } + extend: 'Ext.layout.container.AbstractCard', + /* End Definitions */ - if(this.enableFont && !Ext.isSafari2){ - var fontSelectItem = new Ext.Toolbar.Item({ - autoEl: { - tag:'select', - cls:'x-font-select', - html: this.createFontOptions() - } - }); + setActiveItem: function(newCard) { + var me = this, + owner = me.owner, + oldCard = me.activeItem, + newIndex; - items.push( - fontSelectItem, - '-' - ); - } + // Block upward layouts until we are done. + me.layoutBusy = true; - if(this.enableFormat){ - items.push( - btn('bold'), - btn('italic'), - btn('underline') - ); - } + newCard = me.parseActiveItem(newCard); + newIndex = owner.items.indexOf(newCard); - if(this.enableFontSize){ - items.push( - '-', - btn('increasefontsize', false, this.adjustFont), - btn('decreasefontsize', false, this.adjustFont) - ); + // If the card is not a child of the owner, then add it + if (newIndex == -1) { + newIndex = owner.items.items.length; + owner.add(newCard); } - 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' - }) - } - ); - } + // 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); + } - if(this.enableAlignments){ - items.push( - '-', - btn('justifyleft'), - btn('justifycenter'), - btn('justifyright') - ); - } + me.activeItem = newCard; - if(!Ext.isSafari2){ - if(this.enableLinks){ - items.push( - '-', - btn('createlink', false, this.createLink) - ); + // Fire the beforeactivate and beforedeactivate events on the cards + if (newCard.fireEvent('beforeactivate', newCard, oldCard) === false) { + me.layoutBusy = false; + return false; + } + if (oldCard && oldCard.fireEvent('beforedeactivate', oldCard, newCard) === false) { + me.layoutBusy = false; + return false; } - if(this.enableLists){ - items.push( - '-', - btn('insertorderedlist'), - btn('insertunorderedlist') - ); + // If the card hasnt been sized yet, do it now + if (!me.sizeAllCards) { + me.setItemBox(newCard, me.getTargetBox()); } - if(this.enableSourceEdit){ - items.push( - '-', - btn('sourceedit', true, function(btn){ - this.toggleSourceEdit(!this.sourceEditMode); - }) - ); + else { + // onLayout calls setItemBox + me.onLayout(); } - } - // build the toolbar - var tb = new Ext.Toolbar({ - renderTo: this.wrap.dom.firstChild, - items: items - }); + if (oldCard) { + if (me.hideInactive) { + oldCard.hide(); + } + oldCard.fireEvent('deactivate', oldCard, newCard); + } - if (fontSelectItem) { - this.fontSelect = fontSelectItem.el; + // Make sure the new card is shown + if (newCard.hidden) { + newCard.show(); + } - this.mon(this.fontSelect, 'change', function(){ - var font = this.fontSelect.dom.value; - this.relayCmd('fontname', font); - this.deferFocus(); - }, this); + newCard.fireEvent('activate', newCard, oldCard); + + me.layoutBusy = false; + + if (!me.sizeAllCards) { + if (!owner.componentLayout.layoutBusy) { + me.onLayout(); + } + } + return newCard; } - // stop form submits - this.mon(tb.el, 'click', function(e){ - e.preventDefault(); - }); + 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() + }); - this.tb = tb; - this.tb.doLayout(); - }, +// {@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. - onDisable: function(){ - this.wrap.mask(); - Ext.form.HtmlEditor.superclass.onDisable.call(this); - }, + 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', { - onEnable: function(){ - this.wrap.unmask(); - Ext.form.HtmlEditor.superclass.onEnable.call(this); - }, + extend: 'Ext.layout.container.Auto', + alias: ['layout.column'], + alternateClassName: 'Ext.layout.ColumnLayout', - setReadOnly: function(readOnly){ + type: 'column', - 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'; - } - this.disableItems(readOnly); - } - }, + itemCls: Ext.baseCSSPrefix + 'column', - /** - * 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 - */ - getDocMarkup : function(){ - var h = Ext.fly(this.iframe).getHeight() - this.iframePad * 2; - return String.format('', this.iframePad, h); - }, + targetCls: Ext.baseCSSPrefix + 'column-layout-ct', - // private - getEditorBody : function(){ - var doc = this.getDoc(); - return doc.body || doc.documentElement; - }, + scrollOffset: 0, - // private - getDoc : function(){ - return Ext.isIE ? this.getWin().document : (this.iframe.contentDocument || this.getWin().document); - }, + bindToOwnerCtComponent: false, - // private - getWin : function(){ - return Ext.isIE ? this.iframe.contentWindow : window.frames[this.iframe.name]; + getRenderTarget : function() { + if (!this.innerCt) { + + // the innerCt prevents wrapping and shuffling while + // the container is resizing + this.innerCt = this.getTarget().createChild({ + cls: Ext.baseCSSPrefix + 'column-inner' + }); + + // 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 - 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, + 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(); + } + } + } - this.createToolbar(this); + 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); + } + } - this.disableItems(true); + 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); + } + } + } - this.tb.doLayout(); + // 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) { - this.createIFrame(); + // 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(!this.width){ - var sz = this.el.getSize(); - this.setSize(sz.width, this.height || sz.height); + // If the layout caused height overflow, recurse back and recalculate (with overflow setting restored on non-IE6) + if (me.adjustmentPass) { + me.onLayout(); + } } - this.resizeEl = this.positionEl = this.wrap; - }, + delete me.adjustmentPass; + } +}); +/** + * @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} + * +// 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() + }); + + */ - createIFrame: function(){ - var iframe = document.createElement('iframe'); - iframe.name = Ext.id(); - iframe.frameBorder = '0'; - iframe.style.overflow = 'auto'; +Ext.define('Ext.layout.container.Table', { - this.wrap.dom.appendChild(iframe); - this.iframe = iframe; + /* Begin Definitions */ - this.monitorTask = Ext.TaskMgr.start({ - run: this.checkDesignMode, - scope: this, - interval:100 - }); - }, + alias: ['layout.table'], + extend: 'Ext.layout.container.Auto', + alternateClassName: 'Ext.layout.TableLayout', - initFrame : function(){ - Ext.TaskMgr.stop(this.monitorTask); - var doc = this.getDoc(); - this.win = this.getWin(); + /* End Definitions */ - doc.open(); - doc.write(this.getDocMarkup()); - doc.close(); + /** + * @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. + */ - 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); - } - }, - interval : 10, - duration:10000, - scope: this - }; - Ext.TaskMgr.start(task); - }, + // private + monitorResize:false, + type: 'table', - checkDesignMode : function(){ - if(this.wrap && this.wrap.dom.offsetWidth){ - var doc = this.getDoc(); - if(!doc){ - return; - } - if(!doc.editorInitialized || this.getDesignMode() != 'on'){ - this.initFrame(); + // 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, + + 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', + + /** + * @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%' } } - }, + } +} + */ + tableAttrs:null, - /* private - * set current design mode. To enable, mode can be true or 'on', off otherwise + /** + * @private + * Iterates over all passed items, ensuring they are rendered in a cell in the proper + * location in the table structure. */ - setDesignMode : function(mode){ - var doc ; - if(doc = this.getDoc()){ - if(this.readOnly){ - mode = false; + 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]; + + // If no row present, create and insert one + trEl = rows[rowIdx]; + if (!trEl) { + trEl = tbody.insertRow(rowIdx); } - doc.designMode = (/on|true/i).test(String(mode).toLowerCase()) ?'on':'off'; - } - }, + // 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 - getDesignMode : function(){ - var doc = this.getDoc(); - if(!doc){ return ''; } - return String(doc.designMode).toLowerCase(); + // 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 || '') + }); - disableItems: function(disabled){ - if(this.fontSelect){ - this.fontSelect.dom.disabled = disabled; - } - this.tb.items.each(function(item){ - if(item.getItemId() != 'sourceedit'){ - item.setDisabled(disabled); + // 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); + } } - }); + } + + // Delete any extra rows + rowIdx++; + while (tbody.rows[rowIdx]) { + tbody.deleteRow(rowIdx); + } }, - // 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'; - } - } + 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()); + }); } }, /** - * Toggles the editor between standard and source edit mode. - * @param {Boolean} sourceEdit (optional) True for source edit, false for standard - */ - toggleSourceEdit : function(sourceEditMode){ - var iframeHeight, - elHeight; + * @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; - if (sourceEditMode === undefined) { - sourceEditMode = !this.sourceEditMode; - } - this.sourceEditMode = sourceEditMode === true; - var btn = this.tb.getComponent('sourceedit'); + for (; i < len; i++) { + item = items[i]; - if (btn.pressed !== this.sourceEditMode) { - btn.toggle(this.sourceEditMode); - if (!btn.xtbHidden) { - return; + // 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++; + } } - } - 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(); + // Add the cell info to the list + cells.push({ + rowIdx: rowIdx, + cellIdx: cellIdx + }); - 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'; + // Increment + rowspans[colIdx] = item.rowspan || 1; + colIdx += item.colspan || 1; + cellIdx++; } - 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); + return cells; }, - // private used internally - createLink : function() { - var url = prompt(this.createLinkText, this.defaultLinkValue); - if(url && url != 'http:/'+'/'){ - this.relayCmd('createlink', url); + /** + * @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; }, - // private - initEvents : function(){ - this.originalValue = this.getValue(); - }, + /** + * @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; + } +}); +/** + * @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 + * @param {Object} config The config object + */ +Ext.define('Ext.menu.Item', { + extend: 'Ext.Component', + alias: 'widget.menuitem', + alternateClassName: 'Ext.menu.TextItem', + /** - * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide - * @method + * @property {Boolean} activated + * Whether or not this item is currently activated */ - markInvalid : Ext.emptyFn, /** - * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide - * @method + * @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 */ - clearInvalid : Ext.emptyFn, - - // docs inherit from Field - setValue : function(v){ - Ext.form.HtmlEditor.superclass.setValue.call(this, v); - this.pushValue(); - return this; - }, - + activeCls: Ext.baseCSSPrefix + 'menu-item-active', + /** - * 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 + * @cfg {String} ariaRole @hide */ - cleanHtml: function(html) { - html = String(html); - if(Ext.isWebKit){ // strip safari nonsense - html = html.replace(/\sclass="(?:Apple-style-span|khtml-block-placeholder)"/gi, ''); + ariaRole: 'menuitem', + + /** + * @cfg {Boolean} canActivate + * Whether or not this menu item can be activated when focused/mouseovered. Defaults to `true`. + * @markdown + */ + canActivate: true, + + /** + * @cfg {Number} clickHideDelay + * The delay in milliseconds to wait before hiding the menu after clicking the menu item. + * This only has an effect when `hideOnClick: true`. Defaults to `1`. + * @markdown + */ + clickHideDelay: 1, + + /** + * @cfg {Boolean} destroyMenu + * Whether or not to destroy any associated sub-menu when this item is destroyed. Defaults to `true`. + */ + destroyMenu: true, + + /** + * @cfg {String} disabledCls + * The CSS class added to the menu item when the item is disabled. + * Defaults to `Ext.baseCSSPrefix + 'menu-item-disabled'`. + * @markdown + */ + disabledCls: Ext.baseCSSPrefix + 'menu-item-disabled', + + /** + * @cfg {String} href + * The href attribute to use for the underlying anchor link. Defaults to `#`. + * @markdown + */ + + /** + * @cfg {String} hrefTarget + * The target attribute to use for the underlying anchor link. Defaults to `undefined`. + * @markdown + */ + + /** + * @cfg {Boolean} hideOnClick + * Whether to not to hide the owning menu when this item is clicked. Defaults to `true`. + * @markdown + */ + hideOnClick: true, + + /** + * @cfg {String} icon + * The path to an icon to display in this item. Defaults to `Ext.BLANK_IMAGE_URL`. + * @markdown + */ + + /** + * @cfg {String} iconCls + * A CSS class that specifies a `background-image` to use as the icon for this item. Defaults to `undefined`. + * @markdown + */ + + isMenuItem: true, + + /** + * @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. + */ + + /** + * @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 + */ + menuAlign: 'tl-tr?', + + /** + * @cfg {Number} menuExpandDelay + * The delay in milliseconds before this item's sub-menu expands after this item is moused over. Defaults to `200`. + * @markdown + */ + menuExpandDelay: 200, + + /** + * @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 {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">', + '', + 'style="margin-right: 17px;" >{text}', + '', + '', + '', + '', + '' + ], + + maskOnDisable: false, + + /** + * @cfg {String} text + * The text/html to display in this item. Defaults to `undefined`. + * @markdown + */ + + 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); } - - /* - * 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); + }, + + 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 html; }, - + + 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); + } + }, + + deferHideMenu: function() { + if (this.menu.isVisible()) { + this.menu.hide(); + } + }, + + deferHideParentMenus: function() { + Ext.menu.Manager.hideAll(); + }, + + 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); + } + } + }, + + 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); + } + }, + + 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'); + } + + 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); + }, + + 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(); + } + }, + + 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(); + } + } + me.callParent(arguments); + }, + + 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); + }, + /** - * Protected method that will not generally be called directly. Syncs the contents - * of the editor iframe with the textarea. + * Sets the {@link #click} handler of this item + * @param {Function} fn The handler function + * @param {Object} scope (optional) The scope of the handler function */ - 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 + ''; - } + setHandler: function(fn, scope) { + this.handler = fn || null; + this.scope = scope; + }, + + /** + * Sets the {@link #iconCls} of this item + * @param {String} iconCls The CSS class to set to {@link #iconCls} + */ + setIconCls: function(iconCls) { + var me = this; + + if (me.iconEl) { + if (me.iconCls) { + me.iconEl.removeCls(me.iconCls); } - html = this.cleanHtml(html); - if(this.fireEvent('beforesync', this, html) !== false){ - this.el.dom.value = html; - this.fireEvent('sync', this, html); + + if (iconCls) { + me.iconEl.addCls(iconCls); } } + + me.iconCls = iconCls; }, - - //docs inherit from Field - getValue : function() { - this[this.sourceEditMode ? 'pushValue' : 'syncValue'](); - return Ext.form.HtmlEditor.superclass.getValue.call(this); - }, - + /** - * Protected method that will not generally be called directly. Pushes the value of the textarea - * into the iframe editor. + * Sets the {@link #text} of this item + * @param {String} text The {@link #text} */ - 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); + 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); } - this.fireEvent('push', this, v); } - + } else if (el) { + el.update(''); } - }, + + me.text = text; + } +}); - // private - deferFocus : function(){ - this.focus.defer(10, this); - }, +/** + * @class Ext.menu.CheckItem + * @extends Ext.menu.Item - // docs inherit from Field - focus : function(){ - if(this.win && !this.sourceEditMode){ - this.win.focus(); - }else{ - this.el.focus(); - } - }, +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 - 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; +Ext.define('Ext.menu.CheckItem', { + extend: 'Ext.menu.Item', + alias: 'widget.menucheckitem', - ss['background-attachment'] = 'fixed'; // w3c - dbody.bgProperties = 'fixed'; // ie + /** + * @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', - Ext.DomHelper.applyStyles(dbody, ss); + /** + * @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, - doc = this.getDoc(); + afterRender: function() { + var me = this; + this.callParent(); + me.checked = !me.checked; + me.setChecked(!me.checked, true); + }, - if(doc){ - try{ - Ext.EventManager.removeAll(doc); - }catch(e){} - } + 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', - /* - * 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. + /** + * @event checkchange + * Fires after a change event. + * @param {Ext.menu.CheckItem} this + * @param {Boolean} checked */ - fn = this.onEditorEvent.createDelegate(this); - Ext.EventManager.on(doc, { - mousedown: fn, - dblclick: fn, - click: fn, - keyup: fn, - buffer:100 - }); + 'checkchange' + ); - if(Ext.isGecko){ - Ext.EventManager.on(doc, 'keypress', this.applyCommand, this); - } - if(Ext.isIE || Ext.isWebKit || Ext.isOpera){ - Ext.EventManager.on(doc, 'keydown', this.fixKeys, this); - } - doc.editorInitialized = true; - this.initialized = true; - this.pushValue(); - this.setReadOnly(this.readOnly); - this.fireEvent('initialize', this); - }catch(e){} - }, + me.callParent(arguments); - // 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){} + Ext.menu.Manager.registerCheckable(me); + + if (me.group) { + if (!me.iconCls) { + me.iconCls = me.groupCls; } - if(this.wrap){ - this.wrap.dom.innerHTML = ''; - this.wrap.remove(); + if (me.initialConfig.hideOnClick !== false) { + me.hideOnClick = true; } } + }, - if(this.el){ - this.el.removeAllListeners(); - this.el.remove(); - } - this.purgeListeners(); + /** + * 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; }, - // 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(); - } - try{ - this.execCmd('useCSS', true); - this.execCmd('styleWithCSS', false); - }catch(e){} - } - this.fireEvent('activate', this); + /** + * 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; }, - // 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; - } - v = Math.max(1, v+adjust) + (Ext.isSafari ? 'px' : 0); + onClick: function(e) { + var me = this; + if(!me.disabled && !me.checkChangeDisabled && !(me.checked && me.group)) { + me.setChecked(!me.checked); } - this.execCmd('FontSize', v); + this.callParent([e]); }, - // private - onEditorEvent : function(e){ - this.updateToolbar(); + onDestroy: function() { + Ext.menu.Manager.unregisterCheckable(this); + this.callParent(arguments); }, - /** - * 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. + * 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 */ - updateToolbar: function(){ - - if(this.readOnly){ - return; + 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); + } } + } +}); - if(!this.activated){ - this.onFirstFocus(); - return; - } +/** + * @class Ext.menu.KeyNav + * @private + */ +Ext.define('Ext.menu.KeyNav', { + extend: 'Ext.util.KeyNav', - var btns = this.tb.items.map, - doc = this.getDoc(); + requires: ['Ext.FocusManager'], + + constructor: function(menu) { + var me = this; - 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')); - } + 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 + }]); + }, - Ext.menu.MenuMgr.hideAll(); + down: function(e) { + var me = this, + fi = me.menu.focusedItem; - this.syncValue(); + if (fi && e.getKey() == Ext.EventObject.DOWN && me.isWhitelisted(fi)) { + return true; + } + me.focusNextItem(1); }, - // private - relayBtnCmd : function(btn){ - this.relayCmd(btn.getItemId()); - }, + enter: function(e) { + var menu = this.menu; - /** - * 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); + if (menu.activeItem) { + menu.onClick(e); + } }, - /** - * 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(); + escape: function(e) { + Ext.menu.Manager.hideAll(); }, - // 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(); - } + focusNextItem: function(step) { + var menu = this.menu, + items = menu.items, + focusedItem = menu.focusedItem, + startIdx = focusedItem ? items.indexOf(focusedItem) : -1, + idx = startIdx + step; + + 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; } }, - /** - * 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; + isWhitelisted: function(item) { + return Ext.FocusManager.isWhitelisted(item); + }, + + left: function(e) { + var menu = this.menu, + fi = menu.focusedItem, + ai = menu.activeItem; + + if (fi && this.isWhitelisted(fi)) { + return true; } - if(Ext.isIE){ - this.win.focus(); - var doc = this.getDoc(), - r = doc.selection.createRange(); - if(r){ - r.pasteHTML(text); - this.syncValue(); - this.deferFocus(); - } - }else{ - this.win.focus(); - this.execCmd('InsertHTML', text); - this.deferFocus(); + + menu.hide(); + if (menu.parentMenu) { + menu.parentMenu.focus(); } }, - // 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(); - } - }; + right: function(e) { + var menu = this.menu, + fi = menu.focusedItem, + ai = menu.activeItem, + am; + + if (fi && this.isWhitelisted(fi)) { + return true; } - }(), - /** - * Returns the editor's toolbar. This is only available after the editor has been rendered. - * @return {Ext.Toolbar} - */ - getToolbar : function(){ - return this.tb; + if (ai) { + am = menu.activeItem.menu; + if (am) { + ai.expandMenu(0); + Ext.defer(function() { + am.setActiveItem(am.items.getAt(0)); + }, 25); + } + } }, - /** - * 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' + tab: function(e) { + var me = this; + + if (e.shiftKey) { + me.up(e); + } else { + me.down(e); + } }, - ... - - * @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' + + 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); } - - // 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 - */ +}); +/** + * @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 + */ +Ext.define('Ext.menu.Separator', { + extend: 'Ext.menu.Item', + alias: 'widget.menuseparator', + /** - * @cfg {Boolean} allowDomMove @hide + * @cfg {String} activeCls @hide */ + /** - * @cfg {String} applyTo @hide + * @cfg {Boolean} canActivate @hide */ + canActivate: false, + /** - * @cfg {String} autoHeight @hide + * @cfg {Boolean} clickHideDelay @hide */ + /** - * @cfg {String} autoWidth @hide + * @cfg {Boolean} destroyMenu @hide */ + /** - * @cfg {String} cls @hide + * @cfg {Boolean} disabledCls @hide */ + + focusable: false, + /** - * @cfg {String} disabled @hide + * @cfg {String} href @hide */ + /** - * @cfg {String} disabledClass @hide + * @cfg {String} hrefTarget @hide */ + /** - * @cfg {String} msgTarget @hide + * @cfg {Boolean} hideOnClick @hide */ + hideOnClick: false, + /** - * @cfg {String} readOnly @hide + * @cfg {String} icon @hide */ + /** - * @cfg {String} style @hide + * @cfg {String} iconCls @hide */ + /** - * @cfg {String} validationDelay @hide + * @cfg {Mixed} menu @hide */ + /** - * @cfg {String} validationEvent @hide + * @cfg {String} menuAlign @hide */ + /** - * @cfg {String} tabIndex @hide + * @cfg {Number} menuExpandDelay @hide */ + /** - * @property disabled - * @hide + * @cfg {Number} menuHideDelay @hide */ + /** - * @method applyToMarkup - * @hide + * @cfg {Boolean} plain @hide */ + plain: true, + /** - * @method disable - * @hide + * @cfg {String} separatorCls + * The CSS class used by the separator item to show the incised line. + * Defaults to `Ext.baseCSSPrefix + 'menu-item-separator'`. + * @markdown */ + separatorCls: Ext.baseCSSPrefix + 'menu-item-separator', + /** - * @method enable - * @hide + * @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' + ], + /** - * @method validate - * @hide + * @cfg {Boolean} allowOtherMenus + * True to allow multiple menus to be displayed at the same time. Defaults to `false`. + * @markdown */ + allowOtherMenus: false, + /** - * @event valid - * @hide + * @cfg {String} ariaRole @hide */ + ariaRole: 'menu', + /** - * @method setDisabled - * @hide + * @cfg {Boolean} autoRender @hide + * floating is true, so autoRender always happens */ + /** - * @cfg keys - * @hide + * @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 */ -}); -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: - * -new Ext.form.TimeField({ - minValue: '9:00 AM', - maxValue: '6:00 PM', - increment: 30 -}); - - * @constructor - * Create a new TimeField - * @param {Object} config - * @xtype timefield - */ -Ext.form.TimeField = Ext.extend(Ext.form.ComboBox, { + defaultAlign: 'tl-bl?', + /** - * @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). + * @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 */ - minValue : undefined, + floating: true, + /** - * @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). + * @cfg {Boolean} @hide + * Menu performs its own size changing constraining, so ensure Component's constraining is not applied */ - maxValue : undefined, + constrain: false, + /** - * @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}'). + * @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 */ - minText : "The time in this field must be equal to or after {0}", + hidden: true, + /** - * @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}'). + * @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 */ - maxText : "The time in this field must be equal to or before {0}", + ignoreParentClicks: false, + + isMenu: true, + /** - * @cfg {String} invalidText - * The error text to display when the time in the field is invalid (defaults to - * '{value} is not a valid time'). + * @cfg {String/Object} layout @hide */ - 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. + * @cfg {Boolean} showSeparator True to show the icon separator. (defaults to true). */ - format : "g:i A", + showSeparator : true, + /** - * @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'). + * @cfg {Number} minWidth + * The minimum width of the Menu. Defaults to `120`. + * @markdown */ - 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", + minWidth: 120, + /** - * @cfg {Number} increment - * The number of minutes between each time value in the list (defaults to 15). + * @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 */ - increment: 15, - // private override - mode: 'local', - // private override - triggerAction: 'all', - // private override - typeAhead: false, + initComponent: function() { + var me = this, + prefix = Ext.baseCSSPrefix, + cls = [prefix + 'menu'], + bodyCls = me.bodyCls ? [me.bodyCls] : []; + + me.addEvents( + /** + * @event click + * Fires when this menu is clicked + * @param {Ext.menu.Menu} menu The menu which has been clicked + * @param {Ext.Component} item The menu item that was clicked. `undefined` if not applicable. + * @param {Ext.EventObject} e The underlying {@link Ext.EventObject}. + * @markdown + */ + 'click', + + /** + * @event mouseenter + * Fires when the mouse enters this menu + * @param {Ext.menu.Menu} menu The menu + * @param {Ext.EventObject} e The underlying {@link Ext.EventObject} + * @markdown + */ + 'mouseenter', + + /** + * @event mouseleave + * Fires when the mouse leaves this menu + * @param {Ext.menu.Menu} menu The menu + * @param {Ext.EventObject} e The underlying {@link Ext.EventObject} + * @markdown + */ + 'mouseleave', + + /** + * @event mouseover + * Fires when the mouse is hovering over this menu + * @param {Ext.menu.Menu} menu The menu + * @param {Ext.Component} item The menu item that the mouse is over. `undefined` if not applicable. + * @param {Ext.EventObject} e The underlying {@link Ext.EventObject} + */ + 'mouseover' + ); + + Ext.menu.Manager.register(me); + + // Menu classes + if (me.plain) { + cls.push(prefix + 'menu-plain'); + } + me.cls = cls.join(' '); + + // Menu body classes + bodyCls.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' + }; + + // hidden defaults to false if floating is configured as false + if (me.floating === false && me.initialConfig.hidden !== true) { + me.hidden = false; + } + + me.callParent(arguments); - // 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', + 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; + }); + }, - initDateFormat: 'j/n/Y', + afterRender: function(ct) { + var me = this, + prefix = Ext.baseCSSPrefix, + space = ' '; - // private - initComponent : function(){ - if(Ext.isDefined(this.minValue)){ - this.setMinValue(this.minValue, true); + 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 + }); } - if(Ext.isDefined(this.maxValue)){ - this.setMaxValue(this.maxValue, true); + + me.focusEl = me.el.createChild({ + cls: prefix + 'menu-focus', + tabIndex: '-1', + html: space + }); + + me.mon(me.el, { + click: me.onClick, + mouseover: me.onMouseOver, + scope: me + }); + me.mouseMonitor = me.el.monitorMouseLeave(100, me.onMouseLeave, me); + + if (me.showSeparator && ((!Ext.isStrict && Ext.isIE) || Ext.isIE6)) { + me.iconSepEl.setHeight(me.el.getHeight()); } - if(!this.store){ - this.generateStore(true); + + me.keyNav = Ext.create('Ext.menu.KeyNav', me); + }, + + 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; + + 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); } - Ext.form.TimeField.superclass.initComponent.call(this); }, /** - * Replaces any existing {@link #minValue} with the new time and refreshes the store. - * @param {Date/String} value The minimum time that can be selected + * Returns whether a menu item can be activated or not. + * @return {Boolean} */ - setMinValue: function(value, /* private */ initial){ - this.setLimit(value, true, initial); - return this; + canActivateItem: function(item) { + return item && !item.isDisabled() && item.isVisible() && (item.canActivate || item.getXTypes().indexOf('menuitem') < 0); }, /** - * Replaces any existing {@link #maxValue} with the new time and refreshes the store. - * @param {Date/String} value The maximum time that can be selected + * Deactivates the current active item on the menu, if one exists. */ - setMaxValue: function(value, /* private */ initial){ - this.setLimit(value, false, initial); - return this; + deactivateActiveItem: function() { + var me = this; + + if (me.activeItem) { + me.activeItem.deactivate(); + if (!me.activeItem.activated) { + delete me.activeItem; + } + } + if (me.focusedItem) { + me.focusedItem.blur(); + if (!me.focusedItem.$focused) { + delete me.focusedItem; + } + } + }, + + // inherit docs + getFocusEl: function() { + return this.focusEl; + }, + + // inherit docs + hide: function() { + this.deactivateActiveItem(); + this.callParent(arguments); }, // 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 = []; + getItemFromEvent: function(e) { + return this.getChildByElement(e.getTarget()); + }, - while(min <= max){ - times.push(min.dateFormat(this.format)); - min = min.add('mi', this.increment); + lookupComponent: function(cmp) { + var me = this; + + if (Ext.isString(cmp)) { + cmp = me.lookupItemFromString(cmp); + } else if (Ext.isObject(cmp)) { + cmp = me.lookupItemFromObject(cmp); } - this.bindStore(times, initial); + + // 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 - 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(); + lookupItemFromObject: function(cmp) { + var me = this, + prefix = Ext.baseCSSPrefix, + cls, + intercept; + + 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); } } - }, - // inherited docs - getValue : function(){ - var v = Ext.form.TimeField.superclass.getValue.call(this); - return this.formatDate(this.parseDate(v)) || ''; - }, + if (cmp.isMenuItem) { + cmp.parentMenu = me; + } - // inherited docs - setValue : function(value){ - return Ext.form.TimeField.superclass.setValue.call(this, this.formatDate(this.parseDate(value))); + if (!cmp.isMenuItem && !cmp.dock) { + 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'); + } + + if (cmp.rendered) { + cmp.el.addCls(cls); + } else { + cmp.cls = (cmp.cls ? cmp.cls : '') + ' ' + cls.join(' '); + } + cmp.isMenuItem = true; + } + return cmp; }, - // private overrides - validateValue : Ext.form.DateField.prototype.validateValue, + // private + lookupItemFromString: function(cmp) { + return (cmp == 'separator' || cmp == '-') ? + Ext.createWidget('menuseparator') + : Ext.createWidget('menuitem', { + canActivate: false, + hideOnClick: false, + plain: true, + text: cmp + }); + }, - formatDate : Ext.form.DateField.prototype.formatDate, + onClick: function(e) { + var me = this, + item; - parseDate: function(value) { - if (!value || Ext.isDate(value)) { - return value; + if (me.disabled) { + e.stopEvent(); + return; } - 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; + if ((e.getTarget() == me.focusEl.dom) || e.within(me.layout.getRenderTarget())) { + item = me.getItemFromEvent(e) || me.activeItem; - 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]); + if (item) { + if (item.getXTypes().indexOf('menuitem') >= 0) { + if (!item.menu || !me.ignoreParentClicks) { + item.onClick(e); + } else { + e.stopEvent(); + } + } } + me.fireEvent('click', me, item, e); } + }, - return v; - } -}); -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. - * @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 - */ -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, - - /** - * @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, - - // private override - actionMode: 'wrap', - - /** - * Initialize the component. - * @private - */ - 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)]; + onDestroy: function() { + var me = this; + + Ext.menu.Manager.unregister(me); + if (me.rendered) { + me.el.un(me.mouseMonitor); + me.keyNav.destroy(); + delete me.keyNav; } - this.slider = new Ext.Slider(cfg); - Ext.form.SliderField.superclass.initComponent.call(this); - }, - - /** - * 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 - */ - 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); - }, - - /** - * 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 - */ - onResize : function(w, h, aw, ah){ - Ext.form.SliderField.superclass.onResize.call(this, w, h, aw, ah); - this.slider.setSize(w, h); - }, - - /** - * Initialize any events for this class. - * @private - */ - initEvents : function(){ - Ext.form.SliderField.superclass.initEvents.call(this); - this.slider.on('change', this.onChange, this); - }, - - /** - * 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 - */ - onChange : function(slider, v){ - this.setValue(v, undefined, true); + me.callParent(arguments); }, - - /** - * Enable the slider when the field is enabled. - * @private - */ - onEnable : function(){ - Ext.form.SliderField.superclass.onEnable.call(this); - this.slider.enable(); + + onMouseLeave: function(e) { + var me = this; + + me.deactivateActiveItem(); + + if (me.disabled) { + return; + } + + me.fireEvent('mouseleave', me, e); }, - - /** - * Disable the slider when the field is disabled. - * @private - */ - onDisable : function(){ - Ext.form.SliderField.superclass.onDisable.call(this); - this.slider.disable(); + + 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); }, - - /** - * Ensure the slider is destroyed when the field is destroyed. - * @private - */ - beforeDestroy : function(){ - Ext.destroy(this.slider); - Ext.form.SliderField.superclass.beforeDestroy.call(this); + + 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()); + } }, - + /** - * If a side icon is shown, do alignment to the slider - * @private + * 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 */ - alignErrorIcon : function(){ - this.errorIcon.alignTo(this.slider.el, 'tl-tr', [2, 0]); + showBy: function(cmp, pos, off) { + var me = this, + xy, + region; + + 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. + xy = me.el.getAlignToXY(cmp, pos || me.defaultAlign, off); + if (me.floatParent) { + region = me.floatParent.getTargetEl().getViewRegion(); + xy[0] -= region.x; + xy[1] -= region.y; + } + me.showAt(xy); + } + return me; }, - /** - * Sets the minimum field value. - * @param {Number} v The new minimum value. - * @return {Ext.form.SliderField} this - */ - setMinValue : function(v){ - this.slider.setMinValue(v); - return this; + // inherit docs + showAt: function(){ + this.callParent(arguments); + if (this.floating) { + this.doConstrain(); + } }, - + + doConstrain : function() { + var me = this, + y = me.el.getY(), + max, full, + vector, + 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); + } + } + vector = me.getConstrainVector(); + if (vector) { + me.setPosition(me.getPosition()[0] + vector[0]); + } + 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' + ], + /** - * Sets the maximum field value. - * @param {Number} v The new maximum value. - * @return {Ext.form.SliderField} this + * @cfg {Boolean} hideOnClick + * False to continue showing the menu after a date is selected, defaults to true. */ - setMaxValue : function(v){ - this.slider.setMaxValue(v); - return this; - }, - + hideOnClick : true, + /** - * 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} pickerId + * An id to assign to the underlying color picker. Defaults to null. */ - 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()); - }, - + pickerId : null, + /** - * Gets the current value for this field. - * @return {Number} The current value. + * @cfg {Number} maxHeight + * @hide */ - 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, { /** - * @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. + * The {@link Ext.picker.Color} instance for this ColorMenu + * @property picker + * @type ColorPicker */ + /** - * @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. + * @event click + * @hide */ + /** - * @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. + * @event itemclick + * @hide */ - // 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); - } + 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); } - 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 + * Hides picker on select if hideOnClick is true + * @private */ - 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; - } - return this; + 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.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.create('Ext.menu.Menu', { + width: 100, + height: 90, + floating: false, // usually you want this set to True (default) + renderTo: Ext.getBody(), // usually rendered by it's containing component + items: [{ + text: 'choose a date', + menu: dateMenu + },{ + iconCls: 'add16', + text: 'icon item' + },{ + text: 'regular item' + }] + }); -Ext.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. + * @xtype datemenu + * @author Nicolas Ferrero */ + Ext.define('Ext.menu.DatePicker', { + extend: 'Ext.menu.Menu', -/** - * @cfg {Boolean} submitEmptyText If set to true, the emptyText value will be sent with the form - * when it is submitted. Defaults to true. - */ + alias: 'widget.datemenu', -/** - * 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); - } - } - }); - } - } -},{ - 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} - */ + requires: [ + 'Ext.picker.Date' + ], - // interface method - run : function(options){ + /** + * @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, - // interface method - success : function(response){ + /** + * @cfg {Number} maxHeight + * @hide + */ - }, + /** + * The {@link Ext.picker.Date} instance for this DateMenu + * @property picker + * @type Ext.picker.Date + */ - // interface method - handleResponse : function(response){ + /** + * @event click + * @hide + */ - }, + /** + * @event itemclick + * @hide + */ - // default connection failure - failure : function(response){ - this.response = response; - this.failureType = Ext.form.Action.CONNECT_FAILURE; - this.form.afterAction(this, false); - }, + initComponent : function(){ + var me = this; - // 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; - } - this.result = this.handleResponse(response); - return this.result; - }, + Ext.apply(me, { + showSeparator: false, + plain: true, + items: Ext.applyIf({ + cls: Ext.baseCSSPrefix + 'menu-date-item', + id: me.pickerId, + xtype: 'datepicker' + }, me.initialConfig) + }); - // 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); - } - } - return url; - }, + me.callParent(arguments); - // private - getMethod : function(){ - return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase(); - }, + 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']); - // 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); + if (me.hideOnClick) { + me.on('select', me.hidePickerOnSelect, me); } - return p; }, - // 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 - }; + hidePickerOnSelect: function() { + Ext.menu.Manager.hideAll(); } -}; - + }); /** - * @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); -}; + * @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(); + } + }] + }); -Ext.extend(Ext.form.Action.Submit, Ext.form.Action, { + * @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 {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 {Object} scope + * The scope to execute the {@link #handler} function. Defaults to the tool. + */ + + /** + * @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 {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. + * @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 {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. + * @cfg {Boolean} stopEvent + * Defaults to true. Specify as false to allow click event to propagate. */ - type : 'submit', + stopEvent: true, - // 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 = ""; - } - }); - } - 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(); - } - }); - } - }else if (o.clientValidation !== false){ // client validation failed - this.failureType = Ext.form.Action.CLIENT_INVALID; - this.form.afterAction(this, false); + 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) { + 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; - // 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); + Ext.applyIf(me.renderData, { + baseCls: me.baseCls, + blank: Ext.BLANK_IMAGE_URL, + type: me.type + }); + me.renderSelectors.toolEl = '.' + me.baseCls + '-' + me.type; + me.callParent(); }, - // 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; - } + // 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)); } - if(errors.length < 1){ - errors = null; + else { + me.toolEl.dom.qtip = me.qtip; } - return { - success : rs.success, - errors : errors - }; } - return Ext.decode(response.responseText); - } -}); - -/** - * @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 + me.mon(me.toolEl, { + click: me.onClick, + mousedown: me.onMouseDown, + mouseover: me.onMouseOver, + mouseout: me.onMouseOut, + scope: me + }); }, - 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; -}; - -Ext.extend(Ext.form.Action.Load, Ext.form.Action, { - // private - type : 'load', - // 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() - })); + /** + * 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; }, - // 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); + /** + * Binds this tool to a component. + * @private + * @param {Ext.Component} component The component + */ + bindTo: function(component) { + this.owner = component; }, - // 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 - }; + /** + * 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; } - return Ext.decode(response.responseText); - } -}); - + owner = me.owner || me.ownerCt; + //remove the pressed + over class + me.el.removeCls(me.toolPressedCls); + me.el.removeCls(me.toolOverCls); -/** - * @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, - - // configs apply to child items - defaults: {anchor: '100%'}, - defaultType: 'textfield', - items: [{ - fieldLabel: 'Name', - name: 'name' - },{ - fieldLabel: 'Email', - name: 'email' - },{ - fieldLabel: 'Company', - name: 'company' - }], + if (me.stopEvent !== false) { + e.stopEvent(); + } - // 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 + 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(); }, - // specify the order for the passed params - paramOrder: ['uid', 'foo'] -}); -// 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" - } + /** + * 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; } - } -] - * - */ -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); + this.el.addCls(this.toolPressedCls); }, - 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); + /** + * Called when the user rolls over a tool + * Adds the over class ({@link #toolOverCls}) + * @private + */ + onMouseOver: function() { + if (this.disabled) { + return false; } - return buf; - }, - // 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; + this.el.addCls(this.toolOverCls); }, - success : function(response, trans){ - if(trans.type == Ext.Direct.exceptions.SERVER){ - response = {}; - } - Ext.form.Action.DirectLoad.superclass.success.call(this, response); + /** + * Called when the user rolls out from a tool. + * Removes the over class ({@link #toolOverCls}) + * @private + */ + onMouseOut: function() { + this.el.removeCls(this.toolOverCls); } }); - /** - * @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 - } - }); - } - }], - - // configs apply to child items - defaults: {anchor: '100%'}, - defaultType: 'textfield', - items: [{ - fieldLabel: 'Name', - name: 'name' - },{ - fieldLabel: 'Email', - name: 'email' - },{ - fieldLabel: 'Company', - name: 'company' - }], - - // configs for BasicForm - api: { - // The server-side method to call for load() requests - load: Profile.getBasicInfo, - // The server-side must mark the submit handler as a 'formHandler' - submit: Profile.updateBasicInfo - }, - // specify the order for the passed params - paramOrder: ['uid', 'foo'] -}); - * - * The 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" - } -} - * - * Also see the discussion in {@link Ext.form.Action.DirectLoad}. + * @class Ext.resizer.Handle + * @extends Ext.Component + * + * Provides a handle for 9-point resizing of Elements or Components. */ -Ext.form.Action.DirectSubmit = Ext.extend(Ext.form.Action.Submit, { - constructor : function(form, opts) { - Ext.form.Action.DirectSubmit.superclass.constructor.call(this, form, opts); - }, - 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; - }, - // 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; - }, - - success : function(response, trans){ - if(trans.type == Ext.Direct.exceptions.SERVER){ - response = {}; - } - Ext.form.Action.DirectSubmit.superclass.success.call(this, response); +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(); } }); -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); - }, - // 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: + * @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: * -// 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); + + + 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' }, - 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, - - /** - * 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"', + uses: ['Ext.resizer.ResizeTracker', 'Ext.Component'], - /** - * 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, + alternateClassName: 'Ext.Resizable', - /** - * 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, + 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', -// 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'; - } - } - }, - {@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' -}); - * - * 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. - * - * @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, - /** - * @cfg {Number} autoExpandMin The minimum width the {@link #autoExpandColumn} - * can have (if enabled). Defaults to 50. - */ - autoExpandMin : 50, - /** - * @cfg {Boolean} columnLines true to add css for column separation lines. - * Default is false. - */ - columnLines : false, - /** - * @cfg {Object} cm Shorthand for {@link #colModel}. - */ - /** - * @cfg {Object} colModel The {@link Ext.grid.ColumnModel} to use when rendering the grid (required). - */ - /** - * @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 {String} ddGroup The DD group this GridPanel belongs to. Defaults to 'GridDD' if not specified. + * @cfg {Boolean} dynamic + * Specify as true to update the {@link #target} (Element or {@link Ext.Component Component}) dynamically during dragging. + * This is true by default, but the {@link Ext.Component Component} class passes false when it + * is configured as {@link Ext.Component#resizable}. + * If specified as false, a proxy element is displayed during the resize operation, and the {@link #target} + * is updated on mouseup. */ + dynamic: true, + /** - * @cfg {String} 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} 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'. */ - ddText : '{0} selected row{1}', + handles: 's e se', + /** - * @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 {Number} height Optional. The height to set target to in pixels (defaults to null) */ - deferRowRender : true, + height : null, + /** - * @cfg {Boolean} disableSelection true to disable selections in the grid. Defaults to false. - * Ignored if a {@link #selModel SelectionModel} is specified. + * @cfg {Number} width Optional. The width to set the target to in pixels (defaults to null) */ + width : null, + /** - * @cfg {Boolean} enableColumnResize false to turn off column resizing for the whole grid. Defaults to true. + * @cfg {Number} minHeight The minimum height for the element (defaults to 20) */ + minHeight : 20, + /** - * @cfg {Boolean} enableColumnHide - * Defaults to true to enable {@link Ext.grid.Column#hidden hiding of columns} - * with the {@link #enableHdMenu header menu}. + * @cfg {Number} minWidth The minimum width for the element (defaults to 20) */ - enableColumnHide : true, + minWidth : 20, + /** - * @cfg {Boolean} enableColumnMove Defaults to true to enable drag and drop reorder of columns. false - * to turn off column reordering via drag drop. + * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000) */ - enableColumnMove : true, + maxHeight : 10000, + /** - * @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} maxWidth The maximum width for the element (defaults to 10000) */ - enableDragDrop : false, + maxWidth : 10000, + /** - * @cfg {Boolean} enableHdMenu Defaults to true to enable the drop down button for menu in the headers. + * @cfg {Boolean} pinned True to ensure that the resize handles are always + * visible, false indicates resizing by cursor changes only (defaults to false) */ - enableHdMenu : true, + pinned: false, + /** - * @cfg {Boolean} hideHeaders True to hide the grid's header. Defaults to false. + * @cfg {Boolean} preserveRatio True to preserve the original ratio between height + * and width during resize (defaults to false) */ + preserveRatio: false, + /** - * @cfg {Object} loadMask An {@link Ext.LoadMask} config or true to mask the grid while - * loading. Defaults to false. + * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false) */ - loadMask : false, + transparent: false, + /** - * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if autoHeight is not on. + * @cfg {Mixed} constrainTo Optional. An element, or a {@link Ext.util.Region} into which the resize operation + * must be constrained. */ + + possiblePositions: { + n: 'north', + s: 'south', + e: 'east', + w: 'west', + se: 'southeast', + sw: 'southwest', + nw: 'northwest', + ne: 'northeast' + }, + /** - * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Defaults to 25. + * @cfg {Mixed} target The Element or Component to resize. */ - minColumnWidth : 25, + /** - * @cfg {Object} sm Shorthand for {@link #selModel}. + * Outer element for resizing behavior. + * @type Ext.core.Element + * @property el */ + + constructor: function(config) { + var me = this, + target, + tag, + handles = me.handles, + handleCls, + possibles, + len, + i = 0, + pos; + + this.addEvents( + /** + * @event beforeresize + * Fired before resize is allowed. Return false to cancel resize. + * @param {Ext.resizer.Resizer} this + * @param {Number} width The start width + * @param {Number} height The start height + * @param {Ext.EventObject} e The mousedown event + */ + 'beforeresize', + /** + * @event resizedrag + * Fires during resizing. Return false to cancel resize. + * @param {Ext.resizer.Resizer} this + * @param {Number} width The new width + * @param {Number} height The new height + * @param {Ext.EventObject} e The mousedown event + */ + 'resizedrag', + /** + * @event resize + * Fired after a resize. + * @param {Ext.resizer.Resizer} this + * @param {Number} width The new width + * @param {Number} height The new height + * @param {Ext.EventObject} e The mouseup event + */ + 'resize' + ); + + if (Ext.isString(config) || Ext.isElement(config) || config.dom) { + target = config; + config = arguments[1] || {}; + config.target = target; + } + // will apply config to this + me.mixins.observable.constructor.call(me, config); + + // If target is a Component, ensure that we pull the element out. + // Resizer must examine the underlying Element. + target = me.target; + if (target) { + if (target.isComponent) { + 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); + } + + // 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); + } + + // 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); + } + + /** + * @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'; + } + + 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); + } + } + } + + // Constrain within configured maxima + if (Ext.isNumber(me.width)) { + me.width = Ext.Number.constrain(me.width, me.minWidth, me.maxWidth); + } + if (Ext.isNumber(me.height)) { + me.height = Ext.Number.constrain(me.height, me.minHeight, me.maxHeight); + } + + // Size the 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); + } + + me.forceHandlesHeight(); + }, + + disable: function() { + this.resizeTracker.disable(); + }, + + enable: function() { + this.resizeTracker.enable(); + }, + /** - * @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). + * @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); + }, + /** - * @cfg {Ext.data.Store} store The {@link Ext.data.Store} the grid should use as its data source (required). + * @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); + }, + /** - * @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. + * @private Relay the Tracker's dragend event as resize + * @param tracker The Resizer + * @param e The Event */ - stripeRows : false, + onResizeEnd: function(tracker, e) { + var me = this, + b = me.target.getBox(); + me.forceHandlesHeight(); + return me.fireEvent('resize', me, b.width, b.height, e); + }, + /** - * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is true - * for GridPanel, but false for EditorGridPanel. + * Perform a manual resize and fires the 'resize' event. + * @param {Number} width + * @param {Number} height */ - trackMouseOver : true, + resizeTo : function(width, height){ + this.target.setSize(width, height); + this.fireEvent('resize', this, width, height, null); + }, + /** - * @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. + * 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 */ - stateEvents : ['columnmove', 'columnresize', 'sortchange', 'groupchange'], + getEl : function() { + return this.el; + }, + /** - * @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()}. + * 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} */ - view : null, + getTarget: function() { + return this.target; + }, + + 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); + } + }, /** - * @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 []. + * @private + * Fix IE6 handle height issue. */ - bubbleEvents: [], + 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(); + } + } +}); + +/** + * @class Ext.resizer.ResizeTracker + * @extends Ext.dd.DragTracker + */ +Ext.define('Ext.resizer.ResizeTracker', { + extend: 'Ext.dd.DragTracker', + dynamic: true, + preserveRatio: false, + + // Default to no constraint + constrainTo: null, + + 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); + + // 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(); + + // 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); + } + }; + } + }, + + onBeforeStart: function(e) { + // record the startBox + this.startBox = this.el.getBox(); + }, /** - * @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. + * @private + * Returns the object that will be resized on every mousemove event. + * If dynamic is false, this will be a proxy, otherwise it will be our actual target. */ + getDynamicTarget: function() { + var 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'); + } + this.proxy.show(); + return this.proxy; + }, - // private - rendered : false, - // private - viewReady : false, + onStart: function(e) { + // returns the Ext.ResizeHandle that the user started dragging + this.activeResizeHandle = Ext.getCmp(this.getDragTarget().id); - // private - initComponent : function(){ - Ext.grid.GridPanel.superclass.initComponent.call(this); + // 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); + } + } + } + + if (heightAdjust === 0) { + vertDir = 'none'; + } + if (widthAdjust === 0) { + horizDir = 'none'; + } + me.resize(newBox, { + horizontal: horizDir, + vertical: vertDir + }, atEnd); + }, + + getResizeTarget: function(atEnd) { + return atEnd ? this.target : this.getDynamicTarget(); + }, + + resize: function(box, direction, atEnd) { + var 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); + } + } + }, + + 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, + + overlayCls: Ext.baseCSSPrefix + 'resizable-overlay', + + 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 me = this, + prevCmp = me.getPrevCmp(), + nextCmp = me.getNextCmp(); - if(this.columnLines){ - this.cls = (this.cls || '') + ' x-grid-with-col-lines'; + // SplitterTracker is disabled if any of its adjacents are collapsed. + if (nextCmp.collapsed || prevCmp.collapsed) { + return false; } - // override any provided value since it isn't valid - // and is causing too many bug reports ;) - this.autoScroll = false; - this.autoWidth = false; + // store boxes of previous and next + me.prevBox = prevCmp.getEl().getBox(); + me.nextBox = nextCmp.getEl().getBox(); + me.constrainTo = me.calculateConstrainRegion(); + }, - if(Ext.isArray(this.columns)){ - this.colModel = new Ext.grid.ColumnModel(this.columns); - delete this.columns; + // We move the splitter el. Add the proxy class. + onStart: function(e) { + var splitter = this.getSplitter(), + overlay; + + splitter.addCls(splitter.baseCls + '-active'); + overlay = this.overlay = Ext.getBody().createChild({ + cls: this.overlayCls, + html: ' ' + }); + overlay.unselectable(); + overlay.setSize(Ext.core.Element.getViewWidth(true), Ext.core.Element.getViewHeight(true)); + overlay.show(); + }, + + // calculate the constrain Region in which the splitter el may be moved. + calculateConstrainRegion: function() { + var me = this, + splitter = me.getSplitter(), + splitWidth = splitter.getWidth(), + defaultMin = splitter.defaultSplitMin, + orient = splitter.orientation, + prevBox = me.prevBox, + prevCmp = me.getPrevCmp(), + nextBox = me.nextBox, + nextCmp = me.getNextCmp(), + // prev and nextConstrainRegions are the maximumBoxes minus the + // minimumBoxes. The result is always the intersection + // of these two boxes. + prevConstrainRegion, nextConstrainRegion; + + // 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 + ); } - // check and correct shorthanded configs - if(this.ds){ - this.store = this.ds; - delete this.ds; + // intersection of the two regions to provide region draggable + return prevConstrainRegion.intersect(nextConstrainRegion); + }, + + // Performs the actual resizing of the previous and next components + performResize: function(e) { + var me = this, + offset = me.getOffset('dragTarget'), + splitter = me.getSplitter(), + orient = splitter.orientation, + prevCmp = me.getPrevCmp(), + nextCmp = me.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(me.prevBox.width + offset[0], prevCmp.getHeight()); + } + } + if (nextCmp) { + if (!nextCmp.maintainFlex) { + delete nextCmp.flex; + nextCmp.setSize(me.nextBox.width - offset[0], nextCmp.getHeight()); + } + } + // verticals + } else { + if (prevCmp) { + if (!prevCmp.maintainFlex) { + delete prevCmp.flex; + prevCmp.setSize(prevCmp.getWidth(), me.prevBox.height + offset[1]); + } + } + if (nextCmp) { + if (!nextCmp.maintainFlex) { + delete nextCmp.flex; + nextCmp.setSize(prevCmp.getWidth(), me.nextBox.height - offset[1]); + } + } } - if(this.cm){ - this.colModel = this.cm; - delete this.cm; + delete owner.suspendLayout; + layout.onLayout(); + }, + + // perform the resize and remove the proxy class from the splitter el + onEnd: function(e) { + var me = this, + splitter = me.getSplitter(); + + splitter.removeCls(splitter.baseCls + '-active'); + if (me.overlay) { + me.overlay.remove(); + delete me.overlay; } - if(this.sm){ - this.selModel = this.sm; - delete this.sm; + me.performResize(); + }, + + // Track the proxy and set the proper XY coordinates + // while constraining the drag + onDrag: function(e) { + var me = this, + offset = me.getOffset('dragTarget'), + splitter = me.getSplitter(), + splitEl = splitter.getEl(), + orient = splitter.orientation; + + if (orient === "vertical") { + splitEl.setX(me.startRegion.left + offset[0]); + } else { + splitEl.setY(me.startRegion.top + offset[1]); } - this.store = Ext.StoreMgr.lookup(this.store); + }, + + 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'], + + /** + * @cfg {Boolean} enableKeyNav + * Turns on/off keyboard navigation within the grid. Defaults to true. + */ + 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( - // 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 + * @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 */ - 'keypress', + 'deselect', + /** - * @event keydown - * The raw keydown event for the entire grid. - * @param {Ext.EventObject} e + * @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 */ - 'keydown', + 'select' + ); + this.callParent(arguments); + }, - // 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', + 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 + }); - /** - * @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', + if (me.enableKeyNav) { + me.initKeyNav(view); + } + }, - /** - * @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', + initKeyNav: function(view) { + var me = this; + + if (!view.rendered) { + view.on('render', Ext.Function.bind(me.initKeyNav, me, [view], 0), me, {single: true}); + return; + } - /** - * @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', + view.el.set({ + tabIndex: -1 + }); - /** - * @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', + // 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; + }, - /** - * @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', + onKeyUp: function(e, t) { + this.move('up', e); + }, + 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; + }, + + /** + * Returns the current position in the format {row: row, column: column} + */ + getCurrentPosition: function() { + return this.position; + }, + + /** + * Sets the current position + * @param {Object} position The position to set. + */ + setCurrentPosition: function(pos) { + var me = this; + + if (me.position) { + me.onCellDeselect(me.position); + } + if (pos) { + me.onCellSelect(pos); + } + me.position = pos; + }, + + /** + * Set the current position based on where the user clicks. + * @private + */ + 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); + }, + + onKeyTab: function(e, t) { + var me = this, + direction = e.shiftKey ? 'left' : 'right', + editingPlugin = me.view.editingPlugin, + position = me.move(direction, e); + + if (editingPlugin && position && me.wasEditing) { + editingPlugin.startEditByPosition(position); + } + delete me.wasEditing; + }, + + 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; + } + }, + + refresh: function() { + var pos = this.getCurrentPosition(); + if (pos) { + this.onCellSelect(pos); + } + }, + + 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 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', - /** - * @event sortchange - * Fires when the grid's store sort changes - * @param {Grid} this - * @param {Object} sortInfo An object with the keys field and direction - */ - 'sortchange', - /** - * @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. - */ - 'groupchange', - /** - * @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 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 */ - 'reconfigure', + 'deselect', + /** - * @event viewready - * Fires when the grid view is available (use this for selecting a default row). - * @param {Grid} this + * @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 */ - 'viewready' + 'select' ); + this.callParent(arguments); }, - // private - onRender : function(ct, position){ - Ext.grid.GridPanel.superclass.onRender.apply(this, 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 + }); - var c = this.getGridEl(); + if (me.enableKeyNav) { + me.initKeyNav(view); + } + }, - this.el.addClass('x-grid-panel'); + initKeyNav: function(view) { + var me = this; + + if (!view.rendered) { + view.on('render', Ext.Function.bind(me.initKeyNav, me, [view], 0), me, {single: true}); + return; + } - this.mon(c, { - scope: this, - mousedown: this.onMouseDown, - click: this.onClick, - dblclick: this.onDblClick, - contextmenu: this.onContextMenu + view.el.set({ + tabIndex: -1 }); - this.relayEvents(c, ['mousedown','mouseup','mouseover','mouseout','keypress', 'keydown']); - - var view = this.getView(); - view.init(this); - view.render(); - this.getSelectionModel().init(this); + // 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 - initEvents : function(){ - Ext.grid.GridPanel.superclass.initEvents.call(this); + // 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(this.loadMask){ - this.loadMask = new Ext.LoadMask(this.bwrap, - Ext.apply({store:this.store}, this.loadMask)); + if (row) { + rowHeight = Ext.fly(row).getHeight(); + gridViewHeight = view.el.getHeight(); + rowsVisible = Math.floor(gridViewHeight / rowHeight); } - }, - initStateEvents : function(){ - Ext.grid.GridPanel.superclass.initStateEvents.call(this); - this.mon(this.colModel, 'hiddenchange', this.saveState, this, {delay: 100}); + return rowsVisible; }, - applyState : function(state){ - var cm = this.colModel, - cs = state.columns, - store = this.store, - s, - c, - oldIndex; - - 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(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(); - } + // 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); } - } - var o = Ext.apply({}, state); - delete o.columns; - delete o.sort; - Ext.grid.GridPanel.superclass.applyState.call(this, o); }, - getState : function(){ - var o = {columns: []}, - store = this.store, - ss, - gs; - - 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; + // 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); } } - if(store){ - ss = store.getSortState(); - if(ss){ - o.sort = ss; + }, + + // 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; } - if(store.getGroupState){ - gs = store.getGroupState(); - if(gs){ - o.group = gs; - } + 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); } + } - 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(); + // 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); + } } - this.viewReady = true; }, - /** - * 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 - */ - 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)); + // 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); + } } } - if(this.view){ - this.view.initData(store, colModel); - } - this.store = store; - this.colModel = colModel; - if(rendered){ - this.view.refresh(true); - } - 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(); + // 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); + } } - Ext.destroy(this.colModel, this.selModel); - this.store = this.selModel = this.colModel = this.view = this.loadMask = null; - Ext.grid.GridPanel.superclass.onDestroy.call(this); + // 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); + //} }, - // private - processEvent : function(name, e){ - this.view.processEvent(name, e); + // 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); + } + } }, - - // private - onClick : function(e){ - this.processEvent('click', e); + + scrollByDeltaX: function(delta) { + var view = this.views[0], + section = view.up(), + hScroll = section.horizontalScroller; + + if (hScroll) { + hScroll.scrollByDeltaX(delta); + } }, - - // private - onMouseDown : function(e){ - this.processEvent('mousedown', e); + + onKeyLeft: function(e, t) { + this.scrollByDeltaX(-this.deltaScroll); }, - - // private - onContextMenu : function(e, t){ - this.processEvent('contextmenu', e); + + onKeyRight: function(e, t) { + this.scrollByDeltaX(this.deltaScroll); }, - // private - onDblClick : function(e){ - this.processEvent('dblclick', e); + // 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); }, - // 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; - } - 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--; - } - } else { - if(col >= clen){ - row++; - first = false; - } - while(row < rlen){ - if(!first){ - col = 0; + // 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); } - first = false; - while(col < clen){ - if(fn.call(scope || this, row, col, cm) === true){ - return [row, col]; - } - col++; + } else { + views[i].onRowDeselect(rowIdx, suppressEvent); + if (!suppressEvent) { + me.fireEvent('deselect', me, record, rowIdx); } - row++; } } - return null; - }, - - /** - * Returns the grid's underlying element. - * @return {Element} The element - */ - getGridEl : function(){ - return this.body; }, - // private for compatibility, overridden by editor grid - stopEditing : Ext.emptyFn, - - /** - * 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); + // 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); + } + } } - return this.selModel; - }, - /** - * Returns the grid's data store. - * @return {Ext.data.Store} The store - */ - getStore : function(){ - return this.store; - }, - - /** - * Returns the grid's ColumnModel. - * @return {Ext.grid.ColumnModel} The column model - */ - getColumnModel : function(){ - return this.colModel; + if (newFocused) { + rowIdx = store.indexOf(newFocused); + if (rowIdx != -1) { + for (i = 0; i < viewsLn; i++) { + views[i].onRowFocus(rowIdx, true, supressFocus); + } + } + } }, - - /** - * Returns the grid's GridView object. - * @return {Ext.grid.GridView} The grid view - */ - getView : function(){ - if(!this.view){ - this.view = new Ext.grid.GridView(this.viewConfig); + + 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); } - return this.view; }, - /** - * 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'); + + selectByPosition: function(position) { + var record = this.store.getAt(position.row); + this.select(record); } - - /** - * @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 - */ - /** - * @method findByType - * @hide - */ - /** - * @method getComponent - * @hide - */ - /** - * @method getLayout - * @hide - */ - /** - * @method getUpdater - * @hide - */ - /** - * @method insert - * @hide - */ - /** - * @method load - * @hide - */ - /** - * @method remove - * @hide - */ - /** - * @event add - * @hide - */ - /** - * @event afterlayout - * @hide - */ - /** - * @event beforeadd - * @hide - */ - /** - * @event beforeremove - * @hide - */ - /** - * @event remove - * @hide - */ - - - - /** - * @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 {String} contentEl @hide - */ - /** - * @cfg {String} disabledClass @hide - */ - /** - * @cfg {String} elements @hide - */ - /** - * @cfg {String} html @hide - */ - /** - * @cfg {Boolean} preventBodyReset - * @hide - */ - /** - * @property disabled - * @hide - */ - /** - * @method applyToMarkup - * @hide - */ - /** - * @method enable - * @hide - */ - /** - * @method disable - * @hide - */ - /** - * @method setDisabled - * @hide - */ }); -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.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.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'; - } -}, - - * @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. - */ - - /** - * @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>'); - - */ - - /** - * @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. - * - */ - - /** - * 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} deferEmptyText True to defer {@link #emptyText} being applied until the store's - * first load (defaults to true). - */ - deferEmptyText : true, +Ext.define('Ext.selection.CheckboxModel', { + alias: 'selection.checkboxmodel', + extend: 'Ext.selection.RowModel', /** - * @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 {String} mode + * Modes of selection. + * Valid values are SINGLE, SIMPLE, and MULTI. Defaults to 'MULTI' */ - scrollOffset : undefined, + mode: 'MULTI', /** - * @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}

not

{@link #forceFit}

false

true

all times

will

{@link #autoFill}

true

false

['sort-asc', 'sort-desc']

'Sort Ascending'

'Sort Descending'

'Columns'

'x-grid3-row-selected'


-    .x-grid3-row-selected {background-color: yellow;}
-


-    .x-grid3-row-selected .x-grid3-cell-inner {
-        color: #FFCC00;
-    }
-

4

10

'td.x-grid3-cell'

'div.x-grid3-row'

', - '

{header}

', - '

{body}

', - '

', this.grid.enableHdMenu ? '' : '', - '{value}

', - '

', - '{cells}', - (this.enableRowBody ? '' : ''), - '

{body}

{value}

Read-only

Return the index of the grid column which contains the passed HTMLElement.

false

Return the index of the grid row which contains the passed HTMLElement.

false

<div>

<td>

= above.value) { + newValue = above.value; } } - // add first/last-row classes - if (startRow === 0) { - Ext.fly(rows[0]).addClass(this.firstRowCls); - } - - Ext.fly(rows[rows.length - 1]).addClass(this.lastRowCls); + slider.setValue(index, newValue, false); + slider.fireEvent('drag', slider, e, me); }, - afterRender : function(){ - if(!this.ds || !this.cm){ - return; - } - this.mainBody.dom.innerHTML = this.renderRows() || ' '; - this.processRows(0, true); + getNewValue: function() { + var slider = this.slider, + pos = slider.innerEl.translatePoints(this.tracker.getXY()); - if(this.deferEmptyText !== true){ - this.applyEmptyText(); - } - this.grid.fireEvent('viewready', this.grid); + return Ext.util.Format.round(slider.reverseValue(pos.left), slider.decimalPrecision); }, /** * @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. + * 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 */ - 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'} - ); - - 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' - }); - } + onDragEnd: function(e) { + var me = this, + slider = me.slider, + value = me.value; - this.hmenu.on('itemclick', this.handleHdMenuClick, this); - } + me.el.removeCls(Ext.baseCSSPrefix + 'slider-thumb-drag'); - if (g.trackMouseOver) { - this.mainBody.on({ - scope : this, - mouseover: this.onRowOver, - mouseout : this.onRowOut - }); - } + me.dragging = false; + slider.fireEvent('dragend', slider, e); - if (g.enableDragDrop || g.enableDrag) { - this.dragZone = new Ext.grid.GridDragZone(g, { - ddGroup : g.ddGroup || 'GridDD' - }); + if (me.dragStartValue != value) { + slider.fireEvent('changecomplete', slider, value, me); } - - 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); + 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 { - body = this.findRowBody(t); - if (body) { - g.fireEvent('rowbody' + name, g, row, e); - } + Ext.create('Ext.fx.Anim', { + target: this.el, + duration: 350, + to: { + bottom: v + } + }); } - } else { - g.fireEvent('container' + name, g, e); - } - } - }, - - // private - layout : function() { - if(!this.mainBody){ - return; // not rendered - } - 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; - } - - 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); - - var hdHeight = this.mainHd.getHeight(); - var vh = csize.height - (hdHeight); - - this.scroller.setSize(vw, vh); - if(this.innerHd){ - this.innerHd.style.width = (vw)+'px'; - } - } - if(this.forceFit){ - if(this.lastViewWidth != vw){ - this.fitColumns(false, false); - this.lastViewWidth = vw; } - }else { - this.autoExpand(); - this.syncHeaderScroll(); } - this.onLayout(vw, vh); - }, - - // template functions for subclasses and plugins - // these functions include precalculated values - onLayout : function(vw, vh){ - // do nothing - }, - - onColumnWidthUpdated : function(col, w, tw){ - //template method - }, - - onAllColumnWidthsUpdated : function(ws, tw){ - //template method - }, + } +}); - onColumnHiddenUpdated : function(col, hidden, tw){ - // template method - }, +/** + * @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, - updateColumnText : function(col, text){ - // template method + init: function(slider) { + var me = this; + + slider.on({ + scope : me, + dragstart: me.onSlide, + drag : me.onSlide, + dragend : me.hide, + destroy : me.destroy + }); }, - - afterMove : function(colIndex){ - // template method + /** + * @private + * Called whenever a dragstart or drag event is received on the associated Thumb. + * Aligns the Tip with the Thumb's new position. + * @param {Ext.slider.MultiSlider} slider The slider + * @param {Ext.EventObject} e The Event object + * @param {Ext.slider.Thumb} thumb The thumb that the Tip is attached to + */ + onSlide : function(slider, e, thumb) { + var me = this; + me.show(); + me.update(me.getText(thumb)); + me.doComponentLayout(); + me.el.alignTo(thumb.el, 'b-t?', me.offsets); }, - /* ----------------------------------- Core Specific -------------------------------------------*/ - // private - init : function(grid){ - this.grid = grid; + /** + * 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); + } +}); +/** + * @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' + ], - this.initTemplates(); - this.initData(grid.store, grid.colModel); - this.initUI(grid); - }, + fieldSubTpl: [ + '

', + '

', + '', + '

', + '

', + { + disableFormats: true, + compiled: true + } + ], - // private - getColumnId : function(index){ - return this.cm.getColumnId(index); - }, + /** + * @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. + */ - // private - getOffsetWidth : function() { - return (this.cm.getTotalWidth() + this.getScrollOffset()) + 'px'; - }, + /** + * @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. + */ - getScrollOffset: function(){ - return Ext.num(this.scrollOffset, Ext.getScrollBarWidth()); - }, + /** + * @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, /** * @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 + * @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 */ - renderHeaders : function() { - var cm = this.cm, - ts = this.templates, - ct = ts.hcell, - cb = [], - p = {}, - len = cm.getColumnCount(), - last = len - 1; - - 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 ' : ''); + clickRange: [5,15], - if (cm.config[i].align == 'right') { - p.istyle = 'padding-right:16px'; - } else { - delete p.istyle; - } - cb[cb.length] = ct.apply(p); - } - return ts.header.apply({cells: cb.join(''), tstyle:'width:'+this.getTotalWidth()+';'}); - }, + /** + * @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, - // private - getColumnTooltip : function(i){ - var tt = this.cm.getColumnTooltip(i); - if(tt){ - if(Ext.QuickTips.isEnabled()){ - return 'ext:qtip="'+tt+'"'; - }else{ - return 'title="'+tt+'"'; - } - } - return ''; - }, + /** + * True while the thumb is in a drag operation + * @type Boolean + */ + dragging: false, - // private - beforeUpdate : function(){ - this.grid.stopEditing(true); - }, + /** + * @cfg {Boolean} constrainThumbs True to disallow thumbs from overlapping one another. Defaults to true + */ + constrainThumbs: 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(); - }, + componentLayout: 'sliderfield', /** - * Focuses the specified row. - * @param {Number} row The row index + * @cfg {Boolean} useTips + * True to use an Ext.slider.Tip to display tips for the value. Defaults to true. */ - focusRow : function(row){ - this.focusCell(row, 0, false); - }, + useTips : true, /** - * Focuses the specified cell. - * @param {Number} row The row index - * @param {Number} col The column index + * @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. */ - 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); - } - }, - - 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; - } - col = (col !== undefined ? col : 0); + tipText : null, - 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); - } + ariaRole: 'slider', - return {row: rowEl, cell: cellEl}; - }, + // 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; - 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()]; - }, + // Store for use in dirty check + me.originalValue = values; - 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)); + // Add a thumb for each value + for (; i < len; i++) { + me.addThumb(values[i]); } - this.focusEl.setXY(xy||this.scroller.getXY()); }, - ensureVisible : function(row, col, hscroll){ - var resolved = this.resolveCell(row, col, hscroll); - if(!resolved || !resolved.row){ - return; - } + // private override + initComponent : function() { + var me = this, + tipPlug, + hasTip; + + /** + * @property thumbs + * @type Array + * Array containing references to each thumb + */ + me.thumbs = []; - var rowEl = resolved.row, - cellEl = resolved.cell, - c = this.scroller.dom, - ctop = 0, - p = rowEl, - stop = this.el.dom; + me.keyIncrement = Math.max(me.increment, me.keyIncrement); - while(p && p != stop){ - ctop += p.offsetTop; - p = p.offsetParent; - } + 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', - ctop -= this.mainHd.dom.offsetHeight; - stop = parseInt(c.scrollTop, 10); + /** + * @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', - var cbot = ctop + rowEl.offsetHeight, - ch = c.clientHeight, - sbot = stop + ch; + /** + * @event changecomplete + * Fires when the slider value is changed by the user and any drag operations have completed. + * @param {Ext.slider.Multi} slider The slider + * @param {Number} newValue The new value which the slider has been changed to. + * @param {Ext.slider.Thumb} thumb The thumb that was changed + */ + 'changecomplete', + /** + * @event dragstart + * Fires after a drag operation has started. + * @param {Ext.slider.Multi} slider The slider + * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker + */ + 'dragstart', - if(ctop < stop){ - c.scrollTop = ctop; - }else if(cbot > sbot){ - c.scrollTop = cbot-ch; - } + /** + * @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', - if(hscroll !== false){ - var cleft = parseInt(cellEl.offsetLeft, 10); - var cright = cleft + cellEl.offsetWidth; + /** + * @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' + ); - 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; - } + if (me.vertical) { + Ext.apply(me, Ext.slider.Multi.Vertical); } - 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); + me.callParent(); + + // 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; } - 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); + }); + if (!hasTip) { + me.plugins.push(Ext.create('Ext.slider.Tip', tipPlug)); } } - this.syncFocusEl(firstRow); }, - // private - deleteRows : function(dm, firstRow, lastRow){ - if(dm.getRowCount()<1){ - this.refresh(); - }else{ - this.fireEvent('beforerowsdeleted', this, firstRow, lastRow); - - this.removeRows(firstRow, lastRow); + /** + * 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); - this.processRows(firstRow); - this.fireEvent('rowsdeleted', this, firstRow, lastRow); + //render the thumb now if needed + if (me.rendered) { + thumb.render(); } - }, - // 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; + return thumb; }, - // 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; - }, + /** + * @private + * Moves the given thumb above all other by increasing its z-index. This is called when as drag + * any thumb, so that the thumb that was just dragged is always at the highest z-index. This is + * required when the thumbs are stacked on top of each other at one of the ends of the slider's + * range, which can result in the user not being able to move any of them. + * @param {Ext.slider.Thumb} topThumb The thumb to move to the top + */ + promoteThumb: function(topThumb) { + var thumbs = this.thumbs, + ln = thumbs.length, + zIndex, thumb, i; + + for (i = 0; i < ln; i++) { + thumb = thumbs[i]; - // private - getTotalWidth : function(){ - return this.cm.getTotalWidth()+'px'; + if (thumb == topThumb) { + thumb.bringToFront(); + } else { + thumb.sendToBack(); + } + } }, - // 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(); - - if(aw < 20){ // not initialized, so don't screw up the default widths - return; - } - var extra = aw - tw; + // private override + onRender : function() { + var me = this, + i = 0, + thumbs = me.thumbs, + len = thumbs.length, + thumb; - if(extra === 0){ - return false; - } + Ext.applyIf(me.subTplData, { + vertical: me.vertical ? Ext.baseCSSPrefix + 'slider-vert' : Ext.baseCSSPrefix + 'slider-horz', + minValue: me.minValue, + maxValue: me.maxValue, + value: me.value + }); - 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; - } - } - } - 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); - } + Ext.applyIf(me.renderSelectors, { + endEl: '.' + Ext.baseCSSPrefix + 'slider-end', + innerEl: '.' + Ext.baseCSSPrefix + 'slider-inner', + focusEl: '.' + Ext.baseCSSPrefix + 'slider-focus' + }); - if((tw = cm.getTotalWidth(false)) > aw){ - var adjustCol = ac != vc ? omitColumn : extraCol; - cm.setColumnWidth(adjustCol, Math.max(1, - cm.getColumnWidth(adjustCol)- (tw-aw)), true); - } + me.callParent(arguments); - if(preventRefresh !== true){ - this.updateAllColumnWidths(); + //render each thumb + for (; i < len; i++) { + thumbs[i].render(); } + //calculate the size of half a thumb + thumb = me.innerEl.down('.' + Ext.baseCSSPrefix + 'slider-thumb'); + me.halfThumb = (me.vertical ? thumb.getHeight() : thumb.getWidth()) / 2; - 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); - } - } - } - } + /** + * 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 + */ + onChange : function(slider, v) { + this.setValue(v, undefined, true); }, /** * @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 + * Adds keyboard and mouse listeners on this.el. Ignores click events on the internal focus element. */ - 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); - - 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) - }; - } + initEvents : function() { + var me = this; + + me.mon(me.el, { + scope : me, + mousedown: me.onMouseDown, + keydown : me.onKeyDown, + change : me.onChange + }); - return cs; + me.focusEl.swallowEvent("click", true); }, - // 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 + * Mousedown handler for the slider. If the clickToChange is enabled and the click was not on the draggable 'thumb', + * this calculates the new value of the slider and tells the implementation (Horizontal or Vertical) to move the thumb + * @param {Ext.EventObject} e The click event + */ + onMouseDown : function(e) { + var me = this, + thumbClicked = false, + i = 0, + thumbs = me.thumbs, + len = thumbs.length, + local; + + if (me.disabled) { + return; } - var cs = this.getColumnData(); - - startRow = startRow || 0; - endRow = !Ext.isDefined(endRow) ? ds.getCount()-1 : endRow; - - // records to render - var rs = ds.getRange(startRow, endRow); - - return this.doRender(cs, rs, ds, startRow, colCount, stripe); - }, - - // private - renderBody : function(){ - var markup = this.renderRows() || ' '; - return this.templates.body.apply({rows: markup}); - }, + //see if the click was on any of the thumbs + for (; i < len; i++) { + thumbClicked = thumbClicked || e.target == thumbs[i].el.dom; + } - // 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; - } + if (me.clickToChange && !thumbClicked) { + local = me.innerEl.translatePoints(e.getXY()); + me.onClickChange(local); } - this.insertRows(ds, index, index, true); - this.getRow(index).rowIndex = index; - this.onRemove(ds, record, index+1, true); - this.fireEvent('rowupdated', this, index, record); + me.focus(); }, /** - * Refreshs the grid UI - * @param {Boolean} headersToo (optional) True to also refresh the headers + * @private + * 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. */ - 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(); + 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.processRows(0, true); - this.layout(); - this.applyEmptyText(); - this.fireEvent('refresh', this); }, /** * @private - * Displays the configured emptyText if there are currently no rows to display + * 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 */ - applyEmptyText : function(){ - if(this.emptyText && !this.hasRows()){ - this.mainBody.update('

' + this.emptyText + '

'); + 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; + + for (; i < len; i++) { + thumb = me.thumbs[i]; + value = thumb.value; + dist = Math.abs(value - clickValue); + + if (Math.abs(dist <= nearestDistance)) { + nearest = thumb; + index = i; + nearestDistance = dist; + } } + return nearest; }, /** * @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. + * 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 */ - updateHeaderSortState : function(){ - var state = this.ds.getSortState(); - if (!state) { + 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; } - - if (!this.sortState || (this.sortState.field != state.field || this.sortState.direction != state.direction)) { - this.grid.fireEvent('sortchange', this.grid, state); - } - - this.sortState = state; - - var sortColumn = this.cm.findColumnIndex(state.field); - if (sortColumn != -1){ - var sortDir = state.direction; - this.updateSortIcon(sortColumn, sortDir); + k = e.getKey(); + + switch(k) { + case e.UP: + case e.RIGHT: + e.stopEvent(); + val = e.ctrlKey ? me.maxValue : me.getValue(0) + me.keyIncrement; + me.setValue(0, val, undefined, true); + break; + case e.DOWN: + case e.LEFT: + e.stopEvent(); + val = e.ctrlKey ? me.minValue : me.getValue(0) - me.keyIncrement; + me.setValue(0, val, undefined, true); + break; + default: + e.preventDefault(); } }, /** * @private - * Removes any sorting indicator classes from the column headers + * 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 */ - clearHeaderSortState : function(){ - if (!this.sortState) { - return; + 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; + } } - this.grid.fireEvent('sortchange', this.grid, null); - this.mainHd.select('td').removeClass(this.sortClasses); - delete this.sortState; + return Ext.Number.constrain(newValue, this.minValue, this.maxValue); }, // 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; - } + afterRender : function() { + var me = this, + i = 0, + thumbs = me.thumbs, + len = thumbs.length, + thumb, + v; + + me.callParent(arguments); - this.initData(null, null); - this.purgeListeners(); - Ext.fly(this.innerHd).un("click", this.handleHdDown, this); + for (; i < len; i++) { + thumb = thumbs[i]; - 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 (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); + } } - 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]; - } - - if (this.splitZone){ // enableColumnResize - this.splitZone.destroy(); - delete this.splitZone._domRef; - delete Ext.dd.DDM.ids["gridSplitters" + this.grid.getGridEl().id]; } + }, - Ext.fly(this.innerHd).removeAllListeners(); - Ext.removeNode(this.innerHd); - delete this.innerHd; + /** + * @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); + }, - 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 - ); + /** + * @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; + }, - delete this.grid.container; + /** + * 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); - if(this.dragZone){ - this.dragZone.destroy(); + for (; i < len; ++i) { + t = thumbs[i]; + t.value = t.value < val ? val : t.value; } + me.syncThumbs(); + }, - Ext.dd.DDM.currentTarget = null; - delete Ext.dd.DDM.locationCache[this.grid.getGridEl().id]; + /** + * 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); - Ext.EventManager.removeResizeListener(this.onWindowResize, this); + for (; i < len; ++i) { + t = thumbs[i]; + t.value = t.value > val ? val : t.value; + } + me.syncThumbs(); }, - // private - onDenyColumnHide : function(){ + /** + * 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 + }); - }, + thumb.move(me.translateValue(value), Ext.isDefined(animate) ? animate !== false : me.animate); - // 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); + me.fireEvent('change', me, value, thumb); + if (changeComplete) { + me.fireEvent('changecomplete', me, value, thumb); + } } - }else if(this.forceFit){ - this.fitColumns(true, false); - }else if(this.grid.autoExpandColumn){ - this.autoExpand(true); } - - this.renderUI(); }, - /* --------------------------------- 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; - - 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; + /** + * @private + */ + translateValue : function(v) { + var ratio = this.getRatio(); + return (v * ratio) - (this.minValue * ratio) - this.halfThumb; }, - // private - onDataChange : function(){ - this.refresh(); - this.updateHeaderSortState(); - this.syncFocusEl(0); + /** + * @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 - onClear : function(){ - this.refresh(); - this.syncFocusEl(0); + focus : function() { + this.focusEl.focus(10); }, - // private - onUpdate : function(ds, record){ - this.refreshRow(record); - }, + //private + onDisable: function() { + var me = this, + i = 0, + thumbs = me.thumbs, + len = thumbs.length, + thumb, + el, + xy; + + me.callParent(); - // private - onAdd : function(ds, records, index){ - this.insertRows(ds, index, index + (records.length-1)); - }, + for (; i < len; i++) { + thumb = thumbs[i]; + el = thumb.el; - // 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); - } - }, + thumb.disable(); - // private - onLoad : function(){ - if (Ext.isGecko){ - if (!this.scrollToTopTask) { - this.scrollToTopTask = new Ext.util.DelayedTask(this.scrollToTop, this); + if(Ext.isIE) { + //IE breaks when using overflow visible and opacity other than 1. + //Create a place holder for the thumb and display it. + xy = el.getXY(); + el.hide(); + + me.innerEl.addCls(me.disabledCls).dom.disabled = true; + + if (!me.thumbHolder) { + me.thumbHolder = me.endEl.createChild({cls: Ext.baseCSSPrefix + 'slider-thumb ' + me.disabledCls}); + } + + me.thumbHolder.show().setXY(xy); } - this.scrollToTopTask.delay(1); - }else{ - this.scrollToTop(); } }, - // private - onColWidthChange : function(cm, col, width){ - this.updateColumnWidth(col, width); - }, + //private + onEnable: function() { + var me = this, + i = 0, + thumbs = me.thumbs, + len = thumbs.length, + thumb, + el; + + this.callParent(); - // private - onHeaderChange : function(cm, col, text){ - this.updateHeaders(); - }, + for (; i < len; i++) { + thumb = thumbs[i]; + el = thumb.el; - // private - onHiddenChange : function(cm, col, hidden){ - this.updateColumnHidden(col, hidden); - }, + thumb.enable(); - // 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); - }, + if (Ext.isIE) { + me.innerEl.removeCls(me.disabledCls).dom.disabled = false; - // private - onColConfigChange : function(){ - delete this.lastViewWidth; - this.indexMap = null; - this.refresh(true); - }, + if (me.thumbHolder) { + me.thumbHolder.hide(); + } - /* -------------------- UI Events and Handlers ------------------------------ */ - // private - initUI : function(grid){ - grid.on('headerclick', this.onHeaderClick, this); + el.show(); + me.syncThumbs(); + } + } }, - // private - initEvents : function(){ - }, + /** + * 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 - onHeaderClick : function(g, index){ - if(this.headersDisabled || !this.cm.isSortable(index)){ - return; + for (; i < length; i++) { + thumbs[i].move(this.translateValue(thumbs[i].value)); + } } - g.stopEditing(true); - g.store.sort(this.cm.getDataIndex(index)); }, - // private - onRowOver : function(e, t){ - var row; - if((row = this.findRowIndex(t)) !== false){ - this.addRowClass(row, 'x-grid3-row-over'); - } + /** + * 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 - 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'); + /** + * 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); } - }, - // private - handleWheel : function(e){ - e.stopPropagation(); + return values; }, - // private - onRowSelect : function(row){ - this.addRowClass(row, this.selectedRowClass); + getSubmitValue: function() { + var me = this; + return (me.disabled || !me.submitValue) ? null : me.getValue(); }, - // private - onRowDeselect : function(row){ - this.removeRowClass(row, this.selectedRowClass); + 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 - onCellSelect : function(row, col){ - var cell = this.getCell(row, col); - if(cell){ - this.fly(cell).addClass('x-grid3-cell-selected'); - } - }, + beforeDestroy : function() { + var me = this; + + Ext.destroyMembers(me.innerEl, me.endEl, me.focusEl); + Ext.each(me.thumbs, function(thumb) { + Ext.destroy(thumb); + }, me); - // private - onCellDeselect : function(row, col){ - var cell = this.getCell(row, col); - if(cell){ - this.fly(cell).removeClass('x-grid3-cell-selected'); - } + me.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(); - } + 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; + }, - this.grid.fireEvent('columnresize', i, w); - }, + onClickChange : function(local) { + var me = this, + thumb, index, bottom; - // 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; + 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); + + me.setValue(index, Ext.util.Format.round(me.minValue + bottom, me.decimalPrecision), undefined, true); } - cm.setHidden(index, item.checked); } - } - return true; - }, - - // private - isHideableColumn : function(c){ - return !c.hidden; - }, - - // 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 - })); } } - }, + } +}); - // 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?'); - } - }, +/** + * @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'], - // 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 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]); }, - // 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; - } - }, + /** + * 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; - // 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 = ''; + //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); } - }, - // private - hasRows : function(){ - var fc = this.mainBody.dom.firstChild; - return fc && fc.nodeType == 1 && fc.className != 'x-grid-empty'; + return this.callParent(args); }, - // back compat - bind : function(d, c){ - this.initData(d, c); + // 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.GridView.SplitDragZone = Ext.extend(Ext.dd.DDProxy, { +/** + * @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', - 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); - }, + requires: [ + 'Ext.layout.component.Tab', + 'Ext.util.KeyNav' + ], - allowHeaderDrag : function(e){ - return true; - }, + componentLayout: 'tab', - 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; - } - } - } - 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); - } - } - }, + isTab: true, - 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); - }, + baseCls: Ext.baseCSSPrefix + 'tab', - autoOffset : function(){ - this.setDelta(0,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; - }, + /** + * @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', - 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; - }, + /** + * @cfg {String} disabledCls + * The CSS class to be applied to a Tab when it is disabled. Defaults to 'x-tab-disabled'. + */ - 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; - }, + /** + * @cfg {String} closableCls + * The CSS class which is added to the tab when it is closable + */ + closableCls: 'closable', - afterValidDrop : function(){ - this.completeDrop(); - }, + /** + * @cfg {Boolean} closable True to make the Tab start closable (the close icon will be visible). Defaults to true + */ + closable: true, - afterInvalidDrop : function(){ - this.completeDrop(); - }, - - completeDrop: function(){ - var v = this.view, - disabled = this.dragHeadersDisabled; - setTimeout(function(){ - v.headersDisabled = disabled; - }, 50); - } -}); + /** + * @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', -// 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, - - 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); - }, + /** + * @property Boolean + * Read-only property indicating that this tab is currently active. This is NOT a public configuration. + */ + active: false, - getTargetFromEvent : function(e){ - var t = Ext.lib.Event.getTarget(e), - cindex = this.view.findCellIndex(t); - if(cindex !== false){ - return this.view.getHeaderCell(cindex); - } - }, + /** + * @property closable + * @type Boolean + * True if the tab is currently closable + */ - 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; - } - return null; - }, + scale: false, - 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; - }, + position: 'top', + + initComponent: function() { + var me = this; - 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.addEvents( + /** + * @event activate + * @param {Ext.tab.Tab} this + */ + 'activate', - if(this.grid.colModel.isFixed(this.view.getCellIndex(n))){ - return false; - } + /** + * @event deactivate + * @param {Ext.tab.Tab} this + */ + 'deactivate', - 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; - }, + /** + * @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); - onNodeEnter : function(n, dd, e, data){ - if(data.header != n){ - this.positionIndicator(data.header, n, e); + if (me.card) { + me.setCard(me.card); } }, - 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; - }, + /** + * @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'); - onNodeOut : function(n, dd, e, data){ - this.proxyTop.hide(); - this.proxyBottom.hide(); - }, + me.syncClosableUI(); - 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; + me.callParent(arguments); + + if (me.active) { + me.activate(true); } - 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'); + me.syncClosableElements(); + + me.keyNav = Ext.create('Ext.util.KeyNav', me.el, { + enter: me.onEnterKey, + del: me.onDeleteKey, + scope: me + }); }, - handleMouseDown : function(e){ - }, + // inherit docs + enable : function(silent) { + var me = this; - 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); + + me.removeClsWithUI(me.position + '-disabled'); - 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); + return me; }, + // inherit docs + disable : function(silent) { + var me = this; + + me.callParent(arguments); + + me.addClsWithUI(me.position + '-disabled'); - 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); - } - } - }, - - 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); + return me; }, - - 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'; -}; - -Ext.extend(Ext.grid.GridDragZone, Ext.dd.DragZone, { - ddGroup : "GridDD", - + /** - *

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.GridPanel
The GridPanel from which the data is being dragged.
ddel : htmlElement
An htmlElement which provides the "picture" of the data being dragged.
rowIndex : Number
The index of the row which receieved the mousedown gesture which triggered the drag.
selections : Array
An Array of the selected Records which are being dragged from the GridPanel.

+ * @ignore */ - 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); - } - return {grid: this.grid, ddel: this.ddel, rowIndex: rowIndex, selections:sm.getSelections()}; + onDestroy: function() { + var me = this; + + if (me.closeEl) { + me.closeEl.un('click', Ext.EventManager.preventDefault); + me.closeEl = null; } - 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}.

- */ - onInitDrag : function(e){ - var data = this.dragData; - this.ddel.innerHTML = this.grid.getDragDropText(); - this.proxy.update(this.ddel); - // fire start drag? - }, + Ext.destroy(me.keyNav); + delete me.keyNav; - /** - * 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; + me.callParent(arguments); }, /** - *

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]) + * 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) */ - getRepairXY : function(e, data){ - return false; - }, + setClosable: function(closable) { + var me = this; - onEndDrag : function(data, e){ - // fire end drag? - }, + // Closable must be true if no args + closable = (!arguments.length || !!closable); - onValidDrop : function(dd, e, id){ - // fire drag drop? - this.hideProxy(); - }, + if (me.closable != closable) { + me.closable = closable; - beforeInvalidDrop : function(e, id){ + // set property on the user-facing item ('card'): + if (me.card) { + me.card.closable = closable; + } - } -}); -/** - * @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}. - */ + me.syncClosableUI(); - 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]; + if (me.rendered) { + me.syncClosableElements(); + + // Tab will change width to accommodate close icon + me.doComponentLayout(); + if (me.ownerCt) { + me.ownerCt.doLayout(); + } + } + } }, /** - * Returns the index for a specified column id. - * @param {String} id The column id - * @return {Number} the index, or -1 if not found + * This method ensures that the closeBtn element exists or not based on 'closable'. + * @private */ - getIndexById : function(id){ - for(var i = 0, len = this.config.length; i < len; i++){ - if(this.config[i].id == id){ - return i; + syncClosableElements: function () { + var me = this; + + 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; } } - 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. + * This method ensures that the UI classes are added or removed based on 'closable'. + * @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); + syncClosableUI: function () { + var me = this, classes = [me.closableCls, me.closableCls + '-' + me.position]; + + if (me.closable) { + me.addClsWithUI(classes); + } else { + me.removeClsWithUI(classes); + } }, /** - * Returns the number of columns. - * @param {Boolean} visibleOnly Optional. Pass as true to only include visible columns. - * @return {Number} + * 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 */ - 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; - } - return this.config.length; + setCard: function(card) { + var me = this; + + me.card = card; + me.setText(me.title || card.title); + me.setIconCls(me.iconCls || card.iconCls); }, /** - * 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; + * @private + * Listener attached to click events on the Tab's close button + */ + onCloseClick: function() { + var me = this; + + if (me.fireEvent('beforeclose', me) !== false) { + if (me.tabBar) { + if (me.tabBar.closeTab(me) === false) { + // beforeclose on the panel vetoed the event, stop here + return; + } + } else { + // if there's no tabbar, fire the close event + me.fireEvent('close', me); } } - return r; }, - + /** - * Returns true if the specified column is sortable. - * @param {Number} col The column index - * @return {Boolean} + * Fires the close event on the tab. + * @private */ - isSortable : function(col){ - return !!this.config[col].sortable; + fireClose: function(){ + this.fireEvent('close', this); }, - + /** - * Returns true if the specified column menu is disabled. - * @param {Number} col The column index - * @return {Boolean} + * @private */ - isMenuDisabled : function(col){ - return !!this.config[col].menuDisabled; + onEnterKey: function(e) { + var me = this; + + if (me.tabBar) { + me.tabBar.onClick(e, me.el); + } }, - - /** - * 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}. + + /** + * @private */ - getRenderer : function(col){ - if(!this.config[col].renderer){ - return Ext.grid.ColumnModel.defaultRenderer; + onDeleteKey: function(e) { + var me = this; + + if (me.closable) { + me.onCloseClick(); } - return this.config[col].renderer; }, + + // @private + activate : function(supressEvent) { + var me = this; + + me.active = true; + me.addClsWithUI([me.activeCls, me.position + '-' + me.activeCls]); - getRendererScope : function(col){ - return this.config[col].scope; + if (supressEvent !== true) { + me.fireEvent('activate', me); + } }, + // @private + deactivate : function(supressEvent) { + var me = this; + + me.active = false; + me.removeClsWithUI([me.activeCls, me.position + '-' + me.activeCls]); + + if (supressEvent !== true) { + me.fireEvent('deactivate', me); + } + } +}); + +/** + * @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', + /** - * 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.

+ * @cfg Boolean plain + * True to not show the full background on the tabbar */ - setRenderer : function(col, fn){ - this.config[col].renderer = fn; - }, + plain: false, + + // @private + renderTpl: [ + '

{baseCls}-body-{ui} {parent.baseCls}-body-{parent.ui}-{.}" style="{bodyStyle}">

', + '

{baseCls}-strip-{ui} {parent.baseCls}-strip-{parent.ui}-{.}">

' + ], /** - * Returns the width for the specified column. - * @param {Number} col The column index - * @return {Number} + * @cfg {Number} minTabWidth The minimum width for each tab. Defaults to 30. */ - getColumnWidth : function(col){ - return this.config[col].width; - }, + minTabWidth: 30, /** - * 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. + * @cfg {Number} maxTabWidth The maximum width for each tab. Defaults to undefined. */ - setColumnWidth : function(col, width, suppressEvent){ - this.config[col].width = width; - this.totalWidth = null; - if(!suppressEvent){ - this.fireEvent("widthchange", this, col, width); + maxTabWidth: undefined, + + // @private + initComponent: function() { + var me = this, + keys; + + if (me.plain) { + me.setUI(me.ui + '-plain'); } + + 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' + ); + + Ext.applyIf(me.renderSelectors, { + body : '.' + me.baseCls + '-body', + strip: '.' + me.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 + }); }, - /** - * 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 + onAdd: function(tab) { + var me = this, + tabPanel = me.tabPanel, + hasOwner = !!tabPanel; + + me.callParent(arguments); + tab.position = me.dock; + if (hasOwner) { + tab.minWidth = tabPanel.minTabWidth; } - return this.totalWidth; + else { + tab.minWidth = me.minTabWidth + (tab.iconCls ? 25 : 0); + } + tab.maxWidth = me.maxTabWidth || (hasOwner ? tabPanel.maxTabWidth : undefined); }, - /** - * Returns the header for the specified column. - * @param {Number} col The column index - * @return {String} - */ - getColumnHeader : function(col){ - return this.config[col].header; - }, + // @private + afterRender: function() { + var me = this; - /** - * 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); + me.mon(me.el, { + scope: me, + click: me.onClick, + delegate: '.' + Ext.baseCSSPrefix + 'tab' + }); + me.callParent(arguments); + }, - /** - * 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; + afterComponentLayout : function() { + var me = this; + + me.callParent(arguments); + me.strip.setWidth(me.el.getWidth()); }, - /** - * 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 - */ - getDataIndex : function(col){ - return this.config[col].dataIndex; - }, + // @private + onClick: function(e, target) { + // The target might not be a valid tab el. + var tab = Ext.getCmp(target.id), + tabPanel = this.tabPanel, + allowActive = true; - /** - * 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; + target = e.getTarget(); + + if (tab && tab.isDisabled && !tab.isDisabled()) { + if (tab.closable && target === tab.closeEl.dom) { + tab.onCloseClick(); + } else { + if (tabPanel) { + // TabPanel will card setActiveTab of the TabBar + tabPanel.setActiveTab(tab.card); + } else { + this.setActiveTab(tab); + } + tab.focus(); + } + } }, /** - * 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 + * @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 */ - findColumnIndex : function(dataIndex){ - var c = this.config; - for(var i = 0, len = c.length; i < len; i++){ - if(c[i].dataIndex == dataIndex){ - return i; + closeTab: function(tab) { + var me = this, + card = tab.card, + tabPanel = me.tabPanel, + nextTab; + + if (card && card.fireEvent('beforeclose', card) === false) { + return false; + } + + if (tab.active && me.items.getCount() > 1) { + nextTab = tab.next('tab') || me.items.items[0]; + me.setActiveTab(nextTab); + if (tabPanel) { + tabPanel.setActiveTab(nextTab.card); } } - return -1; + /* + * force the close event to fire. By the time this function returns, + * the tab is already destroyed and all listeners have been purged + * so the tab can't fire itself. + */ + tab.fireClose(); + me.remove(tab); + + if (tabPanel && card) { + card.fireEvent('close', card); + tabPanel.remove(card); + } + + if (nextTab) { + nextTab.focus(); + } }, /** - * 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;
+     * @private
+     * Marks the given tab as active
+     * @param {Ext.Tab} tab The tab to mark active
+     */
+    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);
     }
-    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; +/** + * @author Ed Spencer, Tommy Maintz, Brian Moeskau + * @class Ext.tab.Panel + * @extends Ext.panel.Panel - //force boolean - return !!(ed || (!Ext.isDefined(ed) && c.editor)); - }, +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. - /** - * 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); - }, +__Note:__ - /** - * 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; - }, +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); + } + }); + + Ext.create('Ext.button.Button', { + text : 'Select the second tab', + scope : this, + handler : function() { + tabs.setActiveTab(1); + }, + renderTo : Ext.getBody() + }); + +The {@link #getActiveTab} is a another useful method in TabPanel which will return the current active tab. + +Example 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 : 'Get active tab', + scope : this, + handler : function() { + var tab = tabs.getActiveTab(); + alert('Current tab: ' + tab.title); + }, + renderTo : Ext.getBody() + }); + +Adding a new tab is very simple with a TabPanel. You simple call the {@link #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 + * + * {@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'), + cls = record.get('cls'); + + 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); + } + if (cls) { + metaData.tdCls += ' ' + cls; + } + 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.rendered || !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.rendered || !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.

true

{@link Ext.grid.ColumnModel#defaultSortable}

{@link Ext.data.Store#remoteSort}

true

false

true

false

true

false

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
-}
-
```

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;
-   }
-}
-     *

{@link #renderer}

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}
-    }, {
-        ...
-    }]
-});
-     *

this

false

{@link #editable}

isColumn

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.

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.

'true'

'false'

' '

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.

'0,000.00'

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.

'm/d/Y'

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.

definition string

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}


- // 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}
- ]);
-

true

false


-     * '<div class="x-grid3-hd-checker">&#160;</div>'
-     *

'x-grid3-hd-checker'

'Select Rows'

'x-grid3-hd-checker'

20

true

false

true

text

true

undefined

single

cell

cell : see {@link #getSelectedCell} - *
record : Ext.data.record The {@link Ext.data.Record Record} - * which provides the data for the row containing the selection

cell : see {@link #getSelectedCell} - *
record : Ext.data.record
The {@link Ext.data.Record Record} - * which provides the data for the row containing the selection

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);
-     * 
```

true

'/'

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.

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.

'/'

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.

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();
-};
-             *

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.


-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;
-  }
-});
-             *


-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);
-


-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"
-    }
-});
-


-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'
-    }
-});
-


-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
-    }
-});
-


-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"
-});
-

false

{@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();
+        }
+    }
 });
- *

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}

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.

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.

"before"

"after"

"append"

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.

This event is fired through the TreeView. Add listeners to the TreeView object

if any

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.

"before"

"after"

"append"

true

false

true

{@link Ext.grid.Column#groupName groupName}

{@link Ext.grid.Column#header header}

true

false

true

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.

true

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.

true

'(None)'

Defaults to true

Set to false to disallow the View from accepting drop gestures

true

false

Defaults to true

Set to false to disallow dragging items from the View

'{text}'

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.


-var grid = new Ext.grid.GridPanel({
-    ...
-    view: new Ext.grid.GroupingView({
-        groupTextTpl: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
-    }),
-});
-     *

'value'

'display'

'value'

', - '

', this.groupTextTpl ,'

', - '

' - ); - } - this.startGroup.compile(); - - if (!this.endGroup) { - this.endGroup = '

'/'

false

get()

null

validStatus


+     * var validStatus = Ext.util.Cookies.get("valid");
+     *

' + + Ext.util.Format.htmlEncode(token) + + '

this


+// Handle tab changes on a TabPanel
+tabPanel.on('tabchange', function(tabPanel, tab){
+Ext.History.add(tabPanel.id + ':' + tab.id);
+});
+

', + '

', + '{[this.embedFeature(values, parent, xindex, xcount)]}', + '

'; }, - // 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 '

', + '