文档帮助

内容

术语、图标和标签访问级别成员类型成员语法成员标记类图标成员图标导航和功能类成员快速导航菜单获取器和设置器方法历史记录栏搜索和过滤器 API 文档类元数据展开和折叠示例和类成员桌面 -vs- 移动视图查看类源

术语、图标和标签

许多类在使用配置对象创建（实例化）类时具有快捷名称。快捷名称称为别名（如果类扩展 Ext.Component，则称为xtype）。别名/xtype 列在适用类的类名旁边，以便快速参考。

访问级别

框架类或其成员可以指定为私有或受保护。否则，类/成员为公有。公有、受保护和私有是用于传达如何以及何时使用类或类成员的访问描述符。

公有类和类成员可供任何其他类或应用程序代码使用，并且可以依赖它们在主要产品版本中保持稳定和持久。公有类和成员可以通过子类安全地进行扩展。
受保护类成员是稳定的公有成员，旨在由拥有类或其子类使用。受保护成员可以通过子类安全地进行扩展。
私有类和类成员由框架内部使用，不打算由应用程序开发人员使用。私有类和成员可能会在任何时候更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖它们。

成员类型

配置 - 类的配置选项。
属性 - 类实例化后设置一次。*参见下文的只读。
方法 - 类可以执行的操作。方法应作为实例方法读取，只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边有一个静态标签。*参见下文的静态。
事件 - 事件特定于框架事件系统，允许类以编程方式引发事件，由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但不会在 API 文档中专门描述。*对于 DOM 事件，请参阅 MDN 的事件参考页面。
主题变量 - 框架采用的可视化主题引擎使用的变量。
主题混合 - 框架采用的可视化主题引擎使用的函数，并且可以使用在各种主题变量中设置的值。

成员语法

下面是一个示例类成员，我们可以对其进行分析以显示类成员的语法（在本例中，从 Ext.button.Button 类中查看的 lookupComponent 方法）。

Ext.container.Container

查看源

lookupComponent ( item ) : Ext.Component

受保护

在初始化items配置期间将原始配置对象添加到此容器时，或者添加新项目时（added），或者{@link #insert inserted}时调用。

此方法将传递的对象转换为实例化子组件。

当需要对子创建应用特殊处理时，可以在子类中覆盖此方法。

参数

项目：对象

要添加的配置对象。

Ext.Component

要添加的组件。

我们来看一下成员行中的每一部分

展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（在本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法的参数）将在括号内列在方法名称旁边（在本例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 JavaScript 对象（在本例中为 Ext.Component）。对于不返回 undefined 的方法，可以省略此项，或者可能显示由正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，则方法可能返回一个组件，如果失败则返回 false，显示为 Ext.Component/Boolean）。
标志 - 接下来将显示适用于成员的任何标志（在本例中为 PROTECTED - 请参阅下面的标志部分）
成员来源 - 在成员行的右侧是最初描述成员的类（在本例中为 Ext.container.Container）。如果成员来自当前类，则源类将显示为蓝色链接；如果成员是从祖先或混合类继承的，则显示为灰色。
成员源 - 在成员来源类下方的右侧是一个查看成员源的链接（在本例中为 查看源）
参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述（在本例中为 item : Object）列出。
返回 - 如果类返回的值不为 undefined，则“返回”部分将记录返回的类或对象类型以及描述（在本例中为 Ext.Component）
自（示例中未显示） - 某些成员将在成员描述之后显示该成员首次引入的产品版本（即 自 3.4.0 起可用 - 示例中未显示）
默认（示例中未显示） - 配置通常显示要应用于类实例的默认配置值，如果未覆盖（即 默认为：false）

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

必需 - 实例化类时的必需配置
可绑定 - 配置具有一个 setter，允许通过 ViewModel 绑定设置此配置
只读 - 可以读取该属性，但不能用于在运行时配置/重新配置类实例
单例 - 单例类在定义后立即实例化，并且不能手动实例化
静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
可链式 - 指在调用时返回类实例的方法。
这支持链式方法调用，例如：classInstance.method1().method2().etc();
已弃用 - 计划在未来框架版本中删除的类或成员，并且在当前版本中提供以保持向后兼容性。
已弃用的类和成员将有一条消息，指导你使用首选的类/方法。
已删除 - 仅在文档中作为框架版本之间升级的用户参考而存在的已删除类或成员
模板 - 在基类中定义的方法，旨在由子类覆盖
抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构，并提供有限的代码（如果有的话）。类特定的代码将通过子类中的覆盖来提供。
可预防 - 如果从事件处理程序返回 false，则标记为可预防的事件将不会触发

类图标

- 表示框架类

- 单例框架类。*有关更多信息，请参阅单例标志

- 组件类型框架类（Ext JS 框架中任何扩展 Ext.Component 的类）

- 表示当前查看版本中的类、成员或指南是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示当前查看版本中的类、成员或指南是新的

在 API 文档页面上的类名正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮显示按类型划分的成员数（此计数在应用筛选器时更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单，其中包含所有该类型的成员，以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中，它们位于其使用的配置正下方。Getter 和 Setter 方法文档将位于配置行中，以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中，并显示在顶部标题栏正下方（使用可用空间）。默认情况下，仅显示与您当前正在查看的产品/版本匹配的搜索结果。您可以通过单击历史记录栏右侧的按钮并选择“全部”单选按钮来扩展显示内容。这将显示历史记录栏中所有产品/版本的所有近期页面。

在历史记录配置菜单中，您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮进行筛选。单击按钮将清除历史记录栏以及保存在本地存储中的历史记录。

如果在历史记录配置菜单中选择了“全部”，则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后，每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也将以工具提示的形式显示产品/版本。

搜索和筛选器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上，还有一个筛选器输入字段，它使用筛选器字符串筛选成员行。除了按字符串筛选外，您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框筛选类列表以包含或排除私有类。

单击空的搜索字段将显示您最近的 10 次搜索，以便快速导航。

API 文档类元数据

每个 API 文档页面（除了 JavaScript 原语页面）都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

备用名称 - 一个或多个其他类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类有一个备用类名 Ext.Button）。备用类名通常用于向后兼容。
层次结构 - 层次结构视图列出了当前类的继承链，从其祖先类到根基类。
混合 - 混合到当前类的类列表
继承的混合 - 混合到当前类祖先的类列表
必需 - 实例化类所需的已定义的所有类
用途 - 类在其生命周期中的某个时刻可能使用的类列表，但对于类的初始实例化来说并非必需
子类 - 扩展当前类的类

展开和折叠示例和类成员

默认情况下，可运行示例（小提琴）在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

默认情况下，类成员在页面上折叠。您可以使用成员行左侧的箭头图标展开和折叠成员，或全局使用右上角的展开/折叠所有切换按钮。

桌面 -vs- 移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸因素进行优化的视图。桌面视图和“移动”视图之间的主要区别是

全局导航将位于左侧菜单中，可通过汉堡包菜单图标访问。菜单包含以下内容（在大多数页面上）
- 当前产品名称（作为到产品登录页面的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- （API 文档）带成员筛选器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别筛选器复选框和每个成员计数的“筛选器”选项卡
- （API 文档）包含与当前类相关的元数据菜单的“相关类”选项卡
- （指南）指南的目录

查看类源

可以通过单击 API 文档页面顶部的类名称来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。

Sencha Touch 2.4

显示私有类

顶部

内容

简介和 HBox VBox 布局卡片布局适合布局对接打包和对齐 (HBox) 打包和对齐 (VBox) 进一步阅读

在 Sencha Touch 中使用布局

Sencha Touch 2 中的布局简介来自 Sencha 在 Vimeo 上。

简介和 HBox

布局描述了应用程序中组件的大小和位置。例如，电子邮件客户端可能有一个固定在左侧的消息列表，占用可用宽度的三分之一，以及屏幕其余部分的消息查看面板。

我们可以使用 hbox 布局及其在其中“flex”项的能力来实现这一点。弹性意味着我们根据每个子组件的flex来划分可用区域，因此为了实现上面的示例，我们可以设置 flex，如下面的图像所示

在此布局的代码中，我们需要在任何容器上指定“hbox”布局，然后为每个子组件（本例中为面板）提供 flex 参数，如下所示

Ext.create('Ext.Container', {
    fullscreen: true,
    layout: 'hbox',
    items: [
        {
            xtype: 'panel',
            html: 'message list',
            flex: 1
        },
        {
            xtype: 'panel',
            html: 'message preview',
            flex: 2
        }
    ]
});

这将创建一个填充屏幕的容器，并在其中创建一个消息列表面板和一个预览面板。它们各自的 flex 配置为 1 和 2，这意味着消息列表占据可用宽度的三分之一，预览占据剩余的三分之二。如果我们的容器宽 300 像素，则第一个项目（flex: 1）将宽 100 像素，第二个项目（flex: 2）将宽 200 像素。

hbox 布局是最有用的布局之一，因为它可以将组件排列在各种水平组合中。有关更多示例，请参见Ext.layout.HBox。

VBox 布局

VBox 与 HBox 类似，只是垂直而不是水平。同样，我们可以很容易地将它可视化为一组堆叠的盒子

创建此代码几乎与前面的示例相同，我们只交换了layout: 'hbox'为layout: 'vbox'

Ext.create('Ext.Container', {
    fullscreen: true,
    layout: 'vbox',
    items: [
        {
            xtype: 'panel',
            html: 'message list',
            flex: 1
        },
        {
            xtype: 'panel',
            html: 'message preview',
            flex: 2
        }
    ]
});

如果我们的容器高 300 像素，则第一个面板（flex: 1）将高 100 像素，第二个面板（flex: 2）将高 200 像素。有关更多示例，请参见Ext.layout.VBox。

卡片布局

有时，您希望在小型设备屏幕上显示多个信息屏幕信息。TabPanel 和 Carousel 都使您一次只能看到多个屏幕中的一个屏幕，并且它们在底层都使用卡片布局。

卡片布局采用应用于它的容器的大小，并调整当前活动项的大小，以完全填充容器。然后它会隐藏其余的项，允许您更改当前可见的项，但一次只显示一个

在前面的图像中，灰色框是容器，内部的蓝色框是当前活动的卡片。其他三张卡片从视图中隐藏，但稍后可以换入。虽然直接创建卡片布局并不常见，但您可以按照以下方式进行操作

var panel = Ext.create('Ext.Panel', {
    layout: 'card',
    items: [
        {
            html: "First Item"
        },
        {
            html: "Second Item"
        },
        {
            html: "Third Item"
        },
        {
            html: "Fourth Item"
        }
    ]
});

panel.setActiveItem(1);

在此示例中，我们创建了一个具有卡片布局的面板，然后将第二个项设置为活动项（活动项索引以零为基准，因此 1 对应于第二个项）。但在大多数情况下，您应该使用选项卡面板或走马灯。

适合布局

适合布局可能是最简单的布局。它所做的就是使子组件适合其父容器的全部大小。

例如，如果您有一个 200px x 200px 的父容器，并为其提供一个子组件和一个“适合”布局，则子组件也将为 200px x 200px

var panel = Ext.create('Ext.Panel', {
    width: 200,
    height: 200,
    layout: 'fit',

    items: {
        xtype: 'panel',
        html: 'Also 200px by 200px'
    }
});

Ext.Viewport.add(panel);

请注意，如果您向具有适合布局的容器中添加多个项，则只有第一个项将可见。如果您想在多个项之间切换，请改用卡片布局。

对接

每个布局都能够对接内部的项。对接使您能够将其他组件放置在父容器的顶部、右侧、底部或左侧边缘，根据需要调整其他项的大小。

例如，回到本指南中的第一个 hbox 布局，让我们想象一下我们想要在顶部对接另一个组件，如下面的图像所示

此功能通常用于工具栏和横幅等项，并且使用docked: 'top'配置很容易实现

Ext.create('Ext.Container', {
    fullscreen: true,
    layout: 'hbox',
    items: [
        {
            docked: 'top',
            xtype: 'panel',
            height: 20,
            html: 'This is docked to the top'
        },
        {
            xtype: 'panel',
            html: 'message list',
            flex: 1
        },
        {
            xtype: 'panel',
            html: 'message preview',
            flex: 2
        }
    ]
});

您可以通过简单地在您想要对接的子组件上提供dock配置来添加任意数量的对接项。项也可以对接到任何一侧，例如，如果我们想使用我们之前的 vbox 示例执行此操作

我们可以通过指定docked: 'left'来实现此目的

Ext.create('Ext.Container', {
    fullscreen: true,
    layout: 'vbox',
    items: [
        {
            docked: 'left',
            xtype: 'panel',
            width: 100,
            html: 'This is docked to the left'
        },
        {
            xtype: 'panel',
            html: 'message list',
            flex: 1
        },
        {
            xtype: 'panel',
            html: 'message preview',
            flex: 2
        }
    ]
});

您可以在每侧添加多个对接项（例如，在“底部”位置对接多个项）。

打包和对齐 (HBox)

打包和对齐功能控制子元素在布局中的对齐方式。“打包”是指当前布局的轴，而“对齐”则是相反的。例如，在 HBox 布局中，“打包”是指水平轴，“对齐”是指垂直轴。以下示例说明了差异

展开代码

代码运行

Ext.application({ name : 'Sencha', launch : function() { var container = Ext.create('Ext.Container', { fullscreen: true, layout: { type: 'hbox', align: 'start', pack: 'start' }, items: [{ docked: 'top', xtype: 'titlebar', title: 'HBox 布局' }, { docked: 'top', xtype: 'toolbar', items: [{ xtype: 'container', html: '打包：', style: 'color: #fff; padding: 0 10px; width: 85px;' }, { xtype: 'segmentedbutton', allowDepress: false, items: [{ text: '开始', handler: function() { layout.setPack('start'); }, pressed: true }, { text: '居中', handler: function() { layout.setPack('center'); } }, { text: '结束', handler: function() { layout.setPack('end'); } }] }] }, { docked: 'top', xtype: 'toolbar', items: [{ xtype: 'container', html: '对齐：', style: 'color: #fff; padding: 0 10px; width: 85px;' }, { xtype: 'segmentedbutton', allowDepress: false, items: [{ text: '开始', handler: function() { layout.setAlign('start'); }, pressed: true }, { text: '居中', handler: function() { layout.setAlign('center'); } }, { text: '结束', handler: function() { layout.setAlign('end'); } }, { text: '拉伸', handler: function() { layout.setAlign('stretch'); } }] }] }, { xtype: 'button', text: '按钮 1', margin: 2 }, { xtype: 'button', text: '按钮 2', margin: 2 }, { xtype: 'button', text: '按钮 3', margin: 2 }] }); var layout = container.getLayout(); } });

打包和对齐 (VBox)

展开代码

代码运行

Ext.application({ name : 'Sencha', launch : function() { var container = Ext.create('Ext.Container', { fullscreen: true, layout: { type: 'vbox', align: 'start', pack: 'start' }, items: [{ docked: 'top', xtype: 'titlebar', title: 'VBox 布局' }, { docked: 'top', xtype: 'toolbar', items: [{ xtype: 'container', html: '打包：', style: 'color: #fff; padding: 0 10px; width: 85px;' }, { xtype: 'segmentedbutton', allowDepress: false, items: [{ text: '开始', handler: function() { layout.setPack('start'); }, pressed: true }, { text: '居中', handler: function() { layout.setPack('center'); } }, { text: '结束', handler: function() { layout.setPack('end'); } }] }] }, { docked: 'top', xtype: 'toolbar', items: [{ xtype: 'container', html: '对齐：', style: 'color: #fff; padding: 0 10px; width: 85px;' }, { xtype: 'segmentedbutton', allowDepress: false, items: [{ text: '开始', handler: function() { layout.setAlign('start'); }, pressed: true }, { text: '居中', handler: function() { layout.setAlign('center'); } }, { text: '结束', handler: function() { layout.setAlign('end'); } }, { text: '拉伸', handler: function() { layout.setAlign('stretch'); } }] }] }, { xtype: 'button', text: '按钮 1', margin: 2 }, { xtype: 'button', text: '按钮 2', margin: 2 }, { xtype: 'button', text: '按钮 3', margin: 2 }] }); var layout = container.getLayout(); } });

进一步阅读

布局只是 Sencha Touch 生态系统的一部分。为了更好地理解该框架及其工作原理，我们建议阅读以下指南