许多类在使用配置对象创建(实例化)时都有快捷名称。快捷名称被称为 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
- 示例中未显示),紧接在成员描述之后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
的备用类名称)。备用类名称通常为了向后兼容性而维护。可运行的示例 (Fiddle) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”(查看源代码)链接来查看类成员的源代码。
Sencha Touch 2 为框架带来了许多改进。由于其中一些更改需要您更新应用程序代码的部分内容,因此本指南将引导您完成需要进行的更改。
除了本指南外,Sencha Touch 2 还附带了一个向后兼容性构建,使迁移过程更加容易。请注意,此构建不能自动保证您的 1.x 应用程序开箱即用。在可能的情况下,兼容性构建会找出您的 1.x 应用程序代码尝试执行的操作,并将其路由到 2.x API。每当它这样做时,兼容性构建都会在控制台中记录警告,指示您需要更新的项目。
如果您按照以下步骤操作,然后更正兼容性层告知您的任何警告,您应该获得一个可以在 Sencha Touch 2.x 上运行的应用程序。
SenchaCon 2011:从 Touch 1.x 迁移到 2.0,来自 Sencha,发布在 Vimeo 上。
迁移应用程序时,最大的更改与类的定义方式有关。Sencha Touch 2 使用从 Ext JS 4 派生的升级类系统,该系统带来了强大的新功能,例如 mixins、动态加载和配置系统。
在 Sencha Touch 1.x 中,定义类主要有两种方式 - 使用 Ext.extend 和使用 MVC 特定的便捷函数之一,例如 regModel 和 regController。在 Sencha Touch 2 中,所有类都以相同的方式定义,使用 Ext.define 方法。让我们考虑以下 1.x 示例类,看看如何将其迁移到 2.x 框架
Geo.views.BillSummary = Ext.extend(Ext.Panel, {
scroll: 'vertical',
html: "Loading...",
styleHtmlContent: true,
initComponent: function() {
this.tpl = Ext.XTemplate.from('billsummary');
Geo.views.BillSummary.superclass.initComponent.call(this);
},
/**
* Get the billSummary and update the contents of the panel.
*/
getBill: function(bill) {
Geo.CongressService.getBillSummary({
bill: bill
}, this.onBillSummaryResponse, this);
},
// private
onBillSummaryResponse: function(billSummary) {
if (Ext.isArray(billSummary.Paragraph)) {
this.update(billSummary);
} else {
this.update('No Bill Summary Available');
}
}
});
在 Sencha Touch 2.x 中,之前的代码编写如下
Ext.define('Geo.view.BillSummary', {
extend: 'Ext.Panel',
config: {
scroll: 'vertical',
html: 'Loading...',
styleHtmlContent: true
},
initialize: function() {
this.callParent(arguments);
this.tpl = Ext.Template.from('billsummary');
},
/**
* Get the billSummary and update the contents of the panel.
*/
getBill: function(bill) {
Geo.CongressService.getBillSummary({
bill: bill
}, this.onBillSummaryResponse, this);
},
// private
onBillSummaryResponse: function(billSummary) {
if (Ext.isArray(billSummary.Paragraph)) {
this.setHtml(billSummary);
} else {
this.setHtml('No Bill Summary Available');
}
}
});
首先要注意的是,我们已将 Ext.extend 替换为 Ext.define。所有旧的组成部分仍然存在,但我们已将它们重新排列以使用新语法。您可以注意到,在 2.x 版本中,所有类名都是基于字符串的。这使动态加载系统能够自动将这些类加载到页面上(如果它们尚未存在)。有关更多详细信息,请参阅 类系统指南。
另一个更改与将所有配置选项移动到 config 对象有关。每个类的配置选项都可以在类文档中找到。定义类时,在类的配置部分中找到的任何参数都应放入 config 对象中。
配置系统提供了一些关键优势,主要是 API 一致性的保证。例如,html 配置选项保证我们可以随时调用 getHtml 和 setHtml,从而消除了猜测要调用哪些函数的麻烦。每个配置选项都有 getter 和 setter 函数,它们遵循与 getHtml 和 setHtml 相同的模式。我们在 onBillSummaryResponse 函数中利用了这一点,我们将旧的“update”函数替换为更清晰的 setHtml 函数。
最后,我们将 initComponent 替换为 initialize。在框架的 1.x 版本中,initComponent 仅在 Component 类上可用,这排除了所有其他类,例如 Models、Controllers 和实用程序。在 2.x 版本中,每个类都有一个 initialize 函数,如果您希望在实例化时执行某些逻辑,则可以实现该函数。这里需要注意的另一个细节是,您不再需要冗长的 Geo.views.BillSummary.superclass.initComponent.call(this); 调用 - 您可以始终使用 this.callParent(arguments) 来调用超类函数。
Sencha Touch 2 中的 MVC 架构是对 Sencha Touch 1 中采用的方法的改进。虽然大多数概念相同,但语法已得到改进,以使 API 更具表现力,并使您的代码更具可读性和可测试性。
与 Sencha Touch 2 中的所有其他类类似,模型类和其余数据包现在期望将其配置放入 config 块中。Sencha Touch 2 还统一了定义应用程序所有类的方式:不再需要 Ext.regModel - 相反,模型就像任何其他类一样被 定义。迁移模型非常简单 - 考虑到您曾经有一个模型,如以下代码示例所示
Ext.regModel('MyApp.model.User', {
fields: [
{name: 'name', type: 'string'},
{name: 'age', type: 'int'},
{name: 'alive', type: 'boolean', defaultValue: true}
],
validations: [
{type: 'presence', field: 'age'},
{type: 'length', field: 'name', min: 2}
],
sayName: function() {
alert(this.get('name'));
}
});
在 Sencha Touch 2 中,相同的模型如下所示
Ext.define('MyApp.model.User', {
extend: 'Ext.data.Model',
config: {
fields: [
{name: 'name', type: 'string'},
{name: 'age', type: 'int'},
{name: 'alive', type: 'boolean', defaultValue: true}
],
validations: [
{type: 'presence', field: 'age'},
{type: 'length', field: 'name', min: 2}
]
},
sayName: function() {
alert(this.get('name'));
}
});
模型迁移通常分四个步骤完成
除了迁移到新的类系统语法外,视图迁移非常简单。要记住的主要点是关于视图类名称的约定。在 Sencha Touch 2 及更高版本中,我们建议您的视图类名称遵循模式 MyApp.view.SomeViewName。请注意,“view”是单数,这使类系统能够自动从文件 app/view/SomeViewName.js 加载视图类。
对于 Ext.application 定义,您可以保留 1.x 应用程序中的大多数语法
Ext.application({
name: 'MyApp',
icon: 'resources/images/logo.png',
launch: function() {
Ext.create('MyApp.view.Main');
}
});
唯一的更改是我们使用 Ext.create 来实例化 MyApp.view.Main,这是我们应用程序的主屏幕。
除了此更改之外,在加载应用程序需要的模型、视图、控制器和存储方面,还有另一个细微的更改。在 1.x 中,通常在 Ext.application 块内定义所有控制器,以及一些模型、视图和存储。其余依赖项可能分散在您的应用程序中,使得难以轻松了解应用程序的确切组成。
在 Sencha Touch 2 中,我们鼓励您在 Ext.application 块内定义应用程序的所有依赖项,而不是将其中一些依赖项放在控制器内。一个示例可能如下所示
Ext.application({
name: 'MyApp',
icon: 'resources/images/logo.png',
models: ['User', 'Group'],
controllers: ['Users', 'Login'],
views: ['Main', 'Users'],
stores: ['Users'],
launch: function() {
Ext.create('MyApp.view.Main');
}
});
与模型类似,Sencha Touch 2 期望任何控制器都像任何其他类一样定义,因此 Ext.regController 函数已弃用。在 1.x 版本中,我们可能有一个控制器,如下所示
Ext.regController("searches", {
showSomething: function() {
alert('something');
}
});
在 2.x 版本中,它变为以下示例代码中所示
Ext.define('MyApp.controller.Searches', {
extend: 'Ext.app.Controller',
showSomething: function() {
alert('something');
}
});
如前所述,如果您的 1.x 控制器定义了其他模型、视图或存储依赖项,则应将这些依赖项移动到应用程序中。兼容性构建仍将尝试加载这些依赖项,但非兼容性构建不会。
在 Sencha Touch 1.x 中,控制器在很大程度上是可以外部调度的函数集合。通常,这意味着应用程序将调用 Ext.dispatch,指定控制器名称、要调用的函数以及要传递给函数的参数。有时,调度将是自动的,由路由器拾取的 URL 更改触发。
在 2.x 中,控制器变得更加主动,在其 config 块内主动注册它关心的路由
Ext.define('MyApp.controller.Searches', {
config: {
routes: {
'search/:query': 'doSearch'
}
},
doSearch: function(query) {
alert('searching for ' + query);
}
});
这绕过了对单独路由文件的需求,并允许控制器指示,只要页面 URL 与“search/:query”匹配,就会使用查询调用 doSearch 函数。例如,如果页面 URL 当前为 http://myapp.com/#searches/abc123,则将使用“abc123”调用 doSearch。如果页面 URL 稍后变为“#searches/sencha”,则再次使用“sencha”调用 doSearch。
在 Sencha Touch 2 中,控制器获得了新功能,其中最强大的是 refs 和 control。有关更多信息,请参阅 控制器指南。
一旦您迁移了所有内容并更新了所有代码,以便不再有控制台警告,您的应用程序应该在很大程度上可以正常工作。对于任何特定问题,获得帮助的最佳场所是 Sencha Touch 2 论坛。