Changeset 1040

Timestamp:

10/01/08 15:01:08 (2 months ago)

Author:

douglas

Message:

FIXED Ticket #1280 Introduce workarounds for bug in IE's TextRange?.select() method.

Files:

• branches/new-dialogs/modules/InternetExplorer/InternetExplorer.js (modified) (3 diffs)

branches/new-dialogs/modules/InternetExplorer/InternetExplorer.js

@@ -146 +146 @@
    // make sure there is something before the first script on the page
    html = html.replace(/(<script|<!--)/i,"&nbsp;$1");
+
+   // We've got a workaround for certain issues with saving and restoring
+   // selections that may cause us to fill in junk span tags.  We'll clean
+   // those here
+   html = html.replace(/<span[^>]+id="__InsertSpan_Workaround_[a-z]+".*?><\/span>/i,"");
    
    return html;
@@ -154 +159 @@
    // remove space added before first script on the page
    html = html.replace(/&nbsp;(\s*)(<script|<!--)/i,"$1$2");
+
+   // We've got a workaround for certain issues with saving and restoring
+   // selections that may cause us to fill in junk span tags.  We'll clean
+   // those here
+   html = html.replace(/<span[^>]+id="__InsertSpan_Workaround_[a-z]+".*?><\/span>/i,"");
    
    return html;
@@ -441 +451 @@
 Xinha.prototype.restoreSelection = function(savedSelection)
 {
+  // In order to prevent triggering the IE bug mentioned below, we will try to
+  // optimize by not restoring the selection if it happens to match the current
+  // selection.
+  var range = this.createRange(this.getSelection());
+
+  // We can't compare two selections that come from different documents, so we
+  // must make sure they're from the same document.
+  var findDoc = function(el)
+  {
+    for (var root=el; root; root=root.parentNode)
+    {
+      if (root.tagName.toLowerCase() == 'html')
+      {
+        return root.parentNode;
+      }
+    }
+    return null;
+  }
+
+  if (findDoc(savedSelection.parentElement()) == findDoc(range.parentElement()))
+  {
+    if ((0 == range.compareEndPoints('StartToStart',savedSelection)) &&
+        (0 == range.compareEndPoints('EndToEnd',savedSelection)))
+    {
+      // The selection hasn't moved, no need to restore.
+      return;
+    }
+  }
+
   try { savedSelection.select() } catch (e) {};
+  range = this.createRange(this.getSelection());
+  if (range.parentElement() != savedSelection.parentElement())
+  {
+    // IE has a problem with selections at the end of text nodes that
+    // immediately precede block nodes. Example markup:
+    // <div>Text Node<p>Text in Block</p></div>
+    //               ^
+    // The problem occurs when the cursor is after the 'e' in Node.
+
+    var solution = editor.config.selectWorkaround || 'InsertSpan';
+    switch (solution)
+    {
+      case 'SimulateClick':
+        // Try to get the bounding box of the selection and then simulate a
+        // mouse click in the upper right corner to return the cursor to the
+        // correct location.
+
+        // No code yet, fall through to InsertSpan
+      case 'InsertSpan':
+        // This workaround inserts an empty span element so that we are no
+        // longer trying to select a text node,
+        var parentDoc = findDoc(savedSelection.parentElement());
+
+        // A function used to generate a unique ID for our temporary span.
+        var randLetters = function(count)
+        {
+          // Build a list of 26 letters.
+          var Letters = '';
+          for (var index = 0; index<26; ++index)
+          {
+            Letters += String.fromCharCode('a'.charCodeAt(0) + index);
+          }
+
+          var result = '';
+          for (var index=0; index<count; ++index)
+          {
+            result += Letters.substr(Math.floor(Math.random()*26 + 1), 1);
+          }
+          return result;
+        }
+
+        // We'll try to find a unique ID to use for finding our element.
+        var keyLength = 1;
+        var tempId = '__InsertSpan_Workaround_' + randLetters(keyLength);
+        while (parentDoc.getElementById(tempId))
+        {
+          // Each time there's a collision, we'll increase our key length by
+          // one, making the chances of a collision exponentially more rare.
+          keyLength += 1;
+          tempId = '__InsertSpan_Workaround_' + randLetters(keyLength);
+        }
+
+        // Now that we have a uniquely identifiable element, we'll stick it and
+        // and use it to orient our selection.
+        savedSelection.pasteHTML('<span id="' + tempId + '"></span>');
+        var tempSpan = parentDoc.getElementById(tempId);
+        savedSelection.moveToElementText(tempSpan);
+        savedSelection.select();
+        break;
+      case 'JustificationHack':
+        // Setting the justification on an element causes IE to alter the
+        // markup so that the selection we want to make is possible.
+        // Unfortunately, this can force block elements to be kicked out of
+        // their containing element, so it is not recommended.
+
+        // Set a non-valid character and use it to anchor our selection.
+        var magicString = String.fromCharCode(1);
+        savedSelection.pasteHTML(magicString);
+        savedSelection.findText(magicString,-1);
+        savedSelection.select();
+
+        // I don't know how to find out if there's an existing justification on
+        // this element.  Hopefully, you're doing all of your styling outside,
+        // so I'll just clear.  I already told you this was a hack.
+        savedSelection.execCommand('JustifyNone');
+        savedSelection.pasteHTML('');
+        break;
+      case 'VisiblePrompt':
+      default:
+        // This method will insert a little box character to hold our selection
+        // in the desired spot.  We're depending on the user to see this ugly
+        // box and delete it themselves.
+        var magicString = String.fromCharCode(1);
+        savedSelection.pasteHTML(magicString);
+        savedSelection.findText(magicString,-1);
+        savedSelection.select();
+    }
+  }
 }