Package com.intellij.lang.refactoring

Interface InlineHandler

All Known Implementing Classes:

GroovyInlineHandler, XmlInlineHandler

public interface InlineHandler

Interface that should be implemented by the language in order to provide inline functionality and possibly participate in inline of elements in other languages this language may reference.

See Also:

InlineHandlers.getInlineHandlers(com.intellij.lang.Language)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InlineHandler.Inliner
static interface	InlineHandler.Settings

Method Summary

Modifier and Type	Method and Description
default boolean	canInlineElement(PsiElement element)
InlineHandler.Inliner	createInliner(PsiElement element, InlineHandler.Settings settings)
InlineHandler.Settings	prepareInlineElement(PsiElement element, Editor editor, boolean invokedOnReference)
void	removeDefinition(PsiElement element, InlineHandler.Settings settings)

Method Detail

canInlineElement

default boolean canInlineElement(PsiElement element)

prepareInlineElement

InlineHandler.Settings prepareInlineElement(PsiElement element,
                                            Editor editor,
                                            boolean invokedOnReference)

Parameters:

element - element to be inlined

invokedOnReference - true if the user invoked the refactoring on an element reference

editor - in case refactoring has been called in the editor

Returns:

Settings object in case refactoring should be performed or null otherwise

removeDefinition

void removeDefinition(PsiElement element,
                      InlineHandler.Settings settings)

Parameters:

element - inlined element

createInliner

InlineHandler.Inliner createInliner(PsiElement element,
                                    InlineHandler.Settings settings)

Parameters:

element - inlined element

settings - inlining settings

Returns:

Inliner instance to be used for inlining references in this language