文档帮助

目录

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 Getter 和 Setter 方法 历史记录栏 搜索和过滤器 API 文档类元数据 展开和折叠示例和类成员 桌面 -vs- 移动视图 查看类源代码

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
受保护

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

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

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

参数

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha Touch 2.4


顶部

目录

创建一个简单的嵌套列表 Tree Store 数据 加载远程数据 详情卡片 详情容器

在 Sencha Touch 中使用嵌套列表

Ext.NestedList 是 Sencha Touch 中的一个组件，它提供了一个 miller column 界面，用于在嵌套数据集之间导航，界面简洁易用。

创建一个简单的嵌套列表

创建简单的 嵌套列表 是使用以下配置完成的

让我们看一下创建基本 嵌套列表 所需的以下代码

让我们逐步了解之前的代码

  • 首先我们定义我们的 ListItem 模型。这是一个简单的 模型，其中定义了一个字段，即我们的 text 字段。这是此时唯一需要的信息，它将显示在每个项目的列表中。

  • 接下来我们创建我们的 treeStore。

  • 我们传递给它的第一个属性是先前定义的 模型 实例。

  • 然后我们定义将传递到我们的 treeStore 中的数据的 defaultRootProperty。在我们的例子中，这将是 items。

  • 然后我们定义 root 属性。这是将传递到 treeStore 中的数据。

Tree Store 数据

前一个示例中最令人困惑的部分肯定是 TreeStore 及其 TreeStore Root。让我们再次看一下代码

var treeStore = Ext.create('Ext.data.TreeStore', {
    model: 'ListItem',
    defaultRootProperty: 'items',
    root: {
        items: [
            {
                text: 'Drinks',
                items: [
                    {
                        text: 'Water',
                        items: [
                            { text: 'Still', leaf: true },
                            { text: 'Sparkling', leaf: true }
                        ]
                    },
                    { text: 'Soda', leaf: true }
                ]
            },
            {
                text: 'Snacks',
                items: [
                    { text: 'Nuts', leaf: true },
                    { text: 'Pretzels', leaf: true },
                    { text: 'Wasabi Peas', leaf: true  }
                ]
            }
        ]
    }
});

前两行很容易理解：首先我们创建 Ext.data.TreeStore 的实例，然后我们给它一个我们在上面定义的模型。

defaultRootProperty 是开始变得有点棘手的地方。它是您的数据的根字段，它告诉 嵌套列表 数据从哪里开始。这是相同的，无论它是内联 JavaScript（如上所示）还是远程数据（我们稍后会介绍）。此属性也适用于您数据中的每个项目，即使它是嵌套的。

root 属性在本例中是此 TreeStore 的数据。它是一个对象，并且只有一个属性 - items - 这也是我们的 defaultRootProperty。在每个项目中，我们指定一个 text 属性，我们也在上面的 ListItem 模型中定义了该属性。请注意，Drinks、Water 和 Snacks 项目也具有子项（使用 defaultRootProperty items）。

有些项目还具有 leaf 属性。这意味着当用户点击此项目时，如果配置了 详情卡片，则会显示该卡片 - 但我们稍后再介绍。

加载远程数据

在前面的示例中，我们添加了一些内联数据，但在创建真实世界的示例时，这种情况很少见。如果我们想从远程 JSON 文件加载数据怎么办？

实际上非常相似。让我们看一下我们想要加载的以下 JSON 文件

{
    "items": [
        {
            "text": "Drinks",
            "items": [
                {
                    "text": "Water",
                    "items": [
                        { "text": "Still", "leaf": true },
                        { "text": "Sparkling", "leaf": true }
                    ]
                },
                { "text": "Soda", "leaf": true }
            ]
        },
        {
            "text": "Snacks",
            "items": [
                { "text": "Nuts", "leaf": true },
                { "text": "Pretzels", "leaf": true },
                { "text": "Wasabi Peas", "leaf": true  }
            ]
        }
    ]
}

由于它与我们之前定义的内联 root 属性相同，让我们看一下创建 TreeStore 时的差异

var treeStore = Ext.create('Ext.data.TreeStore', {
    model: 'ListItem',
    defaultRootProperty: 'items',
    proxy: {
        type: 'ajax',
        url: 'data.json'
    }
});

我们使用 create 创建 store 并像以前一样设置 model 和 defaultRootProperty 属性，但随后我们设置了 proxy。此属性告诉 TreeStore 使用指定的代理加载其数据。在本例中，我们给它一个 type 为 'ajax'（因为它正在加载远程文件），然后是 JSON 文件的 url。

详情卡片

当用户点击 leaf 项目（在 TreeStore 在前面的示例中加载的数据中定义）时，会显示 详情卡片（如果已配置）。它可以是任何类型的 组件，这意味着它非常可定制。您可以使用嵌套列表配置中的 详情卡片 配置来设置详情卡片。让我们看一下以下简单示例

如您所见，当您点击其中一个 leaf 项目时，详情卡片 变为可见。因此，让我们看一下以下代码

Ext.create('Ext.NestedList', {
    fullscreen: true,
    store: treeStore,
    detailCard: {
        html: 'You are viewing the detail card!'
    }
});

在此示例中，我们将 详情卡片 设置为一个对象，并设置了 html 的配置。此对象会自动转换为 组件（就像您在 container 上调用 add 时一样）。

如果我们想根据我们点击的项目在 详情卡片 中设置数据怎么办？让我们看一下我们是如何做到这一点的

Ext.create('Ext.NestedList', {
    fullscreen: true,
    store: treeStore,
    detailCard: {
        html: 'You are viewing the detail card!'
    },
    listeners: {
        leafitemtap: function(nestedList, list, index, target, record) {
            var detailCard = nestedList.getDetailCard();
            detailCard.setHtml('You selected: ' + record.get('text'));
        }
    }
});

请注意我们是如何添加 listeners 配置的。我们这样做是因为我们想监听 leafitemtap 事件，该事件在点击任何 leaf 项目时调用。

当该事件触发时，它会传递许多参数

  • nestedList - 这是对 嵌套列表 实例的引用。
  • list - 这是对最后一个 列表 的引用，在该列表中点击了带有 leaf 配置的项目。
  • index - 模型 在 列表 Store 中的索引。
  • target - 点击的 元素。
  • record - 点击的项目的 模型。

由于我们知道何时有人点击 leaf 项目，并且我们知道点击了哪个 record，因此我们可以使用一些数据更新 详情卡片。

要获取 详情卡片，我们可以使用我们的 详情卡片 的 getDetailCard 配置。

最后，让我们看一下这个完整的示例

详情容器

嵌套列表有一个 详情容器 配置，用于指定 详情卡片 的容器。当您希望 详情卡片 位于另一个容器中时，会使用此配置，这在屏幕尺寸大于普通手机的屏幕尺寸时通常是这种情况。

让我们看一个实际操作的例子

如您所见，我们现在在 Viewport 中有以下两个项目

要设置配置，您需要提供对要用作 详情容器 的容器的引用

var detailContainer = Ext.create('Ext.Container', {
    layout: 'card'
});

var nestedList = Ext.create('Ext.NestedList', {
    store: treeStore,
    detailCard: true,
    detailContainer: detailContainer
});

如果您未指定 详情容器，则 详情卡片 将添加到 嵌套列表 中。

Sencha Touch 2.4