Package com.intellij.codeInsight.intention.impl

Class ImplementAbstractMethodAction

java.lang.Object

com.intellij.codeInsight.intention.impl.BaseIntentionAction

com.intellij.codeInsight.intention.impl.ImplementAbstractMethodAction

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

Direct Known Subclasses:

CopyAbstractMethodImplementationAction

public class ImplementAbstractMethodAction
extends BaseIntentionAction

Field Summary

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ImplementAbstractMethodAction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamilyName() Returns the name of the family of intentions.
protected java.lang.String	getIntentionName(PsiMethod method)
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
protected void	invokeHandler(Project project, Editor editor, PsiMethod method)
protected boolean	isAvailable(com.intellij.codeInsight.intention.impl.ImplementAbstractMethodAction.MyElementProcessor processor)
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 com.intellij.codeInsight.intention.impl.BaseIntentionAction

canModify, getText, setText, toString

Methods inherited from class java.lang.Object

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

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

getElementToMakeWritable

Constructor Detail

ImplementAbstractMethodAction

public ImplementAbstractMethodAction()

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

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.

getIntentionName

protected java.lang.String getIntentionName(PsiMethod method)

isAvailable

protected boolean isAvailable(com.intellij.codeInsight.intention.impl.ImplementAbstractMethodAction.MyElementProcessor processor)

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.

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

invokeHandler

protected void invokeHandler(Project project,
                             Editor editor,
                             PsiMethod method)

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 BaseIntentionAction

Returns:

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