X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.Version.js diff --git a/docs/output/Ext.Version.js b/docs/output/Ext.Version.js index 1c2320d9..87497d7f 100644 --- a/docs/output/Ext.Version.js +++ b/docs/output/Ext.Version.js @@ -1,530 +1 @@ -Ext.data.JsonP.Ext_Version({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": "Jacky Nguyen ", - "members": { - "cfg": [ - - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "Version.html#Ext-Version-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": " ...", - "static": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

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

\n", - "name": "version" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "doc": "\n", - "owner": "Ext.Version", - "name": "Version", - "html_filename": "Version.html", - "return": { - "type": "Ext.Version", - "doc": "

this

\n" - }, - "linenr": 35 - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-compare", - "shortDoc": "Compare 2 specified versions, starting from left to right. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The current version to compare to

\n", - "name": "current" - }, - { - "type": "String", - "optional": false, - "doc": "

The target version to compare to

\n", - "name": "target" - } - ], - "name": "compare", - "owner": "Ext.Version", - "doc": "

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' < 'alpha' = 'a' < 'beta' = 'b' < 'RC' = 'rc' < '#' < 'pl' = 'p' < 'anything else'

\n", - "linenr": 212, - "return": { - "type": "Number", - "doc": "

Returns -1 if the current version is smaller than the target version, 1 if greater, and 0 if they're equivalent

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-deprecate", - "shortDoc": "Create a closure for deprecated code. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The package name

\n", - "name": "packageName" - }, - { - "type": "String", - "optional": false, - "doc": "

The last version before it's deprecated

\n", - "name": "since" - }, - { - "type": "Function", - "optional": false, - "doc": "

The callback function to be executed with the specified version is less than the current version

\n", - "name": "closure" - }, - { - "type": "Object", - "optional": false, - "doc": "

The execution scope (this) if the closure

\n", - "name": "scope" - } - ], - "name": "deprecate", - "owner": "Ext.Version", - "doc": "

Create a closure for deprecated code.

\n\n
// 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
\n", - "linenr": 283, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-equals", - "shortDoc": "Returns whether this version equals to the supplied argument ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

The version to compare with

\n", - "name": "target" - } - ], - "name": "equals", - "owner": "Ext.Version", - "doc": "

Returns whether this version equals to the supplied argument

\n", - "linenr": 144, - "return": { - "type": "Boolean", - "doc": "

True if this version equals to the target, false otherwise

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getBuild", - "shortDoc": "Returns the build component value ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "getBuild", - "owner": "Ext.Version", - "doc": "

Returns the build component value

\n", - "linenr": 110, - "return": { - "type": "Number", - "doc": "

build

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getComponentValue", - "shortDoc": "Converts a version component to a comparable value ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The value to convert

\n", - "name": "value" - } - ], - "name": "getComponentValue", - "owner": "Ext.Version", - "doc": "

Converts a version component to a comparable value

\n", - "linenr": 201, - "return": { - "type": "Mixed", - "doc": "\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getMajor", - "shortDoc": "Returns the major component value ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "getMajor", - "owner": "Ext.Version", - "doc": "

Returns the major component value

\n", - "linenr": 86, - "return": { - "type": "Number", - "doc": "

major

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getMinor", - "shortDoc": "Returns the minor component value ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "getMinor", - "owner": "Ext.Version", - "doc": "

Returns the minor component value

\n", - "linenr": 94, - "return": { - "type": "Number", - "doc": "

minor

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getPatch", - "shortDoc": "Returns the patch component value ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "getPatch", - "owner": "Ext.Version", - "doc": "

Returns the patch component value

\n", - "linenr": 102, - "return": { - "type": "Number", - "doc": "

patch

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getRelease", - "shortDoc": "Returns the release component value ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "getRelease", - "owner": "Ext.Version", - "doc": "

Returns the release component value

\n", - "linenr": 118, - "return": { - "type": "Number", - "doc": "

release

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getShortVersion", - "shortDoc": "Returns shortVersion version without dots and release ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "getShortVersion", - "owner": "Ext.Version", - "doc": "

Returns shortVersion version without dots and release

\n", - "linenr": 178, - "return": { - "type": "String", - "doc": "\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-getVersion", - "shortDoc": "Get the version number of the supplied package name; will return the last registered version\n(last Ext.setVersion cal...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

(Optional) The package name, for example: 'core', 'touch', 'extjs'

\n", - "name": "packageName" - } - ], - "name": "getVersion", - "owner": "Ext.Version", - "doc": "

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.

\n", - "linenr": 268, - "return": { - "type": "Ext.Version", - "doc": "

The version

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-isGreaterThan", - "shortDoc": "Returns whether this version if greater than the supplied argument ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

The version to compare with

\n", - "name": "target" - } - ], - "name": "isGreaterThan", - "owner": "Ext.Version", - "doc": "

Returns whether this version if greater than the supplied argument

\n", - "linenr": 126, - "return": { - "type": "Boolean", - "doc": "

True if this version if greater than the target, false otherwise

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-isLessThan", - "shortDoc": "Returns whether this version if smaller than the supplied argument ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

The version to compare with

\n", - "name": "target" - } - ], - "name": "isLessThan", - "owner": "Ext.Version", - "doc": "

Returns whether this version if smaller than the supplied argument

\n", - "linenr": 135, - "return": { - "type": "Boolean", - "doc": "

True if this version if smaller than the target, false otherwise

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-match", - "shortDoc": "Returns whether this version matches the supplied argument. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

The version to compare with

\n", - "name": "target" - } - ], - "name": "match", - "owner": "Ext.Version", - "doc": "

Returns whether this version matches the supplied argument. Example:

\n\n
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
\n\n", - "linenr": 153, - "return": { - "type": "Boolean", - "doc": "

True if this version matches the target, false otherwise

\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-setVersion", - "shortDoc": "Set version number for the given package name. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The package name, for example: 'core', 'touch', 'extjs'

\n", - "name": "packageName" - }, - { - "type": "String/Ext.Version", - "optional": false, - "doc": "

The version, for example: '1.2.3alpha', '2.4.0-dev'

\n", - "name": "version" - } - ], - "name": "setVersion", - "owner": "Ext.Version", - "doc": "

Set version number for the given package name.

\n", - "linenr": 254, - "return": { - "type": "Ext", - "doc": "\n" - }, - "html_filename": "Version.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Version.html#Ext-Version-method-toArray", - "shortDoc": "Returns this format: [major, minor, patch, build, release]. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "params": [ - - ], - "name": "toArray", - "owner": "Ext.Version", - "doc": "

Returns this format: [major, minor, patch, build, release]. Useful for comparison

\n", - "linenr": 170, - "return": { - "type": "Array", - "doc": "\n" - }, - "html_filename": "Version.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Version.html#Ext-Version", - "subclasses": [ - - ], - "static": false, - "author": "Jacky Nguyen ", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/version/Version.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.Version", - "doc": "

A utility class that wrap around a string version number and provide convenient\nmethod to perform comparison. See also: compare. Example:

\n\n
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
\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Version.html", - "extends": null -}); \ No newline at end of file +Ext.data.JsonP.Ext_Version({"tagname":"class","html":"
Files
Version.js

A utility class that wrap around a string version number and provide convenient\nmethod to perform comparison. See also: compare. Example:

\n\n
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
\n

Methods

Defined By

Instance Methods

Ext.Version
view source
new( String/Number version ) : Ext.Version
...
\n

Parameters

  • version : String/Number

    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

    \n

Returns

Ext.Version
view source
( String packageName, String since, Function closure, Object scope )
Create a closure for deprecated code. ...

Create a closure for deprecated code.

\n\n
// 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
\n

Parameters

  • packageName : String

    The package name

    \n
  • since : String

    The last version before it's deprecated

    \n
  • closure : Function

    The callback function to be executed with the specified version is less than the current version

    \n
  • scope : Object

    The execution scope (this) if the closure

    \n
Ext.Version
view source
( String/Number target ) : Boolean
Returns whether this version equals to the supplied argument ...

Returns whether this version equals to the supplied argument

\n

Parameters

Returns

  • Boolean

    True if this version equals to the target, false otherwise

    \n
Ext.Version
view source
( ) : Number
Returns the build component value ...

Returns the build component value

\n

Returns

Ext.Version
view source
( ) : Number
Returns the major component value ...

Returns the major component value

\n

Returns

Ext.Version
view source
( ) : Number
Returns the minor component value ...

Returns the minor component value

\n

Returns

Ext.Version
view source
( ) : Number
Returns the patch component value ...

Returns the patch component value

\n

Returns

Ext.Version
view source
( ) : Number
Returns the release component value ...

Returns the release component value

\n

Returns

Ext.Version
view source
( ) : String
Returns shortVersion version without dots and release ...

Returns shortVersion version without dots and release

\n

Returns

Ext.Version
view source
( [String packageName] ) : Ext.Version
Get the version number of the supplied package name; will return the last registered version\n(last Ext.setVersion cal...

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.

\n

Parameters

  • packageName : String (optional)

    The package name, for example: 'core', 'touch', 'extjs'

    \n

Returns

Ext.Version
view source
( String/Number target ) : Boolean
Returns whether this version if greater than the supplied argument ...

Returns whether this version if greater than the supplied argument

\n

Parameters

Returns

  • Boolean

    True if this version if greater than the target, false otherwise

    \n
Ext.Version
view source
( String/Number target ) : Boolean
Returns whether this version if smaller than the supplied argument ...

Returns whether this version if smaller than the supplied argument

\n

Parameters

Returns

  • Boolean

    True if this version if smaller than the target, false otherwise

    \n
Ext.Version
view source
( String/Number target ) : Boolean
Returns whether this version matches the supplied argument. ...

Returns whether this version matches the supplied argument. Example:

\n\n
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
\n\n

Parameters

Returns

  • Boolean

    True if this version matches the target, false otherwise

    \n
Ext.Version
view source
( String packageName, String/Ext.Version version ) : Ext
Set version number for the given package name. ...

Set version number for the given package name.

\n

Parameters

  • packageName : String

    The package name, for example: 'core', 'touch', 'extjs'

    \n
  • version : String/Ext.Version

    The version, for example: '1.2.3alpha', '2.4.0-dev'

    \n

Returns

Ext.Version
view source
( ) : Number[]
Returns this format: [major, minor, patch, build, release]. ...

Returns this format: [major, minor, patch, build, release]. Useful for comparison

\n

Returns

Defined By

Static Methods

Ext.Version
view source
( String current, String target ) : Numberstatic
Compare 2 specified versions, starting from left to right. ...

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' < 'alpha' = 'a' < 'beta' = 'b' < 'RC' = 'rc' < '#' < 'pl' = 'p' < 'anything else'

\n

Parameters

  • current : String

    The current version to compare to

    \n
  • target : String

    The target version to compare to

    \n

Returns

  • Number

    Returns -1 if the current version is smaller than the target version, 1 if greater, and 0 if they're equivalent

    \n
Ext.Version
view source
( Object value ) : Objectstatic
Converts a version component to a comparable value ...

Converts a version component to a comparable value

\n

Parameters

  • value : Object

    The value to convert

    \n

Returns

","allMixins":[],"meta":{"author":["Jacky Nguyen "],"docauthor":["Jacky Nguyen "]},"requires":[],"deprecated":null,"extends":null,"inheritable":false,"static":false,"superclasses":[],"singleton":false,"code_type":"nop","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"compare","id":"static-method-compare"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getComponentValue","id":"static-method-getComponentValue"}],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"deprecate","id":"method-deprecate"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"equals","id":"method-equals"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getBuild","id":"method-getBuild"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getMajor","id":"method-getMajor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getMinor","id":"method-getMinor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getPatch","id":"method-getPatch"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getRelease","id":"method-getRelease"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getShortVersion","id":"method-getShortVersion"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"getVersion","id":"method-getVersion"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"isGreaterThan","id":"method-isGreaterThan"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"isLessThan","id":"method-isLessThan"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"match","id":"method-match"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"setVersion","id":"method-setVersion"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Version","template":false,"required":null,"protected":false,"name":"toArray","id":"method-toArray"}],"event":[]},"private":false,"component":false,"name":"Ext.Version","alternateClassNames":[],"id":"class-Ext.Version","mixedInto":[],"xtypes":{},"files":[{"href":"Version.html#Ext-Version","filename":"Version.js"}]}); \ No newline at end of file