From b970f7ac4f4a5e027ceebdf3a44172af08ae02a7 Mon Sep 17 00:00:00 2001
From: "neil%parkwaycc.co.uk" <neil%parkwaycc.co.uk>
Date: Wed, 12 Feb 2003 11:42:50 +0000
Subject: [PATCH] Bug 112264 need descriptive tooltips for thread pane column
 headers r/sr=sspitzer a=asa

---
 .../base/resources/content/commandglue.js     |  4 ++
 .../base/resources/content/threadPane.xul     | 54 +++++++++++++------
 .../locale/en-US/messenger.properties         |  4 ++
 .../resources/locale/en-US/threadpane.dtd     | 17 +++++-
 4 files changed, 60 insertions(+), 19 deletions(-)

diff --git a/mailnews/base/resources/content/commandglue.js b/mailnews/base/resources/content/commandglue.js
index 3dfb21cae454..220e3f1ec2ee 100644
--- a/mailnews/base/resources/content/commandglue.js
+++ b/mailnews/base/resources/content/commandglue.js
@@ -385,11 +385,13 @@ function SetSentFolderColumns(isSentFolder)
   var searchCriteria = document.getElementById("searchCriteria");
   if(isSentFolder)
   {
+    senderOrRecipientColumn.setAttribute("tooltiptext", gMessengerBundle.getString("recipientColumnTooltip"));
     senderOrRecipientColumn.setAttribute("label", gMessengerBundle.getString("recipientColumnHeader"));
     searchCriteria.setAttribute("value", gMessengerBundle.getString("recipientSearchCriteria"));
   }
   else
   {
+    senderOrRecipientColumn.setAttribute("tooltiptext", gMessengerBundle.getString("senderColumnTooltip"));
     senderOrRecipientColumn.setAttribute("label", gMessengerBundle.getString("senderColumnHeader"));
     searchCriteria.setAttribute("value", gMessengerBundle.getString("senderSearchCriteria"));
   }
@@ -400,9 +402,11 @@ function SetNewsFolderColumns(isNewsFolder)
   var sizeColumn = document.getElementById("sizeCol");
 
   if (isNewsFolder) {
+     sizeColumn.setAttribute("tooltiptext",gMessengerBundle.getString("linesColumnTooltip"));
      sizeColumn.setAttribute("label",gMessengerBundle.getString("linesColumnHeader"));
   }
   else {
+     sizeColumn.setAttribute("tooltiptext", gMessengerBundle.getString("sizeColumnTooltip"));
      sizeColumn.setAttribute("label", gMessengerBundle.getString("sizeColumnHeader"));
   }
 }
diff --git a/mailnews/base/resources/content/threadPane.xul b/mailnews/base/resources/content/threadPane.xul
index 2c7357cfbc31..95d61cfb38cd 100644
--- a/mailnews/base/resources/content/threadPane.xul
+++ b/mailnews/base/resources/content/threadPane.xul
@@ -18,13 +18,17 @@ The Initial Developer of the Original Code is Netscape
 Communications Corporation. Portions created by Netscape are
  Copyright (C) 1998-1999 Netscape Communications Corporation. All
 Rights Reserved.
+
+Contributors:
+  Neil Rashbrook <neil@parkwaycc.co.uk>
+
 -->
 
 <?xml-stylesheet href="chrome://messenger/skin/threadPane.css" type="text/css"?>
 <?xml-stylesheet href="chrome://messenger/skin/threadPaneExtras.css" type="text/css"?>
 <?xml-stylesheet href="chrome://messenger/skin/threadPaneLabels.css" type="text/css"?>
 
-<!DOCTYPE window SYSTEM "chrome://messenger/locale/threadpane.dtd">
+<!DOCTYPE overlay SYSTEM "chrome://messenger/locale/threadpane.dtd">
 
 <overlay
   xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
@@ -35,36 +39,52 @@ Rights Reserved.
     onkeypress="ThreadPaneKeyPress(event);"
     onselect="ThreadPaneSelectionChanged();">
   <treecols>
-    <treecol id="threadCol" display="&threadColumn.label;" class="treecol-image threadColumnHeader" currentView="unthreaded" cycler="true" persist="hidden ordinal" fixed="true" />
-    <treecol id="subjectCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="7" label="&subjectColumn.label;" ignoreincolumnpicker="true"/>
+    <treecol id="threadCol" persist="hidden ordinal" fixed="true" cycler="true" class="treecol-image threadColumnHeader" currentView="unthreaded"
+             display="&threadColumn.label;" tooltiptext="&threadColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="senderOrRecipientCol" class="sortDirectionIndicator" persist="hidden ordinal width"  flex="4" label="&senderColumn.label;"/>
+    <treecol id="subjectCol" persist="hidden ordinal width" flex="7" ignoreincolumnpicker="true"
+             label="&subjectColumn.label;" tooltiptext="&subjectColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="unreadButtonColHeader" fixed="true" persist="hidden ordinal" class="treecol-image readColumnHeader" display="&readColumn.label;" cycler="true"/> 
+    <treecol id="senderOrRecipientCol" persist="hidden ordinal width" flex="4"
+             label="&senderColumn.label;" tooltiptext="&senderColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="dateCol" class="sortDirectionIndicator" persist="hidden ordinal width"  flex="2" label="&dateColumn.label;"/>
+    <treecol id="unreadButtonColHeader" persist="hidden ordinal" fixed="true" cycler="true" class="treecol-image readColumnHeader"
+             display="&readColumn.label;" tooltiptext="&readColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="statusCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1" label="&statusColumn.label;"/>
+    <treecol id="dateCol" persist="hidden ordinal width" flex="2"
+             label="&dateColumn.label;" tooltiptext="&dateColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="sizeCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1"  label="&sizeColumn.label;"/>
+    <treecol id="statusCol" persist="hidden ordinal width" flex="1" hidden="true"
+             label="&statusColumn.label;" tooltiptext="&statusColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="junkStatusCol" fixed="true" persist="hidden ordinal width" class="treecol-image junkStatusHeader" display="&junkStatusColumn.label;" cycler="true"/>
+    <treecol id="sizeCol" persist="hidden ordinal width" flex="1" hidden="true"
+             label="&sizeColumn.label;" tooltiptext="&sizeColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="flaggedCol" fixed="true" persist="hidden ordinal" class="treecol-image flagColumnHeader" display="&flagColumn.label;" cycler="true"/>
+    <treecol id="junkStatusCol" persist="hidden ordinal width" fixed="true" cycler="true" hidden="true" class="treecol-image junkStatusHeader"
+             display="&junkStatusColumn.label;" tooltiptext="&junkStatusColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="labelCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1" label="&labelColumn.label;"/>
+    <treecol id="flaggedCol" persist="hidden ordinal" fixed="true" cycler="true" hidden="true" class="treecol-image flagColumnHeader"
+             display="&flagColumn.label;" tooltiptext="&flagColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="priorityCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1" label="&priorityColumn.label;"/>
+    <treecol id="labelCol" persist="hidden ordinal width" flex="1" hidden="true"
+             label="&labelColumn.label;" tooltiptext="&labelColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="unreadCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1" label="&unreadColumn.label;"/>
+    <treecol id="priorityCol" persist="hidden ordinal width" flex="1"
+             label="&priorityColumn.label;" tooltiptext="&priorityColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="totalCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1" label="&totalColumn.label;"/>
+    <treecol id="unreadCol" persist="hidden ordinal width" flex="1" hidden="true"
+             label="&unreadColumn.label;" tooltiptext="&unreadColumn.tooltip;"/>
     <splitter class="tree-splitter"/>
-    <treecol id="locationCol" class="sortDirectionIndicator" persist="width" flex="1" hidden="true" ignoreincolumnpicker="true" label="&locationColumn.label;"/>
+    <treecol id="totalCol" persist="hidden ordinal width" flex="1" hidden="true"
+             label="&totalColumn.label;" tooltiptext="&totalColumn.tooltip;"/>
+    <splitter class="tree-splitter"/>
+    <treecol id="locationCol" persist="width" flex="1" hidden="true" ignoreincolumnpicker="true"
+             label="&locationColumn.label;" tooltiptext="&locationColumn.tooltip;"/>
 <!-- not enabled yet.  note, Mail.app has it.  useful for debugging.
-     if we were going to turn it on, we'd need to add "View | Sort By | ID", too
+     users can still sort by ID via the menu (Order Received)
     <splitter class="tree-splitter"/>
-    <treecol id="idCol" class="sortDirectionIndicator" persist="hidden ordinal width" flex="1" label="&idColumn.label;"/>
+    <treecol id="idCol" persist="hidden ordinal width" flex="1" hidden="true"
+             label="&idColumn.label;" display="&orderReceivedColumn.label;" tooltiptext="&idColumn.tooltip;"/>
 -->
   </treecols>
   <treechildren ondraggesture="BeginDragThreadPane(event);"/>
diff --git a/mailnews/base/resources/locale/en-US/messenger.properties b/mailnews/base/resources/locale/en-US/messenger.properties
index 599bb281b112..b89bd432ceff 100644
--- a/mailnews/base/resources/locale/en-US/messenger.properties
+++ b/mailnews/base/resources/locale/en-US/messenger.properties
@@ -106,12 +106,16 @@ serverType-none=Local Mail Store
 serverType-movemail=Unix Movemail
 
 # used in the column and in the "View | Sort By " menu
+recipientColumnTooltip=Click to sort by recipient
 recipientColumnHeader=Recipient
 recipientAccessKey=r
+senderColumnTooltip=Click to sort by sender
 senderColumnHeader=Sender
 senderAccessKey=r
 
+sizeColumnTooltip=Click to sort by size
 sizeColumnHeader=Size
+linesColumnTooltip=Click to sort by lines
 linesColumnHeader=Lines
 
 # status feedback stuff
diff --git a/mailnews/base/resources/locale/en-US/threadpane.dtd b/mailnews/base/resources/locale/en-US/threadpane.dtd
index f7118d31cc13..1d52ae28044f 100644
--- a/mailnews/base/resources/locale/en-US/threadpane.dtd
+++ b/mailnews/base/resources/locale/en-US/threadpane.dtd
@@ -37,8 +37,21 @@ Rights Reserved.
 <!ENTITY idColumn.label "ID">
 
 <!--Tooltips-->
-<!ENTITY threadColumnHeader.tooltip "Click to display message threads"> 
-<!ENTITY columnChooser.tooltip "Click to select columns to display"> 
+<!ENTITY threadColumn.tooltip "Click to display message threads"> 
+<!ENTITY senderColumn.tooltip "Click to sort by sender">
+<!ENTITY subjectColumn.tooltip "Click to sort by subject">
+<!ENTITY dateColumn.tooltip "Click to sort by date">
+<!ENTITY priorityColumn.tooltip "Click to sort by priority">
+<!ENTITY labelColumn.tooltip "Click to sort by label">
+<!ENTITY statusColumn.tooltip "Click to sort by status">
+<!ENTITY sizeColumn.tooltip "Click to sort by size">
+<!ENTITY junkStatusColumn.tooltip "Click to sort by junk status">
+<!ENTITY unreadColumn.tooltip "Click to sort by unread">
+<!ENTITY totalColumn.tooltip "Click to sort by total">
+<!ENTITY readColumn.tooltip "Click to sort by read">
+<!ENTITY flagColumn.tooltip "Click to sort by flag">
+<!ENTITY locationColumn.tooltip "Click to sort by location">
+<!ENTITY idColumn.tooltip "Click to sort by order received">