Package com.intellij.openapi.command

Class CommandProcessor

java.lang.Object

com.intellij.openapi.command.CommandProcessor

Direct Known Subclasses:

CommandProcessorEx

public abstract class CommandProcessor
extends java.lang.Object

A class for defining 'command' scopes. Every undoable change should be executed as part of a command. Commands can nest, in such a case only the outer-most command is taken into account. Commands with the same 'group id' are merged for undo/redo purposes. 'Transparent' actions (commands) are similar to usual commands but don't create a separate undo/redo step - they are undone/redone together with a 'adjacent' non-transparent commands.

Constructor Summary

Constructors

Constructor and Description
CommandProcessor()

Method Summary

Modifier and Type	Method and Description
abstract void	addAffectedDocuments(Project project, Document... docs)
abstract void	addAffectedFiles(Project project, VirtualFile... files)
abstract void	addCommandListener(CommandListener listener) Deprecated. use CommandListener.TOPIC
void	addCommandListener(CommandListener listener, Disposable parentDisposable) Deprecated. use CommandListener.TOPIC
abstract void	executeCommand(Project project, java.lang.Runnable runnable, java.lang.String name, java.lang.Object groupId)
abstract void	executeCommand(Project project, java.lang.Runnable runnable, java.lang.String name, java.lang.Object groupId, Document document)
abstract void	executeCommand(Project project, java.lang.Runnable runnable, java.lang.String name, java.lang.Object groupId, UndoConfirmationPolicy confirmationPolicy)
abstract void	executeCommand(Project project, java.lang.Runnable command, java.lang.String name, java.lang.Object groupId, UndoConfirmationPolicy confirmationPolicy, boolean shouldRecordCommandForActiveDocument)
abstract void	executeCommand(Project project, java.lang.Runnable command, java.lang.String name, java.lang.Object groupId, UndoConfirmationPolicy confirmationPolicy, Document document)
abstract void	executeCommand(java.lang.Runnable runnable, java.lang.String name, java.lang.Object groupId) Deprecated. use executeCommand(Project, Runnable, String, Object)
abstract java.lang.Runnable	getCurrentCommand()
abstract java.lang.Object	getCurrentCommandGroupId()
abstract java.lang.String	getCurrentCommandName()
abstract Project	getCurrentCommandProject()
static CommandProcessor	getInstance()
abstract boolean	isUndoTransparentActionInProgress()
abstract void	markCurrentCommandAsGlobal(Project project)
abstract void	removeCommandListener(CommandListener listener) Deprecated. use CommandListener.TOPIC
abstract void	runUndoTransparentAction(java.lang.Runnable action) Defines a scope which contains undoable actions, for which there won't be a separate undo/redo step - they will be undone/redone along with 'adjacent' command.
abstract void	setCurrentCommandGroupId(java.lang.Object groupId)
abstract void	setCurrentCommandName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandProcessor

public CommandProcessor()

Method Detail

getInstance

public static CommandProcessor getInstance()

executeCommand

@Deprecated
public abstract void executeCommand(java.lang.Runnable runnable,
                                    java.lang.String name,
                                    java.lang.Object groupId)

Deprecated. use executeCommand(Project, Runnable, String, Object)

executeCommand

public abstract void executeCommand(Project project,
                                    java.lang.Runnable runnable,
                                    java.lang.String name,
                                    java.lang.Object groupId)

executeCommand

public abstract void executeCommand(Project project,
                                    java.lang.Runnable runnable,
                                    java.lang.String name,
                                    java.lang.Object groupId,
                                    Document document)

executeCommand

public abstract void executeCommand(Project project,
                                    java.lang.Runnable runnable,
                                    java.lang.String name,
                                    java.lang.Object groupId,
                                    UndoConfirmationPolicy confirmationPolicy)

executeCommand

public abstract void executeCommand(Project project,
                                    java.lang.Runnable command,
                                    java.lang.String name,
                                    java.lang.Object groupId,
                                    UndoConfirmationPolicy confirmationPolicy,
                                    Document document)

executeCommand

public abstract void executeCommand(Project project,
                                    java.lang.Runnable command,
                                    java.lang.String name,
                                    java.lang.Object groupId,
                                    UndoConfirmationPolicy confirmationPolicy,
                                    boolean shouldRecordCommandForActiveDocument)

Parameters:

shouldRecordCommandForActiveDocument - false if the action is not supposed to be recorded into the currently open document's history. Examples of such actions: Create New File, Change Project Settings etc. Default is true.

setCurrentCommandName

public abstract void setCurrentCommandName(java.lang.String name)

setCurrentCommandGroupId

public abstract void setCurrentCommandGroupId(java.lang.Object groupId)

getCurrentCommand

public abstract java.lang.Runnable getCurrentCommand()

getCurrentCommandName

public abstract java.lang.String getCurrentCommandName()

getCurrentCommandGroupId

public abstract java.lang.Object getCurrentCommandGroupId()

getCurrentCommandProject

public abstract Project getCurrentCommandProject()

runUndoTransparentAction

public abstract void runUndoTransparentAction(java.lang.Runnable action)

Defines a scope which contains undoable actions, for which there won't be a separate undo/redo step - they will be undone/redone along with 'adjacent' command.

isUndoTransparentActionInProgress

public abstract boolean isUndoTransparentActionInProgress()

See Also:

runUndoTransparentAction(Runnable)

markCurrentCommandAsGlobal

public abstract void markCurrentCommandAsGlobal(Project project)

addAffectedDocuments

public abstract void addAffectedDocuments(Project project,
                                          Document... docs)

addAffectedFiles

public abstract void addAffectedFiles(Project project,
                                      VirtualFile... files)

addCommandListener

@Deprecated
public abstract void addCommandListener(CommandListener listener)

Deprecated. use CommandListener.TOPIC

addCommandListener

@Deprecated
public void addCommandListener(CommandListener listener,
                               Disposable parentDisposable)

Deprecated. use CommandListener.TOPIC

removeCommandListener

@Deprecated
public abstract void removeCommandListener(CommandListener listener)

Deprecated. use CommandListener.TOPIC