Package com.intellij.codeInsight.intention.impl

Class QuickEditAction

java.lang.Object

com.intellij.codeInsight.intention.impl.QuickEditActionKeys

com.intellij.codeInsight.intention.impl.QuickEditAction

All Implemented Interfaces:

FileModifier, IntentionAction, LowPriorityAction, PriorityAction, WriteActionAware

public class QuickEditAction
extends QuickEditActionKeys
implements IntentionAction, LowPriorityAction

"Quick Edit Language" intention action that provides an editor which shows an injected language fragment's complete prefix and suffix in non-editable areas and allows to edit the fragment without having to consider any additional escaping rules (e.g. when editing regexes in String literals).

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.codeInsight.intention.PriorityAction

PriorityAction.Priority

Field Summary

Fields

Modifier and Type	Field and Description
static Key<QuickEditHandler>	QUICK_EDIT_HANDLER

Fields inherited from class com.intellij.codeInsight.intention.impl.QuickEditActionKeys

EDIT_ACTION_AVAILABLE

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
QuickEditAction()

Method Summary

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.

Methods inherited from class java.lang.Object

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

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

getElementToMakeWritable

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

getPriority

Field Detail

QUICK_EDIT_HANDLER

public static final Key<QuickEditHandler> QUICK_EDIT_HANDLER

Constructor Detail

QuickEditAction

public QuickEditAction()

Method Detail

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.

Specified by:

isAvailable in interface IntentionAction

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.

getRangePair

protected Pair<PsiElement,TextRange> getRangePair(PsiFile file,
                                                  Editor editor)

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.

Specified by:

invoke in interface IntentionAction

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

invokeImpl

public QuickEditHandler invokeImpl(Project project,
                                   Editor editor,
                                   PsiFile file)
                            throws IncorrectOperationException

Throws:

IncorrectOperationException

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

Returns:

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

getExistingHandler

public static QuickEditHandler getExistingHandler(PsiFile injectedFile)

isShowInBalloon

protected boolean isShowInBalloon()

createBalloonComponent

protected javax.swing.JComponent createBalloonComponent(PsiFile file)

getText

public java.lang.String getText()

Description copied from interface: IntentionAction

Returns text to be shown in the list of available actions, if this action is available.

Specified by:

getText in interface IntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

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.

Specified by:

getFamilyName in interface IntentionAction

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

getBalloonPosition

public static Balloon.Position getBalloonPosition(Editor editor)