public class QuickEditAction extends QuickEditActionKeys implements IntentionAction, LowPriorityAction
PriorityAction.Priority
Modifier and Type | Field and Description |
---|---|
static Key<QuickEditHandler> |
QUICK_EDIT_HANDLER |
EDIT_ACTION_AVAILABLE
EMPTY_ARRAY
Constructor and Description |
---|
QuickEditAction() |
Modifier and Type | Method and Description |
---|---|
protected javax.swing.JComponent |
createBalloonComponent(PsiFile file) |
static Balloon.Position |
getBalloonPosition(Editor editor) |
static QuickEditHandler |
getExistingHandler(PsiFile injectedFile) |
java.lang.String |
getFamilyName()
Returns the name of the family of intentions.
|
protected Pair<PsiElement,TextRange> |
getRangePair(PsiFile file,
Editor editor) |
java.lang.String |
getText()
Returns text to be shown in the list of available actions, if this action
is available.
|
void |
invoke(Project project,
Editor editor,
PsiFile file)
Called when user invokes intention.
|
QuickEditHandler |
invokeImpl(Project project,
Editor editor,
PsiFile file) |
boolean |
isAvailable(Project project,
Editor editor,
PsiFile file)
Checks whether this intention is available at a caret offset in the file.
|
protected boolean |
isShowInBalloon() |
boolean |
startInWriteAction()
Indicate whether this action should be invoked inside write action.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getElementToMakeWritable
getPriority
public static final Key<QuickEditHandler> QUICK_EDIT_HANDLER
public boolean isAvailable(Project project, Editor editor, PsiFile file)
IntentionAction
isAvailable
in interface IntentionAction
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.true
if the intention is available, false
otherwise.protected Pair<PsiElement,TextRange> getRangePair(PsiFile file, Editor editor)
public void invoke(Project project, Editor editor, PsiFile file) throws IncorrectOperationException
IntentionAction
IntentionAction.startInWriteAction()
returns true
, this method is also called
inside write action.invoke
in interface IntentionAction
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.IncorrectOperationException
public QuickEditHandler invokeImpl(Project project, Editor editor, PsiFile file) throws IncorrectOperationException
IncorrectOperationException
public boolean startInWriteAction()
IntentionAction
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)
.startInWriteAction
in interface IntentionAction
startInWriteAction
in interface WriteActionAware
true
if the intention requires a write action, false
otherwise.public static QuickEditHandler getExistingHandler(PsiFile injectedFile)
protected boolean isShowInBalloon()
protected javax.swing.JComponent createBalloonComponent(PsiFile file)
public java.lang.String getText()
IntentionAction
getText
in interface IntentionAction
IntentionAction.isAvailable(Project, Editor, PsiFile)
public java.lang.String getFamilyName()
IntentionAction
getFamilyName
in interface IntentionAction
IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)
public static Balloon.Position getBalloonPosition(Editor editor)