文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,类/成员是 public(公共)。Publicprotectedprivate 是访问描述符,用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

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

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha 文档


顶部

Ext JS

Modern Toolkit
现代工具包为从桌面到手机的所有现代浏览器提供 HTML5 应用程序支持。

Classic Toolkit
经典工具包为大多数桌面浏览器、平板电脑和触摸屏笔记本电脑提供支持。

入门 >

文档 >

ExtAngular

了解使用 Sencha ExtAngular 构建应用程序的基础知识。

入门 >

文档 >

ExtWebComponents

了解使用 Sencha ExtWebComponents 构建应用程序的基础知识。

入门 >

文档 >

ExtReact

ExtReact 将 Ext JS 组件的强大功能带入 React 框架,以及 JSX 编码风格。

ExtReact 包括 Grids、Trees、Charts、Menus、Layouts 和许多其他组件,可以大大缩短您开发下一个应用程序所需的时间。

入门 >

文档 >

Sencha Test

在 Sencha Test 的帮助下,测试您的应用程序现在可以成为您产品生命周期不可或缺的一部分。借助 Sencha Test,您可以使用一个全面的解决方案执行跨浏览器和跨平台测试。

入门 >

文档 >

Cmd

Sencha Cmd 是构建 Sencha 应用程序的基石。它提供了一整套生命周期管理功能,例如脚手架、代码缩小和生产构建创建,以补充您的 Sencha 项目。

入门 >

文档 >

Architect

Sencha Architect 使您的团队能够使用拖放功能构建 HTML5 应用程序,从而减少您在手动编码上花费的时间,并优化您的应用程序代码以获得高性能。

移动应用教程 >

桌面应用教程 >

文档 >

Sencha Themer

Sencha Themer 使您能够为 Ext JS 6 应用程序设置样式,并使其看起来很棒。您可以使用图形工具创建自定义主题 - 无需编写代码。Sencha Themer 使您可以访问所有 Ext JS 组件和检查工具,以设置细粒度的样式并生成带有动态样式表的主题包。

入门 >

文档 >

IDE 插件

Sencha 的 IDE 插件是在 Sencha 框架和主要 IDE 之间创建融合的工具。这些插件支持代码完成和检查等功能,同时与原生 IDE 行为无缝协作。

文档 >

Sencha Inspector

Sencha Inspector 是一种调试工具,可直接访问使用 Sencha 框架构建的应用程序的组件、类等。它使您可以分析代码是否存在过度嵌套等问题,并有助于提高性能。

入门 >

文档 >

GXT

Sencha GXT 是最全面的 Java 框架,用于构建功能丰富的 Web 应用程序。它使用 GWT 编译器,允许开发人员使用 Java 编写应用程序并编译为高度优化的跨平台 HTML5 代码。

入门 >

文档 >

Touch

Sencha Touch 是领先的基于 MVC 的 JavaScript 框架,用于构建跨平台移动 Web 应用程序。Sencha Touch 利用硬件加速技术为移动设备提供高性能 UI 组件。

入门 >

文档 >

Sencha WebTestIt

WebTestIt 是一个轻量级 IDE,针对使用 Selenium 或 Protractor 构建 UI Web 测试进行了优化。提高生产力并在本地或云端自动化测试。

入门 >

文档 >

Sencha GRUI

Sencha GRUI 是一个轻量级 IDE,针对使用 Selenium 或 Protractor 构建 UI Web 测试进行了优化。提高生产力并在本地或云端自动化测试。

简介 >

入门 >

ReExt

ReExt 将 Sencha Ext JS 组件与您的 React 代码库无缝集成,从而实现现代和数据密集型应用程序的快速开发。

简介 >

Rapid Ext JS

Sencha Rapid Ext JS 使您的团队能够在最流行的 IDE VS Code 中使用拖放功能构建 HTML5 应用程序,从而减少您在手动编码上花费的时间,并优化您的应用程序代码以获得高性能。

简介 >

Sencha 文档