Package com.intellij.openapi.actionSystem

Class AnActionEvent

java.lang.Object

com.intellij.openapi.actionSystem.AnActionEvent

All Implemented Interfaces:

PlaceProvider<java.lang.String>

Direct Known Subclasses:

AnActionButton.AnActionEventWrapper, GestureActionEvent

public class AnActionEvent
extends java.lang.Object
implements PlaceProvider<java.lang.String>

Container for the information necessary to execute or update an AnAction.

See Also:

AnAction.actionPerformed(AnActionEvent), AnAction.update(AnActionEvent)

Constructor Summary

Constructors

Constructor and Description
AnActionEvent(java.awt.event.InputEvent inputEvent, DataContext dataContext, java.lang.String place, Presentation presentation, ActionManager actionManager, int modifiers)
AnActionEvent(java.awt.event.InputEvent inputEvent, DataContext dataContext, java.lang.String place, Presentation presentation, ActionManager actionManager, int modifiers, boolean isContextMenuAction, boolean isActionToolbar)

Method Summary

Modifier and Type	Method and Description
void	accept(AnActionEventVisitor visitor)
static AnActionEvent	createFromAnAction(AnAction action, java.awt.event.InputEvent event, java.lang.String place, DataContext dataContext)
static AnActionEvent	createFromDataContext(java.lang.String place, Presentation presentation, DataContext dataContext)
static AnActionEvent	createFromInputEvent(AnAction action, java.awt.event.InputEvent event, java.lang.String place) Deprecated. use createFromInputEvent(InputEvent, String, Presentation, DataContext, boolean, boolean)
static AnActionEvent	createFromInputEvent(java.awt.event.InputEvent event, java.lang.String place, Presentation presentation, DataContext dataContext)
static AnActionEvent	createFromInputEvent(java.awt.event.InputEvent event, java.lang.String place, Presentation presentation, DataContext dataContext, boolean isContextMenuAction, boolean isToolbarAction)
ActionManager	getActionManager()
<T> T	getData(DataKey<T> key)
DataContext	getDataContext() Returns the context which allows to retrieve information about the state of IDE related to the action invocation (active editor, selection and so on).
static DataContext	getInjectedDataContext(DataContext context)
java.awt.event.InputEvent	getInputEvent() Returns the InputEvent which causes invocation of the action.
int	getModifiers() Returns the modifier keys held down during this action event.
java.lang.String	getPlace() Returns the identifier of the place in the IDE user interface from where the action is invoked or updated.
Presentation	getPresentation() Returns the presentation which represents the action in the place from where it is invoked or updated.
Project	getProject()
<T> T	getRequiredData(DataKey<T> key) Returns not null data by a data key.
static java.lang.String	injectedId(java.lang.String dataId)
boolean	isFromActionToolbar()
boolean	isFromContextMenu() Deprecated. This method returns true for both main menu and context menu invocations. Use ActionPlaces.isPopupPlace(String) instead to get results only from context menus.
boolean	isInInjectedContext()
void	setInjectedContext(boolean worksInInjected)
static java.lang.String	uninjectedId(java.lang.String dataId)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnActionEvent

public AnActionEvent(java.awt.event.InputEvent inputEvent,
                     DataContext dataContext,
                     java.lang.String place,
                     Presentation presentation,
                     ActionManager actionManager,
                     int modifiers)

Throws:

java.lang.IllegalArgumentException - if dataContext is null or place is null or presentation is null

See Also:

ActionManager.getInstance()

AnActionEvent

public AnActionEvent(java.awt.event.InputEvent inputEvent,
                     DataContext dataContext,
                     java.lang.String place,
                     Presentation presentation,
                     ActionManager actionManager,
                     int modifiers,
                     boolean isContextMenuAction,
                     boolean isActionToolbar)

Throws:

java.lang.IllegalArgumentException - if dataContext is null or place is null or presentation is null

See Also:

ActionManager.getInstance()

Method Detail

createFromInputEvent

@Deprecated
public static AnActionEvent createFromInputEvent(AnAction action,
                                                 java.awt.event.InputEvent event,
                                                 java.lang.String place)

Deprecated. use createFromInputEvent(InputEvent, String, Presentation, DataContext, boolean, boolean)

createFromAnAction

public static AnActionEvent createFromAnAction(AnAction action,
                                               java.awt.event.InputEvent event,
                                               java.lang.String place,
                                               DataContext dataContext)

createFromDataContext

public static AnActionEvent createFromDataContext(java.lang.String place,
                                                  Presentation presentation,
                                                  DataContext dataContext)

createFromInputEvent

public static AnActionEvent createFromInputEvent(java.awt.event.InputEvent event,
                                                 java.lang.String place,
                                                 Presentation presentation,
                                                 DataContext dataContext)

createFromInputEvent

public static AnActionEvent createFromInputEvent(java.awt.event.InputEvent event,
                                                 java.lang.String place,
                                                 Presentation presentation,
                                                 DataContext dataContext,
                                                 boolean isContextMenuAction,
                                                 boolean isToolbarAction)

getInputEvent

public java.awt.event.InputEvent getInputEvent()

Returns the InputEvent which causes invocation of the action. It might be KeyEvent, MouseEvent.

Returns:

the InputEvent instance.

getProject

public Project getProject()

Returns:

Project from the context of this event.

injectedId

public static java.lang.String injectedId(java.lang.String dataId)

uninjectedId

public static java.lang.String uninjectedId(java.lang.String dataId)

getInjectedDataContext

public static DataContext getInjectedDataContext(DataContext context)

getDataContext

public DataContext getDataContext()

Returns the context which allows to retrieve information about the state of IDE related to the action invocation (active editor, selection and so on).

Returns:

the data context instance.

getData

public <T> T getData(DataKey<T> key)

getRequiredData

public <T> T getRequiredData(DataKey<T> key)

Returns not null data by a data key. This method assumes that data has been checked for null in AnAction#update method.

Example of proper usage:

 public class MyAction extends AnAction {
   public void update(AnActionEvent e) {
     // perform action if and only if EDITOR != null
     boolean enabled = e.getData(CommonDataKeys.EDITOR) != null;
     e.getPresentation.setEnabled(enabled);
   }

   public void actionPerformed(AnActionEvent e) {
     // if we're here then EDITOR != null
     Document doc = e.getRequiredData(CommonDataKeys.EDITOR).getDocument();
     doSomething(doc);
   }
 }

 

getPlace

public java.lang.String getPlace()

Returns the identifier of the place in the IDE user interface from where the action is invoked or updated.

Specified by:

getPlace in interface PlaceProvider<java.lang.String>

Returns:

the place identifier

See Also:

ActionPlaces

isFromActionToolbar

public boolean isFromActionToolbar()

isFromContextMenu

@Deprecated
public boolean isFromContextMenu()

Deprecated. This method returns true for both main menu and context menu invocations. Use ActionPlaces.isPopupPlace(String) instead to get results only from context menus.

getPresentation

public Presentation getPresentation()

Returns the presentation which represents the action in the place from where it is invoked or updated.

Returns:

the presentation instance.

getModifiers

public int getModifiers()

Returns the modifier keys held down during this action event.

Returns:

the modifier keys.

getActionManager

public ActionManager getActionManager()

setInjectedContext

public void setInjectedContext(boolean worksInInjected)

isInInjectedContext

public boolean isInInjectedContext()

accept

public void accept(AnActionEventVisitor visitor)