许多类在使用配置对象创建(实例化)类时使用快捷名称。快捷名称称为别名
(如果类扩展了 Ext.Component,则称为xtype
)。对于可应用的类,别名/xtype 会列在类名称旁边,以便快速参考。
框架类或其成员可以指定为private
或protected
。否则,类/成员为public
。Public
、protected
和private
是访问描述符,用于传达如何以及何时应该使用类或类成员。
Public类和类成员可供任何其他类或应用程序代码使用,并且可以作为主要产品版本中稳定的和持久的类和成员。Public 类和成员可以通过子类安全地进行扩展。
Protected类成员是稳定的public
成员,旨在由拥有类或其子类使用。Protected 成员可以通过子类安全地进行扩展。
Private类和类成员由框架内部使用,不打算由应用程序开发人员使用。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
)。备用类名通常用于向后兼容。可运行的示例(Fiddle)默认情况下在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换全部状态将在页面加载之间记住。
默认情况下,类成员在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化视图。桌面和“移动”视图的主要区别是
可以通过单击 API 文档页面顶部的类名称来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。
主题配置语法参考。
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
}
}
}