From 66a2e3d659b14a9bd8ee7a24a0b62d44ee41449e Mon Sep 17 00:00:00 2001
From: Allan Jardine <allan.jardine@sprymedia.co.uk>
Date: Wed, 7 Dec 2011 10:24:03 +0000
Subject: [PATCH] Experiment with tabindex on the sorting headers and the
 pagination buttons. More to follow...

---
 build/make.sh                 | 12 ++++--
 media/js/jquery.dataTables.js | 74 ++++++++++++++++++++++++++++++++++-
 media/src/DataTables.js       | 49 +++++++++++++++++++++++
 media/src/core/core.draw.js   |  2 +
 media/src/core/core.sort.js   | 12 +++++-
 media/src/ext/ext.paging.js   | 11 ++++++
 6 files changed, 153 insertions(+), 7 deletions(-)

diff --git a/build/make.sh b/build/make.sh
index 1cae3f4b..1ee56047 100755
--- a/build/make.sh
+++ b/build/make.sh
@@ -2,7 +2,7 @@
 
 # DEFAULTS
 CLOSURE="/usr/local/closure_compiler/compiler.jar"
-JSDOC3="/usr/local/jsdoc3/jsdoc.jar"
+JSDOC="/usr/local/jsdoc/jsdoc"
 
 
 echo ""
@@ -40,5 +40,11 @@ mv DataTables.js.build ../js/jquery.dataTables.js
 
 
 if [ "$1" = "compress" ]; then
-	java -jar $CLOSURE --js ../js/jquery.dataTables.js > ../js/jquery.dataTables.min.closure.js
-fi
\ No newline at end of file
+	java -jar $CLOSURE --js ../js/jquery.dataTables.js > ../js/jquery.dataTables.min.js
+fi
+
+# Docs
+if [ "$1" = "docs" ]; then
+	echo "  Documentation"
+	$JSDOC -d ../../docs -t JSDoc-DataTables ../js/jquery.dataTables.js
+fi
diff --git a/media/js/jquery.dataTables.js b/media/js/jquery.dataTables.js
index a699cdfa..ce2b168f 100644
--- a/media/js/jquery.dataTables.js
+++ b/media/js/jquery.dataTables.js
@@ -35,7 +35,9 @@
 	 * HTML table. For a full list of features please refer to
 	 * <a href="http://datatables.net">DataTables.net</a>.
 	 *  @class
+	 *  @global
 	 *  @constructor
+	 *  @name DataTable
 	 *  @param {object} [oInit={}] Configuration object for DataTables. Options
 	 *    are defined by {@link DataTable.models.oInit}
 	 *  @requires jQuery 1.3+
@@ -1069,6 +1071,7 @@
 				for ( i=0, iLen=oSettings.aoColumns.length ; i<iLen ; i++ )
 				{
 					nTh = oSettings.aoColumns[i].nTh;
+					nTh.setAttribute('tabindex', '0');
 					
 					if ( oSettings.aoColumns[i].sClass !== null )
 					{
@@ -1091,6 +1094,7 @@
 				{
 					nTh = oSettings.aoColumns[i].nTh;
 					nTh.innerHTML = oSettings.aoColumns[i].sTitle;
+					nTh.setAttribute('tabindex', '0');
 					
 					if ( oSettings.aoColumns[i].sClass !== null )
 					{
@@ -3919,7 +3923,7 @@
 		 */
 		function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
 		{
-			$(nNode).bind( 'click.DT', function (e) {
+			var sortingFn = function (e) {
 				/* If the column is not sortable - don't to anything */
 				if ( oSettings.aoColumns[iDataIndex].bSortable === false )
 				{
@@ -4024,7 +4028,15 @@
 				{
 					fnCallback( oSettings );
 				}
-			} );
+			};
+		
+			$(nNode)
+				.bind( 'click.DT', sortingFn )
+				.bind( 'keypress.DT', function (e) {
+					if ( e.which === 13 ) {
+						sortingFn(e);
+					}
+				} );
 		}
 		
 		
@@ -9919,6 +9931,9 @@
 				
 				nPrevious.className = oSettings.oClasses.sPagePrevDisabled;
 				nNext.className = oSettings.oClasses.sPageNextDisabled;
+	
+				nPrevious.setAttribute('tabindex', '0');
+				nNext.setAttribute('tabindex', '0');
 				
 				nPrevious.title = oSettings.oLanguage.oPaginate.sPrevious;
 				nNext.title = oSettings.oLanguage.oPaginate.sNext;
@@ -9928,9 +9943,17 @@
 				
 				$(nPrevious)
 					.bind( 'click.DT', { action: "previous" }, fnClickHandler )
+					.bind( 'keypress.DT', { action: "previous" }, function (e){
+						if ( e.which === 13 ) {
+							fnClickHandler(e);
+						} } )
 					.bind( 'selectstart.DT', function () { return false; } ); /* Take the brutal approach to cancelling text selection */
 				$(nNext)
 					.bind( 'click.DT', { action: "next" }, fnClickHandler )
+					.bind( 'keypress.DT', { action: "next" }, function (e){
+						if ( e.which === 13 ) {
+							fnClickHandler(e);
+						} } )
 					.bind( 'selectstart.DT', function () { return false; } );
 				
 				/* ID the first elements only */
@@ -10347,4 +10370,51 @@
 	$.fn.dataTableSettings = DataTable.settings;
 	$.fn.dataTableExt = DataTable.ext;
 
+
+	// Information about events fired by DataTables - for documentation.
+	/**
+	 * Draw event, fired whenever the table is redrawn on the page, at the same point as
+	 * fnDrawCallback. This may be useful for binding events or performing calculations when
+	 * the table is altered at all.
+	 *  @name DataTable#draw
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Filter event, fired when the filtering applied to the table (using the build in global
+	 * global filter, or column filters) is altered.
+	 *  @name DataTable#filter
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Page change event, fired when the paging of the table is altered.
+	 *  @name DataTable#page
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Sort event, fired when the sorting applied to the table is altered.
+	 *  @name DataTable#sort
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Ajax (XHR) event, fired whenever an Ajax request is completed from a request to 
+	 * made to the server for new data (note that this trigger is called in fnServerData,
+	 * if you override fnServerData and which to use this event, you need to trigger it in
+	 * you success function).
+	 *  @name DataTable#xhr
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
 })(jQuery, window, document);
diff --git a/media/src/DataTables.js b/media/src/DataTables.js
index fc878ca6..4db307e1 100644
--- a/media/src/DataTables.js
+++ b/media/src/DataTables.js
@@ -35,7 +35,9 @@
 	 * HTML table. For a full list of features please refer to
 	 * <a href="http://datatables.net">DataTables.net</a>.
 	 *  @class
+	 *  @global
 	 *  @constructor
+	 *  @name DataTable
 	 *  @param {object} [oInit={}] Configuration object for DataTables. Options
 	 *    are defined by {@link DataTable.models.oInit}
 	 *  @requires jQuery 1.3+
@@ -129,4 +131,51 @@
 	$.fn.dataTableSettings = DataTable.settings;
 	$.fn.dataTableExt = DataTable.ext;
 
+
+	// Information about events fired by DataTables - for documentation.
+	/**
+	 * Draw event, fired whenever the table is redrawn on the page, at the same point as
+	 * fnDrawCallback. This may be useful for binding events or performing calculations when
+	 * the table is altered at all.
+	 *  @name DataTable#draw
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Filter event, fired when the filtering applied to the table (using the build in global
+	 * global filter, or column filters) is altered.
+	 *  @name DataTable#filter
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Page change event, fired when the paging of the table is altered.
+	 *  @name DataTable#page
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Sort event, fired when the sorting applied to the table is altered.
+	 *  @name DataTable#sort
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
+
+	/**
+	 * Ajax (XHR) event, fired whenever an Ajax request is completed from a request to 
+	 * made to the server for new data (note that this trigger is called in fnServerData,
+	 * if you override fnServerData and which to use this event, you need to trigger it in
+	 * you success function).
+	 *  @name DataTable#xhr
+	 *  @event
+	 *  @param {event} e jQuery event object
+	 *  @param {object} o DataTables settings object {@link DataTable.models.oSettings}
+	 */
 })(jQuery, window, document);
diff --git a/media/src/core/core.draw.js b/media/src/core/core.draw.js
index 211e68a3..a8a7358d 100644
--- a/media/src/core/core.draw.js
+++ b/media/src/core/core.draw.js
@@ -96,6 +96,7 @@ function _fnBuildHead( oSettings )
 		for ( i=0, iLen=oSettings.aoColumns.length ; i<iLen ; i++ )
 		{
 			nTh = oSettings.aoColumns[i].nTh;
+			nTh.setAttribute('tabindex', '0');
 			
 			if ( oSettings.aoColumns[i].sClass !== null )
 			{
@@ -118,6 +119,7 @@ function _fnBuildHead( oSettings )
 		{
 			nTh = oSettings.aoColumns[i].nTh;
 			nTh.innerHTML = oSettings.aoColumns[i].sTitle;
+			nTh.setAttribute('tabindex', '0');
 			
 			if ( oSettings.aoColumns[i].sClass !== null )
 			{
diff --git a/media/src/core/core.sort.js b/media/src/core/core.sort.js
index 147b024d..c9b36e52 100644
--- a/media/src/core/core.sort.js
+++ b/media/src/core/core.sort.js
@@ -158,7 +158,7 @@ function _fnSort ( oSettings, bApplyClasses )
  */
 function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
 {
-	$(nNode).bind( 'click.DT', function (e) {
+	var sortingFn = function (e) {
 		/* If the column is not sortable - don't to anything */
 		if ( oSettings.aoColumns[iDataIndex].bSortable === false )
 		{
@@ -263,7 +263,15 @@ function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
 		{
 			fnCallback( oSettings );
 		}
-	} );
+	};
+
+	$(nNode)
+		.bind( 'click.DT', sortingFn )
+		.bind( 'keypress.DT', function (e) {
+			if ( e.which === 13 ) {
+				sortingFn(e);
+			}
+		} );
 }
 
 
diff --git a/media/src/ext/ext.paging.js b/media/src/ext/ext.paging.js
index f0b9830d..8ff06437 100644
--- a/media/src/ext/ext.paging.js
+++ b/media/src/ext/ext.paging.js
@@ -47,6 +47,9 @@ $.extend( DataTable.ext.oPagination, {
 			
 			nPrevious.className = oSettings.oClasses.sPagePrevDisabled;
 			nNext.className = oSettings.oClasses.sPageNextDisabled;
+
+			nPrevious.setAttribute('tabindex', '0');
+			nNext.setAttribute('tabindex', '0');
 			
 			nPrevious.title = oSettings.oLanguage.oPaginate.sPrevious;
 			nNext.title = oSettings.oLanguage.oPaginate.sNext;
@@ -56,9 +59,17 @@ $.extend( DataTable.ext.oPagination, {
 			
 			$(nPrevious)
 				.bind( 'click.DT', { action: "previous" }, fnClickHandler )
+				.bind( 'keypress.DT', { action: "previous" }, function (e){
+					if ( e.which === 13 ) {
+						fnClickHandler(e);
+					} } )
 				.bind( 'selectstart.DT', function () { return false; } ); /* Take the brutal approach to cancelling text selection */
 			$(nNext)
 				.bind( 'click.DT', { action: "next" }, fnClickHandler )
+				.bind( 'keypress.DT', { action: "next" }, function (e){
+					if ( e.which === 13 ) {
+						fnClickHandler(e);
+					} } )
 				.bind( 'selectstart.DT', function () { return false; } );
 			
 			/* ID the first elements only */