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

Class IgnoreExtResourceAction

java.lang.Object

com.intellij.codeInsight.intention.impl.BaseIntentionAction

com.intellij.codeInsight.daemon.impl.quickfix.IgnoreExtResourceAction

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

public class IgnoreExtResourceAction
extends BaseIntentionAction

Field Summary

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
IgnoreExtResourceAction()

Method Summary

Modifier and Type	Method and Description
protected void	doInvoke(PsiFile file, int offset, java.lang.String uri, Editor editor)
boolean	equals(java.lang.Object obj)
static java.lang.String	findUri(PsiFile file, int offset)
PsiElement	getElementToMakeWritable(PsiFile currentFile) Controls whether this intention/fix is going to modify the current file.
java.lang.String	getFamilyName() Returns the name of the family of intentions.
protected java.lang.String	getQuickFixKeyId()
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
protected boolean	isAcceptableUri(java.lang.String uri)
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.

Methods inherited from class com.intellij.codeInsight.intention.impl.BaseIntentionAction

canModify, getText, setText, startInWriteAction, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IgnoreExtResourceAction

public IgnoreExtResourceAction()

Method Detail

getQuickFixKeyId

protected java.lang.String getQuickFixKeyId()

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile currentFile)

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:

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

doInvoke

protected void doInvoke(PsiFile file,
                        int offset,
                        java.lang.String uri,
                        Editor editor)
                 throws IncorrectOperationException

Throws:

IncorrectOperationException

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.

isAcceptableUri

protected boolean isAcceptableUri(java.lang.String uri)

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

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

findUri

public static java.lang.String findUri(PsiFile file,
                                       int offset)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object