summaryrefslogtreecommitdiff
path: root/platform/platform-api/src/com/intellij/ui/JBListWithHintProvider.java
blob: 5ef516210e0da48de9f2e9d6dbb876f7c5902866 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 * Copyright 2000-2013 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;

import com.intellij.openapi.ui.popup.JBPopup;
import com.intellij.psi.PsiElement;
import com.intellij.ui.components.JBList;
import com.intellij.ui.popup.PopupUpdateProcessorBase;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import java.util.Collection;

/**
 * @author pegov
 */
public abstract class JBListWithHintProvider extends JBList {
  private JBPopup myHint;

  public JBListWithHintProvider() {
    addSelectionListener();
  }

  public JBListWithHintProvider(ListModel dataModel) {
    super(dataModel);
    addSelectionListener();
  }

  public JBListWithHintProvider(Object... listData) {
    super(listData);
    addSelectionListener();
  }

  public JBListWithHintProvider(Collection items) {
    super(items);
    addSelectionListener();
  }
  
  private void addSelectionListener() {
    addListSelectionListener(new ListSelectionListener() {
      @Override
      public void valueChanged(final ListSelectionEvent e) {
        if (getClientProperty(ListUtil.SELECTED_BY_MOUSE_EVENT) != Boolean.TRUE) {
          final Object[] selectedValues = ((JList)e.getSource()).getSelectedValues();
          if (selectedValues.length != 1) return;

          final PsiElement element = getPsiElementForHint(selectedValues[0]);
          if (element != null && element.isValid()) {
            updateHint(element);
          }
        }
      }
    });
  }

  @Nullable
  protected abstract PsiElement getPsiElementForHint(final Object selectedValue);

  public void registerHint(final JBPopup hint) {
    hideHint();
    myHint = hint;
  }
  
  public void hideHint() {
    if (myHint != null && myHint.isVisible()) {
      myHint.cancel();
    }

    myHint = null;
  }
  
  public void updateHint(PsiElement element) {
    if (myHint == null || !myHint.isVisible()) return;

    final PopupUpdateProcessorBase updateProcessor = myHint.getUserData(PopupUpdateProcessorBase.class);
    if (updateProcessor != null) {
      updateProcessor.updatePopup(element);
    }
  }
  
}