Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / source / ColorMenu.html
index 8830d64..a8eb381 100644 (file)
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \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.ColorMenu"></div>/**\r
- * @class Ext.menu.ColorMenu\r
- * @extends Ext.menu.Menu\r
- * <p>A menu containing a {@link Ext.ColorPalette} Component.</p>\r
- * <p>Notes:</p><div class="mdetail-params"><ul>\r
- * <li>Although not listed here, the <b>constructor</b> for this class\r
- * accepts all of the configuration options of <b>{@link Ext.ColorPalette}</b>.</li>\r
- * <li>If subclassing ColorMenu, any configuration options for the ColorPalette must be\r
- * applied to the <tt><b>initialConfig</b></tt> property of the ColorMenu.\r
- * Applying {@link Ext.ColorPalette ColorPalette} configuration settings to\r
- * <b><tt>this</tt></b> will <b>not</b> affect the ColorPalette's configuration.</li>\r
- * </ul></div> * \r
- * @xtype colormenu\r
- */\r
- Ext.menu.ColorMenu = Ext.extend(Ext.menu.Menu, {\r
-    <div id="cfg-Ext.menu.ColorMenu-enableScrolling"></div>/** \r
-     * @cfg {Boolean} enableScrolling\r
-     * @hide \r
-     */\r
-    enableScrolling : false,\r
-    <div id="cfg-Ext.menu.ColorMenu-handler"></div>/**\r
-     * @cfg {Function} handler\r
-     * Optional. A function that will handle the select event of this menu.\r
-     * The handler is passed the following parameters:<div class="mdetail-params"><ul>\r
-     * <li><code>palette</code> : ColorPalette<div class="sub-desc">The {@link #palette Ext.ColorPalette}.</div></li>\r
-     * <li><code>color</code> : String<div class="sub-desc">The 6-digit color hex code (without the # symbol).</div></li>\r
-     * </ul></div>\r
-     */\r
-    <div id="cfg-Ext.menu.ColorMenu-scope"></div>/**\r
-     * @cfg {Object} scope\r
-     * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>\r
-     * function will be called.  Defaults to this ColorMenu instance.\r
-     */    \r
-    \r
-    <div id="cfg-Ext.menu.ColorMenu-hideOnClick"></div>/** \r
-     * @cfg {Boolean} hideOnClick\r
-     * False to continue showing the menu after a color is selected, defaults to true.\r
-     */\r
-    hideOnClick : true,\r
-    \r
-    cls : 'x-color-menu',\r
-    \r
-    <div id="cfg-Ext.menu.ColorMenu-paletteId"></div>/** \r
-     * @cfg {String} paletteId\r
-     * An id to assign to the underlying color palette. Defaults to <tt>null</tt>.\r
-     */\r
-    paletteId : null,\r
-    \r
-    <div id="cfg-Ext.menu.ColorMenu-maxHeight"></div>/** \r
-     * @cfg {Number} maxHeight\r
-     * @hide \r
-     */\r
-    <div id="cfg-Ext.menu.ColorMenu-scrollIncrement"></div>/** \r
-     * @cfg {Number} scrollIncrement\r
-     * @hide \r
-     */\r
-    <div id="prop-Ext.menu.ColorMenu-palette"></div>/**\r
-     * @property palette\r
-     * @type ColorPalette\r
-     * The {@link Ext.ColorPalette} instance for this ColorMenu\r
-     */\r
-    \r
-    \r
-    <div id="event-Ext.menu.ColorMenu-click"></div>/**\r
-     * @event click\r
-     * @hide\r
-     */\r
-    \r
-    <div id="event-Ext.menu.ColorMenu-itemclick"></div>/**\r
-     * @event itemclick\r
-     * @hide\r
-     */\r
-    \r
-    initComponent : function(){\r
-        Ext.apply(this, {\r
-            plain: true,\r
-            showSeparator: false,\r
-            items: this.palette = new Ext.ColorPalette(Ext.applyIf({\r
-                id: this.paletteId\r
-            }, this.initialConfig))\r
-        });\r
-        this.palette.purgeListeners();\r
-        Ext.menu.ColorMenu.superclass.initComponent.call(this);\r
-        <div id="event-Ext.menu.ColorMenu-select"></div>/**\r
-         * @event select\r
-         * Fires when a color is selected from the {@link #palette Ext.ColorPalette}\r
-         * @param {Ext.ColorPalette} palette The {@link #palette Ext.ColorPalette}\r
-            * @param {String} color The 6-digit color hex code (without the # symbol)\r
-         */\r
-        this.relayEvents(this.palette, ['select']);\r
-        this.on('select', this.menuHide, this);\r
-        if(this.handler){\r
-            this.on('select', this.handler, this.scope || this);\r
-        }\r
-    },\r
-\r
-    menuHide : function(){\r
-        if(this.hideOnClick){\r
-            this.hide(true);\r
-        }\r
-    }\r
-});\r
-Ext.reg('colormenu', Ext.menu.ColorMenu);\r
-</pre>    \r
-</body>\r
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.2.0
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.menu.ColorMenu"></div>/**
+ * @class Ext.menu.ColorMenu
+ * @extends Ext.menu.Menu
+ * <p>A menu containing a {@link Ext.ColorPalette} Component.</p>
+ * <p>Notes:</p><div class="mdetail-params"><ul>
+ * <li>Although not listed here, the <b>constructor</b> for this class
+ * accepts all of the configuration options of <b>{@link Ext.ColorPalette}</b>.</li>
+ * <li>If subclassing ColorMenu, any configuration options for the ColorPalette must be
+ * applied to the <tt><b>initialConfig</b></tt> property of the ColorMenu.
+ * Applying {@link Ext.ColorPalette ColorPalette} configuration settings to
+ * <b><tt>this</tt></b> will <b>not</b> affect the ColorPalette's configuration.</li>
+ * </ul></div> * 
+ * @xtype colormenu
+ */
+ Ext.menu.ColorMenu = Ext.extend(Ext.menu.Menu, {
+    <div id="cfg-Ext.menu.ColorMenu-enableScrolling"></div>/** 
+     * @cfg {Boolean} enableScrolling
+     * @hide 
+     */
+    enableScrolling : false,
+    <div id="cfg-Ext.menu.ColorMenu-handler"></div>/**
+     * @cfg {Function} handler
+     * Optional. A function that will handle the select event of this menu.
+     * The handler is passed the following parameters:<div class="mdetail-params"><ul>
+     * <li><code>palette</code> : ColorPalette<div class="sub-desc">The {@link #palette Ext.ColorPalette}.</div></li>
+     * <li><code>color</code> : String<div class="sub-desc">The 6-digit color hex code (without the # symbol).</div></li>
+     * </ul></div>
+     */
+    <div id="cfg-Ext.menu.ColorMenu-scope"></div>/**
+     * @cfg {Object} scope
+     * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>
+     * function will be called.  Defaults to this ColorMenu instance.
+     */    
+    
+    <div id="cfg-Ext.menu.ColorMenu-hideOnClick"></div>/** 
+     * @cfg {Boolean} hideOnClick
+     * False to continue showing the menu after a color is selected, defaults to true.
+     */
+    hideOnClick : true,
+    
+    cls : 'x-color-menu',
+    
+    <div id="cfg-Ext.menu.ColorMenu-paletteId"></div>/** 
+     * @cfg {String} paletteId
+     * An id to assign to the underlying color palette. Defaults to <tt>null</tt>.
+     */
+    paletteId : null,
+    
+    <div id="cfg-Ext.menu.ColorMenu-maxHeight"></div>/** 
+     * @cfg {Number} maxHeight
+     * @hide 
+     */
+    <div id="cfg-Ext.menu.ColorMenu-scrollIncrement"></div>/** 
+     * @cfg {Number} scrollIncrement
+     * @hide 
+     */
+    <div id="prop-Ext.menu.ColorMenu-palette"></div>/**
+     * @property palette
+     * @type ColorPalette
+     * The {@link Ext.ColorPalette} instance for this ColorMenu
+     */
+    
+    
+    <div id="event-Ext.menu.ColorMenu-click"></div>/**
+     * @event click
+     * @hide
+     */
+    
+    <div id="event-Ext.menu.ColorMenu-itemclick"></div>/**
+     * @event itemclick
+     * @hide
+     */
+    
+    initComponent : function(){
+        Ext.apply(this, {
+            plain: true,
+            showSeparator: false,
+            items: this.palette = new Ext.ColorPalette(Ext.applyIf({
+                id: this.paletteId
+            }, this.initialConfig))
+        });
+        this.palette.purgeListeners();
+        Ext.menu.ColorMenu.superclass.initComponent.call(this);
+        <div id="event-Ext.menu.ColorMenu-select"></div>/**
+         * @event select
+         * Fires when a color is selected from the {@link #palette Ext.ColorPalette}
+         * @param {Ext.ColorPalette} palette The {@link #palette Ext.ColorPalette}
+            * @param {String} color The 6-digit color hex code (without the # symbol)
+         */
+        this.relayEvents(this.palette, ['select']);
+        this.on('select', this.menuHide, this);
+        if(this.handler){
+            this.on('select', this.handler, this.scope || this);
+        }
+    },
+
+    menuHide : function(){
+        if(this.hideOnClick){
+            this.hide(true);
+        }
+    }
+});
+Ext.reg('colormenu', Ext.menu.ColorMenu);
+</pre>    
+</body>
 </html>
\ No newline at end of file