public abstract class LocalQuickFixAndIntentionActionOnPsiElement extends LocalQuickFixOnPsiElement implements IntentionAction
LOG, myEndElement, myStartElementEMPTY_ARRAYEMPTY_ARRAY| Modifier | Constructor and Description |
|---|---|
protected |
LocalQuickFixAndIntentionActionOnPsiElement(PsiElement element) |
protected |
LocalQuickFixAndIntentionActionOnPsiElement(PsiElement startElement,
PsiElement endElement) |
| Modifier and Type | Method and Description |
|---|---|
void |
invoke(Project project,
Editor editor,
PsiFile file)
Called when user invokes intention.
|
abstract void |
invoke(Project project,
PsiFile file,
Editor editor,
PsiElement startElement,
PsiElement endElement)
Performs the action.
|
void |
invoke(Project project,
PsiFile file,
PsiElement startElement,
PsiElement endElement) |
boolean |
isAvailable(Project project,
Editor editor,
PsiFile file)
Checks whether this intention is available at a caret offset in the file.
|
boolean |
isAvailable(Project project,
PsiFile file,
Editor editor,
PsiElement startElement,
PsiElement endElement) |
boolean |
startInWriteAction()
Indicate whether this action should be invoked inside write action.
|
applyFix, applyFix, getEndElement, getName, getStartElement, getText, isAvailable, isAvailableclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetFamilyName, getTextgetElementToMakeWritablegetFamilyNameprotected LocalQuickFixAndIntentionActionOnPsiElement(PsiElement element)
protected LocalQuickFixAndIntentionActionOnPsiElement(PsiElement startElement, PsiElement endElement)
public final void invoke(Project project, Editor editor, PsiFile file) throws IncorrectOperationException
IntentionActionIntentionAction.startInWriteAction() returns true, this method is also called
inside write action.invoke in interface IntentionActionproject - the project in which the intention is invoked.editor - the editor in which the intention is invoked.file - the file open in the editor.IncorrectOperationExceptionpublic final boolean isAvailable(Project project, Editor editor, PsiFile file)
IntentionActionisAvailable in interface IntentionActionproject - 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.true if the intention is available, false otherwise.public boolean isAvailable(Project project, PsiFile file, Editor editor, PsiElement startElement, PsiElement endElement)
public abstract void invoke(Project project, PsiFile file, Editor editor, PsiElement startElement, PsiElement endElement)
editor - the editor where the action is invoked or null if it's invoked from batch inspections results' tool window.public void invoke(Project project, PsiFile file, PsiElement startElement, PsiElement endElement)
invoke in class LocalQuickFixOnPsiElementpublic boolean startInWriteAction()
IntentionActionfalse 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).startInWriteAction in interface IntentionActionstartInWriteAction in interface WriteActionAwaretrue if the intention requires a write action, false otherwise.