// $Id: PropPanelFeature.java,v 1.12 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.

// $header$
package org.argouml.uml.ui.foundation.core;

import javax.swing.ImageIcon;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;

import org.argouml.i18n.Translator;
import org.argouml.swingext.Orientation;
import org.argouml.uml.ui.UMLComboBox2;
import org.argouml.uml.ui.UMLLinkedList;

/**
 * Abstract class for the properties panel of a Feature.
 * 
 * @since Nov 6, 2002
 * @author jaap.branderhorst@xs4all.nl
 */
public abstract class PropPanelFeature extends PropPanelModelElement {

    private UMLFeatureOwnerScopeCheckBox ownerScopeCheckbox;

    private UMLComboBox2 ownerComboBox;

    private JScrollPane ownerScroll;

    private static UMLFeatureOwnerListModel ownerListModel;

    private static UMLFeatureOwnerComboBoxModel ownerComboBoxModel;
    
    private JPanel visibilityPanel;

    /**
     * Constructor.
     * @param name name
     * @param icon icon
     * @param orientation orientation
     */
    protected PropPanelFeature(String name, ImageIcon icon,
            Orientation orientation) {
        super(name, icon, orientation);
    }

    /**
     * Constructor for PropPanelFeature.
     * 
     * @param name the name to be shown at the top of the panel
     * @param orientation the orientation of the panel
     */
    protected PropPanelFeature(String name, Orientation orientation) {
        super(name, orientation);
    }

    /**
     * Returns the ownerComboBox.
     * 
     * @return UMLComboBox2
     */
    public UMLComboBox2 getOwnerComboBox() {
        if (ownerComboBox == null) {
            if (ownerComboBoxModel == null) {
                ownerComboBoxModel = new UMLFeatureOwnerComboBoxModel();
            }
            ownerComboBox = new UMLComboBox2(ownerComboBoxModel,
                    ActionSetFeatureOwner.getInstance());
        }
        return ownerComboBox;
    }

    /**
     * Returns the ownerScroll.
     * 
     * @return JScrollPane
     */
    public JScrollPane getOwnerScroll() {
        if (ownerScroll == null) {
            if (ownerListModel == null) {
                ownerListModel = new UMLFeatureOwnerListModel();
            }
            JList list = new UMLLinkedList(ownerListModel);
            list.setVisibleRowCount(1);
            ownerScroll = new JScrollPane(list);
        }
        return ownerScroll;
    }

    /**
     * Returns the ownerScopeCheckbox.
     * 
     * @return UMLFeatureOwnerScopeCheckBox
     */
    public UMLFeatureOwnerScopeCheckBox getOwnerScopeCheckbox() {
        if (ownerScopeCheckbox == null) {
            ownerScopeCheckbox = new UMLFeatureOwnerScopeCheckBox();
        }
        return ownerScopeCheckbox;
    }
    
    /**
     * @return the panel for the visibility
     */
    protected JPanel getVisibilityPanel() {
        if (visibilityPanel == null) {
            visibilityPanel = new UMLModelElementVisibilityRadioButtonPanel(
                    Translator.localize("UMLMenu", "label.visibility"), true);
        }
        return visibilityPanel;
    }

}