platform-api/src/com/intellij/codeInsight/hint/HintManager.java

   1 package com.intellij.codeInsight.hint;
   2
   3 import com.intellij.openapi.components.ServiceManager;
   4 import com.intellij.openapi.editor.Editor;
   5 import com.intellij.ui.awt.RelativePoint;
   6 import org.jetbrains.annotations.NotNull;
   7
   8 import javax.swing.*;
   9
  10 /**
  11  * @author cdr
  12  */
  13 public abstract class HintManager {
  14   // Constants for 'constraint' parameter of showErrorHint()
  15   public static final short ABOVE = 1;
  16   public static final short UNDER = 2;
  17   public static final short LEFT = 3;
  18   public static final short RIGHT = 4;
  19   public static final short RIGHT_UNDER = 5;
  20
  21   // Constants for 'flags' parameters
  22   public static final int HIDE_BY_ESCAPE = 0x01;
  23   public static final int HIDE_BY_ANY_KEY = 0x02;
  24   public static final int HIDE_BY_LOOKUP_ITEM_CHANGE = 0x04;
  25   public static final int HIDE_BY_TEXT_CHANGE = 0x08;
  26   public static final int HIDE_BY_OTHER_HINT = 0x10;
  27   public static final int HIDE_BY_SCROLLING = 0x20;
  28   public static final int HIDE_IF_OUT_OF_EDITOR = 0x40;
  29   public static final int UPDATE_BY_SCROLLING = 0x80;
  30
  31   public abstract void showHint(@NotNull JComponent component, @NotNull RelativePoint p, int flags, int timeout);
  32
  33   public abstract void showErrorHint(@NotNull Editor editor, String text);
  34
  35   public abstract void showInformationHint(@NotNull Editor editor, String text);
  36
  37   public abstract void showQuestionHint(
  38     Editor editor,
  39     String hintText,
  40     int offset1,
  41     int offset2,
  42     QuestionAction action);
  43
  44   protected abstract boolean hideHints(int mask, boolean onlyOne, boolean editorChanged);
  45
  46   public static HintManager getInstance() {
  47     return ServiceManager.getService(HintManager.class);
  48   }
  49
  50   public abstract void showErrorHint(
  51     Editor editor,
  52     String hintText,
  53     int offset1,
  54     int offset2,
  55     short constraint,
  56     int flags,
  57     int timeout);
  58
  59   public abstract void hideAllHints();
  60
  61   public abstract boolean hasShownHintsThatWillHideByOtherHint();
  62 }