文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

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)在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换全部状态将在页面加载之间记住。

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

桌面视图与移动视图

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

查看类源

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

GXT 4.x


顶部

Maven 配置

与 GXT 一起使用 Maven 配置。

Sencha MyGet 存储库配置

用于使用制品库来检索制品的 Pom.xml repositories 配置。

  • ~/.m2/settings.xml 中的凭据配置示例。

      <!-- Add this to the settings.xml file -->
      <!-- Use the support portal credentials -->
      <server>
          <id>sencha-myget</id>
          <username>[email protected]</username>
          <password>xxxxxx</password>
      </server>
    
  • pom.xml 存储库配置示例。

    <!-- https://ext.js.cn/gxt/latest/getting_started/maven/Maven.html -->
    <!-- ~/.m2/settings.xml add <server/> with the support portal credentials -->
    <repositories>
      <repository>
        <id>sencha-myget</id>
        <url>https://sencha.myget.org/F/artifacts/maven/</url>
      </repository>
    </repositories>
    <pluginRepositories>
      <pluginRepository>
        <id>sencha-myget</id>
        <url>https://sencha.myget.org/F/artifacts/maven/</url>
      </pluginRepository>
    </pluginRepositories>
    
  • pom.xml 依赖项示例。

    <dependencies>
      <dependencies>
        <!-- GXT -->
        <dependency>
          <groupId>com.sencha.gxt</groupId>
          <artifactId>gxt</artifactId>
          <version>4.1.0</version>
        </dependency>
        <dependency>
          <groupId>com.sencha.gxt</groupId>
          <artifactId>gxt-chart</artifactId>
          <version>4.1.0</version>
        </dependency>
        <dependency>
          <groupId>com.sencha.gxt</groupId>
          <artifactId>gxt-theme-neptune</artifactId>
          <version>4.1.0</version>
        </dependency>
        <dependency>
          <groupId>com.sencha.gxt</groupId>
          <artifactId>gxt-theme-triton</artifactId>
          <version>4.1.0</version>
        </dependency>
      </dependencies>
    

构建主题

使用单独的模块为项目构建主题。这需要几个步骤来排列 IDE 和 Maven 编译器的类路径。

找出主题构建器的模块配置的最佳路径是使用 GXT Archetypes 之一创建一个沙盒项目。

GXT 4.x