文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

在初始化items配置期间或添加新项目时将原始配置对象添加到此容器时调用,或者added),或 {@link #insert inserted

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

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

参数

item :  Object

正在添加的配置对象。

返回
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 基本类型页面)都有一个与该类相关的元数据的菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

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

Sencha Touch 2.4


顶部

创建你的第一个应用

本指南帮助你为移动设备创建第一个应用。

在开始之前,请确保你已安装 Sencha Touch 要求的所有适当软件。这些要求在 入门指南 中列出。

创建一个启动环境

选择或创建一个目录,你的应用程序将驻留在其中,更改到该目录,并发出以下命令

 $ sencha -sdk /path/to/touch generate app MyApp .

其中

  1. /path/to/touch 是你解压 Touch 软件的目录。
  2. MyApp 是你给你的应用程序的名称。

这将生成一个以 MyApp 变量命名并位于当前目录中的 Sencha Touch 应用程序启动名称空间。

启动应用程序包含创建 Sencha Touch 应用程序所需的所有文件,包括默认的 index.html 文件、Touch SDK 的副本、CSS 文件以及用于为你的应用程序创建原生包的图像和配置文件。

你可以通过在网络浏览器中打开它来验证你的应用程序是否已成功生成。如果你将 SDK 提取到你的 webroot 文件夹,请导航到 http://localhost/MyApp。如果你使用 Sencha Cmd web 服务器,则可以使用 http://localhost:1841/ URL 访问已服务的应用程序。

我们正在创建什么

我们正在创建一个简单的移动网络应用程序,用于公司的移动网站。该应用程序包括一个主页、一个联系表单和一个简单的列表,该列表获取 Sencha 的最新博客文章,并允许访问者在移动设备上阅读它们。

解压 Sencha Touch 后,您可以用以下示例替换 app.js 文件中的代码。

注意app.js 文件中的起始内容包含额外的代码,对于此示例,您可以忽略它们。

以下是一个交互式示例应用程序,您可以更改代码并预览结果

入门

由于该应用程序使用包含四个页面的 选项卡面板,因此我们首先创建 UI。Sencha Touch 的入口点是 Ext.application 的 launch 函数。将其视为应用程序的 main 部分,以及包含应用程序逻辑的位置。

如果您在浏览器中运行此代码(通过单击预览按钮),则 Ext.tab.Panel 将出现在屏幕顶部。由于主页可能更受欢迎,因此向其中添加一些内容并将选项卡栏重新定位到页面底部。默认情况下,选项卡栏位于页面顶部,但设置 tabBarPosition 配置会将其移动到页面底部。然后,我们将 HTML 添加到 items 数组中以创建内容。使用 items 数组将子项添加到容器中,如下面的代码所示

您可以单击示例旁边的预览按钮来检查结果:您应该会看到一些 HTML 内容,但看起来不太好。我们向面板添加 cls 配置,添加一个 CSS 类,我们可以针对该类进行定位以使事情看起来更好。我们添加的 CSS 位于 SDK 下载中的 examples/getting_started/resources/css/app.css 文件中。以下是主页在此时的外观

添加博客页面

现在我们有一个外观不错的主页,我们转到下一个屏幕。为了使每个页面的代码易于遵循,我们一次创建一个选项卡,然后在最后将它们全部组合在一起。

目前,我们删除第一个标签页,并用一个列表替换它。我们使用 Google 的 Feed API 服务 来获取 Feed。由于涉及更多代码,我们首先看一下结果,然后解释如何完成它

您可以单击示例代码上方的“代码编辑器”按钮以查看完整代码,但我们将逐一介绍它。此时,我们使用 嵌套列表 而不是面板,并使用从 sencha.com/blog 获取的最新博客文章填充列表。我们使用嵌套列表组件,以便可以通过轻触列表来深入了解博客条目。

让我们从列表本身开始,分解之前的代码

在之前的代码中,我们为嵌套列表提供了许多单行配置 - title、iconCls 和 displayField - 以及一个称为 store 的更详细的配置。Store 配置告诉嵌套列表如何获取其数据。让我们检查每个 Store 配置

  • type: tree - 创建嵌套列表使用的 树存储
  • fields - 告诉 Store 我们在博客数据中期望哪些字段(标题、内容、作者等)。
  • proxy - 告诉 Store 从何处获取其数据。
  • root - 告诉根节点它不是叶子。由于在代码前面,我们将 leaf defaultValue 设置为 true,因此我们需要为根节点覆盖它。

在所有 Store 配置中,proxy 正在执行最重要的工作。我们告诉代理使用 Google 的 Feed API 服务 以 JSON-P 格式返回我们的博客数据。这使我们能够从博客中获取 Feed 数据并在我们的应用中查看它(例如,尝试将之前的示例中的 Sencha 博客 URL 换成 http://rss.slashdot.org/Slashdot/slashdot 以获取 Slashdot 的 Feed)。

代理定义的最后一部分是 Reader。Reader 是将 Google 的响应解码为有用数据的实体。当 Google 发送回博客数据时,他们将其嵌套在 JSON 对象中,该对象看起来有点像以下示例

{
    responseData: {
        feed: {
            entries: [
                {author: 'Bob', title: 'Great Post', content: 'Really good content...'}
            ]
        }
    }
}

在此代码中,重要的部分是 entries 数组,因此我们将 Reader 的 rootProperty 设置为 'responseData.feed.entries',并让框架完成其余的工作。

深入了解

现在我们已经获取和显示了嵌套列表数据,我们需要允许用户轻触条目以阅读它。要添加此功能,我们向嵌套列表添加了另外两个配置,如下所示

{
    xtype: 'nestedlist',
    //all other configurations as above

    detailCard: {
        xtype: 'panel',
        scrollable: true,
        styleHtmlContent: true
    },

    listeners: {
        itemtap: function(nestedList, list, index, element, post) {
            this.getDetailCard().setHtml(post.get('content'));
        }
    }
}

在此代码示例中,我们创建了一个 detailCard,这是嵌套列表的一个有用的功能,它允许你在用户点击某个项目时显示不同的视图。我们配置了 detailCard,使其成为一个可滚动的 Panel,它使用 styleHtmlContent 使文本看起来不错。

最后一步是添加一个 itemtap 侦听器,它会在每次点击某个项目时调用我们的函数。该函数将 detailCard 的 HTML 设置为所点击帖子的内容。框架会以动画形式将 detail card 视图显示出来,以使帖子显示出来。这是我们编写的唯一一行代码,用于使博客阅读器工作。

创建联系表单

我们为我们的应用程序执行的最后一件事是创建联系表单。我们获取用户的姓名、电子邮件地址和消息,并使用 FieldSet 使其看起来不错。此功能的代码如下

这一次,我们创建了一个包含 fieldsetform。该 fieldset 包含三个字段 - 一个用于姓名,一个用于电子邮件地址,一个用于消息。我们使用 [[touch: Ext.layout.VBox VBox 布局]] 将项目垂直排列在页面上,一个在另一个上面。

在面板底部,我们添加了一个 Button,带有点击 handler。该 handler 使用 up 方法,该方法返回包含该按钮的表单面板。然后,我们调用 submit 来提交表单,该表单会将其发送到指定的 URL ('contact.php')。

将所有内容放在一起

在单独创建每个视图后,让我们将它们全部组合到一个完整的应用程序中

后续步骤

你可以在 Sencha Fiddle 中找到入门应用程序的完整源代码。

创建应用程序后,你可以使用此命令构建它

 sencha app build

Sencha Touch 2.4