Package com.intellij.codeInsight.intention

Class IntentionManager

java.lang.Object

com.intellij.codeInsight.intention.IntentionManager

Direct Known Subclasses:

IntentionManagerImpl

public abstract class IntentionManager
extends java.lang.Object

Manager for intentions. All intentions must be registered here.

See Also:

IntentionAction

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<IntentionActionBean>	EP_INTENTION_ACTIONS
static Key<java.lang.Boolean>	SHOW_INTENTION_OPTIONS_KEY Key to be used within UserDataHolder in order to check presence of explicit indication on if intentions sub-menu should be shown.

Constructor Summary

Constructors

Constructor and Description
IntentionManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addAction(IntentionAction action) Registers an intention action.
abstract LocalQuickFix	convertToFix(IntentionAction action) Wraps given action in a LocalQuickFix object.
abstract IntentionAction	createCleanupAllIntention()
abstract IntentionAction	createFixAllIntention(InspectionToolWrapper toolWrapper, IntentionAction action)
abstract IntentionAction []	getAvailableIntentionActions() Returns all registered intention actions which are available now (not disabled via Settings|Intentions or Alt-Enter|Disable intention quick fix)
abstract java.util.List<IntentionAction>	getCleanupIntentionOptions()
static IntentionManager	getInstance()
static IntentionManager	getInstance(Project project) Deprecated. Use getInstance() instead. Returns instance of IntentionManager for given project.
abstract IntentionAction []	getIntentionActions() Returns all registered intention actions.
abstract java.util.List<IntentionAction>	getStandardIntentionOptions(HighlightDisplayKey displayKey, PsiElement context)
abstract void	registerIntentionAndMetaData(IntentionAction action, java.lang.String... category) Deprecated. Please use <intentionAction> extension point instead
abstract void	unregisterIntention(IntentionAction intentionAction)

Methods inherited from class java.lang.Object

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

Field Detail

EP_INTENTION_ACTIONS

public static final ExtensionPointName<IntentionActionBean> EP_INTENTION_ACTIONS

SHOW_INTENTION_OPTIONS_KEY

public static final Key<java.lang.Boolean> SHOW_INTENTION_OPTIONS_KEY

Key to be used within UserDataHolder in order to check presence of explicit indication on if intentions sub-menu should be shown.

Constructor Detail

IntentionManager

public IntentionManager()

Method Detail

getInstance

@Deprecated
public static IntentionManager getInstance(Project project)

Deprecated. Use getInstance() instead. Returns instance of IntentionManager for given project.

Parameters:

project - the project for which the instance is returned.

Returns:

instance of the IntentionManager assigned for given project.

getInstance

public static IntentionManager getInstance()

addAction

public abstract void addAction(IntentionAction action)

Registers an intention action.

Parameters:

action - the intention action to register.

getIntentionActions

public abstract IntentionAction [] getIntentionActions()

Returns all registered intention actions.

Returns:

array of registered actions.

getAvailableIntentionActions

public abstract IntentionAction [] getAvailableIntentionActions()

Returns all registered intention actions which are available now (not disabled via Settings|Intentions or Alt-Enter|Disable intention quick fix)

Returns:

array of actions.

registerIntentionAndMetaData

@Deprecated
public abstract void registerIntentionAndMetaData(IntentionAction action,
                                                  java.lang.String... category)

Deprecated. Please use <intentionAction> extension point instead

Registers an intention action which can be enabled or disabled through the "Intention Settings" dialog. To provide the description and the example code for the intention, the directory with the name equal to IntentionAction.getFamilyName() needs to be created under the intentionDescriptions directory of the resource root. The directory needs to contain three files. description.html provides the description of the intention, before.java.template provides the sample code before the intention is invoked, and after.java.template provides the sample code after invoking the intention. The templates can contain a fragment of code surrounded with <spot> and </spot> markers. If present, that fragment will be surrounded by a blinking rectangle in the inspection preview pane.

Parameters:

action - the intention action to register.

category - the name of the category or categories under which the intention will be shown in the "Intention Settings" dialog.

unregisterIntention

public abstract void unregisterIntention(IntentionAction intentionAction)

getStandardIntentionOptions

public abstract java.util.List<IntentionAction> getStandardIntentionOptions(HighlightDisplayKey displayKey,
                                                                            PsiElement context)

Returns:

actions used as additional options for the given problem. E.g. actions for suppress the problem via comment, javadoc or annotation, and edit corresponding inspection settings.

createFixAllIntention

public abstract IntentionAction createFixAllIntention(InspectionToolWrapper toolWrapper,
                                                      IntentionAction action)

Returns:

"Fix all '' inspections problems for a file" intention if toolWrapper is local inspection or simple global one

createCleanupAllIntention

public abstract IntentionAction createCleanupAllIntention()

Returns:

intention to start code cleanup on file

getCleanupIntentionOptions

public abstract java.util.List<IntentionAction> getCleanupIntentionOptions()

Returns:

options for cleanup intention createCleanupAllIntention() e.g. edit enabled cleanup inspections or starting cleanup on predefined scope

convertToFix

public abstract LocalQuickFix convertToFix(IntentionAction action)

Wraps given action in a LocalQuickFix object.

Parameters:

action - action to convert.

Returns:

quick fix instance.