Package com.intellij.codeInspection.ex

Class EditInspectionToolsSettingsAction

java.lang.Object

com.intellij.codeInspection.ex.EditInspectionToolsSettingsAction

All Implemented Interfaces:

FileModifier, HighPriorityAction, IntentionAction, PriorityAction, WriteActionAware, Iconable

public class EditInspectionToolsSettingsAction
extends java.lang.Object
implements IntentionAction, Iconable, HighPriorityAction

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Nested classes/interfaces inherited from interface com.intellij.codeInsight.intention.PriorityAction

PriorityAction.Priority

Field Summary

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

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
EditInspectionToolsSettingsAction(HighlightDisplayKey key)

Method Summary

Modifier and Type	Method and Description
static boolean	editSettings(Project project, InspectionProfileImpl inspectionProfile, java.util.function.Consumer<? super ErrorsConfigurable> configurableAction)
boolean	editToolSettings(Project project, InspectionProfileImpl inspectionProfile)
static boolean	editToolSettings(Project project, InspectionProfileImpl inspectionProfile, java.lang.String selectedToolShortName)
java.lang.String	getFamilyName() Returns the name of the family of intentions.
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.
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.
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

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

getPriority

Constructor Detail

EditInspectionToolsSettingsAction

public EditInspectionToolsSettingsAction(HighlightDisplayKey key)

Method Detail

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)

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

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

isAvailable

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

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

editToolSettings

public boolean editToolSettings(Project project,
                                InspectionProfileImpl inspectionProfile)

editToolSettings

public static boolean editToolSettings(Project project,
                                       InspectionProfileImpl inspectionProfile,
                                       java.lang.String selectedToolShortName)

editSettings

public static boolean editSettings(Project project,
                                   InspectionProfileImpl inspectionProfile,
                                   java.util.function.Consumer<? super ErrorsConfigurable> configurableAction)

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.

getIcon

public javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable