Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / Separator.html
index 393eb65..59dbf81 100644 (file)
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.menu.Separator"></div>/**
- * @class Ext.menu.Separator
- * @extends Ext.menu.BaseItem
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </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
+ *
  * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
- * add one of these by using "-" in you call to add() or in your items config rather than creating one directly.
- * @constructor
- * @param {Object} config Configuration options
+ * 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.menu.Separator/Ext.menu.Separator.png Ext.menu.Separator component}
+ *
+ * ## 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',
+ *         }]
+ *     }); 
+ *
  * @xtype menuseparator
+ * @markdown
+ * @constructor
+ * @param {Object} config The config object
  */
-Ext.menu.Separator = function(config){
-    Ext.menu.Separator.superclass.constructor.call(this, config);
-};
-
-Ext.extend(Ext.menu.Separator, Ext.menu.BaseItem, {
-    <div id="cfg-Ext.menu.Separator-itemCls"></div>/**
-     * @cfg {String} itemCls The default CSS class to use for separators (defaults to "x-menu-sep")
-     */
-    itemCls : "x-menu-sep",
-    <div id="cfg-Ext.menu.Separator-hideOnClick"></div>/**
-     * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false)
-     */
-    hideOnClick : false,
-    
-    <div id="cfg-Ext.menu.Separator-activeClass"></div>/** 
-     * @cfg {String} activeClass
-     * @hide 
-     */
-    activeClass: '',
-
-    // private
-    onRender : function(li){
-        var s = document.createElement("span");
-        s.className = this.itemCls;
-        s.innerHTML = "&#160;";
-        this.el = s;
-        li.addClass("x-menu-sep-li");
-        Ext.menu.Separator.superclass.onRender.apply(this, arguments);
+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.reg('menuseparator', Ext.menu.Separator);</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+});</pre>
+</body>
+</html>