许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias
(或 xtype
,如果该类扩展了 Ext.Component)。alias/xtype 列在适用类的类名旁边,以供快速参考。
框架类或其成员可以指定为 private
或 protected
。否则,类/成员为 public
。Public
、protected
和 private
是访问描述符,用于传达应如何以及何时使用类或类成员。
Public 类和类成员可供任何其他类或应用程序代码使用,并且在主要产品版本中可以作为稳定且持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用,不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略,恕不另行通知,并且不应在应用程序逻辑中依赖。
static
标签。*见下面的静态。下面是一个示例类成员,我们可以对其进行剖析,以显示类成员的语法(在本例中为从 Ext.button.Button 类查看的 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回除 undefined
以外的任何内容的方法,可以省略此项,或者可以显示为用正斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,方法可能会返回 Component,如果失败,则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的标志部分)Ext.container.Container
)。如果成员来自当前类,则源类将显示为蓝色链接;如果成员是从祖先类或混合类继承的,则显示为灰色。view source
)item : Object
)。undefined
以外的值,“返回”部分将注释返回的类或对象类型以及描述(示例中为 Ext.Component
)Available since 3.4.0
- 在示例中未显示)紧随成员描述之后Defaults to: false
)API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息,请参阅 singleton 标志
- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示 config
类型的类成员
- 表示 property
类型的类成员
- 表示 method
类型的类成员
- 表示 event
类型的类成员
- 表示 theme variable
类型的类成员
- 表示 theme mixin
类型的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上的类名称正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型计数的成员数(此计数会随着过滤器的应用而更新)。单击该按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类配置选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分,就在它们所处理的配置下方。Getter 和 setter 方法文档将在配置行中找到,以便于参考。
您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(JavaScript 原始页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名)。通常维护备用类名以实现向后兼容性。可运行示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或右上角的展开/折叠所有切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名称来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
通常,在构建以移动设备为目标的应用程序时,您需要了解有关应用程序运行环境的特定信息。可能是浏览器类型、设备名称,或者特定功能是否可用。Sencha Touch 中的环境包为您提供了一个 API,您可以使用该 API 查找所有这些信息。
您可以使用 Ext.os.name
检测您的应用程序正在其上运行的操作系统。这将返回以下值之一
您还可以使用 Ext.os.is
singleton 检查当前操作系统是否与某个操作系统匹配。例如,如果您想检查当前操作系统是否为 Android 或 Mac OS,您可以使用以下代码
if (Ext.os.is.Android) {
// ...
}
if (Ext.os.is.MacOS) {
// ...
}
您还可以使用它来检测设备是否为 iPhone、iPad 或 iPod,方法如下所示 Ext.os.is
if (Ext.os.is.iPad) {
// ...
}
也可以使用以下 Ext.os.version
调用访问操作系统的版本
alert('You are running: ' + Ext.os.name + ', version ' + Ext.os.version.version);
您还可以通过使用 Ext.browser.name
查找有关您正在运行应用程序的浏览器的信息。可用值的列表如下
您还可以使用 Ext.browser.is
检查当前浏览器是否为上述值之一
if (Ext.browser.is.Chrome) {
// ...
}
Ext.browser.is
singleton 还提供了有关当前浏览器的其他有用信息,这些信息可能对您的应用程序有用
Ext.browser.userAgent
- 返回当前 userAgentExt.browser.isSecure
- 如果当前页面正在使用 SSL,则返回 trueExt.browser.isStrict
- 如果浏览器处于严格模式,则返回 trueExt.browser.engineName
- 返回浏览器引擎名称 (WebKit
, Gecko
, Presto
, Trident
和 Other
)Ext.browser.engineVersion
- 返回浏览器引擎的版本您可以使用 Ext.feature singleton 检查是否存在某些浏览器功能。例如,如果您想检查浏览器是否支持 canvas,您可以检查使用以下代码
if (Ext.feature.has.Canvas) {
// ...
}
可用的功能如下