AbstractShapeTests.java

/******************************************************************************
 * Copyright (c) 2002, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    IBM Corporation - initial API and implementation 
 ****************************************************************************/

package org.eclipse.gmf.tests.runtime.diagram.ui;

import java.util.Iterator;

import org.eclipse.draw2d.geometry.Dimension;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.gef.Request;
import org.eclipse.gef.commands.Command;
import org.eclipse.gmf.runtime.diagram.core.util.ViewUtil;
import org.eclipse.gmf.runtime.diagram.ui.commands.SetBoundsCommand;
import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
import org.eclipse.gmf.runtime.emf.core.util.EObjectAdapter;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.gmf.tests.runtime.diagram.ui.util.ITestCommandCallback;

/**
 * @author chmahone,choang
 * 
 * <p>Abstract Test class that implements the shapes test.  This abstract class doesn't not
 * know what diagram or if we are dealing with EMF or RMS
 * Diagram Test that wish to run the shapes test in the specific context of thier digram should 
 * extend this abstract class.</p>
 * 
 * <p>What's left for you to do</p>
 * <br> 1.  Implement all the abstract methods and the suite() as described in the javadoc for </br>
 * <br> @see org.eclipse.gmf.tests.runtime.diagram.ui.AbstractTestBase
 */
public abstract class AbstractShapeTests extends AbstractTestBase {

    public AbstractShapeTests(String arg0) {
        super(arg0);
    }

    /**
     * Executes a generic command on all the EditParts in the diagram (assuming they provide
     * the command).  Checks that the property value is updated after the command.
     * 
     * @param request         request for the command to be executed
     * @param propertyValue   value that the property will be changed to 
     * @param propertyID      property id string that identifies this view property
     */
    protected void testCommandOnEditParts(
        final Request request,
        final Object propertyValue,
        final EStructuralFeature feature) {
        Iterator objects = getShapesIn(getDrawSurfaceEditPart()).iterator();
        while (objects.hasNext()) {
            IGraphicalEditPart editPart = (IGraphicalEditPart) objects.next();
            Command cmd = editPart.getCommand(request);
            if (cmd != null) {
                final View view = (View)editPart.getModel();
                testCommand(cmd, new ITestCommandCallback() {
                    public void onCommandExecution() {
                        assertTrue(
                            ViewUtil.getStructuralFeatureValue(view,feature).equals(
                                propertyValue));
                    }
                });
            }
        }
    }

    /**
     * Method testRATLC00046844.
     * Tests to make sure undo is working when resizing an editpart.
     * @throws Exception
     */
    public void testRATLC00046844() throws Exception {

        // get the first edit part
        IGraphicalEditPart editPart = null;
        Iterator objects = getShapesIn(getDrawSurfaceEditPart()).iterator();
        while (objects.hasNext()) {
            editPart = (IGraphicalEditPart) objects.next();
            break;
        }

        View shapeView = (View) editPart.getModel();

        getDrawSurfaceFigure().invalidate();
		getDrawSurfaceFigure().validate();

        final Dimension newDim = new Dimension(400, 400);
        final Dimension oldDim = editPart.getFigure().getSize();

        SetBoundsCommand cmd = new SetBoundsCommand(getTestFixture()
            .getEditingDomain(), "testRATLC00046844", new EObjectAdapter(shapeView), newDim); //$NON-NLS-1$
        
        testCommand(cmd, new ITestCommandCallback() {
            public void onCommandExecution() {
            	// do nothing
            }
        });

        // force an undo to test value is restored.
        getTestFixture().getCommandStack().undo();
		getDrawSurfaceFigure().invalidate();
		getDrawSurfaceFigure().validate();

        assertTrue(editPart.getFigure().getSize().equals(oldDim));
    }

    /**
     * @see junit.framework.TestCase#setUp()
     * 
     * Setup the data for the shapes tests which involves
     * 1. calling super.setup() which will create project,diagram and open the diagram
     * 2. create the shapes and the connectors on the diagram
     * 
     * Note it calls the abstract method createConnectorView which needs to be implemented by
     * the class that implements this abstract class.
     */
    protected void setUp() throws Exception {
        super.setUp();
    }

    /**
     * @see junit.framework.TestCase#tearDown()
     */
    protected void tearDown() throws Exception {
        super.tearDown();
    }

}