public class AnnotateIntentionAction extends BaseIntentionAction implements LowPriorityAction
PriorityAction.PriorityEMPTY_ARRAY| Constructor and Description |
|---|
AnnotateIntentionAction() |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getFamilyName()
Returns the name of the family of intentions.
|
void |
invoke(Project project,
Editor editor,
PsiFile file)
Called when user invokes intention.
|
boolean |
isAvailable(Project project,
Editor editor,
PsiFile file)
Checks whether this intention is available at a caret offset in the file.
|
boolean |
selectSingle(Editor editor,
PsiFile file,
java.lang.String annotationShortName)
Configure the intention to annotate an element at caret in the editor with concrete annotation
|
boolean |
startInWriteAction()
Indicate whether this action should be invoked inside write action.
|
canModify, getText, setText, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetPrioritygetElementToMakeWritablepublic java.lang.String getFamilyName()
IntentionActiongetFamilyName in interface IntentionActionIntentionManager.registerIntentionAndMetaData(IntentionAction, String...)public boolean selectSingle(Editor editor, PsiFile file, java.lang.String annotationShortName)
editor - an editorfile - a fileannotationShortName - a short name of the annotation to addpublic 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 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 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 WriteActionAwarestartInWriteAction in class BaseIntentionActiontrue if the intention requires a write action, false otherwise.