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();
- *
-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'
- ]
-});
-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.
+ */
+
+ enableOverflow : false,
+
+ /**
+ * @cfg {Boolean} enableOverflow
+ * Defaults to false. Configure true to make the toolbar provide a button
+ * which activates a dropdown Menu to show items which overflow the Toolbar's width.
+ */
+ /**
+ * @cfg {String} buttonAlign
+ * The default position at which to align child items. Defaults to "left"
+ * May be specified as "center" to cause items added before a Fill (A "->") item
+ * to be centered in the Toolbar. Items added after a Fill are still right-aligned.
+ * Specify as "right" to right align all child items.
+ */
+
+ trackMenus : true,
+ internalDefaults: {removeMode: 'container', hideParent: true},
+ toolbarCls: 'x-toolbar',
+
+ initComponent : function(){
+ T.superclass.initComponent.call(this);
+
+ /**
+ * @event overflowchange
+ * Fires after the overflow state has changed.
+ * @param {Object} c The Container
+ * @param {Boolean} lastOverflow overflow state
+ */
+ this.addEvents('overflowchange');
+ },
+
+ // private
+ onRender : function(ct, position){
+ if(!this.el){
+ if(!this.autoCreate){
+ this.autoCreate = {
+ cls: this.toolbarCls + ' x-small-editor'
+ };
+ }
+ this.el = ct.createChild(Ext.apply({ id: this.id },this.autoCreate), position);
+ Ext.Toolbar.superclass.onRender.apply(this, arguments);
+ }
+ },
+
+ /**
+ * Adds element(s) to the toolbar -- this function takes a variable number of
+ * arguments of mixed type and adds them to the toolbar.
+ *
Note: See the notes within {@link Ext.Container#add}.
+ * @param {Mixed} arg1 The following types of arguments are all valid:
+ *
+ * - {@link Ext.Button} config: A valid button config object (equivalent to {@link #addButton})
+ * - HtmlElement: Any standard HTML element (equivalent to {@link #addElement})
+ * - Field: Any form field (equivalent to {@link #addField})
+ * - Item: Any subclass of {@link Ext.Toolbar.Item} (equivalent to {@link #addItem})
+ * - String: Any generic string (gets wrapped in a {@link Ext.Toolbar.TextItem}, equivalent to {@link #addText}).
+ * Note that there are a few special strings that are treated differently as explained next.
+ * - '-': Creates a separator element (equivalent to {@link #addSeparator})
+ * - ' ': Creates a spacer element (equivalent to {@link #addSpacer})
+ * - '->': Creates a fill element (equivalent to {@link #addFill})
+ *
+ * @param {Mixed} arg2
+ * @param {Mixed} etc.
+ * @method add
+ */
+
+ // private
+ lookupComponent : function(c){
+ if(Ext.isString(c)){
+ if(c == '-'){
+ c = new T.Separator();
+ }else if(c == ' '){
+ c = new T.Spacer();
+ }else if(c == '->'){
+ c = new T.Fill();
+ }else{
+ c = new T.TextItem(c);
+ }
+ this.applyDefaults(c);
+ }else{
+ if(c.isFormField || c.render){ // some kind of form field, some kind of Toolbar.Item
+ c = this.createComponent(c);
+ }else if(c.tag){ // DomHelper spec
+ c = new T.Item({autoEl: c});
+ }else if(c.tagName){ // element
+ c = new T.Item({el:c});
+ }else if(Ext.isObject(c)){ // must be button config?
+ c = c.xtype ? this.createComponent(c) : this.constructButton(c);
+ }
+ }
+ return c;
+ },
+
+ // private
+ applyDefaults : function(c){
+ if(!Ext.isString(c)){
+ c = Ext.Toolbar.superclass.applyDefaults.call(this, c);
+ var d = this.internalDefaults;
+ if(c.events){
+ Ext.applyIf(c.initialConfig, d);
+ Ext.apply(c, d);
+ }else{
+ Ext.applyIf(c, d);
+ }
+ }
+ return c;
+ },
+
+ /**
+ * Adds a separator
+ *
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);
+ }
+ },
+
+ // private
+ constructButton : function(item){
+ var b = item.events ? item : this.createComponent(item, item.split ? 'splitbutton' : this.defaultType);
+ return b;
+ },
+
+ // private
+ onAdd : function(c){
+ Ext.Toolbar.superclass.onAdd.call(this);
+ this.trackMenu(c);
+ if(this.disabled){
+ c.disable();
+ }
+ },
+
+ // private
+ onRemove : function(c){
+ Ext.Toolbar.superclass.onRemove.call(this);
+ this.trackMenu(c, true);
+ },
+
+ // 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'
+ ]
+});
+
+ * @constructor
+ * Creates a new Separator
+ * @xtype tbseparator
+ */
+T.Separator = Ext.extend(T.Item, {
+ onRender : function(ct, position){
+ this.el = ct.createChild({tag:'span', cls:'xtb-sep'}, position);
+ }
+});
+Ext.reg('tbseparator', T.Separator);
+
+/**
+ * @class Ext.Toolbar.Spacer
+ * @extends Ext.Toolbar.Item
+ * A simple element that adds extra horizontal space between items in a toolbar.
+ * By default a 2px wide space is added via css specification:
+.x-toolbar .xtb-spacer {
+ width:2px;
+}
+ *
+ * Example usage:
+ *
+new Ext.Panel({
+ tbar : [
+ 'Item 1',
+ {xtype: 'tbspacer'}, // or ' '
+ 'Item 2',
+ // space width is also configurable via javascript
+ {xtype: 'tbspacer', width: 50}, // add a 50px space
+ 'Item 3'
+ ]
+});
+
+ * @constructor
+ * Creates a new Spacer
+ * @xtype tbspacer
+ */
+T.Spacer = Ext.extend(T.Item, {
+ /**
+ * @cfg {Number} width
+ * The width of the spacer in pixels (defaults to 2px via css style .x-toolbar .xtb-spacer).
+ */
+
+ onRender : function(ct, position){
+ this.el = ct.createChild({tag:'div', cls:'xtb-spacer', style: this.width?'width:'+this.width+'px':''}, position);
+ }
+});
+Ext.reg('tbspacer', T.Spacer);
+
+/**
+ * @class Ext.Toolbar.Fill
+ * @extends Ext.Toolbar.Spacer
+ * A non-rendering placeholder item which instructs the Toolbar's Layout to begin using
+ * the right-justified button container.
+ *
+new Ext.Panel({
+ tbar : [
+ 'Item 1',
+ {xtype: 'tbfill'}, // or '->'
+ 'Item 2'
+ ]
+});
+
+ * @constructor
+ * Creates a new Fill
+ * @xtype tbfill
+ */
+T.Fill = Ext.extend(T.Item, {
+ // private
+ render : Ext.emptyFn,
+ isFill : true
+});
+Ext.reg('tbfill', T.Fill);
+
+/**
+ * @class Ext.Toolbar.TextItem
+ * @extends Ext.Toolbar.Item
+ * A simple class that renders text directly into a toolbar
+ * (with css class:'xtb-text'). Example usage:
+ *
+new Ext.Panel({
+ tbar : [
+ {xtype: 'tbtext', text: 'Item 1'} // or simply 'Item 1'
+ ]
+});
+
+ * @constructor
+ * Creates a new TextItem
+ * @param {String/Object} text A text string, or a config object containing a text property
+ * @xtype tbtext
+ */
+T.TextItem = Ext.extend(T.Item, {
+ /**
+ * @cfg {String} text The text to be used as innerHTML (html tags are accepted)
+ */
+
+ constructor: function(config){
+ T.TextItem.superclass.constructor.call(this, Ext.isString(config) ? {text: config} : config);
+ },
+
+ // private
+ onRender : function(ct, position) {
+ this.autoEl = {cls: 'xtb-text', html: this.text || ''};
+ T.TextItem.superclass.onRender.call(this, ct, position);
+ },
+
+ /**
+ * Updates this item's text, setting the text to be used as innerHTML.
+ * @param {String} t The text to display (html accepted).
+ */
+ setText : function(t) {
+ if(this.rendered){
+ this.el.update(t);
+ }else{
+ this.text = t;
+ }
+ }
+});
+Ext.reg('tbtext', T.TextItem);
+
+// backwards compat
+T.Button = Ext.extend(Ext.Button, {});
+T.SplitButton = Ext.extend(Ext.SplitButton, {});
+Ext.reg('tbbutton', T.Button);
+Ext.reg('tbsplit', T.SplitButton);
+
+})();