文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为私有受保护。否则,类/成员为公有公有受保护私有是访问描述符,用于传达如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

在初始化items配置期间或添加新项目或{@link #insert 插入}时,将原始配置对象添加到此容器中时调用。

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

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

参数

项目 对象

正在添加的配置对象。

返回
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

可以通过单击 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”目录中。以下列表提供了每个选项的其他详细信息

  • 类型:“核心”或“全部” - 核心包括基本类,但不包括任何组件,全部意味着包含所有内容
  • 加载器:是否激活动态加载。默认情况下,只有 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