文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

当原始配置对象添加到此容器时调用,无论是在初始化 items 配置期间,还是在添加新项目 added 或 {@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 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

List Store Editor

将数据映射到编辑器图。

参考

演示

List store editor

此示例涵盖了使用 ListStoreEditor 的网格。

在此示例中,文件如下所示

对象图

示例中使用的对象图。此人员编辑器示例使用 Grid 用于人员的书籍库。请参阅 Grid 了解更多信息。

Person object graph

public class Person {
  private long id;
  private String name;
  private boolean active;
  private double ratio;
  private List<Book> library;
  public Person() {
  }
  public void setId(long id) {
    this.id = id;
  }
  public long getId() {
    return id;
  }
  public void setName(String name) {
    this.name = name;
  }
  public String getName() {
    return name;
  }
  public boolean isActive() {
    return active;
  }
  public void setActive(boolean active) {
    this.active = active;
  }
  public double getRatio() {
    return ratio;
  }
  public void setRatio(double ratio) {
    this.ratio = ratio;
  }
  public List<Book> getLibrary() {
    return library;
  }
  public void setLibrary(List<Book> library) {
    this.library = library;
  }
  @Override
  public String toString() {
    String s = "{ Person: ";
    s += "name=" + name + " ";
    s += "active=" + active + " ";
    s += "ratio=" + ratio + " ";
    s += "library=" + library + " ";
    s += "}";
    return s;
  }
}

Book object graph

public class Book {
  private long id;
  private String title;
  private int pages;
  public Book() {
  }
  public long getId() {
    return id;
  }
  public void setId(long id) {
    this.id = id;
  }
  public String getTitle() {
    return title;
  }
  public void setTitle(String title) {
    this.title = title;
  }
  public int getPages() {
    return pages;
  }
  public void setPages(int pages) {
    this.pages = pages;
  }
  @Override
  public String toString() {
    String s = "{ Book: ";
    s += "title=" + title + " ";
    s += "}";
    return s;
  }
}

Book Grid editor

BookGridEditor,它使用 ListStoreEditor 用于库或书籍

import com.google.gwt.core.client.GWT;
import com.google.gwt.editor.client.Editor;
import com.google.gwt.editor.client.IsEditor;
import com.google.gwt.user.client.ui.Composite;
import com.sencha.gxt.core.client.ValueProvider;
import com.sencha.gxt.data.client.editor.ListStoreEditor;
import com.sencha.gxt.data.shared.ListStore;
import com.sencha.gxt.data.shared.ModelKeyProvider;
import com.sencha.gxt.data.shared.PropertyAccess;
import com.sencha.gxt.widget.core.client.form.IntegerSpinnerField;
import com.sencha.gxt.widget.core.client.form.TextField;
import com.sencha.gxt.widget.core.client.grid.ColumnConfig;
import com.sencha.gxt.widget.core.client.grid.ColumnModel;
import com.sencha.gxt.widget.core.client.grid.Grid;
import com.sencha.gxt.widget.core.client.grid.editing.GridEditing;
import com.sencha.gxt.widget.core.client.grid.editing.GridInlineEditing;
import com.sencha.project.client.liststoreeditor.domain.Book;

import java.util.ArrayList;
import java.util.List;

public class BookGridEditor extends Composite implements IsEditor<Editor<List<Book>>> {
  interface BookProperties extends PropertyAccess<Book> {
    ModelKeyProvider<Book> id();

    ValueProvider<Book, String> title();

    ValueProvider<Book, Integer> pages();
  }

  private static final BookProperties bookProperties = GWT.create(BookProperties.class);

  private ListStore<Book> listStore;

  public BookGridEditor() {
    listStore = new ListStore<Book>(bookProperties.id());

    ColumnConfig<Book, String> colTitle = new ColumnConfig<Book, String>(bookProperties.title(), 150, "Title");
    ColumnConfig<Book, Integer> colPages = new ColumnConfig<Book, Integer>(bookProperties.pages(), 50, "Pages");

    List<ColumnConfig<Book, ?>> columns = new ArrayList<ColumnConfig<Book, ?>>();
    columns.add(colTitle);
    columns.add(colPages);
    ColumnModel<Book> cm = new ColumnModel<Book>(columns);

    Grid<Book> grid = new Grid<Book>(listStore, cm);
    grid.setPixelSize(200, 200);

    GridEditing<Book> editing = new GridInlineEditing<Book>(grid);
    editing.addEditor(colTitle, new TextField());
    editing.addEditor(colPages, new IntegerSpinnerField());

    initWidget(grid);

    grid.getView().setAutoExpandColumn(colTitle);
  }

  @Override
  public Editor<List<Book>> asEditor() {
    return new ListStoreEditor<Book>(listStore);
  }
}

Person editor

Person editor UiBinder

PersonEditor.ui.xml UiBinder,连接编辑器和输入

<!-- PersonEditor.ui.xml file -->
<!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
<ui:UiBinder
        xmlns:ui="urn:ui:com.google.gwt.uibinder"
        xmlns:container="urn:import:com.sencha.gxt.widget.core.client.container"
        xmlns:form="urn:import:com.sencha.gxt.widget.core.client.form"
        xmlns:button="urn:import:com.sencha.gxt.widget.core.client.button"
        xmlns:books="urn:import:com.sencha.project.client.liststoreeditor.bookslist">
    <ui:style>
        .widget {
            margin: 30px;
        }
    </ui:style>

    <container:FlowLayoutContainer ui:field="container" width="300" addStyleNames="{style.widget}">
        <container:child>
            <button:TextButton text="Save" ui:field="save"/>
        </container:child>
        <container:child>
            <form:FieldLabel text="Name">
                <form:widget>
                    <form:TextField ui:field="name"/>
                </form:widget>
            </form:FieldLabel>
        </container:child>
        <container:child>
            <form:FieldLabel text="" labelSeparator="">
                <form:widget>
                    <form:CheckBox ui:field="active" boxLabel="Active" enabled="true"/>
                </form:widget>
            </form:FieldLabel>
        </container:child>
        <container:child>
            <form:FieldLabel text="Ratio">
                <form:widget>
                    <form:DoubleSpinnerField ui:field="ratio"/>
                </form:widget>
            </form:FieldLabel>
        </container:child>
        <container:child>
            <form:FieldLabel text="Library">
                <form:widget>
                    <books:BookGridEditor ui:field="library"/>
                </form:widget>
            </form:FieldLabel>
        </container:child>
    </container:FlowLayoutContainer>
</ui:UiBinder>

Person editor widget

PersonEditor 连接 BookGridEditor 作为子编辑器,用于编辑人员的书籍库

import com.google.gwt.core.client.GWT;
import com.google.gwt.editor.client.Editor;
import com.google.gwt.editor.client.SimpleBeanEditorDriver;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.uibinder.client.UiHandler;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.Widget;
import com.sencha.gxt.widget.core.client.event.SelectEvent;
import com.sencha.gxt.widget.core.client.form.CheckBox;
import com.sencha.gxt.widget.core.client.form.DoubleSpinnerField;
import com.sencha.gxt.widget.core.client.form.TextField;
import com.sencha.project.client.liststoreeditor.books.BookGridEditor;
import com.sencha.project.client.liststoreeditor.domain.Person;

public class PersonEditor extends Composite implements Editor<Person> {
  // Editor driver
  private static final PersonDriver driver = GWT.create(PersonDriver.class);

  interface PersonDriver extends SimpleBeanEditorDriver<Person, PersonEditor> {
  }

  // UiBinder and fields
  private static final PersonEditorUiBinder uiBinder = GWT.create(PersonEditorUiBinder.class);

  interface PersonEditorUiBinder extends UiBinder<Widget, PersonEditor> {
  }

  @UiField
  TextField name;
  @UiField
  CheckBox active;
  @UiField
  DoubleSpinnerField ratio;
  @UiField
  BookGridEditor library;

  public PersonEditor() {
    initWidget(uiBinder.createAndBindUi(this));

    // Initialize the editor driver
    driver.initialize(this);
  }

  // Fill in the editors fields with the person properties
  public void edit(Person person) {
    driver.edit(person);
  }

  // When save is clicked
  @UiHandler("save")
  public void onSaveSelect(SelectEvent event) {
    Person person = driver.flush();
    System.out.println(person);

    // { Person: name=Fred Flinstone active=true ratio=13.123456
    //           library=[{ Book: title=The coming Iceage }, { Book: title=How to train a dinosaur. }] }
  }
}

示例编辑器用法

使用 PersonEditor 编辑人员

public void onModuleLoad() {
  Book book1 = new Book();
  Book book2 = new Book();

  book1.setId(1);
  book2.setId(2);
  book1.setTitle("The coming Iceage");
  book2.setTitle("How to train a dinosaur");
  book1.setPages(2);
  book2.setPages(3);

  List<Book> library = new ArrayList<Book>();
  library.add(book1);
  library.add(book2);

  Person person = new Person();
  person.setId(1);
  person.setName("Fred Flinstone");
  person.setActive(true);
  person.setRatio(12.123456);
  person.setLibrary(library);

  PersonEditor personEditor = new PersonEditor();
  RootPanel.get().add(personEditor);

  personEditor.edit(person);
}

GXT 4.x