bootstrap-tagsinput操作标签对象，实现从表格中选人和移除

最近接到个需求，要从表格中选人并给这些人统一发送通知，需要用到tagsinput这个插件。

插件我找到了两种。

一个是jQuery tags input，主要方法有addTag、removeTag、importTags等，详细资料和用法这位仁兄写的非常具体，推荐阅读：jQuery Tags Input 插件显示选择记录--HackerVirus。主要实现思路是：单独定义两个数组addUserList和addNameList分别用来储存用户Id和姓名，在添加标签的回调方法OnAddTag和删除标签的回调方法OnRemoveTag中对这两个数组进行对应操作。实际使用过程中遇到一个问题：因为标签项中只存了姓名，所以重名情况下删除标签时会删掉其他同名用户。（如果有解决思路欢迎留言交流赐教~）

现有项目中引用的是另一种：bootstrap-tagsinput，GitHub上有详细源码和教程：bootstrap-tagsinput。这套插件能直接将对象存储为标签项，将itemText作为展示文本、itemValue作为唯一标识。

需要特别注意的是，对象作为标签项时，控制是否允许输入的freeInput属性会失效。为了实现控件的不允许输入，单独定义了一个interactive属性，true为允许输入，false为不允许输入。在build方法中，加入如下代码，为标签控件添加只读属性readonly。

if (!self.options.interactive) {$input.attr("readonly", "readonly");
}

具体实现步骤：

1. 引入插件。bootstrap-tagsinput.js文件复制到项目中，并在jsp页面中进行引用。（小白注意路径哦，这的路径只是个例子）

<script type="text/javascript" src="bootstrap-tagsinput.js"></script>

2. JSP中定义一个input标签、一个清空按钮。

<input id="selectedUsers" value="" readonly="readonly"/>
<span class="btn-clearChoice">清空 </span>

3. JS中初始化数组用户ID列表addUserList、用户姓名列表addNameList和标签输入框tagsinput，参数设置如下：

addUserList = new Array();
addNameList = new Array();$('#selectedUsers').tagsinput({freeInput:false,    //不允许输入，标签类型为对象时此属性无效allowDuplicates: false,    //不允许重复，只姓名重复不受影响trimValue: true,    //去掉空格itemValue: 'value', //标签值字段为valueitemText: 'text',   //标签  展示文本字段为textinteractive : false,//不允许外部输入标签
});

4. 定义添加标签的回调方法OnAddTag、删除标签的回调方法OnRemoveTag、清空按钮绑定的清空方法：

$('#selectedUsers').bind('itemAdded', function(event){var tag = event.item;    //新添加的标签项addUserList.push(tag.value);//标签值（用户Id）加入addUserList数组addNameList.push(tag.text);//标签文本（用户姓名）加入addNameList数组
});$('#selectedUsers').bind('itemRemoved', function(event) {var tag = event.item;    //移除的标签项var index = $.inArray(tag.value, addUserList);//返回标签值在addUserList中的index，-1为未找到if (index != -1) {addUserList.splice(index, 1);    //从index位置，删除1个元素addNameList.splice(index, 1);_self.orgUserListTable.fnPageChange(parseInt($("div#orguserlisttable .current").html()) - 1);    //刷新表格后留在当前页}
});$('.btn-clearChoice').unbind().bind('click', function() {$('#selectedUsers').tagsinput('removeAll');addUserList = new Array();addNameList = new Array();
});

5. 项目中的表格用的是datatables-1.10.3。

对每个用户检查其是否已加入用户列表，并在表格的回调方法中，为按钮绑定btn-adduser事件。

注意：这里统一从表格添加用户，然后添加按钮不可点击；统一从标签框移除用户，移除后刷新表格当前页，已移除的用户操作栏的添加按钮变为可点击。

经过尝试，这里表格中没设计成添加后变成“移除”按钮，那样不太好实现，有实现了的欢迎交流！

{"sTitle" : "操作","mData" : "userId","render" : function(data, style, obj) {var editDom = "";var index = $.inArray(data, addUserList);    //检查当前用户Id在用户列表中的index，-1为未加入if (obj.status != 0 && index >= 0) {editDom = "<span class='btn btn-success btn-xs btn-adduser' disabled> 添加 </span> ";//若当前用户已在用户列表中，添加按钮不可点击} else if (obj.status != 0 && index < 0){editDom = "<span class='btn btn-success btn-xs btn-adduser'> 添加 </span> ";}return "<input type='hidden' name='userid' value='" + obj.userId + "'/>" + "<input type='hidden' name='username' value='" + obj.fullName + "'/>" +editDom;},
}

setting.fnDrawCallback = function() {$('.btn-adduser').unbind().bind('click', function() {var userid = $(this).parents("TR").find("input[type=hidden][name=userid]").val();var username = $(this).parents("TR").find("input[type=hidden][name=username]").val();$(this).attr("disabled", "disabled");$("#selectedUsers").tagsinput('add', { "value": userId , "text": userName});});
};

注：这里使用addUserList和addNameList并不是必须的，主要是针对这里的特殊需求，便于直观地看到表格中的用户是否可添加。

附完整的bootstrap-tagsinput.js源码：

(function ($) {"use strict";var defaultOptions = {tagClass: function(item) {return 'label label-info';},itemValue: function(item) {return item ? item.toString() : item;},itemText: function(item) {return this.itemValue(item);},itemTitle: function(item) {return null;},freeInput: true,addOnBlur: true,maxTags: undefined,maxChars: undefined,confirmKeys: [13],delimiter: ',',delimiterRegex: null,cancelConfirmKeysOnEmpty: true,onTagExists: function(item, $tag) {$tag.hide().fadeIn();},trimValue: false,allowDuplicates: false,interactive : true,};/*** Constructor function*/function TagsInput(element, options) {this.itemsArray = [];this.$element = $(element);this.$element.hide();this.isSelect = (element.tagName === 'SELECT');this.multiple = (this.isSelect && element.hasAttribute('multiple'));this.objectItems = options && options.itemValue;this.placeholderText = element.hasAttribute('placeholder') ? this.$element.attr('placeholder') : '';this.inputSize = Math.max(1, this.placeholderText.length);this.$container = $('<div class="bootstrap-tagsinput"></div>');this.$input = $('<input type="text" placeholder="' + this.placeholderText + '"/>').appendTo(this.$container);this.$element.before(this.$container);this.build(options);}TagsInput.prototype = {constructor: TagsInput,/*** Adds the given item as a new tag. Pass true to dontPushVal to prevent* updating the elements val()*/add: function(item, dontPushVal, options) {var self = this;if (self.options.maxTags && self.itemsArray.length >= self.options.maxTags)return;// Ignore falsey values, except falseif (item !== false && !item)return;// Trim valueif (typeof item === "string" && self.options.trimValue) {item = $.trim(item);}// Throw an error when trying to add an object while the itemValue option was not setif (typeof item === "object" && !self.objectItems)throw("Can't add objects when itemValue option is not set");// Ignore strings only containg whitespaceif (item.toString().match(/^\s*$/))return;// If SELECT but not multiple, remove current tagif (self.isSelect && !self.multiple && self.itemsArray.length > 0)self.remove(self.itemsArray[0]);if (typeof item === "string" && this.$element[0].tagName === 'INPUT') {var delimiter = (self.options.delimiterRegex) ? self.options.delimiterRegex : self.options.delimiter;var items = item.split(delimiter);if (items.length > 1) {for (var i = 0; i < items.length; i++) {this.add(items[i], true);}if (!dontPushVal)self.pushVal();return;}}var itemValue = self.options.itemValue(item),itemText = self.options.itemText(item),tagClass = self.options.tagClass(item),itemTitle = self.options.itemTitle(item);// Ignore items allready addedvar existing = $.grep(self.itemsArray, function(item) { return self.options.itemValue(item) === itemValue; } )[0];if (existing && !self.options.allowDuplicates) {// Invoke onTagExistsif (self.options.onTagExists) {var $existingTag = $(".tag", self.$container).filter(function() { return $(this).data("item") === existing; });self.options.onTagExists(item, $existingTag);}return;}// if length greater than limitif (self.items().toString().length + item.length + 1 > self.options.maxInputLength)return;// raise beforeItemAdd argvar beforeItemAddEvent = $.Event('beforeItemAdd', { item: item, cancel: false, options: options});self.$element.trigger(beforeItemAddEvent);if (beforeItemAddEvent.cancel)return;// register item in internal array and mapself.itemsArray.push(item);// add a tag elementvar $tag = $('<span class="tag ' + htmlEncode(tagClass) + (itemTitle !== null ? ('" title="' + itemTitle) : '') + '">' + htmlEncode(itemText) + '<span data-role="remove"></span></span>');$tag.data('item', item);self.findInputWrapper().before($tag);$tag.after(' ');// add <option /> if item represents a value not present in one of the <select />'s optionsif (self.isSelect && !$('option[value="' + encodeURIComponent(itemValue) + '"]',self.$element)[0]) {var $option = $('<option selected>' + htmlEncode(itemText) + '</option>');$option.data('item', item);$option.attr('value', itemValue);self.$element.append($option);}if (!dontPushVal)self.pushVal();// Add class when reached maxTagsif (self.options.maxTags === self.itemsArray.length || self.items().toString().length === self.options.maxInputLength)self.$container.addClass('bootstrap-tagsinput-max');self.$element.trigger($.Event('itemAdded', { item: item, options: options }));},/*** Removes the given item. Pass true to dontPushVal to prevent updating the* elements val()*/remove: function(item, dontPushVal, options) {var self = this;if (self.objectItems) {if (typeof item === "object")item = $.grep(self.itemsArray, function(other) { return self.options.itemValue(other) ==  self.options.itemValue(item); } );elseitem = $.grep(self.itemsArray, function(other) { return self.options.itemValue(other) ==  item; } );item = item[item.length-1];}if (item) {var beforeItemRemoveEvent = $.Event('beforeItemRemove', { item: item, cancel: false, options: options });self.$element.trigger(beforeItemRemoveEvent);if (beforeItemRemoveEvent.cancel)return;$('.tag', self.$container).filter(function() { return $(this).data('item') === item; }).remove();$('option', self.$element).filter(function() { return $(this).data('item') === item; }).remove();if($.inArray(item, self.itemsArray) !== -1)self.itemsArray.splice($.inArray(item, self.itemsArray), 1);}if (!dontPushVal)self.pushVal();// Remove class when reached maxTagsif (self.options.maxTags > self.itemsArray.length)self.$container.removeClass('bootstrap-tagsinput-max');self.$element.trigger($.Event('itemRemoved',  { item: item, options: options }));},/*** Removes all items*/removeAll: function() {var self = this;$('.tag', self.$container).remove();$('option', self.$element).remove();while(self.itemsArray.length > 0)self.itemsArray.pop();self.pushVal();},/*** Refreshes the tags so they match the text/value of their corresponding* item.*/refresh: function() {var self = this;$('.tag', self.$container).each(function() {var $tag = $(this),item = $tag.data('item'),itemValue = self.options.itemValue(item),itemText = self.options.itemText(item),tagClass = self.options.tagClass(item);// Update tag's class and inner text$tag.attr('class', null);$tag.addClass('tag ' + htmlEncode(tagClass));$tag.contents().filter(function() {return this.nodeType == 3;})[0].nodeValue = htmlEncode(itemText);if (self.isSelect) {var option = $('option', self.$element).filter(function() { return $(this).data('item') === item; });option.attr('value', itemValue);}});},/*** Returns the items added as tags*/items: function() {return this.itemsArray;},/*** Assembly value by retrieving the value of each item, and set it on the* element.*/pushVal: function() {var self = this,val = $.map(self.items(), function(item) {return self.options.itemValue(item).toString();});self.$element.val(val, true).trigger('change');},/*** Initializes the tags input behaviour on the element*/build: function(options) {var self = this;self.options = $.extend({}, defaultOptions, options);// When itemValue is set, freeInput should always be falseif (self.objectItems)self.options.freeInput = false;makeOptionItemFunction(self.options, 'itemValue');makeOptionItemFunction(self.options, 'itemText');makeOptionFunction(self.options, 'tagClass');// Typeahead Bootstrap version 2.3.2if (self.options.typeahead) {var typeahead = self.options.typeahead || {};makeOptionFunction(typeahead, 'source');self.$input.typeahead($.extend({}, typeahead, {source: function (query, process) {function processItems(items) {var texts = [];for (var i = 0; i < items.length; i++) {var text = self.options.itemText(items[i]);map[text] = items[i];texts.push(text);}process(texts);}this.map = {};var map = this.map,data = typeahead.source(query);if ($.isFunction(data.success)) {// support for Angular callbacksdata.success(processItems);} else if ($.isFunction(data.then)) {// support for Angular promisesdata.then(processItems);} else {// support for functions and jquery promises$.when(data).then(processItems);}},updater: function (text) {self.add(this.map[text]);return this.map[text];},matcher: function (text) {return (text.toLowerCase().indexOf(this.query.trim().toLowerCase()) !== -1);},sorter: function (texts) {return texts.sort();},highlighter: function (text) {var regex = new RegExp( '(' + this.query + ')', 'gi' );return text.replace( regex, "<strong>$1</strong>" );}}));}// typeahead.jsif (self.options.typeaheadjs) {var typeaheadConfig = null;var typeaheadDatasets = {};// Determine if main configurations were passed or simply a datasetvar typeaheadjs = self.options.typeaheadjs;if ($.isArray(typeaheadjs)) {typeaheadConfig = typeaheadjs[0];typeaheadDatasets = typeaheadjs[1];} else {typeaheadDatasets = typeaheadjs;}self.$input.typeahead(typeaheadConfig, typeaheadDatasets).on('typeahead:selected', $.proxy(function (obj, datum) {if (typeaheadDatasets.valueKey)self.add(datum[typeaheadDatasets.valueKey]);elseself.add(datum);self.$input.typeahead('val', '');}, self));}self.$container.on('click', $.proxy(function(event) {if (! self.$element.attr('disabled')) {self.$input.removeAttr('disabled');}self.$input.focus();}, self));if (self.options.addOnBlur && self.options.freeInput) {self.$input.on('focusout', $.proxy(function(event) {// HACK: only process on focusout when no typeahead opened, to//       avoid adding the typeahead text as tagif ($('.typeahead, .twitter-typeahead', self.$container).length === 0) {self.add(self.$input.val());self.$input.val('');}}, self));}self.$container.on('keydown', 'input', $.proxy(function(event) {var $input = $(event.target),$inputWrapper = self.findInputWrapper();if (self.$element.attr('disabled')) {self.$input.attr('disabled', 'disabled');return;}switch (event.which) {// BACKSPACEcase 8:if (doGetCaretPosition($input[0]) === 0) {var prev = $inputWrapper.prev();if (prev.length) {self.remove(prev.data('item'));}}break;// DELETEcase 46:if (doGetCaretPosition($input[0]) === 0) {var next = $inputWrapper.next();if (next.length) {self.remove(next.data('item'));}}break;// LEFT ARROWcase 37:// Try to move the input before the previous tagvar $prevTag = $inputWrapper.prev();if ($input.val().length === 0 && $prevTag[0]) {$prevTag.before($inputWrapper);$input.focus();}break;// RIGHT ARROWcase 39:// Try to move the input after the next tagvar $nextTag = $inputWrapper.next();if ($input.val().length === 0 && $nextTag[0]) {$nextTag.after($inputWrapper);$input.focus();}break;default:// ignore}// Reset internal input's sizevar textLength = $input.val().length,wordSpace = Math.ceil(textLength / 5),size = textLength + wordSpace + 1;$input.attr('size', Math.max(this.inputSize, $input.val().length));}, self));self.$container.on('keypress', 'input', $.proxy(function(event) {var $input = $(event.target);if (self.$element.attr('disabled')) {self.$input.attr('disabled', 'disabled');return;}var text = $input.val(),maxLengthReached = self.options.maxChars && text.length >= self.options.maxChars;if (self.options.freeInput && (keyCombinationInList(event, self.options.confirmKeys) || maxLengthReached)) {// Only attempt to add a tag if there is data in the fieldif (text.length !== 0) {self.add(maxLengthReached ? text.substr(0, self.options.maxChars) : text);$input.val('');}// If the field is empty, let the event triggered fire as usualif (self.options.cancelConfirmKeysOnEmpty === false) {event.preventDefault();}}// Reset internal input's sizevar textLength = $input.val().length,wordSpace = Math.ceil(textLength / 5),size = textLength + wordSpace + 1;$input.attr('size', Math.max(this.inputSize, $input.val().length));if (!self.options.interactive) {$input.attr("readonly", "readonly");}}, self));// Remove icon clickedself.$container.on('click', '[data-role=remove]', $.proxy(function(event) {if (self.$element.attr('disabled')) {return;}self.remove($(event.target).closest('.tag').data('item'));}, self));// Only add existing value as tags when using strings as tagsif (self.options.itemValue === defaultOptions.itemValue) {if (self.$element[0].tagName === 'INPUT') {self.add(self.$element.val());} else {$('option', self.$element).each(function() {self.add($(this).attr('value'), true);});}}},/*** Removes all tagsinput behaviour and unregsiter all event handlers*/destroy: function() {var self = this;// Unbind eventsself.$container.off('keypress', 'input');self.$container.off('click', '[role=remove]');self.$container.remove();self.$element.removeData('tagsinput');self.$element.show();},/*** Sets focus on the tagsinput*/focus: function() {this.$input.focus();},/*** Returns the internal input element*/input: function() {return this.$input;},/*** Returns the element which is wrapped around the internal input. This* is normally the $container, but typeahead.js moves the $input element.*/findInputWrapper: function() {var elt = this.$input[0],container = this.$container[0];while(elt && elt.parentNode !== container)elt = elt.parentNode;return $(elt);}};/*** Register JQuery plugin*/$.fn.tagsinput = function(arg1, arg2, arg3) {var results = [];this.each(function() {var tagsinput = $(this).data('tagsinput');// Initialize a new tags inputif (!tagsinput) {tagsinput = new TagsInput(this, arg1);$(this).data('tagsinput', tagsinput);results.push(tagsinput);if (this.tagName === 'SELECT') {$('option', $(this)).attr('selected', 'selected');}// Init tags from $(this).val()$(this).val($(this).val());} else if (!arg1 && !arg2) {// tagsinput already exists// no function, trying to initresults.push(tagsinput);} else if(tagsinput[arg1] !== undefined) {// Invoke function on existing tags inputif(tagsinput[arg1].length === 3 && arg3 !== undefined){var retVal = tagsinput[arg1](arg2, null, arg3);}else{var retVal = tagsinput[arg1](arg2);}if (retVal !== undefined)results.push(retVal);}});if ( typeof arg1 == 'string') {// Return the results from the invoked function callsreturn results.length > 1 ? results : results[0];} else {return results;}};$.fn.tagsinput.Constructor = TagsInput;/*** Most options support both a string or number as well as a function as* option value. This function makes sure that the option with the given* key in the given options is wrapped in a function*/function makeOptionItemFunction(options, key) {if (typeof options[key] !== 'function') {var propertyName = options[key];options[key] = function(item) { return item[propertyName]; };}}function makeOptionFunction(options, key) {if (typeof options[key] !== 'function') {var value = options[key];options[key] = function() { return value; };}}/*** HtmlEncodes the given value*/var htmlEncodeContainer = $('<div />');function htmlEncode(value) {if (value) {return htmlEncodeContainer.text(value).html();} else {return '';}}/*** Returns the position of the caret in the given input field* http://flightschool.acylt.com/devnotes/caret-position-woes/*/function doGetCaretPosition(oField) {var iCaretPos = 0;if (document.selection) {oField.focus ();var oSel = document.selection.createRange();oSel.moveStart ('character', -oField.value.length);iCaretPos = oSel.text.length;} else if (oField.selectionStart || oField.selectionStart == '0') {iCaretPos = oField.selectionStart;}return (iCaretPos);}/*** Returns boolean indicates whether user has pressed an expected key combination.* @param object keyPressEvent: JavaScript event object, refer*     http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html* @param object lookupList: expected key combinations, as in:*     [13, {which: 188, shiftKey: true}]*/function keyCombinationInList(keyPressEvent, lookupList) {var found = false;$.each(lookupList, function (index, keyCombination) {if (typeof (keyCombination) === 'number' && keyPressEvent.which === keyCombination) {found = true;return false;}if (keyPressEvent.which === keyCombination.which) {var alt = !keyCombination.hasOwnProperty('altKey') || keyPressEvent.altKey === keyCombination.altKey,shift = !keyCombination.hasOwnProperty('shiftKey') || keyPressEvent.shiftKey === keyCombination.shiftKey,ctrl = !keyCombination.hasOwnProperty('ctrlKey') || keyPressEvent.ctrlKey === keyCombination.ctrlKey;if (alt && shift && ctrl) {found = true;return false;}}});return found;}/*** Initialize tagsinput behaviour on inputs and selects which have* data-role=tagsinput*/$(function() {$("input[data-role=tagsinput], select[multiple][data-role=tagsinput]").tagsinput();});
})(window.jQuery);

如有误欢迎批评指正！

bootstrap-tagsinput操作标签对象，实现从表格中选人和移除相关推荐

html5自定义标签库,Bootstrap tagsinput自定义标签插件
tagsinput是一款基于Bootstrap的自定义标签插件.该自定义标签插件提供api接口,可以将input和select元素转换为标签.并能和typehead.js插件结合,提供查询提示信息. ...
DOM操作标签与jQuery框架
今日内容概要 1 > DOM操作标签 1.1 > 动态创建一个a 标签 1.2 > 默认与自定义属性 1.3 > getAttribute和removAttribute 方法 ...
049_jQuery 操作标签
一,jQuery操作标签 1,操作 class 类 1.1,操作 class 类 addClass("c1") // 添加指定的CSS类名. removeClass("c ...
ie和firefox操作table对象的异同
2019独角兽企业重金招聘Python工程师标准>>> ie和firefox下操作table对象的异同[测试浏览器版本:ie为8,9,firefox为2.0] 1)在ie下,tabl ...
Selenium提取数据之标签对象提取文本内容和属性值
Selenium提取数据之标签对象提取文本内容和属性值 find_element仅仅能够获取元素,不能够直接获取其中的数据,如果需要获取数据需要使用以下方法对元素执行点击操作element.clic ...
VSTO Office二次开发PPTRibbonX命令操作及对象添加
VSTO Office二次开发PPTRibbonX命令操作及对象添加本篇分享对于Power Point中一些命令的操作和对于一些比较常用对象.特殊对象的添加功能. 对于Power Point命令操作 ...
php中插入表格标签,PHP_HTML中的表格元素，一，table标签。tablegt - phpStudy
HTML中的表格元素一, 1,border属性的参数值是数字,表示表格边框宽度所占的像素点数.它也可以不带有参数值使用,仅表示该表格是有边框的.例如, 2,width和height属性的作用是指定表 ...
jQuery操作标签--样式、文本、属性操作, 文档处理
1.样式 2.文本 3.属性操作全选,反选效果 4.文档处理操作标签一.样式操作样式类: addClass(); // 添加指定的css类名removeClass(); //移除指定的css类 ...
前端基础之操作标签—文档处理
一.操作标签 1.文档处理 <1>添加到指定元素内部的后面 $(A).append(B) // 把B追加到A后面 $(B).appendTo(A) // 把B追加到A后面 < ...
5.14 js对象函数 js操作document对象
---对象 var myObject ={} /* 声明对象字面变量*/ myObject点语法取值赋值代码格式 var person = { name : "zhangs ...

bootstrap-tagsinput操作标签对象，实现从表格中选人和移除

具体实现步骤：

bootstrap-tagsinput操作标签对象，实现从表格中选人和移除相关推荐

最新文章

热门文章