15.16 Auswahlmenüs, Listen und Spinner

15.16.1 Auswahlmenü (JComboBox)

Ein Auswahlmenü (engl. choice box, auch combo box) zeigt eine Zeichenkette aus einer Liste von Möglichkeiten an. Wird die Choice-Box aufgeklappt, kann ein Element aus der List-Box gewählt werden. Ein neuer Eintrag erscheint dann im Titel des Menüs.

Die JComboBox ist das Swing-Auswahlmenü, das optional ein Textfeld zur Eingabe anbietet. In diesem Textfeld können Texte in beliebigen Modellen dargestellt und ausgewählt werden; ein Tastendruck lässt die Liste zu dem Eintrag springen, dessen Buchstabe eingegeben wurde. Ob das Textfeld editiert werden kann, bestimmt setEditable(). Befinden sich zu viele Einträge in der Liste, stellt Swing automatisch eine scrollende Liste dar. Ab welcher Anzahl von Elementen die scrollende Liste dargestellt wird, bestimmt setMaximumRowCount(). Mit addItem() lassen sich Elemente dem assoziierten ComboBoxModel hinzufügen, mit removeItem() wieder entfernen, und getItemAt(index) erfragt ein Element. Das aktuell ausgewählte Element erfahren wir mit getSelectedItem() und den Index mit getSelectedIndex().

Abbildung 15.17 Beispiel einer JComboBox

Beim Auswählen eines Eintrags wird ein Action- und ItemEvent ausgelöst, mit dem wir das ausgewählte Objekt erfragen können.

Listing 15.40 com/tutego/insel/ui/list/JComboBoxDemo.java

package com.tutego.insel.ui.list; 
 
import java.awt.*; 
import java.awt.event.*; 
import javax.swing.*; 
 
public class JComboBoxDemo 
{ 
  public static void main( String[] args ) 
  { 
    JFrame frame = new JFrame(); 
    frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
 
    String[] lang = { 
      "Patronengurt", "Hausnummer", "Schmetterling", "Sphinx", "Anbetung", 
      "Ende" 
    }; 
 
    // First JComboBox 
 
    JComboBox combo1 = new JComboBox(); 
 
    for ( String s : lang ) 
      combo1.addItem( s ); 
 
    frame.add( combo1, BorderLayout.LINE_START ); 
 
    combo1.addActionListener( new ActionListener() { 
      public void actionPerformed( ActionEvent e ) 
      { 
        System.out.println( e ); 
        JComboBox selectedChoice = (JComboBox) e.getSource(); 
        if ( selectedChoice.getSelectedItem().equals( "Ende" ) ) 
          System.exit( 0 ); 
      } 
    } ); 
 
    // Second JComboBox 
 
    JComboBox combo2 = new JComboBox( lang ); 
 
    combo2.setEditable( true ); 
    combo2.setSelectedItem( "Sphinx" ); 
    combo2.setMaximumRowCount( 4 ); 
 
    frame.add( combo2, BorderLayout.LINE_END ); 
 
    frame.pack(); 
    frame.setVisible( true ); 
  } 
}

Die Methode addItem() funktioniert nur dann, wenn im Konstruktor kein spezielles Model angegeben wurde. Mit Modellen werden wir uns zu einem späteren Zeitpunkt näher beschäftigen. Sehen wir uns zunächst die Konstruktoren an.

class javax.swing.JComboBox 
extends JComponent 
implements ItemSelectable, ListDataListener, ActionListener, Accessible

• JComboBox() Erzeugt ein leeres Auswahlmenü mit einem Standardmodel.

• JComboBox( Object[] items ) Erzeugt ein Auswahlmenü mit Elementen, die im Feld items angegeben sind.

• JComboBox( Vector items ) Erzeugt ein Auswahlmenü mit Elementen, die im Vektor items abgelegt sind.

• JComboBox( ComboBoxModel aModel ) Erzeugt ein Auswahlmenü mit einem Combo-Box-Model, das die Daten speichert.

Zur Selektion beziehungsweise Abfrage selektierter Elemente bietet die Klasse weitere Funktionen an:

• Object getSelectedItem() Liefert die aktuelle Wahl zurück.

• Object[] getSelectedObjects() Liefert ein Array mit den selektierten Einträgen.

• int getSelectedIndex() Liefert den Index des aktuell selektierten Eintrags.

• void setSelectedIndex( int position ) Setzt den Eintrag im Titel des Menüs auf den Eintrag mit der Nummer position.

• void setSelectedItem( Object anObject ) Setzt den Eintrag string in die Titelleiste, wenn dieser in der Liste ist. Falls mehrere Einträge gleich dem string sind, wird jener Eintrag verwendet, der zuerst gefunden wurde. Dieser besitzt dann also den kleinsten Index.

Durchreiche-Methoden an das Model

Elemente lassen sich jetzt hinzufügen und löschen. Etwas seltsam erscheint uns die Tatsache, dass die JComboBox selbst diese Methoden anbietet. Ähnliche Swing-Komponenten (wie die JList oder JTable) bieten diese Anfrage- und Veränderungsmethoden nicht an, sondern erwarten direkt eine Änderung am Model und nicht an der Komponente. Das Besondere an Swing-Komponenten ist ja gerade, dass das Model verändert und abgefragt wird. Im Fall der JComboBox speichert sie die Daten natürlich immer noch nicht selbst, sondern leitet sie an das Model weiter. So sind diese Methoden nur Durchreiche-Methoden.

class javax.swing.JComboBox 
extends JComponent 
implements ItemSelectable, ListDataListener, ActionListener, Accessible

• void addItem( Object anObject ) Fügt dem Model einen Eintrag hinzu.

• Object getItemAt( int index ) Liefert den Eintrag an der Position index. Die Rückgabe ist null, wenn sich der Index außerhalb des Bereichs befindet.

• int getItemCount() Liefert die Anzahl der Einträge im Auswahlmenü.

• void insertItemAt( Object anObject, int index ) Fügt einen Eintrag an einer bestimmten Stelle ein.

• void removeItem( Object anObject ) Löscht den Eintrag aus der Liste.

• void removeItemAt( int position ) Löscht den Eintrag an der Position position.

• void removeAll() Entfernt alle Einträge aus dem Auswahlmenü.

Die Methoden zum Modifizieren des Models funktionieren nur dann, wenn das ComboBox-Model insbesondere ein MutableComboBoxModel ist.

Ereignisse der JComboBox

Die JComboBox löst bei der Selektion zwei Arten von Ereignissen aus: ActionEvents und Item Events. Seit Java 1.4 lässt sich auch ein PopupMenuListener hinzufügen. Zum An- und Abmelden dienen die üblichen Methoden. Der Unterschied in den Ereignissen ActionEvent und ItemEvent ist:

• Der ActionListener empfängt nur ein Ereignis bei einem neu gewählten Element.

• Der ItemListener empfängt alle Veränderungen bei Selektionen. Das heißt, wenn der Benutzer ein neues Element anwählt, gibt es ein Ereignis für die Deselektion und eins für die Selektion. Geht der Benutzer etwa mit der Cursor-Taste durch die Liste, rasselt es an Ereignissen.

class javax.swing.JComboBox 
extends JComponent 
implements ItemSelectable, ListDataListener, ActionListener, Accessible

• void addItemListener( ItemListener aListener )

• void removeItemListener( ItemListener aListener )

• void addActionListener( ActionListener l )

• void removeActionListener( ActionListener l )

Wenn die Box mit setEditable(true) editierbar gemacht wurde und der Benutzer im Textfeld eine Eingabe tätigte, wird ebenfalls der ActionListener informiert. Dann lässt sich jedoch nicht mehr direkt der Ursprung des ActionEvents ersehen. Standardmäßig bleibt die Selektion unverändert, und insbesondere wird das Element nicht automatisch in das Model übertragen.

15.16.2 Zuordnung einer Taste mit einem Eintrag

Bei der Benutzung einer JComboBox möchten Benutzer gern Elemente schnell per Tastatur auswählen. Ist etwa eine sortierte Auswahl mit Zeichenketten gegeben, sollte ein getippter Buchstabe zum ersten Eintrag führen, der mit diesem Buchstaben beginnt. Diese Funktionalität ist in Swing schon vorprogrammiert, kann aber noch erweitert werden. Dazu gilt es, einen KeySelectionManager zu implementieren. Dieser verbindet mit der gedrückten Taste (char) einen Index in der ComboBox (int).Unser nächstes Beispiel soll zeigen, wie eine Liste mit den ersten Buchstaben des Alphabets mit der Tastenauswahl 1, 2, 3 verbunden wird. Der interessanteste Teil ist die innere Klasse, die die Schnittstelle JComboBox.KeySelectionManager implementiert.

Listing 15.41 com/tutego/insel/ui/list/JComboBoxKeySelection.java

package com.tutego.insel.ui.list; 
 
import javax.swing.*; 
 
class JComboBoxKeySelection 
{ 
  public static void main( String[] args ) 
  { 
    JFrame frame = new JFrame(); 
    frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
 
    JComboBox cb = new JComboBox( "A,B,C".split(",") ); 
 
    cb.setKeySelectionManager( new JComboBox.KeySelectionManager() 
    { 
      public int selectionForKey( char aKey, ComboBoxModel aModel ) 
      { 
 
        int pos = Math.abs( aKey – 1 – '0' ); 
 
        return pos >= aModel.getSize() ? aModel.getSize() – 1 : pos; 
      } 
    } ); 
    frame.add( cb ); 
 
    frame.pack(); 
    frame.setVisible( true ); 
  } 
}

Die Methode selectionForKey() bekommt den ausgewählten Buchstaben und das Model. Dieses Model ist nicht so unnötig, wie es auf den ersten Blick erscheint, denn es ist wichtig, aus ihm die maximale Anzahl an Elementen auszulesen, damit es zu keiner fehlerhaften Rückgabe kommt. Eine Bedingung testet, ob eine Auswahl getätigt wird, die zu einem ungültigen Eintrag führen würde.

15.16.3 Datumsauswahl

Einen Dialog oder eine Komponente zur Auswahl eines Datums liefert Java nicht aus. Auf dem freien Markt gibt es allerdings einige Komponenten, die das nachliefern. Unter ihnen sind:

• JXDatePicker vom SwingX-Projekt (https://swingx.dev.java.net/) zeigt Wochen eines Monats an. Eine Vorstellung gibt die Seite http://www.javalobby.org/java/forums/t45447.html.

• DateComboBox von Rob MacGrogan bietet eine Combo-Box für Datumseingaben. Die freie Bibliothek unter http://pswing.sourceforge.net/ blendet neben einem Textfeld eine Schaltfläche zur Datumsauswahl an.

15.16.4 Listen (JList)

Eine JList zeigt in einer Spalte [Üblicherweise wählt die Liste eine Spalten-Darstellung. Eine JList kann jedoch die Einträge auch horizontal anordnen. ] einige Mengen von Einträgen, aus denen der Benutzer wählen kann.

String[] listData = { 
  "Shinguz", "Glapum'tianer", "Suffus", "Zypanon", "Tschung" }; 
JComponent jList = new JList( listData );

Statt dem Konstruktor in einem Feld die Daten zu geben, nimmt er auch Daten in einem Vector an.

class javax.swing.JList 
extends JComponent 
implements Scrollable, Accessible

• JList() Erzeugt eine neue leere List-Box.

• JList( Object[] listData )

• JList( Vector listData ) Erzeugt eine Liste mit Daten, die dem Feld oder dem Vektor entstammen.

Ein einfaches Listen-Model

Eine JList verwaltet Einträge immer in einem Listen-Modell. Üblicherweise findet nicht der Konstruktor mit dem Objekt-Feld oder Vector Verwendung – der ein internes immutables Listen-Modell aufbaut –, sondern ein Konstruktor, der ein eigenes Listen-Modell annimmt.

Ein Standard-Listenmodell, welches von der API dem java.util.Vector zum Verwechseln ähnlich sieht, ist das DefaultListModel; Elemente lassen sich zu diesem Model einfach mit addElement()hinzufügen.

Listing 15.42 com/tutego/insel/ui/list/JListDemo.java

package com.tutego.insel.ui.list; 
 
import javax.swing.*; 
import javax.swing.event.*; 
 
public class JListDemo 
{ 
  public static void main( String[] args ) 
  { 
    JFrame frame = new JFrame( "Levels of Happiness" ); 
    frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
 
    final DefaultListModel lykkeligModel = new DefaultListModel(); 
 
    for ( String s : ("1. Denmark,2. Switzerland,3. Austria," + 
                      "4. Iceland,5. Bahamas,35. Germany," + 
                      "174. Ukraine,178. Burundi,Ende").split(",") ) 
      lykkeligModel.addElement( s ); 
 
    JList l = new JList( lykkeligModel ); 
 
    l.addListSelectionListener( new ListSelectionListener() { 
      public void valueChanged( ListSelectionEvent e ) { 
        if ( e.getValueIsAdjusting() ) 
          return; 
 
        System.out.println( e ); 
 
        if ( lykkeligModel.get( e.getLastIndex() ).equals( "Ende" ) ) 
          System.exit( 0 ); 
      } 
    } ); 
 
    frame.add( new JScrollPane(l) ); 
    frame.pack(); 
    frame.setVisible( true ); 
  } 
}

Die JList stellt die Einträge über einen Listen-Renderer an. Bei der Auswahl eines Eintrags und beim Doppelklick löst die Komponente ein ListSelectionEvent aus, die ein ListSelectionListener meldet. Die Methode getValueIsAdjusting() vom ListSelectionEvent liefert true, wenn der Benutzer den Selektionsvorgang noch nicht abgeschlossen hat, zum Beispiel mit einem Mausklick ein Element selektiert hat und mit gedrückter Maustaste auf andere Elemente geht. Aus dem ListSelectionEvent erfragt getLastIndex() das Ende des Selektionsbereiches, so dass get() vom Listen-Model das Element erfragen kann.

class javax.swing.JList 
extends JComponent 
implements Scrollable, Accessible

• JList( ListModel dataModel ) Erzeugt die Liste mit einem spezifischen Model.

• Da das Model die Daten beinhaltet, fehlen der JList-Komponente die Modifikationsfunktionen.

Einen Eintrag selektieren

Eine JList kann nicht nur ein selektiertes Element besitzen, sondern auch eine Gruppe von Elementen (Intervall genannt) können markiert sein. Welche Selektionsart möglich ist, bestimmt ein internes ListSelectionModel, welches drei Konstanten definiert.

• SINGLE_SELECTION. Nur ein Element darf zur gleichen Zeit selektiert sein.

• MULTIPLE_INTERVAL_SELECTION. Eine zusammenhängende Gruppe von Elementen dürfen selektiert sein.

• SINGLE_INTERVAL_SELECTION. Auch nicht zusammenhängende Elemente können selektiert sein.

Eine neue Selektionsart weist der JList die Methode setSelectionMode(int selectionMode) zu, der eine der drei genannten Konstanten übergeben wird.

Bei jeder Änderung der Selektion meldet die JList ein ListSelectionEvent, auf die ein ListSelectionListener reagiert. Die Erweiterung von EventObject definiert drei Operationen:

class javax.swing.event.ListSelectionEvent 
extends EventObject

• int getFirstIndex()

• int getLastIndex()

• boolean getValueIsAdjusting()

Die Methoden haben wir im Beispielprogramm schon genutzt.

Außer im Ereignislistener auf die Selektionseigenschaften zuzugreifen, bietet die JList einige praktische Methoden (wie getSelectedIndex()), die bei einer einfachen Selektion direkt den Index des markierten Elements geben.

class javax.swing.JList 
extends JComponent 
implements Scrollable, Accessible

• void clearSelection() Löscht vorgenommene Selektionen.

• int getSelectedIndex() Liefert die Position des selektierten Eintrags und –1, wenn kein Element gewählt wurde.

• int[] getSelectedIndices() Liefert die Positionen aller selektierten Einträge.

• Object getSelectedValue() Liefert den gewählten Wert oder null.

• Object[] getSelectedValues() Liefert alle gewählten Werte.

• void setSelectionMode( int selectionMode ) Setzt den Selektionsmodus. Das Argument kann die Werte ListSelection-Model.SINGLE_SELECTION (nur ein Eintrag), SINGLE_INTERVAL_SELECTION (mehrere Werte, aber in einem Intervall) oder, was der Standard ist, MULTIPLE_INTERVAL_SELECTION (beliebige Anzahl von Selektionen) annehmen.

• int getSelectionMode() Liefert den Selektionsmodus.

• void ensureIndexIsVisible( int index ) Bewegt die Liste in einem Ausschnitt, sodass der Eintrag an der Stelle index sichtbar ist.

• void addListSelectionListener( ListSelectionListener listener ) Fügt einen Listener hinzu.

• void removeListSelectionListener( ListSelectionListener listener ) Entfernt den Listener.

Beispiel mit Textfeld, Schaltfläche und Liste

Eine Oberfläche soll eine Schaltfläche zum Löschen von selektierten Elementen einer Liste anbieten, genauso wie ein Textfeld zum Eintragen neuer Strings. Wir können dazu drei Swing-Komponenten vorsehen und ein DefaultListModel als Datenbehälter.

Listing 15.43 com/tutego/insel/ui/list/JListAddElementsDemo.java

final DefaultListModel listModel = new DefaultListModel(); 
final JList list = new JList( listModel ); 
JButton     btn  = new JButton( "Remove" ); 
JTextField  tf   = new JTextField();

Für die Schaltfläche lässt sich folgender Ereignisbehandler vorsehen:

btn.addActionListener( new ActionListener() { 
  @Override public void actionPerformed( ActionEvent e ) { 
    int index = list.getSelectedIndex(); 
    if ( index == –1 ) 
      return; 
    listModel.remove( index ); 
  } 
} );

Gibt es kein selektiertes Element, liefert getSelectedIndex() die Rückgabe –1, und die Methode beendet die Verarbeitung.

Für das Textfeld nimmt der ActionListener einfach den Text heraus und setzt ihn per add-Element() in das DefaultListModel.

tf.addActionListener( new ActionListener() 
{ 
  @Override public void actionPerformed( ActionEvent e ) 
  { 
    String text = ((JTextField)e.getSource()).getText(); 
    listModel.addElement( text ); 
    ((JTextField)e.getSource()).setText( "" ); 
  } 
} );

Renderer

Aufgabe eines Renderes ist es, die Elemente darzustellen. Standardmäßig nutzt die JList einen speziellen JLabel zur Darstellung, welcher die toString()-Funktion auf jedem Listenelement aufruft und darstellt. Ein eigener Renderer ist leicht implementiert: Zunächst ist eine Klasse zu schreiben, die ListCellRenderer implementiert – am besten über die abstrakte Basisklasse DefaultListCellRenderer. Die JList-Methode setCellRenderer(ListCellRenderer) setzt ihn dann und verweist bei der Darstellung eines Eintrags an dieses Objekt.

Ein Render-Beispiel gibt das Unterkapitel bei Tabellen und auch die API-Dokumentation zeigt bei ListCellRenderer ein einfaches Beispiel.

15.16.5 Drehfeld (JSpinner)

Ein JSpinner ist eine Drehfeld-Komponente und besteht aus einem Eingabefeld (Editor) mit zwei kleinen Pfeilen, die eine Veränderung der Werte erlauben. Entweder trägt der Nutzer in das Textfeld eine gültige Zahl ein, die mit den Pfeilen verändert werden kann, oder eine Liste von Auswahlelementen wird angezeigt, aus denen der Benutzer wählen kann. Am Nächsten sind JSpinner mit Combo-Boxen verwandt, doch geht bei ihnen kein Popup-Menü auf.

SpinnerModel

Ein JSpinner arbeitet auf einem Model vom Typ SpinnerModel, das ähnlich wie ein Iterator Zugriff auf die Elemente ermöglicht. Ein SpinnerModel wird im Konstruktor von JSpinner gesetzt oder über setModel().

SpinnerListModel

Ein vorgefertigtes Model ist das SpinnerListModel, das mit einem Feld initialisiert wird.

String[]     days    = new DateFormatSymbols().getWeekdays(); 
SpinnerModel model   = new SpinnerListModel( days ); 
JSpinner     spinner = new JSpinner( model );

SpinnerDateModel

Ein weiteres Model ist das SpinnerDateModel. Es erlaubt dem Benutzer lokalisierte Datumseingaben. Der JSpinner zeigt dann die Eingabezeile an, und das Model speichert die Benutzereingabe und bietet Anfragemethoden, um das gewählte Datum abzufragen.

SpinnerDateModel model   = new SpinnerDateModel(); 
JSpinner         spinner = new JSpinner( model ); 
Date             value   = model.getDate();

Der Konstruktor SpinnerDateModel(Date value, Comparable start, Comparable end, int stepSize) erlaubt die Angabe eines Start- und eines Enddatums. Sie können null sein, wenn keine Grenzen gewünscht sind. Die Variable stepSize gibt an, welches Format zu editieren ist. Dahinter stehen viele Konstanten aus Calendar wie etwa YEAR, HOUR oder WEEK_OF_MONTH.

Listing 15.44 com/tutego/insel/ui/swing/JSpinnerDemo.java

package com.tutego.insel.ui.swing; 
 
import javax.swing.*; 
 
public class JSpinnerDemo 
{ 
  public static void main( String[] args ) 
  { 
    JFrame f = new JFrame(); 
    f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
 
    f.setLayout( new BoxLayout(f.getContentPane(), BoxLayout.Y_AXIS) ); 
 
    // Nummern-Spinner für Werte von 1 bis 10, in 0,2er Schritten 
    SpinnerNumberModel model1 = new SpinnerNumberModel( 5.0, 0.0, 10.0, 0.2 ); 
    JSpinner spin1 = new JSpinner( model1 ); 
 
    f.add( spin1 ); 
 
    // Spinner mit einem SpinnerListModel mit Komikern 
 
    String[] comedians = { 
      "Joseph Hader", "Charlie Chaplin", "Vicco von Bülow", 
      "Heinz Erhardt", "Michael Mittermeier" }; 
 
    SpinnerListModel model2 = new SpinnerListModel( comedians ); 
    JSpinner spin2 = new JSpinner( model2 ); 
 
    f.add( spin2 ); 
 
    f.pack(); 
    f.setVisible( true ); 
  } 
}

Ihr Kommentar