Package com.intellij.codeInsight.intention.impl

Class PriorityActionWrapper

java.lang.Object

com.intellij.codeInspection.LocalQuickFixOnPsiElement

com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

com.intellij.codeInsight.intention.impl.PriorityActionWrapper

All Implemented Interfaces:

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

public abstract class PriorityActionWrapper
extends LocalQuickFixAndIntentionActionOnPsiElement

Field Summary

Fields inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

LOG, myEndElement, myStartElement

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

EMPTY_ARRAY

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Method Summary

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

Methods inherited from class com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

invoke, invoke, isAvailable, 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

Method Detail

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

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile file)

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:

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

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)

lowPriority

public static LocalQuickFixAndIntentionActionOnPsiElement lowPriority(PsiElement element,
                                                                      LocalQuickFixAndIntentionActionOnPsiElement fix)