文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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 文档和成员类型菜单的 config 部分中,就在它们所处理的 config 下方。Getter 和 Setter 方法文档将在 config 行中找到,以便于参考。

历史记录栏

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

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

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

搜索和过滤器

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

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

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面视图 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

小部件配置

构建 GWT 和 GXT 小部件的基本构建块。

前提条件

使用的小部件配置可能因应用程序设计要求而异。我们建议阅读 布局

参考

调整子项大小

这些小部件配置类型将使父级能够正确调整其子级的大小。请参阅有关 布局布局容器根面板布局 的更多信息。

  • IsWidget
  • GXT Composite
  • GWT ResizeComposite

不调整子项大小

这些小部件配置在不调整子项大小时工作。请参阅有关 布局布局容器根面板布局 的更多信息。

  • GWT Composite

小部件配置

IsWidget

此配置分离了对 Widget 类的依赖,并且对于 JUnit 测试很有用。

  • com.google.gwt.user.client.ui.IsWidget 基本示例

      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.VerticalLayoutContainer;
    
      public class TheIsWidget implements IsWidget {
          private VerticalLayoutContainer widget;
    
          @Override
          public Widget asWidget() {
              if (widget == null) {
                  widget = new VerticalLayoutContainer();
                  widget.add(new HTML("Using IsWidget"), new VerticalLayoutContainer.VerticalLayoutData(1, 1));
              }
              return widget;
          }
      }
    

使用 UiBinder 的 IsWidget

此配置分离了对 Widget 类的依赖,并且对于 JUnit 测试很有用。

  • com.google.gwt.user.client.ui.IsWidget 和 UiBinder 的基本示例

      import com.google.gwt.core.client.GWT;
      import com.google.gwt.uibinder.client.UiBinder;
      import com.google.gwt.user.client.ui.IsWidget;
      import com.google.gwt.user.client.ui.Widget;
      import com.sencha.gxt.widget.core.client.container.SimpleContainer;
    
      public class TheWidget implements IsWidget {
          // UiBinder with a the more specific root widget SimpleContainer
          interface TheWidgetUiBinder extends UiBinder<SimpleContainer, TheWidget> {
          }
    
          private static TheWidgetUiBinder binder = GWT.create(TheWidgetUiBinder.class);
    
          private SimpleContainer widget;
    
          @Override
          public Widget asWidget() {
              if (widget == null) {
                  widget = binder.createAndBindUi(this);
              }
              return widget;
          }
      }
    
  • TheWidget.ui.xml uiBinder 文件

      <!-- TheWidget.ui.xml file -->
      <ui:UiBinder xmlns:ui='urn:ui:com.google.gwt.uibinder'
                   xmlns:g='urn:import:com.google.gwt.user.client.ui'
                   xmlns:container="urn:import:com.sencha.gxt.widget.core.client.container">
          <container:SimpleContainer>
              <g:HTML>Using UiBinder</g:HTML>
          </container:SimpleContainer>
      </ui:UiBinder>
    

GXT Composite

此小部件配置类似于 GWT composite,并将像下面的 ResizingComposite 一样传递大小调整。

  • 基本示例

      import com.google.gwt.user.client.ui.HTML;
      import com.sencha.gxt.widget.core.client.Composite;
      import com.sencha.gxt.widget.core.client.container.VerticalLayoutContainer;
    
      public class TheGxtComposite extends Composite {
          public TheGxtComposite() {
              VerticalLayoutContainer widget = new VerticalLayoutContainer();
              widget.add(new HTML("Using Gxt Composite"), new VerticalLayoutContainer.VerticalLayoutData(1, 1));
    
              initWidget(widget);
          }
      }
    

使用 UiBinder 的 GXT Composite

此小部件配置用于封装一个或多个小部件。它不会传递大小调整。

  • 带有 GXT com.sencha.gxt.widget.core.client.Composite 和 UiBinder 的基本示例

      import com.google.gwt.core.client.GWT;
      import com.google.gwt.uibinder.client.UiBinder;
      import com.google.gwt.user.client.ui.Widget;
      import com.sencha.gxt.widget.core.client.Composite;
      import com.sencha.gxt.widget.core.client.container.SimpleContainer;
    
      public class TheWidget extends Composite {
          interface TheWidgetUiBinder extends UiBinder<Widget, TheWidget> {
          }
    
          private static TheWidgetUiBinder binder = GWT.create(TheWidgetUiBinder.class);
    
          private SimpleContainer widget;
    
          public TheWidget() {
              initWidget(binder.createAndBindUi(this));
          }
      }
    
  • TheWidget.ui.xml UiBinder 文件

      <!-- TheWidget.ui.xml file -->
      <ui:UiBinder xmlns:ui='urn:ui:com.google.gwt.uibinder'
                   xmlns:g='urn:import:com.google.gwt.user.client.ui'
                   xmlns:container="urn:import:com.sencha.gxt.widget.core.client.container">
          <container:SimpleContainer>
              <g:HTML>Using Composite with UiBinder</g:HTML>
          </container:SimpleContainer>
      </ui:UiBinder>
    

GWT Composite

此小部件配置用于封装一个或多个小部件,并且不会传递大小调整。此小部件不实现 com.google.gwt.user.client.ui.RequiresResize

  • 带有 GWT com.google.gwt.user.client.ui.Composite 的基本示例。

      import com.google.gwt.user.client.ui.Composite;
      import com.google.gwt.user.client.ui.HTML;
      import com.sencha.gxt.widget.core.client.container.VerticalLayoutContainer;
    
      public class TheGwtComposite extends Composite {
        public TheGwtComposite() {
          VerticalLayoutContainer widget = new VerticalLayoutContainer();
          widget.add(new HTML("Using Gwt Resize Composite"), new VerticalLayoutContainer.VerticalLayoutData(1, 1));
    
          initWidget(widget);
        }
      }
    

GWT ResizeComposite

此小部件配置用于封装一个或多个小部件并传递大小调整。

  • 带有 GWT com.google.gwt.user.client.ui.ResizeComposite 的基本示例。

      import com.google.gwt.user.client.ui.HTML;
      import com.google.gwt.user.client.ui.ResizeComposite;
      import com.sencha.gxt.widget.core.client.container.VerticalLayoutContainer;
    
      public class TheGwtResizeComposite extends ResizeComposite {
        public TheGwtResizeComposite() {
          VerticalLayoutContainer widget = new VerticalLayoutContainer();
          widget.add(new HTML("Using Gwt Resize Composite"), new VerticalLayoutContainer.VerticalLayoutData(1, 1));
    
          initWidget(widget);
        }
      }
    

GXT 4.x