文档帮助

目录

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

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
protected

当原始配置对象添加到此容器时调用，无论是在 items 配置的初始化期间，还是在添加新项目 added) or {@link #insert inserted 时。

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

当需要对子创建应用特殊处理时，可以在子类中重写此方法。

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型的框架类（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 原始页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

目录

参考 HasCell 用法 组合单元格 Identity Value Provider

组合单元格

组合单元格将多个单元格组合成一个单元格。这个难题有两个部分。在组合单元格中使用的 HasCell 单元格包装器。

参考

HasCell 用法

HasCell 单元格包装器将主单元格模型数据类型转换为单元格模型数据类型。CompositeCell 使用 HasCell 将数据类型发送到单元格。

  • TextInputCell 示例

      import com.google.gwt.cell.client.Cell;
  import com.google.gwt.cell.client.FieldUpdater;
  import com.google.gwt.cell.client.HasCell;
  import com.sencha.gxt.cell.core.client.form.TextInputCell;

  public class TextCellHasCell implements HasCell<Stock, String> {

    private TextInputCell sliderCell = new TextInputCell();

    @Override
    public Cell<String> getCell() {
      return sliderCell;
    }

    @Override
    public FieldUpdater<Stock, String> getFieldUpdater() {
      return new FieldUpdater<Stock, String>() {
        @Override
        public void update(int index, Stock object, String value) {
          object.setLast(Double.valueOf(value));
        }
      };
    }

    @Override
    public String getValue(Stock object) {
      return object.getLast().toString();
    }

  }

  • ButtonCell 示例

      import com.google.gwt.cell.client.Cell;
  import com.google.gwt.cell.client.FieldUpdater;
  import com.google.gwt.cell.client.HasCell;
  import com.google.gwt.cell.client.ValueUpdater;
  import com.google.gwt.dom.client.NativeEvent;
  import com.sencha.gxt.cell.core.client.ButtonCell;
  import com.sencha.gxt.core.client.dom.XElement;

  public class ButtonCellHasCell implements HasCell<Stock, String> {

    private ButtonCell<String> buttonCell = new ButtonCell<String>() {
      protected void onClick(Cell.Context context, XElement p, String value, NativeEvent event,
          ValueUpdater<String> valueUpdater) {
        super.onClick(context, p, value, event, valueUpdater);

        System.out.println("Button onClick");
      };
    };

    @Override
    public Cell<String> getCell() {
      return buttonCell;
    }

    @Override
    public FieldUpdater<Stock, String> getFieldUpdater() {
      return new FieldUpdater<Stock, String>() {
        @Override
        public void update(int index, Stock object, String value) {
        }
      };
    }

    @Override
    public String getValue(Stock object) {
      return "Finished";
    }

  }

组合单元格

组合单元格组合了包装本机单元格的 HasCell。

  • 使用 HasCell 的组合单元格示例。

      // Combine more than one cell for the column
  List<HasCell<Stock, ?>> cells = new ArrayList<HasCell<Stock, ?>>();
  cells.add(new TextCellHasCell());
  cells.add(new ButtonCellHasCell());

  CompositeCell<Stock> compositeCell = new CompositeCell<Stock>(cells) {
    // override the default layout
    @Override
    protected <X> void render(Cell.Context context, Stock value, SafeHtmlBuilder sb, HasCell<Stock, X> hasCell) {
      // Override individual cell layout
      Cell<X> cell = hasCell.getCell();

      // set the width of the text input cell
      if (cell instanceof TextInputCell) {
        ColumnConfig<Stock, Object> cc = grid.getColumnModel().getColumn(context.getColumn());
        TextInputCell tic = (TextInputCell) cell;
        tic.setWidth(cc.getWidth() - 20);
      }

      sb.appendHtmlConstant("<span>");
      cell.render(context, hasCell.getValue(value), sb);
      sb.appendHtmlConstant("</span>");
    }
  };

Identity Value Provider

Identity value provider 将整个数据对象或模型发送到单元格以供使用。HasCell 包装器允许特定单元格类型的数据转换。

  • 网格列配置中的 IdentityValueProvider 示例。

      // Use the model as the value provider and convert it in the HasCell implementation
  ColumnConfig<Stock, Stock> lastTransCol = new ColumnConfig<Stock, Stock>(new IdentityValueProvider<Stock>("Last"));

  lastTransCol.setHeader("Last");
  lastTransCol.setWidth(250);
  lastTransCol.setCell(compositeCell);

GXT 4.x