Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / Color2.html
index 5bc687f..5f9e625 100644 (file)
 </head>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><span id='Ext-draw-Color'>/**
-</span> * @class Ext.draw.Color
- * @extends Object
- *
- * Represents an RGB color and provides helper functions get
+</span> * Represents an RGB color and provides helper functions get
  * color components in HSL color space.
  */
 Ext.define('Ext.draw.Color', {
@@ -40,7 +37,7 @@ Ext.define('Ext.draw.Color', {
     lightnessFactor: 0.2,
 
 <span id='Ext-draw-Color-method-constructor'>    /**
-</span>     * @constructor
+</span>     * Creates new Color.
      * @param {Number} red Red component (0..255)
      * @param {Number} green Green component (0..255)
      * @param {Number} blue Blue component (0..255)
@@ -79,7 +76,7 @@ Ext.define('Ext.draw.Color', {
 
 <span id='Ext-draw-Color-method-getRGB'>    /**
 </span>     * Get the RGB values.
-     * @return {Array}
+     * @return {[Number]}
      */
     getRGB: function() {
         var me = this;
@@ -88,7 +85,7 @@ Ext.define('Ext.draw.Color', {
 
 <span id='Ext-draw-Color-method-getHSL'>    /**
 </span>     * Get the equivalent HSL components of the color.
-     * @return {Array}
+     * @return {[Number]}
      */
     getHSL: function() {
         var me = this,
@@ -163,9 +160,12 @@ Ext.define('Ext.draw.Color', {
 <span id='Ext-draw-Color-method-toHex'>    /**
 </span>     * Convert a color to hexadecimal format.
      *
-     * @param {String|Array} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff').
+     * **Note:** This method is both static and instance.
+     *
+     * @param {String/[String]} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff').
      * Can also be an Array, in this case the function handles the first member.
      * @returns {String} The color in hexadecimal format.
+     * @static
      */
     toHex: function(color) {
         if (Ext.isArray(color)) {
@@ -198,8 +198,11 @@ Ext.define('Ext.draw.Color', {
      *
      * If the string is not recognized, an undefined will be returned instead.
      *
+     * **Note:** This method is both static and instance.
+     *
      * @param {String} str Color in string.
      * @returns Ext.draw.Color
+     * @static
      */
     fromString: function(str) {
         var values, r, g, b,
@@ -244,11 +247,14 @@ Ext.define('Ext.draw.Color', {
 
 <span id='Ext-draw-Color-method-fromHSL'>    /**
 </span>     * Create a new color based on the specified HSL values.
+     *
+     * **Note:** This method is both static and instance.
      *
      * @param {Number} h Hue component (0..359)
      * @param {Number} s Saturation component (0..1)
      * @param {Number} l Lightness component (0..1)
      * @returns Ext.draw.Color
+     * @static
      */
     fromHSL: function(h, s, l) {
         var C, X, m, i, rgb = [],