Package com.intellij.execution

Class Executor

java.lang.Object

com.intellij.execution.Executor

Direct Known Subclasses:

CoverageExecutor, DefaultDebugExecutor, DefaultRunExecutor

public abstract class Executor
extends java.lang.Object

Describes a specific way of executing any possible run configuration. The three default executors provided by the IntelliJ Platform by default are Run, Debug and Run with Coverage. Each executor gets its own toolbar button, which starts the selected run configuration using this executor, and its own context menu item for starting a configuration using this executor.

See Also:

ExecutorRegistry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Executor.ActionWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<Executor>	EXECUTOR_EXTENSION_NAME

Constructor Summary

Constructors

Constructor and Description
Executor()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getActionName()
abstract java.lang.String	getContextActionId()
abstract java.lang.String	getDescription() Returns the action description (text displayed in the status bar) for the toolbar button corresponding to the executor.
abstract javax.swing.Icon	getDisabledIcon() Returns the 16x16 icon for the disabled toolbar button corresponding to the executor.
abstract java.lang.String	getHelpId()
abstract javax.swing.Icon	getIcon() Returns the 16x16 icon for the toolbar button corresponding to the executor.
abstract java.lang.String	getId() Returns the unique ID of the executor.
abstract java.lang.String	getStartActionText()
java.lang.String	getStartActionText(java.lang.String configurationName)
abstract javax.swing.Icon	getToolWindowIcon()
abstract java.lang.String	getToolWindowId() Returns the ID of the toolwindow in which the run tabs created by this executor will be displayed.
boolean	isApplicable(Project project) Return false to suppress action visibility for given project.
Executor.ActionWrapper	runnerActionsGroupExecutorActionCustomizer() Returns the way to customize ExecutorAction (or ExecutorGroupActionGroup) created for this Executor by ExecutorRegistryImpl
static java.lang.String	shortenNameIfNeed(java.lang.String name) Deprecated. use shortenNameIfNeeded(String) instead
static java.lang.String	shortenNameIfNeeded(java.lang.String name) Too long names don't fit into UI controls and have to be trimmed

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTOR_EXTENSION_NAME

public static final ExtensionPointName<Executor> EXECUTOR_EXTENSION_NAME

Constructor Detail

Executor

public Executor()

Method Detail

getToolWindowId

public abstract java.lang.String getToolWindowId()

Returns the ID of the toolwindow in which the run tabs created by this executor will be displayed.

Returns:

the ID of the toolwindow (usually ToolWindowId.RUN or ToolWindowId.DEBUG).

getToolWindowIcon

public abstract javax.swing.Icon getToolWindowIcon()

getIcon

public abstract javax.swing.Icon getIcon()

Returns the 16x16 icon for the toolbar button corresponding to the executor.

Returns:

the icon.

getDisabledIcon

public abstract javax.swing.Icon getDisabledIcon()

Returns the 16x16 icon for the disabled toolbar button corresponding to the executor.

Returns:

the icon for the disabled button.

getDescription

public abstract java.lang.String getDescription()

Returns the action description (text displayed in the status bar) for the toolbar button corresponding to the executor.

Returns:

the executor action description.

getActionName

public abstract java.lang.String getActionName()

getId

public abstract java.lang.String getId()

Returns the unique ID of the executor.

Returns:

the ID of the executor.

getStartActionText

public abstract java.lang.String getStartActionText()

Returns:

text of the action in text-with-mnemonic format

getContextActionId

public abstract java.lang.String getContextActionId()

getHelpId

public abstract java.lang.String getHelpId()

runnerActionsGroupExecutorActionCustomizer

public Executor.ActionWrapper runnerActionsGroupExecutorActionCustomizer()

Returns the way to customize ExecutorAction (or ExecutorGroupActionGroup) created for this Executor by ExecutorRegistryImpl

Returns:

the way to customize ExecutorRegistryImpl.ExecutorAction (or ExecutorRegistryImpl.ExecutorGroupActionGroup) created for this Executor, that will be shown in ExecutorRegistryImpl.RUNNERS_GROUP group on main toolbar

getStartActionText

public java.lang.String getStartActionText(java.lang.String configurationName)

Returns:

text of the action specialized for given configuration name in text-with-mnemonic format.

isApplicable

public boolean isApplicable(Project project)

Return false to suppress action visibility for given project.

shortenNameIfNeeded

public static java.lang.String shortenNameIfNeeded(java.lang.String name)

Too long names don't fit into UI controls and have to be trimmed

shortenNameIfNeed

@Deprecated
public static java.lang.String shortenNameIfNeed(java.lang.String name)

Deprecated. use shortenNameIfNeeded(String) instead