Ext.draw.Color

Hierarchy

Ext.Base
Ext.draw.Color

Files

Represents an RGB color and provides helper functions on it e.g. to get color components in HSL color space.

Defined By

Config options

The default factor to compute the lighter or darker color. ...

The default factor to compute the lighter or darker color.

Defaults to: 0.2

Properties

Defined By

Instance properties

Ext.draw.Color
view source
: Booleanprivate
...

Defaults to: true

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'
Defined By

Static properties

...

Defaults to: []

Ext.draw.Color
view source
: RegExpprivatestatic
...

Defaults to: /(.*?)rgb\((\d+),\s*(\d+),\s*(\d+)\)/

Ext.draw.Color
view source
: RegExpprivatestatic
...

Defaults to: /\s*#([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)\s*/

Ext.draw.Color
view source
: RegExpprivatestatic
...

Defaults to: /\s*rgb\((\d+),\s*(\d+),\s*(\d+)\)/

Ext.draw.Color
view source
: RegExpprivatestatic
...

Defaults to: /\s*rgba\((\d+),\s*(\d+),\s*(\d+),\s*([\.\d]+)\)/

Methods

Defined By

Instance methods

Ext.draw.Color
view source
new( red, green, blue, [alpha] ) : Ext.draw.Color
...

Parameters

  • red : Number

    Red component (0..255)

  • green : Number

    Green component (0..255)

  • blue : Number

    Blue component (0..255)

  • alpha : Number (optional)

    Alpha component (0..1)

    Defaults to: 1

Returns

Fires

    Call the original method that was previously overridden with override, This method is deprecated as callParent does ...

    Call the original method that was previously overridden with override,

    This method is deprecated as callParent does the same thing.

    Ext.define('My.Cat', {
        constructor: function() {
            alert("I'm a cat!");
        }
    });
    
    My.Cat.override({
        constructor: function() {
            alert("I'm going to be a cat!");
    
            var instance = this.callOverridden();
    
            alert("Meeeeoooowwww");
    
            return instance;
        }
    });
    
    var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                              // alerts "I'm a cat!"
                              // alerts "Meeeeoooowwww"
    

    Parameters

    • args : Array/Arguments

      The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

    Returns

    • Object

      Returns the result of calling the overridden method

    Call the "parent" method of the current method. ...

    Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

     Ext.define('My.Base', {
         constructor: function (x) {
             this.x = x;
         },
    
         statics: {
             method: function (x) {
                 return x;
             }
         }
     });
    
     Ext.define('My.Derived', {
         extend: 'My.Base',
    
         constructor: function () {
             this.callParent([21]);
         }
     });
    
     var obj = new My.Derived();
    
     alert(obj.x);  // alerts 21
    

    This can be used with an override as follows:

     Ext.define('My.DerivedOverride', {
         override: 'My.Derived',
    
         constructor: function (x) {
             this.callParent([x*2]); // calls original My.Derived constructor
         }
     });
    
     var obj = new My.Derived();
    
     alert(obj.x);  // now alerts 42
    

    This also works with static methods.

     Ext.define('My.Derived2', {
         extend: 'My.Base',
    
         statics: {
             method: function (x) {
                 return this.callParent([x*2]); // calls My.Base.method
             }
         }
     });
    
     alert(My.Base.method(10));     // alerts 10
     alert(My.Derived2.method(10)); // alerts 20
    

    Lastly, it also works with overridden static methods.

     Ext.define('My.Derived2Override', {
         override: 'My.Derived2',
    
         statics: {
             method: function (x) {
                 return this.callParent([x*2]); // calls My.Derived2.method
             }
         }
     });
    
     alert(My.Derived2.method(10)); // now alerts 40
    

    To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

    Parameters

    • args : Array/Arguments

      The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

    Returns

    • Object

      Returns the result of calling the parent method

    This method is used by an override to call the superclass method but bypass any overridden method. ...

    This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

    Consider:

     Ext.define('Ext.some.Class', {
         method: function () {
             console.log('Good');
         }
     });
    
     Ext.define('Ext.some.DerivedClass', {
         method: function () {
             console.log('Bad');
    
             // ... logic but with a bug ...
    
             this.callParent();
         }
     });
    

    To patch the bug in DerivedClass.method, the typical solution is to create an override:

     Ext.define('App.paches.DerivedClass', {
         override: 'Ext.some.DerivedClass',
    
         method: function () {
             console.log('Fixed');
    
             // ... logic but with bug fixed ...
    
             this.callSuper();
         }
     });
    

    The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

    Parameters

    • args : Array/Arguments

      The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

    Returns

    • Object

      Returns the result of calling the superclass method

    Ext.draw.Color
    view source
    ( [factor] ) : Ext.draw.Color
    Return a new color that is darker than this color. ...

    Return a new color that is darker than this color.

    Parameters

    • factor : Number (optional)

      Darker factor (0..1).

      Defaults to: 0.2

    Returns

    Fires

      Ext.draw.Color
      view source
      ( [factor] ) : Ext.draw.Color
      Return a new color that is lighter than this color. ...

      Return a new color that is lighter than this color.

      Parameters

      • factor : Number (optional)

        Lighter factor (0..1).

        Defaults to: 0.2

      Returns

      Fires

        ...

        Parameters

        Ext.draw.Color
        view source
        ( ) : Number
        Returns the gray value (0 to 255) of the color. ...

        Returns the gray value (0 to 255) of the color.

        The gray value is calculated using the formula r0.3 + g0.59 + b*0.11.

        Returns

        Ext.draw.Color
        view source
        ( [target] ) : Array
        Get the equivalent HSL components of the color. ...

        Get the equivalent HSL components of the color.

        Parameters

        • target : Array (optional)

          Optional array to receive the values.

        Returns

        Returns the initial configuration passed to constructor. ...

        Returns the initial configuration passed to constructor.

        Parameters

        • name : String (optional)

          When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

        Returns

        ...

        Parameters

        ( instanceConfig ) : Objectchainableprotected
        Initialize configuration for this class. ...

        Initialize configuration for this class. a typical example:

        Ext.define('My.awesome.Class', {
            // The default config
            config: {
                name: 'Awesome',
                isAwesome: true
            },
        
            constructor: function(config) {
                this.initConfig(config);
            }
        });
        
        var awesome = new My.awesome.Class({
            name: 'Super Awesome'
        });
        
        alert(awesome.getName()); // 'Super Awesome'
        

        Parameters

        Returns

        • Object

          mixins The mixin prototypes as key - value pairs

        Fires

          ( names, callback, scope )private
          ...

          Parameters

          ( config, applyIfNotSet ) : Ext.Basechainableprivate
          ...

          Parameters

          Returns

          Ext.draw.Color
          view source
          ( str ) : Object
          Parse the string and set current color. ...

          Parse the string and set current color.

          Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'.

          If the string is not recognized, an undefined will be returned instead.

          Parameters

          Returns

          Fires

            Ext.draw.Color
            view source
            ( h, s, l ) : Objectchainable
            Set current color based on the specified HSL values. ...

            Set current color based on the specified HSL values.

            Parameters

            • h : Number

              Hue component (0..359)

            • s : Number

              Saturation component (0..1)

            • l : Number

              Lightness component (0..1)

            Returns

            Fires

              Ext.draw.Color
              view source
              ( red, green, blue, alpha )private
              ...

              Parameters

              Get the reference to the class from which this object was instantiated. ...

              Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

              Ext.define('My.Cat', {
                  statics: {
                      totalCreated: 0,
                      speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                  },
              
                  constructor: function() {
                      var statics = this.statics();
              
                      alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                      // equivalent to: My.Cat.speciesName
              
                      alert(this.self.speciesName);   // dependent on 'this'
              
                      statics.totalCreated++;
                  },
              
                  clone: function() {
                      var cloned = new this.self();                    // dependent on 'this'
              
                      cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
              
                      return cloned;
                  }
              });
              
              
              Ext.define('My.SnowLeopard', {
                  extend: 'My.Cat',
              
                  statics: {
                      speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                  },
              
                  constructor: function() {
                      this.callParent();
                  }
              });
              
              var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
              
              var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
              
              var clone = snowLeopard.clone();
              alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
              alert(clone.groupName);                 // alerts 'Cat'
              
              alert(My.Cat.totalCreated);             // alerts 3
              

              Returns

              Ext.draw.Color
              view source
              ( color ) : String
              Convert a color to hexadecimal format. ...

              Convert a color to hexadecimal format.

              Parameters

              • color : String/Array

                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.

              Ext.draw.Color
              view source
              ( ) : String
              Return the color in the hex format, i.e. ...

              Return the color in the hex format, i.e. '#rrggbb'.

              Returns

              Defined By

              Static methods

              ( config, fullMerge )privatestatic
              ...

              Parameters

              ( members )chainableprivatestatic
              ...

              Parameters

              ( name, member )chainableprivatestatic
              ...

              Parameters

              ( members )chainablestatic
              Add methods / properties to the prototype of this class. ...

              Add methods / properties to the prototype of this class.

              Ext.define('My.awesome.Cat', {
                  constructor: function() {
                      // ...
                  }
              });
              
               My.awesome.Cat.addMembers({
                   meow: function() {
                      alert('Meowww...');
                   }
               });
              
               var kitty = new My.awesome.Cat();
               kitty.meow();
              

              Parameters

              ( members ) : Ext.Basechainablestatic
              Add / override static properties of this class. ...

              Add / override static properties of this class.

              Ext.define('My.cool.Class', {
                  // this.se
              });
              
              My.cool.Class.addStatics({
                  someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                  method1: function() {  },    // My.cool.Class.method1 = function() { ... };
                  method2: function() {  }     // My.cool.Class.method2 = function() { ... };
              });
              

              Parameters

              Returns

              ( xtype )chainableprivatestatic
              ...

              Parameters

              ( fromClass, members ) : Ext.Basechainableprivatestatic
              Borrow another class' members to the prototype of this class. ...

              Borrow another class' members to the prototype of this class.

              Ext.define('Bank', {
                  money: '$$$',
                  printMoney: function() {
                      alert('$$$$$$$');
                  }
              });
              
              Ext.define('Thief', {
                  // ...
              });
              
              Thief.borrow(Bank, ['money', 'printMoney']);
              
              var steve = new Thief();
              
              alert(steve.money); // alerts '$$$'
              steve.printMoney(); // alerts '$$$$$$$'
              

              Parameters

              • fromClass : Ext.Base

                The class to borrow members from

              • members : Array/String

                The names of the members to borrow

              Returns

              ( args )protectedstatic
              ...

              Parameters

              Ext.draw.Color
              view source
              ( [red], [green], [blue], [alpha] ) : Ext.draw.Colorstatic
              Convenience method for creating a color. ...

              Convenience method for creating a color.

              Can be called with several different combinations of arguments:

              // Ext.draw.Color is returned unchanged.
              Ext.draw.Color.create(new Ext.draw.color(255, 0, 0, 0));
              
              // CSS color string.
              Ext.draw.Color.create("red");
              
              // Array of red, green, blue, alpha
              Ext.draw.Color.create([255, 0, 0, 0]);
              
              // Separate arguments of red, green, blue, alpha
              Ext.draw.Color.create(255, 0, 0, 0);
              
              // Returns black when no arguments given.
              Ext.draw.Color.create();
              

              Parameters

              • red : Ext.draw.Color/String/Number[]/Number (optional)

                Red component (0..255), CSS color string or array of all components.

              • green : Number (optional)

                Green component (0..255)

              • blue : Number (optional)

                Blue component (0..255)

              • alpha : Number (optional)

                Alpha component (0..1)

                Defaults to: 1

              Returns

              Overrides: Ext.Base.create

              ( alias, origin )static
              Create aliases for existing prototype methods. ...

              Create aliases for existing prototype methods. Example:

              Ext.define('My.cool.Class', {
                  method1: function() {  },
                  method2: function() {  }
              });
              
              var test = new My.cool.Class();
              
              My.cool.Class.createAlias({
                  method3: 'method1',
                  method4: 'method2'
              });
              
              test.method3(); // test.method1()
              
              My.cool.Class.createAlias('method5', 'method3');
              
              test.method5(); // test.method3() -> test.method1()
              

              Parameters

              ( parent )privatestatic
              ...

              Parameters

              Ext.draw.Color
              view source
              ( red, [green], [blue], [alpha] ) : Ext.draw.Colorstatic
              Returns a flyweight instance of Ext.draw.Color. ...

              Returns a flyweight instance of Ext.draw.Color.

              Can be called with either a CSS color string or with separate arguments for red, green, blue, alpha.

              Parameters

              • red : Number/String

                Red component (0..255) or CSS color string.

              • green : Number (optional)

                Green component (0..255)

              • blue : Number (optional)

                Blue component (0..255)

              • alpha : Number (optional)

                Alpha component (0..1)

                Defaults to: 1

              Returns

              Ext.draw.Color
              view source
              ( h, s, l ) : Ext.draw.Colorstatic
              Create a new color based on the specified HSL values. ...

              Create a new color based on the specified HSL values.

              Parameters

              • h : Number

                Hue component (0..359)

              • s : Number

                Saturation component (0..1)

              • l : Number

                Lightness component (0..1)

              Returns

              Ext.draw.Color
              view source
              ( string ) : Ext.draw.Colorstatic
              Parse the string and create a new color. ...

              Parse the string and create a new color.

              Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'.

              If the string is not recognized, an undefined will be returned instead.

              Parameters

              • string : String

                Color in string.

              Returns

              Get the current class' name in string format. ...

              Get the current class' name in string format.

              Ext.define('My.cool.Class', {
                  constructor: function() {
                      alert(this.self.getName()); // alerts 'My.cool.Class'
                  }
              });
              
              My.cool.Class.getName(); // 'My.cool.Class'
              

              Returns

              ...
              ( name, mixinClass )privatestatic
              Used internally by the mixins pre-processor ...

              Used internally by the mixins pre-processor

              Parameters

              ( fn, scope )chainableprivatestatic
              ...

              Parameters

              ( members ) : Ext.Basechainabledeprecatedstatic
              Override members of this class. ...

              Override members of this class. Overridden methods can be invoked via callParent.

              Ext.define('My.Cat', {
                  constructor: function() {
                      alert("I'm a cat!");
                  }
              });
              
              My.Cat.override({
                  constructor: function() {
                      alert("I'm going to be a cat!");
              
                      var instance = this.callParent(arguments);
              
                      alert("Meeeeoooowwww");
              
                      return instance;
                  }
              });
              
              var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                        // alerts "I'm a cat!"
                                        // alerts "Meeeeoooowwww"
              

              As of 2.1, direct use of this method is deprecated. Use Ext.define instead:

              Ext.define('My.CatOverride', {
                  override: 'My.Cat',
              
                  constructor: function() {
                      alert("I'm going to be a cat!");
              
                      var instance = this.callParent(arguments);
              
                      alert("Meeeeoooowwww");
              
                      return instance;
                  }
              });
              

              The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

              This method has been deprecated since 2.1.0

              Please use Ext.define instead

              Parameters

              • members : Object

                The properties to add to this class. This should be specified as an object literal containing one or more properties.

              Returns