许多类在使用配置对象创建(实例化)类时使用快捷名称。快捷名称称为别名
(如果类扩展 Ext.Component,则称为xtype
)。别名/xtype 列在适用类的类名旁边,以便快速参考。
框架类或其成员可以指定为private
或protected
。否则,类/成员为public
。Public
、protected
和private
是访问描述符,用于传达如何以及何时使用类或类成员。
Public 类和类成员可供任何其他类或应用程序代码使用,并且可以依赖于主要产品版本中稳定且持久。公共类和成员可以通过子类安全地进行扩展。
Protected 类成员是稳定的public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地进行扩展。
Private 类和类成员由框架内部使用,不打算由应用程序开发人员使用。私有类和成员可能会在任何时候在不另行通知的情况下从框架中更改或省略,并且不应在应用程序逻辑中依赖它们。
static
标签。*请参见下面的静态。下面是一个示例类成员,我们可以对其进行剖析以显示类成员的语法(在这种情况下,从 Ext.button.Button 类中查看的 lookupComponent 方法)。
让我们看看成员行的每个部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回 undefined
以外任何内容的方法,可以省略此项,或者可能显示多个可能的值,这些值用正斜杠 /
分隔,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回一个组件,如果失败则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参见下面的标志部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员是从祖先类或混合类继承的,则显示为灰色。查看源
)item : Object
)列出。undefined
,则“返回”部分将注明返回的类或对象类型以及描述(在本例中为 Ext.Component
)自 3.4.0 起可用
- 在示例中未显示),就在成员描述之后默认为:false
)API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则不会触发- 表示框架类
- 单例框架类。*有关更多信息,请参见单例标志
- 组件类型框架类(Ext JS 框架中任何扩展 Ext.Component 的类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config
的类成员
- 表示类型为 property
的类成员
- 表示类型为 method
的类成员
- 表示类型为 event
的类成员
- 表示类型为 theme variable
的类成员
- 表示类型为 theme mixin
的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面的类名称下方,有一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员数(此计数会在应用筛选器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上,将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。
与类配置选项关联的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,位于它们所使用的配置下方。Getter 和 Setter 方法文档将位于配置行中,以便于参考。
您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用空间)。默认情况下,显示的唯一搜索结果是与您当前正在查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示内容。这将在历史记录栏中显示所有产品/版本的所有近期页面。
在历史记录配置菜单中,您还将看到最近访问的页面列表。结果按“当前产品/版本”和“全部”单选选项进行筛选。单击 按钮将清除历史记录栏以及保存在本地存储中的历史记录。
如果在历史记录配置菜单中选择了“全部”,则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后,每个历史记录页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上,还将显示产品/版本作为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个筛选器输入字段,它使用筛选器字符串筛选成员行。除了按字符串筛选外,您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。
API 类导航树底部的复选框筛选类列表,以包括或排除私有类。
单击一个空的搜索字段将显示您最近的 10 次搜索,以便快速导航。
每个 API 文档页面(Javascript 原始页面除外)都有一个菜单视图,其中包含与该类相关的元数据。此元数据视图将具有以下一个或多个
Ext.button.Button
类有一个备用类名 Ext.Button
)。备用类名通常用于向后兼容。可运行的示例(Fiddles)默认情况下在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换全部状态将在页面加载之间记住。
类成员默认情况下在页面上折叠。您可以使用成员行左侧的箭头图标或使用右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸进行优化的视图。桌面和“移动”视图之间的主要区别是
可以通过单击 API 文档页面顶部的类名来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。
应用程序样式是指用户对组件外观和感觉的调整。这些调整可能包括:颜色、颜色渐变、字体、边距/内边距等。可以通过 Architect 以多种方式实现此目的。
你可以
本指南主要关注前两点。在开始之前,我们先来定义样式和主题之间的区别。
样式是一个全局术语,它包括主题,还包括对 CSS 的直接更改。这些更改在项目中作为独立资源实现。
主题涉及对 Ext JS 主题 SCSS 的修改。可以通过修改变量、创建组件 UI 或添加其他覆盖来修改主题 SCSS。然后将主题编译为可以应用于项目的包。
每个 Sencha 框架都附带许多可以在应用程序中使用的主题。Architect 使您能够通过以下任何方式将主题应用于应用程序
在 Architect 外部开发主题,使用 Sencha Cmd 编译它,然后将定义主题的结果 CSS 文件作为 CSS 资源 包含在 Architect 项目中。
在工具箱中选择一个框架主题,将其添加到项目中并应用它。项目可以包含任意数量的主题,但一次只能应用一个主题。
通过在项目中选择主题资源来自定义工具箱主题。然后,您将能够查看定义主题外观的所有变量,按组件组织。此外,可以为支持它们的组件创建新的 UI。然后,您可以通过添加自定义 SCSS 资源来扩展这些 UI。这些更改会立即编译,并且可以在 Architect 画布中预览。
将主题保存到工具箱或将其导出到外部文件,以便其他项目和用户可以使用它。
CSS 资源只是一个 CSS 文件,其中包含视图组件的自定义样式。要添加 CSS 资源,请在工具箱中找到它并将其添加到项目中的资源中。添加 CSS 资源后,将其 URL 配置设置为 CSS 文件的位置。
通常最好给 URL 配置一个相对于主 app.html
文件的路径。使用相对路径允许您在 Architect 的代码编辑器中编辑文件的内容。只需在检查器中选择 CSS 资源并切换到代码视图。然后,您可以编辑 CSS 代码以更新目标 .css
文件并将其重新应用到画布上。如果在指定的本地路径中不存在文件,Architect 会在您保存或构建项目时创建该文件。
配置 CSS 资源后,Architect 会尝试加载。如果成功,Architect 会将您的自定义 CSS 应用到画布上,以便您在设计应用程序时看到自定义样式。如果您的 CSS 文件以 Architect 之外的某种方式被修改,您可以通过单击画布上方的“刷新 CSS”按钮重新加载并将其重新应用到画布上。
通过在画布中加载和应用 CSS,您的自定义样式可能会覆盖基本框架样式。这可能会破坏画布上组件的显示。在大多数情况下,CSS 样式优先,因为它们是在主题和框架样式之后应用的。我们建议使用框架中没有的 CSS 类。这消除了与基本 CSS 冲突的可能性。
Sencha 框架都附带一系列主题,可以应用于使用 Ext JS 4.2+ 构建的应用程序。
以下主题可用于 Sencha Ext JS 项目
经典 - 经典蓝色 Ext JS 主题。
灰色 - 扩展“ext-theme-classic”。与经典相同,但带有灰色色调。
访问 - 无障碍主题。扩展“ext-theme-classic”。这是一个为 Ext JS 4.2 WAI-ARIA 无障碍要求创建的传统主题。它保留了向后兼容性,但被 aria 主题取代。
Neptune - 现代无边框主题。扩展“ext-theme-neutral”。此主题经过专门设计,易于修改,最适合作为自定义主题的基础。
经典 - 经典蓝色 Ext JS 主题。
灰色 - 扩展“ext-theme-classic”。与经典相同,但带有灰色色调。
Neptune - 现代无边框主题。扩展“ext-theme-neutral”。此主题经过专门设计,易于修改,最适合作为自定义主题的基础。
Neptune Touch - 与 Neptune 相同,但包含用于触摸屏设备的放大组件。
Crisp - 现代简约主题。扩展“ext-theme-neptune”。
Crisp Touch - 与 Crisp 相同,但包含用于触摸屏设备的放大组件。
ARIA - 无障碍主题。扩展“ext-theme-neptune”。
经典 - 经典蓝色 Ext JS 主题。
Gray - 扩展“theme-classic”。与 classic 相同,但带有灰色色调。
Neptune - 现代无边框主题。扩展“theme-neutral”。此主题经过专门设计,易于修改,最适合作为自定义主题的基础。
Neptune Touch - 与 Neptune 相同,但包含用于触摸屏设备的放大组件。
Crisp - 现代简约主题。扩展“theme-neptune”。
Crisp Touch - 与 Crisp 相同,但包含用于触摸屏设备的放大组件。
ARIA - 无障碍主题。扩展“theme-neptune”。
Triton - 现代无边框主题。扩展“theme-neptune”。此主题经过专门设计,易于修改,最适合作为自定义主题的基础。
Windows Phone - 适用于 Internet Explorer 10 及更高版本设备(如 Windows Phone 和 Microsoft Surface)的主题。
Cupertino - 基于 iOS7+ 的设备主题。
Neptune Touch - 现代无边框主题。扩展“theme-neutral”。包含用于触摸屏设备的放大组件。
MountainView - 基于 Android 的设备主题。
Triton - 现代无边框主题。扩展“theme-neptune”。此主题经过专门设计,易于修改,最适合作为移动设备的自定义主题的基础。
Ext JS 主题在包中进行组织,并且具有层次结构。“theme-base”是基础主题,其中包含框架组件的布局信息。“theme-neutral”继承自“theme-base”,并为所有组件配置全局变量和规则。其他所有主题都以某种方式从“theme-neutral”扩展而来。
此外,Ext JS 还包含一个用于触摸大小调整的子包,该子包可帮助“theme-neptune-touch”和“theme-crisp-touch”调整触摸屏设备的组件大小。
下表应有助于您了解 Ext JS 中的主题继承工作原理。
有关 Ext JS 主题的更多信息,请参阅 Ext JS 主题指南
Quick Themes 允许您只需单击几下即可创建一些主题的全面变体。这可防止您必须自定义每个组件,从而提供了一条更清晰的简单主题路径。
Ext JS 中提供了以下 Quick Themes
Neptune
Neptune Touch
Crisp
Crisp Touch
所有框架主题、自定义添加的主题和 Quick Themes 都可以在工具箱中的“主题”下找到。您可以通过以下任何方式将主题从工具箱应用到您的项目
将主题拖动到画布面板的空白区域
将主题拖动到检查器面板的资源节点。
在检查器面板中选择资源节点,然后双击主题。
将主题添加到项目后,Architect 会询问您是否要将此主题应用到您的项目。
您可以在项目中包含任意数量的主题,但任何给定时间只应用一个主题。要应用不同的主题,请在检查器面板中右键单击
它并选择“应用主题”。您可以以相同的方式从项目中删除或复制主题。
您可从工具箱轻松自定义项目中的主题资源。您还可以通过修改库中theme
配置的值来应用不可自定义的框架主题。只需选择一个框架主题。内置主题将显示在列表顶部,任何其他自定义主题将显示在底部。
注意:如果您已从工具箱向项目应用了主题,则更改theme
配置不会将其从项目中删除。它只是不再被应用。在库中设置theme
配置与应用自定义主题的效果相同。
开始之前,请注意您无法为 Ext JS 4.2 之前的框架版本创建自定义主题。
以下是自定义主题的一般步骤
如前所述,向您的项目应用 Sencha 定义的一个主题。
在项目检查器中选择此主题。它将显示一个名称,如“MyCrispTheme”。您可以通过修改配置面板中的文件名
来重命名主题。
单击“主题”手风琴标题以显示按组件分组的全局变量列表。这些变量可根据需要进行修改以自定义您的主题。更改全局变量将影响所述组件的所有实例的外观。如果您想修改组件的单个实例,请参阅下面的 UI 部分。
定义并命名自定义主题后,在项目检查器窗口中右键单击
主题以获取一个下拉菜单,该菜单允许您将主题保存到工具箱或将其导出到可与其他用户共享的文件。
当您将自定义主题保存到工具箱时,您会看到一个弹出窗口,您可以在其中定义主题的显示名称以及将使用的类别和组
当您将自定义主题导出到文件时,您会看到一个弹出窗口,您可以在其中定义文件名和将写入.xdc
文件的位置。
另一个用户可以下载此文件,然后使用“编辑”菜单栏项上的“导入组件”链接导入它。
如果您不想将 Architect 主题包含在项目中,请按照以下简单步骤操作。
您可以通过更改全局变量的值来自定义主题的许多方面。
选择“主题”手风琴后,单击列出的任何类名左侧的三角形以显示该组件的全局变量。
每个变量名称都相当不言自明,但其中大多数还带有带有更详细解释的工具提示。变量名称还记录在 Ext JS API 参考页面的“CSS 变量”部分下。
除了网格中列出的可读“显示名称”外,每个变量还有一个“真实名称”或“scss 名称”。此类变量值的语法以 $ 符号开头(例如基本颜色变量的 $base-color)。这是一个变量引用,可用于将变量链接在一起。如果两个变量的类型相同,您可以在另一个变量的值字段中使用其中一个的 scss 名称。
为 Ext.Class 和 Ext.Component 定义的变量是根级别的。这些变量不会直接修改组件,但由于它们的派生类,更新它们可以改变主题的整体外观。
组件变量通常不应引用为其他组件定义的变量,除非所述组件彼此继承。
您可以通过使用筛选面板搜索以下任何命名方案来查找和修改您要更改的变量
选择变量后,您可以添加一个新值。可接受的值取决于变量类型。如果您输入不可接受的值,编译器通常会在编译时给出错误。我们将在下面讨论一些不同的变量类型。
颜色变量具有一个集成的颜色选择器,该选择器还显示当前颜色值的预览。
单击颜色以启动颜色选择器,为项目中的组件设置不同的颜色。
我们将在本指南的后面部分讨论颜色选择器。
渐变变量具有一个集成的渐变选择器,该选择器还显示当前渐变和渐变曲线的预览。渐变是针对为同一组件选择的颜色执行操作的函数,并以灰色进行预览。但是,应用后,渐变将显示正确的颜色。
颜色渐变指定用于逐步填充区域的一系列颜色。
常规 | 面板 | 标签(栏) | 网格 | 按钮 |
---|---|---|---|---|
斜角 | 反向面板 | 标签栏 | 网格标题 | 光泽按钮 |
光泽 | 面板标题 | 标签 | 网格标题(悬停) | 光泽按钮(悬停) |
凹陷 | 活动标签 | 网格行(悬停) | 光泽按钮(按下) | |
哑光 | 标签(悬停) | 特殊网格单元格 | ||
反向哑光 | 禁用标签 |
字体系列变量具有许多可以选择的预设字体。这些是常见的网络安全字体系列。但是,可以手动输入任何其他字体或字体系列组合。
在应用程序中使用网络字体
在代码编辑器中编辑 css/scss
文件,以使用包含网络字体的 @font-face 规则。
通过打开配置选项卡并在 SCSS 行右侧单击“+”号,在项目中的主题资源下添加一个 SCSS 段。
设置 compile/include
顺序,以便 SCSS 段在主题的其余部分之前运行。为此,单击“SCSS 资源”行上的箭头以添加“编译顺序”行。从下拉菜单中选择 beforeVariables
。
按照上述步骤操作后,你应该能够将任何已安装字体的字体名称用作主题中任何字体系列变量的值。
默认情况下,每次修改变量时都会重新编译主题。你将注意到配置面板底部有一个编译进度条。如果为任何变量分配了无效值,编译器会发出警告。
你可以通过单击进度条左侧的“A”按钮关闭自动编译功能。然后,你可以通过单击“A”按钮和进度条之间的按钮来执行手动编译。
编译栏显示在配置面板的底部。
当编译栏为橙色(如上所示)时,自动编译已关闭,并且自上次编译运行以来已修改变量值。
当编译栏为红色时,表示编译错误。
列出的每个主题和 UI 变量在修改后都会获得一个复选框。切换此复选框可让你快速比较组件的原始外观和修改后的组件值。
网格中的每个变量都处于三种可能状态之一,由左边缘的指示栏标识
默认状态(指示栏为灰色)– 变量设置为默认值,复选框不可见。
启用状态(指示栏为蓝色)– 你已修改此变量的值。复选框中出现一个勾号。你可以单击勾号转到禁用状态。切换启用和禁用状态可让你快速比较两个值。
禁用状态(指示栏为橙色)– 你已修改此变量的值,但已将其切换为关闭状态。这意味着在编译主题时,你的值不会是用户定义的,而是编译为默认状态。
在启用和禁用状态下,为变量显示的值是用户分配给它的值。
要恢复变量的原始值,请右键单击
变量名称,然后从下拉菜单中选择重置
。执行此操作后,变量处于默认状态。从视觉上看,显示默认值,指示栏为灰色,复选框不可见。
UI 有一组附加变量,这些变量会覆盖组件实例的基本变量,而主题中的全局变量对该组件的所有实例都有效。
应用主题时,你可以选择符合条件的组件。符合条件将通过 UI 手风琴标题栏的存在以视觉方式表示。配置面板还显示一个 UI 配置,其值为全局
或默认
。此状态取决于组件和框架,因为某些组件带有预制的框架 UI。
支持 UI 的组件将具有 UI 配置。
例如,如果你使用的是默认的、不可修改的 Ext JS 主题之一,则主题化界面不可用。要以这种方式修改 UI 配置,你必须知道要使用的有效 UI 名称。
作为一个简单的示例,使用 Ext JS“左/上/下”布局模板打开一个项目。
ui
。default
更改为light
。默认 UI 无法修改或删除。为了修改 UI,你需要创建自己的自定义版本。
要为组件创建自己的 UI,请单击“+”号添加新的 UI 类型。默认情况下,这些 UI 被命名为“Untitled {x}”。你可以通过单击 UI 面板最右侧的齿轮并输入弹出窗口中显示的所需名称来重命名 UI。如果所选组件不支持 UI,则不会显示 UI 下拉选择器和“+”按钮。
创建新的 UI 类型会导致显示所有相关变量。
在编译新 UI 后,你可以将新组件拖到画布或检查器中。最初,你选择的每个新组件都使用默认 UI 显示。要更改此设置,只需单击 UI 框右侧的箭头并选择新 UI。这会将你的自定义 UI 应用于如下所示的组件。
在某些情况下,你可能希望超越变量调整。
为了帮助实现这一点,Architect 中提供了两种类型的可修改 SCSS 资源
模板 SCSS - 可以添加到任何模板的 SCSS 段。这些段可帮助你设置数据生成内容的样式,例如列表、数据视图等。这些段属于模板,并且无论应用什么自定义主题都将存在。这些 SCSS 资源也包装在一个自定义类中,以便它们保持模板特定性,以避免 CSS 冲突。
主题 SCSS - 可以添加到任何主题根目录的 SCSS 段。
要添加 SCSS 资源,请选择一个模板或主题,然后单击配置窗格中SCSS
配置旁边的 + 按钮。
在代码编辑器的工具栏中编辑 SCSS 资源时,有一些有用的操作可用
插入 Tpl 结构将以适当的 SCSS 语法从模板数据中插入 CSS 类名称,以便你可以更快地设置模板样式。
插入颜色将使用颜色选择器在编辑器中插入颜色。如果选择了颜色,则打开颜色选择器时该颜色将显示在颜色选择器中。
注意:Architect 通常会保护你,让你不必了解 SASS 的复杂性。也就是说,如果你需要访问此信息,你可以阅读SASS 参考指南。
此外,主题 SCSS 可以指定相对于主题其他部分的编译顺序。
颜色选择器提供了一个可自定义的调色板,以帮助你在自定义主题时选择合适的颜色。
右上角的大方块显示当前分配的颜色调色板。你可以通过以下任何一种方式为调色板选择另一种基本颜色
Hex
字段中提供基本颜色的十六进制值。可以通过在色条上上下拖动光标或在每列底部方框中提供绝对值来调整这些值。你还可以使用调色板正方形下方的方框中 RGB 系统指定颜色。
当你修改调色器中的不同值时,主调色板显示正方形上的色相选择器会移动以显示当前选择的准确颜色;此颜色的较大色块也会显示在右上角的矩形中。
当你对结果满意时,单击“确定”按钮。这会自动更新变量的颜色,并使用新定义的颜色编译主题。窗口右下部分会显示一个进度条,以指示编译器的进度。编译完成后,画布中显示的项目组件将更改为使用新定义的调色板。
以下是修改自定义主题中颜色的其他一些提示
要复制 scss 名称,右键单击
变量名称,然后从下拉菜单中选择“复制 SCSS 引用”。
如果使用调色器或手动设置有效的 CSS 颜色名称或十六进制值,则其值进行某种计算的变量将被绝对颜色值覆盖。
选择新颜色时,可以单击屏幕右下方的“添加”以将颜色色块正方形添加到显示中,或将颜色从右上角的颜色预览中拖动到调色板中以添加它。如果你想将其他变量设置为相同的调色板,则只需选择变量,然后单击表示该调色板颜色的颜色色块正方形即可。
你可以拖动调色板菜单中的色块来重新排列它们的显示方式。要从调色板中删除色块,请将其拖放到调色板外部。调色板菜单的内容在项目和框架之间保持不变。
一些图标和图像与主题相关。例如,复选框和各种触发器的外观。选择一个主题并单击“图像”选项卡时,将显示关联图像的列表。单个图像可能由多个组件使用。
Sencha Architect 使你能够在应用程序样式中包含图像。
按钮和其他组件可以附加图像。
向组件添加图像
project/resources/
目录下的有意义的位置。此目录中的图像可以在画布中呈现,并且 Ext JS 项目的预览和构建操作可以访问它们。 注意:有关 Architect 项目文件结构的更多信息,请参阅 项目文件。
选择要附加图像的组件。
转到配置面板并选择图标配置。
提供包含图像的 .png
文件的 URL。使用相对于 mainapp.html
文件的路径可以为你提供最大的灵活性,尽管绝对路径名也可以使用。
当你有一个徽标或其他图像想要在不同的视图中重复使用时,请使用该图像创建一个自定义组件
将图像放置在项目树中 project/resources/
目录下的有意义的位置。
创建一个容器并选择它。
转到配置面板并找到 html
配置。将此配置设置为 <img src="path/to/my/image.png"/>
等值。
将组件的宽度和高度设置为与图像的宽度和高度匹配。
将此容器另存为自定义组件。
你现在可以根据需要轻松拖放包含徽标的组件。
将图像放置在项目树中 project/resources/
目录下的有意义的位置。
在 SCSS 代码中引用图像如下所示
url('project/resources/your-image-folder/your-image.png').