文档帮助

目录

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

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

当原始配置对象添加到此容器时调用，无论是在 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 原始类型页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

目录

参考 reset.css HTML 样式选项 非混淆 Css 类名 UiBinder 用法 ClientBundle 用法 客户端 Bundle 接线示例

HTML 样式

使用 CSS 设置 HTML 样式。

  • 外观通常会优先于任何自定义样式。

参考

reset.css

reset.css 文件在 GWT 模块项目配置中使用，以便为所有受支持的浏览器上的 GXT 创建通用的 CSS 平台。因此，在设置 HTML 样式时，您必须显式提供一些默认样式。

HTML 样式选项

从下面的 UiBinder 和 ClientBundle 开始，为小部件和元素提供样式有多种选择。当您提供自己的样式时，请务必检查目标浏览器以确保渲染一致性。

非混淆 Css 类名

您可以使用未混淆的完整类名。这将允许您直接调用元素。虽然可以这样做，但通常使用选择器来设置小部件中子元素的样式。

  • 使用此选项可使用完全限定的 css 类名。这将启用漂亮的样式名称。

      <!-- Add this to the GWT project module xml descriptor project.gwt.xml -->
  <set-configuration-property name="CssResource.style" value="pretty" />

UiBinder 用法

UiBinder 提供了一个内联样式元素来添加 CSS 选择器。这会以内联方式添加样式，这将影响整个应用程序。

  • 带有内联样式配置的 UiBinder 示例。

      <ui:UiBinder xmlns:ui='urn:ui:com.google.gwt.uibinder'
      xmlns:g='urn:import:com.google.gwt.user.client.ui'>

      <!-- http://www.w3.org/TR/CSS2/sample.html - can be used to copy default styles -->
      <ui:style>
      h1 {
          font-size: 2em;
          margin: .67em 0;
      }
      </ui:style>

      <g:HTMLPanel>
          <h1>This is heading 1</h1>
      </g:HTMLPanel>
  </ui:UiBinder>

ClientBundle 用法

GWT 提供了方便的资源捆绑，可以清晰地抽象样式。此方法展示了如何在小部件中使用原始 HTML 并设置其样式。

连接客户端捆绑包有三个步骤。

  1. 配置 CSS 文件。

  2. 配置 Java 接口以引用 CSS 选择器和其他资源。

  3. 注入样式，然后在小部件或元素上获取并设置样式名称。

客户端 Bundle 接线示例

  1. customStyles.css 文件，它将通过客户端捆绑包提供样式。

     /* customStyles.css file */

 .htmlFormatting {
     border: 1px solid red;
 }

 .htmlFormatting h1,h2,h3,h4,h5,h6 {
     border: 2px solid blue;
 }

  2. 这为小部件中的 CSS 资源访问连接了客户端捆绑包。

     import com.google.gwt.core.client.GWT;
 import com.google.gwt.resources.client.ClientBundle;
 import com.google.gwt.resources.client.CssResource;

 public interface CustomHtmlStyle extends ClientBundle {

   // static factory for getting the client bundle resource instance
   public static final CustomHtmlStyle INSTANCE = GWT.create(CustomHtmlStyle.class);

   public interface LayoutStyles extends CssResource {
     // this is one of the css selectors in the style sheet
     String htmlFormatting();
   }

   // the css file name 'customStyles.css' located in the same package
   public LayoutStyles customStyles();
 }

  3. 使用客户端捆绑包实例获取 CSS 选择器样式名称的示例。

     import com.google.gwt.user.client.ui.HTML;
 import com.google.gwt.user.client.ui.IsWidget;
 import com.google.gwt.user.client.ui.Widget;
 import com.sencha.gxt.widget.core.client.container.CssFloatLayoutContainer;
 import com.sencha.gxt.widget.core.client.container.CssFloatLayoutContainer.CssFloatData;

 public class HtmlStyle implements IsWidget {

   private CssFloatLayoutContainer widget;

   @Override
   public Widget asWidget() {
     if (widget == null) {
       // inject the styles into the document so they are available
       CustomHtmlStyle.INSTANCE.customStyles().ensureInjected();

       widget = new CssFloatLayoutContainer();
       widget.add(new HTML("<h1>This is heading 1</h>"), new CssFloatData(1));

       // Get the client bundle style name reference
       String styleName = CustomHtmlStyle.INSTANCE.customStyles().htmlFormatting();
       widget.setStyleName(styleName);

     }
     return widget;
   }
 }

GXT 4.x