| /* |
| * Copyright 2000-2012 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.codeInsight.hint; |
| |
| import com.intellij.openapi.components.ServiceManager; |
| import com.intellij.openapi.editor.Editor; |
| import com.intellij.ui.awt.RelativePoint; |
| import org.intellij.lang.annotations.MagicConstant; |
| import org.jetbrains.annotations.NotNull; |
| |
| import javax.swing.*; |
| |
| /** |
| * @author cdr |
| */ |
| public abstract class HintManager { |
| public static HintManager getInstance() { |
| return ServiceManager.getService(HintManager.class); |
| } |
| |
| // Constants for 'constraint' parameter of showErrorHint() |
| public static final short ABOVE = 1; |
| public static final short UNDER = 2; |
| public static final short LEFT = 3; |
| public static final short RIGHT = 4; |
| public static final short RIGHT_UNDER = 5; |
| public static final short DEFAULT = 6; |
| @MagicConstant(intValues = {ABOVE, UNDER, LEFT, RIGHT, RIGHT_UNDER, DEFAULT}) |
| public @interface PositionFlags {} |
| |
| |
| // Constants for 'flags' parameters |
| public static final int HIDE_BY_ESCAPE = 0x01; |
| public static final int HIDE_BY_ANY_KEY = 0x02; |
| public static final int HIDE_BY_LOOKUP_ITEM_CHANGE = 0x04; |
| public static final int HIDE_BY_TEXT_CHANGE = 0x08; |
| public static final int HIDE_BY_OTHER_HINT = 0x10; |
| public static final int HIDE_BY_SCROLLING = 0x20; |
| public static final int HIDE_IF_OUT_OF_EDITOR = 0x40; |
| public static final int UPDATE_BY_SCROLLING = 0x80; |
| public static final int HIDE_BY_MOUSEOVER = 0x100; |
| |
| @MagicConstant(flags = {HIDE_BY_ESCAPE, HIDE_BY_ANY_KEY, HIDE_BY_LOOKUP_ITEM_CHANGE, HIDE_BY_TEXT_CHANGE, HIDE_BY_OTHER_HINT, HIDE_BY_SCROLLING, HIDE_IF_OUT_OF_EDITOR, UPDATE_BY_SCROLLING, HIDE_BY_MOUSEOVER}) |
| public @interface HideFlags {} |
| |
| public abstract void showHint(@NotNull JComponent component, @NotNull RelativePoint p, @HideFlags int flags, int timeout); |
| |
| public abstract void showErrorHint(@NotNull Editor editor, @NotNull String text); |
| public abstract void showErrorHint(@NotNull Editor editor, @NotNull String text, @PositionFlags short position); |
| |
| public abstract void showInformationHint(@NotNull Editor editor, @NotNull String text); |
| |
| public abstract void showInformationHint(@NotNull Editor editor, @NotNull JComponent component); |
| |
| public abstract void showQuestionHint(@NotNull Editor editor, @NotNull String hintText, int offset1, int offset2, @NotNull QuestionAction action); |
| |
| public abstract boolean hideHints(@HideFlags int mask, boolean onlyOne, boolean editorChanged); |
| |
| public abstract void showErrorHint(@NotNull Editor editor, @NotNull String hintText, int offset1, int offset2, @PositionFlags short constraint, @HideFlags int flags, int timeout); |
| |
| public abstract void hideAllHints(); |
| |
| public abstract boolean hasShownHintsThatWillHideByOtherHint(boolean willShowTooltip); |
| } |