UndoAction.java

/*FreeMind - A Program for creating and viewing Mindmaps
 *Copyright (C) 2000-2004  Joerg Mueller, Daniel Polansky, Christian Foltin and others.
 *
 *See COPYING for Details
 *
 *This program is free software; you can redistribute it and/or
 *modify it under the terms of the GNU General Public License
 *as published by the Free Software Foundation; either version 2
 *of the License, or (at your option) any later version.
 *
 *This program is distributed in the hope that it will be useful,
 *but WITHOUT ANY WARRANTY; without even the implied warranty of
 *MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *GNU General Public License for more details.
 *
 *You should have received a copy of the GNU General Public License
 *along with this program; if not, write to the Free Software
 *Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Created on 20.09.2004
 */
/*$Id: UndoAction.java,v 1.1.2.2.2.4 2006/11/26 10:20:44 dpolivaev Exp $*/

package freemind.modes.mindmapmode.actions;

import java.awt.EventQueue;
import java.awt.event.ActionEvent;
import java.util.Iterator;
import java.util.Vector;
import java.util.logging.Logger;

import javax.swing.Icon;
import javax.swing.ImageIcon;

import freemind.controller.actions.generated.instance.CompoundAction;
import freemind.controller.actions.generated.instance.XmlAction;
import freemind.main.Tools;
import freemind.modes.mindmapmode.MindMapController;
import freemind.modes.mindmapmode.actions.xml.AbstractXmlAction;
import freemind.modes.mindmapmode.actions.xml.ActionPair;

public class UndoAction extends AbstractXmlAction {

	private MindMapController controller;
	private boolean isUndoAction;
	protected Vector actionPairList = new Vector();
	private long timeOfLastAdd = 0;
	private boolean actionFrameStarted = false;
	private static final long TIME_TO_BEGIN_NEW_ACTION = 100;
	protected static Logger logger;

	public UndoAction(MindMapController controller) {
		this(controller, controller.getText("undo"), new ImageIcon(
				controller.getResource("images/undo.png")), controller);
		this.controller = controller;
		if (logger == null) {
			logger = controller.getFrame()
					.getLogger(this.getClass().toString());
		}
	}

	protected UndoAction(MindMapController adapter, String text, Icon icon,
			MindMapController mode) {
		super(text, icon, mode);
		this.controller = adapter;
		setEnabled(false);
		isUndoAction = false;
	}

	/**
     */
	public boolean isUndoAction() {
		return isUndoAction;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * freemind.controller.actions.AbstractXmlAction#xmlActionPerformed(java
	 * .awt.event.ActionEvent)
	 */
	protected void xmlActionPerformed(ActionEvent arg0) {
		if (actionPairList.size() > 0) {
			ActionPair pair = (ActionPair) actionPairList.get(0);
			informUndoPartner(pair);
			actionPairList.remove(0);
			undoDoAction(pair);
		}
		if (actionPairList.size() == 0) {
			// disable undo
			this.setEnabled(false);
		}
	}

	/**
     */
	protected void informUndoPartner(ActionPair pair) {
		this.controller.redo.add(pair.reverse());
		this.controller.redo.setEnabled(true);
	}

	protected void undoDoAction(ActionPair pair) {
		logger.info("Undo, doing: " + Tools.printXmlAction(pair.getUndoAction()));
		logger.info("Redo, would: " + Tools.printXmlAction(pair.getDoAction()));
		isUndoAction = true;
		this.controller.doTransaction("Undo",
				new ActionPair(pair.getUndoAction(), pair.getDoAction()));
		isUndoAction = false;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see javax.swing.Action#setEnabled(boolean)
	 */
	public void setEnabled(boolean arg0) {
		if (arg0)
			super.setEnabled(actionPairList.size() != 0);
		else
			super.setEnabled(false);
	}

	public void add(ActionPair pair) {
		XmlAction dcDo = Tools.deepCopy(pair.getDoAction());
		XmlAction dcUndo = Tools.deepCopy(pair.getUndoAction());
		long currentTime = System.currentTimeMillis();
		if ((actionPairList.size() > 0)
				&& (actionFrameStarted || currentTime - timeOfLastAdd < TIME_TO_BEGIN_NEW_ACTION)) {
			// the actions are gathered in one compound action.
			ActionPair firstPair = (ActionPair) actionPairList.get(0);
			CompoundAction action;
			CompoundAction remedia;
			if (!(firstPair.getDoAction() instanceof CompoundAction)
					|| !(firstPair.getUndoAction() instanceof CompoundAction)) {
				action = new CompoundAction();
				action.addChoice(firstPair.getDoAction());
				remedia = new CompoundAction();
				remedia.addChoice(firstPair.getUndoAction());
				actionPairList.remove(0);
				actionPairList.add(0, new ActionPair(action, remedia));
				firstPair = (ActionPair) actionPairList.get(0);
			} else {
				action = (CompoundAction) firstPair.getDoAction();
				remedia = (CompoundAction) firstPair.getUndoAction();
			}
			action.addChoice(dcDo);
			remedia.addAtChoice(0, dcUndo);
		} else {
			ActionPair storagePair = new ActionPair(dcDo, dcUndo);
			actionPairList.add(0, storagePair);
			// and cut vector, if bigger than given size:
			int maxEntries = 100;
			try {
				maxEntries = new Integer(controller.getFrame().getProperty(
						"undo_levels")).intValue();
			} catch (NumberFormatException e) {
				freemind.main.Resources.getInstance().logException(e);
			}
			while (actionPairList.size() > maxEntries) {
				actionPairList.remove(actionPairList.size() - 1); // remove
																	// last elt
			}
		}
		startActionFrame();
		timeOfLastAdd = currentTime;
	}

	private void startActionFrame() {
		if (actionFrameStarted == false && EventQueue.isDispatchThread()) {
			actionFrameStarted = true;
			EventQueue.invokeLater(new Runnable() {
				public void run() {
					actionFrameStarted = false;
				}
			});
		}
	}

	public void clear() {
		actionPairList.clear();
	}

	public void print() {
		logger.info("Undo list:");
		int j = 0;
		for (Iterator i = actionPairList.iterator(); i.hasNext();) {
			ActionPair pair = (ActionPair) i.next();
			logger.info("line " + (j++) + " = "
					+ Tools.printXmlAction(pair.getDoAction()));
		}
	}
}