文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

  • 展开/折叠 - 在成员行的左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称(本例中为 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 - 示例中未显示),紧随成员描述之后
  • 默认值示例中未显示)- Config 通常显示要应用于类实例的默认 config 值(如果未被覆盖)(即 Defaults to: false

成员标志

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

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

类图标

- 表示框架类

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

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南是当前查看版本中的新内容

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南是当前查看版本中的新内容

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类 config 选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 config 部分中,就在它们所使用的 config 下方。Getter 和 setter 方法文档将在 config 行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并显示在顶部标题栏下方(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来展开显示的内容。这将显示所有产品/版本的所有最近页面访问历史记录。

在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读来过滤类成员。这可以通过使用页面顶部的复选框来完成。

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

  • Alternate Name(别名)- 一个或多个附加的类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的别名)。别名通常为了向后兼容性而维护。
  • Hierarchy(层次结构)- 层次结构视图列出当前类通过其祖先类一直到根基类的继承链。
  • Mixins(混入)- 混入当前类的类列表
  • Inherited Mixins(继承的混入)- 混入当前类的祖先的类列表
  • Requires(需要的)- 类实例化所需定义的所有类
  • Uses(使用的)- 类在其生命周期的某个时刻可能使用的类列表,但不一定是类最初实例化所必需的
  • Subclasses(子类)- 扩展当前类的类

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源码

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

Cmd


顶部

App Build Process 内部

Sencha Cmd 提供的构建脚本是将 Sencha Cmd 的许多底层功能(例如编译器)捆绑在一起并实现自动化的组件。构建很少有万能的解决方案,因此构建脚本提供了许多选项来配置和自定义其行为。本指南将解释构建脚本背后的原理,以及您在需要定制构建过程以满足您的需求时应查看的位置。

先决条件

建议在继续阅读之前阅读以下指南

简介

在内部,sencha app build 命令执行基本验证并调用应用程序根目录 "build.xml" 中找到的 Apache Ant 构建脚本。具体来说,它调用此脚本的 "build" 目标。这意味着可以检查、扩展甚至修改整个构建过程。

由于 sencha app build 只是调用 Ant "build.xml" 文件的 "build" 目标,因此您可以等效地直接从 Ant 调用构建。这在 Eclipse 和 NetBeans 等 IDE 中调用构建以及在了解 Ant 的持续集成服务器(几乎所有服务器)中都很有用。

生成的 build.xml 是一个最小的 Ant 脚本,它使用 Ant import 任务导入 .sencha/app/build-impl.xml 以及其他几个文件。虽然 build.xml 旨在在生成后进行编辑,但 .sencha/app/*-impl.xml 文件不是。这些文件将被 sencha app upgrade 替换,不应编辑。这些文件非常适合参考,但不应修改,除非绝对必要。

构建目标

以下目标定义了从开始到结束的应用程序构建过程。除了 init 之外,每个目标都有一个属性可以设置为 1 以禁用该步骤。

  • init
  • refresh
  • resolve (默认为 1;设置 skip.resolve=0 以启用)
  • js
  • resources
  • sass
  • slice
  • page
  • native-package

除了 init 之外,这些目标中的每一个都可以通过使用以 "skip." 为前缀的目标名称的构建属性(见下文)从默认构建中删除。例如,要禁用 slice 目标

skip.slice=1

如果只需要该部分,也可以单独运行这些步骤。这通常对于仅重建 Sass 非常有用

sencha ant sass

注意: 如果您安装了 Ant 1.8 或更高版本,使用 sencha ant 相当于使用您自己的 Ant 版本。

配置

sencha app build 背后的构建脚本的大多数方面都由属性控制,这在 Ant 中很典型。在这种情况下,有两种属性:配置属性和构建属性。

配置属性

Sencha Cmd 配置属性可用于构建脚本,但也驱动 Sencha Cmd 的许多其他功能(如编译器)。要查看当前配置属性集,请运行以下命令

sencha diag show

在大多数情况下,您可以通过其前缀来判断每个属性的来源

  • app. -- 请参阅 "app.json"".sencha/app/sencha.cfg"
  • workspace. -- 请参阅 "workspace.json"".sencha/workspace/sencha.cfg"
  • framework. -- 请参阅 Ext JS 或 Sencha Touch SDK 中的 "cmd/sencha.cfg"
  • cmd. -- 请参阅 Sencha Cmd 安装文件夹中的 "sencha.cfg"

配置属性的使用比构建过程广泛得多,并在 高级 Sencha Cmd 中详细讨论。

构建属性

构建脚本定义了许多其他特定于构建的属性。这些构建属性通常以 "build." 为前缀。

要查看这些属性的当前值,您可以从您的应用程序文件夹运行以下命令

sencha ant .props

设置构建属性

有很多方法可以配置构建属性。最简单的方法是编辑构建属性文件之一。要决定编辑哪个文件,了解每个文件的优先级以及在什么条件下加载它们很有帮助。

  • "local.properties" -- 如果存在,则首先加载此文件。此文件旨在仅在本地应用(到本地计算机)。它不应提交到源代码控制以供他人使用。这些设置优先于其他属性文件中以及当前配置属性中定义的任何属性。
  • Sencha Cmd 配置属性
  • ".sencha/app/${build.environment}.properties" -- 根据 build.environment 属性的值,将加载以下文件中的一个。在这些文件中设置属性允许您根据正在运行的构建类型为属性设置不同的值。
    • ".sencha/app/native.properties"
    • ".sencha/app/package.properties"
    • ".sencha/app/production.properties"
    • ".sencha/app/testing.properties"
  • ".sencha/app/build.properties" -- 这些属性接下来加载,并且优先级低于特定于构建环境的属性。这些是所有(或大多数)环境使用的属性。此文件用于自定义。
  • ".sencha/app/defaults.properties" -- 这些属性是要加载的最后一个(默认)值。此文件由 Sencha Cmd “拥有”,并且每次发布新属性时都会更新。此文件用作已定义构建属性集的参考,但不应编辑;请编辑任何其他文件。

优先级高于 "local.properties" 的唯一属性是通过命令行传入的属性。

自定义

许多常见需求通过构建属性来解决,但不可能以这种方式解决所有用例。当配置选项无法完成任务时,下一个级别的自定义是扩展生成的 "build.xml" Ant 脚本。

除了 import 任务之外,"build.xml" 还包含一个注释块,描述了许多可用的扩展点。这些扩展点采用可选的 Ant 目标形式,并以其构建过程步骤命名,但带有 "-before-""-after-" 前缀。最常见的扩展点是以下这些

  • init
    • -before-init
    • -after-init
  • refresh
    • -before-refresh
    • -after-refresh
  • resolve
    • -before-resolve
    • -after-resolve
  • js
    • -before-js
    • -after-js
  • resources
    • -before-resources
    • -after-resources
  • sass
    • -before-sass
    • -after-sass
  • slice
    • -before-slice
    • -after-slice
  • page
    • -before-page
    • -after-page
  • native-package
    • -before-native-package
    • -after-native-package

要在任何构建步骤之前或之后执行其他处理,请将适当命名的目标添加到 "build.xml"。这些目标将由 sencha app build 调用。如果您使用 Ant 直接调用特定目标,也会调用这些目标。

这些扩展点的常见用途之一是对 "all-classes.js" 文件中的构建输出进行后处理。例如,使用一些预定义的 Ant 任务,我们可以在生成的文件生成后在其上放置版权标题

<target name="-after-page">
    <tstamp>
        <format property="THISYEAR" pattern="yyyy"/>
    </tstamp>

    <!--
    The build.classes.file property holds the full path to the "all-classes.js"
    file so we use that variable rather than hard-code the name.
    -->
    <move file="${build.classes.file}" tofile="${build.classes.file}.tmp"/>

    <concat destfile="${build.classes.file}">
        <header filtering="no" trimleading="yes">
/*
 * Copyright (C) ${THISYEAR}. All Rights Reserved.
 * My Company Name
 */
        </header>
        <fileset file="${build.classes.file}.tmp"/>
    </concat>

    <delete file="${build.classes.file}.tmp" />
</target>

后续步骤

Cmd