Package com.intellij.refactoring.actions

Class BaseRefactoringAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.refactoring.actions.BaseRefactoringAction

All Implemented Interfaces:

UpdateInBackground, PossiblyDumbAware

Direct Known Subclasses:

BaseJavaRefactoringAction, BasePlatformRefactoringAction, ConvertToJavaAction, ConvertToStaticAction, EditPropertyValueAction, IntroduceParameterObjectAction, InvertBooleanAction, MoveAction, PyBaseRefactoringAction, RenameElementAction, SafeDeleteAction

public abstract class BaseRefactoringAction
extends AnAction
implements UpdateInBackground

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
BaseRefactoringAction()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected boolean	disableOnCompiledElement()
protected PsiElement	findRefactoringTargetInEditor(DataContext dataContext)
protected java.lang.String	getActionName(DataContext dataContext)
static PsiElement	getElementAtCaret(Editor editor, PsiFile file)
protected abstract RefactoringActionHandler	getHandler(DataContext dataContext)
static PsiElement []	getPsiElementArray(DataContext dataContext)
protected boolean	hasAvailableHandler(DataContext dataContext)
protected boolean	isAvailableForFile(PsiFile file)
protected boolean	isAvailableForLanguage(Language language)
protected abstract boolean	isAvailableInEditorOnly()
protected boolean	isAvailableOnElementInEditorAndFile(PsiElement element, Editor editor, PsiFile file, DataContext context)
protected boolean	isAvailableOnElementInEditorAndFile(PsiElement element, Editor editor, PsiFile file, DataContext context, java.lang.String place)
protected boolean	isEnabledOnDataContext(DataContext dataContext)
protected abstract boolean	isEnabledOnElements(PsiElement [] elements)
protected boolean	isHidden()
void	update(AnActionEvent e) Updates the state of the action.

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setInjectedContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Constructor Detail

BaseRefactoringAction

public BaseRefactoringAction()

Method Detail

isAvailableInEditorOnly

protected abstract boolean isAvailableInEditorOnly()

isEnabledOnElements

protected abstract boolean isEnabledOnElements(PsiElement [] elements)

isAvailableOnElementInEditorAndFile

protected boolean isAvailableOnElementInEditorAndFile(PsiElement element,
                                                      Editor editor,
                                                      PsiFile file,
                                                      DataContext context,
                                                      java.lang.String place)

isAvailableOnElementInEditorAndFile

protected boolean isAvailableOnElementInEditorAndFile(PsiElement element,
                                                      Editor editor,
                                                      PsiFile file,
                                                      DataContext context)

hasAvailableHandler

protected boolean hasAvailableHandler(DataContext dataContext)

getHandler

protected abstract RefactoringActionHandler getHandler(DataContext dataContext)

actionPerformed

public final void actionPerformed(AnActionEvent e)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

isEnabledOnDataContext

protected boolean isEnabledOnDataContext(DataContext dataContext)

update

public void update(AnActionEvent e)

Description copied from class: AnAction

Updates the state of the action. Default implementation does nothing. Override this method to provide the ability to dynamically change action's state and(or) presentation depending on the context (For example when your action state depends on the selection you can check for selection and change the state accordingly).

This method can be called frequently, and on UI thread. This means that this method is supposed to work really fast, no real work should be done at this phase. For example, checking selection in a tree or a list, is considered valid, but working with a file system or PSI (especially resolve) is not. If you cannot determine the state of the action fast enough, you should do it in the AnAction.actionPerformed(AnActionEvent) method and notify the user that action cannot be executed if it's the case.

If the action is added to a toolbar, its "update" can be called twice a second, but only if there was any user activity or a focus transfer. If your action's availability is changed in absence of any of these events, please call ActivityTracker.getInstance().inc() to notify action subsystem to update all toolbar actions when your subsystem's determines that its actions' visibility might be affected.

Overrides:

update in class AnAction

Parameters:

e - Carries information on the invocation place and data available

findRefactoringTargetInEditor

protected PsiElement findRefactoringTargetInEditor(DataContext dataContext)

getActionName

protected java.lang.String getActionName(DataContext dataContext)

disableOnCompiledElement

protected boolean disableOnCompiledElement()

isHidden

protected boolean isHidden()

getElementAtCaret

public static PsiElement getElementAtCaret(Editor editor,
                                           PsiFile file)

isAvailableForLanguage

protected boolean isAvailableForLanguage(Language language)

isAvailableForFile

protected boolean isAvailableForFile(PsiFile file)

getPsiElementArray

public static PsiElement [] getPsiElementArray(DataContext dataContext)