---

TAbstractTreeTableModel.java

/*
*  Name:        TAbstractCellEditor.java
*  Author:      Philip Milne
*  Maintainer:  Rafael Jesus Alcantara Perez
*  Summary:     Abstract tree-table model.
*  Date:        $Date: 2003/09/28 23:27:56 $
*  Revision:    $Revision: 1.3 $
*
*  Copyright (C) 2003  Rafael Jesus Alcantara Perez <rafa@dedalo-ing.com>
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program; if not, write to the Free Software
*  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
*  MA 02111-1307, USA.
*
*
*  Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.
*
*  Redistribution and use in source and binary forms, with or
*  without modification, are permitted provided that the following
*  conditions are met:
*
*  - Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
*  - Redistribution in binary form must reproduce the above
*    copyright notice, this list of conditions and the following
*    disclaimer in the documentation and/or other materials
*    provided with the distribution.
*
*  Neither the name of Sun Microsystems, Inc. or the names of
*  contributors may be used to endorse or promote products derived
*  from this software without specific prior written permission.
*
*  This software is provided "AS IS," without a warranty of any
*  kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
*  WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
*  FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
*  EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY
*  DAMAGES OR LIABILITIES SUFFERED BY LICENSEE AS A RESULT OF OR
*  RELATING TO USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE OR
*  ITS DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE
*  FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT,
*  SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER
*  CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF
*  THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS
*  BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
*  You acknowledge that this software is not designed, licensed or
*  intended for use in the design, construction, operation or
*  maintenance of any nuclear facility.
*/

package org.mpcl.nui.treetable;

import javax.swing.event.EventListenerList;
import javax.swing.event.TreeModelEvent;
import javax.swing.event.TreeModelListener;
import javax.swing.tree.TreePath;

 
public abstract class TAbstractTreeTableModel implements ITreeTableModel
{

  protected EventListenerList   tEventListenerList;

  protected Object   tRootNode;


  //
  //  C O N S T R U C T O R S
  //

  public TAbstractTreeTableModel (Object tROOT_NODE)
  {
    tRootNode          = tROOT_NODE;
    tEventListenerList = new EventListenerList();
  }

  public void addTreeModelListener (TreeModelListener tTREE_MODEL_LISTENER)
  {
    tEventListenerList.add (TreeModelListener.class, tTREE_MODEL_LISTENER);
  }

  public void removeTreeModelListener (TreeModelListener tTREE_MODEL_LISTENER)
  {
    tEventListenerList.remove (TreeModelListener.class, tTREE_MODEL_LISTENER);
  }

  public void setValueAt (Object tVALUE, Object tNODE, int iCOLUMN) {}

  public void valueForPathChanged (TreePath tTREE_PATH, Object newValue) {}


  //
  //   S E L E C T O R S
  //

  protected void fireTreeNodesChanged (TreePath tTREE_PATH)
  {

    Object[]         aListenerTypeListenerPair;
    TreeModelEvent   tTreeModelEvent = null;

    //
    //  The getListenerList()  method is guaranteed to return a non-null array.
    //  Processes  the  listeners  last  to first,  notifying  those  that  are
    //  interested in this event.  The \a ChangeEvent object is created lazily.
    //
    aListenerTypeListenerPair = tEventListenerList.getListenerList();
    for (int I = aListenerTypeListenerPair.length-2; ( I >= 0 ) ;I-=2)
    {
      if ( aListenerTypeListenerPair [I] == TreeModelListener.class )
      {
        if ( tTreeModelEvent == null )
        {
          tTreeModelEvent = new TreeModelEvent (this, tTREE_PATH);
        }
        ((TreeModelListener) aListenerTypeListenerPair [I + 1]).treeNodesChanged (tTreeModelEvent);
      }          
    }

  }  // fireTreeNodesChanged()

  protected void fireTreeNodesChanged ( Object   tSOURCE         ,
                                        Object[] atPATH          ,
                                        int[]    aiCHILD_INDICES ,
                                        Object[] atCHILDREN      )
  {

    Object[]         aListenerTypeListenerPair;
    TreeModelEvent   tTreeModelEvent = null;

    //
    //  The getListenerList()  method is guaranteed to return a non-null array.
    //  Processes  the  listeners  last  to first,  notifying  those  that  are
    //  interested in this event.  The \a ChangeEvent object is created lazily.
    //
    aListenerTypeListenerPair = tEventListenerList.getListenerList();
    for (int I = aListenerTypeListenerPair.length-2; ( I >= 0 ) ;I-=2)
    {
      if ( aListenerTypeListenerPair [I] == TreeModelListener.class )
      {
        if ( tTreeModelEvent == null )
        {
          tTreeModelEvent = new TreeModelEvent (tSOURCE, atPATH, aiCHILD_INDICES, atCHILDREN);
        }
        ((TreeModelListener) aListenerTypeListenerPair [I + 1]).treeNodesChanged (tTreeModelEvent);
      }          
    }

  }  // fireTreeNodesChanged()

  protected void fireTreeNodesInserted ( Object   tSOURCE         ,
                                         Object[] atPATH          ,
                                         int[]    aiCHILD_INDICES ,
                                         Object[] atCHILDREN      )
  {

    Object[]         aListenerTypeListenerPair;
    TreeModelEvent   tTreeModelEvent = null;

    //
    //  The getListenerList()  method is guaranteed to return a non-null array.
    //  Processes  the  listeners  last  to first,  notifying  those  that  are
    //  interested in this event.  The \a ChangeEvent object is created lazily.
    //
    aListenerTypeListenerPair = tEventListenerList.getListenerList();
    for (int I = aListenerTypeListenerPair.length-2; ( I >= 0 ) ;I-=2)
    {
      if ( aListenerTypeListenerPair [I] == TreeModelListener.class )
      {
        if ( tTreeModelEvent == null )
        {
          tTreeModelEvent = new TreeModelEvent (tSOURCE, atPATH, aiCHILD_INDICES, atCHILDREN);
        }
        ((TreeModelListener) aListenerTypeListenerPair [I + 1]).treeNodesInserted (tTreeModelEvent);
      }
    }

  }  // fireTreeNodesInserted()

  /*
  *  Notifies all listeners  that have registered interest for  notification on
  *  this event type.
  *  @param tSOURCE
  *         The object  responsible  for  generating the  event  (typically the
  *         creator of the event object passes this for its value).
  *  @param atPATH
  *         An  array of \a Object  identifying  the path to the  parent of the
  *         modified  item(s),  where the  first  element of  the array  is the
  *         object stored at the root node  and the last  element is the object
  *         stored at the parent node.
  *  @param aiCHILD_INDICES
  *         An array of \a int that  specifies the index  values of the removed
  *         items. The indices must be in sorted order, from lowest to highest.
  *  @param atCHILDREN
  *         An array of \a Object containing the inserted,  removed, or changed
  *         objects.
  */
  protected void fireTreeNodesRemoved ( Object   tSOURCE         ,
                                        Object[] atPATH          ,
                                        int[]    aiCHILD_INDICES ,
                                        Object[] atCHILDREN      )
  {

    Object[]         aListenerTypeListenerPair;
    TreeModelEvent   tTreeModelEvent = null;

    //
    //  The getListenerList()  method is guaranteed to return a non-null array.
    //  Processes  the  listeners  last  to first,  notifying  those  that  are
    //  interested in this event.  The \a ChangeEvent object is created lazily.
    //
    aListenerTypeListenerPair = tEventListenerList.getListenerList();
    for (int I = aListenerTypeListenerPair.length-2; ( I >= 0 ) ;I-=2)
    {
      if ( aListenerTypeListenerPair [I] == TreeModelListener.class )
      {
        if ( tTreeModelEvent == null )
        {
          tTreeModelEvent = new TreeModelEvent (tSOURCE, atPATH, aiCHILD_INDICES, atCHILDREN);
        }
        ((TreeModelListener) aListenerTypeListenerPair [I + 1]).treeNodesRemoved (tTreeModelEvent);
      }
    }

  }  // fireTreeNodesRemoved()

  protected void fireTreeStructureChanged (TreePath tTREE_PATH)
  {

    Object[]         aListenerTypeListenerPair;
    TreeModelEvent   tTreeModelEvent = null;

    //
    //  The getListenerList()  method is guaranteed to return a non-null array.
    //  Processes  the  listeners  last  to first,  notifying  those  that  are
    //  interested in this event.  The \a ChangeEvent object is created lazily.
    //
    aListenerTypeListenerPair = tEventListenerList.getListenerList();
    for (int I = aListenerTypeListenerPair.length-2; ( I >= 0 ) ;I-=2)
    {
      if ( aListenerTypeListenerPair [I] == TreeModelListener.class )
      {
        if ( tTreeModelEvent == null )
        {
          tTreeModelEvent = new TreeModelEvent (this, tTREE_PATH);
        }
        ((TreeModelListener) aListenerTypeListenerPair [I + 1]).treeStructureChanged (tTreeModelEvent);
      }          
    }

  }  // fireTreeStructureChanged()

  protected void fireTreeStructureChanged ( Object   tSOURCE         ,
                                            Object[] atPATH          ,
                                            int[]    aiCHILD_INDICES ,
                                            Object[] atCHILDREN      )
  {

    Object[]         aListenerTypeListenerPair;
    TreeModelEvent   tTreeModelEvent = null;

    //
    //  The getListenerList()  method is guaranteed to return a non-null array.
    //  Processes  the  listeners  last  to first,  notifying  those  that  are
    //  interested in this event.  The \a ChangeEvent object is created lazily.
    //
    aListenerTypeListenerPair = tEventListenerList.getListenerList();
    for (int I = aListenerTypeListenerPair.length-2; ( I >= 0 ) ;I-=2)
    {
      if ( aListenerTypeListenerPair [I] == TreeModelListener.class )
      {
        if ( tTreeModelEvent == null )
        {
          tTreeModelEvent = new TreeModelEvent (tSOURCE, atPATH, aiCHILD_INDICES, atCHILDREN);
        }
        ((TreeModelListener) aListenerTypeListenerPair [I + 1]).treeStructureChanged (tTreeModelEvent);
      }
    }

  }  // fireTreeStructureChanged()


  //
  //  S E L E C T O R S
  //

  public Class getColumnClass (int iCOLUMN)
  {
    return Object.class;
  }

  public int getIndexOfChild (Object tPARENT_NODE, Object tCHILD_NODE)
  {
    int   iChildNodeIndex = -1;

    for (int I = 0; ( I < getChildCount (tPARENT_NODE) ) ;++I)
    {
      if ( getChild (tPARENT_NODE, I).equals (tCHILD_NODE) )
      {
        iChildNodeIndex = I;
        break;
      }
    }
    return iChildNodeIndex;
  }

  public Object getRoot()
  {
    return tRootNode;
  }

  public boolean isCellEditable (Object tNODE, int iCOLUMN)
  { 
    return ( getColumnClass (iCOLUMN) == ITreeTableModel.class );
  }

  public boolean isLeaf (Object tNODE)
  {
    return ( getChildCount (tNODE) == 0 );
  }

}  // class TAbstractTreeTableModel

---