X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.Version.js?ds=sidebyside diff --git a/docs/output/Ext.Version.js b/docs/output/Ext.Version.js new file mode 100644 index 00000000..a5a69374 --- /dev/null +++ b/docs/output/Ext.Version.js @@ -0,0 +1,477 @@ +Ext.data.JsonP.Ext_Version({ + "tagname": "class", + "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", + "extends": null, + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": "Jacky Nguyen ", + "docauthor": "Jacky Nguyen ", + "singleton": false, + "private": false, + "cfg": [ + + ], + "method": [ + { + "tagname": "method", + "name": "Version", + "member": "Ext.Version", + "doc": "\n", + "params": [ + { + "type": "String/Number", + "name": "version", + "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", + "optional": false + }, + { + "type": "Object", + "name": "version", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.Version", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 35, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-constructor", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "compare", + "member": "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", + "params": [ + { + "type": "String", + "name": "current", + "doc": "

The current version to compare to

\n", + "optional": false + }, + { + "type": "String", + "name": "target", + "doc": "

The target version to compare to

\n", + "optional": false + } + ], + "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" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 214, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-compare", + "shortDoc": "Compare 2 specified versions, starting from left to right. If a part contains special version strings,\nthey are handl..." + }, + { + "tagname": "method", + "name": "deprecate", + "member": "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", + "params": [ + { + "type": "String", + "name": "packageName", + "doc": "

The package name

\n", + "optional": false + }, + { + "type": "String", + "name": "since", + "doc": "

The last version before it's deprecated

\n", + "optional": false + }, + { + "type": "Function", + "name": "closure", + "doc": "

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

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

The execution scope (this) if the closure

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 285, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-deprecate", + "shortDoc": "Create a closure for deprecated code.\n\n// This means Ext.oldMethod is only supported in 4.0.0beta and older.\n// If Ex..." + }, + { + "tagname": "method", + "name": "equals", + "member": "Ext.Version", + "doc": "

Returns whether this version equals to the supplied argument

\n", + "params": [ + { + "type": "String/Number", + "name": "target", + "doc": "

The version to compare with

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

True if this version equals to the target, false otherwise

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 146, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-equals", + "shortDoc": "

Returns whether this version equals to the supplied argument

\n" + }, + { + "tagname": "method", + "name": "getBuild", + "member": "Ext.Version", + "doc": "

Returns the build component value

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "

build

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 112, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getBuild", + "shortDoc": "

Returns the build component value

\n" + }, + { + "tagname": "method", + "name": "getComponentValue", + "member": "Ext.Version", + "doc": "

Converts a version component to a comparable value

\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "

The value to convert

\n", + "optional": false + } + ], + "return": { + "type": "Mixed", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 203, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getComponentValue", + "shortDoc": "

Converts a version component to a comparable value

\n" + }, + { + "tagname": "method", + "name": "getMajor", + "member": "Ext.Version", + "doc": "

Returns the major component value

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "

major

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 88, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getMajor", + "shortDoc": "

Returns the major component value

\n" + }, + { + "tagname": "method", + "name": "getMinor", + "member": "Ext.Version", + "doc": "

Returns the minor component value

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "

minor

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 96, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getMinor", + "shortDoc": "

Returns the minor component value

\n" + }, + { + "tagname": "method", + "name": "getPatch", + "member": "Ext.Version", + "doc": "

Returns the patch component value

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "

patch

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 104, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getPatch", + "shortDoc": "

Returns the patch component value

\n" + }, + { + "tagname": "method", + "name": "getRelease", + "member": "Ext.Version", + "doc": "

Returns the release component value

\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "

release

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 120, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getRelease", + "shortDoc": "

Returns the release component value

\n" + }, + { + "tagname": "method", + "name": "getShortVersion", + "member": "Ext.Version", + "doc": "

Returns shortVersion version without dots and release

\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 180, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-getShortVersion", + "shortDoc": "

Returns shortVersion version without dots and release

\n" + }, + { + "tagname": "method", + "name": "getVersion", + "member": "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", + "params": [ + { + "type": "String", + "name": "packageName", + "doc": "

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

\n", + "optional": false + } + ], + "return": { + "type": "Ext.Version", + "doc": "

The version

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 270, + "html_filename": "Version.html", + "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..." + }, + { + "tagname": "method", + "name": "isGreaterThan", + "member": "Ext.Version", + "doc": "

Returns whether this version if greater than the supplied argument

\n", + "params": [ + { + "type": "String/Number", + "name": "target", + "doc": "

The version to compare with

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

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

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 128, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-isGreaterThan", + "shortDoc": "

Returns whether this version if greater than the supplied argument

\n" + }, + { + "tagname": "method", + "name": "isLessThan", + "member": "Ext.Version", + "doc": "

Returns whether this version if smaller than the supplied argument

\n", + "params": [ + { + "type": "String/Number", + "name": "target", + "doc": "

The version to compare with

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

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

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 137, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-isLessThan", + "shortDoc": "

Returns whether this version if smaller than the supplied argument

\n" + }, + { + "tagname": "method", + "name": "match", + "member": "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", + "params": [ + { + "type": "String/Number", + "name": "target", + "doc": "

The version to compare with

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

True if this version matches the target, false otherwise

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 155, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-match", + "shortDoc": "Returns whether this version matches the supplied argument. Example:\n\nvar version = new Ext.Version('1.0.2beta');\ncon..." + }, + { + "tagname": "method", + "name": "setVersion", + "member": "Ext.Version", + "doc": "

Set version number for the given package name.

\n", + "params": [ + { + "type": "String", + "name": "packageName", + "doc": "

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

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

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

\n", + "optional": false + } + ], + "return": { + "type": "Ext", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 256, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-setVersion", + "shortDoc": "

Set version number for the given package name.

\n" + }, + { + "tagname": "method", + "name": "toArray", + "member": "Ext.Version", + "doc": "

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

\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 172, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version-method-toArray", + "shortDoc": "

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

\n" + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/version/Version.js", + "linenr": 1, + "html_filename": "Version.html", + "href": "Version.html#Ext-Version", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file