/* $Id: CmdSetPreferredSize.java 17842 2010-01-12 19:21:22Z linus $
 *****************************************************************************
 * Copyright (c) 2009 Contributors - see below
 * 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:
 *    tfmorris
 *****************************************************************************
 *
 * Some portions of this file was previously release using the BSD License:
 */

// Copyright (c) 1996-2009 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.ui.cmd;

import java.util.ArrayList;
import java.util.List;

import org.tigris.gef.base.Cmd;
import org.tigris.gef.base.Editor;
import org.tigris.gef.base.Globals;
import org.tigris.gef.base.SelectionManager;
import org.tigris.gef.presentation.Fig;

import org.argouml.i18n.Translator;


/**
 * A command to set selected figs to their minimum size. <p>
 * Despite its name, really the minimum size is selected here! <p>
 * 
 * TODO: Rename this class.
 *
 * @author Markus Klink
 */
public class CmdSetPreferredSize extends Cmd {

    /**
     * Default constructor - set minimum size command.
     */
    public CmdSetPreferredSize() {
//        super(Translator.localize("action.size-to-fit-contents"));
	super(Translator.localize("action.set-minimum-size"));
    }


    /**
     * Set the fig to be resized.
     *
     * @param f the fig to resize
     */
    public void setFigToResize(Fig f) {
        List<Fig> figs = new ArrayList<Fig>(1);
        figs.add(f);
        setArg("figs", figs);
    }

    /**
     * Set the figs to be resized.
     *
     * @param figs the list of figs to resize
     */
    public void setFigToResize(List figs) {
        setArg("figs", figs);
    }


    /**
     * Set all the figs in the selection or passed by param "figs" to the
     * size according to the mode of the command.
     */
    public void doIt() {
        Editor ce = Globals.curEditor();
        List<Fig> figs = (List<Fig>) getArg("figs");
        if (figs == null) {
            SelectionManager sm = ce.getSelectionManager();
            if (sm.getLocked()) {
                Globals.showStatus(
                    Translator.localize("action.locked-objects-not-modify"));
                return;
            }
            figs = sm.getFigs();
        }

        if (figs == null) {
            return;
        }
        int size = figs.size();
        if (size == 0) {
            return;
        }

        for (int i = 0; i < size; i++) {
            Fig fi = figs.get(i);
            /* Only resize elements which the user would also be able
             * to resize: */
            if (fi.isResizable() 
                    /* But exclude elements that enclose others, 
                     * since their algorithms to calculate the minimum size 
                     * does not take enclosed objects into account: */
                    && (fi.getEnclosedFigs() == null 
                            || fi.getEnclosedFigs().size() == 0)) {
                fi.setSize(fi.getMinimumSize());
                /* TODO: Beautify the 2nd part of this string: */
                Globals.showStatus(Translator.localize("action.setting-size", 
                        new Object[] {fi}));
            }
            fi.endTrans();
        }
    }


    /*
     * @see org.tigris.gef.base.Cmd#undoIt()
     */
    public void undoIt() {
        // unsupported. 
    }

}