replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / ui / Hint.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.ui;
17
18 import com.intellij.ui.awt.RelativePoint;
19 import org.jetbrains.annotations.NotNull;
20
21 import javax.swing.*;
22
23 /**
24  * @see #hide()
25  */
26 public interface Hint {
27   /**
28    * @param parentComponent    defines coordinate system where hint will be shown.
29    *                           Cannot be {@code null}.
30    * @param x                  x coordinate of hint in parent coordinate system
31    * @param y                  y coordinate of hint in parent coordinate system
32    * @param focusBackComponent component which should get focus when the hint will
33    * @param hintInfo
34    */
35   void show(@NotNull JComponent parentComponent, int x, int y, JComponent focusBackComponent, @NotNull HintHint hintInfo);
36
37   /**
38    * @return whether the hint is showing or not
39    */
40   boolean isVisible();
41
42   /**
43    * Hides current hint object.
44    * <p/>
45    * <b>Note:</b> this method is also used as a destruction callback, i.e. it performs necessary de-initialization when
46    * current hint is not necessary to use anymore. Hence, it's <b>necessary</b> to call it from place where you definitely
47    * now that current hint will not be used.
48    */
49   void hide();
50
51   void addHintListener(@NotNull HintListener listener);
52
53   void removeHintListener(@NotNull HintListener listener);
54
55   void pack();
56
57   void setLocation(@NotNull RelativePoint point);
58 }