文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

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

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

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

参数

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

PropertyAccess

PropertyAccess提供实现者通过属性提供程序定义访问 bean 值。

  • PropertyAccess<M> 泛型类型 <M> 表示 bean 模型。
  • PropertyAccess<M> 接口提供样板代码减少。
  • bean 类成员变量访问器应遵循 Java bean 访问器模式。

参考

演示

示例

这是一个 bean 的 PropertyAccess 定义配置的简单示例。

Bean

带有具有匹配访问器属性命名的类数据成员的 bean。

  • 请注意,访问器的属性名称以大写字母开头。
  • 可以使用 @Path("get_property")@Path("getproperty") 或仅将 PropertyAccess 方法命名为类似 getproperty 的名称来规避访问器属性。

      public class Stock implements Serializable {
        private Integer id;
        private String name;
    
        public Stock() {}
    
        // Notice the the accessor Id starts with a capital.
        public Integer getId() {
          return id;
        }
        public void setId(Integer id) {
          this.id = id;
        }
    
        // Notice the accessor Name starts with a capital.
        public String getName() {
          return name;
        }
        public void setName(String name) {
          this.name = name;
        }
        //...
      }
    

PropertyAccess bean 定义

这是一个简单的 PropertyAccess<Stock> 接口,它描述了 bean 中可用的值。

  • @Path("id") 允许更改属性名称。

      public interface StockProperties extends PropertyAccess<Stock> {
        // The property is defined as 'key()' but matches up to the bean class variable 'id'
        @Path("id")
        ModelKeyProvider<Stock> key();          
        ValueProvider<Stock, String> name();
        //...
      } 
    
  • 初始化 bean PropertyAccess<M> 定义。

      private static final StockProperties gridProperties = GWT.create(StockProperties.class);
    

属性定义命名

属性名称表示 bean 类成员变量,或者换句话说,类变量名称。

  • @Path("classVariableName") 属性提供程序注释允许不同的属性命名。

属性值提供程序

属性提供程序为 bean 值的数据访问提供定义。

  • ModelKeyProvider<M>LabelProvider<M>ValueProvider<M, V> 是三个主要的属性提供程序。

IdentityValueProvider<M>

提供只读 ValueProvider<M>。为属性提供只读值。

LabelProvider<M>

为属性提供只读字符串。

ModelKeyProvider<M>

提供实现者访问 bean 的唯一标识符。

StringLabelProvider<M>

提供一个只读字符串,该字符串调用值的 value.toString()

ToStringValueProvider<M>

提供一个只读字符串,该字符串调用值的 value.toString()

ValueProvider<M, V>

提供对属性 bean 值的访问器。<V> 泛型表示 bean 值类型。

  • com.sencha.gxt.core.client.ValueProvider Javadoc
  • 例子

      ValueProvider<Stock, String> name();
      ValueProvider<Stock, Double> change();
      ValueProvider<Stock, Date> lastTrans();
      ValueProvider<Stock, Boolean> split();
      ValueProvider<Stock, String> industry();
    

GXT 4.x