/* A menu item factory that opens a dialog for adding ports.

 Copyright (c) 1999-2006 The Regents of the University of California.
 All rights reserved.
 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the above
 copyright notice and the following two paragraphs appear in all copies
 of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 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 OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY

 */
package ptolemy.vergil.kernel;

import java.awt.Component;
import java.awt.Frame;
import java.awt.event.ActionEvent;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JMenuItem;

import ptolemy.actor.gui.Configuration;
import ptolemy.actor.gui.DialogTableau;
import ptolemy.actor.gui.PortConfigurerDialog;
import ptolemy.actor.gui.TableauFrame;
import ptolemy.kernel.Entity;
import ptolemy.kernel.util.NamedObj;
import ptolemy.vergil.toolbox.MenuItemFactory;
import ptolemy.vergil.unit.UnitConstraintsDialog;
import diva.gui.toolbox.JContextMenu;

//////////////////////////////////////////////////////////////////////////
//// PortDialogFactory

/**
 A factory that creates a dialog to configure, add, or remove ports
 from objects.

 @deprecated Use PortDialogAction.
 @author Edward A. Lee and Steve Neuendorffer
 @version $Id$
 @since Ptolemy II 2.0
 @Pt.ProposedRating Red (eal)
 @Pt.AcceptedRating Red (johnr)
 */
public class PortDialogFactory implements MenuItemFactory {
    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /**
     * Add an item to the given context menu that will open a dialog to add or
     * remove ports from an object.
     *
     * @param menu The context menu.
     * @param object The object whose ports are being manipulated.
     * @return The JMenuItem or null if the object argument is not an
     * Entity.
     */
    public JMenuItem create(final JContextMenu menu, NamedObj object) {
        JMenuItem retv = null;

        // Removed this method since it was never used. EAL
        // final NamedObj target = _getItemTargetFromMenuTarget(object);
        final NamedObj target = object;

        // ensure that we actually have a target, and that it's an Entity.
        if (!(target instanceof Entity)) {
            return null;
        }

        // Create a dialog for configuring the object.
        // First, identify the top parent frame.
        // Normally, this is a Frame, but just in case, we check.
        // If it isn't a Frame, then the edit parameters dialog
        // will not have the appropriate parent, and will disappear
        // when put in the background.
        // Note, this uses the "new" way of doing dialogs.
        Action configPortsAction = new AbstractAction(_configPorts) {
            public void actionPerformed(ActionEvent e) {
                Component parent = menu.getInvoker();

                while (parent.getParent() != null) {
                    parent = parent.getParent();
                }

                if (parent instanceof Frame) {
                    DialogTableau dialogTableau = DialogTableau.createDialog(
                            (Frame) parent, _configuration,
                            ((TableauFrame) parent).getEffigy(),
                            PortConfigurerDialog.class, (Entity) target);

                    if (dialogTableau != null) {
                        dialogTableau.show();
                    }
                }
            }
        };

        retv = menu.add(configPortsAction, _configPorts);

        Action configUnitsAction = new AbstractAction(_configUnits) {
            public void actionPerformed(ActionEvent e) {
                Component parent = menu.getInvoker();

                while (parent.getParent() != null) {
                    parent = parent.getParent();
                }

                if (parent instanceof Frame) {
                    DialogTableau dialogTableau = DialogTableau.createDialog(
                            (Frame) parent, _configuration,
                            ((TableauFrame) parent).getEffigy(),
                            UnitConstraintsDialog.class, (Entity) target);

                    if (dialogTableau != null) {
                        dialogTableau.show();
                    }
                }
            }
        };

        retv = menu.add(configUnitsAction, _configUnits);

        return retv;
    }

    /**
     * Set the configuration for use by the help screen.
     *
     * @param configuration
     *            The configuration.
     */
    public void setConfiguration(Configuration configuration) {
        _configuration = configuration;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private variables                 ////

    /** The configuration. */
    private static String _configPorts = "Configure Ports";

    private static String _configUnits = "Configure Units";

    private Configuration _configuration;
}