Package com.intellij.execution.actions

Class BaseRunConfigurationAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ActionGroup

com.intellij.execution.actions.BaseRunConfigurationAction

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

CreateAction, RunContextAction

public abstract class BaseRunConfigurationAction
extends ActionGroup

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from class com.intellij.openapi.actionSystem.ActionGroup

EMPTY_GROUP

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRunConfigurationAction(java.util.function.Supplier<java.lang.String> text, java.util.function.Supplier<java.lang.String> description, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) This method can be called in popup menus if ActionGroup.canBePerformed(DataContext) is true.
protected void	approximatePresentationByPreviousAvailability(AnActionEvent event, ThreeState hadAnythingRunnable)
void	beforeActionPerformedUpdate(AnActionEvent e) Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard.
boolean	canBePerformed(DataContext dataContext)
protected java.util.List<AnAction>	createChildActions(ConfigurationContext context, java.util.List<? extends ConfigurationFromContext> configurations)
protected void	fullUpdate(AnActionEvent event)
AnAction []	getChildren(AnActionEvent e) Returns the children of the group.
boolean	isDumbAware()
protected boolean	isEnabledFor(RunConfiguration configuration)
protected abstract void	perform(ConfigurationContext context)
static java.lang.String	suggestRunActionName(LocatableConfiguration configuration)
void	update(AnActionEvent event) Updates the state of the action.
protected abstract void	updatePresentation(Presentation presentation, java.lang.String actionText, ConfigurationContext context)

Methods inherited from class com.intellij.openapi.actionSystem.ActionGroup

addPropertyChangeListener, disableIfNoVisibleChildren, firePropertyChange, getChildren, hideIfNoVisibleChildren, isPopup, isPopup, isPrimary, removePropertyChangeListener, replace, setPopup

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setInjectedContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

BaseRunConfigurationAction

protected BaseRunConfigurationAction(java.util.function.Supplier<java.lang.String> text,
                                     java.util.function.Supplier<java.lang.String> description,
                                     javax.swing.Icon icon)

Method Detail

getChildren

public AnAction [] getChildren(AnActionEvent e)

Description copied from class: ActionGroup

Returns the children of the group.

Specified by:

getChildren in class ActionGroup

Returns:

An array representing children of this group. All returned children must be not null.

createChildActions

protected java.util.List<AnAction> createChildActions(ConfigurationContext context,
                                                      java.util.List<? extends ConfigurationFromContext> configurations)

isEnabledFor

protected boolean isEnabledFor(RunConfiguration configuration)

canBePerformed

public boolean canBePerformed(DataContext dataContext)

Overrides:

canBePerformed in class ActionGroup

Returns:

true if ActionGroup.actionPerformed(AnActionEvent) should be called.

actionPerformed

public void actionPerformed(AnActionEvent e)

Description copied from class: ActionGroup

This method can be called in popup menus if ActionGroup.canBePerformed(DataContext) is true.

Overrides:

actionPerformed in class ActionGroup

Parameters:

e - Carries information on the invocation place

perform

protected abstract void perform(ConfigurationContext context)

beforeActionPerformedUpdate

public void beforeActionPerformedUpdate(AnActionEvent e)

Description copied from class: AnAction

Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard. Default implementation delegates to AnAction.update(AnActionEvent).

Overrides:

beforeActionPerformedUpdate in class AnAction

Parameters:

e - Carries information on the invocation place and data available

update

public void update(AnActionEvent event)

Description copied from class: AnAction

Updates the state of the action. Default implementation does nothing. Override this method to provide the ability to dynamically change action's state and(or) presentation depending on the context (For example when your action state depends on the selection you can check for selection and change the state accordingly).

This method can be called frequently, and on UI thread. This means that this method is supposed to work really fast, no real work should be done at this phase. For example, checking selection in a tree or a list, is considered valid, but working with a file system or PSI (especially resolve) is not. If you cannot determine the state of the action fast enough, you should do it in the AnAction.actionPerformed(AnActionEvent) method and notify the user that action cannot be executed if it's the case.

If the action is added to a toolbar, its "update" can be called twice a second, but only if there was any user activity or a focus transfer. If your action's availability is changed in absence of any of these events, please call ActivityTracker.getInstance().inc() to notify action subsystem to update all toolbar actions when your subsystem's determines that its actions' visibility might be affected.

Overrides:

update in class AnAction

Parameters:

event - Carries information on the invocation place and data available

approximatePresentationByPreviousAvailability

protected void approximatePresentationByPreviousAvailability(AnActionEvent event,
                                                             ThreeState hadAnythingRunnable)

fullUpdate

protected void fullUpdate(AnActionEvent event)

isDumbAware

public boolean isDumbAware()

Specified by:

isDumbAware in interface PossiblyDumbAware

Overrides:

isDumbAware in class ActionGroup

suggestRunActionName

public static java.lang.String suggestRunActionName(LocatableConfiguration configuration)

updatePresentation

protected abstract void updatePresentation(Presentation presentation,
                                           java.lang.String actionText,
                                           ConfigurationContext context)