列表编辑器
许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称被称为 alias（别名）（如果类扩展了 Ext.Component，则为 xtype）。别名/xtype 列在适用类的类名旁边，以供快速参考。
框架类或其成员可以指定为 private（私有的）或 protected（受保护的）。否则，该类/成员为 public（公共的）。Public、protected 和 private 是访问描述符，用于传达类或类成员应如何以及何时使用。
公共的 类和类成员可供任何其他类或应用程序代码使用，并且可以在主要产品版本中作为稳定且持久的内容依赖。公共类和成员可以通过子类安全地扩展。
受保护的 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
私有的 类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖它们。
static（静态的）标签。*请参阅下面的静态。下面是一个示例类成员，我们可以对其进行剖析，以展示类成员的语法（在本例中，从 Ext.button.Button 类查看的 lookupComponent 方法）。
让我们看一下成员行的每个部分
lookupComponent）( item )）Ext.Component）。对于不返回除 undefined 以外的任何内容的方法，可以省略此项，或者可以显示为用正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，则方法可能返回一个 Component，如果失败，则返回 false，这将显示为 Ext.Component/Boolean）。PROTECTED - 请参阅下面的标志部分）Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接；如果它从祖先类或混入类继承，则显示为灰色。view source（查看源代码））item : Object）。undefined 以外的值，则“返回值”部分将注明返回的类或对象类型以及描述（示例中为 Ext.Component）Available since 3.4.0（始于 3.4.0 版本）- 示例中未显示），紧随成员描述之后Defaults to: false（默认为：false））API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();false，则标记为可阻止的事件将不会触发- 表示一个框架类
- 一个单例框架类。*有关更多信息，请参阅单例标志
- 一个组件类型的框架类（Ext JS 框架中扩展 Ext.Component 的任何类）
- 表示该类、成员或指南在当前查看的版本中是新增的
- 表示类型为 config（配置）的类成员
- 表示类型为 property（属性）的类成员
- 表示类型为 method（方法）的类成员
- 表示类型为 event（事件）的类成员
- 表示类型为 theme variable（主题变量）的类成员
- 表示类型为 theme mixin（主题混入）的类成员
- 表示该类、成员或指南在当前查看的版本中是新增的
在 API 文档页面上，类名下方是一行按钮，对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数（此计数在应用过滤器后会更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单，以便快速导航。
与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中，紧挨着它们所作用的配置下方。Getter 和 Setter 方法文档将在配置行中找到，以便于参考。
您的页面历史记录保存在本地存储中，并显示在顶部标题栏下方（使用可用的实际空间）。默认情况下，显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中，您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”，则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后，每个历史页面的产品/版本将与页面名称一起显示在历史记录栏中。将光标悬停在历史记录栏中的页面名称上也会显示产品/版本作为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上，还有一个过滤器输入字段，该字段使用过滤器字符串过滤成员行。除了按字符串过滤外，您还可以按访问级别、继承和只读过滤类成员。这可以通过使用页面顶部的复选框来完成。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近的 10 次搜索，以便快速导航。
每个 API 文档页面（JavaScript 原始类型页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button 类具有备用类名 Ext.Button）。备用类名通常是为了向后兼容性而维护的。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”（查看源代码）链接来查看类成员的源代码。
将数据映射到编辑器图中。
有很多方法可以将 widget 构建为编辑器。在本指南中，示例提供了一个高级概述，其中一些 widget 使用了 UiBinder，而另一些则没有。UiBinder 不是布局所必需的，尽管它被用来提供带有编辑器构造的 widget 的角度。
本指南涵盖了 ListEditor 的基本示例。
在此示例中，文件如下所示
示例中使用的对象图。此 Person 编辑器使用 ListEditor 编辑 Person 的图书馆书籍列表。
包含图书馆书籍列表的 Person 对象图
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;
}
}
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;
}
}
BookItemEditor.ui.xml UiBinder
<!-- BookItemEditor.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:g="urn:import:com.google.gwt.user.client.ui"
xmlns:button="urn:import:com.sencha.gxt.widget.core.client.button"
xmlns:form="urn:import:com.sencha.gxt.widget.core.client.form">
<g:HorizontalPanel>
<g:cell>
<form:TextField ui:field="title" width="150px" />
</g:cell>
<g:cell>
<form:IntegerSpinnerField ui:field="pages" width="50px" />
</g:cell>
<g:cell>
<button:TextButton text="Delete" ui:field="delete" />
</g:cell>
</g:HorizontalPanel>
</ui:UiBinder>
用于编辑 Book 的 BookItemEditor
import com.google.gwt.core.client.GWT;
import com.google.gwt.editor.client.Editor;
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.IsWidget;
import com.google.gwt.user.client.ui.Widget;
import com.google.web.bindery.event.shared.HandlerRegistration;
import com.sencha.gxt.widget.core.client.event.SelectEvent;
import com.sencha.gxt.widget.core.client.form.IntegerSpinnerField;
import com.sencha.gxt.widget.core.client.form.TextField;
import com.sencha.project.client.listeditor.domain.Book;
import com.sencha.project.client.listeditor.event.EditorDeleteEvent;
import com.sencha.project.client.listeditor.event.EditorDeleteEventHandler;
public class BookItemEditor implements IsWidget, Editor<Book> {
// UiBinder
private static BookItemUiBinder uiBinder = GWT.create(BookItemUiBinder.class);
interface BookItemUiBinder extends UiBinder<Widget, BookItemEditor> {
}
@UiField
TextField title;
@UiField
IntegerSpinnerField pages;
private Widget widget;
@Override
public Widget asWidget() {
if (widget == null) {
widget = uiBinder.createAndBindUi(this);
}
return widget;
}
public final HandlerRegistration addDeleteHandler(EditorDeleteEventHandler handler) {
return widget.addHandler(handler, EditorDeleteEvent.TYPE);
}
@UiHandler("delete")
public void onDeleteSelect(SelectEvent event) {
widget.fireEvent(new EditorDeleteEvent());
}
}
用于删除库列表中 BookItemEditor 项目的事件和处理程序。
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.user.client.ui.Widget;
public class EditorDeleteEvent extends GwtEvent<EditorDeleteEventHandler> {
public static Type<EditorDeleteEventHandler> TYPE = new Type<EditorDeleteEventHandler>();
private Widget source;
public EditorDeleteEvent(Widget source) {
this.source = source;
}
public EditorDeleteEvent() {
}
@Override
public Type<EditorDeleteEventHandler> getAssociatedType() {
return TYPE;
}
@Override
protected void dispatch(EditorDeleteEventHandler handler) {
handler.onDeleteEvent(this);
}
public Widget getSource() {
return source;
}
}
import com.google.gwt.event.shared.EventHandler;
public interface EditorDeleteEventHandler extends EventHandler {
public void onDeleteEvent(EditorDeleteEvent event);
}
用于编辑人员图书馆书籍列表的 BookListEditor。ListEditor 创建一个由 ItemEditorSource 支持的列表，该列表管理添加和删除编辑器列表项。
import com.google.gwt.core.client.GWT;
import com.google.gwt.editor.client.IsEditor;
import com.google.gwt.editor.client.adapters.EditorSource;
import com.google.gwt.editor.client.adapters.ListEditor;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.IsWidget;
import com.google.gwt.user.client.ui.Widget;
import com.sencha.gxt.widget.core.client.container.FlowLayoutContainer;
import com.sencha.project.client.listeditor.domain.Book;
import com.sencha.project.client.listeditor.event.EditorDeleteEvent;
import com.sencha.project.client.listeditor.event.EditorDeleteEventHandler;
public class BookListEditor extends Composite implements IsWidget, IsEditor<ListEditor<Book, BookItemEditor>> {
// ListEditorExample and item editor manager.
private class ItemEditorSource extends EditorSource<BookItemEditor> {
@Override
public BookItemEditor create(final int index) {
BookItemEditor item = new BookItemEditor();
container.insert(item, index);
item.addDeleteHandler(new EditorDeleteEventHandler() {
public void onDeleteEvent(EditorDeleteEvent event) {
removeItem(index);
}
});
return item;
}
@Override
public void dispose(BookItemEditor item) {
item.asWidget().removeFromParent();
}
@Override
public void setIndex(BookItemEditor item, int index) {
container.insert(item, index);
}
}
// This source backs the ListEditorExample, which adds,inserts and removes child widgets from the list.
private ListEditor<Book, BookItemEditor> listEditor = ListEditor.of(new ItemEditorSource());
private FlowLayoutContainer widget;
public BookListEditor() {
initWidget(asWidget());
}
@Override
public Widget asWidget() {
if (widget == null) {
widget = new FlowLayoutContainer();
}
return widget;
}
@Override
public ListEditor<Book, BookItemEditor> asEditor() {
return listEditor;
}
// This is a good place to delete the item from the database, before removing
private void removeItem(int index) {
listEditor.getList().remove(index);
}
}
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.listeditor.bookslist">
<container:FlowLayoutContainer ui:field="container" width="300">
<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:BookListEditor ui:field="library"/>
</form:widget>
</form:FieldLabel>
</container:child>
</container:FlowLayoutContainer>
</ui:UiBinder>
PersonEditor 连接编辑器以编辑 Person
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.IsWidget;
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.listeditor.bookslist.BookListEditor;
import com.sencha.project.client.listeditor.domain.Person;
public class PersonEditor implements IsWidget, 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
BookListEditor library;
private Widget widget;
@Override
public Widget asWidget() {
if (widget == null) {
widget = uiBinder.createAndBindUi(this);
// Initialize the editor driver
driver.initialize(this);
}
return widget;
}
// 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. }] }
}
}
使用编辑器编辑一个人
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 | 使用条款