文档帮助

内容

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

术语、图标和标签

许多类在使用配置对象创建（实例化）类时使用简写名称。简写名称称为别名（如果类扩展了 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 插入}。

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

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

参数

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Ext JS 7.8.0


顶部

内容

概述 命名约定 类 源文件 方法和变量 示例 属性 声明 配置 静态 错误处理和调试

类系统

概述

Ext JS 附带数百个类。迄今为止，我们拥有超过 200 万名开发人员，他们来自不同的背景和地区。在这个规模下，我们在提供一个通用的代码架构方面面临着巨大挑战，该架构

  • 熟悉且易于学习
  • 快速开发、易于调试且部署无忧
  • 组织良好、可扩展且易于维护

由于 JavaScript 是一种无类、基于原型的 语言，其最强大的功能之一是灵活性。可以使用许多不同的编码风格和技术来解决任何问题。但是，这会导致不可预测性。如果没有统一的结构，JavaScript 代码可能难以理解、维护和重用。

基于类的编程 另一方面，仍然是面向对象编程最流行的模型。 基于类的语言 通常需要强类型、封装和标准编码约定。通过让开发人员遵守大量原则，代码更有可能随着时间的推移而变得可预测、可扩展和可扩展。但是，此模型不具备 JavaScript 的动态功能。

每种方法都有其优缺点，但我们能否保留两者的优点，同时隐藏其缺点？答案是肯定的，您可以在 Ext JS 中找到解决方案。

命名约定

在整个代码库中对类、命名空间和文件名使用一致的命名约定有助于使代码井井有条、结构化且可读。

类

类名只能包含**字母数字**字符。数字是允许的，但建议不要使用，除非它们属于技术术语。不要使用下划线、连字符或任何其他非字母数字字符。例如

  • MyCompany.useful_util.Debug_Toolbar 不建议使用
  • MyCompany.util.Base64 是最好的

类名应在适当的情况下分组到包中，并使用对象属性点表示法 (.) 正确地命名空间。至少应该有一个唯一的顶级命名空间，后跟类名。例如

MyCompany.data.CoolProxy
MyCompany.Application

顶级命名空间和实际类名应使用驼峰命名法。其他所有内容都应使用小写字母。例如

MyCompany.form.action.AutoLoad

不属于 Sencha 分发的类绝不应使用 Ext 作为顶级命名空间。

缩略词也应遵循上面列出的驼峰命名法约定。例如

  • Ext.data.JsonProxy 而不是 Ext.data.JSONProxy
  • MyCompany.util.HtmlParser 而不是 MyCompary.parser.HTMLParser
  • MyCompany.server.Http 而不是 MyCompany.server.HTTP

源文件

类的名称直接映射到存储它们的文件夹路径。因此，每个文件只能有一个类。例如

  • Ext.util.Observable 存储在 path/to/src/Ext/util/Observable.js 中
  • Ext.form.action.Submit 存储在 path/to/src/Ext/form/action/Submit.js 中
  • MyCompany.chart.axis.Numeric 存储在 path/to/src/MyCompany/chart/axis/Numeric.js 中

path/to/src 是应用程序类的目录。所有类都应保留在此公共根目录下，并应正确命名空间，以获得最佳的开发、维护和部署体验。

方法和变量

  • 与类名类似，方法和变量名只能包含**字母数字**字符。数字是允许的，但不鼓励使用，除非它们属于技术术语。不要使用下划线、连字符或任何其他非字母数字字符。
  • 方法和变量名应始终使用驼峰命名法。这也适用于缩略词。

示例

  • 可接受的方法名

    • encodeUsingMd5()
    • getHtml() 而不是 getHTML()
    • getJsonResponse() 而不是 getJSONResponse()
    • parseXmlContent() 而不是 parseXMLContent()

  • 可接受的变量名

    • var isGoodName
    • var base64Encoder
    • var xmlReader
    • var httpServer

属性

  • 类属性名遵循完全相同的约定，除非它们是静态常量。

  • 作为常量的静态类属性应全部大写。例如

    • Ext.MessageBox.YES = "Yes"
    • Ext.MessageBox.NO = "No"
    • MyCompany.alien.Math.PI = "4.13"

声明

您可以使用一种方法来创建类：Ext.define。其基本语法如下

Ext.define(className, members, onClassCreated);
  • className：类名
  • members 是一个对象，它以键值对的形式表示类成员的集合
  • onClassCreated 是一个可选的函数回调，当定义类的所有依赖项都准备就绪且类本身完全创建时，它将被调用。由于类创建的异步性质，此回调在许多情况下很有用。这些将在第四部分中进一步讨论

示例

Ext.define('My.sample.Person', {
    name: 'Unknown',

    constructor: function(name) {
        if (name) {
            this.name = name;
        }
    },

    eat: function(foodType) {
        alert(this.name + " is eating: " + foodType);
    }
});

var bob = Ext.create('My.sample.Person', 'Bob');

bob.eat("Salad"); // alert("Bob is eating: Salad");

注意：我们使用 Ext.create() 方法创建了 My.sample.Person 的新实例。我们本可以使用 new 关键字 (new My.sample.Person())。但是，建议养成始终使用 Ext.create 的习惯，因为它允许您利用动态加载的优势。有关动态加载的更多信息，请参阅入门指南

配置

还有一个专门的 config 属性，它在类创建之前由强大的 Ext.Class 预处理器处理。功能包括

  • 配置完全封装在其他类成员之外
  • 如果方法尚未定义，则在类创建期间会自动将每个配置属性的 getter 和 setter 方法生成到类原型中。
  • 自动生成的 setter 方法在设置值之前会在内部调用 apply 方法（如果在类上定义）。如果您需要在设置值之前运行自定义逻辑，可以覆盖配置属性的 apply 方法。如果您的 apply 方法没有返回值，则 setter 不会设置值。当设置不同的值时，也会调用 update 方法（如果定义）。apply 和 update 方法都将新值和旧值作为参数传递。

对于使用 configs 的 Ext 类，您不需要手动调用 initConfig()。但是，对于扩展 Ext.Base 的自己的类，仍然需要调用 initConfig()。

您可以在下面看到配置示例。

Ext.define('My.own.Window', {
   extend: 'Ext.Component',
   /** @readonly */
   isWindow: true,

   config: {
       title: 'Title Here',

       bottomBar: {
           height: 50,
           resizable: false
       }
   },

   applyTitle: function(title) {
       if (!Ext.isString(title) || title.length === 0) {
           alert('Error: Title must be a valid non-empty string');
       }
       else {
           return title;
       }
   },

   applyBottomBar: function(bottomBar) {
       if (bottomBar) {
           if (!this.bottomBar) {
               return Ext.create('My.own.WindowBottomBar', bottomBar);
           }
           else {
               this.bottomBar.setConfig(bottomBar);
           }
       }
   }
});

/** A child component to complete the example. */
Ext.define('My.own.WindowBottomBar', {
   config: {
       height: undefined,
       resizable: true
   }
});

以下是一个使用示例

var myWindow = Ext.create('My.own.Window', {
    title: 'Hello World',
    bottomBar: {
        height: 60
    }
});

alert(myWindow.getTitle()); // alerts "Hello World"

myWindow.setTitle('Something New');

alert(myWindow.getTitle()); // alerts "Something New"

myWindow.setTitle(null); // alerts "Error: Title must be a valid non-empty string"

myWindow.setBottomBar({ height: 100 });

alert(myWindow.getBottomBar().getHeight()); // alerts 100

静态成员

可以使用 statics 配置定义静态成员

Ext.define('Computer', {
    statics: {
        instanceCount: 0,
        factory: function(brand) {
            // 'this' in static methods refer to the class itself
            return new this({brand: brand});
        }
    },

    config: {
        brand: null
    }
});

var dellComputer = Computer.factory('Dell');
var appleComputer = Computer.factory('Mac');

alert(appleComputer.getBrand()); // using the auto-generated getter to get the value of a config property. Alerts "Mac"

错误处理和调试

Ext JS 包含一些有用的功能，可以帮助您进行调试和错误处理。

  • 您可以使用 Ext.getDisplayName() 获取任何方法的显示名称。这对于抛出包含类名和方法名的错误描述特别有用

      throw new Error('['+ Ext.getDisplayName(arguments.callee) +'] Some message here');

  • 当使用 Ext.define() 定义的任何类的任何方法中抛出错误时，如果您使用的是基于 WebKit 的浏览器（Chrome 或 Safari），您应该在调用堆栈中看到方法和类名。例如，以下是它在 Chrome 中的样子

Ext JS 7.8.0