许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名
(如果类扩展了 Ext.Component,则称为 xtype
)。别名/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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
Native 打包最重要的好处之一是能够访问 Native API。Sencha Touch 通过其 Ext.device
API 提供对 Native API 的访问。Ext.device
API 本身不提供 Native API 功能,它只是一个包装器,您可以使用它来访问由 Sencha Packager 或第三方解决方案(如 Apache Cordova 或模拟器或仿真器)驱动的 Native API。
Sencha Touch Ext.device
提供以下 API
您还可以使用 Ext.device.Device 从一个应用程序启动另一个应用程序。
注意: 有关适用于 Accelerometer、Browser、Camera、Capture、Compass、Connection、Contacts、Device、FileSystem、Geolocation、Globalization、Media、Notification、Push、Splashscreen 和 SQLite(存储)的 Apache Cordova Ext.device API,请参阅 开发 Cordova 应用。Cordova 指南还描述了如何为 Android、iOS 和 BlackBerry 模拟和打包您的应用。
因为我们希望保持应用程序的小巧,并且因为 Native API 仅适用于 Native 打包的应用程序,所以 Ext.device
API 未包含在 Sencha Touch 的标准构建中。当您要使用任何 Device API 时,必须使用 Ext.require
来引入它们
Ext.require('Ext.device.Connection');
Ext.application({
name: 'MyApp'
// the rest of your app follows
});
Connection API 确定设备当前是否在线。此 API 公开两个主要方法 - isOnline
和 getType
if (Ext.device.Connection.isOnline()) {
Ext.Msg.alert('You are currently connected via ' + Ext.device.Connection.getType());
} else {
Ext.Msg.alert('You are not currently connected');
}
这可能是 Ext.device
提供的 API 中最简单的 API。如果您在设备上或模拟器内加载此代码,您将看到一个 Sencha Touch 消息框出现,指示您处于离线状态,或者指示您的连接类型(wifi、2g、3g 等),如果您在线。有关可能的连接类型的完整列表,请参阅 Ext.device.Connection 文档。
通知用于显示 Native 对话框。通知的工作方式非常类似于 Ext.Msg,并且可以通过多种不同的方式进行配置。例如,以下示例演示了如何显示带有标题和消息的 Native 通知框
Ext.device.Notification.show({
title: 'One Button',
message: 'This is a simple notification with one button.'
});
此代码导致出现一个 Native 通知窗口,如下图所示
以下代码显示一个带有配置标题和消息的 Native 消息框。它还添加了一个“确定”按钮,以便用户可以关闭消息。当用户点击按钮时,将调用回调 - 在此示例中,我们通过打开第二个通知来响应按钮点击
Ext.device.Notification.show({
title: 'One Button',
message: 'This is a simple notification with one button.',
callback: function(button) {
//When the user taps a button, show another notification
Ext.device.Notification.show({
message: 'You pressed: "' + button + '"'
});
}
});
我们没有为第二条消息提供标题,这没问题 - 它只显示消息和一个“确定”按钮。我们可以按如下方式自定义呈现给用户的按钮
Ext.device.Notification.show({
title: 'Multiple Buttons',
message: 'This is a notification with multiple buttons.',
buttons: ["Cancel", "Login", "Another"],
callback: function(button) {
//When the user taps a button, show another notification
Ext.device.Notification.show({
message: 'You pressed: "' + button + '"'
});
}
});
这次,我们在 buttons 数组中提供了三个按钮文本字符串。当我们运行此代码时,我们现在看到按钮彼此堆叠在一起,如下图所示
通知 API 的另一项功能是使设备振动。您可以按照以下代码所示进行此操作
Ext.device.notification.vibrate();
此方法调用使设备短暂振动,并且可以根据需要经常调用。
Camera API 允许您使用手机的摄像头拍照,或者从手机上现有的照片库中选择图像。以下代码示例演示了如何拍摄新照片
Ext.device.Camera.capture({
source: 'camera',
destination: 'file',
success: function(url) {
//show the newly captured image in a full screen Ext.Img component:
Ext.create('Ext.Img', {
src: url,
fullscreen: true
});
}
});
在此示例中,我们指定了两个选项(除了我们的 success 回调)- source 和 destination。我们可以将 source 设置为“camera”或“library” - 第一个选项打开相机以拍摄新照片,第二个选项打开 Native 照片浏览器窗口以选择现有图像。此示例打开相机应用并将新图像保存到文件,最后调用我们的 success 函数,并使用该文件的本地 URL。
可以传递到 Ext.device.Camera#capture 调用的其他选项如下
success
- 如果成功获取图像,则调用。failure
- 如果无法获取图像,则调用。scope
- 设置运行 success
和 failure
函数的 this
值。quality
- 为相机提供有关图像压缩质量的提示 (0-100)。width
- 指示新图像的所需宽度,以像素为单位。height
- 指示新图像的所需高度,以像素为单位。source
- 指示“camera”或“library” - “camera”拍摄新照片,“library”选择现有照片。destination
- 指示“file”或“data” - file 返回新图像的本地 url,“data”返回图像的 Base64 编码字符串。encoding
- 指示“jpeg”、“jpg”或“png” - 前两个选项将图像编码为 JPEG,第三个选项编码为 PNG。可以将任意数量的选项传递到您的 Ext.device.Camera#capture 调用中。
Orientation API 提供有关设备当前方向的信息。此示例注册一个处理程序函数,该函数在每次检测到设备方向更改时调用
Ext.device.Orientation.on('orientation', function(e) {
var alpha = Math.round(e.alpha),
beta = Math.round(e.beta),
gamma = Math.round(e.gamma);
console.log(alpha, beta, gamma);
});
此示例提供一系列控制台消息,其中包含设备的 alpha、beta 和 gamma 方向。这些值对应于设备可以围绕其旋转的三个维度,并以 0 到 360 度表示。
您可以使用自定义 Scheme URL 从一个应用程序启动另一个应用程序
Ext.application({
name: 'Sencha',
requires: ['Ext.device.Device'],
launch: function() {
if (Ext.device.Device.scheme) {
// The application was opened via another application. Do something:
alert('Applicaton opened via another application: ' + Ext.device.Device.scheme.url);
}
// Listen for future changes
Ext.device.Device.on('schemeupdate', function(device, scheme) {
// The application was launched, closed, and then launched another from another application
// this means onReady is not called again (because the application is already running
// in the background) - but this event will be fired
alert('Applicated reopened via another application: ' + scheme.url);
}, this);
}
});
为了使此代码工作,在打包应用程序时,通过在 package.json
文件(Sencha Native Packager 配置文件)内的 rawConfig
属性中添加以下代码来添加自定义 URL
{
...
"rawConfig": "<key>CFBundleURLTypes</key><array><dict><key>CFBundleURLSchemes</key><array><string>sencha</string></array><key>CFBundleURLName</key><string>com.sencha.example</string></dict></array>"
...
}
您可以从上一个示例中更改可用的 URL scheme 和应用程序标识符。
您可以通过打包并将应用程序安装到设备或 iOS 模拟器上,打开 Safari,然后键入:sencha:testing
来测试代码。应用程序启动并显示带有指定 URL 的警报。
注意: 这目前仅适用于 Sencha Native Packager。如果您尝试在使用 Apache Cordova 打包或仅在浏览器中时监听此事件,它将不起作用。有关 Apache Cordova Ext.device.device.Cordova 事件,请参阅 开发 Cordova 应用。
现在您已经了解了如何使用 Ext.device
API 访问 Native 设备功能,请继续阅读有关 Native 打包 的指南,开始在真机上测试应用。