docs/source/ColorPalette.html

   1 <html>\r
   2 <head>\r
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
   4   <title>The source code</title>\r
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
   7 </head>\r
   8 <body  onload="prettyPrint();">\r
   9     <pre class="prettyprint lang-js"><div id="cls-Ext.ColorPalette"></div>/**
  10  * @class Ext.ColorPalette
  11  * @extends Ext.Component
  12  * Simple color palette class for choosing colors.  The palette can be rendered to any container.<br />
  13  * Here's an example of typical usage:
  14  * <pre><code>
  15 var cp = new Ext.ColorPalette({value:'993300'});  // initial selected color
  16 cp.render('my-div');
  17
  18 cp.on('select', function(palette, selColor){
  19     // do something with selColor
  20 });
  21 </code></pre>
  22  * @constructor
  23  * Create a new ColorPalette
  24  * @param {Object} config The config object
  25  * @xtype colorpalette
  26  */
  27 Ext.ColorPalette = Ext.extend(Ext.Component, {
  28         <div id="cfg-Ext.ColorPalette-tpl"></div>/**
  29          * @cfg {String} tpl An existing XTemplate instance to be used in place of the default template for rendering the component.
  30          */
  31     <div id="cfg-Ext.ColorPalette-itemCls"></div>/**
  32      * @cfg {String} itemCls
  33      * The CSS class to apply to the containing element (defaults to 'x-color-palette')
  34      */
  35     itemCls : 'x-color-palette',
  36     <div id="cfg-Ext.ColorPalette-value"></div>/**
  37      * @cfg {String} value
  38      * The initial color to highlight (should be a valid 6-digit color hex code without the # symbol).  Note that
  39      * the hex codes are case-sensitive.
  40      */
  41     value : null,
  42     <div id="cfg-Ext.ColorPalette-clickEvent"></div>/**
  43      * @cfg {String} clickEvent
  44      * The DOM event that will cause a color to be selected. This can be any valid event name (dblclick, contextmenu).
  45      * Defaults to <tt>'click'</tt>.
  46      */
  47     clickEvent :'click',
  48     // private
  49     ctype : 'Ext.ColorPalette',
  50
  51     <div id="cfg-Ext.ColorPalette-allowReselect"></div>/**
  52      * @cfg {Boolean} allowReselect If set to true then reselecting a color that is already selected fires the {@link #select} event
  53      */
  54     allowReselect : false,
  55
  56     <div id="prop-Ext.ColorPalette-colors"></div>/**
  57      * <p>An array of 6-digit color hex code strings (without the # symbol).  This array can contain any number
  58      * of colors, and each hex code should be unique.  The width of the palette is controlled via CSS by adjusting
  59      * the width property of the 'x-color-palette' class (or assigning a custom class), so you can balance the number
  60      * of colors with the width setting until the box is symmetrical.</p>
  61      * <p>You can override individual colors if needed:</p>
  62      * <pre><code>
  63 var cp = new Ext.ColorPalette();
  64 cp.colors[0] = 'FF0000';  // change the first box to red
  65 </code></pre>
  66
  67 Or you can provide a custom array of your own for complete control:
  68 <pre><code>
  69 var cp = new Ext.ColorPalette();
  70 cp.colors = ['000000', '993300', '333300'];
  71 </code></pre>
  72      * @type Array
  73      */
  74     colors : [
  75         '000000', '993300', '333300', '003300', '003366', '000080', '333399', '333333',
  76         '800000', 'FF6600', '808000', '008000', '008080', '0000FF', '666699', '808080',
  77         'FF0000', 'FF9900', '99CC00', '339966', '33CCCC', '3366FF', '800080', '969696',
  78         'FF00FF', 'FFCC00', 'FFFF00', '00FF00', '00FFFF', '00CCFF', '993366', 'C0C0C0',
  79         'FF99CC', 'FFCC99', 'FFFF99', 'CCFFCC', 'CCFFFF', '99CCFF', 'CC99FF', 'FFFFFF'
  80     ],
  81
  82     <div id="cfg-Ext.ColorPalette-handler"></div>/**
  83      * @cfg {Function} handler
  84      * Optional. A function that will handle the select event of this palette.
  85      * The handler is passed the following parameters:<div class="mdetail-params"><ul>
  86      * <li><code>palette</code> : ColorPalette<div class="sub-desc">The {@link #palette Ext.ColorPalette}.</div></li>
  87      * <li><code>color</code> : String<div class="sub-desc">The 6-digit color hex code (without the # symbol).</div></li>
  88      * </ul></div>
  89      */
  90     <div id="cfg-Ext.ColorPalette-scope"></div>/**
  91      * @cfg {Object} scope
  92      * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>
  93      * function will be called.  Defaults to this ColorPalette instance.
  94      */
  95
  96     // private
  97     initComponent : function(){
  98         Ext.ColorPalette.superclass.initComponent.call(this);
  99         this.addEvents(
 100             <div id="event-Ext.ColorPalette-select"></div>/**
 101              * @event select
 102              * Fires when a color is selected
 103              * @param {ColorPalette} this
 104              * @param {String} color The 6-digit color hex code (without the # symbol)
 105              */
 106             'select'
 107         );
 108
 109         if(this.handler){
 110             this.on('select', this.handler, this.scope, true);
 111         }
 112     },
 113
 114     // private
 115     onRender : function(container, position){
 116         this.autoEl = {
 117             tag: 'div',
 118             cls: this.itemCls
 119         };
 120         Ext.ColorPalette.superclass.onRender.call(this, container, position);
 121         var t = this.tpl || new Ext.XTemplate(
 122             '<tpl for="."><a href="#" class="color-{.}" hidefocus="on"><em><span style="background:#{.}" unselectable="on">&#160;</span></em></a></tpl>'
 123         );
 124         t.overwrite(this.el, this.colors);
 125         this.mon(this.el, this.clickEvent, this.handleClick, this, {delegate: 'a'});
 126         if(this.clickEvent != 'click'){
 127                 this.mon(this.el, 'click', Ext.emptyFn, this, {delegate: 'a', preventDefault: true});
 128         }
 129     },
 130
 131     // private
 132     afterRender : function(){
 133         Ext.ColorPalette.superclass.afterRender.call(this);
 134         if(this.value){
 135             var s = this.value;
 136             this.value = null;
 137             this.select(s);
 138         }
 139     },
 140
 141     // private
 142     handleClick : function(e, t){
 143         e.preventDefault();
 144         if(!this.disabled){
 145             var c = t.className.match(/(?:^|\s)color-(.{6})(?:\s|$)/)[1];
 146             this.select(c.toUpperCase());
 147         }
 148     },
 149
 150     <div id="method-Ext.ColorPalette-select"></div>/**
 151      * Selects the specified color in the palette (fires the {@link #select} event)
 152      * @param {String} color A valid 6-digit color hex code (# will be stripped if included)
 153      */
 154     select : function(color){
 155         color = color.replace('#', '');
 156         if(color != this.value || this.allowReselect){
 157             var el = this.el;
 158             if(this.value){
 159                 el.child('a.color-'+this.value).removeClass('x-color-palette-sel');
 160             }
 161             el.child('a.color-'+color).addClass('x-color-palette-sel');
 162             this.value = color;
 163             this.fireEvent('select', this, color);
 164         }
 165     }
 166
 167     <div id="cfg-Ext.ColorPalette-autoEl"></div>/**
 168      * @cfg {String} autoEl @hide
 169      */
 170 });
 171 Ext.reg('colorpalette', Ext.ColorPalette);
 172 </pre>    \r
 173 </body>\r
 174 </html>