文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 privateprotected。否则,类/成员是 publicPublicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

Architect 4.3


顶部

Ext JS 视图组件

此处提供 Architect 的 Ext JS 版本工具箱中视图组件类别的一般描述。当您单击工具箱中的每个组件名称时,Architect 会在工具箱下方的文本面板中显示其简要描述,其中包括指向 [[ext: Ext JS API 文档]] 的链接。有关每个组件的完整信息,请点击这些链接。本节中的链接也将您带到 Ext JS API 文档。

Ext JS 组件类别

工具箱将 Ext JS 视图组织成以下类别

  • 容器
  • 图表,包括图表系列和图表轴
  • 表单字段
  • 表格,包括表格列、表格功能、表格选择和表格视图
  • 菜单
  • 标准
  • 工具栏
  • 视图

让我们更仔细地看看这些组件类型中的每一种。

容器

容器是可以包含其他组件的组件。Architect 允许您从标准 Ext JS 容器中进行选择,这些容器可以满足大多数 UI 开发需求。这包括以下内容

Container。 可以包含其他组件的最简单组件。所有其他容器类型都是 Container 类的扩展。Container 只是一个逻辑容器,不包含任何默认的视觉特征。

FieldContainer。使 UI 能够轻松地在表单的同一行上显示多个字段,以及与其他表单字段的显示匹配的标签和可选的验证消息。FieldContainer 的常见用途是用于多部分名称字段。但是,FieldContainer 可以包含任何类型的表单字段,而不仅仅是文本字段。通过将字段拖动到 FieldContainer 中或复制现有字段来添加字段。

FieldSet。 FieldSet 用于对表单面板中的相关字段进行分组,并允许您在视觉上分隔表单的元素。例如,在线销售表单可能会将字段分为几组,一组用于账单地址,另一组用于送货地址。FieldSet 可以单独使用或在表单内部使用,并且可以选择在顶部添加标题,在底部添加说明。通常,FieldSet 包含表单字段,但 FieldSet 也可以包含嵌套容器。例如,嵌套容器组件可以在 FieldSet 中用于创建多列布局。

Form Panel。 一种专门的面板,用于对表单字段和标签的集合进行分组,并添加了验证和提交表单的功能。除了各种表单字段外,还可以将容器(如 Container 和 FieldSet)添加到表单面板。例如,嵌套容器可用于构建多列表单。

Panel。 用户界面的基本构建块,提供强大的应用程序功能。可以将面板添加到任何类型的容器,并且可以将子组件添加到其主体区域或停靠到其四个边缘中的任何一个。除了通用面板容器外,Ext JS 还提供了许多专门类型的面板,包括表单面板、选项卡面板、表格面板和树面板。窗口容器也是面板的扩展。

Tab Panel。 一种专门类型的面板,它使用卡片布局将嵌套组件的集合显示为单独的选项卡。Architect 默认情况下向画布添加一个带有三个选项卡组件的选项卡面板。可以将其他子组件添加到每个选项卡,并且可以通过将组件拖动到选项卡面板上来添加选项卡。

Viewport。 用于表示浏览器窗口中的整个可见应用程序区域。Viewport 会自动调整自身大小以适应浏览器视口的大小。每个页面只能有一个 Viewport,但它可以包含嵌套面板,每个面板都有自己的布局和嵌套组件。Viewport 不可滚动;如果需要滚动,请在 Viewport 中使用可滚动的子组件。

Window。 一种专门类型的面板,可以调整大小和拖动。窗口也可以最大化以填充视口、最小化和恢复到以前的大小。与普通面板不同,窗口是浮动的并且可以关闭。窗口通常用于呈现对话框和错误。

图表

Ext JS 4 中引入的图表包允许可视化具有多种不同图表类型的复杂数据存储。图表工具箱部分提供了一组预定义的图表类型,其中常见的轴和系列配置已到位,并且临时数据存储附加了虚拟数据。将其中一种图表类型添加到项目后,需要将其数据存储从虚拟数据更改为您已定义的实际数据存储。您可以更改、添加和删除其子轴和系列项目,以满足您的应用程序及其 UI 的需求。

Architect 工具箱将图表组件分解为以下三个部分

从以下类型的预定义图表中选择

  • 条形图
  • 柱状图
  • 仪表图
  • 图例线
  • 饼图
  • 雷达图
  • 堆叠条形图

图表系列 包含支持的系列类型 - 数据存储中记录的实际表示形式,包括标签、高亮、提示和标注。系列类型还通过动画、隐藏、显示所有元素以及显示图例项目颜色和其他事件驱动的行为来处理鼠标事件。示例包括条形系列,它将数据记录显示为水平条;柱形系列,它将数据记录显示为垂直条;以及仪表系列,它沿弧线将单个数据点显示为仪表。

图表轴 包含支持的轴类型 - 带有刻度线和值标签的刻度,用于图表数据的一个或多个维度,用于定义图表的轴。可以配置轴位置、类型、样式。示例包括类别轴,通常用于按非数字字段(如一年中的月份或人名)排列数据点;仪表轴,它沿弧线为仪表系列显示刻度线;数值轴,用于按数字字段(如访客人数或股票价格)排列数据点;以及径向轴。

表单字段

表单字段是您添加到 表单面板 容器以创建表单的组件。Ext JS 提供了用于构建几乎任何类型表单的标准字段类型,包括复选框、复选框组、组合框、日期字段、HTML 编辑器、标签、文本字段等等。要对相关字段进行分组,请将它们放在嵌套在表单面板中的 FieldSet 容器中。如果要创建多列表单,请为列添加嵌套容器。有关构建表单的更多信息,请参阅 在 Architect 中构建 Ext JS 表单

表格

表格以交互式表格显示数据。Ext JS 提供了各种用于构建表格的组件,从 表格面板 开始,它内置支持调整列大小和排序列以及将列拖动到表格中的新位置。表格面板还支持水平滚动以及单选和多选。Ext JS 还提供了单元格编辑和行编辑插件,这些插件提供了对表格值进行内联编辑的支持,一次编辑一个单元格或一次编辑整行。

Architect 工具箱将表格组件分解为以下部分

表格列: 包含表格面板中使用的列类型,包括操作、布尔值、日期、数字和模板列。默认情况下,表格面板在添加到项目时包含字符串、数字、日期和布尔值列。

表格功能: 包含可插拔功能,这些功能修改表格数据的呈现方式,包括分组、分组摘要、行主体和摘要,每种功能都根据您配置的方式排列表格中的项目。

表格选择: 包含用于在表格中选择数据元素的方法,包括单元格选择、复选框选择和行选择模型。将您要使用的模型拖动到表格面板上以启用它。

菜单

菜单组件用于构建菜单。Ext JS 提供了一组标准的菜单组件 - 包括复选框项、颜色菜单、日期菜单和菜单项 - 您可以通过 Architect 添加和配置这些组件。例如,要构建菜单栏,请从标准组件集中为每个菜单向工具栏(请参阅下面的工具栏)添加一个按钮(请参阅下面的标准集),然后为每个按钮配置一个菜单组件。

标准

标准组件为您的 UI 提供基本构建块,包括按钮、进度条、拆分器和工具组件。标准还包括 Ext.Component,它是所有其他组件的基础。通常,不直接使用 Component;而是使用容器或其他专用组件。

工具栏

工具栏包括用于构建工具栏的组件,包括工具栏、按钮组、填充、分隔符和间隔符组件。要创建带有其控件的工具栏,请添加一个 工具栏 组件,然后将控件组件添加到工具栏。工具栏通常添加到面板容器,并且可以通过在工具栏的配置弹出窗口中设置“停靠在父级中”选项来停靠到面板的任何边缘。

使用树组件构建树,您的应用程序使用树以可以展开和折叠的列表显示分层数据。基本的 Ext JS 树构建块是 树面板 容器。树面板包含一个根节点和任意数量的子节点。您可以将树面板绑定到 TreeStore。当 TreeStore 中的数据发生更改时,它们会自动反映在树面板中。

视图

用于显示来自数据存储的动态数据的组件,使您可以通过 XTemplate 完全控制数据的格式和布局。视图 组件使用 XTemplate 从 Store 显示数据,以格式化和布局数据。当附加存储中的数据发生更改时,视图会自动更新 UI 中的数据。视图为常见操作(如单击和鼠标悬停)提供内置支持,并支持单选和多选。

Architect 4.3