Package com.intellij.ide.macro

Class PromptingMacro

java.lang.Object

com.intellij.ide.macro.Macro

com.intellij.ide.macro.PromptingMacro

Direct Known Subclasses:

FilePromptMacro, PromptMacro

public abstract class PromptingMacro
extends Macro

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.ide.macro.Macro

Macro.ExecutionCancelledException, Macro.Silent

Field Summary

Fields inherited from class com.intellij.ide.macro.Macro

EP_NAME, myCachedPreview

Constructor Summary

Constructors

Constructor and Description
PromptingMacro()

Method Summary

Modifier and Type	Method and Description
java.lang.String	expand(DataContext dataContext)
protected abstract java.lang.String	promptUser(DataContext dataContext) Called from expand() method

Methods inherited from class com.intellij.ide.macro.Macro

cachePreview, expand, getDescription, getName, getPath, getVirtualDirOrParent, preview

Methods inherited from class java.lang.Object

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

Constructor Detail

PromptingMacro

public PromptingMacro()

Method Detail

expand

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

Specified by:

expand in class Macro

Throws:

Macro.ExecutionCancelledException

promptUser

protected abstract java.lang.String promptUser(DataContext dataContext)

Called from expand() method

Parameters:

dataContext -

Returns:

user input. If null is returned, ExecutionCancelledException is thrown by expand() method