Package com.intellij.codeInspection

Class IntentionAndQuickFixAction

java.lang.Object

com.intellij.codeInspection.IntentionAndQuickFixAction

All Implemented Interfaces:

FileModifier, IntentionAction, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

Direct Known Subclasses:

DisableInspectionToolAction, RepositoryAddLibraryAction

public abstract class IntentionAndQuickFixAction
extends java.lang.Object
implements LocalQuickFix, IntentionAction

See Also:

LocalQuickFixAndIntentionActionOnPsiElement

Field Summary

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
IntentionAndQuickFixAction()

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
abstract void	applyFix(Project project, PsiFile file, Editor editor)
abstract java.lang.String	getFamilyName() Returns the name of the family of intentions.
abstract java.lang.String	getName()
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
boolean	isAvailable(Project project, Editor editor, PsiFile file) In general case will be called if invoked as IntentionAction.
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class java.lang.Object

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

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

getElementToMakeWritable

Constructor Detail

IntentionAndQuickFixAction

public IntentionAndQuickFixAction()

Method Detail

getName

public abstract java.lang.String getName()

Specified by:

getName in interface QuickFix<ProblemDescriptor>

Returns:

the name of the quick fix.

getFamilyName

public abstract java.lang.String getFamilyName()

Description copied from interface: IntentionAction

Returns the name of the family of intentions. It is used to externalize "auto-show" state of intentions. When the user clicks on a light bulb in intention list, all intentions with the same family name get enabled/disabled. The name is also shown in settings tree.

Specified by:

getFamilyName in interface IntentionAction

Specified by:

getFamilyName in interface QuickFix<ProblemDescriptor>

Returns:

text to appear in "Apply Fix" popup when multiple Quick Fixes exist (in the results of batch code inspection). For example, if the name of the quickfix is "Create template <filename>", the return value of getFamilyName() should be "Create template". If the name of the quickfix does not depend on a specific element, simply return QuickFix.getName().

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

applyFix

public abstract void applyFix(Project project,
                              PsiFile file,
                              Editor editor)

getText

public java.lang.String getText()

Description copied from interface: IntentionAction

Returns text to be shown in the list of available actions, if this action is available.

Specified by:

getText in interface IntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

applyFix

public void applyFix(Project project,
                     ProblemDescriptor descriptor)

Description copied from interface: QuickFix

Called to apply the fix.

Please call com.intellij.profile.codeInspection.ProjectInspectionProfileManager#fireProfileChanged() if inspection profile is changed as result of fix.

Specified by:

applyFix in interface QuickFix<ProblemDescriptor>

Parameters:

project - Project

descriptor - problem reported by the tool which provided this quick fix action

invoke

public 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.

Specified by:

invoke in interface IntentionAction

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

isAvailable

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

In general case will be called if invoked as IntentionAction.

Specified by:

isAvailable in interface IntentionAction

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.

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: WriteActionAware

Indicate whether this action should be invoked inside write action.

Should return false if e.g. modal dialog is shown inside the action. If false is returned the action itself is responsible for starting write action when needed, by calling Application.runWriteAction(Runnable).

Specified by:

startInWriteAction in interface IntentionAction

Specified by:

startInWriteAction in interface WriteActionAware

Returns:

true if the action requires a write action (default), false otherwise.