/*! - * Ext JS Library 3.0.3 - * Copyright(c) 2006-2009 Ext JS, LLC - * licensing@extjs.com - * http://www.extjs.com/license + +/** + * @class Ext.toolbar.Toolbar + * @extends Ext.container.Container + +Basic Toolbar class. Although the {@link Ext.container.Container#defaultType defaultType} for Toolbar is {@link Ext.button.Button button}, Toolbar +elements (child items for the Toolbar container) may be virtually any type of Component. Toolbar elements can be created explicitly via their +constructors, or implicitly via their xtypes, and can be {@link #add}ed dynamically. + +__Some items have shortcut strings for creation:__ + +| Shortcut | xtype | Class | Description | +|:---------|:--------------|:------------------------------|:---------------------------------------------------| +| `->` | `tbspacer` | {@link Ext.toolbar.Fill} | begin using the right-justified button container | +| `-` | `tbseparator` | {@link Ext.toolbar.Separator} | add a vertical separator bar between toolbar items | +| ` ` | `tbspacer` | {@link Ext.toolbar.Spacer} | add horiztonal space between elements | + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar1.png Toolbar component} +Example usage: + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 500, + items: [ + { + // xtype: 'button', // default for Toolbars + text: 'Button' + }, + { + xtype: 'splitbutton', + text : 'Split Button' + }, + // begin using the right-justified button container + '->', // same as {xtype: 'tbfill'}, // Ext.toolbar.Fill + { + xtype : 'textfield', + name : 'field1', + emptyText: 'enter search term' + }, + // add a vertical separator bar between toolbar items + '-', // same as {xtype: 'tbseparator'} to create Ext.toolbar.Separator + 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.toolbar.TextItem + {xtype: 'tbspacer'},// same as ' ' to create Ext.toolbar.Spacer + 'text 2', + {xtype: 'tbspacer', width: 50}, // add a 50px space + 'text 3' + ] + }); + +Toolbars have {@link #enable} and {@link #disable} methods which when called, will enable/disable all items within your toolbar. + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar2.png Toolbar component} +Example usage: + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 400, + items: [ + { + text: 'Button' + }, + { + xtype: 'splitbutton', + text : 'Split Button' + }, + '->', + { + xtype : 'textfield', + name : 'field1', + emptyText: 'enter search term' + } + ] + }); + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar3.png Toolbar component} +Example usage: + + var enableBtn = Ext.create('Ext.button.Button', { + text : 'Enable All Items', + disabled: true, + scope : this, + handler : function() { + //disable the enable button and enable the disable button + enableBtn.disable(); + disableBtn.enable(); + + //enable the toolbar + toolbar.enable(); + } + }); + + var disableBtn = Ext.create('Ext.button.Button', { + text : 'Disable All Items', + scope : this, + handler : function() { + //enable the enable button and disable button + disableBtn.disable(); + enableBtn.enable(); + + //disable the toolbar + toolbar.disable(); + } + }); + + var toolbar = Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 400, + margin : '5 0 0 0', + items : [enableBtn, disableBtn] + }); + +Adding items to and removing items from a toolbar is as simple as calling the {@link #add} and {@link #remove} methods. There is also a {@link #removeAll} method +which remove all items within the toolbar. + +{@img Ext.toolbar.Toolbar/Ext.toolbar.Toolbar4.png Toolbar component} +Example usage: + + var toolbar = Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 700, + items: [ + { + text: 'Example Button' + } + ] + }); + + var addedItems = []; + + Ext.create('Ext.toolbar.Toolbar', { + renderTo: document.body, + width : 700, + margin : '5 0 0 0', + items : [ + { + text : 'Add a button', + scope : this, + handler: function() { + var text = prompt('Please enter the text for your button:'); + addedItems.push(toolbar.add({ + text: text + })); + } + }, + { + text : 'Add a text item', + scope : this, + handler: function() { + var text = prompt('Please enter the text for your item:'); + addedItems.push(toolbar.add(text)); + } + }, + { + text : 'Add a toolbar seperator', + scope : this, + handler: function() { + addedItems.push(toolbar.add('-')); + } + }, + { + text : 'Add a toolbar spacer', + scope : this, + handler: function() { + addedItems.push(toolbar.add('->')); + } + }, + '->', + { + text : 'Remove last inserted item', + scope : this, + handler: function() { + if (addedItems.length) { + toolbar.remove(addedItems.pop()); + } else if (toolbar.items.length) { + toolbar.remove(toolbar.items.last()); + } else { + alert('No items in the toolbar'); + } + } + }, + { + text : 'Remove all items', + scope : this, + handler: function() { + toolbar.removeAll(); + } + } + ] + }); + + * @constructor + * Creates a new Toolbar + * @param {Object/Array} config A config object or an array of buttons to <code>{@link #add}</code> + * @xtype toolbar + * @docauthor Robert Dougan <rob@sencha.com> + * @markdown */ -/** - * @class Ext.layout.ToolbarLayout - * @extends Ext.layout.ContainerLayout - * Layout manager implicitly used by Ext.Toolbar. - */ -Ext.layout.ToolbarLayout = Ext.extend(Ext.layout.ContainerLayout, { - monitorResize : true, - triggerWidth : 18, - lastOverflow : false, - - noItemsMenuText : '', - // private - onLayout : function(ct, target){ - if(!this.leftTr){ - target.addClass('x-toolbar-layout-ct'); - target.insertHtml('beforeEnd', - '
Basic Toolbar class. Although the {@link Ext.Container#defaultType defaultType} for Toolbar - * is {@link Ext.Button button}, Toolbar elements (child items for the Toolbar container) may - * be virtually any type of Component. Toolbar elements can be created explicitly via their constructors, - * or implicitly via their xtypes, and can be {@link #add}ed dynamically.
- *Some items have shortcut strings for creation:
- *
-Shortcut xtype Class Description
-'->' 'tbfill' {@link Ext.Toolbar.Fill} begin using the right-justified button container
-'-' 'tbseparator' {@link Ext.Toolbar.Separator} add a vertical separator bar between toolbar items
-' ' 'tbspacer' {@link Ext.Toolbar.Spacer} add horiztonal space between elements
- *
- *
- * Example usage of various elements:
- *
-var tb = new Ext.Toolbar({
- renderTo: document.body,
- width: 600,
- height: 100,
- items: [
- {
- // xtype: 'button', // default for Toolbars, same as 'tbbutton'
- text: 'Button'
- },
- {
- xtype: 'splitbutton', // same as 'tbsplitbutton'
- text: 'Split Button'
- },
- // begin using the right-justified button container
- '->', // same as {xtype: 'tbfill'}, // Ext.Toolbar.Fill
- {
- xtype: 'textfield',
- name: 'field1',
- emptyText: 'enter search term'
- },
- // add a vertical separator bar between toolbar items
- '-', // same as {xtype: 'tbseparator'} to create Ext.Toolbar.Separator
- 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.Toolbar.TextItem
- {xtype: 'tbspacer'},// same as ' ' to create Ext.Toolbar.Spacer
- 'text 2',
- {xtype: 'tbspacer', width: 50}, // add a 50px space
- 'text 3'
- ]
-});
- *
-// ComboBox creation
-var combo = new Ext.form.ComboBox({
- store: new Ext.data.ArrayStore({
- autoDestroy: true,
- fields: ['initials', 'fullname'],
- data : [
- ['FF', 'Fred Flintstone'],
- ['BR', 'Barney Rubble']
- ]
- }),
- displayField: 'fullname',
- typeAhead: true,
- mode: 'local',
- forceSelection: true,
- triggerAction: 'all',
- emptyText: 'Select a name...',
- selectOnFocus: true,
- width: 135,
- getListParent: function() {
- return this.el.up('.x-menu');
- },
- iconCls: 'no-icon' //use iconCls if placing within menu to shift to right side of menu
-});
-
-// put ComboBox in a Menu
-var menu = new Ext.menu.Menu({
- id: 'mainMenu',
- items: [
- combo // A Field in a Menu
- ]
-});
-
-// add a Button with the menu
-tb.add({
- text:'Button w/ Menu',
- menu: menu // assign menu by instance
- });
-tb.doLayout();
- * layout:'toolbar').
- * Developers may override this configuration option if another layout
- * is required (the constructor must be passed a configuration object in this
- * case instead of an array).
- * See {@link Ext.Container#layout} for additional information.
- */
-
- trackMenus : true,
- internalDefaults: {removeMode: 'container', hideParent: true},
- toolbarCls: 'x-toolbar',
-
- initComponent : function(){
- T.superclass.initComponent.call(this);
-
- /**
- * @event overflowchange
- * Fires after the overflow state has changed.
- * @param {Object} c The Container
- * @param {Boolean} lastOverflow overflow state
- */
- this.addEvents('overflowchange');
- },
-
- // private
- onRender : function(ct, position){
- if(!this.el){
- if(!this.autoCreate){
- this.autoCreate = {
- cls: this.toolbarCls + ' x-small-editor'
- };
- }
- this.el = ct.createChild(Ext.apply({ id: this.id },this.autoCreate), position);
- Ext.Toolbar.superclass.onRender.apply(this, arguments);
- }
- },
-
- /**
- * Adds element(s) to the toolbar -- this function takes a variable number of - * arguments of mixed type and adds them to the toolbar.
- *Note: See the notes within {@link Ext.Container#add}.
- * @param {Mixed} arg1 The following types of arguments are all valid: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 - initMenuTracking : function(item){ - if(this.trackMenus && item.menu){ - this.mon(item, { - 'menutriggerover' : this.onButtonTriggerOver, - 'menushow' : this.onButtonMenuShow, - 'menuhide' : this.onButtonMenuHide, - scope: this - }); - } - }, - - // private - constructButton : function(item){ - var b = item.events ? item : this.constructItem(item, item.split ? 'splitbutton' : this.defaultType); - this.initMenuTracking(b); - return b; - }, - - // private - onDisable : function(){ - this.items.each(function(item){ - if(item.disable){ - item.disable(); - } - }); - }, - - // private - onEnable : function(){ - this.items.each(function(item){ - if(item.enable){ - item.enable(); - } - }); - }, - - // private - onButtonTriggerOver : function(btn){ - if(this.activeMenuBtn && this.activeMenuBtn != btn){ - this.activeMenuBtn.hideMenu(); - btn.showMenu(); - this.activeMenuBtn = btn; - } - }, - - // private - onButtonMenuShow : function(btn){ - this.activeMenuBtn = btn; - }, - - // private - onButtonMenuHide : function(btn){ - delete this.activeMenuBtn; - } -}); -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'
- ]
-});
-