Package com.intellij.codeInspection.ex

Class QuickFixAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.codeInspection.ex.QuickFixAction

All Implemented Interfaces:

CustomComponentAction, PossiblyDumbAware

Direct Known Subclasses:

LocalQuickFixWrapper

public abstract class QuickFixAction
extends AnAction
implements CustomComponentAction

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields

Modifier and Type	Field and Description
static QuickFixAction[]	EMPTY
protected InspectionToolWrapper	myToolWrapper

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.actionSystem.ex.CustomComponentAction

ACTION_KEY, COMPONENT_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QuickFixAction(java.lang.String text, javax.swing.Icon icon, javax.swing.KeyStroke keyStroke, InspectionToolWrapper toolWrapper)
protected	QuickFixAction(java.lang.String text, InspectionToolWrapper toolWrapper)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected void	applyFix(Project project, GlobalInspectionContextImpl context, CommonProblemDescriptor [] descriptors, java.util.Set<? super PsiElement> ignoredElements)
protected boolean	applyFix(RefEntity [] refElements)
javax.swing.JComponent	createCustomComponent(Presentation presentation, java.lang.String place)
protected static InspectionResultsView	getInvoker(AnActionEvent e)
java.lang.String	getText()
protected boolean	isProblemDescriptorsAcceptable()
protected void	performFixesInBatch(Project project, java.util.List<CommonProblemDescriptor[]> descriptors, GlobalInspectionContextImpl context, java.util.Set<? super PsiElement> ignoredElements)
protected static void	refreshViews(Project project, RefEntity [] resolvedElements, InspectionToolWrapper toolWrapper)
static void	removeElements(RefEntity [] refElements, Project project, InspectionToolWrapper toolWrapper)
protected boolean	startInWriteAction()
void	update(AnActionEvent e) Updates the state of the action.

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setInjectedContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.actionSystem.ex.CustomComponentAction

createCustomComponent

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Field Detail

EMPTY

public static final QuickFixAction[] EMPTY

myToolWrapper

protected final InspectionToolWrapper myToolWrapper

Constructor Detail

QuickFixAction

protected QuickFixAction(java.lang.String text,
                         InspectionToolWrapper toolWrapper)

QuickFixAction

protected QuickFixAction(java.lang.String text,
                         javax.swing.Icon icon,
                         javax.swing.KeyStroke keyStroke,
                         InspectionToolWrapper toolWrapper)

Method Detail

getInvoker

protected static InspectionResultsView getInvoker(AnActionEvent e)

update

public void update(AnActionEvent e)

Description copied from class: AnAction

Updates the state of the action. Default implementation does nothing. Override this method to provide the ability to dynamically change action's state and(or) presentation depending on the context (For example when your action state depends on the selection you can check for selection and change the state accordingly).

This method can be called frequently, and on UI thread. This means that this method is supposed to work really fast, no real work should be done at this phase. For example, checking selection in a tree or a list, is considered valid, but working with a file system or PSI (especially resolve) is not. If you cannot determine the state of the action fast enough, you should do it in the AnAction.actionPerformed(AnActionEvent) method and notify the user that action cannot be executed if it's the case.

If the action is added to a toolbar, its "update" can be called twice a second, but only if there was any user activity or a focus transfer. If your action's availability is changed in absence of any of these events, please call ActivityTracker.getInstance().inc() to notify action subsystem to update all toolbar actions when your subsystem's determines that its actions' visibility might be affected.

Overrides:

update in class AnAction

Parameters:

e - Carries information on the invocation place and data available

isProblemDescriptorsAcceptable

protected boolean isProblemDescriptorsAcceptable()

getText

public java.lang.String getText()

actionPerformed

public void actionPerformed(AnActionEvent e)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

applyFix

protected void applyFix(Project project,
                        GlobalInspectionContextImpl context,
                        CommonProblemDescriptor [] descriptors,
                        java.util.Set<? super PsiElement> ignoredElements)

startInWriteAction

protected boolean startInWriteAction()

performFixesInBatch

protected void performFixesInBatch(Project project,
                                   java.util.List<CommonProblemDescriptor[]> descriptors,
                                   GlobalInspectionContextImpl context,
                                   java.util.Set<? super PsiElement> ignoredElements)

removeElements

public static void removeElements(RefEntity [] refElements,
                                  Project project,
                                  InspectionToolWrapper toolWrapper)

refreshViews

protected static void refreshViews(Project project,
                                   RefEntity [] resolvedElements,
                                   InspectionToolWrapper toolWrapper)

applyFix

protected boolean applyFix(RefEntity [] refElements)

Returns:

true if immediate UI update needed.

createCustomComponent

public javax.swing.JComponent createCustomComponent(Presentation presentation,
                                                    java.lang.String place)

Specified by:

createCustomComponent in interface CustomComponentAction

Returns:

custom JComponent that represents action in UI. You (as a client/implementor) or this interface are not allowed to invoke this method directly. Only action system can invoke it!

The component should not be stored in the action instance because it may be shown on several toolbars simultaneously. Use CustomComponentAction.COMPONENT_KEY to retrieve current component from a Presentation instance in AnAction.update(AnActionEvent) method.