UndoableChangeCollectorNameEdit.java

/*
 * Copyright (c) 2007 BUSINESS OBJECTS SOFTWARE LIMITED
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *  
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *  
 *     * Neither the name of Business Objects nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *  
 * 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.
 */


/*
 * UndoableChangeCollectorNameEdit.java
 * Creation date: (04/08/2002 11:35:00 AM)
 * By: Edward Lam
 */
package org.openquark.gems.client;

import javax.swing.undo.AbstractUndoableEdit;
import javax.swing.undo.UndoableEdit;

/**
 * An UndoableEdit used to undo a change in the name of a collector gem.
 * Creation date: (04/08/2002 11:35:00 AM)
 * @author Edward Lam
 */
public class UndoableChangeCollectorNameEdit extends AbstractUndoableEdit {

    private static final long serialVersionUID = 2131155598313881181L;

    /** The tabletop for the gem. */    
    private final TableTop tableTop;

    /** The collector gem in question. */
    private final CollectorGem collectorGem;
    
    /** The old name of the collector gem. */
    private final String oldName;

    /** The new name of the collector gem. */
    private final String newName;

    /**
     * Constructor for an UndoableChangeGemNameEdit.
     * Creation date: (04/08/2002 11:35:00 AM)
     * @param tableTop the tabletop to which to add.
     * @param collectorGem the collector gem in question
     * @param oldName the name of the gem before the event
     */
    UndoableChangeCollectorNameEdit(TableTop tableTop, CollectorGem collectorGem, String oldName) {
        this.tableTop = tableTop;
        this.collectorGem = collectorGem;
        this.oldName = oldName;
        this.newName = collectorGem.getUnqualifiedName();
    }
    
    /**
     * A reasonable name for this edit.
     * Creation date: (04/08/2002 11:39:00 AM)
     */
    @Override
    public String getPresentationName() {
        return GemCutter.getResourceString("UndoText_ChangeCollectorName");
    }

    /**
     * Redo the edit.
     * Creation date: (04/08/2002 11:38:00 AM)
     */
    @Override
    public void redo() {
        super.redo();
        collectorGem.setName(newName);
    }

    /**
     * Undo the edit.
     * Creation date: (04/08/2002 11:38:00 AM)
     */
    @Override
    public void undo() {
        super.undo();
        collectorGem.setName(oldName);
    }

    /**
     * Replace anEdit if possible.
     * Creation date: (04/08/2002 11:46:00 AM)
     * @return boolean whether the edit was absorbed.
     */
    @Override
    public boolean replaceEdit(UndoableEdit anEdit){

        // Replace if the other edit is equivalent to this one
        if (!(anEdit instanceof UndoableChangeCollectorNameEdit)) {
            return false;
        }
        
        UndoableChangeCollectorNameEdit otherEdit = (UndoableChangeCollectorNameEdit)anEdit;

        return (otherEdit.tableTop == this.tableTop &&
                otherEdit.collectorGem == this.collectorGem &&
                otherEdit.oldName.equals(this.oldName) &&
                otherEdit.newName.equals(this.newName));
        
    }
}