Package com.intellij.codeInspection.ex

Class DisableInspectionToolAction

java.lang.Object

com.intellij.codeInspection.IntentionAndQuickFixAction

com.intellij.codeInspection.ex.DisableInspectionToolAction

All Implemented Interfaces:

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

public class DisableInspectionToolAction
extends IntentionAndQuickFixAction
implements Iconable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

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
DisableInspectionToolAction(HighlightDisplayKey key)
DisableInspectionToolAction(LocalInspectionTool tool)

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, PsiFile file, Editor editor)
java.lang.String	getFamilyName() Returns the name of the family of intentions.
javax.swing.Icon	getIcon(int flags)
java.lang.String	getName()
static java.lang.String	getNameText()
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 com.intellij.codeInspection.IntentionAndQuickFixAction

applyFix, getText, invoke

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

DisableInspectionToolAction

public DisableInspectionToolAction(LocalInspectionTool tool)

DisableInspectionToolAction

public DisableInspectionToolAction(HighlightDisplayKey key)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface QuickFix<ProblemDescriptor>

Specified by:

getName in class IntentionAndQuickFixAction

Returns:

the name of the quick fix.

getFamilyName

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

Specified by:

getFamilyName in class IntentionAndQuickFixAction

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

isAvailable

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

Description copied from class: IntentionAndQuickFixAction

In general case will be called if invoked as IntentionAction.

Specified by:

isAvailable in interface IntentionAction

Overrides:

isAvailable in class IntentionAndQuickFixAction

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.

applyFix

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

Specified by:

applyFix in class IntentionAndQuickFixAction

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

Overrides:

startInWriteAction in class IntentionAndQuickFixAction

Returns:

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

getIcon

public javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable

getNameText

public static java.lang.String getNameText()