文档帮助

目录

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

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

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

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

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

参数 (Parameters)

item :  Object

正在添加的配置对象。

返回值 (Returns)
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 Touch 中的一个新组件。在其基础上，它是一个带有卡片布局和停靠工具栏的简单容器；但除此之外，我们还构建了一种以堆栈式方式推送（添加）和弹出（删除）视图的简便方法。当您推送视图时，它会将该视图添加到 stack 中，并将新标题动画到工具栏中。它还在工具栏中动画化一个后退按钮，以便您可以返回（或弹出）到上一个视图。

以下示例演示了此功能

创建一个简单的导航视图

创建导航视图类似于创建其他容器。您使用 create。

var view = Ext.create('Ext.navigation.View', {
    fullscreen: true,
    items: [
        {
            title: 'Navigation View',
            html: 'This is the first item in the stack!'
        }
    ]
});

在本示例中，我们为导航视图提供以下两个配置

  • Fullscreen: 这确保它自动插入到 viewport 中。
  • Items: 这表示导航视图包含的 items。由于我们在这里只插入一个 item，因此它是 stack 中的第一个 item，因此处于活动状态。
    • title: 这是显示在导航栏中的标题（不是必需的）。
    • html: 我们在这里使用 html 配置来提供一些虚拟内容。

推送新的视图

“推送”意味着向导航视图的堆栈添加新视图。推送将触发以下三个操作

  1. 动画化导航视图以显示新 item（滑动）。
  2. 在导航栏中动画化 item 的 title 配置（如果指定）（滑动）。
  3. 将后退按钮动画化到导航栏中（滑动）。

推送视图是使用 push 方法完成的

view.push({
    title: 'New views title',
    html: 'Some content'
});

您可以传递对组件的引用，也可以像上一个示例中那样使用配置。当然，您推送的 item 可以是 component 的任何子类

var tabPanel = Ext.create('Ext.tab.Panel', {
    items: [
        {
            title: 'First',
            html: 'first'
        },
        {
            title: 'Second',
            html: 'second'
        }
    ]
});

view.push(tabPanel);

弹出视图

“弹出”意味着从导航视图中删除最顶层（视觉上活动的）视图。当然，您需要在堆栈中有多于一个 item 才能使此操作产生任何结果。当您弹出视图时，它会执行以下操作

  1. 将导航视图动画化回堆栈中的上一个 item（反向滑动）。
  2. 将当前标题动画移出视图，并将先前堆栈的标题动画移入视图（滑动）。
  3. 将后退按钮动画移出视图，如果堆栈中仍有超过两个 item，则动画化上一个视图的后退按钮。

弹出视图是通过调用 pop 方法完成的

view.pop();

Sencha Touch 2.4