docs/source/Color.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-picker-Color'>/**
  19 </span> * Color picker provides a simple color palette for choosing colors. The picker can be rendered to any container. The
  20  * available default to a standard 40-color palette; this can be customized with the {@link #colors} config.
  21  *
  22  * Typically you will need to implement a handler function to be notified when the user chooses a color from the picker;
  23  * you can register the handler using the {@link #select} event, or by implementing the {@link #handler} method.
  24  *
  25  *     @example
  26  *     Ext.create('Ext.picker.Color', {
  27  *         value: '993300',  // initial selected color
  28  *         renderTo: Ext.getBody(),
  29  *         listeners: {
  30  *             select: function(picker, selColor) {
  31  *                 alert(selColor);
  32  *             }
  33  *         }
  34  *     });
  35  */
  36 Ext.define('Ext.picker.Color', {
  37     extend: 'Ext.Component',
  38     requires: 'Ext.XTemplate',
  39     alias: 'widget.colorpicker',
  40     alternateClassName: 'Ext.ColorPalette',
  41
  42 <span id='Ext-picker-Color-cfg-componentCls'>    /**
  43 </span>     * @cfg {String} [componentCls='x-color-picker']
  44      * The CSS class to apply to the containing element.
  45      */
  46     componentCls : Ext.baseCSSPrefix + 'color-picker',
  47
  48 <span id='Ext-picker-Color-cfg-selectedCls'>    /**
  49 </span>     * @cfg {String} [selectedCls='x-color-picker-selected']
  50      * The CSS class to apply to the selected element
  51      */
  52     selectedCls: Ext.baseCSSPrefix + 'color-picker-selected',
  53
  54 <span id='Ext-picker-Color-cfg-value'>    /**
  55 </span>     * @cfg {String} value
  56      * The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that the hex
  57      * codes are case-sensitive.
  58      */
  59     value : null,
  60
  61 <span id='Ext-picker-Color-cfg-clickEvent'>    /**
  62 </span>     * @cfg {String} clickEvent
  63      * The DOM event that will cause a color to be selected. This can be any valid event name (dblclick, contextmenu).
  64      */
  65     clickEvent :'click',
  66
  67 <span id='Ext-picker-Color-cfg-allowReselect'>    /**
  68 </span>     * @cfg {Boolean} allowReselect
  69      * If set to true then reselecting a color that is already selected fires the {@link #select} event
  70      */
  71     allowReselect : false,
  72
  73 <span id='Ext-picker-Color-property-colors'>    /**
  74 </span>     * @property {String[]} colors
  75      * An array of 6-digit color hex code strings (without the # symbol). This array can contain any number of colors,
  76      * and each hex code should be unique. The width of the picker is controlled via CSS by adjusting the width property
  77      * of the 'x-color-picker' class (or assigning a custom class), so you can balance the number of colors with the
  78      * width setting until the box is symmetrical.
  79      *
  80      * You can override individual colors if needed:
  81      *
  82      *     var cp = new Ext.picker.Color();
  83      *     cp.colors[0] = 'FF0000';  // change the first box to red
  84      *
  85      * Or you can provide a custom array of your own for complete control:
  86      *
  87      *     var cp = new Ext.picker.Color();
  88      *     cp.colors = ['000000', '993300', '333300'];
  89      */
  90     colors : [
  91         '000000', '993300', '333300', '003300', '003366', '000080', '333399', '333333',
  92         '800000', 'FF6600', '808000', '008000', '008080', '0000FF', '666699', '808080',
  93         'FF0000', 'FF9900', '99CC00', '339966', '33CCCC', '3366FF', '800080', '969696',
  94         'FF00FF', 'FFCC00', 'FFFF00', '00FF00', '00FFFF', '00CCFF', '993366', 'C0C0C0',
  95         'FF99CC', 'FFCC99', 'FFFF99', 'CCFFCC', 'CCFFFF', '99CCFF', 'CC99FF', 'FFFFFF'
  96     ],
  97
  98 <span id='Ext-picker-Color-cfg-handler'>    /**
  99 </span>     * @cfg {Function} handler
 100      * A function that will handle the select event of this picker. The handler is passed the following parameters:
 101      *
 102      * - `picker` : ColorPicker
 103      *
 104      *   The {@link Ext.picker.Color picker}.
 105      *
 106      * - `color` : String
 107      *
 108      *   The 6-digit color hex code (without the # symbol).
 109      */
 110
 111 <span id='Ext-picker-Color-cfg-scope'>    /**
 112 </span>     * @cfg {Object} scope
 113      * The scope (`this` reference) in which the `{@link #handler}` function will be called. Defaults to this
 114      * Color picker instance.
 115      */
 116
 117     colorRe: /(?:^|\s)color-(.{6})(?:\s|$)/,
 118
 119     renderTpl: [
 120         '&lt;tpl for=&quot;colors&quot;&gt;',
 121             '&lt;a href=&quot;#&quot; class=&quot;color-{.}&quot; hidefocus=&quot;on&quot;&gt;',
 122                 '&lt;em&gt;&lt;span style=&quot;background:#{.}&quot; unselectable=&quot;on&quot;&gt;&amp;#160;&lt;/span&gt;&lt;/em&gt;',
 123             '&lt;/a&gt;',
 124         '&lt;/tpl&gt;'
 125     ],
 126
 127     // private
 128     initComponent : function(){
 129         var me = this;
 130
 131         me.callParent(arguments);
 132         me.addEvents(
 133 <span id='Ext-picker-Color-event-select'>            /**
 134 </span>             * @event select
 135              * Fires when a color is selected
 136              * @param {Ext.picker.Color} this
 137              * @param {String} color The 6-digit color hex code (without the # symbol)
 138              */
 139             'select'
 140         );
 141
 142         if (me.handler) {
 143             me.on('select', me.handler, me.scope, true);
 144         }
 145     },
 146
 147
 148     // private
 149     onRender : function(container, position){
 150         var me = this,
 151             clickEvent = me.clickEvent;
 152
 153         Ext.apply(me.renderData, {
 154             itemCls: me.itemCls,
 155             colors: me.colors
 156         });
 157         me.callParent(arguments);
 158
 159         me.mon(me.el, clickEvent, me.handleClick, me, {delegate: 'a'});
 160         // always stop following the anchors
 161         if(clickEvent != 'click'){
 162             me.mon(me.el, 'click', Ext.emptyFn, me, {delegate: 'a', stopEvent: true});
 163         }
 164     },
 165
 166     // private
 167     afterRender : function(){
 168         var me = this,
 169             value;
 170
 171         me.callParent(arguments);
 172         if (me.value) {
 173             value = me.value;
 174             me.value = null;
 175             me.select(value, true);
 176         }
 177     },
 178
 179     // private
 180     handleClick : function(event, target){
 181         var me = this,
 182             color;
 183
 184         event.stopEvent();
 185         if (!me.disabled) {
 186             color = target.className.match(me.colorRe)[1];
 187             me.select(color.toUpperCase());
 188         }
 189     },
 190
 191 <span id='Ext-picker-Color-method-select'>    /**
 192 </span>     * Selects the specified color in the picker (fires the {@link #select} event)
 193      * @param {String} color A valid 6-digit color hex code (# will be stripped if included)
 194      * @param {Boolean} suppressEvent (optional) True to stop the select event from firing. Defaults to false.
 195      */
 196     select : function(color, suppressEvent){
 197
 198         var me = this,
 199             selectedCls = me.selectedCls,
 200             value = me.value,
 201             el;
 202
 203         color = color.replace('#', '');
 204         if (!me.rendered) {
 205             me.value = color;
 206             return;
 207         }
 208
 209
 210         if (color != value || me.allowReselect) {
 211             el = me.el;
 212
 213             if (me.value) {
 214                 el.down('a.color-' + value).removeCls(selectedCls);
 215             }
 216             el.down('a.color-' + color).addCls(selectedCls);
 217             me.value = color;
 218             if (suppressEvent !== true) {
 219                 me.fireEvent('select', me, color);
 220             }
 221         }
 222     },
 223
 224 <span id='Ext-picker-Color-method-getValue'>    /**
 225 </span>     * Get the currently selected color value.
 226      * @return {String} value The selected value. Null if nothing is selected.
 227      */
 228     getValue: function(){
 229         return this.value || null;
 230     }
 231 });
 232 </pre>
 233 </body>
 234 </html>