Package com.intellij.refactoring.rename.naming

Interface AutomaticRenamerFactory

All Known Implementing Classes:

AutomaticInheritorRenamerFactory, AutomaticOverloadsRenamerFactory, AutomaticParametersRenamerFactory, AutomaticTestRenamerFactory, AutomaticVariableRenamerFactory, ConstructorParameterOnFieldRenameRenamerFactory, FormsRenamerFactory, PyContainingFileRenamerFactory, PyInheritorRenameFactory, PyParametersRenameFactory, RelatedFilesRenamerFactory, ResourceBundleRenamerFactory

public interface AutomaticRenamerFactory

When an element is renamed, allows to prompt the user to rename other elements with names derived from the name of the element being renamed (for example, when a class is renamed, allows to prompt the user to rename variables of this class that have names similar to the name of the class).

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<AutomaticRenamerFactory>	EP_NAME

Method Summary

Modifier and Type	Method and Description
AutomaticRenamer	createRenamer(PsiElement element, java.lang.String newName, java.util.Collection<UsageInfo> usages) Creates an automatic renamer for the given rename operation.
java.lang.String	getOptionName() Returns the title of the checkbox shown in the rename dialog which enables or disables this renamer factory, or null if the renamer factory does not require showing a checkbox in the rename dialog.
boolean	isApplicable(PsiElement element) Checks if this factory can provide additional elements to be renamed for the given element being renamed.
boolean	isEnabled() Returns true if this renamer factory is enabled (and the checkbox representing its state should be checked.) Normally, the implementation of this method needs to load the persisted state of the checkbox.
void	setEnabled(boolean enabled) Persists the state of the checkbox which enables or disables the renamer factory.

Field Detail

EP_NAME

static final ExtensionPointName<AutomaticRenamerFactory> EP_NAME

Method Detail

isApplicable

boolean isApplicable(PsiElement element)

Checks if this factory can provide additional elements to be renamed for the given element being renamed.

Parameters:

element - the element being renamed.

getOptionName

java.lang.String getOptionName()

Returns the title of the checkbox shown in the rename dialog which enables or disables this renamer factory, or null if the renamer factory does not require showing a checkbox in the rename dialog.

Returns:

the checkbox title.

isEnabled

boolean isEnabled()

Returns true if this renamer factory is enabled (and the checkbox representing its state should be checked.) Normally, the implementation of this method needs to load the persisted state of the checkbox.

setEnabled

void setEnabled(boolean enabled)

Persists the state of the checkbox which enables or disables the renamer factory.

Parameters:

enabled - true if the checkbox is checked, false otherwise.

createRenamer

AutomaticRenamer createRenamer(PsiElement element,
                               java.lang.String newName,
                               java.util.Collection<UsageInfo> usages)

Creates an automatic renamer for the given rename operation.

Parameters:

element - the primary element being renamed.

newName - the new name of the element

usages - the list of usages of the primary element.

Returns:

the renamer instance.