major doc changes
[roojs1] / docs / src / Roo_menu_Adapter.js.html
1 <html><head><title>Roo/menu/Adapter.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * &lt;script type=&quot;text/javascript&quot;&gt;
10  */
11
12 /**
13  * @class Roo.menu.Adapter
14  * @extends Roo.menu.BaseItem
15  * @abstract
16  * A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu.
17  * It provides basic rendering, activation management and enable/disable logic required to work in menus.
18  * @constructor
19  * Creates a new Adapter
20  * @param {Object} config Configuration options
21  */
22 </span><span class="jsdoc-var">Roo.menu.Adapter </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">component</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
23     </span><span class="jsdoc-var">Roo.menu.Adapter.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
24     </span><span class="jsdoc-var">this.component </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">component</span><span class="jsdoc-syntax">;
25 };
26 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.menu.Adapter</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.menu.BaseItem</span><span class="jsdoc-syntax">, {
27     </span><span class="jsdoc-comment">// private
28     </span><span class="jsdoc-var">canActivate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
29
30     </span><span class="jsdoc-comment">// private
31     </span><span class="jsdoc-var">onRender </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">container</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">position</span><span class="jsdoc-syntax">){
32         </span><span class="jsdoc-var">this.component.render</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">container</span><span class="jsdoc-syntax">);
33         </span><span class="jsdoc-var">this.el </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.component.getEl</span><span class="jsdoc-syntax">();
34     },
35
36     </span><span class="jsdoc-comment">// private
37     </span><span class="jsdoc-var">activate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
38         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.disabled</span><span class="jsdoc-syntax">){
39             </span><span class="jsdoc-keyword">return false</span><span class="jsdoc-syntax">;
40         }
41         </span><span class="jsdoc-var">this.component.focus</span><span class="jsdoc-syntax">();
42         </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;activate&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
43         </span><span class="jsdoc-keyword">return true</span><span class="jsdoc-syntax">;
44     },
45
46     </span><span class="jsdoc-comment">// private
47     </span><span class="jsdoc-var">deactivate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
48         </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;deactivate&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
49     },
50
51     </span><span class="jsdoc-comment">// private
52     </span><span class="jsdoc-var">disable </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
53         </span><span class="jsdoc-var">this.component.disable</span><span class="jsdoc-syntax">();
54         </span><span class="jsdoc-var">Roo.menu.Adapter.superclass.disable.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
55     },
56
57     </span><span class="jsdoc-comment">// private
58     </span><span class="jsdoc-var">enable </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
59         </span><span class="jsdoc-var">this.component.enable</span><span class="jsdoc-syntax">();
60         </span><span class="jsdoc-var">Roo.menu.Adapter.superclass.enable.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
61     }
62 });</span></code></body></html>