Package com.intellij.refactoring

Interface RefactoringActionHandler

All Known Subinterfaces:

ChangeSignatureHandler, ElementsHandler, RenameHandler

All Known Implementing Classes:

AnonymousToInnerHandler, AntRenameHandler, BaseExpressionToFieldHandler, BaseIntroduceAction, BeanPropertyRenameHandler, ChangeTypeSignatureHandler, ClassRefactoringHandlerBase, CommonEditorReferenceBeanPropertyRenameHandler, ConvertToInstanceMethodHandler, ConvertToJavaHandler, ConvertToStaticHandler, DirectoryAsPackageRenameHandler, DirectoryAsPackageRenameHandlerBase, DirectoryRenameHandlerBase, EncapsulateFieldsHandler, ExtractClassHandler, ExtractIncludeFileBase, ExtractInterfaceHandler, ExtractMethodHandler, ExtractMethodObjectHandler, ExtractSuperclassHandler, FormRenameHandler, GrChangeSignatureHandler, GrIntroduceConstantHandler, GrIntroduceFieldHandler, GrIntroduceFieldHandlerBase, GrIntroduceHandlerBase, GrIntroduceParameterHandler, GrIntroduceVariableHandler, GrMethodInplaceRenameHandler, GroovyExtractMethodHandler, GrPullUpHandler, GrVariableInplaceRenameHandler, InheritanceToDelegationHandler, InlineRefactoringActionHandler, IntroduceConstantHandler, IntroduceFieldHandler, IntroduceFunctionalParameterHandler, IntroduceFunctionalVariableHandler, IntroduceHandler, IntroduceHandler, IntroduceHandlerBase, IntroduceParameterHandler, IntroduceVariableBase, IntroduceVariableHandler, InvertBooleanHandler, JavaChangeSignatureHandler, JavaFxPropertyRenameHandler, JavaPullUpHandler, JavaPushDownHandler, MakeStaticHandler, MemberInplaceRenameHandler, MethodDuplicatesHandler, MoveHandler, MoveInstanceMethodHandler, PlainDirectoryRenameHandler, ProjectFolderRenameHandler, PropertyRenameHandler, PsiElementRenameHandler, PyChangeSignatureHandler, PyClassRefactoringHandler, PyExtractMethodHandler, PyExtractSuperclassHandler, PyIntroduceConstantHandler, PyIntroduceFieldHandler, PyIntroduceParameterHandler, PyIntroduceVariableHandler, PyMagicLiteralRenameHandler, PyPullUpHandler, PyPushDownHandler, RemoveMiddlemanHandler, RenameLibraryHandler, RenameModuleAndDirectoryHandler, RenameModuleHandler, RenameProjectHandler, RenameWrongRefHandler, ReplaceConstructorWithBuilderHandler, ReplaceConstructorWithFactoryHandler, ResourceBundleFromEditorRenameHandler, ResourceBundleFromProjectViewRenameHandler, SafeDeleteHandler, SchemaPrefixRenameHandler, ShRenameHandler, TempWithQueryHandler, TurnRefsToSuperHandler, TypeCookHandler, VariableInplaceRenameHandler, XmlTagRenameHandler, XsltExtractFunctionAction, XsltExtractTemplateAction, XsltIntroduceParameterAction, XsltIntroduceVariableAction, XsltRefactoringActionBase

public interface RefactoringActionHandler

RefactoringActionHandler is an implementation of a specific IDE refactoring, with dialogs, UI and all. It is what gets invoked when user chooses an item from 'Refactoring' menu.

RefactoringActionHandler is a "one-shot" object: you should not invoke it twice.

Use ContextAwareActionHandler to hide an action from popups but allow access by shortcut, main menu or find.

See Also:

RefactoringActionHandlerFactory

Method Summary

Modifier and Type	Method and Description
void	invoke(Project project, Editor editor, PsiFile file, DataContext dataContext) Invokes refactoring action from editor.
void	invoke(Project project, PsiElement [] elements, DataContext dataContext) Invokes refactoring action from elsewhere (not from editor).

Method Detail

invoke

void invoke(Project project,
            Editor editor,
            PsiFile file,
            DataContext dataContext)

Invokes refactoring action from editor. The refactoring obtains all data from editor selection.

Parameters:

project - the project in which the refactoring is invoked.

editor - editor that refactoring is invoked in

file - file should correspond to editor

dataContext - can be null for some but not all of refactoring action handlers (it is recommended to pass DataManager.getDataContext() instead of null)

invoke

void invoke(Project project,
            PsiElement [] elements,
            DataContext dataContext)

Invokes refactoring action from elsewhere (not from editor). Some refactorings do not implement this method.

Parameters:

project - the project in which the refactoring is invoked.

elements - list of elements that refactoring should work on. Refactoring-dependent.

dataContext - can be null for some but not all of refactoring action handlers (it is recommended to pass DataManager.getDataContext() instead of null)