org.openide.util.actions.ActionInvoker Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.openide.util.actions;
import java.awt.event.ActionEvent;
import java.beans.PropertyChangeListener;
import javax.swing.Action;
import org.openide.util.Lookup;
import org.openide.util.RequestProcessor;
import org.openide.util.actions.SystemAction;
import org.openide.util.lookup.ServiceProvider;
/** A mixture of a utility class allowing to invoke actions and also a
*
* code injection mechanism to allow overall system to be aware of invoked
* actions.
*
* Callers shall use the {@link #invokeAction(javax.swing.Action, java.awt.event.ActionEvent, boolean, java.lang.Runnable)}
* method.
*
* Implementors register an implementation of this class via {@link ServiceProvider}
* annotation.
*
* @since 8.1
*/
public abstract class ActionInvoker extends Object {
/** thread to run actions in */
private static final RequestProcessor RP = new RequestProcessor("Module-Actions", Integer.MAX_VALUE); // NOI18N
/** Subclass constructor. */
protected ActionInvoker() {}
/** An infrastructure method that handles invocation of an an action.
* @param action the action to invoke
* @param ev the event used during invocation
*/
protected abstract void invokeAction(Action action, ActionEvent ev);
/** Invokes the action in the currently registered ActionsBridge.
*
* @param action the action that is to be invoked
* @param ev the event used to invoke the action
* @param asynchronous shall the execution be performed in a background thread?
* @param invoker the actual code that shall be performed to "run" the action. If null, action.actionPerformed(ev) will be called
*/
public static void invokeAction(Action action, ActionEvent ev, boolean asynchronous, final Runnable invoker) {
ActionRunnable r = new ActionRunnable(ev, action, asynchronous) {
@Override
protected void run() {
if (invoker == null) {
action.actionPerformed(ev);
} else {
invoker.run();
}
}
};
doPerformAction(action, r);
}
private static void doPerformAction(Action action, final ActionInvoker.ActionRunnable r) {
assert java.awt.EventQueue.isDispatchThread() : "Action " + action.getClass().getName() +
" may not be invoked from the thread " + Thread.currentThread().getName() +
", only the event queue: http://www.netbeans.org/download/4_1/javadoc/OpenAPIs/apichanges.html#actions-event-thread";
if (r.async && !r.needsToBeSynchronous()) {
Runnable r2 = new Runnable() {
public void run() {
r.doRun();
}
};
RP.post(r2);
} else {
r.run();
}
}
/** Special class that can be passed to invokeAction and delegates
* to correct values
*/
private static abstract class ActionRunnable implements Action {
final ActionEvent ev;
final Action action;
final boolean async;
public ActionRunnable(ActionEvent ev, SystemAction action, boolean async) {
this(ev, (Action)action, async);
}
public ActionRunnable(ActionEvent ev, Action action, boolean async) {
this.ev = ev;
this.action = action;
this.async = async;
}
public static ActionRunnable create(ActionEvent ev, Action a, boolean async) {
return new ActionRunnable(ev, a, async) {
@Override
protected void run() {
action.actionPerformed(ev);
}
};
}
public final boolean needsToBeSynchronous() {
return "waitFinished".equals(ev.getActionCommand()); // NOI18N
}
public final void doRun() {
ActionInvoker bridge = Lookup.getDefault().lookup(ActionInvoker.class);
if (bridge != null) {
bridge.invokeAction (this, ev);
} else {
this.actionPerformed(ev);
}
}
protected abstract void run();
public final void actionPerformed(ActionEvent e) {
run();
}
public final void addPropertyChangeListener(PropertyChangeListener listener) {
throw new UnsupportedOperationException();
}
public final Object getValue(String key) {
return action.getValue(key);
}
public final boolean isEnabled() {
return action.isEnabled();
}
public final void putValue(String key, Object value) {
throw new UnsupportedOperationException();
}
public final void removePropertyChangeListener(PropertyChangeListener listener) {
throw new UnsupportedOperationException();
}
public final void setEnabled(boolean b) {
throw new UnsupportedOperationException();
}
}
// end of ActionRunnable
}