排列 | GXT 4.x - Sencha 中文

文档帮助

术语、图标和标签

许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称称为 alias（如果类扩展了 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 配置的初始化期间，或当新项目 added) 或 {@link #insert inserted} 时添加到此容器时调用。

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

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

参数

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 文档和成员类型菜单的 configs 部分中显示，紧挨着它们所使用的配置下方。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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面与移动视图

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

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

查看类源代码

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

GXT 4.x

显示私有类

顶部

GXT 排列参考 GXT 属性 GWT 属性折叠属性折叠所有属性折叠 gxt.device CSS3 FAQ 为什么 GXT 4.0 创建如此多的排列？为什么 GXT 添加额外的属性，而不是使用 user.agent？如果我设置了 gxt.user.agent，为什么不需要设置 user.agent？ GXT.gwt.xml 如何限制排列的数量，以及如何自己进行限制？弃用说明

GXT 排列

排列是为特定目的构建的应用程序构建，旨在提高性能。它执行运行时重新绑定评估，也称为延迟绑定。

参考

软排列

GXT 属性

可以生成排列的属性选项。

属性	属性	注释
gxt.user.agent	IE8、IE9、IE10、IE11、gecko1_8、gecko1_9、safari3、safari4、safari5、chrome、air	浏览器和这些属性被简化为仅 IE9、IE9、IE10、gecko1_8、safari
gxt.device	手机、平板电脑、桌面	设备
gxt.theme	蓝色、灰色、海王星、特里同	主题
gxt.css3.enabled	true, false	IE8 和 IE9 的 Css3 为 false。这会切换主题的外观。

GWT 属性

属性	属性	注释
gwt.logging.logLevel	finest	GXT 日志输出的调试级别。
gwt.logging.enabled	true	开启 GXT 日志记录。
CssResource.enableGss	true, false	GWT 2.7 默认关闭。GWT 2.8 默认开启。
CssResource.gssDefaultInUiBinder	true, false	为 UiBinder 启用 GSS。
CssResource.conversionMode	strict、lenient、off	停止 CSS 到 GSS 的转换。
CssResource.obfuscationPrefix	empty	移除 css 前缀。
CssResource.style	obf、debug、pretty、stable-notype、stable-shorttype、stable	CSS 资源输出类命名格式策略。`obf` 是默认值。

折叠属性

减少构建选项的排列数量。

折叠所有属性

使用 Super Dev Mode 时，默认启用此功能。

将所有排列折叠为一个。
```
  <collapse-all-properties />
```

折叠 gxt.device

gxt.device 属性导致排列激增。

减少新的 gxt.device 属性的排列数量。

  <collapse-property name="gxt.device" values="*" />

CSS3

通过使用 gxt.css3.enabled 属性设置属性，仅在应用程序中使用 CSS3 外观。

<set-property name="gxt.css3.enabled" value="true" />.

FAQ

为什么 GXT 4.0 创建如此多的排列？

GXT 4.0 添加了 gxt.device 和一些其他属性，这些属性导致编译后的排列激增。这可以通过更改项目模块描述符属性配置来控制。要减少排列，可以将属性分组在一起，如下例所示。

<!-- Collapse properties for fewer permutations -->
<collapse-property name="gxt.device" values="phone, tablet" />
<!-- group themes -->
<collapse-property name="gxt.theme" values="blue, gray" />

<!-- group modern browsers-->
<collapse-property name="gxt.user.agent" values="air, safari*, chrome*, gecko*, ie11" />
<collapse-property name="user.agent" values="safari*, gecko*" />

<!-- group ie -->
<collapse-property name="gxt.user.agent" values="ie8, ie9, ie10" />
<collapse-property name="user.agent" values="ie*" />

为什么 GXT 添加额外的属性，而不是使用 user.agent？

事实证明，“user.agent”不容易扩展。回退系统对现有的 CssResource 声明没有任何帮助。这意味着，如果 GXT 添加了“ie10”排列（在 3.0 中添加了），或者希望具有不同的排列，例如 Chrome 与 Safari 排列（例如，解决 chrome 缩放问题的排列），我们可能会破坏项目中的现有代码。

此外，GXT 添加了一个“os”属性，让我们处理平台问题。它可以是“mac”、“linux”或“windows”（或 3.0.3 之后的“unknown”，以处理 Solaris、Chrome OS 等）。在很多情况下不需要这样做，但一个例子包括本机 OS X 复选框，它们在您单击它们后立即模糊，而不是 windows、linux 或 mac 上的 firefox。

如果我设置了 gxt.user.agent，为什么不需要设置 user.agent？

由于 GXT 用户代理属性集比 GWT 用户代理更广泛，因此我们使用以下行根据 GXT 用户代理设置设置 GWT 用户代理

<!-- From /com/sencha/gxt/core/Core.gwt.xml about line 110 -->
<!-- Restrict the permutation explosion -->
<set-property name="user.agent" value="ie8">
  <when-property-is name="gxt.user.agent" value="ie8" />
</set-property>
<set-property name="user.agent" value="ie9">
  <any>
    <when-property-is name="gxt.user.agent" value="ie9" />
    <when-property-is name="gxt.user.agent" value="ie10" />
  </any>
</set-property>
<set-property name="user.agent" value="gecko1_8">
  <any>
    <when-property-is name="gxt.user.agent" value="gecko1_8" />
    <when-property-is name="gxt.user.agent" value="gecko1_9" />
  </any>
</set-property>
<set-property name="user.agent" value="safari">
  <any>
    <when-property-is name="gxt.user.agent" value="safari3" />
    <when-property-is name="gxt.user.agent" value="safari4" />
    <when-property-is name="gxt.user.agent" value="safari5" />
    <when-property-is name="gxt.user.agent" value="air" />
    <when-property-is name="gxt.user.agent" value="chrome" />
  </any>
</set-property>
<set-property name="user.agent" value="opera">
  <when-property-is name="gxt.user.agent" value="opera" />
</set-property>

GXT.gwt.xml 如何限制排列的数量，以及如何自己进行限制？

十三个浏览器属性乘以三个操作系统应该给出大约 39 个排列，除非采取措施限制这些属性。默认情况下，GXT.gwt.xml 使用以下行将这些限制为基本的 6 个排列

<collapse-property name="user.agent.os" values="*" />
<collapse-property name="gxt.user.agent" values="air, safari*, chrome" />
<collapse-property name="gxt.user.agent" values="ie9, ie10" />
<collapse-property name="gxt.user.agent" values="gecko*" />

通过不继承 GXT，您可以有机会设置自己的排列限制。如果您不想自己设置这些限制，请继续继承 GXT 本身。有关使用 <collapse-property> 和 <collapse-all-properties /> 的更多信息，请访问 http://code.google.com/p/google-web-toolkit/wiki/SoftPermutations

弃用说明

IE6 和 IE7 排列已在 GWT 2.6.0+ 中删除，并且未包含在 GXT 3.1 中。

目录

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例及类成员

桌面与移动视图

查看类源代码

GXT 4.x

目录

GXT 排列

参考

GXT 属性

GWT 属性

折叠属性

折叠所有属性

折叠 gxt.device

CSS3

FAQ

为什么 GXT 4.0 创建如此多的排列？

为什么 GXT 添加额外的属性，而不是使用 user.agent？

如果我设置了 gxt.user.agent，为什么不需要设置 user.agent？

GXT.gwt.xml 如何限制排列的数量，以及如何自己进行限制？

弃用说明

GXT 4.x