Package com.intellij.refactoring.rename

Class DirectoryRenameHandlerBase

java.lang.Object

com.intellij.refactoring.rename.DirectoryRenameHandlerBase

All Implemented Interfaces:

TitledHandler, RefactoringActionHandler, RenameHandler

Direct Known Subclasses:

DirectoryAsPackageRenameHandlerBase, PlainDirectoryRenameHandler

public abstract class DirectoryRenameHandlerBase
extends java.lang.Object
implements RenameHandler, TitledHandler

Field Summary

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

EP_NAME

Constructor Summary

Constructors

Constructor and Description
DirectoryRenameHandlerBase()

Method Summary

Modifier and Type	Method and Description
protected PsiDirectory	adjustForRename(DataContext dataContext, PsiElement element)
protected abstract void	doRename(PsiElement element, Project project, PsiElement nameSuggestionContext, Editor editor)
java.lang.String	getActionTitle()
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).
boolean	isAvailableOnDataContext(DataContext dataContext)
protected abstract boolean	isSuitableDirectory(PsiDirectory directory)

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

Constructor Detail

DirectoryRenameHandlerBase

public DirectoryRenameHandlerBase()

Method Detail

getActionTitle

public java.lang.String getActionTitle()

Specified by:

getActionTitle in interface TitledHandler

isAvailableOnDataContext

public boolean isAvailableOnDataContext(DataContext dataContext)

Specified by:

isAvailableOnDataContext in interface RenameHandler

adjustForRename

protected PsiDirectory adjustForRename(DataContext dataContext,
                                       PsiElement element)

isSuitableDirectory

protected abstract boolean isSuitableDirectory(PsiDirectory directory)

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)

doRename

protected abstract void doRename(PsiElement element,
                                 Project project,
                                 PsiElement nameSuggestionContext,
                                 Editor editor)