9.17 Tabellen (JTable)

Mit der Klasse JTable lassen sich auf einfache Weise zweidimensionale Tabellendaten darstellen. Die Java-Bibliothek enthält dafür eine einfache Schnittstelle, die über ein Model und eine eigene Visualisierung ergänzt werden kann. Die vorgefertigte Implementierung bietet schon vieles an, wie zum Beispiel die Änderung der Spaltenbreite, die Navigation über die -Taste oder die Selektion von Spalten oder Zeilen.

Für JTable gibt es einen einfachen Konstruktor, der für die Daten ein zweidimensionales Feld annimmt. Für uns fällt dabei wenig Arbeit an. Das 2D-Feld kann sich aus Object[][] oder auch aus Vektoren von Vektoren zusammensetzen. Intern wird ein Objektfeld jedoch in Vektoren kopiert.

Listing 9.61: com/tutego/insel/ui/table/SimpleTable.java

package com.tutego.insel.ui.table;

import javax.swing.*;

public class SimpleTable
{
  public static void main( String[] args )
  {
    String[][] rowData = {
      { "Japan", "245" }, { "USA", "240" }, { "Italien", "220" },
      { "Spanien", "217" }, {"Türkei", "215"} ,{ "England", "214" },
      { "Frankreich", "190" }, {"Griechenland", "185" },
      { "Deutschland", "180" }, {"Portugal", "170" }
    };

    String[] columnNames =  {
      "Land", "Durchschnittliche Fernsehdauer pro Tag in Minuten"
    };

    JFrame f = new JFrame();
    f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );

    JTable table = new JTable( rowData, columnNames );
    f.add( new JScrollPane( table ) );

    f.pack();
    f.setVisible( true );
  }
}

Wir setzen die Tabelle in eine JScrollPane – auch aus dem Grund, dass dann erst die JTable die Köpfe anzeigt. Beim Scrollen in der Tabelle bleiben die Tabellenköpfe immer stehen. Möchten wir die Spaltennamen extra setzen, nimmt der Konstruktor von JTable im zweiten Argument ein Feld mit Spaltennamen an.

Abbildung 9.45: Einfache Tabelle

9.17.1 Ein eigenes Tabellen-Model

JTable ist ein gutes Beispiel für die Trennung von Daten und Anzeige. Während View und Controller in der Klasse JTable liegen, werden die Daten im Model durch die Schnittstelle TableModel beschrieben. Jeder Datencontainer muss TableModel implementieren und der Anzeige eine Möglichkeit geben, Einträge in einer Zeile und Spalte zu erfragen. Ändert sich das Model, muss zusätzlich die Visualisierung aktualisiert werden. Daher schreibt TableModel einen TableModelListener vor, der die Beobachtung übernimmt.

interface javax.swing.table.TableModel

• Class<?> getColumnClass(int columnIndex)
  Liefert das allgemeinste Klassenobjekt, das die Spalte beschreiben kann.
• int getColumnCount()
  Liefert die Anzahl der Spalten.
• String getColumnName(int columnIndex)
  Gibt den Namen der Spalte columnIndex zurück.
• int getRowCount()
  Liefert die Anzahl der Zeilen.
• Object getValueAt(int rowIndex, int columnIndex)
  Gibt den Eintrag an der Stelle columnIndex und rowIndex zurück.
• void setValueAt(Object aValue, int rowIndex, int columnIndex)
  Setzt den Wert an die gegebene Stelle.
• boolean isCellEditable(int rowIndex, int columnIndex)
  Liefert true, wenn die Zelle an rowIndex und columnIndex editierbar ist.
• void addTableModelListener(TableModelListener l)
  Fügt einen Ereignisbehandler hinzu, der immer dann informiert wird, wenn Daten geändert werden.
• void removeTableModelListener(TableModelListener l)
  Entfernt den Ereignisbehandler.

Abbildung 9.46: Schnittstelle TableModel

Wollen wir auf die inneren Daten zugreifen, benötigen wir das TableModel. Über getModel() lässt sich dies von der JTable erfragen. Wir können die Tabelle auch fragen, welche Zelle selektiert ist.

int col = t.getSelectedColumn();
int row = t.getSelectedRow();
System.out.println( t.getModel().getValueAt(row, col) );

9.17.2 Basisklasse für eigene Modelle (AbstractTableModel)

Für TableModel gibt es schon eine Implementierung als abstrakte Klasse, die uns etwa die Aufgabe abnimmt, Listener an- und abzumelden. In Swing kommt es sehr häufig vor, dass eine Schnittstelle so weit wie möglich von einer Klasse vorimplementiert wird. Dieses Vorgehen ist unter dem Namen Interface/Implementation-Pair bekannt. Die zu TableModel passende Klasse heißt AbstractTableModel und gibt für einige Methoden eine Standardimplementierung vor. AbstractTableModel bietet über eine protected-Variable listenerList Zugriff auf die Listener.

Um ein lauffähiges Model zusammenzubauen, müssen nur noch getColumnCount(), getRowCount() und getValueAt() implementiert werden, dann ist eine Model-Klasse komplett. setValueAt() ist in AbstractTableModel leer implementiert und muss nur bei editierbaren Datenmodellen angepasst werden. isCellEditable() liefert false und muss bei editierbaren Modellen ebenso überschrieben werden. getColumnName() liefert Spaltennamen nach dem Muster A, B, C, ..., Z, AA, AB. getColumnClass() liefert Object.class. Um nach einer Spalte suchen zu können, gibt findColumn(String) den Index der Spalte zurück, die den eingetragenen Namen hat.

Ein Quadratzahlen-Model

Wenn wir eine Tabelle mit Quadrat und Kubus nutzen, können wir ein Model implementieren, das in der ersten Spalte die Zahl, in der zweiten das Quadrat und in der dritten den Kubus abbildet. Die Tabelle verfügt dann über drei Spalten. Sie soll hundert Zeilen groß sein.

Listing 9.62: com/tutego/insel/ui/table/SquareTableModelSimple

package com.tutego.insel.ui.table;

import javax.swing.table.AbstractTableModel;

class SquareTableModelSimple extends AbstractTableModel
{
  @Override public int getRowCount()
  {
    return 100;
  }

  @Override public int getColumnCount()
  {
    return 3;
  }

  @Override public Object getValueAt( int row, int col )
  {
    if ( col == 0 )
      return "" + row;
    else if ( col == 1 )
      return "" + (row * row);
    else
      return "" + (row * row * row);
  }
}

Das Tabellen-Model zuweisen

Verfügen wir über eine Klasse, die ein TableModel implementiert (etwa eine Unterklasse von AbstractTableModel oder DefaultTableModel), so müssen wir ein JTable-Objekt mit diesem Model verbinden. Dafür gibt es zwei Möglichkeiten: Wir können im Konstruktor das Model angeben oder es nachträglich mit setModel(TableModel) zuweisen.

Listing 9.63: com/tutego/insel/ui/table/SquareTable.java, main()

JFrame f = new JFrame();
f.getContentPane().add( new JScrollPane(
  new JTable( new SquareTableModelSimple() ) ) );
f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
f.pack();
f.setVisible( true );

Abbildung 9.47: JTable mit Model

Änderungswünsche

Standardmäßig lassen sich die Zellinhalte nicht ändern. Wenn der Anwender auf eine Zelle klickt, wird es kein Textfeld geben, das eine neue Eingabe ermöglicht. Das ändert sich aber, wenn aus der Schnittstelle TableModel die Methode boolean isCellEditable(int rowIndex, int columnIndex) überschrieben wird und immer dann true liefert, wenn ein Editor eine Änderung der Zelle erlauben soll. Ist diese Änderung für alle Zellen gültig, liefert die Methode immer true; soll zum Beispiel nur die erste Spalte verändert werden dürfen, schreiben wir:

public boolean isCellEditable( int rowIndex, int columnIndex )
{
  return columnIndex == 0;
}

Die Methode isCellEditable() ist aber nur der erste Teil einer Zelländerung. Die JTable (vereinfachen wir es mal) fragt zunächst beim Model über isCellEditable(), ob eine Zelle vom Anwender überhaupt modifiziert werden kann. Wenn das Ergebnis false ist, wird kein Editor angezeigt. Falls das Ergebnis true ist, sucht die JTable einen passenden Editor und ruft nach einer Änderung mit dem neuen Wert die Methode setValueAt(Object aValue, int rowIndex, int columnIndex) auf. Hier muss das Ergebnis in den Datenstrukturen auch wirklich gespeichert werden. Anschließend erfragt die JTable über getValueAt() noch einmal den aktuellen Wert.

void setValueAt( Object aValue, int rowIndex, int columnIndex )
{
  Object oldValue = getValueAt( rowIndex, columnIndex );
}

Ereignisse bei Änderungen

Die Events, die AbstractTableModel auslöst, sind vom Typ TableModelEvent und werden von fireTableDataChanged(), fireTableStructureChanged(), fireTableRowsInserted(), fireTableRowsUpdated(), fireTableRowsDeleted(), fireTableCellUpdated() über die allgemeine Methode fireTableChanged(TableModelEvent) behandelt. Die Methoden zur Ereignisbehandlung sind damit vollständig und müssen von Unterklassen nicht mehr überschrieben werden, es sei denn, wir wollten in einer fire()-Methode Zusätzliches realisieren.

public void setValueAt( Object val, int row, int column )
{
  foo[row][column] = val;
  fireTableCellUpdated( row, column );
}

Die Methode fireTableCellUpdated(int, int) ist nur eine Abkürzung für Folgendes:

public void fireTableCellUpdated(int row, int column) {
  fireTableChanged(new TableModelEvent(this, row, row, column));
}

9.17.3 Ein vorgefertigtes Standard-Modell (DefaultTableModel)

Praktischerweise bringt die Java-Bibliothek schon eine Model-Klasse mit, die wir direkt verwenden können. Dies ist DefaultTableModel, die ebenso eine Unterklasse von AbstractTableModel ist. Nützliche Ergänzungen sind Methoden, mit denen an beliebiger Stelle Zellen eingetragen, verschoben und gelöscht werden können. Nutzen wir JTable ohne eigenes Model, so verwendet es standardmäßig DefaultTableModel mit einer Implementierung von Vektoren aus Vektoren. Ein Hauptvektor speichert Vektoren für jede Zeile. Die Technik lässt sich gut an einer Methode ablesen:

public Object getValueAt( int row, int column )
{
  Vector rowVector = (Vector) dataVector.elementAt( row );
  return rowVector.elementAt( column );
}

Mit den Methoden setDataVector() und getDataVector() lassen sich die Daten intern setzen und auslesen. Diese interne Abbildung der Daten ist jedoch nicht immer erwünscht, da dynamische Strukturen von der Laufzeit her ineffizient sein können. Ist das zu unflexibel, lässt sich immer noch ein eigenes Model von AbstractTableModel ableiten.

Abbildung 9.48: Obertypen von DefaultTableModel

9.17.4 Ein eigener Renderer für Tabellen

Damit eine Tabelle nicht nur die typischen Informationen in Zeichenketten darstellen muss, lässt sich ein TableCellRenderer einsetzen, mit dem man die Tabelleneinträge beliebig visualisieren kann. Die Schnittstelle TableCellRenderer schreibt nur eine Operation vor.

interface javax.swing.table.TableCellRenderer

• Component getTableCellRendererComponent(JTable table, Object value,
  boolean isSelected, boolean hasFocus, int row, int column)

Die Informationen über isSelected, hasFocus, row und column sollen der Zeichenmethode die Möglichkeit geben, ausgewählte Tabellenteile besonders zu behandeln. Steht etwa auf einer Zelle der Fokus, ist ein Rahmen gezeichnet. Ist die Tabelle selektiert, so ist die Zelle mit einer Hintergrundfarbe ausgeschmückt.

DefaultTableCellRenderer

Swing bietet eine Standardimplementierung in Form der Klasse DefaultTableCellRenderer. Diese Klasse erweitert JLabel, und damit lässt sich schon viel anfangen, denn das Ändern des Textes ist genauso einfach wie das Ändern der Farbe oder das Hinzufügen eines Bilds. Viele Aufgaben sind so schon erledigt. Wenn es aufwändiger realisiert werden soll, dann müssen wir direkt TableCellRenderer implementieren.

Für unsere Zwecke soll DefaultTableCellRenderer genügen. Die wichtigste Methode zum Überschreiben ist setValue(Object). In DefaultTableCellRenderer sieht die Originalmethode wie folgt aus:

protected void setValue( Object value ) {
  setText( (value == null) ? "" : value.toString() );
}

Da JTable diesen Renderer als Standard nutzt, sagt dies aus, dass alle Daten in der Tabelle als String-Repräsentation eingesetzt werden.

Wenn wir eigene Visualisierungen wünschen, zum Beispiel mit einer anderen Schriftfarbe, so überschreiben wir einfach setValue() und setzen den Text mit setText() selbst. Die günstige Eigenschaft, dass DefaultTableCellRenderer eine Unterklasse von JLabel ist, macht sich auch bei setForeground() bemerkbar.

Abbildung 9.49: UML-Diagramm von DefaultTableCellRenderer

Liegen im Model einer JTable nicht nur Daten einer Gattung, so lassen sie sich mit instanceof aufschlüsseln. Unserer Tabelle mit den Quadrat- und Kubuszahlen wollen wir einen Renderer mitgeben. Er soll die geraden Zahlen in Blau anzeigen und die ungeraden in Grau:

Listing 9.64: com/tutego/insel/ui/table/ColoredTableCellRenderer.java

package com.tutego.insel.ui.table;

import java.awt.*;
import javax.swing.table.*;

class ColoredTableCellRenderer extends DefaultTableCellRenderer
{
  @Override
  public void setValue( Object value )
  {
    if ( value instanceof Long )
    {
      setForeground( (Long) value % 2 == 0 ? Color.BLUE : Color.GRAY );

      setText( value.toString() );
    }
    else
      super.setValue( value );
  }
}

Die Typanpassung (Long) value veranlasst den Compiler, das long mittels Unboxing aus dem value-Objekt zu extrahieren.

public void setValue( Object value )
{
  if ( value instanceof Gfx ) {
    Gfx gfx = (IconData) value;
    setIcon( gfx.icon );
  }
  else {
    setIcon( null );
    super.setValue( value );
  }
}

Renderer zuweisen

Ein Renderer übernimmt nicht die Darstellung von allen Zellen, sondern nur die von bestimmten Typen. Daher erwartet die Methode setDefaultRenderer() von JTable neben dem Renderer ein Class-Objekt. Nimmt die JTable aus dem Model ein Objekt heraus, erfragt es den Typ und lässt den Zelleninhalt von dem Renderer zeichnen, der mit diesem Typ verbunden ist:

Listing 9.65: com/tutego/insel/ui/table/SquareTableWithRenderer.java, Ausschnitt

TableCellRenderer ren = new ColoredTableCellRenderer();
table.setDefaultRenderer( Long.class, ren );

Stellt die Tabelle ein Element vom Typ Long.class dar, so überlässt sie die Visualisierung dem zugewiesenen ColoredTableCellRenderer. Der Typ Object.class passt auf alle Zelleninhalte.

Mehrzeilige Tabellenzellen

Der DefaultTableCellRenderer ist eine Unterklasse von JLabel, die mehrzeilige Textfelder durch die HTML-Darstellung unterstützt. Für einen Text müsste etwa <HTML>Zeile1-<BR>Zeile2</HTML> geschrieben werden. Eine andere Möglichkeit besteht darin, einen eigenen Renderer zu implementieren, der nicht von DefaultTableCellRenderer abgeleitet ist. Eine weitere Lösung ist, JTextArea als Oberklasse zu nutzen und die notwendige Schnittstelle TableCellRenderer zu implementieren. Die implementierte Methode getTableCellRendererComponent() liefert dann das this-Objekt (das JLabel) zurück, das mit dem Text inklusive Zeilenumbruch gesetzt ist:

Listing 9.66: com/tutego/insel/ui/table/TwoLinesCellRenderer.java, TwoLinesCellRenderer

public class TwoLinesCellRenderer extends JTextArea implements TableCellRenderer
{
  @Override public Component getTableCellRendererComponent(
    JTable table, Object value,
    boolean isSelected, boolean hasFocus, int row, int column )
  {
    setText( value.toString() );    // Value kann String mit \n enthalten

    return this;
  }
}

9.17.5 Zell-Editoren

Anders als bei der JList kann der Benutzer die Zellen einer JTable editieren. Erlaubt das Tabellen-Model eine Veränderung, so stellt die JTable vordefiniert eine Texteingabezeile dar. Ein eigener Editor implementiert die Schnittstelle javax.swing.table.TableCellEditor mit einer Methode getTableCellEditorComponent(), die die Editor-Komponente liefert. Das kann zum Beispiel ein JTextField sein. Nach der Bearbeitung erfragt die JTable das Ergebnis über die Methode getCellEditorValue(). Auch diese Methode schreibt die Schnittstelle (indirekt) vor:

Listing 9.67: com/tutego/insel/ui/table/SimpleTableCellEditor.java

package com.tutego.insel.ui.table;

import java.awt.Component;
import javax.swing.*;
import javax.swing.table.TableCellEditor;

public class SimpleTableCellEditor
  extends AbstractCellEditor
  implements TableCellEditor
{
  private JTextField component = new JTextField();

  @Override public Component getTableCellEditorComponent(
      JTable table, Object value,
      boolean isSelected, int rowIndex, int colIndex )
  {
    component.setText( value.toString() );

    return component;
  }

  @Override public Object getCellEditorValue()
  {
    return component.getText();
  }
}

Die Schnittstelle TableCellEditor selbst deklariert nur die Methode getTableCellEditorComponent(), doch weil CellEditor die Ober-Schnittstelle ist, ergeben sich insgesamt 1 + 7 zu implementierende Methoden. CellEditor ist eine ganz allgemeine Schnittstelle für beliebige Zellen, etwa auch für die Zellen in einem JTree-Objekt. Die abstrakte Basisklasse AbstractCellEditor implementiert bis auf getCellEditorValue() alle Operationen aus CellEditor. Und da unsere Klasse die Schnittstelle TableCellEditor annehmen muss, bleibt es bei der Implementierung von getCellEditorValue() und getTableCellEditorComponent().

9.17.6 Größe und Umrandung der Zellen *

Jede Zelle hat eine bestimmte Größe, die durch den Zellinhalt vorgegeben ist. Zusätzlich liegt zwischen zwei Zellen immer etwas Freiraum. Dieser lässt sich mit getIntercellSpacing() erfragen und mit setIntercellSpacing() setzen:

table.setIntercellSpacing( new Dimension(gapWidth, gapHeight) );

Soll die Zelle rechts und links zum Beispiel 2 Pixel Freiraum bekommen, ist gapWidth auf 4 zu setzen, denn das Dimension-Objekt gibt immer den gesamten vertikalen und horizontalen Abstand zwischen den Zellen an.

Die Gesamtgröße einer Zelle ist dann die der Margin-Zeile + Zellhöhe beziehungsweise Margin-Spalte + Zellbreite. Da jedoch setIntercellSpacing() die Höhe einer Zeile nicht automatisch anpasst, muss sie ausdrücklich gesetzt werden:

table.setRowHeight( table.getRowHeight() + gapHeight );

Zusätzlich zur Margin erhöht eine Linie den Abstand zwischen den Zellen. Auch dieses Raster (engl. grid) lässt sich modifizieren:

9.17.7 Spalteninformationen *

Alle Zelleninformationen der Tabelle stecken im Model einer JTable. Informationen über die Spalten stehen allerdings nicht im TableModel, sondern in Objekten vom Typ TableColumn. Jede Spalte bekommt ein eigenes TableColumn-Objekt, und eine Sammlung der Objekte bildet das TableColumnModel, das wie das TableModel ein Datencontainer der JTable ist.

for ( Enumeration enum = table.getColumnModel().getColumns();
      enum.hasMoreElements(); )
  System.out.println( (TableColumn)eum.nextElement() );

getColumns() bezieht eine Enumeration von TableColumn-Objekten. Soll ein ganz bestimmtes TableColumn-Objekt untersucht werden, kann auch die Methode getColumn(index) genutzt werden.

Liegt ein TableColumn-Objekt vor, lässt sich von diesem die aktuelle minimale und maximale Breite setzen.

table.getColumnModel().getColumn( 0 ).setPreferredWidth( 100 );

AUTO_RESIZE

Verändert der Anwender die Breite einer Spalte, ändert er entweder die Gesamtbreite einer Tabelle, oder er ändert automatisch die Breite der anderen Spalten, um die Gesamtbreite nicht zu verändern. Hier gibt es für die JTable unterschiedliche Möglichkeiten, die eine Methode setAutoResizeMode(int mode) bestimmt. Erlaubte Modi sind Konstanten aus JTable und AUTO_RESIZE_OFF, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_SUBSEQUENT_COLUMNS, AUTO_RESIZE_ LAST_COLUMN, AUTO_RESIZE_ALL_COLUMNS. Sinnvoll sind drei von ihnen:

• AUTO_RESIZE_SUBSEQUENT_COLUMNS: Der Standard. Verändert gleichmäßig die Breiten aller rechts liegenden Spalten.
• AUTO_RESIZE_NEXT_COLUMN: Ändert nur die Breite der nachfolgenden Spalte.
• AUTO_RESIZE_OFF: Ändert die Größe der gesamten Tabelle. Ist nur sinnvoll, wenn die JTable in einer JScrollPane liegt.

9.17.8 Tabellenkopf von Swing-Tabellen *

Der Kopf (engl. header) einer JTable ist ein JTableHeader-Objekt, das von der JTable mit getTableHeader() erfragt werden kann. Dieses JTableHeader-Objekt ist für die Anordnung und Verschiebung der Spalten verantwortlich. Diese Verschiebung kann über das Programm erfolgen (moveColumn()) oder über den Benutzer per Drag & Drop.

table.getTableHeader().setReorderingAllowed( false );
table.getTableHeader().setResizingAllowed( false );

Hier wird deutlich, dass ein JTableHeader die Steuerung der Ausgabe und der Benutzerinteraktion übernimmt, dass aber die Informationen selbst in TableColumn liegen.

9.17.9 Selektionen einer Tabelle *

In einer JTable können auf unterschiedliche Art und Weise Zellen selektiert werden: zum einen nur in einer Zeile oder Spalte, zum anderen kann auch ein ganzer Block oder können auch beliebige Zellen selektiert werden. Die Art der Selektion bestimmen Konstanten in ListSelectionModel. So wird SINGLE_SELECTION nur die Selektion einer einzigen Zelle zulassen.

table.setSelectionMode( ListSelectionModel.SINGLE_INTERVAL_SELECTION );

Mit Methoden lassen sich im Programm alle Elemente einer Spalte oder Zeile selektieren. Die Selektier-Erlaubnis geben zunächst zwei Methoden:

table.setColumnSelectionAllowed( boolean );
table.setRowSelectionAllowed( boolean );

Die Selektion von Spalten gelingt mit setColumnSelectionInterval(), weitere Bereiche lassen sich mit addColumnSelectionInterval() hinzufügen und mit removeColumnSelectionInterval() entfernen. Das Gleiche gilt für die Methoden, die »Row« im Methodennamen tragen.

Schauen wir uns einige Beispiele an: Selektiere in einer JTable table die Spalte 0 komplett:

table.setSelectionMode( ListSelectionModel.MULTIPLE_INTERVAL_SELECTION );
table.setColumnSelectionAllowed( true );
table.setRowSelectionAllowed( false );
table.setColumnSelectionInterval( 0, 0 );

Selektiere in einer Tabelle nur die Zelle 38, 5:

table.setSelectionMode( ListSelectionModel.SINGLE_SELECTION  );
table.setColumnSelectionAllowed( true );
table.setRowSelectionAllowed( true );
table.changeSelection( 38, 5, false, false );

Als Selektionsmodus reicht SINGLE_SELECTION aus, MULTIPLE_INTERVAL_SELECTION wäre aber auch in Ordnung. Beide Selektionen sind zusammen in der Form nicht möglich. Bei einer Einzelselektion wird die Zelle nur umrandet, aber nicht wie beim Standard-Metal-Look-and-Feel blau ausgefüllt.

Die Methode selectAll() selektiert alle Elemente, und clearSelection() löscht alle Selektionen.

9.17.10 Automatisches Sortieren und Filtern mit RowSorter *

Nicht immer sollen alle Daten aus dem Modell so in der Tabelle angezeigt werden. Mitunter ist nur ein Ausschnitt interessant, oder für die Anzeige sollen Werte sortiert werden. All das kann über eine Änderung des Models gemacht werden, aber das ist nicht flexibel. Stattdessen sieht die Java-Bibliothek einen RowSorter vor, auf den die JTable zurückgreift, um auch ohne Änderungen am eigenen Modell Elemente herauszufiltern oder Spalten zu sortieren.

Wir wollen eine einfache JTable mit folgendem Model verwenden, die der RowSorter anschließend dekorieren soll:

Listing 9.68: TableWithRowSorter.java, main() – Ausschnitt

TableModel model = new DefaultTableModel( 100, 3 ) {
  @Override public Object getValueAt( int row, int column ) {
    return "" + (int) Math.pow( row, column + 1 );
  }
};
final JTable table = new JTable( model );

An dem Beispiel ist abzulesen, dass das ursprüngliche model direkt an JTable geht. Der TableRowSorter ist eine Implementierung vom RowSorter und bekommt das ursprüngliche TableModel im Konstruktor übergeben:

Listing 9.69: TableWithRowSorter.java, main() – Ausschnitt

final TableRowSorter<TableModel> rowSorter = new TableRowSorter<TableModel>( model );
table.setRowSorter( rowSorter );

Starten wir das Programm, ist schon eine Sortierung eingebaut, allerdings nur auf String-Ebene, sodass etwa »19« < »2« < »20« ist. Mit einem Klick auf die Kopfzeile der Tabelle zeigt ein kleiner Pfeil die Sortierrichtung an.

Comparator für die Sortierung zuweisen

Da der RowSorter standardmäßig die Inhalte als String sortiert, wollen wir im nächsten Beispiel für die erste Spalte einen Comparator deklarieren, der nach der Anzahl der gesetzten Bits geht:

Listing 9.70: TableWithRowSorter.java, main() – Ausschnitt

rowSorter.setComparator( 0, new Comparator<String>() {
  @Override public int compare( String s1, String s2 )
  {
    int i1 = Integer.parseInt( s1 ), i2 = Integer.parseInt( s2 );
    return Integer.bitCount( i1 ) – Integer.bitCount( i2 );
  }
} );

Die zweite Spalte soll nicht sortierbar sein, sodass wir die Sortierung abschalten:

Listing 9.71: TableWithRowSorter.java, main() – Ausschnitt

rowSorter.setSortable( 1, false );

Die dritte Spalte bleibt weiterhin mit der String-Sortierung.

Filter

Auf die Ergebnismenge lassen sich Filter anwenden, die Elemente herausnehmen. Es gibt einige vordefinierte Filter, die die statischen Methoden dateFilter(), numberFilter() und regexFilter() von RowFilter liefern. Mit setRowFilter() wird er zugewiesen:

Listing 9.72: TableWithRowSorter.java, main() – Ausschnitt

rowSorter.setRowFilter( RowFilter.regexFilter("(0|2|4|6|8)$", 2) );

Der RowFilter lässt alle geraden Zahlen in der dritten Spalte durch – das filtert alle Zeilen heraus, in denen der Wert der dritten Spalte ungerade ist.

Stellungswechsel

Wird eine Zelle in der Tabelle angeklickt und meldet ein Listener den Klick, müssen wir natürlich das richtige Tabellen-Modell nach den Daten fragen. Es gibt einmal das originale Modell und einmal das Modell vom TableRowSorter. Wir müssen daran denken, dass TableRowSorter das originale Modell dekoriert, und daher sind Anfragen am originalen Tabellenmodell nicht zielführend, wenn Zeilen ausgefiltert wurden. Ein Listener zeigt das:

Listing 9.73: TableWithRowSorter.java, main() – Ausschnitt

table.addMouseListener( new MouseAdapter()
{
  @Override
  public void mouseClicked( MouseEvent e )
  {
    int rowAtPoint    = table.rowAtPoint( e.getPoint() );
    int columnAtPoint = table.columnAtPoint( e.getPoint() );
    System.out.printf( "%d/%d%n", rowAtPoint, columnAtPoint );

    int convertedRowAtPoint = rowSorter.convertRowIndexToModel( rowAtPoint );
    int convertedColumAtPoint = table.convertColumnIndexToModel( columnAtPoint );
    System.out.println( rowSorter.getModel().getValueAt( convertedRowAtPoint,
                                                         convertedColumAtPoint) );
  }
} );

Nehmen wir einen Klick auf die Positionen 2/0 an, was für die dritte Zeile und erste Spalte steht. Es ist dann rowAtPoint = 2 und columnAtPoint = 0. Fragen wir bei dem originalen Modell nach, das die Zahlen 0, 1, 2, 3, ... repräsentiert, bekommen wir bei getValueAt(2,0) eine 2. In der Darstellung steht aber keine 2 in der dritten Zeile, sondern eine 4. Und die 4 kommt aus dem internen Modell von RowSorter. Also muss gemappt werden, und das ist die Aufgabe von convertRowIndexToModel(2), das 4 liefert.

Wenn die Spalte zum Beispiel per Drag & Drop verschoben wurde, muss auch columnAtPoint gemappt werden. Das übernimmt die Tabelle selbst, und sie deklariert eine Methode convertColumnIndexToModel(). Da der RowSorter – wie der Name schon sagt – nur auf Zeilen arbeitet, ist bei ihm die Methode nicht zu finden.

Alternative Implementierungen

Eine Alternative beziehungsweise Erweiterung zu den in Java 6 eingefügten Klassen bieten die zwei folgenden Lösungen:

• JXTable (http://swinglabs.org/) ist eine quelloffene und frei verfügbare Erweiterung einer JTable, die Sortierung, Hervorhebung und Filterung einfach unterstützt. Zu SwingX kommen wir später noch.
• Renderpack Render Pipelines (https://renderpack.dev.java.net/) hat keine Abhängigkeit zur JTable (oder JList), sondern definiert allgemeine Swing-Renderer.

Sie funktionieren auch vor Java 6, also unter Java 5 und älter.

Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen.