AnAction (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.actionSystem.AnAction

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

AboutAction, AbstractAction, AbstractActionWithPanel, AbstractAddToTestsPatternAction, AbstractArrangementRuleAction, AbstractConvertLineSeparatorsAction, AbstractDocumentationTooltipAction, AbstractExcludeFromRunAction, AbstractGuiEditorAction, AbstractImportTestsAction, AbstractIntegrateChangesAction, AbstractMissingFilesAction, AbstractTraverseWindowAction, ActionGroup, ActionStub, ActualSizeAction, AddAllOpenFilesToFavorites, AddAntBuildFile, AddComponentAction, AddDomElementAction, AddDomElementAction.ShowPopupAction, AddFacetToModuleAction, AddFrameworkSupportAction, AddGroupAction, AddInlayInternalAction, AddNewFavoritesListAction, AddNewPropertyFileAction, AddOrRemoveCaretDummyAction, AddRectangularSelectionOnMouseDragAction, AddTestProcessAction, AddToFavoritesAction, AnActionButton, AnalyzeDependenciesOnSpecifiedTargetAction, AnalyzeStacktraceAction, AnimatorTestAction, AntBuildFilePropertiesAction, ApplyIntentionAction, ArrangementRemoveConditionAction, ArrayFilterAction, AssociateFileTypeAction, AttachToProcessActionBase, AutomaticRenamingDialog.RenameSelectedAction, AutoRendererAction, BackAction, BackAction, BaseAnalysisAction, BaseDomTreeAction, BaseNavigateToSourceAction, BaseRefactoringAction, BaseTaskAction, BasicAction, BookmarksAction, BrowseHierarchyActionBase, BrowseRepositoryAction, BuildAndRestartConsoleAction, ChameleonAction, ChangeEditorFontSizeAction, ChangeFileEncodingAction, ChangeLibraryLevelActionBase, ChangeListDetailsAction, ChangeTemplateDataLanguageAction, ChangeViewAction, CheckForUpdateAction, CheckMessagesButtonsOrderAction, CheckResourcesAction, CheckSanityAction, ChooseRunConfigurationPopupAction, ChooseSubsequentPropertyValueEditorAction, ClassesActionBase, CleanPycAction, CleanupProjectAction, ClearTextAction, CloseAction, CloseAction, CloseActiveTabAction, CloseAllEditorsAction, CloseAllEditorsButActiveAction, CloseEditorAction, CloseEditorsActionBase, CloseProjectAction, CloseTabToolbarAction, CodeInsightAction, CodeInspectionOnEditorAction, CollapseAllAction, CollapseAllAction, CollapseTreeNodeAction, CollectTroubleshootingInformationAction, CollectZippedLogsAction, CombinePropertiesFilesAction, ComboBoxAction, CompileActionBase, CompileQrcAction, ComputeVirtualFileNameStatAction, ContextHelpAction, ConvertSchemaAction, CopyAction, CopyConfigurationAction, CopyElementAction, CopyPathsAction, CopyQuickDocAction, CopyValueAction, CreateDirectoryOrPackageAction, CreateEditorConfigAction, CreateFromTemplateAction, CreateFromTemplateActionBase, CreateInDirectoryActionBase, CreateRectangularSelectionAction, CreateRectangularSelectionOnMouseDragAction, CreateRendererAction, CreateSnapShotAction, CustomizeUIAction, CutAction, CvsGlobalAction, CyclicDependenciesAction, CyclicSplitLayoutChangeAction, DataBindingWizardAction, DeadlockWithCertificateDialogAction, DebuggerAction, DecodeBytesAction, DefaultAddAction, DefaultCustomComponentAction, DefaultJavaProgramRunner.ControlBreakAction, DefaultJavaProgramRunner.SoftExitAction, DeleteAction, DeleteAction, DeleteComponentAction, DeleteGroupAction, DeselectAllAction, DevelopPluginsAction, DissociateResourceBundleAction, DomCollectionControl.EditAction, DomCollectionControl.RemoveAction, DumbAwareAction, DumpConfigurationTypesAction, DumpDirectoryInfoAction, DumpFocusableComponentHierarchyAction, DumpGroovyControlFlowAction, DumpInspectionDescriptionsAction, DumpIntentionsAction, DumpLookupElementWeights, DumpThreadsAction, EditComponentAction, EditConfigurationAction, EditExternallyAction, EditFavoritesAction, EditFileTemplatesAction, EditGroupAction, EditMacrosAction, EditorAction, EditorAndPreviewLayoutChangeAction, EditorOnlyLayoutChangeAction, EditorRenderingBenchmarkAction, EditorTabbedContainer.CloseTab, EditRuleAliasesDefinitionAction, EditScopesAction, EmptyAction, EmptyAction.MyDelegatingAction, EnterAction, ExcludeFromStubGenerationAction, ExcludeFromValidationAction, ExcludeTreeNodeAction, ExitAction, ExpandAllAction, ExpandAllAction, ExpandSelectionAction, ExpandTreeNodeAction, ExportEclipseProjectsAction, ExportHTMLAction, ExportThreadsAction, ExportToHTMLAction, ExpressionStatisticsAction, ExtendableAction, ExternalJavaDocAction, ExternalSystemAction, ExtractCodeStyleAction, FakeRerunAction, FileChooserAction, FileHistorySingleCommitAction, FilterAction, FilterImagesAction, FindAllAction, FindAllAction, FindByXPathAction, FindForwardBackwardAction, FindFurtherAction, FindInPathAction, FindUsagesAction, FindUsagesInFileAction, FindUsagesInProjectStructureActionBase, FixLineSeparatorsAction, FocusDebuggerAction, FocusEditorAction, FocusOppositePaneAction, FocusTracesAction, ForwardAction, ForwardAction, FullyExpandTreeNodeAction, GenerateByPatternAction, GenerateCopyrightAction, GenerateCoverageReportAction, GenerateGroovyDocAction, GenerateInstanceDocumentFromSchemaAction, GenerateMainAction, GenerateVisitorByHierarchyAction, GetVersionAction, GotoActionBase, GotoCustomRegionAction, GotoLineAction, GoToMnemonicBookmarkActionBase, GotoNextIncompletePropertyAction, GotoRelatedSymbolAction, GrayFilterConfig, GrExecuteCommandAction, GroovyDocAddPackageAction, GroovyDocReducePackageAction, GroovyShellActionBase, GroupByLeavesAction, GroupByNullnessActionBase, GroupConfigurationsAction, HelpTopicsAction, HidpiInfo, HierarchyBrowserBaseEx.BaseOnThisElementAction, HighlightUsagesAction, HistoryDialog.MyAction, HotSwapAction, I18nizeAction, IconWithTextAction, IgnoreFileAction, ImplementMethodAction, ImportModuleAction, ImportModuleFromImlFileAction, ImportToRepositoryAction, ImportUsagesAction, IncludeTreeNodeAction, IncrementalSearchAction, InlineModuleDependencyAction, InsertPathAction, InspectionViewActionBase, InspectStubIndexAction, InvalidateCachesAction, InvokeQuickFixAction, InvokeTemplateAction, Java9GenerateModuleDescriptorsAction, JBTabsDemoAction, JdkPopupAction, JetBrainsTvAction, JumpToLastEditAction, JumpToLastWindowAction, JumpToNextEditAction, LaunchJShellConsoleAction, LfeBaseProxyAction, LoadAllContentsAction, LoadAllVfsStoredContentsAction, LocalHistoryAction, MacMessagesTest, MacWindowActionBase, MaintenanceAction, ManageProjectTemplatesAction, MarkdownHeaderAction, MarkdownIntroduceLinkReferenceAction, MarkFileDirtyAction, MarkLibraryRootAction, MasterDetailsComponent.MyActionGroupWrapper, MasterDetailsComponent.MyDeleteAction, MaximizeToolWindowAction, MergeAction, MergeFilesAction, MergeSourceDetailsAction, MigrateAction, MigrateCvsRootAction, MorphingAction, MoveArrangementGroupingRuleDownAction, MoveArrangementGroupingRuleUpAction, MoveEditorToOppositeTabGroupAction, MoveModulesOutsideGroupAction, MoveModulesToGroupAction, MoveSelectionToDownAction, MoveSelectionToLeftAction, MoveSelectionToRightAction, MoveSelectionToUpAction, MultiCaretCodeInsightAction, MultiplePasteAction, MvcRunCommandAction, NavBarActions, NavigateAction, NewDummyProjectAction, NewModuleAction, NewProjectAction, NextChangeAction, NextDifferenceAction, NextOccurenceAction, NextProjectWindow, NextTabAction, NotificationTestAction, OnlineDocAction, OpenFileAction, OpenInEditorWithMouseAction, OpenInSceneBuilderAction, OpenOutputAction, OpenRepositoryVersionAction, OptimizeImportsAction, OverrideMethodAction, PackageFileAction, PasteAction, PlaySavedMacros, PopupHectorAction, PositionTrackerTestAction, PrevChangeAction, PrevDifferenceAction, PreviewFormAction, PreviewOnlyLayoutChangeAction, PreviousOccurenceAction, PreviousTabAction, PruneEmptyDirectoriesAction, PutIntoDefaultLocationActionBase, PyManagePackagesAction, PyRunFileInConsoleAction, PythonSpellcheckerGenerateDictionariesAction, QuickFixAction, QuickSwitchSchemeAction, RearrangeCodeAction, RefCardAction, ReformatCodeAction, RefreshAction, RefreshAction, RefreshAllExternalProjectsAction, RefreshRemoteFileAction, RefreshStatuses, ReloadCustomComponentsAction, RemoveBomAction, RemoveBuildFileAction, RemoveDynamicAction, RemoveUsageAction, RenameFileAction, ReopenClosedTabAction, ReopenProjectAction, ReplaceInPathAction, ResizeToolWindowAction, ResourceBundleEditorShowQuickFixesAction, RestoreConfigurationAction, RestoreDefault, RestoreDefaultLayoutAction, RestorePreviousSettingsAction, RevertChangeListAction, RevertSelectedChangesAction, RollbackAction, RollbackDialogAction, RowColumnAction, RunAction, RunAnythingAction, RunnerContentUi.ShowDebugContentAction, RunPythonOrDebugConsoleAction, RunSphinxQuickStartAction, RunTargetAction, SaveAsDirectoryBasedFormatAction, SaveAsTemplateAction, SaveProjectAsTemplateAction, ScanSourceCommentsAction, ScheduleForAdditionAction, ScrollTreeToCenterAction, SearchEverywhereAction, SearchFieldAction, SearchWebAction, SelectAllAction, SelectInAction, SelectionBasedPsiElementInternalAction, SelectNextEditorTabAction, SelectPreviousEditorTabAction, SelectSameTypeAction, SelectSiblingsAction, SendEventLogAction, SendFeedbackAction, SendToFavoritesAction, Separator, SetShortcutAction, SetTodoFilterAction, SetupTaskChooserAction, SeverityEditorDialogAction, ShareWholeProject, ShowAffectedTestsAction, ShowAllAffectedGenericAction, ShowCertificateInfoAction, ShowContentAction, ShowCoveringTestsAction, ShowDelayedMessageInternalAction, ShowDiffWithLocalAction, ShowFeatureUsageStatisticsAction, ShowImageDuplicatesAction, ShowJavadoc, ShowJavadocAction, ShowLogAction, ShowMemoryDialogAction, ShowModuleDependenciesAction, ShowModulePropertiesAction, ShowNavBarAction, ShowNotificationIconsDialogAction, ShowPluginManagerAction, ShowProgressTestDialogAction, ShowQuickActionPopupAction, ShowRecentFindUsagesAction, ShowRecentTests, ShowReformatFileDialog, ShowRegistryAction, ShowRelatedStackAction, ShowRunningListAction, ShowSearchHistoryAction, ShowSettingsAction, ShowSouthPanelTestDialogAction, ShowStructureSettingsAction, ShowThumbnailsAction, ShowTipsAction, ShowUIDefaultsAction, ShowUsagesAction, ShrinkSelectionAction, SilentCodeCleanupAction, SplitAction, StartInplaceEditing, StartInplaceEditingAction, StartStopMacroRecordingAction, StartupWizardAction, StaticIconFieldsAction, StopAction, StopRangeSearchAction, StoreDefaultLayoutAction, SwingActionDelegate, SwitchCoverageSuiteAction, Switcher, SynchronizeAction, SynchronizeCurrentFileAction, SyncViewsAction, TabbedContentAction, TabListAction, TargetActionStub, TechnicalSupportAction, TemplateProjectPropertiesAction, TestCompilerReferenceServiceAction, TestDnd, TestGestureAction, TestMacMessagesAction, TestMacMessagesSequencesAction, TestMessageBoxAction, TextFieldAction, ThreeStateCheckboxAction, ThrowDebugExceptionAction, ToggleAction, ToggleFieldBreakpointAction, ToggleLaggingModeAction, ToggleMethodBreakpointAction, ToggleNumberedBookmarkActionBase, TogglePathShowingAction, TogglePopupHintsAction, TogglePresentationModeAction, ToggleReadOnlyAttributeAction, ToolAction, ToolWindowContextMenuActionBase, TraceStreamAction, TreeCollapseAllActionBase, TreeExpandAllActionBase, UngroupConfigurationsActions, UnmarkAddedAction, UnscrambleAction, UnshelveSilentlyAction, UnwrapHandler.MyUnwrapAction, UpdateRunningApplicationAction, UpFolderAction, UploadApplicationAction, UsedIconsListingAction, ValidateXmlAction, ViewBreakpointsAction, ViewOfflineResultsAction, VirtualFileInfoAction, WebBrowser, WelcomePopupAction, WhatsNewAction, WindowAction, WrapInAction, WrapWithCustomTemplateAction, XDebuggerActionBase, XDebuggerTreeActionBase, XFetchValueActionBase, XPathAction, XWatchesTreeActionBase, ZoomInAction, ZoomOutAction
```
public abstract class AnAction
extends java.lang.Object
implements PossiblyDumbAware
```
Represents an entity that has a state, a presentation and can be performed. For an action to be useful, you need to implement actionPerformed(com.intellij.openapi.actionSystem.AnActionEvent) and optionally to override update(com.intellij.openapi.actionSystem.AnActionEvent). By overriding the update(com.intellij.openapi.actionSystem.AnActionEvent) method you can dynamically change action's presentation depending on the place (for more information on places see ActionPlaces. The same action can have various presentations.
```
  public class MyAction extends AnAction {
    public MyAction() {
      // ...
    }

    public void update(AnActionEvent e) {
      Presentation presentation = e.getPresentation();
      if (e.getPlace().equals(ActionPlaces.MAIN_MENU)) {
        presentation.setText("My Menu item name");
      } else if (e.getPlace().equals(ActionPlaces.MAIN_TOOLBAR)) {
        presentation.setText("My Toolbar item name");
      }
    }

    public void actionPerformed(AnActionEvent e) { ... }
  }
 
```
See Also:

AnActionEvent, Presentation, ActionPlaces, DumbAwareAction

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AnAction.TransparentUpdate

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AnAction.TransparentUpdate`

Field Summary

Fields
Modifier and Type Field and Description

static Key<java.util.List<AnAction>> ACTIONS_KEY

static AnAction[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static Key<java.util.List<AnAction>>`	`ACTIONS_KEY`
`static AnAction[]`	`EMPTY_ARRAY`

Constructor Summary

Constructors
Constructor and Description
`AnAction()` Creates a new action with its text, description and icon set to `null`.
`AnAction(javax.swing.Icon icon)` Creates a new action with `icon` provided.
`AnAction(java.lang.String text)` Creates a new action with the specified text.
`AnAction(java.lang.String text, java.lang.String description, javax.swing.Icon icon)` Constructs a new action with the specified text, description and icon.
`AnAction(java.util.function.Supplier<java.lang.String> dynamicText)` Creates a new action with the specified text.
`AnAction(java.util.function.Supplier<java.lang.String> dynamicText, javax.swing.Icon icon)` Constructs a new action with the specified dynamicText, dynamicDescription and icon.
`AnAction(java.util.function.Supplier<java.lang.String> dynamicText, java.util.function.Supplier<java.lang.String> dynamicDescription, javax.swing.Icon icon)` Constructs a new action with the specified dynamicText, dynamicDescription and icon.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`actionPerformed(AnActionEvent e)` Implement this method to provide your action handler.
`void`	`addTextOverride(java.lang.String place, java.lang.String text)`
`void`	`applyTextOverride(AnActionEvent e)`
`void`	`beforeActionPerformedUpdate(AnActionEvent e)` Same as `update(AnActionEvent)` but is calls immediately before actionPerformed() as final check guard.
`void`	`copyFrom(AnAction sourceAction)` Copies template presentation and shortcuts set from `sourceAction`.
`void`	`copyShortcutFrom(AnAction sourceAction)`
`boolean`	`displayTextInToolbar()` Override with true returned if your action has to display its text along with the icon when placed in the toolbar
`static Project`	`getEventProject(AnActionEvent e)`
`ShortcutSet`	`getShortcutSet()` Returns the shortcut set associated with this action.
`Presentation`	`getTemplatePresentation()` Returns a template presentation that will be used as a template for created presentations.
`java.lang.String`	`getTemplateText()` Returns default action text.
`boolean`	`isDefaultIcon()` Returns true if the action has an internal, not user-customized icon.
`boolean`	`isEnabledInModalContext()`
`boolean`	`isInInjectedContext()`
`boolean`	`isTransparentUpdate()`
`void`	`registerCustomShortcutSet(int keyCode, int modifiers, javax.swing.JComponent component)`
`void`	`registerCustomShortcutSet(javax.swing.JComponent component, Disposable parentDisposable)`
`void`	`registerCustomShortcutSet(ShortcutSet shortcutSet, javax.swing.JComponent component)` Registers a set of shortcuts that will be processed when the specified component is the ancestor of focused component.
`void`	`registerCustomShortcutSet(ShortcutSet shortcutSet, javax.swing.JComponent component, Disposable parentDisposable)`
`void`	`setDefaultIcon(boolean isDefaultIconSet)` Sets the flag indicating whether the action has an internal or a user-customized icon.
`protected void`	`setEnabledInModalContext(boolean enabledInModalContext)`
`void`	`setInjectedContext(boolean worksInInjected)` Enables automatic detection of injected fragments in editor.
`protected void`	`setShortcutSet(ShortcutSet shortcutSet)`
`boolean`	`startInTransaction()` Deprecated. unused
`java.lang.String`	`toString()`
`void`	`unregisterCustomShortcutSet(javax.swing.JComponent component)`
`void`	`update(AnActionEvent e)` Updates the state of the action.
`boolean`	`useSmallerFontForTextInToolbar()` Override with true returned if your action displays text in a smaller font (same as toolbar combobox font) when placed in the toolbar

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

- Field Detail
  - ACTIONS_KEY
```
public static final Key<java.util.List<AnAction>> ACTIONS_KEY
```
  - EMPTY_ARRAY
```
public static final AnAction[] EMPTY_ARRAY
```
- Constructor Detail
  - AnAction
```
public AnAction()
```
    Creates a new action with its text, description and icon set to null.
  - AnAction
```
public AnAction(javax.swing.Icon icon)
```
    Creates a new action with icon provided. Its text, description set to null.
    
    Parameters:
    
    icon - Default icon to appear in toolbars and menus (Note some platform don't have icons in menu).
  - AnAction
```
public AnAction(java.lang.String text)
```
    Creates a new action with the specified text. Description and icon are set to null.
    
    Parameters:
    
    text - Serves as a tooltip when the presentation is a button and the name of the menu item when the presentation is a menu item.
  - AnAction
```
public AnAction(java.util.function.Supplier<java.lang.String> dynamicText)
```
    Creates a new action with the specified text. Description and icon are set to null.
    
    Parameters:
    
    dynamicText - Serves as a tooltip when the presentation is a button and the name of the menu item when the presentation is a menu item. Use it if you need to localize action text.
  - AnAction
```
public AnAction(java.lang.String text,
                java.lang.String description,
                javax.swing.Icon icon)
```
    Constructs a new action with the specified text, description and icon.
    
    Parameters:
    
    text - Serves as a tooltip when the presentation is a button and the name of the menu item when the presentation is a menu item
    
    description - Describes current action, this description will appear on the status bar when presentation has focus
    
    icon - Action's icon
  - AnAction
```
public AnAction(java.util.function.Supplier<java.lang.String> dynamicText,
                javax.swing.Icon icon)
```
    Constructs a new action with the specified dynamicText, dynamicDescription and icon.
    
    Parameters:
    
    dynamicText - Serves as a tooltip when the presentation is a button and the name of the menu item when the presentation is a menu item. Use it if you need to localize action text.
    
    icon - Action's icon
  - AnAction
```
public AnAction(java.util.function.Supplier<java.lang.String> dynamicText,
                java.util.function.Supplier<java.lang.String> dynamicDescription,
                javax.swing.Icon icon)
```
    Constructs a new action with the specified dynamicText, dynamicDescription and icon.
    
    Parameters:
    
    dynamicText - Serves as a tooltip when the presentation is a button and the name of the menu item when the presentation is a menu item. Use it if you need to localize action text.
    
    dynamicDescription - Describes current action, this dynamicDescription will appear on the status bar when presentation has focus. Use it if you need to localize description.
    
    icon - Action's icon
- Method Detail
  - getShortcutSet
```
public final ShortcutSet getShortcutSet()
```
    Returns the shortcut set associated with this action.
    
    Returns:
    
    shortcut set associated with this action
  - registerCustomShortcutSet
```
public final void registerCustomShortcutSet(ShortcutSet shortcutSet,
                                            javax.swing.JComponent component)
```
    Registers a set of shortcuts that will be processed when the specified component is the ancestor of focused component. Note that the action doesn't have to be registered in action manager in order for that shortcut to work.
    
    Parameters:
    
    shortcutSet - the shortcuts for the action.
    
    component - the component for which the shortcuts will be active.
  - registerCustomShortcutSet
```
public final void registerCustomShortcutSet(int keyCode,
                                            int modifiers,
                                            javax.swing.JComponent component)
```
  - registerCustomShortcutSet
```
public final void registerCustomShortcutSet(ShortcutSet shortcutSet,
                                            javax.swing.JComponent component,
                                            Disposable parentDisposable)
```
  - registerCustomShortcutSet
```
public final void registerCustomShortcutSet(javax.swing.JComponent component,
                                            Disposable parentDisposable)
```
  - unregisterCustomShortcutSet
```
public final void unregisterCustomShortcutSet(javax.swing.JComponent component)
```
  - copyFrom
```
public final void copyFrom(AnAction sourceAction)
```
    Copies template presentation and shortcuts set from sourceAction. Consider using ActionUtil.copyFrom(AnAction, String) instead.
  - copyShortcutFrom
```
public final void copyShortcutFrom(AnAction sourceAction)
```
  - isEnabledInModalContext
```
public final boolean isEnabledInModalContext()
```
  - setEnabledInModalContext
```
protected final void setEnabledInModalContext(boolean enabledInModalContext)
```
  - displayTextInToolbar
```
public boolean displayTextInToolbar()
```
    Override with true returned if your action has to display its text along with the icon when placed in the toolbar
  - useSmallerFontForTextInToolbar
```
public boolean useSmallerFontForTextInToolbar()
```
    Override with true returned if your action displays text in a smaller font (same as toolbar combobox font) when placed in the toolbar
  - update
```
public void update(AnActionEvent e)
```
    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 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.
    
    Parameters:
    
    e - Carries information on the invocation place and data available
  - beforeActionPerformedUpdate
```
public void beforeActionPerformedUpdate(AnActionEvent e)
```
    Same as update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard. Default implementation delegates to update(AnActionEvent).
    
    Parameters:
    
    e - Carries information on the invocation place and data available
  - getTemplatePresentation
```
public final Presentation getTemplatePresentation()
```
    Returns a template presentation that will be used as a template for created presentations.
    
    Returns:
    
    template presentation
  - actionPerformed
```
public abstract void actionPerformed(AnActionEvent e)
```
    Implement this method to provide your action handler.
    
    Parameters:
    
    e - Carries information on the invocation place
  - setShortcutSet
```
protected void setShortcutSet(ShortcutSet shortcutSet)
```
  - setDefaultIcon
```
public void setDefaultIcon(boolean isDefaultIconSet)
```
    Sets the flag indicating whether the action has an internal or a user-customized icon.
    
    Parameters:
    
    isDefaultIconSet - true if the icon is internal, false if the icon is customized by the user.
  - isDefaultIcon
```
public boolean isDefaultIcon()
```
    Returns true if the action has an internal, not user-customized icon.
    
    Returns:
    
    true if the icon is internal, false if the icon is customized by the user.
  - setInjectedContext
```
public void setInjectedContext(boolean worksInInjected)
```
    Enables automatic detection of injected fragments in editor. Values in DataContext, passed to the action, like EDITOR, PSI_FILE will refer to an injected fragment, if caret is currently positioned on it.
  - isInInjectedContext
```
public boolean isInInjectedContext()
```
  - isTransparentUpdate
```
public boolean isTransparentUpdate()
```
  - startInTransaction
```
@Deprecated
public boolean startInTransaction()
```
    Deprecated. unused
  - addTextOverride
```
public void addTextOverride(java.lang.String place,
                            java.lang.String text)
```
  - applyTextOverride
```
public void applyTextOverride(AnActionEvent e)
```
  - getEventProject
```
public static Project getEventProject(AnActionEvent e)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getTemplateText
```
public java.lang.String getTemplateText()
```
    Returns default action text. This method must be overridden in case template presentation contains user data like Project name, Run Configuration name, etc
    
    Returns:
    
    action presentable text without private user data

Class AnAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ACTIONS_KEY

EMPTY_ARRAY

Constructor Detail

AnAction

AnAction

AnAction

AnAction

AnAction

AnAction

AnAction

Method Detail

getShortcutSet

registerCustomShortcutSet

registerCustomShortcutSet

registerCustomShortcutSet

registerCustomShortcutSet

unregisterCustomShortcutSet

copyFrom

copyShortcutFrom

isEnabledInModalContext

setEnabledInModalContext

displayTextInToolbar

useSmallerFontForTextInToolbar

update

beforeActionPerformedUpdate

getTemplatePresentation

actionPerformed

setShortcutSet

setDefaultIcon

isDefaultIcon

setInjectedContext

isInInjectedContext

isTransparentUpdate

startInTransaction

addTextOverride

applyTextOverride

getEventProject

toString

getTemplateText