org.openide.actions.SaveAction Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.openide.actions;
import java.awt.event.ActionEvent;
import java.io.IOException;
import java.util.Collection;
import java.util.LinkedList;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.AbstractAction;
import javax.swing.Action;
import org.netbeans.api.actions.Savable;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;
import org.openide.awt.StatusDisplayer;
import org.openide.cookies.SaveCookie;
import org.openide.nodes.Node;
import org.openide.util.ContextAwareAction;
import org.openide.util.Exceptions;
import org.openide.util.HelpCtx;
import org.openide.util.Lookup;
import org.openide.util.NbBundle;
import org.openide.util.UserQuestionException;
import org.openide.util.actions.CookieAction;
/** Save a one or more objects. Since version 6.20 this handles ANY selection
* instead of EXACTLY_ONE selection.
* @see Savable
* @see SaveCookie
*
* @author Jan Jancura, Petr Hamernik, Ian Formanek, Dafe Simonek
*/
public class SaveAction extends CookieAction {
private static Class dataObject;
private static java.lang.reflect.Method getNodeDelegate;
public SaveAction() {
putValue("noIconInMenu", Boolean.TRUE); //NOI18N
}
protected Class[] cookieClasses() {
return new Class[] { Savable.class };
}
@Override
public Action createContextAwareInstance(Lookup actionContext) {
return new Delegate(this, actionContext);
}
final void performAction(Lookup context) {
Collection cookieList = context.lookupAll(Savable.class);
Collection nodeList = new LinkedList(context.lookupAll(Node.class));
COOKIE: for (Savable savable : cookieList) {
//Determine if the savable belongs to a node in our context
for (Node node : nodeList) {
if (savable.equals(node.getLookup().lookup(Savable.class))) {
performAction(savable, node);
nodeList.remove(node);
continue COOKIE;
}
}
//The savable was not found in any node in our context - save it by itself.
performAction(savable, null);
}
}
protected void performAction(final Node[] activatedNodes) {
for (int i = 0; i < activatedNodes.length; i++) {
Node node = activatedNodes[i];
Savable sc = node.getLookup().lookup(Savable.class);
assert sc != null : "Savable must be present on " + node + ". "
+ "See http://www.netbeans.org/issues/show_bug.cgi?id=68285 for details on overriding " + node.getClass().getName() + ".getCookie correctly.";
// avoid NPE if disabled assertions
if (sc == null) return ;
performAction(sc, node);
}
}
private void performAction(Savable sc, Node n) {
UserQuestionException userEx = null;
for (;;) {
try {
if (userEx == null) {
sc.save();
} else {
userEx.confirmed();
}
StatusDisplayer.getDefault().setStatusText(
NbBundle.getMessage(SaveAction.class, "MSG_saved", getSaveMessage(sc, n))
);
} catch (UserQuestionException ex) {
NotifyDescriptor nd = new NotifyDescriptor.Confirmation(ex.getLocalizedMessage(),
NotifyDescriptor.YES_NO_OPTION);
Object res = DialogDisplayer.getDefault().notify(nd);
if (NotifyDescriptor.OK_OPTION.equals(res)) {
userEx = ex;
continue;
}
} catch (IOException e) {
Exceptions.attachLocalizedMessage(e,
NbBundle.getMessage(SaveAction.class,
"EXC_notsaved",
getSaveMessage(sc, n),
e.getLocalizedMessage ()));
Logger.getLogger (getClass ().getName ()).log (Level.SEVERE, null, e);
}
break;
}
}
@Override
protected boolean asynchronous() {
return false;
}
private String getSaveMessage(Savable sc, Node n) {
if (n == null) {
return sc.toString();
}
if (dataObject == null) {
// read the class
ClassLoader l = Lookup.getDefault().lookup(ClassLoader.class);
if (l == null) {
l = getClass().getClassLoader();
}
try {
dataObject = Class.forName("org.openide.loaders.DataObject", true, l).asSubclass(Node.Cookie.class); // NOI18N
getNodeDelegate = dataObject.getMethod("getNodeDelegate"); // NOI18N
} catch (Exception ex) {
Exceptions.printStackTrace(ex);
}
}
if (getNodeDelegate != null) {
// try to search for a name on the class
Object obj = n.getCookie(dataObject);
if (obj != null) {
try {
n = (Node) getNodeDelegate.invoke(obj, new Object[0]);
} catch (Exception ex) {
Exceptions.printStackTrace(ex);
}
}
}
return n.getDisplayName();
}
protected int mode() {
return MODE_ANY;
}
public String getName() {
return NbBundle.getMessage(SaveAction.class, "Save");
}
public HelpCtx getHelpCtx() {
return new HelpCtx(SaveAction.class);
}
@Override
protected String iconResource() {
return "org/openide/resources/actions/save.png"; // NOI18N
}
private static final class Delegate extends AbstractAction
implements ContextAwareAction {
final SaveAction sa;
final Lookup context;
public Delegate(SaveAction sa, Lookup context) {
this.sa = sa;
this.context = context;
}
public Action createContextAwareInstance(Lookup actionContext) {
return new Delegate(sa, actionContext);
}
@Override
public Object getValue(String key) {
return sa.getValue(key);
}
@Override
public void putValue(String key, Object value) {
sa.putValue(key, value);
}
@Override
public boolean isEnabled() {
return context.lookup(Savable.class) != null;
}
public void actionPerformed(ActionEvent e) {
sa.performAction(context);
}
}
}