/* Navigation Tree Model

 Copyright (c) 2003-2005 THALES.
 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 THALES 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 THALES HAS BEEN
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 THALES 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 THALES HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
 UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

 Created on 01 sept. 2003

 */
/*
 * Created on 01 sept. 2003
 *
 */
package thales.vergil.navigable;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import javax.swing.tree.TreePath;

import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.NamedObj;
import ptolemy.vergil.tree.ClassAndEntityTreeModel;

/**
 <p>Titre : NavigationTreeModel</p>
 <p>Description : used to represent all the entities of a MoML file</p>
 <p>Société : Thales Research and technology</p>
 @author Jérôme Blanc & Benoit Masson  * 01 sept. 2003
 @version $Id$
 @since Ptolemy II 4.0
 @Pt.ProposedRating @ProposedRating Yellow (jerome.blanc)
 @Pt.AcceptedRating @AcceptedRating
 */
public class NavigationTreeModel extends ClassAndEntityTreeModel {
    public NavigationTreeModel(NamedObj root) {
        super(root);
    }

    /** Return true if the object is a leaf node.  In this base class,
     *  an object is a leaf node if it is not an instance of CompositeEntity.
     *  ATTENTION il se peut qu'il faille ne plus faire se test lors de
     * l'utilisation de bibliothèque.
     *  @return True if the node has no children.
     */
    public boolean isLeaf(Object object) {
        if (!(object instanceof CompositeEntity)) {
            return true;
        }
        // NOTE: The following is probably not a good idea because it
        // will force evaluation of the contents of a Library prematurely.
        else if (((CompositeEntity) object).numberOfEntities() == 0) {
            return true;
        }

        return false;
    }

    //private members
    private List listeners = new ArrayList();

    /**
     * Register a listener
     * @param tree
     */
    public void register(NavigationPTree tree) {
        listeners.add(tree);
    }

    /**
     * remove a listener
     * @param tree
     * @return True if the tree was in the listeners, otherwise return false.
     */
    public boolean unRegister(NavigationPTree tree) {
        return listeners.remove(tree);
    }

    /**
     * set all listening PTree to the same path
     * @param path
     */
    public void setSelectedItem(TreePath path) {
        for (Iterator it = listeners.iterator(); it.hasNext();) {
            NavigationPTree aTree = (NavigationPTree) it.next();
            aTree.setSelectionPath(path);
        }
    }

    /**
     * expand/collapse all the NavigationTree
     * @param aPath
     */
    public void expandPath(TreePath aPath, boolean collapse) {
        for (Iterator it = listeners.iterator(); it.hasNext();) {
            NavigationPTree aTree = (NavigationPTree) it.next();

            if (collapse) {
                aTree.collapsePath(aPath);
            } else {
                aTree.expandPath(aPath);
            }
        }
    }
}