文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 privateprotected。否则,类/成员为 publicPublicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

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

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

当需要对子创建应用特殊处理时,可以在子类中重写此方法。

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

- Singleton 框架类。*有关更多信息,请参阅 singleton 标志

- 组件类型框架类(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 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例及类成员

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

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

桌面与移动视图

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

查看类源代码

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

Sencha Touch 2.4


顶部

使用和创建构建

Sencha Touch 附带一个类系统,该系统具有在需要时动态加载类的能力。这种方法在开发和生产中都有许多好处。

在开发中,动态加载意味着您将获得一个文件接一个文件的堆栈跟踪,这使得调试应用程序问题变得更加容易。对于生产,我们提供了一个构建工具,使您能够轻松创建最小化的自定义构建,该构建仅包含您的应用程序实际使用的类,这意味着通常可以缩短用户的加载时间。

注意: 如果您首先使用 sencha cordova initsencha phonegap init 命令初始化这些功能,则可以将 sencha app build [-run] native 构建命令与 Cordova 或 PhoneGap 一起使用。

有关更多信息,请参阅 Cordova 和 PhoneGap 应用

选择构建

Sencha Touch 开箱即用地提供了五个构建版本。如果您想尽快启动并运行,最好在本地开发应用程序时使用 sencha-touch-debug.js,然后在生产环境中切换到 sencha-touch.js。其他三个构建版本非常适合在生产环境中进行调试、在没有自定义构建的情况下在生产环境中运行以及将您的 Touch 1.x 应用程序迁移到 2.x。

由于每个构建版本都用于不同的目的,并且是使用一组不同的构建选项创建的,因此我们创建了一个表格,详细说明了每个构建版本的配置

名称 类型 加载器 最小化 注释 调试 兼容性 用途
sencha-touch-debug.js 核心 在本地开发应用程序时使用
sencha-touch.js 核心 在生产环境中与自定义构建一起使用
sencha-touch-all.js 全部 如果您没有自定义构建,则在生产环境中使用
sencha-touch-all-debug.js 全部 用于在暂存/生产环境中调试您的应用程序
builds/sencha-touch-all-compat.js 全部 用于将您的 1.x 应用程序迁移到 2.x

注意: 只有 sencha-touch-all-compat.js 包含在 SDK 下载的“builds”目录中。以下列表提供了有关每个选项的更多详细信息

  • 类型: “Core”或“All” - Core 包括基类,但不包括组件,All 表示包含所有内容
  • 加载器: 是否激活动态加载。默认情况下,只有 sencha-touch-debug.js 激活了此功能
  • 最小化: 表示构建已使用 YUI(Yahoo 用户界面)压缩器压缩
  • 注释: 表示构建仍然包含 JSDoc 注释(这些注释通常在生产环境中剥离以加快下载速度)
  • 调试: 表示构建提供调试消息,例如,如果您错误配置了类
  • 兼容性: 表示代码在构建中提供了与 Sencha Touch 1.x 的向后兼容性

在开发模式下使用 sencha-touch-debug.js,然后在生产环境中切换到 sencha-touch.js 或 sencha-touch-all.js 以及自定义构建。

创建您自己的构建

在绝大多数情况下,Sencha Touch 应用程序应在生产环境中使用自定义构建,原因有两个

  1. 自定义构建包含您的应用程序实际使用的框架类,从而节省了下载时间
  2. 自定义构建将您的所有应用程序类包含在一个文件中,这转化为单个网络请求

对于已部署的应用程序,第二个原因最为重要。由于大多数应用程序都有大量文件(有时是数百个),因此逐个加载它们,尤其是在移动连接上,可能需要很长时间。每个请求可能会增加数百毫秒的延迟,这很容易使应用程序的总体加载时间增加几秒钟。

为了在生产环境中快速加载您的应用程序,请使用 Sencha 的命令行构建工具 Sencha Cmd,它

  1. 确定您的应用程序使用的框架类
  2. 在您的应用程序启动时加载应用程序类
  3. 将所有类合并到一个文件中,并按正确的顺序排列类
  4. 剥离所有 JSDoc 注释并将文件最小化,使其尽可能小

安装 Sencha Cmd

确保您下载并安装了 Sencha Cmd

生成构建

我们假设您已经有一个在本地工作的应用程序,并且您只想为生产环境构建它。如果您还没有应用程序,或者不知道如何创建一个应用程序,请查看 入门 指南。

假设您的应用程序在本地工作,让我们继续。为了说明其工作原理,我们将使用 Sencha Touch SDK 附带的 Twitter 示例。查看示例的 index.html 文件

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>Twitter</title>

    <link rel="stylesheet" href="resources/css/application.css" type="text/css">

    <script type="text/javascript" src="touch/sencha-touch-debug.js"></script>
    <script type="text/javascript" src="app.js"></script>
</head>
<body></body>
</html>

注意: 我们加载了 sencha-touch-debug.js 和 app.js,这使我们可以在开发应用程序时使用动态加载。这是 Sencha Cmd 生成最小构建能力的基础。

在命令行中,将目录更改为包含您的应用程序的硬盘驱动器目录

cd ~/path/to/my/app

要生成与本机打包程序兼容的构建,请使用以下命令之一

  • sencha app build native
    • 构建应用程序并准备一个名为 packager.temp.json 的文件,您可以使用该文件打包应用程序--packager.temp.json 与 packager.json 相同,但包含其他路径。使用 sencha app package run packager.temp.json 命令来运行打包程序并启动模拟器。
  • sencha app build -run native

    • 构建并自动打包应用程序,并启动相应的模拟器
  • sencha app build package

    • 构建具有打包支持的应用程序,但不配置打包程序 JSON 文件。
      这对于手动维护多个 packager.json 文件(android.json、ios.json 等)的项目很有用。

    • 适用于持续集成构建,其中构建可能运行一次,然后打包多次,例如

      • sencha app build package
      • sencha app package build android.json
      • sencha app package build ios.json

注意: 如果您首先使用 sencha cordova initsencha phonegap init 命令初始化这些功能,则可以将“sencha app build [-run] native”命令与 Cordova 或 PhoneGap 一起使用。有关更多信息,请参阅 Cordova 和 PhoneGap 应用

更新您的 HTML 文件

为生产环境准备应用程序的最后一步是更新您的 HTML 文件以使用 sencha-touch.js 而不是 sencha-touch-debug.js,并加载您新生成的 all-classes.js 文件。twitter 示例文件最终如下所示

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>Twitter</title>

    <link rel="stylesheet" href="resources/css/application.css" type="text/css">

    <script type="text/javascript" src="touch/sencha-touch.js"></script>
    <script type="text/javascript" src="all-classes.js"></script>
    <script type="text/javascript" src="app.js"></script>
</head>
<body></body>
</html>

与其一直更改您的主 index.html 文件,不如创建一个名为 index-production.html 的副本,该副本看起来像上一个文件,这很常见。许多开发人员生成一个简单的部署脚本,该脚本自动将应用程序复制到部署文件夹中,并将 index-production.html 重命名为 index.html,以便可以上传构建。

Sencha Touch 2.4