/*! - * Ext JS Library 3.3.0 - * Copyright(c) 2006-2010 Ext JS, Inc. - * licensing@extjs.com - * http://www.extjs.com/license - */ -/** - * @class Ext.Toolbar - * @extends Ext.Container - *Basic Toolbar class. Although the {@link Ext.Container#defaultType defaultType} for Toolbar - * is {@link Ext.Button button}, Toolbar elements (child items for the Toolbar container) may - * be virtually any type of Component. Toolbar elements can be created explicitly via their constructors, - * or implicitly via their xtypes, and can be {@link #add}ed dynamically.
- *Some items have shortcut strings for creation:
- *-Shortcut xtype Class Description -'->' 'tbfill' {@link Ext.Toolbar.Fill} begin using the right-justified button container -'-' 'tbseparator' {@link Ext.Toolbar.Separator} add a vertical separator bar between toolbar items -' ' 'tbspacer' {@link Ext.Toolbar.Spacer} add horiztonal space between elements - *- * - * Example usage of various elements: - *- * Example adding a ComboBox within a menu of a button: - *-var tb = new Ext.Toolbar({ - renderTo: document.body, - width: 600, - height: 100, - items: [ - { - // xtype: 'button', // default for Toolbars, same as 'tbbutton' - text: 'Button' - }, - { - xtype: 'splitbutton', // same as 'tbsplitbutton' - text: 'Split Button' - }, - // begin using the right-justified button container - '->', // same as {xtype: 'tbfill'}, // Ext.Toolbar.Fill - { - xtype: 'textfield', - name: 'field1', - emptyText: 'enter search term' - }, - // add a vertical separator bar between toolbar items - '-', // same as {xtype: 'tbseparator'} to create Ext.Toolbar.Separator - 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.Toolbar.TextItem - {xtype: 'tbspacer'},// same as ' ' to create Ext.Toolbar.Spacer - 'text 2', - {xtype: 'tbspacer', width: 50}, // add a 50px space - 'text 3' - ] -}); - *- * @constructor - * Creates a new Toolbar - * @param {Object/Array} config A config object or an array of buttons to {@link #add} - * @xtype toolbar - */ -Ext.Toolbar = function(config){ - if(Ext.isArray(config)){ - config = {items: config, layout: 'toolbar'}; - } else { - config = Ext.apply({ - layout: 'toolbar' - }, config); - if(config.buttons) { - config.items = config.buttons; + + 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(); } - } - Ext.Toolbar.superclass.constructor.call(this, config); -}; + }); + + var toolbar = Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 400, + margin : '5 0 0 0', + items : [enableBtn, disableBtn] + }); -(function(){ +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. -var T = Ext.Toolbar; +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar4.png Toolbar component} +Example usage: -Ext.extend(T, Ext.Container, { + var toolbar = Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 700, + items: [ + { + text: 'Example Button' + } + ] + }); + + var addedItems = []; + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 700, + margin : '5 0 0 0', + items : [ + { + text : 'Add a button', + scope : this, + handler: function() { + var text = prompt('Please enter the text for your button:'); + addedItems.push(toolbar.add({ + text: text + })); + } + }, + { + text : 'Add a text item', + scope : this, + handler: function() { + var text = prompt('Please enter the text for your item:'); + addedItems.push(toolbar.add(text)); + } + }, + { + text : 'Add a toolbar seperator', + scope : this, + handler: function() { + addedItems.push(toolbar.add('-')); + } + }, + { + text : 'Add a toolbar spacer', + scope : this, + handler: function() { + addedItems.push(toolbar.add('->')); + } + }, + '->', + { + text : 'Remove last inserted item', + scope : this, + handler: function() { + if (addedItems.length) { + toolbar.remove(addedItems.pop()); + } else if (toolbar.items.length) { + toolbar.remove(toolbar.items.last()); + } else { + alert('No items in the toolbar'); + } + } + }, + { + text : 'Remove all items', + scope : this, + handler: function() { + toolbar.removeAll(); + } + } + ] + }); + * @constructor + * Creates a new Toolbar + * @param {Object/Array} config A config object or an array of buttons to <code>{@link #add}</code> + * @docauthor Robert Dougan <rob@sencha.com> + * @markdown + */ +Ext.define('Ext.toolbar.Toolbar', { + extend: 'Ext.container.Container', + requires: [ + 'Ext.toolbar.Fill', + 'Ext.layout.container.HBox', + 'Ext.layout.container.VBox', + 'Ext.FocusManager' + ], + uses: [ + 'Ext.toolbar.Separator' + ], + alias: 'widget.toolbar', + alternateClassName: 'Ext.Toolbar', + + isToolbar: true, + baseCls : Ext.baseCSSPrefix + 'toolbar', + ariaRole : 'toolbar', + defaultType: 'button', + + /** + * @cfg {Boolean} vertical + * Set to `true` to make the toolbar vertical. The layout will become a `vbox`. + * (defaults to `false`) + */ + vertical: false, - /** - * @cfg {String/Object} layout - * This class assigns a default layout (-// ComboBox creation -var combo = new Ext.form.ComboBox({ - store: new Ext.data.ArrayStore({ - autoDestroy: true, - fields: ['initials', 'fullname'], - data : [ - ['FF', 'Fred Flintstone'], - ['BR', 'Barney Rubble'] + +/** + * @class Ext.toolbar.Toolbar + * @extends Ext.container.Container + +Basic Toolbar class. Although the {@link Ext.container.Container#defaultType defaultType} for Toolbar is {@link Ext.button.Button button}, Toolbar +elements (child items for the Toolbar container) may be virtually any type of Component. Toolbar elements can be created explicitly via their +constructors, or implicitly via their xtypes, and can be {@link #add}ed dynamically. + +__Some items have shortcut strings for creation:__ + +| Shortcut | xtype | Class | Description | +|:---------|:--------------|:------------------------------|:---------------------------------------------------| +| `->` | `tbspacer` | {@link Ext.toolbar.Fill} | begin using the right-justified button container | +| `-` | `tbseparator` | {@link Ext.toolbar.Separator} | add a vertical separator bar between toolbar items | +| ` ` | `tbspacer` | {@link Ext.toolbar.Spacer} | add horiztonal space between elements | + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar1.png Toolbar component} +Example usage: + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 500, + items: [ + { + // xtype: 'button', // default for Toolbars + text: 'Button' + }, + { + xtype: 'splitbutton', + text : 'Split Button' + }, + // begin using the right-justified button container + '->', // same as {xtype: 'tbfill'}, // Ext.toolbar.Fill + { + xtype : 'textfield', + name : 'field1', + emptyText: 'enter search term' + }, + // add a vertical separator bar between toolbar items + '-', // same as {xtype: 'tbseparator'} to create Ext.toolbar.Separator + 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.toolbar.TextItem + {xtype: 'tbspacer'},// same as ' ' to create Ext.toolbar.Spacer + 'text 2', + {xtype: 'tbspacer', width: 50}, // add a 50px space + 'text 3' ] - }), - displayField: 'fullname', - typeAhead: true, - mode: 'local', - forceSelection: true, - triggerAction: 'all', - emptyText: 'Select a name...', - selectOnFocus: true, - width: 135, - getListParent: function() { - return this.el.up('.x-menu'); - }, - iconCls: 'no-icon' //use iconCls if placing within menu to shift to right side of menu -}); + }); -// put ComboBox in a Menu -var menu = new Ext.menu.Menu({ - id: 'mainMenu', - items: [ - combo // A Field in a Menu - ] -}); +Toolbars have {@link #enable} and {@link #disable} methods which when called, will enable/disable all items within your toolbar. + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar2.png Toolbar component} +Example usage: + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 400, + items: [ + { + text: 'Button' + }, + { + xtype: 'splitbutton', + text : 'Split Button' + }, + '->', + { + xtype : 'textfield', + name : 'field1', + emptyText: 'enter search term' + } + ] + }); -// add a Button with the menu -tb.add({ - text:'Button w/ Menu', - menu: menu // assign menu by instance +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar3.png Toolbar component} +Example usage: + + var enableBtn = Ext.create('Ext.button.Button', { + text : 'Enable All Items', + disabled: true, + scope : this, + handler : function() { + //disable the enable button and enable the disable button + enableBtn.disable(); + disableBtn.enable(); + + //enable the toolbar + toolbar.enable(); + } }); -tb.doLayout(); - *layout:'toolbar'). - * Developers may override this configuration option if another layout + /** + * @cfg {String/Object} layout + * This class assigns a default layout (<code>layout:'<b>hbox</b>'</code>). + * Developers <i>may</i> override this configuration option if another layout * is required (the constructor must be passed a configuration object in this * case instead of an array). - * See {@link Ext.Container#layout} for additional information. + * See {@link Ext.container.Container#layout} for additional information. */ - enableOverflow : false, - - /** - * @cfg {Boolean} enableOverflow - * Defaults to false. Configure true to make the toolbar provide a button + /** + * @cfg {Boolean} enableOverflow + * Defaults to false. Configure <code>true</code> to make the toolbar provide a button * which activates a dropdown Menu to show items which overflow the Toolbar's width. */ - /** - * @cfg {String} buttonAlign - *The default position at which to align child items. Defaults to
- *"left"May be specified as
- *"center"to cause items added before a Fill (A"->") item - * to be centered in the Toolbar. Items added after a Fill are still right-aligned.Specify as
- */ - - trackMenus : true, - internalDefaults: {removeMode: 'container', hideParent: true}, - toolbarCls: 'x-toolbar', + enableOverflow: false, + + // private + trackMenus: true, + + itemCls: Ext.baseCSSPrefix + 'toolbar-item', + + initComponent: function() { + var me = this, + keys; + + // check for simplified (old-style) overflow config: + if (!me.layout && me.enableOverflow) { + me.layout = { overflowHandler: 'Menu' }; + } + + if (me.dock === 'right' || me.dock === 'left') { + me.vertical = true; + } - initComponent : function(){ - T.superclass.initComponent.call(this); + 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.addClsWithUI('vertical'); + } + + // @TODO: remove this hack and implement a more general solution + if (me.ui === 'footer') { + me.ignoreBorderManagement = true; + } + + me.callParent(); - /** - * @event overflowchange + /** + * @event overflowchange * Fires after the overflow state has changed. * @param {Object} c The Container * @param {Boolean} lastOverflow overflow state */ - this.addEvents('overflowchange'); - }, - - // private - onRender : function(ct, position){ - if(!this.el){ - if(!this.autoCreate){ - this.autoCreate = { - cls: this.toolbarCls + ' x-small-editor' - }; - } - this.el = ct.createChild(Ext.apply({ id: this.id },this.autoCreate), position); - Ext.Toolbar.superclass.onRender.apply(this, arguments); - } + me.addEvents('overflowchange'); + + // Subscribe to Ext.FocusManager for key navigation + keys = me.vertical ? ['up', 'down'] : ['left', 'right']; + Ext.FocusManager.subscribe(me, { + keys: keys + }); }, - /** - *"right"to right align all child items.Adds element(s) to the toolbar -- this function takes a variable number of - * arguments of mixed type and adds them to the toolbar.
- *Note: See the notes within {@link Ext.Container#add}.
- * @param {Mixed} arg1 The following types of arguments are all valid:
- *
Note: See the notes within {@link Ext.Container#add}.
- * @return {Ext.Toolbar.Item} The separator {@link Ext.Toolbar.Item item} - */ - addSeparator : function(){ - return this.add(new T.Separator()); - }, - - /** - * Adds a spacer element - *Note: See the notes within {@link Ext.Container#add}.
- * @return {Ext.Toolbar.Spacer} The spacer item - */ - addSpacer : function(){ - return this.add(new T.Spacer()); - }, - - /** - * Forces subsequent additions into the float:right toolbar - *Note: See the notes within {@link Ext.Container#add}.
- */ - addFill : function(){ - this.add(new T.Fill()); - }, - - /** - * Adds any standard HTML element to the toolbar - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Mixed} el The element or id of the element to add - * @return {Ext.Toolbar.Item} The element's item - */ - addElement : function(el){ - return this.addItem(new T.Item({el:el})); - }, - - /** - * Adds any Toolbar.Item or subclass - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Ext.Toolbar.Item} item - * @return {Ext.Toolbar.Item} The item - */ - addItem : function(item){ - return this.add.apply(this, arguments); - }, - - /** - * Adds a button (or buttons). See {@link Ext.Button} for more info on the config. - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Object/Array} config A button config or array of configs - * @return {Ext.Button/Array} - */ - addButton : function(config){ - if(Ext.isArray(config)){ - var buttons = []; - for(var i = 0, len = config.length; i < len; i++) { - buttons.push(this.addButton(config[i])); - } - return buttons; - } - return this.add(this.constructButton(config)); - }, - - /** - * Adds text to the toolbar - *Note: See the notes within {@link Ext.Container#add}.
- * @param {String} text The text to add - * @return {Ext.Toolbar.Item} The element's item - */ - addText : function(text){ - return this.addItem(new T.TextItem(text)); - }, - - /** - * Adds a new element to the toolbar from the passed {@link Ext.DomHelper} config - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Object} config - * @return {Ext.Toolbar.Item} The element's item - */ - addDom : function(config){ - return this.add(new T.Item({autoEl: config})); - }, - - /** - * Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have - * been rendered yet. For a field that has already been rendered, use {@link #addElement}. - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Ext.form.Field} field - * @return {Ext.Toolbar.Item} - */ - addField : function(field){ - return this.add(field); - }, - - /** - * Inserts any {@link Ext.Toolbar.Item}/{@link Ext.Button} at the specified index. - *Note: See the notes within {@link Ext.Container#add}.
- * @param {Number} index The index where the item is to be inserted - * @param {Object/Ext.Toolbar.Item/Ext.Button/Array} item The button, or button config object to be - * inserted, or an array of buttons/configs. - * @return {Ext.Button/Item} - */ - insertButton : function(index, item){ - if(Ext.isArray(item)){ - var buttons = []; - for(var i = 0, len = item.length; i < len; i++) { - buttons.push(this.insertButton(index + i, item[i])); - } - return buttons; - } - return Ext.Toolbar.superclass.insert.call(this, index, item); - }, - // private - trackMenu : function(item, remove){ - if(this.trackMenus && item.menu){ - var method = remove ? 'mun' : 'mon'; - this[method](item, 'menutriggerover', this.onButtonTriggerOver, this); - this[method](item, 'menushow', this.onButtonMenuShow, this); - this[method](item, 'menuhide', this.onButtonMenuHide, this); + trackMenu: function(item, remove) { + if (this.trackMenus && item.menu) { + var method = remove ? 'mun' : 'mon', + me = this; + + me[method](item, 'menutriggerover', me.onButtonTriggerOver, me); + me[method](item, 'menushow', me.onButtonMenuShow, me); + me[method](item, 'menuhide', me.onButtonMenuHide, me); } }, // private - constructButton : function(item){ - var b = item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType); - return b; + constructButton: function(item) { + return item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType); }, // private - onAdd : function(c){ - Ext.Toolbar.superclass.onAdd.call(this); - this.trackMenu(c); - if(this.disabled){ - c.disable(); + onBeforeAdd: function(component) { + if (component.is('field') || (component.is('button') && this.ui != 'footer')) { + component.ui = component.ui + '-toolbar'; } - }, - - // private - onRemove : function(c){ - Ext.Toolbar.superclass.onRemove.call(this); - if (c == this.activeMenuBtn) { - delete this.activeMenuBtn; + + // Any separators needs to know if is vertical or not + if (component instanceof Ext.toolbar.Separator) { + component.setUI((this.vertical) ? 'vertical' : 'horizontal'); } - this.trackMenu(c, true); + + this.callParent(arguments); }, // private - onDisable : function(){ - this.items.each(function(item){ - if(item.disable){ - item.disable(); - } - }); + onAdd: function(component) { + this.callParent(arguments); + + this.trackMenu(component); + if (this.disabled) { + component.disable(); + } }, // private - onEnable : function(){ - this.items.each(function(item){ - if(item.enable){ - item.enable(); - } - }); + onRemove: function(c) { + this.callParent(arguments); + this.trackMenu(c, true); }, // private - onButtonTriggerOver : function(btn){ - if(this.activeMenuBtn && this.activeMenuBtn != btn){ + onButtonTriggerOver: function(btn){ + if (this.activeMenuBtn && this.activeMenuBtn != btn) { this.activeMenuBtn.hideMenu(); btn.showMenu(); this.activeMenuBtn = btn; @@ -418,179 +417,20 @@ Ext.extend(T, Ext.Container, { }, // private - onButtonMenuShow : function(btn){ + onButtonMenuShow: function(btn) { this.activeMenuBtn = btn; }, // private - onButtonMenuHide : function(btn){ + onButtonMenuHide: function(btn) { delete this.activeMenuBtn; } -}); -Ext.reg('toolbar', Ext.Toolbar); - -/** - * @class Ext.Toolbar.Item - * @extends Ext.BoxComponent - * The base class that other non-interacting Toolbar Item classes should extend in order to - * get some basic common toolbar item functionality. - * @constructor - * Creates a new Item - * @param {HTMLElement} el - * @xtype tbitem - */ -T.Item = Ext.extend(Ext.BoxComponent, { - hideParent: true, // Hiding a Toolbar.Item hides its containing TD - enable:Ext.emptyFn, - disable:Ext.emptyFn, - focus:Ext.emptyFn - /** - * @cfg {String} overflowText Text to be used for the menu if the item is overflowed. - */ -}); -Ext.reg('tbitem', T.Item); - -/** - * @class Ext.Toolbar.Separator - * @extends Ext.Toolbar.Item - * A simple class that adds a vertical separator bar between toolbar items - * (css class:'xtb-sep'). Example usage: - *
-new Ext.Panel({
- tbar : [
- 'Item 1',
- {xtype: 'tbseparator'}, // or '-'
- 'Item 2'
- ]
-});
-
-.x-toolbar .xtb-spacer {
- width:2px;
-}
- * Example usage:
- *
-new Ext.Panel({
- tbar : [
- 'Item 1',
- {xtype: 'tbspacer'}, // or ' '
- 'Item 2',
- // space width is also configurable via javascript
- {xtype: 'tbspacer', width: 50}, // add a 50px space
- 'Item 3'
- ]
-});
-
-new Ext.Panel({
- tbar : [
- 'Item 1',
- {xtype: 'tbfill'}, // or '->'
- 'Item 2'
- ]
-});
-
-new Ext.Panel({
- tbar : [
- {xtype: 'tbtext', text: 'Item 1'} // or simply 'Item 1'
- ]
-});
-