Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / src / picker / Color.js
diff --git a/src/picker/Color.js b/src/picker/Color.js
new file mode 100644 (file)
index 0000000..1abb2d3
--- /dev/null
@@ -0,0 +1,215 @@
+/**
+ * @class Ext.picker.Color
+ * @extends Ext.Component
+ * <p>ColorPicker provides a simple color palette for choosing colors. The picker can be rendered to any container.
+ * The available default to a standard 40-color palette; this can be customized with the {@link #colors} config.</p>
+ * <p>Typically you will need to implement a handler function to be notified when the user chooses a color from the
+ * picker; you can register the handler using the {@link #select} event, or by implementing the {@link #handler}
+ * method.</p>
+ * <p>Here's an example of typical usage:</p>
+ * <pre><code>var cp = new Ext.picker.Color({
+    value: '993300',  // initial selected color
+    renderTo: 'my-div'
+});
+
+cp.on('select', function(picker, selColor){
+    // do something with selColor
+});
+</code></pre>
+ * {@img Ext.picker.Color/Ext.picker.Color.png Ext.picker.Color component}
+ *
+ * @constructor
+ * Create a new ColorPicker
+ * @param {Object} config The config object
+ * 
+ * @xtype colorpicker
+ */
+Ext.define('Ext.picker.Color', {
+    extend: 'Ext.Component',
+    requires: 'Ext.XTemplate',
+    alias: 'widget.colorpicker',
+    alternateClassName: 'Ext.ColorPalette',
+    
+    /**
+     * @cfg {String} componentCls
+     * The CSS class to apply to the containing element (defaults to 'x-color-picker')
+     */
+    componentCls : Ext.baseCSSPrefix + 'color-picker',
+    
+    /**
+     * @cfg {String} selectedCls
+     * The CSS class to apply to the selected element
+     */
+    selectedCls: Ext.baseCSSPrefix + 'color-picker-selected',
+    
+    /**
+     * @cfg {String} value
+     * The initial color to highlight (should be a valid 6-digit color hex code without the # symbol).  Note that
+     * the hex codes are case-sensitive.
+     */
+    value : null,
+    
+    /**
+     * @cfg {String} clickEvent
+     * The DOM event that will cause a color to be selected. This can be any valid event name (dblclick, contextmenu).
+     * Defaults to <tt>'click'</tt>.
+     */
+    clickEvent :'click',
+
+    /**
+     * @cfg {Boolean} allowReselect If set to true then reselecting a color that is already selected fires the {@link #select} event
+     */
+    allowReselect : false,
+
+    /**
+     * <p>An array of 6-digit color hex code strings (without the # symbol).  This array can contain any number
+     * of colors, and each hex code should be unique.  The width of the picker is controlled via CSS by adjusting
+     * the width property of the 'x-color-picker' class (or assigning a custom class), so you can balance the number
+     * of colors with the width setting until the box is symmetrical.</p>
+     * <p>You can override individual colors if needed:</p>
+     * <pre><code>
+var cp = new Ext.picker.Color();
+cp.colors[0] = 'FF0000';  // change the first box to red
+</code></pre>
+
+Or you can provide a custom array of your own for complete control:
+<pre><code>
+var cp = new Ext.picker.Color();
+cp.colors = ['000000', '993300', '333300'];
+</code></pre>
+     * @type Array
+     */
+    colors : [
+        '000000', '993300', '333300', '003300', '003366', '000080', '333399', '333333',
+        '800000', 'FF6600', '808000', '008000', '008080', '0000FF', '666699', '808080',
+        'FF0000', 'FF9900', '99CC00', '339966', '33CCCC', '3366FF', '800080', '969696',
+        'FF00FF', 'FFCC00', 'FFFF00', '00FF00', '00FFFF', '00CCFF', '993366', 'C0C0C0',
+        'FF99CC', 'FFCC99', 'FFFF99', 'CCFFCC', 'CCFFFF', '99CCFF', 'CC99FF', 'FFFFFF'
+    ],
+
+    /**
+     * @cfg {Function} handler
+     * Optional. A function that will handle the select event of this picker.
+     * The handler is passed the following parameters:<div class="mdetail-params"><ul>
+     * <li><code>picker</code> : ColorPicker<div class="sub-desc">The {@link #picker Ext.picker.Color}.</div></li>
+     * <li><code>color</code> : String<div class="sub-desc">The 6-digit color hex code (without the # symbol).</div></li>
+     * </ul></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 ColorPicker instance.
+     */
+    
+    colorRe: /(?:^|\s)color-(.{6})(?:\s|$)/,
+    
+    constructor: function() {
+        this.renderTpl = Ext.create('Ext.XTemplate', '<tpl for="colors"><a href="#" class="color-{.}" hidefocus="on"><em><span style="background:#{.}" unselectable="on">&#160;</span></em></a></tpl>');
+        this.callParent(arguments);
+    },
+    
+    // private
+    initComponent : function(){
+        var me = this;
+        
+        this.callParent(arguments);
+        me.addEvents(
+            /**
+             * @event select
+             * Fires when a color is selected
+             * @param {Ext.picker.Color} this
+             * @param {String} color The 6-digit color hex code (without the # symbol)
+             */
+            'select'
+        );
+
+        if (me.handler) {
+            me.on('select', me.handler, me.scope, true);
+        }
+    },
+
+
+    // private
+    onRender : function(container, position){
+        var me = this,
+            clickEvent = me.clickEvent;
+            
+        Ext.apply(me.renderData, {
+            itemCls: me.itemCls,
+            colors: me.colors    
+        });
+        this.callParent(arguments);
+
+        me.mon(me.el, clickEvent, me.handleClick, me, {delegate: 'a'});
+        // always stop following the anchors
+        if(clickEvent != 'click'){
+            me.mon(me.el, 'click', Ext.emptyFn, me, {delegate: 'a', stopEvent: true});
+        }
+    },
+
+    // private
+    afterRender : function(){
+        var me = this,
+            value;
+            
+        this.callParent(arguments);
+        if (me.value) {
+            value = me.value;
+            me.value = null;
+            me.select(value, true);
+        }
+    },
+
+    // private
+    handleClick : function(event, target){
+        var me = this,
+            color;
+            
+        event.stopEvent();
+        if (!me.disabled) {
+            color = target.className.match(me.colorRe)[1];
+            me.select(color.toUpperCase());
+        }
+    },
+
+    /**
+     * Selects the specified color in the picker (fires the {@link #select} event)
+     * @param {String} color A valid 6-digit color hex code (# will be stripped if included)
+     * @param {Boolean} suppressEvent (optional) True to stop the select event from firing. Defaults to <tt>false</tt>.
+     */
+    select : function(color, suppressEvent){
+        
+        var me = this,
+            selectedCls = me.selectedCls,
+            value = me.value,
+            el;
+            
+        color = color.replace('#', '');
+        if (!me.rendered) {
+            me.value = color;
+            return;
+        }
+        
+        
+        if (color != value || me.allowReselect) {
+            el = me.el;
+
+            if (me.value) {
+                el.down('a.color-' + value).removeCls(selectedCls);
+            }
+            el.down('a.color-' + color).addCls(selectedCls);
+            me.value = color;
+            if (suppressEvent !== true) {
+                me.fireEvent('select', me, color);
+            }
+        }
+    },
+    
+    /**
+     * Get the currently selected color value.
+     * @return {String} value The selected value. Null if nothing is selected.
+     */
+    getValue: function(){
+        return this.value || null;
+    }
+});