本文档由项目中的 wb-debug.js 自动提取。每个条目包含源码提炼的使用说明、优先采用源码示例的用法示例,以及完整 JSDoc 供参数和行为核对。
Wb.toLine
Wb.toLine(text, ellipsisLength);源码:wb-debug.js:4239
使用说明
把文本转换成单行,使用此函数将替换文本中的换行符为空格。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.toLine(
"示例值",
/* ellipsisLength */ undefined
);源码注释
/**
* 把文本转换成单行,使用此函数将替换文本中的换行符为空格。
* @param {String} text 需要替换的文本。
* @param {Number} [ellipsisLength] 是否生成缩略文本,如果此值大于0将生成不大于该长度的缩略文本。
* @return {String} 生成的单行文本。
*/Wb.numValidator
Wb.numValidator(precision, scale);源码:wb-debug.js:4254
使用说明
获取指定位数和小数位数的数字验证函数。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.numValidator(
0,
0
);源码注释
/**
* 获取指定位数和小数位数的数字验证函数。
* @param {Number} precision 数字总长度。
* @param {Number} [scale] 小数位数,默认为0。
* @return {Function} 验证函数。
*/Wb.strToDate
Wb.strToDate(string);源码:wb-debug.js:4277
使用说明
把标准格式的字符串转换成日期类型。标准格式指字符串必须符合Y-m-d H:i:s或Y-m-d H:i:s.u的格式。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.strToDate("示例值");源码注释
/**
* 把标准格式的字符串转换成日期类型。标准格式指字符串必须符合Y-m-d H:i:s或Y-m-d H:i:s.u的格式。
* @param {String} string 需要转换为日期类型的字符串。
* @return {Date} 转换后的日期。如果string为空或格式无效返回undefined。
*/Wb.dateToStr
Wb.dateToStr(date);源码:wb-debug.js:4290
使用说明
把日期转换成标准格式的字符串。标准格式指Y-m-d H:i:s.u的格式。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.dateToStr(new Date());源码注释
/**
* 把日期转换成标准格式的字符串。标准格式指Y-m-d H:i:s.u的格式。
* @param {Date} date 需要转换为字符类型的日期。
* @return {String} 转换后的字符串。
*/Wb.dateToText
Wb.dateToText(date, timePart);源码:wb-debug.js:4300
使用说明
把日期转换成可阅读的文本格式。转换的格式可受客户端使用的区域不同而不同。 undefined如果时间部分为00:00:00.000则只显示日期部分否则显示日期和时间。默认为undefined。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.dateToText(
new Date(),
/* timePart */ undefined
);源码注释
/**
* 把日期转换成可阅读的文本格式。转换的格式可受客户端使用的区域不同而不同。
* @param {Date} date 需要转换为字符类型的日期。
* @param {Boolean} [timePart] 是否显示时间部分。true只显示时间部分,false只显示日期部分,null显示日期和时间,
* undefined如果时间部分为00:00:00.000则只显示日期部分否则显示日期和时间。默认为undefined。
* @return {String} 转换后的字符串。
*/Wb.kv
Wb.kv(value, items);源码:wb-debug.js:4332
使用说明
把指定键名转换成对应的值。如果没有找到指定键名返回空串。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.kv(
/* value */ undefined,
[]
);源码注释
/**
* 把指定键名转换成对应的值。如果没有找到指定键名返回空串。
* @param {Object} K 键名。
* @param {Array} items 键值对应项列表。
* @return {String} 键名对应的值或空串。
*/Wb.kvRenderer
Wb.kvRenderer(value, r);源码:wb-debug.js:4339
使用说明
用于显示键值的Renderer。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.kvRenderer(
/* value */ undefined,
/* r */ undefined
);源码注释
/**
* 用于显示键值的Renderer。
*/Wb.format
Wb.format(param);源码:wb-debug.js:4356
使用说明
对指定类型的数据进行格式化。可格式化的数据包括日期,数字和字符串。关于此方法的说明分别见Ext.Date.format, Ext.util.Format.number和Ext.String.format。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.format(/* param */ undefined);源码注释
/**
* 对指定类型的数据进行格式化。可格式化的数据包括日期,数字和字符串。关于此方法的说明分别见Ext.Date.format,
* Ext.util.Format.number和Ext.String.format。
* @param {Object} param 需要格式化的值。
* @return {String} 格式化后的字符串。
*/Wb.getTag
Wb.getTag(object, tagName);源码:wb-debug.js:4370
使用说明
获取Store返回原始数据的附加属性。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.getTag(
app.object,
/* tagName */ undefined
);源码注释
/**
* 获取Store返回原始数据的附加属性。
* @param {Ext.grid.Panel/Ext.data.Store} object 表格或store对象。
* @param {String} tagName 属性名称。
* @return {Object} 获取的属性值。
*/Wb.getColumns
Wb.getColumns(object);源码:wb-debug.js:4379
使用说明
获取store返回的原始columns列表。该值取自store.proxy.reader.rawData.columns属性。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.getColumns(app.object);源码注释
/**
* 获取store返回的原始columns列表。该值取自store.proxy.reader.rawData.columns属性。
* @param {Ext.grid.Panel/Ext.data.Store} object 表格或store对象。
* @return {Array} 原始列组成的数组。
*/Wb.fetchColumns
Wb.fetchColumns(grid);源码:wb-debug.js:4396
使用说明
获取store返回的columns实例列表。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.fetchColumns(app.grid);源码注释
/**
* 获取store返回的columns实例列表。
* @param {Ext.grid.Panel} grid 表格对象。
* @return {Array} 实例列组成的数组。
*/Wb.getColumn
Wb.getColumn(object, fieldName);源码:wb-debug.js:4411
使用说明
获取表格中指定字段名称所在列对象。如果表格列对象未生成,列取自store.proxy.reader.rawData.columns属性。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.getColumn(
app.object,
"示例值"
);源码注释
/**
* 获取表格中指定字段名称所在列对象。如果表格列对象未生成,列取自store.proxy.reader.rawData.columns属性。
* @param {Ext.grid.Panel/Ext.data.Store} object 表格或store对象。
* @param {String/Number} fieldName 字段名称或索引号。
* @return {Object} 列对象。如果没有找到返回null。
*/Wb.loadColumns
Wb.loadColumns(object, reload);源码:wb-debug.js:4425
使用说明
加载表格关联的列。列数据来自表格关联的store.proxy.reader.rawData.columns属性。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.loadColumns(
app.object,
true
);源码注释
/**
* 加载表格关联的列。列数据来自表格关联的store.proxy.reader.rawData.columns属性。
* @param {Ext.grid.Panel/Ext.data.Store} object 表格或store对象。
* @param {Boolean} reload 是否刷新列。如果false当只有表格列为空时加载,否则每次都刷新列。默认为false。
*/Wb.autoLoadColumns
Wb.autoLoadColumns(grid);源码:wb-debug.js:4454
使用说明
表格自动加载列接口方法。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.autoLoadColumns(app.grid);源码注释
/**
* 表格自动加载列接口方法。
* @param {Ext.grid.Panel} grid 表格对象。
*/Wb.timeRenderer
Wb.timeRenderer(value);源码:wb-debug.js:4475
使用说明
时间类型显示函数,仅显示日期类型的时间部分。参数说明见column的renderer属性。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.timeRenderer(/* value */ undefined);源码注释
/**
* 时间类型显示函数,仅显示日期类型的时间部分。参数说明见column的renderer属性。
* @return {String} 时间部分文本。
*/Wb.blobRenderer
Wb.blobRenderer(value, b, c, rowIndex, colIndex);源码:wb-debug.js:4481
使用说明
二进制字段的显示函数。提供二进制字段的上传、下载和清空功能。参数说明见column的renderer属性。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.blobRenderer(
/* value */ undefined,
/* b */ undefined,
/* c */ undefined,
0,
0
);源码注释
/**
* 二进制字段的显示函数。提供二进制字段的上传、下载和清空功能。参数说明见column的renderer属性。
*/Wb.getIcon
Wb.getIcon(iconCls, title);源码:wb-debug.js:4522
使用说明
生成指定图标样式的图标HTML脚本。该脚本通常可用于表格、树、下拉框、HTML等。
用法示例
以下示例直接取自源码注释。
return Wb.getIcon('user_icon', '用户') + value; //应用于Column的renderer配置项源码注释
/**
* 生成指定图标样式的图标HTML脚本。该脚本通常可用于表格、树、下拉框、HTML等。
*
* Example:
*
* return Wb.getIcon('user_icon', '用户') + value; //应用于Column的renderer配置项
*
* @param {String} iconCls 图标样式。
* @param {String} [title] 图标提示文本。
* @return {String} HTML脚本。
*/Wb.getUrlIcon
Wb.getUrlIcon(url, title);源码:wb-debug.js:4540
使用说明
生成指定图标样式的图标HTML脚本。该脚本通常可用于表格、树、下拉框、HTML等。
用法示例
以下示例直接取自源码注释。
return Wb.getIcon('user_icon', '用户') + value; //应用于Column的renderer配置项源码注释
/**
* 生成指定图标样式的图标HTML脚本。该脚本通常可用于表格、树、下拉框、HTML等。
*
* Example:
*
* return Wb.getIcon('user_icon', '用户') + value; //应用于Column的renderer配置项
*
* @param {String} iconCls 图标样式。
* @param {String} [title] 图标提示文本。
* @return {String} HTML脚本。
*/Wb.call
Wb.call(componentId, methodName, params);源码:wb-debug.js:4553
使用说明
通过指定对象id和方法名称来调用指定对象的指定方法。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.call(
/* componentId */ undefined,
"示例值",
{ /* 参数或数据 */ }
);源码注释
/**
* 通过指定对象id和方法名称来调用指定对象的指定方法。
* @param {String} componentId 对象id。
* @param {String} methodName 方法名称。
* @param {Object...} params 方法调用的参数列表。
*/Wb.invoke
Wb.invoke(dom);源码:wb-debug.js:4562
使用说明
调用dom所在对象关联appScope内指定名称的方法,方法名称由dom组件method属性指定,关联组件的样式由cls属性指定,默认为x-grid。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.invoke(app.dom);源码注释
/**
* 调用dom所在对象关联appScope内指定名称的方法,方法名称由dom组件method属性指定,关联组件的样式由cls属性指定,默认为x-grid。
* @param {DOM} dom 关联的dom对象。
* @param {Object...} params 方法调用的参数列表。
*/Wb.setBox
Wb.setBox(source, dest);源码:wb-debug.js:4575
使用说明
根据源控件大小和位置,设置目标控件大小和位置。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.setBox(
app.source,
app.dest
);源码注释
/**
* 根据源控件大小和位置,设置目标控件大小和位置。
* @param {Component} source 源控件。
* @param {Component} dest 目标控件。
* @return {Boolean} 如果已经更改目标位置返回true,否则返回false。
*/Wb.find
Wb.find(component, name, value);源码:wb-debug.js:4620
使用说明
在指定对象中查找名称和值匹配的项。
用法示例
以下示例直接取自源码注释。
var index = Wb.find(store, 'name', value);
var item = Wb.find([{a: 123}, {a: 'abc'}], 'a', 'abc');
var item = Wb.find(records, fieldName, value);源码注释
/**
* 在指定对象中查找名称和值匹配的项。
*
* Example:
*
* var index = Wb.find(store, 'name', value);
*
* var item = Wb.find([{a: 123}, {a: 'abc'}], 'a', 'abc');
*
* var item = Wb.find(records, fieldName, value);
*
* @param {Mixed} component 查找的对象。
* @param {String} name 查找的名称。
* @param {Object} value 查找的值。
* @return {Object} 查找到的项。如果没有找到返回null。
*/Wb.namePart
Wb.namePart(string);源码:wb-debug.js:4653
使用说明
获取字符串中的名称部分。名称部分为第一个“=”符号前的字符串。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.namePart("示例值");源码注释
/**
* 获取字符串中的名称部分。名称部分为第一个“=”符号前的字符串。
* @param {String} string 需要获取名称的字符串。
* @return {String} 名称部分字符串。如果字符串中没有“=”,将返回整个字符串。
*/Wb.valuePart
Wb.valuePart(string);源码:wb-debug.js:4667
使用说明
获取字符串中的值部分。值部分为第一个“=”符号后的字符串。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.valuePart("示例值");源码注释
/**
* 获取字符串中的值部分。值部分为第一个“=”符号后的字符串。
* @param {String} string 需要获取值的字符串。
* @return {String} 值部分字符串。如果字符串中没有“=”,将返回空串。
*/Wb.getSelText
Wb.getSelText();源码:wb-debug.js:4680
使用说明
获取文档中选择的文本内容。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.getSelText();源码注释
/**
* 获取文档中选择的文本内容。
* @return {String} 选择的文本内容。
*/Wb.pluck
Wb.pluck(records, name);源码:wb-debug.js:4693
使用说明
获取记录集指定属性值组成的数组。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.pluck(
[],
"示例值"
);源码注释
/**
* 获取记录集指定属性值组成的数组。
* @param {Ext.data.Model[]} records 记录集。
* @param {String} name 属性名称。
* @return {Array} 值组成的数组。
*/Wb.clearSelText
Wb.clearSelText();源码:wb-debug.js:4703
使用说明
清除浏览器中所有选择的文本。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.clearSelText();源码注释
/**
* 清除浏览器中所有选择的文本。
*/Wb.monEnter
Wb.monEnter(panel, fn);源码:wb-debug.js:4715
使用说明
监听面板按回车键,如果面板按回车键将执行指定方法。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.monEnter(
app.panel,
function () {
// 处理结果
}
);源码注释
/**
* 监听面板按回车键,如果面板按回车键将执行指定方法。
* @param {Panel} panel 面板对象,事件将添加到该面板。
* @param {Function} fn 当面板上按回车键时执行的方法。
*/Wb.isEditor
Wb.isEditor(dom);源码:wb-debug.js:4733
使用说明
判断指定DOM对象是否是可编辑的控件。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.isEditor(app.dom);源码注释
/**
* 判断指定DOM对象是否是可编辑的控件。
* @param {DOM} dom 需要判断的dom对象。
* @return {Boolean} true可编辑的控件,false不可编辑的控件。
*/Wb.setCookie
Wb.setCookie(name, value);源码:wb-debug.js:4741
使用说明
设置指定名称和值的Cookie。Cookie保留时长为1个月。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.setCookie(
"示例值",
/* value */ undefined
);源码注释
/**
* 设置指定名称和值的Cookie。Cookie保留时长为1个月。
* @param {String} name Cookie名称。
* @param {Object} value Cookie值。
*/Wb.getCookie
Wb.getCookie(name);源码:wb-debug.js:4749
使用说明
获取指定名称的cookie。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.getCookie("示例值");源码注释
/**
* 获取指定名称的cookie。
* @param {String} name Cookie名称。
* @return {Object} 获取的Cookie值。
*/Wb.setChecked
Wb.setChecked(node, checked, tree, ignoreBox);源码:wb-debug.js:4759
使用说明
高效设置节点选择框是否选择,如果节点被选择节点文字使用蓝色高亮,如果节点未被选择节点文字使用灰色加删除线样式。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.setChecked(
/* node */ undefined,
true,
app.tree,
/* ignoreBox */ undefined
);源码注释
/**
* 高效设置节点选择框是否选择,如果节点被选择节点文字使用蓝色高亮,如果节点未被选择节点文字使用灰色加删除线样式。
* @param {NodeInterface} node 节点。
* @param {Boolean} checked 选择状态。如果为null选择框不选中,文字不加样式。
* @param {TreePanel} tree 树控件对象。
* @param {Boolean} [ignoreBox] 是否不处理节点前的复选框,默认为false。
*/Wb.show
Wb.show(config);源码:wb-debug.js:4785
使用说明
创建指定对象实例并显示。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.show({ /* 配置项 */ });源码注释
/**
* 创建指定对象实例并显示。
* @param {Object} config 实例配置对象。
* @return {Component} 实例对象。
*/Wb.sort
Wb.sort(array, itemName, useLocale);源码:wb-debug.js:4797
使用说明
对指定数组进行正向非区分大小写的排序。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.sort(
/* array */ undefined,
/* itemName */ undefined,
true
);源码注释
/**
* 对指定数组进行正向非区分大小写的排序。
* @param {Array} array 需要排序的数组。排序结果将影响数组。
* @param {String} [itemName] 如果指定该值,表示比较对象中的该名称值。
* @param {Boolean} [useLocale] 是否使用本地方法localeCompare比较,默认为true。
* @return {Array} 排序后的数组本身。
*/Wb.bindChange
Wb.bindChange(grid, changeEvent);源码:wb-debug.js:4826
使用说明
绑定grid/store的所有列编辑器的change事件和对应store的添加/删除事件至指定事件。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.bindChange(
app.grid,
/* changeEvent */ undefined
);源码注释
/**
* 绑定grid/store的所有列编辑器的change事件和对应store的添加/删除事件至指定事件。
* @param {Ext.grid.Panel/Ext.data.Store} object 表格或store对象。
* @param {Function} changeEvent 绑定的change事件。
*/Wb.setDisabled
Wb.setDisabled(items, disabled);源码:wb-debug.js:4850
使用说明
对参数列表中的所有控件设置禁用状态。
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.setDisabled(
[],
true
);源码注释
/**
* 对参数列表中的所有控件设置禁用状态。
* @param {Component/Component[]} items 控件列表或单个控件。
* @param {Boolean} disabled 是否禁用。
*/Wb.setReadOnly
Wb.setReadOnly(items, readOnly);源码:wb-debug.js:4865
使用说明
对参数列表中的所有控件设置只读状态。 Mountain 2017-12-11 10:39:29 @qiaoyi
用法示例
以下为最小调用模板;请将 app.*、示例值和地址替换为当前页面的实际对象。
Wb.setReadOnly(
[],
true
);源码注释
/**
* 对参数列表中的所有控件设置只读状态。
* @param {Component/Component[]} items 控件列表或单个控件。
* @param {Boolean} disabled 是否禁用。
* Mountain 2017-12-11 10:39:29 @qiaoyi
*/