文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

当在初始化items配置期间或添加新项目时将原始配置对象添加到此容器中,或者added),或 {@link #insert inserted

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

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

参数

item :  Object

正在添加的配置对象。

返回
Ext.Component

要添加的组件。

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

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

类图标

- 表示框架类

- 单例框架类。*有关更多信息,请参见单例标志

- 组件类型框架类(Ext JS 框架中任何扩展 Ext.Component 的类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上类名称正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮按类型显示成员数(此计数在应用筛选器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。

获取器和设置器方法

与类配置选项相关的获取器和设置器方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,它们位于它们所处理的配置正下方。获取器和设置器方法文档将在配置行中找到,以便于参考。

历史记录栏

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

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

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

搜索和筛选器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个筛选器输入字段,它使用筛选器字符串筛选成员行。除了按字符串筛选外,您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框筛选类列表,以包括或排除私有类。

单击空搜索字段将显示您最近的 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原始页面除外)都有一个与该类相关的元数据的菜单视图。此元数据视图将具有以下一个或多个

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

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

GXT 4.x


顶部

使用 Eclipse Standard 源文件夹开始使用 GXT

要求

下载

如果您是试用客户

访问此 页面

如果您是活跃客户

从我们的 支持门户 下载。

构建路径

将 GXT jar 添加到项目的构建路径中。

  1. 在项目中创建一个lib目录。

  2. 找到 GXT Jar gxt-x.x.x.jar,然后将其复制到项目的lib目录中。

  3. lib目录中,右键单击gxt-x.x.x.jar,然后选择添加到构建路径

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样式表插入到项目 GXT XML 模块中。

     <!-- GXT Stylesheet -->
     <stylesheet src="reset.css" />
    
  4. 当使用 GXT 时,项目 GWT XML 模块将类似于以下内容。

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE module PUBLIC "-//Google Inc.//DTD GWT 2.7.0//EN"
          "http://gwtproject.org/doctype/2.7.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" />
    
        <!-- 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>
    

可选

GXT 内容辅助

配置 Eclipse 内容辅助以首先建议 GXT 组件。

  1. 右键单击项目,然后选择构建路径,再选择配置构建路径

  2. 选择顺序和导出选项卡。

  3. 选择 gxt-x.x.x.jar 并将其移动到 GWT 库上方。

  4. Eclipse 内容辅助的外观。

验证 GXT 安装

一旦项目设置完成,通过测试框架来验证库是否可用。

  1. 找到入口点类并添加一个 GXT 小部件。

     TextButton textButton = new TextButton("Verify GXT Works");
     RootPanel.get().add(textButton);
     textButton.addSelectHandler(new SelectHandler() {
       @Override
       public void onSelect(SelectEvent event) {
         MessageBox messageBox = new MessageBox("GXT Works.");
         messageBox.show();
       }
     });
    
  2. 调试项目并验证应用程序加载后小部件是否已呈现。

GXT 4.x