Bearbeiten von „Ein eigenes TreeModel schreiben“

[[Kategorie:Tutorials (Java)]]
TreeModels enthalten die Daten, die ein {{JAPI|JTree}} darstellen soll. In diesem Artikel werden wir uns damit befassen, wie man Schritt für Schritt ein eigenes dynamisches {{JAPI|TreeModel}} aufbaut. Nach der Lektüre dieses Artikels sollte der Leser in der Lage sein, selbstständig eigene TreeModels zu entwickeln. 

==Überblick==
Damit der JTree das darzustellende Datenformat verstehen kann, muss dieses einem entsprechenden Standard genügen. Den kleinsten gemeinsamen Nenner bildet hier das {{JAPI|TreeModel}}. 

Im Gegensatz zu {{JAPI|JTable}} existiert für den JTree keine abstrakte Standardimplementierung seines Datenmodells. JTable bietet hier die [[Klasse]] {{JAPI|AbstractTableModel}} welche das [[Interface]] {{JAPI|TableModel}} implementiert an. Diese Klasse enthält bereits eine einfache Verarbeitung von {{JAPI|TableModelEvent}}s, reagiert also auf Veränderungen im TableModel. AbstractTableModel wird schließlich von {{JAPI|DefaultTableModel}} beerbt, mit dem Tabellen mit Standard-Datentypen wie bspw. {{JAPI|Integer}}, {{JAPI|Double}}, {{JAPI|Float}}, {{JAPI|Boolean}}, {{JAPI|String}}, {{JAPI|Icon}} erzeugt werden können.

'''Mehr zu all dem im großen [[JTable (Tutorial)©]].'''

Eine vergleichbare Klasse ''AbstractTreeModel'' gibt es in der Java-API nicht. Für eigene baumartig strukturierte Datentypen muss hier ein eigenes TreeModel geschrieben werden. Mit {{JAPI|DefaultTreeModel}} gibt es schon eine Standardimplementierung eines TreeModels. Die Daten des Baums werden mit Hilfe von Objekten, die das Interface {{JAPI|TreeNode}} implementieren, dargestellt. Veränderbare Daten erfordern den Einsatz von {{JAPI|MutableTreeNode}}. Eine Standardimplementierung wird bereits mit {{JAPI|DefaultMutableTreeNode}} von der Java-API mitgeliefert.

'''Mehr dazu im großen [[JTree (Tutorial)©]].'''

==Das Interface TreeModel==
Das Interface {{JAPI|TreeModel}} schreibt Methoden vor, die eine Klasse implementieren muss, wenn ein {{JAPI|JTree}} die in ihr enthaltenen Daten grafisch darstellen können soll. 
<syntaxhighlight lang="java">
public interface TreeModel {
   void addTreeModelListener(TreeModelListener l);

   Object getChild(Object parent, int index);

   int getChildCount(Object parent);

   int 	getIndexOfChild(Object parent, Object child);

   Object getRoot();

   boolean isLeaf(Object node);

   void	removeTreeModelListener(TreeModelListener l);

   void valueForPathChanged(TreePath path, Object newValue);
}
</syntaxhighlight>

==Dynamisches TreeModel implementieren==
Nehmen wir an, wir hätten bereits eine eigene Datenstruktur, die die Produktion von Fahrrädern speichert und die wir im JTree präsentieren und zur Laufzeit auch verändern wollen.

Um ein eigenes TreeModel zun implementieren, müssen wir nun also erstmal das {{JAPI|TreeModel}}-[[Interface]] implementieren und damit alle von ihm vorgeschriebenen Methoden überschreiben:

<syntaxhighlight lang="java">
public BicycleTreeModel implements TreeModel {

   public Object getChild(Object parent, int index) {

   }

   public int getChildCount(Object parent) {

   }

   public int getIndexOfChild(Object parent, Object child) {

   }

   public Object getRoot() {

   }

   public boolean isLeaf(Object node) {

   }

   public void removeTreeModelListener(TreeModelListener l) {

   }

   public void addTreeModelListener(TreeModelListener l) {

   }

   public void valueForPathChanged(TreePath path, Object newValue) {

   }
}
</syntaxhighlight>

===TreeModelListener verwalten===
Komponenten wie der JTree interessieren sich für das Geschehen in einem TreeModel und lauschen auf Ereignisse, die sich durch Benutzeraktionen ergeben. Das kann z. B. das Hinzufügen, Ändern oder Löschen von Datenelementen im TreeModel sein.

Damit ein Ereignis-Interessent ({{JAPI|TreeModelListener}}) die Benachrichtigungen über {{JAPI|TreeModelEvent}}s abonieren kann, muss er sich als Abonent registrieren.

Mit der [[Klasse]] {{JAPI|EventListenerList}} gibt es in Java bereits eine fertige Ereignis-Lauscher-Liste, die für alle möglichen [...]ModelListener-Typen eingesetzt werden kann.<br>
Im Folgenden kümmern wir uns also darum, dass wir diese EventListenerList in unser TreeModel einbauen und auch die Möglichkeit schaffen, dass sich Interessenten für die Benachrichtigung über TreeModelEvents an unserem "Abo-Dienst" anmelden und auch von ihm wieder abmelden können. 

Zeit, um den bereits implementierten Methoden <code>addTreeModelListener(TreeModelListener l)</code> und <code>removeTreeModelListener(TreeModelListener l)</code> sinnvollen Code zu geben!
<syntaxhighlight lang="java">
public BicycleTreeModel implements TreeModel {

   private EventListenerList listeners = new EventListenerList();

   [...]

   public void addTreeModelListener(TreeModelListener l) {
      listeners.remove(TreeModelListener.class, listener);
   }

   public void removeTreeModelListener(TreeModelListener l) {
      listeners.add(TreeModelListener.class, listener);
   }

   [...]
}
</syntaxhighlight>

===Ein Konstruktor für unser TreeModel===
Wie wir oben bereits angenommen haben, haben wir vielleicht schon eine Datenstruktur, die die Produktion von Fahrrädern verwaltet und speichert. Dann sollte unser [[Konstruktor]] per Parameter diese Datenstruktur auch übernehmen, um sie dann in unserem TreeModel weiter auslesen, und beschreiben zu können. Vorteil hier; ohne unsere Datenstruktur anpassen zu müssen, können wir diese nun auch über den JTree verwalten und vor allem darstellen.

<syntaxhighlight lang="java">
public BicycleTreeModel implements TreeModel {

   private final EventListenerList listeners = new EventListenerList();
   private final BicycleProduction production;

   public BicycleTreeModel(BicycleProduction production) {
      this.production = production;
   }

   [...]
}
</syntaxhighlight>

{{In Arbeit}}