Package com.intellij.codeInspection

Class SuppressIntentionAction

java.lang.Object

com.intellij.codeInspection.SuppressIntentionAction

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware, Iconable

Direct Known Subclasses:

AbstractSuppressByNoInspectionCommentFix, SuppressIntentionActionFromFix

public abstract class SuppressIntentionAction
extends java.lang.Object
implements Iconable, IntentionAction

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static 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

Constructor Summary

Constructors

Constructor and Description
SuppressIntentionAction()

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getIcon(int flags)
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
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.
boolean	isSuppressAll()
protected void	setText(java.lang.String text)
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.
java.lang.String	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

Field Detail

EMPTY_ARRAY

public static final SuppressIntentionAction[] EMPTY_ARRAY

Constructor Detail

SuppressIntentionAction

public SuppressIntentionAction()

Method Detail

getIcon

public javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable

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)

setText

protected void setText(java.lang.String text)

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

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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.

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

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.

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.

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.

isSuppressAll

public boolean isSuppressAll()