X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/ee06f37b0f6f6d94cd05a6ffae556660f7c4a2bc..c930e9176a5a85509c5b0230e2bff5c22a591432:/docs/source/ColorPalette.html?ds=sidebyside diff --git a/docs/source/ColorPalette.html b/docs/source/ColorPalette.html new file mode 100644 index 00000000..723fc9d4 --- /dev/null +++ b/docs/source/ColorPalette.html @@ -0,0 +1,166 @@ + + + The source code + + + + +
/** + * @class Ext.ColorPalette + * @extends Ext.Component + * Simple color palette class for choosing colors. The palette can be rendered to any container.
+ * Here's an example of typical usage: + *

+var cp = new Ext.ColorPalette({value:'993300'});  // initial selected color
+cp.render('my-div');
+
+cp.on('select', function(palette, selColor){
+    // do something with selColor
+});
+
+ * @constructor + * Create a new ColorPalette + * @param {Object} config The config object + * @xtype colorpalette + */ +Ext.ColorPalette = function(config){ + Ext.ColorPalette.superclass.constructor.call(this, config); + this.addEvents( +
/** + * @event select + * Fires when a color is selected + * @param {ColorPalette} this + * @param {String} color The 6-digit color hex code (without the # symbol) + */ + 'select' + ); + + if(this.handler){ + this.on('select', this.handler, this.scope, true); + } +}; +Ext.extend(Ext.ColorPalette, Ext.Component, { +
/** + * @cfg {String} tpl An existing XTemplate instance to be used in place of the default template for rendering the component. + */ +
/** + * @cfg {String} itemCls + * The CSS class to apply to the containing element (defaults to 'x-color-palette') + */ + itemCls : 'x-color-palette', +
/** + * @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, + clickEvent :'click', + // private + ctype : 'Ext.ColorPalette', + +
/** + * @cfg {Boolean} allowReselect If set to true then reselecting a color that is already selected fires the {@link #select} event + */ + allowReselect : false, + +
/** + *

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 palette is controlled via CSS by adjusting + * the width property of the 'x-color-palette' class (or assigning a custom class), so you can balance the number + * of colors with the width setting until the box is symmetrical.

+ *

You can override individual colors if needed:

+ *

+var cp = new Ext.ColorPalette();
+cp.colors[0] = 'FF0000';  // change the first box to red
+
+ +Or you can provide a custom array of your own for complete control: +

+var cp = new Ext.ColorPalette();
+cp.colors = ['000000', '993300', '333300'];
+
+ * @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 palette. + * The handler is passed the following parameters:
+ */ +
/** + * @cfg {Object} scope + * The scope (this reference) in which the {@link #handler} + * function will be called. Defaults to this ColorPalette instance. + */ + + // private + onRender : function(container, position){ + var t = this.tpl || new Ext.XTemplate( + ' ' + ); + var el = document.createElement('div'); + el.id = this.getId(); + el.className = this.itemCls; + t.overwrite(el, this.colors); + container.dom.insertBefore(el, position); + this.el = Ext.get(el); + this.mon(this.el, this.clickEvent, this.handleClick, this, {delegate: 'a'}); + if(this.clickEvent != 'click'){ + this.mon(this.el, 'click', Ext.emptyFn, this, {delegate: 'a', preventDefault: true}); + } + }, + + // private + afterRender : function(){ + Ext.ColorPalette.superclass.afterRender.call(this); + if(this.value){ + var s = this.value; + this.value = null; + this.select(s); + } + }, + + // private + handleClick : function(e, t){ + e.preventDefault(); + if(!this.disabled){ + var c = t.className.match(/(?:^|\s)color-(.{6})(?:\s|$)/)[1]; + this.select(c.toUpperCase()); + } + }, + +
/** + * Selects the specified color in the palette (fires the {@link #select} event) + * @param {String} color A valid 6-digit color hex code (# will be stripped if included) + */ + select : function(color){ + color = color.replace('#', ''); + if(color != this.value || this.allowReselect){ + var el = this.el; + if(this.value){ + el.child('a.color-'+this.value).removeClass('x-color-palette-sel'); + } + el.child('a.color-'+color).addClass('x-color-palette-sel'); + this.value = color; + this.fireEvent('select', this, color); + } + } + +
/** + * @cfg {String} autoEl @hide + */ +}); +Ext.reg('colorpalette', Ext.ColorPalette); +
+ + \ No newline at end of file