Blame view
static/plugins/datatables/extensions/KeyTable/js/dataTables.keyTable.js
28.8 KB
f96567709 modify page |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 |
/*! KeyTable 1.2.1 * ©2010-2014 SpryMedia Ltd - datatables.net/license */ /** * @summary KeyTable * @description Spreadsheet like keyboard navigation for DataTables * @version 1.2.1 * @file dataTables.keyTable.js * @author SpryMedia Ltd (www.sprymedia.co.uk) * @contact www.sprymedia.co.uk/contact * @copyright Copyright 2009-2014 SpryMedia Ltd. * * This source file is free software, available under the following license: * MIT license - http://datatables.net/license/mit * * This source file is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY * or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details. * * For details please refer to: http://www.datatables.net */ // Global scope for KeyTable for backwards compatibility. Will be removed in 1.3 var KeyTable; (function(window, document, undefined) { var factory = function( $, DataTable ) { "use strict"; KeyTable = function ( oInit ) { /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * API parameters * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* * Variable: block * Purpose: Flag whether or not KeyTable events should be processed * Scope: KeyTable - public */ this.block = false; /* * Variable: event * Purpose: Container for all event application methods * Scope: KeyTable - public * Notes: This object contains all the public methods for adding and removing events - these * are dynamically added later on */ this.event = { "remove": {} }; /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * API methods * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* * Function: fnGetCurrentPosition * Purpose: Get the currently focused cell's position * Returns: array int: [ x, y ] * Inputs: void */ this.fnGetCurrentPosition = function () { return [ _iOldX, _iOldY ]; }; /* * Function: fnGetCurrentData * Purpose: Get the currently focused cell's data (innerHTML) * Returns: string: - data requested * Inputs: void */ this.fnGetCurrentData = function () { return _nOldFocus.innerHTML; }; /* * Function: fnGetCurrentTD * Purpose: Get the currently focused cell * Returns: node: - focused element * Inputs: void */ this.fnGetCurrentTD = function () { return _nOldFocus; }; /* * Function: fnSetPosition * Purpose: Set the position of the focused cell * Returns: - * Inputs: int:x - x coordinate * int:y - y coordinate * Notes: Thanks to Rohan Daxini for the basis of this function */ this.fnSetPosition = function( x, y ) { if ( typeof x == 'object' && x.nodeName ) { _fnSetFocus( x ); } else { _fnSetFocus( _fnCellFromCoords(x, y) ); } }; /* * Function: fnBlur * Purpose: Blur the current focus * Returns: - * Inputs: - */ this.fnBlur = function() { _fnBlur(); }; /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Private parameters * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* * Variable: _nBody * Purpose: Body node of the table - cached for renference * Scope: KeyTable - private */ var _nBody = null; /* * Variable: * Purpose: * Scope: KeyTable - private */ var _nOldFocus = null; /* * Variable: _iOldX and _iOldY * Purpose: X and Y coords of the old elemet that was focused on * Scope: KeyTable - private */ var _iOldX = null; var _iOldY = null; /* * Variable: _that * Purpose: Scope saving for 'this' after a jQuery event * Scope: KeyTable - private */ var _that = null; /* * Variable: sFocusClass * Purpose: Class that should be used for focusing on a cell * Scope: KeyTable - private */ var _sFocusClass = "focus"; /* * Variable: _bKeyCapture * Purpose: Flag for should KeyTable capture key events or not * Scope: KeyTable - private */ var _bKeyCapture = false; /* * Variable: _oaoEvents * Purpose: Event cache object, one array for each supported event for speed of searching * Scope: KeyTable - private */ var _oaoEvents = { "action": [], "esc": [], "focus": [], "blur": [] }; /* * Variable: _oDatatable * Purpose: DataTables settings object for if we are actually using a * DataTables table * Scope: KeyTable - private */ var _oDatatable = null; var _bForm; var _nInput; var _bInputFocused = false; /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Private methods * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Key table events */ /* * Function: _fnEventAddTemplate * Purpose: Create a function (with closure for sKey) event addition API * Returns: function: - template function * Inputs: string:sKey - type of event to detect */ function _fnEventAddTemplate( sKey ) { /* * Function: - * Purpose: API function for adding event to cache * Returns: - * Inputs: 1. node:x - target node to add event for * 2. function:y - callback function to apply * or * 1. int:x - x coord. of target cell (can be null for live events) * 2. int:y - y coord. of target cell (can be null for live events) * 3. function:z - callback function to apply * Notes: This function is (interally) overloaded (in as much as javascript allows for * that) - the target cell can be given by either node or coords. */ return function ( x, y, z ) { if ( (x===null || typeof x == "number") && (y===null || typeof y == "number") && typeof z == "function" ) { _fnEventAdd( sKey, x, y, z ); } else if ( typeof x == "object" && typeof y == "function" ) { var aCoords = _fnCoordsFromCell( x ); _fnEventAdd( sKey, aCoords[0], aCoords[1], y ); } else { alert( "Unhandable event type was added: x" +x+ " y:" +y+ " z:" +z ); } }; } /* * Function: _fnEventRemoveTemplate * Purpose: Create a function (with closure for sKey) event removal API * Returns: function: - template function * Inputs: string:sKey - type of event to detect */ function _fnEventRemoveTemplate( sKey ) { /* * Function: - * Purpose: API function for removing event from cache * Returns: int: - number of events removed * Inputs: 1. node:x - target node to remove event from * 2. function:y - callback function to apply * or * 1. int:x - x coord. of target cell (can be null for live events) * 2. int:y - y coord. of target cell (can be null for live events) * 3. function:z - callback function to remove - optional * Notes: This function is (interally) overloaded (in as much as javascript allows for * that) - the target cell can be given by either node or coords and the function * to remove is optional */ return function ( x, y, z ) { if ( (x===null || typeof arguments[0] == "number") && (y===null || typeof arguments[1] == "number" ) ) { if ( typeof arguments[2] == "function" ) { _fnEventRemove( sKey, x, y, z ); } else { _fnEventRemove( sKey, x, y ); } } else if ( typeof arguments[0] == "object" ) { var aCoords = _fnCoordsFromCell( x ); if ( typeof arguments[1] == "function" ) { _fnEventRemove( sKey, aCoords[0], aCoords[1], y ); } else { _fnEventRemove( sKey, aCoords[0], aCoords[1] ); } } else { alert( "Unhandable event type was removed: x" +x+ " y:" +y+ " z:" +z ); } }; } /* Use the template functions to add the event API functions */ for ( var sKey in _oaoEvents ) { if ( sKey ) { this.event[sKey] = _fnEventAddTemplate( sKey ); this.event.remove[sKey] = _fnEventRemoveTemplate( sKey ); } } /* * Function: _fnEventAdd * Purpose: Add an event to the internal cache * Returns: - * Inputs: string:sType - type of event to add, given by the available elements in _oaoEvents * int:x - x-coords to add event to - can be null for "blanket" event * int:y - y-coords to add event to - can be null for "blanket" event * function:fn - callback function for when triggered */ function _fnEventAdd( sType, x, y, fn ) { _oaoEvents[sType].push( { "x": x, "y": y, "fn": fn } ); } /* * Function: _fnEventRemove * Purpose: Remove an event from the event cache * Returns: int: - number of matching events removed * Inputs: string:sType - type of event to look for * node:nTarget - target table cell * function:fn - optional - remove this function. If not given all handlers of this * type will be removed */ function _fnEventRemove( sType, x, y, fn ) { var iCorrector = 0; for ( var i=0, iLen=_oaoEvents[sType].length ; i<iLen-iCorrector ; i++ ) { if ( typeof fn != 'undefined' ) { if ( _oaoEvents[sType][i-iCorrector].x == x && _oaoEvents[sType][i-iCorrector].y == y && _oaoEvents[sType][i-iCorrector].fn == fn ) { _oaoEvents[sType].splice( i-iCorrector, 1 ); iCorrector++; } } else { if ( _oaoEvents[sType][i-iCorrector].x == x && _oaoEvents[sType][i-iCorrector].y == y ) { _oaoEvents[sType].splice( i, 1 ); return 1; } } } return iCorrector; } /* * Function: _fnEventFire * Purpose: Look thought the events cache and fire off the event of interest * Returns: int:iFired - number of events fired * Inputs: string:sType - type of event to look for * int:x - x coord of cell * int:y - y coord of ell * Notes: It might be more efficient to return after the first event has been tirggered, * but that would mean that only one function of a particular type can be * subscribed to a particular node. */ function _fnEventFire ( sType, x, y ) { var iFired = 0; var aEvents = _oaoEvents[sType]; for ( var i=0 ; i<aEvents.length ; i++ ) { if ( (aEvents[i].x == x && aEvents[i].y == y ) || (aEvents[i].x === null && aEvents[i].y == y ) || (aEvents[i].x == x && aEvents[i].y === null ) || (aEvents[i].x === null && aEvents[i].y === null ) ) { aEvents[i].fn( _fnCellFromCoords(x,y), x, y ); iFired++; } } return iFired; } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Focus functions */ /* * Function: _fnSetFocus * Purpose: Set focus on a node, and remove from an old node if needed * Returns: - * Inputs: node:nTarget - node we want to focus on * bool:bAutoScroll - optional - should we scroll the view port to the display */ function _fnSetFocus( nTarget, bAutoScroll ) { /* If node already has focus, just ignore this call */ if ( _nOldFocus == nTarget ) { return; } if ( typeof bAutoScroll == 'undefined' ) { bAutoScroll = true; } /* Remove old focus (with blur event if needed) */ if ( _nOldFocus !== null ) { _fnRemoveFocus( _nOldFocus ); } /* Add the new class to highlight the focused cell */ $(nTarget).addClass( _sFocusClass ); $(nTarget).parent().addClass( _sFocusClass ); /* If it's a DataTable then we need to jump the paging to the relevant page */ var oSettings; if ( _oDatatable ) { oSettings = _oDatatable; var iRow = _fnFindDtCell( nTarget )[1]; var bKeyCaptureCache = _bKeyCapture; /* Page forwards */ while ( iRow >= oSettings.fnDisplayEnd() ) { if ( oSettings._iDisplayLength >= 0 ) { /* Make sure we are not over running the display array */ if ( oSettings._iDisplayStart + oSettings._iDisplayLength < oSettings.fnRecordsDisplay() ) { oSettings._iDisplayStart += oSettings._iDisplayLength; } } else { oSettings._iDisplayStart = 0; } _oDatatable.oApi._fnCalculateEnd( oSettings ); } /* Page backwards */ while ( iRow < oSettings._iDisplayStart ) { oSettings._iDisplayStart = oSettings._iDisplayLength>=0 ? oSettings._iDisplayStart - oSettings._iDisplayLength : 0; if ( oSettings._iDisplayStart < 0 ) { oSettings._iDisplayStart = 0; } _oDatatable.oApi._fnCalculateEnd( oSettings ); } /* Re-draw the table */ _oDatatable.oApi._fnDraw( oSettings ); /* Restore the key capture */ _bKeyCapture = bKeyCaptureCache; } /* Cache the information that we are interested in */ var aNewPos = _fnCoordsFromCell( nTarget ); _nOldFocus = nTarget; _iOldX = aNewPos[0]; _iOldY = aNewPos[1]; var iViewportHeight, iViewportWidth, iScrollTop, iScrollLeft, iHeight, iWidth, aiPos; if ( bAutoScroll ) { /* Scroll the viewport such that the new cell is fully visible in the rendered window */ iViewportHeight = $(window).height(); iViewportWidth = $(window).width(); iScrollTop = $(document).scrollTop(); iScrollLeft = $(document).scrollLeft(); iHeight = nTarget.offsetHeight; iWidth = nTarget.offsetWidth; aiPos = _fnGetPos( nTarget ); /* Take account of scrolling in DataTables 1.7 - remove scrolling since that would add to * the positioning calculation */ if ( _oDatatable && typeof oSettings.oScroll != 'undefined' && (oSettings.oScroll.sX !== "" || oSettings.oScroll.sY !== "") ) { aiPos[1] -= $(oSettings.nTable.parentNode).scrollTop(); aiPos[0] -= $(oSettings.nTable.parentNode).scrollLeft(); } /* Correct viewport positioning for vertical scrolling */ if ( aiPos[1]+iHeight > iScrollTop+iViewportHeight ) { /* Displayed element if off the bottom of the viewport */ _fnSetScrollTop( aiPos[1]+iHeight - iViewportHeight ); } else if ( aiPos[1] < iScrollTop ) { /* Displayed element if off the top of the viewport */ _fnSetScrollTop( aiPos[1] ); } /* Correct viewport positioning for horizontal scrolling */ if ( aiPos[0]+iWidth > iScrollLeft+iViewportWidth ) { /* Displayed element is off the bottom of the viewport */ _fnSetScrollLeft( aiPos[0]+iWidth - iViewportWidth ); } else if ( aiPos[0] < iScrollLeft ) { /* Displayed element if off the Left of the viewport */ _fnSetScrollLeft( aiPos[0] ); } } /* Take account of scrolling in DataTables 1.7 */ if ( _oDatatable && typeof oSettings.oScroll != 'undefined' && (oSettings.oScroll.sX !== "" || oSettings.oScroll.sY !== "") ) { var dtScrollBody = oSettings.nTable.parentNode; iViewportHeight = dtScrollBody.clientHeight; iViewportWidth = dtScrollBody.clientWidth; iScrollTop = dtScrollBody.scrollTop; iScrollLeft = dtScrollBody.scrollLeft; iHeight = nTarget.offsetHeight; iWidth = nTarget.offsetWidth; /* Correct for vertical scrolling */ if ( nTarget.offsetTop + iHeight > iViewportHeight+iScrollTop ) { dtScrollBody.scrollTop = (nTarget.offsetTop + iHeight) - iViewportHeight; } else if ( nTarget.offsetTop < iScrollTop ) { dtScrollBody.scrollTop = nTarget.offsetTop; } /* Correct for horizontal scrolling */ if ( nTarget.offsetLeft + iWidth > iViewportWidth+iScrollLeft ) { dtScrollBody.scrollLeft = (nTarget.offsetLeft + iWidth) - iViewportWidth; } else if ( nTarget.offsetLeft < iScrollLeft ) { dtScrollBody.scrollLeft = nTarget.offsetLeft; } } /* Focused - so we want to capture the keys */ _fnCaptureKeys(); /* Fire of the focus event if there is one */ _fnEventFire( "focus", _iOldX, _iOldY ); } /* * Function: _fnBlur * Purpose: Blur focus from the whole table * Returns: - * Inputs: - */ function _fnBlur() { _fnRemoveFocus( _nOldFocus ); _iOldX = null; _iOldY = null; _nOldFocus = null; _fnReleaseKeys(); } /* * Function: _fnRemoveFocus * Purpose: Remove focus from a cell and fire any blur events which are attached * Returns: - * Inputs: node:nTarget - cell of interest */ function _fnRemoveFocus( nTarget ) { $(nTarget).removeClass( _sFocusClass ); $(nTarget).parent().removeClass( _sFocusClass ); _fnEventFire( "blur", _iOldX, _iOldY ); } /* * Function: _fnClick * Purpose: Focus on the element that has been clicked on by the user * Returns: - * Inputs: event:e - click event */ function _fnClick ( e ) { var nTarget = this; while ( nTarget.nodeName != "TD" ) { nTarget = nTarget.parentNode; } _fnSetFocus( nTarget ); _fnCaptureKeys(); } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Key events */ /* * Function: _fnKey * Purpose: Deal with a key events, be it moving the focus or return etc. * Returns: bool: - allow browser default action * Inputs: event:e - key event */ function _fnKey ( e ) { /* If user or system has blocked KeyTable from doing anything, just ignore this event */ if ( _that.block || !_bKeyCapture ) { return true; } /* If a modifier key is pressed (exapct shift), ignore the event */ if ( e.metaKey || e.altKey || e.ctrlKey ) { return true; } var x, y, iTableWidth = _nBody.getElementsByTagName('tr')[0].getElementsByTagName('td').length, iTableHeight; /* Get table height and width - done here so as to be dynamic (if table is updated) */ if ( _oDatatable ) { /* * Locate the current node in the DataTable overriding the old positions - the reason for * is is that there might have been some DataTables interaction between the last focus and * now */ iTableHeight = _oDatatable.aiDisplay.length; var aDtPos = _fnFindDtCell( _nOldFocus ); if ( aDtPos === null ) { /* If the table has been updated such that the focused cell can't be seen - do nothing */ return; } _iOldX = aDtPos[ 0 ]; _iOldY = aDtPos[ 1 ]; } else { iTableHeight = _nBody.getElementsByTagName('tr').length; } /* Capture shift+tab to match the left arrow key */ var iKey = (e.keyCode == 9 && e.shiftKey) ? -1 : e.keyCode; switch( iKey ) { case 13: /* return */ e.preventDefault(); e.stopPropagation(); _fnEventFire( "action", _iOldX, _iOldY ); return true; case 27: /* esc */ if ( !_fnEventFire( "esc", _iOldX, _iOldY ) ) { /* Only lose focus if there isn't an escape handler on the cell */ _fnBlur(); return; } x = _iOldX; y = _iOldY; break; case -1: case 37: /* left arrow */ if ( _iOldX > 0 ) { x = _iOldX - 1; y = _iOldY; } else if ( _iOldY > 0 ) { x = iTableWidth-1; y = _iOldY - 1; } else { /* at start of table */ if ( iKey == -1 && _bForm ) { /* If we are in a form, return focus to the 'input' element such that tabbing will * follow correctly in the browser */ _bInputFocused = true; _nInput.focus(); /* This timeout is a little nasty - but IE appears to have some asyhnc behaviour for * focus */ setTimeout( function(){ _bInputFocused = false; }, 0 ); _bKeyCapture = false; _fnBlur(); return true; } else { return false; } } break; case 38: /* up arrow */ if ( _iOldY > 0 ) { x = _iOldX; y = _iOldY - 1; } else { return false; } break; case 36: /* home */ x = _iOldX; y = 0; break; case 33: /* page up */ x = _iOldX; y = _iOldY - 10; if (y < 0) { y = 0; } break; case 9: /* tab */ case 39: /* right arrow */ if ( _iOldX < iTableWidth-1 ) { x = _iOldX + 1; y = _iOldY; } else if ( _iOldY < iTableHeight-1 ) { x = 0; y = _iOldY + 1; } else { /* at end of table */ if ( iKey == 9 && _bForm ) { /* If we are in a form, return focus to the 'input' element such that tabbing will * follow correctly in the browser */ _bInputFocused = true; _nInput.focus(); /* This timeout is a little nasty - but IE appears to have some asyhnc behaviour for * focus */ setTimeout( function(){ _bInputFocused = false; }, 0 ); _bKeyCapture = false; _fnBlur(); return true; } else { return false; } } break; case 40: /* down arrow */ if ( _iOldY < iTableHeight-1 ) { x = _iOldX; y = _iOldY + 1; } else { return false; } break; case 35: /* end */ x = _iOldX; y = iTableHeight-1; break; case 34: /* page down */ x = _iOldX; y = _iOldY+10; if (y > iTableHeight-1) { y = iTableHeight-1; } break; default: /* Nothing we are interested in */ return true; } _fnSetFocus( _fnCellFromCoords(x, y) ); return false; } /* * Function: _fnCaptureKeys * Purpose: Start capturing key events for this table * Returns: - * Inputs: - */ function _fnCaptureKeys( ) { if ( !_bKeyCapture ) { _bKeyCapture = true; } } /* * Function: _fnReleaseKeys * Purpose: Stop capturing key events for this table * Returns: - * Inputs: - */ function _fnReleaseKeys( ) { _bKeyCapture = false; } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Support functions */ /* * Function: _fnCellFromCoords * Purpose: Calulate the target TD cell from x and y coordinates * Returns: node: - TD target * Inputs: int:x - x coordinate * int:y - y coordinate */ function _fnCellFromCoords( x, y ) { if ( _oDatatable ) { if ( typeof _oDatatable.aoData[ _oDatatable.aiDisplay[ y ] ] != 'undefined' ) { return _oDatatable.aoData[ _oDatatable.aiDisplay[ y ] ].nTr.getElementsByTagName('td')[x]; } else { return null; } } else { return $('tr:eq('+y+')>td:eq('+x+')', _nBody )[0]; } } /* * Function: _fnCoordsFromCell * Purpose: Calculate the x and y position in a table from a TD cell * Returns: array[2] int: [x, y] * Inputs: node:n - TD cell of interest * Notes: Not actually interested in this for DataTables since it might go out of date */ function _fnCoordsFromCell( n ) { if ( _oDatatable ) { return [ $('td', n.parentNode).index(n), $('tr', n.parentNode.parentNode).index(n.parentNode) + _oDatatable._iDisplayStart ]; } else { return [ $('td', n.parentNode).index(n), $('tr', n.parentNode.parentNode).index(n.parentNode) ]; } } /* * Function: _fnSetScrollTop * Purpose: Set the vertical scrolling position * Returns: - * Inputs: int:iPos - scrolltop * Notes: This is so nasty, but without browser detection you can't tell which you should set * So on browsers that support both, the scroll top will be set twice. I can live with * that :-) */ function _fnSetScrollTop( iPos ) { document.documentElement.scrollTop = iPos; document.body.scrollTop = iPos; } /* * Function: _fnSetScrollLeft * Purpose: Set the horizontal scrolling position * Returns: - * Inputs: int:iPos - scrollleft */ function _fnSetScrollLeft( iPos ) { document.documentElement.scrollLeft = iPos; document.body.scrollLeft = iPos; } /* * Function: _fnGetPos * Purpose: Get the position of an object on the rendered page * Returns: array[2] int: [left, right] * Inputs: node:obj - element of interest */ function _fnGetPos ( obj ) { var iLeft = 0; var iTop = 0; if (obj.offsetParent) { iLeft = obj.offsetLeft; iTop = obj.offsetTop; obj = obj.offsetParent; while (obj) { iLeft += obj.offsetLeft; iTop += obj.offsetTop; obj = obj.offsetParent; } } return [iLeft,iTop]; } /* * Function: _fnFindDtCell * Purpose: Get the coords. of a cell from the DataTables internal information * Returns: array[2] int: [x, y] coords. or null if not found * Inputs: node:nTarget - the node of interest */ function _fnFindDtCell( nTarget ) { for ( var i=0, iLen=_oDatatable.aiDisplay.length ; i<iLen ; i++ ) { var nTr = _oDatatable.aoData[ _oDatatable.aiDisplay[i] ].nTr; var nTds = nTr.getElementsByTagName('td'); for ( var j=0, jLen=nTds.length ; j<jLen ; j++ ) { if ( nTds[j] == nTarget ) { return [ j, i ]; } } } return null; } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Initialisation */ /* * Function: _fnInit * Purpose: Initialise the KeyTable * Returns: - * Inputs: object:oInit - optional - Initalisation object with the following parameters: * array[2] int:focus - x and y coordinates of the initial target * or * node:focus - the node to set initial focus on * node:table - the table to use, if not given, first table with class 'KeyTable' will be used * string:focusClass - focusing class to give to table elements * object:that - focus * bool:initScroll - scroll the view port on load, default true * int:tabIndex - the tab index to give the hidden input element */ function _fnInit( table, datatable, oInit, that ) { /* Save scope */ _that = that; /* Capture undefined initialisation and apply the defaults */ if ( typeof oInit == 'undefined' ) { oInit = {}; } if ( typeof oInit.focus == 'undefined' ) { oInit.focus = [0,0]; } oInit.table = table; $(oInit.table).addClass('KeyTable'); if ( typeof oInit.focusClass != 'undefined' ) { _sFocusClass = oInit.focusClass; } if ( typeof datatable != 'undefined' ) { _oDatatable = datatable; } if ( typeof oInit.initScroll == 'undefined' ) { oInit.initScroll = true; } if ( typeof oInit.form == 'undefined' ) { oInit.form = false; } _bForm = oInit.form; /* Cache the tbody node of interest */ _nBody = oInit.table.getElementsByTagName('tbody')[0]; /* If the table is inside a form, then we need a hidden input box which can be used by the * browser to catch the browser tabbing for our table */ if ( _bForm ) { var nDiv = document.createElement('div'); _nInput = document.createElement('input'); nDiv.style.height = "1px"; /* Opera requires a little something */ nDiv.style.width = "0px"; nDiv.style.overflow = "hidden"; if ( typeof oInit.tabIndex != 'undefined' ) { _nInput.tabIndex = oInit.tabIndex; } nDiv.appendChild(_nInput); oInit.table.parentNode.insertBefore( nDiv, oInit.table.nextSibling ); $(_nInput).focus( function () { /* See if we want to 'tab into' the table or out */ if ( !_bInputFocused ) { _bKeyCapture = true; _bInputFocused = false; if ( typeof oInit.focus.nodeName != "undefined" ) { _fnSetFocus( oInit.focus, oInit.initScroll ); } else { _fnSetFocus( _fnCellFromCoords( oInit.focus[0], oInit.focus[1]), oInit.initScroll ); } /* Need to interup the thread for this to work */ setTimeout( function() { _nInput.blur(); }, 0 ); } } ); _bKeyCapture = false; } else { /* Set the initial focus on the table */ if ( typeof oInit.focus.nodeName != "undefined" ) { _fnSetFocus( oInit.focus, oInit.initScroll ); } else { _fnSetFocus( _fnCellFromCoords( oInit.focus[0], oInit.focus[1]), oInit.initScroll ); } _fnCaptureKeys(); } /* Add event listeners */ $(document).bind( "keydown", _fnKey ); if ( _oDatatable ) { $(_oDatatable.nTable).on( 'click', 'td', _fnClick ); } else { $(_nBody).on( 'click', 'td', _fnClick ); } /* Loose table focus when click outside the table */ $(document).click( function(e) { var nTarget = e.target; var bTableClick = false; while ( nTarget ) { if ( nTarget == oInit.table ) { bTableClick = true; break; } nTarget = nTarget.parentNode; } if ( !bTableClick ) { _fnBlur(); } } ); } var table, datatable; if ( oInit === undefined ) { table = $('table.KeyTable')[0]; datatable = null; } else if ( $.isPlainObject( oInit ) ) { table = oInit.table; datatable = oInit.datatable; } else { datatable = new $.fn.dataTable.Api( oInit ).settings()[0]; table = datatable.nTable; } /* Initialise our new object */ _fnInit( table, datatable, oInit, this ); }; KeyTable.version = "1.2.1"; $.fn.dataTable.KeyTable = KeyTable; $.fn.DataTable.KeyTable = KeyTable; return KeyTable; }; // /factory // Define as an AMD module if possible if ( typeof define === 'function' && define.amd ) { define( ['jquery', 'datatables'], factory ); } else if ( typeof exports === 'object' ) { // Node/CommonJS factory( require('jquery'), require('datatables') ); } else if ( jQuery && !jQuery.fn.dataTable.KeyTable ) { // Otherwise simply initialise as normal, stopping multiple evaluation factory( jQuery, jQuery.fn.dataTable ); } })(window, document); |