docs/output/Ext.Version.js

   1 Ext.data.JsonP.Ext_Version({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": "Jacky Nguyen <jacky@sencha.com>",
   7   "members": {
   8     "cfg": [
   9
  10     ],
  11     "method": [
  12       {
  13         "deprecated": null,
  14         "alias": null,
  15         "href": "Version.html#Ext-Version-method-constructor",
  16         "tagname": "method",
  17         "protected": false,
  18         "shortDoc": " ...",
  19         "static": false,
  20         "params": [
  21           {
  22             "type": "String/Number",
  23             "optional": false,
  24             "doc": "<p>The version number in the follow standard format: major[.minor[.patch[.build[release]]]]\nExamples: 1.0 or 1.2.3beta or 1.2.3.4RC</p>\n",
  25             "name": "version"
  26           }
  27         ],
  28         "private": false,
  29         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
  30         "doc": "\n",
  31         "owner": "Ext.Version",
  32         "name": "Version",
  33         "html_filename": "Version.html",
  34         "return": {
  35           "type": "Ext.Version",
  36           "doc": "<p>this</p>\n"
  37         },
  38         "linenr": 35
  39       },
  40       {
  41         "deprecated": null,
  42         "alias": null,
  43         "protected": false,
  44         "tagname": "method",
  45         "href": "Version.html#Ext-Version-method-compare",
  46         "shortDoc": "Compare 2 specified versions, starting from left to right. ...",
  47         "static": true,
  48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
  49         "private": false,
  50         "params": [
  51           {
  52             "type": "String",
  53             "optional": false,
  54             "doc": "<p>The current version to compare to</p>\n",
  55             "name": "current"
  56           },
  57           {
  58             "type": "String",
  59             "optional": false,
  60             "doc": "<p>The target version to compare to</p>\n",
  61             "name": "target"
  62           }
  63         ],
  64         "name": "compare",
  65         "owner": "Ext.Version",
  66         "doc": "<p>Compare 2 specified versions, starting from left to right. If a part contains special version strings,\nthey are handled in the following order:\n'dev' &lt; 'alpha' = 'a' &lt; 'beta' = 'b' &lt; 'RC' = 'rc' &lt; '#' &lt; 'pl' = 'p' &lt; 'anything else'</p>\n",
  67         "linenr": 212,
  68         "return": {
  69           "type": "Number",
  70           "doc": "<p>Returns -1 if the current version is smaller than the target version, 1 if greater, and 0 if they're equivalent</p>\n"
  71         },
  72         "html_filename": "Version.html"
  73       },
  74       {
  75         "deprecated": null,
  76         "alias": null,
  77         "protected": false,
  78         "tagname": "method",
  79         "href": "Version.html#Ext-Version-method-deprecate",
  80         "shortDoc": "Create a closure for deprecated code. ...",
  81         "static": false,
  82         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
  83         "private": false,
  84         "params": [
  85           {
  86             "type": "String",
  87             "optional": false,
  88             "doc": "<p>The package name</p>\n",
  89             "name": "packageName"
  90           },
  91           {
  92             "type": "String",
  93             "optional": false,
  94             "doc": "<p>The last version before it's deprecated</p>\n",
  95             "name": "since"
  96           },
  97           {
  98             "type": "Function",
  99             "optional": false,
 100             "doc": "<p>The callback function to be executed with the specified version is less than the current version</p>\n",
 101             "name": "closure"
 102           },
 103           {
 104             "type": "Object",
 105             "optional": false,
 106             "doc": "<p>The execution scope (<tt>this</tt>) if the closure</p>\n",
 107             "name": "scope"
 108           }
 109         ],
 110         "name": "deprecate",
 111         "owner": "Ext.Version",
 112         "doc": "<p>Create a closure for deprecated code.</p>\n\n<pre><code>// This means Ext.oldMethod is only supported in 4.0.0beta and older.\n// If Ext.getVersion('extjs') returns a version that is later than '4.0.0beta', for example '4.0.0RC',\n// the closure will not be invoked\nExt.deprecate('extjs', '4.0.0beta', function() {\n    Ext.oldMethod = Ext.newMethod;\n\n    ...\n});\n</code></pre>\n",
 113         "linenr": 283,
 114         "return": {
 115           "type": "void",
 116           "doc": "\n"
 117         },
 118         "html_filename": "Version.html"
 119       },
 120       {
 121         "deprecated": null,
 122         "alias": null,
 123         "protected": false,
 124         "tagname": "method",
 125         "href": "Version.html#Ext-Version-method-equals",
 126         "shortDoc": "Returns whether this version equals to the supplied argument ...",
 127         "static": false,
 128         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 129         "private": false,
 130         "params": [
 131           {
 132             "type": "String/Number",
 133             "optional": false,
 134             "doc": "<p>The version to compare with</p>\n",
 135             "name": "target"
 136           }
 137         ],
 138         "name": "equals",
 139         "owner": "Ext.Version",
 140         "doc": "<p>Returns whether this version equals to the supplied argument</p>\n",
 141         "linenr": 144,
 142         "return": {
 143           "type": "Boolean",
 144           "doc": "<p>True if this version equals to the target, false otherwise</p>\n"
 145         },
 146         "html_filename": "Version.html"
 147       },
 148       {
 149         "deprecated": null,
 150         "alias": null,
 151         "protected": false,
 152         "tagname": "method",
 153         "href": "Version.html#Ext-Version-method-getBuild",
 154         "shortDoc": "Returns the build component value ...",
 155         "static": false,
 156         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 157         "private": false,
 158         "params": [
 159
 160         ],
 161         "name": "getBuild",
 162         "owner": "Ext.Version",
 163         "doc": "<p>Returns the build component value</p>\n",
 164         "linenr": 110,
 165         "return": {
 166           "type": "Number",
 167           "doc": "<p>build</p>\n"
 168         },
 169         "html_filename": "Version.html"
 170       },
 171       {
 172         "deprecated": null,
 173         "alias": null,
 174         "protected": false,
 175         "tagname": "method",
 176         "href": "Version.html#Ext-Version-method-getComponentValue",
 177         "shortDoc": "Converts a version component to a comparable value ...",
 178         "static": true,
 179         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 180         "private": false,
 181         "params": [
 182           {
 183             "type": "Mixed",
 184             "optional": false,
 185             "doc": "<p>The value to convert</p>\n",
 186             "name": "value"
 187           }
 188         ],
 189         "name": "getComponentValue",
 190         "owner": "Ext.Version",
 191         "doc": "<p>Converts a version component to a comparable value</p>\n",
 192         "linenr": 201,
 193         "return": {
 194           "type": "Mixed",
 195           "doc": "\n"
 196         },
 197         "html_filename": "Version.html"
 198       },
 199       {
 200         "deprecated": null,
 201         "alias": null,
 202         "protected": false,
 203         "tagname": "method",
 204         "href": "Version.html#Ext-Version-method-getMajor",
 205         "shortDoc": "Returns the major component value ...",
 206         "static": false,
 207         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 208         "private": false,
 209         "params": [
 210
 211         ],
 212         "name": "getMajor",
 213         "owner": "Ext.Version",
 214         "doc": "<p>Returns the major component value</p>\n",
 215         "linenr": 86,
 216         "return": {
 217           "type": "Number",
 218           "doc": "<p>major</p>\n"
 219         },
 220         "html_filename": "Version.html"
 221       },
 222       {
 223         "deprecated": null,
 224         "alias": null,
 225         "protected": false,
 226         "tagname": "method",
 227         "href": "Version.html#Ext-Version-method-getMinor",
 228         "shortDoc": "Returns the minor component value ...",
 229         "static": false,
 230         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 231         "private": false,
 232         "params": [
 233
 234         ],
 235         "name": "getMinor",
 236         "owner": "Ext.Version",
 237         "doc": "<p>Returns the minor component value</p>\n",
 238         "linenr": 94,
 239         "return": {
 240           "type": "Number",
 241           "doc": "<p>minor</p>\n"
 242         },
 243         "html_filename": "Version.html"
 244       },
 245       {
 246         "deprecated": null,
 247         "alias": null,
 248         "protected": false,
 249         "tagname": "method",
 250         "href": "Version.html#Ext-Version-method-getPatch",
 251         "shortDoc": "Returns the patch component value ...",
 252         "static": false,
 253         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 254         "private": false,
 255         "params": [
 256
 257         ],
 258         "name": "getPatch",
 259         "owner": "Ext.Version",
 260         "doc": "<p>Returns the patch component value</p>\n",
 261         "linenr": 102,
 262         "return": {
 263           "type": "Number",
 264           "doc": "<p>patch</p>\n"
 265         },
 266         "html_filename": "Version.html"
 267       },
 268       {
 269         "deprecated": null,
 270         "alias": null,
 271         "protected": false,
 272         "tagname": "method",
 273         "href": "Version.html#Ext-Version-method-getRelease",
 274         "shortDoc": "Returns the release component value ...",
 275         "static": false,
 276         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 277         "private": false,
 278         "params": [
 279
 280         ],
 281         "name": "getRelease",
 282         "owner": "Ext.Version",
 283         "doc": "<p>Returns the release component value</p>\n",
 284         "linenr": 118,
 285         "return": {
 286           "type": "Number",
 287           "doc": "<p>release</p>\n"
 288         },
 289         "html_filename": "Version.html"
 290       },
 291       {
 292         "deprecated": null,
 293         "alias": null,
 294         "protected": false,
 295         "tagname": "method",
 296         "href": "Version.html#Ext-Version-method-getShortVersion",
 297         "shortDoc": "Returns shortVersion version without dots and release ...",
 298         "static": false,
 299         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 300         "private": false,
 301         "params": [
 302
 303         ],
 304         "name": "getShortVersion",
 305         "owner": "Ext.Version",
 306         "doc": "<p>Returns shortVersion version without dots and release</p>\n",
 307         "linenr": 178,
 308         "return": {
 309           "type": "String",
 310           "doc": "\n"
 311         },
 312         "html_filename": "Version.html"
 313       },
 314       {
 315         "deprecated": null,
 316         "alias": null,
 317         "protected": false,
 318         "tagname": "method",
 319         "href": "Version.html#Ext-Version-method-getVersion",
 320         "shortDoc": "Get the version number of the supplied package name; will return the last registered version\n(last Ext.setVersion cal...",
 321         "static": false,
 322         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 323         "private": false,
 324         "params": [
 325           {
 326             "type": "String",
 327             "optional": false,
 328             "doc": "<p>(Optional) The package name, for example: 'core', 'touch', 'extjs'</p>\n",
 329             "name": "packageName"
 330           }
 331         ],
 332         "name": "getVersion",
 333         "owner": "Ext.Version",
 334         "doc": "<p>Get the version number of the supplied package name; will return the last registered version\n(last Ext.setVersion call) if there's no package name given.</p>\n",
 335         "linenr": 268,
 336         "return": {
 337           "type": "Ext.Version",
 338           "doc": "<p>The version</p>\n"
 339         },
 340         "html_filename": "Version.html"
 341       },
 342       {
 343         "deprecated": null,
 344         "alias": null,
 345         "protected": false,
 346         "tagname": "method",
 347         "href": "Version.html#Ext-Version-method-isGreaterThan",
 348         "shortDoc": "Returns whether this version if greater than the supplied argument ...",
 349         "static": false,
 350         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 351         "private": false,
 352         "params": [
 353           {
 354             "type": "String/Number",
 355             "optional": false,
 356             "doc": "<p>The version to compare with</p>\n",
 357             "name": "target"
 358           }
 359         ],
 360         "name": "isGreaterThan",
 361         "owner": "Ext.Version",
 362         "doc": "<p>Returns whether this version if greater than the supplied argument</p>\n",
 363         "linenr": 126,
 364         "return": {
 365           "type": "Boolean",
 366           "doc": "<p>True if this version if greater than the target, false otherwise</p>\n"
 367         },
 368         "html_filename": "Version.html"
 369       },
 370       {
 371         "deprecated": null,
 372         "alias": null,
 373         "protected": false,
 374         "tagname": "method",
 375         "href": "Version.html#Ext-Version-method-isLessThan",
 376         "shortDoc": "Returns whether this version if smaller than the supplied argument ...",
 377         "static": false,
 378         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 379         "private": false,
 380         "params": [
 381           {
 382             "type": "String/Number",
 383             "optional": false,
 384             "doc": "<p>The version to compare with</p>\n",
 385             "name": "target"
 386           }
 387         ],
 388         "name": "isLessThan",
 389         "owner": "Ext.Version",
 390         "doc": "<p>Returns whether this version if smaller than the supplied argument</p>\n",
 391         "linenr": 135,
 392         "return": {
 393           "type": "Boolean",
 394           "doc": "<p>True if this version if smaller than the target, false otherwise</p>\n"
 395         },
 396         "html_filename": "Version.html"
 397       },
 398       {
 399         "deprecated": null,
 400         "alias": null,
 401         "protected": false,
 402         "tagname": "method",
 403         "href": "Version.html#Ext-Version-method-match",
 404         "shortDoc": "Returns whether this version matches the supplied argument. ...",
 405         "static": false,
 406         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 407         "private": false,
 408         "params": [
 409           {
 410             "type": "String/Number",
 411             "optional": false,
 412             "doc": "<p>The version to compare with</p>\n",
 413             "name": "target"
 414           }
 415         ],
 416         "name": "match",
 417         "owner": "Ext.Version",
 418         "doc": "<p>Returns whether this version matches the supplied argument. Example:</p>\n\n<pre><code>var version = new Ext.Version('1.0.2beta');\nconsole.log(version.match(1)); // True\nconsole.log(version.match(1.0)); // True\nconsole.log(version.match('1.0.2')); // True\nconsole.log(version.match('1.0.2RC')); // False\n</code></pre>\n\n",
 419         "linenr": 153,
 420         "return": {
 421           "type": "Boolean",
 422           "doc": "<p>True if this version matches the target, false otherwise</p>\n"
 423         },
 424         "html_filename": "Version.html"
 425       },
 426       {
 427         "deprecated": null,
 428         "alias": null,
 429         "protected": false,
 430         "tagname": "method",
 431         "href": "Version.html#Ext-Version-method-setVersion",
 432         "shortDoc": "Set version number for the given package name. ...",
 433         "static": false,
 434         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 435         "private": false,
 436         "params": [
 437           {
 438             "type": "String",
 439             "optional": false,
 440             "doc": "<p>The package name, for example: 'core', 'touch', 'extjs'</p>\n",
 441             "name": "packageName"
 442           },
 443           {
 444             "type": "String/Ext.Version",
 445             "optional": false,
 446             "doc": "<p>The version, for example: '1.2.3alpha', '2.4.0-dev'</p>\n",
 447             "name": "version"
 448           }
 449         ],
 450         "name": "setVersion",
 451         "owner": "Ext.Version",
 452         "doc": "<p>Set version number for the given package name.</p>\n",
 453         "linenr": 254,
 454         "return": {
 455           "type": "Ext",
 456           "doc": "\n"
 457         },
 458         "html_filename": "Version.html"
 459       },
 460       {
 461         "deprecated": null,
 462         "alias": null,
 463         "protected": false,
 464         "tagname": "method",
 465         "href": "Version.html#Ext-Version-method-toArray",
 466         "shortDoc": "Returns this format: [major, minor, patch, build, release]. ...",
 467         "static": false,
 468         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 469         "private": false,
 470         "params": [
 471
 472         ],
 473         "name": "toArray",
 474         "owner": "Ext.Version",
 475         "doc": "<p>Returns this format: [major, minor, patch, build, release]. Useful for comparison</p>\n",
 476         "linenr": 170,
 477         "return": {
 478           "type": "Array",
 479           "doc": "\n"
 480         },
 481         "html_filename": "Version.html"
 482       }
 483     ],
 484     "property": [
 485
 486     ],
 487     "cssVar": [
 488
 489     ],
 490     "cssMixin": [
 491
 492     ],
 493     "event": [
 494
 495     ]
 496   },
 497   "singleton": false,
 498   "alias": null,
 499   "superclasses": [
 500
 501   ],
 502   "protected": false,
 503   "tagname": "class",
 504   "mixins": [
 505
 506   ],
 507   "href": "Version.html#Ext-Version",
 508   "subclasses": [
 509
 510   ],
 511   "static": false,
 512   "author": "Jacky Nguyen <jacky@sencha.com>",
 513   "component": false,
 514   "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js",
 515   "private": false,
 516   "alternateClassNames": [
 517
 518   ],
 519   "name": "Ext.Version",
 520   "doc": "<p>A utility class that wrap around a string version number and provide convenient\nmethod to perform comparison. See also: <a href=\"#/api/Ext.Version-method-compare\" rel=\"Ext.Version-method-compare\" class=\"docClass\">compare</a>. Example:</p>\n\n<pre><code>var version = new Ext.Version('1.0.2beta');\nconsole.log(\"Version is \" + version); // Version is 1.0.2beta\n\nconsole.log(version.getMajor()); // 1\nconsole.log(version.getMinor()); // 0\nconsole.log(version.getPatch()); // 2\nconsole.log(version.getBuild()); // 0\nconsole.log(version.getRelease()); // beta\n\nconsole.log(version.isGreaterThan('1.0.1')); // True\nconsole.log(version.isGreaterThan('1.0.2alpha')); // True\nconsole.log(version.isGreaterThan('1.0.2RC')); // False\nconsole.log(version.isGreaterThan('1.0.2')); // False\nconsole.log(version.isLessThan('1.0.2')); // True\n\nconsole.log(version.match(1.0)); // True\nconsole.log(version.match('1.0.2')); // True\n</code></pre>\n",
 521   "mixedInto": [
 522
 523   ],
 524   "linenr": 1,
 525   "xtypes": [
 526
 527   ],
 528   "html_filename": "Version.html",
 529   "extends": null
 530 });