文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

  • 展开/折叠 - 成员行左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称(本例中为 lookupComponent
  • 方法参数 - 方法使用的任何必需或可选参数(或传递给事件处理程序方法的参数)将列在方法名称旁边的括号内(本例中为 ( item )
  • 返回类型 - 方法或属性返回的类实例或 javascript 对象(在本例中为 Ext.Component)。对于不返回除 undefined 以外的任何内容的方法,可以省略此项,或者可以显示为以正斜杠 / 分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回 Component,如果失败,则返回 false,这将显示为 Ext.Component/Boolean)。
  • 标志 - 适用于成员的任何标志都将显示在旁边(本例中为 PROTECTED - 请参阅下面的标志部分)
  • 成员来源 - 成员行右侧是最初描述成员的类(本例中为 Ext.container.Container)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员从祖先类或混合类继承,则显示为灰色链接。
  • 成员源代码 - 成员来源类右侧下方是一个链接,用于查看成员的源代码(示例中为 view source
  • 参数列表 - 类方法的每个参数都将使用与上面括号中找到的名称相同的名称、预期的类或对象类型以及参数的描述列出(示例中为 item : Object)。
  • 返回值 - 如果类返回除 undefined 以外的值,“返回值”部分将注明返回的类或对象类型以及描述(示例中为 Ext.Component
  • Since示例中未显示)- 某些成员将显示该成员首次引入的产品版本(即 Available since 3.4.0 - 示例中未显示),紧跟在成员描述之后
  • Default示例中未显示)- Configs 通常显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false

成员标志

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

  • Required - 实例化类时所需的配置
  • Bindable - 配置具有 setter,允许通过 ViewModel 绑定设置此配置
  • Read Only - 属性可以读取,但不能用于在运行时配置/重新配置类实例
  • Singleton - Singleton 类在定义后立即实例化,不能手动实例化
  • Static - 静态方法或属性是属于类本身的方法或属性,而不是类的实例
  • Chainable - 指的是在调用时返回类实例的方法。
    这允许链式方法调用,例如:classInstance.method1().method2().etc();
  • Deprecated - 计划在未来框架版本中删除的类或成员,并在当前版本中提供以实现向后兼容性。
    已弃用的类和成员将有一条消息,指导您将来首选的类/方法。
  • Removed - 已删除的类或成员,仅在文档中作为升级框架版本的用户的参考
  • Template - 在基类中定义的方法,旨在由子类覆盖
  • Abstract - 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的(如果有的话)代码。特定于类的代码将通过子类中的覆盖提供。
  • Preventable - 如果事件处理程序返回 false,则标记为可阻止的事件将不会触发

类图标

- 表示框架类

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

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南是当前查看版本中的新增内容

成员图标

- 表示 config 类型的类成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

- 表示类、成员或指南是当前查看版本中的新增内容

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数在应用过滤器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类 config 选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中,就在它们与之配合使用的 config 下方。Getter 和 setter 方法文档将在 config 行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并在顶部标题栏下方显示(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。

在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择“全部”,“在历史记录栏中显示产品详细信息”的复选框选项将启用。选中后,每个历史页面的产品/版本将在历史记录栏中与页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

  • Alternate Name - 一个或多个附加的类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的备用类名)。备用类名通常为了向后兼容性而维护。
  • Hierarchy - 层级视图列出了当前类的继承链,一直到其祖先类,直到根基类。
  • Mixins - 混合到当前类中的类列表
  • Inherited Mixins - 混合到当前类的祖先中的类列表
  • Requires - 实例化类所需定义的所有类
  • Uses - 类在其生命周期的某个时刻可能使用的类列表,但不一定是最初实例化类所必需的
  • Subclasses - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

  • 全局导航将位于左侧的菜单中,可通过汉堡菜单图标访问。菜单包含以下内容(在大多数页面上)
    • 当前产品的名称(作为指向产品着陆页的链接)
    • 用于导航回文档主页的 Sencha 图标
    • 产品菜单下拉按钮
    • API 文档和指南的导航树选项卡
  • 当前上下文导航和工具位于右侧,可通过齿轮图标访问。上下文菜单包含以下内容
    • 全局搜索输入字段
    • (API 文档) 带有成员过滤器、“展开/折叠所有示例”按钮、“展开/折叠所有成员行”按钮、访问级别过滤器复选框和每个成员计数的“过滤器”选项卡
    • (API 文档) 包含与当前类相关的元数据菜单的“相关类”选项卡
    • (指南) 指南的目录

查看类源代码

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

History :

Ext JS 7.8.0

API
Getting Started
What's New
Examples
Choosing Components
App Architecture
Core Concepts
App Design
Upgrade Adviser
Backend Connectors
App Build Tools - npm & Cmd
Other Resources
Supported BrowsersSupported Platforms
Tutorials
Grid Tutorial
Grid TutorialsTopicsFeature List
Basics
Data Manipulation
Advanced
Login App
Quick Start

顶部

Ext JS 7.8.0 发行说明

功能

  • EXTJS-28605 - 新功能 Froala 编辑器未在 Classic 中实现。

改进

  • EXTJS-29650 - 复选框焦点使用默认 Material 主题颜色的阴影。
  • EXTJS-23309 - 改进对只读单元格的支持,当涉及使用剪贴板“粘贴”时。
  • EXTJS-28895 - 网格和数据视图子项缺少 keydown 和 keyup 事件。

修复

  • EXTJS-26921 - 在组合框存储上添加 id 字段可能会在 typeahead 上抛出未捕获的错误。
  • EXTJS-29625 - 在单击操作列时重新加载存储后,行变为可编辑。
  • EXTJS-29575 - 当配置为 multiselect: true 和 query mode: remote 时,使用新值搜索时,组合框会丢失选择。
  • EXTJS-29354 - JAWS 2020 未宣布网格上的 LoadMask。
  • EXTJS-29966 - 在带有单元格编辑器的网格中,组合框在触发器单击时不会展开。
  • EXTJS-27942 - Ext.date.align 为 YEAR 返回输入值。
  • EXTJS-29175 - 日语区域设置文件中未翻译 picker 和 datepicker 的完成按钮。
  • EXTJS-29978 - 修复所有使用“remote”queryMode 的 Ext JS kitchensink 示例。请参阅 此处 运行的示例。

Modern

  • EXTJS-28979 - 带有虚拟存储的组合框在滚动时隐藏 picker。
  • EXTJS-29724 - 如果为隐藏组件调用 ensureVisible,则会生成无限循环。
  • EXTJS-29255 - 网格列菜单项在过滤器和列之间混淆位置。
  • EXTJS-29676 - 调整大小后无法滚动网格。

Classic

  • EXTJS-28530 - MessageBox ENTER 即使在按钮禁用时也会触发 ok/yes 按钮回调。
  • EXTJS-28232 - Charts 的 SVG 引擎无法隐藏图表中的标签。
  • EXTJS-29305 - Tab 焦点在 DataView 元素中的锚标记上不起作用。
  • EXTJS-29586 - Treelist 需要 font-awesome 包/不使用现有主题的图标/样式。
  • EXTJS-24377 - 当 Ext.MessageBox.wait 配置了文本时,下次不使用文本调用时,它将不会显示百分比进度。
  • EXTJS-28887 - 标签左对齐在 Classic Material 主题中已损坏。
  • EXTJS-25456 - 锁定网格列菜单在隐藏列时折叠。
  • EXTJS-29572 - 无法重新展开带有“msgTarget: under”的表单。

工具

  • SDKTOOLS-2146 - Sencha Cmd 现在支持更高的 Java (LTS) 版本,如 Java 17 和 21,以及 Java 版本 8 和 11 的向后兼容性
  • SDKTOOLS-2141 - 升级 Closure Compiler 以支持 ES11 和最新语法。
  • SDKTOOLS-2143 - CMD+Nashorn - 由于 Nashorn 已从 JDK11 中弃用,因此更新 CMD 的未来版本。
  • SDKTOOLS-2123 - 验证 Sencha app watch(以及所有其他功能,如 build 等)是否适用于 Apple M1 芯片。
  • SDKTOOLS-2168 - 更新 Sencha Cmd 以支持 Ext JS 7.8。
  • SDKTOOLS-2148 - 改进了 Cmd Compiler 对 Ecma 的支持,称赞使用了 Closure。

    但是,当使用 closure 类型 whitespace 时,ES5 较高版本中引入的某些方法会导致错误,例如 $jscom not defined

    • 要解决这些问题,请在 app.json 中使用以下代码。
      "compressor": {
          "type": "closure",
          "compression" : "whitespace",
          "polyfills" : "all"
      }
  • OTOOLS-102 - Open Tooling 支持 Ext JS 7.8.0。

  • DSGNR-8404 - 将 Sencha Architect 更新到版本 4.3.5,支持 ExtJS 7.8。
  • DSGNR-8353 - 无法在 Sencha Architect 中打开存档项目。
  • DSGNR-8289 - 无法在现代工具包中创建 UI。
  • DSGNR-8284 - 在安装期间,Sencha Architect 许可证信息已更新。
  • CAT-1018 - Sencha Themer 缺少一些图标。
  • CAT-1053 - 将 Sencha Themer 更新到版本 1.4.4,支持 Ext. JS 7.8。
  • CAT-1030 - 使用 Sencha Themer 和 ext-gen 创建主题。
  • EJUA-22 - 升级顾问给出错误的私有配置警告。
  • EJUA-30 - 更新升级顾问和 ESLint 插件以支持 Ext JS 7.8。
  • IDEAPLUGIN-394 - Sencha JetBrains 插件现在支持 JetBrains IDE 的 2023.3.1、2023.3.2 和 2023.3.3 版本的 IntelliJ、WebStorm 和 PhpStorm 中的代码完成功能

    除了此修复程序,我们还解决了以下问题

    • 阻止在 xtype 来自框架现代版本中默认指定的值的组件中显示正确的自动完成建议列表。
    • 当使用 lookup(…) 或 lookupReference(…) 方法时,阻止显示来自引用的自动完成建议列表。
    • 阻止建议在框架上定义为 eventedConfig 事件的事件。
  • IDEAPLUGIN-396 - Sencha JetBrains 插件现在适用于 JetBrains IDE 的 2023.3.1、2023.3.2 和 2023.3.3 版本
  • VSCP-80 - 修复了包创建问题
  • VSCP-106 - Sencha Visual Studio 代码插件支持最新的 IDE 版本 1.84、1.85 和 1.86

Ext JS 7.8.0

Ext JS
ExtAngular
ExtReact
ExtWebComponents
Sencha Test
Cmd
Architect
Themer
IDE Plugins
Sencha Inspector
Fiddle
GXT
Sencha Touch
WebTestIt
Sencha GRUI
Rapid Ext JS
ReExt