Toolbar.html
14.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-toolbar-Toolbar-method-constructor'><span id='Ext-toolbar-Toolbar'>/**
</span></span> * 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 #method-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 #method-enable} and {@link #method-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 #method-add}
* and {@link #method-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 separator',
* 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 {@link #method-add}
* @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'
],
uses: [
'Ext.toolbar.Separator'
],
alias: 'widget.toolbar',
alternateClassName: 'Ext.Toolbar',
<span id='Ext-toolbar-Toolbar-property-isToolbar'> /**
</span> * @property {Boolean} isToolbar
* `true` in this class to identify an object as an instantiated Toolbar, or subclass thereof.
*/
isToolbar: true,
baseCls : Ext.baseCSSPrefix + 'toolbar',
ariaRole : 'toolbar',
defaultType: 'button',
<span id='Ext-toolbar-Toolbar-cfg-vertical'> /**
</span> * @cfg {Boolean} vertical
* Set to `true` to make the toolbar vertical. The layout will become a `vbox`.
*/
vertical: false,
<span id='Ext-toolbar-Toolbar-cfg-layout'> /**
</span> * @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.
*/
<span id='Ext-toolbar-Toolbar-cfg-enableOverflow'> /**
</span> * @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,
<span id='Ext-toolbar-Toolbar-cfg-menuTriggerCls'> /**
</span> * @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',
statics: {
shortcuts: {
'-' : 'tbseparator',
' ' : 'tbspacer'
},
shortcutsHV: {
// horizontal
0: {
'->': { xtype: 'tbfill', height: 0 }
},
// vertical
1: {
'->': { xtype: 'tbfill', width: 0 }
}
}
},
initComponent: function() {
var me = this,
keys;
// check for simplified (old-style) overflow config:
if (!me.layout && me.enableOverflow) {
me.layout = { overflowHandler: 'Menu' };
}
if (me.dock === 'right' || me.dock === 'left') {
me.vertical = true;
}
me.layout = Ext.applyIf(Ext.isString(me.layout) ? {
type: me.layout
} : me.layout || {}, {
type: me.vertical ? 'vbox' : 'hbox',
align: me.vertical ? 'stretchmax' : 'middle'
});
if (me.vertical) {
me.addClsWithUI('vertical');
}
// @TODO: remove this hack and implement a more general solution
if (me.ui === 'footer') {
me.ignoreBorderManagement = true;
}
me.callParent();
<span id='Ext-toolbar-Toolbar-event-overflowchange'> /**
</span> * @event overflowchange
* Fires after the overflow state has changed.
* @param {Object} c The Container
* @param {Boolean} lastOverflow overflow state
*/
me.addEvents('overflowchange');
},
getRefItems: function(deep) {
var me = this,
items = me.callParent(arguments),
layout = me.layout,
handler;
if (deep && me.enableOverflow) {
handler = layout.overflowHandler;
if (handler && handler.menu) {
items = items.concat(handler.menu.getRefItems(deep));
}
}
return items;
},
<span id='Ext-toolbar-Toolbar-method-add'> /**
</span> * Adds element(s) to the toolbar -- this function takes a variable number of
* arguments of mixed type and adds them to the toolbar.
*
* **Note**: See the notes within {@link Ext.container.Container#method-add}.
*
* @param {Object...} args The following types of arguments are all valid:
*
* - `{@link Ext.button.Button config}`: A valid button config object
* - `HtmlElement`: Any standard HTML element
* - `Field`: Any form field
* - `Item`: Any subclass of {@link Ext.toolbar.Item}
* - `String`: Any generic string (gets wrapped in a {@link Ext.toolbar.TextItem}).
*
* Note that there are a few special strings that are treated differently as explained next:
*
* - `'-'`: Creates a separator element
* - `' '`: Creates a spacer element
* - `'->'`: Creates a fill element
*
* @method add
*/
// private
lookupComponent: function(c) {
if (typeof c == 'string') {
var T = Ext.toolbar.Toolbar,
shortcut = T.shortcutsHV[this.vertical ? 1 : 0][c] || T.shortcuts[c];
if (typeof shortcut == 'string') {
c = {
xtype: shortcut
};
} else if (shortcut) {
c = Ext.apply({}, shortcut);
} else {
c = {
xtype: 'tbtext',
text: c
};
}
this.applyDefaults(c);
}
return this.callParent(arguments);
},
// private
applyDefaults: function(c) {
if (!Ext.isString(c)) {
c = this.callParent(arguments);
}
return c;
},
// private
trackMenu: function(item, remove) {
if (this.trackMenus && item.menu) {
var method = remove ? 'mun' : 'mon',
me = this;
me[method](item, 'mouseover', me.onButtonOver, me);
me[method](item, 'menushow', me.onButtonMenuShow, me);
me[method](item, 'menuhide', me.onButtonMenuHide, me);
}
},
// private
constructButton: function(item) {
return item.events ? item
: Ext.widget(item.split ? 'splitbutton' : this.defaultType, item);
},
// private
onBeforeAdd: function(component) {
if (component.is('field') || (component.is('button') && this.ui != 'footer')) {
component.ui = component.ui + '-toolbar';
}
// Any separators needs to know if is vertical or not
if (component instanceof Ext.toolbar.Separator) {
component.setUI((this.vertical) ? 'vertical' : 'horizontal');
}
this.callParent(arguments);
},
// private
onAdd: function(component) {
this.callParent(arguments);
this.trackMenu(component);
},
// private
onRemove: function(c) {
this.callParent(arguments);
this.trackMenu(c, true);
},
getChildItemsToDisable: function() {
return this.items.getRange();
},
// private
onButtonOver: 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;
}
});</pre>
</body>
</html>