文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有的)或 protected(受保护的)。否则,类/成员是 public(公共的)。Publicprotectedprivate 是访问描述符,用于传达应该如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面视图与移动视图

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

查看类源代码

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

GXT 4.x


顶部

GWT Driver 入门指南

Selenium WebDriver 的 GWT 绑定。

参考

GWT 中的浏览器测试

GwtDriver 为 WebDriver 测试带来了 GWT 支持。我们通过公开运行应用程序中的一些类型详细信息,并让测试询问 Widget 的结构,而不是强迫它们仅依赖于 DOM 结构、CSS 类或元素 ID 来实现这一点。这样,您可以分别编写应用程序和测试,而两者都不会依赖于另一方的结构和期望。

当您测试应用程序中的屏幕时,通常不会查看 DOM 结构并使用正确的 ID 或 XPATH 定位元素,然后再单击它,而是依赖于文本内容或其他附近的(通常是父级或同级)Widget。gwt-driver 项目尝试鼓励基于结构和地标的 WebDriver 测试。这样做的好处是编写的测试更易于维护,并且随着应用程序的不断增长,更易于重构和重用。

概念

基本思想是引用描述应用程序中 Widget 的模型,而不是 dom 元素本身。仍然可以(并且通常有必要)引用这些元素,但在大多数情况下,这仅对于不适合构建到模型本身中的特定一次性功能是必需的。

模型都从 org.senchalabs.gwt.gwtdriver.models.GwtWidget 扩展而来。它们从那里有几个路径

  • 使用 org.senchalabs.gwt.gwtdriver.models.GwtWidget.ForWidget 进行装饰,指示它们应该表示的 gwt Widget 类型。对各种断言很有用。
  • 在其泛型中指定 GwtWidgetFinder,描述在此 Widget 中可以找到父级的常见方式。有关此内容的更多信息,请参见下面的查找器。

定位 Widget

模块配置

GWT 项目将需要一个在编译期间使用的附加库才能使用 GWT Driver。这可以在主模块配置中使用,也可以创建仅在测试期间使用的测试模块。

<inherits name="org.senchalabs.gwt.gwtdriver.GwtDriver"/>

查找器

Window loginDialog = GwtWidget.find(Window.class, driver)
    .withHeading("log in").done();

loginDialog.find(Button.class).withText("Register").done().click();

使用 findElement 和 GwtWidget.java

// Find the HorizontalLayoutContainer elements
WebElement hlcElement = driver.findElement(
    new FasterByChained(By.xpath(".//div/*"), new ByWidget(driver,
        com.sencha.gxt.widget.core.client.container.HorizontalLayoutContainer.class)));

// Find the VerticalLayoutContainer elements in HorizontalLayoutContainer
List<WebElement> vlcElements = hlcElement.findElements(
    new FasterByChained(By.xpath("//div"), new ByWidget(driver,
        com.sencha.gxt.widget.core.client.container.VerticalLayoutContainer.class)));

// Find the left widgets in the VerticalLayoutContainer element
WidgetContainer leftWidgets = new WidgetContainer(driver, vlcElements.get(0));
List<GwtWidget<?>> leftButtons = leftWidgets.findWidgets(By.xpath(".//div"));

// Find the button widget
Button lb = leftButtons.get(0).as(Button.class);

与 Widget 交互

由于每个 GwtWidget 模型都具有对其所基于的 WebElement 的内部引用,因此与 Widget 交互通常与与该元素交互一样简单。通常,每个 GwtWidget 都应提供一些基本的交互方法,但不可避免地需要提供额外的功能 - 您可以调用 getElement() 来获取 Widget 中的根元素。

构建您自己的模型

如果您开发了自己的 Widget,则需要根据您期望 Widget 使用的结构以及您期望如何搜索它们来构建自己的 Widget 模型和查找器。gxt-driver 项目包含许多模型和查找器,可以作为如何查找和与运行应用程序中的 Widget 交互的基本示例。

GXT 4.x