文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

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

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

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

参数

项目 :  对象

正在添加的配置对象。

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

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

桌面 -vs- 移动视图

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

查看类源

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

GXT 4.x


顶部

主题构建器简介

随着 GXT 3.1 的主题构建器的引入,你现在可以开始生成主题作为大量外观,只需几个设置。

参考

关于

主题构建器是一个工具,它采用一个简单的主题配置文件,并生成一个 jar 文件,其中包含对 GXT 应用程序进行主题设置所需的所有外观。主题配置文件格式允许使用 css3 值,例如边框半径和渐变,并且主题创建者可以创建可以在可能不支持这些功能的浏览器中使用外观。它通过尽可能使用现代 CSS 和 HTML 来实现这一点,否则生成所需功能的图像。

    theme {
      name = "neptune"
      basePackage = "com.sencha.gxt.theme.neptune"
      details {
        buttonGroup {
          borderRadius = 3
          border = util.border('solid', '#dfeaf2', 3)
          headerGradient = util.solidGradientString('#dfeaf2')
          font = util.fontStyle("helvetica, arial, verdana", '13px', '#666666');
          ...
        }
        ...

虽然 GXT 3.1 本身继续支持 Java 6,但主题构建器本身需要 Java 7,尽管主题构建器生成的代码将与 Java 6 兼容。命令行工具经过测试,可以在 Windows 和 OS X 以及多个 Linux 发行版上运行。下载 zip 中的 shell 和批处理脚本仅在 Windows 或 OS X 上运行,以防止 zip 文件变得更大。要在 Linux 上运行脚本,需要 PhantomJS 的副本。

GXT 中几乎所有可用的窗口小部件和单元格都可以使用 350 多个配置属性进行主题设置。对于所有显示文本的窗口小部件,可以通过单个配置指定字体系列、大小、颜色和粗细。对于带边框的窗口小部件,还可以指定颜色、宽度和样式。在许多窗口小部件中,填充和间距是可配置的,背景颜色也是可配置的,有时甚至渐变也是可配置的。

实现

主题生成器从一组接口开始,并读取每个方法的名称以决定要预期的属性。任何非基本类型、非字符串方法都假定为子对象,该对象也必须存在于配置文件中。配置文件被解析到内存中,并且在需要值时,从属性集中查找这些值,并且根据需要执行任何表达式或函数。

然后,所有这些数据都用于实现上述接口,这些接口仅返回常量。这允许编译器将这些常量重写到引用它们的位置,以确保我们拥有尽可能最简单的 CSS。使用这组初始 CSS 在 PhantomJS 中启动一个示例应用程序,以绘制基本窗口小部件集,并截取屏幕截图,以及对边框、填充等位置的测量,以便可以从该屏幕截图中剪切图像。然后,这些生成的图像可用于不支持渐变或圆角的浏览器。

入门

打包主题

  • 试用其中一个打包的 主题

构建主题

GXT 4.x