// $Id: PropPanelGeneralization.java,v 1.44 2004/09/19 21:06:25 mvw Exp $
// Copyright (c) 1996-2002 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 javax.swing.JList;
import javax.swing.JScrollPane;
import javax.swing.JTextField;

import org.apache.log4j.Logger;
import org.argouml.i18n.Translator;
import org.argouml.model.ModelFacade;
import org.argouml.ui.targetmanager.TargetManager;
import org.argouml.uml.ui.ActionNavigateContainerElement;
import org.argouml.uml.ui.ActionRemoveFromModel;
import org.argouml.uml.ui.PropPanelButton2;
import org.argouml.uml.ui.UMLComboBox2;
import org.argouml.uml.ui.UMLLinkedList;
import org.argouml.uml.ui.UMLTextField2;
import org.argouml.util.ConfigLoader;

/**
 * The properties panel for a Generalization.
 * 
 * TODO: this property panel needs refactoring to remove dependency on old gui
 * components.
 */
public class PropPanelGeneralization extends PropPanelModelElement {

    private static final Logger LOG = Logger
            .getLogger(PropPanelGeneralization.class);

    private JTextField discriminatorTextField;

    private JScrollPane parentScroll;

    private JScrollPane childScroll;

    private static UMLDiscriminatorNameDocument discriminatorDocument = 
        new UMLDiscriminatorNameDocument();

    private static UMLGeneralizationChildListModel childListModel = 
        new UMLGeneralizationChildListModel();

    private static UMLGeneralizationParentListModel parentListModel = 
        new UMLGeneralizationParentListModel();

    /**
     * The constructor.
     * 
     */
    public PropPanelGeneralization() {
        super("Generalization", ConfigLoader.getTabPropsOrientation());
        Class mclass = (Class) ModelFacade.GENERALIZATION;

        Class[] namesToWatch = {(Class) ModelFacade.STEREOTYPE,
            (Class) ModelFacade.NAMESPACE, (Class) ModelFacade.CLASSIFIER };
        setNameEventListening(namesToWatch);

        addField(Translator.localize("UMLMenu", "label.name"),
                getNameTextField());

        addField(Translator.localize("UMLMenu", "label.stereotype"),
                getStereotypeBox());

        addField(Translator.localize("UMLMenu", "label.discriminator"),
                getDiscriminatorTextField());

        addField(Translator.localize("UMLMenu", "label.namespace"),
                getNamespaceComboBox());

        addSeperator();

        addField(Translator.localize("UMLMenu", "label.parent"),
                getParentScroll());

        addField(Translator.localize("UMLMenu", "label.child"),
                getChildScroll());

        addField(Translator.localize("UMLMenu", "label.powertype"),
                new UMLComboBox2(new UMLGeneralizationPowertypeComboBoxModel(),
                        ActionSetGeneralizationPowertype.getInstance()));

        addButton(new PropPanelButton2(this,
                new ActionNavigateContainerElement()));
        addButton(new PropPanelButton2(this, new ActionRemoveFromModel()));
    }

    /**
     * @see org.argouml.uml.ui.foundation.core.PropPanelModelElement#navigateUp()
     */
    public void navigateUp() {
        Object target = getTarget();
        if (ModelFacade.isAModelElement(target)) {
            Object namespace = ModelFacade.getNamespace(target);
            if (namespace != null) {
                TargetManager.getInstance().setTarget(namespace);
            }
        }
    }

    /**
     * @return the discriminator textfield
     */
    protected JTextField getDiscriminatorTextField() {
        if (discriminatorTextField == null) {
            discriminatorTextField = new UMLTextField2(discriminatorDocument);
        }
        return discriminatorTextField;
    }

    /**
     * @return the scrollpane for the parent
     */
    protected JScrollPane getParentScroll() {
        if (parentScroll == null) {
            JList list = new UMLLinkedList(parentListModel);
            list.setVisibleRowCount(1);
            parentScroll = new JScrollPane(list,
                    JScrollPane.VERTICAL_SCROLLBAR_NEVER,
                    JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
        }
        return parentScroll;
    }

    /**
     * @return the scrollpane for the child
     */
    public JScrollPane getChildScroll() {
        if (childScroll == null) {
            JList list = new UMLLinkedList(childListModel);
            list.setVisibleRowCount(1);
            childScroll = new JScrollPane(list,
                    JScrollPane.VERTICAL_SCROLLBAR_NEVER,
                    JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
        }
        return childScroll;
    }

} /* end class PropPanelGeneralization */