配置函数
许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称被称为 别名（如果类扩展了 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，则标记为可阻止的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息，请参阅 singleton 标志
- 组件类型框架类（Ext JS 框架中扩展 Ext.Component 的任何类）
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config 的类成员
- 表示类型为 property 的类成员
- 表示类型为 method 的类成员
- 表示类型为 event 的类成员
- 表示类型为 theme variable 的类成员
- 表示类型为 theme mixin 的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上的类名称正下方是一行按钮，对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数（此计数在应用过滤器时会更新）。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单，以便快速导航。
与类配置选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中，紧挨着它们所使用的配置下方。getter 和 setter 方法文档将在配置行中找到，以便于参考。
您的页面历史记录保存在本地存储中，并显示在顶部标题栏正下方（使用可用的实际空间）。默认情况下，显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中，您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择了“全部”，则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后，每个历史页面的产品/版本将在历史记录栏中的页面名称旁边显示。将光标悬停在历史记录栏中的页面名称上也会以工具提示的形式显示产品/版本。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上，还有一个过滤器输入字段，用于使用过滤器字符串过滤成员行。除了按字符串过滤外，您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索，以便快速导航。
每个 API 文档页面（JavaScript 原始页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button 类具有 Ext.Button 的备用类名称）。备用类名称通常为了向后兼容性而维护。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名称来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
主题配置语法参考。
主题配置的某些部分可能是配置中其他值的派生值。与其手动计算这些值，不如使用 util 包中提供的几个配置函数。util 包提供了便捷函数，可以在主题构建期间预先计算主题中的值，而不是影响任何运行时性能。
按 scale 量使给定的渐变数据结构变暗
| 名称 | 描述 |
|---|---|
| gradientDetails | 要变暗的 渐变结构 |
| scale | 一个双精度值，表示要变暗的百分比。例如：0.2 将使颜色变暗 20% |
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
inactiveGradientDetails = util.darkenGradient(activeGradientDetails, 0.2)
上面的示例将评估为以下内容
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
inactiveGradientDetails {
stops = [
"#18457a 0%",
"#206dac 50%",
"#1963a1 51%",
"#6494b9 100%"
]
}
按 scale 量使渐变数据结构变亮。有关如何使用它的详细信息，请参阅上面的 darkenGradient。
从指定的颜色创建单色渐变的便捷方法。返回 渐变数据结构。
| 名称 | 描述 |
|---|---|
| colorString | 用于构建纯色渐变对象的十六进制颜色 |
从指定的颜色创建单色渐变的便捷方法。返回渐变字符串，适用于 CSS。
| 名称 | 描述 |
|---|---|
| colorString | 用于构建纯色渐变字符串的十六进制颜色 |
按 scale 量使十六进制颜色字符串变暗。
| 名称 | 描述 |
|---|---|
| colorString | 要变暗的十六进制颜色 |
| scale | 一个双精度值，表示要变暗的百分比。例如：0.2 将使颜色变暗 20%。 |
textColor = "#1e5799"
inactiveTextColor = util.darkenColor(textColor, 0.2)
上面的示例将评估为以下内容
textColor = "#1e5799"
inactiveTextColor = "#6494b9"
按 scale 量使十六进制颜色字符串变亮。
| 名称 | 描述 |
|---|---|
| colorString | 要变亮的十六进制颜色 |
| scale | 一个双精度值，表示要变亮的百分比。例如：0.2 将使颜色变亮 20%。 |
textColor = "#1e5799"
overTextColor = util.lightenColor(textColor, 0.2)
上面的示例将评估为以下内容
textColor = "#1e5799"
overTextColor = "#4b78ad"
使用可选的 ratio 混合两种十六进制颜色。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| color1 | 要混合的第一个十六进制字符串颜色 | ||
| color2 | 要混合的第二个十六进制字符串颜色 | ||
| ratio | 混合比例 | 0.5 |
red = "#ff0000"
blue = "#0000ff"
eggplant = util.mixColors(red, blue)
lipstick = util.mixColors(red, blue, 0.3)
purple = util.mixColors(red, blue, 0.7)
上面的示例将评估为以下内容
red = "#ff0000"
blue = "#0000ff"
eggplant = "#7f007f"
lipstick = "#b2004c"
purple = "#4c00b2"
将渐变数据结构转换为 CSS 友好的字符串。
| 名称 | 描述 |
|---|---|
| gradientDetails | 渐变数据结构 |
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
activeGradient = util.gradientString(activeGradientDetails)
上面的示例将评估为以下内容
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
activeGradient = "#1e5799 0%, #2989d8 50%, #207cca 51%, #7db9e8 100%"
返回渐变数据结构的最后一个停止颜色。如果渐变需要融入背景，则很有用。
| 名称 | 描述 |
|---|---|
| gradientDetails | 渐变数据结构 |
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
panelBackgroundColor = util.lastStopColor(activeGradientDetails)
上面的示例将评估为以下内容
activeGradientDetails {
stops = [
"#1e5799 0%",
"#2989d8 50%",
"#207cca 51%",
"#7db9e8 100%"
]
}
panelBackgroundColor = "#7db9e8"
将颜色名称转换为其十六进制表示形式。当需要在样式中使用命名颜色时很有用。
| 名称 | 描述 |
|---|---|
| name | 要转换为十六进制字符串的颜色名称 |
red = util.colorNameToHex('red')
blue = util.colorNameToHex('blue')
aliceblue = util.colorNameToHex('aliceblue')
上面的示例将评估为以下内容
red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"
将 RGB 颜色值转换为十六进制字符串。
| 名称 | 描述 |
|---|---|
| red | 颜色的红色值，范围为 0-255 |
| green | 颜色的绿色值，范围为 0-255 |
| blue | 颜色的蓝色值，范围为 0-255 |
red = util.rgbToHex(255, 0, 0)
blue = util.rgbToHex(0, 0, 255)
aliceblue = util.rgbToHex(240, 248, 255)
上面的示例将评估为以下内容
red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"
用于在一行中分配所有边距详细信息的辅助函数。第一个参数之后的所有参数都是可选的，遵循 CSS 样式的边距值。所有值均以像素为单位。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| 顶部 | 要应用于元素/小部件顶部的边距（以像素为单位） | ||
| right | 要应用于元素/小部件右侧的边距（以像素为单位） | 顶部 |
|
| bottom | 要应用于元素/小部件底部的边距（以像素为单位） | 顶部 |
|
| left | 要应用于元素/小部件左侧的边距（以像素为单位） | right |
buttonMargin = util.margin(0, 3, 0, 2)
上面的示例将评估为以下内容
buttonMargin {
top = 0
right = 3
bottom = 0
left = 2
}
info {
//...
margin = util.margin(2, 0)
//...
}
上面的示例将评估为
info {
//...
margin {
top = 2
right = 0
bottom = 2
left = 0
}
//...
}
用于在一行中分配所有内边距详细信息的辅助函数。第一个参数之后的所有参数都是可选的，遵循 CSS 样式的内边距值。所有值均以像素为单位。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| 顶部 | 要应用于元素/小部件顶部的内边距（以像素为单位） | ||
| right | 要应用于元素/小部件右侧的内边距（以像素为单位） | 顶部 |
|
| bottom | 要应用于元素/小部件底部的内边距（以像素为单位） | 顶部 |
|
| left | 要应用于元素/小部件左侧的内边距（以像素为单位） | right |
与 util.margin 的用法相同
用于在一行中分配所有边框详细信息的辅助函数。第一个参数之后的所有参数都是可选的，尽管对于可见边框，至少应指定前三个参数。请注意，并非所有边框都使用此边框对象进行管理，因为在某些情况下，需要单独描述和管理不同的详细信息。边框粗细值是整数，被视为像素。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| style | 要使用的边框样式，使用 border-style 的合法值，例如 none、solid、dashed 等 |
||
| color | 要使用的边框的 css 颜色 | "#000000" |
|
| 顶部 | 顶部边框的粗细。 | 0 |
|
| right | 右侧边框的粗细 | 顶部 |
|
| bottom | 底部边框的粗细 | 顶部 |
|
| left | 左侧边框的粗细 | right |
无边框
border = util.border('none')
所有侧面的实心蓝色边框
border = util.border('solid', '#0000ff', 1)
这将评估为
border {
style = 'solid'
color = '#0000ff'
top = 1
right = 1
bottom = 1
left = 1
}
返回给定数字的绝对值
返回传入的两个数字中较小的一个
返回传入的两个数字中较大的一个
创建一个新对象，其中包含第一个参数的所有值，并覆盖第二个参数中指定的任何属性。
| 名称 | 描述 |
|---|---|
| originalObject | 要克隆然后修改的对象。这通常是对配置中已声明的现有对象的引用 |
| additionalProperties | 应在新创建的对象中覆盖的属性 |
dayText = util.fontStyle('helvetica,arial,verdana,sans-serif', '13px', '#000000')
dayDisabledText = util.extend(dayText, {
color = '#808080'
})
这将评估为
dayText {
family = 'helvetica,arial,verdana,sans-serif'
size = '13px'
color = '#000000'
weight = 'normal'
}
dayDisabledText {
family = 'helvetica,arial,verdana,sans-serif'
size = '13px'
color = '#808080'
weight = 'normal'
}
用于在一行中声明文本样式的辅助函数。仅第一个参数是必需的。与 themer 采用的大多数其他尺寸不同，字体大小被视为字符串，以支持各种可能的 CSS font-size 值。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| family | 要使用的字体系列。任何有效的 CSS font-family 值在此处都是合法的。 |
||
| size | 要使用的字体大小。任何有效的 CSS font-size 值在此处都是合法的。 |
"medium" |
|
| color | 要使用的文本颜色。任何有效的 CSS 颜色在此处都是合法的。 | "#000000" |
|
| weight | 要使用的字体粗细。任何有效的 CSS font-weight 值在此处都是合法的 |
"normal" |
实用程序方法，用于帮助协调 CSS3 和切片外观之间的布局差异。为了保持内边距和外边距值的一致应用，此值使我们能够确保 CSS3 实现将具有与切片版本相同的大小。
| 名称 | 描述 |
|---|---|
| borderObject | 边框对象，例如 util.border 将返回的对象 |
| radius | 一个整数，指定相关角上的边框半径 |
接受颜色和可选的缩放值，并返回一个光泽渐变字符串。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| base | 要开始使用的初始颜色。 | ||
| scale | 将基色拉伸到渐变中时要使用的可选值 | 0.15 |
util.glossyGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15
接受颜色和可选的缩放值，并返回一个斜面渐变字符串。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| base | 要开始使用的初始颜色。 | ||
| scale | 将基色拉伸到渐变中时要使用的可选值 | 0.15 |
util.bevelGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15
接受颜色和可选的缩放值，并返回一个凹陷渐变字符串。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| base | 要开始使用的初始颜色。 | ||
| scale | 将基色拉伸到渐变中时要使用的可选值 | 0.5 |
util.recessedGradient('#157FCC')
接受颜色和可选的缩放值，并返回一个亚光渐变字符串。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| base | 要开始使用的初始颜色。 | ||
| scale | 将基色拉伸到渐变中时要使用的可选值 | 0.04 |
util.matteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.03
接受颜色和可选的缩放值，并返回一个反向亚光渐变字符串。
| 名称 | 描述 | 默认值 | |
|---|---|---|---|
| base | 要开始使用的初始颜色。 | ||
| scale | 将基色拉伸到渐变中时要使用的可选值 | 0.06 |
util.reversedMatteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.06
GXT | 使用条款