Package com.intellij.openapi.actionSystem

Class EmptyAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.EmptyAction

All Implemented Interfaces:

PossiblyDumbAware

public final class EmptyAction
extends AnAction

This class purpose is to reserve action-id in a plugin.xml so the action appears in Keymap. Then Keymap assignments can be used for non-registered actions created on runtime.

Another usage is to override (hide) already registered actions by means of plugin.xml, see EmptyActionGroup as well.

See Also:

EmptyActionGroup

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmptyAction.DelegatingCompactActionGroup
static class	EmptyAction.MyDelegatingAction
static class	EmptyAction.MyDelegatingActionGroup

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
EmptyAction()
EmptyAction(boolean enabled)
EmptyAction(java.lang.String text, java.lang.String description, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
static AnAction	createEmptyAction(java.lang.String name, javax.swing.Icon icon, boolean alwaysEnabled)
static void	registerActionShortcuts(javax.swing.JComponent component, javax.swing.JComponent fromComponent)
static AnAction	registerWithShortcutSet(java.lang.String id, ShortcutSet shortcutSet, javax.swing.JComponent component) Registers global action on a component with a custom shortcut set.
static void	setupAction(AnAction action, java.lang.String id, javax.swing.JComponent component)
void	update(AnActionEvent e) Updates the state of the action.
static AnAction	wrap(AnAction action) Creates proxy action

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

EmptyAction

public EmptyAction()

EmptyAction

public EmptyAction(boolean enabled)

EmptyAction

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

Method Detail

createEmptyAction

public static AnAction createEmptyAction(java.lang.String name,
                                         javax.swing.Icon icon,
                                         boolean alwaysEnabled)

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

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

setupAction

public static void setupAction(AnAction action,
                               java.lang.String id,
                               javax.swing.JComponent component)

registerActionShortcuts

public static void registerActionShortcuts(javax.swing.JComponent component,
                                           javax.swing.JComponent fromComponent)

registerWithShortcutSet

public static AnAction registerWithShortcutSet(java.lang.String id,
                                               ShortcutSet shortcutSet,
                                               javax.swing.JComponent component)

Registers global action on a component with a custom shortcut set.

ActionManager.getInstance().getAction(id).registerCustomShortcutSet(shortcutSet, component) shouldn't be used directly, because it will erase shortcuts, assigned to this action in keymap.

wrap

public static AnAction wrap(AnAction action)

Creates proxy action

It allows to alter template presentation and shortcut set without affecting original action,