Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.env.OS.js
1 Ext.data.JsonP.Ext_env_OS({
2   "tagname": "class",
3   "name": "Ext.env.OS",
4   "doc": "<p>Provide useful information about the current operating system environment. Access the global instance stored in Ext.os. Example:</p>\n\n<pre><code>if (Ext.os.is.Windows) {\n     // Windows specific code here\n}\n\nif (Ext.os.is.iOS) {\n     // iPad, iPod, iPhone, etc.\n}\n\nconsole.log(\"Version \" + Ext.os.version);\n</code></pre>\n\n\n<p>For a full list of supported values, refer to: <a href=\"#/api/Ext.env.OS-method-is\" rel=\"Ext.env.OS-method-is\" class=\"docClass\">Ext.env.OS.is</a></p>\n",
5   "extends": null,
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18
19   ],
20   "method": [
21     {
22       "tagname": "method",
23       "name": "is",
24       "member": "Ext.env.OS",
25       "doc": "<p>A \"hybrid\" property, can be either accessed as a method call, i.e:</p>\n\n<pre><code>if (Ext.os.is('Android')) { ... }\n</code></pre>\n\n\n<p>or as an object with boolean properties, i.e:</p>\n\n<pre><code>if (Ext.os.is.Android) { ... }\n</code></pre>\n\n\n<p>Versions can be conveniently checked as well. For example:</p>\n\n<pre><code>if (Ext.os.is.Android2) { ... } // Equivalent to (Ext.os.is.Android && Ext.os.version.equals(2))\n\nif (Ext.os.is.iOS32) { ... } // Equivalent to (Ext.os.is.iOS && Ext.os.version.equals(3.2))\n</code></pre>\n\n\n<p>Note that only <a href=\"#/api/Ext.Version-method-getMajor\" rel=\"Ext.Version-method-getMajor\" class=\"docClass\">major component</a>  and <a href=\"#/api/Ext.Version-method-getShortVersion\" rel=\"Ext.Version-method-getShortVersion\" class=\"docClass\">shortVersion</a>\nvalue of the version are available via direct property checking.</p>\n\n<p>Supported values are: iOS, iPad, iPhone, iPod, Android, WebOS, BlackBerry, MacOSX, Windows, Linux and Other</p>\n",
26       "params": [
27         {
28           "type": "String",
29           "name": "value",
30           "doc": "<p>The OS name to check</p>\n",
31           "optional": false
32         }
33       ],
34       "return": {
35         "type": "Boolean",
36         "doc": "\n"
37       },
38       "private": false,
39       "static": false,
40       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/env/OS.js",
41       "linenr": 39,
42       "html_filename": "OS.html",
43       "href": "OS.html#Ext-env-OS-method-is",
44       "shortDoc": "A \"hybrid\" property, can be either accessed as a method call, i.e:\n\nif (Ext.os.is('Android')) { ... }\n\n\n\nor as an obj..."
45     }
46   ],
47   "property": [
48     {
49       "tagname": "property",
50       "name": "name",
51       "member": "Ext.env.OS",
52       "type": "String",
53       "doc": "<p>Read-only - the full name of the current operating system\nPossible values are: iOS, Android, WebOS, BlackBerry, MacOSX, Windows, Linux and Other</p>\n",
54       "private": false,
55       "static": false,
56       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/env/OS.js",
57       "linenr": 68,
58       "html_filename": "OS.html",
59       "href": "OS.html#Ext-env-OS-property-name",
60       "shortDoc": "Read-only - the full name of the current operating system\nPossible values are: iOS, Android, WebOS, BlackBerry, MacOS..."
61     },
62     {
63       "tagname": "property",
64       "name": "version",
65       "member": "Ext.env.OS",
66       "type": "Ext.Version",
67       "doc": "<p>Read-only, refer to <a href=\"#/api/Ext.Version\" rel=\"Ext.Version\" class=\"docClass\">Ext.Version</a></p>\n",
68       "private": false,
69       "static": false,
70       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/env/OS.js",
71       "linenr": 75,
72       "html_filename": "OS.html",
73       "href": "OS.html#Ext-env-OS-property-version"
74     }
75   ],
76   "event": [
77
78   ],
79   "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/env/OS.js",
80   "linenr": 1,
81   "html_filename": "OS.html",
82   "href": "OS.html#Ext-env-OS",
83   "cssVar": [
84
85   ],
86   "cssMixin": [
87
88   ],
89   "component": false,
90   "superclasses": [
91
92   ],
93   "subclasses": [
94
95   ],
96   "mixedInto": [
97
98   ],
99   "allMixins": [
100
101   ]
102 });