许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称称为 alias
(或 xtype
,如果类扩展了 Ext.Component)。别名/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
- 示例中未显示),紧跟在成员描述之后Defaults to: 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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
ExtJS 附带了三个 Web 字体包,可用于您的应用程序。这些 Web 字体可用于指定图标,以用于提供 iconCls
或 glyph
配置属性的组件。
下表包含三个字体包及其相关信息
字体包 | 包名称 | fontCls | iconPrefix | fontFamily |
ExtJs | font-ext | ext | ext | ExtJS |
Font Awesome | font-awesome | x-fa | fa | FontAwesome |
Pictos | font-pictos | pictos | pictos | Pictos |
注意: Ext JS 7.x 支持 Font Awesome 5.6.3+ 版本。有关所有可用的 Font Awesome 图标列表,请查看 Font Awesome 速查表。
字体包通过在应用程序的 app.json 文件(对于应用程序)或 package.json 文件(对于主题/代码包)的 requires
数组中指定字体包名称(如上)来包含
// Require the Pictos font package
"requires": [
"font-pictos"
]
一旦您的应用程序需要,您可以使用 iconCls
或 glyph
配置属性显示字体图标。
iconCls
配置允许您利用包中预定义的 CSS 样式,这些样式映射到具有有意义名称(例如 home、help、info)的 Web 字体字符
使用 iconCls
配置属性引用图标非常简单,只需以以下格式指定 iconCls 即可
iconCls: '{fontCls} {iconPrefix}-{iconName}'
每个字体包的 {fontCls} 和 {iconPrefix} 值显示在上面的表格中。每个图标的 {iconName} 在本指南末尾的详细字体包表格中找到。
例如,要指定 Pictos home
图标,您需要将 iconCls
属性指定为
iconCls: 'pictos pictos-home'
类似地,要指定 Font Awesome home
图标,您需要将 iconCls
属性指定为
iconCls: 'x-fa fa-home'
在 Classic 工具包中,许多组件(例如,按钮和菜单项)都有一个 glyph
配置,允许使用字符或十六进制代码来指示图标在字体文件中的索引位置。
例如,以 Picos home
图标为例,您需要将 glyph
属性指定为
glyph: 'H'
甚至
glyph: 'x48' // ASCII 'H'
如果您的应用程序中有多个字体包,您可以通过提供如下所示的字体系列名称来指定要使用的字体系列
glyph: 'x48@FontAwesome'
以下是参考表格,其中提供了每个字体包中可用图标的列表。表格显示了图标本身,用于 glyph
配置属性的字符或十六进制代码,以及用于 iconCls
配置属性的 CSS 类名称(见上文)。
图标 | Glyph 值 | iconName | 图标 | Glyph 值 | iconName | |
| xe612 | equals-vertical | | xe600 | collapse | |
| xe601 | columns | | xe602 | dirty-rtl | |
| xe603 | dirty | | xe604 | edit-html | |
| xe605 | equals | | xe606 | expand | |
| xe607 | group-by | | xe609 | ne-handle | |
| xe60a | nw-handle | | xe60b | se-handle | |
| xe60c | sw-handle | | xe60d | text-background-color | |
| xe60e | text-color | | xe60e | text-decrease | |
| xe60e | text-increase | | xe60e | unpin |
图标 | Glyph 值 | iconName | 图标 | Glyph 值 | iconName | |
a | a | anchor | A | A | attachment2 | |
b | b | box | B | B | bird | |
c | c | upload | C | C | cloud | |
d | d | forbidden | D | D | delete_black1 | |
e | e | lightning | E | E | eye | |
f | f | rss | F | F | file | |
g | g | team | G | G | browser | |
h | h | help | H | H | home | |
i | i | info | I | I | inbox | |
j | j | attachment | J | J | network | |
k | k | heart | K | K | key | |
l | l | list | L | L | radio | |
m | m | music | M | M | ||
n | n | table | N | N | news | |
o | o | folder | O | O | case | |
p | p | pencil | P | P | photos | |
q | q | chat2 | Q | Q | power | |
r | r | retweet | R | R | action | |
s | s | search | S | S | favorites | |
t | t | time | T | T | plane | |
u | u | switch | U | U | user | |
v | v | camera | V | V | video | |
w | w | chat | W | W | compose | |
x | x | settings2 | X | X | truck | |
y | y | settings | Y | Y | chart2 | |
z | z | tags | Z | Z | chart | |
\` | \` | expand | ~ | ~ | download | |
1 | 1 | refresh | ! | @ | warning_black | |
2 | 2 | check | @ | @ | locate | |
3 | 3 | check2 | # | # | trash | |
4 | 4 | play | $ | $ | cart | |
5 | 5 | pause | % | % | bank | |
6 | 6 | stop | ^ | ^ | flag | |
7 | 7 | forward | & | & | add | |
8 | 8 | rewind | * | * | delete | |
9 | 9 | play2 | ( | ( | lock | |
0 | 0 | refresh2 | ) | ! | unlock | |
- | - | minus | _ | _ | minus2 | |
= | = | battery | + | + | add2 | |
[ | [ | left | { | { | up | |
] | ] | right | } | } | down | |
\ | \ | calendar | | | | | screens | |
; | ; | shuffle | : | : | bell | |
' | ' | wireless | " | " | quote | |
, | , | speedometer | < | < | volume_mute | |
. | . | more | > | > | volume | |
/ | / | ? | ? | question |