文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为privateprotected。否则,该类/成员为publicPublicprotectedprivate是访问描述符,用于传达类或类成员的使用方式和时间。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间,或添加新项目时,将原始配置对象添加到此容器时调用added), or {@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 原始页面)都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Ext JS 7.8.0


顶部

布局和容器

布局系统是 Ext JS 最强大的部分之一。它处理应用程序中每个 组件 的大小和位置。本指南介绍了如何开始使用布局的基础知识。

容器

Ext JS 应用程序 UI 由 组件 组成(有关组件的更多信息,请参阅 组件指南。一个 容器 是一种特殊的组件类型,可以包含其他组件。典型的 Ext JS 应用程序由多层嵌套组件组成

最常用的容器是 面板。让我们看看作为容器如何允许面板包含其他组件

我们刚刚创建了一个面板,它将自身渲染到文档主体,并且我们使用 items 配置将两个子面板添加到我们的容器面板中。

布局

每个 容器 都有一个 布局 来管理其子 组件 的大小和位置。在本节中,我们将讨论如何配置容器以使用特定类型的布局,以及布局系统如何保持所有内容同步。

使用布局

在上面的示例中,我们没有为容器 面板 指定布局。请注意,子面板是如何一个接一个地排列的,就像 DOM 中的普通块元素一样。这是因为所有容器的默认布局是 自动布局。自动布局不会为子元素指定任何特殊的位置或大小规则。例如,假设我们希望我们的两个子面板并排放置,并且每个面板都占用容器宽度的一半 - 我们可以使用 列布局,只需在容器上提供一个 布局 配置即可。

Ext JS 提供了一套完整的布局,可以满足您能想到的几乎所有类型的布局。请参阅 厨房水槽的布局部分,以查看不同布局的实际应用。

布局系统的工作原理

一个 容器布局 负责容器所有子元素的初始位置和大小。在内部,框架调用容器的 updateLayout 方法,该方法会触发布局计算容器所有子元素的正确大小和位置,并更新 DOM。updateLayout 方法是完全递归的,因此容器的任何子元素都会调用其 updateLayout 方法。这将一直持续到 组件 层次结构的底部。您通常不需要在应用程序代码中调用 updateLayout(),因为框架应该为您处理它。

当容器被 调整大小 或当子组件 项目添加移除 时,会触发重新布局。通常,我们只需要依靠框架来处理布局更新,但有时我们希望阻止框架自动布局,以便我们可以将多个操作一起批处理,然后在完成时手动触发布局。为此,我们使用容器上的 suspendLayout 标志来阻止它在执行通常会触发布局的操作(例如添加或移除项目)时进行布局。完成后,我们只需关闭 suspendLayout 标志并通过调用容器的 updateLayout 方法手动触发布局。

组件布局

就像一个 容器布局 定义了容器如何调整其 组件 项目 的大小和位置一样,组件也有一个 布局,它定义了组件如何调整其内部子项目的大小和位置。组件布局使用 componentLayout 配置选项进行配置。

通常,除非您正在编写自定义组件,否则您不需要使用此配置,因为所有提供的组件都带有自己的布局管理器。大多数组件使用 自动布局,但更复杂的组件将需要自定义组件布局(例如具有标题、页脚和工具栏的 面板)。

Ext JS 7.8.0