文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

Auto Beans

具有 JSON 和 XML 支持的 GWT Auto Beans。

目标

  • 减少样板代码
  • 序列化和反序列化 JSON 对象
  • 为 XML、JSON 和通用模型创建操作提供支持
  • 可在服务器端代码中使用

参考

支持的属性

  • 值类型
    • 原始类型及其包装类
    • BigInteger, BigDecimal
    • java.util.Date
    • 枚举类型
    • 字符串
  • 引用类型
    • 类似 Bean 的接口
    • 任何支持的属性类型的列表或集合
    • 任何支持的属性类型的映射

示例

JSON

XML

AutoBean 构造

AutoBean 必须使用接口类型参数化(例如 AutoBean)。此接口类型可以具有任何类型层次结构,并且无需扩展任何特定类型即可与 AutoBeans 一起使用。需要区分目标接口是否为“简单”。

简单接口满足以下属性

  • 仅具有 getter 和 setter 方法
  • 任何非属性方法都必须由类别实现

简单的 AutoBean 可以由 AutoBeanFactory 构建,而无需提供委托实例。

如果从目标接口中的方法返回引用接口,则该实例将自动由 AutoBean 实例包装。可以通过在 AutoBeanFactory 上放置 @NoWrap 注释来禁用此行为。

  • 示例

      import com.google.gwt.core.client.EntryPoint;
      import com.google.gwt.core.client.GWT;
      import com.google.web.bindery.autobean.shared.AutoBean;
      import com.google.web.bindery.autobean.shared.AutoBeanCodex;
      import com.google.web.bindery.autobean.shared.AutoBeanFactory;
      import com.google.web.bindery.autobean.shared.AutoBeanUtils;
    
      public class AutobeanExample implements EntryPoint {
    
        interface Person {
          String getName();
          void setName(String name);
    
          void setAddress(Address address);
          Address getAddress();
        }
    
        interface Address {
          void setStreet(String street);
          String getStreet();
    
          void setCity(String city);
          String getCity();
        }
    
        interface BeanFactory extends AutoBeanFactory {
          AutoBean<Address> address();
    
          AutoBean<Person> person();
        }
    
        @Override
        public void onModuleLoad() {
          BeanFactory factory = GWT.create(BeanFactory.class);
    
          // create a person autobean
          AutoBean<Person> personBean1 = factory.person();
    
          // serialize it into JSON
          String json = AutoBeanCodex.encode(personBean1).getPayload();
          System.out.println("json=" + json);
    
          // deserialize json into auto bean
          AutoBean<Person> bean = AutoBeanCodex.decode(factory, Person.class, json);
    
          // get the object
          Person person = bean.as();
    
          // create a autobean out of the object
          AutoBean<Person> personBean2 = AutoBeanUtils.getAutoBean(person);
        }
    
      }
    

AutoBean 选项

accept()

AutoBean 控制器提供了一个访问者 API,允许代码检查 AutoBean 的属性,而代码事先不知道包装的接口。

as()

AutoBean 充当 shim 对象的控制器,该对象实现了 AutoBean 参数化的接口。例如,为了获取 AutoBean 的 Person 接口有必要调用 as() 方法。这种间接级别的目的是为了避免如果 AutoBean 也实现其目标接口时可能发生的方法签名冲突。

clone()

可以克隆 AutoBean 和其中存储的属性值。clone() 方法有一个布尔参数,它将触发深拷贝或浅拷贝。与 AutoBean 关联的任何标签值都不会被克隆。包装委托对象的 AutoBeans 无法克隆。

getTag() / setTag()

任何类型的任意元数据都可以通过使用 AutoBean 作为类似 map 的对象与 AutoBean 关联。标签值不参与克隆或序列化操作。

isFrozen() / setFrozen()

可以通过调用 setFrozen() 禁用属性突变。任何尝试在冻结的 AutoBean 上调用 setter 的操作都将导致 IllegalStateException。

isWrapper() / unwrap()

如果用于实例化 AutoBean 的工厂方法提供了委托对象,则可以通过调用 unwrap() 对象来分离 AutoBean。isWrapper() 方法将指示

AutoBeanFactory

用于创建 bean 的工厂。

interface MyFactory extends AutoBeanFactory { // 用于简单 AutoBean 的工厂方法 AutoBeanperson();

// 用于非简单类型或包装现有实例的工厂方法 AutoBeanperson(Person toWrap); }

AutoBeanVisitor

AutoBeanVisitor 是一个具体的、无操作的基类型,旨在由希望在 AutoBean 的目标接口上编写类似反射代码的开发人员扩展。

visit() / endVisit()

无论 AutoBean 图的引用结构如何,访问者都将精确访问任何给定的 AutoBean 一次。AutoBeanVisitor 的用户不应需要自己实现循环检测。

Context 接口为空,存在是为了允许未来扩展。

visitReferenceProperty() / visitValueProperty()

AutoBeanVisitor 类型中的属性访问方法将接收 PropertyContext 对象,该对象允许突变属性的值,以及提供有关字段的类型信息。在调用 set() 之前调用 canSet() 可以提高代码的整洁度。

visitCollectionProperty() / visitMapProperty()

这些访问方法的行为类似于 visitReferenceProperty(),但是传递到这些方法中的 PropertyContext 专门用于提供 Collection 或 Map 对象的参数化。

AutoBeanUtils

diff()

在两个 AutoBeans 中的属性之间执行浅比较,并返回一个属性映射,其中包含彼此不相等的属性。bean 不需要是相同的接口类型,这允许一定程度的鸭子类型。

getAllProperties()

创建 AutoBean 中属性的浅拷贝。修改返回的映射的结构不会对 AutoBean 的状态产生任何影响。映射中的引用值不会被克隆,而是 AutoBean 的属性持有的相同实例。

类别

纯 bean 接口在产生有用的系统方面只能做到这一点。例如,RequestFactory 使用的 EntityProxy 类型是一个 AutoBean 接口,除了添加了 stableId() 方法。如果任何非属性接口的实现由类别提供,则 AutoBeanFactory 可以生成非包装器(又名“简单”)的非简单接口的实例。

interface Person {
  String getName();
  void setName(String name);
  boolean marry(Person spouse);
}

@Category(PersonCategory.class)
interface MyFactory {
  // Would be illegal without a category providing an implementation of marry(AutoBean<Person> person, Person spouse)
  AutoBean<Person> person();
}

class PersonCategory {
  public static boolean marry(AutoBean<Person> instance, Person spouse) {
    return new Marriage(instance.as(), spouse).accepted();
  }
}

对于任何非属性方法,类别都必须声明一个公共静态方法,该方法具有一个额外的第 0 个参数,该参数接受支持实例的 AutoBean。RequestFactory 的另一个示例演示了 stableId() 方法的实现

class EntityProxyCategory {
  EntityProxyId<?> stableId(AutoBean<EntityProxy> instance) {
    return (EntityProxyId<?>) instance.getTag("stableId");
}

@Category 注释可以指定多个类别类型。将选择第一个类别中名称与类型可分配的非属性方法匹配的第一个方法。在做出此决定时,会检查第 0 个参数 AutoBean 的参数化。

GXT 4.x