/* $Id: UMLCallStateEntryList.java 17883 2010-01-12 21:11:38Z 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:
 *    linus
 *****************************************************************************
 *
 * Some portions of this file was previously release using the BSD License:
 */

// Copyright (c) 2006 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.behavior.activity_graphs;

import javax.swing.JMenu;
import javax.swing.JPopupMenu;

import org.argouml.i18n.Translator;
import org.argouml.uml.ui.ActionRemoveModelElement;
import org.argouml.uml.ui.UMLModelElementListModel2;
import org.argouml.uml.ui.UMLMutableLinkedList;
import org.argouml.uml.ui.behavior.common_behavior.ActionNewAction;
import org.argouml.uml.ui.behavior.common_behavior.ActionNewCallAction;

/**
 * This class is very similar to the UMLStateEntryList,
 * but since it is used for a CallState,
 * it allows only the creation of one Action type: CallAction.
 *
 * @author michiel
 */
class UMLCallStateEntryList extends UMLMutableLinkedList {

    /**
     * Constructor for UMLStateEntryList.
     * @param dataModel the model
     */
    public UMLCallStateEntryList(
        UMLModelElementListModel2 dataModel) {
        super(dataModel);
    }

    /*
     * @see org.argouml.uml.ui.UMLMutableLinkedList#getPopupMenu()
     */
    public JPopupMenu getPopupMenu() {
        return new PopupMenuNewCallAction(ActionNewAction.Roles.ENTRY, this);
    }

    static class PopupMenuNewCallAction extends JPopupMenu {

        /**
         * Constructs a new popupmenu. The given parameter role determines what
         * the purpose is of the actions that can be created via this popupmenu.
         * The parameter must comply to the interface Roles
         * defined on ActionNewAction.
         * @param role the role
         * @param list the list
         */
        public PopupMenuNewCallAction(String role, UMLMutableLinkedList list) {
            super();

            JMenu newMenu = new JMenu();
            newMenu.setText(Translator.localize("action.new"));

            newMenu.add(ActionNewCallAction.getInstance());
            ActionNewCallAction.getInstance().setTarget(list.getTarget());
            ActionNewCallAction.getInstance().putValue(
                    ActionNewAction.ROLE, role);

            add(newMenu);

            addSeparator();

            ActionRemoveModelElement.SINGLETON.setObjectToRemove(ActionNewAction
                 .getAction(role, list.getTarget()));
            add(ActionRemoveModelElement.SINGLETON);
        }
    }

}