Package com.intellij.openapi.actionSystem

Class DefaultActionGroup

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ActionGroup

com.intellij.openapi.actionSystem.DefaultActionGroup

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

AbstractNewProjectStep, AddServiceActionGroup, CheckResourcesAction.Group, CodeCompletionGroup, DefaultCompactActionGroup, EmptyActionGroup, ExternalSystemRunConfigurationMenu, IgnoreActionGroup, InspectionFilterAction, MoveProjectToGroupActionGroup, MvcActionGroup, NonEmptyActionGroup, NonTrivialActionGroup, OpenInNewTabActionGroup, ProjectGroupActionGroup, ProjectSpecificAction, ProjectWindowActionGroup, PyVariableViewSettings.VariablesPolicyGroup, RunDashboardFilterActionGroup, SmartPopupActionGroup, StandardVcsGroup, ToolWindowMoveAction.Group, ToolWindowViewModeAction.Group, UpdatableDefaultActionGroup, VcsActionGroup, VcsGroupsWrapper, VcsLogToolbarPopupActionGroup, VcsQuickListPopupAction.NonVcsAware, VcsQuickListPopupAction.VcsAware, XmlActionsGroup

public class DefaultActionGroup
extends ActionGroup

A default implementation of ActionGroup. Provides the ability to add children actions and separators between them. In most of the cases you will be using this implementation but note that there are cases (for example "Recent files" dialog) where children are determined on rules different than just positional constraints, that's when you need to implement your own ActionGroup.

See Also:

Constraints, ComputableActionGroup, NonEmptyActionGroup, NonTrivialActionGroup, SmartPopupActionGroup

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.ActionGroup

EMPTY_GROUP

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultActionGroup()
	DefaultActionGroup(AnAction... actions) Creates an action group containing the specified actions.
	DefaultActionGroup(java.util.List<? extends AnAction> actions) Creates an action group containing the specified actions.
	DefaultActionGroup(java.lang.String shortName, boolean popup)
	DefaultActionGroup(java.lang.String name, java.util.List<? extends AnAction> actions)
protected	DefaultActionGroup(java.util.function.Supplier<java.lang.String> shortName, boolean popup)
	DefaultActionGroup(java.util.function.Supplier<java.lang.String> name, java.util.List<? extends AnAction> actions)

Method Summary

Modifier and Type	Method and Description
void	add(AnAction action)
void	add(AnAction action, ActionManager actionManager) Adds the specified action to the tail.
void	add(AnAction action, Constraints constraint) Adds the specified action with the specified constraint.
void	add(AnAction action, Constraints constraint, ActionManager actionManager)
ActionInGroup	addAction(AnAction action)
ActionInGroup	addAction(AnAction action, Constraints constraint)
ActionInGroup	addAction(AnAction action, Constraints constraint, ActionManager actionManager)
void	addAll(ActionGroup group)
void	addAll(AnAction... actions)
void	addAll(java.util.Collection<? extends AnAction> actionList)
void	addAll(java.util.Collection<? extends AnAction> actionList, ActionManager actionManager)
void	addSeparator() Adds a separator to the tail.
void	addSeparator(java.lang.String separatorText)
void	copyFromGroup(DefaultActionGroup other) Copies content from group.
static DefaultActionGroup	createFlatGroup(java.util.function.Supplier<java.lang.String> shortName)
static DefaultActionGroup	createPopupGroup(java.util.function.Supplier<java.lang.String> shortName)
static DefaultActionGroup	createPopupGroupWithEmptyText()
static DefaultActionGroup	createUserDataAwareGroup(java.lang.String templateText) Creates an action group with specified template text.
AnAction []	getChildActionsOrStubs()
AnAction []	getChildren(AnActionEvent e) Returns the children of the group.
AnAction []	getChildren(AnActionEvent e, ActionManager actionManager) Returns group's children in the order determined by constraints.
int	getChildrenCount() Returns the number of contained children (including separators).
int	getModificationStamp()
void	remove(AnAction action) Removes specified action from group.
void	remove(AnAction action, ActionManager actionManager)
void	remove(AnAction action, java.lang.String id)
void	removeAll() Removes all children actions (separators as well) from the group.
boolean	replaceAction(AnAction oldAction, AnAction newAction) Replaces specified action with the a one.

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

actionPerformed, addPropertyChangeListener, canBePerformed, disableIfNoVisibleChildren, firePropertyChange, hideIfNoVisibleChildren, isDumbAware, isPopup, isPopup, isPrimary, removePropertyChangeListener, replace, setPopup

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

Constructor Detail

DefaultActionGroup

public DefaultActionGroup()

DefaultActionGroup

public DefaultActionGroup(AnAction... actions)

Creates an action group containing the specified actions.

Parameters:

actions - the actions to add to the group

DefaultActionGroup

public DefaultActionGroup(java.util.List<? extends AnAction> actions)

Creates an action group containing the specified actions.

Parameters:

actions - the actions to add to the group

DefaultActionGroup

public DefaultActionGroup(java.util.function.Supplier<java.lang.String> name,
                          java.util.List<? extends AnAction> actions)

DefaultActionGroup

public DefaultActionGroup(java.lang.String name,
                          java.util.List<? extends AnAction> actions)

DefaultActionGroup

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

DefaultActionGroup

protected DefaultActionGroup(java.util.function.Supplier<java.lang.String> shortName,
                             boolean popup)

Method Detail

createPopupGroup

public static DefaultActionGroup createPopupGroup(java.util.function.Supplier<java.lang.String> shortName)

createFlatGroup

public static DefaultActionGroup createFlatGroup(java.util.function.Supplier<java.lang.String> shortName)

createPopupGroupWithEmptyText

public static DefaultActionGroup createPopupGroupWithEmptyText()

getModificationStamp

public int getModificationStamp()

add

public final void add(AnAction action,
                      ActionManager actionManager)

Adds the specified action to the tail.

Parameters:

action - Action to be added

actionManager - ActionManager instance

add

public final void add(AnAction action)

addAction

public final ActionInGroup addAction(AnAction action)

addSeparator

public final void addSeparator()

Adds a separator to the tail.

add

public final void add(AnAction action,
                      Constraints constraint)

Adds the specified action with the specified constraint.

Parameters:

action - Action to be added; cannot be null

constraint - Constraint to be used for determining action's position; cannot be null

Throws:

java.lang.IllegalArgumentException - in case when:

action is null

constraint is null

action is already in the group

addAction

public final ActionInGroup addAction(AnAction action,
                                     Constraints constraint)

add

public final void add(AnAction action,
                      Constraints constraint,
                      ActionManager actionManager)

addAction

public final ActionInGroup addAction(AnAction action,
                                     Constraints constraint,
                                     ActionManager actionManager)

remove

public final void remove(AnAction action)

Removes specified action from group.

Parameters:

action - Action to be removed

remove

public final void remove(AnAction action,
                         ActionManager actionManager)

remove

public final void remove(AnAction action,
                         java.lang.String id)

removeAll

public final void removeAll()

Removes all children actions (separators as well) from the group.

replaceAction

public boolean replaceAction(AnAction oldAction,
                             AnAction newAction)

Replaces specified action with the a one.

copyFromGroup

public void copyFromGroup(DefaultActionGroup other)

Copies content from group.

Parameters:

other - group to copy from

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.

getChildren

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

Returns group's children in the order determined by constraints.

Overrides:

getChildren in class ActionGroup

Parameters:

e - not used

Returns:

An array of children actions

getChildrenCount

public final int getChildrenCount()

Returns the number of contained children (including separators).

Returns:

number of children in the group

getChildActionsOrStubs

public final AnAction [] getChildActionsOrStubs()

addAll

public final void addAll(ActionGroup group)

addAll

public final void addAll(java.util.Collection<? extends AnAction> actionList)

addAll

public final void addAll(java.util.Collection<? extends AnAction> actionList,
                         ActionManager actionManager)

addAll

public final void addAll(AnAction... actions)

addSeparator

public void addSeparator(java.lang.String separatorText)

createUserDataAwareGroup

public static DefaultActionGroup createUserDataAwareGroup(java.lang.String templateText)

Creates an action group with specified template text. It is necessary to redefine template text if group contains user specific data such as Project name, file name, etc

Parameters:

templateText - template text which will be used in statistics

Returns:

action group