Package com.intellij.refactoring

Class IntroduceHandlerBase

java.lang.Object

com.intellij.refactoring.IntroduceHandlerBase

All Implemented Interfaces:

ContextAwareActionHandler, RefactoringActionHandler

Direct Known Subclasses:

BaseExpressionToFieldHandler, IntroduceParameterHandler, IntroduceVariableBase

public abstract class IntroduceHandlerBase
extends java.lang.Object
implements RefactoringActionHandler, ContextAwareActionHandler

Constructor Summary

Constructors

Constructor and Description
IntroduceHandlerBase()

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptLocalVariable()
abstract AbstractInplaceIntroducer	getInplaceIntroducer()
void	invoke(Project project, PsiElement [] elements, DataContext dataContext) Invokes refactoring action from elsewhere (not from editor).
void	invoke(Project project, PsiElement element, Editor editor)
protected abstract boolean	invokeImpl(Project project, PsiExpression tempExpr, Editor editor)
protected abstract boolean	invokeImpl(Project project, PsiLocalVariable localVariable, Editor editor)
boolean	isAvailableForQuickList(Editor editor, PsiFile file, DataContext dataContext) Handlers could provide useful hints when they are actually not available, e.g.

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.RefactoringActionHandler

invoke

Constructor Detail

IntroduceHandlerBase

public IntroduceHandlerBase()

Method Detail

isAvailableForQuickList

public boolean isAvailableForQuickList(Editor editor,
                                       PsiFile file,
                                       DataContext dataContext)

Description copied from interface: ContextAwareActionHandler

Handlers could provide useful hints when they are actually not available, e.g. 'No methods to implement', 'Selected block should represent ...', 'Caret should be positioned at the name of ...', etc. At the same time, when the action is invoked through refactorings quick list popup, generate popup or in another manner but not through main menu (shortcut or find action are treated the same), it's better to hide the action: it would pollute menu with one more choice but can't do anything.

Specified by:

isAvailableForQuickList in interface ContextAwareActionHandler

Returns:

It's assumed that handler is valid for file. Still should be lightweight, because is invoked from action update. false - if action won't proceed

acceptLocalVariable

protected boolean acceptLocalVariable()

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)

invoke

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

invokeImpl

protected abstract boolean invokeImpl(Project project,
                                      PsiExpression tempExpr,
                                      Editor editor)

Parameters:

editor - editor to highlight stuff in. Should accept null

invokeImpl

protected abstract boolean invokeImpl(Project project,
                                      PsiLocalVariable localVariable,
                                      Editor editor)

Parameters:

editor - editor to highlight stuff in. Should accept null

getInplaceIntroducer

public abstract AbstractInplaceIntroducer getInplaceIntroducer()