文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达应如何以及何时使用类或类成员。

Public 类和类成员可供任何其他类或应用程序代码使用，并且可以作为主要产品版本中的稳定和持久组件进行依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略，恕不另行通知，不应在应用程序逻辑中依赖。

成员类型

Config - 类的配置选项。
Property - 类实例化后设置。*请参阅下面的只读。
Method - 类可以执行的操作。方法应理解为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static 标签。*请参阅下面的静态。
Event - 事件是框架事件系统特有的，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中专门描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架使用的视觉主题引擎使用的变量。
Theme Mixin - 框架使用的视觉主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

protected

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

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

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

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

展开/折叠 - 成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（本例中为 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 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中，紧挨着它们所作用的配置下方。Getter 和 Setter 方法文档将在配置行中找到，以便于参考。

历史记录栏

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

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

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

搜索和过滤器

可以使用页面顶部的搜索字段搜索 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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。

GXT 4.x

显示私有类

顶部

Native Events

使用 GWT 处理逻辑事件。

参考

gwt:com.google.gwt.user.client.Event Javadoc

事件

可在 Element 上 sink 并在 widget 事件循环中触发的可用原生事件。

事件	事件描述
ONBLUR	当元素失去键盘焦点时触发。
ONCHANGE	当输入元素的值更改时触发。
ONCLICK	当用户单击元素时触发。
ONDBLCLICK	当用户双击元素时触发。
ONERROR	当图像遇到错误时触发。
ONFOCUS	当元素获得键盘焦点时触发。
ONGESTURECHANGE	当用户手势更改时触发。
ONGESTUREEND	当用户手势结束时触发。
ONGESTURESTART	当用户手势开始时触发。
ONKEYDOWN	当用户按下键时触发。
ONKEYPRESS	当字符从按键生成时（直接或通过自动重复）触发。
ONKEYUP	当用户释放键时触发。
ONLOAD	当元素（通常是 IMG）完成加载时触发。
ONLOSECAPTURE	当具有鼠标捕获的元素失去捕获时触发。
ONMOUSEDOWN	当用户在元素上按下鼠标按钮时触发。
ONMOUSEMOVE	当鼠标在元素区域内移动时触发。
ONMOUSEOUT	当鼠标移出元素区域时触发。
ONMOUSEOVER	当鼠标移入元素区域时触发。
ONMOUSEUP	当用户在元素上释放鼠标按钮时触发。
ONMOUSEWHEEL	当用户在元素上滚动鼠标滚轮时触发。
ONPASTE	当用户将文本粘贴到输入元素中时触发。
ONSCROLL	当可滚动元素的滚动偏移量更改时触发。
ONTOUCHCANCEL	当用户取消触摸元素时触发。
ONTOUCHEND	当用户结束触摸元素时触发。
ONTOUCHMOVE	当用户在触摸元素时移动时触发。
ONTOUCHSTART	当用户开始触摸元素时触发。
ONCONTEXTMENU	当用户请求元素的上下文菜单时触发（通常通过右键单击）。
FOCUSEVENTS = ONFOCUS \| ONBLUR;	涵盖焦点事件（焦点和失焦）的位掩码。
KEYEVENTS = ONKEYDOWN \| ONKEYPRESS \| ONKEYUP;	涵盖所有键盘事件（按下、释放和按压）的位掩码。
MOUSEEVENTS = ONMOUSEDOWN \| ONMOUSEUP \| ONMOUSEMOVE \| ONMOUSEOVER \| ONMOUSEOUT;	涵盖所有鼠标事件（按下、释放、移动、悬停和移出），但不包括单击、双击或滚轮事件的位掩码。
TOUCHEVENTS = ONTOUCHSTART \| ONTOUCHMOVE \| ONTOUCHEND \| ONTOUCHCANCEL;	涵盖所有触摸事件（开始、移动、结束、取消）的位掩码。
GESTUREEVENTS = ONGESTURESTART \| ONGESTURECHANGE \| ONGESTUREEND;	涵盖所有手势事件（开始、更改、结束）的位掩码。

Sinking

事件将在 sinking 后在元素上触发。事件通过 widgets onBrowserEvent(NativeEvent) 循环触发。

在 Widget 上 Sinking

直接在 widget 的元素上完成 Sinking。
```
  widget.sinkEvents(Event.ONTOUCHSTART)
```

使用 DOM 处理程序在 widget 的元素上 sinking 完成 Sinking。这在一个步骤中完成 sinking 并添加处理程序。

  widget.addDomHandler(new TouchStartHandler() {
    @Override
    public void onTouchStart(TouchStartEvent event) { 
    }
  }, TouchStartEvent.getType());

在 Element 上 Sinking

在 GWT 中在 element 上 sinking 在旧版浏览器中存在潜在的垃圾回收问题，可能导致内存泄漏。

  // Use the widget framework, this can cause memory leaks
  Element element = DOM.getElementById("main");
  Event.sinkEvents(element, Event.ONCLICK);
  DOM.setEventListener(element, new EventListener() {          
    @Override
    public void onBrowserEvent(Event event) {
          if (Event.ONCLICK == event.getTypeInt()) {
            System.out.println("clicked");
          }
    }
  });

目录

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例及类成员

桌面 -vs- 移动视图

查看类源代码

GXT 4.x

目录

Native Events

参考

事件

Sinking

在 Widget 上 Sinking

在 Element 上 Sinking

GXT 4.x