Package com.intellij.codeInsight.daemon.impl.quickfix

Class ModifierFix

java.lang.Object

com.intellij.codeInspection.LocalQuickFixOnPsiElement

com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

com.intellij.codeInsight.daemon.impl.quickfix.ModifierFix

All Implemented Interfaces:

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

public class ModifierFix
extends LocalQuickFixAndIntentionActionOnPsiElement

Field Summary

Fields inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

myEndElement, myStartElement

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

EMPTY_ARRAY

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ModifierFix(PsiModifierListOwner owner, java.lang.String modifier, boolean shouldHave, boolean showContainingClass)
ModifierFix(PsiModifierList modifierList, java.lang.String modifier, boolean shouldHave, boolean showContainingClass)

Method Summary

Modifier and Type	Method and Description
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, PsiFile file, Editor editor, PsiElement startElement, PsiElement endElement) Performs the action.
boolean	isAvailable(Project project, PsiFile file, Editor editor, PsiElement startElement, PsiElement endElement)
boolean	isAvailable(Project project, PsiFile file, PsiElement startElement, PsiElement endElement)
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

invoke, invoke, isAvailable

Methods inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

applyFix, applyFix, getEndElement, getName, getStartElement, isAvailable

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

ModifierFix

public ModifierFix(PsiModifierList modifierList,
                   java.lang.String modifier,
                   boolean shouldHave,
                   boolean showContainingClass)

ModifierFix

public ModifierFix(PsiModifierListOwner owner,
                   java.lang.String modifier,
                   boolean shouldHave,
                   boolean showContainingClass)

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

Specified by:

getText in class LocalQuickFixOnPsiElement

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

isAvailable

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

Overrides:

isAvailable in class LocalQuickFixAndIntentionActionOnPsiElement

isAvailable

public boolean isAvailable(Project project,
                           PsiFile file,
                           PsiElement startElement,
                           PsiElement endElement)

Overrides:

isAvailable in class LocalQuickFixOnPsiElement

invoke

public void invoke(Project project,
                   PsiFile file,
                   Editor editor,
                   PsiElement startElement,
                   PsiElement endElement)

Description copied from class: LocalQuickFixAndIntentionActionOnPsiElement

Performs the action.

Specified by:

invoke in class LocalQuickFixAndIntentionActionOnPsiElement

editor - the editor where the action is invoked or null if it's invoked from batch inspections results' tool window.

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 LocalQuickFixAndIntentionActionOnPsiElement

Returns:

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