DrawEdit.java

/********************************************************************************
 *                                                                              *
 *  (c) Copyright 2010 Verizon Communications USA and The Open University UK    *
 *                                                                              *
 *  This software is freely distributed in accordance with                      *
 *  the GNU Lesser General Public (LGPL) license, version 3 or later            *
 *  as published by the Free Software Foundation.                               *
 *  For details see LGPL: http://www.fsf.org/licensing/licenses/lgpl.html       *
 *               and GPL: http://www.fsf.org/licensing/licenses/gpl-3.0.html    *
 *                                                                              *
 *  This software is provided by the copyright holders and contributors "as is" *
 *  and any express or implied warranties, including, but not limited to, the   *
 *  implied warranties of merchantability and fitness for a particular purpose  *
 *  are disclaimed. In no event shall the copyright owner or contributors be    *
 *  liable for any direct, indirect, incidental, special, exemplary, or         *
 *  consequential damages (including, but not limited to, procurement of        *
 *  substitute goods or services; loss of use, data, or profits; or business    *
 *  interruption) however caused and on any theory of liability, whether in     *
 *  contract, strict liability, or tort (including negligence or otherwise)     *
 *  arising in any way out of the use of this software, even if advised of the  *
 *  possibility of such damage.                                                 *
 *                                                                              *
 ********************************************************************************/

package com.compendium.ui.edits;

import java.util.Vector;

import javax.swing.undo.AbstractUndoableEdit;
import javax.swing.undo.CannotRedoException;
import javax.swing.undo.CannotUndoException;

import com.compendium.LanguageProperties;
import com.compendium.ui.UIScribblePad;
import com.compendium.ui.UIShape;

/**
 * The Edit function for undoing/redoing the scribble layer drawings.
 *
 * @author	Michelle Bachler
 */
public class DrawEdit extends AbstractUndoableEdit {

	/** The scribble pad holding the data to undo.*/
	public UIScribblePad oScribblePad = null;

	/** The shape to undo redo.*/
	public UIShape oShape = null;

	/** a list of shapes to undo/redo (when a pencil is used).*/
	public Vector vtShapes = null;

	/**
	 * The constructor.
	 * @param pad, the UIScribblePad associated with this draw event.
	 * @param shape, the shape object to undo / redo.
	 */
	public DrawEdit (UIScribblePad pad, Vector vtShapes) {
		oScribblePad = pad;
		this.vtShapes = vtShapes;
	}

	/**
	 * The constructor.
	 * @param pad, the UIScribblePad associated with this draw event.
	 * @param shape, the shape object to undo / redo.
	 */
	public DrawEdit (UIScribblePad pad, UIShape shape) {
		oScribblePad = pad;
		oShape = shape;
	}

	/**
	 * Undoes the last edit operation of this type.
	 *
     * @exception CannotUndoException if <code>canUndo</code> returns <code>false</code>.
     * @see	#canUndo
 	 */
	public void undo() throws CannotUndoException {
		if (vtShapes != null)
			oScribblePad.undo(vtShapes);
		else
			oScribblePad.undo(oShape);
	}

	/**
     * Redoes the previous edit of this type.
     *
     * @exception CannotRedoException if <code>canRedo</code> returns <code>false</code>
     * @see	#canRedo
 	 */
	public void redo() throws CannotRedoException {
		if (vtShapes != null)
			oScribblePad.redo(vtShapes);
		else
			oScribblePad.redo(oShape);
	}

    /**
     * Returns true if this edit is <code>alive</code>
     * and <code>hasBeenDone</code> is <code>true</code>.
	 * HERE: always return true.
     *
     * @return true if this edit is <code>alive</code> and <code>hasBeenDone</code> is <code>true</code>
     *
     * @see	#undo
     * @see	#redo
     */
	public boolean canUndo() { return true; }

    /**
     * Returns <code>true</code> if this edit is <code>alive</code>
     * and <code>hasBeenDone</code> is <code>false</code>.
	 * HERE: always return true.
     *
     * @return <code>true</code> if this edit is <code>alive</code> and <code>hasBeenDone</code> is <code>false</code>
	 *
     * @see	#undo
     * @see	#redo
     */
	public boolean canRedo() { return true; }

    /**
     *  Used by <code>getUndoPresentationName</code> and <code>getRedoPresentationName</code> to
     *  construct the strings they return.
     *
     *	@return the presentation name for this edit.
     */
	public String getPresentationName() {

		if (oShape != null) {
			int type = oShape.getType();
			if (type == UIScribblePad.OVAL)
				return LanguageProperties.getString(LanguageProperties.EDITS_BUNDLE, "DrawEdit.circle"); //$NON-NLS-1$
			else if (type == UIScribblePad.RECTANGLE)
				return LanguageProperties.getString(LanguageProperties.EDITS_BUNDLE, "DrawEdit.square"); //$NON-NLS-1$
			else if (type == UIScribblePad.LINE)
				return LanguageProperties.getString(LanguageProperties.EDITS_BUNDLE, "DrawEdit.line"); //$NON-NLS-1$
			else
				return LanguageProperties.getString(LanguageProperties.EDITS_BUNDLE, "DrawEdit.drawing"); //$NON-NLS-1$
		}
		else {
			return LanguageProperties.getString(LanguageProperties.EDITS_BUNDLE, "DrawEdit.drawing"); //$NON-NLS-1$
		}
	}
}