// $Id: UMLAttributesListModel.java,v 1.17 2004/09/13 19:21:23 mvw Exp $
// Copyright (c) 1996-99 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;

import org.argouml.model.ModelFacade;
import java.util.Collection;

import javax.swing.JPopupMenu;

import org.argouml.model.uml.UmlFactory;

/**
 *   This class implements a list model for the attributes of a classifier.
 *   Used with a UMLList to display a list of attributes.  Since attributes
 *   may be mixed with other model elements in the features of a classifier,
 *   this class implements a cache of attributes that are keep synchronized
 *   with the features of the current classifier.
 *
 *   @author Curt Arnold
 *   @see UMLModelElementListModel
 *   @see UMLList
 *
 * @deprecated as of ArgoUml 0.13.5 (10-may-2003), replaced by 
 * {@link org.argouml.uml.ui.foundation.core.UMLClassAttributeListModel},
 * this class is part of the 'old'(pre 0.13.*) implementation of proppanels
 * that used reflection a lot.
 */
public class UMLAttributesListModel extends UMLModelElementCachedListModel  {

    private static final String NULLLABEL = "null";
    private java.util.List attributes;

    /**
     *   Creates a new attribute list model
     *   @param container the container (typically a PropPanelClass or 
     *                    PropPanelInterface) that provides access to 
     *                    the target classifier.
     *   @param property  a string that specifies the name of an event that 
     *                    should force a refresh of the list model.  
     *                    A null value will cause all events 
     *                    to trigger a refresh.
     *   @param showNone  if true, an element labelled "none" will be shown 
     *                    where there are no actual entries in the list.
     */
    public UMLAttributesListModel(UMLUserInterfaceContainer container, 
            String property, boolean showNone) {
        super(container, property, showNone);
    }
    /**
     * Called to indicate that the cache of 
     * attributes may have become invalid.
     */
    protected void resetCache() {
        attributes = null;
    }
    /**
     * Called to determine if a particular feauture 
     * of the underlying collection
     * should be in the cached list of model elements.
     * @param obj object to be considered.
     * @return true if object is appropriate for this list.
     */
    public boolean isProperClass(Object obj) {
        return org.argouml.model.ModelFacade.isAAttribute(obj);
    }
    /**
     *   returns the raw underlying collection from the current target
     *   of the container.
     *
     *   @return underlying collection.
     */
    public Collection getRawCollection() {
        Collection raw = null;
        Object target = getTarget();
        if (org.argouml.model.ModelFacade.isAClassifier(target)) {
            raw = ModelFacade.getFeatures(target);
        }
        return raw;
    }
    /**
     * Returns the cache of model elements, 
     * rebuilding the cache if invalidated.
     * @return cache of model elements
     */
    protected java.util.List getCache() {
        if (attributes == null) {
            attributes = buildCache();
        }
        return attributes;
    }

    /**
     *   Adds a new attribute, updating both the cache and underlying collection
     *   and navigating to new attribute.  Called by "Add" popup menu item.
     *   @param  index position of new attribute (zero-based) but only refers
     *           to the index position in the particular list box, 
     *           not the collection.
     *   @author Phil Sager July 18, 2001
     *   Modified: Dec  06, 2001 - thn
  */
    public void add(int index) {
        Object target = getTarget();
        if (org.argouml.model.ModelFacade.isAClassifier(target)) {
            Object/*MClassifier*/ classifier = target;
            Collection oldFeatures = ModelFacade.getFeatures(classifier);
            Object/*MAttribute*/ newAttr = 
                UmlFactory.getFactory().getCore().buildAttribute(classifier);
            ModelFacade.setFeatures(classifier, addElement(oldFeatures, 
                index, newAttr, attributes.isEmpty() 
                ? null : attributes.get(index)));
            fireContentsChanged(this, index - 1, index);
            navigateTo(newAttr);
        }
    }  // ...end of add()...

    /**
     *   Deletes a specific attribute from both the cache and underlying
     *   collection.
     *   @param index position of attribute to be deleted.
     */
    public void delete(int index) {
        Object target = getTarget();
        if (org.argouml.model.ModelFacade.isAClassifier(target) 
                && attributes != null) {
            Object attribute = attributes.get(index);
            if (attribute != null) {
		if (attributes != null) {
                    attributes.remove(index);
                }

                ModelFacade.removeFeature(target, attribute);
                resetSize();
                fireIntervalRemoved(this, index, index);
            }
        }
    }


    /**
     *   Moves attribute up in the underlying collection.
     *   @param index element to move up
     */
    public void moveUp(int index) {
        Object target = getTarget();
        if (org.argouml.model.ModelFacade.isAClassifier(target)) {
            Object/*MClassifier*/ classifier = target;
            Collection oldFeatures = ModelFacade.getFeatures(classifier);
            ModelFacade.setFeatures(classifier, swap(oldFeatures, index - 1, 
                    attributes.get(index - 1), attributes.get(index)));
            fireContentsChanged(this, index - 1, index);
        }
    }

    /**
     *  Moves an attribute down in the underlying collection.
     *  @param index element to move down.
     */
    public void moveDown(int index) {
        Object target = getTarget();
        if (org.argouml.model.ModelFacade.isAClassifier(target)) {
            Object/*MClassifier*/ classifier = target;
            Collection oldFeatures = ModelFacade.getFeatures(classifier);
            ModelFacade.setFeatures(classifier, swap(oldFeatures, index, 
                    attributes.get(index), attributes.get(index + 1)));
            fireContentsChanged(this, index, index + 1);
        }
    }
    
    /**
     *  This method builds a context (pop-up) menu for the list.  
     *
     *  @param popup popup menu
     *  @param index index of selected list item
     *  @return "true" if popup menu should be displayed
     */
    public boolean buildPopup(JPopupMenu popup, int index) {
        UMLUserInterfaceContainer container = getContainer();
        UMLListMenuItem open = new UMLListMenuItem(
                container.localize("Open"), this, "open", index);
        UMLListMenuItem delete = new UMLListMenuItem(
                container.localize("Delete"), this, "delete", index);
        if (getModelElementSize() <= 0) {
            open.setEnabled(false);
            delete.setEnabled(false);
        }

        popup.add(open);
        UMLListMenuItem add = new UMLListMenuItem(
                container.localize("New"), this, "add", index);
        if (getUpper() >= 0 && getModelElementSize() >= getUpper()) {
            add.setEnabled(false);
        }
        popup.add(add);
        popup.add(delete);
        /*
        UMLListMenuItem moveUp = new UMLListMenuItem(container.localize(
            "Move Up"),this,"moveUp",index);
        if(index == 0) moveUp.setEnabled(false);
        popup.add(moveUp);
        UMLListMenuItem moveDown = new UMLListMenuItem(container.localize(
            "Move Down"),this,"moveDown",index);
        if(index == getSize()-1) moveDown.setEnabled(false);
        popup.add(moveDown);
        */
        return true;
    }
}