文档帮助

目录

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 Getter 和 Setter 方法 历史记录栏 搜索和过滤器 API 文档类元数据 展开和折叠示例以及类成员 桌面视图与移动视图 查看类源代码

术语、图标和标签

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

访问级别

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

成员类型

成员语法

下面是一个类成员示例，我们可以剖析它以展示类成员的语法（在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法）。

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
受保护的

当原始配置对象添加到此容器时调用，无论是在 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


顶部

目录

参考 启用 GSS 自动转换 自动转换模式 文件 编译 转换 自动转换 自动转换模式 Java 转换器 Java 转换器选项 Java 转换器单文件示例 Java 转换器项目示例 自定义外观选项 主题属性工厂

GSS

GSS 为现代浏览器提供 CSS3，并为 IE8 和 IE9 提供切片模拟，使用
GSS 样式表语法。GSS 提供了增强的语法功能，可以为每个客户端烘焙恰到好处的 CSS3 配置。

参考

启用 GSS

为项目启用 GSS 使用。

为项目启用 GSS

<!-- Put this in the Project.gwt.xml configuration file -->
<set-configuration-property name="CssResource.enableGss" value="true" />

为项目 UiBinder 启用 GSS

<!-- Put this in the Project.gwt.xml configuration file -->
<set-configuration-property name="CssResource.gssDefaultInUiBinder" value="true" />

为单个 UiBinder 启用内联 GSS

<ui:style gss="true">
   /* style... */
</ui:style>

自动转换

动态将 .css 文件转换为 .gss。

<!-- Put this in the Project.gwt.xml configuration file -->
<!-- Modes: strict, lenient, off --> 
<set-configuration-property name="CssResource.conversionMode" value="strict" />

自动转换模式

有三种模式：strict（严格）、lenient（宽松）和 off（关闭）。

模式 描述
strict（严格） 任何 css 生成器转换错误都将中止编译。
lenient（宽松） gss 生成器不会因 css 错误而失败。
off（关闭） gss 生成器不会将 css 转换为 gss。

文件

GSS 的文件扩展名。

  • .gss 例如 MyStyles.gss

  • 无效用法

      // Don't mix .css and .gss files
  @Source({"file1.css", "file2.gss"})
  Styles css();

编译

手动编译 GSS 文件以进行验证。

  • 运行 java -jar closure-stylesheets.jar --pretty-print MyStyles.gss

转换

自动转换

使用编译器生成器动态将 .css 文件转换为 .gss。

<!-- Put this in the Project.gwt.xml configuration file -->
<!-- Modes: strict, lenient, off --> 
<set-configuration-property name="CssResource.conversionMode" value="strict" />

自动转换模式

有三种模式：strict（严格）、lenient（宽松）和 off（关闭）。

模式 描述
strict（严格） 任何 CSS 生成器转换错误都将中止编译。
lenient（宽松） GSS 生成器不会因 CSS 错误而失败。
off（关闭） GSS 生成器不会将 CSS 转换为 GSS。

Java 转换器

运行 java 应用程序将 .css 文件转换为 .gss 文件。

java com.google.gwt.resources.converter.Css2Gss [Options] [file or directory]

Java 转换器选项

  • -r - 递归转换给定目录中的所有 CSS 文件。不会删除 .css 文件。
  • -condition [list_of_conditionals] - 指定以逗号分隔的变量列表，这些变量在条件语句中使用，以映射到配置属性。转换器在转换这些条件时不会使用 is() 函数。
  • -scope [list_of_files] - 指定以逗号分隔的 CSS 文件列表，用于转换以确定所有定义的变量。

Java 转换器单文件示例

$ CP=”/path/to/gwt-user.jar:/path/to/gwt-dev.jar”
$ java -cp $CP com.google.gwt.resources.converter.Css2Gss /path/to/myStyles.css

Java 转换器项目示例

$ java -cp $CP com.google.gwt.resources.converter.Css2Gss -r /path/to/project

自定义外观选项

并非所有浏览器都支持 CSS3，因此 GXT 提供了切片外观来模拟 CSS3 规则，例如圆角。在编写自定义外观并且需要支持旧版浏览器时，可以设置开关以提供兼容的外观。

主题属性工厂

确定浏览器是否可以支持 CSS3 或切片。

import com.google.gwt.core.client.GWT;
import com.sencha.gxt.core.client.BindingPropertySet;
import com.sencha.gxt.core.client.BindingPropertySet.PropertyName;

public class ThemePropertyUtils {
  @PropertyName("gxt.css3.enabled")
  interface Theme extends BindingPropertySet {
    @PropertyValue("true")
    boolean isCss3Enabled();
  }

  private static final Theme themeSettings() {
    return GWT.<Theme> create(Theme.class);
  }
}

在不支持 CSS3 时切换外观

ButtonCellAppearance<String> redThemeAppearance = null;
if (ThemePropertyUtils.themeSettings().isCss3Enabled()) {
  redThemeAppearance = new Css3ButtonCellAppearance<String>();
} else {
  redThemeAppearance = new SlicedButtonCellAppearance<String>();
}

GXT 4.x