文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

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

展开和折叠示例和类成员

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

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

桌面视图与移动视图

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

查看类源代码

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

GXT 4.x


顶部

Sencha GXT 4.0 到 4.1 迁移指南

GXT 4.1.0 更新

GXT 4.1.0 已将 GWT 升级到 2.9.0,并将 Java 升级到 Java 11。

本指南涵盖了从 GXT 4.0 迁移到 GXT 4.1 的过程。

Maven 配置

将 Maven 配置与 GXT 一起使用。

Sencha MyGet 仓库配置

Pom.xml repositories 配置,用于使用 artifactory 检索构件。

  • ~/.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://extjs.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 入门

从以下各节中选择 IDE 和配置样式即可开始。

Eclipse

IntelliJ IDEA

入门常规配置

通常,设置 GXT 需要将库添加到构建路径并在 GWT XML 模块中进行配置。

构建路径配置

  • 将 GXT 库添加到项目 Build Path(构建路径)。

Jar 配置

如果您是 TRIAL 客户

访问此页面

如果您是 ACTIVE 客户

从我们的支持门户网站下载。

Maven 配置

  • 将 GXT 依赖项添加到 pom.xml 依赖项部分。

      <project>
          <dependencies>
              <!-- GXT -->
              <dependency>
                <groupId>com.sencha.gxt</groupId>
                <artifactId>gxt</artifactId>
                <version>4.1.0</version>
              </dependency>
          </dependencies>
      </project>
    

GWT XML 模块配置

配置 GWT 项目以继承 GXT 模块。

  1. 将 GXT 模块插入到项目 GWT XML 模块中。

      <!-- Other module inherits -->
      <inherits name='com.sencha.gxt.ui.GXT' />
    
  2. 删除内置样式 Clean,因为它不受支持。其他样式 StandardChromeDark 不会与 GXT 冲突。

     <!-- <inherits name='com.google.gwt.user.theme.clean.Clean'/> -->
    
  3. reset.css 样式表插入到项目 GWT XML 模块中。

     <!-- GXT Stylesheet -->
     <stylesheet src="reset.css" />
    
  4. 项目 GWT XML 模块中的 GXT 配置将如下所示

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE module PUBLIC "-//Google Inc.//DTD GWT 2.9.0//EN"
          "http://gwtproject.org/doctype/2.9.0/gwt-module.dtd">
      <module rename-to='gxt_project'>
        <!-- Inherit the core Web Toolkit stuff. -->
        <inherits name='com.google.gwt.user.User' />
    
        <!-- Other module inherits -->
        <inherits name='com.sencha.gxt.ui.GXT' />
    
        <!-- GXT stylesheet -->
        <stylesheet src="reset.css" /> <!-- Sets up the GXT default stylesheet -->
    
        <!-- Neptune Theme -->
        <inherits name="com.sencha.gxt.theme.neptune.Theme" />
    
        <!-- Specify the app entry point class. -->
        <entry-point class='com.sencha.gxt.project.client.GXT_Project' />
    
        <!-- Specify the paths for translatable code -->
        <source path='client' />
        <source path='shared' />
      </module>
    

    可选

    减少编译期间的排列组合数量。

    • 类似这样的内容可以添加到 GWT XML 模块描述符中

              <!-- collapse properties for fewer permutations -->
              <collapse-property name="gxt.device" values="phone, tablet" />
              <!-- <collapse-property name="gxt.theme" values="blue, gray" /> -->
      
              <collapse-property name="gxt.user.agent" values="air, safari*, chrome*, gecko*, ie11" />
              <collapse-property name="user.agent" values="safari*, gecko*" />
      
              <collapse-property name="gxt.user.agent" values="ie8, ie9, ie10" />
              <collapse-property name="user.agent" values="ie*" />
      

HTML 文档类型

HTML 页面文档类型必须设置为 HTML 5。这控制渲染引擎将如何渲染 GXT。

  • 将 html 页面文档类型设置为 HTML 5,位于 HTML 5 页面的顶部。

      <!DOCTYPE html>
    
  • 可以使用 HTML 4 strict 文档类型。

      <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.11//EN" "http://www.w3.org/TR/html4/strict.dtd">
    
  • HTML 5 页面示例。

      <!DOCTYPE html>
      <html>
        <head>
          <meta http-equiv="content-type" content="text/html; charset=UTF-8">
          <link type="text/css" rel="stylesheet" href="Project.css">
          <title>Project</title>
          <script type="text/javascript" language="javascript" src="project/project.nocache.js"></script>
        </head>
        <body>
    
        </body>
      </html>
    

构建主题

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

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

Sencha GXT 3.x 到 4.x 迁移指南

这涵盖了从 3.x 迁移到 4.x 的更改。

GWT

  • 升级到 GWT 2.7.0。
  • GWT 2.8.0 尚未发布,但发布后,它将与 GXT 4.0 配合使用。

Super Dev Mode 调试

以 Web 模式速度和源代码修改后的快速应用程序刷新来调试 GWT 应用程序。

了解如何在 Super Dev Mode 中详细使用,以实现更快的调试。

API 变更

已经进行了一些小的 API 变更,例如方法名称。

发行说明中查找这些更改的列表。

CSS3

Google 样式表 (GSS) 已默认添加到 GXT API,它为 GXT 小部件外观生成 CSS3。这并不意味着应用程序中必须更改 .css 文件的用法。虽然可以对任何 GWT 应用程序小部件执行相同的操作,但必须将其打开。打开它意味着任何 .css 文件都必须转换为 .gss 文件,并且转换 .css 文件可以通过几种不同的方式完成。

GSS 指南中了解如何将 .css 文件转换为 .gss 文件。

触摸支持

触摸支持已添加到 GXT API,并经过专门验证,可与平板电脑配合使用。这意味着该应用程序将在具有触摸手势的平板电脑上运行,而无需您付出额外的努力。如果您正在设计自定义小部件并且需要触摸支持,则可以添加手势来处理特定的触摸事件。

这是 GXT 手势识别器的列表。

主题升级

项目主题构建器主题配置文件将必须升级,因为以前的文件将缺少属性。在 3.x 主题文件上运行主题构建器,它将在输出日志中提供缺少的属性。

生成主题指南中了解有关如何运行主题构建器的更多信息。

主题选择

新的 Triton 主题已添加到主题选择中。

主题指南中了解有哪些主题可用。

排列组合

默认构建将具有更多的排列组合,因为已添加了新的构建延迟绑定属性。新的 gxt.device 属性已添加到桌面、平板电脑和手机排列组合区分中。此属性可以折叠,这意味着它仍会将设备逻辑烘焙到其中,但不会在单独的排列组合中执行此操作。

排列组合指南中了解有关属性折叠的更多信息。

GXT 4.x