Package com.intellij.openapi.vcs.actions

Class AbstractVcsAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.project.DumbAwareAction

com.intellij.openapi.vcs.actions.AbstractVcsAction

All Implemented Interfaces:

DumbAware, PossiblyDumbAware

Direct Known Subclasses:

AbstractCommonUpdateAction, AbstractShowDiffAction, CompareWithSelectedRevisionAction, SelectAndCompareWithSelectedRevisionAction, SelectedBlockHistoryAction, ShowBaseRevisionAction, TabbedShowHistoryAction

public abstract class AbstractVcsAction
extends DumbAwareAction

Nested Class Summary

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

AnAction.TransparentUpdate

Field Summary

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
AbstractVcsAction()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected abstract void	actionPerformed(VcsContext e)
protected boolean	forceSyncUpdate(AnActionEvent e) Deprecated. Only sync update is currently supported by AbstractVcsAction. Use com.intellij.openapi.actionSystem.AsyncUpdateAction directly if async update is necessary.
static java.util.Collection<AbstractVcs>	getActiveVcses(VcsContext dataContext)
protected void	performUpdate(Presentation presentation, VcsContext vcsContext) Deprecated. Use update(VcsContext, Presentation).
void	update(AnActionEvent e) Updates the state of the action.
protected abstract void	update(VcsContext vcsContext, Presentation presentation)

Methods inherited from class com.intellij.openapi.project.DumbAwareAction

create, create

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

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, 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

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Constructor Detail

AbstractVcsAction

public AbstractVcsAction()

Method Detail

getActiveVcses

public static java.util.Collection<AbstractVcs> getActiveVcses(VcsContext dataContext)

update

public void update(AnActionEvent e)

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:

e - Carries information on the invocation place and data available

actionPerformed

public void actionPerformed(AnActionEvent e)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

update

protected abstract void update(VcsContext vcsContext,
                               Presentation presentation)

actionPerformed

protected abstract void actionPerformed(VcsContext e)

forceSyncUpdate

@Deprecated
protected boolean forceSyncUpdate(AnActionEvent e)

Deprecated. Only sync update is currently supported by AbstractVcsAction. Use com.intellij.openapi.actionSystem.AsyncUpdateAction directly if async update is necessary.

performUpdate

@Deprecated
protected void performUpdate(Presentation presentation,
                             VcsContext vcsContext)

Deprecated. Use update(VcsContext, Presentation).