Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / Color.html
diff --git a/docs/source/Color.html b/docs/source/Color.html
new file mode 100644 (file)
index 0000000..03bf64c
--- /dev/null
@@ -0,0 +1,216 @@
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-picker.Color-method-constructor'><span id='Ext-picker.Color'>/**
+</span></span> * @class Ext.picker.Color
+ * @extends Ext.Component
+ * &lt;p&gt;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.&lt;/p&gt;
+ * &lt;p&gt;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.&lt;/p&gt;
+ * &lt;p&gt;Here's an example of typical usage:&lt;/p&gt;
+ * &lt;pre&gt;&lt;code&gt;var cp = new Ext.picker.Color({
+    value: '993300',  // initial selected color
+    renderTo: 'my-div'
+});
+
+cp.on('select', function(picker, selColor){
+    // do something with selColor
+});
+&lt;/code&gt;&lt;/pre&gt;
+ * {@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',
+    
+<span id='Ext-picker.Color-cfg-componentCls'>    /**
+</span>     * @cfg {String} componentCls
+     * The CSS class to apply to the containing element (defaults to 'x-color-picker')
+     */
+    componentCls : Ext.baseCSSPrefix + 'color-picker',
+    
+<span id='Ext-picker.Color-cfg-selectedCls'>    /**
+</span>     * @cfg {String} selectedCls
+     * The CSS class to apply to the selected element
+     */
+    selectedCls: Ext.baseCSSPrefix + 'color-picker-selected',
+    
+<span id='Ext-picker.Color-cfg-value'>    /**
+</span>     * @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,
+    
+<span id='Ext-picker.Color-cfg-clickEvent'>    /**
+</span>     * @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 &lt;tt&gt;'click'&lt;/tt&gt;.
+     */
+    clickEvent :'click',
+
+<span id='Ext-picker.Color-cfg-allowReselect'>    /**
+</span>     * @cfg {Boolean} allowReselect If set to true then reselecting a color that is already selected fires the {@link #select} event
+     */
+    allowReselect : false,
+
+<span id='Ext-picker.Color-property-colors'>    /**
+</span>     * &lt;p&gt;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.&lt;/p&gt;
+     * &lt;p&gt;You can override individual colors if needed:&lt;/p&gt;
+     * &lt;pre&gt;&lt;code&gt;
+var cp = new Ext.picker.Color();
+cp.colors[0] = 'FF0000';  // change the first box to red
+&lt;/code&gt;&lt;/pre&gt;
+
+Or you can provide a custom array of your own for complete control:
+&lt;pre&gt;&lt;code&gt;
+var cp = new Ext.picker.Color();
+cp.colors = ['000000', '993300', '333300'];
+&lt;/code&gt;&lt;/pre&gt;
+     * @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'
+    ],
+
+<span id='Ext-picker.Color-cfg-handler'>    /**
+</span>     * @cfg {Function} handler
+     * Optional. A function that will handle the select event of this picker.
+     * The handler is passed the following parameters:&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
+     * &lt;li&gt;&lt;code&gt;picker&lt;/code&gt; : ColorPicker&lt;div class=&quot;sub-desc&quot;&gt;The {@link #picker Ext.picker.Color}.&lt;/div&gt;&lt;/li&gt;
+     * &lt;li&gt;&lt;code&gt;color&lt;/code&gt; : String&lt;div class=&quot;sub-desc&quot;&gt;The 6-digit color hex code (without the # symbol).&lt;/div&gt;&lt;/li&gt;
+     * &lt;/ul&gt;&lt;/div&gt;
+     */
+<span id='Ext-picker.Color-cfg-scope'>    /**
+</span>     * @cfg {Object} scope
+     * The scope (&lt;tt&gt;&lt;b&gt;this&lt;/b&gt;&lt;/tt&gt; reference) in which the &lt;code&gt;{@link #handler}&lt;/code&gt;
+     * function will be called.  Defaults to this ColorPicker instance.
+     */
+    
+    colorRe: /(?:^|\s)color-(.{6})(?:\s|$)/,
+    
+    constructor: function() {
+        this.renderTpl = Ext.create('Ext.XTemplate', '&lt;tpl for=&quot;colors&quot;&gt;&lt;a href=&quot;#&quot; class=&quot;color-{.}&quot; hidefocus=&quot;on&quot;&gt;&lt;em&gt;&lt;span style=&quot;background:#{.}&quot; unselectable=&quot;on&quot;&gt;&amp;#160;&lt;/span&gt;&lt;/em&gt;&lt;/a&gt;&lt;/tpl&gt;');
+        this.callParent(arguments);
+    },
+    
+    // private
+    initComponent : function(){
+        var me = this;
+        
+        this.callParent(arguments);
+        me.addEvents(
+<span id='Ext-picker.Color-event-select'>            /**
+</span>             * @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());
+        }
+    },
+
+<span id='Ext-picker.Color-method-select'>    /**
+</span>     * 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 &lt;tt&gt;false&lt;/tt&gt;.
+     */
+    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);
+            }
+        }
+    },
+    
+<span id='Ext-picker.Color-method-getValue'>    /**
+</span>     * Get the currently selected color value.
+     * @return {String} value The selected value. Null if nothing is selected.
+     */
+    getValue: function(){
+        return this.value || null;
+    }
+});
+</pre></pre></body></html>
\ No newline at end of file