Item.html
17.2 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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
<!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-menu-Item'>/**
</span> * A base class for all menu items that require menu-related functionality such as click handling,
* sub-menus, icons, etc.
*
* @example
* Ext.create('Ext.menu.Menu', {
* width: 100,
* height: 100,
* floating: false, // usually you want this set to True (default)
* renderTo: Ext.getBody(), // usually rendered by it's containing component
* items: [{
* text: 'icon item',
* iconCls: 'add16'
* },{
* text: 'text item'
* },{
* text: 'plain item',
* plain: true
* }]
* });
*/
Ext.define('Ext.menu.Item', {
extend: 'Ext.Component',
alias: 'widget.menuitem',
alternateClassName: 'Ext.menu.TextItem',
<span id='Ext-menu-Item-property-activated'> /**
</span> * @property {Boolean} activated
* Whether or not this item is currently activated
*/
<span id='Ext-menu-Item-property-parentMenu'> /**
</span> * @property {Ext.menu.Menu} parentMenu
* The parent Menu of this item.
*/
<span id='Ext-menu-Item-cfg-activeCls'> /**
</span> * @cfg {String} activeCls
* The CSS class added to the menu item when the item is activated (focused/mouseover).
*/
activeCls: Ext.baseCSSPrefix + 'menu-item-active',
<span id='Ext-menu-Item-cfg-ariaRole'> /**
</span> * @cfg {String} ariaRole
* @private
*/
ariaRole: 'menuitem',
<span id='Ext-menu-Item-cfg-canActivate'> /**
</span> * @cfg {Boolean} canActivate
* Whether or not this menu item can be activated when focused/mouseovered.
*/
canActivate: true,
<span id='Ext-menu-Item-cfg-clickHideDelay'> /**
</span> * @cfg {Number} clickHideDelay
* The delay in milliseconds to wait before hiding the menu after clicking the menu item.
* This only has an effect when `hideOnClick: true`.
*/
clickHideDelay: 1,
<span id='Ext-menu-Item-cfg-destroyMenu'> /**
</span> * @cfg {Boolean} destroyMenu
* Whether or not to destroy any associated sub-menu when this item is destroyed.
*/
destroyMenu: true,
<span id='Ext-menu-Item-cfg-disabledCls'> /**
</span> * @cfg {String} disabledCls
* The CSS class added to the menu item when the item is disabled.
*/
disabledCls: Ext.baseCSSPrefix + 'menu-item-disabled',
<span id='Ext-menu-Item-cfg-href'> /**
</span> * @cfg {String} [href='#']
* The href attribute to use for the underlying anchor link.
*/
<span id='Ext-menu-Item-cfg-hrefTarget'> /**
</span> * @cfg {String} hrefTarget
* The target attribute to use for the underlying anchor link.
*/
<span id='Ext-menu-Item-cfg-hideOnClick'> /**
</span> * @cfg {Boolean} hideOnClick
* Whether to not to hide the owning menu when this item is clicked.
*/
hideOnClick: true,
<span id='Ext-menu-Item-cfg-icon'> /**
</span> * @cfg {String} icon
* The path to an icon to display in this item.
*
* Defaults to `Ext.BLANK_IMAGE_URL`.
*/
<span id='Ext-menu-Item-cfg-iconCls'> /**
</span> * @cfg {String} iconCls
* A CSS class that specifies a `background-image` to use as the icon for this item.
*/
isMenuItem: true,
<span id='Ext-menu-Item-cfg-menu'> /**
</span> * @cfg {Ext.menu.Menu/Object} menu
* Either an instance of {@link Ext.menu.Menu} or a config object for an {@link Ext.menu.Menu}
* which will act as a sub-menu to this item.
*/
<span id='Ext-menu-Item-property-menu'> /**
</span> * @property {Ext.menu.Menu} menu The sub-menu associated with this item, if one was configured.
*/
<span id='Ext-menu-Item-cfg-menuAlign'> /**
</span> * @cfg {String} menuAlign
* The default {@link Ext.Element#getAlignToXY Ext.Element.getAlignToXY} anchor position value for this
* item's sub-menu relative to this item's position.
*/
menuAlign: 'tl-tr?',
<span id='Ext-menu-Item-cfg-menuExpandDelay'> /**
</span> * @cfg {Number} menuExpandDelay
* The delay in milliseconds before this item's sub-menu expands after this item is moused over.
*/
menuExpandDelay: 200,
<span id='Ext-menu-Item-cfg-menuHideDelay'> /**
</span> * @cfg {Number} menuHideDelay
* The delay in milliseconds before this item's sub-menu hides after this item is moused out.
*/
menuHideDelay: 200,
<span id='Ext-menu-Item-cfg-plain'> /**
</span> * @cfg {Boolean} plain
* Whether or not this item is plain text/html with no icon or visual activation.
*/
<span id='Ext-menu-Item-cfg-tooltip'> /**
</span> * @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.
*/
<span id='Ext-menu-Item-cfg-tooltipType'> /**
</span> * @cfg {String} tooltipType
* The type of tooltip to use. Either 'qtip' for QuickTips or 'title' for title attribute.
*/
tooltipType: 'qtip',
arrowCls: Ext.baseCSSPrefix + 'menu-item-arrow',
childEls: [
'itemEl', 'iconEl', 'textEl', 'arrowEl'
],
renderTpl: [
'<tpl if="plain">',
'{text}',
'<tpl else>',
'<a id="{id}-itemEl" class="' + Ext.baseCSSPrefix + 'menu-item-link" href="{href}" <tpl if="hrefTarget">target="{hrefTarget}"</tpl> hidefocus="true" unselectable="on">',
'<img id="{id}-iconEl" src="{icon}" class="' + Ext.baseCSSPrefix + 'menu-item-icon {iconCls}" />',
'<span id="{id}-textEl" class="' + Ext.baseCSSPrefix + 'menu-item-text" <tpl if="arrowCls">style="margin-right: 17px;"</tpl> >{text}</span>',
'<img id="{id}-arrowEl" src="{blank}" class="{arrowCls}" />',
'</a>',
'</tpl>'
],
maskOnDisable: false,
<span id='Ext-menu-Item-cfg-text'> /**
</span> * @cfg {String} text
* The text/html to display in this item.
*/
<span id='Ext-menu-Item-cfg-handler'> /**
</span> * @cfg {Function} handler
* A function called when the menu item is clicked (can be used instead of {@link #click} event).
* @cfg {Ext.menu.Item} handler.item The item that was clicked
* @cfg {Ext.EventObject} handler.e The underyling {@link Ext.EventObject}.
*/
activate: function() {
var me = this;
if (!me.activated && me.canActivate && me.rendered && !me.isDisabled() && me.isVisible()) {
me.el.addCls(me.activeCls);
me.focus();
me.activated = true;
me.fireEvent('activate', me);
}
},
getFocusEl: function() {
return this.itemEl;
},
deactivate: function() {
var me = this;
if (me.activated) {
me.el.removeCls(me.activeCls);
me.blur();
me.hideMenu();
me.activated = false;
me.fireEvent('deactivate', me);
}
},
deferExpandMenu: function() {
var me = this;
if (me.activated && (!me.menu.rendered || !me.menu.isVisible())) {
me.parentMenu.activeChild = me.menu;
me.menu.parentItem = me;
me.menu.parentMenu = me.menu.ownerCt = me.parentMenu;
me.menu.showBy(me, me.menuAlign);
}
},
deferHideMenu: function() {
if (this.menu.isVisible()) {
this.menu.hide();
}
},
cancelDeferHide: function(){
clearTimeout(this.hideMenuTimer);
},
deferHideParentMenus: function() {
var ancestor;
Ext.menu.Manager.hideAll();
if (!Ext.Element.getActiveElement()) {
// If we have just hidden all Menus, and there is no currently focused element in the dom, transfer focus to the first visible ancestor if any.
ancestor = this.up(':not([hidden])');
if (ancestor) {
ancestor.focus();
}
}
},
expandMenu: function(delay) {
var me = this;
if (me.menu) {
me.cancelDeferHide();
if (delay === 0) {
me.deferExpandMenu();
} else {
me.expandMenuTimer = Ext.defer(me.deferExpandMenu, Ext.isNumber(delay) ? delay : me.menuExpandDelay, me);
}
}
},
getRefItems: function(deep){
var menu = this.menu,
items;
if (menu) {
items = menu.getRefItems(deep);
items.unshift(menu);
}
return items || [];
},
hideMenu: function(delay) {
var me = this;
if (me.menu) {
clearTimeout(me.expandMenuTimer);
me.hideMenuTimer = Ext.defer(me.deferHideMenu, Ext.isNumber(delay) ? delay : me.menuHideDelay, me);
}
},
initComponent: function() {
var me = this,
prefix = Ext.baseCSSPrefix,
cls = [prefix + 'menu-item'],
menu;
me.addEvents(
<span id='Ext-menu-Item-event-activate'> /**
</span> * @event activate
* Fires when this item is activated
* @param {Ext.menu.Item} item The activated item
*/
'activate',
<span id='Ext-menu-Item-event-click'> /**
</span> * @event click
* Fires when this item is clicked
* @param {Ext.menu.Item} item The item that was clicked
* @param {Ext.EventObject} e The underyling {@link Ext.EventObject}.
*/
'click',
<span id='Ext-menu-Item-event-deactivate'> /**
</span> * @event deactivate
* Fires when this tiem is deactivated
* @param {Ext.menu.Item} item The deactivated item
*/
'deactivate'
);
if (me.plain) {
cls.push(prefix + 'menu-item-plain');
}
if (me.cls) {
cls.push(me.cls);
}
me.cls = cls.join(' ');
if (me.menu) {
menu = me.menu;
delete me.menu;
me.setMenu(menu);
}
me.callParent(arguments);
},
onClick: function(e) {
var me = this;
if (!me.href) {
e.stopEvent();
}
if (me.disabled) {
return;
}
if (me.hideOnClick) {
me.deferHideParentMenusTimer = Ext.defer(me.deferHideParentMenus, me.clickHideDelay, me);
}
Ext.callback(me.handler, me.scope || me, [me, e]);
me.fireEvent('click', me, e);
if (!me.hideOnClick) {
me.focus();
}
},
onRemoved: function() {
var me = this;
// Removing the active item, must deactivate it.
if (me.activated && me.parentMenu.activeItem === me) {
me.parentMenu.deactivateActiveItem();
}
me.callParent(arguments);
delete me.parentMenu;
delete me.ownerButton;
},
// private
beforeDestroy: function() {
var me = this;
if (me.rendered) {
me.clearTip();
}
me.callParent();
},
onDestroy: function() {
var me = this;
clearTimeout(me.expandMenuTimer);
me.cancelDeferHide();
clearTimeout(me.deferHideParentMenusTimer);
me.setMenu(null);
me.callParent(arguments);
},
beforeRender: function() {
var me = this,
blank = Ext.BLANK_IMAGE_URL,
iconCls,
arrowCls;
me.callParent();
if (me.iconAlign === 'right') {
iconCls = me.checkChangeDisabled ? me.disabledCls : '';
arrowCls = Ext.baseCSSPrefix + 'menu-item-icon-right ' + me.iconCls;
} else {
iconCls = me.iconCls + (me.checkChangeDisabled ? ' ' + me.disabledCls : '');
arrowCls = me.menu ? me.arrowCls : '';
}
Ext.applyIf(me.renderData, {
href: me.href || '#',
hrefTarget: me.hrefTarget,
icon: me.icon || blank,
iconCls: iconCls,
plain: me.plain,
text: me.text,
arrowCls: arrowCls,
blank: blank
});
},
onRender: function() {
var me = this;
me.callParent(arguments);
if (me.tooltip) {
me.setTooltip(me.tooltip, true);
}
},
<span id='Ext-menu-Item-method-setMenu'> /**
</span> * Set a child menu for this item. See the {@link #cfg-menu} configuration.
* @param {Ext.menu.Menu/Object} menu A menu, or menu configuration. null may be
* passed to remove the menu.
* @param {Boolean} [destroyMenu] True to destroy any existing menu. False to
* prevent destruction. If not specified, the {@link #destroyMenu} configuration
* will be used.
*/
setMenu: function(menu, destroyMenu) {
var me = this,
oldMenu = me.menu,
arrowEl = me.arrowEl;
if (oldMenu) {
delete oldMenu.parentItem;
delete oldMenu.parentMenu;
delete oldMenu.ownerCt;
delete oldMenu.ownerItem;
if (destroyMenu === true || (destroyMenu !== false && me.destroyMenu)) {
Ext.destroy(oldMenu);
}
}
if (menu) {
me.menu = Ext.menu.Manager.get(menu);
me.menu.ownerItem = me;
} else {
me.menu = null;
}
if (me.rendered && !me.destroying && arrowEl) {
arrowEl[me.menu ? 'addCls' : 'removeCls'](me.arrowCls);
}
},
<span id='Ext-menu-Item-method-setHandler'> /**
</span> * Sets the {@link #click} handler of this item
* @param {Function} fn The handler function
* @param {Object} [scope] The scope of the handler function
*/
setHandler: function(fn, scope) {
this.handler = fn || null;
this.scope = scope;
},
<span id='Ext-menu-Item-method-setIcon'> /**
</span> * Sets the {@link #icon} on this item.
* @param {String} icon The new icon
*/
setIcon: function(icon){
var iconEl = this.iconEl;
if (iconEl) {
iconEl.src = icon || Ext.BLANK_IMAGE_URL;
}
this.icon = icon;
},
<span id='Ext-menu-Item-method-setIconCls'> /**
</span> * Sets the {@link #iconCls} of this item
* @param {String} iconCls The CSS class to set to {@link #iconCls}
*/
setIconCls: function(iconCls) {
var me = this,
iconEl = me.iconEl;
if (iconEl) {
if (me.iconCls) {
iconEl.removeCls(me.iconCls);
}
if (iconCls) {
iconEl.addCls(iconCls);
}
}
me.iconCls = iconCls;
},
<span id='Ext-menu-Item-method-setText'> /**
</span> * Sets the {@link #text} of this item
* @param {String} text The {@link #text}
*/
setText: function(text) {
var me = this,
el = me.textEl || me.el;
me.text = text;
if (me.rendered) {
el.update(text || '');
// cannot just call layout on the component due to stretchmax
me.ownerCt.updateLayout();
}
},
getTipAttr: function(){
return this.tooltipType == 'qtip' ? 'data-qtip' : 'title';
},
//private
clearTip: function() {
if (Ext.isObject(this.tooltip)) {
Ext.tip.QuickTipManager.unregister(this.itemEl);
}
},
<span id='Ext-menu-Item-method-setTooltip'> /**
</span> * Sets the tooltip for this menu item.
*
* @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.menu.Item} 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.itemEl.id
},
tooltip));
me.tooltip = tooltip;
} else {
me.itemEl.dom.setAttribute(me.getTipAttr(), tooltip);
}
} else {
me.tooltip = tooltip;
}
return me;
}
});
</pre>
</body>
</html>