Package com.intellij.openapi.actionSystem

Class ActionGroup

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ActionGroup

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

AddAllToFavoritesActionGroup, AddCloudConnectionActionGroup, AddDomElementActionGroup, AddToFavoritesActionGroup, AnnotateActionGroup, AntBuildGroup, AssociationsGroup, BaseRunConfigurationAction, BaseStructureConfigurable.AbstractAddGroup, BranchActionGroup, ComputableActionGroup, CreateFromTemplateGroup, CustomisedActionGroup, DefaultActionGroup, DirDiffToolbarActions, EmptyAction.MyDelegatingActionGroup, ExcludingActionGroup, ExecutorRegistryImpl.ExecutorGroupActionGroup, FileTemplateSeparator, FilterByTagActionGroup, GenerateFromTestCreatorsGroup, GoToChangePopupAction, HgBranchPopupActions.HgShowUnnamedHeadsForCurrentBranchAction, HighlightersActionGroup, ImportTestsGroup, LightActionGroup, LineMarkerActionWrapper, MacrosGroup, MarkSourceRootActionGroup, MoveModuleToGroup, MoveModuleToGroupTopLevel, NewActionGroup, QuickFixesViewActionGroup, RecentProjectsGroup, RootAction, SendToFavoritesGroup, SetEditorSettingsAction, ShowAnnotateOperationsPopup.Group, ShowAnnotationColorsAction, ShowRecentFindUsagesGroup, ShowShortenNames, SimpleActionGroup, SplitButtonAction, SuppressActionWrapper, SurroundActionGroup, ToggleLogColumnsActionGroup, ToolWindowsGroup, TopAnomaliesAction, VcsQuickListPopupAction.Providers, VcsQuickListPopupAction.VcsNameSeparator, ViewAsGroup, ViewAsGroup, WeighingNewActionGroup

public abstract class ActionGroup
extends AnAction

Represents a group of actions.

See Also:

DefaultActionGroup, ComputableActionGroup, CheckedActionGroup, CompactActionGroup

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
static ActionGroup	EMPTY_GROUP

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ActionGroup() Creates a new ActionGroup with shortName set to null and popup set to false.
ActionGroup(java.lang.String shortName, boolean popup) Creates a new ActionGroup with the specified shortName and popup.
ActionGroup(java.lang.String text, java.lang.String description, javax.swing.Icon icon)
ActionGroup(java.util.function.Supplier<java.lang.String> shortName, boolean popup)
ActionGroup(java.util.function.Supplier<java.lang.String> dynamicText, java.util.function.Supplier<java.lang.String> dynamicDescription, 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 canBePerformed(DataContext) is true.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
boolean	canBePerformed(DataContext context)
boolean	disableIfNoVisibleChildren()
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
abstract AnAction []	getChildren(AnActionEvent e) Returns the children of the group.
AnAction []	getChildren(AnActionEvent e, ActionManager actionManager)
boolean	hideIfNoVisibleChildren()
boolean	isDumbAware()
boolean	isPopup() Returns the type of the group.
boolean	isPopup(java.lang.String place)
boolean	isPrimary(AnAction action)
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)
protected void	replace(AnAction originalAction, AnAction newAction)
void	setPopup(boolean popup) Sets the type of the group.

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, update, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_GROUP

public static final ActionGroup EMPTY_GROUP

Constructor Detail

ActionGroup

public ActionGroup()

Creates a new ActionGroup with shortName set to null and popup set to false.

ActionGroup

public ActionGroup(java.lang.String shortName,
                   boolean popup)

Creates a new ActionGroup with the specified shortName and popup.

Parameters:

shortName - Text that represents a short name for this action group

popup - true if this group is a popup, false otherwise

ActionGroup

public ActionGroup(java.util.function.Supplier<java.lang.String> shortName,
                   boolean popup)

ActionGroup

public ActionGroup(java.lang.String text,
                   java.lang.String description,
                   javax.swing.Icon icon)

ActionGroup

public ActionGroup(java.util.function.Supplier<java.lang.String> dynamicText,
                   java.util.function.Supplier<java.lang.String> dynamicDescription,
                   javax.swing.Icon icon)

Method Detail

actionPerformed

public void actionPerformed(AnActionEvent e)

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

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

canBePerformed

public boolean canBePerformed(DataContext context)

Returns:

true if actionPerformed(AnActionEvent) should be called.

isPopup

public boolean isPopup()

Returns the type of the group.

Returns:

true if the group is a popup, false otherwise

isPopup

public boolean isPopup(java.lang.String place)

setPopup

public final void setPopup(boolean popup)

Sets the type of the group.

Parameters:

popup - If true the group will be shown as a popup in menus.

addPropertyChangeListener

public final void addPropertyChangeListener(java.beans.PropertyChangeListener l)

removePropertyChangeListener

public final void removePropertyChangeListener(java.beans.PropertyChangeListener l)

firePropertyChange

protected final void firePropertyChange(java.lang.String propertyName,
                                        java.lang.Object oldValue,
                                        java.lang.Object newValue)

getChildren

public abstract AnAction [] getChildren(AnActionEvent e)

Returns the children of the group.

Returns:

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

getChildren

public AnAction [] getChildren(AnActionEvent e,
                               ActionManager actionManager)

isPrimary

public final boolean isPrimary(AnAction action)

replace

protected final void replace(AnAction originalAction,
                             AnAction newAction)

isDumbAware

public boolean isDumbAware()

hideIfNoVisibleChildren

public boolean hideIfNoVisibleChildren()

disableIfNoVisibleChildren

public boolean disableIfNoVisibleChildren()