Package com.intellij.ide.macro

Class EditorMacro

java.lang.Object

com.intellij.ide.macro.Macro

com.intellij.ide.macro.EditorMacro

Direct Known Subclasses:

ColumnNumberMacro, LineNumberMacro, SelectedTextMacro, SelectionEndColumnMacro, SelectionEndLineMacro, SelectionStartColumnMacro, SelectionStartLineMacro

public abstract class EditorMacro
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
EditorMacro(java.lang.String name, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
java.lang.String	expand(DataContext dataContext)
protected abstract java.lang.String	expand(Editor editor)
protected static java.lang.String	getColumnNumber(Editor editor, LogicalPosition pos)
java.lang.String	getDescription()
java.lang.String	getName()

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

cachePreview, expand, getPath, getVirtualDirOrParent, preview

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorMacro

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

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class Macro

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class Macro

expand

public final java.lang.String expand(DataContext dataContext)

Specified by:

expand in class Macro

getColumnNumber

protected static java.lang.String getColumnNumber(Editor editor,
                                                  LogicalPosition pos)

Returns:

1-based column index where tabs are treated as single characters. External tools don't know about IDEA's tab size.

expand

protected abstract java.lang.String expand(Editor editor)