Package com.intellij.codeInsight.template

Class Macro

java.lang.Object

com.intellij.codeInsight.template.Macro

Direct Known Subclasses:

AnnotatedMacro, BaseCompleteMacro, CastToLeftSideTypeMacro, ClassNameMacro, CollectionElementNameMacro, ComponentTypeOfMacro, DescendantClassesEnumMacro, EnumMacro, ExpectedTypeMacro, ExpressionTypeMacro, FilePathMacroBase, GroovyScriptMacro, GuessElementTypeMacro, IterableComponentTypeMacro, LineNumberMacro, MacroBase, MethodNameMacro, MethodParametersMacro, MethodReturnTypeMacro, PyClassNameMacro, PyFunctionNameMacro, PyIterableVariableMacro, QualifiedClassNameMacro, RightSideTypeMacro, ShowParameterInfoMacro, SimpleMacro, SubtypesMacro, SuggestIndexNameMacro, SuggestVariableNameMacro, TypeOfVariableMacro, VariableOfTypeMacro, VariableTypeMacroBase

public abstract class Macro
extends java.lang.Object

A macro which can be used in live templates.

Register in extension point com.intellij.liveTemplateMacro.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Macro()

Method Summary

Modifier and Type	Method and Description
LookupElement []	calculateLookupItems(Expression [] params, ExpressionContext context)
Result	calculateQuickResult(Expression [] params, ExpressionContext context)
abstract Result	calculateResult(Expression [] params, ExpressionContext context)
java.lang.String	getDefaultValue()
LookupFocusDegree	getLookupFocusDegree()
abstract java.lang.String	getName()
abstract java.lang.String	getPresentableName()
boolean	isAcceptableInContext(TemplateContextType context)

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<Macro> EP_NAME

Constructor Detail

Macro

public Macro()

Method Detail

getName

public abstract java.lang.String getName()

getPresentableName

public abstract java.lang.String getPresentableName()

Returns:

a presentable string that will be shown in the combobox in Edit Template Variables dialog

getDefaultValue

public java.lang.String getDefaultValue()

calculateResult

public abstract Result calculateResult(Expression [] params,
                                       ExpressionContext context)

calculateQuickResult

public Result calculateQuickResult(Expression [] params,
                                   ExpressionContext context)

calculateLookupItems

public LookupElement [] calculateLookupItems(Expression [] params,
                                             ExpressionContext context)

isAcceptableInContext

public boolean isAcceptableInContext(TemplateContextType context)

getLookupFocusDegree

public LookupFocusDegree getLookupFocusDegree()

Returns:

focus degree to use for macro's lookup.

See Also:

LookupFocusDegree