Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / ColorMenu.html
diff --git a/docs/source/ColorMenu.html b/docs/source/ColorMenu.html
new file mode 100644 (file)
index 0000000..c15b62d
--- /dev/null
@@ -0,0 +1,103 @@
+<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.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
+    <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(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>
\ No newline at end of file