/ext-4.0.7/pkgs/classes.js
https://bitbucket.org/srogerf/javascript · JavaScript · 29252 lines · 13512 code · 3108 blank · 12632 comment · 2962 complexity · a081e388c7e0f979768b033e444b0e49 MD5 · raw file
- /*
- This file is part of Ext JS 4
- Copyright (c) 2011 Sencha Inc
- Contact: http://www.sencha.com/contact
- GNU General Public License Usage
- This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
- If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
- */
- /**
- * 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.
- * this.callParent(arguments)
- * }
- * });
- *
- * 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 {Ext.util.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 {Ext.util.Observable} o The Observable to capture events from.
- * @param {Function} fn The function to call when an event is fired.
- * @param {Object} scope (optional) The scope (`this` reference) in which the function is executed. Defaults to
- * the Observable firing the event.
- * @static
- */
- capture: function(o, fn, scope) {
- 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
- */
- 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
- *
- * A config object containing one or more event handlers to be added to this object during initialization. This
- * should be a valid listeners config object as specified in the {@link #addListener} example for attaching multiple
- * handlers at once.
- *
- * **DOM events from Ext JS {@link Ext.Component Components}**
- *
- * While _some_ Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually
- * only done when extra value can be added. For example the {@link Ext.view.View DataView}'s **`{@link
- * Ext.view.View#itemclick itemclick}`** event passing the node clicked on. To access DOM events directly from a
- * child element of a Component, we need to specify the `element` option to identify the Component property to add a
- * DOM listener to:
- *
- * new Ext.panel.Panel({
- * width: 400,
- * height: 200,
- * dockedItems: [{
- * xtype: 'toolbar'
- * }],
- * listeners: {
- * click: {
- * element: 'el', //bind to the underlying el property on the panel
- * fn: function(){ console.log('click el'); }
- * },
- * dblclick: {
- * element: 'body', //bind to the underlying body property on the panel
- * fn: function(){ console.log('dblclick body'); }
- * }
- * }
- * });
- */
- // @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|freezeEvent)$/,
- /**
- * Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is
- * destroyed.
- *
- * @param {Ext.util.Observable/Ext.Element} item The item to which to add a listener/listeners.
- * @param {Object/String} ename The event name, or an object containing event name properties.
- * @param {Function} fn (optional) If the `ename` parameter was an event name, this is the handler function.
- * @param {Object} scope (optional) If the `ename` parameter was an event name, this is the scope (`this` reference)
- * in which the handler function is executed.
- * @param {Object} 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 (typeof ename !== 'string') {
- 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 {Ext.util.Observable/Ext.Element} item The item from which to remove a listener/listeners.
- * @param {Object/String} ename The event name, or an object containing event name properties.
- * @param {Function} fn (optional) If the `ename` parameter was an event name, this is the handler function.
- * @param {Object} scope (optional) If the `ename` parameter was an event name, this is the scope (`this` reference)
- * in which the handler function is executed.
- */
- removeManagedListener : function(item, ename, fn, scope) {
- var me = this,
- options,
- config,
- managedListeners,
- length,
- i;
- if (typeof ename !== 'string') {
- options = ename;
- for (ename in options) {
- if (options.hasOwnProperty(ename)) {
- config = options[ename];
- if (!me.eventOptionsRe.test(ename)) {
- me.removeManagedListener(item, ename, config.fn || config, config.scope || options.scope);
- }
- }
- }
- }
- 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, plus the `options` object passed
- * to {@link #addListener}).
- *
- * An event may be set to bubble up an Observable parent hierarchy (See {@link Ext.Component#getBubbleTarget}) by
- * calling {@link #enableBubble}.
- *
- * @param {String} eventName The name of the event to fire.
- * @param {Object...} args Variable number of parameters are passed to handlers.
- * @return {Boolean} returns false if any of the handlers return false otherwise it returns true.
- */
- fireEvent: function(eventName) {
- var name = eventName.toLowerCase(),
- events = this.events,
- event = events && events[name],
- bubbles = event && event.bubble;
- return this.continueFireEvent(name, Ext.Array.slice(arguments, 1), bubbles);
- },
- /**
- * Continue to fire event.
- * @private
- *
- * @param {String} eventName
- * @param {Array} args
- * @param {Boolean} bubbles
- */
- continueFireEvent: function(eventName, args, bubbles) {
- var target = this,
- queue, event,
- ret = true;
- do {
- if (target.eventsSuspended === true) {
- if ((queue = target.eventQueue)) {
- queue.push([eventName, args, bubbles]);
- }
- return ret;
- } else {
- event = target.events[eventName];
- // Continue bubbling if event exists and it is `true` or the handler didn't returns false and it
- // configure to bubble.
- if (event && event != true) {
- if ((ret = event.fire.apply(event, args)) === false) {
- break;
- }
- }
- }
- } while (bubbles && (target = target.getBubbleParent()));
- return ret;
- },
- /**
- * Gets the bubbling parent for an Observable
- * @private
- * @return {Ext.util.Observable} The bubble parent. null is returned if no bubble target exists
- */
- getBubbleParent: function(){
- var me = this, parent = me.getBubbleTarget && me.getBubbleTarget();
- if (parent && parent.isObservable) {
- return parent;
- }
- return null;
- },
- /**
- * Appends an event handler to this object.
- *
- * @param {String} eventName The name of the event to listen for. May also be an object who's property names are
- * event names.
- * @param {Function} fn The method the event invokes. Will be called with arguments given to
- * {@link #fireEvent} plus the `options` parameter described below.
- * @param {Object} [scope] The scope (`this` reference) in which the handler function is executed. **If
- * omitted, defaults to the object which fired the event.**
- * @param {Object} [options] An object containing handler configuration.
- *
- * **Note:** Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
- *
- * This object may contain any of the following properties:
- *
- * - **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'
- * }
- * });
- *
- * **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
- * });
- *
- * One can also specify options for each event handler separately:
- *
- * myGridPanel.on({
- * cellClick: {fn: this.onCellClick, scope: this, single: true},
- * mouseover: {fn: panel.onMouseOver, scope: panel}
- * });
- *
- */
- addListener: function(ename, fn, scope, options) {
- var me = this,
- config,
- event;
- if (typeof ename !== 'string') {
- 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} fn 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. It must be the same as the
- * scope argument specified in the original call to {@link #addListener} or the listener will not be removed.
- */
- removeListener: function(ename, fn, scope) {
- var me = this,
- config,
- event,
- options;
- if (typeof ename !== 'string') {
- options = ename;
- for (ename in options) {
- if (options.hasOwnProperty(ename)) {
- config = options[ename];
- if (!me.eventOptionsRe.test(ename)) {
- me.removeListener(ename, config.fn || config, config.scope || options.scope);
- }
- }
- }
- } else {
- ename = ename.toLowerCase();
- event = me.events[ename];
- if (event && event.isEvent) {
- 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();
- },
- //<debug>
- purgeListeners : function() {
- if (Ext.global.console) {
- Ext.global.console.warn('Observable: purgeListeners has been deprecated. Please use clearListeners.');
- }
- return this.clearListeners.apply(this, arguments);
- },
- //</debug>
- /**
- * 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);
- }
- }
- },
- //<debug>
- purgeManagedListeners : function() {
- if (Ext.global.console) {
- Ext.global.console.warn('Observable: purgeManagedListeners has been deprecated. Please use clearManagedListeners.');
- }
- return this.clearManagedListeners.apply(this, arguments);
- },
- //</debug>
- /**
- * 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. Usage:
- *
- * this.addEvents({
- * storeloaded: true,
- * storecleared: true
- * });
- *
- * @param {String...} more (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;
- },
- /**
- * Suspends the firing of all events. (see {@link #resumeEvents})
- *
- * @param {Boolean} queueSuspended Pass as true to queue up suspended events to be fired
- * after the {@link #resumeEvents} call instead of discarding all suspended events.
- */
- suspendEvents: function(queueSuspended) {
- this.eventsSuspended = true;
- if (queueSuspended && !this.eventQueue) {
- this.eventQueue = [];
- }
- },
- /**
- * Resumes firing events (see {@link #suspendEvents}).
- *
- * If events were suspended using the `queueSuspended` parameter, then all events fired
- * during event suspension will be sent to any listeners now.
- */
- resumeEvents: function() {
- var me = this,
- queued = me.eventQueue;
- me.eventsSuspended = false;
- delete me.eventQueue;
- if (queued) {
- Ext.each(queued, function(e) {
- me.continueFireEvent.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 {String[]} events Array of event names to relay.
- * @param {String} prefix
- */
- 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/String[]} 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() {
- this.createAlias({
- /**
- * @method
- * Shorthand for {@link #addListener}.
- * @alias Ext.util.Observable#addListener
- */
- on: 'addListener',
- /**
- * @method
- * Shorthand for {@link #removeListener}.
- * @alias Ext.util.Observable#removeListener
- */
- un: 'removeListener',
- /**
- * @method
- * Shorthand for {@link #addManagedListener}.
- * @alias Ext.util.Observable#addManagedListener
- */
- mon: 'addManagedListener',
- /**
- * @method
- * Shorthand for {@link #removeManagedListener}.
- * @alias Ext.util.Observable#removeManagedListener
- */
- 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){
- Ext.Array.erase(e.before, i, 1);
- return;
- }
- }
- for(i = 0, len = e.after.length; i < len; i++){
- if(e.after[i].fn == fn && e.after[i].scope == scope){
- Ext.Array.erase(e.after, i, 1);
- return;
- }
- }
- },
- toggleEventLogging: function(toggle) {
- Ext.util.Observable[toggle ? 'capture' : 'releaseCapture'](this, function(en) {
- if (Ext.isDefined(Ext.global.console)) {
- Ext.global.console.log(en, arguments);
- }
- });
- }
- };
- }());
- });
- /**
- * @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.Element}, {@link Ext.CompositeElement},
- * {@link Ext.draw.Sprite}, {@link Ext.draw.CompositeSprite}, and {@link Ext.Component}. Note that Components
- * have a limited subset of what attributes can be animated such as top, left, x, y, height, width, and
- * opacity (color, paddings, and margins can not be animated).
- *
- * ## Animation Basics
- *
- * All animations require three things - `easing`, `duration`, and `to` (the final end value for each property)
- * you wish to animate. Easing and duration are defaulted values specified below.
- * Easing describes how the intermediate values used during a transition will be calculated.
- * {@link Ext.fx.Anim#easing Easing} allows for a transition to change speed over its duration.
- * You may use the defaults for easing and duration, but you must always set a
- * {@link Ext.fx.Anim#to to} property which is the end value for all animations.
- *
- * Popular element 'to' configurations are:
- *
- * - opacity
- * - x
- * - y
- * - color
- * - height
- * - width
- *
- * Popular sprite 'to' configurations are:
- *
- * - translation
- * - path
- * - scale
- * - stroke
- * - rotation
- *
- * The default duration for animations is 250 (which is a 1/4 of a second). Duration is denoted in
- * milliseconds. Therefore 1 second is 1000, 1 minute would be 60000, and so on. The default easing curve
- * used for all animations is 'ease'. Popular easing functions are included and can be found in {@link Ext.fx.Anim#easing Easing}.
- *
- * For example, a simple animation to fade out an element with a default easing and duration:
- *
- * var p1 = Ext.get('myElementId');
- *
- * p1.animate({
- * to: {
- * opacity: 0
- * }
- * });
- *
- * To make this animation fade out in a tenth of a second:
- *
- * var p1 = Ext.get('myElementId');
- *
- * p1.animate({
- * duration: 100,
- * to: {
- * opacity: 0
- * }
- * });
- *
- * ## Animation Queues
- *
- * By default all animations are added to a queue which allows for animation via a chain-style API.
- * For example, the following code will queue 4 animations which occur sequentially (one right after the other):
- *
- * p1.animate({
- * to: {
- * x: 500
- * }
- * }).animate({
- * to: {
- * y: 150
- * }
- * }).animate({
- * to: {
- * backgroundColor: '#f00' //red
- * }
- * }).animate({
- * to: {
- * opacity: 0
- * }
- * });
- *
- * You can change this behavior by calling the {@link Ext.util.Animate#syncFx syncFx} method and all
- * subsequent animations for the specified target will be run concurrently (at the same time).
- *
- * p1.syncFx(); //this will make all animations run at the same time
- *
- * p1.animate({
- * to: {
- * x: 500
- * }
- * }).animate({
- * to: {
- * y: 150
- * }
- * }).animate({
- * to: {
- * backgroundColor: '#f00' //red
- * }
- * }).animate({
- * to: {
- * opacity: 0
- * }
- * });
- *
- * This works the same as:
- *
- * p1.animate({
- * to: {
- * x: 500,
- * y: 150,
- * backgroundColor: '#f00' //red
- * opacity: 0
- * }
- * });
- *
- * The {@link Ext.util.Animate#stopAnimation stopAnimation} method can be used to stop any
- * currently running animations and clear any queued animations.
- *
- * ## Animation Keyframes
- *
- * You can also set up complex animations with {@link Ext.fx.Anim#keyframes keyframes} which follow the
- * CSS3 Animation configuration pattern. Note rotation, translation, and scaling can only be done for sprites.
- * The previous example can be written with the following syntax:
- *
- * p1.animate({
- * duration: 1000, //one second total
- * keyframes: {
- * 25: { //from 0 to 250ms (25%)
- * x: 0
- * },
- * 50: { //from 250ms to 500ms (50%)
- * y: 0
- * },
- * 75: { //from 500ms to 750ms (75%)
- * backgroundColor: '#f00' //red
- * },
- * 100: { //from 750ms to 1sec
- * opacity: 0
- * }
- * }
- * });
- *
- * ## Animation Events
- *
- * Each animation you create has events for {@link Ext.fx.Anim#beforeanimate beforeanimate},
- * {@link Ext.fx.Anim#afteranimate afteranimate}, and {@link Ext.fx.Anim#lastframe lastframe}.
- * Keyframed animations adds an additional {@link Ext.fx.Animator#keyframe keyframe} event which
- * fires for each keyframe in your animation.
- *
- * All animations support the {@link Ext.util.Observable#listeners listeners} configuration to attact functions to these events.
- *
- * startAnimate: function() {
- * var p1 = Ext.get('myElementId');
- * p1.animate({
- * duration: 100,
- * to: {
- * opacity: 0
- * },
- * listeners: {
- * beforeanimate: function() {
- * // Execute my custom method before the animation
- * this.myBeforeAnimateFn();
- * },
- * afteranimate: function() {
- * // Execute my custom method after the animation
- * this.myAfterAnimateFn();
- * },
- * scope: this
- * });
- * },
- * myBeforeAnimateFn: function() {
- * // My custom logic
- * },
- * myAfterAnimateFn: function() {
- * // My custom logic
- * }
- *
- * Due to the fact that animations run asynchronously, you can determine if an animation is currently
- * running on any target by using the {@link Ext.util.Animate#getActiveAnimation getActiveAnimation}
- * method. This method will return false if there are no active animations or return the currently
- * running {@link Ext.fx.Anim} instance.
- *
- * In this example, we're going to wait for the current animation to finish, then stop any other
- * queued animations before we fade our element's opacity to 0:
- *
- * var curAnim = p1.getActiveAnimation();
- * if (curAnim) {
- * curAnim.on('afteranimate', function() {
- * p1.stopAnimation();
- * p1.animate({
- * to: {
- * opacity: 0
- * }
- * });
- * });
- * }
- *
- * @docauthor Jamie Avins <jamie@sencha.com>
- */
- Ext.define('Ext.util.Animate', {
- uses: ['Ext.fx.Manager', 'Ext.fx.Anim'],
- /**
- * <p>Perform custom animation on this object.<p>
- * <p>This method is applicable to both the {@link Ext.Component Component} class and the {@link Ext.Element Element} class.
- * It performs animated transitions of certain properties of this object over a specified timeline.</p>
- * <p>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 <b><code>to</code></b> is mandatory.</p>
- * <p>Properties include<ul>
- * <li><code>from</code> <div class="sub-desc">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.<div></li>
- * <li><code>to</code> <div class="sub-desc">An object which specifies end values for the properties being animated.</div></li>
- * <li><code>duration</code><div class="sub-desc">The duration <b>in milliseconds</b> for which the animation will run.</div></li>
- * <li><code>easing</code> <div class="sub-desc">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:<code><ul>
- * <li>ease</li>
- * <li>easeIn</li>
- * <li>easeOut</li>
- * <li>easeInOut</li>
- * <li>backIn</li>
- * <li>backOut</li>
- * <li>elasticIn</li>
- * <li>elasticOut</li>
- * <li>bounceIn</li>
- * <li>bounceOut</li>
- * </ul></code></div></li>
- * <li><code>keyframes</code> <div class="sub-desc">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.</div></li>
- * <li><code>listeners</code> <div class="sub-desc">This is a standard {@link Ext.util.Observable#listeners listeners} configuration object which may be used
- * to inject behaviour at either the <code>beforeanimate</code> event or the <code>afteranimate</code> event.</div></li>
- * </ul></p>
- * <h3>Animating an {@link Ext.Element Element}</h3>
- * When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
- * <li><code>x</code> <div class="sub-desc">The page X position in pixels.</div></li>
- * <li><code>y</code> <div class="sub-desc">The page Y position in pixels</div></li>
- * <li><code>left</code> <div class="sub-desc">The element's CSS <code>left</code> value. Units must be supplied.</div></li>
- * <li><code>top</code> <div class="sub-desc">The element's CSS <code>top</code> value. Units must be supplied.</div></li>
- * <li><code>width</code> <div class="sub-desc">The element's CSS <code>width</code> value. Units must be supplied.</div></li>
- * <li><code>height</code> <div class="sub-desc">The element's CSS <code>height</code> value. Units must be supplied.</div></li>
- * <li><code>scrollLeft</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
- * <li><code>scrollTop</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
- * <li><code>opacity</code> <div class="sub-desc">The element's <code>opacity</code> value. This must be a value between <code>0</code> and <code>1</code>.</div></li>
- * </ul>
- * <p><b>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.</b></p>
- * <h3>Animating a {@link Ext.Component Component}</h3>
- * When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
- * <li><code>x</code> <div class="sub-desc">The Component's page X position in pixels.</div></li>
- * <li><code>y</code> <div class="sub-desc">The Component's page Y position in pixels</div></li>
- * <li><code>left</code> <div class="sub-desc">The Component's <code>left</code> value in pixels.</div></li>
- * <li><code>top</code> <div class="sub-desc">The Component's <code>top</code> value in pixels.</div></li>
- * <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
- * <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
- * <li><code>dynamic</code> <div class="sub-desc">Specify as true to update the Component's layout (if it is a Container) at every frame
- * of the animation. <i>Use sparingly as laying out on every intermediate size change is an expensive operation</i>.</div></li>
- * </ul>
- * <p>For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:</p>
- * <pre><code>
- 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,
- }
- });
- });
- </code></pre>
- * <p>For performance reasons, by default, the internal layout is only updated when the Window reaches its final <code>"to"</code> size. If dynamic updating of the Window's child
- * Components is required, then configure the animation with <code>dynamic: true</code> and the two child items will maintain their proportions during the animation.</p>
- * @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.Element} The Element
- * @method
- */
- stopFx: Ext.Function.alias(Ext.util.Animate, 'stopAnimation'),
- /**
- * Stops any running effects and clears this object's internal effects queue if it contains
- * any additional effects that haven't started yet.
- * @return {Ext.Element} The Element
- */
- stopAnimation: function() {
- Ext.fx.Manager.stopAnimation(this.id);
- return this;
- },
- /**
- * Ensures that all effects queued after syncFx is called on this object are
- * run concurrently. This is the opposite of {@link #sequenceFx}.
- * @return {Object} this
- */
- syncFx: function() {
- Ext.fx.Manager.setFxDefaults(this.id, {
- concurrent: true
- });
- return this;
- },
- /**
- * Ensures that all effects queued after sequenceFx is called on this object are
- * run in sequence. This is the opposite of {@link #syncFx}.
- * @return {Object} this
- */
- sequenceFx: function() {
- Ext.fx.Manager.setFxDefaults(this.id, {
- concurrent: false
- });
- return this;
- },
- /**
- * @deprecated 4.0 Replaced by {@link #getActiveAnimation}
- * @alias Ext.util.Animate#getActiveAnimation
- * @method
- */
- hasActiveFx: Ext.Function.alias(Ext.util.Animate, 'getActiveAnimation'),
- /**
- * Returns the current animation if this object has any effects actively running or queued, else returns false.
- * @return {Ext.fx.Anim/Boolean} Anim if element has active effects, else false
- */
- getActiveAnimation: function() {
- return Ext.fx.Manager.getActiveAnimation(this.id);
- }
- }, function(){
- // Apply Animate mixin manually until Element is defined in the proper 4.x way
- Ext.applyIf(Ext.Element.prototype, this.prototype);
- // We need to call this again so the animation methods get copied over to CE
- Ext.CompositeElementLite.importElementMethods();
- });
- /**
- * @class Ext.state.Provider
- * <p>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.</p>
- *
- * <p>This class provides methods for encoding and decoding <b>typed</b> 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.</p>
- */
- 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 <tt>'ext-'</tt>
- */
- prefix: 'ext-',
-
- constructor : function(config){
- config = config || {};
- var me = this;
- Ext.apply(me, config);
- /**
- * @event statechange
- * Fires when a state change occurs.
- * @param {Ext.state.Provider} this This state provider
- * @param {String} key The state key which was changed
- * @param {String} value The encoded value for the state
- */
- me.addEvents("statechange");
- me.state = {};
- me.mixins.observable.constructor.call(me);
- },
-
- /**
- * Returns the current value for a key
- * @param {String} name The key name
- * @param {Object} defaultValue A default value to return if the key's value is not found
- * @return {Object} The state data
- */
- get : function(name, defaultValue){
- return typeof this.state[name] == "undefined" ?
- defaultValue : this.state[name];
- },
- /**
- * Clears a value from the state
- * @param {String} name The key name
- */
- clear : function(name){
- var me = this;
- delete me.state[name];
- me.fireEvent("statechange", me, name, null);
- },
- /**
- * Sets the value for a key
- * @param {String} name The key name
- * @param {Object} value The value to set
- */
- set : function(name, value){
- var me = this;
- me.state[name] = value;
- me.fireEvent("statechange", me, name, value);
- },
- /**
- * Decodes a string previously encoded with {@link #encodeValue}.
- * @param {String} value The value to decode
- * @return {Object} The decoded value
- */
- decodeValue : function(value){
- // a -> Array
- // n -> Number
- // d -> Date
- // b -> Boolean
- // s -> String
- // o -> Object
- // -> Empty (null)
- var me = this,
- re = /^(a|n|d|b|s|o|e)\:(.*)$/,
- matches = re.exec(unescape(value)),
- all,
- type,
- 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 {Object} value The value to encode
- * @return {String} The encoded value
- */
- encodeValue : function(value){
- var flat = '',
- i = 0,
- enc,
- len,
- key;
-
- if (value == null) {
- return 'e:1';
- } else if(typeof value == 'number') {
- enc = 'n:' + value;
- } else if(typeof value == 'boolean') {
- enc = 'b:' + (value ? '1' : '0');
- } else if(Ext.isDate(value)) {
- enc = 'd:' + value.toGMTString();
- } else if(Ext.isArray(value)) {
- for (len = value.length; i < len; i++) {
- flat += this.encodeValue(value[i]);
- if (i != len - 1) {
- flat += '^';
- }
- }
- enc = 'a:' + flat;
- } else if (typeof value == 'object') {
- for (key in value) {
- if (typeof value[key] != 'function' && value[key] !== undefined) {
- flat += key + '=' + this.encodeValue(value[key]) + '^';
- }
- }
- enc = 'o:' + flat.substring(0, flat.length-1);
- } else {
- enc = 's:' + value;
- }
- return escape(enc);
- }
- });
- /**
- * 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
- * - last
- *
- * Queries return an array of components.
- * Here are some example queries.
- *
- * // retrieve all Ext.Panels in the document by xtype
- * var panelsArray = Ext.ComponentQuery.query('panel');
- *
- * // retrieve all Ext.Panels within the container with an id myCt
- * var panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel');
- *
- * // retrieve all direct children which are Ext.Panels within myCt
- * var directChildPanel = Ext.ComponentQuery.query('#myCt > panel');
- *
- * // retrieve all grids and trees
- * var gridsAndTrees = Ext.ComponentQuery.query('gridpanel, treepanel');
- *
- * For easy access to queries based from a particular Container see the {@link Ext.container.Container#query},
- * {@link Ext.container.Container#down} and {@link Ext.container.Container#child} methods. Also see
- * {@link Ext.Component#up}.
- */
- Ext.define('Ext.ComponentQuery', {
- singleton: true,
- 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 :<pseudo_class>(<selector>)
- re: /^\:([\w\-]+)(?:\(((?:\{[^\}]+\})|(?:(?!\{)[^\s>\/]*?(?!\})))\))?/,
- method: filterByPseudo
- }, {
- // checks for {<member_expression>}
- re: /^(?:\{([^\}]+)\})/,
- method: filterFnPattern
- }];
- // @class Ext.ComponentQuery.Query
- // This internal class is completely hidden in documentation.
- cq.Query = Ext.extend(Object, {
- constructor: function(cfg) {
- cfg = cfg || {};
- Ext.apply(this, cfg);
- },
- // Executes this Query upon the selected root.
- // The root provides the initial source of candidate Component matches which are progressively
- // filtered by iterating through this Query's operations cache.
- // If no root is provided, all registered Components are searched via the ComponentManager.
- // root may be a Container who's descendant Components are filtered
- // root may be a Component with an implementation of getRefItems which provides some nested Components such as the
- // docked items within a Panel.
- // root may be an array of candidate Components to filter using this Query.
- execute : function(root) {
- var operations = this.operations,
- i = 0,
- length = operations.length,
- operation,
- workingItems;
- // no root, use all Components in the document
- if (!root) {
- workingItems = Ext.ComponentManager.all.getArray();
- }
- // Root is 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;
- },
- last: function(components) {
- return components[components.length - 1];
- }
- },
- /**
- * Returns an array of matched Components from within the passed root object.
- *
- * This method filters returned Components in a similar way to how CSS selector based DOM
- * queries work using a textual selector string.
- *
- * See class summary for details.
- *
- * @param {String} selector The selector string to filter returned Components
- * @param {Ext.container.Container} root The Container within which to perform the query.
- * If omitted, all Components within the document are included in the search.
- *
- * This parameter may also be an array of Components to filter according to the selector.</p>
- * @returns {Ext.Component[]} The matched Components.
- *
- * @member Ext.ComponentQuery
- */
- query: function(selector, root) {
- var selectors = selector.split(','),
- length = selectors.length,
- i = 0,
- results = [],
- noDupResults = [],
- dupMatcher = {},
- query, resultsLn, cmp;
- for (; i < length; i++) {
- selector = Ext.String.trim(selectors[i]);
- query = this.cache[selector];
- 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 {Ext.Component} component The Component to test
- * @param {String} selector The selector string to test against.
- * @return {Boolean} True if the Component matches the selector.
- * @member Ext.ComponentQuery
- */
- is: function(component, selector) {
- if (!selector) {
- return true;
- }
- var 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
- }
- //<debug>
- // Exhausted all matches: It's an error
- if (i === (length - 1)) {
- Ext.Error.raise('Invalid ComponentQuery selector: "' + arguments[0] + '"');
- }
- //</debug>
- }
- }
- // 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.HashMap
- * <p>
- * 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:
- * <pre><code>
- 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);
- });
- * </code></pre>
- * </p>
- *
- * <p>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}.
- * </p>
- */
- Ext.define('Ext.util.HashMap', {
- mixins: {
- observable: 'Ext.util.Observable'
- },
- /**
- * @cfg {Function} keyFn A function that is used to retrieve a default key for a passed object.
- * A default is provided that returns the <b>id</b> property on the object. This function is only used
- * if the add method is called with a single argument.
- */
- /**
- * Creates new HashMap.
- * @param {Object} config (optional) Config object.
- */
- constructor: function(config) {
- config = config || {};
-
- var me = this,
- keyFn = config.keyFn;
- me.addEvents(
- /**
- * @event add
- * Fires when a new item is added to the hash
- * @param {Ext.util.HashMap} this.
- * @param {String} key The key of the added item.
- * @param {Object} value The value of the added item.
- */
- 'add',
- /**
- * @event clear
- * Fires when the hash is cleared.
- * @param {Ext.util.HashMap} this.
- */
- 'clear',
- /**
- * @event remove
- * Fires when an item is removed from the hash.
- * @param {Ext.util.HashMap} this.
- * @param {String} key The key of the removed item.
- * @param {Object} value The value of the removed item.
- */
- 'remove',
- /**
- * @event replace
- * Fires when an item is replaced in the hash.
- * @param {Ext.util.HashMap} this.
- * @param {String} key The key of the replaced item.
- * @param {Object} value The new value for the item.
- * @param {Object} old The old value for the item.
- */
- 'replace'
- );
- me.mixins.observable.constructor.call(me, config);
- me.clear(true);
-
- if (keyFn) {
- me.getKey = keyFn;
- }
- },
- /**
- * Gets the number of items in the hash.
- * @return {Number} The number of items in the hash.
- */
- getCount: function() {
- return this.length;
- },
- /**
- * Implementation for being able to extract the key from an object if only
- * a single argument is passed.
- * @private
- * @param {String} key The key
- * @param {Object} value The value
- * @return {Array} [key, value]
- */
- getData: function(key, value) {
- // if we have no value, it means we need to get the key from the object
- if (value === undefined) {
- value = key;
- key = this.getKey(value);
- }
- return [key, value];
- },
- /**
- * Extracts the key from an object. This is a default implementation, it may be overridden
- * @param {Object} o The object to get the key from
- * @return {String} The key to use.
- */
- getKey: function(o) {
- return o.id;
- },
- /**
- * Adds an item to the collection. Fires the {@link #add} event when complete.
- * @param {String} key <p>The key to associate with the item, or the new item.</p>
- * <p>If a {@link #getKey} implementation was specified for this HashMap,
- * or if the key of the stored items is in a property called <tt><b>id</b></tt>,
- * the HashMap will be able to <i>derive</i> the key for the new item.
- * In this case just pass the new item in this parameter.</p>
- * @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)) {
- return 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, <tt>undefined</tt> 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:
- * <div class="mdetail-params"><ul>
- * <li><b>key</b> : String<p class="sub-desc">The key of the item</p></li>
- * <li><b>value</b> : Number<p class="sub-desc">The value of the item</p></li>
- * <li><b>length</b> : Number<p class="sub-desc">The total number of items in the hash</p></li>
- * </ul></div>
- * @param {Function} fn The function to execute.
- * @param {Object} scope The scope to execute in. Defaults to <tt>this</tt>.
- * @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 <tt>undefined</tt> 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.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:
- <pre><code>
- // in your initialization function
- init : function(){
- Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
- var win = new Window(...);
- win.restoreState();
- }
- </code></pre>
- * 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 <evan@sencha.com>
- */
- 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 {Ext.state.Provider} stateProvider The state provider to set
- */
- setProvider : function(stateProvider){
- this.provider = stateProvider;
- },
- /**
- * Returns the current value for a key
- * @param {String} name The key name
- * @param {Object} defaultValue The default value to return if the key lookup does not match
- * @return {Object} The state data
- */
- get : function(key, defaultValue){
- return this.provider.get(key, defaultValue);
- },
- /**
- * Sets the value for a key
- * @param {String} name The key name
- * @param {Object} value The state data
- */
- set : function(key, value){
- this.provider.set(key, value);
- },
- /**
- * Clears a value from the state
- * @param {String} name The key name
- */
- clear : function(key){
- this.provider.clear(key);
- },
- /**
- * Gets the currently configured state provider
- * @return {Ext.state.Provider} The state provider
- */
- getProvider : function(){
- return this.provider;
- }
- });
- /**
- * @class Ext.state.Stateful
- * A mixin for being able to save the state of an object to an underlying
- * {@link Ext.state.Provider}.
- */
- Ext.define('Ext.state.Stateful', {
- /* Begin Definitions */
- mixins: {
- observable: 'Ext.util.Observable'
- },
- requires: ['Ext.state.Manager'],
- /* End Definitions */
- /**
- * @cfg {Boolean} stateful
- * <p>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 <code>{@link #stateId}</code> 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.<p>
- * <p>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.</p>
- * <p>To set the state provider for the current page:</p>
- * <pre><code>
- Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
- expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
- }));
- * </code></pre>
- * <p>A stateful object attempts to save state when one of the events
- * listed in the <code>{@link #stateEvents}</code> configuration fires.</p>
- * <p>To save state, a stateful object first serializes its state by
- * calling <b><code>{@link #getState}</code></b>. 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.</p>
- * <p>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 <code>{@link #stateId}</code>.</p>
- * <p>During construction, a stateful object attempts to <i>restore</i>
- * its state by calling {@link Ext.state.Manager#get} passing the
- * <code>{@link #stateId}</code></p>
- * <p>The resulting object is passed to <b><code>{@link #applyState}</code></b>.
- * The default implementation of <code>{@link #applyState}</code> simply copies
- * properties into the object, but a developer may override this to support
- * more behaviour.</p>
- * <p>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.</p>
- */
- stateful: true,
- /**
- * @cfg {String} stateId
- * The unique id for this object to use for state management purposes.
- * <p>See {@link #stateful} for an explanation of saving and restoring state.</p>
- */
- /**
- * @cfg {String[]} stateEvents
- * <p>An array of events that, when fired, should trigger this object to
- * save its state. Defaults to none. <code>stateEvents</code> may be any type
- * of event supported by this object, including browser or custom events
- * (e.g., <tt>['click', 'customerchange']</tt>).</p>
- * <p>See <code>{@link #stateful}</code> for an explanation of saving and
- * restoring object state.</p>
- */
- /**
- * @cfg {Number} saveDelay
- * A buffer to be applied if many state events are fired within a short period.
- */
- 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 = 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 <b><tt>applyState</tt></b>. 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 <b><tt>applyState</tt></b>. 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
- * <b><tt>getState()</tt></b> 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
- * <b><tt>getState()</tt></b> 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/String[]} 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);
- }
- }
- }
- }
- },
- /**
- * Conditionally saves a single property from this object to the given state object.
- * The idea is to only save state which has changed from the initial state so that
- * current software settings do not override future software settings. Only those
- * values that are user-changed state should be saved.
- *
- * @param {String} propName The name of the property to save.
- * @param {Object} state The state object in to which to save the property.
- * @param {String} stateName (optional) The name to use for the property in state.
- * @return {Boolean} True if the property was saved, false if not.
- */
- savePropToState: function (propName, state, stateName) {
- var me = this,
- value = me[propName],
- config = me.initialConfig;
- if (me.hasOwnProperty(propName)) {
- if (!config || config[propName] !== value) {
- if (state) {
- state[stateName || propName] = value;
- }
- return true;
- }
- }
- return false;
- },
- savePropsToState: function (propNames, state) {
- var me = this;
- Ext.each(propNames, function (propName) {
- me.savePropToState(propName, state);
- });
- return state;
- },
- /**
- * Destroys this stateful object.
- */
- destroy: function(){
- var task = this.stateTask;
- if (task) {
- task.cancel();
- }
- this.clearListeners();
- }
- });
- /**
- * Base Manager class
- */
- Ext.define('Ext.AbstractManager', {
- /* Begin Definitions */
- requires: ['Ext.util.HashMap'],
- /* End Definitions */
- typeName: 'type',
- constructor: function(config) {
- Ext.apply(this, config || {});
- /**
- * @property {Ext.util.HashMap} all
- * Contains all of the items currently managed
- */
- this.all = 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 {Object} The item, undefined if not found.
- */
- get : function(id) {
- return this.all.get(id);
- },
- /**
- * Registers an item to be managed
- * @param {Object} item The item to register
- */
- register: function(item) {
- //<debug>
- var all = this.all,
- key = all.getKey(item);
-
- if (all.containsKey(key)) {
- Ext.Error.raise('Registering duplicate id "' + key + '" with this manager');
- }
- //</debug>
- this.all.add(item);
- },
- /**
- * Unregisters an item by removing it from this manager
- * @param {Object} item The item to unregister
- */
- unregister: function(item) {
- this.all.remove(item);
- },
- /**
- * Registers a new item constructor, keyed by a type key.
- * @param {String} type The mnemonic string by which the class may be looked up.
- * @param {Function} cls The new instance class.
- */
- registerType : function(type, cls) {
- this.types[type] = cls;
- cls[this.typeName] = type;
- },
- /**
- * Checks if an item type is registered.
- * @param {String} type The mnemonic string by which the class may be looked up
- * @return {Boolean} Whether the type is registered.
- */
- isRegistered : function(type){
- return this.types[type] !== undefined;
- },
- /**
- * Creates and returns an instance of whatever this manager manages, based on the supplied type and
- * config object.
- * @param {Object} config The config object
- * @param {String} defaultType If no type is discovered in the config object, we fall back to this type
- * @return {Object} The instance of whatever this manager is managing
- */
- create: function(config, defaultType) {
- var type = config[this.typeName] || config.type || defaultType,
- Constructor = this.types[type];
- //<debug>
- if (Constructor === undefined) {
- Ext.Error.raise("The '" + type + "' type has not been registered with this manager");
- }
- //</debug>
- 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.
- * @param {Function} fn The function to execute.
- * @param {String} fn.key The key of the item
- * @param {Number} fn.value The value of the item
- * @param {Number} fn.length The total number of items in the collection
- * @param {Boolean} fn.return False to cease iteration.
- * @param {Object} scope The scope to execute in. Defaults to `this`.
- */
- each: function(fn, scope){
- this.all.each(fn, scope || this);
- },
-
- /**
- * Gets the number of items in the collection.
- * @return {Number} The number of items in the collection.
- */
- getCount: function(){
- return this.all.getCount();
- }
- });
- /**
- * @class Ext.ComponentManager
- * @extends Ext.AbstractManager
- * <p>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}).</p>
- * <p>This object also provides a registry of available Component <i>classes</i>
- * indexed by a mnemonic code known as the Component's {@link Ext.Component#xtype xtype}.
- * The <code>xtype</code> provides a way to avoid instantiating child Components
- * when creating a full, nested config object for a complete Ext page.</p>
- * <p>A child Component may be specified simply as a <i>config object</i>
- * as long as the correct <code>{@link Ext.Component#xtype xtype}</code> is specified so that if and when the Component
- * needs rendering, the correct type can be looked up for lazy instantiation.</p>
- * <p>For a list of all available <code>{@link Ext.Component#xtype xtypes}</code>, see {@link Ext.Component}.</p>
- * @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 {Function} defaultType (optional) The constructor to provide the default Component type if
- * the config object does not contain a <code>xtype</code>. (Optional if the config contains a <code>xtype</code>).
- * @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;
- }
- });
- /**
- * An abstract base class which provides shared methods for Components across the Sencha product line.
- *
- * Please refer to sub class's documentation
- * @private
- */
- Ext.define('Ext.AbstractComponent', {
- /* Begin Definitions */
- requires: [
- 'Ext.ComponentQuery',
- 'Ext.ComponentManager'
- ],
- mixins: {
- observable: 'Ext.util.Observable',
- animate: 'Ext.util.Animate',
- state: 'Ext.state.Stateful'
- },
- // The "uses" property specifies class which are used in an instantiated AbstractComponent.
- // They do *not* have to be loaded before this class may be defined - that is what "requires" is for.
- uses: [
- 'Ext.PluginManager',
- 'Ext.ComponentManager',
- 'Ext.Element',
- 'Ext.DomHelper',
- 'Ext.XTemplate',
- 'Ext.ComponentQuery',
- 'Ext.ComponentLoader',
- 'Ext.EventManager',
- 'Ext.layout.Layout',
- 'Ext.layout.component.Auto',
- 'Ext.LoadMask',
- '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.**
- *
- * It should not be necessary to use this configuration except for singleton objects in your application. Components
- * created with an id may be accessed globally using {@link Ext#getCmp Ext.getCmp}.
- *
- * Instead of using assigned ids, use the {@link #itemId} config, and {@link Ext.ComponentQuery ComponentQuery}
- * which provides selector-based searching for Sencha Components analogous to DOM querying. The {@link
- * Ext.container.Container Container} class contains {@link Ext.container.Container#down shortcut methods} to query
- * its descendant Components by selector.
- *
- * Note that this id will also be used as the element id for the containing HTML element that is rendered to the
- * page for this component. This allows you to write id-based CSS rules to style the specific instance of this
- * component uniquely, and also to select sub-elements using this component's id as the parent.
- *
- * **Note**: to avoid complications imposed by a unique id also see `{@link #itemId}`.
- *
- * **Note**: to access the container of a Component see `{@link #ownerCt}`.
- *
- * Defaults to an {@link #getId auto-assigned id}.
- */
- /**
- * @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 Ext.container.Container#query}`, `{@link Ext.container.Container#down}` and
- * `{@link Ext.container.Container#child}`.
- *
- * **Note**: to access the container of an item see {@link #ownerCt}.
- */
- /**
- * @property {Ext.Container} ownerCt
- * This Component's owner {@link Ext.container.Container Container} (is set automatically
- * when this Component is added to a Container). Read-only.
- *
- * **Note**: to access items within the Container see {@link #itemId}.
- */
- /**
- * @property {Boolean} layoutManagedWidth
- * @private
- * Flag set by the container layout to which this Component is added.
- * If the layout manages this Component's width, it sets the value to 1.
- * If it does NOT manage the width, it sets it to 2.
- * If the layout MAY affect the width, but only if the owning Container has a fixed width, this is set to 0.
- */
- /**
- * @property {Boolean} layoutManagedHeight
- * @private
- * Flag set by the container layout to which this Component is added.
- * If the layout manages this Component's height, it sets the value to 1.
- * If it does NOT manage the height, it sets it to 2.
- * If the layout MAY affect the height, but only if the owning Container has a fixed height, this is set to 0.
- */
- /**
- * @cfg {String/Object} autoEl
- * A tag name or {@link Ext.DomHelper DomHelper} spec used to create the {@link #getEl Element} which will
- * encapsulate this Component.
- *
- * You do not normally need to specify this. For the base classes {@link Ext.Component} and
- * {@link Ext.container.Container}, this defaults to **'div'**. The more complex Sencha classes use a more
- * complex DOM structure specified by their own {@link #renderTpl}s.
- *
- * This is intended to allow the developer to create application-specific utility Components encapsulated by
- * different DOM elements. Example usage:
- *
- * {
- * xtype: 'component',
- * autoEl: {
- * tag: 'img',
- * src: 'http://www.example.com/example.jpg'
- * }
- * }, {
- * xtype: 'component',
- * autoEl: {
- * tag: 'blockquote',
- * html: 'autoEl is cool!'
- * }
- * }, {
- * xtype: 'container',
- * autoEl: 'ul',
- * cls: 'ux-unordered-list',
- * items: {
- * xtype: 'component',
- * autoEl: 'li',
- * html: 'First list item'
- * }
- * }
- */
- /**
- * @cfg {Ext.XTemplate/String/String[]} renderTpl
- * An {@link Ext.XTemplate XTemplate} used to create the internal structure inside this Component's encapsulating
- * {@link #getEl Element}.
- *
- * You do not normally need to specify this. For the base classes {@link Ext.Component} and
- * {@link Ext.container.Container}, this defaults to **`null`** which means that they will be initially rendered
- * with no internal structure; they render their {@link #getEl Element} empty. The more specialized 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} and {@link #childEls} options.
- */
- renderTpl: null,
- /**
- * @cfg {Object} renderData
- *
- * The data used by {@link #renderTpl} in addition to the following property values of the component:
- *
- * - id
- * - ui
- * - uiCls
- * - baseCls
- * - componentCls
- * - frame
- *
- * See {@link #renderSelectors} and {@link #childEls} for usage examples.
- */
- /**
- * @cfg {Object} renderSelectors
- * An object containing properties specifying {@link Ext.DomQuery DomQuery} selectors which identify child elements
- * created by the render process.
- *
- * After the Component's internal structure is rendered according to the {@link #renderTpl}, this object is iterated through,
- * and the found Elements are added as properties to the Component using the `renderSelector` property name.
- *
- * For example, a Component which renderes a title and description into its element:
- *
- * Ext.create('Ext.Component', {
- * renderTo: Ext.getBody(),
- * renderTpl: [
- * '<h1 class="title">{title}</h1>',
- * '<p>{desc}</p>'
- * ],
- * renderData: {
- * title: "Error",
- * desc: "Something went wrong"
- * },
- * renderSelectors: {
- * titleEl: 'h1.title',
- * descEl: 'p'
- * },
- * listeners: {
- * afterrender: function(cmp){
- * // After rendering the component will have a titleEl and descEl properties
- * cmp.titleEl.setStyle({color: "red"});
- * }
- * }
- * });
- *
- * For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the
- * Component after render), see {@link #childEls} and {@link #addChildEls}.
- */
- /**
- * @cfg {Object[]} childEls
- * An array describing the child elements of the Component. Each member of the array
- * is an object with these properties:
- *
- * - `name` - The property name on the Component for the child element.
- * - `itemId` - The id to combine with the Component's id that is the id of the child element.
- * - `id` - The id of the child element.
- *
- * If the array member is a string, it is equivalent to `{ name: m, itemId: m }`.
- *
- * For example, a Component which renders a title and body text:
- *
- * Ext.create('Ext.Component', {
- * renderTo: Ext.getBody(),
- * renderTpl: [
- * '<h1 id="{id}-title">{title}</h1>',
- * '<p>{msg}</p>',
- * ],
- * renderData: {
- * title: "Error",
- * msg: "Something went wrong"
- * },
- * childEls: ["title"],
- * listeners: {
- * afterrender: function(cmp){
- * // After rendering the component will have a title property
- * cmp.title.setStyle({color: "red"});
- * }
- * }
- * });
- *
- * A more flexible, but somewhat slower, approach is {@link #renderSelectors}.
- */
- /**
- * @cfg {String/HTMLElement/Ext.Element} renderTo
- * Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.
- *
- * **Notes:**
- *
- * Do *not* use this option if the Component is to be a child item of a {@link Ext.container.Container Container}.
- * It is the responsibility of the {@link Ext.container.Container Container}'s
- * {@link Ext.container.Container#layout layout manager} to render and manage its child items.
- *
- * When using this config, a call to render() is not required.
- *
- * See `{@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}.
- */
- /**
- * @property {Object} 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:
- *
- * @property {Number} frameSize.top The width of the top framing element in pixels.
- * @property {Number} frameSize.right The width of the right framing element in pixels.
- * @property {Number} frameSize.bottom The width of the bottom framing element in pixels.
- * @property {Number} frameSize.left The width of the left framing element in pixels.
- */
- /**
- * @cfg {String/Object} componentLayout
- * The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout
- * manager which sizes a Component's internal structure in response to the Component being sized.
- *
- * Generally, developers will not use this configuration as all provided Components which need their internal
- * elements sizing (Such as {@link Ext.form.field.Base input fields}) come with their own componentLayout managers.
- *
- * The {@link Ext.layout.container.Auto default layout manager} will be used on instances of the base Ext.Component
- * class which simply sizes the Component's encapsulating element to the height and width specified in the
- * {@link #setSize} method.
- */
- /**
- * @cfg {Ext.XTemplate/Ext.Template/String/String[]} tpl
- * An {@link Ext.Template}, {@link Ext.XTemplate} or an array of strings to form an Ext.XTemplate. Used in
- * conjunction with the `{@link #data}` and `{@link #tplWriteMode}` configurations.
- */
- /**
- * @cfg {Object} data
- * The initial set of data to apply to the `{@link #tpl}` to update the content area of the Component.
- */
- /**
- * @cfg {String} xtype
- * The `xtype` configuration option can be used to optimize Component creation and rendering. It serves as a
- * shortcut to the full componet name. For example, the component `Ext.button.Button` has an xtype of `button`.
- *
- * You can define your own xtype on a custom {@link Ext.Component component} by specifying the
- * {@link Ext.Class#alias alias} config option with a prefix of `widget`. For example:
- *
- * Ext.define('PressMeButton', {
- * extend: 'Ext.button.Button',
- * alias: 'widget.pressmebutton',
- * text: 'Press Me'
- * })
- *
- * Any Component can be created implicitly as an object config with an xtype specified, allowing it to be
- * declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is
- * rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources
- * until they are actually needed. In complex, nested layouts containing many Components, this can make a
- * noticeable improvement in performance.
- *
- * // Explicit creation of contained Components:
- * var panel = new Ext.Panel({
- * ...
- * items: [
- * Ext.create('Ext.button.Button', {
- * text: 'OK'
- * })
- * ]
- * };
- *
- * // Implicit creation using xtype:
- * var panel = new Ext.Panel({
- * ...
- * items: [{
- * xtype: 'button',
- * text: 'OK'
- * }]
- * };
- *
- * In the first example, the button will always be created immediately during the panel's initialization. With
- * many added Components, this approach could potentially slow the rendering of the page. In the second example,
- * the button will not be created or rendered until the panel is actually displayed in the browser. If the panel
- * is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and
- * will never consume any resources whatsoever.
- */
- /**
- * @cfg {String} tplWriteMode
- * The Ext.(X)Template method to use when updating the content area of the Component.
- * See `{@link Ext.XTemplate#overwrite}` for information on default mode.
- */
- tplWriteMode: 'overwrite',
- /**
- * @cfg {String} [baseCls='x-component']
- * 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. 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. 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='x-item-disabled']
- * CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
- */
- disabledCls: Ext.baseCSSPrefix + 'item-disabled',
- /**
- * @cfg {String/String[]} ui
- * A set style for a component. Can be a string or an Array of multiple strings (UIs)
- */
- ui: 'default',
- /**
- * @cfg {String[]} 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.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
- * True to hide the component.
- */
- hidden: false,
- /**
- * @cfg {Boolean} disabled
- * True to disable the component.
- */
- disabled: false,
- /**
- * @cfg {Boolean} [draggable=false]
- * Allows the component to be dragged.
- */
- /**
- * @property {Boolean} draggable
- * Read-only property indicating whether or not the component can be dragged
- */
- draggable: false,
- /**
- * @cfg {Boolean} floating
- * Create the Component as a floating and use absolute positioning.
- *
- * The z-index of floating Components is handled by a ZIndexManager. If you simply render a floating Component into the DOM, it will be managed
- * by the global {@link Ext.WindowManager WindowManager}.
- *
- * If you include a floating Component as a child item of a Container, then upon render, ExtJS will seek an ancestor floating Component to house a new
- * ZIndexManager instance to manage its descendant floaters. If no floating ancestor can be found, the global WindowManager will be used.
- *
- * When a floating Component which has a ZindexManager managing descendant floaters is destroyed, those descendant floaters will also be destroyed.
- */
- floating: false,
- /**
- * @cfg {String} hideMode
- * A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:
- *
- * - `'display'` : The Component will be hidden using the `display: none` style.
- * - `'visibility'` : The Component will be hidden using the `visibility: hidden` style.
- * - `'offsets'` : The Component will be hidden by absolutely positioning it out of the visible area of the document.
- * This is useful when a hidden Component must maintain measurable dimensions. Hiding using `display` results in a
- * Component having zero dimensions.
- */
- hideMode: 'display',
- /**
- * @cfg {String} contentEl
- * Specify an existing HTML element, or the `id` of an existing HTML element to use as the content for this component.
- *
- * This config option is used to take an existing HTML element and place it in the layout element of a new component
- * (it simply moves the specified DOM element _after the Component is rendered_ to use as the content.
- *
- * **Notes:**
- *
- * The specified HTML element is appended to the layout element of the component _after any configured
- * {@link #html HTML} has been inserted_, and so the document will not contain this element at the time
- * the {@link #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.DomHelper DomHelper} specification to use as the layout element content.
- * The HTML content is added after the component is rendered, so the document will not contain this HTML at the time
- * the {@link #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).
- */
- styleHtmlContent: false,
- /**
- * @cfg {String} [styleHtmlCls='x-html']
- * The class that is added to the content target when you set styleHtmlContent to true.
- */
- 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.
- */
- /**
- * @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 {Boolean/String/HTMLElement/Ext.Element} autoRender
- * This config is intended mainly for non-{@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}_. If {@link #floating} is true, the value of this config is omited as if it is `true`.
- *
- * Specify as `true` to have this Component render to the document body upon first show.
- *
- * Specify as an element, or the ID of an element to have this Component render to a specific element upon first
- * show.
- *
- * **This defaults to `true` for the {@link Ext.window.Window Window} class.**
- */
- autoRender: false,
- needsLayout: false,
- // @private
- allowDomMove: true,
- /**
- * @cfg {Object/Object[]} 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.
- */
- /**
- * @property {Boolean} rendered
- * Read-only property indicating whether or not the component has been rendered.
- */
- rendered: false,
- /**
- * @property {Number} componentLayoutCounter
- * @private
- * The number of component layout calls made on this object.
- */
- componentLayoutCounter: 0,
- weight: 0,
- trimRe: /^\s+|\s+$/g,
- spacesRe: /\s+/,
- /**
- * @property {Boolean} maskOnDisable
- * This is an internal flag that you use when creating custom components. By default this is set to true which means
- * that every component gets a mask when its disabled. Components like FieldContainer, FieldSet, Field, Button, Tab
- * override this property to false since they want to implement custom disable logic.
- */
- maskOnDisable: true,
- /**
- * Creates new Component.
- * @param {Object} config (optional) Config object.
- */
- 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);
- me.constructPlugins();
- }
- 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);
- // Save state on resize.
- this.addStateEvents('resize');
- // 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();
- }
- //<debug>
- 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;
- }
- //</debug>
- },
- initComponent: function () {
- // This is called again here to allow derived classes to add plugin configs to the
- // plugins array before calling down to this, the base initComponent.
- this.constructPlugins();
- },
- /**
- * The supplied default state gathering method for the AbstractComponent class.
- *
- * This method returns dimension settings such as `flex`, `anchor`, `width` and `height` along with `collapsed`
- * state.
- *
- * Subclasses which implement more complex state should call the superclass's implementation, and apply their state
- * to the result if this basic state is to be saved.
- *
- * Note that Component state will only be saved if the Component has a {@link #stateId} and there as a StateProvider
- * configured for the document.
- *
- * @return {Object}
- */
- getState: function() {
- var me = this,
- layout = me.ownerCt ? (me.shadowOwnerCt || me.ownerCt).getLayout() : null,
- state = {
- collapsed: me.collapsed
- },
- width = me.width,
- height = me.height,
- cm = me.collapseMemento,
- anchors;
- // If a Panel-local collapse has taken place, use remembered values as the dimensions.
- // TODO: remove this coupling with Panel's privates! All collapse/expand logic should be refactored into one place.
- if (me.collapsed && cm) {
- if (Ext.isDefined(cm.data.width)) {
- width = cm.width;
- }
- if (Ext.isDefined(cm.data.height)) {
- height = cm.height;
- }
- }
- // If we have flex, only store the perpendicular dimension.
- if (layout && me.flex) {
- state.flex = me.flex;
- if (layout.perpendicularPrefix) {
- state[layout.perpendicularPrefix] = me['get' + layout.perpendicularPrefixCap]();
- } else {
- //<debug>
- if (Ext.isDefined(Ext.global.console)) {
- Ext.global.console.warn('Ext.Component: Specified a flex value on a component not inside a Box layout');
- }
- //</debug>
- }
- }
- // If we have anchor, only store dimensions which are *not* being anchored
- else if (layout && me.anchor) {
- state.anchor = me.anchor;
- anchors = me.anchor.split(' ').concat(null);
- if (!anchors[0]) {
- if (me.width) {
- state.width = width;
- }
- }
- if (!anchors[1]) {
- if (me.height) {
- state.height = height;
- }
- }
- }
- // Store dimensions.
- else {
- if (me.width) {
- state.width = width;
- }
- if (me.height) {
- state.height = height;
- }
- }
- // Don't save dimensions if they are unchanged from the original configuration.
- if (state.width == me.initialConfig.width) {
- delete state.width;
- }
- if (state.height == me.initialConfig.height) {
- delete state.height;
- }
- // If a Box layout was managing the perpendicular dimension, don't save that dimension
- if (layout && layout.align && (layout.align.indexOf('stretch') !== -1)) {
- delete state[layout.perpendicularPrefix];
- }
- return state;
- },
- 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.
- *
- * @return {Ext.Component}
- */
- 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;
- },
- /**
- * Ensures that the plugins array contains fully constructed plugin instances. This converts any configs into their
- * appropriate instances.
- */
- constructPlugins: function() {
- var me = this,
- plugins = me.plugins,
- i, len;
- if (plugins) {
- for (i = 0, len = plugins.length; i < len; i++) {
- // this just returns already-constructed plugin instances...
- plugins[i] = me.constructPlugin(plugins[i]);
- }
- }
- },
- // @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) {
- // Flag set during the render process.
- // It can be used to inhibit event-driven layout calls during the render phase
- me.rendering = true;
- // 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.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);
- }
- // Delete the flag once the rendering is done.
- delete me.rendering;
- }
- return me;
- },
- // @private
- onRender : function(container, position) {
- var me = this,
- el = me.el,
- styles = me.initStyles(),
- renderTpl, renderData, i;
- position = me.getInsertPosition(position);
- if (!el) {
- if (position) {
- el = Ext.DomHelper.insertBefore(position, me.getElConfig(), true);
- }
- else {
- el = Ext.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'
- });
- }
- }
- me.setUI(me.ui);
- el.addCls(me.initCls());
- 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.initFrame();
- renderTpl = me.initRenderTpl();
- if (renderTpl) {
- renderData = me.initRenderData();
- renderTpl.append(me.getTargetEl(), renderData);
- }
- me.applyRenderSelectors();
- me.rendered = true;
- },
- // @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.
- // Also, if this is a collapsed Panel, it needs an initial component layout
- // to lay out its header so that it can have a height determined.
- if (me.collapsed || (!me.ownerCt || (me.height || me.width))) {
- me.setSize(me.width, me.height);
- } else {
- // It is expected that child items be rendered before this method returns and
- // the afterrender event fires. Since we aren't going to do the layout now, we
- // must render the child items. This is handled implicitly above in the layout
- // caused by setSize.
- me.renderChildren();
- }
- // For floaters, calculate x and y if they aren't defined by aligning
- // the sized element to the center of either the container or the ownerCt
- if (me.floating && (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);
- }
- },
- /**
- * @private
- * Called by Component#doAutoRender
- *
- * Register a Container configured `floating: true` with this Component's {@link Ext.ZIndexManager ZIndexManager}.
- *
- * Components added in ths way will not participate in any layout, but will be rendered
- * upon first show in the way that {@link Ext.window.Window Window}s are.
- */
- registerFloatingItem: function(cmp) {
- var me = this;
- if (!me.floatingItems) {
- me.floatingItems = Ext.create('Ext.ZIndexManager', me);
- }
- me.floatingItems.register(cmp);
- },
- renderChildren: function () {
- var me = this,
- layout = me.getComponentLayout();
- me.suspendLayout = true;
- layout.renderChildren();
- delete me.suspendLayout;
- },
- frameCls: Ext.baseCSSPrefix + 'frame',
- frameIdRegex: /[-]frame\d+[TMB][LCR]$/,
- frameElementCls: {
- tl: [],
- tc: [],
- tr: [],
- ml: [],
- mc: [],
- mr: [],
- bl: [],
- bc: [],
- br: []
- },
- frameTpl: [
- '<tpl if="top">',
- '<tpl if="left"><div id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl></tpl>" style="background-position: {tl}; padding-left: {frameWidth}px" role="presentation"></tpl>',
- '<tpl if="right"><div id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl></tpl>" style="background-position: {tr}; padding-right: {frameWidth}px" role="presentation"></tpl>',
- '<div id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl></tpl>" style="background-position: {tc}; height: {frameWidth}px" role="presentation"></div>',
- '<tpl if="right"></div></tpl>',
- '<tpl if="left"></div></tpl>',
- '</tpl>',
- '<tpl if="left"><div id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl></tpl>" style="background-position: {ml}; padding-left: {frameWidth}px" role="presentation"></tpl>',
- '<tpl if="right"><div id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl></tpl>" style="background-position: {mr}; padding-right: {frameWidth}px" role="presentation"></tpl>',
- '<div id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl></tpl>" role="presentation"></div>',
- '<tpl if="right"></div></tpl>',
- '<tpl if="left"></div></tpl>',
- '<tpl if="bottom">',
- '<tpl if="left"><div id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl></tpl>" style="background-position: {bl}; padding-left: {frameWidth}px" role="presentation"></tpl>',
- '<tpl if="right"><div id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl></tpl>" style="background-position: {br}; padding-right: {frameWidth}px" role="presentation"></tpl>',
- '<div id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl></tpl>" style="background-position: {bc}; height: {frameWidth}px" role="presentation"></div>',
- '<tpl if="right"></div></tpl>',
- '<tpl if="left"></div></tpl>',
- '</tpl>'
- ],
- frameTableTpl: [
- '<table><tbody>',
- '<tpl if="top">',
- '<tr>',
- '<tpl if="left"><td id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl></tpl>" style="background-position: {tl}; padding-left:{frameWidth}px" role="presentation"></td></tpl>',
- '<td id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl></tpl>" style="background-position: {tc}; height: {frameWidth}px" role="presentation"></td>',
- '<tpl if="right"><td id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl></tpl>" style="background-position: {tr}; padding-left: {frameWidth}px" role="presentation"></td></tpl>',
- '</tr>',
- '</tpl>',
- '<tr>',
- '<tpl if="left"><td id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl></tpl>" style="background-position: {ml}; padding-left: {frameWidth}px" role="presentation"></td></tpl>',
- '<td id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl></tpl>" style="background-position: 0 0;" role="presentation"></td>',
- '<tpl if="right"><td id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl></tpl>" style="background-position: {mr}; padding-left: {frameWidth}px" role="presentation"></td></tpl>',
- '</tr>',
- '<tpl if="bottom">',
- '<tr>',
- '<tpl if="left"><td id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl></tpl>" style="background-position: {bl}; padding-left: {frameWidth}px" role="presentation"></td></tpl>',
- '<td id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl></tpl>" style="background-position: {bc}; height: {frameWidth}px" role="presentation"></td>',
- '<tpl if="right"><td id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl></tpl>" style="background-position: {br}; padding-left: {frameWidth}px" role="presentation"></td></tpl>',
- '</tr>',
- '</tpl>',
- '</tbody></table>'
- ],
- /**
- * @private
- */
- initFrame : function() {
- if (Ext.supports.CSS3BorderRadius) {
- return false;
- }
- var me = this,
- frameInfo = me.getFrameInfo(),
- frameWidth = frameInfo.width,
- frameTpl = me.getFrameTpl(frameInfo.table),
- frameGenId;
- if (me.frame) {
- // since we render id's into the markup and id's NEED to be unique, we have a
- // simple strategy for numbering their generations.
- me.frameGenId = frameGenId = (me.frameGenId || 0) + 1;
- frameGenId = me.id + '-frame' + frameGenId;
- // Here we render the frameTpl to this component. This inserts the 9point div or the table framing.
- frameTpl.insertFirst(me.el, Ext.apply({}, {
- fgid: frameGenId,
- 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');
- // Clean out the childEls for the old frame elements (the majority of the els)
- me.removeChildEls(function (c) {
- return c.id && me.frameIdRegex.test(c.id);
- });
- // Add the childEls for each of the new frame elements
- Ext.each(['TL','TC','TR','ML','MC','MR','BL','BC','BR'], function (suffix) {
- me.childEls.push({ name: 'frame' + suffix, id: frameGenId + suffix });
- });
- }
- },
- 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) {
- //<debug error>
- 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.");
- //</debug>
- }
- 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 {String[]} 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);
- //<deprecated since=0.99>
- 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;
- }
- //</deprecated>
- 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 = [],
- classes = [],
- cls,
- i;
- //loop through all exisiting uiCls and update the ui in them
- for (i = 0; i < oldUICls.length; i++) {
- cls = oldUICls[i];
- classes = classes.concat(me.removeClsWithUI(cls, true));
- newUICls.push(cls);
- }
- if (classes.length) {
- me.removeCls(classes);
- }
- //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
- classes = [];
- for (i = 0; i < newUICls.length; i++) {
- cls = newUICls[i];
- classes = classes.concat(me.addClsWithUI(cls, true));
- }
- if (classes.length) {
- me.addCls(classes);
- }
- },
- /**
- * Adds a cls to the uiCls array, which will also call {@link #addUIClsToElement} and adds to all elements of this
- * component.
- * @param {String/String[]} cls A string or an array of strings to add to the uiCls
- * @param {Object} skip (Boolean) skip True to skip adding it to the class and do it later (via the return)
- */
- addClsWithUI: function(cls, skip) {
- var me = this,
- classes = [],
- 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]);
- classes = classes.concat(me.addUIClsToElement(cls[i]));
- }
- }
- if (skip !== true) {
- me.addCls(classes);
- }
- return classes;
- },
- /**
- * Removes a cls to the uiCls array, which will also call {@link #removeUIClsFromElement} and removes it from all
- * elements of this component.
- * @param {String/String[]} cls A string or an array of strings to remove to the uiCls
- */
- removeClsWithUI: function(cls, skip) {
- var me = this,
- classes = [],
- 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]);
- classes = classes.concat(me.removeUIClsFromElement(cls[i]));
- }
- }
- if (skip !== true) {
- me.removeCls(classes);
- }
- return classes;
- },
- /**
- * 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
- */
- addUIClsToElement: function(cls, force) {
- var me = this,
- result = [],
- frameElementCls = me.frameElementCls;
- result.push(Ext.baseCSSPrefix + cls);
- result.push(me.baseCls + '-' + cls);
- result.push(me.baseCls + '-' + me.ui + '-' + cls);
- if (!force && me.frame && !Ext.supports.CSS3BorderRadius) {
- // define each element of the frame
- var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'],
- classes, i, j, 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()];
- classes = [me.baseCls + '-' + me.ui + '-' + els[i], me.baseCls + '-' + me.ui + '-' + cls + '-' + els[i]];
- if (el && el.dom) {
- el.addCls(classes);
- } else {
- for (j = 0; j < classes.length; j++) {
- if (Ext.Array.indexOf(frameElementCls[els[i]], classes[j]) == -1) {
- frameElementCls[els[i]].push(classes[j]);
- }
- }
- }
- }
- }
- me.frameElementCls = frameElementCls;
- return result;
- },
- /**
- * Method which removes a specified UI + uiCls from the components element. The cls which is added to the element
- * will be: `this.baseCls + '-' + ui`
- * @param {String} ui The UI to add to the element
- */
- removeUIClsFromElement: function(cls, force) {
- var me = this,
- result = [],
- frameElementCls = me.frameElementCls;
- result.push(Ext.baseCSSPrefix + cls);
- result.push(me.baseCls + '-' + cls);
- result.push(me.baseCls + '-' + me.ui + '-' + cls);
- if (!force && me.frame && !Ext.supports.CSS3BorderRadius) {
- // define each element of the frame
- var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'],
- i, el;
- cls = me.baseCls + '-' + me.ui + '-' + cls + '-' + els[i];
- // 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(cls);
- } else {
- Ext.Array.remove(frameElementCls[els[i]], cls);
- }
- }
- }
- me.frameElementCls = frameElementCls;
- return result;
- },
- /**
- * Method which adds a specified UI to the components element.
- * @private
- */
- addUIToElement: function(force) {
- var me = this,
- frameElementCls = me.frameElementCls;
- me.addCls(me.baseCls + '-' + me.ui);
- if (me.frame && !Ext.supports.CSS3BorderRadius) {
- // define each element of the frame
- var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'],
- i, el, cls;
- // 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()];
- cls = me.baseCls + '-' + me.ui + '-' + els[i];
- if (el) {
- el.addCls(cls);
- } else {
- if (!Ext.Array.contains(frameElementCls[els[i]], cls)) {
- frameElementCls[els[i]].push(cls);
- }
- }
- }
- }
- },
- /**
- * Method which removes a specified UI from the components element.
- * @private
- */
- removeUIFromElement: function() {
- var me = this,
- frameElementCls = me.frameElementCls;
- me.removeCls(me.baseCls + '-' + me.ui);
- if (me.frame && !Ext.supports.CSS3BorderRadius) {
- // define each element of the frame
- var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'],
- i, j, el, cls;
- // 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()];
- cls = me.baseCls + '-' + me.ui + '-' + els[i];
- if (el) {
- el.removeCls(cls);
- } else {
- Ext.Array.remove(frameElementCls[els[i]], cls);
- }
- }
- }
- },
- getElConfig : function() {
- if (Ext.isString(this.autoEl)) {
- this.autoEl = {
- tag: this.autoEl
- };
- }
- 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/Ext.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.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, {
- id: me.id,
- ui: me.ui,
- uiCls: me.uiCls,
- baseCls: me.baseCls,
- componentCls: me.componentCls,
- frame: me.frame
- });
- },
- /**
- * @private
- */
- getTpl: function(name) {
- var me = this,
- prototype = me.self.prototype,
- ownerPrototype,
- tpl;
- if (me.hasOwnProperty(name)) {
- tpl = me[name];
- if (tpl && !(tpl instanceof Ext.XTemplate)) {
- me[name] = Ext.ClassManager.dynInstantiate('Ext.XTemplate', tpl);
- }
- return me[name];
- }
- if (!(prototype[name] instanceof Ext.XTemplate)) {
- ownerPrototype = prototype;
- do {
- if (ownerPrototype.hasOwnProperty(name)) {
- tpl = ownerPrototype[name];
- if (tpl && !(tpl instanceof Ext.XTemplate)) {
- ownerPrototype[name] = Ext.ClassManager.dynInstantiate('Ext.XTemplate', tpl);
- 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');
- },
- /**
- * Converts style definitions to String.
- * @return {String} A CSS style string with style, padding, margin and border.
- * @private
- */
- initStyles: function() {
- var style = {},
- me = this,
- Element = Ext.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.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,
- el,
- property,
- fn = function(listeners){
- me.mon(el, listeners);
- };
- if (afterRenderEvents) {
- for (property in afterRenderEvents) {
- if (afterRenderEvents.hasOwnProperty(property)) {
- el = me[property];
- if (el && el.on) {
- Ext.each(afterRenderEvents[property], fn);
- }
- }
- }
- }
- },
- /**
- * Adds each argument passed to this method to the {@link #childEls} array.
- */
- addChildEls: function () {
- var me = this,
- childEls = me.childEls || (me.childEls = []);
- childEls.push.apply(childEls, arguments);
- },
- /**
- * Removes items in the childEls array based on the return value of a supplied test function. The function is called
- * with a entry in childEls and if the test function return true, that entry is removed. If false, that entry is
- * kept.
- * @param {Function} testFn The test function.
- */
- removeChildEls: function (testFn) {
- var me = this,
- old = me.childEls,
- keepers = (me.childEls = []),
- n, i, cel;
- for (i = 0, n = old.length; i < n; ++i) {
- cel = old[i];
- if (!testFn(cel)) {
- keepers.push(cel);
- }
- }
- },
- /**
- * Sets references to elements inside the component. This applies {@link #renderSelectors}
- * as well as {@link #childEls}.
- * @private
- */
- applyRenderSelectors: function() {
- var me = this,
- childEls = me.childEls,
- selectors = me.renderSelectors,
- el = me.el,
- dom = el.dom,
- baseId, childName, childId, i, selector;
- if (childEls) {
- baseId = me.id + '-';
- for (i = childEls.length; i--; ) {
- childName = childId = childEls[i];
- if (typeof(childName) != 'string') {
- childId = childName.id || (baseId + childName.itemId);
- childName = childName.name;
- } else {
- childId = baseId + childId;
- }
- // We don't use Ext.get because that is 3x (or more) slower on IE6-8. Since
- // we know the el's are children of our el we use getById instead:
- me[childName] = el.getById(childId);
- }
- }
- // We still support renderSelectors. There are a few places in the framework that
- // need them and they are a documented part of the API. In fact, we support mixing
- // childEls and renderSelectors (no reason not to).
- if (selectors) {
- for (selector in selectors) {
- if (selectors.hasOwnProperty(selector) && selectors[selector]) {
- me[selector] = Ext.get(Ext.DomQuery.selectNode(selectors[selector], dom));
- }
- }
- }
- },
- /**
- * 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] The simple selector to test.
- * @return {Ext.container.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] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following items.
- * @return {Ext.Component} The next sibling (or the next sibling which matches the selector).
- * Returns null if there is no matching sibling.
- */
- nextSibling: function(selector) {
- var o = this.ownerCt, it, last, idx, c;
- if (o) {
- it = o.items;
- idx = it.indexOf(this) + 1;
- if (idx) {
- if (selector) {
- for (last = it.getCount(); idx < last; idx++) {
- if ((c = it.getAt(idx)).is(selector)) {
- return c;
- }
- }
- } else {
- if (idx < it.getCount()) {
- return it.getAt(idx);
- }
- }
- }
- }
- return null;
- },
- /**
- * Returns the previous sibling of this Component.
- *
- * Optionally selects the previous sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery}
- * selector.
- *
- * May also be 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] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding items.
- * @return {Ext.Component} The previous sibling (or the previous sibling which matches the selector).
- * Returns null if there is no matching sibling.
- */
- previousSibling: function(selector) {
- var o = this.ownerCt, it, idx, c;
- if (o) {
- it = o.items;
- idx = it.indexOf(this);
- if (idx != -1) {
- if (selector) {
- for (--idx; idx >= 0; idx--) {
- if ((c = it.getAt(idx)).is(selector)) {
- return c;
- }
- }
- } else {
- if (idx) {
- return it.getAt(--idx);
- }
- }
- }
- }
- return null;
- },
- /**
- * Returns the previous node in the Component tree in tree traversal order.
- *
- * Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the
- * tree in reverse order to attempt to find a match. Contrast with {@link #previousSibling}.
- * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding nodes.
- * @return {Ext.Component} The previous node (or the previous node which matches the selector).
- * Returns null if there is no matching node.
- */
- previousNode: function(selector, 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 #nextSibling}.
- * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following nodes.
- * @return {Ext.Component} The next node (or the next node which matches the selector).
- * Returns null if there is no matching node.
- */
- nextNode: function(selector, 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.
- * @return {String}
- */
- 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.
- * @return {Ext.core.Element}
- */
- 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=false] True to check whether this Component is directly of the specified xtype, false to
- * check whether this Component is descended from the xtype.
- * @return {Boolean} True if this component descends from the specified xtype, false otherwise.
- */
- 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, parentXtypes;
- if (!self.xtypes) {
- xtypes = [];
- parentPrototype = this;
- while (parentPrototype) {
- parentXtypes = parentPrototype.xtypes;
- if (parentXtypes !== undefined) {
- xtypes.unshift.apply(xtypes, parentXtypes);
- }
- parentPrototype = parentPrototype.superclass;
- }
- self.xtypeChain = xtypes;
- self.xtypes = xtypes.join('/');
- }
- return self.xtypes;
- },
- /**
- * Update the content area of a component.
- * @param {String/Object} htmlOrData If this component has been configured with a template via the tpl config then
- * it will use this argument as data to populate the template. If this component was not configured with a template,
- * the components content area will be updated via Ext.Element update
- * @param {Boolean} [loadScripts=false] Only legitimate when using the html configuration.
- * @param {Function} [callback] Only legitimate when using the html configuration. Callback to execute when
- * scripts have finished loading
- */
- 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.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=false] Pass `true` to interrogate the visibility status of all parent Containers to
- * determine whether this Component is truly visible to the user.
- *
- * Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating
- * dynamically laid out UIs in a hidden Container before showing them.
- *
- * @return {Boolean} True if this component is visible, false otherwise.
- */
- 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=false] Passing true 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=false] 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 True to disable.
- */
- setDisabled : function(disabled) {
- return this[disabled ? 'disable': 'enable']();
- },
- /**
- * Method to determine whether this Component is currently set to hidden.
- * @return {Boolean} the hidden state of this Component.
- */
- isHidden : function() {
- return this.hidden;
- },
- /**
- * Adds a CSS class to the top level element representing this component.
- * @param {String} 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;
- },
- /**
- * 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.
- * @param {Object} className
- * @return {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;
- },
- //<debug>
- 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);
- },
- //</debug>
- addOverCls: function() {
- var me = this;
- if (!me.disabled) {
- me.el.addCls(me.overCls);
- }
- },
- removeOverCls: function() {
- this.el.removeCls(this.overCls);
- },
- addListener : function(element, listeners, scope, options) {
- var me = this,
- fn,
- option;
- if (Ext.isString(element) && (Ext.isObject(listeners) || options && options.element)) {
- if (options.element) {
- fn = listeners;
- listeners = {};
- listeners[element] = fn;
- element = options.element;
- if (scope) {
- listeners.scope = scope;
- }
- for (option in options) {
- if (options.hasOwnProperty(option)) {
- if (me.eventOptionsRe.test(option)) {
- listeners[option] = options[option];
- }
- }
- }
- }
- // At this point we have a variable called element,
- // and a listeners object that can be passed to on
- if (me[element] && me[element].on) {
- me.mon(me[element], listeners);
- } else {
- me.afterRenderEvents = me.afterRenderEvents || {};
- if (!me.afterRenderEvents[element]) {
- me.afterRenderEvents[element] = [];
- }
- me.afterRenderEvents[element].push(listeners);
- }
- }
- return 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 {Number/String/Object} width The new width to set. This may be one of:
- *
- * - A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).
- * - A String used to set the CSS width style.
- * - A size object in the format `{width: widthValue, height: heightValue}`.
- * - `undefined` to leave the width unchanged.
- *
- * @param {Number/String} height The new height to set (not required if a size object is passed as the first arg).
- * This may be one of:
- *
- * - A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).
- * - A String used to set the CSS height style. Animation may **not** be used.
- * - `undefined` to leave the height unchanged.
- *
- * @return {Ext.Component} this
- */
- setSize : function(width, height) {
- var me = this,
- 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;
- },
- isFixedWidth: function() {
- var me = this,
- layoutManagedWidth = me.layoutManagedWidth;
- if (Ext.isDefined(me.width) || layoutManagedWidth == 1) {
- return true;
- }
- if (layoutManagedWidth == 2) {
- return false;
- }
- return (me.ownerCt && me.ownerCt.isFixedWidth());
- },
- isFixedHeight: function() {
- var me = this,
- layoutManagedHeight = me.layoutManagedHeight;
- if (Ext.isDefined(me.height) || layoutManagedHeight == 1) {
- return true;
- }
- if (layoutManagedHeight == 2) {
- return false;
- }
- return (me.ownerCt && me.ownerCt.isFixedHeight());
- },
- setCalculatedSize : function(width, height, callingContainer) {
- var me = this,
- layoutCollection;
- // support for standard size objects
- if (Ext.isObject(width)) {
- callingContainer = 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: callingContainer
- };
- return me;
- }
- me.doComponentLayout(width, height, false, callingContainer);
- return me;
- },
- /**
- * This method needs to be called whenever you change something on this component that requires the Component's
- * layout to be recalculated.
- * @param {Object} width
- * @param {Object} height
- * @param {Object} isSetSize
- * @param {Object} callingContainer
- * @return {Ext.container.Container} this
- */
- doComponentLayout : function(width, height, isSetSize, callingContainer) {
- var me = this,
- componentLayout = me.getComponentLayout(),
- lastComponentSize = componentLayout.lastComponentSize || {
- width: undefined,
- height: undefined
- };
- // 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) {
- // If no width passed, then only insert a value if the Component is NOT ALLOWED to autowidth itself.
- if (!Ext.isDefined(width)) {
- if (me.isFixedWidth()) {
- width = Ext.isDefined(me.width) ? me.width : lastComponentSize.width;
- }
- }
- // If no height passed, then only insert a value if the Component is NOT ALLOWED to autoheight itself.
- if (!Ext.isDefined(height)) {
- if (me.isFixedHeight()) {
- height = Ext.isDefined(me.height) ? me.height : lastComponentSize.height;
- }
- }
- if (isSetSize) {
- me.width = width;
- me.height = height;
- }
- componentLayout.layout(width, height, isSetSize, callingContainer);
- }
- return me;
- },
- /**
- * Forces this component to redo its componentLayout.
- */
- forceComponentLayout: function () {
- this.doComponentLayout();
- },
- // @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;
- },
- /**
- * Occurs after componentLayout is run.
- * @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} callingContainer Container requesting the layout. Only used when isSetSize is false.
- */
- afterComponentLayout: function(width, height, isSetSize, callingContainer) {
- var me = this,
- layout = me.componentLayout,
- oldSize = me.preLayoutSize;
- ++me.componentLayoutCounter;
- if (!oldSize || ((width !== oldSize.width) || (height !== oldSize.height))) {
- me.fireEvent('resize', me, 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} callingContainer Container requesting sent the layout. Only used when isSetSize is false.
- */
- beforeComponentLayout: function(width, height, isSetSize, callingContainer) {
- this.preLayoutSize = this.componentLayout.lastComponentSize;
- return true;
- },
- /**
- * Sets the left and top of the component. To set the page XY position instead, use
- * {@link Ext.Component#setPagePosition setPagePosition}. This method fires the {@link #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.Element#defaultUnit}s (by default, pixels).
- * - A String used to set the CSS width style.
- *
- * @return {Ext.Component} this
- */
- setWidth : function(width) {
- return this.setSize(width);
- },
- /**
- * Sets the height of the component. This method fires the {@link #resize} event.
- *
- * @param {Number} height The new height to set. This may be one of:
- *
- * - A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).
- * - A String used to set the CSS height style.
- * - _undefined_ to leave the height unchanged.
- *
- * @return {Ext.Component} this
- */
- setHeight : function(height) {
- return this.setSize(undefined, height);
- },
- /**
- * Gets the current size of the component's underlying element.
- * @return {Object} An object containing the element's size {width: (element width), height: (element height)}
- */
- getSize : function() {
- return this.el.getSize();
- },
- /**
- * Gets the current width of the component's underlying element.
- * @return {Number}
- */
- getWidth : function() {
- return this.el.getWidth();
- },
- /**
- * Gets the current height of the component's underlying element.
- * @return {Number}
- */
- getHeight : function() {
- return this.el.getHeight();
- },
- /**
- * Gets the {@link Ext.ComponentLoader} for this Component.
- * @return {Ext.ComponentLoader} The loader instance, null if it doesn't exist.
- */
- getLoader: function(){
- var me = this,
- autoLoad = me.autoLoad ? (Ext.isObject(me.autoLoad) ? me.autoLoad : {url: me.autoLoad}) : null,
- loader = me.loader || autoLoad;
- if (loader) {
- if (!loader.isLoader) {
- me.loader = 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=false] 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.
- * @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)
- * @param {Object} dock The dock position.
- * @param {Boolean} [layoutParent=false] True to re-layout parent.
- * @return {Ext.Component} this
- */
- setDocked : function(dock, layoutParent) {
- var me = this;
- me.dock = dock;
- if (layoutParent && me.ownerCt && me.rendered) {
- me.ownerCt.doComponentLayout();
- }
- return me;
- },
- onDestroy : function() {
- var me = this;
- if (me.monitorResize && Ext.EventManager.resizeEvent) {
- Ext.EventManager.resizeEvent.removeListener(me.setSize, me);
- }
- // Destroying the floatingItems ZIndexManager will also destroy descendant floating Components
- Ext.destroy(
- me.componentLayout,
- me.loadMask,
- me.floatingItems
- );
- },
- /**
- * Remove any references to elements added via renderSelectors/childEls
- * @private
- */
- cleanElementRefs: function(){
- var me = this,
- i = 0,
- childEls = me.childEls,
- selectors = me.renderSelectors,
- selector,
- name,
- len;
- if (me.rendered) {
- if (childEls) {
- for (len = childEls.length; i < len; ++i) {
- name = childEls[i];
- if (typeof(name) != 'string') {
- name = name.name;
- }
- delete me[name];
- }
- }
- if (selectors) {
- for (selector in selectors) {
- if (selectors.hasOwnProperty(selector)) {
- delete me[selector];
- }
- }
- }
- }
- delete me.rendered;
- delete me.el;
- delete me.frameBody;
- },
- /**
- * 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);
- }
- me.onDestroy();
- // Attempt to destroy all plugins
- Ext.destroy(me.plugins);
- if (me.rendered) {
- me.el.remove();
- }
- me.fireEvent('destroy', me);
- Ext.ComponentManager.unregister(me);
- me.mixins.state.destroy.call(me);
- me.clearListeners();
- // make sure we clean up the element references after removing all events
- me.cleanElementRefs();
- me.destroying = false;
- me.isDestroyed = true;
- }
- }
- },
- /**
- * Retrieves a plugin by its pluginId which has been bound to this component.
- * @param {Object} pluginId
- * @return {Ext.AbstractPlugin} plugin instance.
- */
- 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
- * @return {Boolean} True if it is.
- */
- isDescendantOf: function(container) {
- return !!this.findParentBy(function(p){
- return p === container;
- });
- }
- }, function() {
- this.createAlias({
- on: 'addListener',
- prev: 'previousSibling',
- next: 'nextSibling'
- });
- });
- /**
- * The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
- *
- * This class defines the essential API of plugins as used by Components by defining the following methods:
- *
- * - `init` : The plugin initialization method which the owning Component calls at Component initialization time.
- *
- * The Component passes itself as the sole parameter.
- *
- * Subclasses should set up bidirectional links between the plugin and its client Component here.
- *
- * - `destroy` : The plugin cleanup method which the owning Component calls at Component destruction time.
- *
- * Use this method to break links between the plugin and the Component and to free any allocated resources.
- *
- * - `enable` : The base implementation just sets the plugin's `disabled` flag to `false`
- *
- * - `disable` : The base implementation just sets the plugin's `disabled` flag to `true`
- */
- Ext.define('Ext.AbstractPlugin', {
- disabled: false,
- constructor: function(config) {
- //<debug>
- if (!config.cmp && Ext.global.console) {
- Ext.global.console.warn("Attempted to attach a plugin ");
- }
- //</debug>
- Ext.apply(this, config);
- },
- getCmp: function() {
- return this.cmp;
- },
- /**
- * @method
- * The init method is invoked after initComponent method has been run for the client Component.
- *
- * The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
- * links between the plugin and its client Component in their own implementation of this method.
- * @param {Ext.Component} client The client Component which owns this plugin.
- */
- init: Ext.emptyFn,
- /**
- * @method
- * The destroy method is invoked by the owning Component at the time the Component is being destroyed.
- *
- * The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of
- * this method.
- */
- destroy: Ext.emptyFn,
- /**
- * The base implementation just sets the plugin's `disabled` flag to `false`
- *
- * Plugin subclasses which need more complex processing may implement an overriding implementation.
- */
- enable: function() {
- this.disabled = false;
- },
- /**
- * The base implementation just sets the plugin's `disabled` flag to `true`
- *
- * Plugin subclasses which need more complex processing may implement an overriding implementation.
- */
- disable: function() {
- this.disabled = true;
- }
- });
- /**
- * 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
- * True to add a unique cache-buster param to GET requests.
- */
- disableCaching: true,
- /**
- * @cfg {Boolean} withCredentials
- * True to set `withCredentials = true` on the XHR object
- */
- withCredentials: false,
- /**
- * @cfg {Boolean} cors
- * True to enable CORS support on the XHR object. Currently the only effect of this option
- * is to use the XDomainRequest object instead of XMLHttpRequest if the browser is IE8 or above.
- */
- cors: false,
- /**
- * @cfg {String} disableCachingParam
- * Change the parameter which is sent went disabling caching through a cache buster.
- */
- disableCachingParam: '_dc',
- /**
- * @cfg {Number} timeout
- * The timeout in milliseconds to be used for requests.
- */
- timeout : 30000,
- /**
- * @cfg {Object} extraParams
- * Any parameters to be appended to the request.
- */
- 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 {Ext.data.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 {Ext.data.Connection} conn This Connection object.
- * @param {Object} response The XHR object containing the response data.
- * See [The XMLHttpRequest Object](http://www.w3.org/TR/XMLHttpRequest/) for details.
- * @param {Object} options The options config object passed to the {@link #request} method.
- */
- 'requestcomplete',
- /**
- * @event requestexception
- * Fires if an error HTTP status was returned from the server.
- * See [HTTP Status Code Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)
- * for details of HTTP status codes.
- * @param {Ext.data.Connection} conn This Connection object.
- * @param {Object} response The XHR object containing the response data.
- * See [The XMLHttpRequest Object](http://www.w3.org/TR/XMLHttpRequest/) for details.
- * @param {Object} options The options config object passed to the {@link #request} method.
- */
- '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:
- *
- * (The options object may also contain any other property which might be needed to perform
- * postprocessing in a callback because it is passed to callback functions.)
- *
- * @param {String/Function} options.url The URL to which to send the request, or a function
- * to call which returns a URL string. The scope of the function is specified by the `scope` option.
- * Defaults to the configured `url`.
- *
- * @param {Object/String/Function} options.params An object containing properties which are
- * used as parameters to the request, a url encoded string or a function to call to get either. The scope
- * of the function is specified by the `scope` option.
- *
- * @param {String} options.method The HTTP method to use
- * for the request. Defaults to the configured method, or if no method was configured,
- * "GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that
- * the method name is case-sensitive and should be all caps.
- *
- * @param {Function} options.callback The function to be called upon receipt of the HTTP response.
- * The callback is called regardless of success or failure and is passed the following parameters:
- * @param {Object} options.callback.options The parameter to the request call.
- * @param {Boolean} options.callback.success True if the request succeeded.
- * @param {Object} options.callback.response The XMLHttpRequest object containing the response data.
- * See [www.w3.org/TR/XMLHttpRequest/](http://www.w3.org/TR/XMLHttpRequest/) for details about
- * accessing elements of the response.
- *
- * @param {Function} options.success The function to be called upon success of the request.
- * The callback is passed the following parameters:
- * @param {Object} options.success.response The XMLHttpRequest object containing the response data.
- * @param {Object} options.success.options The parameter to the request call.
- *
- * @param {Function} options.failure The function to be called upon success of the request.
- * The callback is passed the following parameters:
- * @param {Object} options.failure.response The XMLHttpRequest object containing the response data.
- * @param {Object} options.failure.options The parameter to the request call.
- *
- * @param {Object} options.scope The scope in which to execute the callbacks: The "this" object for
- * the callback function. If the `url`, or `params` options were specified as functions from which to
- * draw values, then this also serves as the scope for those function calls. Defaults to the browser
- * window.
- *
- * @param {Number} options.timeout The timeout in milliseconds to be used for this request.
- * Defaults to 30 seconds.
- *
- * @param {Ext.Element/HTMLElement/String} options.form The `<form>` Element or the id of the `<form>`
- * to pull parameters from.
- *
- * @param {Boolean} options.isUpload **Only meaningful when used with the `form` option.**
- *
- * True if the form object is a file upload (will be set automatically if the form was configured
- * with **`enctype`** `"multipart/form-data"`).
- *
- * File uploads are not performed using normal "Ajax" techniques, that is they are **not**
- * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
- * DOM `<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.
- *
- * [target]: http://www.w3.org/TR/REC-html40/present/frames.html#adef-target
- * [Content-Type]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
- * [multipart/form]: http://www.faqs.org/rfcs/rfc2388.html
- *
- * @param {Object} options.headers Request headers to set for the request.
- *
- * @param {Object} options.xmlData 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.
- *
- * @param {Object/String} options.jsonData 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.
- *
- * @param {Boolean} options.disableCaching True to add a unique cache-buster param to GET requests.
- *
- * @param {Boolean} options.withCredentials True to add the withCredentials property to the XHR object
- *
- * @return {Object} 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
- if ((options.cors === true || me.cors === true) && Ext.isIe && Ext.ieVersion >= 8) {
- xhr = new XDomainRequest();
- } else {
- 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);
- }
- if (options.withCredentials === true || me.withCredentials === true) {
- xhr.withCredentials = true;
- }
- 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;
- me.latestId = request.id;
- // 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;
- }
- },
- /**
- * Uploads a form using a hidden iframe.
- * @param {String/HTMLElement/Ext.Element} 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);
- });
- },
- /**
- * @private
- * Callback handler for the upload function. After we've submitted the form via the iframe this creates a bogus
- * response object to simulate an XHR and populates its responseText from the now-loaded iframe's document body
- * (or a textarea inside the body). We then clean up by removing the iframe
- */
- 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[frame.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);
- },
- /**
- * Detects 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;
- },
- /**
- * Gets 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;
- },
- /**
- * Sets 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);
- //<debug>
- if (!url) {
- Ext.Error.raise({
- options: options,
- msg: 'No URL specified'
- });
- }
- //</debug>
- // 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
- * @template
- * @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
- * @template
- * @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.Element.serializeForm(form);
- params = params ? (params + '&' + serializedForm) : serializedForm;
- }
- return params;
- },
- /**
- * Template method for overriding method
- * @template
- * @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;
- })(),
- /**
- * Determines whether this object has a request outstanding.
- * @param {Object} [request] Defaults to the last transaction
- * @return {Boolean} True if there is an outstanding request.
- */
- isLoading : function(request) {
- if (!request) {
- request = this.getLatest();
- }
- 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 an active request.
- * @param {Object} [request] Defaults to the last request
- */
- abort : function(request) {
- var me = this;
-
- if (!request) {
- request = me.getLatest();
- }
- 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);
- }
- },
-
- /**
- * Aborts all active requests
- */
- abortAll: function(){
- var requests = this.requests,
- id;
-
- for (id in requests) {
- if (requests.hasOwnProperty(id)) {
- this.abort(requests[id]);
- }
- }
- },
-
- /**
- * Gets the most recent request
- * @private
- * @return {Object} The request. Null if there is no recent request
- */
- getLatest: function(){
- var id = this.latestId,
- request;
-
- if (id) {
- request = this.requests[id];
- }
- return request || null;
- },
- /**
- * 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);
- }
- },
- /**
- * Clears the timeout on the request
- * @private
- * @param {Object} The request
- */
- clearTimeout: function(request){
- clearTimeout(request.timeout);
- delete request.timeout;
- },
- /**
- * Cleans 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,
- success,
- response;
- try {
- result = me.parseStatus(request.xhr.status);
- } catch (e) {
- // in some browsers we can't access the status if the readyState is not 4, so the request has failed
- result = {
- success : false,
- isException : false
- };
- }
- success = result.success;
- 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;
- },
- /**
- * Checks 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
- };
- },
- /**
- * Creates 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;
- },
- /**
- * Creates 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 {Boolean} disableCaching
- * True to add a unique cache-buster param to GET requests. Defaults to true.
- */
- /**
- * @property {String} url
- * The default URL to be used for requests to the server.
- * If the server receives all requests through one URL, setting this once is easier than
- * entering it on every request.
- */
- /**
- * @property {Object} extraParams
- * An object containing properties which are used as extra parameters to each request made
- * by this object. Session information and other data that you need
- * to pass with each request are commonly put here.
- */
- /**
- * @property {Object} defaultHeaders
- * An object containing request headers which are added to each request made by this object.
- */
- /**
- * @property {String} method
- * The default HTTP method to be used for requests. Note that this is case-sensitive and
- * should be all caps (if not set but params are present will use
- * <tt>"POST"</tt>, otherwise will use <tt>"GET"</tt>.)
- */
- /**
- * @property {Number} timeout
- * The timeout in milliseconds to be used for requests. Defaults to 30000.
- */
- /**
- * @property {Boolean} autoAbort
- * Whether a new request should abort any pending requests.
- */
- autoAbort : false
- });
- /**
- * 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.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.
- */
- 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.
- */
- 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.
- */
- baseParams: null,
- /**
- * @cfg {Boolean/Object} autoLoad
- * True to have the loader make a request as soon as it is created.
- * This argument can also be a set of options that will be passed to {@link #load} is called.
- */
- autoLoad: false,
- /**
- * @cfg {HTMLElement/Ext.Element/String} target
- * The target element for the loader. It can be the DOM element, the id or an {@link Ext.Element}.
- */
- target: null,
- /**
- * @cfg {Boolean/String} 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.
- */
- 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.
- * Will be called with the following config parameters:
- *
- * - this - The ElementLoader instance.
- * - response - The response object.
- * - options - Ajax options.
- */
- /**
- * @cfg {Function} failure A function to be called when a load request fails.
- * Will be called with the following config parameters:
- *
- * - this - The ElementLoader instance.
- * - response - The response object.
- * - options - Ajax options.
- */
- /**
- * @cfg {Function} callback A function to be called when a load request finishes.
- * Will be called with the following config parameters:
- *
- * - this - The ElementLoader instance.
- * - success - True if successful request.
- * - response - The response object.
- * - options - Ajax options.
- */
- /**
- * @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 load
- * 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);
- }
- },
- /**
- * Sets an {@link Ext.Element} as the target of this loader.
- * Note that if the target is changed, any active requests will be aborted.
- * @param {String/HTMLElement/Ext.Element} target The element or its ID.
- */
- setTarget: function(target){
- var me = this;
- target = Ext.get(target);
- if (me.target && me.target != target) {
- me.abort();
- }
- me.target = target;
- },
- /**
- * Returns the target of this loader.
- * @return {Ext.Component} The target or 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;
- }
- },
- /**
- * Removes the mask on the target
- * @private
- */
- removeMask: function(){
- this.target.unmask();
- },
- /**
- * Adds the mask on the target
- * @private
- * @param {Boolean/Object} mask The mask configuration
- */
- addMask: function(mask){
- this.target.mask(mask === true ? null : mask);
- },
- /**
- * Loads 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) {
- //<debug>
- if (!this.target) {
- Ext.Error.raise('A valid target is required when loading content');
- }
- //</debug>
- 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
- });
- //<debug>
- if (!options.url) {
- Ext.Error.raise('You must specify the URL from which content should be loaded');
- }
- //</debug>
- 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);
- },
- /**
- * Sets any additional options on the active request
- * @private
- * @param {Object} active The active request
- * @param {Object} options The initial options
- */
- setOptions: Ext.emptyFn,
- /**
- * Parses 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.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.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.Container#add}. Using this renderer has the same effect as specifying
- * the {@link Ext.container.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 = [];
- //<debug>
- if (!target.isContainer) {
- Ext.Error.raise({
- target: target,
- msg: 'Components can only be loaded into a container'
- });
- }
- //</debug>
- 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.
- * If a string is passed it will be looked up via the id.
- */
- target: null,
- /**
- * @cfg {Boolean/Object} loadMask True or a {@link Ext.LoadMask} configuration to enable masking during loading.
- */
- 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.
- 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;
- }
- }
- });
- */
- 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 {Boolean/Object} 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;
- }
- }
- });
- /**
- * @author Ed Spencer
- *
- * 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',
- * 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'));
- * });
- * }
- * });
- *
- * });
- *
- */
- Ext.define('Ext.data.Association', {
- /**
- * @cfg {String} ownerModel (required)
- * The string name of the model that owns the association.
- */
- /**
- * @cfg {String} associatedModel (required)
- * The string name of the model that is being associated with.
- */
- /**
- * @cfg {String} primaryKey
- * The name of the primary key on the associated model. 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:
- //<debug>
- Ext.Error.raise('Unknown Association type: "' + association.type + '"');
- //</debug>
- }
- }
- return association;
- }
- },
- /**
- * Creates the Association object.
- * @param {Object} [config] Config object.
- */
- 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;
- //<debug>
- 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 + ")");
- }
- //</debug>
- this.ownerModel = ownerModel;
- this.associatedModel = associatedModel;
- /**
- * @property {String} ownerName
- * The name of the model that 'owns' the association
- */
- /**
- * @property {String} associatedName
- * The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is
- * 'Order')
- */
- 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 Ext#create Ext.create} method. Ext.create replaces
- the deprecated {@link #create Ext.ModelManager.create} method. It is also possible to create a model instance
- this by using the Model type directly. The following 3 snippets are equivalent:
- Ext.define('User', {
- extend: 'Ext.data.Model',
- fields: ['first', 'last']
- });
- // method 1, create using Ext.create (recommended)
- Ext.create('User', {
- first: 'Ed',
- last: 'Spencer'
- });
- // method 2, create through the manager (deprecated)
- Ext.ModelManager.create({
- first: 'Ed',
- last: 'Spencer'
- }, 'User');
- // method 3, 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 {Ext.data.Association[]} associationStack
- */
- 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.
- * @return {Ext.data.Model} a model class.
- */
- 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.
- *
- * This method is deprecated. Use {@link Ext#create Ext.create} instead. For example:
- *
- * Ext.create('User', {
- * first: 'Ed',
- * last: 'Spencer'
- * });
- *
- * @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() {
- /**
- * Old way for creating Model classes. Instead use:
- *
- * Ext.define("MyModel", {
- * extend: "Ext.data.Model",
- * fields: []
- * });
- *
- * @param {String} name Name of the Model class.
- * @param {Object} config A configuration object for the Model you wish to create.
- * @return {Ext.data.Model} The newly registered Model
- * @member Ext
- * @deprecated 4.0.0 Use {@link Ext#define} instead.
- */
- Ext.regModel = function() {
- //<debug>
- 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: []});.');
- }
- //</debug>
- return this.ModelManager.registerType.apply(this.ModelManager, arguments);
- };
- });
- /**
- * @singleton
- *
- * Provides a registry of available Plugin classes indexed by a mnemonic code known as the Plugin's ptype.
- *
- * A plugin may be specified simply as a *config object* as long as the correct `ptype` is specified:
- *
- * {
- * ptype: 'gridviewdragdrop',
- * dragText: 'Drag and drop to reorganize'
- * }
- *
- * Or just use the ptype on its own:
- *
- * 'gridviewdragdrop'
- *
- * Alternatively you can instantiate the plugin with Ext.create:
- *
- * Ext.create('Ext.view.plugin.AutoComplete', {
- * ptype: 'gridviewdragdrop',
- * dragText: 'Drag and drop to reorganize'
- * })
- */
- Ext.define('Ext.PluginManager', {
- extend: 'Ext.AbstractManager',
- alternateClassName: 'Ext.PluginMgr',
- singleton: true,
- typeName: 'ptype',
- /**
- * Creates a new Plugin from the specified config object using the config object's ptype to determine the class to
- * instantiate.
- * @param {Object} config A configuration object for the Plugin you wish to create.
- * @param {Function} defaultType (optional) The constructor to provide the default Plugin type if the config object does not
- * contain a `ptype`. (Optional if the config contains a `ptype`).
- * @return {Ext.Component} The newly instantiated Plugin.
- */
- //create: function(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 {Ext.AbstractPlugin[]} 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 {Function} cls The new Plugin class.
- * @member Ext
- * @method preg
- */
- Ext.preg = function() {
- return Ext.PluginManager.registerType.apply(Ext.PluginManager, arguments);
- };
- });
- /**
- * 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:
- *
- * An Array will be combined with `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.
- */
- Ext.define('Ext.Template', {
- /* Begin Definitions */
- requires: ['Ext.DomHelper', 'Ext.util.Format'],
- inheritableStatics: {
- /**
- * Creates a template from the passed element's value (_display:none_ textarea, preferred) or innerHTML.
- * @param {String/HTMLElement} el A DOM element or its id
- * @param {Object} config (optional) Config object
- * @return {Ext.Template} The created template
- * @static
- * @inheritable
- */
- from: function(el, config) {
- el = Ext.getDom(el);
- return new this(el.value || el.innerHTML, config || '');
- }
- },
- /* End Definitions */
- /**
- * Creates new template.
- *
- * @param {String...} html List of strings to be concatenated into template.
- * Alternatively an array of strings can be given, but then no config object may be passed.
- * @param {Object} config (optional) Config object
- */
- constructor: function(html) {
- var me = this,
- args = arguments,
- buffer = [],
- i = 0,
- length = args.length,
- value;
- me.initialConfig = {};
- 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} compiled
- * True to immediately compile the template. Defaults to false.
- */
- /**
- * @cfg {Boolean} disableFormats
- * True to disable format functions in the template. If the template doesn't contain
- * format functions, setting disableFormats to true will reduce apply time. Defaults to false.
- */
- disableFormats: false,
- re: /\{([\w\-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
- /**
- * Returns an HTML fragment of this template with the specified values applied.
- *
- * @param {Object/Array} values The template values. Can be an array if your params are numeric:
- *
- * var tpl = new Ext.Template('Name: {0}, Age: {1}');
- * tpl.applyTemplate(['John', 25]);
- *
- * or an object:
- *
- * var tpl = new Ext.Template('Name: {name}, Age: {age}');
- * tpl.applyTemplate({name: 'John', age: 25});
- *
- * @return {String} The HTML fragment
- */
- 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.
- * @return {Ext.Template} this
- */
- set: function(html, compile) {
- var me = this;
- me.html = html;
- me.compiled = null;
- return compile ? me.compile() : me;
- },
- compileARe: /\\/g,
- compileBRe: /(\r\n|\n)/g,
- compileCRe: /'/g,
- /**
- * Compiles the template into an internal function, eliminating the RegEx overhead.
- * @return {Ext.Template} this
- */
- compile: function() {
- var me = this,
- fm = Ext.util.Format,
- useFormat = me.disableFormats !== true,
- body, bodyReturn;
- function fn(m, name, format, args) {
- if (format && useFormat) {
- args = args ? ',' + args: "";
- if (format.substr(0, 5) != "this.") {
- format = "fm." + format + '(';
- }
- else {
- format = 'this.' + format.substr(5) + '(';
- }
- }
- else {
- args = '';
- format = "(values['" + name + "'] == undefined ? '' : ";
- }
- return "'," + format + "values['" + name + "']" + args + ") ,'";
- }
- bodyReturn = me.html.replace(me.compileARe, '\\\\').replace(me.compileBRe, '\\n').replace(me.compileCRe, "\\'").replace(me.re, fn);
- body = "this.compiled = function(values){ return ['" + bodyReturn + "'].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 {String/HTMLElement/Ext.Element} el The context element
- * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
- * @param {Boolean} returnElement (optional) true to return a Ext.Element.
- * @return {HTMLElement/Ext.Element} The new node or Element
- */
- insertFirst: function(el, values, returnElement) {
- return this.doInsert('afterBegin', el, values, returnElement);
- },
- /**
- * Applies the supplied values to the template and inserts the new node(s) before el.
- *
- * @param {String/HTMLElement/Ext.Element} el The context element
- * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
- * @param {Boolean} returnElement (optional) true to return a Ext.Element.
- * @return {HTMLElement/Ext.Element} The new node or Element
- */
- insertBefore: function(el, values, returnElement) {
- return this.doInsert('beforeBegin', el, values, returnElement);
- },
- /**
- * Applies the supplied values to the template and inserts the new node(s) after el.
- *
- * @param {String/HTMLElement/Ext.Element} el The context element
- * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
- * @param {Boolean} returnElement (optional) true to return a Ext.Element.
- * @return {HTMLElement/Ext.Element} The new node or Element
- */
- insertAfter: function(el, values, returnElement) {
- return this.doInsert('afterEnd', el, values, returnElement);
- },
- /**
- * Applies the supplied `values` to the template and appends the new node(s) to the specified `el`.
- *
- * For example usage see {@link Ext.Template Ext.Template class docs}.
- *
- * @param {String/HTMLElement/Ext.Element} el The context element
- * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
- * @param {Boolean} returnElement (optional) true to return an Ext.Element.
- * @return {HTMLElement/Ext.Element} The new node or Element
- */
- append: function(el, values, returnElement) {
- return this.doInsert('beforeEnd', el, values, returnElement);
- },
- doInsert: function(where, el, values, returnEl) {
- el = Ext.getDom(el);
- var newNode = Ext.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 {String/HTMLElement/Ext.Element} el The context element
- * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
- * @param {Boolean} returnElement (optional) true to return a Ext.Element.
- * @return {HTMLElement/Ext.Element} The new node or Element
- */
- overwrite: function(el, values, returnElement) {
- el = Ext.getDom(el);
- el.innerHTML = this.applyTemplate(values);
- return returnElement ? Ext.get(el.firstChild, true) : el.firstChild;
- }
- }, function() {
- /**
- * @method apply
- * @member Ext.Template
- * Alias for {@link #applyTemplate}.
- * @alias Ext.Template#applyTemplate
- */
- this.createAlias('apply', 'applyTemplate');
- });
- /**
- * 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).
- *
- * Examples:
- *
- * <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 > 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.
- *
- * Examples:
- *
- * <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 == "Tommy"">Hello</tpl>
- *
- * Using the sample data above:
- *
- * var tpl = new Ext.XTemplate(
- * '<p>Name: {name}</p>',
- * '<p>Kids: ',
- * '<tpl for="kids">',
- * '<tpl if="age > 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 > 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:
- * disableFormats: true,
- * // member functions:
- * isGirl: function(name){
- * return name == 'Sara Grace';
- * },
- * isBaby: function(age){
- * return age < 1;
- * }
- * }
- * );
- * tpl.overwrite(panel.body, data);
- */
- Ext.define('Ext.XTemplate', {
- /* Begin Definitions */
- extend: 'Ext.Template',
- /* End Definitions */
- argsRe: /<tpl\b[^>]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/,
- nameRe: /^<tpl\b[^>]*?for="(.*?)"/,
- ifRe: /^<tpl\b[^>]*?if="(.*?)"/,
- execRe: /^<tpl\b[^>]*?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 = ['<tpl>', html, '</tpl>'].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,
- /**
- * @cfg {Boolean} compiled
- * Only applies to {@link Ext.Template}, XTemplates are compiled automatically.
- */
- 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;
- },
- // inherit docs from Ext.Template
- applyTemplate: function(values) {
- return this.master.compiled.call(this, values, {}, 1, 1);
- },
- /**
- * Does nothing. XTemplates are compiled automatically, so this function simply returns this.
- * @return {Ext.XTemplate} this
- */
- compile: function() {
- return this;
- }
- }, function() {
- // re-create the alias, inheriting it from Ext.Template doesn't work as intended.
- this.createAlias('apply', 'applyTemplate');
- });
- /**
- * @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 the {@link Ext.ComponentQuery documentation}. 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.
- *
- * <u>Using refs</u>
- *
- * 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.
- *
- * <u>Generated getter methods</u>
- *
- * 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.
- *
- * <u>Further Reading</u>
- *
- * For more information about writing Ext JS 4 applications, please see the
- * [application architecture guide](#/guide/application_architecture). Also see the {@link Ext.app.Application} documentation.
- *
- * @docauthor Ed Spencer
- */
- Ext.define('Ext.app.Controller', {
- mixins: {
- observable: 'Ext.util.Observable'
- },
- /**
- * @cfg {String} id The id of this controller. You can use this id when dispatching.
- */
-
- /**
- * @cfg {String[]} models
- * Array of models to require from AppName.model namespace. For example:
- *
- * Ext.define("MyApp.controller.Foo", {
- * extend: "Ext.app.Controller",
- * models: ['User', 'Vehicle']
- * });
- *
- * This is equivalent of:
- *
- * Ext.define("MyApp.controller.Foo", {
- * extend: "Ext.app.Controller",
- * requires: ['MyApp.model.User', 'MyApp.model.Vehicle']
- * });
- *
- */
- /**
- * @cfg {String[]} views
- * Array of views to require from AppName.view namespace. For example:
- *
- * Ext.define("MyApp.controller.Foo", {
- * extend: "Ext.app.Controller",
- * views: ['List', 'Detail']
- * });
- *
- * This is equivalent of:
- *
- * Ext.define("MyApp.controller.Foo", {
- * extend: "Ext.app.Controller",
- * requires: ['MyApp.view.List', 'MyApp.view.Detail']
- * });
- *
- */
- /**
- * @cfg {String[]} stores
- * Array of stores to require from AppName.store namespace. For example:
- *
- * Ext.define("MyApp.controller.Foo", {
- * extend: "Ext.app.Controller",
- * stores: ['Users', 'Vehicles']
- * });
- *
- * This is equivalent of:
- *
- * Ext.define("MyApp.controller.Foo", {
- * extend: "Ext.app.Controller",
- * requires: ['MyApp.store.Users', 'MyApp.store.Vehicles']
- * });
- *
- */
- 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));
- };
- }
- },
- /**
- * Creates new Controller.
- * @param {Object} config (optional) Config object.
- */
- 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);
- }
- },
- /**
- * A template 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.
- *
- * @param {Ext.app.Application} application
- * @template
- */
- init: function(application) {},
- /**
- * A template method like {@link #init}, but called after the viewport is created.
- * This is called after the {@link Ext.app.Application#launch launch} method of Application is executed.
- *
- * @param {Ext.app.Application} application
- * @template
- */
- 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;
- },
- /**
- * Adds listeners to components selected via {@link Ext.ComponentQuery}. Accepts an
- * object containing component paths mapped to a hash of listener functions.
- *
- * In the following example the `updateUser` function is mapped to to the `click`
- * event on a button component, which is a child of the `useredit` component.
- *
- * Ext.define('AM.controller.Users', {
- * init: function() {
- * this.control({
- * 'useredit button[action=save]': {
- * click: this.updateUser
- * }
- * });
- * },
- *
- * updateUser: function(button) {
- * console.log('clicked the Save button');
- * }
- * });
- *
- * See {@link Ext.ComponentQuery} for more information on component selectors.
- *
- * @param {String/Object} selectors If a String, the second argument is used as the
- * listeners, otherwise an object of selectors -> listeners is assumed
- * @param {Object} listeners
- */
- control: function(selectors, listeners) {
- this.application.control(selectors, listeners, this);
- },
- /**
- * Returns instance of a {@link Ext.app.Controller controller} with the given name.
- * When controller doesn't exist yet, it's created.
- * @param {String} name
- * @return {Ext.app.Controller} a controller instance.
- */
- getController: function(name) {
- return this.application.getController(name);
- },
- /**
- * Returns instance of a {@link Ext.data.Store Store} with the given name.
- * When store doesn't exist yet, it's created.
- * @param {String} name
- * @return {Ext.data.Store} a store instance.
- */
- getStore: function(name) {
- return this.application.getStore(name);
- },
- /**
- * Returns a {@link Ext.data.Model Model} class with the given name.
- * A shorthand for using {@link Ext.ModelManager#getModel}.
- * @param {String} name
- * @return {Ext.data.Model} a model class.
- */
- getModel: function(model) {
- return this.application.getModel(model);
- },
- /**
- * Returns a View class with the given name. To create an instance of the view,
- * you can use it like it's used by Application to create the Viewport:
- *
- * this.getView('Viewport').create();
- *
- * @param {String} name
- * @return {Ext.Base} a view class.
- */
- getView: function(view) {
- return this.application.getView(view);
- }
- });
- /**
- * @author Don Griffin
- *
- * This class is a base for all id generators. It also provides lookup of id generators by
- * their id.
- *
- * Generally, id generators are used to generate a primary key for new model instances. There
- * are different approaches to solving this problem, so this mechanism has both simple use
- * cases and is open to custom implementations. A {@link Ext.data.Model} requests id generation
- * using the {@link Ext.data.Model#idgen} property.
- *
- * # Identity, Type and Shared IdGenerators
- *
- * It is often desirable to share IdGenerators to ensure uniqueness or common configuration.
- * This is done by giving IdGenerator instances an id property by which they can be looked
- * up using the {@link #get} method. To configure two {@link Ext.data.Model Model} classes
- * to share one {@link Ext.data.SequentialIdGenerator sequential} id generator, you simply
- * assign them the same id:
- *
- * Ext.define('MyApp.data.MyModelA', {
- * extend: 'Ext.data.Model',
- * idgen: {
- * type: 'sequential',
- * id: 'foo'
- * }
- * });
- *
- * Ext.define('MyApp.data.MyModelB', {
- * extend: 'Ext.data.Model',
- * idgen: {
- * type: 'sequential',
- * id: 'foo'
- * }
- * });
- *
- * To make this as simple as possible for generator types that are shared by many (or all)
- * Models, the IdGenerator types (such as 'sequential' or 'uuid') are also reserved as
- * generator id's. This is used by the {@link Ext.data.UuidGenerator} which has an id equal
- * to its type ('uuid'). In other words, the following Models share the same generator:
- *
- * Ext.define('MyApp.data.MyModelX', {
- * extend: 'Ext.data.Model',
- * idgen: 'uuid'
- * });
- *
- * Ext.define('MyApp.data.MyModelY', {
- * extend: 'Ext.data.Model',
- * idgen: 'uuid'
- * });
- *
- * This can be overridden (by specifying the id explicitly), but there is no particularly
- * good reason to do so for this generator type.
- *
- * # Creating Custom Generators
- *
- * An id generator should derive from this class and implement the {@link #generate} method.
- * The constructor will apply config properties on new instances, so a constructor is often
- * not necessary.
- *
- * To register an id generator type, a derived class should provide an `alias` like so:
- *
- * Ext.define('MyApp.data.CustomIdGenerator', {
- * extend: 'Ext.data.IdGenerator',
- * alias: 'idgen.custom',
- *
- * configProp: 42, // some config property w/default value
- *
- * generate: function () {
- * return ... // a new id
- * }
- * });
- *
- * Using the custom id generator is then straightforward:
- *
- * Ext.define('MyApp.data.MyModel', {
- * extend: 'Ext.data.Model',
- * idgen: 'custom'
- * });
- * // or...
- *
- * Ext.define('MyApp.data.MyModel', {
- * extend: 'Ext.data.Model',
- * idgen: {
- * type: 'custom',
- * configProp: value
- * }
- * });
- *
- * It is not recommended to mix shared generators with generator configuration. This leads
- * to unpredictable results unless all configurations match (which is also redundant). In
- * such cases, a custom generator with a default id is the best approach.
- *
- * Ext.define('MyApp.data.CustomIdGenerator', {
- * extend: 'Ext.data.SequentialIdGenerator',
- * alias: 'idgen.custom',
- *
- * id: 'custom', // shared by default
- *
- * prefix: 'ID_',
- * seed: 1000
- * });
- *
- * Ext.define('MyApp.data.MyModelX', {
- * extend: 'Ext.data.Model',
- * idgen: 'custom'
- * });
- *
- * Ext.define('MyApp.data.MyModelY', {
- * extend: 'Ext.data.Model',
- * idgen: 'custom'
- * });
- *
- * // the above models share a generator that produces ID_1000, ID_1001, etc..
- *
- */
- Ext.define('Ext.data.IdGenerator', {
- isGenerator: true,
- /**
- * Initializes a new instance.
- * @param {Object} config (optional) Configuration object to be applied to the new instance.
- */
- constructor: function(config) {
- var me = this;
- Ext.apply(me, config);
- if (me.id) {
- Ext.data.IdGenerator.all[me.id] = me;
- }
- },
- /**
- * @cfg {String} id
- * The id by which to register a new instance. This instance can be found using the
- * {@link Ext.data.IdGenerator#get} static method.
- */
- getRecId: function (rec) {
- return rec.modelName + '-' + rec.internalId;
- },
- /**
- * Generates and returns the next id. This method must be implemented by the derived
- * class.
- *
- * @return {String} The next id.
- * @method generate
- * @abstract
- */
- statics: {
- /**
- * @property {Object} all
- * This object is keyed by id to lookup instances.
- * @private
- * @static
- */
- all: {},
- /**
- * Returns the IdGenerator given its config description.
- * @param {String/Object} config If this parameter is an IdGenerator instance, it is
- * simply returned. If this is a string, it is first used as an id for lookup and
- * then, if there is no match, as a type to create a new instance. This parameter
- * can also be a config object that contains a `type` property (among others) that
- * are used to create and configure the instance.
- * @static
- */
- get: function (config) {
- var generator,
- id,
- type;
- if (typeof config == 'string') {
- id = type = config;
- config = null;
- } else if (config.isGenerator) {
- return config;
- } else {
- id = config.id || config.type;
- type = config.type;
- }
- generator = this.all[id];
- if (!generator) {
- generator = Ext.create('idgen.' + type, config);
- }
- return generator;
- }
- }
- });
- /**
- * @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.
- * <ul>
- * <li><b>asText</b> - Removes any tags and converts the value to a string</li>
- * <li><b>asUCText</b> - Removes any tags and converts the value to an uppercase string</li>
- * <li><b>asUCText</b> - Converts the value to an uppercase string</li>
- * <li><b>asDate</b> - Converts the value into Unix epoch time</li>
- * <li><b>asFloat</b> - Converts the value to a floating point number</li>
- * <li><b>asInt</b> - Converts the value to an integer number</li>
- * </ul>
- * <p>
- * It is also possible to create a custom sortType that can be used throughout
- * an application.
- * <pre><code>
- 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
- }]
- });
- * </code></pre>
- * </p>
- * @singleton
- * @docauthor Evan Trimboli <evan@sencha.com>
- */
- Ext.define('Ext.data.SortTypes', {
-
- singleton: true,
-
- /**
- * Default sort that does nothing
- * @param {Object} s The value being converted
- * @return {Object} 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 {Object} 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 {Object} s The value being converted
- * @return {String} The comparison value
- */
- asUCText : function(s) {
- return String(s).toUpperCase().replace(this.stripTagsRE, "");
- },
- /**
- * Case insensitive string
- * @param {Object} s The value being converted
- * @return {String} The comparison value
- */
- asUCString : function(s) {
- return String(s).toUpperCase();
- },
- /**
- * Date sorting
- * @param {Object} 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 {Object} s The value being converted
- * @return {Number} The comparison value
- */
- asFloat : function(s) {
- var val = parseFloat(String(s).replace(/,/g, ""));
- return isNaN(val) ? 0 : val;
- },
- /**
- * Integer sorting
- * @param {Object} 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;
- }
- });
- /**
- * 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);
- *
- */
- Ext.define('Ext.util.Filter', {
- /* Begin Definitions */
- /* End Definitions */
- /**
- * @cfg {String} property
- * The property to filter on. Required unless a {@link #filterFn} is passed
- */
-
- /**
- * @cfg {Function} filterFn
- * A custom filter function which is passed each item in the {@link Ext.util.MixedCollection} in turn. Should return
- * true to accept each item or false to reject it
- */
-
- /**
- * @cfg {Boolean} anyMatch
- * True to allow any match - no regex start/end line anchors will be added.
- */
- anyMatch: false,
-
- /**
- * @cfg {Boolean} exactMatch
- * True to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true.
- */
- exactMatch: false,
-
- /**
- * @cfg {Boolean} caseSensitive
- * True to make the regex case sensitive (adds 'i' switch to regex).
- */
- caseSensitive: false,
-
- /**
- * @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
- */
- /**
- * Creates new Filter.
- * @param {Object} [config] Config object
- */
- constructor: function(config) {
- var me = this;
- Ext.apply(me, config);
-
- //we're aliasing filter to filterFn mostly for API cleanliness reasons, despite the fact it dirties the code here.
- //Ext.util.Sorter takes a sorterFn property but allows .sort to be called - we do the same here
- me.filter = me.filter || me.filterFn;
-
- if (me.filter === undefined) {
- if (me.property === undefined || me.value === undefined) {
- // Commented this out temporarily because it stops us using string ids in models. TODO: Remove this once
- // Model has been updated to allow string ids
-
- // Ext.Error.raise("A Filter requires either a property or a filterFn to be set");
- } else {
- me.filter = me.createFilterFn();
- }
-
- me.filterFn = me.filter;
- }
- },
-
- /**
- * @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) {
- var value = me.getRoot.call(me, item)[property];
- return matcher === null ? value === null : matcher.test(value);
- };
- },
-
- /**
- * @private
- * Returns the root property of the given item, based on the configured {@link #root} property
- * @param {Object} item The item
- * @return {Object} The root property of the object
- */
- getRoot: function(item) {
- var root = this.root;
- return root === undefined ? item : item[root];
- },
-
- /**
- * @private
- * Returns a regular expression based on the given value and matching options
- */
- createValueMatcher : function() {
- var me = this,
- value = me.value,
- anyMatch = me.anyMatch,
- exactMatch = me.exactMatch,
- caseSensitive = me.caseSensitive,
- escapeRe = Ext.String.escapeRegex;
-
- if (value === null) {
- return value;
- }
-
- if (!value.exec) { // not a regex
- value = String(value);
- if (anyMatch === true) {
- value = escapeRe(value);
- } else {
- value = '^' + escapeRe(value);
- if (exactMatch === true) {
- value += '$';
- }
- }
- value = new RegExp(value, caseSensitive ? '' : 'i');
- }
-
- return value;
- }
- });
- /**
- * Represents a single sorter that can be applied to a Store. The sorter is used
- * to compare two values against each other for the purpose of ordering them. Ordering
- * is achieved by specifying either:
- *
- * - {@link #property A sorting property}
- * - {@link #sorterFn A sorting function}
- *
- * As a contrived example, we can specify a custom sorter that sorts by rank:
- *
- * Ext.define('Person', {
- * extend: 'Ext.data.Model',
- * fields: ['name', 'rank']
- * });
- *
- * Ext.create('Ext.data.Store', {
- * model: 'Person',
- * proxy: 'memory',
- * sorters: [{
- * sorterFn: function(o1, o2){
- * var getRank = function(o){
- * var name = o.get('rank');
- * if (name === 'first') {
- * return 1;
- * } else if (name === 'second') {
- * return 2;
- * } else {
- * return 3;
- * }
- * },
- * rank1 = getRank(o1),
- * rank2 = getRank(o2);
- *
- * if (rank1 === rank2) {
- * return 0;
- * }
- *
- * return rank1 < rank2 ? -1 : 1;
- * }
- * }],
- * data: [{
- * name: 'Person1',
- * rank: 'second'
- * }, {
- * name: 'Person2',
- * rank: 'third'
- * }, {
- * name: 'Person3',
- * rank: 'first'
- * }]
- * });
- */
- Ext.define('Ext.util.Sorter', {
- /**
- * @cfg {String} property
- * The property to sort by. Required unless {@link #sorterFn} is provided. The property is extracted from the object
- * directly and compared for sorting using the built in comparison operators.
- */
-
- /**
- * @cfg {Function} sorterFn
- * A specific sorter function to execute. Can be passed instead of {@link #property}. This sorter function allows
- * for any kind of custom/complex comparisons. The sorterFn receives two arguments, the objects being compared. The
- * function should return:
- *
- * - -1 if o1 is "less than" o2
- * - 0 if o1 is "equal" to o2
- * - 1 if o1 is "greater than" o2
- */
-
- /**
- * @cfg {String} root
- * Optional root property. This is mostly useful when sorting a Store, in which case we set the root to 'data' to
- * make the filter pull the {@link #property} out of the data object of each item
- */
-
- /**
- * @cfg {Function} transform
- * A function that will be run on each value before it is compared in the sorter. The function will receive a single
- * argument, the value.
- */
-
- /**
- * @cfg {String} direction
- * The direction to sort by.
- */
- direction: "ASC",
-
- constructor: function(config) {
- var me = this;
-
- Ext.apply(me, config);
-
- //<debug>
- if (me.property === undefined && me.sorterFn === undefined) {
- Ext.Error.raise("A Sorter requires either a property or a sorter function");
- }
- //</debug>
-
- 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];
- },
-
- /**
- * Set the sorting direction for this sorter.
- * @param {String} direction The direction to sort in. Should be either 'ASC' or 'DESC'.
- */
- setDirection: function(direction) {
- var me = this;
- me.direction = direction;
- me.updateSortFunction();
- },
-
- /**
- * Toggles the sorting direction for this sorter.
- */
- toggle: function() {
- var me = this;
- me.direction = Ext.String.toggle(me.direction, "ASC", "DESC");
- me.updateSortFunction();
- },
-
- /**
- * Update the sort function for this sorter.
- * @param {Function} [fn] A new sorter function for this sorter. If not specified it will use the default
- * sorting function.
- */
- updateSortFunction: function(fn) {
- var me = this;
- fn = fn || me.sorterFn || me.defaultSorterFn;
- me.sort = me.createSortFunction(fn);
- }
- });
- /**
- * @author Ed Spencer
- *
- * 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}.
- */
- Ext.define('Ext.data.Operation', {
- /**
- * @cfg {Boolean} synchronous
- * True if this Operation is to be executed synchronously. 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 {Ext.util.Filter[]} filters
- * Optional array of filter objects. Only applies to 'read' actions.
- */
- filters: undefined,
- /**
- * @cfg {Ext.util.Sorter[]} sorters
- * Optional array of sorter objects. Only applies to 'read' actions.
- */
- sorters: undefined,
- /**
- * @cfg {Ext.util.Grouper} 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.
- */
- batch: undefined,
- /**
- * @cfg {Function} callback
- * Function to execute when operation completed. Will be called with the following parameters:
- *
- * - records : Array of Ext.data.Model objects.
- * - operation : The Ext.data.Operation itself.
- * - success : True when operation completed successfully.
- */
- callback: undefined,
- /**
- * @cfg {Object} scope
- * Scope for the {@link #callback} function.
- */
- scope: undefined,
- /**
- * @property {Boolean} started
- * Read-only property tracking the start status of this Operation. Use {@link #isStarted}.
- * @private
- */
- started: false,
- /**
- * @property {Boolean} running
- * Read-only property tracking the run status of this Operation. Use {@link #isRunning}.
- * @private
- */
- running: false,
- /**
- * @property {Boolean} complete
- * Read-only property tracking the completion status of this Operation. Use {@link #isComplete}.
- * @private
- */
- complete: false,
- /**
- * @property {Boolean} success
- * 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.
- * @private
- */
- success: undefined,
- /**
- * @property {Boolean} exception
- * Read-only property tracking the exception status of this Operation. Use {@link #hasException} and see {@link #getError}.
- * @private
- */
- exception: false,
- /**
- * @property {String/Object} error
- * The error object passed when {@link #setException} was called. This could be any object or primitive.
- * @private
- */
- error: undefined,
- /**
- * @property {RegExp} actionCommitRecordsRe
- * The RegExp used to categorize actions that require record commits.
- */
- actionCommitRecordsRe: /^(?:create|update)$/i,
- /**
- * @property {RegExp} actionSkipSyncRe
- * The RegExp used to categorize actions that skip local record synchronization. This defaults
- * to match 'destroy'.
- */
- actionSkipSyncRe: /^destroy$/i,
- /**
- * Creates new Operation object.
- * @param {Object} config (optional) Config object.
- */
- constructor: function(config) {
- Ext.apply(this, config || {});
- },
- /**
- * This method is called to commit data to this instance's records given the records in
- * the server response. This is followed by calling {@link Ext.data.Model#commit} on all
- * those records (for 'create' and 'update' actions).
- *
- * If this {@link #action} is 'destroy', any server records are ignored and the
- * {@link Ext.data.Model#commit} method is not called.
- *
- * @param {Ext.data.Model[]} serverRecords An array of {@link Ext.data.Model} objects returned by
- * the server.
- * @markdown
- */
- commitRecords: function (serverRecords) {
- var me = this,
- mc, index, clientRecords, serverRec, clientRec;
- if (!me.actionSkipSyncRe.test(me.action)) {
- clientRecords = me.records;
- if (clientRecords && clientRecords.length) {
- mc = Ext.create('Ext.util.MixedCollection', true, function(r) {return r.getId();});
- mc.addAll(clientRecords);
- for (index = serverRecords ? serverRecords.length : 0; index--; ) {
- serverRec = serverRecords[index];
- clientRec = mc.get(serverRec.getId());
- if (clientRec) {
- clientRec.beginEdit();
- clientRec.set(serverRec.data);
- clientRec.endEdit(true);
- }
- }
- if (me.actionCommitRecordsRe.test(me.action)) {
- for (index = clientRecords.length; index--; ) {
- clientRecords[index].commit();
- }
- }
- }
- }
- },
- /**
- * 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 {String/Object} 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 {String/Object} The error object
- */
- getError: function() {
- return this.error;
- },
- /**
- * Returns an array of Ext.data.Model instances as set by the Proxy.
- * @return {Ext.data.Model[]} 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
- *
- * 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,
-
- /**
- * @property {String} presenceMessage
- * The default error message used when a presence validation fails.
- */
- presenceMessage: 'must be present',
-
- /**
- * @property {String} lengthMessage
- * The default error message used when a length validation fails.
- */
- lengthMessage: 'is the wrong length',
-
- /**
- * @property {Boolean} formatMessage
- * The default error message used when a format validation fails.
- */
- formatMessage: 'is the wrong format',
-
- /**
- * @property {String} inclusionMessage
- * The default error message used when an inclusion validation fails.
- */
- inclusionMessage: 'is not included in the list of acceptable values',
-
- /**
- * @property {String} exclusionMessage
- * The default error message used when an exclusion validation fails.
- */
- exclusionMessage: 'is not an acceptable value',
-
- /**
- * @property {String} emailMessage
- * The default error message used when an email validation fails
- */
- emailMessage: 'is not a valid email address',
-
- /**
- * @property {RegExp} emailRe
- * The regular expression used to validate email addresses
- */
- emailRe: /^([a-zA-Z0-9_\.\-])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/,
-
- /**
- * Validates that the given value is present.
- * For example:
- *
- * validations: [{type: 'presence', field: 'age'}]
- *
- * @param {Object} config Config object
- * @param {Object} value The value to validate
- * @return {Boolean} True if validation passed
- */
- presence: function(config, value) {
- if (value === undefined) {
- value = config;
- }
-
- //we need an additional check for zero here because zero is an acceptable form of present data
- return !!value || value === 0;
- },
-
- /**
- * Returns true if the given value is between the configured min and max values.
- * For example:
- *
- * validations: [{type: 'length', field: 'name', min: 2}]
- *
- * @param {Object} config Config object
- * @param {String} value The value to validate
- * @return {Boolean} True if the value passes validation
- */
- length: function(config, value) {
- if (value === undefined || value === null) {
- return false;
- }
-
- var length = value.length,
- min = config.min,
- max = config.max;
-
- if ((min && length < min) || (max && length > max)) {
- return false;
- } else {
- return true;
- }
- },
-
- /**
- * Validates that an email string is in the correct format
- * @param {Object} config Config object
- * @param {String} email The email address
- * @return {Boolean} True if the value passes validation
- */
- email: function(config, email) {
- return Ext.data.validations.emailRe.test(email);
- },
-
- /**
- * Returns true if the given value passes validation against the configured `matcher` regex.
- * For example:
- *
- * validations: [{type: 'format', field: 'username', matcher: /([a-z]+)[0-9]{2,3}/}]
- *
- * @param {Object} config 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 `list`.
- * For example:
- *
- * validations: [{type: 'inclusion', field: 'gender', list: ['Male', 'Female']}]
- *
- * @param {Object} config Config object
- * @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 `list`.
- * For example:
- *
- * validations: [{type: 'exclusion', field: 'username', list: ['Admin', 'Operator']}]
- *
- * @param {Object} config 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
- *
- * Simple wrapper class that represents a set of records returned by a Proxy.
- */
- 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 {@link #count}).
- */
- total: 0,
- /**
- * @cfg {Boolean} success
- * True if the ResultSet loaded successfully, false if any errors were encountered.
- */
- success: false,
- /**
- * @cfg {Ext.data.Model[]} records (required)
- * The array of record instances.
- */
- /**
- * Creates the resultSet
- * @param {Object} [config] Config object.
- */
- constructor: function(config) {
- Ext.apply(this, config);
- /**
- * @property {Number} totalRecords
- * Copy of this.total.
- * @deprecated Will be removed in Ext JS 5.0. Use {@link #total} instead.
- */
- this.totalRecords = this.total;
- if (config.count === undefined) {
- this.count = this.records.length;
- }
- }
- });
- /**
- * @author Ed Spencer
- *
- * 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}.
- */
- 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. 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
- * }
- *
- * If the value is not present, the field name will always be used.
- */
- nameProperty: 'name',
- /**
- * Creates new Writer.
- * @param {Object} [config] Config object.
- */
- 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;
- }
- });
- /**
- * 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 Ext.Component#focus focused} when
- * it is {@link #toFront brought to the front}.
- */
- 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.
- */
- shadow: 'sides',
- constructor: function(config) {
- var me = this;
-
- me.floating = true;
- me.el = Ext.create('Ext.Layer', Ext.apply({}, config, {
- hideMode: me.hideMode,
- hidden: me.hidden,
- shadow: Ext.isDefined(me.shadow) ? me.shadow : 'sides',
- shadowOffset: me.shadowOffset,
- constrain: false,
- shim: me.shim === false ? false : undefined
- }), me.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() {
- var me = this;
-
- if (me.hideOnParentHide !== false) {
- me.showOnParentShow = me.isVisible();
- me.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;
- me.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 {String/HTMLElement/Ext.Element/Ext.util.Region} constrainTo (Optional) The Element or {@link Ext.util.Region Region} into which this Component is
- * to be constrained. Defaults to the element into which this floating Component was rendered.
- */
- doConstrain: function(constrainTo) {
- var me = this,
- vector = me.getConstrainVector(constrainTo || me.el.getScopeParent()),
- 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 {String/HTMLElement/Ext.Element/Ext.util.Region} constrainTo (Optional) The Element or {@link Ext.util.Region Region} into which this Component is to be constrained.
- * @return {Number[]} 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 {Ext.Component/Ext.Element/HTMLElement/String} 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="tl-bl?"] The position to align to (see {@link
- * Ext.Element#alignTo} for more details).
- * @param {Number[]} [offsets] Offset the positioning by [x, y]
- * @return {Ext.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=false] Specify `true` to prevent the Component from being focused.
- * @return {Ext.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 Ext.Component#activate activate} or
- * {@link Ext.Component#deactivate deactivate} event depending on which action occurred.
- *
- * @param {Boolean} [active=false] True to activate the Component, false to deactivate it.
- * @param {Ext.Component} [newActive] The newly active Component which is taking over topmost zIndex position.
- */
- setActive: function(active, newActive) {
- var me = this;
-
- if (active) {
- if (me.el.shadow && !me.maximized) {
- me.el.enableShadow(true);
- }
- me.fireEvent('activate', me);
- } else {
- // Only the *Windows* in a zIndex stack share a shadow. All other types of floaters
- // can keep their shadows all the time
- if ((me instanceof Ext.window.Window) && (newActive instanceof Ext.window.Window)) {
- me.el.disableShadow();
- }
- me.fireEvent('deactivate', me);
- }
- },
- /**
- * Sends this Component to the back of (lower z-index than) any other visible windows
- * @return {Ext.Component} this
- */
- toBack: function() {
- this.zIndexManager.sendToBack(this);
- return this;
- },
- /**
- * Center this Component in its container.
- * @return {Ext.Component} this
- */
- center: function() {
- var me = this,
- xy = me.el.getAlignToXY(me.container, 'c-c');
- me.setPagePosition(xy);
- return me;
- },
- // 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);
- }
- });
- /**
- * 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 (!layout || typeof layout === 'string') {
- type = layout || defaultType;
- layout = {};
- }
- else {
- type = layout.type || defaultType;
- }
- 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.renderChildren();
- return true;
- },
- renderChildren: function () {
- this.renderItems(this.getLayoutItems(), this.getRenderTarget());
- },
- /**
- * @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 me = this,
- ln = items.length,
- i = 0,
- item;
- for (; i < ln; i++) {
- item = items[i];
- if (item && !item.rendered) {
- me.renderItem(item, target, i);
- } else if (!me.isValidParent(item, target, i)) {
- me.moveItem(item, target, i);
- } else {
- // still need to configure the item, it may have moved in the container.
- me.configureItem(item);
- }
- }
- },
- // @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.Element} target The target Element
- * @param {Number} position The position within the target to render the item to
- */
- renderItem : function(item, target, position) {
- var me = this;
- if (!item.rendered) {
- if (me.itemCls) {
- item.addCls(me.itemCls);
- }
- if (me.owner.itemCls) {
- item.addCls(me.owner.itemCls);
- }
- item.render(target, position);
- me.configureItem(item);
- me.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() {
- var me = this,
- targetCls = me.targetCls;
-
- if (!me.initialized && !Ext.isEmpty(targetCls)) {
- me.getTarget().addCls(targetCls);
- }
- me.initialized = true;
- },
- // @private Sets the layout owner
- setOwner : function(owner) {
- this.owner = owner;
- },
- // @private - Returns empty array
- getLayoutItems : function() {
- return [];
- },
- /**
- * @private
- * Applies itemCls
- * Empty template method
- */
- configureItem: Ext.emptyFn,
-
- // 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 el = item.el,
- owner = this.owner,
- itemCls = this.itemCls,
- ownerCls = owner.itemCls;
-
- // Clear managed dimensions flag when removed from the layout.
- if (item.rendered && !item.isDestroyed) {
- if (itemCls) {
- el.removeCls(itemCls);
- }
- if (ownerCls) {
- el.removeCls(ownerCls);
- }
- }
- // These flags are set at the time a child item is added to a layout.
- // The layout must decide if it is managing the item's width, or its height, or both.
- // See AbstractComponent for docs on these properties.
- delete item.layoutManagedWidth;
- delete item.layoutManagedHeight;
- },
- /**
- * 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.
- * @template
- */
- destroy : function() {
- var targetCls = this.targetCls,
- target;
-
- if (!Ext.isEmpty(targetCls)) {
- target = this.getTarget();
- if (target) {
- target.removeCls(targetCls);
- }
- }
- this.onDestroy();
- }
- });
- /**
- * @class Ext.ZIndexManager
- * <p>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.</p>
- * <p>{@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}.</p>
- * <p>{@link Ext.Component#floating Floating} Components which are descendants of {@link Ext.Component#floating floating} <i>Containers</i>
- * (for example a {@link 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. Therefore ComboBox dropdowns within Windows will have managed z-indices
- * guaranteed to be correct, relative to the Window.</p>
- */
- 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);
- }
- }
- }
- },
- // 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);
- 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(comp) {
- var zIndex = comp.el.getStyle('zIndex') - 4,
- maskTarget = comp.floatParent ? comp.floatParent.getTargetEl() : Ext.get(comp.getEl().dom.parentNode),
- parentBox;
-
- if (!maskTarget) {
- //<debug>
- Ext.global.console && Ext.global.console.warn && Ext.global.console.warn('mask target could not be found. Mask cannot be shown');
- //</debug>
- return;
- }
-
- parentBox = maskTarget.getBox();
- if (!this.mask) {
- this.mask = Ext.getBody().createChild({
- cls: Ext.baseCSSPrefix + 'mask'
- });
- this.mask.setVisibilityMode(Ext.Element.DISPLAY);
- this.mask.on('click', this._onMaskClick, this);
- }
- if (maskTarget.dom === document.body) {
- parentBox.height = Ext.Element.getViewHeight();
- }
- maskTarget.addCls(Ext.baseCSSPrefix + 'body-masked');
- this.mask.setBox(parentBox);
- this.mask.setStyle('zIndex', zIndex);
- this.mask.show();
- },
- _hideModalMask: function() {
- if (this.mask && this.mask.dom.parentNode) {
- Ext.get(this.mask.dom.parentNode).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(Ext.get(this.mask.dom.parentNode).getViewSize(true));
- }
- },
- /**
- * <p>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.</p>
- * <p>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:</p><code><pre>
- MyDesktop.getDesktop().getManager().register(Ext.MessageBox);
- </pre></code>
- * @param {Ext.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);
- },
- /**
- * <p>Unregisters a {@link Ext.Component} from this ZIndexManager. This should not
- * need to be called. Components are automatically unregistered upon destruction.
- * See {@link #register}.</p>
- * @param {Ext.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) {
- this._showModalMask(comp);
- }
- 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 (<code>this</code> 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 (<code>this</code> 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 (<code>this</code> 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 (<code>this</code> 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() {
- this.each(function(c) {
- c.destroy();
- });
- delete this.zIndexStack;
- delete this.list;
- delete this.container;
- delete this.targetEl;
- }
- }, function() {
- /**
- * @class Ext.WindowManager
- * @extends Ext.ZIndexManager
- * <p>The default global floating Component group that is available automatically.</p>
- * <p>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.</p>
- * <p><i>Floating</i> Containers create their own instance of ZIndexManager, and floating Components added at any depth below
- * there are managed by that ZIndexManager.</p>
- * @singleton
- */
- Ext.WindowManager = Ext.WindowMgr = new this();
- });
- /**
- * @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. By default KeyMap starts enabled.<br />
- * Usage:
- <pre><code>
- // 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.'); }
- }
- ]);
- </code></pre>
- */
- Ext.define('Ext.util.KeyMap', {
- alternateClassName: 'Ext.KeyMap',
- /**
- * Creates new KeyMap.
- * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
- * @param {Object} binding The binding (see {@link #addBinding})
- * @param {String} [eventName="keydown"] The event to bind to
- */
- 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:
- * <pre>
- 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.
- </pre>
- *
- * Usage:
- * <pre><code>
- // 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
- });
- </code></pre>
- * @param {Object/Object[]} 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.toUpperCase();
- 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.toUpperCase().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/Number[]/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 (<code>this</code> 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(){
- var me = this;
-
- if (!me.enabled) {
- me.el.on(me.eventName, me.handleKeyDown, me);
- me.enabled = true;
- }
- },
- /**
- * Disable this KeyMap
- */
- disable: function(){
- var me = this;
-
- if (me.enabled) {
- me.el.removeListener(me.eventName, me.handleKeyDown, me);
- me.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.
- *
- */
- Ext.define('Ext.util.ClickRepeater', {
- extend: 'Ext.util.Observable',
- /**
- * Creates new ClickRepeater.
- * @param {String/HTMLElement/Ext.Element} el The element or its ID to listen on
- * @param {Object} config (optional) Config object.
- */
- 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 {String/HTMLElement/Ext.Element} 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);
- }
- });
- /**
- * @class Ext.layout.component.Component
- * @extends Ext.layout.Layout
- *
- * 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.
- *
- * @private
- */
- 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, callingContainer) {
- this.callParent(arguments);
- var me = this,
- owner = me.owner,
- ownerCt = owner.ownerCt,
- layout = owner.layout,
- isVisible = owner.isVisible(true),
- ownerElChild = owner.el.child,
- layoutCollection;
- // Cache the size we began with so we can see if there has been any effect.
- me.previousComponentSize = me.lastComponentSize;
- // Do not allow autoing of any dimensions which are fixed
- if (!isSetSize
- && ((!Ext.isNumber(width) && owner.isFixedWidth()) ||
- (!Ext.isNumber(height) && owner.isFixedHeight()))
- // unless we are being told to do so by the ownerCt's layout
- && callingContainer && callingContainer !== ownerCt) {
-
- 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)) {
- return owner.beforeComponentLayout(width, height, isSetSize, callingContainer);
- }
- else {
- return false;
- }
- },
- /**
- * Check if the new size is different from the current size and only
- * trigger a layout if it is necessary.
- * @param {Number} width The new width to set.
- * @param {Number} height The new height to set.
- */
- needsLayout : function(width, height) {
- var me = this,
- widthBeingChanged,
- heightBeingChanged;
- me.lastComponentSize = me.lastComponentSize || {
- width: -Infinity,
- height: -Infinity
- };
- // If autoWidthing, or an explicitly different width is passed, then the width is being changed.
- widthBeingChanged = !Ext.isDefined(width) || me.lastComponentSize.width !== width;
- // If autoHeighting, or an explicitly different height is passed, then the height is being changed.
- heightBeingChanged = !Ext.isDefined(height) || me.lastComponentSize.height !== height;
- // isSizing flag added to prevent redundant layouts when going up the layout chain
- return !me.isSizing && (me.childrenChanged || widthBeingChanged || heightBeingChanged);
- },
- /**
- * Set the size of any element supporting undefined, null, and values.
- * @param {Number} width The new width to set.
- * @param {Number} 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.Element}
- */
- getTarget : function() {
- return this.owner.el;
- },
- /**
- * <p>Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.</p>
- * May be overridden in Component layout managers which implement an inner element.
- * @return {Ext.Element}
- */
- getRenderTarget : function() {
- return this.owner.el;
- },
- /**
- * Set the size of the target element.
- * @param {Number} width The new width to set.
- * @param {Number} 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,
- curSize = this.lastComponentSize,
- prevSize = this.previousComponentSize,
- widthChange = (prevSize && curSize && Ext.isNumber(curSize.width )) ? curSize.width !== prevSize.width : true,
- heightChange = (prevSize && curSize && Ext.isNumber(curSize.height)) ? curSize.height !== prevSize.height : true;
- // If size has not changed, do not inform upstream layouts
- if (!ownerCt || (!widthChange && !heightChange)) {
- return;
- }
- ownerCtComponentLayout = ownerCt.componentLayout;
- ownerCtContainerLayout = ownerCt.layout;
- if (!owner.floating && ownerCtComponentLayout && ownerCtComponentLayout.monitorChildren && !ownerCtComponentLayout.layoutBusy) {
- if (!ownerCt.suspendLayout && ownerCtContainerLayout && !ownerCtContainerLayout.layoutBusy) {
- // If the owning Container may be adjusted in any of the the dimension which have changed, perform its Component layout
- if (((widthChange && !ownerCt.isFixedWidth()) || (heightChange && !ownerCt.isFixedHeight()))) {
- // Set the isSizing flag so that the upstream Container layout (called after a Component layout) can omit this component from sizing operations
- this.isSizing = true;
- ownerCt.doComponentLayout();
- this.isSizing = false;
- }
- // Execute upstream Container layout
- 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.isAutoDock) {
- 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);
- }
- });
- /**
- * 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;
- }
- },
-
- /**
- * Creates new TextMetrics.
- * @param {String/HTMLElement/Ext.Element} bindTo The element or its ID to bind to.
- * @param {Number} fixedWidth (optional) 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);
- }
- },
-
- /**
- * 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 {String/HTMLElement/Ext.Element} el The element or its ID.
- */
- 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.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 : 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.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 (ignored if enableScroll is false)
- */
- animateScroll: false,
- /**
- * @cfg {Number} scrollIncrement
- * The number of pixels to scroll by on scroller click
- */
- scrollIncrement: 20,
- /**
- * @cfg {Number} wheelIncrement
- * The number of pixels to increment on mouse wheel scrolling.
- */
- wheelIncrement: 10,
- /**
- * @cfg {Number} scrollRepeatInterval
- * Number of milliseconds between each scroll while a scroller button is held down
- */
- scrollRepeatInterval: 60,
- /**
- * @cfg {Number} scrollDuration
- * Number of milliseconds that each scroll animation lasts
- */
- 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='x-box-scroller']
- * 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.Element.DISPLAY);
- after.setVisibilityMode(Ext.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.Element
- * The left scroller element. Only created when needed.
- */
- this.beforeScroller = before;
- /**
- * @property afterScroller
- * @type Ext.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) {
- //<debug>
- if(!(offset instanceof this.statics())) {
- Ext.Error.raise('Offset must be an instance of Ext.util.Offset');
- }
- //</debug>
- 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
- * <p>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.</p>
- * <p>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:</p>
- <pre><code>
- 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
- });
- </code></pre>
- */
- 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
- }
- },
- /**
- * Creates new KeyNav.
- * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
- * @param {Object} config The config
- */
- constructor: function(el, config){
- this.setConfig(el, config || {});
- },
-
- /**
- * Sets up a configuration for the KeyNav.
- * @private
- * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
- * @param {Object} config 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.
- */
- 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}.
- */
- defaultEventAction: "stopEvent",
-
- /**
- * @cfg {Boolean} forceKeyDown
- * Handle the keydown event instead of keypress. 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
- */
- Ext.define('Ext.fx.target.Target', {
- isAnimTarget: true,
- /**
- * Creates new Target.
- * @param {Ext.Component/Ext.Element/Ext.draw.Sprite} target The object to be animated
- */
- constructor: function(target) {
- this.target = target;
- this.id = this.getId();
- },
-
- getId: function() {
- return this.target.id;
- }
- });
- /**
- * @class Ext.fx.target.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 = <targetComponent>
- // 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 && meth.setSize.target.el) {
- 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;
- }
- });
- /**
- * Represents an RGB color and provides helper functions get
- * color components in HSL color space.
- */
- Ext.define('Ext.draw.Color', {
- /* Begin Definitions */
- /* End Definitions */
- colorToHexRe: /(.*?)rgb\((\d+),\s*(\d+),\s*(\d+)\)/,
- rgbRe: /\s*rgb\s*\(\s*([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)\s*\)\s*/,
- hexRe: /\s*#([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)\s*/,
- /**
- * @cfg {Number} lightnessFactor
- *
- * The default factor to compute the lighter or darker color. Defaults to 0.2.
- */
- lightnessFactor: 0.2,
- /**
- * Creates new Color.
- * @param {Number} red Red component (0..255)
- * @param {Number} green Green component (0..255)
- * @param {Number} blue Blue component (0..255)
- */
- constructor : function(red, green, blue) {
- var me = this,
- clamp = Ext.Number.constrain;
- me.r = clamp(red, 0, 255);
- me.g = clamp(green, 0, 255);
- me.b = clamp(blue, 0, 255);
- },
- /**
- * Get the red component of the color, in the range 0..255.
- * @return {Number}
- */
- getRed: function() {
- return this.r;
- },
- /**
- * Get the green component of the color, in the range 0..255.
- * @return {Number}
- */
- getGreen: function() {
- return this.g;
- },
- /**
- * Get the blue component of the color, in the range 0..255.
- * @return {Number}
- */
- getBlue: function() {
- return this.b;
- },
- /**
- * Get the RGB values.
- * @return {Number[]}
- */
- getRGB: function() {
- var me = this;
- return [me.r, me.g, me.b];
- },
- /**
- * Get the equivalent HSL components of the color.
- * @return {Number[]}
- */
- getHSL: function() {
- var me = this,
- r = me.r / 255,
- g = me.g / 255,
- b = me.b / 255,
- max = Math.max(r, g, b),
- min = Math.min(r, g, b),
- delta = max - min,
- h,
- s = 0,
- l = 0.5 * (max + min);
- // min==max means achromatic (hue is undefined)
- if (min != max) {
- s = (l < 0.5) ? delta / (max + min) : delta / (2 - max - min);
- if (r == max) {
- h = 60 * (g - b) / delta;
- } else if (g == max) {
- h = 120 + 60 * (b - r) / delta;
- } else {
- h = 240 + 60 * (r - g) / delta;
- }
- if (h < 0) {
- h += 360;
- }
- if (h >= 360) {
- h -= 360;
- }
- }
- return [h, s, l];
- },
- /**
- * Return a new color that is lighter than this color.
- * @param {Number} factor Lighter factor (0..1), default to 0.2
- * @return Ext.draw.Color
- */
- getLighter: function(factor) {
- var hsl = this.getHSL();
- factor = factor || this.lightnessFactor;
- hsl[2] = Ext.Number.constrain(hsl[2] + factor, 0, 1);
- return this.fromHSL(hsl[0], hsl[1], hsl[2]);
- },
- /**
- * Return a new color that is darker than this color.
- * @param {Number} factor Darker factor (0..1), default to 0.2
- * @return Ext.draw.Color
- */
- getDarker: function(factor) {
- factor = factor || this.lightnessFactor;
- return this.getLighter(-factor);
- },
- /**
- * Return the color in the hex format, i.e. '#rrggbb'.
- * @return {String}
- */
- toString: function() {
- var me = this,
- round = Math.round,
- r = round(me.r).toString(16),
- g = round(me.g).toString(16),
- b = round(me.b).toString(16);
- r = (r.length == 1) ? '0' + r : r;
- g = (g.length == 1) ? '0' + g : g;
- b = (b.length == 1) ? '0' + b : b;
- return ['#', r, g, b].join('');
- },
- /**
- * Convert a color to hexadecimal format.
- *
- * **Note:** This method is both static and instance.
- *
- * @param {String/String[]} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff').
- * Can also be an Array, in this case the function handles the first member.
- * @returns {String} The color in hexadecimal format.
- * @static
- */
- toHex: function(color) {
- if (Ext.isArray(color)) {
- color = color[0];
- }
- if (!Ext.isString(color)) {
- return '';
- }
- if (color.substr(0, 1) === '#') {
- return color;
- }
- var digits = this.colorToHexRe.exec(color);
- 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.
- *
- * **Note:** This method is both static and instance.
- *
- * @param {String} str Color in string.
- * @returns Ext.draw.Color
- * @static
- */
- fromString: function(str) {
- var values, r, g, b,
- parse = parseInt;
- if ((str.length == 4 || str.length == 7) && str.substr(0, 1) === '#') {
- values = str.match(this.hexRe);
- if (values) {
- r = parse(values[1], 16) >> 0;
- g = parse(values[2], 16) >> 0;
- b = parse(values[3], 16) >> 0;
- if (str.length == 4) {
- r += (r * 16);
- g += (g * 16);
- b += (b * 16);
- }
- }
- }
- else {
- values = str.match(this.rgbRe);
- if (values) {
- r = values[1];
- g = values[2];
- b = values[3];
- }
- }
- return (typeof r == 'undefined') ? undefined : 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.
- *
- * **Note:** This method is both static and instance.
- *
- * @param {Number} h Hue component (0..359)
- * @param {Number} s Saturation component (0..1)
- * @param {Number} l Lightness component (0..1)
- * @returns Ext.draw.Color
- * @static
- */
- fromHSL: function(h, s, l) {
- var C, X, m, i, rgb = [],
- abs = Math.abs,
- floor = Math.floor;
- if (s == 0 || h == null) {
- // achromatic
- rgb = [l, l, l];
- }
- else {
- // http://en.wikipedia.org/wiki/HSL_and_HSV#From_HSL
- // C is the chroma
- // X is the second largest component
- // m is the lightness adjustment
- h /= 60;
- C = s * (1 - abs(2 * l - 1));
- X = C * (1 - abs(h - 2 * floor(h / 2) - 1));
- m = l - C / 2;
- switch (floor(h)) {
- case 0:
- rgb = [C, X, 0];
- break;
- case 1:
- rgb = [X, C, 0];
- break;
- case 2:
- rgb = [0, C, X];
- break;
- case 3:
- rgb = [0, X, C];
- break;
- case 4:
- rgb = [X, 0, C];
- break;
- case 5:
- rgb = [C, 0, X];
- break;
- }
- rgb = [rgb[0] + m, rgb[1] + m, rgb[2] + m];
- }
- return 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.
- */
- Ext.define('Ext.dd.StatusProxy', {
- animRepair: false,
- /**
- * Creates new StatusProxy.
- * @param {Object} config (optional) Config object.
- */
- constructor: function(config){
- Ext.apply(this, config);
- this.id = this.id || Ext.id();
- this.proxy = Ext.createWidget('component', {
- floating: true,
- stateful: false,
- id: this.id,
- html: '<div class="' + Ext.baseCSSPrefix + 'dd-drop-icon"></div>' +
- '<div class="' + Ext.baseCSSPrefix + 'dd-drag-ghost"></div>',
- 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.Element.VISIBILITY);
- this.el.hide();
- this.ghost = Ext.get(this.el.dom.childNodes[1]);
- this.dropStatus = this.dropNotAllowed;
- },
- /**
- * @cfg {String} [dropAllowed="x-dd-drop-ok"]
- * The CSS class to apply to the status element when drop is allowed.
- */
- dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok',
- /**
- * @cfg {String} [dropNotAllowed="x-dd-drop-nodrop"]
- * The CSS class to apply to the status element when drop is not allowed.
- */
- 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.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 {Number[]} 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 (<code>this</code> 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);
- }
- });
- /**
- * 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.
- * @private
- */
- Ext.define('Ext.panel.Proxy', {
- alternateClassName: 'Ext.dd.PanelProxy',
- /**
- * Creates new panel proxy.
- * @param {Ext.panel.Panel} panel The {@link Ext.panel.Panel} to proxy for
- * @param {Object} [config] Config object
- */
- 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.
- * 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 {Ext.Element} The proxy's element
- */
- getEl: function(){
- return this.ghost.el;
- },
- /**
- * Gets the proxy's ghost Panel
- * @return {Ext.panel.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 {Ext.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.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] 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.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) {
- if (this.onLayout_running) {
- return;
- }
- this.onLayout_running = true;
- 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: {}
- };
- // Clear isAutoDock flag
- delete layout.isAutoDock;
- 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 == null || 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 == null) && (width == null)) {
- autoHeight = true;
- autoWidth = true;
- me.setTargetSize(null);
- me.setBodyBox({width: null, height: null});
- }
- // Auto-height
- else if (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;
- // Set flag so we don't do a redundant container layout
- layout.isAutoDock = layout.autoSize !== 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;
- info.autoHeight = autoHeight;
- info.autoWidth = autoWidth;
- }
- // 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();
- me.setTargetSize(info.size.width, info.size.height);
- }
- else {
- me.setTargetSize(width, height);
- me.dockItems();
- }
- me.callParent(arguments);
- this.onLayout_running = false;
- },
- /**
- * @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() {
- this.calculateDockBoxes();
- // 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,
- autoWidth = info.autoWidth,
- autoHeight = info.autoHeight,
- boxes = info.boxes,
- ln = boxes.length,
- dock, i, item;
- // 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];
- item = dock.item;
- item.setPosition(dock.x, dock.y);
- if ((autoWidth || autoHeight) && item.layout && item.layout.isLayout) {
- // Auto-Sized so have the container layout notify the component layout.
- item.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() {
- if (this.calculateDockBoxes_running) {
- // [AbstractDock#calculateDockBoxes] attempted to run again while it was already running
- return;
- }
- this.calculateDockBoxes_running = true;
- // 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,
- autoWidth = info.autoWidth,
- autoHeight = info.autoHeight,
- 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);
- }
- this.calculateDockBoxes_running = false;
- },
- /**
- * @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,
- owner = this.owner,
- 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;
- if (info.autoHeight) {
- size.height += box.height;
- } else {
- bodyBox.height -= box.height;
- }
- }
- break;
- case 'bottom':
- if (!box.overlay) {
- if (info.autoHeight) {
- size.height += box.height;
- } else {
- bodyBox.height -= box.height;
- }
- }
- box.y = (bodyBox.y + bodyBox.height);
- break;
- case 'left':
- box.x = bodyBox.x;
- if (!box.overlay) {
- bodyBox.x += box.width;
- if (info.autoWidth) {
- size.width += box.width;
- } else {
- bodyBox.width -= box.width;
- }
- }
- break;
- case 'right':
- if (!box.overlay) {
- if (info.autoWidth) {
- 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.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 <b>visible</b> docked items inside this layout's owner Panel
- * @return {Array} An array containing all the <b>visible</b> 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.contains(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);
- if (item.dock == 'top' || item.dock == 'bottom') {
- item.layoutManagedWidth = 1;
- item.layoutManagedHeight = 2;
- } else {
- item.layoutManagedWidth = 2;
- item.layoutManagedHeight = 1;
- }
-
- 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.util.Memento
- * This class manages a set of captured properties from an object. These captured properties
- * can later be restored to an object.
- */
- Ext.define('Ext.util.Memento', function () {
- function captureOne (src, target, prop) {
- src[prop] = target[prop];
- }
- function removeOne (src, target, prop) {
- delete src[prop];
- }
- function restoreOne (src, target, prop) {
- var value = src[prop];
- if (value || src.hasOwnProperty(prop)) {
- restoreValue(target, prop, value);
- }
- }
- function restoreValue (target, prop, value) {
- if (Ext.isDefined(value)) {
- target[prop] = value;
- } else {
- delete target[prop];
- }
- }
- function doMany (doOne, src, target, props) {
- if (src) {
- if (Ext.isArray(props)) {
- Ext.each(props, function (prop) {
- doOne(src, target, prop);
- });
- } else {
- doOne(src, target, props);
- }
- }
- }
- return {
- /**
- * @property data
- * The collection of captured properties.
- * @private
- */
- data: null,
- /**
- * @property target
- * The default target object for capture/restore (passed to the constructor).
- */
- target: null,
- /**
- * Creates a new memento and optionally captures properties from the target object.
- * @param {Object} target The target from which to capture properties. If specified in the
- * constructor, this target becomes the default target for all other operations.
- * @param {String/String[]} props The property or array of properties to capture.
- */
- constructor: function (target, props) {
- if (target) {
- this.target = target;
- if (props) {
- this.capture(props);
- }
- }
- },
- /**
- * Captures the specified properties from the target object in this memento.
- * @param {String/String[]} props The property or array of properties to capture.
- * @param {Object} target The object from which to capture properties.
- */
- capture: function (props, target) {
- doMany(captureOne, this.data || (this.data = {}), target || this.target, props);
- },
- /**
- * Removes the specified properties from this memento. These properties will not be
- * restored later without re-capturing their values.
- * @param {String/String[]} props The property or array of properties to remove.
- */
- remove: function (props) {
- doMany(removeOne, this.data, null, props);
- },
- /**
- * Restores the specified properties from this memento to the target object.
- * @param {String/String[]} props The property or array of properties to restore.
- * @param {Boolean} clear True to remove the restored properties from this memento or
- * false to keep them (default is true).
- * @param {Object} target The object to which to restore properties.
- */
- restore: function (props, clear, target) {
- doMany(restoreOne, this.data, target || this.target, props);
- if (clear !== false) {
- this.remove(props);
- }
- },
- /**
- * Restores all captured properties in this memento to the target object.
- * @param {Boolean} clear True to remove the restored properties from this memento or
- * false to keep them (default is true).
- * @param {Object} target The object to which to restore properties.
- */
- restoreAll: function (clear, target) {
- var me = this,
- t = target || this.target;
- Ext.Object.each(me.data, function (prop, value) {
- restoreValue(t, prop, value);
- });
- if (clear !== false) {
- delete me.data;
- }
- }
- };
- }());
- /**
- * @class Ext.app.EventBus
- * @private
- */
- 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!
- if (event.fire.apply(event, Array.prototype.slice.call(args, 1)) === false) {
- return false;
- };
- }
- }
- }
- }
- }
- },
- 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
- * <p>This is a static class containing the system-supplied data types which may be given to a {@link Ext.data.Field Field}.<p/>
- * <p>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.</p>
- * <p>Developers may add their own application-specific data types to this class. Definition names must be UPPERCASE.
- * each type definition must contain three properties:</p>
- * <div class="mdetail-params"><ul>
- * <li><code>convert</code> : <i>Function</i><div class="sub-desc">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:
- * <div class="mdetail-params"><ul>
- * <li><b>v</b> : Mixed<div class="sub-desc">The data value as read by the Reader, if undefined will use
- * the configured <tt>{@link Ext.data.Field#defaultValue defaultValue}</tt>.</div></li>
- * <li><b>rec</b> : Mixed<div class="sub-desc">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.</div></li>
- * </ul></div></div></li>
- * <li><code>sortType</code> : <i>Function</i> <div class="sub-desc">A function to convert the stored data into comparable form, as defined by {@link Ext.data.SortTypes}.</div></li>
- * <li><code>type</code> : <i>String</i> <div class="sub-desc">A textual data type name.</div></li>
- * </ul></div>
- * <p>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 <code>lat</code> and <code>long</code>, you would define a new data type like this:</p>
- *<pre><code>
- // 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'
- };
- </code></pre>
- * <p>Then, when declaring a Model, use: <pre><code>
- 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: 'longitude', mapping: 'long', type: types.FLOAT },
- { name: 'position', type: types.VELATLONG }
- ]
- });
- </code></pre>
- * @singleton
- */
- Ext.define('Ext.data.Types', {
- singleton: true,
- requires: ['Ext.data.SortTypes']
- }, function() {
- var st = Ext.data.SortTypes;
- Ext.apply(Ext.data.Types, {
- /**
- * @property {RegExp} stripRe
- * A regular expression for stripping non-numeric characters from a numeric value. Defaults to <tt>/[\$,%]/g</tt>.
- * This should be overridden for localization.
- */
- stripRe: /[\$,%]/g,
- /**
- * @property {Object} 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'
- },
- /**
- * @property {Object} 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'
- },
- /**
- * @property {Object} INT
- * This data type means that the raw data is converted into an integer before it is placed into a Record.
- * <p>The synonym <code>INTEGER</code> is equivalent.</p>
- */
- 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'
- },
- /**
- * @property {Object} FLOAT
- * This data type means that the raw data is converted into a number before it is placed into a Record.
- * <p>The synonym <code>NUMBER</code> is equivalent.</p>
- */
- 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'
- },
- /**
- * @property {Object} BOOL
- * <p>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 <code>true</code>.</p>
- * <p>The synonym <code>BOOLEAN</code> is equivalent.</p>
- */
- 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'
- },
- /**
- * @property {Object} 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,
- parsed;
- 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);
- }
- parsed = Date.parse(v);
- return parsed ? new Date(parsed) : null;
- },
- sortType: st.asDate,
- type: 'date'
- }
- });
- Ext.apply(Ext.data.Types, {
- /**
- * @property {Object} BOOLEAN
- * <p>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 <code>true</code>.</p>
- * <p>The synonym <code>BOOL</code> is equivalent.</p>
- */
- BOOLEAN: this.BOOL,
- /**
- * @property {Object} INTEGER
- * This data type means that the raw data is converted into an integer before it is placed into a Record.
- * <p>The synonym <code>INT</code> is equivalent.</p>
- */
- INTEGER: this.INT,
- /**
- * @property {Object} NUMBER
- * This data type means that the raw data is converted into a number before it is placed into a Record.
- * <p>The synonym <code>FLOAT</code> is equivalent.</p>
- */
- NUMBER: this.FLOAT
- });
- });
- /**
- * @author Ed Spencer
- *
- * 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.create('User', {name: 'Ed Spencer'});
- *
- * 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 {String/Object} type
- *
- * 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
- *
- * 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 Ext.data.Model#fields fields} array.
- *
- * Example of convert functions:
- *
- * 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 = Ext.create('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
- *
- * 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 Ext.Date}.
- */
- dateFormat: null,
-
- /**
- * @cfg {Boolean} useNull
- *
- * 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 {Object} defaultValue
- *
- * 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
- *
- * 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
- *
- * Initial direction to sort (`"ASC"` or `"DESC"`). Defaults to `"ASC"`.
- */
- sortDir : "ASC",
- /**
- * @cfg {Boolean} allowBlank
- * @private
- *
- * 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
- });
- /**
- * @class Ext.util.AbstractMixedCollection
- * @private
- */
- 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 <tt>true</tt> if the {@link #addAll}
- * function should add function references to the collection. Defaults to
- * <tt>false</tt>.
- */
- allowFunctions : false,
- /**
- * Adds an item to the collection. Fires the {@link #add} event when complete.
- * @param {String} key <p>The key to associate with the item, or the new item.</p>
- * <p>If a {@link #getKey} implementation was specified for this MixedCollection,
- * or if the key of the stored items is in a property called <tt><b>id</b></tt>,
- * the MixedCollection will be able to <i>derive</i> the key for the new item.
- * In this case just pass the new item in this parameter.</p>
- * @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 <b><code>item.id</code></b> but you can provide your own implementation
- * to return a different value as in the following examples:<pre><code>
- // 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);
- * </code></pre>
- * @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 <p>The key associated with the item to replace, or the replacement item.</p>
- * <p>If you supplied a {@link #getKey} implementation for this MixedCollection, or if the key
- * of your stored items is in a property called <tt><b>id</b></tt>, then the MixedCollection
- * will be able to <i>derive</i> 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.</p>
- * @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 <code>{@link #allowFunctions}</code>
- * has been set to <tt>true</tt>.
- */
- 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:
- * <div class="mdetail-params"><ul>
- * <li><b>item</b> : Mixed<p class="sub-desc">The collection item</p></li>
- * <li><b>index</b> : Number<p class="sub-desc">The item's index</p></li>
- * <li><b>length</b> : Number<p class="sub-desc">The total number of items in the collection</p></li>
- * </ul></div>
- * 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 (<code>this</code> 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 (<code>this</code> 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 (<code>this</code> reference) in which the function is executed. Defaults to the browser window.
- * @return {Object} The first item in the collection which returned true from the selection function, or null if none was found
- */
- findBy : function(fn, scope) {
- var keys = this.keys,
- items = this.items,
- i = 0,
- len = items.length;
- for (; i < len; i++) {
- if (fn.call(scope || window, items[i], keys[i])) {
- return items[i];
- }
- }
- return null;
- },
- //<deprecated since="0.99">
- 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);
- },
- //</deprecated>
- /**
- * 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++;
- Ext.Array.splice(me.items, index, 0, myObj);
- if (typeof myKey != 'undefined' && myKey !== null) {
- me.map[myKey] = myObj;
- }
- Ext.Array.splice(me.keys, 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];
- Ext.Array.erase(me.items, index, 1);
- key = me.keys[index];
- if (typeof key != 'undefined') {
- delete me.map[key];
- }
- Ext.Array.erase(me.keys, index, 1);
- 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 #getByKey} first, then if nothing matched calling {@link #getAt}.
- * @param {String/Number} key The key or index of the item.
- * @return {Object} If the item is found, returns the item. If the item was not found, returns <tt>undefined</tt>.
- * If an item was found, but is a Class, returns <tt>null</tt>.
- */
- 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] 'root' property to extract the first argument from. This is used mainly when
- * summing fields in records, where the fields are all stored inside the 'data' object
- * @param {Number} [start=0] The record index to start at
- * @param {Number} [end=-1] The record index to end at
- * @return {Number} The total
- */
- sum: function(property, root, start, end) {
- var values = this.extractValues(property, root),
- length = values.length,
- sum = 0,
- i;
- start = start || 0;
- end = (end || end === 0) ? end : length - 1;
- for (i = start; i <= end; i++) {
- sum += values[i];
- }
- return sum;
- },
- /**
- * Collects unique values of a particular property in this MixedCollection
- * @param {String} property The property to collect on
- * @param {String} root (optional) 'root' property to extract the first argument from. This is used mainly when
- * summing fields in records, where the fields are all stored inside the 'data' object
- * @param {Boolean} allowBlank (optional) Pass true to allow null, undefined or empty string values
- * @return {Array} The unique values
- */
- collect: function(property, root, allowNull) {
- var values = this.extractValues(property, root),
- length = values.length,
- hits = {},
- unique = [],
- value, strValue, i;
- for (i = 0; i < length; i++) {
- value = values[i];
- strValue = String(value);
- if ((allowNull || !Ext.isEmpty(value)) && !hits[strValue]) {
- hits[strValue] = true;
- unique.push(value);
- }
- }
- return unique;
- },
- /**
- * @private
- * Extracts all of the given property values from the items in the MC. Mainly used as a supporting method for
- * functions like sum and collect.
- * @param {String} property The property to extract
- * @param {String} root (optional) 'root' property to extract the first argument from. This is used mainly when
- * extracting field data from Model instances, where the fields are stored inside the 'data' object
- * @return {Array} The extracted values
- */
- extractValues: function(property, root) {
- var values = this.items;
- if (root) {
- values = Ext.Array.pluck(values, root);
- }
- return Ext.Array.pluck(values, property);
- },
- /**
- * 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;
- },
- /**
- * <p>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:</p>
- <pre><code>
- //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);
- </code></pre>
- *
- *
- * @param {Ext.util.Filter[]/String} property A property on your objects, or an array of {@link Ext.util.Filter Filter} objects
- * @param {String/RegExp} value Either string that the property values
- * should start with or a RegExp to test against the property
- * @param {Boolean} [anyMatch=false] True to match any part of the string, not just the beginning
- * @param {Boolean} [caseSensitive=false] True for case sensitive comparison.
- * @return {Ext.util.MixedCollection} The new filtered collection
- */
- 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 <i>new</i> 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 (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.
- * @return {Ext.util.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=0] The index to start searching at.
- * @param {Boolean} [anyMatch=false] True to match any part of the string, not just the beginning.
- * @param {Boolean} [caseSensitive=false] True for case sensitive comparison.
- * @return {Number} The matched index or -1
- */
- 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 <i>true</i> 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] The scope (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.
- * @param {Number} [start=0] The index to start searching at.
- * @return {Number} The matched index or -1
- */
- 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 {Ext.util.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;
- }
- });
- /**
- * @docauthor Tommy Maintz <tommy@sencha.com>
- *
- * A mixin which allows a data component to be sorted. This is used by e.g. {@link Ext.data.Store} and {@link Ext.data.TreeStore}.
- *
- * **NOTE**: This mixin is mainly for internal use and most users should not need to use it directly. It
- * is more likely you will want to use one of the component classes that import this mixin, such as
- * {@link Ext.data.Store} or {@link Ext.data.TreeStore}.
- */
- Ext.define("Ext.util.Sortable", {
- /**
- * @property {Boolean} isSortable
- * Flag denoting that this object is sortable. Always true.
- */
- isSortable: true,
- /**
- * @property {String} defaultSortDirection
- * The default sort direction to use if one is not specified.
- */
- defaultSortDirection: "ASC",
- requires: [
- 'Ext.util.Sorter'
- ],
- /**
- * @property {String} sortRoot
- * The property in each item that contains the data to sort.
- */
- /**
- * Performs initialization of this mixin. Component classes using this mixin should call this method during their
- * own initialization.
- */
- initSortable: function() {
- var me = this,
- sorters = me.sorters;
- /**
- * @property {Ext.util.MixedCollection} sorters
- * The collection of {@link Ext.util.Sorter Sorters} currently applied to this Store
- */
- me.sorters = 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/Ext.util.Sorter[]} sorters Either a string name of one of the fields in this Store's configured
- * {@link Ext.data.Model Model}, or an array of sorter configurations.
- * @param {String} direction The overall direction to sort the data by. Defaults to "ASC".
- * @return {Ext.util.Sorter[]}
- */
- 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);
-
- 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 {Object[]} sorters The sorters array
- * @return {Ext.util.Sorter[]} Array of Ext.util.Sorter objects
- */
- decodeSorters: function(sorters) {
- if (!Ext.isArray(sorters)) {
- if (sorters === undefined) {
- sorters = [];
- } else {
- sorters = [sorters];
- }
- }
- var length = sorters.length,
- Sorter = Ext.util.Sorter,
- fields = this.model ? this.model.prototype.fields : null,
- field,
- config, i;
- for (i = 0; i < length; i++) {
- config = sorters[i];
- if (!(config instanceof Sorter)) {
- if (Ext.isString(config)) {
- config = {
- property: config
- };
- }
- Ext.applyIf(config, {
- root : this.sortRoot,
- direction: "ASC"
- });
- //support for 3.x style sorters where a function can be defined as 'fn'
- if (config.fn) {
- config.sorterFn = config.fn;
- }
- //support a function to be passed as a sorter definition
- if (typeof config == 'function') {
- config = {
- sorterFn: config
- };
- }
- // ensure sortType gets pushed on if necessary
- if (fields && !config.transform) {
- field = fields.get(config.property);
- config.transform = field ? field.sortType : undefined;
- }
- sorters[i] = Ext.create('Ext.util.Sorter', config);
- }
- }
- return sorters;
- },
- getSorters: function() {
- return this.sorters.items;
- }
- });
- /**
- * @class Ext.util.MixedCollection
- * <p>
- * 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:
- * <pre><code>
- 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
- * </code></pre>
- *
- * <p>
- * The MixedCollection also has support for sorting and filtering of the values in the collection.
- * <pre><code>
- 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
- * </code></pre>
- * </p>
- */
- Ext.define('Ext.util.MixedCollection', {
- extend: 'Ext.util.AbstractMixedCollection',
- mixins: {
- sortable: 'Ext.util.Sortable'
- },
- /**
- * Creates new MixedCollection.
- * @param {Boolean} allowFunctions Specify <tt>true</tt> if the {@link #addAll}
- * function should add function references to the collection. Defaults to
- * <tt>false</tt>.
- * @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.
- */
- 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 <b>key</b>s.
- * @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);
- });
- }
- });
- /**
- * @author Ed Spencer
- * @class Ext.data.Errors
- * @extends Ext.util.MixedCollection
- *
- * <p>Wraps a collection of validation error responses and provides convenient functions for
- * accessing and errors for specific fields.</p>
- *
- * <p>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:</p>
- *
- <pre><code>
- //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'}]
- </code></pre>
- */
- 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 {Object[]} 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
- *
- * Readers are used to interpret data to be loaded into a {@link Ext.data.Model Model} instance or a {@link
- * Ext.data.Store Store} - often in response to an AJAX request. In general there is usually no need to create
- * a Reader instance directly, since a Reader is almost always used together with a {@link Ext.data.proxy.Proxy Proxy},
- * and is configured using the Proxy's {@link Ext.data.proxy.Proxy#cfg-reader reader} configuration property:
- *
- * Ext.create('Ext.data.Store', {
- * model: 'User',
- * proxy: {
- * type: 'ajax',
- * url : 'users.json',
- * reader: {
- * type: 'json',
- * root: 'users'
- * }
- * },
- * });
- *
- * The above reader is configured to consume a JSON string that looks something like this:
- *
- * {
- * "success": true,
- * "users": [
- * { "name": "User 1" },
- * { "name": "User 2" }
- * ]
- * }
- *
- *
- * # 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 = Ext.create('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
- */
- 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.Server}.{@link Ext.data.proxy.Server#exception exception} for additional information.
- */
- successProperty: 'success',
- /**
- * @cfg {String} root
- * The name of the property which contains the Array of row objects. For JSON reader it's dot-separated list
- * of property names. For XML reader it's a CSS selector. For array reader it's not applicable.
- *
- * By default the natural root of the data will be used. The root Json array, the root XML element, or the array.
- *
- * 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,
-
- /**
- * Creates new Reader.
- * @param {Object} config (optional) Config object.
- */
- 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 {Object} 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);
- }
-
- /**
- * @property {Object} rawData
- * The raw data object that was last passed to readRecords. Stored for further processing if needed
- */
- 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} 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 {Object} 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 {Object} data The raw data object
- * @param {String} associationName The name of the association to get data for (uses associationKey if present)
- * @return {Object} 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 {Object} data The data object
- * @return {Object} 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) {
- //<debug>
- Ext.Error.raise("getResponseData must be implemented in the Ext.data.reader.Reader subclass");
- //</debug>
- },
- /**
- * @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=false] True to automatically remove existing extractor functions first
- */
- 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
- *
- * <p>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:</p>
- *
- <pre><code>
- Ext.define('User', {
- extend: 'Ext.data.Model',
- fields: ['id', 'name', 'email']
- });
- var store = Ext.create('Ext.data.Store', {
- model: 'User',
- proxy: {
- type: 'ajax',
- url : 'users.json',
- reader: {
- type: 'json'
- }
- }
- });
- </code></pre>
- *
- * <p>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.</p>
- *
- * <p>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:
- *
- <pre><code>
- reader: {
- type : 'json',
- model: 'User'
- }
- </code></pre>
- *
- * <p>The reader we set up is ready to read data from our server - at the moment it will accept a response like this:</p>
- *
- <pre><code>
- [
- {
- "id": 1,
- "name": "Ed Spencer",
- "email": "ed@sencha.com"
- },
- {
- "id": 2,
- "name": "Abe Elias",
- "email": "abe@sencha.com"
- }
- ]
- </code></pre>
- *
- * <p><u>Reading other JSON formats</u></p>
- *
- * <p>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:</p>
- *
- <pre><code>
- {
- "users": [
- {
- "id": 1,
- "name": "Ed Spencer",
- "email": "ed@sencha.com"
- },
- {
- "id": 2,
- "name": "Abe Elias",
- "email": "abe@sencha.com"
- }
- ]
- }
- </code></pre>
- *
- * <p>To parse this we just pass in a {@link #root} configuration that matches the 'users' above:</p>
- *
- <pre><code>
- reader: {
- type: 'json',
- root: 'users'
- }
- </code></pre>
- *
- * <p>Sometimes the JSON structure is even more complicated. Document databases like CouchDB often provide metadata
- * around each record inside a nested structure like this:</p>
- *
- <pre><code>
- {
- "total": 122,
- "offset": 0,
- "users": [
- {
- "id": "ed-spencer-1",
- "value": 1,
- "user": {
- "id": 1,
- "name": "Ed Spencer",
- "email": "ed@sencha.com"
- }
- }
- ]
- }
- </code></pre>
- *
- * <p>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:</p>
- *
- <pre><code>
- reader: {
- type : 'json',
- root : 'users',
- record: 'user'
- }
- </code></pre>
- *
- * <p><u>Response metadata</u></p>
- *
- * <p>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:</p>
- *
- <pre><code>
- {
- "total": 100,
- "success": true,
- "users": [
- {
- "id": 1,
- "name": "Ed Spencer",
- "email": "ed@sencha.com"
- }
- ]
- }
- </code></pre>
- *
- * <p>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:</p>
- *
- <pre><code>
- reader: {
- type : 'json',
- root : 'users',
- totalProperty : 'total',
- successProperty: 'success'
- }
- </code></pre>
- *
- * <p>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.</p>
- */
- 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.
- */
- /**
- * @cfg {Boolean} useSimpleAccessors True to ensure that field names/mappings are treated as literals when
- * reading values. Defalts to <tt>false</tt>.
- * 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 {Object} jsonData
- */
- this.jsonData = data;
- return this.callParent([data]);
- },
- //inherit docs
- getResponseData: function(response) {
- var data;
- try {
- 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()
- });
- }
- //<debug>
- if (!data) {
- Ext.Error.raise('JSON object not found');
- }
- //</debug>
- 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 {Ext.data.Model[]} The records
- */
- extractData: function(root) {
- var recordName = this.record,
- data = [],
- length, i;
- if (recordName) {
- length = root.length;
-
- if (!length && Ext.isObject(root)) {
- length = 1;
- root = [root];
- }
- 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 <tt>undefined</tt>.
- * Example generated request, using root: 'records':
- <pre><code>
- {'records': [{name: 'my record'}, {name: 'another record'}]}
- </code></pre>
- */
- root: undefined,
-
- /**
- * @cfg {Boolean} encode True to use Ext.encode() on the data before sending. Defaults to <tt>false</tt>.
- * 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 <tt>true</tt>. Example:
- * <pre><code>
- // with allowSingle: true
- "root": {
- "first": "Mark",
- "last": "Corrigan"
- }
- // with allowSingle: false
- "root": [{
- "first": "Mark",
- "last": "Corrigan"
- }]
- * </code></pre>
- */
- 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 {
- //<debug>
- Ext.Error.raise('Must specify a root when using encode');
- //</debug>
- }
- } else {
- // send as jsonData
- request.jsonData = request.jsonData || {};
- if (root) {
- request.jsonData[root] = data;
- } else {
- request.jsonData = data;
- }
- }
- return request;
- }
- });
- /**
- * @author Ed Spencer
- *
- * 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.Manager} 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.
- */
- 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.
- */
-
- /**
- * @cfg {Object/String/Ext.data.reader.Reader} reader
- * The Ext.data.reader.Reader to use to decode the server's response or data read from client. 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 or saved to client. This can either be
- * a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').
- */
-
- isProxy: true,
-
- /**
- * Creates the Proxy
- * @param {Object} config (optional) Config object.
- */
- 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
- *
- * 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).
- * @private
- */
- 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 {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
- * Disable caching by adding a unique parameter name to the request. Set to false to allow caching. Defaults to true.
- */
- 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
- * The number of milliseconds to wait for a response. Defaults to 30000 milliseconds (30 seconds).
- */
- timeout : 30000,
- /**
- * @cfg {Object} api
- * Specific urls to call on CRUD action methods "create", "read", "update" and "destroy". Defaults to:
- *
- * api: {
- * create : undefined,
- * read : undefined,
- * update : undefined,
- * destroy : undefined
- * }
- *
- * The url is built based upon the action being executed [create|read|update|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: {
- * create : '/controller/new',
- * read : '/controller/load',
- * update : '/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}.
- */
- 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(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;
- },
- // Should this be documented as protected method?
- processResponse: function(success, operation, request, response, callback, scope){
- var me = this,
- reader,
- result;
- if (success === true) {
- reader = me.getReader();
- result = reader.read(me.extractResponseData(response));
- if (result.success !== false) {
- //see comment in buildRequest for why we include the response object here
- Ext.apply(operation, {
- response: response,
- resultSet: result
- });
- operation.commitRecords(result.records);
- 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.
- * @template
- * @private
- * @param {Object} response The server response
- * @return {Object} 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 {Object} 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 {Ext.util.Sorter[]} 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 {Ext.util.Filter[]} filters 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(operation) {
- var me = this,
- params = {},
- 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);
- //<debug>
- if (!url) {
- Ext.Error.raise("You are using a ServerProxy but have not supplied it with a url.");
- }
- //</debug>
- 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) {
- //<debug>
- Ext.Error.raise("The doRequest function has not been implemented on your Ext.data.proxy.Server subclass. See src/data/ServerProxy.js for details");
- //</debug>
- },
- /**
- * 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
- *
- * 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 = Ext.create('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 Ext.data.Store#proxy 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 Ext.data.Store#load load} will override any specified callback and params options. In this case, use the
- * {@link Ext.data.Store Store}'s events to modify parameters, or react to loading events.
- *
- * @param {Object} config (optional) Config object.
- * 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 {Object} 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
- *
- * 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.create('User', {
- * name : 'Conan',
- * age : 24,
- * phone: '555-555-5555'
- * });
- *
- * 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.create('User', {
- * name: 'Ed',
- * gender: 'Male',
- * username: 'edspencer'
- * });
- *
- * 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.create('User', {name: 'Ed Spencer', email: 'ed@sencha.com'});
- *
- * 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 = Ext.create('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
- * Creates new Model instance.
- * @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.IdGenerator',
- '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,
- idgen = data.idgen,
- 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;
- if (idgen) {
- data.idgen = Ext.data.IdGenerator.get(idgen);
- }
- //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
- * @return {Ext.data.proxy.Proxy}
- * @static
- * @inheritable
- */
- 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
- * @static
- * @inheritable
- */
- getProxy: function() {
- return this.proxy;
- },
- /**
- * 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
- * @static
- * @inheritable
- */
- 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 Ext#create
- * create}d and {@link #constructor 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;
- }
- },
- /**
- * @cfg {String/Object} idgen
- * The id generator to use for this model. The default id generator does not generate
- * values for the {@link #idProperty}.
- *
- * This can be overridden at the model level to provide a custom generator for a model.
- * The simplest form of this would be:
- *
- * Ext.define('MyApp.data.MyModel', {
- * extend: 'Ext.data.Model',
- * requires: ['Ext.data.SequentialIdGenerator'],
- * idgen: 'sequential',
- * ...
- * });
- *
- * The above would generate {@link Ext.data.SequentialIdGenerator sequential} id's such
- * as 1, 2, 3 etc..
- *
- * Another useful id generator is {@link Ext.data.UuidGenerator}:
- *
- * Ext.define('MyApp.data.MyModel', {
- * extend: 'Ext.data.Model',
- * requires: ['Ext.data.UuidGenerator'],
- * idgen: 'uuid',
- * ...
- * });
- *
- * An id generation can also be further configured:
- *
- * Ext.define('MyApp.data.MyModel', {
- * extend: 'Ext.data.Model',
- * idgen: {
- * type: 'sequential',
- * seed: 1000,
- * prefix: 'ID_'
- * }
- * });
- *
- * The above would generate id's such as ID_1000, ID_1001, ID_1002 etc..
- *
- * If multiple models share an id space, a single generator can be shared:
- *
- * Ext.define('MyApp.data.MyModelX', {
- * extend: 'Ext.data.Model',
- * idgen: {
- * type: 'sequential',
- * id: 'xy'
- * }
- * });
- *
- * Ext.define('MyApp.data.MyModelY', {
- * extend: 'Ext.data.Model',
- * idgen: {
- * type: 'sequential',
- * id: 'xy'
- * }
- * });
- *
- * For more complex, shared id generators, a custom generator is the best approach.
- * See {@link Ext.data.IdGenerator} for details on creating custom id generators.
- *
- * @markdown
- */
- idgen: {
- isGenerator: true,
- type: 'default',
- generate: function () {
- return null;
- },
- getRecId: function (rec) {
- return rec.modelName + '-' + rec.internalId;
- }
- },
- /**
- * @property {Boolean} editing
- * Internal flag used to track whether or not the model instance is currently being edited. Read-only.
- */
- editing : false,
- /**
- * @property {Boolean} dirty
- * True if this Record has been modified. Read-only.
- */
- dirty : false,
- /**
- * @cfg {String} persistenceProperty
- * The property on this Persistable object that its data is saved to. Defaults to 'data'
- * (e.g. all persistable data resides in this.data.)
- */
- persistenceProperty: 'data',
- evented: false,
- isModel: true,
- /**
- * @property {Boolean} phantom
- * 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.
- */
- phantom : false,
- /**
- * @cfg {String} idProperty
- * The name of the field treated as this Model's unique id. Defaults to 'id'.
- */
- idProperty: 'id',
- /**
- * @cfg {String} defaultProxyType
- * The string type of the default Model Proxy. Defaults to 'ajax'.
- */
- defaultProxyType: 'ajax',
- // Fields config and property
- /**
- * @cfg {Object[]/String[]} fields
- * The fields for this model.
- */
- /**
- * @property {Ext.util.MixedCollection} fields
- * The fields defined on this model.
- */
- /**
- * @cfg {Object[]} validations
- * An array of {@link Ext.data.validations validations} for this model.
- */
- // Associations configs and properties
- /**
- * @cfg {Object[]} associations
- * An array of {@link Ext.data.Association associations} for this model.
- */
- /**
- * @cfg {String/Object/String[]/Object[]} hasMany
- * One or more {@link Ext.data.HasManyAssociation HasMany associations} for this model.
- */
- /**
- * @cfg {String/Object/String[]/Object[]} belongsTo
- * One or more {@link Ext.data.BelongsToAssociation BelongsTo associations} for this model.
- */
- /**
- * @property {Ext.util.MixedCollection} associations
- * {@link Ext.data.Association Associations} defined on this model.
- */
- /**
- * @cfg {String/Object/Ext.data.proxy.Proxy} proxy
- * The {@link Ext.data.proxy.Proxy proxy} to use for this model.
- */
- // raw not documented intentionally, meant to be used internally.
- constructor: function(data, id, raw) {
- data = data || {};
- var me = this,
- fields,
- length,
- field,
- name,
- i,
- newId,
- 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);
- /**
- * @property {Object} raw The raw data used to create this model if created via a reader.
- */
- me.raw = raw;
- Ext.applyIf(me, {
- data: {}
- });
- /**
- * @property {Object} modified Key: value pairs of all fields whose values have changed
- */
- me.modified = {};
- // Deal with spelling error in previous releases
- if (me.persistanceProperty) {
- //<debug>
- if (Ext.isDefined(Ext.global.console)) {
- Ext.global.console.warn('Ext.data.Model: persistanceProperty has been deprecated. Use persistenceProperty instead.');
- }
- //</debug>
- me.persistenceProperty = me.persistanceProperty;
- }
- me[me.persistenceProperty] = {};
- 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);
- if (me.getId()) {
- me.phantom = false;
- } else if (me.phantom) {
- newId = me.idgen.generate();
- if (newId !== null) {
- me.setId(newId);
- }
- }
- // clear any dirty/modified since we're initializing
- me.dirty = false;
- me.modified = {};
- if (typeof me.init == 'function') {
- me.init();
- }
- me.id = me.idgen.getRecId(me);
- },
- /**
- * Returns the value of the given field
- * @param {String} fieldName The field to fetch the value for
- * @return {Object} The value
- */
- get: function(field) {
- return this[this.persistenceProperty][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 {Object} value The value to set
- */
- set: function(fieldName, value) {
- var me = this,
- fields = me.fields,
- modified = me.modified,
- convertFields = [],
- field, key, i, currentValue, notEditing, count, length;
- /*
- * 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)) {
- notEditing = !me.editing;
- count = 0;
- 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;
- }
- if (!count && notEditing) {
- me.beginEdit();
- }
- ++count;
- me.set(key, fieldName[key]);
- }
- }
- length = convertFields.length;
- if (length) {
- if (!count && notEditing) {
- me.beginEdit();
- }
- count += length;
- for (i = 0; i < length; i++) {
- field = convertFields[i];
- me.set(field, fieldName[field]);
- }
- }
- if (notEditing && count) {
- me.endEdit();
- }
- } else {
- if (fields) {
- field = fields.get(fieldName);
- if (field && field.convert) {
- value = field.convert(value, me);
- }
- }
- currentValue = me.get(fieldName);
- me[me.persistenceProperty][fieldName] = value;
- if (field && field.persist && !me.isEqual(currentValue, value)) {
- if (me.isModified(fieldName)) {
- if (me.isEqual(modified[fieldName], value)) {
- // the original value in me.modified equals the new value, so the
- // field is no longer modified
- delete modified[fieldName];
- // we might have removed the last modified field, so check to see if
- // there are any modified fields remaining and correct me.dirty:
- me.dirty = false;
- for (key in modified) {
- if (modified.hasOwnProperty(key)){
- me.dirty = true;
- break;
- }
- }
- }
- } else {
- me.dirty = true;
- 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;
- },
- /**
- * Begins 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.persistenceProperty]);
- 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.persistenceProperty] = me.dataSave;
- me.dirty = me.dirtySave;
- delete me.modifiedSave;
- delete me.dataSave;
- delete me.dirtySave;
- }
- },
- /**
- * Ends 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,
- didChange;
-
- if (me.editing) {
- me.editing = false;
- didChange = me.dirty || me.changedWhileEditing();
- delete me.modifiedSave;
- delete me.dataSave;
- delete me.dirtySave;
- if (silent !== true && didChange) {
- me.afterEdit();
- }
- }
- },
-
- /**
- * Checks if the underlying data has changed during an edit. This doesn't necessarily
- * mean the record is dirty, however we still need to notify the store since it may need
- * to update any views.
- * @private
- * @return {Boolean} True if the underlying data has changed during an edit.
- */
- changedWhileEditing: function(){
- var me = this,
- saved = me.dataSave,
- data = me[me.persistenceProperty],
- key;
-
- for (key in data) {
- if (data.hasOwnProperty(key)) {
- if (!me.isEqual(data[key], saved[key])) {
- return true;
- }
- }
- }
- return false;
- },
- /**
- * 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.proxy.Server#writer writer enabled store}.
- *
- * Marking a record `{@link #dirty}` causes the phantom to be returned by {@link Ext.data.Store#getUpdatedRecords}
- * where it will have a create action composed for it during {@link Ext.data.Model#save model 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);
- },
- //<debug>
- 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);
- },
- //</debug>
- /**
- * 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.persistenceProperty][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.phantom = me.dirty = me.editing = false;
- me.modified = {};
- if (silent !== true) {
- me.afterCommit();
- }
- },
- /**
- * Creates a copy (clone) of this Model instance.
- *
- * @param {String} [id] A new id, defaults to the id of the instance being copied.
- * See `{@link Ext.data.Model#id 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 {Ext.data.Model}
- */
- copy : function(newId) {
- var me = this;
- return new me.self(Ext.apply({}, me[me.persistenceProperty]), 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
- * @return {Ext.data.proxy.Proxy}
- */
- 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}.
- * @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. Config object for {@link Ext.data.Operation}.
- * @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. Config object for {@link Ext.data.Operation}.
- * @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 to which this model has been added.
- */
- join : function(store) {
- /**
- * @property {Ext.data.Store} store
- * The {@link Ext.data.Store Store} to which this Record belongs.
- */
- this.store = store;
- },
- /**
- * Tells this model instance that it has been removed from the store.
- * @param {Ext.data.Store} store The store from which this model has been removed.
- */
- unjoin: function(store) {
- 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 {String[]} 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;
- }
- });
- /**
- * @docauthor Evan Trimboli <evan@sencha.com>
- *
- * 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
- * });
- *
- */
- 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...} stores Any number of Store instances
- */
- 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...} stores Any number of Store instances or ID-s
- */
- 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} store 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
- * @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);
- };
- /**
- * Shortcut to {@link Ext.data.StoreManager#lookup}.
- * @member Ext
- * @method getStore
- * @alias Ext.data.StoreManager#lookup
- */
- Ext.getStore = function(name) {
- return Ext.data.StoreManager.lookup(name);
- };
- });
- /**
- * 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][1] 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}. See the [Component Guide][2] for more information on xtypes and the
- * Component hierarchy.
- *
- * 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}
- * progressbar {@link Ext.ProgressBar}
- * slider {@link Ext.slider.Single}
- * 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
- * ---------------------------------------
- * pagingtoolbar {@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 cover 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:
- *
- * @example
- * 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 {@link Ext.view.View View}, or {@link
- * Ext.grid.Panel GridPanel}, or {@link Ext.tree.Panel TreePanel} be used.
- *
- * [1]: http://sencha.com/learn/Tutorial:Creating_new_UI_controls
- */
- 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',
- VERTICAL_DIRECTION_Re: /^(?:top|bottom)$/,
- // RegExp whih specifies characters in an xtype which must be translated to '-' when generating auto IDs.
- // This includes dot, comma and whitespace
- INVALID_ID_CHARS_Re: /[\.,\s]/g
- },
- /* End Definitions */
- /**
- * @cfg {Boolean/Object} 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. Only applies when resizable = true.
- */
- resizeHandles: 'all',
- /**
- * @cfg {Boolean} [autoScroll=false]
- * `true` to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary,
- * `false` to clip any overflowing content.
- */
- /**
- * @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.
- */
- toFrontOnShow: true,
- /**
- * @property {Ext.ZIndexManager} zIndexManager
- * 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 {Ext.Container} floatParent
- * 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}
- */
- /**
- * @cfg {Boolean/Object} [draggable=false]
- * 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=false]
- * **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(
- // '<div id="{id}" class="{baseCls} {cls} {cmpCls}<tpl if="typeof ui !== \'undefined\'"> {uiBase}-{ui}</tpl>"<tpl if="typeof style !== \'undefined\'"> style="{style}"</tpl>></div>', {
- // compiled: true,
- // disableFormats: true
- // }
- //),
- /**
- * Creates new Component.
- * @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
- */
- constructor: function(config) {
- var me = this;
- config = config || {};
- if (config.initialConfig) {
- // Being initialized from an Ext.Action instance...
- if (config.isAction) {
- me.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
- };
- }
- me.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 (me.baseAction){
- me.baseAction.addComponent(me);
- }
- },
- /**
- * The initComponent template method is an important initialization step for a Component. It is intended to be
- * implemented by each subclass of Ext.Component to provide any needed constructor logic. The
- * initComponent method of the class being created is called first, with each initComponent method
- * up the hierarchy to Ext.Component being called thereafter. This makes it easy to implement and,
- * if needed, override the constructor logic of the Component at any step in the hierarchy.
- *
- * The initComponent method **must** contain a call to {@link Ext.Base#callParent callParent} in order
- * to ensure that the parent class' initComponent method is also called.
- *
- * The following example demonstrates using a dynamic string for the text of a button at the time of
- * instantiation of the class.
- *
- * Ext.define('DynamicButtonText', {
- * extend: 'Ext.button.Button',
- *
- * initComponent: function() {
- * this.text = new Date();
- * this.renderTo = Ext.getBody();
- * this.callParent();
- * }
- * });
- *
- * Ext.onReady(function() {
- * Ext.create('DynamicButtonText');
- * });
- *
- * @template
- */
- initComponent: function() {
- var me = this;
- me.callParent();
- 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.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) {
- var me = this;
- resizable = Ext.apply({
- target: me,
- dynamic: false,
- constrainTo: me.constrainTo || (me.floatParent ? me.floatParent.getTargetEl() : me.el.getScopeParent()),
- handles: me.resizeHandles
- }, resizable);
- resizable.target = me;
- me.resizer = Ext.create('Ext.resizer.Resizer', resizable);
- },
- getDragEl: function() {
- return this.el;
- },
- initDraggable: function() {
- var me = this,
- ddConfig = Ext.applyIf({
- el: me.getDragEl(),
- constrainTo: me.constrain ? (me.constrainTo || (me.floatParent ? me.floatParent.getTargetEl() : me.el.getScopeParent())) : undefined
- }, me.draggable);
- // Add extra configs if Component is specified to be constrained
- if (me.constrain || me.constrainDelegate) {
- ddConfig.constrain = me.constrain;
- ddConfig.constrainDelegate = me.constrainDelegate;
- }
- me.dd = Ext.create('Ext.util.ComponentDragger', me, 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 {Boolean/Object} [animate] If true, the Component is _animated_ into its new position. You may also pass an
- * animation configuration.
- * @return {Ext.Component} this
- */
- setPosition: function(x, y, animate) {
- var me = this,
- 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
- * Template method called after a Component has been positioned.
- */
- afterSetPosition: function(ax, ay) {
- this.onPosition(ax, ay);
- this.fireEvent('move', this, ax, ay);
- },
- /**
- * Displays component at specific xy position.
- * A floating component (like a menu) is positioned relative to its ownerCt if any.
- * Useful for popping up a context menu:
- *
- * listeners: {
- * itemcontextmenu: function(view, record, item, index, event, options) {
- * Ext.create('Ext.menu.Menu', {
- * width: 100,
- * height: 100,
- * margin: '0 0 10 0',
- * items: [{
- * text: 'regular item 1'
- * },{
- * text: 'regular item 2'
- * },{
- * text: 'regular item 3'
- * }]
- * }).showAt(event.getXY());
- * }
- * }
- *
- * @param {Number} x The new x position
- * @param {Number} y The new y position
- * @param {Boolean/Object} [animate] True to animate the Component into its new position. You may also pass an
- * animation configuration.
- */
- showAt: function(x, y, animate) {
- var me = this;
- if (me.floating) {
- me.setPosition(x, y, animate);
- } else {
- me.setPagePosition(x, y, animate);
- }
- me.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 {Boolean/Object} [animate] True to animate the Component into its new position. You may also pass an
- * animation configuration.
- * @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=false] If true the element's left and top are returned instead of page XY.
- * @return {Object} box An object in the format {x, y, width, height}
- */
- getBox : function(local){
- var pos = this.getPosition(local),
- size = this.getSize();
- size.x = pos[0];
- size.y = pos[1];
- return size;
- },
- /**
- * 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
- 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=false] If true the element's left and top are returned instead of page XY.
- * @return {Number[]} The XY position of the element (e.g., [100, 200])
- */
- getPosition: function(local) {
- var me = this,
- el = me.el,
- xy,
- o;
- // Floating Components which were just rendered with no ownerCt return local position.
- if ((local === true) || (me.floating && !me.floatParent)) {
- return [el.getLeft(true), el.getTop(true)];
- }
- xy = me.xy || el.getXY();
- // Floating Components in an ownerCt have to have their positions made relative
- if (me.floating) {
- o = me.floatParent.getTargetEl().getViewRegion();
- xy[0] -= o.left;
- xy[1] -= o.top;
- }
- return xy;
- },
- getId: function() {
- var me = this,
- xtype;
- if (!me.id) {
- xtype = me.getXType();
- xtype = xtype ? xtype.replace(Ext.Component.INVALID_ID_CHARS_Re, '-') : 'ext-comp';
- me.id = xtype + '-' + me.getAutoId();
- }
- return me.id;
- },
- 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/Ext.Element} [animateTarget=null] **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.
- * @param {Function} [callback] A callback function to call after the Component is displayed.
- * Only necessary if animation was specified.
- * @param {Object} [scope] The scope (`this` reference) in which the callback is executed.
- * Defaults to this Component.
- * @return {Ext.Component} this
- */
- show: function(animateTarget, cb, scope) {
- var me = this;
- if (me.rendered && me.isVisible()) {
- if (me.toFrontOnShow && me.floating) {
- me.toFront();
- }
- } else if (me.fireEvent('beforeshow', me) !== false) {
- me.hidden = false;
- // Render on first show if there is an autoRender config, or if this is a floater (Window, Menu, BoundList etc).
- if (!me.rendered && (me.autoRender || me.floating)) {
- me.doAutoRender();
- }
- if (me.rendered) {
- me.beforeShow();
- me.onShow.apply(me, arguments);
- // Notify any owning Container unless it's suspended.
- // Floating Components do not participate in layouts.
- if (me.ownerCt && !me.floating && !(me.ownerCt.suspendLayout || me.ownerCt.layout.layoutBusy)) {
- me.ownerCt.doLayout();
- }
- me.afterShow.apply(me, arguments);
- }
- }
- return me;
- },
- beforeShow: Ext.emptyFn,
- // Private. Override in subclasses where more complex behaviour is needed.
- onShow: function() {
- var me = this;
- me.el.show();
- me.callParent(arguments);
- if (me.floating && me.constrain) {
- me.doConstrain();
- }
- },
- 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();
- me.el.addCls(Ext.baseCSSPrefix + 'hide-offsets');
- ghostPanel = me.ghost();
- ghostPanel.el.stopAnimation();
- // Shunting it offscreen immediately, *before* the Animation class grabs it ensure no flicker.
- ghostPanel.el.setX(-10000);
- ghostPanel.el.animate({
- from: fromBox,
- to: toBox,
- listeners: {
- afteranimate: function() {
- delete ghostPanel.componentLayout.lastComponentSize;
- me.unghost();
- me.el.removeCls(Ext.baseCSSPrefix + 'hide-offsets');
- me.onShowComplete(cb, scope);
- }
- }
- });
- }
- else {
- me.onShowComplete(cb, scope);
- }
- },
- onShowComplete: function(cb, scope) {
- var me = this;
- 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/Ext.Element/Ext.Component} [animateTarget=null] **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.
- * @param {Function} [callback] A callback function to call after the Component is hidden.
- * @param {Object} [scope] The scope (`this` reference) in which the callback is executed.
- * Defaults to this Component.
- * @return {Ext.Component} this
- */
- hide: function() {
- var me = this;
- // 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.
- me.showOnParentShow = false;
- if (!(me.rendered && !me.isVisible()) && me.fireEvent('beforehide', me) !== false) {
- me.hidden = true;
- if (me.rendered) {
- me.onHide.apply(me, arguments);
- // Notify any owning Container unless it's suspended.
- // Floating Components do not participate in layouts.
- if (me.ownerCt && !me.floating && !(me.ownerCt.suspendLayout || me.ownerCt.layout.layoutBusy)) {
- me.ownerCt.doLayout();
- }
- }
- }
- return me;
- },
- // 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
- * 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.proxyWrap,
- 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] If applicable, true to also select the text in this component
- * @param {Boolean/Number} [delay] 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.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(),
- cfg = Ext.applyIf(overrides, this.initialConfig),
- self;
- cfg.id = id;
- 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/Ext.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] The scope of the function. Defaults to current node.
- * @param {Array} [args] The args to call the function with. Defaults 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() {
- var me = this,
- target;
- if (!me.proxy) {
- target = Ext.getBody();
- if (Ext.scopeResetCSS) {
- me.proxyWrap = target = Ext.getBody().createChild({
- cls: Ext.baseCSSPrefix + 'reset'
- });
- }
- me.proxy = me.el.createProxy(Ext.baseCSSPrefix + 'proxy-el', target, true);
- }
- return me.proxy;
- }
- });
- /**
- * @class Ext.layout.container.AbstractContainer
- * @extends Ext.layout.Layout
- * Please refer to sub classes documentation
- * @private
- */
- Ext.define('Ext.layout.container.AbstractContainer', {
- /* Begin Definitions */
- extend: 'Ext.layout.Layout',
- /* End Definitions */
- type: 'container',
- /**
- * @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
- * <p>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#componentCls componentCls} also.</p>
- * </p>
- */
- /**
- * 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);
- },
- /**
- * <p>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).</p>
- * @return {Ext.Component[]} of child components
- */
- getLayoutItems: function() {
- return this.owner && this.owner.items && this.owner.items.items || [];
- },
- /**
- * Containers should not lay out child components when collapsed.
- */
- beforeLayout: function() {
- return !this.owner.collapsed && this.callParent(arguments);
- },
- afterLayout: function() {
- this.owner.afterLayout(this);
- },
- /**
- * Returns the owner component's resize element.
- * @return {Ext.Element}
- */
- getTarget: function() {
- return this.owner.getTargetEl();
- },
- /**
- * <p>Returns the element into which rendering must take place. Defaults to the owner Container's target element.</p>
- * May be overridden in layout managers which implement an inner element.
- * @return {Ext.Element}
- */
- getRenderTarget: function() {
- return this.owner.getTargetEl();
- }
- });
- /**
- * @class Ext.layout.container.Container
- * @extends Ext.layout.container.AbstractContainer
- * <p>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.</p>
- */
- Ext.define('Ext.layout.container.Container', {
- /* Begin Definitions */
- extend: 'Ext.layout.container.AbstractContainer',
- alternateClassName: 'Ext.layout.ContainerLayout',
- /* End Definitions */
- layoutItem: function(item, box) {
- if (box) {
- item.doComponentLayout(box.width, box.height);
- } else {
- item.doComponentLayout();
- }
- },
- 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;
- }
- },
- /**
- * @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.
- *
- * @example
- * 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',
- 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]);
- }
- }
- },
- configureItem: function(item) {
- this.callParent(arguments);
- // Auto layout does not manage any dimensions.
- item.layoutManagedHeight = 2;
- item.layoutManagedWidth = 2;
- }
- });
- /**
- * @class Ext.container.AbstractContainer
- * @extends Ext.Component
- * An abstract base class which provides shared methods for Containers across the Sencha product line.
- * @private
- */
- 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
- * <p><b>Important</b>: In order for child items to be correctly sized and
- * positioned, typically a layout manager <b>must</b> be specified through
- * the <code>layout</code> configuration option.</p>
- * <p>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:</p>
- * <p>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).</p>
- * <p><b><code>layout</code></b> may be specified as either as an Object or as a String:</p>
- * <div><ul class="mdetail-params">
- * <li><u>Specify as an Object</u></li>
- * <div><ul class="mdetail-params">
- * <li>Example usage:</li>
- * <pre><code>
- layout: {
- type: 'vbox',
- align: 'left'
- }
- </code></pre>
- *
- * <li><code><b>type</b></code></li>
- * <br/><p>The layout type to be used for this container. If not specified,
- * a default {@link Ext.layout.container.Auto} will be created and used.</p>
- * <p>Valid layout <code>type</code> values are:</p>
- * <div class="sub-desc"><ul class="mdetail-params">
- * <li><code><b>{@link Ext.layout.container.Auto Auto}</b></code> <b>Default</b></li>
- * <li><code><b>{@link Ext.layout.container.Card card}</b></code></li>
- * <li><code><b>{@link Ext.layout.container.Fit fit}</b></code></li>
- * <li><code><b>{@link Ext.layout.container.HBox hbox}</b></code></li>
- * <li><code><b>{@link Ext.layout.container.VBox vbox}</b></code></li>
- * <li><code><b>{@link Ext.layout.container.Anchor anchor}</b></code></li>
- * <li><code><b>{@link Ext.layout.container.Table table}</b></code></li>
- * </ul></div>
- *
- * <li>Layout specific configuration properties</li>
- * <p>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 <code>type</code>
- * specified.</p>
- *
- * </ul></div>
- *
- * <li><u>Specify as a String</u></li>
- * <div><ul class="mdetail-params">
- * <li>Example usage:</li>
- * <pre><code>
- layout: 'vbox'
- </code></pre>
- * <li><code><b>layout</b></code></li>
- * <p>The layout <code>type</code> to be used for this container (see list
- * of valid layout type values above).</p>
- * <p>Additional layout specific configuration properties. For complete
- * details regarding the valid config options for each layout type, see the
- * layout class corresponding to the <code>layout</code> specified.</p>
- * </ul></div></ul></div>
- */
- /**
- * @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/Object[]} items
- * <p>A single item, or an array of child Components to be added to this container</p>
- * <p><b>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.</b><p>
- * <p>Example:</p>
- * <pre><code>
- // 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
- </code></pre>
- * <p>Each item may be:</p>
- * <ul>
- * <li>A {@link Ext.Component Component}</li>
- * <li>A Component configuration object</li>
- * </ul>
- * <p>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.</p>
- * <p>Every Component class has its own {@link Ext.Component#xtype xtype}.</p>
- * <p>If an {@link Ext.Component#xtype xtype} is not explicitly
- * specified, the {@link #defaultType} for the Container is used, which by default is usually <code>panel</code>.</p>
- * <p><b>Notes</b>:</p>
- * <p>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.</p>
- * <p>Do not specify <code>{@link Ext.panel.Panel#contentEl contentEl}</code> or
- * <code>{@link Ext.panel.Panel#html html}</code> with <code>items</code>.</p>
- */
- /**
- * @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.
- *
- * Defaults are applied to both config objects and instantiated components conditionally so as not to override
- * existing properties in the item (see {@link Ext#applyIf}).
- *
- * 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: [
- * // default will not be applied here, panel1 will be autoScroll: false
- * {
- * xtype: 'panel',
- * id: 'panel1',
- * autoScroll: false
- * },
- * // this component will have autoScroll: true
- * new Ext.panel.Panel({
- * id: 'panel2'
- * })
- * ]
- */
- /** @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
- * <p>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.</p>
- * <p>Defaults to <code>'panel'</code>.</p>
- */
- defaultType: 'panel',
- isContainer : true,
- /**
- * The number of container layout calls made on this object.
- * @property layoutCounter
- * @type {Number}
- * @private
- */
- layoutCounter : 0,
- baseCls: Ext.baseCSSPrefix + 'container',
- /**
- * @cfg {String[]} bubbleEvents
- * <p>An array of events that, when fired, should be bubbled to any parent container.
- * See {@link Ext.util.Observable#enableBubble}.
- * Defaults to <code>['add', 'remove']</code>.
- */
- 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 {Ext.layout.container.Container} 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'
- );
- // 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();
- },
- renderChildren: function () {
- var me = this,
- layout = me.getLayout();
- me.callParent();
- // this component's elements exist, so now create the child components' elements
- if (layout) {
- me.suspendLayout = true;
- layout.renderChildren();
- delete me.suspendLayout;
- }
- },
- // @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 framework 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 (!me.isFixedWidth() || !me.isFixedHeight()) {
- // 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 set, either by configuration, or by an owning layout, 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.layoutCounter;
- 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);
- }
- 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 {Ext.Component[]/Ext.Component...} component
- * Either one or more Components to add or an Array of Components to add.
- * See `{@link #items}` for additional information.
- *
- * @return {Ext.Component[]/Ext.Component} 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];
- //<debug>
- if (!item) {
- Ext.Error.raise("Trying to add a null item as a child of Container with itemId/id: " + me.getItemId());
- }
- //</debug>
- 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;
- },
- 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.<br><br>
- * Ext uses lazy rendering, and will only render the inserted Component should
- * it become necessary.<br><br>
- * 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.<br><br>
- * 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 {Ext.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);
- //<debug>
- 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.");
- }
- //</debug>
- 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 {Ext.Component[]} 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 (if we removed anything!)
- me.suspendLayout = false;
- if (len) {
- 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 (<code>this</code> 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] The scope of the function (defaults to current component)
- * @param {Array} [args] 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 <code>{@link #items}</code> <b>property</b>
- * and gets a direct child component of this container.
- * @param {String/Number} comp This parameter may be any of the following:
- * <div><ul class="mdetail-params">
- * <li>a <b><code>String</code></b> : representing the <code>{@link Ext.Component#itemId itemId}</code>
- * or <code>{@link Ext.Component#id id}</code> of the child component </li>
- * <li>a <b><code>Number</code></b> : representing the position of the child component
- * within the <code>{@link #items}</code> <b>property</b></li>
- * </ul></div>
- * <p>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 (optional) Selector complying to an Ext.ComponentQuery selector.
- * If no selector is specified all items will be returned.
- * @return {Ext.Component[]} Components which matched the selector
- */
- query : function(selector) {
- selector = 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 (optional) An Ext.ComponentQuery selector. If no selector is
- * specified, the first child will be returned.
- * @return Ext.Component
- */
- child : function(selector) {
- selector = 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 (optional) An Ext.ComponentQuery selector. If no selector is
- * specified, the first child will be returned.
- * @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.callParent();
- }
- });
- /**
- * Base class for any 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 Ext.panel.Panel, Ext.window.Window and
- * 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.
- *
- * The code below illustrates how to explicitly create a Container:
- *
- * @example
- * // 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 {@link 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
- * Ext.layout.container.Card, Ext.layout.container.Anchor, Ext.layout.container.VBox,
- * Ext.layout.container.HBox, and 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.
- */
- 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 {Ext.Element/HTMLElement/String} el The element to test (or ID of element).
- * @return {Ext.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;
- }
- });
- /**
- * A non-rendering placeholder item which instructs the Toolbar's Layout to begin using
- * the right-justified button container.
- *
- * @example
- * Ext.create('Ext.panel.Panel', {
- * title: 'Toolbar Fill Example',
- * width: 300,
- * height: 200,
- * tbar : [
- * 'Item 1',
- * { xtype: 'tbfill' },
- * 'Item 2'
- * ],
- * renderTo: Ext.getBody()
- * });
- */
- 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.
- */
- 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').
- *
- * @example
- * Ext.create('Ext.panel.Panel', {
- * title: 'Toolbar Seperator Example',
- * width: 300,
- * height: 200,
- * tbar : [
- * 'Item 1',
- * { xtype: 'tbseparator' },
- * 'Item 2'
- * ],
- * renderTo: Ext.getBody()
- * });
- */
- 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,
- target = e.target;
- if (Ext.Date.getElapsed(lastShow) > 50 && active.length > 0 && !e.getTarget('.' + Ext.baseCSSPrefix + 'menu')) {
- me.hideAll();
- // in IE, if we mousedown on a focusable element, the focus gets cancelled and the focus event is never
- // fired on the element, so we'll focus it here
- if (Ext.isIE && Ext.fly(target).focusable()) {
- target.focus();
- }
- }
- },
- // 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);
- }
- }
- }
- }
- });
- /**
- * 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,
- btnIconEl = owner.btnIconEl,
- sizeIconEl = (owner.icon || owner.iconCls) && (owner.iconAlign == "top" || owner.iconAlign == "bottom"),
- 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.isIE6 || 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);
- if (sizeIconEl) {
- btnIconEl.setWidth(metrics.width + btnFrameWidth);
- }
- } else {
- // Remove any previous fixed widths
- ownerEl.setWidth(null);
- btnEl.setWidth(null);
- btnInnerEl.setWidth(null);
- btnIconEl.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 (btnHeight >= 0) {
- 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<br>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 <em> 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();
- }
- });
- /**
- * @docauthor Robert Dougan <rob@sencha.com>
- *
- * Create simple buttons with this component. Customisations include {@link #iconAlign aligned}
- * {@link #iconCls icons}, {@link #menu dropdown menus}, {@link #tooltip tooltips}
- * and {@link #scale sizing options}. Specify a {@link #handler handler} to run code when
- * a user clicks the button, or use {@link #listeners listeners} for other events such as
- * {@link #mouseover mouseover}. Example usage:
- *
- * @example
- * 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:
- *
- * @example
- * Ext.create('Ext.Button', {
- * text : 'Dynamic 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:
- *
- * @example
- * 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'`
- *
- * Example usage:
- *
- * @example
- * 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`.
- * Example usage:
- *
- * @example
- * 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. Example usage:
- *
- * @example
- * 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:
- *
- * @example
- * 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.');
- * }
- * }
- * }
- * });
- */
- 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',
- /**
- * @property {Boolean} hidden
- * True if this button is hidden. Read-only.
- */
- hidden: false,
- /**
- * @property {Boolean} disabled
- * True if this button is disabled. Read-only.
- */
- disabled: false,
- /**
- * @property {Boolean} pressed
- * True if this button is pressed (only if enableToggle = true). Read-only.
- */
- 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).
- * @cfg {Ext.button.Button} handler.button This button.
- * @cfg {Ext.EventObject} handler.e 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=false]
- * True to start hidden.
- */
- /**
- * @cfg {Boolean} [disabled=true]
- * True to start disabled.
- */
- /**
- * @cfg {Boolean} [pressed=false]
- * 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=false]
- * True to repeat fire the click event while the mouse is down. This can also be a
- * {@link Ext.util.ClickRepeater ClickRepeater} config object.
- */
- /**
- * @cfg {Number} tabIndex
- * Set a DOM tabIndex for this button.
- */
- /**
- * @cfg {Boolean} [allowDepress=true]
- * False to not allow a pressed Button to be depressed. Only valid when {@link #enableToggle} is true.
- */
- /**
- * @cfg {Boolean} [enableToggle=false]
- * True to enable pressed/not pressed toggling.
- */
- enableToggle: false,
- /**
- * @cfg {Function} toggleHandler
- * Function called when a Button with {@link #enableToggle} set to true is clicked.
- * @cfg {Ext.button.Button} toggleHandler.button This button.
- * @cfg {Boolean} toggleHandler.state The next state of the Button, true means pressed.
- */
- /**
- * @cfg {Ext.menu.Menu/String/Object} menu
- * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob.
- */
- /**
- * @cfg {String} menuAlign
- * The position to align the menu to (see {@link Ext.Element#alignTo} for more details).
- */
- menuAlign: 'tl-bl?',
- /**
- * @cfg {String} textAlign
- * The text alignment for this button (center, left, right).
- */
- textAlign: 'center',
- /**
- * @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
- * The type of `<input>` to create: submit, reset or 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).
- */
- clickEvent: 'click',
- /**
- * @cfg {Boolean} preventDefault
- * True to prevent the default action when the {@link #clickEvent} is processed.
- */
- preventDefault: true,
- /**
- * @cfg {Boolean} handleMouseEvents
- * False to disable visual cues on mouseover, mouseout and mousedown.
- */
- handleMouseEvents: true,
- /**
- * @cfg {String} tooltipType
- * The type of tooltip to use. Either 'qtip' for QuickTips or 'title' for title attribute.
- */
- tooltipType: 'qtip',
- /**
- * @cfg {String} [baseCls='x-btn']
- * The base CSS class to add to all buttons.
- */
- baseCls: Ext.baseCSSPrefix + 'btn',
- /**
- * @cfg {String} pressedCls
- * The CSS class to add to a button when it is in the pressed state.
- */
- pressedCls: 'pressed',
- /**
- * @cfg {String} overCls
- * The CSS class to add to a button when it is in the over (hovered) state.
- */
- overCls: 'over',
- /**
- * @cfg {String} focusCls
- * The CSS class to add to a button when it is in the focussed state.
- */
- focusCls: 'focus',
- /**
- * @cfg {String} menuActiveCls
- * The CSS class to add to a button when it's menu is active.
- */
- menuActiveCls: 'menu-active',
- /**
- * @cfg {String} href
- * The URL to visit when the button is clicked. Specifying this config is equivalent to specifying:
- *
- * handler: function() { window.location = "http://www.sencha.com" }
- */
- /**
- * @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:
- '<em id="{id}-btnWrap" class="{splitCls}">' +
- '<tpl if="href">' +
- '<a id="{id}-btnEl" href="{href}" target="{target}"<tpl if="tabIndex"> tabIndex="{tabIndex}"</tpl> role="link">' +
- '<span id="{id}-btnInnerEl" class="{baseCls}-inner">' +
- '{text}' +
- '</span>' +
- '<span id="{id}-btnIconEl" class="{baseCls}-icon"></span>' +
- '</a>' +
- '</tpl>' +
- '<tpl if="!href">' +
- '<button id="{id}-btnEl" type="{type}" hidefocus="true"' +
- // the autocomplete="off" is required to prevent Firefox from remembering
- // the button's disabled state between page reloads.
- '<tpl if="tabIndex"> tabIndex="{tabIndex}"</tpl> role="button" autocomplete="off">' +
- '<span id="{id}-btnInnerEl" class="{baseCls}-inner" style="{innerSpanStyle}">' +
- '{text}' +
- '</span>' +
- '<span id="{id}-btnIconEl" class="{baseCls}-icon {iconCls}"> </span>' +
- '</button>' +
- '</tpl>' +
- '</em>' ,
- /**
- * @cfg {String} scale
- * 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.
- */
- 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
- * The side of the Button box to render the icon. Four values are allowed:
- *
- * - 'top'
- * - 'right'
- * - 'bottom'
- * - 'left'
- */
- iconAlign: 'left',
- /**
- * @cfg {String} arrowAlign
- * The side of the Button box to render the arrow if the button has an associated {@link #menu}. Two
- * values are allowed:
- *
- * - 'right'
- * - 'bottom'
- */
- arrowAlign: 'right',
- /**
- * @cfg {String} arrowCls
- * The className used for the inner arrow element if the button has a menu.
- */
- arrowCls: 'arrow',
- /**
- * @property {Ext.Template} template
- * 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}.
- */
- /**
- * @cfg {String} cls
- * A CSS class string to apply to the button's main element.
- */
- /**
- * @property {Ext.menu.Menu} 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.
- */
- maskOnDisable: false,
- // inherit docs
- initComponent: function() {
- var me = this;
- me.callParent(arguments);
- me.addEvents(
- /**
- * @event click
- * Fires when this button is clicked
- * @param {Ext.button.Button} this
- * @param {Event} e The click event
- */
- 'click',
- /**
- * @event toggle
- * Fires when the 'pressed' state of this button changes (only if enableToggle = true)
- * @param {Ext.button.Button} this
- * @param {Boolean} pressed
- */
- 'toggle',
- /**
- * @event mouseover
- * Fires when the mouse hovers over the button
- * @param {Ext.button.Button} this
- * @param {Event} e The event object
- */
- 'mouseover',
- /**
- * @event mouseout
- * Fires when the mouse exits the button
- * @param {Ext.button.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 {Ext.button.Button} this
- * @param {Ext.menu.Menu} menu
- */
- 'menushow',
- /**
- * @event menuhide
- * If this button has a menu, this event fires when it is hidden
- * @param {Ext.button.Button} this
- * @param {Ext.menu.Menu} menu
- */
- 'menuhide',
- /**
- * @event menutriggerover
- * If this button has a menu, this event fires when the mouse enters the menu triggering element
- * @param {Ext.button.Button} this
- * @param {Ext.menu.Menu} menu
- * @param {Event} e
- */
- 'menutriggerover',
- /**
- * @event menutriggerout
- * If this button has a menu, this event fires when the mouse leaves the menu triggering element
- * @param {Ext.button.Button} this
- * @param {Ext.menu.Menu} menu
- * @param {Event} 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,
- cls = [],
- btnIconEl = me.btnIconEl,
- hide = 'x-hide-display';
- 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');
- }
- if (btnIconEl) {
- btnIconEl.removeCls(hide);
- }
- } else {
- if (me.text) {
- cls.push('noicon');
- }
- if (btnIconEl) {
- btnIconEl.addCls(hide);
- }
- }
- 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());
- me.addChildEls('btnEl', 'btnWrap', 'btnInnerEl', 'btnIconEl');
- 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.setAttribute(me.getTipAttr(), 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);
- }
- if (me.textAlign) {
- me.setTextAlign(me.textAlign);
- }
- // 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.
- *
- * @return {Object} Substitution data for a Template. The default implementation which provides data for the default
- * {@link #template} returns an Object containing the following properties:
- * @return {String} return.type The `<button>`'s {@link #type}
- * @return {String} return.splitCls A CSS class to determine the presence and position of an arrow icon.
- * (`'x-btn-arrow'` or `'x-btn-arrow-bottom'` or `''`)
- * @return {String} return.cls A CSS class name applied to the Button's main `<tbody>` element which determines the
- * button's scale and icon alignment.
- * @return {String} return.text The {@link #text} to display ion the Button.
- * @return {Number} return.tabIndex The tab index within the input flow.
- */
- 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,
- iconCls : me.iconCls || '',
- 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;
- },
- /**
- * Sets the href of the link dynamically according to the params passed, and any {@link #baseParams} configured.
- *
- * **Only valid if the Button was originally configured with a {@link #href}**
- *
- * @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,
- btnIconEl = me.btnIconEl,
- oldCls = me.iconCls;
-
- me.iconCls = cls;
- if (btnIconEl) {
- // Remove the previous iconCls from the button
- btnIconEl.removeCls(oldCls);
- btnIconEl.addCls(cls || '');
- me.setButtonCls();
- }
- 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(me.getTipAttr(), tooltip);
- }
- } else {
- me.tooltip = tooltip;
- }
- return me;
- },
- /**
- * Sets the text alignment for this button.
- * @param {String} align The new alignment of the button text. See {@link #textAlign}.
- */
- setTextAlign: function(align) {
- var me = this,
- btnEl = me.btnEl;
- if (btnEl) {
- btnEl.removeCls(me.baseCls + '-' + me.textAlign);
- btnEl.addCls(me.baseCls + '-' + align);
- }
- me.textAlign = align;
- return me;
- },
- getTipAttr: function(){
- return this.tooltipType == 'qtip' ? 'data-qtip' : 'title';
- },
- // 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.menu);
- }
- Ext.destroy(me.btnInnerEl, me.repeater);
- me.callParent();
- },
- // 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;
- 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] 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,
- iconEl = me.btnIconEl;
-
- me.icon = icon;
- if (iconEl) {
- iconEl.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] Force a particular state
- * @param {Boolean} [suppressEvent=false] 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;
- },
-
- maybeShowMenu: function(){
- var me = this;
- if (me.menu && !me.hasVisibleMenu() && !me.ignoreNextClick) {
- me.showMenu();
- }
- },
- /**
- * Shows this button's menu (if it has one)
- */
- showMenu: function() {
- var me = this;
- if (me.rendered && me.menu) {
- if (me.tooltip && me.getTipAttr() != 'title') {
- Ext.tip.QuickTipManager.getQuickTip().cancelShow(me.btnEl);
- }
- if (me.menu.isVisible()) {
- me.menu.hide();
- }
- me.menu.showBy(me.el, me.menuAlign);
- }
- return me;
- },
- /**
- * Hides 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) {
- me.doToggle();
- me.maybeShowMenu();
- me.fireHandler(e);
- }
- },
-
- fireHandler: function(e){
- var me = this,
- handler = me.handler;
-
- me.fireEvent('click', me, e);
- if (handler) {
- handler.call(me.scope || me, me, e);
- }
- me.onBlur();
- },
-
- doToggle: function(){
- var me = this;
- if (me.enableToggle && (me.allowDepress !== false || !me.pressed)) {
- me.toggle();
- }
- },
- /**
- * @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 <em>.
- * @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 <em>.
- * @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');
- me.removeClsWithUI(me.overCls);
- 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 {Number[]} [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 = {};
- function toggleGroup(btn, state) {
- var g, i, l;
- 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
- * @hide
- */
- 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 {Ext.button.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 : '<div class="' + Ext.baseCSSPrefix + 'toolbar-no-items">(None)</div>',
- 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', {
- 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 : me.layout.owner.menuTriggerCls,
- 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.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);
- }
- });
- /**
- * This class represents a rectangular region in X,Y space, and performs geometric
- * transformations or tests upon the region.
- *
- * This class may be used to compare the document regions occupied by elements.
- */
- Ext.define('Ext.util.Region', {
- /* Begin Definitions */
- requires: ['Ext.util.Offset'],
- statics: {
- /**
- * @static
- * Retrieves an Ext.util.Region for a particular element.
- * @param {String/HTMLElement/Ext.Element} el An element ID, htmlElement or Ext.Element representing an element in the document.
- * @returns {Ext.util.Region} region
- */
- getRegion: function(el) {
- return Ext.fly(el).getPageBox(true);
- },
- /**
- * @static
- * Creates a Region from a "box" Object which contains four numeric properties `top`, `right`, `bottom` and `left`.
- * @param {Object} o An object with `top`, `right`, `bottom` and `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 */
- /**
- * Creates a region from the bounding sides.
- * @param {Number} top Top The topmost pixel of the Region.
- * @param {Number} right Right The rightmost pixel of the Region.
- * @param {Number} bottom Bottom The bottom pixel of the Region.
- * @param {Number} left Left The leftmost pixel of the Region.
- */
- 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
- * @return {Boolean}
- */
- 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
- * @return {Ext.util.Region} a new 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
- * @return {Ext.util.Region} this
- */
- 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
- * @return {Ext.util.Region} this
- */
- 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]
- * @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]
- * @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]
- * @param {Ext.util.Point/Ext.util.Offset/Object} [p]
- * @param {Number} [factor]
- * @return {Ext.util.Point/Ext.util.Offset/Object/Number}
- * @private
- */
- 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=1] The factor.
- * @return {Number}
- * @private
- */
- 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, defaults to 1
- * @return {Number}
- * @private
- */
- 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
- * @private
- */
- getSize: function() {
- return {
- width: this.right - this.x,
- height: this.bottom - this.y
- };
- },
- /**
- * Create a copy of this Region.
- * @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 {Ext.util.Region} p The region to copy from.
- * @return {Ext.util.Region} This Region
- */
- 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} x Object containing the `x` and `y` properties.
- * Or the x value is using the two argument form.
- * @param {Number} y 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
- */
- 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
- */
- handleIds: {},
- /**
- * the DragDrop object that is currently being dragged
- * @property {Ext.dd.DragDrop} dragCurrent
- * @private
- **/
- dragCurrent: null,
- /**
- * the DragDrop object(s) that are being hovered over
- * @property {Ext.dd.DragDrop[]} dragOvers
- * @private
- */
- dragOvers: {},
- /**
- * the X distance between the cursor and the object being dragged
- * @property deltaX
- * @type Number
- * @private
- */
- deltaX: 0,
- /**
- * the Y distance between the cursor and the object being dragged
- * @property deltaY
- * @type Number
- * @private
- */
- 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
- */
- 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
- */
- stopPropagation: true,
- /**
- * Internal flag that is set to true when drag and drop has been
- * intialized
- * @property initialized
- * @private
- */
- initialized: false,
- /**
- * All drag and drop can be disabled.
- * @property locked
- * @private
- */
- locked: false,
- /**
- * Called the first time an element is registered.
- * @method init
- * @private
- */
- 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 Number
- */
- 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 Number
- */
- INTERSECT: 1,
- /**
- * The current drag and drop mode. Default: POINT
- * @property mode
- * @type Number
- */
- mode: 0,
- /**
- * Runs method on all drag and drop objects
- * @method _execOnAll
- * @private
- */
- _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
- */
- _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
- */
- _onResize: function(e) {
- this._execOnAll("resetConstraints", []);
- },
- /**
- * Lock all drag and drop functionality
- * @method lock
- */
- lock: function() { this.locked = true; },
- /**
- * Unlock all drag and drop functionality
- * @method unlock
- */
- unlock: function() { this.locked = false; },
- /**
- * Is drag and drop locked?
- * @method isLocked
- * @return {Boolean} True if drag and drop is locked, false otherwise.
- */
- 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
- */
- 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
- */
- 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 Number
- */
- 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 Number
- */
- clickTimeThresh: 350,
- /**
- * Flag that indicates that either the drag pixel threshold or the
- * mousdown time threshold has been met
- * @property dragThreshMet
- * @type Boolean
- * @private
- */
- dragThreshMet: false,
- /**
- * Timeout used for the click time threshold
- * @property clickTimeout
- * @type Object
- * @private
- */
- clickTimeout: null,
- /**
- * The X position of the mousedown event stored for later use when a
- * drag threshold is met.
- * @property startX
- * @type Number
- * @private
- */
- startX: 0,
- /**
- * The Y position of the mousedown event stored for later use when a
- * drag threshold is met.
- * @property startY
- * @type Number
- * @private
- */
- startY: 0,
- /**
- * Each DragDrop instance must be registered with the DragDropManager.
- * This is executed in DragDrop.init()
- * @method regDragDrop
- * @param {Ext.dd.DragDrop} oDD the DragDrop object to register
- * @param {String} sGroup the name of the group this element belongs to
- */
- 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
- */
- 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
- */
- _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
- */
- 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
- */
- 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 {Ext.dd.DragDrop} p_oDD the obj to get related data for
- * @param {Boolean} bTargetsOnly if true, only return targetable objs
- * @return {Ext.dd.DragDrop[]} the related instances
- */
- 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 {Ext.dd.DragDrop} oDD the drag obj
- * @param {Ext.dd.DragDrop} oTargetDD the target
- * @return {Boolean} true if the target is a legal target for the
- * dd obj
- */
- isLegalTarget: function (oDD, oTargetDD) {
- var targets = this.getRelated(oDD, true);
- for (var i=0, len=targets.length;i<len;++i) {
- if (targets[i].id == oTargetDD.id) {
- return true;
- }
- }
- return false;
- },
- /**
- * My goal is to be able to transparently determine if an object is
- * typeof DragDrop, and the exact subclass of DragDrop. typeof
- * returns "object", oDD.constructor.toString() always returns
- * "DragDrop" and not the name of the subclass. So for now it just
- * evaluates a well-known variable in DragDrop.
- * @method isTypeOfDD
- * @param {Object} the object to evaluate
- * @return {Boolean} true if typeof oDD = DragDrop
- */
- isTypeOfDD: function (oDD) {
- return (oDD && oDD.__ygDragDrop);
- },
- /**
- * Utility function to determine if a given element has been
- * registered as a drag drop handle for the given Drag Drop object.
- * @method isHandle
- * @param {String} id the element id to check
- * @return {Boolean} true if this element is a DragDrop handle, false
- * otherwise
- */
- isHandle: function(sDDId, sHandleId) {
- return ( this.handleIds[sDDId] &&
- this.handleIds[sDDId][sHandleId] );
- },
- /**
- * Returns the DragDrop instance for a given id
- * @method getDDById
- * @param {String} id the id of the DragDrop object
- * @return {Ext.dd.DragDrop} the drag drop object, null if it is not found
- */
- getDDById: function(id) {
- for (var i in this.ids) {
- if (this.ids[i][id]) {
- return this.ids[i][id];
- }
- }
- return null;
- },
- /**
- * Fired after a registered DragDrop object gets the mousedown event.
- * Sets up the events required to track the object being dragged
- * @method handleMouseDown
- * @param {Event} e the event
- * @param {Ext.dd.DragDrop} oDD the DragDrop object being dragged
- * @private
- */
- handleMouseDown: function(e, oDD) {
- if(Ext.tip.QuickTipManager){
- Ext.tip.QuickTipManager.ddDisable();
- }
- if(this.dragCurrent){
- // the original browser mouseup wasn't handled (e.g. outside FF browser window)
- // so clean up first to avoid breaking the next drag
- this.handleMouseUp(e);
- }
- this.currentTarget = e.getTarget();
- this.dragCurrent = oDD;
- var el = oDD.getEl();
- // track start position
- this.startX = e.getPageX();
- this.startY = e.getPageY();
- this.deltaX = this.startX - el.offsetLeft;
- this.deltaY = this.startY - el.offsetTop;
- this.dragThreshMet = false;
- this.clickTimeout = setTimeout(
- function() {
- var DDM = Ext.dd.DragDropManager;
- DDM.startDrag(DDM.startX, DDM.startY);
- },
- this.clickTimeThresh );
- },
- /**
- * Fired when either the drag pixel threshol or the mousedown hold
- * time threshold has been met.
- * @method startDrag
- * @param {Number} x the X position of the original mousedown
- * @param {Number} y the Y position of the original mousedown
- */
- startDrag: function(x, y) {
- clearTimeout(this.clickTimeout);
- if (this.dragCurrent) {
- this.dragCurrent.b4StartDrag(x, y);
- this.dragCurrent.startDrag(x, y);
- }
- this.dragThreshMet = true;
- },
- /**
- * Internal function to handle the mouseup event. Will be invoked
- * from the context of the document.
- * @method handleMouseUp
- * @param {Event} e the event
- * @private
- */
- handleMouseUp: function(e) {
- if(Ext.tip && Ext.tip.QuickTipManager){
- Ext.tip.QuickTipManager.ddEnable();
- }
- if (! this.dragCurrent) {
- return;
- }
- clearTimeout(this.clickTimeout);
- if (this.dragThreshMet) {
- this.fireEvents(e, true);
- } else {
- }
- this.stopDrag(e);
- this.stopEvent(e);
- },
- /**
- * Utility to stop event propagation and event default, if these
- * features are turned on.
- * @method stopEvent
- * @param {Event} e the event as returned by this.getEvent()
- */
- stopEvent: function(e){
- if(this.stopPropagation) {
- e.stopPropagation();
- }
- if (this.preventDefault) {
- e.preventDefault();
- }
- },
- /**
- * Internal function to clean up event handlers after the drag
- * operation is complete
- * @method stopDrag
- * @param {Event} e the event
- * @private
- */
- stopDrag: function(e) {
- // Fire the drag end event for the item that was dragged
- if (this.dragCurrent) {
- if (this.dragThreshMet) {
- this.dragCurrent.b4EndDrag(e);
- this.dragCurrent.endDrag(e);
- }
- this.dragCurrent.onMouseUp(e);
- }
- this.dragCurrent = null;
- this.dragOvers = {};
- },
- /**
- * Internal function to handle the mousemove event. Will be invoked
- * from the context of the html element.
- *
- * @TODO figure out what we can do about mouse events lost when the
- * user drags objects beyond the window boundary. Currently we can
- * detect this in internet explorer by verifying that the mouse is
- * down during the mousemove event. Firefox doesn't give us the
- * button state on the mousemove event.
- * @method handleMouseMove
- * @param {Event} e the event
- * @private
- */
- handleMouseMove: function(e) {
- if (! this.dragCurrent) {
- return true;
- }
- // var button = e.which || e.button;
- // check for IE mouseup outside of page boundary
- if (Ext.isIE && (e.button !== 0 && e.button !== 1 && e.button !== 2)) {
- this.stopEvent(e);
- return this.handleMouseUp(e);
- }
- if (!this.dragThreshMet) {
- var diffX = Math.abs(this.startX - e.getPageX());
- var diffY = Math.abs(this.startY - e.getPageY());
- if (diffX > 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
- */
- 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<len; ++i) {
- dc.b4DragOut(e, outEvts[i].id);
- dc.onDragOut(e, outEvts[i].id);
- }
- // fire enter events
- for (i=0,len=enterEvts.length; i<len; ++i) {
- // dc.b4DragEnter(e, oDD.id);
- dc.onDragEnter(e, enterEvts[i].id);
- }
- // fire over events
- for (i=0,len=overEvts.length; i<len; ++i) {
- dc.b4DragOver(e, overEvts[i].id);
- dc.onDragOver(e, overEvts[i].id);
- }
- // fire drop events
- for (i=0, len=dropEvts.length; i<len; ++i) {
- dc.b4DragDrop(e, dropEvts[i].id);
- dc.onDragDrop(e, dropEvts[i].id);
- }
- }
- // notify about a drop that did not find a target
- if (isDrop && !dropEvts.length) {
- dc.onInvalidDrop(e);
- }
- },
- /**
- * Helper function for getting the best match from the list of drag
- * and drop objects returned by the drag and drop events when we are
- * in INTERSECT mode. It returns either the first object that the
- * cursor is over, or the object that has the greatest overlap with
- * the dragged element.
- * @method getBestMatch
- * @param {Ext.dd.DragDrop[]} dds The array of drag and drop objects
- * targeted
- * @return {Ext.dd.DragDrop} The best single match
- */
- getBestMatch: function(dds) {
- var winner = null;
- // Return null if the input is not what we expect
- //if (!dds || !dds.length || dds.length == 0) {
- // winner = null;
- // If there is only one item, it wins
- //} else if (dds.length == 1) {
- var len = dds.length;
- if (len == 1) {
- winner = dds[0];
- } else {
- // Loop through the targeted items
- for (var i=0; i<len; ++i) {
- var dd = dds[i];
- // If the cursor is over the object, it wins. If the
- // cursor is over multiple matches, the first one we come
- // to wins.
- if (dd.cursorIsOver) {
- winner = dd;
- break;
- // Otherwise the object with the most overlap wins
- } else {
- if (!winner ||
- winner.overlap.getArea() < dd.overlap.getArea()) {
- winner = dd;
- }
- }
- }
- }
- return winner;
- },
- /**
- * Refreshes the cache of the top-left and bottom-right points of the
- * drag and drop objects in the specified group(s). This is in the
- * format that is stored in the drag and drop instance, so typical
- * usage is:
- * <code>
- * Ext.dd.DragDropManager.refreshCache(ddinstance.groups);
- * </code>
- * Alternatively:
- * <code>
- * Ext.dd.DragDropManager.refreshCache({group1:true, group2:true});
- * </code>
- * @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
- */
- 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
- */
- 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 {Ext.dd.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.
- */
- 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.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 {Ext.dd.DragDrop} oTarget the DragDrop object we are inspecting
- * @return {Boolean} true if the mouse is over the target
- * @private
- */
- 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
- */
- _onUnload: function(e, me) {
- Ext.dd.DragDropManager.unregAll();
- },
- /**
- * Cleans up the drag and drop events and objects.
- * @method unregAll
- * @private
- */
- 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
- */
- elementCache: {},
- /**
- * Get the wrapper for the DOM element specified
- * @method getElWrapper
- * @param {String} id the id of the element to get
- * @return {Ext.dd.DragDropManager.ElementWrapper} the wrapped element
- * @private
- * @deprecated This wrapper isn't that useful
- */
- 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
- */
- 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
- */
- getCss: function(id) {
- var el = Ext.getDom(id);
- return (el) ? el.style : null;
- },
- /**
- * @class Ext.dd.DragDropManager.ElementWrapper
- * Inner class for cached elements
- * @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;
- },
- // The DragDropManager class continues
- /** @class Ext.dd.DragDropManager */
- /**
- * Returns the X position of an html element
- * @param {HTMLElement} el the element for which to get the position
- * @return {Number} the X coordinate
- */
- getPosX: function(el) {
- return Ext.Element.getX(el);
- },
- /**
- * Returns the Y position of an html element
- * @param {HTMLElement} el the element for which to get the position
- * @return {Number} the Y coordinate
- */
- getPosY: function(el) {
- return Ext.Element.getY(el);
- },
- /**
- * Swap two nodes. In IE, we use the native method, for others we
- * emulate the IE behavior
- * @param {HTMLElement} n1 the first node to swap
- * @param {HTMLElement} n2 the other node to swap
- */
- 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
- * @private
- */
- 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
- * @param {HTMLElement} el the element
- * @param {String} styleProp the style property
- * @return {String} The value of the style property
- */
- getStyle: function(el, styleProp) {
- return Ext.fly(el).getStyle(styleProp);
- },
- /**
- * Gets the scrollTop
- * @return {Number} the document's scrollTop
- */
- getScrollTop: function () {
- return this.getScroll().top;
- },
- /**
- * Gets the scrollLeft
- * @return {Number} the document's scrollTop
- */
- getScrollLeft: function () {
- return this.getScroll().left;
- },
- /**
- * Sets the x/y position of an element to the location of the
- * target element.
- * @param {HTMLElement} moveEl The element to move
- * @param {HTMLElement} targetEl The position reference element
- */
- moveToEl: function (moveEl, targetEl) {
- var aCoord = Ext.Element.getXY(targetEl);
- Ext.Element.setXY(moveEl, aCoord);
- },
- /**
- * Numeric array sort function
- * @param {Number} a
- * @param {Number} b
- * @returns {Number} positive, negative or 0
- */
- numericSort: function(a, b) {
- return (a - b);
- },
- /**
- * Internal counter
- * @property {Number} _timeoutCount
- * @private
- */
- _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.
- * @private
- */
- _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.
- * @param {HTMLElement} node the html element to inspect
- */
- 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
- * <p>Base Class for HBoxLayout and VBoxLayout Classes. Generally it should not need to be used directly.</p>
- */
- 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 {Boolean/Number/Object} animate
- * <p>If truthy, child Component are <i>animated</i> into position whenever the Container
- * is layed out. If this option is numeric, it is used as the animation duration in milliseconds.</p>
- * <p>May be set as a property at any time.</p>
- */
- /**
- * @cfg {Object} defaultMargins
- * <p>If the individual contained items do not have a <tt>margins</tt>
- * property specified or margin specified via CSS, the default margins from this property will be
- * applied to each item.</p>
- * <br><p>This property may be specified as an object containing margins
- * to apply in the format:</p><pre><code>
- {
- top: (top margin),
- right: (right margin),
- bottom: (bottom margin),
- left: (left margin)
- }</code></pre>
- * <p>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:</p>
- * <div class="mdetail-params"><ul>
- * <li>If there is only one value, it applies to all sides.</li>
- * <li>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.</li>
- * <li>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.</li>
- * <li>If there are four values, they apply to the top, right, bottom, and
- * left, respectively.</li>
- * </ul></div>
- */
- defaultMargins: {
- top: 0,
- right: 0,
- bottom: 0,
- left: 0
- },
- /**
- * @cfg {String} padding
- * <p>Sets the padding to be applied to all child items managed by this layout.</p>
- * <p>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:</p>
- * <div class="mdetail-params"><ul>
- * <li>If there is only one value, it applies to all sides.</li>
- * <li>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.</li>
- * <li>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.</li>
- * <li>If there are four values, they apply to the top, right, bottom, and
- * left, respectively.</li>
- * </ul></div>
- */
- 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:
- * <div class="mdetail-params"><ul>
- * <li><b><tt>start</tt></b> : <b>Default</b><div class="sub-desc">child items are packed together at
- * <b>left</b> side of container</div></li>
- * <li><b><tt>center</tt></b> : <div class="sub-desc">child items are packed together at
- * <b>mid-width</b> of container</div></li>
- * <li><b><tt>end</tt></b> : <div class="sub-desc">child items are packed together at <b>right</b>
- * side of container</div></li>
- * </ul></div>
- */
- /**
- * @cfg {Number} flex
- * This configuration option is to be applied to <b>child <tt>items</tt></b> of the container managed
- * by this layout. Each child item with a <tt>flex</tt> property will be flexed <b>horizontally</b>
- * according to each item's <b>relative</b> <tt>flex</tt> value compared to the sum of all items with
- * a <tt>flex</tt> value specified. Any child items that have either a <tt>flex = 0</tt> or
- * <tt>flex = undefined</tt> 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,
- // 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} shrinkToFit
- * True (the default) to allow fixed size components to shrink (limited to their
- * minimum size) to avoid overflow. False to preserve fixed sizes even if they cause
- * overflow.
- */
- shrinkToFit: 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 {Ext.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;
- var size = child.getBox(false, true);
- return {
- left: size.left,
- top: size.top,
- width: size.width,
- height: size.height
- };
- },
- /**
- * @private
- * Calculates the size and positioning of the passed child item.
- * @param {Ext.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),
- innerCtBorderWidth = me.innerCt.getBorderWidth(me.perpendicularLT + me.perpendicularRB),
- 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];
- if (!child.flex || !(me.align == 'stretch' || me.align == 'stretchmax')) {
- if (child.componentLayout.initialized !== true) {
- 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.
- // Ensure that the tracked maximum perpendicular size takes into account child min[Width|Height] settings!
- maxSize = mmax(maxSize, mmax(childPerpendicular, child[perpendicularMinString]||0) + childMargins[me.perpendicularLeftTop] + childMargins[me.perpendicularRightBottom]);
- tmpObj[parallelPrefix] = childParallel || undefinedValue;
- tmpObj.dirtySize = child.componentLayout.lastComponentSize ? (tmpObj[parallelPrefix] !== child.componentLayout.lastComponentSize[parallelPrefix]) : false;
- tmpObj[perpendicularPrefix] = childPerpendicular || undefinedValue;
- boxes.push(tmpObj);
- }
- // Only calculate parallel overflow indicators if we are not auto sizing
- if (!me.autoSize) {
- 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 if (me.shrinkToFit) {
- 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;
- }
- tooNarrow = (shortfall > 0);
- }
- 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) - innerCtBorderWidth - 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();
- 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);
- },
-
- animCallback: Ext.emptyFn,
- /**
- * Resizes and repositions each child component
- * @param {Object[]} 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.animCallback(anim);
- 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 {Object} 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.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');
- margins.height = margins.top + margins.bottom;
- margins.width = margins.left + margins.right;
- style.marginTop = style.marginRight = style.marginBottom = style.marginLeft = '0';
- // Item must reference calculated margins.
- item.margins = margins;
- },
- /**
- * @private
- */
- destroy: function() {
- Ext.destroy(this.innerCt, this.overflowHandler);
- this.callParent(arguments);
- }
- });
- /**
- * 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.
- *
- * @example
- * 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',
- configureItem: function(item) {
- if (item.flex) {
- item.layoutManagedWidth = 1;
- } else {
- item.layoutManagedWidth = 2;
- }
- if (this.align === 'stretch' || this.align === 'stretchmax') {
- item.layoutManagedHeight = 1;
- } else {
- item.layoutManagedHeight = 2;
- }
- this.callParent(arguments);
- }
- });
- /**
- * 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.
- *
- * @example
- * 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',
- configureItem: function(item) {
- if (item.flex) {
- item.layoutManagedHeight = 1;
- } else {
- item.layoutManagedHeight = 2;
- }
- if (this.align === 'stretch' || this.align === 'stretchmax') {
- item.layoutManagedWidth = 1;
- } else {
- item.layoutManagedWidth = 2;
- }
- this.callParent(arguments);
- }
- });
- /**
- * @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 `Ext.FocusManager.enable();`. In turn, you may
- deactivate the FocusManager by subsequently calling `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
- * @author Jarred Nicholls <jarred@sencha.com>
- * @docauthor Jarred Nicholls <jarred@sencha.com>
- */
- 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`.
- */
- focusElementCls: Ext.baseCSSPrefix + 'focus-element',
- focusFrameCls: Ext.baseCSSPrefix + 'focus-frame',
- /**
- * @property {String[]} 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.
- */
- 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.
- */
- '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.
- */
- '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/String[]} 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.Element.DISPLAY);
- me.focusFrameWidth = 2;
- 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();
- } else {
- parent.focus();
- }
- // In some browsers (Chrome) FocusManager can handle this before other
- // handlers. Ext Windows have their own Esc key handling, so we need to
- // return true here to allow the event to bubble.
- return true;
- },
- 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).setLeftTop(bl, bt);
- fb.setWidth(bw).setLeftTop(bl, bt + bh - fw);
- fl.setHeight(bh - fw - fw).setLeftTop(bl, bt + fw);
- fr.setHeight(bh - fw - fw).setLeftTop(bl + bw - fw, bt + fw);
- 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/String[]} 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
- * @param {Array/Object} options.keys
- * 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
- * }
- *
- * @param {Boolean} options.focusFrame
- * `true` to show the focus frame around a component when it is focused. Defaults to `false`.
- */
- 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.
- */
- 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();
- }
- });
- /**
- * 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
- * |:---------|:--------------|:------------------------------|:---------------------------------------------------
- * | `->` | `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
- * 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' }
- * {
- * 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.
- *
- * @example
- * 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'
- * }
- * ]
- * });
- *
- * Example
- *
- * @example
- * 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.
- *
- * @example
- * 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/Object[]} config A config object or an array of buttons to <code>{@link #add}</code>
- * @docauthor Robert Dougan <rob@sencha.com>
- */
- 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`.
- */
- 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
- * 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,
- /**
- * @cfg {String} menuTriggerCls
- * Configure the icon class of the overflow button.
- */
- menuTriggerCls: Ext.baseCSSPrefix + 'toolbar-more-icon',
-
- // 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',
- clearInnerCtOnLayout: true
- });
- if (me.vertical) {
- me.addCls