文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

当原始配置对象添加到此容器时调用,无论是在 items 配置的初始化期间,还是在添加新项目时 added),或 {@link #insert inserted}

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

让我们看看成员行的每个部分

成员标志

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

类图标

- 表示框架类

- Singleton 框架类。*有关更多信息,请参阅 singleton 标志

- 组件类型框架类(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 值,例如边框半径和渐变,并且 themer 创建的外观可用于可能不支持这些功能的浏览器。它通过尽可能使用现代 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 的副本。

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

实现

主题构建器从一组接口开始,并读取每个方法的名称以确定要期望哪些属性。任何非原始类型、非 String 类型的方法都被假定为必须也存在于配置文件中的子对象。配置文件被解析到内存中,并且在需要值时,会从属性集中查找它们,并根据需要执行任何表达式或函数。

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

入门

打包主题

  • 试用一个打包的主题

构建主题

GXT 4.x