文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析以显示类成员的语法(在这种情况下,是从 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 文档页面顶部的类名来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。

Ext JS 7.8.0 - 经典工具包


顶部
指南适用于: classic

Ext JS 经典工具包主题

本指南是 Ext JS 主题 指南的延续,重点介绍 Ext JS 经典工具包的主题 API,因此请在继续之前阅读该指南。有关现代工具包的信息,请参阅 Ext JS 现代工具包主题 指南。

要求

本指南假设你已满足 Ext JS 主题 指南中描述的所有要求。回顾一下

设置

本指南假设您已拥有一个工作区、自定义 my-themedemo-app,如 Ext JS 主题指南中所述。

您应该可以使用以下命令watch演示应用程序(或运行 sencha app build --development 命令来编译您的样式)

$ sencha app watch --fashion

在运行 sencha app watch 之后,您可以使用该 URL 拉取您的应用程序

http://localhost:1841/demo-app/

--fashion 开关将指示浏览器在您对应用程序主题进行更改时刷新应用程序中的样式 - 通常在不到一秒内!提醒:此实时更新功能仅在现代浏览器上受支持(其他浏览器需要手动重新加载才能看到更改)。

主题组件

如前一个 指南 中所述,组件的主题 API 包含变量和混合。组件的默认外观由其变量决定,而自定义外观可以通过调用“UI 混合”来定义和命名。

配置主题变量

每个可设置主题的 Ext JS 组件都有一系列变量,可用于配置其外观。让我们在 my-theme 中更改面板标题的 font-family。创建一个名为 my-theme/sass/var/panel/Panel.scss 的文件,并添加以下代码

$panel-header-font-family: Times New Roman;

现在查看您的应用程序,您应该会看到面板标题使用“Times New Roman”字体。您可以在组件的 API 文档的“主题变量”部分中找到每个组件的完整变量列表。例如,请参见 Ext.panel.Panel 并滚动到标题为“主题变量”的部分

使用主题混合

Ext JS Classic Toolkit 中的所有组件都有一个 ui 配置属性,其默认为 "default"。此配置属性可以在各个组件实例上进行配置,以使它们与同类型的其他实例具有不同的外观。此配置在 Neptune 主题中用于创建不同类型的 面板按钮。例如,具有默认 ui 的面板具有深蓝色标题,而具有“light”ui 的面板具有浅蓝色标题。按钮使用 ui 使工具栏按钮与常规按钮具有不同的外观。

theme-neutral 主题包括许多不同的 Ext JS 组件的主题混合(或 UI 混合)。您可以调用这些混合来为组件生成新的 ui。每个组件的可用混合在 API 文档中列出。例如,请参见 Ext.panel.Panel 并向下滚动到“主题混合”部分,以查看面板 UI 混合接受哪些参数。让我们使用此混合来创建自定义面板 ui

创建一个名为 my-theme/sass/src/panel/Panel.scss 的文件,并向其中添加以下内容

@include extjs-panel-ui(
    $ui: 'highlight-framed',
    $ui-header-background-color: red,
    $ui-border-color: red,
    $ui-header-border-color: red,
    $ui-body-border-color: red,
    $ui-border-width: 5px,
    $ui-border-radius: 5px,
    $ui-header-color: white
);

此混合调用创建了一个名为 "highlight" 的新面板 ui,它具有红色标题背景、红色边框、5px 边框、5px 边框半径和白色文本。要使用此 ui,请使用 'highlight' 作为其 ui 属性(以及 frame: true)配置面板。打开 demo-app/app/view/main/List.js 并将其内容替换为以下内容

Ext.define('App.view.main.List', {
    extend: 'Ext.grid.Panel',
    xtype: 'mainlist',

    ui: 'highlight',
    frame: true,

    requires: [
        'App.store.Personnel'
    ],

    title: 'Personnel',

    store: {
        type: 'personnel'
    },

    columns: [
        { text: 'Name',  dataIndex: 'name' },
        { text: 'Email', dataIndex: 'email', flex: 1 },
        { text: 'Phone', dataIndex: 'phone', flex: 1 }
    ],

    listeners: {
        select: 'onItemSelected'
    }
});

在 Web 浏览器中查看您的应用程序,您应该会看到红色的“highlight”网格。

虽然 UI 混合是为组件配置多种外观的便捷方式,但它们不应被过度使用。每次调用 UI 混合都会生成额外的 CSS 规则。过度调用 UI 混合会产生过大的 CSS 文件。

在 IE 中为 CSS3 效果切片图像

在某些主题中,许多组件具有圆角和线性渐变背景。在现代浏览器中使用 CSS3 轻松实现这些效果。但是,Ext JS 支持 IE8 和 IE9,这两个浏览器都不支持这些效果(或以使组合效果变得有问题的某种方式支持)。

Sencha Cmd 通过在无头浏览器中渲染需要这些效果的每个组件并从 IE8/9 中组件标记中用作背景图像的圆角和渐变中切片图像来弥补这一差距。在添加自定义 ui 时,您需要将它们包含在 Sencha Cmd 使用的切片清单中,以便装饰有自定义 ui 的组件在 IE8/9 中使用时会被切片。

为此,我们需要告诉 Sencha Cmd 哪些组件和 ui 需要切片。为了为本指南前面创建的“highlight”面板 ui 的圆角创建切片,请编辑名为 my-theme/sass/example/custom.js 的文件并添加以下内容

Ext.theme.addManifest({
    xtype: 'panel',
    ui: 'highlight'
});

注意:可以在同一个 addManifest 调用中添加多个清单条目,例如

Ext.theme.addManifest({
    xtype: 'panel',
    ui: 'highlight'
}, {
    xtype: 'button',
    ui: 'green'
});

如果你创建了一个需要切片的原始组件,你需要将任何适用的 ui 配置添加到切片清单,如上所示。你还需要使用 custom.js 中的 Ext.theme.addShortcuts() 调用为自定义组件添加配置条目。

传递给清单的快捷方式配置以及 ui 将用于呈现用于切片的自定义组件。

有关如何使用 Ext.theme.addShortcutsExt.theme.addManifest 的更详细说明,请参阅 my-theme/sass/example/render.js 中找到的每个方法的内联文档说明。你可以在 ext/classic/theme-base/sass/example/shortcuts.js 文件中参阅框架组件的 addShortcuts 示例。

修改图像资源

作为修改图像资源的一个示例,我们来更改 MessageBox 组件的信息图标。将以下图像另存为 my-theme/resources/images/shared/icon-info.png。此图像资源将优先于 my-workspace/ext/classic/theme-crisp/resources/images/shared/icon-info.png 中父 Crisp 主题中使用的图像资源。

现在修改你的测试应用程序以显示使用自定义图标的 MessageBox。将以下 tbar 配置添加到应用程序的 demo-app/app/view/main/List.js 文件中的“突出显示”网格

...
tbar: [{
    text: 'Show Message',
    handler: function() {
        Ext.Msg.show({
            title: 'Info',
            msg: 'Message Box with custom icon',
            buttons: Ext.MessageBox.OK,
            icon: Ext.MessageBox.INFO
        });
    }
}]
...

现在,在浏览器中查看应用程序。当你单击“显示消息”按钮时,你应该会看到 MessageBox 中有一个笑脸。

为你的应用程序设置样式

应用程序之间不共享的样式属于应用程序本身,而不是主题。Sencha Cmd 提供了一种简单的方法来添加应用程序级样式,允许你将样式与 JavaScript 代码一起组织。

为应用程序的视图设置样式

要编写与应用程序视图关联的 CSS 规则,你需要在与视图位于同一文件夹中且具有相同基本名称的位置创建一个 .scss 文件。例如,要设置位于 demo-app/app/view/main/Main.js 中的视图 App.view.main.Main 的样式,你需要将该代码放入 demo-app/app/view/main/Main.scss 中。

让我们设置 App 应用程序中用户选项卡的内容样式

.content-panel-body h2 {
    color: orange;
}

content-panel-body CSS 类添加到应用程序的 Main.js 文件中用户面板的配置中

...
title: 'Users',
iconCls: 'fa-user',
html: '<h2>Content appropriate for the current navigation.</h2>',
bodyCls: 'content-panel-body'
...

查看你的应用程序,你会看到用户视图中的 h2 元素现在为橙色。虽然添加任意 CSS 样式的能力提供了最大的灵活性,但任何直接应用于 Ext JS 组件拥有的元素的样式都应尽可能使用 Ext JS 主题 API 设置样式。使用主题 API 可以保护你的样式免受未来版本 Ext JS 中标记更改的影响。

其他说明

“默认”组件图像

各种组件都有与组件的 "default" ui 相关的图像(按钮、菜单等)。当你为其中一个组件创建自定义 ui 时,你会注意到在编译主题时,它会警告你的主题中找不到图像。

WARNING: @theme-background-image: Theme image not found:

在刷新主题或应用程序时,Sencha Cmd 将使用 ui 名称代替图像名称中的 "default" 来查找图像。例如,如果你为小型按钮创建一个名称为 "admin" 的混合 ui,Sencha Cmd 会警告找不到 "admin-small-arrow.png"

解决此警告的方法是从你正在扩展的主题中将文件名中包含“default”的任何图像资源复制到自定义主题的 resources/images 目录中。然后,你将重命名这些文件,并将“default”替换为你的自定义 ui 的名称。对于自定义主题中扩展 Neptune 的 "admin" 按钮 ui,你将从 ext/classic/theme-neptune/resources/images/button 文件夹中复制 "default" 图像,并将它们粘贴到 packages/local/my-theme/resources/images/button/ 中。然后,你将把所有 "default" 实例重命名为 "admin"。例如

$ mv default-small-arrow.png admin-small-arrow.png

Ext.button.Button

在创建自定义 ui 时,需要将按钮 ui 图像从父主题复制到自定义主题。有关更多详细信息,请参阅上面的“'default' 组件图像”部分。

按钮比例可以配置为 smallmediumlarge,其中 small 为默认值。在为按钮创建自定义 UI 时,你需要为应用程序中使用的每个比例提供一个按钮混合。

注意:应避免使用 extjs-button-ui 混合,而应使用特定于比例的混合设置按钮样式。

@include extjs-button-small-ui(
    $ui: 'green',
    $background-color: green
);

@include extjs-button-medium-ui(
    $ui: 'green',
    $background-color: green
);

@include extjs-button-large-ui(
    $ui: 'green',
    $background-color: green
);

使用 -toollbar 按钮 mixin 时也适用。每个按钮都有一个比例,并且应该单独包含在 Button.scss 文件中,以支持所有按钮比例。此外,在使用 -toolbar 按钮 mixin 时,您需要将 -toolbar 添加到应用程序中按钮的 ui 配置中。下面是一个小工具栏按钮 mixin 的示例

@include extjs-button-toolbar-small-ui(
    $ui: 'green',
    $background-color: green
);

它将装饰一个在工具栏中配置的按钮,如下所示

xtype: 'toolbar',
items: [{
    text: 'Toolbar Button',
    ui: 'green-toolbar'
}]

Ext.panel.Panel

面板可以配置为 frame: true,并且默认情况下为 frame: false。因此,如果您有 ui 配置 ui: 'highlight',则生成的 Panel.scss 将如下所示

@include extjs-panel-ui(
    $ui: 'highlight',
    $ui-header-background-color: red,
    $ui-border-color: red,
    $ui-header-border-color: red,
    $ui-body-border-color: red,
    $ui-border-width: 5px,
    $ui-border-radius: 5px
);

但是,这只会对无边框面板应用样式。为了对配置为 frame: trueui: 'highlight' 的面板设置样式,您需要在 Panel.scss 文件中将 -framed 添加到 $ui 名称。通常,Panel.scss 中将同时表示有边框和无边框的 ui 版本

@include extjs-panel-ui(
    $ui: 'highlight',
    $ui-header-background-color: red,
    $ui-border-color: red,
    $ui-header-border-color: red,
    $ui-body-border-color: red,
    $ui-border-width: 5px,
    $ui-border-radius: 5px
);

@include extjs-panel-ui(
    $ui: 'highlight-framed',
    $ui-header-background-color: red,
    $ui-border-color: red,
    $ui-header-border-color: red,
    $ui-body-border-color: red,
    $ui-border-width: 5px,
    $ui-border-radius: 5px
);

Ext.menu.Menu

在创建自定义 ui 时,需要将菜单 ui 图像从父主题复制到自定义主题。有关更多详细信息,请参见上面的“'default' 组件图像”部分。

Ext.toolbar.Breadcrumb

在创建自定义 ui 时,需要将面包屑 ui 图像从父主题复制到自定义主题。有关更多详细信息,请参见上面的“'default' 组件图像”部分。

Ext.tab.Tab

在创建自定义 ui 时,需要将选项卡 ui 图像从父主题复制到自定义主题。有关更多详细信息,请参见上面的“'default' 组件图像”部分。

在创建选项卡 ui 时,请务必包括您想要设置样式的所有适用的状态变量,包括 -active 选项卡状态,例如 $ui-color-active$ui-background-color-active 等。

Ext.tab.Bar

在创建自定义 ui 时,需要将 TabBar ui 图像从父主题复制到自定义主题。有关更多详细信息,请参见上面的“'default' 组件图像”部分。

注意:在使用 extjs-tab-bar-ui mixin 创建 TabBar ui 时,您需要创建同名的相应 tab-ui

这将确保选项卡在您的主题中正确呈现。不创建匹配的选项卡主题可能会导致选项卡呈现不可预测。

Ext.toolbar.Toolbar

在创建自定义 ui 时,需要将工具栏 ui 图像从父主题复制到自定义主题。有关更多详细信息,请参见上面的“'default' 组件图像”部分。

从 Ext JS 5.x 升级

虽然大部分主题更新发生在 Ext JS 5 和 6 之间的幕后,但在升级主题时需要注意一些更改。

sass/etc/all.scss 中定义的任何变量都应移至 sass/var/all.scss(或 sass/var/all.scss 导入的 .scss 文件)。

推荐)从变量声明的末尾删除 !default

推荐)将自定义主题文件夹从应用程序/工作区的根 packages/ 文件夹重新定位到 packages/local/

Ext JS 7.8.0 - Classic Toolkit