Package com.intellij.codeInsight.intention

Class PsiElementBaseIntentionAction

java.lang.Object

com.intellij.codeInsight.intention.impl.BaseIntentionAction

com.intellij.codeInsight.intention.PsiElementBaseIntentionAction

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

Direct Known Subclasses:

AbstractListIntentionAction, AddExceptionToExistingCatchFix, AddSchemaPrefixIntention, BaseColorIntentionAction, BaseMoveInitializerToMethodAction, BaseRefactoringIntentionAction, BreakStringOnLineBreaksIntentionAction, ChangeClassParametersIntention, ChangeUIDAction, ComposeFunctionChainAction, ConvertAtomicToLongAdderIntention, ConvertCompactConstructorToCanonicalAction, ConvertFieldToAtomicIntention, ConvertFieldToThreadLocalIntention, ConvertSchemaPrefixToDefaultIntention, ConvertToBasicLatinAction, ConvertToSingleReturnAction, CreateMissingSwitchBranchesAction, CreateTestAction, CreateTestAction, DataPointHolderConversionIntention, DefineParamsDefaultValueAction, ExtractChainedMapAction, ExtractIfConditionAction, ExtractSetFromComparisonChainAction, GenerateMissedTestsAction, InlineStreamMapAction, InsertLiteralUnderscoresAction, InvertIfConditionAction, JavaFxCollapseSubTagToAttributeIntention, JavaFxExpandAttributeIntention, JavaFxFieldToPropertyIntention, JavaFxInjectPageLanguageIntention, JavaFxWrapWithDefineIntention, MergeFilterChainAction, RemoveLiteralUnderscoresAction, ReplaceCastWithVariableAction, SimplifyForEachInspection.ForEachNonFinalFix, SortContentAction, SplitDeclarationAction, SplitFilterAction, SplitSwitchBranchWithSeveralCaseValuesAction, SurroundAutoCloseableAction, SurroundWithArrayFix, SwapIfStatementsIntentionAction, UnrollLoopAction, UnwrapElseBranchAction, XmlChooseColorIntentionAction

public abstract class PsiElementBaseIntentionAction
extends BaseIntentionAction

To solve "caret after last symbol" problem consider using BaseElementAtCaretIntentionAction

Field Summary

Fields inherited from interface com.intellij.codeInsight.intention.IntentionAction

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiElementBaseIntentionAction()

Method Summary

Modifier and Type	Method and Description
boolean	checkFile(PsiFile file) Check whether this intention available in file.
abstract void	invoke(Project project, Editor editor, PsiElement element) Invokes intention action for the element under caret.
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
abstract boolean	isAvailable(Project project, Editor editor, PsiElement element) Checks whether this intention is available at a caret offset in file.
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.

Methods inherited from class com.intellij.codeInsight.intention.impl.BaseIntentionAction

canModify, getText, setText, startInWriteAction, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.codeInsight.intention.IntentionAction

getFamilyName

Methods inherited from interface com.intellij.codeInsight.intention.FileModifier

getElementToMakeWritable

Constructor Detail

PsiElementBaseIntentionAction

public PsiElementBaseIntentionAction()

Method Detail

invoke

public final void invoke(Project project,
                         Editor editor,
                         PsiFile file)
                  throws IncorrectOperationException

Description copied from interface: IntentionAction

Called when user invokes intention. This method is called inside command. If IntentionAction.startInWriteAction() returns true, this method is also called inside write action.

Parameters:

project - the project in which the intention is invoked.

editor - the editor in which the intention is invoked.

file - the file open in the editor.

Throws:

IncorrectOperationException

checkFile

public boolean checkFile(PsiFile file)

Check whether this intention available in file.

invoke

public abstract void invoke(Project project,
                            Editor editor,
                            PsiElement element)
                     throws IncorrectOperationException

Invokes intention action for the element under caret.

Parameters:

project - the project in which the file is opened.

editor - the editor for the file.

element - the element under cursor.

Throws:

IncorrectOperationException

isAvailable

public final boolean isAvailable(Project project,
                                 Editor editor,
                                 PsiFile file)

Description copied from interface: IntentionAction

Checks whether this intention is available at a caret offset in the file. If this method returns true, a light bulb for this intention is shown.

Parameters:

project - the project in which the availability is checked.

editor - the editor in which the intention will be invoked.

file - the file open in the editor.

Returns:

true if the intention is available, false otherwise.

isAvailable

public abstract boolean isAvailable(Project project,
                                    Editor editor,
                                    PsiElement element)

Checks whether this intention is available at a caret offset in file. If this method returns true, a light bulb for this intention is shown.

Parameters:

project - the project in which the availability is checked.

editor - the editor in which the intention will be invoked.

element - the element under caret.

Returns:

true if the intention is available, false otherwise.