文档帮助

目录

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 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
受保护

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

  • 展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称（在本例中为 lookupComponent）
  • 方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法的参数）将列在方法名称旁边的括号内（在本例中为 ( item )）
  • 返回类型 - 方法或属性返回的类实例或 javascript 对象（在本例中为 Ext.Component）。对于不返回除 undefined 之外任何内容的方法，可以省略此项，或者可以显示为用正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，方法可能返回 Component，如果失败，则返回 false，这将显示为 Ext.Component/Boolean）。
  • 标志 - 适用于成员的任何标志都将显示在旁边（在本例中为 PROTECTED - 请参阅下面的标志部分）
  • 成员来源 - 在成员行的右侧是最初描述成员的类（在本例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接，如果是从祖先类或混合类继承的，则显示为灰色。
  • 成员源代码 - 在成员来源类右侧下方是查看成员源代码的链接（示例中为 查看源代码）
  • 参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出（示例中为 item : Object）。
  • 返回值 - 如果类返回除 undefined 之外的值，“返回值”部分将注明返回的类或对象类型以及描述（示例中为 Ext.Component）
  • 自...起（示例中未显示） - 某些成员将显示该成员首次引入的产品版本（例如 自 3.4.0 起可用 - 示例中未显示），就在成员描述之后
  • 默认值（示例中未显示） - 配置通常显示要应用于类实例的默认配置值（如果未被覆盖）（例如 默认为：false）

成员标志

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

  • Required（必需） - 实例化类时必需的配置
  • Bindable（可绑定） - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
  • 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 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中，就在它们所对应的配置下方。Getter 和 Setter 方法文档将在配置行中找到，以便于参考。

历史记录栏

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

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

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

搜索和过滤器

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

GXT 4.x


顶部

目录

参考 构建主题 Sencha 专业服务 概述 编辑 命名 注释 属性值 渐变 配置函数

主题构建器语法

主题配置语法参考。

参考

构建主题

Sencha 专业服务

Sencha 专业服务可以为您构建主题。在此处咨询 专业服务 选项。

概述

主题配置文件结构是一组命名空间的键/值对。值被命名空间以便更轻松地分组，可以使用点表示法，或在 {} 中对数据进行分组。文件的根命名空间是 theme。

为了知道如何调用主题以及在哪里构建主题，必须指定 theme.name 和 theme.basePackage。对于包“com.example”中名为“red”的主题，此文件可能开始看起来像这样

theme {
  name = "red"
  basePackage = "com.example"
}

也可以这样写

theme.name = "red"
theme.basePackage = "com.example"

主题的特定详细信息预计将在 theme.details 中找到，基于它们用于哪个小部件以及它们设置的属性。随着内容嵌套得越来越深，{} 表示法变得越来越有用，以保持文件的可读性。

编辑

使用任何基本文本编辑器编辑主题配置文件。

命名

某些属性是必需的，例如 theme.name 和 theme.basePackage，以及实际生成主题所需的属性。如果它们缺失，则在尝试生成主题时会收到错误消息。您还可以创建自己的属性，让它们成为您选择的任何类型。这些不会对编译外观产生任何影响，但有助于您在一个文件中定义常量，并在其他地方引用它们。

注释

可以以 Java 和 Javascript 接受的任何一种方式向文件中添加注释，可以使用 // 注释掉行的其余部分，也可以使用 /* 和 */ 注释掉两者之间的所有内容。

属性值

每个属性都可以设置为常量值、表达式或对另一个属性的引用。这使您可以在一个地方编写一些起始属性，然后在整个文件中引用它们，对它们进行基本数学运算，或根据需要重复使用它们。属性可以是多种类型：字符串、整数、双精度浮点数和对象。对象实际上只是另一层嵌套的命名空间，但当您从其他属性引用它们时，它们可以充当对象。

例如，您可以在主题的早期定义默认的测试详细信息集，并在以后使用它们

theme {
  name = "red"
  basePackage = "com.example"

  // standard font settings, to be used throughout this file
  defaultFont {
    color = "#ffffff"
    family = "Tahoma, Arial, Verdana, sans-serif"
    size = "14px"
    weight = "bold"
  }

  details {
    info {
      messageText = defaultFont
      //note that this could also be written as
      //messageText = theme.defaultFont
    }
  }
}

渐变

渐变语法

配置函数

配置函数语法

GXT 4.x