Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / Separator.html
index 59dbf81..33c1ce1 100644 (file)
   </script>
 </head>
 <body onload="prettyPrint(); highlight();">
-  <pre class="prettyprint lang-js"><span id='Ext-menu-Separator-method-constructor'><span id='Ext-menu-Separator'>/**
-</span></span> * @class Ext.menu.Separator
- * @extends Ext.menu.Item
+  <pre class="prettyprint lang-js"><span id='Ext-toolbar-Separator'>/**
+</span> * @class Ext.toolbar.Separator
+ * @extends Ext.toolbar.Item
+ * A simple class that adds a vertical separator bar between toolbar items
+ * (css class:&lt;tt&gt;'x-toolbar-separator'&lt;/tt&gt;). 
  *
- * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
- * add one of these by using &quot;-&quot; in your call to add() or in your items config rather than creating one directly.
+ * {@img Ext.toolbar.Separator/Ext.toolbar.Separator.png Toolbar Separator}
  *
- * {@img Ext.menu.Separator/Ext.menu.Separator.png Ext.menu.Separator component}
+ * ## Example
  *
- * ## Code 
- *
- *     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'
- *         },{
- *             xtype: 'menuseparator'
- *         },{
- *            text: 'seperator above',
- *         },{
- *            text: 'regular item',
- *         }]
+ *     Ext.create('Ext.panel.Panel', {
+ *         title: 'Toolbar Seperator Example',
+ *         width: 300,
+ *         height: 200,
+ *         tbar : [
+ *             'Item 1',
+ *             {xtype: 'tbseparator'}, // or '-'
+ *             'Item 2'
+ *         ],
+ *         renderTo: Ext.getBody()
  *     }); 
  *
- * @xtype menuseparator
- * @markdown
- * @constructor
- * @param {Object} config The config object
  */
-Ext.define('Ext.menu.Separator', {
-    extend: 'Ext.menu.Item',
-    alias: 'widget.menuseparator',
-    
-<span id='Ext-menu-Separator-cfg-activeCls'>    /**
-</span>     * @cfg {String} activeCls @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-canActivate'>    /**
-</span>     * @cfg {Boolean} canActivate @hide
-     */
-    canActivate: false,
-    
-<span id='Ext-menu-Separator-cfg-clickHideDelay'>    /**
-</span>     * @cfg {Boolean} clickHideDelay @hide
-     */
-     
-<span id='Ext-menu-Separator-cfg-destroyMenu'>    /**
-</span>     * @cfg {Boolean} destroyMenu @hide
-     */
-     
-<span id='Ext-menu-Separator-cfg-disabledCls'>    /**
-</span>     * @cfg {Boolean} disabledCls @hide
-     */
-     
-    focusable: false,
-     
-<span id='Ext-menu-Separator-cfg-href'>    /**
-</span>     * @cfg {String} href @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-hrefTarget'>    /**
-</span>     * @cfg {String} hrefTarget @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-hideOnClick'>    /**
-</span>     * @cfg {Boolean} hideOnClick @hide
-     */
-    hideOnClick: false,
-    
-<span id='Ext-menu-Separator-cfg-icon'>    /**
-</span>     * @cfg {String} icon @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-iconCls'>    /**
-</span>     * @cfg {String} iconCls @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-menu'>    /**
-</span>     * @cfg {Mixed} menu @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-menuAlign'>    /**
-</span>     * @cfg {String} menuAlign @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-menuExpandDelay'>    /**
-</span>     * @cfg {Number} menuExpandDelay @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-menuHideDelay'>    /**
-</span>     * @cfg {Number} menuHideDelay @hide
-     */
-    
-<span id='Ext-menu-Separator-cfg-plain'>    /**
-</span>     * @cfg {Boolean} plain @hide
-     */
-    plain: true,
-    
-<span id='Ext-menu-Separator-cfg-separatorCls'>    /**
-</span>     * @cfg {String} separatorCls
-     * The CSS class used by the separator item to show the incised line.
-     * Defaults to `Ext.baseCSSPrefix + 'menu-item-separator'`.
-     * @markdown
-     */
-    separatorCls: Ext.baseCSSPrefix + 'menu-item-separator',
-    
-<span id='Ext-menu-Separator-cfg-text'>    /**
-</span>     * @cfg {String} text @hide
-     */
-    text: '&amp;#160;',
-    
-    onRender: function(ct, pos) {
-        var me = this,
-            sepCls = me.separatorCls;
-            
-        me.cls += ' ' + sepCls;
-        
-        Ext.applyIf(me.renderSelectors, {
-            itemSepEl: '.' + sepCls
-        });
-        
-        me.callParent(arguments);
-    }
+Ext.define('Ext.toolbar.Separator', {
+    extend: 'Ext.toolbar.Item',
+    alias: 'widget.tbseparator',
+    alternateClassName: 'Ext.Toolbar.Separator',
+    baseCls: Ext.baseCSSPrefix + 'toolbar-separator',
+    focusable: false
 });</pre>
 </body>
 </html>