From 5586b73117f64b8fe0889d988bcb9700decfafdf Mon Sep 17 00:00:00 2001
From: "Denis.Zhdanov" <Denis.Zhdanov@jetbrains.com>
Date: Fri, 13 Jul 2012 08:37:59 +0400
Subject: [PATCH] IDEA-66333 Quick documentation lookup on mouse hover

Updating pinned doc content on Ctrl+mouse hover
---
 .../documentation/DocumentationManager.java   |  4 +-
 .../QuickDocOnMouseOverManager.java           |  2 +-
 .../navigation/CtrlMouseHandler.java          | 53 +++++++++++++++----
 3 files changed, 47 insertions(+), 12 deletions(-)

diff --git a/platform/lang-impl/src/com/intellij/codeInsight/documentation/DocumentationManager.java b/platform/lang-impl/src/com/intellij/codeInsight/documentation/DocumentationManager.java
index 2d8469c26136..512b28c3ea51 100644
--- a/platform/lang-impl/src/com/intellij/codeInsight/documentation/DocumentationManager.java
+++ b/platform/lang-impl/src/com/intellij/codeInsight/documentation/DocumentationManager.java
@@ -180,8 +180,8 @@ public class DocumentationManager extends DockablePopupManager<DocumentationComp
     return myCloseOnSneeze;
   }
 
-  public boolean hasDockedDocWindow() {
-    return myToolWindow != null;
+  public boolean hasActiveDockedDocWindow() {
+    return myToolWindow != null && myToolWindow.isVisible();
   }
   
   public void setAllowContentUpdateFromContext(boolean allow) {
diff --git a/platform/lang-impl/src/com/intellij/codeInsight/documentation/QuickDocOnMouseOverManager.java b/platform/lang-impl/src/com/intellij/codeInsight/documentation/QuickDocOnMouseOverManager.java
index 82da337ffdd4..233edbefcf4e 100644
--- a/platform/lang-impl/src/com/intellij/codeInsight/documentation/QuickDocOnMouseOverManager.java
+++ b/platform/lang-impl/src/com/intellij/codeInsight/documentation/QuickDocOnMouseOverManager.java
@@ -301,7 +301,7 @@ public class QuickDocOnMouseOverManager {
       
       // We don't want to show a quick doc control if there is an active hint (e.g. the mouse is under an invalid element
       // and corresponding error info is shown).
-      if (!info.docManager.hasDockedDocWindow() && myHintManager.hasShownHintsThatWillHideByOtherHint(false)) {
+      if (!info.docManager.hasActiveDockedDocWindow() && myHintManager.hasShownHintsThatWillHideByOtherHint(false)) {
         myAlarm.addRequest(this, EditorSettingsExternalizable.getInstance().getQuickDocOnMouseOverElementDelayMillis());
         return;
       }
diff --git a/platform/lang-impl/src/com/intellij/codeInsight/navigation/CtrlMouseHandler.java b/platform/lang-impl/src/com/intellij/codeInsight/navigation/CtrlMouseHandler.java
index ec0041d1eb6f..739d682c6660 100644
--- a/platform/lang-impl/src/com/intellij/codeInsight/navigation/CtrlMouseHandler.java
+++ b/platform/lang-impl/src/com/intellij/codeInsight/navigation/CtrlMouseHandler.java
@@ -32,7 +32,9 @@ import com.intellij.navigation.NavigationItem;
 import com.intellij.openapi.actionSystem.IdeActions;
 import com.intellij.openapi.actionSystem.MouseShortcut;
 import com.intellij.openapi.actionSystem.Shortcut;
-import com.intellij.openapi.application.*;
+import com.intellij.openapi.application.AccessToken;
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.application.ReadAction;
 import com.intellij.openapi.components.AbstractProjectComponent;
 import com.intellij.openapi.editor.Document;
 import com.intellij.openapi.editor.Editor;
@@ -85,13 +87,14 @@ import java.util.List;
 
 public class CtrlMouseHandler extends AbstractProjectComponent {
 
-  private static final int ourQuickDocRowsNumber         = getIntProperty("quick.doc.desired.rows.number", 1);
+  private static final int    ourQuickDocRowsNumber = getIntProperty("quick.doc.desired.rows.number", 1);
 
   private final TextAttributes  ourReferenceAttributes;
   private       HighlightersSet myHighlighter;
   @JdkConstants.InputEventMask private int             myStoredModifiers = 0;
   private                              TooltipProvider myTooltipProvider = null;
-  private final FileEditorManager myFileEditorManager;
+  private final FileEditorManager    myFileEditorManager;
+  private final DocumentationManager myDocumentationManager;
 
   private enum BrowseMode {None, Declaration, TypeDeclaration, Implementation}
 
@@ -194,17 +197,26 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
       .createTextAttributesKey("CTRL_CLICKABLE", new TextAttributes(Color.blue, null, Color.blue, EffectType.LINE_UNDERSCORE, 0));
 
   public CtrlMouseHandler(final Project project, StartupManager startupManager, EditorColorsManager colorsManager,
-                          FileEditorManager fileEditorManager) {
+                          FileEditorManager fileEditorManager, @NotNull DocumentationManager documentationManager,
+                          @NotNull final EditorFactory editorFactory)
+  {
     super(project);
     startupManager.registerPostStartupActivity(new DumbAwareRunnable() {
       public void run() {
-        EditorEventMulticaster eventMulticaster = EditorFactory.getInstance().getEventMulticaster();
+        EditorEventMulticaster eventMulticaster = editorFactory.getEventMulticaster();
         eventMulticaster.addEditorMouseListener(myEditorMouseAdapter, project);
         eventMulticaster.addEditorMouseMotionListener(myEditorMouseMotionListener, project);
+        eventMulticaster.addCaretListener(new CaretListener() {
+          @Override
+          public void caretPositionChanged(CaretEvent e) {
+            myDocumentationManager.setAllowContentUpdateFromContext(true);
+          }
+        }, project);
       }
     });
     ourReferenceAttributes = colorsManager.getGlobalScheme().getAttributes(CTRL_CLICKABLE_ATTRIBUTES_KEY);
     myFileEditorManager = fileEditorManager;
+    myDocumentationManager = documentationManager;
   }
 
   @NotNull
@@ -343,6 +355,8 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
 
     public abstract boolean isValid(Document document);
 
+    public abstract void showDocInfo(@NotNull DocumentationManager docManager);
+
     protected boolean rangesAreCorrect(Document document) {
       final TextRange docRange = new TextRange(0, document.getTextLength());
       for (TextRange range : getRanges()) {
@@ -392,6 +406,12 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
 
       return rangesAreCorrect(document);
     }
+
+    @Override
+    public void showDocInfo(@NotNull DocumentationManager docManager) {
+      docManager.showJavaDocInfo(myTargetElement, myElementAtPointer, true, null);
+      docManager.setAllowContentUpdateFromContext(false);
+    }
   }
 
   private static class InfoMultiple extends Info {
@@ -408,6 +428,11 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
     public boolean isValid(Document document) {
       return rangesAreCorrect(document);
     }
+
+    @Override
+    public void showDocInfo(@NotNull DocumentationManager docManager) {
+      // Do nothing
+    }
   }
 
   @Nullable
@@ -608,10 +633,14 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
       DocInfo docInfo = info.getInfo();
 
       if (docInfo.text == null) return;
+
+      if (myDocumentationManager.hasActiveDockedDocWindow()) {
+        info.showDocInfo(myDocumentationManager);
+      }
       
       HyperlinkListener listener = (docInfo.docProvider == null || docInfo.context == null)
                                    ? null
-                                   : new QuickDocHyperlinkListener(myProject, docInfo.docProvider, docInfo.context);
+                                   : new QuickDocHyperlinkListener(myProject, myDocumentationManager, docInfo.docProvider, docInfo.context);
       JComponent label = HintUtil.createInformationLabel(docInfo.text, listener);
       final LightweightHint hint = new LightweightHint(label);
       final HintManagerImpl hintManager = HintManagerImpl.getInstanceImpl();
@@ -691,11 +720,17 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
   private static class QuickDocHyperlinkListener implements HyperlinkListener {
 
     @NotNull private final Project               myProject;
+    @NotNull private final DocumentationManager  myDocumentationManager;
     @NotNull private final DocumentationProvider myProvider;
     @NotNull private final PsiElement            myContext;
 
-    QuickDocHyperlinkListener(@NotNull Project project, @NotNull DocumentationProvider provider, @NotNull PsiElement context) {
+    QuickDocHyperlinkListener(@NotNull Project project,
+                              @NotNull DocumentationManager manager,
+                              @NotNull DocumentationProvider provider,
+                              @NotNull PsiElement context)
+    {
       myProject = project;
+      myDocumentationManager = manager;
       myProvider = provider;
       myContext = context;
     }
@@ -712,11 +747,11 @@ public class CtrlMouseHandler extends AbstractProjectComponent {
       }
 
       String elementName = e.getDescription().substring(DocumentationManager.PSI_ELEMENT_PROTOCOL.length());
-      
+
       final PsiElement targetElement = myProvider.getDocumentationElementForLink(PsiManager.getInstance(myProject), elementName, myContext);
       if (targetElement != null) {
         ApplicationManager.getApplication().getComponent(IdeTooltipManager.class).hideCurrentNow(false);
-        DocumentationManager.getInstance(myProject).showJavaDocInfo(targetElement, myContext, true, null);
+        myDocumentationManager.showJavaDocInfo(targetElement, myContext, true, null);
       }
     }
   }