// @author 文志新 http://jsfiddle.net/wenyi/47nz7ez9/3/ /**关于插件的通用构造
*
* 构造函数PluginName($trigger,options)传入触发元素和配置项，以便在构造函数中使用触发元素
* 写在$.fn.pluginName外围，通过实例化$ele.data('bootstrap.table',(dat=new BootstrapTable(this,options)));
* 实例写在触发元素的data属性中，以便调用该实例，避免多次创造实例;
* $.fn.pluginName(option)参数是对象，执行构造函数PluginName，产生新的实例;
* 是字符串，调用data对象中存储的实例执行方法，提供PluginName.prototype的方法接口;
* 脱离在构造函数PluginName及其原型中的函数，通过$.fn.pluginName.util暴露接口;
* 构造函数PluginName使用$ele.trigger提供事件接口;
* 配置项可以是html页面data数据配置、或者$.fn.pluginName参数option配置;
* 在html中的配置可以方便使用模板引擎传值实现初始化，后台java使用content.put方法;
* 默认配置项利用js中一切都是对象的特点附着在PluginName.DEFAULTS;
*
* 构造函数渲染页面时，先填充页面内容，再绑定事件;
* 绑定事件通过$ele.off(eventType).on(eventType,function(){})先解绑;
*
* 书写有分支具体情况到主干通用情况，类似先做能力检测，再做浏览器嗅探
* 应用场景，if(){return};抽离分支具体情况，后续代码对主干通用情况进行处理
* 优先检测具体的配置项，其次对自定义配置项、默认配置项作混合处理
* 预先配置子条目的显示情况、数据信息，再次配置父条目的显示情况、配置信息
*
* if语句传递设置的详情变量时，先顺序设置头部，再针对一般情况进行处理，其次设置尾部
* 类似插件作者对分页切换页面按钮的处理，
* 借form、to设置起始页展示情况，再是两串...，最后是尾页的显示情况
*/ /**关于jquery
*
* data:
* $(ele).data()以对象形式返回;
* $(ele).data({url:"www.baidu.com"})以对象形式设置data属性;
* $(ele).data(url,{param:"www.baidu.com"})以对象形式设置某个data属性;
*
* event:
* $.proxy(fn,content)调用的函数fn，传入的上下文content;
* $.Event(eventType,arguments)转化成事件，并传入参数，只可使用一次;
*
* type:
* $.isNumeric()判断变量是否数值型或数字值字符串，包含十六进制等;
* $.isFunction()判断是否为函数;
* $.isEmptyObject()是否为空对象;
* $.isPlainObject()是否为对象字面量;
* $.isArray()是否数组;
* $.type()判断类型;
*
* util:
* $.grep([]/{},function(item,index))过滤出返回值为真的数组;
* $.map([]/{},function(item,index))过滤出以返回值为数组元素的数组;
* $.inArray()返回元素在数组中的位置;
*/ /**bootstap
* 使用caret样式实现三角形;
*/ /**技巧
*
* 使用数组拼接字符串，这样做方便使用三目运算符处理可变的内容;
*
* i<0?[]:{} 三目运算符后跟数组或对象;
*
* 三目运算符以[]包裹，获取对象的属性;
*
* "paramName".split(/(?=[A-Z])/) 返回结果为["param","Name"];
*
* str.replace(/%s/g, function(){}) 对每个匹配值应用函数;
*
* [{i:1},{j:2}].sort(function(a,b){}) a、b为数组元素;
*
* 非字符串数组对象使用toString()方法转换后，再调用localeCompare进行比较;
*
* ~~利用按位非转化成整数型;
*
* Object.getOwnPropertyNames以数组形式返回对象的属性;
*
* scrollWidth包含超过可视区域的长度;
* clientWidth可视区域不包括滚动条的宽度;
* offsetWidth可视区域包括滚动条的宽度;
* outerWidth包括内边距、边框的宽度;
* outerWidth(true)包括内边距、边框、外边距的宽度;
* innerWidth包括内边距、不包括边框的宽度;
*
* scrollLeft()获取元素的水平偏移，有水平滚动条的情况下;
* scrollTop()获取元素的垂直偏移，有垂直滚动条的情况下;
*
* 通过hide()方法隐藏的元素可以用:hidden伪类获取;
*/ /**关于本插件
*
* html页面配置项写在触发元素的data属性，在$.prototype.bootstrapTable方法将其和默认配置项合并;
* 触发元素还包含表格内容如表头信息，在构造函数Bootstrap中获取该信息，与配置项对应内容合并;
* js配置的优先级高于html页面配置项，initTable获取页面配置thead>tr>th、tbody>tr>td信息;
* 表体渲染通过this.data实现，搜索、排序以及其他方法更新this.data数据，实现数据和显示分离;
*/
!function ($) {
'use strict'; /**工具函数
*
* sprintf(str,str1,str2):
* sprintf("<span style='%s'>%s</span>","text-align:center"."hello");
* 顺序替换文本，无替换文本返回空;
*
* getPropertyFromOther(list,from,to,value):
* getPropertyFromOther(this.columns,'field','title',value);
* 获取field属性为value的数组元素的title属性值this.columns[i].title;
* 应用场景：卡片式显示时需要获取标题栏的显示文案信息;
*
* getFieldIndex(columns,field):
* getFieldIndex(this.columns,field);
* 获取field属性为field的数组元素的列坐标this.columns[i].filedIndex;
*
* setFieldIndex(this.options.columns):
* setFieldIndex([[
{colspan:4,title:'Group1'},// 跨几列
{rowspan:3,title:'ID'},// 跨几行
],[
{rowspan:2,title:'Name1'},
{colspan:3,title:'Group2'},
],[
{title:'Name2'},
{title:'Name3'},
{title:'Name4'},
]])
* 为每条标题栏数据设置filedIndex:所在列/列坐标;
* 无field主键的标题栏数据以列坐标作为field属性的值;
* 意义：借用this.columns[fieldIndex]=column构建this.columns;
* this.column的数据格式为{[column]}，列坐标相同的标题栏取靠后的子标题;
* 问题：用户配置options.columns时需要顺序写就标题栏，以子标题不跨列为前提，函数的应用场景变得有限;
*
* getScrollBarWidth获取滚动条的宽度;
*
* calculateObjectValue(self,name,args,defaultValue):
* 当name为字符串时，获取window对象的方法并执行，参数为args，没有该方法时调用sprintf替换name文本;
* 当name为函数时，传入args执行该函数;
* 以上情况都不是返回defaultValue;
* 问题：原型中的方法可以直接调用，window对象的方法使用户配置变得繁琐，sprintfy也可以预先作判断后调用;
*
* compareObjects(objectA,objectB,compareLength):
* compareObjects(this.options, options, true);
* 当compareLength为真时，先比较两个对象的长度是否相同，其次比较同名元素是否等值;
* 当compareLength为否时，只比较两个对象的同名元素是否等值;
* 问题：在插件中的使用，依赖this.options和options长度相等，且没有不同名的属性;
*
* escapeHTML转义;
*
* getRealHeight($el):
* 以子元素的最大高度作为父元素的高度;
*
* getRealDataAttr($(this).data()):
* 将paramName的data属性转换成param-name修改完成后输出;
*
* getItemField(item,field,escape):
* 当field为函数时，获取item[field]并进行转义(escape为真的情况下);
* 当field为字符串时，以最末一个点号后的字符获取item中的属性并进行转义(escape为真的情况下);
* 问题：实际应用场景field多是字符串，且没有点号，可以限制用户配置使调用函数变得方便;
*
* isIEBrowser是否IE浏览器或者Trident呈现引擎;
*/
var cachedWidth = null; // 顺序替换文本，无替换文本返回空;
var sprintf = function (str) {
var args = arguments,
flag = true,
i = 1; str = str.replace(/%s/g, function () {
var arg = args[i++];// 对每个匹配值应用函数，i自加1，直到无匹配值; if (typeof arg === 'undefined') {
flag = false;
return '';
}
return arg;
});
return flag ? str : '';
}; // 获取from属性为value的数组元素的to属性值this.columns[i].to;
// 应用场景，卡片式显示时需要获取标题栏的显示文案信息;
var getPropertyFromOther = function (list, from, to, value) {
var result = '';
$.each(list, function (i, item) {
if (item[from] === value) {
result = item[to];
return false;
}
return true;
});
return result;
}; // 获取field属性为field的数组元素的列坐标this.columns[i].filedIndex;
var getFieldIndex = function (columns, field) {
var index = -1; $.each(columns, function (i, column) {
if (column.field === field) {
index = i;
return false;
}
return true;
});
return index;
}; // 为每条标题栏数据设置filedIndex:所在列/列坐标;
/**
* 策略：
* 表头分割成columns.length（总行数）* totalCol（总列数）的矩阵，以flag矩阵标记为false;
* 各标题栏为columns[i][j].rowspan（行数）* columns[i][j].colspan（列数）的小矩阵;
* 从左自右、从上而下遍历标题栏小矩阵，将标题栏对应的flag首行、首列标记为true;
* 因标题栏只能跨列或跨行，不能既跨行又跨列，函数的实现依赖用户输入正确的options.columns格式，
*/
var setFieldIndex = function (columns) {
var i, j, k,
totalCol = 0,
flag = []; for (i = 0; i < columns[0].length; i++) {
totalCol += columns[0][i].colspan || 1;// 表格总列数;
} for (i = 0; i < columns.length; i++) {// columns.length表格总行数;
flag[i] = [];
for (j = 0; j < totalCol; j++) {
flag[i][j] = false;
}
} for (i = 0; i < columns.length; i++) {
for (j = 0; j < columns[i].length; j++) {// columns[i].length某行共有多少元素;
var r = columns[i][j],
rowspan = r.rowspan || 1,
colspan = r.colspan || 1,
// i为标题栏小矩阵在flag大矩阵的行位置;
// index记录标题栏小矩阵在flag大矩阵的列位置;
index = $.inArray(false, flag[i]); if (colspan === 1) {
// fieldIndex记录每个标题栏的列坐标信息;
r.fieldIndex = index;
if (typeof r.field === 'undefined') {
r.field = index;
}
} // 目的是让$.inArray(false, flag[i])正确获取标题栏的列坐标;
for (k = 0; k < rowspan; k++) {
flag[i + k][index] = true;
}
for (k = 0; k < colspan; k++) {
flag[i][index + k] = true;
}
}
}
}; // 获取滚动条的宽度;
var getScrollBarWidth = function () {
if (cachedWidth === null) {
var inner = $('<p/>').addClass('fixed-table-scroll-inner'),
outer = $('<div/>').addClass('fixed-table-scroll-outer'),
w1, w2; outer.append(inner);
$('body').append(outer); w1 = inner[0].offsetWidth;
outer.css('overflow', 'scroll');
w2 = inner[0].offsetWidth; if (w1 === w2) {
w2 = outer[0].clientWidth;
} outer.remove();
cachedWidth = w1 - w2;
}
return cachedWidth;
}; // 当name为字符串时，获取window对象的方法并执行，参数为args，没有该方法时调用sprintf替换name文本;
// 当name为函数时，传入args执行该函数;以上情况都不是返回defaultValue;
var calculateObjectValue = function (self, name, args, defaultValue) {
var func = name; if (typeof name === 'string') {
// support obj.func1.func2
var names = name.split('.'); if (names.length > 1) {
func = window;
$.each(names, function (i, f) {
func = func[f];
});
} else {
func = window[name];
}
}
if (typeof func === 'object') {
return func;
}
if (typeof func === 'function') {
return func.apply(self, args);
}
if (!func && typeof name === 'string' && sprintf.apply(this, [name].concat(args))) {
return sprintf.apply(this, [name].concat(args));
}
return defaultValue;
}; // 当compareLength为真时，先比较两个对象的长度是否相同，其次比较同名元素是否等值;
// 当compareLength为否时，只比较两个对象的同名元素是否等值;
var compareObjects = function (objectA, objectB, compareLength) {
var objectAProperties = Object.getOwnPropertyNames(objectA),
objectBProperties = Object.getOwnPropertyNames(objectB),
propName = ''; if (compareLength) {
if (objectAProperties.length !== objectBProperties.length) {
return false;
}
} for (var i = 0; i < objectAProperties.length; i++) {
propName = objectAProperties[i]; if ($.inArray(propName, objectBProperties) > -1) {
if (objectA[propName] !== objectB[propName]) {
return false;
}
}
} return true;
}; // 转义;
var escapeHTML = function (text) {
if (typeof text === 'string') {
return text
.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/"/g, '"')
.replace(/'/g, ''')
.replace(/`/g, '`');
}
return text;
}; // 以子元素的最大高度作为父元素的高度;
var getRealHeight = function ($el) {
var height = 0;
$el.children().each(function () {
if (height < $(this).outerHeight(true)) {
height = $(this).outerHeight(true);
}
});
return height;
}; // 将paramName的data属性转换成param-name修改完成后输出;
var getRealDataAttr = function (dataAttr) {
for (var attr in dataAttr) {
// "paramName".split(/(?=[A-Z])/) 返回结果为["param","Name"];
var auxAttr = attr.split(/(?=[A-Z])/).join('-').toLowerCase();
if (auxAttr !== attr) {
dataAttr[auxAttr] = dataAttr[attr];
delete dataAttr[attr];
}
}
return dataAttr;
}; // 当field为函数时，获取item[field]并进行转义(escape为真的情况下);
// 当field为字符串时，以最末一个点号后的字符获取item中的属性并进行转义(escape为真的情况下);
var getItemField = function (item, field, escape) {
var value = item; if (typeof field !== 'string' || item.hasOwnProperty(field)) {
return escape ? escapeHTML(item[field]) : item[field];
}
var props = field.split('.');
for (var p in props) {
value = value && value[props[p]];
}
return escape ? escapeHTML(value) : value;
}; // 浏览器嗅探，匹配IE浏览器或呈现引擎Trident的返回为真;
var isIEBrowser = function () {
return !!(navigator.userAgent.indexOf("MSIE ") > 0 || !!navigator.userAgent.match(/Trident.*rv\:11\./));
}; /**BootstrapTable构造函数
*
* this.$el带table标签的触发元素，置入this.$tableBody中;
* this.$container最外层包裹元素.bootstrap-table;
* this.$toolbar即是.bootstrap-table下工具栏元素.fixed-table-toolbar;
* this.$pagination即是.bootstrap-table下分页元素.fixed-table-pagination;
* this.$tableContainer即是.bootstrap-table下标题内容元素.fixed-table-container;
* this.$tableHeader即是.fixed-table-container下表头元素.fixed-table-header;
* this.$tableBody即是.fixed-table-container下表体元素.fixed-table-body;
* this.$tableFooter即是.fixed-table-container下表尾元素.fixed-table-footer;
* this.$tableLoading即是.fixed-table-container下加载中提示元素.fixed-table-loading;
* this.$header即是this.$el下的thead元素;
* this.$header_即是对this.$header的克隆，置入this.$tableHeader中，目的是实现表体的滚动;
* this.options.toolbar用户自定义按钮组，置入this.$toolbar中;
*
*
*
* this.options.column:
* 混合js和html表头标题栏的配置项，包括thead>tr的class/title/html/rowspan/colspan/data;
* this.columns:
* 以this.columns[fieldIndex]的数组形式[columns]记录表体相应标题栏的数据内容;
* this.options.data:
* 有js配置，获取js配置，没有js配置，获取html配置;
* 包含tbody>tr的id/class/data，tbody>tr>td的html/id/class/rowspan/title/data;
* this.header.fields:
* 以this.header.fields[column.fieldIndex]数组形式[field]记录表体每列数据的主键;
* 应用场景：渲染表体td时由该主键通过getFieldIndex获取this.columns的序号;
* 问题：不能直接通过tr的序号获取this.columns数据，或者VisibleColumns数据？？？
* this.header.fields剔除了this.columns中visible为false的内容;
* this.header.styles、this.header.classes:
* 数组形式存储经过处理的每列数据的样式、类;
* this.header.formatters、this.header.cellStyles、this.header.sorters:
* 数组形式存储格式化函数、设置单元格样式函数、排序函数，或者window方法名;
* this.header.events、this.header.sortNames、this.header.searchables:
* 数组形式存储表体相应标题栏配置的事件events、上传排序的字段sortName、可搜索searchable;
* 应用场景:由主键名在this.header.fields的位置锁定对应的事件、排序字段、可搜索;
* this.header.stateField:
* 复选框内容上传时的字段名;
* this.data:
* initSearch搜索前以及执行filterBy方法前与this.options.data等值;
* 搜索后this.data为过滤后数据;
* data的数据格式:
对象形式
[{ // 行tr中的属性设置
_data:{
index:1,// 后续会自动赋值为数据在当前页的所在行号
field:field
},
_id:id,
_class:class,
field1:value1,field2:value2, //填充在单元格中的显示内容，从this.header.fields数组中获取属性名field1等
_field_id
}] // 每一行特定的样式、属性根据this.options.rowStyle、this.options.rowAttributes获取
数组形式
[["field","class"]] // 数组形式不能对每一行添加特定的data属性、id以及class
// 特定的的样式、属性仍可由this.options.rowStyle、this.options.rowAttributes获取
// 以及data-index添加行号、data-uniqueId每行的唯一标识，根据options.uniqueId从data中获取
* this.options.data:
* initSearch搜索前以及执行filterBy方法前与this.data等值;
* 搜索后this.data为未过滤数据;
* 应用场景：搜索未使用前后台数据交互，通过this.options.data获取新的过滤数据this.data;
* this.searchText:
* this.text:
* 搜索文本;
* this.filterColumns:
* options.data和this.filterColumns相符则在this.data中保留，不相符则在this.data中删除;
* prototype.filterBy方法使用;
*
*
*
* init():
* 初始化函数;
* initLocale():
* 将语言包添加进配置项this.options中，数据格式是{formatLoadingMessage:fn};
* initContainer():
* 创建包裹元素this.container及其子元素this.$toolbar、this.$pagination等，为表格添加样式;
* initTable():
* 获取页面thead>th、tbody>tr>td的配置内容更新options.columns、options.data配置信息;
* this.columns记录表体每列数据相应标题栏options.column的数据内容;
* initHeader():
* 由options.columns渲染表头,th的data-field记为column[field],data数据记为column;
* 更新this.header记录主键、样式、事件、格式化函数等，以及stateField复选框上传字段;
* 绑定事件，包括点击排序、确认键排序、全选，更新上传数据、页面状态等;
* initFooter():
* 显示隐藏表尾;
* initData(data,type):
* 页面初始化时this.data赋值为this.options.data;
* ajax交互时this.data赋值为后台返回的数据，options.data也同样更新为后台返回的数据;
* type为append时，表格尾部插入数据，this.data、options.data尾部插入相应数据;
* type为prepend时，表格顶部插入数据，this.data、options.data头部插入相应数据;
* 前台分页的情况下调用this.initSort进行排序，后台分页以返回数据为准;
* initSort():
* onSort方法设置点击排序按钮时，更新options.sortName为相应标题栏column.field值;
* initSort由column.field值获得相应的sortName;
* 调用option.sorter函数或window[option.sorter]方法进行比较排序;
* 排序通过更新this.data数据实现,this.data渲染到页面使用initBody方法;
* onSort():
* 点击排序时更新options.sortName为被排序列数据对应column[field]值，以便initSort获取sortName;
* 更新options.sortOrder为被排序列数据对应column[order]值，或保持原有值;
* 触发sort事件，调用initServer获取后台数据，调用initSort排序、initBody渲染表体;
* initToolbar():
* 创建工具栏内的用户自定义按钮组、分页显示隐藏切换按钮、刷新按钮、筛选条目按钮;
* 以及卡片表格显示切换按钮、搜索框，并绑定相应事件；筛选条目时触发column-switch事件;
* onSearch():
* this.text，this.options.text设为搜索框去除两端空白的值，pageNumber设为1;
* 调用initSearch将筛选本地数据;调用updatePagination完成远程交互或单渲染本地数据;
* 触发search事件;
* initSearch():
* 前台分页的情况下，先通过this.filterColumns通过this.option.data过滤this.data数据;
* 再通过搜索文本过滤this.data数据;
* 输入文本和经this.header.formatters或window[this.header.formatters]函数格式化匹配比对;
* initPagination():
* 初始化设置分页相关页面信息显示情况，包括当前页显示第几条到第几天数据，共几条数据，每页显示几条数据;
* 以及每页显示数据量切换按钮，选择页面的分页栏显示情况，再绑定事件;
* 通过options.pageNumber获取this.pageFrom、this.pageTo，以便前台分页时initBody获取相应数据;
* updatePagination():
* 分页点选按钮有disabled属性则返回，无则重新布局分页显示面板;
* maintainSelected为否时，调用resetRows重置复选框为不选中，调用initServer交互或initbody渲染页面;
* initSever由后台返回数据;
* initPagination通过options.pageNumber取得options.pageFrom、options.pageTo;
* initBody由options.pageFrom、options.pageTo获取需要渲染的数据data;
* 触发page-change事件;
* onPageListChange():
* 每页显示数据量下拉列表选中时触发，替换每页显示数据量按钮文本;
* 更新options.pageSize，通过updatePagination调用initPagination设置this.pageFrom、this.pageTo;
* updatePagination再调用initServer完成交互，或initBody渲染本地数据;
* onPageFirst():
* onPagePre():
* onPageNext():
* onPageLast():
* onPageNumber():
* 更新options.pageNumber,通过updatePagination调用initPagination设置this.pageFrom、this.pageTo;
* updatePagination再调用initServer完成交互，或initBody渲染本地数据;
* 跳转分页首页、上一页、下一页、尾页，由页码跳转;
* initBody():
* fixedScroll为否的情况下，表体移动到顶部;
* 通过this.pageFrom、this.pageTo截取this.getData()数据row渲染表体，主要是tbody>tr以及tbody>tr>td;
* tbody>tr的data-index设为行号，class、id为row._class、row._id，样式、data数据通过调用函数获得;
* tbody>tr>td区分为卡片显示和表格显示两类，显示值取经this.header.formatters[i]处理后的row[field];
* tbody>tr>td其他class、id、title、data取row[_field_class]等;
* 绑定展开卡片详情按钮点击事件、复选框点击事件、this.header.events中的事件;
* 触发post-body、pre-body事件;
* initServer():
* 触发ajax事件（可以是用户自定义的方法options.ajax），上传数据格式为:
* {
* searchText:this.searchText,
* sortName:this.options.sortName,
* sortOrder:this.options.sortOrder,
* pageSize/limit:...,
* pageNumber/offset:...,
* [filter]:...,
* query:...
* }
* 上传成功调用this.load方法，触发load-success事件、上传失败load-error事件;
* initSearchText():
* 初始化若设置搜索文本，开启搜索，不支持本地数据搜索;
* getCaret():
* getCaret改变排序点击箭头的上下方向;
* updateSelected():
* 全选以及全不选时改变全选复选框的勾选状态，以及tr行添加或删除selected类;
* updateRows():
* 复选框选中或撤销选中后更新this.data数据中的[this.header.stateField]属性，以便上传复选框的状态;
* resetRows():
* 重置，撤销复选框选中，以及data[i][that.header.stateField]赋值为false;
* trigger():
* 执行this.options[BootstrapTable.EVENTS[name]]函数(类似浏览器默认事件)，并触发事件;
* resetHeader():
* 一定时间内触发this.fitHeader函数调整表头的水平偏移，垂直滚动不影响表头;
* fitHeader():
* 克隆this.$el中的表头，置入this.$tableHeader中，出使垂直滚动时，表头信息不变;
* 调整表体水平偏移量和表体水平一致;
* resetFooter():
* 创建表尾，利用footerFormatter填充表尾内容，调用fitFooter调整表尾偏移;
* fitFooter():
* 调整表尾水平偏移，设置表尾fnt-cell的宽度;
* toggleColumn():
* toggleColumn筛选条目下拉菜单点选时更新columns[i].visible信息;
* this.columns信息的改变，重新调用表头、表体、搜索框、分页初始化函数;
* 当勾选的显示条目小于this.options.minimumCountColumns时，勾选的条目设置disabled属性;
* toggleRow():
* 从表体中找到data-index=index或data-uniqueid=uniqueId那一行，根据visible显示或隐藏;
* getVisibleFields():
* 从this.column中剔除visible为false的项，返回field数组;
*/
var BootstrapTable = function (el, options) {
this.options = options;
this.$el = $(el);
this.$el_ = this.$el.clone();// 记录触发元素的初始值，destroy销毁重置的时候使用
this.timeoutId_ = 0;// 超时计时器，有滚动条的情况下调整表头的水平偏移量
this.timeoutFooter_ = 0;// 超时计时器，有滚动条的情况下调整表尾的水平偏移量 this.init();
}; BootstrapTable.DEFAULTS = {
classes: 'table table-hover',// 触发元素table加入的样式;
locale: undefined,// 设置语言包;
height: undefined,// 包括分页和工具栏的高度;
undefinedText: '-',// 无显示文本时默认显示内容;
sortName: undefined,
// 初始化排序字段名，须是column.filed主键名;
// 点击排序后更新options.sortName为被排序列的主键名columns[i].field;
// 通过主键名在this.header.fields中的序号获取sortName，比较后排序;
sortOrder: 'asc',// 升序或降序，并且上传
striped: false,// 触发元素table是否显示间行色
columns: [[]],
data: [],
dataField: 'rows',// 后台传回data数据的字段名
method: 'get',// ajax发送类型
url: undefined,// ajax发送地址
ajax: undefined,
// 用户自定义ajax，或通过字符串调用window下的方法，对插件内配置有较多使用，调用其实不便
cache: true,// ajax设置
contentType: 'application/json',
dataType: 'json',
ajaxOptions: {},
queryParams: function (params) {
return params;
},
queryParamsType: 'limit', // undefined
responseHandler: function (res) {
return res;
},// ajax处理相应的函数
pagination: false,// 分页是否显示
onlyInfoPagination: false,// 分页文案提示只显示有多少条数据
sidePagination: 'client', // client or server 前台分页或后台分页
totalRows: 0, // server side need to set
pageNumber: 1,// 初始化显示第几页
pageSize: 10,// 初始化页面多少条数据
pageList: [10, 25, 50, 100],// 每页显示数据量切换配置项
paginationHAlign: 'right', //right, left 分页浮动设置
paginationVAlign: 'bottom', //bottom, top, both
// 分页显示位置，上、下或上下均显示，默认底部显示
// 设置一页显示多少条数据按钮向上下拉，还是向下下拉，默认向上下拉
// 设置为both时，分页在上下位置均显示，设置一页显示多少条数据按钮向上下拉
paginationDetailHAlign: 'left', //right, left 每页几行数据显示区浮动情况
paginationPreText: '‹',// 分页上一页按钮
paginationNextText: '›',// 分页下一页按钮
search: false,// 是否支持搜索
searchOnEnterKey: false,// enter键开启搜索
strictSearch: false,// 搜索框输入内容是否须和条目显示数据严格匹配，false时只要键入部分值就可获得结果
searchAlign: 'right',// 搜索框对齐方式
selectItemName: 'btSelectItem',// 复选框默认上传name值
showHeader: true,// 显示表头，包含标题栏内容
showFooter: false,// 默认隐藏表尾
showColumns: false,// 显示筛选条目按钮
showPaginationSwitch: false,// 显示分页隐藏展示按钮
showRefresh: false,// 显示刷新按钮
showToggle: false,// 显示切换表格显示或卡片式详情显示按钮
buttonsAlign: 'right',// 显示隐藏分页、刷新、切换表格或卡片显示模式、筛选显示条目、下载按钮浮动设置
smartDisplay: true,
// smartDisplay为真，当总页数为1时，屏蔽分页，以及下拉列表仅有一条时，屏蔽切换条目数按钮下拉功能
escape: false,// 是否转义
minimumCountColumns: 1,// 最小显示条目数
idField: undefined,// data中存储复选框value的键值
uniqueId: undefined,// 从data中获取每行数据唯一标识的属性名
cardView: false,// 是否显示卡片式详情（移动端），直接罗列每行信息，不以表格形式显现
detailView: false,// 表格显示数据时，每行数据前是否有点击按钮，显示这行数据的卡片式详情
detailFormatter: function (index, row) {
return '';
},// 折叠式卡片详情渲染文本，包含html标签、Dom元素
trimOnSearch: true,// 搜索框键入值执行搜索时，清除两端空格填入该搜索框
clickToSelect: false,
singleSelect: false,// 复选框只能单选，需设置column.radio属性为真
toolbar: undefined,// 用户自定义按钮组，区别于搜索框、分页切换按钮等
toolbarAlign: 'left',// 用户自定义按钮组浮动情况
checkboxHeader: true,// 为否隐藏全选按钮
sortable: true,// 可排序全局设置
silentSort: true,// ajax交互的时候是否显示loadding加载信息
maintainSelected: false,// 为真且翻页时，保持前一页各条row[that.header.stateField]为翻页前的值
searchTimeOut: 500,
// 搜索框键入值敲enter后隔多少时间执行搜索，使用clearTimeout避免间隔时间内多次键入反复搜索
searchText: '',// 初始化搜索内容
iconSize: undefined,// 按钮、搜索输入框通用大小，使用bootstrap的sm、md、lg等
iconsPrefix: 'glyphicon', // 按钮通用样式
icons: {
paginationSwitchDown: 'glyphicon-collapse-down icon-chevron-down',// 显示分页按钮
paginationSwitchUp: 'glyphicon-collapse-up icon-chevron-up',// 隐藏分页按钮
refresh: 'glyphicon-refresh icon-refresh',// 刷新按钮
toggle: 'glyphicon-list-alt icon-list-alt',// 切换表格详情显示、卡片式显示按钮
columns: 'glyphicon-th icon-th',// 筛选条目按钮
detailOpen: 'glyphicon-plus icon-plus',// 卡片式详情展开按钮
detailClose: 'glyphicon-minus icon-minus'// 卡片式详情折叠按钮
},// 工具栏按钮具体样式 rowStyle: function (row, index) {
return {};
},// 传递给每一行的css设置，row为这一行的data数据 rowAttributes: function (row, index) {
return {};
},// 传递给每一行的属性设置 onAll: function (name, args) {
return false;
},
onClickCell: function (field, value, row, $element) {
return false;
},
onDblClickCell: function (field, value, row, $element) {
return false;
},
onClickRow: function (item, $element) {
return false;
},
onDblClickRow: function (item, $element) {
return false;
},
onSort: function (name, order) {
return false;
},
onCheck: function (row) {
return false;
},
onUncheck: function (row) {
return false;
},
onCheckAll: function (rows) {
return false;
},
onUncheckAll: function (rows) {
return false;
},
onCheckSome: function (rows) {
return false;
},
onUncheckSome: function (rows) {
return false;
},
onLoadSuccess: function (data) {
return false;
},
onLoadError: function (status) {
return false;
},
onColumnSwitch: function (field, checked) {
return false;
},
onPageChange: function (number, size) {
return false;
},
onSearch: function (text) {
return false;
},
onToggle: function (cardView) {
return false;
},
onPreBody: function (data) {
return false;
},
onPostBody: function () {
return false;
},
onPostHeader: function () {
return false;
},
onExpandRow: function (index, row, $detail) {
return false;
},
onCollapseRow: function (index, row) {
return false;
},
onRefreshOptions: function (options) {
return false;
},
onResetView: function () {
return false;
}
}; BootstrapTable.LOCALES = []; BootstrapTable.LOCALES['en-US'] = BootstrapTable.LOCALES['en'] = {
formatLoadingMessage: function () {
return 'Loading, please wait...';
},
formatRecordsPerPage: function (pageNumber) {
return sprintf('%s records per page', pageNumber);
},// 每页显示条目数提示文案
formatShowingRows: function (pageFrom, pageTo, totalRows) {
return sprintf('Showing %s to %s of %s rows', pageFrom, pageTo, totalRows);
},// 分页提示当前页从第pageFrom到pageTo，总totalRows条
formatDetailPagination: function (totalRows) {
return sprintf('Showing %s rows', totalRows);// 分页提示供多少条数据
},
formatSearch: function () {
return 'Search';
},// 设置搜索框placeholder属性
formatNoMatches: function () {
return 'No matching records found';
},// 没有数据时提示文案
formatPaginationSwitch: function () {
return 'Hide/Show pagination';
},// 显示隐藏分页按钮title属性提示文案
formatRefresh: function () {
return 'Refresh';
},// 刷新按钮title属性提示文案
formatToggle: function () {
return 'Toggle';
},// 切换表格、卡片显示模式按钮title属性提示文案
formatColumns: function () {
return 'Columns';
},// 筛选显示条目按钮title属性提示文案
formatAllRows: function () {
return 'All';
}
}; $.extend(BootstrapTable.DEFAULTS, BootstrapTable.LOCALES['en-US']); BootstrapTable.COLUMN_DEFAULTS = {
radio: false,// 有否radio，有则options.singleSelect设为真
checkbox: false,// 有否checkbox，options.singleSelect设为真，checkbox单选
checkboxEnabled: true,// 复选框是否可选
field: undefined,// 后台数据的id号
title: undefined,// 内容文案
titleTooltip: undefined,// title属性文案
'class': undefined,// 样式
align: undefined, // tbody、thead、tfoot文本对齐情况
halign: undefined, // thead文本对齐情况
falign: undefined, // tfoot文本对齐情况
valign: undefined, // 垂直对齐情况
width: undefined, // 宽度，字符串或数值输入，均转化为"36px"或"10%"形式
sortable: false,// 是否可排序，options.sortable设置为真的时候可用
order: 'asc', // asc, desc
visible: true,// 可见性
switchable: true,// 该条目可以通过筛选条目按钮切换显示状态
clickToSelect: true,
formatter: undefined,
// 以function(field,row,index){}格式化数据，field后台字段，row行数据，index对应row的序号值
// 无配置时以title显示，有配置时以返回值显示
footerFormatter: undefined,// 填充表尾内容
events: undefined,// 数据格式为[{"click element":functionName}],回调中传入（value,row,index）
sorter: undefined,// 调用sorter函数或window[sorter]函数进行排序，高优先级
sortName: undefined,// 进行排序的字段名，用以获取options.data中的数据
cellStyle: undefined,
// 调用cellStyle函数或window[cellStyle]函数添加样式以及类;
// 以function(field,row,index){}设置单元格样式以及样式类，返回数据格式为{classes:"class1 class2",css:{key:value}}
searchable: true,// 设置哪一列的数据元素可搜索
searchFormatter: true,
cardVisible: true// 设为否时，卡片式显示时该列数据不显示
}; BootstrapTable.EVENTS = {
'all.bs.table': 'onAll',
'click-cell.bs.table': 'onClickCell',
'dbl-click-cell.bs.table': 'onDblClickCell',
'click-row.bs.table': 'onClickRow',
'dbl-click-row.bs.table': 'onDblClickRow',
'sort.bs.table': 'onSort',
'check.bs.table': 'onCheck',
'uncheck.bs.table': 'onUncheck',
'check-all.bs.table': 'onCheckAll',
'uncheck-all.bs.table': 'onUncheckAll',
'check-some.bs.table': 'onCheckSome',
'uncheck-some.bs.table': 'onUncheckSome',
'load-success.bs.table': 'onLoadSuccess',
'load-error.bs.table': 'onLoadError',
'column-switch.bs.table': 'onColumnSwitch',
'page-change.bs.table': 'onPageChange',
'search.bs.table': 'onSearch',
'toggle.bs.table': 'onToggle',
'pre-body.bs.table': 'onPreBody',
'post-body.bs.table': 'onPostBody',
'post-header.bs.table': 'onPostHeader',
'expand-row.bs.table': 'onExpandRow',
'collapse-row.bs.table': 'onCollapseRow',
'refresh-options.bs.table': 'onRefreshOptions',
'reset-view.bs.table': 'onResetView'
}; BootstrapTable.prototype.init = function () {
this.initLocale();
// 将语言包添加进配置项this.options中，数据格式是{formatLoadingMessage:fn};
this.initContainer();
// 创建包裹元素this.container及其子元素this.$toolbar、this.$pagination等，为表格添加样式;
this.initTable();
// 获取页面配置更新options.columns、options.data，this.columns记录表体对应标题栏的数据;
this.initHeader();
// 渲染表头，设置this.header数据记录主键等，绑定表头事件，卡片式显示时隐藏表头;
this.initData();
// 页面初始化、后台传值、表头表尾插入数据，更新this.data、options.data，前台分页则排序;
this.initFooter();
// 显示隐藏表尾;
this.initToolbar();
// 创建工具栏按钮组，并绑定事件;
this.initPagination();
// 创建分页相关内容，并绑定事件;
this.initBody();
// 渲染表体，区分卡片显示和表格显示两类，绑定相关事件;
this.initSearchText();
// 初始化若设置搜索文本，开启搜索，不支持本地数据搜索;
this.initServer();
// 上传数据，成功时调用load方法渲染表格;
}; // 将语言包添加进配置项this.options中，数据格式是{formatLoadingMessage:fn};
BootstrapTable.prototype.initLocale = function () {
if (this.options.locale) {
var parts = this.options.locale.split(/-|_/);
parts[0].toLowerCase();
parts[1] && parts[1].toUpperCase();
if ($.fn.bootstrapTable.locales[this.options.locale]) {
$.extend(this.options, $.fn.bootstrapTable.locales[this.options.locale]);
} else if ($.fn.bootstrapTable.locales[parts.join('-')]) {
$.extend(this.options, $.fn.bootstrapTable.locales[parts.join('-')]);
} else if ($.fn.bootstrapTable.locales[parts[0]]) {
$.extend(this.options, $.fn.bootstrapTable.locales[parts[0]]);
}
}
}; // 创建包裹元素this.container及其子元素this.$toolbar、this.$pagination等，为表格添加样式;
BootstrapTable.prototype.initContainer = function () {
this.$container = $([
'<div class="bootstrap-table">',
'<div class="fixed-table-toolbar"></div>',
this.options.paginationVAlign === 'top' || this.options.paginationVAlign === 'both' ?
'<div class="fixed-table-pagination" style="clear: both;"></div>' :
'',
'<div class="fixed-table-container">',
'<div class="fixed-table-header"><table></table></div>',
'<div class="fixed-table-body">',
'<div class="fixed-table-loading">',
this.options.formatLoadingMessage(),
'</div>',
'</div>',
'<div class="fixed-table-footer"><table><tr></tr></table></div>',
this.options.paginationVAlign === 'bottom' || this.options.paginationVAlign === 'both' ?
'<div class="fixed-table-pagination"></div>' :
'',
'</div>',
'</div>'
].join('')); this.$container.insertAfter(this.$el);
this.$tableContainer = this.$container.find('.fixed-table-container');
this.$tableHeader = this.$container.find('.fixed-table-header');
this.$tableBody = this.$container.find('.fixed-table-body');
this.$tableLoading = this.$container.find('.fixed-table-loading');
this.$tableFooter = this.$container.find('.fixed-table-footer');
this.$toolbar = this.$container.find('.fixed-table-toolbar');
this.$pagination = this.$container.find('.fixed-table-pagination'); this.$tableBody.append(this.$el);
this.$container.after('<div class="clearfix"></div>'); this.$el.addClass(this.options.classes);
if (this.options.striped) {
this.$el.addClass('table-striped');
}
if ($.inArray('table-no-bordered', this.options.classes.split(' ')) !== -1) {
this.$tableContainer.addClass('table-no-bordered');
}
}; // 当html中包含thead>tr>th以及tbody>tr>td时，获取页面的配置项更新options.columns、options.data;
// js配置的优先级高于html页面配置;
// this.columns以this.columns[fieldIndex]的数组形式[columns]记录表体相应标题栏的数据内容;
BootstrapTable.prototype.initTable = function () {
var that = this,
columns = [],
data = []; // 触发元素table中有thead子标签等则使用（查询排序的时候），无则创建
this.$header = this.$el.find('>thead');
if (!this.$header.length) {
this.$header = $('<thead></thead>').appendTo(this.$el);
}
this.$header.find('tr').each(function () {
var column = []; $(this).find('th').each(function () {
column.push($.extend({}, {
title: $(this).html(),
'class': $(this).attr('class'),
titleTooltip: $(this).attr('title'),
rowspan: $(this).attr('rowspan') ? +$(this).attr('rowspan') : undefined,
colspan: $(this).attr('colspan') ? +$(this).attr('colspan') : undefined
}, $(this).data()));
});
columns.push(column);
});
if (!$.isArray(this.options.columns[0])) {
this.options.columns = [this.options.columns];// 都处理成两维数组的形式
}
this.options.columns = $.extend(true, [], columns, this.options.columns); // 借用this.columns[fieldIndex]=column构建this.columns;
// this.column的数据格式为{[column]}，列坐标相同的标题栏取靠后的子标题;
// 意义：填充表体内容时，this.column提供每列数据的相关信息;
this.columns = []; // setFieldIndex将标题栏的fieldIndex属性赋值为标题栏所在列坐标;
setFieldIndex(this.options.columns); $.each(this.options.columns, function (i, columns) {
$.each(columns, function (j, column) {
column = $.extend({}, BootstrapTable.COLUMN_DEFAULTS, column); if (typeof column.fieldIndex !== 'undefined') {
that.columns[column.fieldIndex] = column;
} that.options.columns[i][j] = column;
});
}); if (this.options.data.length) {
return;
} this.$el.find('>tbody>tr').each(function () {
var row = {}; // 获取每一行tr的id、class、data属性，以数组形式赋值给data
row._id = $(this).attr('id');
row._class = $(this).attr('class');
row._data = getRealDataAttr($(this).data()); // 获取某一行每个子元素的内容、id、class、rowspan、title、data属性
$(this).find('td').each(function (i) {
// field通常是后台数据的id号，没有该值的时候赋值为column列坐标信息，写入本地数据的时候
var field = that.columns[i].field; row[field] = $(this).html();
// save td's id, class and data-* attributes
row['_' + field + '_id'] = $(this).attr('id');
row['_' + field + '_class'] = $(this).attr('class');
row['_' + field + '_rowspan'] = $(this).attr('rowspan');
row['_' + field + '_title'] = $(this).attr('title');
row['_' + field + '_data'] = getRealDataAttr($(this).data());
});
data.push(row);
}); this.options.data = data;
}; // 由options.columns渲染表头,th的data-field记为column[field],data数据记为column;
// 更新this.header记录主键、样式、事件、格式化函数等，以及stateField复选框上传字段;
// 绑定事件，包括点击排序、确认键排序、全选，更新上传数据、页面状态等；
BootstrapTable.prototype.initHeader = function () {
var that = this,
visibleColumns = {},
html = []; this.header = {
fields: [],
styles: [],
classes: [],
formatters: [],
events: [],
sorters: [],
sortNames: [],
cellStyles: [],
searchables: []
}; $.each(this.options.columns, function (i, columns) {
html.push('<tr>'); // 页面以表格显示且有卡片式详情点击按钮的时候，表头首列为该按钮开辟一个空白的单元格
if (i == 0 && !that.options.cardView && that.options.detailView) {
html.push(sprintf('<th class="detail" rowspan="%s"><div class="fht-cell"></div></th>',
that.options.columns.length));
} $.each(columns, function (j, column) {
var text = '',
halign = '',
align = '',
style = '',
class_ = sprintf(' class="%s"', column['class']),
order = that.options.sortOrder || column.order,
unitWidth = 'px',
width = column.width; // width输入宽度有%或px时，分割%或px到unitWidth中，width保留数字字符串
// width输入数值时，unitWidth默认取px
if (column.width !== undefined && (!that.options.cardView)) {
if (typeof column.width === 'string') {
if (column.width.indexOf('%') !== -1) {
unitWidth = '%';
}
}
}
if (column.width && typeof column.width === 'string') {
width = column.width.replace('%', '').replace('px', '');
} halign = sprintf('text-align: %s; ', column.halign ? column.halign : column.align);
align = sprintf('text-align: %s; ', column.align);
style = sprintf('vertical-align: %s; ', column.valign);
style += sprintf('width: %s; ', (column.checkbox || column.radio) && !width ?
'36px' : (width ? width + unitWidth : undefined)); /**
* this.header.styles、this.header.classes:
* 数组形式存储经过处理的每列数据的样式、类;
* this.header.formatters、this.header.cellStyles、this.header.sorters:
* 数组形式存储格式化函数、设置单元格样式函数、排序函数，或者window方法名;
* this.header.events、this.header.sortNames、this.header.searchables:
* 数组形式存储表体相应标题栏配置的事件events、上传排序的字段名sortName、可搜索searchable;
*/
// 填充触发元素的tbody内容块时使用
if (typeof column.fieldIndex !== 'undefined') {
that.header.fields[column.fieldIndex] = column.field;
that.header.styles[column.fieldIndex] = align + style;
that.header.classes[column.fieldIndex] = class_;
that.header.formatters[column.fieldIndex] = column.formatter;
that.header.events[column.fieldIndex] = column.events;
that.header.sorters[column.fieldIndex] = column.sorter;
that.header.sortNames[column.fieldIndex] = column.sortName;
that.header.cellStyles[column.fieldIndex] = column.cellStyle;
that.header.searchables[column.fieldIndex] = column.searchable; if (!column.visible) {
return;
} if (that.options.cardView && (!column.cardVisible)) {
return;
} visibleColumns[column.field] = column;
} // options.columns数据回显和渲染页面
html.push('<th' + sprintf(' title="%s"', column.titleTooltip),
column.checkbox || column.radio ?
sprintf(' class="bs-checkbox %s"', column['class'] || '') :
class_,
sprintf(' style="%s"', halign + style),
sprintf(' rowspan="%s"', column.rowspan),
sprintf(' colspan="%s"', column.colspan),
sprintf(' data-field="%s"', column.field),
"tabindex='0'",
'>'); html.push(sprintf('<div class="th-inner %s">', that.options.sortable && column.sortable ?
'sortable both' : '')); text = column.title; if (column.checkbox) {
if (!that.options.singleSelect && that.options.checkboxHeader) {
text = '<input name="btSelectAll" type="checkbox" />';
}
that.header.stateField = column.field;// 复选框内容上传时的字段名
}
if (column.radio) {
text = '';
that.header.stateField = column.field;
that.options.singleSelect = true;
} html.push(text);
html.push('</div>');
html.push('<div class="fht-cell"></div>');
html.push('</div>');
html.push('</th>');
});
html.push('</tr>');
}); this.$header.html(html.join(''));
this.$header.find('th[data-field]').each(function (i) {
// 标题栏data属性写入各自的column数据，展开卡片式详情时使用
$(this).data(visibleColumns[$(this).data('field')]);
}); // 绑定点击排序事件
this.$container.off('click', '.th-inner').on('click', '.th-inner', function (event) {
var target = $(this);
if (target.closest('.bootstrap-table')[0] !== that.$container[0])
return false; if (that.options.sortable && target.parent().data().sortable) {
that.onSort(event);
}
}); // 确认键排序
this.$header.children().children().off('keypress').on('keypress', function (event) {
if (that.options.sortable && $(this).data().sortable) {
var code = event.keyCode || event.which;
if (code == 13) { //Enter keycode
that.onSort(event);
}
}
}); // 显示隐藏表头，调整this.$tableLoading位置;options.cardView为真时卡片式显示隐藏表头
if (!this.options.showHeader || this.options.cardView) {
this.$header.hide();
this.$tableHeader.hide();
this.$tableLoading.css('top', 0);
} else {
this.$header.show();
this.$tableHeader.show();
this.$tableLoading.css('top', this.$header.outerHeight() + 1); this.getCaret();// 更新排序箭头显示情况
} // 全选
this.$selectAll = this.$header.find('[name="btSelectAll"]');
this.$selectAll.off('click').on('click', function () {
var checked = $(this).prop('checked');
that[checked ? 'checkAll' : 'uncheckAll']();// 改变复选框勾选状态，更新上传数据
that.updateSelected();// tr添加selected类
});
}; // 显示隐藏表尾
BootstrapTable.prototype.initFooter = function () {
if (!this.options.showFooter || this.options.cardView) {
this.$tableFooter.hide();
} else {
this.$tableFooter.show();
}
}; // 页面初始化时this.data赋值为this.options.data;
// ajax交互时this.data赋值为后台返回的数据，options.data也同样更新为后台返回的数据;
// type为append时，表格尾部插入数据，this.data、options.data尾部插入相应数据;
// type为prepend时，表格顶部插入数据，this.data、options.data头部插入相应数据;
// 前台分页的情况下调用this.initSort，后台分页以返回数据为准;
BootstrapTable.prototype.initData = function (data, type) {
if (type === 'append') {
this.data = this.data.concat(data);
} else if (type === 'prepend') {
this.data = [].concat(data).concat(this.data);
} else {
this.data = data || this.options.data;
} if (type === 'append') {
this.options.data = this.options.data.concat(data);
} else if (type === 'prepend') {
this.options.data = [].concat(data).concat(this.options.data);
} else {
this.options.data = this.data;
} if (this.options.sidePagination === 'server') {
return;
}
this.initSort();
}; // onSort方法设置点击排序按钮时，更新options.sortName为相应标题栏column.field值;
// initSort由column.field值获得相应的sortName;
// 调用option.sorter函数或window[option.sorter]方法进行比较排序;
// 或者直接比较data[sortName]进行排序;
// 排序通过更新this.data数据实现,this.data渲染到页面使用initBody方法;
BootstrapTable.prototype.initSort = function () {
var that = this,
name = this.options.sortName,
order = this.options.sortOrder === 'desc' ? -1 : 1,
index = $.inArray(this.options.sortName, this.header.fields); if (index !== -1) {
this.data.sort(function (a, b) {
if (that.header.sortNames[index]) {
name = that.header.sortNames[index];// 获取colum.sortName
}
// 获取每行数据的data[sortName]的值，转义后返回
var aa = getItemField(a, name, that.options.escape),
bb = getItemField(b, name, that.options.escape),
// 调用column.sorter函数或window[column.sorter]方法进行比较，上下文是that.header
value = calculateObjectValue(that.header, that.header.sorters[index], [aa, bb]); if (value !== undefined) {
return order * value;
} if (aa === undefined || aa === null) {
aa = '';
}
if (bb === undefined || bb === null) {
bb = '';
} if ($.isNumeric(aa) && $.isNumeric(bb)) {
aa = parseFloat(aa);
bb = parseFloat(bb);
if (aa < bb) {
return order * -1;
}
return order;
} if (aa === bb) {
return 0;
} if (typeof aa !== 'string') {
aa = aa.toString();
} if (aa.localeCompare(bb) === -1) {//bb为何不要转换？
return order * -1;
} return order;
});
}
}; // 点击排序时更新options.sortName为被排序列数据对应column[field]值，以便initSort获取sortName;
// 更新options.sortOrder为被排序列数据对应column[order]值，或保持原有值;
// 触发sort事件，调用initServer获取后台数据，调用initSort排序、initBody渲染表体;
BootstrapTable.prototype.onSort = function (event) {
var $this = event.type === "keypress" ? $(event.currentTarget) : $(event.currentTarget).parent(),
$this_ = this.$header.find('th').eq($this.index());// 记录this.$header下相同元素 this.$header.add(this.$header_).find('span.order').remove(); // options.sortName更新被排序列数据对应column[field]值，以便initSort获取sortName加以比较;
if (this.options.sortName === $this.data('field')) {
this.options.sortOrder = this.options.sortOrder === 'asc' ? 'desc' : 'asc';
} else {
this.options.sortName = $this.data('field');
this.options.sortOrder = $this.data('order') === 'asc' ? 'desc' : 'asc';
}
this.trigger('sort', this.options.sortName, this.options.sortOrder); $this.add($this_).data('order', this.options.sortOrder); this.getCaret();// 更新排序箭头样式 if (this.options.sidePagination === 'server') {
this.initServer(this.options.silentSort);
return;
} this.initSort();
this.initBody();
}; // 创建工具栏内的用户自定义按钮组、分页显示隐藏切换按钮、刷新按钮、筛选条目按钮
// 以及卡片表格显示切换按钮、搜索框，并绑定相应事件；
// 筛选条目时触发column-switch事件;
BootstrapTable.prototype.initToolbar = function () {
var that = this,
html = [],
timeoutId = 0,
$keepOpen,
$search,
switchableCount = 0; if (this.$toolbar.find('.bars').children().length) {
$('body').append($(this.options.toolbar));
}
this.$toolbar.html(''); if (typeof this.options.toolbar === 'string' || typeof this.options.toolbar === 'object') {
$(sprintf('<div class="bars pull-%s"></div>', this.options.toolbarAlign))
.appendTo(this.$toolbar)
.append($(this.options.toolbar));
// $(this.options.toolbar)引用对象形式，只会在页面上创建一次
} html = [sprintf('<div class="columns columns-%s btn-group pull-%s">',
this.options.buttonsAlign, this.options.buttonsAlign)]; if (typeof this.options.icons === 'string') {
// 调用window[options.icons]函数显示按钮列表
this.options.icons = calculateObjectValue(null, this.options.icons);
} // 显示隐藏分页按钮
if (this.options.showPaginationSwitch) {
html.push(sprintf('<button class="btn btn-default" type="button" name="paginationSwitch" title="%s">',
this.options.formatPaginationSwitch()),
sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.paginationSwitchDown),
'</button>');
} // 刷新按钮
if (this.options.showRefresh) {
html.push(sprintf('<button class="btn btn-default' +
sprintf(' btn-%s', this.options.iconSize) +
'" type="button" name="refresh" title="%s">',
this.options.formatRefresh()),
sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.refresh),
'</button>');
} // 卡片式显示或表格详情显示切换按钮
if (this.options.showToggle) {
html.push(sprintf('<button class="btn btn-default' +
sprintf(' btn-%s', this.options.iconSize) +
'" type="button" name="toggle" title="%s">',
this.options.formatToggle()),
sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.toggle),
'</button>');
} // 筛选条目按钮，并创建下拉列表
if (this.options.showColumns) {
html.push(sprintf('<div class="keep-open btn-group" title="%s">',
this.options.formatColumns()),
'<button type="button" class="btn btn-default' +
sprintf(' btn-%s', this.options.iconSize) +
' dropdown-toggle" data-toggle="dropdown">',
sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.columns),
' <span class="caret"></span>',
'</button>',
'<ul class="dropdown-menu" role="menu">'); $.each(this.columns, function (i, column) {
if (column.radio || column.checkbox) {
return;
} if (that.options.cardView && (!column.cardVisible)) {
return;
} var checked = column.visible ? ' checked="checked"' : ''; if (column.switchable) {
html.push(sprintf('<li>' +
'<label><input type="checkbox" data-field="%s" value="%s"%s> %s</label>' +
'</li>', column.field, i, checked, column.title));
switchableCount++;
}
});
html.push('</ul>',
'</div>');
} html.push('</div>'); if (this.showToolbar || html.length > 2) {
this.$toolbar.append(html.join(''));
} // 绑定分页显示隐藏按钮点击事件
if (this.options.showPaginationSwitch) {
this.$toolbar.find('button[name="paginationSwitch"]')
.off('click').on('click', $.proxy(this.togglePagination, this));
} // 绑定刷新按钮点击事件
if (this.options.showRefresh) {
this.$toolbar.find('button[name="refresh"]')
.off('click').on('click', $.proxy(this.refresh, this));
} // 绑定卡片式显示、表格详情显示切换按钮点击事件
if (this.options.showToggle) {
this.$toolbar.find('button[name="toggle"]')
.off('click').on('click', function () {
that.toggleView();
});
} // 帮点筛选条目下拉列表中复选框的点击事件，筛选条目按钮点击事件由bootstrap提供
if (this.options.showColumns) {
$keepOpen = this.$toolbar.find('.keep-open'); if (switchableCount <= this.options.minimumCountColumns) {
$keepOpen.find('input').prop('disabled', true);
} $keepOpen.find('li').off('click').on('click', function (event) {
event.stopImmediatePropagation();// 阻止事件冒泡，并阻止同类型事件的冒泡
});
$keepOpen.find('input').off('click').on('click', function () {
var $this = $(this); that.toggleColumn(getFieldIndex(that.columns,
$(this).data('field')), $this.prop('checked'), false);
that.trigger('column-switch', $(this).data('field'), $this.prop('checked'));
});
} // 创建搜索框，并绑定搜索事件
if (this.options.search) {
html = [];
html.push(
'<div class="pull-' + this.options.searchAlign + ' search">',
sprintf('<input class="form-control' +
sprintf(' input-%s', this.options.iconSize) +
'" type="text" placeholder="%s">',
this.options.formatSearch()),
'</div>'); this.$toolbar.append(html.join(''));
$search = this.$toolbar.find('.search input');
$search.off('keyup drop').on('keyup drop', function (event) {
if (that.options.searchOnEnterKey) {
if (event.keyCode !== 13) {
return;
}
} clearTimeout(timeoutId);
timeoutId = setTimeout(function () {
that.onSearch(event);
}, that.options.searchTimeOut);
}); if (isIEBrowser()) {
$search.off('mouseup').on('mouseup', function (event) {
clearTimeout(timeoutId);
timeoutId = setTimeout(function () {
that.onSearch(event);
}, that.options.searchTimeOut);
});
}
}
}; // this.text，this.options.text设为搜索框去除两端空白的值，pageNumber设为1;
// 调用initSearch将筛选本地数据;调用updatePagination完成远程交互或单渲染本地数据;
// 触发search事件;
BootstrapTable.prototype.onSearch = function (event) {
var text = $.trim($(event.currentTarget).val()); if (this.options.trimOnSearch && $(event.currentTarget).val() !== text) {
$(event.currentTarget).val(text);
} if (text === this.searchText) {
return;
}
this.searchText = text;
this.options.searchText = text; this.options.pageNumber = 1;
this.initSearch();
this.updatePagination();
this.trigger('search', text);
}; // 前台分页的情况下，先通过this.filterColumns通过this.option.data过滤this.data数据;
// 再通过搜索文本过滤this.data数据;
// 输入文本和经this.header.formatters或window[this.header.formatters]函数格式化匹配比对;
BootstrapTable.prototype.initSearch = function () {
var that = this; if (this.options.sidePagination !== 'server') {
var s = this.searchText && this.searchText.toLowerCase();
var f = $.isEmptyObject(this.filterColumns) ? null : this.filterColumns; // options.data和this.filterColumns相符则在this.data中保留，不相符则在this.data中删除
this.data = f ? $.grep(this.options.data, function (item, i) {
for (var key in f) {
if ($.isArray(f[key])) {
if ($.inArray(item[key], f[key]) === -1) {
return false;
}
} else if (item[key] !== f[key]) {
return false;
}
}
return true;
}) : this.options.data; // 在前台分页的情况下检索数据，使用$.grep返回筛选后的数组内容
this.data = s ? $.grep(this.data, function (item, i) {
for (var key in item) {
key = $.isNumeric(key) ? parseInt(key, 10) : key;
var value = item[key],//data[key]
// 当key为field时，getFieldIndex获取相应列条目数据fieldIndex值，否则返回-1
// 问题，可以设置if语句排除key不等于field的情况，j和index等值
column = that.columns[getFieldIndex(that.columns, key)],
j = $.inArray(key, that.header.fields); if (column && column.searchFormatter) {
value = calculateObjectValue(column,
that.header.formatters[j], [value, item, i], value);
} var index = $.inArray(key, that.header.fields);
if (index !== -1 && that.header.searchables[index] && (typeof value === 'string' || typeof value === 'number')) {
if (that.options.strictSearch) {
if ((value + '').toLowerCase() === s) {
return true;
}
} else {
if ((value + '').toLowerCase().indexOf(s) !== -1) {
return true;
}
}
}
}
return false;
}) : this.data;
}
}; // 初始化设置分页相关页面信息显示情况，包括当前页显示第几条到第几天数据，共几条数据，每页显示几条数据;
// 以及每页显示数据量切换按钮，选择页面的分页栏显示情况，再绑定事件;
// 通过options.pageNumber获取this.pageFrom、this.pageTo，以便前台分页时initBody获取相应数据;
BootstrapTable.prototype.initPagination = function () {
if (!this.options.pagination) {
this.$pagination.hide();
return;
} else {
this.$pagination.show();
} var that = this,
html = [],
$allSelected = false,// 为真时，显示所有数据条目，同时显示数据量切换按钮文本改为options.formatAllRows()
i, from, to,
$pageList,
$first, $pre,
$next, $last,
$number,
data = this.getData(); if (this.options.sidePagination !== 'server') {
this.options.totalRows = data.length;// 数据总条数
} // this.options.totalRows数据总条数;
// this.options.pageSize一页显示几条数据，显示数据量切换按钮默认文本;
// this.totalPages总页数，与this.options.totalPages似没有差别，疑为插件作者未调优代码;
// this.options.totalPages总页数;
// this.options.pageNumber当前页页码;
// this.pageFrom当前页从总数据的第几条开始;
// this.pageTo当前页到总数据的第几条为止;
if (this.options.totalRows) {
// 当options.pageSize和options.formatAllRows()相同时，意味显示所有条目
// 或者options.pageSize即为options.totalRows总条目数，且options.formatAllRows()在pageList设置中
// $allSelected记为真，页面显示数据量切换按钮的显示文本为options.formatAllRows()
if (this.options.pageSize === this.options.formatAllRows()) {
this.options.pageSize = this.options.totalRows;
$allSelected = true;
} else if (this.options.pageSize === this.options.totalRows) {
var pageLst = typeof this.options.pageList === 'string' ?
this.options.pageList.replace('[', '').replace(']', '')
.replace(/ /g, '').toLowerCase().split(',') : this.options.pageList;// 每页显示数据条数列表项
if ($.inArray(this.options.formatAllRows().toLowerCase(), pageLst) > -1) {
$allSelected = true;
}
}
this.totalPages = ~~((this.options.totalRows - 1) / this.options.pageSize) + 1;
// -1针对this.options.totalRows是this.options.pageSize倍数的情况 this.options.totalPages = this.totalPages;
}
if (this.totalPages > 0 && this.options.pageNumber > this.totalPages) {
this.options.pageNumber = this.totalPages;
} this.pageFrom = (this.options.pageNumber - 1) * this.options.pageSize + 1;
this.pageTo = this.options.pageNumber * this.options.pageSize;
if (this.pageTo > this.options.totalRows) {
this.pageTo = this.options.totalRows;
} // 分页提示文案，即总共包含几条数据，或当前页从第几条到第几条
html.push(
'<div class="pull-' + this.options.paginationDetailHAlign + ' pagination-detail">',
'<span class="pagination-info">',
this.options.onlyInfoPagination ? this.options.formatDetailPagination(this.options.totalRows) :
this.options.formatShowingRows(this.pageFrom, this.pageTo, this.options.totalRows),
'</span>'); if (!this.options.onlyInfoPagination) {
html.push('<span class="page-list">'); // 分页提示文案，即每页显示几条数据，每页显示数据量下拉列表
var pageNumber = [
sprintf('<span class="btn-group %s">',
this.options.paginationVAlign === 'top' || this.options.paginationVAlign === 'both' ?
'dropdown' : 'dropup'),
'<button type="button" class="btn btn-default ' +
sprintf(' btn-%s', this.options.iconSize) +
' dropdown-toggle" data-toggle="dropdown">',
'<span class="page-size">',
$allSelected ? this.options.formatAllRows() : this.options.pageSize,
'</span>',
' <span class="caret"></span>',
'</button>',
'<ul class="dropdown-menu" role="menu">'
],
pageList = this.options.pageList; // 每页切换条目数下拉列表实现
if (typeof this.options.pageList === 'string') {
var list = this.options.pageList.replace('[', '').replace(']', '')
.replace(/ /g, '').split(','); pageList = [];
$.each(list, function (i, value) {
pageList.push(value.toUpperCase() === that.options.formatAllRows().toUpperCase() ?
that.options.formatAllRows() : +value);
});
}
$.each(pageList, function (i, page) {
// this.options.smartDisplay为真，当总页数为1时，屏蔽分页，以及下拉列表仅有一条时，屏蔽切换条目数按钮下拉功能
if (!that.options.smartDisplay || i === 0 || pageList[i - 1] <= that.options.totalRows) {
var active;
if ($allSelected) {
active = page === that.options.formatAllRows() ? ' class="active"' : '';
} else {
active = page === that.options.pageSize ? ' class="active"' : '';
}
pageNumber.push(sprintf('<li%s><a href="javascript:void(0)">%s</a></li>', active, page));
}
}); pageNumber.push('</ul></span>'); html.push(this.options.formatRecordsPerPage(pageNumber.join('')));
html.push('</span>'); // 分页
// 策略：通过from初始页、to结尾页，先设置首页起的显示情况，再设置...按钮的显示情况，接着尾页的显示情况
// 顺序设置，由一般到具体
html.push('</div>',
'<div class="pull-' + this.options.paginationHAlign + ' pagination">',
'<ul class="pagination' + sprintf(' pagination-%s', this.options.iconSize) + '">',
'<li class="page-pre"><a href="javascript:void(0)">' + this.options.paginationPreText + '</a></li>'); if (this.totalPages < 5) {
from = 1;
to = this.totalPages;
} else {
from = this.options.pageNumber - 2;
to = from + 4;
if (from < 1) {
from = 1;
to = 5;
}
if (to > this.totalPages) {
to = this.totalPages;
from = to - 4;
}
} // 总页数大于6时，显示第一页，最后一页，pageNumber--，pageNumber，pageNumber++，以及两串...
if (this.totalPages >= 6) {
if (this.options.pageNumber >= 3) {
html.push('<li class="page-first' + (1 === this.options.pageNumber ? ' active' : '') + '">',
'<a href="javascript:void(0)">', 1, '</a>',
'</li>'); from++;
} if (this.options.pageNumber >= 4) {
// from--显示第二页按钮
if (this.options.pageNumber == 4 || this.totalPages == 6 || this.totalPages == 7) {
from--;
} else {
html.push('<li class="page-first-separator disabled">',
'<a href="javascript:void(0)">...</a>',
'</li>');
} to--;
}
} // 根据上一条if语句form++的情况，pageNumber临近尾页的时候执行from--，显示后五条
if (this.totalPages >= 7) {
if (this.options.pageNumber >= (this.totalPages - 2)) {
from--;
}
} // 根据上一条if语句to--的情况，pageNumber挨近尾页的时候执行to--，显示后五条
if (this.totalPages == 6) {
if (this.options.pageNumber >= (this.totalPages - 2)) {
to++;
}
} else if (this.totalPages >= 7) {
if (this.totalPages == 7 || this.options.pageNumber >= (this.totalPages - 3)) {
to++;
}
} for (i = from; i <= to; i++) {
html.push('<li class="page-number' + (i === this.options.pageNumber ? ' active' : '') + '">',
'<a href="javascript:void(0)">', i, '</a>',
'</li>');
} if (this.totalPages >= 8) {
if (this.options.pageNumber <= (this.totalPages - 4)) {
html.push('<li class="page-last-separator disabled">',
'<a href="javascript:void(0)">...</a>',
'</li>');
}
} if (this.totalPages >= 6) {
if (this.options.pageNumber <= (this.totalPages - 3)) {
html.push('<li class="page-last' + (this.totalPages === this.options.pageNumber ? ' active' : '') + '">',
'<a href="javascript:void(0)">', this.totalPages, '</a>',
'</li>');
}
} html.push(
'<li class="page-next"><a href="javascript:void(0)">' + this.options.paginationNextText + '</a></li>',
'</ul>',
'</div>');
}
this.$pagination.html(html.join('')); if (!this.options.onlyInfoPagination) {
$pageList = this.$pagination.find('.page-list a');// 每页显示数据量切换按钮
$first = this.$pagination.find('.page-first');
$pre = this.$pagination.find('.page-pre');
$next = this.$pagination.find('.page-next');
$last = this.$pagination.find('.page-last');
$number = this.$pagination.find('.page-number'); if (this.options.smartDisplay) {
if (this.totalPages <= 1) {
this.$pagination.find('div.pagination').hide();
}
if (pageList.length < 2 || this.options.totalRows <= pageList[0]) {
this.$pagination.find('span.page-list').hide();
} this.$pagination[this.getData().length ? 'show' : 'hide']();
} if ($allSelected) {
this.options.pageSize = this.options.formatAllRows();
} // 绑定事件
$pageList.off('click').on('click', $.proxy(this.onPageListChange, this));
$first.off('click').on('click', $.proxy(this.onPageFirst, this));
$pre.off('click').on('click', $.proxy(this.onPagePre, this));
$next.off('click').on('click', $.proxy(this.onPageNext, this));
$last.off('click').on('click', $.proxy(this.onPageLast, this));
$number.off('click').on('click', $.proxy(this.onPageNumber, this));
}
}; // 分页点选按钮有disabled属性则返回，无则重新布局分页显示面板;
// maintainSelected为否时，调用resetRows重置复选框为不选中，调用initServer交互或initbody渲染页面;
// initSever由后台返回数据;
// initPagination通过options.pageNumber取得options.pageFrom、options.pageTo;
// initBody由options.pageFrom、options.pageTo获取需要渲染的数据data;
// 触发page-change事件;
BootstrapTable.prototype.updatePagination = function (event) {
// Fix #171: IE disabled button can be clicked bug.
if (event && $(event.currentTarget).hasClass('disabled')) {
return;
} if (!this.options.maintainSelected) {
this.resetRows();
} this.initPagination();
if (this.options.sidePagination === 'server') {
this.initServer();
} else {
this.initBody();
} this.trigger('page-change', this.options.pageNumber, this.options.pageSize);
}; // 每页显示数据量下拉列表选中时触发，替换每页显示数据量按钮文本;
// 更新options.pageSize，通过updatePagination调用initPagination设置this.pageFrom、this.pageTo;
// updatePagination再调用initServer完成交互，或initBody渲染本地数据;
BootstrapTable.prototype.onPageListChange = function (event) {
var $this = $(event.currentTarget); $this.parent().addClass('active').siblings().removeClass('active');
this.options.pageSize = $this.text().toUpperCase() === this.options.formatAllRows().toUpperCase() ?
this.options.formatAllRows() : +$this.text();
this.$toolbar.find('.page-size').text(this.options.pageSize); this.updatePagination(event);
}; // 更新options.pageNumber,通过updatePagination调用initPagination设置this.pageFrom、this.pageTo;
// updatePagination再调用initServer完成交互，或initBody渲染本地数据;
// 跳转分页首页
BootstrapTable.prototype.onPageFirst = function (event) {
this.options.pageNumber = 1;
this.updatePagination(event);
};
// 跳转分页上一页
BootstrapTable.prototype.onPagePre = function (event) {
if ((this.options.pageNumber - 1) == 0) {
this.options.pageNumber = this.options.totalPages;
} else {
this.options.pageNumber--;
}
this.updatePagination(event);
};
// 跳转分页下一页
BootstrapTable.prototype.onPageNext = function (event) {
if ((this.options.pageNumber + 1) > this.options.totalPages) {
this.options.pageNumber = 1;
} else {
this.options.pageNumber++;
}
this.updatePagination(event);
};
// 跳转尾页
BootstrapTable.prototype.onPageLast = function (event) {
this.options.pageNumber = this.totalPages;
this.updatePagination(event);
};
// 由页码跳转
BootstrapTable.prototype.onPageNumber = function (event) {
if (this.options.pageNumber === +$(event.currentTarget).text()) {
return;
}
this.options.pageNumber = +$(event.currentTarget).text();
this.updatePagination(event);
}; // fixedScroll为否的情况下，表体移动到顶部;
// 通过this.pageFrom、this.pageTo截取this.getData()数据row渲染表体，主要是tbody>tr以及tbody>tr>td;
// tbody>tr的data-index设为行号，class、id为row._class、row._id，样式、data数据通过调用函数获得;
// tbody>tr>td区分为卡片显示和表格显示两类，显示值取经this.header.formatters[i]处理后的row[field];
// tbody>tr>td其他class、id、title、data取row[_field_class]等;
// 绑定展开卡片详情按钮点击事件、复选框点击事件、this.header.events中的事件;
// 触发post-body、pre-body事件;
BootstrapTable.prototype.initBody = function (fixedScroll) {
var that = this,
html = [],
data = this.getData();// 获取搜索过滤后的数据
// data的数据格式为对象形式
// [{ // 行tr中的属性设置
// _data:{
// index:1,// 后续会自动赋值为数据在当前页的所在行号
// field:field
// },
// _id:id,
// _class:class,
// field1:value1,field2:value2, //填充在单元格中的显示内容，从this.header.fields数组中获取属性名field1等
// _field_id
// }] // 每一行特定的样式、属性根据this.options.rowStyle、this.options.rowAttributes获取
// 数组形式
// [["field","class"]] // 数组形式不能对每一行添加特定的data属性、id以及class
// // 特定的的样式、属性仍可由this.options.rowStyle、this.options.rowAttributes获取
// // 以及data-index添加行号、data-uniqueId每行的唯一标识，根据options.uniqueId从data中获取
//
// tr以及checkbox中data数组的序号data-index，以便于获取data[data-index]数据调用 this.trigger('pre-body', data); this.$body = this.$el.find('>tbody');
if (!this.$body.length) {
this.$body = $('<tbody></tbody>').appendTo(this.$el);
}// 页面初始化存在tbody>tr>td的情况下，this.options.data数据由initTable获取 //Fix #389 Bootstrap-table-flatJSON is not working
// 未作分页或后台分页的情况返回所有数据
if (!this.options.pagination || this.options.sidePagination === 'server') {
this.pageFrom = 1;
this.pageTo = data.length;
} for (var i = this.pageFrom - 1; i < this.pageTo; i++) {
var key,
item = data[i],// 行数据信息row
style = {},
csses = [],
data_ = '',
attributes = {},
htmlAttributes = []; // 通过options.rowStyle(row,index)函数或window[options.rowStyle](row,index)获取tbody>tr样式
style = calculateObjectValue(this.options, this.options.rowStyle, [item, i], style);
if (style && style.css) {
for (key in style.css) {
csses.push(key + ': ' + style.css[key]);
}
} // 通过options.rowAttributes(row,index)函数或window[options.rowAttributes](row,index)获取tbody>tr属性
attributes = calculateObjectValue(this.options,
this.options.rowAttributes, [item, i], attributes);
if (attributes) {
for (key in attributes) {
htmlAttributes.push(sprintf('%s="%s"', key, escapeHTML(attributes[key])));
}
} // 通过row._data，row._id，row._class，row[options.uniqueId]渲染tbody>tr
if (item._data && !$.isEmptyObject(item._data)) {
$.each(item._data, function (k, v) {
if (k === 'index') {
return;
}
data_ += sprintf(' data-%s="%s"', k, v);
});
} html.push('<tr',
sprintf(' %s', htmlAttributes.join(' ')),
sprintf(' id="%s"', $.isArray(item) ? undefined : item._id),
sprintf(' class="%s"', style.classes || ($.isArray(item) ? undefined : item._class)),
sprintf(' data-index="%s"', i),
sprintf(' data-uniqueid="%s"', item[this.options.uniqueId]),
sprintf('%s', data_),
'>'
); // 卡片式显示跨列
if (this.options.cardView) {
html.push(sprintf('<td colspan="%s">', this.header.fields.length));
} // 表格显示时添加每行数据前点击展示卡片式详情按钮
if (!this.options.cardView && this.options.detailView) {
html.push('<td>',
'<a class="detail-icon" href="javascript:">',
sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.detailOpen),
'</a>',
'</td>');
} // 遍历this.header.fields获取主键field值，再由主键field拼接row中的属性取值，包括row[field]
// 显示文本row[field]调用对应的this.header.formatter[j]处理后获取
// j即列坐标
$.each(this.header.fields, function (j, field) {
var text = '',
value = getItemField(item, field, that.options.escape),// 获取row[field]
type = '',
cellStyle = {},
id_ = '',
class_ = that.header.classes[j],
data_ = '',
rowspan_ = '',
title_ = '',
column = that.columns[getFieldIndex(that.columns, field)]; if (!column.visible) {// 筛选时设置
return;
} style = sprintf('style="%s"', csses.concat(that.header.styles[j]).join('; ')); // 调用that.header.formatters[j](item.field,item,i)格式化显示内容
// 特别当单元格是复选框的时候，value返回值可以是对象形式{checked:true;disabled:true}，此时无显示文本
value = calculateObjectValue(column,
that.header.formatters[j], [value, item, i], value); if (item['_' + field + '_id']) {
id_ = sprintf(' id="%s"', item['_' + field + '_id']);
}
if (item['_' + field + '_class']) {
class_ = sprintf(' class="%s"', item['_' + field + '_class']);
}
if (item['_' + field + '_rowspan']) {
rowspan_ = sprintf(' rowspan="%s"', item['_' + field + '_rowspan']);
}
if (item['_' + field + '_title']) {
title_ = sprintf(' title="%s"', item['_' + field + '_title']);
}
// 调用that.header.cellStyles[j](item.field,item,i)设置单元格显示样式
cellStyle = calculateObjectValue(that.header,
that.header.cellStyles[j], [value, item, i], cellStyle);
if (cellStyle.classes) {
class_ = sprintf(' class="%s"', cellStyle.classes);
}
if (cellStyle.css) {
var csses_ = [];
for (var key in cellStyle.css) {
csses_.push(key + ': ' + cellStyle.css[key]);
}
style = sprintf('style="%s"', csses_.concat(that.header.styles[j]).join('; '));
} if (item['_' + field + '_data'] && !$.isEmptyObject(item['_' + field + '_data'])) {
$.each(item['_' + field + '_data'], function (k, v) {
if (k === 'index') {
return;
}
data_ += sprintf(' data-%s="%s"', k, v);
});
} if (column.checkbox || column.radio) {
type = column.checkbox ? 'checkbox' : type;
type = column.radio ? 'radio' : type; text = [sprintf(that.options.cardView ?
'<div class="card-view %s">' : '<td class="bs-checkbox %s">', column['class'] || ''),
'<input' +
sprintf(' data-index="%s"', i) +
sprintf(' name="%s"', that.options.selectItemName) +
sprintf(' type="%s"', type) +
sprintf(' value="%s"', item[that.options.idField]) +
sprintf(' checked="%s"', value === true ||
(value && value.checked) ? 'checked' : undefined) +
sprintf(' disabled="%s"', !column.checkboxEnabled ||
(value && value.disabled) ? 'disabled' : undefined) +
' />',
that.header.formatters[j] && typeof value === 'string' ? value : '',
that.options.cardView ? '</div>' : '</td>'
].join(''); // 复选框上传内容字段名属性后添加true选中/false未选中值
item[that.header.stateField] = value === true || (value && value.checked);
} else {
value = typeof value === 'undefined' || value === null ?
that.options.undefinedText : value; // getPropertyFromOther卡片式显示时获取标题栏的文本内容
text = that.options.cardView ? ['<div class="card-view">',
that.options.showHeader ? sprintf('<span class="title" %s>%s</span>', style,
getPropertyFromOther(that.columns, 'field', 'title', field)) : '',
sprintf('<span class="value">%s</span>', value),
'</div>'
].join('') : [sprintf('<td%s %s %s %s %s %s>', id_, class_, style, data_, rowspan_, title_),
value,
'</td>'
].join(''); if (that.options.cardView && that.options.smartDisplay && value === '') {
// 占位符，以利于根据元素序号准确地绑定事件
text = '<div class="card-view"></div>';
}
} html.push(text);
}); if (this.options.cardView) {
html.push('</td>');
} html.push('</tr>');
} if (!html.length) {
html.push('<tr class="no-records-found">',
sprintf('<td colspan="%s">%s</td>',
this.$header.find('th').length, this.options.formatNoMatches()),
'</tr>');
} this.$body.html(html.join('')); if (!fixedScroll) {
this.scrollTo(0);
} // 点击单元格触发单元格以及当前行点击事件，复选框则勾选
this.$body.find('> tr[data-index] > td').off('click dblclick').on('click dblclick', function (e) {
var $td = $(this),
$tr = $td.parent(),
item = that.data[$tr.data('index')],// 获取当前行的data[data-index]数据调用
index = $td[0].cellIndex,// 返回一行内单元格所在的列坐标
field = that.header.fields[that.options.detailView && !that.options.cardView ? index - 1 : index],
column = that.columns[getFieldIndex(that.columns, field)],
value = getItemField(item, field, that.options.escape); if ($td.find('.detail-icon').length) {
return;
} // 单元格点击事件传入单元格的field（借此获取data中的有关数据）、显示内容value值data[data-index][field]、
// 当前行data数据item值data[data-index]、单元格jquery对象$td
that.trigger(e.type === 'click' ? 'click-cell' : 'dbl-click-cell', field, value, item, $td);
// 行点击事件传入当前行data数据item值data[data-index]以及当前行jquery对象$tr
that.trigger(e.type === 'click' ? 'click-row' : 'dbl-click-row', item, $tr); if (e.type === 'click' && that.options.clickToSelect && column.clickToSelect) {
var $selectItem = $tr.find(sprintf('[name="%s"]', that.options.selectItemName));
if ($selectItem.length) {
$selectItem[0].click(); // #144: .trigger('click') bug
}
}
}); // 展开折叠卡片式详情
this.$body.find('> tr[data-index] > td > .detail-icon').off('click').on('click', function () {
var $this = $(this),
$tr = $this.parent().parent(),
index = $tr.data('index'),
row = data[index]; // Fix #980 Detail view, when searching, returns wrong row if ($tr.next().is('tr.detail-view')) {
$this.find('i').attr('class', sprintf('%s %s', that.options.iconsPrefix, that.options.icons.detailOpen));
$tr.next().remove();
that.trigger('collapse-row', index, row);
} else {
$this.find('i').attr('class', sprintf('%s %s', that.options.iconsPrefix, that.options.icons.detailClose));
$tr.after(sprintf('<tr class="detail-view"><td colspan="%s"></td></tr>', $tr.find('td').length));
var $element = $tr.next().find('td');
// options.detailFormatter执行后渲染折叠式卡片详情文本内容，包含html标签、Dom元素
var content = calculateObjectValue(that.options, that.options.detailFormatter, [index, row, $element], '');
if($element.length === 1) {
$element.append(content);
}
that.trigger('expand-row', index, row, $element);
}
that.resetView();
}); // 绑定复选框点击事件
this.$selectItem = this.$body.find(sprintf('[name="%s"]', this.options.selectItemName));
this.$selectItem.off('click').on('click', function (event) {
event.stopImmediatePropagation(); var $this = $(this),
checked = $this.prop('checked'),
row = that.data[$this.data('index')]; if (that.options.maintainSelected && $(this).is(':radio')) {
$.each(that.options.data, function (i, row) {
row[that.header.stateField] = false;
});
} row[that.header.stateField] = checked; if (that.options.singleSelect) {
that.$selectItem.not(this).each(function () {
that.data[$(this).data('index')][that.header.stateField] = false;
});
that.$selectItem.filter(':checked').not(this).prop('checked', false);
} that.updateSelected();
that.trigger(checked ? 'check' : 'uncheck', row, $this);
}); // 由this.header.events为tbody>tr>td中子元素绑定事件
$.each(this.header.events, function (i, events) {
if (!events) {
return;
}
// fix bug, if events is defined with namespace
if (typeof events === 'string') {
events = calculateObjectValue(null, events);
} var field = that.header.fields[i],
fieldIndex = $.inArray(field, that.getVisibleFields()); if (that.options.detailView && !that.options.cardView) {
fieldIndex += 1;
} for (var key in events) {
that.$body.find('>tr:not(.no-records-found)').each(function () {
var $tr = $(this),
$td = $tr.find(that.options.cardView ? '.card-view' : 'td').eq(fieldIndex),
index = key.indexOf(' '),
name = key.substring(0, index),
el = key.substring(index + 1),
func = events[key]; $td.find(el).off(name).on(name, function (e) {
var index = $tr.data('index'),
row = that.data[index],
value = row[field]; func.apply(this, [e, value, row, index]);
});
});
}
}); this.updateSelected();
this.resetView(); this.trigger('post-body');
}; // 触发ajax事件（可以是用户自定义的方法options.ajax），上传数据格式为
// {
// searchText:this.searchText,
// sortName:this.options.sortName,
// sortOrder:this.options.sortOrder,
// pageSize/limit:...,
// pageNumber/offset:...,
// [filter]:...,
// query:...
// }
// 触发上传成功调用this.load方法，触发load-success事件、上传失败load-error事件
BootstrapTable.prototype.initServer = function (silent, query) {
var that = this,
data = {},
params = {
searchText: this.searchText,
sortName: this.options.sortName,
sortOrder: this.options.sortOrder
},
request;// ajax配置 if(this.options.pagination) {
params.pageSize = this.options.pageSize === this.options.formatAllRows() ?
this.options.totalRows : this.options.pageSize;
params.pageNumber = this.options.pageNumber;
} if (!this.options.url && !this.options.ajax) {
return;
} // 意义？？？
if (this.options.queryParamsType === 'limit') {
params = {
search: params.searchText,
sort: params.sortName,
order: params.sortOrder
};
if (this.options.pagination) {
params.limit = this.options.pageSize === this.options.formatAllRows() ?
this.options.totalRows : this.options.pageSize;
params.offset = this.options.pageSize === this.options.formatAllRows() ?
0 : this.options.pageSize * (this.options.pageNumber - 1);
}
} // this.filterColumnsPartial用于设置后台过滤？？？
if (!($.isEmptyObject(this.filterColumnsPartial))) {
params['filter'] = JSON.stringify(this.filterColumnsPartial, null);
} // 调用options.queryParams处理上传的内容param，包括搜索文本、排序字段、排序方式
// 以及当前页显示几条数据、当前页数或limit、offset
data = calculateObjectValue(this.options, this.options.queryParams, [params], data); $.extend(data, query || {}); if (data === false) {
return;
} if (!silent) {
this.$tableLoading.show();
}
request = $.extend({}, calculateObjectValue(null, this.options.ajaxOptions), {
type: this.options.method,
url: this.options.url,
data: this.options.contentType === 'application/json' && this.options.method === 'post' ?
JSON.stringify(data) : data,
cache: this.options.cache,
contentType: this.options.contentType,
dataType: this.options.dataType,
success: function (res) {
res = calculateObjectValue(that.options, that.options.responseHandler, [res], res);
that.load(res);
that.trigger('load-success', res);
if (!silent) that.$tableLoading.hide();
},
error: function (res) {
that.trigger('load-error', res.status, res);
if (!silent) that.$tableLoading.hide();
}
}); if (this.options.ajax) {
calculateObjectValue(this, this.options.ajax, [request], null);
} else {
$.ajax(request);
}
}; // 初始化若设置搜索文本，开启搜索，不支持本地数据搜索
BootstrapTable.prototype.initSearchText = function () {
if (this.options.search) {
if (this.options.searchText !== '') {
var $search = this.$toolbar.find('.search input');
$search.val(this.options.searchText);
this.onSearch({currentTarget: $search});
}
}
}; // getCaret改变排序点击箭头的上下方向
BootstrapTable.prototype.getCaret = function () {
var that = this; $.each(this.$header.find('th'), function (i, th) {
$(th).find('.sortable').removeClass('desc asc').addClass($(th).data('field') === that.options.sortName ? that.options.sortOrder : 'both');
});
}; // 全选以及全不选时改变全选复选框的勾选状态，以及tr行添加或删除selected类
BootstrapTable.prototype.updateSelected = function () {
var checkAll = this.$selectItem.filter(':enabled').length &&
this.$selectItem.filter(':enabled').length ===
this.$selectItem.filter(':enabled').filter(':checked').length; this.$selectAll.add(this.$selectAll_).prop('checked', checkAll); this.$selectItem.each(function () {
$(this).closest('tr')[$(this).prop('checked') ? 'addClass' : 'removeClass']('selected');
});
}; // 复选框选中或撤销选中后更新this.data数据中的[this.header.stateField]属性，以便上传复选框的状态
BootstrapTable.prototype.updateRows = function () {
var that = this; this.$selectItem.each(function () {
that.data[$(this).data('index')][that.header.stateField] = $(this).prop('checked');
});
}; // 重置，撤销复选框选中，以及data[i][that.header.stateField]赋值为false
BootstrapTable.prototype.resetRows = function () {
var that = this; $.each(this.data, function (i, row) {
that.$selectAll.prop('checked', false);
that.$selectItem.prop('checked', false);
if (that.header.stateField) {
row[that.header.stateField] = false;
}
});
}; // 执行this.options[BootstrapTable.EVENTS[name]]函数(类似浏览器默认事件)，并触发事件
BootstrapTable.prototype.trigger = function (name) {
var args = Array.prototype.slice.call(arguments, 1); name += '.bs.table';
this.options[BootstrapTable.EVENTS[name]].apply(this.options, args);
this.$el.trigger($.Event(name), args); this.options.onAll(name, args);
this.$el.trigger($.Event('all.bs.table'), [name, args]);
}; // 一定时间内触发this.fitHeader函数调整表头的水平偏移，垂直滚动不影响表头
BootstrapTable.prototype.resetHeader = function () {
// fix #61: the hidden table reset header bug.
// fix bug: get $el.css('width') error sometime (height = 500)
clearTimeout(this.timeoutId_);
this.timeoutId_ = setTimeout($.proxy(this.fitHeader, this), this.$el.is(':hidden') ? 100 : 0);
}; // 克隆this.$el中的表头，置入this.$tableHeader中，出使垂直滚动时，表头信息不变
// 调整表体水平偏移量和表体水平一致
BootstrapTable.prototype.fitHeader = function () {
var that = this,
fixedBody,
scrollWidth,
focused,
focusedTemp; if (that.$el.is(':hidden')) {
that.timeoutId_ = setTimeout($.proxy(that.fitHeader, that), 100);
return;
}
fixedBody = this.$tableBody.get(0);// 包裹表单的.fixed-table-body元素 // .fixed-table-container有固定高度，其子元素.fixed-table-body超过该高度就显示滚动条
scrollWidth = fixedBody.scrollWidth > fixedBody.clientWidth &&
fixedBody.scrollHeight > fixedBody.clientHeight + this.$header.outerHeight() ?
getScrollBarWidth() : 0; this.$el.css('margin-top', -this.$header.outerHeight()); // 表头聚焦的元素添加focus-temp类，从而使this.$tableHeader的同个元素获得焦点
focused = $(':focus');
if (focused.length > 0) {
var $th = focused.parents('th');
if ($th.length > 0) {
var dataField = $th.attr('data-field');
if (dataField !== undefined) {
var $headerTh = this.$header.find("[data-field='" + dataField + "']");
if ($headerTh.length > 0) {
$headerTh.find(":input").addClass("focus-temp");
}
}
}
} this.$header_ = this.$header.clone(true, true);
this.$selectAll_ = this.$header_.find('[name="btSelectAll"]');
this.$tableHeader.css({
'margin-right': scrollWidth
}).find('table').css('width', this.$el.outerWidth())
.html('').attr('class', this.$el.attr('class'))
.append(this.$header_); focusedTemp = $('.focus-temp:visible:eq(0)');
if (focusedTemp.length > 0) {
focusedTemp.focus();
this.$header.find('.focus-temp').removeClass('focus-temp');
} // fix bug: $.data() is not working as expected after $.append()
// that.$header_是jquery对象，如果改变了this的值，$(this).data()获取内容和bug是咋回事？？？
this.$header.find('th[data-field]').each(function (i) {
that.$header_.find(sprintf('th[data-field="%s"]', $(this).data('field'))).data($(this).data());
}); var visibleFields = this.getVisibleFields(); // 标题栏单元格中的.fht-cell元素和表格中元素的宽度相一致，意义？？？
this.$body.find('>tr:first-child:not(.no-records-found) > *').each(function (i) {
var $this = $(this),
index = i; if (that.options.detailView && !that.options.cardView) {
if (i === 0) {
that.$header_.find('th.detail').find('.fht-cell').width($this.innerWidth());
}
index = i - 1;
} that.$header_.find(sprintf('th[data-field="%s"]', visibleFields[index]))
.find('.fht-cell').width($this.innerWidth());
}); // 当窗口缩放时，出现滚动条，表头表尾水平偏移情况相当
this.$tableBody.off('scroll').on('scroll', function () {
that.$tableHeader.scrollLeft($(this).scrollLeft()); if (that.options.showFooter && !that.options.cardView) {
that.$tableFooter.scrollLeft($(this).scrollLeft());
}
});
that.trigger('post-header');
}; // 创建表尾，利用footerFormatter填充表尾内容，调用fitFooter调整表尾偏移
BootstrapTable.prototype.resetFooter = function () {
var that = this,
data = that.getData(),
html = []; if (!this.options.showFooter || this.options.cardView) {
return;
} if (!this.options.cardView && this.options.detailView) {
html.push('<td><div class="th-inner"> </div><div class="fht-cell"></div></td>');
} $.each(this.columns, function (i, column) {
var falign = '',
style = '',
class_ = sprintf(' class="%s"', column['class']); if (!column.visible) {
return;
} if (that.options.cardView && (!column.cardVisible)) {
return;
} falign = sprintf('text-align: %s; ', column.falign ? column.falign : column.align);
style = sprintf('vertical-align: %s; ', column.valign); html.push('<td', class_, sprintf(' style="%s"', falign + style), '>');
html.push('<div class="th-inner">'); html.push(calculateObjectValue(column, column.footerFormatter, [data], ' ') || ' '); html.push('</div>');
html.push('<div class="fht-cell"></div>');
html.push('</div>');
html.push('</td>');
}); this.$tableFooter.find('tr').html(html.join(''));
clearTimeout(this.timeoutFooter_);
this.timeoutFooter_ = setTimeout($.proxy(this.fitFooter, this),
this.$el.is(':hidden') ? 100 : 0);
}; // 调整表尾水平偏移，设置表尾fnt-cell的宽度
BootstrapTable.prototype.fitFooter = function () {
var that = this,
$footerTd,
elWidth,
scrollWidth; clearTimeout(this.timeoutFooter_);
if (this.$el.is(':hidden')) {
this.timeoutFooter_ = setTimeout($.proxy(this.fitFooter, this), 100);
return;
} elWidth = this.$el.css('width');
scrollWidth = elWidth > this.$tableBody.width() ? getScrollBarWidth() : 0; this.$tableFooter.css({
'margin-right': scrollWidth
}).find('table').css('width', elWidth)
.attr('class', this.$el.attr('class')); $footerTd = this.$tableFooter.find('td'); this.$body.find('>tr:first-child:not(.no-records-found) > *').each(function (i) {
var $this = $(this); $footerTd.eq(i).find('.fht-cell').width($this.innerWidth());
});
}; // toggleColumn筛选条目下拉菜单点选时更新columns[i].visible信息;
// this.columns信息的改变，重新调用表头、表体、搜索框、分页初始化函数;
// 当勾选的显示条目小于this.options.minimumCountColumns时，勾选的条目设置disabled属性;
BootstrapTable.prototype.toggleColumn = function (index, checked, needUpdate) {
if (index === -1) {
return;
}
this.columns[index].visible = checked; this.initHeader();
this.initSearch();
this.initPagination();
this.initBody(); if (this.options.showColumns) {// this.options.showColumns显示筛选条目按钮
var $items = this.$toolbar.find('.keep-open input').prop('disabled', false); if (needUpdate) {
$items.filter(sprintf('[value="%s"]', index)).prop('checked', checked);
} if ($items.filter(':checked').length <= this.options.minimumCountColumns) {
$items.filter(':checked').prop('disabled', true);
}
}
}; // 从表体中找到data-index=index或data-uniqueid=uniqueId那一行，根据visible显示或隐藏
BootstrapTable.prototype.toggleRow = function (index, uniqueId, visible) {
if (index === -1) {
return;
} this.$body.find(typeof index !== 'undefined' ?
sprintf('tr[data-index="%s"]', index) :
sprintf('tr[data-uniqueid="%s"]', uniqueId))
[visible ? 'show' : 'hide']();
}; // 从this.column中剔除visible为false的项，返回field数组
BootstrapTable.prototype.getVisibleFields = function () {
var that = this,
visibleFields = []; $.each(this.header.fields, function (j, field) {
// this.columns以列坐标:数据的形式保存
var column = that.columns[getFieldIndex(that.columns, field)]; if (!column.visible) {
return;
}
visibleFields.push(field);
});
return visibleFields;
}; /**公共方法：通过bootstrap(fnName,argunments)调用
*
* resetView():
* 调整表体的高度;
* getData():
* 搜索过滤后的数据保存在this.data中，过滤前数据保存在options.data,针对数据在前台的情况;
* 有过滤数据，返回过滤数据this.data，无则返回未过滤数据this.options.data;
* 前台分页，获取this.pageFrom-1到this.pageTo的data数据或者整个data数据;
* load():
* 使用后台传回的数据或本地data数据更新data、搜索框、分页、表体显示;
* 后台传回数据格式为{total:,rows:,[fixedScroll]:};
* append():
* 从表格尾部插入数据;
* prepend():
* 从表格头部插入数据;
* remove():
* 移除指定行数据，通过行数据row中的某个属性比较删除拥有相同值的行数据data;
* param数据格式为{field:paramName,values:paramValues},paramName、paramValues和data对应;
* removeAll():
* 移除所有行数据;
* getRowByUniqueId():
* 获取row[options.uniqueId]或者row._data[options.uniqueId]同id相等的某一行数据;
* removeByUniqueId():
* 移除row[options.uniqueId]或者row._data[options.uniqueId]同id相等的某一行数据;
* updateByUniqueId():
* 更新替换某一行数据，参数格式为{id:row[options.uniqueId],row:row替换数据};
* insertRow():
* 在某一行后插入数据，参数格式为{index:index行号,row:row插入数据内容};
* updateRow():
* 更新替换某一行数据，参数格式为{index:index行号,row:row替换数据};
* showRow():
* 根据{[index:index],[uniqueid:uniqueId]}找到某一行，显示;
* hideRow():
* 根据{[index:index],[uniqueid:uniqueId]}找到某一行，隐藏;
* getRowsHidden():
* 获取并返回隐藏的行，根据show将这些行数据显示出来;
* mergeCells():
* 合并单元格，传参为{index:index.field:field,rowspan:3,colspan:4};
* 隐藏被合并单元格，重新设置显示单元格rowspan、colspan属性;
* updateCell():
* 更新单元的显示文本，传参为{index:index,field:field,value:value}，根据index、field找到单元格;
* getOptions():
* 返回配置项;
* getSelections():
* 通过过滤后的数据this.data返回选中行的数据;
* getAllSelections():
* 通过未过滤的数据this.options.data返回选中行的数据;
* checkAll():
* 全选;
* unCheckAll():
* 全不选;
* checkInvert():
* 反选;
* checkAll_():
* 全选或全不选执行函数;
* check():
* 选中;
* unCheck():
* 取消选中;
* check_():
* 选中、取消选中执行函数;
* checkBy():
* 选中某几行数据;
* unCheckBy():
* 取消选中某几行数据;
* checkBy_():
* 根据条件选中、取消选中某几行数据执行函数，obj参数格式为{field:paramName,values:paramValues};
* destory():
* 移出触发元素，其内容、样式通过this.$el_改为初始值，移除构造函数添加最外层包裹元素this.$container;
* showLoading():
* 显示后台数据载入文案;
* hideLoading():
* 隐藏后台数据载入文案;
* togglePagination():
* 分页切换按钮显示隐藏分页内容;
* refresh():
* 刷新页面到第一页，传入参数为{url:url,slient:slient,query:query};
* resetWidth():
* 调用fitHeader、fitFooter函数调整表头、表尾的宽度;
* showColumn():
* 根据field属性获得fieldIndex，再调用toggleColumn显示某列;
* hideColumn():
* 根据field属性获得fieldIndex，再调用toggleColumn隐藏某列;
* getHiddenColumns():
* 获得隐藏的某几列;
* filterBy():
* 设置过滤数组this.filterColumns;
* options.data和this.filterColumns相符则在this.data中保留，不相符则在this.data中删除;
* 设置页码为1，重新调用initSearch、updatePagination渲染表格;
* scrollTo():
* 设置this.$tableBody滚动条的垂直偏移，意义是移动到第几行数据;
* getScrollPosition():
* 表体滚动到顶部;
* selectPage():
* 设置this.options.pageNumber当前页，调用updatePagination更新表体，initBody或initServer方法;
* prevPage():
* nextPage():
* 上一页，下一页;
* toggleView():
* 切换卡片式显示或者表格详情显示;
* refreshView():
* 更新传入的配置项options，调用destory重置，init重新渲染页面;
* resetSearch():
* 设置搜索框文本，启动数据搜索;
* expandRow_():
* 表格详情显示时，折叠展开按钮执行函数;
* expandRow():
* 展开对应行的卡片详情;
* collapseRow():
* 折叠对应行的卡片详情;
* expandAllRows():
* expandAllRows展开所有卡片式详情，在表格显示的时候;
* isSubTable为真，展开父子表格的详情;
* collapseAllRows():
* expandAllRows展开所有卡片式详情，在表格显示的时候;
* updateFormatText():
* 更新配置项中的格式化函数;
*/ // 调整表体的高度
BootstrapTable.prototype.resetView = function (params) {
var padding = 0; if (params && params.height) {
this.options.height = params.height;
} this.$selectAll.prop('checked', this.$selectItem.length > 0 &&
this.$selectItem.length === this.$selectItem.filter(':checked').length); if (this.options.height) {
var toolbarHeight = getRealHeight(this.$toolbar),
paginationHeight = getRealHeight(this.$pagination),
height = this.options.height - toolbarHeight - paginationHeight; this.$tableContainer.css('height', height + 'px');
} if (this.options.cardView) {
this.$el.css('margin-top', '0');
this.$tableContainer.css('padding-bottom', '0');
return;
} if (this.options.showHeader && this.options.height) {
this.$tableHeader.show();
this.resetHeader();
padding += this.$header.outerHeight();
} else {
this.$tableHeader.hide();
this.trigger('post-header');
} if (this.options.showFooter) {
this.resetFooter();
if (this.options.height) {
padding += this.$tableFooter.outerHeight() + 1;
}
} this.getCaret();
this.$tableContainer.css('padding-bottom', padding + 'px');
this.trigger('reset-view');
}; // 过滤或搜索过滤后的数据保存在this.data中，过滤前的数据保存在this.options.data,针对数据在前台的情况;
// 有过滤数据，返回过滤数据this.data，无则返回未过滤数据this.options.data;
// 前台分页，获取this.pageFrom-1到this.pageTo的data数据或者整个data数据;
BootstrapTable.prototype.getData = function (useCurrentPage) {
return (this.searchText || !$.isEmptyObject(this.filterColumns) || !$.isEmptyObject(this.filterColumnsPartial)) ?
(useCurrentPage ? this.data.slice(this.pageFrom - 1, this.pageTo) : this.data) :
(useCurrentPage ? this.options.data.slice(this.pageFrom - 1, this.pageTo) : this.options.data);
}; // 使用后台传回的数据或本地data数据更新data、搜索框、分页、表体显示
// 后台传回数据格式为{total:,rows:,[fixedScroll]:}
BootstrapTable.prototype.load = function (data) {
var fixedScroll = false; // #431: support pagination
if (this.options.sidePagination === 'server') {
this.options.totalRows = data.total;
fixedScroll = data.fixedScroll;
data = data[this.options.dataField];
} else if (!$.isArray(data)) { // support fixedScroll
fixedScroll = data.fixedScroll;
data = data.data;
} this.initData(data);
this.initSearch();
this.initPagination();
this.initBody(fixedScroll);
}; // 从表格尾部插入数据
BootstrapTable.prototype.append = function (data) {
this.initData(data, 'append');
this.initSearch();
this.initPagination();
this.initSort();
this.initBody(true);
}; // 从表格头部插入数据
BootstrapTable.prototype.prepend = function (data) {
this.initData(data, 'prepend');
this.initSearch();
this.initPagination();
this.initSort();
this.initBody(true);
}; // 移除指定行数据，通过行数据row中的某个属性比较删除拥有相同值的行数据data
// param数据格式为{field:paramName,values:paramValues},paramName、paramValues和data对应
/** var ids = $.map($table.bootstrapTable('getSelections'), function (row) {
return row.id;
});
$table.bootstrapTable('remove', {
field: 'id',
values: ids
});
*/
BootstrapTable.prototype.remove = function (params) {
var len = this.options.data.length,
i, row; if (!params.hasOwnProperty('field') || !params.hasOwnProperty('values')) {
return;
} for (i = len - 1; i >= 0; i--) {
row = this.options.data[i]; if (!row.hasOwnProperty(params.field)) {
continue;
}
if ($.inArray(row[params.field], params.values) !== -1) {
this.options.data.splice(i, 1);
}
} if (len === this.options.data.length) {
return;
} this.initSearch();
this.initPagination();
this.initSort();
this.initBody(true);
}; // 移除所有行数据
BootstrapTable.prototype.removeAll = function () {
if (this.options.data.length > 0) {
this.options.data.splice(0, this.options.data.length);
this.initSearch();
this.initPagination();
this.initBody(true);
}
}; // 获取row[options.uniqueId]或者row._data[options.uniqueId]同id相等的某一行数据
BootstrapTable.prototype.getRowByUniqueId = function (id) {
var uniqueId = this.options.uniqueId,
len = this.options.data.length,
dataRow = null,
i, row, rowUniqueId; for (i = len - 1; i >= 0; i--) {
row = this.options.data[i]; if (row.hasOwnProperty(uniqueId)) { // uniqueId is a column
rowUniqueId = row[uniqueId];
} else if(row._data.hasOwnProperty(uniqueId)) { // uniqueId is a row data property
rowUniqueId = row._data[uniqueId];
} else {
continue;
} if (typeof rowUniqueId === 'string') {
id = id.toString();
} else if (typeof rowUniqueId === 'number') {
if ((Number(rowUniqueId) === rowUniqueId) && (rowUniqueId % 1 === 0)) {
id = parseInt(id);
} else if ((rowUniqueId === Number(rowUniqueId)) && (rowUniqueId !== 0)) {
id = parseFloat(id);
}
} if (rowUniqueId === id) {
dataRow = row;
break;
}
} return dataRow;
}; // 移除row[options.uniqueId]或者row._data[options.uniqueId]同id相等的某一行数据
BootstrapTable.prototype.removeByUniqueId = function (id) {
var len = this.options.data.length,
row = this.getRowByUniqueId(id); if (row) {
this.options.data.splice(this.options.data.indexOf(row), 1);
} if (len === this.options.data.length) {
return;
} this.initSearch();
this.initPagination();
this.initBody(true);
}; // 更新替换某一行数据，参数格式为{id:row[options.uniqueId],row:row替换数据}
BootstrapTable.prototype.updateByUniqueId = function (params) {
var rowId; if (!params.hasOwnProperty('id') || !params.hasOwnProperty('row')) {
return;
} rowId = $.inArray(this.getRowByUniqueId(params.id), this.options.data); if (rowId === -1) {
return;
} $.extend(this.data[rowId], params.row);
this.initSort();
this.initBody(true);
}; // 在某一行后插入数据，参数格式为{index:index行号,row:row插入数据内容}
BootstrapTable.prototype.insertRow = function (params) {
if (!params.hasOwnProperty('index') || !params.hasOwnProperty('row')) {
return;
}
this.data.splice(params.index, 0, params.row);
this.initSearch();
this.initPagination();
this.initSort();
this.initBody(true);
}; // 更新替换某一行数据，参数格式为{index:index行号,row:row替换数据}
BootstrapTable.prototype.updateRow = function (params) {
if (!params.hasOwnProperty('index') || !params.hasOwnProperty('row')) {
return;
}
$.extend(this.data[params.index], params.row);
this.initSort();
this.initBody(true);
}; // 根据{[index:index],[uniqueid:uniqueId]}找到某一行，显示
BootstrapTable.prototype.showRow = function (params) {
if (!params.hasOwnProperty('index') && !params.hasOwnProperty('uniqueId')) {
return;
}
this.toggleRow(params.index, params.uniqueId, true);
}; // 根据{[index:index],[uniqueid:uniqueId]}找到某一行，隐藏
BootstrapTable.prototype.hideRow = function (params) {
if (!params.hasOwnProperty('index') && !params.hasOwnProperty('uniqueId')) {
return;
}
this.toggleRow(params.index, params.uniqueId, false);
}; // 获取并返回隐藏的行，根据show将这些行数据显示出来
BootstrapTable.prototype.getRowsHidden = function (show) {
var rows = $(this.$body[0]).children().filter(':hidden'),
i = 0;
if (show) {
for (; i < rows.length; i++) {
$(rows[i]).show();
}
}
return rows;
}; // 合并单元格，传参为{index:index.field:field,rowspan:3,colspan:4}
// 隐藏被合并单元格，重新设置显示单元格rowspan、colspan属性
BootstrapTable.prototype.mergeCells = function (options) {
var row = options.index,
col = $.inArray(options.field, this.getVisibleFields()),
rowspan = options.rowspan || 1,
colspan = options.colspan || 1,
i, j,
$tr = this.$body.find('>tr'),
$td; if (this.options.detailView && !this.options.cardView) {
col += 1;
} $td = $tr.eq(row).find('>td').eq(col); if (row < 0 || col < 0 || row >= this.data.length) {
return;
} for (i = row; i < row + rowspan; i++) {
for (j = col; j < col + colspan; j++) {
$tr.eq(i).find('>td').eq(j).hide();
}
} $td.attr('rowspan', rowspan).attr('colspan', colspan).show();
}; // 更新单元的显示文本，传参为{index:index,field:field,value:value}，根据index、field找到单元格
BootstrapTable.prototype.updateCell = function (params) {
if (!params.hasOwnProperty('index') ||
!params.hasOwnProperty('field') ||
!params.hasOwnProperty('value')) {
return;
}
this.data[params.index][params.field] = params.value; if (params.reinit === false) {
return;
}
this.initSort();
this.initBody(true);
}; // 返回配置项
BootstrapTable.prototype.getOptions = function () {
return this.options;
}; // 通过过滤后的数据this.data返回选中行的数据
BootstrapTable.prototype.getSelections = function () {
var that = this; return $.grep(this.data, function (row) {
return row[that.header.stateField];
});
}; // 通过未过滤的数据this.options.data返回选中行的数据
BootstrapTable.prototype.getAllSelections = function () {
var that = this; return $.grep(this.options.data, function (row) {
return row[that.header.stateField];
});
}; // 执行全选
BootstrapTable.prototype.checkAll = function () {
this.checkAll_(true);
}; // 执行全不选
BootstrapTable.prototype.uncheckAll = function () {
this.checkAll_(false);
}; // 反选，调用updateRows执行initSort、initBody，调用updateSelect为行元素tr添加selected类
BootstrapTable.prototype.checkInvert = function () {
var that = this;
var rows = that.$selectItem.filter(':enabled');
var checked = rows.filter(':checked');
rows.each(function() {
$(this).prop('checked', !$(this).prop('checked'));
});
that.updateRows();
that.updateSelected();
that.trigger('uncheck-some', checked);
checked = that.getSelections();
that.trigger('check-some', checked);
}; // 全选或全不选执行函数，为什么这时又不像所在的行添加selected类？？？
BootstrapTable.prototype.checkAll_ = function (checked) {
var rows;
if (!checked) {
rows = this.getSelections();
}
this.$selectAll.add(this.$selectAll_).prop('checked', checked);//全选按钮
this.$selectItem.filter(':enabled').prop('checked', checked);
this.updateRows();
if (checked) {
rows = this.getSelections();
}
this.trigger(checked ? 'check-all' : 'uncheck-all', rows);
}; // 选中
BootstrapTable.prototype.check = function (index) {
this.check_(true, index);
}; // 取消选中
BootstrapTable.prototype.uncheck = function (index) {
this.check_(false, index);
}; // 选中、取消选中执行函数
BootstrapTable.prototype.check_ = function (checked, index) {
var $el = this.$selectItem.filter(sprintf('[data-index="%s"]', index)).prop('checked', checked);
this.data[index][this.header.stateField] = checked;
this.updateSelected();
this.trigger(checked ? 'check' : 'uncheck', this.data[index], $el);
}; // 选中某几行数据
BootstrapTable.prototype.checkBy = function (obj) {
this.checkBy_(true, obj);
}; // 取消选中某几行数据
BootstrapTable.prototype.uncheckBy = function (obj) {
this.checkBy_(false, obj);
}; // 根据条件选中、取消选中某几行数据执行函数，obj参数格式为{field:paramName,values:paramValues}
BootstrapTable.prototype.checkBy_ = function (checked, obj) {
if (!obj.hasOwnProperty('field') || !obj.hasOwnProperty('values')) {
return;
} var that = this,
rows = [];
$.each(this.options.data, function (index, row) {
if (!row.hasOwnProperty(obj.field)) {
return false;
}
if ($.inArray(row[obj.field], obj.values) !== -1) {
var $el = that.$selectItem.filter(':enabled')
.filter(sprintf('[data-index="%s"]', index)).prop('checked', checked);
row[that.header.stateField] = checked;
rows.push(row);
that.trigger(checked ? 'check' : 'uncheck', row, $el);
}
});
this.updateSelected();
this.trigger(checked ? 'check-some' : 'uncheck-some', rows);
}; // 移出触发元素，其内容、样式通过this.$el_改为初始值，移除构造函数添加最外层包裹元素this.$container
BootstrapTable.prototype.destroy = function () {
this.$el.insertBefore(this.$container);
$(this.options.toolbar).insertBefore(this.$el);
this.$container.next().remove();
this.$container.remove();
this.$el.html(this.$el_.html())
.css('margin-top', '0')
.attr('class', this.$el_.attr('class') || ''); // reset the class
}; // 显示后台数据载入文案
BootstrapTable.prototype.showLoading = function () {
this.$tableLoading.show();
}; // 隐藏后台数据载入文案
BootstrapTable.prototype.hideLoading = function () {
this.$tableLoading.hide();
}; // 分页切换按钮显示隐藏分页内容
BootstrapTable.prototype.togglePagination = function () {
this.options.pagination = !this.options.pagination;
var button = this.$toolbar.find('button[name="paginationSwitch"] i');
if (this.options.pagination) {
button.attr("class", this.options.iconsPrefix + " " + this.options.icons.paginationSwitchDown);
} else {
button.attr("class", this.options.iconsPrefix + " " + this.options.icons.paginationSwitchUp);
}
this.updatePagination();
}; // 刷新页面到第一页，传入参数为{url:url,slient:slient,query:query}
BootstrapTable.prototype.refresh = function (params) {
if (params && params.url) {
this.options.url = params.url;
this.options.pageNumber = 1;
}
this.initServer(params && params.silent, params && params.query);
}; // 调用fitHeader、fitFooter函数调整表头、表尾的宽度
BootstrapTable.prototype.resetWidth = function () {
if (this.options.showHeader && this.options.height) {
this.fitHeader();
}
if (this.options.showFooter) {
this.fitFooter();
}
}; // 根据field属性获得fieldIndex，再调用toggleColumn显示某列
BootstrapTable.prototype.showColumn = function (field) {
this.toggleColumn(getFieldIndex(this.columns, field), true, true);
}; // 根据field属性获得fieldIndex，再调用toggleColumn隐藏某列
BootstrapTable.prototype.hideColumn = function (field) {
this.toggleColumn(getFieldIndex(this.columns, field), false, true);
}; // 获得隐藏的某几列
BootstrapTable.prototype.getHiddenColumns = function () {
return $.grep(this.columns, function (column) {
return !column.visible;
});
}; // 设置过滤数组this.filterColumns;
// options.data和this.filterColumns相符则在this.data中保留，不相符则在this.data中删除;
// 设置页码为1，重新调用initSearch、updatePagination渲染表格;
BootstrapTable.prototype.filterBy = function (columns) {
this.filterColumns = $.isEmptyObject(columns) ? {} : columns;
this.options.pageNumber = 1;
this.initSearch();
this.updatePagination();
}; // 设置this.$tableBody滚动条的垂直偏移，意义是移动到第几行数据
BootstrapTable.prototype.scrollTo = function (value) {
if (typeof value === 'string') {
value = value === 'bottom' ? this.$tableBody[0].scrollHeight : 0;
}
if (typeof value === 'number') {
this.$tableBody.scrollTop(value);
}
if (typeof value === 'undefined') {
return this.$tableBody.scrollTop();// 返回顶部
}
}; // 表体滚动到顶部
BootstrapTable.prototype.getScrollPosition = function () {
return this.scrollTo();
}; // 设置this.options.pageNumber当前页，调用updatePagination更新表体，initBody或initServer方法
BootstrapTable.prototype.selectPage = function (page) {
if (page > 0 && page <= this.options.totalPages) {
this.options.pageNumber = page;
this.updatePagination();
}
}; // 前一页
BootstrapTable.prototype.prevPage = function () {
if (this.options.pageNumber > 1) {
this.options.pageNumber--;
this.updatePagination();
}
}; // 后一页
BootstrapTable.prototype.nextPage = function () {
if (this.options.pageNumber < this.options.totalPages) {
this.options.pageNumber++;
this.updatePagination();
}
}; // 切换卡片式显示或者表格详情显示
BootstrapTable.prototype.toggleView = function () {
this.options.cardView = !this.options.cardView;
this.initHeader();
// Fixed remove toolbar when click cardView button.
//that.initToolbar();
this.initBody();
this.trigger('toggle', this.options.cardView);
}; // 更新传入的配置项options，调用destory重置，init重新渲染页面
BootstrapTable.prototype.refreshOptions = function (options) {
//If the objects are equivalent then avoid the call of destroy / init methods
// 当this.options和options长度相当，其中一个属性不同的时候，也会被if语句提前返回？？？
if (compareObjects(this.options, options, true)) {
return;
}
this.options = $.extend(this.options, options);
this.trigger('refresh-options', this.options);
this.destroy();
this.init();
}; // 设置搜索框文本，启动数据搜索
BootstrapTable.prototype.resetSearch = function (text) {
var $search = this.$toolbar.find('.search input');
$search.val(text || '');
this.onSearch({currentTarget: $search});
}; // 表格详情显示时，折叠展开按钮执行函数
BootstrapTable.prototype.expandRow_ = function (expand, index) {
var $tr = this.$body.find(sprintf('> tr[data-index="%s"]', index));
if ($tr.next().is('tr.detail-view') === (expand ? false : true)) {
$tr.find('> td > .detail-icon').click();
}
}; // 展开对应行的卡片详情
BootstrapTable.prototype.expandRow = function (index) {
this.expandRow_(true, index);
}; // 折叠对应行的卡片详情
BootstrapTable.prototype.collapseRow = function (index) {
this.expandRow_(false, index);
}; // expandAllRows展开所有卡片式详情，在表格显示的时候
// isSubTable为真，展开父子表格的详情
BootstrapTable.prototype.expandAllRows = function (isSubTable) {
if (isSubTable) {
var $tr = this.$body.find(sprintf('> tr[data-index="%s"]', 0)),
that = this,
detailIcon = null,
executeInterval = false,
idInterval = -1; if (!$tr.next().is('tr.detail-view')) {
$tr.find('> td > .detail-icon').click();
executeInterval = true;
} else if (!$tr.next().next().is('tr.detail-view')) {
$tr.next().find(".detail-icon").click();
executeInterval = true;
} if (executeInterval) {
try {
idInterval = setInterval(function () {
// 父子表格情况，从.detail-view中找到.detail-icon并点击
detailIcon = that.$body.find("tr.detail-view").last().find(".detail-icon");
if (detailIcon.length > 0) {
detailIcon.click();
} else {
clearInterval(idInterval);
}
}, 1);
} catch (ex) {
clearInterval(idInterval);
}
}
} else {
var trs = this.$body.children();
for (var i = 0; i < trs.length; i++) {
this.expandRow_(true, $(trs[i]).data("index"));
}
}
}; // expandAllRows展开所有卡片式详情，在表格显示的时候
BootstrapTable.prototype.collapseAllRows = function (isSubTable) {
if (isSubTable) {
this.expandRow_(false, 0);
} else {
var trs = this.$body.children();
for (var i = 0; i < trs.length; i++) {
this.expandRow_(false, $(trs[i]).data("index"));
}
}
}; // 更新配置项中的格式化函数
BootstrapTable.prototype.updateFormatText = function (name, text) {
if (this.options[sprintf('format%s', name)]) {
if (typeof text === 'string') {
this.options[sprintf('format%s', name)] = function () {
return text;
};
} else if (typeof text === 'function') {
this.options[sprintf('format%s', name)] = text;
}
}
this.initToolbar();
this.initPagination();
this.initBody();
}; // BOOTSTRAP TABLE PLUGIN DEFINITION
// ======================= var allowedMethods = [
'getOptions',
'getSelections', 'getAllSelections', 'getData',
'load', 'append', 'prepend', 'remove', 'removeAll',
'insertRow', 'updateRow', 'updateCell', 'updateByUniqueId', 'removeByUniqueId',
'getRowByUniqueId', 'showRow', 'hideRow', 'getRowsHidden',
'mergeCells',
'checkAll', 'uncheckAll', 'checkInvert',
'check', 'uncheck',
'checkBy', 'uncheckBy',
'refresh',
'resetView',
'resetWidth',
'destroy',
'showLoading', 'hideLoading',
'showColumn', 'hideColumn', 'getHiddenColumns',
'filterBy',
'scrollTo',
'getScrollPosition',
'selectPage', 'prevPage', 'nextPage',
'togglePagination',
'toggleView',
'refreshOptions',
'resetSearch',
'expandRow', 'collapseRow', 'expandAllRows', 'collapseAllRows',
'updateFormatText'
]; $.fn.bootstrapTable = function (option) {
var value,
args = Array.prototype.slice.call(arguments, 1); this.each(function () {
var $this = $(this),
data = $this.data('bootstrap.table'),
// 配置项在触发元素的data数据中，或在js的option传参中
options = $.extend({}, BootstrapTable.DEFAULTS, $this.data(),
typeof option === 'object' && option); if (typeof option === 'string') {
if ($.inArray(option, allowedMethods) < 0) {
throw new Error("Unknown method: " + option);
} if (!data) {
return;
} value = data[option].apply(data, args); if (option === 'destroy') {
$this.removeData('bootstrap.table');
}
} if (!data) {
$this.data('bootstrap.table', (data = new BootstrapTable(this, options)));
}
}); return typeof value === 'undefined' ? this : value;
}; $.fn.bootstrapTable.Constructor = BootstrapTable;
$.fn.bootstrapTable.defaults = BootstrapTable.DEFAULTS;
$.fn.bootstrapTable.columnDefaults = BootstrapTable.COLUMN_DEFAULTS;
$.fn.bootstrapTable.locales = BootstrapTable.LOCALES;
$.fn.bootstrapTable.methods = allowedMethods;
$.fn.bootstrapTable.utils = {
sprintf: sprintf,
getFieldIndex: getFieldIndex,
compareObjects: compareObjects,
calculateObjectValue: calculateObjectValue
}; // BOOTSTRAP TABLE INIT
// ======================= $(function () {
$('[data-toggle="table"]').bootstrapTable();
});
}(jQuery);