1 files changed, 156 insertions, 0 deletions
diff --git a/platform/platform-api/src/com/intellij/ui/popup/HintUpdateSupply.java b/platform/platform-api/src/com/intellij/ui/popup/HintUpdateSupply.java
new file mode 100644
index 000000000000..54b071ab0b94
--- /dev/null
+++ b/platform/platform-api/src/com/intellij/ui/popup/HintUpdateSupply.java
@@ -0,0 +1,156 @@
+/*
+ * Copyright 2000-2014 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.intellij.ui.popup;
+
+import com.intellij.openapi.ui.popup.JBPopup;
+import com.intellij.openapi.util.Key;
+import com.intellij.psi.PsiElement;
+import com.intellij.ui.ListUtil;
+import com.intellij.ui.components.JBList;
+import com.intellij.ui.table.JBTable;
+import com.intellij.ui.treeStructure.Tree;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import javax.swing.*;
+import javax.swing.event.ListSelectionEvent;
+import javax.swing.event.ListSelectionListener;
+import javax.swing.event.TreeSelectionEvent;
+import javax.swing.event.TreeSelectionListener;
+import javax.swing.tree.TreePath;
+
+/**
+ * Use this class to make various hints like QuickDocumentation, ShowImplementations, etc.
+ * respond to the selection change in the original component like ProjectView, various GoTo popups, etc.
+ *
+ * @author gregsh
+ */
+public abstract class HintUpdateSupply {
+  private static final Key<HintUpdateSupply> HINT_UPDATE_MARKER = Key.create("HINT_UPDATE_MARKER");
+
+  @Nullable
+  private JBPopup myHint;
+
+  @Nullable
+  public static HintUpdateSupply getSupply(@NotNull JComponent component) {
+    return (HintUpdateSupply)component.getClientProperty(HINT_UPDATE_MARKER);
+  }
+
+  public static void hideHint(@NotNull JComponent component) {
+    HintUpdateSupply supply = getSupply(component);
+    if (supply != null) supply.hideHint();
+  }
+
+  protected HintUpdateSupply(@NotNull JComponent component) {
+    installSupply(component);
+  }
+
+  public HintUpdateSupply(@NotNull final JBTable table) {
+    installSupply(table);
+    ListSelectionListener listener = new ListSelectionListener() {
+      @Override
+      public void valueChanged(final ListSelectionEvent e) {
+        if (!isHintVisible(HintUpdateSupply.this.myHint) || isSelectedByMouse(table)) return;
+
+        int selected = ((ListSelectionModel)e.getSource()).getLeadSelectionIndex();
+        int rowCount = table.getRowCount();
+        if (selected == -1 || rowCount == 0) return;
+
+        PsiElement element = getPsiElementForHint(table.getValueAt(Math.min(selected, rowCount - 1), 0));
+        if (element != null && element.isValid()) {
+          updateHint(element);
+        }
+      }
+    };
+    table.getSelectionModel().addListSelectionListener(listener);
+    table.getColumnModel().getSelectionModel().addListSelectionListener(listener);
+  }
+
+  public HintUpdateSupply(@NotNull final Tree tree) {
+    installSupply(tree);
+    tree.addTreeSelectionListener(new TreeSelectionListener() {
+      @Override
+      public void valueChanged(final TreeSelectionEvent e) {
+        if (!isHintVisible(HintUpdateSupply.this.myHint) || isSelectedByMouse(tree)) return;
+
+        TreePath path = tree.getSelectionPath();
+        if (path != null) {
+          final PsiElement psiElement = getPsiElementForHint(path.getLastPathComponent());
+          if (psiElement != null && psiElement.isValid()) {
+            updateHint(psiElement);
+          }
+        }
+      }
+    });
+  }
+
+  public HintUpdateSupply(@NotNull final JBList list) {
+    installSupply(list);
+    list.addListSelectionListener(new ListSelectionListener() {
+      @Override
+      public void valueChanged(final ListSelectionEvent e) {
+        if (!isHintVisible(HintUpdateSupply.this.myHint) || isSelectedByMouse(list)) return;
+
+        Object[] selectedValues = ((JList)e.getSource()).getSelectedValues();
+        if (selectedValues.length != 1) return;
+
+        PsiElement element = getPsiElementForHint(selectedValues[0]);
+        if (element != null && element.isValid()) {
+          updateHint(element);
+        }
+      }
+    });
+  }
+
+  @Nullable
+  protected abstract PsiElement getPsiElementForHint(@Nullable Object selectedValue);
+
+  private void installSupply(@NotNull JComponent component) {
+    component.putClientProperty(HINT_UPDATE_MARKER, this);
+  }
+
+  public void registerHint(JBPopup hint) {
+    hideHint();
+    myHint = hint;
+  }
+
+  public void hideHint() {
+    if (isHintVisible(myHint)) {
+      myHint.cancel();
+    }
+
+    myHint = null;
+  }
+
+  public void updateHint(PsiElement element) {
+    if (!isHintVisible(myHint)) return;
+
+    PopupUpdateProcessorBase updateProcessor = myHint.getUserData(PopupUpdateProcessorBase.class);
+    if (updateProcessor != null) {
+      updateProcessor.updatePopup(element);
+    }
+  }
+
+  @Contract("!null->true")
+  private static boolean isHintVisible(JBPopup hint) {
+    return hint != null && hint.isVisible();
+  }
+
+  private static boolean isSelectedByMouse(@NotNull JComponent c) {
+    return Boolean.TRUE.equals(c.getClientProperty(ListUtil.SELECTED_BY_MOUSE_EVENT));
+  }
+}