文档帮助

目录

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 Getter 和 Setter 方法 历史记录栏 搜索和过滤器 API 文档类元数据 展开和折叠示例及类成员 桌面 -vs- 移动视图 查看类源代码

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。

GXT 4.x


顶部

目录

参考 构建自定义验证器 验证器本地化 自定义验证器示例 使用自定义验证器

自定义字段验证

验证字段是否具有预期的数据。

参考

构建自定义验证器

在此自定义验证器示例中，错误通知已国际化，并且验证仅检查“@”字符。

  • 请注意，GXT 内置验证器已国际化。

验证器本地化

首先，创建本地化消息。有关更多信息，请参见 GWT 消息国际化

  • emailValidationError 本地化属性插入到下面列出的 AppMessages 文件中

      emailValidationError = Is {0} an email?

  • 包含 emailValidationError 属性的本地化属性文件示例

      AppMessages_ca.properties
  AppMessages_cs.properties
  AppMessages_da.properties
  AppMessages_de.properties
  AppMessages_el_GR.properties
  AppMessages_es.properties
  AppMessages_fr.properties
  AppMessages_hu.properties
  AppMessages_it.properties
  AppMessages_no.properties
  AppMessages_pl.properties
  AppMessages_pt_BR.properties
  AppMessages_pt_PT.properties
  AppMessages_pt.properties
  AppMessages_ru.properties
  AppMessages_sl.properties
  AppMessages_ua.properties
  AppMessages_zh.properties
  AppMessages.properties

  • Messages 接口示例公开了可用的本地化属性

      import com.google.gwt.i18n.client.Messages;

  public interface AppMessages extends Messages {
    String emailValidationError(String email);
  }

自定义验证器示例

这是一个创建简单自定义电子邮件验证器的示例，该验证器验证给定值是否包含“@”字符。验证器扩展了 AbstractValidator<String> 并实现了上述本地化以用于给定的错误通知。

  • CustomSimpleEmailValidator 示例

      import java.util.List;
  import com.google.gwt.core.client.GWT;
  import com.google.gwt.editor.client.Editor;
  import com.google.gwt.editor.client.EditorError;
  import com.sencha.gxt.project.client.validation.messages.AppMessages;
  import com.sencha.gxt.widget.core.client.form.validator.AbstractValidator;

  public class CustomSimpleEmailValidator extends AbstractValidator<String> {
    private static AppMessages messages = GWT.create(AppMessages.class);

    /**
     * This is the heart of the value validator where it tests the value according
     * to the rules set forth.
     */
    @Override
    public List<EditorError> validate(Editor<String> field, String value) {
      List<EditorError> errors = null;
      if (value != null && (!value.contains("@"))) {
        String message = messages.emailValidationError(value);
        errors = createError(field, message, value);
      }
      return errors;
    }
  }

使用自定义验证器

在此示例中，验证器是一个简单的电子邮件验证器，仅验证字符串是否包含“@”字符。

  • CustomSimpleEmailValidator 验证器示例

      private void createTextField() {
    TextField textField = new TextField();
    textField.addValidator(new EmptyValidator<String>());
    // Custom Validator
    textField.addValidator(new CustomSimpleEmailValidator());

    FieldLabel fieldLabel = new FieldLabel(textField, "Email");
    widget.add(fieldLabel);
  }

GXT 4.x