git.roojs.org Git - roojs1/blob - docs/symbols/Roo.lib.Color.json

   1 {
   2   "name" : "Roo.lib.Color",
   3   "augments" : [],
   4   "childClasses" : {
   5     "Roo.lib.Color" : [
   6       "Roo.lib.HSLColor",
   7       "Roo.lib.HSVColor",
   8       "Roo.lib.RGBColor"
   9     ]
  10   },
  11   "tree_children" : [],
  12   "tree_parent" : [],
  13   "desc" : "An abstract Color implementation. Concrete Color implementations should use\nan instance of this function as their prototype, and implement the getRGB and\ngetHSL functions. getRGB should return an object representing the RGB\ncomponents of this Color, with the red, green, and blue components in the\nrange [0,255] and the alpha component in the range [0,100]. getHSL should\nreturn an object representing the HSL components of this Color, with the hue\ncomponent in the range [0,360), the saturation and lightness components in\nthe range [0,100], and the alpha component in the range [0,1].\n\n\nColor.js\n\nFunctions for Color handling and processing.\n\nhttp://www.safalra.com/web-design/javascript/Color-handling-and-processing/\n\nThe author of this program, Safalra (Stephen Morley), irrevocably releases all\nrights to this program, with the intention of it becoming part of the public\ndomain. Because this program is released into the public domain, it comes with\nno warranty either expressed or implied, to the extent permitted by law.\n\nFor more free and public domain JavaScript code by the same author, visit:\nhttp://www.safalra.com/web-design/javascript/",
  14   "isSingleton" : false,
  15   "isStatic" : false,
  16   "isBuiltin" : false,
  17   "isAbstract" : false,
  18   "isBuilderTop" : false,
  19   "memberOf" : "Color",
  20   "example" : "",
  21   "deprecated" : "",
  22   "since" : "",
  23   "see" : "",
  24   "params" : [],
  25   "returns" : [],
  26   "throws" : "",
  27   "requires" : "",
  28   "config" : [],
  29   "methods" : [
  30     {
  31       "name" : "getPercentageRGB",
  32       "type" : "function",
  33       "desc" : "getPercentageRGB",
  34       "sig" : "()\n{\n\n}",
  35       "static" : false,
  36       "memberOf" : "",
  37       "isStatic" : false,
  38       "isConstructor" : false,
  39       "isPrivate" : false,
  40       "example" : "",
  41       "deprecated" : "",
  42       "since" : "",
  43       "see" : "",
  44       "exceptions" : "",
  45       "requires" : "",
  46       "params" : [],
  47       "returns" : [
  48         {
  49           "name" : "",
  50           "type" : "Object",
  51           "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
  52         }
  53       ]
  54     },
  55     {
  56       "name" : "getRGB",
  57       "type" : "function",
  58       "desc" : "getRGB",
  59       "sig" : "()\n{\n\n}",
  60       "static" : false,
  61       "memberOf" : "",
  62       "isStatic" : false,
  63       "isConstructor" : false,
  64       "isPrivate" : false,
  65       "example" : "",
  66       "deprecated" : "",
  67       "since" : "",
  68       "see" : "",
  69       "exceptions" : "",
  70       "requires" : "",
  71       "params" : [],
  72       "returns" : [
  73         {
  74           "name" : "",
  75           "type" : "Object",
  76           "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
  77         }
  78       ]
  79     },
  80     {
  81       "name" : "getIntegerRGB",
  82       "type" : "function",
  83       "desc" : "getIntegerRGB",
  84       "sig" : "()\n{\n\n}",
  85       "static" : false,
  86       "memberOf" : "",
  87       "isStatic" : false,
  88       "isConstructor" : false,
  89       "isPrivate" : false,
  90       "example" : "",
  91       "deprecated" : "",
  92       "since" : "",
  93       "see" : "",
  94       "exceptions" : "",
  95       "requires" : "",
  96       "params" : [],
  97       "returns" : [
  98         {
  99           "name" : "",
 100           "type" : "Object",
 101           "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
 102         }
 103       ]
 104     },
 105     {
 106       "name" : "getCSSIntegerRGBA",
 107       "type" : "function",
 108       "desc" : "getCSSIntegerRGBA",
 109       "sig" : "()\n{\n\n}",
 110       "static" : false,
 111       "memberOf" : "",
 112       "isStatic" : false,
 113       "isConstructor" : false,
 114       "isPrivate" : false,
 115       "example" : "",
 116       "deprecated" : "",
 117       "since" : "",
 118       "see" : "",
 119       "exceptions" : "",
 120       "requires" : "",
 121       "params" : [],
 122       "returns" : [
 123         {
 124           "name" : "",
 125           "type" : "String",
 126           "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
 127         }
 128       ]
 129     },
 130     {
 131       "name" : "getCSSHSL",
 132       "type" : "function",
 133       "desc" : "getCSSHSL",
 134       "sig" : "()\n{\n\n}",
 135       "static" : false,
 136       "memberOf" : "",
 137       "isStatic" : false,
 138       "isConstructor" : false,
 139       "isPrivate" : false,
 140       "example" : "",
 141       "deprecated" : "",
 142       "since" : "",
 143       "see" : "",
 144       "exceptions" : "",
 145       "requires" : "",
 146       "params" : [],
 147       "returns" : [
 148         {
 149           "name" : "",
 150           "type" : "String",
 151           "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
 152         }
 153       ]
 154     },
 155     {
 156       "name" : "getCSSHexadecimalRGB",
 157       "type" : "function",
 158       "desc" : "getCSSHexadecimalRGB",
 159       "sig" : "()\n{\n\n}",
 160       "static" : false,
 161       "memberOf" : "",
 162       "isStatic" : false,
 163       "isConstructor" : false,
 164       "isPrivate" : false,
 165       "example" : "",
 166       "deprecated" : "",
 167       "since" : "",
 168       "see" : "",
 169       "exceptions" : "",
 170       "requires" : "",
 171       "params" : [],
 172       "returns" : [
 173         {
 174           "name" : "",
 175           "type" : "String",
 176           "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
 177         }
 178       ]
 179     },
 180     {
 181       "name" : "setNodeBackgroundColor",
 182       "type" : "function",
 183       "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
 184       "sig" : "(node)",
 185       "static" : false,
 186       "memberOf" : "",
 187       "isStatic" : false,
 188       "isConstructor" : false,
 189       "isPrivate" : false,
 190       "example" : "",
 191       "deprecated" : "",
 192       "since" : "",
 193       "see" : "",
 194       "exceptions" : "",
 195       "requires" : "",
 196       "params" : [
 197         {
 198           "name" : "node",
 199           "type" : "DomElement",
 200           "desc" : "- the node whose background Color should be set",
 201           "isOptional" : false
 202         }
 203       ],
 204       "returns" : []
 205     },
 206     {
 207       "name" : "getHSL",
 208       "type" : "function",
 209       "desc" : "getHSL",
 210       "sig" : "()\n{\n\n}",
 211       "static" : false,
 212       "memberOf" : "",
 213       "isStatic" : false,
 214       "isConstructor" : false,
 215       "isPrivate" : false,
 216       "example" : "",
 217       "deprecated" : "",
 218       "since" : "",
 219       "see" : "",
 220       "exceptions" : "",
 221       "requires" : "",
 222       "params" : [],
 223       "returns" : [
 224         {
 225           "name" : "",
 226           "type" : "Object",
 227           "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
 228         }
 229       ]
 230     },
 231     {
 232       "name" : "getHSV",
 233       "type" : "function",
 234       "desc" : "getHSV",
 235       "sig" : "()\n{\n\n}",
 236       "static" : false,
 237       "memberOf" : "",
 238       "isStatic" : false,
 239       "isConstructor" : false,
 240       "isPrivate" : false,
 241       "example" : "",
 242       "deprecated" : "",
 243       "since" : "",
 244       "see" : "",
 245       "exceptions" : "",
 246       "requires" : "",
 247       "params" : [],
 248       "returns" : [
 249         {
 250           "name" : "",
 251           "type" : "Object",
 252           "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
 253         }
 254       ]
 255     },
 256     {
 257       "name" : "getCSSPercentageRGB",
 258       "type" : "function",
 259       "desc" : "getCSSPercentageRGB",
 260       "sig" : "()\n{\n\n}",
 261       "static" : false,
 262       "memberOf" : "",
 263       "isStatic" : false,
 264       "isConstructor" : false,
 265       "isPrivate" : false,
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "exceptions" : "",
 271       "requires" : "",
 272       "params" : [],
 273       "returns" : [
 274         {
 275           "name" : "",
 276           "type" : "String",
 277           "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
 278         }
 279       ]
 280     },
 281     {
 282       "name" : "setNodeColor",
 283       "type" : "function",
 284       "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
 285       "sig" : "(node)",
 286       "static" : false,
 287       "memberOf" : "",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "example" : "",
 292       "deprecated" : "",
 293       "since" : "",
 294       "see" : "",
 295       "exceptions" : "",
 296       "requires" : "",
 297       "params" : [
 298         {
 299           "name" : "node",
 300           "type" : "DomElement",
 301           "desc" : "- the node whose Color should be set",
 302           "isOptional" : false
 303         }
 304       ],
 305       "returns" : []
 306     },
 307     {
 308       "name" : "getCSSIntegerRGB",
 309       "type" : "function",
 310       "desc" : "getCSSIntegerRGB",
 311       "sig" : "()\n{\n\n}",
 312       "static" : false,
 313       "memberOf" : "",
 314       "isStatic" : false,
 315       "isConstructor" : false,
 316       "isPrivate" : false,
 317       "example" : "",
 318       "deprecated" : "",
 319       "since" : "",
 320       "see" : "",
 321       "exceptions" : "",
 322       "requires" : "",
 323       "params" : [],
 324       "returns" : [
 325         {
 326           "name" : "",
 327           "type" : "String",
 328           "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
 329         }
 330       ]
 331     },
 332     {
 333       "name" : "getCSSHSLA",
 334       "type" : "function",
 335       "desc" : "getCSSHSLA",
 336       "sig" : "()\n{\n\n}",
 337       "static" : false,
 338       "memberOf" : "",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "example" : "",
 343       "deprecated" : "",
 344       "since" : "",
 345       "see" : "",
 346       "exceptions" : "",
 347       "requires" : "",
 348       "params" : [],
 349       "returns" : [
 350         {
 351           "name" : "",
 352           "type" : "String",
 353           "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
 354         }
 355       ]
 356     },
 357     {
 358       "name" : "getCSSPercentageRGBA",
 359       "type" : "function",
 360       "desc" : "getCSSPercentageRGBA",
 361       "sig" : "()\n{\n\n}",
 362       "static" : false,
 363       "memberOf" : "",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "example" : "",
 368       "deprecated" : "",
 369       "since" : "",
 370       "see" : "",
 371       "exceptions" : "",
 372       "requires" : "",
 373       "params" : [],
 374       "returns" : [
 375         {
 376           "name" : "",
 377           "type" : "String",
 378           "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
 379         }
 380       ]
 381     }
 382   ],
 383   "events" : []
 384 }