IDEA-203230 avoid showing 2 TabWrapper components if content was added right after...
[idea/community.git] / platform / lang-api / src / com / intellij / codeInsight / intention / PsiElementBaseIntentionAction.java
1 /*
2  * Copyright 2000-2012 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.intention;
18
19 import com.intellij.codeInsight.intention.impl.BaseIntentionAction;
20 import com.intellij.openapi.editor.CaretModel;
21 import com.intellij.openapi.editor.Editor;
22 import com.intellij.openapi.project.Project;
23 import com.intellij.psi.PsiElement;
24 import com.intellij.psi.PsiFile;
25 import com.intellij.util.IncorrectOperationException;
26 import org.jetbrains.annotations.NotNull;
27 import org.jetbrains.annotations.Nullable;
28
29 /**
30  * To solve "caret after last symbol" problem consider using {@link BaseElementAtCaretIntentionAction}
31  *
32  * @author Anna Kozlova
33  * @author Konstantin Bulenkov
34  */
35 public abstract class PsiElementBaseIntentionAction extends BaseIntentionAction {
36   @Override
37   public final void invoke(@NotNull Project project, Editor editor, PsiFile file) throws IncorrectOperationException {
38     if (editor == null || !checkFile(file)) return;
39     final PsiElement element = getElement(editor, file);
40     if (element != null) {
41       invoke(project, editor, element);
42     }
43   }
44
45   /**
46    * Check whether this intention available in file.
47    */
48   public boolean checkFile(@Nullable PsiFile file) {
49     if (file == null) return false;
50     return canModify(file);
51   }
52
53   /**
54    * Invokes intention action for the element under caret.
55    *
56    * @param project the project in which the file is opened.
57    * @param editor  the editor for the file.
58    * @param element the element under cursor.
59    */
60   public abstract void invoke(@NotNull Project project, Editor editor, @NotNull PsiElement element) throws IncorrectOperationException;
61
62   @Override
63   public final boolean isAvailable(@NotNull Project project, Editor editor, PsiFile file) {
64     if (!checkFile(file)) return false;
65     final PsiElement element = editor == null ? null : getElement(editor, file);
66     return element != null && isAvailable(project, editor, element);
67   }
68
69   /**
70    * Checks whether this intention is available at a caret offset in file.
71    * If this method returns true, a light bulb for this intention is shown.
72    *
73    * @param project the project in which the availability is checked.
74    * @param editor  the editor in which the intention will be invoked.
75    * @param element the element under caret.
76    * @return true if the intention is available, false otherwise.
77    */
78   public abstract boolean isAvailable(@NotNull Project project, Editor editor, @NotNull PsiElement element);
79
80   @Nullable
81   private static PsiElement getElement(@NotNull Editor editor, @NotNull PsiFile file) {
82     CaretModel caretModel = editor.getCaretModel();
83     int position = caretModel.getOffset();
84     return file.findElementAt(position);
85   }
86 }