文档帮助

目录

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

术语、图标和标签

许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称被称为 别名（如果类扩展了 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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面视图与移动视图

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

查看类源代码

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

GXT 4.x


顶部

目录

大小调整选项 父容器大小调整 字段大小调整 字段 CSS 大小调整 参考 Java 示例 父容器大小 字段自身大小 UiBinder 示例 父容器调整子容器大小 字段自身大小

字段大小调整

字段大小调整可以通过几种不同的方式完成。

大小调整选项

父容器大小调整

当 GXT 布局树与 ResizeContainers 链接在一起，并且父容器被调整大小时，子容器也会被调整大小。

字段大小调整

当字段的父容器未连接到 ResizeContainers 树时，它可以自行调整大小。GXT 布局树可以通过使用 GWT 原生面板或 GXT 非 ResizeContainer 来打破。

字段 CSS 大小调整

虽然 CSS 可以设置字段的大小，但不建议这样做。GXT 组件的额外好处是在每个浏览器中都经过测试，这意味着 GXT 可以保证以编程方式更改大小在每个浏览器中看起来都相同。混合使用 CSS 将不具有相同的外观保证。

参考

Java 示例

父容器大小

在此示例中，VerticalLayoutContainer 的大小是，因为字段嵌入在其中，因此它们的大小适合。

  • VerticalLayoutContainer 调整其子容器大小的示例

      private void display() {
    TextField nameField = new TextField();
    TextField descriptionField = new TextField();

    VerticalLayoutContainer verticalLayoutContainer = new VerticalLayoutContainer();
    verticalLayoutContainer.setWidth(300); 

    verticalLayoutContainer.add(nameField, new VerticalLayoutData(1, -1)); 
    verticalLayoutContainer.add(descriptionField, new VerticalLayoutData(1, -1));

    RootPanel.get().add(verticalLayoutContainer);
  }

字段自身大小

在此示例中，FlowPanel 用于打破父容器调整字段大小。

  • 字段自身大小的示例

      private void display() {
    TextField nameField = new TextField();
    TextField descriptionField = new TextField();

    nameField.setWidth(50);
    descriptionField.setWidth(300);

    FlowPanel flowPanel = new FlowPanel();
    flowPanel.add(nameField);
    flowPanel.add(descriptionField);

    RootPanel.get().add(flowPanel);
  }

UiBinder 示例

父容器调整子容器大小

在此示例中，父 VerticalLayoutContainer 将调整子字段的大小。

  • VerticalLayoutContainer 调整其子容器大小的示例

      <!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
  <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" 
      xmlns:form='urn:import:com.sencha.gxt.widget.core.client.form'>
      <ui:style>
          .widget {
          }
      </ui:style>

      <!--VerticalLayoutData margins -->
      <ui:with type="com.sencha.gxt.core.client.util.Margins" field="margins">
          <ui:attributes top="4" right="4" bottom="4" left="4" />
      </ui:with>

      <!-- VerticalLayoutData layoutData sets sizes of its children -->
      <ui:with type="com.sencha.gxt.widget.core.client.container.VerticalLayoutContainer.VerticalLayoutData" field="layoutData">
          <ui:attributes width="300" height="-1" margins="{margins}" />
      </ui:with>

      <container:VerticalLayoutContainer addStyleNames="{style.widget}">

          <!-- Children take the size of the VerticalLayoutContainer -->
          <container:child layoutData="{layoutData}">
              <form:TextField ui:field="name" />
          </container:child>
          <container:child layoutData="{layoutData}">
              <form:TextField ui:field="description" />
          </container:child>

      </container:VerticalLayoutContainer>
  </ui:UiBinder>

字段自身大小

在此示例中，FlowLayoutContainer 用于打破父容器调整字段大小。

  • 字段自身大小的示例

      <!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
  <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" 
      xmlns:form='urn:import:com.sencha.gxt.widget.core.client.form'>

      <container:FlowLayoutContainer ui:field="container">
           <form:TextField ui:field="name" width="50px" />
           <form:TextField ui:field="description" width="300px" />
      </container:FlowLayoutContainer>
  </ui:UiBinder>

GXT 4.x