Package com.intellij.openapi.actionSystem.impl

Class ActionManagerImpl

java.lang.Object

com.intellij.openapi.actionSystem.ActionManager

com.intellij.openapi.actionSystem.ex.ActionManagerEx

com.intellij.openapi.actionSystem.impl.ActionManagerImpl

All Implemented Interfaces:

Disposable

public final class ActionManagerImpl
extends ActionManagerEx
implements Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
void	addActionPopup(java.lang.Object menu)
void	addActionPopupMenuListener(ActionPopupMenuListener listener, Disposable parentDisposable) Allows to receive notifications when popup menus created from action groups are shown and hidden.
void	addAnActionListener(AnActionListener listener)
void	addTimerListener(int delay, TimerListener listener)
void	addTransparentTimerListener(int delay, TimerListener listener)
boolean	canUnloadActions(IdeaPluginDescriptor pluginDescriptor)
ActionPopupMenu	createActionPopupMenu(java.lang.String place, ActionGroup group) Factory method that creates an ActionPopupMenu from the specified group.
ActionPopupMenu	createActionPopupMenu(java.lang.String place, ActionGroup group, PresentationFactory presentationFactory)
ActionToolbar	createActionToolbar(java.lang.String place, ActionGroup group, boolean horizontal) Factory method that creates an ActionToolbar from the specified group.
ActionToolbar	createActionToolbar(java.lang.String place, ActionGroup group, boolean horizontal, boolean decorateButtons)
javax.swing.JComponent	createButtonToolbar(java.lang.String actionPlace, ActionGroup messageActionGroup) Creates a panel with buttons which invoke actions from the specified action group.
void	dispose() Usually not invoked directly, see class javadoc.
void	fireAfterActionPerformed(AnAction action, DataContext dataContext, AnActionEvent event)
void	fireBeforeActionPerformed(AnAction action, DataContext dataContext, AnActionEvent event)
void	fireBeforeEditorTyping(char c, DataContext dataContext)
AnAction	getAction(java.lang.String id) Returns action associated with the specified actionId.
java.util.Set<java.lang.String>	getActionIds()
java.lang.String []	getActionIds(java.lang.String idPrefix) Returns the list of all registered action IDs with the specified prefix.
AnAction	getActionOrStub(java.lang.String id)
AnAction	getBaseAction(OverridingAction overridingAction) Returns the action overridden by the specified overriding action (with overrides="true" in plugin.xml).
java.lang.String	getId(AnAction action) Returns actionId associated with the specified action.
KeyboardShortcut	getKeyboardShortcut(java.lang.String actionId)
java.lang.String	getLastPreformedActionId() For logging purposes
DefaultActionGroup	getParentGroup(java.lang.String groupId, java.lang.String actionName, PluginId pluginId)
java.lang.String []	getPluginActions(PluginId pluginName)
java.lang.String	getPrevPreformedActionId()
java.util.Comparator<java.lang.String>	getRegistrationOrderComparator() Comparator compares action ids (String) on order of action registration.
boolean	isActionPopupStackEmpty()
boolean	isGroup(java.lang.String actionId) Checks if the specified action ID represents an action group and not an individual action.
boolean	isToolWindowContextMenuVisible()
boolean	isTransparentOnlyActionsUpdateNow()
void	preloadActions(ProgressIndicator indicator)
void	queueActionPerformedEvent(AnAction action, DataContext context, AnActionEvent event)
void	registerAction(java.lang.String actionId, AnAction action) Registers the specified action with the specified id.
void	registerAction(java.lang.String actionId, AnAction action, PluginId pluginId) Registers the specified action with the specified id.
void	registerAction(java.lang.String actionId, AnAction action, PluginId pluginId, java.lang.String projectType)
void	registerPluginActions(IdeaPluginDescriptorImpl plugin, java.util.List<Element> actionDescriptionElements, boolean initialStartup)
void	removeAnActionListener(AnActionListener listener)
void	removeTimerListener(TimerListener listener)
void	removeTransparentTimerListener(TimerListener listener)
void	replaceAction(java.lang.String actionId, AnAction newAction) Replaces an existing action with ID actionId by newAction.
ActionCallback	tryToExecute(AnAction action, java.awt.event.InputEvent inputEvent, java.awt.Component contextComponent, java.lang.String place, boolean now)
void	unloadActions(IdeaPluginDescriptor pluginDescriptor)
void	unregisterAction(java.lang.String actionId) Unregisters the action with the specified actionId.

Methods inherited from class com.intellij.openapi.actionSystem.ex.ActionManagerEx

fireBeforeActionPerformed, getInstanceEx, getKeyStroke

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

addAnActionListener, getComponentName, getInstance

Methods inherited from class java.lang.Object

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

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

addTimerListener

public void addTimerListener(int delay,
                             TimerListener listener)

Specified by:

addTimerListener in class ActionManager

removeTimerListener

public void removeTimerListener(TimerListener listener)

Specified by:

removeTimerListener in class ActionManager

addTransparentTimerListener

public void addTransparentTimerListener(int delay,
                                        TimerListener listener)

Specified by:

addTransparentTimerListener in class ActionManager

removeTransparentTimerListener

public void removeTransparentTimerListener(TimerListener listener)

Specified by:

removeTransparentTimerListener in class ActionManager

createActionPopupMenu

public ActionPopupMenu createActionPopupMenu(java.lang.String place,
                                             ActionGroup group,
                                             PresentationFactory presentationFactory)

createActionPopupMenu

public ActionPopupMenu createActionPopupMenu(java.lang.String place,
                                             ActionGroup group)

Description copied from class: ActionManager

Factory method that creates an ActionPopupMenu from the specified group. The specified place is associated with the created popup.

Specified by:

createActionPopupMenu in class ActionManager

Parameters:

place - Determines the place that will be set for AnActionEvent passed when an action from the group is either performed or updated See ActionPlaces

group - Group from which the actions for the menu are taken.

Returns:

An instance of ActionPopupMenu

createActionToolbar

public ActionToolbar createActionToolbar(java.lang.String place,
                                         ActionGroup group,
                                         boolean horizontal)

Description copied from class: ActionManager

Factory method that creates an ActionToolbar from the specified group. The specified place is associated with the created toolbar.

Specified by:

createActionToolbar in class ActionManager

Parameters:

place - Determines the place that will be set for AnActionEvent passed when an action from the group is either performed or updated. See ActionPlaces

group - Group from which the actions for the toolbar are taken.

horizontal - The orientation of the toolbar (true - horizontal, false - vertical)

Returns:

An instance of ActionToolbar

createActionToolbar

public ActionToolbar createActionToolbar(java.lang.String place,
                                         ActionGroup group,
                                         boolean horizontal,
                                         boolean decorateButtons)

Specified by:

createActionToolbar in class ActionManagerEx

registerPluginActions

public void registerPluginActions(IdeaPluginDescriptorImpl plugin,
                                  java.util.List<Element> actionDescriptionElements,
                                  boolean initialStartup)

getAction

public AnAction getAction(java.lang.String id)

Description copied from class: ActionManager

Returns action associated with the specified actionId.

Specified by:

getAction in class ActionManager

Parameters:

id - Id of the registered action

Returns:

Action associated with the specified actionId, null if there is no actions associated with the specified actionId

See Also:

IdeActions

getId

public java.lang.String getId(AnAction action)

Description copied from class: ActionManager

Returns actionId associated with the specified action.

Specified by:

getId in class ActionManager

Returns:

id associated with the specified action, null if action is not registered

getActionIds

public java.lang.String [] getActionIds(java.lang.String idPrefix)

Description copied from class: ActionManager

Returns the list of all registered action IDs with the specified prefix.

Specified by:

getActionIds in class ActionManager

Returns:

all action ids which have the specified prefix.

isGroup

public boolean isGroup(java.lang.String actionId)

Description copied from class: ActionManager

Checks if the specified action ID represents an action group and not an individual action. Calling this method does not cause instantiation of a specific action class corresponding to the action ID.

Specified by:

isGroup in class ActionManager

Parameters:

actionId - the ID to check.

Returns:

true if the ID represents an action group, false otherwise.

createButtonToolbar

public javax.swing.JComponent createButtonToolbar(java.lang.String actionPlace,
                                                  ActionGroup messageActionGroup)

Description copied from class: ActionManager

Creates a panel with buttons which invoke actions from the specified action group.

Specified by:

createButtonToolbar in class ActionManager

Parameters:

actionPlace - the place where the panel will be used (see ActionPlaces).

messageActionGroup - the action group from which the toolbar is created.

Returns:

the created panel.

getActionOrStub

public AnAction getActionOrStub(java.lang.String id)

Specified by:

getActionOrStub in class ActionManager

getParentGroup

public DefaultActionGroup getParentGroup(java.lang.String groupId,
                                         java.lang.String actionName,
                                         PluginId pluginId)

canUnloadActions

public boolean canUnloadActions(IdeaPluginDescriptor pluginDescriptor)

unloadActions

public void unloadActions(IdeaPluginDescriptor pluginDescriptor)

registerAction

public void registerAction(java.lang.String actionId,
                           AnAction action,
                           PluginId pluginId)

Description copied from class: ActionManager

Registers the specified action with the specified id.

Specified by:

registerAction in class ActionManager

Parameters:

actionId - Id to associate with the action

action - Action to register

pluginId - Identifier of the plugin owning the action. Used to show the actions in the correct place under the "Plugins" node in the "Keymap" settings pane and similar dialogs.

registerAction

public void registerAction(java.lang.String actionId,
                           AnAction action,
                           PluginId pluginId,
                           java.lang.String projectType)

registerAction

public void registerAction(java.lang.String actionId,
                           AnAction action)

Description copied from class: ActionManager

Registers the specified action with the specified id. Note that the IDE's keymaps processing deals only with registered actions.

Specified by:

registerAction in class ActionManager

Parameters:

actionId - Id to associate with the action

action - Action to register

unregisterAction

public void unregisterAction(java.lang.String actionId)

Description copied from class: ActionManager

Unregisters the action with the specified actionId. If you're going to register another action with the same ID, use ActionManager.replaceAction(String, AnAction) instead, otherwise references in action groups may not be replaced.

Specified by:

unregisterAction in class ActionManager

Parameters:

actionId - Id of the action to be unregistered

getRegistrationOrderComparator

public java.util.Comparator<java.lang.String> getRegistrationOrderComparator()

Description copied from class: ActionManagerEx

Comparator compares action ids (String) on order of action registration.

Specified by:

getRegistrationOrderComparator in class ActionManagerEx

Returns:

a negative integer if action that corresponds to the first id was registered earlier than the action that corresponds to the second id; zero if both ids are equal; a positive number otherwise.

getPluginActions

public java.lang.String [] getPluginActions(PluginId pluginName)

Specified by:

getPluginActions in class ActionManagerEx

addActionPopup

public void addActionPopup(java.lang.Object menu)

queueActionPerformedEvent

public void queueActionPerformedEvent(AnAction action,
                                      DataContext context,
                                      AnActionEvent event)

Specified by:

queueActionPerformedEvent in class ActionManagerEx

isToolWindowContextMenuVisible

public boolean isToolWindowContextMenuVisible()

isActionPopupStackEmpty

public boolean isActionPopupStackEmpty()

Specified by:

isActionPopupStackEmpty in class ActionManagerEx

isTransparentOnlyActionsUpdateNow

public boolean isTransparentOnlyActionsUpdateNow()

Specified by:

isTransparentOnlyActionsUpdateNow in class ActionManagerEx

addActionPopupMenuListener

public void addActionPopupMenuListener(ActionPopupMenuListener listener,
                                       Disposable parentDisposable)

Description copied from class: ActionManagerEx

Allows to receive notifications when popup menus created from action groups are shown and hidden.

Specified by:

addActionPopupMenuListener in class ActionManagerEx

replaceAction

public void replaceAction(java.lang.String actionId,
                          AnAction newAction)

Description copied from class: ActionManager

Replaces an existing action with ID actionId by newAction. Using this method for changing behavior of a platform action is not recommended, extract an extension point in the action implementation instead.

Specified by:

replaceAction in class ActionManager

getBaseAction

public AnAction getBaseAction(OverridingAction overridingAction)

Returns the action overridden by the specified overriding action (with overrides="true" in plugin.xml).

addAnActionListener

public void addAnActionListener(AnActionListener listener)

Specified by:

addAnActionListener in class ActionManager

removeAnActionListener

public void removeAnActionListener(AnActionListener listener)

Specified by:

removeAnActionListener in class ActionManager

fireBeforeActionPerformed

public void fireBeforeActionPerformed(AnAction action,
                                      DataContext dataContext,
                                      AnActionEvent event)

Specified by:

fireBeforeActionPerformed in class ActionManagerEx

fireAfterActionPerformed

public void fireAfterActionPerformed(AnAction action,
                                     DataContext dataContext,
                                     AnActionEvent event)

Specified by:

fireAfterActionPerformed in class ActionManagerEx

getKeyboardShortcut

public KeyboardShortcut getKeyboardShortcut(java.lang.String actionId)

Specified by:

getKeyboardShortcut in class ActionManager

fireBeforeEditorTyping

public void fireBeforeEditorTyping(char c,
                                   DataContext dataContext)

Specified by:

fireBeforeEditorTyping in class ActionManagerEx

getLastPreformedActionId

public java.lang.String getLastPreformedActionId()

Description copied from class: ActionManagerEx

For logging purposes

Specified by:

getLastPreformedActionId in class ActionManagerEx

getPrevPreformedActionId

public java.lang.String getPrevPreformedActionId()

Specified by:

getPrevPreformedActionId in class ActionManagerEx

getActionIds

public java.util.Set<java.lang.String> getActionIds()

preloadActions

public void preloadActions(ProgressIndicator indicator)

tryToExecute

public ActionCallback tryToExecute(AnAction action,
                                   java.awt.event.InputEvent inputEvent,
                                   java.awt.Component contextComponent,
                                   java.lang.String place,
                                   boolean now)

Specified by:

tryToExecute in class ActionManager