Package com.intellij.ide.macro

Class Macro

java.lang.Object

com.intellij.ide.macro.Macro

Direct Known Subclasses:

AffectedModuleNamesMacro, ClasspathEntryMacro, ClasspathMacro, ClipboardContentMacro, CompilerContextMakeMacro, ContentRootMacro, EditorMacro, FileClassMacro, FileDirMacro, FileDirNameMacro, FileDirPathFromParentMacro, FileDirRelativeToProjectRootMacro, FileDirRelativeToSourcepathMacro, FileEncodingMacro, FileExtMacro, FileFQPackage, FileNameMacro, FilePackageMacro, FileParentDirMacro, FilePathMacro, FilePathRelativeToProjectRootMacro, FilePathRelativeToSourcepathMacro, FileRelativeDirMacro, FileRelativePathMacro, InterpreterDirectoryMacro, JdkPathMacro, Macro.Silent, ModuleFileDirMacro, ModuleFilePathMacro, ModuleNameMacro, ModulePathMacro, ModuleSdkPathMacro, OutputPathMacro, ProjectFileDirMacro, ProjectNameMacro, ProjectPathMacro, PromptingMacro, SourcepathEntryMacro, SourcepathMacro, UnixSeparatorsMacro

public abstract class Macro
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Macro.ExecutionCancelledException
static class	Macro.Silent

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<Macro>	EP_NAME
protected java.lang.String	myCachedPreview

Constructor Summary

Constructors

Constructor and Description
Macro()

Method Summary

Modifier and Type	Method and Description
void	cachePreview(DataContext dataContext)
abstract java.lang.String	expand(DataContext dataContext)
java.lang.String	expand(DataContext dataContext, java.lang.String... args)
abstract java.lang.String	getDescription()
abstract java.lang.String	getName()
protected static java.lang.String	getPath(VirtualFile file)
protected static VirtualFile	getVirtualDirOrParent(DataContext dataContext)
java.lang.String	preview()

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

myCachedPreview

protected java.lang.String myCachedPreview

Constructor Detail

Macro

public Macro()

Method Detail

getName

public abstract java.lang.String getName()

getDescription

public abstract java.lang.String getDescription()

expand

public abstract java.lang.String expand(DataContext dataContext)
                                 throws Macro.ExecutionCancelledException

Throws:

Macro.ExecutionCancelledException

expand

public java.lang.String expand(DataContext dataContext,
                               java.lang.String... args)
                        throws Macro.ExecutionCancelledException

Throws:

Macro.ExecutionCancelledException

cachePreview

public void cachePreview(DataContext dataContext)

preview

public final java.lang.String preview()

getPath

protected static java.lang.String getPath(VirtualFile file)

getVirtualDirOrParent

protected static VirtualFile getVirtualDirOrParent(DataContext dataContext)