b0f64f4ae9fcb131e1e9b397843ef0ed23e45ba7
[roojs1] / Roo / bootstrap / Menu.js
1 /*
2  * - LGPL
3  *
4  * menu
5  * 
6  */
7
8 /**
9  * @class Roo.bootstrap.Menu
10  * @extends Roo.bootstrap.Component
11  * Bootstrap Menu class - container for MenuItems
12  * @cfg {String} type (dropdown|treeview|submenu) type of menu
13  * @cfg {bool} hidden  if the menu should be hidden when rendered.
14  * @cfg {bool} stopEvent (true|false)  Stop event after trigger press (default true)
15  * @cfg {bool} isLink (true|false)  the menu has link disable auto expand and collaspe (default false)
16   * @cfg {bool} hideTrigger (true|false)  default false - hide the carret for trigger.
17   * @cfg {String} align  default tl-bl? == below  - how the menu should be aligned. 
18  
19  * @constructor
20  * Create a new Menu
21  * @param {Object} config The config object
22  */
23
24
25 Roo.bootstrap.Menu = function(config){
26     
27     if (config.type == 'treeview') {
28         // normally menu's are drawn attached to the document to handle layering etc..
29         // however treeview (used by the docs menu is drawn into the parent element)
30         this.container_method = 'getChildContainer'; 
31     }
32     
33     Roo.bootstrap.Menu.superclass.constructor.call(this, config);
34     if (this.registerMenu && this.type != 'treeview')  {
35         Roo.bootstrap.MenuMgr.register(this);
36     }
37     
38     
39     this.addEvents({
40         /**
41          * @event beforeshow
42          * Fires before this menu is displayed (return false to block)
43          * @param {Roo.menu.Menu} this
44          */
45         beforeshow : true,
46         /**
47          * @event beforehide
48          * Fires before this menu is hidden (return false to block)
49          * @param {Roo.menu.Menu} this
50          */
51         beforehide : true,
52         /**
53          * @event show
54          * Fires after this menu is displayed
55          * @param {Roo.menu.Menu} this
56          */
57         show : true,
58         /**
59          * @event hide
60          * Fires after this menu is hidden
61          * @param {Roo.menu.Menu} this
62          */
63         hide : true,
64         /**
65          * @event click
66          * Fires when this menu is clicked (or when the enter key is pressed while it is active)
67          * @param {Roo.menu.Menu} this
68          * @param {Roo.menu.Item} menuItem The menu item that was clicked
69          * @param {Roo.EventObject} e
70          */
71         click : true,
72         /**
73          * @event mouseover
74          * Fires when the mouse is hovering over this menu
75          * @param {Roo.menu.Menu} this
76          * @param {Roo.EventObject} e
77          * @param {Roo.menu.Item} menuItem The menu item that was clicked
78          */
79         mouseover : true,
80         /**
81          * @event mouseout
82          * Fires when the mouse exits this menu
83          * @param {Roo.menu.Menu} this
84          * @param {Roo.EventObject} e
85          * @param {Roo.menu.Item} menuItem The menu item that was clicked
86          */
87         mouseout : true,
88         /**
89          * @event itemclick
90          * Fires when a menu item contained in this menu is clicked
91          * @param {Roo.menu.BaseItem} baseItem The BaseItem that was clicked
92          * @param {Roo.EventObject} e
93          */
94         itemclick: true
95     });
96     this.menuitems = new Roo.util.MixedCollection(false, function(o) { return o.el.id; });
97 };
98
99 Roo.extend(Roo.bootstrap.Menu, Roo.bootstrap.Component,  {
100     
101    /// html : false,
102    
103     triggerEl : false,  // is this set by component builder? -- it should really be fetched from parent()???
104     type: false,
105     /**
106      * @cfg {Boolean} registerMenu True (default) - means that clicking on screen etc. hides it.
107      */
108     registerMenu : true,
109     
110     menuItems :false, // stores the menu items..
111     
112     hidden:true,
113         
114     parentMenu : false,
115     
116     stopEvent : true,
117     
118     isLink : false,
119     
120     container_method : 'getDocumentBody', // so the menu is rendered on the body and zIndex works.
121     
122     hideTrigger : false,
123     
124     align : 'tl-bl?',
125     
126     
127     getChildContainer : function() {
128         return this.el;  
129     },
130     
131     getAutoCreate : function(){
132          
133         //if (['right'].indexOf(this.align)!==-1) {
134         //    cfg.cn[1].cls += ' pull-right'
135         //}
136          
137         var cfg = {
138             tag : 'ul',
139             cls : 'dropdown-menu shadow' ,
140             style : 'z-index:1000'
141             
142         };
143         
144         if (this.type === 'submenu') {
145             cfg.cls = 'submenu active';
146         }
147         if (this.type === 'treeview') {
148             cfg.cls = 'treeview-menu';
149         }
150         
151         return cfg;
152     },
153     initEvents : function() {
154         
155        // Roo.log("ADD event");
156        // Roo.log(this.triggerEl.dom);
157         
158         this.triggerEl.on('click', this.onTriggerClick, this);
159         
160         this.triggerEl.on(Roo.isTouch ? 'touchstart' : 'mouseup', this.onTriggerPress, this);
161         
162         if (!this.hideTrigger) {
163             if (this.triggerEl.hasClass('nav-item') && this.triggerEl.select('.nav-link',true).length) {
164                 // dropdown toggle on the 'a' in BS4?
165                 this.triggerEl.select('.nav-link',true).first().addClass('dropdown-toggle');
166             } else {
167                 this.triggerEl.addClass('dropdown-toggle');
168             }
169         }
170         if (Roo.isTouch) {
171             this.el.on('touchstart'  , this.onTouch, this);
172         }
173         this.el.on('click' , this.onClick, this);
174
175         this.el.on("mouseover", this.onMouseOver, this);
176         this.el.on("mouseout", this.onMouseOut, this);
177         
178     },
179     
180     findTargetItem : function(e)
181     {
182         var t = e.getTarget(".dropdown-menu-item", this.el,  true);
183         if(!t){
184             return false;
185         }
186         //Roo.log(t);         Roo.log(t.id);
187         if(t && t.id){
188             //Roo.log(this.menuitems);
189             return this.menuitems.get(t.id);
190             
191             //return this.items.get(t.menuItemId);
192         }
193         
194         return false;
195     },
196     
197     onTouch : function(e) 
198     {
199         Roo.log("menu.onTouch");
200         //e.stopEvent(); this make the user popdown broken
201         this.onClick(e);
202     },
203     
204     onClick : function(e)
205     {
206         Roo.log("menu.onClick");
207         
208         var t = this.findTargetItem(e);
209         if(!t || t.isContainer){
210             return;
211         }
212         Roo.log(e);
213         /*
214         if (Roo.isTouch && e.type == 'touchstart' && t.menu  && !t.disabled) {
215             if(t == this.activeItem && t.shouldDeactivate(e)){
216                 this.activeItem.deactivate();
217                 delete this.activeItem;
218                 return;
219             }
220             if(t.canActivate){
221                 this.setActiveItem(t, true);
222             }
223             return;
224             
225             
226         }
227         */
228        
229         Roo.log('pass click event');
230         
231         t.onClick(e);
232         
233         this.fireEvent("click", this, t, e);
234         
235         var _this = this;
236         
237         if(!t.href.length || t.href == '#'){
238             (function() { _this.hide(); }).defer(100);
239         }
240         
241     },
242     
243     onMouseOver : function(e){
244         var t  = this.findTargetItem(e);
245         //Roo.log(t);
246         //if(t){
247         //    if(t.canActivate && !t.disabled){
248         //        this.setActiveItem(t, true);
249         //    }
250         //}
251         
252         this.fireEvent("mouseover", this, e, t);
253     },
254     isVisible : function(){
255         return !this.hidden;
256     },
257     onMouseOut : function(e){
258         var t  = this.findTargetItem(e);
259         
260         //if(t ){
261         //    if(t == this.activeItem && t.shouldDeactivate(e)){
262         //        this.activeItem.deactivate();
263         //        delete this.activeItem;
264         //    }
265         //}
266         this.fireEvent("mouseout", this, e, t);
267     },
268     
269     
270     /**
271      * Displays this menu relative to another element
272      * @param {String/HTMLElement/Roo.Element} element The element to align to
273      * @param {String} position (optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to
274      * the element (defaults to this.defaultAlign)
275      * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
276      */
277     show : function(el, pos, parentMenu)
278     {
279         if (false === this.fireEvent("beforeshow", this)) {
280             Roo.log("show canceled");
281             return;
282         }
283         this.parentMenu = parentMenu;
284         if(!this.el){
285             this.render();
286         }
287         this.el.addClass('show'); // show otherwise we do not know how big we are..
288          
289         var xy = this.el.getAlignToXY(el, pos);
290         
291         // bl-tl << left align  below
292         // tl-bl << left align 
293         
294         if(this.el.getWidth() + xy[0] >= Roo.lib.Dom.getViewWidth()){
295             // if it goes to far to the right.. -> align left.
296             xy = this.el.getAlignToXY(el, this.align.replace('/l/g', 'r'))
297         }
298         if(xy[0] < 0){
299             // was left align - go right?
300             xy = this.el.getAlignToXY(el, this.align.replace('/r/g', 'l'))
301         }
302         
303         // goes down the bottom
304         if(this.el.getHeight() + xy[1] >= Roo.lib.Dom.getViewHeight() ||
305            xy[1]  < 0 ){
306             var a = this.align.replace('?', '').split('-');
307             xy = this.el.getAlignToXY(el, a[1]  + '-' + a[0] + '?')
308             
309         }
310         
311         this.showAt(  xy , parentMenu, false);
312     },
313      /**
314      * Displays this menu at a specific xy position
315      * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)
316      * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
317      */
318     showAt : function(xy, parentMenu, /* private: */_e){
319         this.parentMenu = parentMenu;
320         if(!this.el){
321             this.render();
322         }
323         if(_e !== false){
324             this.fireEvent("beforeshow", this);
325             //xy = this.el.adjustForConstraints(xy);
326         }
327         
328         //this.el.show();
329         this.hideMenuItems();
330         this.hidden = false;
331         this.triggerEl.addClass('open');
332         this.el.addClass('show');
333         
334         
335         
336         // reassign x when hitting right
337         
338         // reassign y when hitting bottom
339         
340         // but the list may align on trigger left or trigger top... should it be a properity?
341         
342         if(this.el.getStyle('top') != 'auto' && this.el.getStyle('top').slice(-1) != "%"){
343             this.el.setXY(xy);
344         }
345         
346         this.focus();
347         this.fireEvent("show", this);
348     },
349     
350     focus : function(){
351         return;
352         if(!this.hidden){
353             this.doFocus.defer(50, this);
354         }
355     },
356
357     doFocus : function(){
358         if(!this.hidden){
359             this.focusEl.focus();
360         }
361     },
362
363     /**
364      * Hides this menu and optionally all parent menus
365      * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false)
366      */
367     hide : function(deep)
368     {
369         if (false === this.fireEvent("beforehide", this)) {
370             Roo.log("hide canceled");
371             return;
372         }
373         this.hideMenuItems();
374         if(this.el && this.isVisible()){
375            
376             if(this.activeItem){
377                 this.activeItem.deactivate();
378                 this.activeItem = null;
379             }
380             this.triggerEl.removeClass('open');;
381             this.el.removeClass('show');
382             this.hidden = true;
383             this.fireEvent("hide", this);
384         }
385         if(deep === true && this.parentMenu){
386             this.parentMenu.hide(true);
387         }
388     },
389     
390     onTriggerClick : function(e)
391     {
392         Roo.log('trigger click');
393         
394         var target = e.getTarget();
395         
396         Roo.log(target.nodeName.toLowerCase());
397         
398         if(target.nodeName.toLowerCase() === 'i'){
399             e.preventDefault();
400         }
401         
402     },
403     
404     onTriggerPress  : function(e)
405     {
406         Roo.log('trigger press');
407         //Roo.log(e.getTarget());
408        // Roo.log(this.triggerEl.dom);
409        
410         // trigger only occurs on normal menu's -- if it's a treeview or dropdown... do not hide/show..
411         var pel = Roo.get(e.getTarget());
412         if (pel.findParent('.dropdown-menu') || pel.findParent('.treeview-menu') ) {
413             Roo.log('is treeview or dropdown?');
414             return;
415         }
416         
417         if(e.getTarget().nodeName.toLowerCase() !== 'i' && this.isLink){
418             return;
419         }
420         
421         if (this.isVisible()) {
422             Roo.log('hide');
423             this.hide();
424         } else {
425             Roo.log('show');
426              
427             this.show(this.triggerEl, this.align, false);
428         }
429         
430         if(this.stopEvent || e.getTarget().nodeName.toLowerCase() === 'i'){
431             e.stopEvent();
432         }
433         
434     },
435        
436     
437     hideMenuItems : function()
438     {
439         Roo.log("hide Menu Items");
440         if (!this.el) { 
441             return;
442         }
443         
444         this.el.select('.open',true).each(function(aa) {
445             
446             aa.removeClass('open');
447          
448         });
449     },
450     addxtypeChild : function (tree, cntr) {
451         var comp= Roo.bootstrap.Menu.superclass.addxtypeChild.call(this, tree, cntr);
452           
453         this.menuitems.add(comp);
454         return comp;
455
456     },
457     getEl : function()
458     {
459         Roo.log(this.el);
460         return this.el;
461     },
462     
463     clear : function()
464     {
465         this.getEl().dom.innerHTML = '';
466         this.menuitems.clear();
467     }
468 });
469
470  
471