Item8303: add links to the right rows for sorting

git-svn-id: http://svn.foswiki.org/trunk@8446 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

Author: CrawfordCurrie

TablePlugin/data/System/TablePlugin.txt

@@ -80,6 +80,11 @@ Click on column heading text to sort by a column. Initial column will be sorted
    * Number is digits, with optional decimal point
    * Otherwise treated as text
 
+If you specify =headerrows=, then the row with the sort links is the row
+closest to the data (the last row in the header). If you do not specify
+=headerrows=, the first row that has a heading in the first column is the
+sort row. To sort by the first _footer_ row, set =headerrows="0"=.
+
 ---++++ Sorting example
 %TABLE{databg="#ffc" databgsorted="#fc3" headerbg="#903" headerbgsorted="#600" initsort="1"}%
 | *Number* | *Decimal* | *Alpha* | *Date* |
@@ -173,6 +178,7 @@ Sort icons in the header are read from System.DocumentGraphics.
 |  Version: | %$VERSION% |
 |  Release: | %$RELEASE% |
 |  Change History: | <!-- specify latest version first -->&nbsp; |
+|  9 Aug 2010 | 1.125: Crawford Currie: Item8303: fixed sorting with multiple headers |
 |  31 Jul 2010 | 1.124: Arthur Clemens: Added attribute =inlinemarkup= to optionally add HTML markup for better copy/pasting. |
 |  05 Apr 2010 | 1.123: New default colors. |
 |  13 Mar 2010 | 1.122: Arthur Clemens: Fixed sorting of columns with mixed data types: numbers, dates, strings, empty cells. |

TablePlugin/lib/Foswiki/Plugins/TablePlugin.pm

@@ -9,7 +9,7 @@ use strict;
 use warnings;
 
 our $VERSION = '$Rev$';
-our $RELEASE = '1.124';
+our $RELEASE = '1.125';
 our $SHORTDESCRIPTION =
   'Control attributes of tables and sorting of table columns';
 our $NO_PREFS_IN_TOPIC = 1;

TablePlugin/lib/Foswiki/Plugins/TablePlugin/Core.pm

@@ -1450,8 +1450,9 @@ sub emitTable {
     my $singleIndent     = "\n\t";
     my $doubleIndent     = "\n\t\t";
     my $tripleIndent     = "\n\t\t\t";
+    # Only *one* row of the table has sort links, and it will either
+    # be the last row in the header or the first row in the footer.
     my $sortLinksWritten = 0;
-    my $writingSortLinks = 0;
 
     foreach my $row (@curTable) {
         my $rowtext  = '';
@@ -1461,6 +1462,7 @@ sub emitTable {
         # update the data color count
         my $headerCellCount = 0;
         my $numberOfCols    = scalar(@$row);
+        my $writingSortLinks = 0;
 
         foreach my $fcell (@$row) {
 
@@ -1554,10 +1556,10 @@ sub emitTable {
 
                 # END html attribute
 
-    # just allow this table to be sorted.
-    #                if (   $sortThisTable
-    #                    && $rowCount == $combinedTableAttrs->{headerrows} - 1 )
-                if ( $sortThisTable && !$sortLinksWritten ) {
+                if ( $sortThisTable
+                       && (!$combinedTableAttrs->{headerrows}
+                             || $rowCount == $combinedTableAttrs->{headerrows} - 1)
+                         && ($writingSortLinks || !$sortLinksWritten)) {
                     $writingSortLinks = 1;
                     my $linkAttributes = {
                         href => $url
@@ -1630,6 +1632,10 @@ sub emitTable {
                 $attr->{class} = _appendSortedCssClass( $attr->{class} );
             }
 
+            if ($writingSortLinks) {
+                $sortLinksWritten = 1;
+            }
+
             my $isLastRow = ( $rowCount == $numberOfRows - 1 );
             if ( $attr->{rowspan} ) {
                 $isLastRow =
@@ -1655,11 +1661,6 @@ sub emitTable {
             use strict 'refs';
         }    # foreach my $fcell ( @$row )
 
-        if ($writingSortLinks) {
-            $writingSortLinks = 0;
-            $sortLinksWritten = 1;
-        }
-
         # assign css class names to tr
         # based on settings: dataBg, dataBgSorted
         my $trClassName = '';

TablePlugin/test/unit/TablePlugin/TablePluginTests.pm

@@ -229,12 +229,12 @@ sub test_doubleTheadandTfootTableusingTablePlugin {
 <table id="table$this->{test_topic}$tableCount" class="foswikiTable" rules="none" border="1">
 	<thead>
 		<tr class="foswikiTableOdd foswikiTableRowdataBgSorted0 foswikiTableRowdataBg0">
-				<th class="foswikiTableCol0 foswikiFirstCol"> <a rel="nofollow" href="$url/$TEST_WEB_NAME/TestTopicTableFormatting?sortcol=0;table=$tableCount;up=0#sorted_table" title="Sort by this column">a</a> </th>
-				<th class="foswikiTableCol1 foswikiLastCol"> <a rel="nofollow" href="$url/$TEST_WEB_NAME/TestTopicTableFormatting?sortcol=1;table=$tableCount;up=0#sorted_table" title="Sort by this column">b</a> </th>
+				<th class="foswikiTableCol0 foswikiFirstCol"> a </th>
+				<th class="foswikiTableCol1 foswikiLastCol"> b </th>
 		</tr>
 		<tr class="foswikiTableEven foswikiTableRowdataBgSorted0 foswikiTableRowdataBg0">
-				<th class="foswikiTableCol0 foswikiFirstCol"> c </th>
-				<th class="foswikiTableCol1 foswikiLastCol"> c </th>
+				<th class="foswikiTableCol0 foswikiFirstCol"> <a rel="nofollow" href="$url/$TEST_WEB_NAME/TestTopicTableFormatting?sortcol=0;table=$tableCount;up=0#sorted_table" title="Sort by this column">c</a> </th>
+				<th class="foswikiTableCol1 foswikiLastCol"> <a rel="nofollow" href="$url/$TEST_WEB_NAME/TestTopicTableFormatting?sortcol=1;table=$tableCount;up=0#sorted_table" title="Sort by this column">d</a> </th>
 		</tr>
 	</thead>
 	<tfoot>
@@ -254,7 +254,7 @@ EXPECTED
     my $actual = <<ACTUAL;
 %TABLE{headerrows="2" footerrows="1"}%
 | *a* | *b* |
-| *c* | *c* |
+| *c* | *d* |
 | 2 | 3 |
 | *ok* | *bad* |
 ACTUAL