Package com.intellij.refactoring.rename

Class PsiElementRenameHandler

java.lang.Object

com.intellij.refactoring.rename.PsiElementRenameHandler

All Implemented Interfaces:

RefactoringActionHandler, RenameHandler

Direct Known Subclasses:

AntRenameHandler, ProjectFolderRenameHandler

public class PsiElementRenameHandler
extends java.lang.Object
implements RenameHandler

created at Nov 13, 2001

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<java.lang.String>	DEFAULT_NAME

Fields inherited from interface com.intellij.refactoring.rename.RenameHandler

EP_NAME

Constructor Summary

Constructors

Constructor and Description
PsiElementRenameHandler()

Method Summary

Modifier and Type	Method and Description
static boolean	canRename(Project project, Editor editor, PsiElement element)
static PsiElement	getElement(DataContext dataContext)
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).
static void	invoke(PsiElement element, Project project, PsiElement nameSuggestionContext, Editor editor)
static void	invoke(PsiElement element, Project project, PsiElement nameSuggestionContext, Editor editor, boolean checkInProject)
boolean	isAvailableOnDataContext(DataContext dataContext)
static boolean	isVetoed(PsiElement element)
static void	rename(PsiElement element, Project project, PsiElement nameSuggestionContext, Editor editor)
static void	rename(PsiElement element, Project project, PsiElement nameSuggestionContext, Editor editor, java.lang.String defaultName)
static void	rename(PsiElement element, Project project, PsiElement nameSuggestionContext, Editor editor, java.lang.String defaultName, RenamePsiElementProcessor processor)
protected boolean	shouldCheckInProject()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.refactoring.rename.RenameHandler

isRenaming

Field Detail

DEFAULT_NAME

public static final DataKey<java.lang.String> DEFAULT_NAME

Constructor Detail

PsiElementRenameHandler

public PsiElementRenameHandler()

Method Detail

invoke

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

Description copied from interface: RefactoringActionHandler

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

Specified by:

invoke in interface RefactoringActionHandler

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

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

Description copied from interface: RefactoringActionHandler

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

Specified by:

invoke in interface RefactoringActionHandler

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)

shouldCheckInProject

protected boolean shouldCheckInProject()

invoke

public static void invoke(PsiElement element,
                          Project project,
                          PsiElement nameSuggestionContext,
                          Editor editor)

invoke

public static void invoke(PsiElement element,
                          Project project,
                          PsiElement nameSuggestionContext,
                          Editor editor,
                          boolean checkInProject)

canRename

public static boolean canRename(Project project,
                                Editor editor,
                                PsiElement element)
                         throws CommonRefactoringUtil.RefactoringErrorHintException

Throws:

CommonRefactoringUtil.RefactoringErrorHintException

rename

public static void rename(PsiElement element,
                          Project project,
                          PsiElement nameSuggestionContext,
                          Editor editor)

rename

public static void rename(PsiElement element,
                          Project project,
                          PsiElement nameSuggestionContext,
                          Editor editor,
                          java.lang.String defaultName)

rename

public static void rename(PsiElement element,
                          Project project,
                          PsiElement nameSuggestionContext,
                          Editor editor,
                          java.lang.String defaultName,
                          RenamePsiElementProcessor processor)

isAvailableOnDataContext

public boolean isAvailableOnDataContext(DataContext dataContext)

Specified by:

isAvailableOnDataContext in interface RenameHandler

isVetoed

public static boolean isVetoed(PsiElement element)

getElement

public static PsiElement getElement(DataContext dataContext)