文档帮助

术语、图标和标签

许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称被称为 别名（如果类扩展了 Ext.Component，则为 xtype）。别名/xtype 列在适用类的类名旁边，方便快速参考。

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员应如何以及何时使用。

Public 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定且持久的内容来依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能随时更改或从框架中省略，恕不另行通知，不应在应用程序逻辑中依赖。

成员类型

Config - 类的配置选项。
Property - 类实例化后设置。*请参阅下面的只读。
Method - 类可以执行的操作。方法应被理解为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static 标签。*请参阅下面的静态。
Event - 事件是框架事件系统特有的，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但在 API 文档中没有具体描述。*对于 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架使用的视觉主题引擎使用的变量。
Theme Mixin - 框架使用的视觉主题引擎使用的函数，可能使用在各种主题变量中设置的值。

成员语法

下面是一个类成员示例，我们可以对其进行剖析以显示类成员的语法（在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法）。

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

受保护的

当原始配置对象添加到此容器时调用，无论是在初始化 items 配置期间，还是在 added) 或 {@link #insert inserted} 新项时调用。

此方法将传递的对象转换为实例化的子组件。

当需要对子组件创建应用特殊处理时，可以在子类中覆盖此方法。

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

让我们看一下成员行的每个部分

展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（在本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法的参数）将列在方法名称旁边的括号内（在本例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 javascript 对象（在本例中为 Ext.Component）。对于不返回除 undefined 以外任何内容的方法，可以省略此项，或者可以显示为由正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，则方法可能返回 Component，如果失败，则返回 false，这将显示为 Ext.Component/Boolean）。
标志 - 适用于成员的任何标志都将显示在旁边（在本例中为 PROTECTED - 请参阅下面的标志部分）
成员来源 - 在成员行的右侧是最初描述成员的类（在本例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接；如果它从祖先类或混合类继承，则显示为灰色。
成员源代码 - 在成员来源类右侧下方是一个链接，用于查看成员的源代码（示例中的 view source）
参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出（示例中的 item : Object）。
返回值 - 如果类返回除 undefined 以外的值，“返回值”部分将注明返回的类或对象类型以及描述（示例中的 Ext.Component）
Since（示例中未显示）- 某些成员将显示该成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示），就在成员描述之后
Default（示例中未显示）- 配置通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 Defaults to: false）

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

Required - 实例化类时必需的配置
Bindable - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
Read Only - 属性可以读取，但不能用于在运行时配置/重新配置类实例
Singleton - 单例类在定义后立即实例化，不能手动实例化
Static - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
Chainable - 指的是在调用时返回类实例的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
Deprecated - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将包含一条消息，指导您使用首选的类/方法。
Removed - 已删除的类或成员，仅在文档中作为在框架版本之间升级的用户的参考而存在
Template - 在基类中定义的方法，旨在由子类覆盖
Abstract - 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的（如果有）代码。特定于类的代码将通过子类中的覆盖来提供。
Preventable - 如果事件处理程序返回 false，则标记为可阻止的事件将不会触发

类图标

- 表示框架类

- 单例框架类。*有关更多信息，请参阅单例标志

- 组件类型框架类（Ext JS 框架中扩展 Ext.Component 的任何类）

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

在 API 文档页面上，类名正下方是一行按钮，对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数（此计数在应用过滤器时更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单，以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中，就在它们所作用的配置下方。Getter 和 Setter 方法文档将在配置行中找到，方便参考。

历史记录栏

您的页面历史记录保存在本地存储中，并显示在顶部标题栏正下方（使用可用的实际空间）。默认情况下，仅显示的搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的按钮并选择“全部”单选按钮来扩展显示内容。这将显示所有产品/版本的所有最近页面历史记录栏。

在历史记录配置菜单中，您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择“全部”，则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后，每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会显示产品/版本作为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上，还有一个过滤器输入字段，可使用过滤器字符串过滤成员行。除了按字符串过滤外，您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索，以便快速导航。

API 文档类元数据

每个 API 文档页面（JavaScript 原始页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

Alternate Name - 一个或多个附加的类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类具有 Ext.Button 的别名）。别名通常是为了向后兼容性而维护的。
Hierarchy - 层次结构视图列出了当前类的继承链，直到其祖先类，一直到根基类。
Mixins - 混合到当前类中的类列表
Inherited Mixins - 混合到当前类的祖先中的类列表
Requires - 实例化类所需定义的所有类
Uses - 类在其生命周期中的某个时刻可能使用的类列表，但不一定是类最初实例化所必需的
Subclasses - 扩展当前类的类

展开和折叠示例和类成员

可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。

桌面与移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面和“移动”视图之间的主要区别在于

全局导航将位于左侧菜单中，可通过汉堡菜单图标访问。菜单包含以下内容（在大多数页面上）
- 当前产品的名称（作为产品着陆页的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- （API 文档）“过滤器”选项卡，其中包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
- （API 文档）“相关类”选项卡，其中包含与当前类相关的元数据菜单
- （指南）指南的目录

查看类源代码

可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

Sencha Touch 2.4

显示私有类

顶部

在您的 Touch 应用程序中使用设备功能

在本指南中，我们将逐步介绍创建一个简单的原生 Sencha Touch 应用程序的过程，该应用程序可以访问 Android 设备的照片库和相机。在应用程序中，您可以

从照片库中选择图像
使用相机拍摄新照片。

结果图像将显示在应用程序的主面板中。

注意： 本指南仅适用于使用 Cordova 的 Android 设备。

先决条件

在继续之前，必须安装以下工具

生成您的 Touch 应用程序

打开您的 CLI 并使用 Sencha Cmd 通过发出以下命令生成一个入门应用程序

sencha -sdk /path/to/sdk generate app touchCamera /target/app/directory

注意： 请使用“touchCamera”作为您的应用程序名称，或准备好根据需要修改提供的代码。

使用示例代码更新应用程序

使用您选择的编辑器，替换应用程序视图目录中“app/view/Main.js”文件的内容。您的新代码应如下所示

Ext.define('touchCamera.view.Main', {
    extend: 'Ext.Panel',
    xtype: 'main',
    requires: [
        'Ext.Button',
        'Ext.Img'
    ],
    config: {
        layout: {
            type:"vbox",
            pack:"center",
            align:"center"
        },
        items: [{
            xtype: 'titlebar',
            docked: 'top',
            title: 'Native API Examples'
        }, {
            xtype: "image",
            src: "http://placehold.it/200x200",
            width: '100%',
            height: '100%'
        }, {
            xtype: 'toolbar',
            docked: 'bottom',
            items: [{
                xtype: "button",
                text: "Photo Library",
                handler: function(btn) {
                    var panel = btn.up('panel');

                    panel.getPhoto(navigator.camera.PictureSourceType.PHOTOLIBRARY);
                }
            }, {
                xtype: "button",
                text: "Take Photo",
                handler: function(btn) {
                    var panel = btn.up('panel');

                    panel.getPhoto(navigator.camera.PictureSourceType.CAMERA);
                }
            }]
        }]
    },

    getPhoto: function(source) {
        var me = this;

        navigator.camera.getPicture(me.success, me.failure, {
            quality: 50,
            destinationType: navigator.camera.DestinationType.FILE_URI,
            sourceType: source 
        });

    },

    success: function(image_uri) {
        var img = Ext.ComponentQuery.query("image")[0];
        img.setSrc(image_uri);
    },

    failure: function(message) {
        alert("Failed" + message);
    }
});

创建和设置 Cordova 环境

下一步是在应用程序文件夹中创建一个 Cordova 项目。Cordova 可以访问原生 Android API，以便应用程序可以与设备照片库和相机交互。

更改到“sencha generate app”生成应用程序的目录。
```
 cd /target/app/directory
```
在您的应用程序目录中创建一个 Cordova 项目。
```
 sencha cordova init
```
您现在应该看到 Cordova 目录已在您的应用程序目录中创建。需要根据您的应用程序需要访问的设备 API 更新为项目创建的默认配置文件。您还必须包含应用程序正常运行所需的设备权限。

此过程还会更新应用程序中的 app.json 文件，以包含“builds”配置块。需要更新此块以反映您的应用程序正在创建的构建类型。

编辑 app.json 文件并更新“builds”块，使其看起来像以下示例。

注意： 在下面的示例中，我们指定了一个新的构建目标“android”，它将使用 Cordova 打包器并在 android 平台上运行

     "builds": {
        "web": {"default": true},
        "android": { // This can be any build target name you desire (eg myApp, apple, etc)
             "packager": "cordova", // Specify that we are using cordova to package the app
             "cordova" : { // configuration for cordova build
                 "config": {
                      "id": "com.domain.touchCamera",  // namespace of application (required)
                      "name": "touchCamera",  // app name which appears under the icon on device
                      "platforms": "android" // add platform(s) here
                 }
            }
         }
     },

CD 进入“cordova”目录
```
 cd cordova
```
应用程序中使用的每个 API 都需要将其对应的插件添加到项目中。在此示例中，使用了相机。要添加相机插件，请在“cordova”目录中发出以下命令
```
 cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git 
```

验证插件是否已添加到“cordova”项目

 cordova plugin list 
 //org.apache.cordova.camera 0.3.4-dev "Camera"

接下来，让我们告诉 Cordova 应用程序将使用相机插件，方法是将以下信息添加到 config.xml 文件中

 <feature name="Camera"> 
     <param name="android-package" value="org.apache.cordova.camera.CameraLauncher" /> 
 </feature>

将写入权限添加到“cordova/platforms/android”中的 AndroidManifest.xml 文件，以便相机可以将图片保存到设备。以下行需要添加到文件中，紧跟在关于 android.permission.INTERNET 的行之后。
```
 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> 
```

构建您的 Android 包

在配置文件已使用适当的权限和功能信息更新后，更改回主应用程序目录并构建应用程序

cd ..
sencha app build android

成功构建将导致在此处创建 Android 包 (APK)

cordova/platforms/android/ant-build

您可以使用以下命令验证其存在

find . name -name *.apk
//./cordova/platforms/android/ant-build/touchCamera-debug-unaligned.apk
//./cordova/platforms/android/ant-build/touchCamera-debug.apk

连接设备

在安装之前，请确保

Android 设备已连接
已启用 Android 调试
Android 设备已获得连接计算机的授权。

接下来，通过发出以下命令确保开发计算机可以看到连接的 Android 设备

adb devices
//* daemon not running. starting it now on port 5037 *
//* daemon started successfully *
//List of devices attached 
//015d262e99100202    device

以上输出显示一台 Android 设备已连接到计算机。

注意： 您的设备编号将与上面找到的编号不同。

如果您没有看到列出的设备，请检查您的连接、设备权限和调试状态。安装应用程序

通过发出以下命令将软件包移动到 Android 设备

$ adb install -r cordova/platforms/android/ant-build/touchCamera-debug.apk 
//1284 KB/s (2446896 bytes in 1.860s)
//pkg: /data/local/tmp/touchCamera-debug.apk
//Success

启动 Touch 应用程序

如果之前的 adb 安装命令成功执行，则 Touch 应用程序将出现在 Android 设备的应用程序部分中。标准的 Cordova 图标将出现，图标下的名称将为 touchCamera。点击图标以启动 Touch 应用程序。

应用程序将在屏幕底部有两个按钮。第一个按钮打开照片库，第二个按钮启动相机。

触摸任一按钮以查看应用程序的运行情况。从照片库或相机返回后，所选图片将显示在应用程序中间的图像块中。

目录

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例和类成员

桌面与移动视图

查看类源代码

Sencha Touch 2.4

目录

在您的 Touch 应用程序中使用设备功能

先决条件

生成您的 Touch 应用程序

使用示例代码更新应用程序

创建和设置 Cordova 环境

构建您的 Android 包

连接设备

启动 Touch 应用程序

Sencha Touch 2.4