From 23fe13c68b7d11295b113ba7e0c7b3bd4aa03645 Mon Sep 17 00:00:00 2001
From: Allan Jardine <allan.jardine@sprymedia.co.uk>
Date: Tue, 14 Sep 2010 19:43:04 +0100
Subject: [PATCH] Fixed: Column visibility was not being saved when calling
 fnSetColumnVis. It would require another draw to save the state before -
 2635.

Fixed: Column visibility was not be restored from the state saving cookie. A small tidy up of the column creation code as well - 2635.
---
 media/js/jquery.dataTables.js                 | 37 +++++++++++-------
 media/unit_testing/tests_onhold/1_dom/2608.js | 13 +++++++
 media/unit_testing/tests_onhold/1_dom/2635.js | 39 +++++++++++++++++++
 3 files changed, 75 insertions(+), 14 deletions(-)
 create mode 100755 media/unit_testing/tests_onhold/1_dom/2635.js

diff --git a/media/js/jquery.dataTables.js b/media/js/jquery.dataTables.js
index 29b01c61..4b9b860c 100644
--- a/media/js/jquery.dataTables.js
+++ b/media/js/jquery.dataTables.js
@@ -2015,6 +2015,7 @@
 			 */
 			_fnAjustColumnSizing( oSettings );
 			_fnDraw( oSettings );
+			_fnSaveState( oSettings );
 		};
 		
 		/*
@@ -2049,6 +2050,9 @@
 			var nBody = oSettings.nTBody;
 			var i, iLen;
 			
+			/* Flag to note that the table is currently being destoryed - no action should be taken */
+			oSettings.bDestroying = true;
+			
 			/* Restore hidden columns */
 			for ( i=0, iLen=oSettings.aoColumns.length ; i<iLen ; i++ )
 			{
@@ -5724,7 +5728,7 @@
 		 */
 		function _fnSaveState ( oSettings )
 		{
-			if ( !oSettings.oFeatures.bStateSave )
+			if ( !oSettings.oFeatures.bStateSave || typeof oSettings.bDestroying != 'undefined' )
 			{
 				return;
 			}
@@ -6480,30 +6484,35 @@
 			
 			/*
 			 * Columns
-			 * See if we should load columns automatically or use defined ones - a bit messy this...
+			 * See if we should load columns automatically or use defined ones
 			 */
 			var nThead = this.getElementsByTagName('thead');
 			var anThs = nThead.length===0 ? [] : _fnGetUniqueThs( nThead[0] );
-			var bUseCols = typeof oInit.aoColumns != 'undefined';
 			
-			for ( i=0, iLen=bUseCols ? oInit.aoColumns.length : anThs.length ; i<iLen ; i++ )
+			/* If not given a column array, generate one with nulls */
+			if ( typeof oInit.aoColumns == 'undefined' )
 			{
-				var oCol = bUseCols ? oInit.aoColumns[i] : null;
-				var nTh = anThs ? anThs[i] : null;
-				
-				/* Check if we have column visibilty state to restore, and also that the length of the 
-				 * state saved columns matches the currently know number of columns
-				 */
+				oInit.aoColumns = [];
+				for ( i=0, iLen=anThs.length ; i<iLen ; i++ )
+				{
+					oInit.aoColumns.push( null );
+				}
+			}
+			
+			/* Add the columns */
+			for ( i=0, iLen=oInit.aoColumns.length ; i<iLen ; i++ )
+			{
+				/* Check if we have column visibilty state to restore */
 				if ( typeof oInit.saved_aoColumns != 'undefined' && oInit.saved_aoColumns.length == iLen )
 				{
-					if ( oCol === null )
+					if ( oInit.aoColumns[i] === null )
 					{
-						oCol = {};
+						oInit.aoColumns[i] = {};
 					}
-					oCol.bVisible = oInit.saved_aoColumns[i].bVisible;
+					oInit.aoColumns[i].bVisible = oInit.saved_aoColumns[i].bVisible;
 				}
 				
-				_fnAddColumn( oSettings, nTh );
+				_fnAddColumn( oSettings, anThs ? anThs[i] : null );
 			}
 			
 			/* Add options from column definations */
diff --git a/media/unit_testing/tests_onhold/1_dom/2608.js b/media/unit_testing/tests_onhold/1_dom/2608.js
index a8a622db..e16b40a4 100755
--- a/media/unit_testing/tests_onhold/1_dom/2608.js
+++ b/media/unit_testing/tests_onhold/1_dom/2608.js
@@ -36,5 +36,18 @@ $(document).ready( function () {
 		function () { return $('#example_filter input').val() == ''; }
 	);
 	
+	oTest.fnTest( 
+		"Clean up",
+		function () {
+			$('#example').dataTable( {
+				"bStateSave": true,
+				"bDestroy": true
+			} );
+			$('#example_filter input').val( '' );
+			$('#example_filter input').keyup();
+		},
+		function () { return $('#example_filter input').val() == ''; }
+	);
+	
 	oTest.fnComplete();
 } );
\ No newline at end of file
diff --git a/media/unit_testing/tests_onhold/1_dom/2635.js b/media/unit_testing/tests_onhold/1_dom/2635.js
new file mode 100755
index 00000000..41a3cebb
--- /dev/null
+++ b/media/unit_testing/tests_onhold/1_dom/2635.js
@@ -0,0 +1,39 @@
+// DATA_TEMPLATE: dom_data
+oTest.fnStart( "2635 - Hiding column and state saving" );
+
+$(document).ready( function () {
+	$('#example').dataTable( {
+		"bStateSave": true
+	} );
+	
+	oTest.fnTest( 
+		"Set the hidden column",
+		function () {
+			$('#example').dataTable().fnSetColumnVis( 2, false );
+		},
+		function () { return $('#example thead th').length == 4; }
+	);
+	
+	oTest.fnTest( 
+		"Destroy the table and remake it - checking one column was removed",
+		function () {
+			$('#example').dataTable( {
+				"bStateSave": true,
+				"bDestroy": true
+			} );
+		},
+		function () { return $('#example thead th').length == 4; }
+	);
+	
+	oTest.fnTest( 
+		"Do it again without state saving and make sure we are back to 5 columns",
+		function () {
+			$('#example').dataTable( {
+				"bDestroy": true
+			} );
+		},
+		function () { return $('#example thead th').length == 5; }
+	);
+	
+	oTest.fnComplete();
+} );
\ No newline at end of file