daea2078fc966ff6ad99bd78d7145ea7714afe4c
[idea/community.git] / platform / lang-api / src / com / intellij / codeInsight / lookup / Lookup.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
17 package com.intellij.codeInsight.lookup;
18
19 import com.intellij.codeInsight.completion.PrefixMatcher;
20 import com.intellij.openapi.editor.Editor;
21 import com.intellij.psi.PsiElement;
22 import com.intellij.psi.PsiFile;
23 import org.jetbrains.annotations.NotNull;
24 import org.jetbrains.annotations.Nullable;
25
26 import java.awt.*;
27 import java.util.List;
28
29 public interface Lookup {
30   char NORMAL_SELECT_CHAR = '\n';
31   char REPLACE_SELECT_CHAR = '\t';
32   char COMPLETE_STATEMENT_SELECT_CHAR = '\r';
33   char AUTO_INSERT_SELECT_CHAR = (char) 0;
34
35   int getLookupStart();
36
37   @Nullable
38   LookupElement getCurrentItem();
39
40   void addLookupListener(LookupListener listener);
41   void removeLookupListener(LookupListener listener);
42
43   /**
44    * @return bounds in layered pane coordinate system
45    */
46   Rectangle getBounds();
47
48   /**
49    * @return bounds of the current item in the layered pane coordinate system.
50    */
51   Rectangle getCurrentItemBounds();
52   boolean isPositionedAboveCaret();
53
54   @Nullable
55   PsiElement getPsiElement();
56
57   @NotNull 
58   Editor getEditor();
59
60   PsiFile getPsiFile();
61
62   boolean isCompletion();
63
64   List<LookupElement> getItems();
65
66   boolean isFocused();
67
68   @NotNull
69   String itemPattern(@NotNull LookupElement element);
70
71   @NotNull
72   PrefixMatcher itemMatcher(@NotNull LookupElement item);
73
74   boolean isSelectionTouched();
75
76   List<String> getAdvertisements();
77 }