dataTables.altEditor.free.js 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655
  1. /*! Datatables altEditor 1.0
  2. */
  3. /**
  4. * @summary altEditor
  5. * @description Lightweight editor for DataTables
  6. * @version 1.0
  7. * @file dataTables.editor.lite.js
  8. * @author kingkode (www.kingkode.com)
  9. * @contact www.kingkode.com/contact
  10. * @copyright Copyright 2016 Kingkode
  11. *
  12. * This source file is free software, available under the following license:
  13. * MIT license - http://datatables.net/license/mit
  14. *
  15. * This source file is distributed in the hope that it will be useful, but
  16. * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17. * or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.
  18. *
  19. * For details please refer to: http://www.kingkode.com
  20. */
  21. (function(factory) {
  22. if (typeof define === 'function' && define.amd) {
  23. // AMD
  24. define(['jquery', 'datatables.net'], function($) {
  25. return factory($, window, document);
  26. });
  27. } else if (typeof exports === 'object') {
  28. // CommonJS
  29. module.exports = function(root, $) {
  30. if (!root) {
  31. root = window;
  32. }
  33. if (!$ || !$.fn.dataTable) {
  34. $ = require('datatables.net')(root, $).$;
  35. }
  36. return factory($, root, root.document);
  37. };
  38. } else {
  39. // Browser
  40. factory(jQuery, window, document);
  41. }
  42. }(function($, window, document, undefined) {
  43. 'use strict';
  44. var DataTable = $.fn.dataTable;
  45. var _instance = 0;
  46. /**
  47. * altEditor provides modal editing of records for Datatables
  48. *
  49. * @class altEditor
  50. * @constructor
  51. * @param {object} oTD DataTables settings object
  52. * @param {object} oConfig Configuration object for altEditor
  53. */
  54. var altEditor = function(dt, opts) {
  55. if (!DataTable.versionCheck || !DataTable.versionCheck('1.10.8')) {
  56. throw ("Warning: altEditor requires DataTables 1.10.8 or greater");
  57. }
  58. // User and defaults configuration object
  59. this.c = $.extend(true, {},
  60. DataTable.defaults.altEditor,
  61. altEditor.defaults,
  62. opts
  63. );
  64. /**
  65. * @namespace Settings object which contains customisable information for altEditor instance
  66. */
  67. this.s = {
  68. /** @type {DataTable.Api} DataTables' API instance */
  69. dt: new DataTable.Api(dt),
  70. /** @type {String} Unique namespace for events attached to the document */
  71. namespace: '.altEditor' + (_instance++)
  72. };
  73. /**
  74. * @namespace Common and useful DOM elements for the class instance
  75. */
  76. this.dom = {
  77. /** @type {jQuery} altEditor handle */
  78. modal: $('<div class="dt-altEditor-handle"/>'),
  79. };
  80. /* Constructor logic */
  81. this._constructor();
  82. }
  83. $.extend(altEditor.prototype, {
  84. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  85. * Constructor
  86. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  87. /**
  88. * Initialise the RowReorder instance
  89. *
  90. * @private
  91. */
  92. _constructor: function() {
  93. // console.log('altEditor Enabled')
  94. var that = this;
  95. var dt = this.s.dt;
  96. this._setup();
  97. dt.on('destroy.altEditor', function() {
  98. dt.off('.altEditor');
  99. $(dt.table().body()).off(that.s.namespace);
  100. $(document.body).off(that.s.namespace);
  101. });
  102. },
  103. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  104. * Private methods
  105. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  106. /**
  107. * Setup dom and bind button actions
  108. *
  109. * @private
  110. */
  111. _setup: function() {
  112. // console.log('Setup');
  113. var that = this;
  114. var dt = this.s.dt;
  115. // add modal
  116. $('body').append('\
  117. <div class="modal fade" id="altEditor-modal" tabindex="-1" role="dialog">\
  118. <div class="modal-dialog">\
  119. <div class="modal-content">\
  120. <div class="modal-header">\
  121. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>\
  122. <h4 class="modal-title"></h4>\
  123. </div>\
  124. <div class="modal-body">\
  125. <p></p>\
  126. </div>\
  127. <div class="modal-footer">\
  128. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>\
  129. <button type="button" class="btn btn-primary">Save changes</button>\
  130. </div>\
  131. </div>\
  132. </div>\
  133. </div>');
  134. // add Edit Button
  135. if (this.s.dt.button('edit:name')) {
  136. this.s.dt.button('edit:name').action(function(e, dt, node, config) {
  137. var rows = dt.rows({
  138. selected: true
  139. }).count();
  140. that._openEditModal();
  141. });
  142. $(document).on('click', '#editRowBtn', function(e) {
  143. e.preventDefault();
  144. e.stopPropagation();
  145. that._editRowData();
  146. });
  147. }
  148. // add Delete Button
  149. if (this.s.dt.button('delete:name')) {
  150. this.s.dt.button('delete:name').action(function(e, dt, node, config) {
  151. var rows = dt.rows({
  152. selected: true
  153. }).count();
  154. that._openDeleteModal();
  155. });
  156. $(document).on('click', '#deleteRowBtn', function(e) {
  157. e.preventDefault();
  158. e.stopPropagation();
  159. that._deleteRow();
  160. });
  161. }
  162. // add Add Button
  163. if (this.s.dt.button('add:name')) {
  164. this.s.dt.button('add:name').action(function(e, dt, node, config) {
  165. var rows = dt.rows({
  166. selected: true
  167. }).count();
  168. that._openAddModal();
  169. });
  170. $(document).on('click', '#addRowBtn', function(e) {
  171. e.preventDefault();
  172. e.stopPropagation();
  173. that._addRowData();
  174. });
  175. }
  176. },
  177. /**
  178. * Emit an event on the DataTable for listeners
  179. *
  180. * @param {string} name Event name
  181. * @param {array} args Event arguments
  182. * @private
  183. */
  184. _emitEvent: function(name, args) {
  185. this.s.dt.iterator('table', function(ctx, i) {
  186. $(ctx.nTable).triggerHandler(name + '.dt', args);
  187. });
  188. },
  189. /**
  190. * Open Edit Modal for selected row
  191. *
  192. * @private
  193. */
  194. _openEditModal: function() {
  195. var that = this;
  196. var dt = this.s.dt;
  197. var columnDefs = [];
  198. for (var i = 0; i < dt.context[0].aoColumns.length; i++) {
  199. columnDefs.push({
  200. title: dt.context[0].aoColumns[i].sTitle,
  201. dataType: dt.context[0].aoColumns[i].dataType,
  202. isPrimary: dt.context[0].aoColumns[i].isPrimary,
  203. })
  204. }
  205. var adata = dt.rows({
  206. selected: true
  207. });
  208. var data = "";
  209. data += "<form class='form-horizontal' name='altEditor-form' role='form'>";
  210. for (var j in columnDefs) {
  211. var cellData = adata.data()[0][j];
  212. var inputSectionHTML = "<div class='form-group'><label for='__INPUT_NAME__' class='col-sm-4 control-label'>__INPUT_NAME__</label>__INPUT_HTML__</div>";
  213. var inputHTML = "<div class='col-sm-7'><input data-type='__INPUT_DATA_TYPE__' __INPUT_READ_ONLY_ATTRIBUTE__ type='__INPUT_TYPE__' id='__INPUT_NAME__' name='__INPUT_NAME__' placeholder='__INPUT_NAME__' style='overflow:hidden' class='form-control' value='__INPUT_VALUE__'></div>";
  214. var option1Checked = "";
  215. var option2Checked = "checked";
  216. if (cellData.dataType == "boolean") {
  217. if(JSON.parse(cellData.value)) {
  218. option1Checked = "checked";
  219. option2Checked = "";
  220. }
  221. inputHTML = "<div class='col-sm-7'><div class='checkbox'><label><label class='radio-inline'><input data-type='__INPUT_DATA_TYPE__' __OPTION_1_CHECKED__ type='radio' name='__INPUT_NAME__' id='__INPUT_NAME__' value='1'>true</label><label class='radio-inline'><input data-type='__INPUT_DATA_TYPE__' __OPTION_2_CHECKED__ type='radio' name='__INPUT_NAME__' id='__INPUT_NAME__' value='0'>false</label></div></div>"
  222. }
  223. //set input type
  224. var inputType = "text";
  225. var inputReadOnlyAttribute = "";
  226. switch (cellData.dataType) {
  227. case 'integer':
  228. inputType = "number";
  229. break;
  230. case 'real':
  231. inputType = "number";
  232. break;
  233. case 'boolean':
  234. inputType = "checkbox";
  235. break;
  236. case 'long':
  237. inputType = "number";
  238. break;
  239. case 'float':
  240. inputType = "number";
  241. break;
  242. case 'text':
  243. inputType = "text";
  244. break;
  245. case 'string_set':
  246. inputType = "text";
  247. break;
  248. }
  249. //set input to read-only if it is a primary key
  250. if (columnDefs[j].isPrimary) {
  251. inputReadOnlyAttribute = "readonly"
  252. }
  253. //append input html
  254. inputSectionHTML = inputSectionHTML.replace(/__INPUT_HTML__/g, inputHTML);
  255. inputSectionHTML = inputSectionHTML.replace(/__INPUT_READ_ONLY_ATTRIBUTE__/g, inputReadOnlyAttribute);
  256. inputSectionHTML = inputSectionHTML.replace(/__INPUT_TYPE__/g, inputType);
  257. inputSectionHTML = inputSectionHTML.replace(/__INPUT_DATA_TYPE__/g, cellData.dataType);
  258. inputSectionHTML = inputSectionHTML.replace(/__INPUT_VALUE__/g, cellData.value);
  259. inputSectionHTML = inputSectionHTML.replace(/__INPUT_NAME__/g, columnDefs[j].title);
  260. inputSectionHTML = inputSectionHTML.replace(/__OPTION_1_CHECKED__/g, option1Checked);
  261. inputSectionHTML = inputSectionHTML.replace(/__OPTION_2_CHECKED__/g, option2Checked);
  262. data += inputSectionHTML;
  263. }
  264. data += "</form>";
  265. $('#altEditor-modal').on('show.bs.modal', function() {
  266. $('#altEditor-modal').find('.modal-title').html('Edit Record');
  267. $('#altEditor-modal').find('.modal-body').html('<pre>' + data + '</pre>');
  268. $('#altEditor-modal').find('.modal-footer').html("<button type='button' data-content='remove' class='btn btn-default' data-dismiss='modal'>Close</button>\
  269. <button type='button' data-content='remove' class='btn btn-primary' id='editRowBtn'>Save Changes</button>");
  270. });
  271. $('#altEditor-modal').modal('show');
  272. $('#altEditor-modal input[0]').focus();
  273. },
  274. _editRowData: function() {
  275. var that = this;
  276. var dt = this.s.dt;
  277. var data = [];
  278. $('form[name="altEditor-form"] input').each(function(i) {
  279. var addToList = true;
  280. var value = $(this).val();
  281. if($(this).attr('type') == "radio" && $(this).prop('checked') == false) {
  282. addToList = false;
  283. }
  284. value = $(this).attr('type') == "radio" ? $(this).val() == "1" : value;
  285. if (addToList){
  286. data.push({
  287. "value": value,
  288. "dataType": $(this).attr('data-type')
  289. });
  290. }
  291. });
  292. var editButtonCurrentText = $("#editRowBtn").text();
  293. $("#editRowBtn").addClass('disabled');
  294. $("#editRowBtn").text("Saving..");
  295. that._emitEvent("update-row", [
  296. JSON.stringify(data),
  297. function(isUpdated) {
  298. //set error message and other properties based on whether update is successfull or not
  299. var alertAdditionClasses = "alert-success";
  300. var alertMessage = "This record has been updated";
  301. var alertHeading = "Success";
  302. if (!isUpdated) {
  303. alertAdditionClasses = "alert-danger";
  304. alertMessage = "Error occurred while updating this record";
  305. alertHeading = "Error";
  306. }
  307. //create alert element html and append it to modal
  308. var messageHTML = '\
  309. <div class="alert __ALERT_ADDITION_CLASSES__" role="alert">\
  310. <strong>__ALERT_HEADING__!</strong>\
  311. __ALERT_MESSAGE__.\
  312. </div>\
  313. ';
  314. messageHTML = messageHTML.replace(/__ALERT_ADDITION_CLASSES__/g, alertAdditionClasses);
  315. messageHTML = messageHTML.replace(/__ALERT_HEADING__/g, alertHeading);
  316. messageHTML = messageHTML.replace(/__ALERT_MESSAGE__/g, alertMessage);
  317. $('#altEditor-modal .modal-body').append(messageHTML);
  318. //update datatable, if update is successfull
  319. if (isUpdated) {
  320. dt.row({
  321. selected: true
  322. }).data(data);
  323. //remove existing alert elements
  324. $('#altEditor-modal').modal('hide');
  325. }
  326. $("#editRowBtn").removeClass('disabled');
  327. $("#editRowBtn").text(editButtonCurrentText);
  328. }
  329. ]);
  330. },
  331. /**
  332. * Open Delete Modal for selected row
  333. *
  334. * @private
  335. */
  336. _openDeleteModal: function() {
  337. var that = this;
  338. var dt = this.s.dt;
  339. var columnDefs = [];
  340. for (var i = 0; i < dt.context[0].aoColumns.length; i++) {
  341. columnDefs.push({
  342. title: dt.context[0].aoColumns[i].sTitle
  343. })
  344. }
  345. var adata = dt.rows({
  346. selected: true
  347. });
  348. var data = "";
  349. data += "<form name='altEditor-form' role='form'>";
  350. for (var i in columnDefs) {
  351. var cellData = adata.data()[0][i];
  352. var inputType = "text";
  353. switch (cellData.dataType) {
  354. case 'integer':
  355. inputType = "number";
  356. break;
  357. case 'real':
  358. inputType = "number";
  359. break;
  360. case 'boolean':
  361. inputType = "checkbox";
  362. break;
  363. case 'long':
  364. inputType = "number";
  365. break;
  366. case 'float':
  367. inputType = "number";
  368. break;
  369. case 'text':
  370. inputType = "text";
  371. break;
  372. case 'string_set':
  373. inputType = "text";
  374. break;
  375. }
  376. data += "<div class='form-group'><label for='" + columnDefs[i].title + "'>" + columnDefs[i].title + " : </label><input type='hidden' data-type='" + inputType + "' id='" + columnDefs[i].title + "' name='" + columnDefs[i].title + "' placeholder='" + columnDefs[i].title + "' style='overflow:hidden' class='form-control' value='" + cellData.value + "' >" + cellData.value + "</input></div>";
  377. }
  378. data += "</form>";
  379. $('#altEditor-modal').on('show.bs.modal', function() {
  380. $('#altEditor-modal').find('.modal-title').html('Delete Record');
  381. $('#altEditor-modal').find('.modal-body').html('<pre>' + data + '</pre>');
  382. $('#altEditor-modal').find('.modal-footer').html("<button type='button' data-content='remove' class='btn btn-default' data-dismiss='modal'>Close</button>\
  383. <button type='button' data-content='remove' class='btn btn-danger' id='deleteRowBtn'>Delete</button>");
  384. });
  385. $('#altEditor-modal').modal('show');
  386. $('#altEditor-modal input[0]').focus();
  387. },
  388. _deleteRow: function() {
  389. var that = this;
  390. var dt = this.s.dt;
  391. var data = [];
  392. $('form[name="altEditor-form"] input').each(function(i) {
  393. var addToList = true;
  394. var value = $(this).val();
  395. value = $(this).val();
  396. console.log("Value : " + value);
  397. if (addToList){
  398. data.push({
  399. "value": value,
  400. "dataType": $(this).attr('data-type')
  401. });
  402. }
  403. });
  404. $('#altEditor-modal .modal-body .alert').remove();
  405. var message = '<div class="alert alert-success" role="alert">\
  406. <strong>Success!</strong> This record has been deleted.\
  407. </div>';
  408. $('#altEditor-modal .modal-body').append(message);
  409. that._emitEvent("delete-row", [
  410. JSON.stringify(data),
  411. function(isDeleted) {
  412. if (isDeleted) {
  413. dt.row({
  414. selected: true
  415. }).remove();
  416. dt.draw();
  417. }
  418. //remove existing alert elements
  419. $('#altEditor-modal').modal('hide');
  420. }
  421. ]);
  422. },
  423. /**
  424. * Open Add Modal for selected row
  425. *
  426. * @private
  427. */
  428. _openAddModal: function() {
  429. var that = this;
  430. var dt = this.s.dt;
  431. var columnDefs = [];
  432. for (var i = 0; i < dt.context[0].aoColumns.length; i++) {
  433. columnDefs.push({
  434. title: dt.context[0].aoColumns[i].sTitle
  435. })
  436. }
  437. var data = "";
  438. data += "<form name='altEditor-form' role='form'>";
  439. for (var j in columnDefs) {
  440. data += "<div class='form-group'><div class='col-sm-3 col-md-3 col-lg-3 text-right' style='padding-top:7px;'><label for='" + columnDefs[j].title + "'>" + columnDefs[j].title + ":</label></div><div class='col-sm-9 col-md-9 col-lg-9'><input type='text' id='" + columnDefs[j].title + "' name='" + columnDefs[j].title + "' placeholder='" + columnDefs[j].title + "' style='overflow:hidden' class='form-control form-control-sm' value=''></div><div style='clear:both;'></div></div>";
  441. }
  442. data += "</form>";
  443. $('#altEditor-modal').on('show.bs.modal', function() {
  444. $('#altEditor-modal').find('.modal-title').html('Add Record');
  445. $('#altEditor-modal').find('.modal-body').html('<pre>' + data + '</pre>');
  446. $('#altEditor-modal').find('.modal-footer').html("<button type='button' data-content='remove' class='btn btn-default' data-dismiss='modal'>Close</button>\
  447. <button type='button' data-content='remove' class='btn btn-primary' id='addRowBtn'>Add Record</button>");
  448. });
  449. $('#altEditor-modal').modal('show');
  450. $('#altEditor-modal input[0]').focus();
  451. },
  452. _addRowData: function() {
  453. console.log('add row')
  454. var that = this;
  455. var dt = this.s.dt;
  456. var data = [];
  457. $('form[name="altEditor-form"] input').each(function(i) {
  458. data.push($(this).val());
  459. });
  460. $('#altEditor-modal .modal-body .alert').remove();
  461. var message = '<div class="alert alert-success" role="alert">\
  462. <strong>Success!</strong> This record has been added.\
  463. </div>';
  464. $('#altEditor-modal .modal-body').append(message);
  465. dt.row.add(data).draw(false);
  466. },
  467. _getExecutionLocationFolder: function() {
  468. var fileName = "dataTables.altEditor.js";
  469. var scriptList = $("script[src]");
  470. var jsFileObject = $.grep(scriptList, function(el) {
  471. if (el.src.indexOf(fileName) !== -1) {
  472. return el;
  473. }
  474. });
  475. var jsFilePath = jsFileObject[0].src;
  476. var jsFileDirectory = jsFilePath.substring(0, jsFilePath.lastIndexOf("/") + 1);
  477. return jsFileDirectory;
  478. }
  479. });
  480. /**
  481. * altEditor version
  482. *
  483. * @static
  484. * @type String
  485. */
  486. altEditor.version = '1.0';
  487. /**
  488. * altEditor defaults
  489. *
  490. * @namespace
  491. */
  492. altEditor.defaults = {
  493. /** @type {Boolean} Ask user what they want to do, even for a single option */
  494. alwaysAsk: false,
  495. /** @type {string|null} What will trigger a focus */
  496. focus: null, // focus, click, hover
  497. /** @type {column-selector} Columns to provide auto fill for */
  498. columns: '', // all
  499. /** @type {boolean|null} Update the cells after a drag */
  500. update: null, // false is editor given, true otherwise
  501. /** @type {DataTable.Editor} Editor instance for automatic submission */
  502. editor: null
  503. };
  504. /**
  505. * Classes used by altEditor that are configurable
  506. *
  507. * @namespace
  508. */
  509. altEditor.classes = {
  510. /** @type {String} Class used by the selection button */
  511. btn: 'btn'
  512. };
  513. // Attach a listener to the document which listens for DataTables initialisation
  514. // events so we can automatically initialise
  515. $(document).on('preInit.dt.altEditor', function(e, settings, json) {
  516. if (e.namespace !== 'dt') {
  517. return;
  518. }
  519. var init = settings.oInit.altEditor;
  520. var defaults = DataTable.defaults.altEditor;
  521. if (init || defaults) {
  522. var opts = $.extend({}, init, defaults);
  523. if (init !== false) {
  524. new altEditor(settings, opts);
  525. }
  526. }
  527. });
  528. // Alias for access
  529. DataTable.altEditor = altEditor;
  530. return altEditor;
  531. }));