From d91df1e9cf8b457a0bcd327c96900ef4e1c3c4da Mon Sep 17 00:00:00 2001
From: "bugzilla%arlen.demon.co.uk"
 <bugzilla%arlen.demon.co.uk@18797224-902f-48f8-a5cc-f745e15eee43>
Date: Sun, 24 Sep 2006 23:38:43 +0000
Subject: [PATCH] Bug 338318 UI for spellcheck in browser window (form fields)
 p=me r=neil sr=jag

git-svn-id: svn://10.0.0.236/trunk@212274 18797224-902f-48f8-a5cc-f745e15eee43
---
 .../locale/en-US/cs_nav_prefs_navigator.xhtml |   9 +-
 mozilla/suite/browser/browser-prefs.js        |   7 ++
 .../common/contentAreaContextOverlay.xul      |  30 ++++++
 mozilla/suite/common/nsContextMenu.js         | 100 ++++++++++++++++--
 mozilla/suite/common/pref/pref-languages.xul  |  16 ++-
 .../chrome/common/contentAreaCommands.dtd     |  10 +-
 .../common/help/cs_nav_prefs_navigator.xhtml  |   9 +-
 .../chrome/common/pref/pref-languages.dtd     |   6 ++
 .../classic/communicator/communicator.css     |   6 ++
 .../modern/communicator/communicator.css      |   6 ++
 mozilla/xpfe/bootstrap/browser-prefs.js       |   7 ++
 mozilla/xpfe/global/jar.mn                    |   1 +
 12 files changed, 196 insertions(+), 11 deletions(-)

diff --git a/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_navigator.xhtml b/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_navigator.xhtml
index 94dcff367ba..2c9a50367fe 100644
--- a/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_navigator.xhtml
+++ b/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_navigator.xhtml
@@ -177,7 +177,8 @@
 </ol>
 
 <p>The Languages preferences panel allows you to choose the languages and
-  character encoding for displaying web pages:</p>
+  character encoding for displaying web pages and choose if and how your typing
+  is spell checked:</p>
 
 <ul>
   <li><strong>Languages for Web Pages</strong>:
@@ -198,6 +199,12 @@
         pages.</li>
     </ul>
   </li>
+  <li><strong>Spelling:</strong>
+    <ul>
+      <li><strong>When typing check my spelling</strong>: Use the drop-down
+        list to select if and how your typing is spell checked.</li>
+    </ul>
+  </li>
 </ul>
 
 <p>[<a href="#navigator_preferences">Return to beginning of section</a>]</p>
diff --git a/mozilla/suite/browser/browser-prefs.js b/mozilla/suite/browser/browser-prefs.js
index 091cba75593..00c68b519fd 100644
--- a/mozilla/suite/browser/browser-prefs.js
+++ b/mozilla/suite/browser/browser-prefs.js
@@ -190,6 +190,13 @@ pref("news.directory",                  "");
 pref("browser.editor.disabled", false);
 pref("spellchecker.dictionary", "");
 
+// this will automatically enable inline spellchecking (if it is available) for
+// editable elements in HTML
+// 0 = spellcheck nothing
+// 1 = check multi-line controls [default]
+// 2 = check multi/single line controls
+pref("layout.spellcheckDefault", 1);
+
 // App-specific update preferences
 
 // Whether or not app updates are enabled - false initally for SeaMonkey
diff --git a/mozilla/suite/common/contentAreaContextOverlay.xul b/mozilla/suite/common/contentAreaContextOverlay.xul
index 67f9f0253ce..c7b8347e1f5 100644
--- a/mozilla/suite/common/contentAreaContextOverlay.xul
+++ b/mozilla/suite/common/contentAreaContextOverlay.xul
@@ -50,6 +50,7 @@
     // Global variable that caches the default search engine info
     var gDefaultEngine = null;
   </script>
+  <script type="application/x-javascript" src="chrome://global/content/inlineSpellCheckUI.js"/>
   <script type="application/x-javascript" src="chrome://communicator/content/nsContextMenu.js"/>
   <script type="application/x-javascript" src="chrome://communicator/content/contentAreaUtils.js"/>
 
@@ -71,6 +72,14 @@
                 oncommand="gContextMenu.allowPopupWindows();"/>
       <menuseparator id="context-sep-popup"/>
 
+      <menuitem id="spell-no-suggestions"
+                disabled="true"
+                label="&spellNoSuggestions.label;"/>
+      <menuitem id="spell-add-to-dictionary"
+                label="&spellAddToDictionary.label;"
+                accesskey="&spellAddToDictionary.accesskey;"
+                oncommand="InlineSpellCheckerUI.addToDictionary();"/>
+      <menuseparator id="spell-suggestions-separator"/>
       <menuitem id="context-openlink"
                 label="&openLinkCmd.label;"
                 accesskey="&openLinkCmd.accesskey;"
@@ -251,6 +260,27 @@
                 label="&metadataCmd.label;"
                 accesskey="&metadataCmd.accesskey;"
                 oncommand="gContextMenu.showMetadata();"/>
+      <menuseparator id="spell-separator"/>
+      <menuitem id="spell-check-enabled"
+                label="&spellEnable.label;"
+                type="checkbox"
+                accesskey="&spellEnable.accesskey;"
+                oncommand="InlineSpellCheckerUI.toggleEnabled();"/>
+      <menuitem id="spell-add-dictionaries-main"
+                label="&spellAddDictionaries.label;"
+                accesskey="&spellAddDictionaries.accesskey;"
+                oncommand="gContextMenu.addDictionaries();"/>
+      <menu id="spell-dictionaries"
+            label="&spellDictionaries.label;"
+            accesskey="&spellDictionaries.accesskey;">
+        <menupopup id="spell-dictionaries-menu">
+          <menuseparator id="spell-language-separator"/>
+          <menuitem id="spell-add-dictionaries"
+                    label="&spellAddDictionaries.label;"
+                    accesskey="&spellAddDictionaries.accesskey;"
+                    oncommand="gContextMenu.addDictionaries();"/>
+        </menupopup>
+      </menu>
       <menuseparator hidden="true" id="context-sep-bidi"/>
       <menuitem hidden="true" id="context-bidi-text-direction-toggle"
                 label="&bidiSwitchTextDirectionItem.label;"
diff --git a/mozilla/suite/common/nsContextMenu.js b/mozilla/suite/common/nsContextMenu.js
index d0a9a904f66..2f84553748d 100644
--- a/mozilla/suite/common/nsContextMenu.js
+++ b/mozilla/suite/common/nsContextMenu.js
@@ -89,8 +89,9 @@ nsContextMenu.prototype = {
           return;
         }
         // Get contextual info.
-        this.setTarget( document.popupNode );
-        
+        this.setTarget( document.popupNode, document.popupRangeParent,
+                        document.popupRangeOffset );
+
         this.isTextSelected = this.isTextSelection();
 
         this.initPopupURL();
@@ -103,6 +104,7 @@ nsContextMenu.prototype = {
         this.initNavigationItems();
         this.initViewItems();
         this.initMiscItems();
+        this.initSpellingItems();
         this.initSaveItems();
         this.initClipboardItems();
         this.initMetadataItems();
@@ -219,6 +221,40 @@ nsContextMenu.prototype = {
         this.showItem( "context-bidi-text-direction-toggle", this.onTextInput && gShowBiDi);
         this.showItem( "context-bidi-page-direction-toggle", !this.onTextInput && gShowBiDi);
     },
+    initSpellingItems : function () {
+        var canSpell = InlineSpellCheckerUI.canSpellCheck;
+        var onMisspelling = InlineSpellCheckerUI.overMisspelling;
+        this.showItem("spell-check-enabled", canSpell);
+        this.showItem("spell-separator", canSpell || this.possibleSpellChecking);
+        if (canSpell)
+            document.getElementById("spell-check-enabled").setAttribute("checked",
+                                                                        InlineSpellCheckerUI.enabled);
+        this.showItem("spell-add-to-dictionary", onMisspelling);
+
+        // suggestion list
+        this.showItem("spell-suggestions-separator", onMisspelling);
+        if (onMisspelling) {
+            var menu = document.getElementById("contentAreaContextMenu");
+            var suggestionsSeparator = document.getElementById("spell-add-to-dictionary");
+            var numsug = InlineSpellCheckerUI.addSuggestionsToMenu(menu, suggestionsSeparator, 5);
+            this.showItem("spell-no-suggestions", numsug == 0);
+        } else {
+            this.showItem("spell-no-suggestions", false);
+        }
+
+        // dictionary list
+        this.showItem("spell-dictionaries", InlineSpellCheckerUI.enabled);
+        if (canSpell) {
+            var dictMenu = document.getElementById("spell-dictionaries-menu");
+            var dictSep = document.getElementById("spell-language-separator");
+            InlineSpellCheckerUI.addDictionaryListToMenu(dictMenu, dictSep);
+        }
+
+        // when there is no spellchecker but we might be able to spellcheck
+        // add the add to dictionaries item. This will ensure that people
+        // with no dictionaries will be able to download them
+        this.showItem("spell-add-dictionaries-main", !canSpell && this.possibleSpellChecking);
+    },
     initClipboardItems : function () {
 
         // Copy depends on whether there is selected text.
@@ -236,7 +272,7 @@ nsContextMenu.prototype = {
         this.showItem( "context-paste", this.onTextInput );
         this.showItem( "context-delete", this.onTextInput );
         this.showItem( "context-sep-paste", this.onTextInput );
-        this.showItem( "context-selectall", true );
+        this.showItem( "context-selectall", !( this.onLink || this.onImage ) );
         this.showItem( "context-sep-selectall", this.isTextSelected && !this.onTextInput );
         // In a text area there will be nothing after select all, so we don't want a sep
         // Otherwise, if there's text selected then there are extra menu items
@@ -263,7 +299,7 @@ nsContextMenu.prototype = {
         this.showItem( "context-metadata", this.onMetaDataItem );
     },
     // Set various context menu attributes based on the state of the world.
-    setTarget : function ( node ) {
+    setTarget : function ( node, rangeParent, rangeOffset ) {
         // Initialize contextual info.
         this.onImage    = false;
         this.onLoadedImage = false;
@@ -276,6 +312,7 @@ nsContextMenu.prototype = {
         this.inFrame    = false;
         this.hasBGImage = false;
         this.bgImageURL = "";
+        this.possibleSpellChecking = false;
 
         // Remember the node that was clicked.
         this.target = node;
@@ -284,6 +321,35 @@ nsContextMenu.prototype = {
                                       .getService(Components.interfaces.nsIPrefBranch)
                                       .getBoolPref("browser.download.autoDownload");
 
+        // Clear any old spellchecking items from the menu, this used to
+        // be in the menu hiding code but wasn't getting called in all
+        // situations. Here, we can ensure it gets cleaned up any time the
+        // menu is shown. Note: must be before uninit because that clears the
+        // internal vars
+        InlineSpellCheckerUI.clearSuggestionsFromMenu();
+        InlineSpellCheckerUI.clearDictionaryListFromMenu();
+
+        InlineSpellCheckerUI.uninit();
+
+        // if the document is editable, show context menu like in text inputs
+        var win = this.target.ownerDocument.defaultView;
+        if (win) {
+          var editingSession = win.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
+                                  .getInterface(Components.interfaces.nsIWebNavigation)
+                                  .QueryInterface(Components.interfaces.nsIInterfaceRequestor)
+                                  .getInterface(Components.interfaces.nsIEditingSession);
+          if (editingSession.windowIsEditable(win)) {
+            this.onTextInput           = true;
+            this.possibleSpellChecking = true;
+            InlineSpellCheckerUI.init(editingSession.getEditorForWindow(win));
+            var canSpell = InlineSpellCheckerUI.canSpellCheck;
+            InlineSpellCheckerUI.initFromEvent(rangeParent, rangeOffset);
+            this.showItem("spell-check-enabled", canSpell);
+            this.showItem("spell-separator", canSpell);
+            return;
+          }
+        }
+
         // See if the user clicked on an image.
         if ( this.target.nodeType == Node.ELEMENT_NODE ) {
             if ( this.target instanceof Components.interfaces.nsIImageLoadingContent && this.target.currentURI  ) {
@@ -296,10 +362,20 @@ nsContextMenu.prototype = {
                 if ( this.target.ownerDocument instanceof ImageDocument )
                    this.onStandaloneImage = true;
             } else if ( this.target instanceof HTMLInputElement ) {
-               type = this.target.getAttribute("type");
-               this.onTextInput = this.isTargetATextBox(this.target);
+                this.onTextInput = this.isTargetATextBox(this.target);
+                // allow spellchecking UI on all writable text boxes except passwords
+                if (!this.target.readOnly && !this.target.disabled && this.target.type == "text") {
+                    this.possibleSpellChecking = true;
+                    InlineSpellCheckerUI.init(this.target.QueryInterface(Components.interfaces.nsIDOMNSEditableElement).editor);
+                    InlineSpellCheckerUI.initFromEvent(rangeParent, rangeOffset);
+                }
             } else if ( this.target instanceof HTMLTextAreaElement ) {
-                 this.onTextInput = true;
+                this.onTextInput = true;
+                if (!this.target.readOnly && !this.target.disabled) {
+                    this.possibleSpellChecking = true;
+                    InlineSpellCheckerUI.init(this.target.QueryInterface(Components.interfaces.nsIDOMNSEditableElement).editor);
+                    InlineSpellCheckerUI.initFromEvent(rangeParent, rangeOffset);
+                }
             } else if ( this.target instanceof HTMLHtmlElement ) {
                // pages with multiple <body>s are lame. we'll teach them a lesson.
                var bodyElt = this.target.ownerDocument.getElementsByTagName("body")[0];
@@ -863,6 +939,16 @@ nsContextMenu.prototype = {
         }
       }
       return false;  
+    },
+
+    addDictionaries : function()
+    {
+      try {
+        var url = pref.getComplexValue("editor.spellcheckers.url",
+                                       Components.interfaces.nsIPrefLocalizedString).data;
+        window.openDialog(getBrowserURL(), "_blank", "chrome,all,dialog=no", url);
+      }
+      catch (ex) {}
     }
 };
 
diff --git a/mozilla/suite/common/pref/pref-languages.xul b/mozilla/suite/common/pref/pref-languages.xul
index fddfc52c76c..f94fa90c6fd 100644
--- a/mozilla/suite/common/pref/pref-languages.xul
+++ b/mozilla/suite/common/pref/pref-languages.xul
@@ -50,7 +50,7 @@
   <script type="application/x-javascript" src="chrome://global/content/strres.js"/>
   <script type="application/x-javascript">
   <![CDATA[
-    var _elementIDs = ["active_languages", "DefaultCharsetList"];
+    var _elementIDs = ["active_languages", "DefaultCharsetList", "spellcheckDefault"];
     var observerService = Components.classes["@mozilla.org/observer-service;1"].getService(Components.interfaces.nsIObserverService);
     observerService.notifyObservers(null, "charsetmenu-selected", "other");
   ]]>
@@ -111,4 +111,18 @@
       </menulist> 
     </hbox>
   </groupbox>
+  <groupbox align="start">
+    <caption label="&spelling.label;"/>
+    <hbox align="center">
+      <label value="&checkSpelling.label;" accesskey="&checkSpelling.accesskey;"
+             control="spellcheckDefault"/>
+      <menulist id="spellcheckDefault" prefstring="layout.spellcheckDefault">
+        <menupopup>
+          <menuitem value="0" label="&dontCheckSpelling.label;"/>
+          <menuitem value="1" label="&multilineCheckSpelling.label;"/>
+          <menuitem value="2" label="&alwaysCheckSpelling.label;"/>
+        </menupopup>
+      </menulist>
+    </hbox>
+  </groupbox>
 </page>
diff --git a/mozilla/suite/locales/en-US/chrome/common/contentAreaCommands.dtd b/mozilla/suite/locales/en-US/chrome/common/contentAreaCommands.dtd
index 0c33fe2d028..92b502872df 100644
--- a/mozilla/suite/locales/en-US/chrome/common/contentAreaCommands.dtd
+++ b/mozilla/suite/locales/en-US/chrome/common/contentAreaCommands.dtd
@@ -99,4 +99,12 @@
 <!ENTITY bidiSwitchPageDirectionItem.accesskey    "g">
 <!ENTITY bidiSwitchTextDirectionItem.label        "Switch Text Direction">
 <!ENTITY bidiSwitchTextDirectionItem.accesskey    "w">
-
+<!ENTITY spellAddToDictionary.label     "Add to dictionary">
+<!ENTITY spellAddToDictionary.accesskey "t">
+<!ENTITY spellEnable.label              "Spell check this field">
+<!ENTITY spellEnable.accesskey          "S">
+<!ENTITY spellNoSuggestions.label       "(No spelling suggestions)">
+<!ENTITY spellDictionaries.label        "Languages">
+<!ENTITY spellDictionaries.accesskey    "L">
+<!ENTITY spellAddDictionaries.label     "Download more dictionaries...">
+<!ENTITY spellAddDictionaries.accesskey "D">
diff --git a/mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_navigator.xhtml b/mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_navigator.xhtml
index 50d8ae3d52a..31483e63375 100644
--- a/mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_navigator.xhtml
+++ b/mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_navigator.xhtml
@@ -177,7 +177,8 @@
 </ol>
 
 <p>The Languages preferences panel allows you to choose the languages and
-  character encoding for displaying web pages:</p>
+  character encoding for displaying web pages and choose if and how your typing
+  is spell checked:</p>
 
 <ul>
   <li><strong>Languages for Web Pages</strong>:
@@ -198,6 +199,12 @@
         pages.</li>
     </ul>
   </li>
+  <li><strong>Spelling:</strong>
+    <ul>
+      <li><strong>When typing check my spelling</strong>: Use the drop-down
+        list to select if and how your typing is spell checked.</li>
+    </ul>
+  </li>
 </ul>
 
 <p>[<a href="#navigator_preferences">Return to beginning of section</a>]</p>
diff --git a/mozilla/suite/locales/en-US/chrome/common/pref/pref-languages.dtd b/mozilla/suite/locales/en-US/chrome/common/pref/pref-languages.dtd
index 8e75207725d..c017b081b93 100644
--- a/mozilla/suite/locales/en-US/chrome/common/pref/pref-languages.dtd
+++ b/mozilla/suite/locales/en-US/chrome/common/pref/pref-languages.dtd
@@ -37,3 +37,9 @@
 <!ENTITY languages.customize.moveDown.label             "Move Down">
 <!ENTITY languages.customize.moveDown.accesskey         "d">
 
+<!ENTITY spelling.label                                 "Spelling">
+<!ENTITY checkSpelling.label                            "When typing check my spelling:">
+<!ENTITY checkSpelling.accesskey                        "W">
+<!ENTITY dontCheckSpelling.label                        "Never">
+<!ENTITY multilineCheckSpelling.label                   "In multiline boxes">
+<!ENTITY alwaysCheckSpelling.label                      "All boxes">
diff --git a/mozilla/themes/classic/communicator/communicator.css b/mozilla/themes/classic/communicator/communicator.css
index cc7b3b11761..11c53fe5b2b 100644
--- a/mozilla/themes/classic/communicator/communicator.css
+++ b/mozilla/themes/classic/communicator/communicator.css
@@ -62,6 +62,12 @@
   list-style-image: url("chrome://communicator/skin/icons/online.gif");
 }
 
+/* ::::: spell checker ::::: */
+
+.spell-suggestion {
+  font-weight: bold;
+}
+
 /* ::::: directional button icons ::::: */
 
 .up {
diff --git a/mozilla/themes/modern/communicator/communicator.css b/mozilla/themes/modern/communicator/communicator.css
index 955b51bd61b..9fe139b5319 100644
--- a/mozilla/themes/modern/communicator/communicator.css
+++ b/mozilla/themes/modern/communicator/communicator.css
@@ -57,6 +57,12 @@
   list-style-image: url("chrome://communicator/skin/icons/online.gif");
 }
 
+/* ::::: spell checker ::::: */
+
+.spell-suggestion {
+  font-weight: bold;
+}
+
 /* ::::: directional button icons ::::: */
 
 .up {
diff --git a/mozilla/xpfe/bootstrap/browser-prefs.js b/mozilla/xpfe/bootstrap/browser-prefs.js
index 8db86580e90..7694a794c3f 100644
--- a/mozilla/xpfe/bootstrap/browser-prefs.js
+++ b/mozilla/xpfe/bootstrap/browser-prefs.js
@@ -189,6 +189,13 @@ pref("news.directory",                  "");
 pref("browser.editor.disabled", false);
 pref("spellchecker.dictionary", "");
 
+// this will automatically enable inline spellchecking (if it is available) for
+// editable elements in HTML
+// 0 = spellcheck nothing
+// 1 = check multi-line controls [default]
+// 2 = check multi/single line controls
+pref("layout.spellcheckDefault", 1);
+
 pref("extensions.getMoreLocalesURL", "chrome://branding/locale/brand.properties");
 
 pref("xpinstall.dialog.confirm",        "chrome://communicator/content/xpinstall/institems.xul");
diff --git a/mozilla/xpfe/global/jar.mn b/mozilla/xpfe/global/jar.mn
index 4441d230e1a..1b9b651da70 100644
--- a/mozilla/xpfe/global/jar.mn
+++ b/mozilla/xpfe/global/jar.mn
@@ -25,6 +25,7 @@ toolkit.jar:
         content/global/nsTransferable.js            (resources/content/nsTransferable.js) 
         content/global/nsUserSettings.js            (resources/content/nsUserSettings.js) 
         content/global/xul.css                      (resources/content/xul.css) 
+*       content/global/inlineSpellCheckUI.js        (/toolkit/content/inlineSpellCheckUI.js)
         content/global/plugins.html                 (/toolkit/content/plugins.html)
         content/global/plugins.css                  (/toolkit/content/plugins.css)
         content/global/printdialog.xul              (resources/content/printdialog.xul)