Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Separator.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><span id='Ext-menu-Separator'>/**
19 </span> * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
20  * add one of these by using &quot;-&quot; in your call to add() or in your items config rather than creating one directly.
21  *
22  *     @example
23  *     Ext.create('Ext.menu.Menu', {
24  *         width: 100,
25  *         height: 100,
26  *         floating: false,  // usually you want this set to True (default)
27  *         renderTo: Ext.getBody(),  // usually rendered by it's containing component
28  *         items: [{
29  *             text: 'icon item',
30  *             iconCls: 'add16'
31  *         },{
32  *             xtype: 'menuseparator'
33  *         },{
34  *            text: 'seperator above',
35  *         },{
36  *            text: 'regular item',
37  *         }]
38  *     });
39  */
40 Ext.define('Ext.menu.Separator', {
41     extend: 'Ext.menu.Item',
42     alias: 'widget.menuseparator',
43
44 <span id='Ext-menu-Separator-cfg-activeCls'>    /**
45 </span>     * @cfg {String} activeCls @hide
46      */
47
48 <span id='Ext-menu-Separator-cfg-canActivate'>    /**
49 </span>     * @cfg {Boolean} canActivate @hide
50      */
51     canActivate: false,
52
53 <span id='Ext-menu-Separator-cfg-clickHideDelay'>    /**
54 </span>     * @cfg {Boolean} clickHideDelay @hide
55      */
56
57 <span id='Ext-menu-Separator-cfg-destroyMenu'>    /**
58 </span>     * @cfg {Boolean} destroyMenu @hide
59      */
60
61 <span id='Ext-menu-Separator-cfg-disabledCls'>    /**
62 </span>     * @cfg {Boolean} disabledCls @hide
63      */
64
65     focusable: false,
66
67 <span id='Ext-menu-Separator-cfg-href'>    /**
68 </span>     * @cfg {String} href @hide
69      */
70
71 <span id='Ext-menu-Separator-cfg-hrefTarget'>    /**
72 </span>     * @cfg {String} hrefTarget @hide
73      */
74
75 <span id='Ext-menu-Separator-cfg-hideOnClick'>    /**
76 </span>     * @cfg {Boolean} hideOnClick @hide
77      */
78     hideOnClick: false,
79
80 <span id='Ext-menu-Separator-cfg-icon'>    /**
81 </span>     * @cfg {String} icon @hide
82      */
83
84 <span id='Ext-menu-Separator-cfg-iconCls'>    /**
85 </span>     * @cfg {String} iconCls @hide
86      */
87
88 <span id='Ext-menu-Separator-cfg-menu'>    /**
89 </span>     * @cfg {Object} menu @hide
90      */
91
92 <span id='Ext-menu-Separator-cfg-menuAlign'>    /**
93 </span>     * @cfg {String} menuAlign @hide
94      */
95
96 <span id='Ext-menu-Separator-cfg-menuExpandDelay'>    /**
97 </span>     * @cfg {Number} menuExpandDelay @hide
98      */
99
100 <span id='Ext-menu-Separator-cfg-menuHideDelay'>    /**
101 </span>     * @cfg {Number} menuHideDelay @hide
102      */
103
104 <span id='Ext-menu-Separator-cfg-plain'>    /**
105 </span>     * @cfg {Boolean} plain @hide
106      */
107     plain: true,
108
109 <span id='Ext-menu-Separator-cfg-separatorCls'>    /**
110 </span>     * @cfg {String} separatorCls
111      * The CSS class used by the separator item to show the incised line.
112      * Defaults to `Ext.baseCSSPrefix + 'menu-item-separator'`.
113      */
114     separatorCls: Ext.baseCSSPrefix + 'menu-item-separator',
115
116 <span id='Ext-menu-Separator-cfg-text'>    /**
117 </span>     * @cfg {String} text @hide
118      */
119     text: '&amp;#160;',
120
121     onRender: function(ct, pos) {
122         var me = this,
123             sepCls = me.separatorCls;
124
125         me.cls += ' ' + sepCls;
126
127         me.callParent(arguments);
128     }
129 });</pre>
130 </body>
131 </html>