/* $Id: ActionSetModelElementVisibility.java 17897 2010-01-12 21:36:40Z 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:
 *    bobtarling
 *****************************************************************************
 *
 * Some portions of this file was previously release using the BSD License:
 */

// Copyright (c) 1996-2007 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.uml.ui.foundation.core;

import java.awt.event.ActionEvent;

import javax.swing.Action;
import javax.swing.JRadioButton;

import org.argouml.i18n.Translator;
import org.argouml.model.Model;
import org.argouml.uml.ui.UMLRadioButtonPanel;
import org.argouml.ui.UndoableAction;

/**
 * This action sets the Visibility of a ModelElement. 
 * Next to a ModelElement, this also works for an 
 * ElementResidence and ElementImport.
 *
 * @author jaap.branderhorst@xs4all.nl
 * @since Jan 4, 2003
 */
public class ActionSetModelElementVisibility extends UndoableAction {
    /**
     * The instance.
     */
    private static final ActionSetModelElementVisibility SINGLETON =
        new ActionSetModelElementVisibility();

    /**
     * PUBLIC_COMMAND determines the visibility.
     */
    public static final String PUBLIC_COMMAND = "public";

    /**
     * PROTECTED_COMMAND determines the visibility.
     */
    public static final String PROTECTED_COMMAND = "protected";

    /**
     * PRIVATE_COMMAND determines the visibility.
     */
    public static final String PRIVATE_COMMAND = "private";

    /**
     * PACKAGE_COMMAND determines the visibility.
     */
    public static final String PACKAGE_COMMAND = "package";

    /**
     * Constructor for ActionSetElementOwnershipSpecification.
     */
    protected ActionSetModelElementVisibility() {
        super(Translator.localize("Set"), null);
        // Set the tooltip string:
        putValue(Action.SHORT_DESCRIPTION, 
                Translator.localize("Set"));
    }

    /*
     * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
     */
    public void actionPerformed(ActionEvent e) {
        super.actionPerformed(e);
        if (e.getSource() instanceof JRadioButton) {
            JRadioButton source = (JRadioButton) e.getSource();
            String actionCommand = source.getActionCommand();
            Object target =
                ((UMLRadioButtonPanel) source.getParent()).getTarget();
            if (Model.getFacade().isAModelElement(target)
                    || Model.getFacade().isAElementResidence(target)
                    || Model.getFacade().isAElementImport(target)) {
                Object kind = null;
                if (actionCommand.equals(PUBLIC_COMMAND)) {
                    kind = Model.getVisibilityKind().getPublic();
                } else if (actionCommand.equals(PROTECTED_COMMAND)) {
                    kind = Model.getVisibilityKind().getProtected();
                } else if (actionCommand.equals(PACKAGE_COMMAND)) {
                    kind = Model.getVisibilityKind().getPackage();
                } else {
                    kind = Model.getVisibilityKind().getPrivate();
                }
                Model.getCoreHelper().setVisibility(target, kind);

            }
        }
    }

    /**
     * @return Returns the sINGLETON.
     */
    public static ActionSetModelElementVisibility getInstance() {
        return SINGLETON;
    }

}