Package com.intellij.codeInsight.template.macro

Class MacroBase

java.lang.Object

com.intellij.codeInsight.template.Macro

com.intellij.codeInsight.template.macro.MacroBase

Direct Known Subclasses:

CapitalizeAndUnderscoreMacro, CapitalizeMacro, CommentMacro, ConcatMacro, ConvertToCamelCaseMacro, DecapitalizeMacro, EscapeStringMacro, FirstWordMacro, RegExMacro, ReplaceSpacesWithUnderscoresMacro, ReplaceUnderscoresWithSpacesMacro, SplitWordsMacro, SubstringBeforeMacro

public abstract class MacroBase
extends Macro

Field Summary

Fields inherited from class com.intellij.codeInsight.template.Macro

EP_NAME

Constructor Summary

Constructors

Constructor and Description
MacroBase(java.lang.String name, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
Result	calculateQuickResult(Expression [] params, ExpressionContext context)
Result	calculateResult(Expression [] params, ExpressionContext context)
protected abstract Result	calculateResult(Expression [] params, ExpressionContext context, boolean quick)
java.lang.String	getDefaultValue()
java.lang.String	getName()
java.lang.String	getPresentableName()
static java.lang.String	getTextResult(Expression [] params, ExpressionContext context)
static java.lang.String	getTextResult(Expression [] params, ExpressionContext context, boolean useSelection)

Methods inherited from class com.intellij.codeInsight.template.Macro

calculateLookupItems, getLookupFocusDegree, isAcceptableInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroBase

public MacroBase(java.lang.String name,
                 java.lang.String description)

Method Detail

calculateResult

protected abstract Result calculateResult(Expression [] params,
                                          ExpressionContext context,
                                          boolean quick)

calculateResult

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

Specified by:

calculateResult in class Macro

calculateQuickResult

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

Overrides:

calculateQuickResult in class Macro

getName

public java.lang.String getName()

Specified by:

getName in class Macro

getPresentableName

public java.lang.String getPresentableName()

Specified by:

getPresentableName in class Macro

Returns:

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

getDefaultValue

public java.lang.String getDefaultValue()

Overrides:

getDefaultValue in class Macro

getTextResult

public static java.lang.String getTextResult(Expression [] params,
                                             ExpressionContext context)

getTextResult

public static java.lang.String getTextResult(Expression [] params,
                                             ExpressionContext context,
                                             boolean useSelection)