Upgrade to ExtJS 4.0.1 - Released 05/18/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="../prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../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-method-constructor'><span id='Ext-menu-Separator'>/**
19 </span></span> * @class Ext.menu.Separator
20  * @extends Ext.menu.Item
21  *
22  * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
23  * add one of these by using &quot;-&quot; in your call to add() or in your items config rather than creating one directly.
24  *
25  * {@img Ext.menu.Separator/Ext.menu.Separator.png Ext.menu.Separator component}
26  *
27  * ## Code 
28  *
29  *     Ext.create('Ext.menu.Menu', {
30  *         width: 100,
31  *         height: 100,
32  *         floating: false,  // usually you want this set to True (default)
33  *         renderTo: Ext.getBody(),  // usually rendered by it's containing component
34  *         items: [{
35  *             text: 'icon item',
36  *             iconCls: 'add16'
37  *         },{
38  *             xtype: 'menuseparator'
39  *         },{
40  *            text: 'seperator above',
41  *         },{
42  *            text: 'regular item',
43  *         }]
44  *     }); 
45  *
46  * @xtype menuseparator
47  * @markdown
48  * @constructor
49  * @param {Object} config The config object
50  */
51 Ext.define('Ext.menu.Separator', {
52     extend: 'Ext.menu.Item',
53     alias: 'widget.menuseparator',
54     
55 <span id='Ext-menu-Separator-cfg-activeCls'>    /**
56 </span>     * @cfg {String} activeCls @hide
57      */
58     
59 <span id='Ext-menu-Separator-cfg-canActivate'>    /**
60 </span>     * @cfg {Boolean} canActivate @hide
61      */
62     canActivate: false,
63     
64 <span id='Ext-menu-Separator-cfg-clickHideDelay'>    /**
65 </span>     * @cfg {Boolean} clickHideDelay @hide
66      */
67      
68 <span id='Ext-menu-Separator-cfg-destroyMenu'>    /**
69 </span>     * @cfg {Boolean} destroyMenu @hide
70      */
71      
72 <span id='Ext-menu-Separator-cfg-disabledCls'>    /**
73 </span>     * @cfg {Boolean} disabledCls @hide
74      */
75      
76     focusable: false,
77      
78 <span id='Ext-menu-Separator-cfg-href'>    /**
79 </span>     * @cfg {String} href @hide
80      */
81     
82 <span id='Ext-menu-Separator-cfg-hrefTarget'>    /**
83 </span>     * @cfg {String} hrefTarget @hide
84      */
85     
86 <span id='Ext-menu-Separator-cfg-hideOnClick'>    /**
87 </span>     * @cfg {Boolean} hideOnClick @hide
88      */
89     hideOnClick: false,
90     
91 <span id='Ext-menu-Separator-cfg-icon'>    /**
92 </span>     * @cfg {String} icon @hide
93      */
94     
95 <span id='Ext-menu-Separator-cfg-iconCls'>    /**
96 </span>     * @cfg {String} iconCls @hide
97      */
98     
99 <span id='Ext-menu-Separator-cfg-menu'>    /**
100 </span>     * @cfg {Mixed} menu @hide
101      */
102     
103 <span id='Ext-menu-Separator-cfg-menuAlign'>    /**
104 </span>     * @cfg {String} menuAlign @hide
105      */
106     
107 <span id='Ext-menu-Separator-cfg-menuExpandDelay'>    /**
108 </span>     * @cfg {Number} menuExpandDelay @hide
109      */
110     
111 <span id='Ext-menu-Separator-cfg-menuHideDelay'>    /**
112 </span>     * @cfg {Number} menuHideDelay @hide
113      */
114     
115 <span id='Ext-menu-Separator-cfg-plain'>    /**
116 </span>     * @cfg {Boolean} plain @hide
117      */
118     plain: true,
119     
120 <span id='Ext-menu-Separator-cfg-separatorCls'>    /**
121 </span>     * @cfg {String} separatorCls
122      * The CSS class used by the separator item to show the incised line.
123      * Defaults to `Ext.baseCSSPrefix + 'menu-item-separator'`.
124      * @markdown
125      */
126     separatorCls: Ext.baseCSSPrefix + 'menu-item-separator',
127     
128 <span id='Ext-menu-Separator-cfg-text'>    /**
129 </span>     * @cfg {String} text @hide
130      */
131     text: '&amp;#160;',
132     
133     onRender: function(ct, pos) {
134         var me = this,
135             sepCls = me.separatorCls;
136             
137         me.cls += ' ' + sepCls;
138         
139         Ext.applyIf(me.renderSelectors, {
140             itemSepEl: '.' + sepCls
141         });
142         
143         me.callParent(arguments);
144     }
145 });</pre>
146 </body>
147 </html>