文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示 config 类型的类成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名称下方,有一行按钮,对应于当前类拥有的成员类型。每个按钮都显示按类型划分的成员计数(此计数会随着应用过滤器而更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类 config 选项相关的 Getter 和 Setter 方法将在方法部分以及 API 文档和成员类型菜单的 config 部分中显示,就在它们所作用的 config 下方。Getter 和 Setter 方法文档将在 config 行中找到,以便于参考。

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

根面板

使用 RootPanel 将 GXT 应用程序附加到 DOM。

参考

另请参阅

RootPanel

RootPanel 是将任何 GXT 小部件附加到 DOM 的基础。首先使用 GXT 布局容器之一,例如 Viewport

  • 使用 RootPanel 的示例。

      public class ProjectEntryPoint implements EntryPoint {
        @Override
        public void onModuleLoad() {
          CssFloatLayoutContainer container = new CssFloatLayoutContainer();
          container.add(new TextField(), new CssFloatData(1));
    
          Viewport viewPort = new Viewport();
          viewPort.setWidget(container);
    
          RootPanel.get().add(viewPort);
        }
      }
    

嵌入

使用 RootPanel 将 GXT 小部件嵌入到任何 HTML div 元素。在 HTML 中查找 div id,并将其与 RootPanel.get("divId") 一起使用,以嵌入 GXT 小部件。

  • 带有 id 的 div 的 HTML 示例。

      <!doctype html>
      <html>
        <head>
          <meta http-equiv="content-type" content="text/html; charset=UTF-8">
          <link type="text/css" rel="stylesheet" href="Project.css">
          <title>Project</title>
          <script type="text/javascript" language="javascript" src="project/project.nocache.js"></script>
        </head>
        <body>
          <div>Header</div>
    
          <!-- Div with the id for use for embedding the widget -->
          <div id="divId"></div>
    
          <div>Footer</div>
        </body>
      </html>
    
  • 在带有 id 的 HTML div 中嵌入小部件的示例。

      public class ProjectEntryPoint implements EntryPoint {
        @Override
          public void onModuleLoad() {
          CssFloatLayoutContainer container = new CssFloatLayoutContainer();
          container.add(new TextField(), new CssFloatData(1));
    
          RootPanel.get("divId").add(container);
        }
      }
    

嵌入调整大小

使用 ReszieLayoutPanel 为需要大小的子 GXT 小部件实现调整大小事件。这可以在窗口大小更改时调整子小部件的大小。

ResizeLayoutPanel 在窗口大小更改时不会触发,但它会监视其自身的 dom 元素的大小,并在大小更改时进行检查。这不是一个廉价的布局。

  • 使用 ResizeLayoutPanel 的示例。

      public class ProjectEntryPoint implements EntryPoint {
        @Override
        public void onModuleLoad() {
          CssFloatLayoutContainer container = new CssFloatLayoutContainer();
          container.add(new TextField(), new CssFloatData(1));
    
          final ResizeLayoutPanel rlp = new ResizeLayoutPanel();
          rlp.setSize("100%", "100%");
          rlp.setWidget(container);
    
          RootPanel.get("divId").add(rlp);
        }
      }
    

RootLayoutPanel

RootLayoutPanel 类似于 RootPanel,但会在 Window 大小更改时触发事件。

RootLayoutPanel 只允许一个子项,RootPanel 允许一对多。RootLayoutPanel 仅是 body 标签(并根据需要添加自己的标签),RootPanel 是任何按 id 标识的标签。

RootLayoutPanel 不会发出初始窗口大小信号,因此我们仍然需要一个 viewport 才能正常工作。当您使用 Viewport 小部件时,使用 RootLayoutPanel 而不是 RootPanel 没有任何优势。

  • 使用 RootLayoutPanel 的示例。

      public class ProjectEntryPoint implements EntryPoint {
        @Override
        public void onModuleLoad() {
          CssFloatLayoutContainer container = new CssFloatLayoutContainer();
          container.add(new TextField(), new CssFloatData(1));
    
          Viewport viewPort = new Viewport();
          viewPort.setWidget(container);
    
          RootLayoutPanel.get().add(viewPort);
        }
      }
    

GXT 4.x