许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias
(别名)(如果该类扩展了 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 方法调用成功,方法可能返回 Component,如果失败,则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的“标志”部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接;如果它从祖先类或混合类继承,则显示为灰色。view source
(查看源代码))item : Object
)。undefined
之外的值,则“返回值”部分将注明返回的类或对象类型以及描述(示例中为 Ext.Component
)Available since 3.4.0
(自 3.4.0 版本起可用)- 示例中未显示),紧跟在成员描述之后Defaults to: false
(默认为: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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”(查看源代码)链接来查看类成员的源代码。
以用户理解的语言和他们习惯的约定进行交流至关重要。Ext JS 包含一个本地化包,可帮助开发人员轻松地将应用程序本地化为多种非英语语言。
您将在 ext-locale 包的 override 文件夹中找到所有捆绑的语言环境文件。语言环境文件只是覆盖,告诉 Ext JS 替换某些组件的默认英语值。这些通常是日期格式、月份和日期名称等。
日期选择器就是一个完美的例子。以下是西班牙语本地化文件中的摘录
Ext.define("Ext.locale.es.picker.Date", {
override: "Ext.picker.Date",
todayText: "Hoy",
minText: "Esta fecha es anterior a la fecha mínima",
maxText: "Esta fecha es posterior a la fecha máxima",
disabledDaysText: "",
disabledDatesText: "",
nextText: 'Mes Siguiente (Control+Right)',
prevText: 'Mes Anterior (Control+Left)',
monthYearText: 'Seleccione un mes (Control+Up/Down para desplazar el año)',
todayTip: "{0} (Barra espaciadora)",
format: "d/m/Y",
startDay: 1
});
要实现本地化,只需修改 Sencha Cmd 生成的基于经典工具包的应用程序中的 app.json
文件。您需要将“ext-locale”包添加到 requires 块。生成的添加内容应如下所示
/**
* The list of required packages (with optional versions; default is "latest").
*
* For example,
*
* "requires": [
* "sencha-charts"
* ]
*/
"requires": [
"ext-locale"
],
注意: 如果您使用的是 Universal 应用程序,则需要将语言环境要求添加到您的经典工具包的 require's 数组中
"classic": {
"requires": [
"ext-locale"
],
...
}
您的应用程序现在已准备好进行本地化。下一步是确定您有兴趣包含的语言。您只需创建一个语言环境设置。只需将以下行添加到您的 app.json
文件中
"locale": "es",
注意: 语言环境设置不是默认条目。您需要手动将其添加到您的 app.json
文件中。
现在您的 app.json
已更新,您可以运行 sencha app build
,Sencha Cmd 将处理更改。刷新后,您应该看到任何具有英语值的组件现在都包含西班牙语值。
在不使用 Sencha Cmd 的情况下本地化 Ext JS 的最简单方法是在您的 index 文件中包含语言环境文件。
<!DOCTYPE html>
<html>
<head>
<!-- Ensure we're using UTF-8 -->
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Localization example</title>
<!-- Main Ext JS files -->
<link rel="stylesheet" type="text/css" href="resources/ext-theme-neptune-all.css">
<script type="text/javascript" src="ext-all.js"></script>
<!-- Include the translations -->
<script type="text/javascript" src="ext-locale-es.js"></script>
<script type="text/javascript">
Ext.onReady(function() {
Ext.create('Ext.picker.Date', {
renderTo: Ext.getBody()
});
});
</script>
</head>
<body>
当您编写自定义组件或插件时,您需要确保遵循 Ext JS 本地化的最佳实践。至少,向用户显示的每个文本字符串都应定义为属性
Ext.define("Ext.ux.Weather", {
sunText: "It's a nice sunny day",
rainText: "Bad weather, don't go out",
// ...other code...
});
在处理日期时,您需要格外小心。每种语言都有自己的书写方式。当您的扩展呈现日期时,请提供配置选项以指定格式。这样,您的扩展用户可以轻松地覆盖特定于语言环境的部分。
您可以通过使用 Ext JS 本身已翻译消息的组件来避免大多数本地化的需要(例如,在呈现“OK”按钮时使用 buttonText)。
如果您已定义带有文本字段、标签或其他本地化代码的应用程序类,则需要使用自定义的语言环境覆盖来覆盖它们。
第一步是创建一个目录,您将在其中放置所有语言环境覆盖。例如,您可能希望将所有语言覆盖放在应用程序中的“locale”目录中。此目录将包含每个语言的子目录,对应于语言环境代码(例如,locale/es 中的西班牙语覆盖,locale/fr 中的法语覆盖等)。
此步骤最重要的部分是确保将每组语言覆盖隔离在与您在 app.json
文件中指定为 locale 属性的值匹配的目录中。
创建语言环境目录结构和覆盖后,您需要告诉 Sencha Cmd 在构建过程中添加这些类。
如果您遵循了上述约定,则可以将以下配置添加到您的 app.json
overrides 属性中
"overrides": "${app.dir}/overrides,${app.dir}/locale/${app.locale}",
这将允许 Sencha Cmd 递归添加在 locale/xx 目录下找到的所有类文件,其中 xx
是在 app.json
文件中的 locale
下指定的语言环境代码。