Package com.intellij.codeInspection

Class SuppressIntentionActionFromFix

java.lang.Object

com.intellij.codeInspection.SuppressIntentionAction

com.intellij.codeInspection.SuppressIntentionActionFromFix

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware, Iconable

public class SuppressIntentionActionFromFix
extends SuppressIntentionAction

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.codeInspection.SuppressIntentionAction

EMPTY_ARRAY

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

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Method Summary

Modifier and Type	Method and Description
static SuppressIntentionAction	convertBatchToSuppressIntentionAction(SuppressQuickFix fix)
static SuppressIntentionAction []	convertBatchToSuppressIntentionActions(SuppressQuickFix [] actions)
PsiElement	getContainer(PsiElement element)
PsiElement	getElementToMakeWritable(PsiFile currentFile) Controls whether this intention/fix is going to modify the current file.
java.lang.String	getFamilyName() Returns the name of the family of intentions.
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, PsiElement element) Invokes intention action for the element under caret.
boolean	isAvailable(Project project, Editor editor, PsiElement element) Checks whether this intention is available at a caret offset in file.
ThreeState	isShouldBeAppliedToInjectionHost()
boolean	isSuppressAll()
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class com.intellij.codeInspection.SuppressIntentionAction

getIcon, invoke, isAvailable, setText, toString

Methods inherited from class java.lang.Object

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

Method Detail

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: IntentionAction

Indicate whether this action should be invoked inside write action. Should return false if, e.g., a 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 SuppressIntentionAction

Returns:

true if the intention requires a write action, false otherwise.

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile currentFile)

Description copied from interface: FileModifier

Controls whether this intention/fix is going to modify the current file. If @NotNull, and the current file is read-only, it will be made writable (honoring version control integration) before the intention/fix is invoked.

By default, as a heuristic, returns the same as WriteActionAware.startInWriteAction().

If the action is going to modify multiple files, or the set of the files is unknown in advance, please don't bother overriding this method, return false from WriteActionAware.startInWriteAction(), and call FileModificationService methods in the implementation, and take write actions yourself as needed.

Parameters:

currentFile - the same file where intention would be invoked (for LocalQuickFix it would be the containing file of ProblemDescriptor.getPsiElement())

convertBatchToSuppressIntentionAction

public static SuppressIntentionAction convertBatchToSuppressIntentionAction(SuppressQuickFix fix)

convertBatchToSuppressIntentionActions

public static SuppressIntentionAction [] convertBatchToSuppressIntentionActions(SuppressQuickFix [] actions)

invoke

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

Description copied from class: SuppressIntentionAction

Invokes intention action for the element under caret.

Specified by:

invoke in class SuppressIntentionAction

Parameters:

project - the project in which the file is opened.

editor - the editor for the file.

element - the element under cursor.

Throws:

IncorrectOperationException

isShouldBeAppliedToInjectionHost

public ThreeState isShouldBeAppliedToInjectionHost()

getContainer

public PsiElement getContainer(PsiElement element)

isAvailable

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

Description copied from class: SuppressIntentionAction

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.

Specified by:

isAvailable in class SuppressIntentionAction

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.

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

Overrides:

getText in class SuppressIntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

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.

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

isSuppressAll

public boolean isSuppressAll()

Overrides:

isSuppressAll in class SuppressIntentionAction