文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

当原始配置对象添加到此容器时调用,无论是在 items 配置的初始化期间,还是在 添加) 或 {@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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

Cmd 7.8.0


顶部

Closure Compiler 配置

Sencha Cmd 7.8.0 配备了升级的 Closure Compiler,并增强了开发人员对通过 Closure API 提供的压缩选项的控制。

压缩级别

Google 的 closure compiler API 使开发人员可以精细控制通过编译器运行的源代码的压缩级别。使用 Sencha Cmd,您可以轻松更改压缩级别,以增强代码混淆并减小占用空间大小,以满足您的要求。

要开始使用,请更新您的 app.json 以将 closure compiler 指定为您的应用程序的压缩器。以下代码段将 closure compiler 设置为生产压缩器。

    /**
     * Settings specific to production builds.
     */
    "production": {
        "output": {
            "appCache": {
                "enable": true,
                "path": "cache.appcache"
            }
        },
        "loader": {
            "cache": "${build.timestamp}"
        },
        "cache": {
            "enable": true
        },
        "compressor": {
            "type": "closure"
        }
    },

Closure Compiler API 提供了三种不同的压缩级别:WHITESPACE_ONLYSIMPLE_OPTIMIZATIONADVANCED_OPTIMIZATION。使用 Cmd 7.0.0,您可以使用所有三个级别。如果您的 app.json 中未设置级别,则默认值为 SIMPLE_OPTIMIZATION。有关不同压缩级别的详细信息,请参阅 Closure API

要指定压缩级别,请更新上面示例代码段中的 "compressor" 对象以包含 "compression" 对象,将其值设置为以下字符串之一

  • "whitespace" 删除注释、换行符、不必要的空格等。
  • "simple" 默认级别等于 "whitespace" + 语法上有效的成员(函数、表达式、变量等)
  • "advanced" 最大优化,它使用 "simple" 压缩,并在此基础上添加基于假设的代码删除和缩减算法。

配置示例

    "compressor": {
        "type": "closure",
        "compression": "advanced" // ADD THIS LINE
    }

注意: “advanced” 压缩设置可能会导致生产代码无法运行。通过查阅 Closure API,了解高级压缩模式的工作原理。

Cmd 7.0.0 中添加了额外的日志记录,以便在将 closure compiler 设置为压缩器类型时,更好地了解编译过程、压缩级别、转译等。

使用压缩级别 whitespace 改进了 Cmd Compiler 使用 Google closure compiler 在 7.8.0 版本中的 ECMA 支持。但是,在 ES5 的更高版本中引入的某些方法在使用 closure 类型 whitespace 时会导致错误,例如 $jscom not defined。要解决这些问题,请在 app.json 中使用以下代码。

"compressor": {
    "type": "closure",
    "compression" : "whitespace",
    "polyfills" : "all"
}

警告级别

Closure API 声明了以下配置选项来控制警告报告的噪声级别

warning_level 指示您希望编译器提供关于代码中可能存在的问题的信息量。仅当同时提供值为 warnings 的 output_info 参数时,warning_level 参数才有效。有三个可能的警告级别

QUIET 仅输出语法错误消息和当前编译器运行的 compilation_level 中包含的优化过程生成的警告。

DEFAULT 除了优化过程生成的语法错误和警告外,还输出选定的代码检查过程生成的警告。

VERBOSE 除了优化过程生成的语法错误和警告外,还输出所有代码检查过程生成的警告。

warning_level 参数默认为 DEFAULT 值。

Sencha Cmd 为您的应用程序的 app.json 中的 compressor 对象提供了 "warningLevel" 配置。

 "compressor": {
    "type": "closure",
    "warningLevel": "quiet" // ADD THIS LINE
}

Cmd 7.8.0