SpreadsheetHistory.java

/**
 ISAcreator is a component of the ISA software suite (http://www.isa-tools.org)

 License:
 ISAcreator is licensed under the Common Public Attribution License version 1.0 (CPAL)

 EXHIBIT A. CPAL version 1.0
 The contents of this file are subject to the CPAL version 1.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://isa-tools.org/licenses/ISAcreator-license.html.
 The License is based on the Mozilla Public License version 1.1 but Sections
 14 and 15 have been added to cover use of software over a computer network and
 provide for limited attribution for the Original Developer. In addition, Exhibit
 A has been modified to be consistent with Exhibit B.

 Software distributed under the License is distributed on an AS IS basis,
 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 the specific language governing rights and limitations under the License.

 The Original Code is ISAcreator.
 The Original Developer is the Initial Developer. The Initial Developer of the
 Original Code is the ISA Team (Eamonn Maguire, eamonnmag@gmail.com;
 Philippe Rocca-Serra, proccaserra@gmail.com; Susanna-Assunta Sansone, sa.sanson@gmail.com;
 http://www.isa-tools.org). All portions of the code written by the ISA Team are
 Copyright (c) 2007-2011 ISA Team. All Rights Reserved.

 EXHIBIT B. Attribution Information
 Attribution Copyright Notice: Copyright (c) 2008-2011 ISA Team
 Attribution Phrase: Developed by the ISA Team
 Attribution URL: http://www.isa-tools.org
 Graphic Image provided in the Covered Code as file: http://isa-tools.org/licenses/icons/poweredByISAtools.png
 Display of Attribution Information is required in Larger Works which are defined in the CPAL as a work which combines Covered Code or portions thereof with code not governed by the terms of the CPAL.

 Sponsors:
 The ISA Team and the ISA software suite have been funded by the EU Carcinogenomics project (http://www.carcinogenomics.eu), the UK BBSRC (http://www.bbsrc.ac.uk), the UK NERC-NEBC (http://nebc.nerc.ac.uk) and in part by the EU NuGO consortium (http://www.nugo.org/everyone).
 */

package org.isatools.isacreator.spreadsheet;

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

class SpreadsheetHistory extends UndoableEditSupport {
    private SpreadsheetModel model;

    /**
     * This adds the range of cells to the history.
     *
     * @param range the cell range the operation will affect
     */
    public void add(SpreadsheetCellRange range) {
        // construct the clipboard to be saved
        SpreadsheetClipboard clip = new SpreadsheetClipboard(model, range, false);
        add(clip);
    }

    /**
     * This adds a clipboard object to the history list.
     *
     * @param clip - SpreadsheetClipboard object to be added.
     */
    public void add(SpreadsheetClipboard clip) {
        UndoableUpdate node = new UndoableUpdate(clip);
        postEdit(node);
    }


    void setTableModel(SpreadsheetModel model) {
        this.model = model;
    }

    /**
     * This is the redo method.
     */
    private void redo(UndoableUpdate current) {
        SpreadsheetCellRange range;


        // get the saved clipboard
        SpreadsheetClipboard oldClip = (SpreadsheetClipboard) current.getObject();
        range = oldClip.getSource();

        // replace the current object with the current model data
        SpreadsheetClipboard newClip = new SpreadsheetClipboard(model, range, false);
        current.setObject(newClip);


        oldClip.paste(model, range.getminCorner());
        model.setSelection(range);


        model.fireTableDataChanged();
        if (range.getColumnList() != null) {
            model.extendedSetSelection(range);
        } else {
            model.setSelection(range);
        }


    }

    /**
     * This is the undo method.
     */
    private void undo(UndoableUpdate current) {
        SpreadsheetCellRange range;

        // get the saved clipboard and its range
        SpreadsheetClipboard oldClip = (SpreadsheetClipboard) current.getObject();
        range = oldClip.getSource();

        // replace the current object with the current table data
        SpreadsheetClipboard newClip = new SpreadsheetClipboard(model, range, false);
        current.setObject(newClip);

        // recover the data (undo)
        oldClip.paste(model, range.getminCorner());

        // recover the selection
        model.fireTableDataChanged();
        if (range.getColumnList() != null) {
            model.extendedSetSelection(range);
        } else {
            model.setSelection(range);
        }
    }

    class UndoableUpdate extends AbstractUndoableEdit {
        private Object obj; // could be a SharpClipboard or a CellRange
        private int type; // one of the 5 History static values defined below

        /**
         * Creates a new instance of UndoableUpdate
         */
        public UndoableUpdate(Object obj) {
            setObject(obj);
        }

        public void redo() throws CannotRedoException {
            super.redo();
            SpreadsheetHistory.this.redo(this);
        }

        public void undo() throws CannotUndoException {
            super.undo();
            SpreadsheetHistory.this.undo(this);
        }

        void setObject(Object obj) {
            this.obj = obj;
        }

        // simple get/set functions

        Object getObject() {
            return obj;
        }

        void setType(int type) {
            this.type = type;
        }

        int getType() {
            return type;
        }
    }
}