许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias
(别名)(如果类扩展了 Ext.Component,则为 xtype
)。别名/xtype 列在适用类的类名旁边,以便快速参考。
框架类或其成员可以指定为 private
(私有)或 protected
(受保护)。否则,类/成员为 public
(公共)。Public
、protected
和 private
是访问描述符,用于传达类或类成员应该如何以及何时使用。
Public(公共)类和类成员可供任何其他类或应用程序代码使用,并且可以在主要产品版本中被依赖为稳定和持久的。公共类和成员可以通过子类安全地扩展。
Protected(受保护)类成员是稳定的 public
(公共)成员,旨在由拥有类或其子类使用。受保护成员可以通过子类安全地扩展。
Private(私有)类和类成员在框架内部使用,不供应用程序开发人员使用。私有类和成员可能随时更改或从框架中省略,恕不另行通知,并且不应在应用程序逻辑中依赖。
static
(静态)标签。*请参阅下面的静态。下面是一个示例类成员,我们可以对其进行剖析以显示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回除 undefined
以外任何内容的方法,可以省略此项,或者可以显示为以斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回 Component,如果失败,则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的标志部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接;如果是从祖先类或混入类继承而来,则显示为灰色。view source
)item : Object
)。undefined
以外的值,则“返回值”部分将注明返回的类或对象类型以及描述(示例中为 Ext.Component
)Available since 3.4.0
- 示例中未显示),紧随成员描述之后Defaults to: false
)API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- 单例框架类。*有关更多信息,请参阅单例标志
- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config
的类成员
- 表示类型为 property
的类成员
- 表示类型为 method
的类成员
- 表示类型为 event
的类成员
- 表示类型为 theme variable
的类成员
- 表示类型为 theme mixin
的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类配置选项相关的 Getter 和 setter 方法将在方法部分以及 API 文档和成员类型菜单的配置部分中显示,就在它们工作的配置下方。Getter 和 setter 方法文档将在配置行中找到,以便于参考。
您的页面历史记录保存在本地存储中,并显示在顶部标题栏的正下方(使用可用的实际空间)。默认情况下,仅显示与您当前查看的产品/版本匹配的搜索结果。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示的内容。这将显示所有产品/版本的所有最近页面历史记录。
在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选选项进行过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”,则“在历史记录栏中显示产品详细信息”的复选框选项将启用。选中后,每个历史页面的产品/版本将与页面名称一起显示在历史记录栏中。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这可以通过使用页面顶部的复选框来完成。
API 类导航树底部的复选框过滤类列表,以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(JavaScript 原始页面除外)都有一个菜单视图,其中包含与该类相关的元数据。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名称)。通常维护备用类名称以实现向后兼容性。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。页面加载之间将记住全部切换状态。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
本指南展示了如何在 Architect 中构建一个简单的 Ext JS 表单,并为表单提交附加一个事件处理程序。它还详细描述了所有可用于构建表单的容器和字段组件,提供了创建表单字段布局的几个常见示例,并逐步介绍了如何从数据存储填充 ComboBox 的下拉列表。
几乎所有表单都由相同的基本部分组成:一个包含一个或多个表单字段的 Form Panel,以及(至少)一个提交按钮,其中包含一个事件处理程序来验证和提交表单。作为此常见情况的快速演示,让我们构建一个最简单的表单之一:登录表单。
启动一个新的 Ext JS 项目,并在项目设置中设置其 URL 前缀。有关详细信息,请参阅 构建您的第一个桌面应用程序 和 构建您的第一个移动应用程序。在工具箱中找到 Form Panel 组件,双击或将其拖动到画布,以将其添加到您的项目中。双击画布上 Panel 的标题栏,并将其更改为 Login
。
将文本字段从工具箱拖到表单面板上。双击其标签并将其更改为 User Name
。在配置中,将 name 属性的值设置为 username
。
将另一个文本字段从工具箱拖到表单面板上。双击其标签并将其更改为 Password
。在配置中,将 name 属性的值设置为 password
,并将其 inputType 设置为 password
,使其表现得像密码字段。
要将这两个字段都标记为必填字段,请选择每个字段,然后在配置中取消选中 allowBlank 属性。
接下来,将工具栏组件从工具箱拖到表单面板上。在检查器中选择工具栏;您也可以在画布中选择它,但是在检查器中选择它意味着您可以确定已选择了正确的组件。在画布中,单击工具栏的 Flyout Config 按钮,并将 Dock In Parent 设置为 bottom
。将一个按钮拖到工具栏上,然后双击以将其标签更改为 Login
。要将按钮与右侧对齐,请选择工具栏,然后在配置中将其 pack 属性设置为 end
。
最后一步是添加逻辑,以便表单在用户提交时执行我们想要的操作。选择登录按钮,并在配置中找到其事件项。单击添加按钮(“+”)以创建一个新事件,然后从事件列表中选择 click
。请注意,检查器中现在有一个作为按钮子级的 click 事件。双击 click 事件以打开事件的代码编辑器。在编辑器中插入以下代码
if (this.getForm().isValid()) {
this.getForm().submit({
url: 'login.php',
success: function(form, action) {
Ext.Msg.alert('Login Successful!');
},
failure: function(form, action) {
Ext.Msg.alert('Login Failed!');
}
});
}
此代码检查底层 Form 是否有效 - 在我们取消选中 allowBlank 属性后,两个字段是否都按要求填写。如果有效,则表单将提交到 URL 为 login.php
的服务器端脚本。该服务器端脚本的内容超出了本教程的范围,但是上面的代码显示了如何处理成功和失败响应。它使用简单的警报消息,但是您将编写任何您想要的逻辑。
让我们尝试一下简单的表单。保存并在浏览器中预览项目。单击“登录”按钮而不输入任何值,然后查看字段是否突出显示为无效。填写值并再次提交,并且假设 login.php
脚本不存在,您将看到失败消息。
接下来,让我们探索您可以用来构建比刚刚描述的示例更复杂的表单的所有容器和字段类型。每个名称都链接到其相应的 API 文档。
Ext JS 提供了用于表单和表单字段分组的专用容器
Form Panel 每个表单的主要最外层容器。它支持 Panel 的所有功能,但公开了一个 底层表单对象(可通过 getForm()
方法访问),该对象为加载和提交表单字段数据添加了特殊功能。
Field Container 允许任何子组件,并在容器主体旁边或上方显示标签,以便与其他字段标签对齐。
FieldSet 呈现为 HTML <fieldset>
元素,并允许折叠其内容。
Radio Group 一组多个单选按钮,在表单提交时聚合为单个提交参数。
以下表单字段组件显示在工具箱中的“表单字段”组下。您通常为添加到表单的每个字段设置 name
配置;当表单提交时,该名称用作字段参数的名称。所有字段还启用一个 fieldLabel
,该标签可以通过 labelAlign
配置与字段并排或位于字段上方对齐,也可以通过 hideLabel
配置隐藏。
Checkbox Group 一组多个复选框,在表单提交时聚合为单个提交参数。
Checkbox 单个复选框字段。
ComboBox 一个文本字段,在下拉列表中显示可能的值选项。列表的内容可以从任何 数据存储 加载,并且可以在用户键入时进行过滤/搜索。ComboBox 在下面更详细地介绍。
Date Field 一个日期类型的文本字段,带有一个触发按钮,可以从弹出日历小部件中选择日期。
Display Field 一个字段,将其值显示为只读纯文本,而不是输入字段。
File Upload Field 文件上传字段。
Hidden Field 隐藏的输入字段。
HTML Editor 一个富 HTML 编辑器字段,带有一组用于控制格式的按钮的工具栏。
Label Field 独立的字段标签。您通常不需要使用它;只需设置字段组件的 fieldLabel 配置即可。
Multi Slider 一个可拖动滑块字段,带有多个滑块拇指。
Number Field 一个仅允许数字值的文本字段,并且可以选择性地显示微调器按钮以递增/递减该值。
Radio 单个单选按钮字段。
Radio Group 一个字段容器,具有用于将 Ext.form.field.Radio
控件排列成列的专用布局,并为 Ext.form.field.Radio
方法提供便利,以获取、设置和验证整个单选按钮组。
Slider 一个可拖动滑块字段。
TextArea 多行文本区域字段。
Text Field 单行文本字段。
Time Field 一个允许时间值的文本字段,带有一个用于时间选择的下拉列表。
Trigger Field 一个文本字段,旁边有一个触发按钮。
默认情况下,添加到 Form Panel 的任何字段都垂直堆叠并扩展到表单的完整宽度。这绝不是唯一的布局;您可以完全控制字段的大小和排列方式,因为 Form Panel 与任何其他 Ext JS 容器一样,支持更改其内部布局以及子容器的嵌套。有关介绍,请参阅 布局。
让我们看一下布局表单的一些常见示例。
Form Panel 的子项默认情况下垂直堆叠呈现并扩展到表单的完整宽度;这是因为 Form Panel 的默认布局是 anchor
,并且其子项被赋予默认的 anchor:'100%'
。如果您希望表单扩展但不是完整宽度,则可以将其 Anchor 配置更改为其他值。例如,anchor: '-100'
将表单从右侧边缘扩展 100 像素。或者,如果您希望字段是固定宽度,请通过单击配置中其旁边的“x”按钮清除其 anchor 配置,并将其 width 配置设置为您想要的值。
FieldSet 是将相关字段视觉上排列成组的最常见方式,它们使表单易于使用。
创建一个 Form Panel 并向其中添加一个 FieldSet,然后将多个其他字段添加到 FieldSet 中。通过双击 FieldSet 并输入新名称来更改 FieldSet 的图例(标题)。
可以通过选中 collapsible 配置使 FieldSet 可折叠。通过选中 collapsed 配置使 FieldSet 默认折叠。
与 Form Panel 一样,FieldSet 会自动配置 anchor
布局;您可以根据需要更改布局,或如上所述控制其子字段的宽度。
Checkbox Group 和 Radio Group 是用于对复选框或单选按钮进行分组的专用容器。
创建一个 Form Panel 并向其中添加一个 Radio Group。将组的主标签更改为 Favorite Color
,并将两个默认单选字段的框标签更改为 Red
和 Green
。向组中添加第三个 Radio 字段,选中其 hideLabel 配置以隐藏主标签,并将其框标签更改为 Blue
。
要连接三个单选按钮,使其一次只允许选中一个按钮,请将所有三个按钮的 name 配置设置为相同的值。
取消选中单选按钮组的 allowBlank 配置,以要求用户选中其中一个单选按钮。如果未选中任何按钮,则表单的验证将失败,并且该组将以与单个字段相同的方式突出显示为无效。
请注意,单选按钮默认水平排列。您可以通过更改 columns 配置将它们排列成垂直列。例如,设置 columns: 1
以创建一个单列。
对于具有大量字段的表单,可以将它们排列在多列中,以最大程度地减少滚动。为此,请在 Form Panel 中使用嵌套容器。可以以多列布局特定部分或整个表单,具体取决于表单字段之间的关系。
例如,创建一个 Form Panel 并将其布局更改为 hbox
。向其中添加两个 Container 实例。请注意,容器并排排列,并且每个容器都占用一半的可用空间,因为 flex 默认设置为 1
。
将每个容器的布局更改为 anchor
。向每个容器添加多个表单字段。现在您有两列字段。您可以通过设置其 margins 配置在列容器之间添加空间。
在某些情况下,表单中一组相关的字段需要对齐在同一行上,而不是在多列中,例如用于多部分名称字段。
例如,创建一个 Form Panel,并向其中添加一个 FieldSet。将 FieldSet 的布局更改为 hbox
,并将其 HBox align 配置设置为 top
。
现在向 FieldSet 中添加一个 Text Field,将其标签更改为 First
,将其 labelAlign 配置设置为 top
,并将其名称设置为 firstname
。右键单击该字段,选择“Duplicate”(复制),并将生成的第二个字段的标签更改为 MI
,名称更改为 middleinitial
。复制第二个字段,并将生成的第三个字段的标签更改为 Last
,名称更改为 lastname
。
现在您有了三个水平排列、大小相等的字段。让我们优化布局。选择 “First” 字段,并将其 flex 更改为 2
。选择 “MI” 字段,移除其 flex 值,将其 width 设置为 30
,并将 margins 设置为 0 10
,使其左右边距为 10 像素。选择 “Last” 字段,并将其 flex 设置为 3
。
ComboBox 字段是最有用的表单字段类型之一,因为它帮助用户轻松地从下拉选择列表中选择值。ComboBox 的下拉列表中列出的项目是使用数据存储定义的。在继续之前,您需要熟悉 Stores and Models。
为 ComboBox 设置 Store 的最简单方法是创建一个本地 Array Store,如下所示:
通过单击 Project Inspector 顶部的 “+” 按钮并选择 “Array Store” 来创建一个新的 Array Store。在 Inspector 中选择新创建的 MyArrayStore,并将其 userClassName 配置更改为 Colors
。通过单击 Config 中 “Fields” 项旁边的 “+” 按钮,为 Store 定义一个 Field;将 Field 的名称命名为 text
。
在此示例中,我们将直接向 Store 中添加静态本地数据;在实际应用程序中,您可能希望使用 Ajax 代理从远程 URL 获取数据,但对于本地数据,让我们通过右键单击代理并选择 “Transform”-->“Ext.data.proxy.Memory” 将 Store 的代理更改为本地内存代理。
让我们向 Store 添加一些静态数组数据,方法是将以下内容作为 Store 的 data 配置的值插入。
[{text:'Red'}, {text:'Green'}, {text:'Blue'}, {text:'Yellow'}, {text:'Purple'}]
最后,让我们创建 ComboBox 字段并将其附加到 Store。创建一个 Form Panel,向其中添加一个 ComboBox,并将 ComboBox 的标签设置为 Color
。选择 ComboBox,并在 Config 中为 store 配置选择 Colors store。由于数据是本地的,请将 queryMode 配置设置为 local
。(如果您的数据是从远程 URL 查询的,则将使用默认值 remote
。)
现在,如果您保存并预览您的项目,您的 ComboBox 会将 Store 中的颜色作为选项显示在其下拉选择列表中,并且在字段中键入内容会自动过滤选项。