/*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.openapi.actionSystem;
import com.intellij.ide.DataManager;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.ui.PlaceProvider;
import org.intellij.lang.annotations.JdkConstants;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.awt.event.InputEvent;
import java.util.HashMap;
import java.util.Map;
/**
* Container for the information necessary to execute or update an {@link AnAction}.
*
* @see AnAction#actionPerformed(AnActionEvent)
* @see AnAction#update(AnActionEvent)
*/
public class AnActionEvent implements PlaceProvider<String> {
private final InputEvent myInputEvent;
@NotNull private final ActionManager myActionManager;
@NotNull private final DataContext myDataContext;
@NotNull private final String myPlace;
@NotNull private final Presentation myPresentation;
@JdkConstants.InputEventMask private final int myModifiers;
private boolean myWorksInInjected;
@NonNls private static final String ourInjectedPrefix = "$injected$.";
private static final Map<String, String> ourInjectedIds = new HashMap<>();
/**
* @throws IllegalArgumentException if <code>dataContext</code> is <code>null</code> or
* <code>place</code> is <code>null</code> or <code>presentation</code> is <code>null</code>
*
* @see ActionManager#getInstance()
*/
public AnActionEvent(InputEvent inputEvent,
@NotNull DataContext dataContext,
@NotNull @NonNls String place,
@NotNull Presentation presentation,
@NotNull ActionManager actionManager,
@JdkConstants.InputEventMask int modifiers) {
// TODO[vova,anton] make this constructor package-private. No one is allowed to create AnActionEvents
myInputEvent = inputEvent;
myActionManager = actionManager;
myDataContext = dataContext;
myPlace = place;
myPresentation = presentation;
myModifiers = modifiers;
}
@Deprecated
@NotNull
public static AnActionEvent createFromInputEvent(@NotNull AnAction action, @Nullable InputEvent event, @NotNull String place) {
DataContext context = event == null ? DataManager.getInstance().getDataContext() : DataManager.getInstance().getDataContext(event.getComponent());
return createFromAnAction(action, event, place, context);
}
@NotNull
public static AnActionEvent createFromAnAction(@NotNull AnAction action,
@Nullable InputEvent event,
@NotNull String place,
@NotNull DataContext dataContext) {
int modifiers = event == null ? 0 : event.getModifiers();
Presentation presentation = action.getTemplatePresentation().clone();
AnActionEvent anActionEvent = new AnActionEvent(event, dataContext, place, presentation, ActionManager.getInstance(), modifiers);
anActionEvent.setInjectedContext(action.isInInjectedContext());
return anActionEvent;
}
@NotNull
public static AnActionEvent createFromDataContext(@NotNull String place,
@Nullable Presentation presentation,
@NotNull DataContext dataContext) {
return new AnActionEvent(null, dataContext, place, presentation == null ? new Presentation() : presentation, ActionManager.getInstance(), 0);
}
@NotNull
public static AnActionEvent createFromInputEvent(@Nullable InputEvent event,
@NotNull String place,
@NotNull Presentation presentation,
@NotNull DataContext dataContext) {
return new AnActionEvent(event, dataContext, place, presentation, ActionManager.getInstance(),
event == null ? 0 : event.getModifiers());
}
/**
* Returns the <code>InputEvent</code> which causes invocation of the action. It might be
* <code>KeyEvent</code>, <code>MouseEvent</code>.
* @return the <code>InputEvent</code> instance.
*/
public InputEvent getInputEvent() {
return myInputEvent;
}
/**
* @return Project from the context of this event.
*/
@Nullable
public Project getProject() {
return getData(CommonDataKeys.PROJECT);
}
@NonNls
public static String injectedId(String dataId) {
synchronized(ourInjectedIds) {
String injected = ourInjectedIds.get(dataId);
if (injected == null) {
injected = ourInjectedPrefix + dataId;
ourInjectedIds.put(dataId, injected);
}
return injected;
}
}
@NonNls
public static String uninjectedId(@NotNull String dataId) {
return StringUtil.trimStart(dataId, ourInjectedPrefix);
}
public static DataContext getInjectedDataContext(final DataContext context) {
return new DataContextWrapper(context) {
@Nullable
@Override
public Object getData(@NonNls String dataId) {
Object injected = super.getData(injectedId(dataId));
if (injected != null) return injected;
return super.getData(dataId);
}
};
}
/**
* Returns the context which allows to retrieve information about the state of IDEA related to
* the action invocation (active editor, selection and so on).
*
* @return the data context instance.
*/
@NotNull
public DataContext getDataContext() {
return myWorksInInjected ? getInjectedDataContext(myDataContext) : myDataContext;
}
@Nullable
public <T> T getData(@NotNull DataKey<T> key) {
return getDataContext().getData(key);
}
/**
* Returns not null data by a data key. This method assumes that data has been checked for null in AnAction#update method.
*<br/><br/>
* Example of proper usage:
*
* <pre>
*
* 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);
* }
* }
*
* </pre>
*/
@NotNull
public <T> T getRequiredData(@NotNull DataKey<T> key) {
T data = getData(key);
assert data != null;
return data;
}
/**
* Returns the identifier of the place in the IDEA user interface from where the action is invoked
* or updated.
*
* @return the place identifier
* @see ActionPlaces
*/
@Override
@NotNull
public String getPlace() {
return myPlace;
}
/**
* Returns the presentation which represents the action in the place from where it is invoked
* or updated.
*
* @return the presentation instance.
*/
@NotNull
public Presentation getPresentation() {
return myPresentation;
}
/**
* Returns the modifier keys held down during this action event.
* @return the modifier keys.
*/
@JdkConstants.InputEventMask
public int getModifiers() {
return myModifiers;
}
@NotNull
public ActionManager getActionManager() {
return myActionManager;
}
public void setInjectedContext(boolean worksInInjected) {
myWorksInInjected = worksInInjected;
}
public boolean isInInjectedContext() {
return myWorksInInjected;
}
public void accept(@NotNull AnActionEventVisitor visitor) {
visitor.visitEvent(this);
}
}