文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员是 public。Public、protected 和 private 是访问描述符，用于说明类或类成员应该如何以及何时使用。

公共类和类成员可供任何其他类或应用程序代码使用，并且可以在主要产品版本中被认为是稳定和持久的。公共类和成员可以通过子类安全地扩展。
受保护的类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
私有类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能随时更改或从框架中省略，恕不另行通知，不应在应用程序逻辑中依赖。

成员类型

Config - 类的配置选项。
Property - 类实例化后设置。*请参阅下面的只读部分。
Method - 类可以执行的操作。方法应被视为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static 标签。*请参阅下面的静态部分。
Event - 事件特定于框架事件系统，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中具体描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架使用的视觉主题引擎使用的变量。
Theme Mixin - 框架使用的视觉主题引擎使用的函数，并且可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

受保护的

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

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

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

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（在本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法的参数）将列在方法名称旁边的括号内（在本例中为 ( item )）
返回值类型 - 方法或属性返回的类实例或 javascript 对象（在本例中为 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 - 示例中未显示），紧接在成员描述之后
默认值（示例中未显示） - Configs 通常显示要应用于类实例的默认配置值（如果未被覆盖）（例如 Defaults to: false）

成员标志

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

必需 - 实例化类时必需的配置
可绑定 - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
只读 - 该属性可以读取，但不能用于在运行时配置/重新配置类实例
单例 - 单例类在定义后立即实例化，不能手动实例化
静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
可链式调用 - 指的是在调用时返回类实例的方法。
这允许链式方法调用，例如：classInstance.method1().method2().etc();
已弃用 - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将有一条消息，指导您将来使用的首选类/方法。
已移除 - 已移除的类或成员，仅在文档中作为用户在框架版本之间升级的参考存在
模板 - 在基类中定义的方法，旨在被子类重写
抽象 - 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的（如果有的话）代码。特定于类的代码将通过子类中的重写来提供。
可阻止 - 如果从事件处理程序返回 false，则标记为可阻止的事件将不会触发

类图标

- 表示框架类

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

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

备用名称 - 一个或多个附加的类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类具有 Ext.Button 的备用类名）。备用类名通常为了向后兼容性而维护。
层次结构 - 层次结构视图列出了当前类通过其祖先类一直到根基类的继承链。
Mixins - 混合到当前类中的类列表
继承的 Mixins - 混合到当前类的祖先类中的类列表
Requires - 实例化类所需定义的所有类
Uses - 类在其生命周期中的某个时刻可能使用的类列表，但并非类最初实例化时必须需要的
子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

全局导航将位于左侧菜单中，可通过汉堡菜单图标访问。菜单包含以下内容（在大多数页面上）
- 当前产品的名称（作为指向产品着陆页面的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- (API 文档) 带有成员过滤器、“展开/折叠所有示例”按钮、“展开/折叠所有成员行”按钮、访问级别过滤器复选框和每个成员计数的“过滤器”选项卡
- (API 文档) 包含与当前类相关的元数据菜单的“相关类”选项卡
- (指南) 指南的目录

查看类源代码

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

GXT 4.x

显示私有类

顶部

参考查找小部件元素查找小部件元素转换小部件元素在 DOM 中查找元素按 id 查找元素按类查找元素按类查找元素按标签查找元素按标签查找元素按名称查找元素按上述组合查找元素迭代元素列表访问第一个子元素查明元素是否具有子元素操作 DOM 创建元素创建元素并设置其内容将元素添加到父元素从其父元素中删除元素正则表达式正则表达式正则表达式迭代异常抛出异常捕获异常捕获未捕获的异常 DOM 事件处理附加事件处理程序删除事件处理程序监听所有事件计时安排未来事件在下一个事件循环中安排在事件循环结束时安排测量函数的执行时间 HTML 属性获取 HTML 属性设置 HTML 属性删除 HTML 属性检查 HTML 属性是否存在 CSS 类添加 CSS 类删除 CSS 类 Ajax 通过 XMLHttpRequest 请求数据对文档完成加载做出反应节点查找节点创建事件处理相对节点子节点克隆

Dom 操作

使用 HTML 文档对象模型。在 DOM 中查找和使用元素。

参考

gxt:com.sencha.gxt.core.client.dom.DomQuery Javadoc
gxt:com.sencha.gxt.core.client.dom.XElement Javadoc
gwt:com.google.gwt.dom.client.Element Javadoc

查找小部件元素

使用 GWT

  Element element = gwtWidget.getElement();

使用 GXT

  XElement element = gxtWidget.getElement();

  Element element = gxtWidget.getElement();

转换小部件元素

转换

使用 GWT

  Element element = gwtWidget.getElement().cast();

使用 GXT

  XElement element = gxtWidget.getElement().cast();

  // Other options
  Element element = gwtWidget.getElement();
  // as factory
  XElement xelement1 = XElement.as(element);
  // casting
  XElement xelement2 = element.cast();

在 DOM 中查找元素

按 id 查找元素

使用 GWT
```
  DOM.getElementById("main");
```

使用 GXT

  DomQuery.select("#main").getItem(0);

  gxtWidget.getElement().select("#main").getItem(0);

按类查找元素

使用 GXT

  DomQuery.select(".visible").getItem(0);

  gxtWidget.getElement().select(".visible").getItem(0);

按类查找元素

使用 GXT

  DomQuery.select(".visible");

  gxtWidget.getElement().select(".visible");

按标签查找元素

使用 GWT

  Document.get().getElementsByTagName("div").getItem(0);

使用 GXT

  DomQuery.select("div").getItem(0);

  gxtWidget.getElement().select("div").getItem(0);

按标签查找元素

使用 GWT

  Document.get().getElementsByTagName("div").getItem(0);

使用 GXT

  DomQuery.select("div");

  gxtWidget.getElement().select("div");

按名称查找元素

使用 GXT

  DomQuery.select("[name='form']");

  gxtWidget.getElement().select("[name='form']");

按上述组合查找元素

将 GWT 与 GXT 结合使用

  DomQuery.select("#main div:first .visible");

  gxtWidget.getElement().select("#main div:first .visible");

迭代元素列表

使用 GXT

  NodeList<Element> elements = DomQuery.select(".visible");
  for (int i=0; i < elements.getLength(); i++) {
    Element element = elements.getItem(i);
  }

  NodeList<Element> elements = gxtWidget.getElement().select(".visible");
  for (int i=0; i < elements.getLength(); i++) {
    Element element = elements.getItem(i);
  }

访问第一个子元素

将 GWT 与 GXT 结合使用
```
  elements.getItem(0);
```

查明元素是否具有子元素

将 GWT 与 GXT 结合使用
```
  elements.getLength() == 0
```

操作 DOM

创建元素

使用 GWT

  DivElement element = Document.get().createDivElement();

创建元素并设置其内容

使用 GWT

  DivElement element = Document.get().createDivElement();
  element.setInnerHTML("<p>A quick brown <em>fox</em>.</p>");

将元素添加到父元素

使用 GWT

  Document.get().getBody().appendChild(element);

从其父元素中删除元素

使用 GWT

  DivElement element = Document.get().createDivElement();
  Document.get().getBody().appendChild(element);
  element.removeFromParent();

正则表达式

gwt:com.google.gwt.regexp.shared.RegExp Javadoc

正则表达式

使用 GWT

  String email = "no-reply@[email protected]";
  Pattern pattern = Pattern.compile("(@)");
  Matcher matcher = pattern.matcher(email);

正则表达式迭代

使用 GWT

  String email = "no-reply@[email protected]";
  RegExp regExp = RegExp.compile("(@)");
  MatchResult matcher = regExp.exec(email);

异常

抛出异常

使用 Java 和 GWT

  throw new Exception("Intruder Alert!!");

捕获异常

使用 Java 和 GWT

  try {
    Integer.parseInt("three");
  } catch (NumberFormatException e) {
    e.printStackTrace();
  }

捕获未捕获的异常

使用 GWT

  GWT.setUncaughtExceptionHandler(new UncaughtExceptionHandler() {
    @Override
    public void onUncaughtException(Throwable e) {
      e.printStackTrace();
    }
  });

DOM 事件处理

附加事件处理程序

建议使用小部件框架以避免内存泄漏。

使用 GWT

  // Use the widget framework, this can cause memory leaks
  Element element = DOM.getElementById("main");
  Event.sinkEvents(element, Event.ONCLICK);
  DOM.setEventListener(element, new EventListener() {          
    @Override
    public void onBrowserEvent(Event event) {
          if (Event.ONCLICK == event.getTypeInt()) {
            System.out.println("clicked");
          }
    }
  });

删除事件处理程序

建议使用小部件框架以避免内存泄漏。

使用 GWT

  DOM.setEventListener(getElement(), null);

监听所有事件

使用 Native Prevew Hander 监听所有 DOM 事件。

使用 GWT

  Event.addNativePreviewHandler(new NativePreviewHandler() {
    public void onPreviewNativeEvent(final NativePreviewEvent event) {
      final int eventType = event.getTypeInt();
      switch (eventType) {
        case Event.ONMOUSEMOVE:
          break;
        case Event.ONCLICK:
          break;
        default:
          break;
      }
    }
  });

计时

安排未来事件

考虑使用 Scheduler.get() 来安排未来执行。

使用 GWT

  Timer timer = new Timer() {
    @Override
    public void run() {
          System.out.print("the future is here");
    }
  };
  timer.schedule(1000);

在下一个事件循环中安排

com.google.gwt.core.client.Scheduler Javadoc - 查看更多调度器选项

使用 GWT

  // This will schedule before scheduleFinally commands.
  Scheduler.get().scheduleDeferred(new ScheduledCommand() {
    @Override
    public void execute() {
          System.out.println("I'm next");
    }
  });

在事件循环结束时安排

gwt:com.google.gwt.core.client.Scheduler Javadoc - 查看更多调度器选项

使用 GWT

  // This will schedule after other scheduled deferred commands.
  Scheduler.get().scheduleFinally(new ScheduledCommand() {
    @Override
    public void execute() {
          System.out.print("the future is here");
    }
  });

测量函数的执行时间

使用 GWT

  long watch = System.currentTimeMillis();
  method();
  long elapsed = System.currentTimeMillis() - watch;
  System.out.println(elapsed);

HTML 属性

获取 HTML 属性

使用 GWT
```
  element.getAttribute("href");
```

设置 HTML 属性

使用 GWT

  element.setAttribute("playable", "true");

删除 HTML 属性

使用 GWT
```
  element.removeAttribute("playable");
```

检查 HTML 属性是否存在

使用 GWT
```
  element.hasAttribute("playable");
```

CSS 类

添加 CSS 类

使用 GWT

  element.setClassName("new-class");

删除 CSS 类

使用 GWT

  element.removeClassName("new-class");

Ajax

通过 XMLHttpRequest 请求数据

使用 GWT

  RequestBuilder request = new RequestBuilder(RequestBuilder.GET, "/data.json");
  request.setCallback(new RequestCallback() {
    @Override
    public void onResponseReceived(Request request, Response response) {
          System.out.println(response.getText());
    }

    @Override
    public void onError(Request request, Throwable exception) {
          exception.printStackTrace();
    }
  });

类似 JQuery

对文档完成加载做出反应

使用 GWT

  public class ProjectEntryPoint implements EntryPoint {
    @Override
    public void onModuleLoad() {
          System.out.println("loaded");
    }
  }

节点查找

com.sencha.gxt.core.client.dom.DomQuery Javadoc - 查看更多选项

使用 GXT

  NodeList<Element> elements = DomQuery.select("input");

  NodeList<Element> elements = gxtWidget.getElement().select("input");

节点创建

使用 GWT

  ImageElement pic = Document.get().createImageElement();
  pic.addClassName("avatar");
  pic.setSrc("myPic.jpg");
  Document.get().getBody().appendChild(pic);

事件处理

建议使用小部件框架以避免内存泄漏。

使用 GWT

  // Use the widget framework, this can cause memory leaks
  Element element = DOM.getElementById("main");
  Event.sinkEvents(element, Event.ONCLICK);
  DOM.setEventListener(element, new EventListener() {          
    @Override
    public void onBrowserEvent(Event event) {
          if (Event.ONCLICK == event.getTypeInt()) {
            System.out.println("clicked");
          }
    }
  });

相对节点

使用 GWT

  Element element = DOM.getElementById("main");
  Node parent = element.getParentNode();
  Node child = parent.getChild(0);
  // Or getting the parent Element
      Element parentElement = element.getParentElement();
      // Or getting the first child element
      Element childElement = parentElement.getFirstChildElement();

子节点

使用 GWT

  Element element = DOM.getElementById("main");
  NodeList<Node> children = element.getChildNodes();

克隆

使用 GWT

  Element element = DOM.getElementById("main");
  Node clonedElement = element.cloneNode(true);

目录

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例和类成员

桌面 -vs- 移动视图

查看类源代码

GXT 4.x

目录

Dom 操作

参考

查找小部件元素

查找小部件元素

转换小部件元素

在 DOM 中查找元素

按 id 查找元素

按类查找元素

按类查找元素

按标签查找元素

按标签查找元素

按名称查找元素

按上述组合查找元素

迭代元素列表

访问第一个子元素

查明元素是否具有子元素

操作 DOM

创建元素

创建元素并设置其内容

将元素添加到父元素

从其父元素中删除元素

正则表达式

正则表达式

正则表达式迭代

异常

抛出异常

捕获异常

捕获未捕获的异常

DOM 事件处理

附加事件处理程序

删除事件处理程序

监听所有事件

计时

安排未来事件

在下一个事件循环中安排

在事件循环结束时安排

测量函数的执行时间

HTML 属性

获取 HTML 属性

设置 HTML 属性

删除 HTML 属性

检查 HTML 属性是否存在

CSS 类

添加 CSS 类

删除 CSS 类

Ajax

通过 XMLHttpRequest 请求数据

类似 JQuery

对文档完成加载做出反应

节点查找

节点创建

事件处理

相对节点

子节点

克隆

GXT 4.x