Package com.intellij.refactoring.rename.inplace

Class InplaceRefactoring

java.lang.Object

com.intellij.refactoring.rename.inplace.InplaceRefactoring

Direct Known Subclasses:

InplaceVariableIntroducer, VariableInplaceRenamer

public abstract class InplaceRefactoring
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Key<InplaceRefactoring>	INPLACE_RENAMER
static Key<java.lang.Boolean>	INTRODUCE_RESTART
protected static Logger	LOG
protected java.lang.String	myAdvertisementText
protected Balloon	myBalloon
protected RangeMarker	myBeforeRevert
protected RangeMarker	myCaretRangeMarker
protected Editor	myEditor
protected PsiNamedElement	myElementToRename
protected java.lang.String	myInitialName
protected java.lang.String	myInsertedName
protected StartMarkAction	myMarkAction
protected java.util.LinkedHashSet<java.lang.String>	myNameSuggestions
protected java.lang.String	myOldName
protected Project	myProject
protected RangeMarker	myRenameOffset
protected PsiElement	myScope
protected RelativePoint	myTarget
protected java.lang.String	myTitle
protected static java.lang.String	OTHER_VARIABLE_NAME
protected static Stack<InplaceRefactoring>	ourRenamersStack
protected static java.lang.String	PRIMARY_VARIABLE_NAME

Constructor Summary

Constructors

Constructor and Description
InplaceRefactoring(Editor editor, PsiNamedElement elementToRename, Project project)
InplaceRefactoring(Editor editor, PsiNamedElement elementToRename, Project project, java.lang.String oldName)
InplaceRefactoring(Editor editor, PsiNamedElement elementToRename, Project project, java.lang.String initialName, java.lang.String oldName)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptReference(PsiReference reference)
protected void	addAdditionalVariables(TemplateBuilderImpl builder)
protected void	addHighlights(java.util.Map<TextRange,TextAttributes> ranges, Editor editor, java.util.Collection<RangeHighlighter> highlighters, HighlightManager highlightManager)
protected void	addReferenceAtCaret(java.util.Collection<PsiReference> refs)
protected void	adjustBalloon(BalloonBuilder builder)
protected void	beforeTemplateStart()
protected boolean	buildTemplateAndStart(java.util.Collection<PsiReference> refs, java.util.Collection<Pair<PsiElement,TextRange>> stringUsages, PsiElement scope, PsiFile containingFile)
static boolean	canStartAnotherRefactoring(Editor editor, Project project, RefactoringActionHandler handler, PsiElement... element)
static void	checkCleared()
protected PsiElement	checkLocalScope()
protected abstract void	collectAdditionalElementsToRename(java.util.List<Pair<PsiElement,TextRange>> stringUsages)
protected java.util.Collection<PsiReference>	collectRefs(SearchScope referencesSearchScope)
protected MyLookupExpression	createLookupExpression(PsiElement selectedElement)
static EditorEx	createPreviewComponent(Project project, FileType languageFileType)
protected Expression	createTemplateExpression(PsiElement selectedElement)
void	finish(boolean success)
static InplaceRefactoring	getActiveInplaceRenamer(Editor editor)
protected abstract java.lang.String	getCommandName() Returns the name of the command performed by the refactoring.
protected javax.swing.JComponent	getComponent()
java.lang.String	getInitialName()
protected PsiElement	getNameIdentifier()
protected TextRange	getRangeToRename(PsiElement element)
protected TextRange	getRangeToRename(PsiReference reference)
protected SearchScope	getReferencesSearchScope(VirtualFile file)
protected PsiElement	getSelectedInEditorElement(PsiElement nameIdentifier, java.util.Collection<? extends PsiReference> refs, java.util.Collection<? extends Pair<PsiElement,TextRange>> stringUsages, int offset)
protected static VirtualFile	getTopLevelVirtualFile(FileViewProvider fileViewProvider)
protected PsiNamedElement	getVariable()
protected boolean	isIdentifier(java.lang.String newName, Language language)
protected boolean	isReferenceAtCaret(PsiElement selectedElement, PsiReference ref)
protected boolean	isRestart()
static boolean	isShowBalloonInHeadlessMode()
protected void	moveOffsetAfter(boolean success) Called after the completion of the refactoring, either a successful or a failed one.
protected void	navigateToAlreadyStarted(Document oldDocument, int exitCode)
protected boolean	notSameFile(VirtualFile file, PsiFile containingFile)
protected void	performCleanup() if brokenOff but not canceled
boolean	performInplaceRefactoring(java.util.LinkedHashSet<java.lang.String> nameSuggestions)
protected abstract boolean	performRefactoring()
protected void	releaseIfNotRestart()
protected void	releaseResources()
protected int	restoreCaretOffset(int offset)
protected void	restoreSelection()
protected void	revertState()
void	setAdvertisementText(java.lang.String advertisementText)
void	setElementToRename(PsiNamedElement elementToRename)
static void	setShowBalloonInHeadlessMode(boolean showBalloonInHeadlessMode)
protected abstract boolean	shouldSelectAll()
protected boolean	shouldStopAtLookupExpression(Expression expression)
protected void	showBalloon()
protected void	showBalloonInEditor()
protected void	showDialogAdvertisement(java.lang.String actionId)
protected StartMarkAction	startRename()
protected boolean	startsOnTheSameElement(RefactoringActionHandler handler, PsiElement element)
protected boolean	startsOnTheSameElements(Editor editor, RefactoringActionHandler handler, PsiElement[] element)
void	stopIntroduce(Editor editor)
static void	stopIntroduce(Editor editor, Project project, java.lang.String commandName)
static void	unableToStartWarning(Project project, Editor editor)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

PRIMARY_VARIABLE_NAME

protected static final java.lang.String PRIMARY_VARIABLE_NAME

See Also:

Constant Field Values

OTHER_VARIABLE_NAME

protected static final java.lang.String OTHER_VARIABLE_NAME

See Also:

Constant Field Values

ourRenamersStack

protected static final Stack<InplaceRefactoring> ourRenamersStack

INPLACE_RENAMER

public static final Key<InplaceRefactoring> INPLACE_RENAMER

INTRODUCE_RESTART

public static final Key<java.lang.Boolean> INTRODUCE_RESTART

myElementToRename

protected PsiNamedElement myElementToRename

myEditor

protected final Editor myEditor

myProject

protected final Project myProject

myRenameOffset

protected RangeMarker myRenameOffset

myAdvertisementText

protected java.lang.String myAdvertisementText

myInitialName

protected java.lang.String myInitialName

myOldName

protected java.lang.String myOldName

myBeforeRevert

protected RangeMarker myBeforeRevert

myInsertedName

protected java.lang.String myInsertedName

myNameSuggestions

protected java.util.LinkedHashSet<java.lang.String> myNameSuggestions

myMarkAction

protected StartMarkAction myMarkAction

myScope

protected PsiElement myScope

myCaretRangeMarker

protected RangeMarker myCaretRangeMarker

myBalloon

protected Balloon myBalloon

myTitle

protected java.lang.String myTitle

myTarget

protected RelativePoint myTarget

Constructor Detail

InplaceRefactoring

public InplaceRefactoring(Editor editor,
                          PsiNamedElement elementToRename,
                          Project project)

InplaceRefactoring

public InplaceRefactoring(Editor editor,
                          PsiNamedElement elementToRename,
                          Project project,
                          java.lang.String oldName)

InplaceRefactoring

public InplaceRefactoring(Editor editor,
                          PsiNamedElement elementToRename,
                          Project project,
                          java.lang.String initialName,
                          java.lang.String oldName)

Method Detail

unableToStartWarning

public static void unableToStartWarning(Project project,
                                        Editor editor)

setAdvertisementText

public void setAdvertisementText(java.lang.String advertisementText)

performInplaceRefactoring

public boolean performInplaceRefactoring(java.util.LinkedHashSet<java.lang.String> nameSuggestions)

notSameFile

protected boolean notSameFile(VirtualFile file,
                              PsiFile containingFile)

getReferencesSearchScope

protected SearchScope getReferencesSearchScope(VirtualFile file)

checkLocalScope

protected PsiElement checkLocalScope()

collectAdditionalElementsToRename

protected abstract void collectAdditionalElementsToRename(java.util.List<Pair<PsiElement,TextRange>> stringUsages)

shouldSelectAll

protected abstract boolean shouldSelectAll()

createLookupExpression

protected MyLookupExpression createLookupExpression(PsiElement selectedElement)

createTemplateExpression

protected Expression createTemplateExpression(PsiElement selectedElement)

acceptReference

protected boolean acceptReference(PsiReference reference)

collectRefs

protected java.util.Collection<PsiReference> collectRefs(SearchScope referencesSearchScope)

buildTemplateAndStart

protected boolean buildTemplateAndStart(java.util.Collection<PsiReference> refs,
                                        java.util.Collection<Pair<PsiElement,TextRange>> stringUsages,
                                        PsiElement scope,
                                        PsiFile containingFile)

shouldStopAtLookupExpression

protected boolean shouldStopAtLookupExpression(Expression expression)

isReferenceAtCaret

protected boolean isReferenceAtCaret(PsiElement selectedElement,
                                     PsiReference ref)

beforeTemplateStart

protected void beforeTemplateStart()

restoreSelection

protected void restoreSelection()

restoreCaretOffset

protected int restoreCaretOffset(int offset)

stopIntroduce

public void stopIntroduce(Editor editor)

stopIntroduce

public static void stopIntroduce(Editor editor,
                                 Project project,
                                 java.lang.String commandName)

navigateToAlreadyStarted

protected void navigateToAlreadyStarted(Document oldDocument,
                                        int exitCode)

getNameIdentifier

protected PsiElement getNameIdentifier()

createPreviewComponent

public static EditorEx createPreviewComponent(Project project,
                                              FileType languageFileType)

startRename

protected StartMarkAction startRename()
                               throws StartMarkAction.AlreadyStartedException

Throws:

StartMarkAction.AlreadyStartedException

getVariable

protected PsiNamedElement getVariable()

moveOffsetAfter

protected void moveOffsetAfter(boolean success)

Called after the completion of the refactoring, either a successful or a failed one.

Parameters:

success - true if the refactoring was accepted, false if it was cancelled (by undo or Esc)

addAdditionalVariables

protected void addAdditionalVariables(TemplateBuilderImpl builder)

addReferenceAtCaret

protected void addReferenceAtCaret(java.util.Collection<PsiReference> refs)

showDialogAdvertisement

protected void showDialogAdvertisement(java.lang.String actionId)

getInitialName

public java.lang.String getInitialName()

revertState

protected void revertState()

getCommandName

protected abstract java.lang.String getCommandName()

Returns the name of the command performed by the refactoring.

Returns:

command name

finish

public void finish(boolean success)

addHighlights

protected void addHighlights(java.util.Map<TextRange,TextAttributes> ranges,
                             Editor editor,
                             java.util.Collection<RangeHighlighter> highlighters,
                             HighlightManager highlightManager)

performRefactoring

protected abstract boolean performRefactoring()

performCleanup

protected void performCleanup()

if brokenOff but not canceled

getRangeToRename

protected TextRange getRangeToRename(PsiElement element)

getRangeToRename

protected TextRange getRangeToRename(PsiReference reference)

setElementToRename

public void setElementToRename(PsiNamedElement elementToRename)

isIdentifier

protected boolean isIdentifier(java.lang.String newName,
                               Language language)

getTopLevelVirtualFile

protected static VirtualFile getTopLevelVirtualFile(FileViewProvider fileViewProvider)

checkCleared

public static void checkCleared()

getSelectedInEditorElement

protected PsiElement getSelectedInEditorElement(PsiElement nameIdentifier,
                                                java.util.Collection<? extends PsiReference> refs,
                                                java.util.Collection<? extends Pair<PsiElement,TextRange>> stringUsages,
                                                int offset)

isRestart

protected boolean isRestart()

canStartAnotherRefactoring

public static boolean canStartAnotherRefactoring(Editor editor,
                                                 Project project,
                                                 RefactoringActionHandler handler,
                                                 PsiElement... element)

getActiveInplaceRenamer

public static InplaceRefactoring getActiveInplaceRenamer(Editor editor)

startsOnTheSameElements

protected boolean startsOnTheSameElements(Editor editor,
                                          RefactoringActionHandler handler,
                                          PsiElement[] element)

startsOnTheSameElement

protected boolean startsOnTheSameElement(RefactoringActionHandler handler,
                                         PsiElement element)

releaseResources

protected void releaseResources()

getComponent

protected javax.swing.JComponent getComponent()

showBalloon

protected void showBalloon()

showBalloonInEditor

protected void showBalloonInEditor()

adjustBalloon

protected void adjustBalloon(BalloonBuilder builder)

releaseIfNotRestart

protected void releaseIfNotRestart()

isShowBalloonInHeadlessMode

public static boolean isShowBalloonInHeadlessMode()

setShowBalloonInHeadlessMode

public static void setShowBalloonInHeadlessMode(boolean showBalloonInHeadlessMode)