15.17 Texteingabefelder

Swing bietet eine Reihe von Textkomponenten:

• JTextField. Einzeiliges Textfeld

• JFormattedTextField. Einzeiliges Textfeld mit Formatierungsvorgaben

• JPasswordField. Einzeilige Eingabe mit verdeckten Zeichen

• JTextArea. Mehrzeiliges Textfeld

• JEditorPane. Editor-Komponente

• JTextPane. Spezialisierung der Editor-Komponente

Die JEditorPane ist die leistungsfähigste Komponente, die über so genannte Editor-Kits reinen Text, HTML oder RTF darstellen und verwalten kann.

Viele wichtige Methoden sind in der Oberklasse javax.swing.text.JTextComponent zu finden. Zwar liegt diese Klasse im Paket javax.swing.text, doch liegen alle anderen Klassen »klassischerweise« unter javax.swing.

15.17.1 Text in einer Eingabezeile

Dem Benutzer werden Eingaben in einem Textfeld ermöglicht – etwa um einen Namen einzugeben. Dabei können wir uns eine eigene Programmierung über ein Label, das Text-Ereignisse verarbeitet, ersparen. Textfelder werden mit der Klasse JTextField erstellt. Unterschiedliche Konstruktoren legen einen Start-String oder die Anzahl der Zeichen fest, die ein Textfeld anzeigen kann.

JTextField wohnort = new JTextField( "Sonsbeck", 20 );

class javax.swing.JTextField 
extends JTextComponent

• JTextField() Erzeugt ein leeres Textfeld.

• JTextField( int columns ) Erzeugt ein Textfeld mit einer gegebenen Anzahl von Spalten.

• JTextField( String text ) Erzeugt ein mit text initialisiertes Textfeld.

• JTextField( String text, int columns ) Erzeugt ein mit text initialisiertes Textfeld mit columns Spalten.

15.17.2 Die Oberklasse der Text-Komponenten (JTextComponent)

Alle Texteingabefelder unter Swing sind von der abstrakten Oberklasse JTextComponent abgeleitet. Die wichtigsten Methoden sind setText(String) und getText(), mit denen sich Zeichenketten setzen und erfragen lassen.

class javax.swing.text.JTextComponent 
extends JComponent 
implements Scrollable, Accessible

• String getText() Liefert den Inhalt des Textfelds.

• String getText( int offs, int len ) Liefert den Inhalt des Textfelds von offs bis offs + len. Stimmen die Bereiche nicht, wird eine BadLocationException ausgelöst.

• String getSelectedText() Liefert den selektierten Text. Keine Selektion ergibt die Rückgabe null.

• void setText( String t ) Setzt den Text neu.

• void read( Reader in, Object desc ) throws IOException Liest den Inhalt aus dem Reader in das Textfeld. desc beschreibt den Datenstrom näher, kann aber null sein. Die read()-Methode erzeugt intern ein neues Document-Objekt und verwirft das alte.

• void write( Writer out ) throws IOException Schreibt den Inhalt des Textfelds in den Writer.

JTextField plz = new JTextField( 5 ); 
plz.setText( "47665" );

Das Caret

Der Cursor in einem Textfeld heißt Caret. Unterschiedliche Anfragen lassen sich an ein Textfeld stellen, um mehr über das Caret herauszufinden. Ein Listener kann an eine JTextComponent gehängt werden, und ebenso kann das Caret frei bewegt werden.

class javax.swing.text.JTextComponent 
extends JComponent 
implements Scrollable, Accessible

• int getCaretPosition(), setCaretPosition( int position ) Liefert beziehungsweise verändert die Position des Eingabe-Cursors.

• Color getCaretColor(), void setCaretColor( Color c ) Liest oder ändert die Farbe des Carets.

textfield.setCaretPosition( textfield.getText().length() );

15.17.3 Geschützte Eingaben (JPasswordField)

Das JPasswordField ist ein spezielles JTextField, das die Zeichen nicht auf dem Bildschirm darstellt, sondern ein alternatives Zeichen zeigt, das so genannte Echozeichen. Standardmäßig ist das ein Sternchen. So lassen sich Passwort-Felder anlegen, die eine Eingabe verbergen.

Listing 15.45 com/tutego/insel/ui/text/JPasswordFieldDemo.java, Ausschnitt

JPasswordField pass = new JPasswordField( 15 ); 
pass.setEchoChar( '#' ); 
comp.add( pass );

Im Konstruktor geben wir die Länge der Textzeile an. Mit der Methode setEchoChar() lässt sich das Echozeichen festlegen. [Wird das Echozeichen auf (char)0 gesetzt, erscheint die Eingabe nicht im Klartext. So macht es nur die AWT-Komponente TextField. ] Leider bleibt das Problem, dass die Sternchen auf die Anzahl der geheimen Zeichen schließen lassen.

Abbildung 15.18 Das Passwort-Feld

15.17.4 Validierende Eingabefelder (JFormattedTextField)

Textfelder, in denen Benutzer Zeichenfolgen eintragen, müssen oft die Eingabe validieren. So dürfen Zahlenfelder keine beliebigen Zeichen annehmen, sondern nur Ziffern und vielleicht Vorzeichen oder Dezimaltrenner. Komplizierte Felder wie ISBN-Nummern oder Datumsformate haben noch weitere Regeln. Eine Implementierung dieser Textfelder sieht häufig so aus, dass auf Tastatureingaben reagiert und sofort geprüft wird, ob alles in Ordnung ist, oder später nach einer actionPerformed(). Schlaue Programmierer nutzen gern die parse()-Funktionen des Format-Objekts aus dem text-Paket, um die Beschränkungen zu prüfen.

Glücklicherweise gibt es seit Version 1.4 eine Zusammenfassung von Format und JTextField zu einer Komponente JFormattedTextField. Wollen wir eine Dezimalfeldeingabe schreiben, so geben wir im Konstruktor ein passendes DecimalFormat-Objekt an.

JFormattedTextField text = new JFormattedTextField( new DecimalFormat("#,###") );

Während der Eingabe testet der Formatter die Zeichenkette nicht auf ihre Korrektheit. Erst wenn der Benutzer zum Beispiel die Return-Taste drückt, wird die Eingabe überprüft.

Das folgende Programm zeigt die Anwendung eines Eingabefelds, das nur Datumswerte eines bestimmten Formats und Dezimalzahlen annimmt.

Listing 15.46 com/tutego/insel/ui/swing/JFormattedTextDemo.java

package com.tutego.insel.ui.swing; 
 
import java.text.*; 
import java.awt.*; 
import java.awt.event.*; 
import javax.swing.*; 
 
public class JFormattedTextDemo 
{ 
  public static void main( String[] args ) 
  { 
    JFrame frame = new JFrame(); 
    frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
    frame.setLayout( new GridLayout(0,1) ); 
 
    ActionListener al =  new ActionListener() { 
      public void actionPerformed( ActionEvent e ) { 
        System.out.println( ((JFormattedTextField)e.getSource()).getText() ); 
    } }; 
 
    JFormattedTextField ftf1 = new JFormattedTextField( 
        new SimpleDateFormat("MM/dd/yy") ); 
    frame.add( ftf1 ); 
    ftf1.addActionListener( al ); 
 
    JFormattedTextField ftf2 = new JFormattedTextField( 
        new DecimalFormat("#,###") ); 
    frame.add( ftf2 ); 
    ftf2.addActionListener( al ); 
 
    frame.pack(); 
    frame.setVisible( true ); 
  } 
}

15.17.5 Einfache mehrzeilige Textfelder (JTextArea)

Mit der Klasse JTextArea lassen sich mehrzeilige editierbare Textfelder erzeugen. Der Zeichensatz kann genau ein Attribut annehmen, das heißt, die Schrift verfügt über genau eine Farbe und eine Schriftart; der Zeichensatz lässt sich mit setFont(Font) zuweisen.

Die JTextArea-Klasse stellt im Gegensatz zur AWT-Komponente TextArea keine automatischen Bildlaufleisten dar, eine Scroll-Eigenschaft muss nachträglich über ein JScrollPane realisiert werden.

Listing 15.47 com/tutego/insel/ui/text/JTextAreaDemo.java

package com.tutego.insel.ui.text; 
 
import javax.swing.*; 
import java.awt.*; 
import java.awt.event.*; 
 
class JTextAreaDemo 
{ 
  static int style = Font.PLAIN, 
             size = 12; 
 
  public static void main( String[] args ) 
  { 
    JFrame f = new JFrame(); 
    f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
 
    final JTextArea t = new JTextArea(); 
    t.setFont( new Font(Font.SANS_SERIF, style, size) ); 
    f.add( new JScrollPane( t ) ); 
 
    ActionListener al = new ActionListener() 
    { 
      public void actionPerformed( ActionEvent e ) 
      { 
        if ( "Ende".equals(e.getActionCommand()) ) 
          System.exit( 0 ); 
 
        if ( "fett".equals(e.getActionCommand()) ) 
          style ^= Font.BOLD; 
        else if ( "kursiv".equals(e.getActionCommand()) ) 
          style ^= Font.ITALIC; 
 
        t.setFont( new Font(Font.SANS_SERIF, style, size) ); 
      } 
    }; 
 
    JPanel p = new JPanel( new GridLayout(1,3) ); 
    f.add( p, BorderLayout.PAGE_START ); 
 
    AbstractButton b; 
 
    p.add( b = new JToggleButton("fett") ); 
    b.addActionListener( al ); 
    b.setFont( new Font(Font.SANS_SERIF, Font.BOLD, 12) ); 
 
    p.add( b = new JToggleButton("kursiv") ); 
    b.addActionListener( al ); 
    b.setFont( new Font(Font.SANS_SERIF, Font.ITALIC, 12) ); 
 
    p.add( b = new JButton("Ende") ); 
    b.addActionListener( al ); 
 
    f.setSize( 400, 600 ); 
    f.setVisible( true ); 
  } 
}

Die Zeile mit der Anweisung style ^= Font.BOLD dreht über den Xor-Operator das entsprechende Flag um. War in style das Bit von Font.BOLD vorher gesetzt, ist es nach der Xor-Operation gelöscht. Genauso ist es umgekehrt. War es nicht gesetzt, ist es anschließend gesetzt. Die Konstanten sind mit 1 (BOLD), 2 (ITALIC) vorbelegt – also einmal Bit 1 und einmal Bit 2.

Abbildung 15.19 Eine JTextArea

class javax.swing.JTextArea 
extends JTextComponent

• JTextArea() Ein neues JTextArea-Objekt wird erzeugt.

• JTextArea( int rows, int columns ) Erzeugt ein neues Objekt mit gegebener Anzahl Zeilen und Spalten.

• JTextArea( String text ) Erzeugt ein JTextArea-Objekt mit einem Starttext.

• JTextArea( String, int rows, int columns ) Eine Kombination aus den beiden vorigen Konstruktoren.

Unterschiedliche Methoden erfragen das Layout und erlauben eine Änderung.

• int getColumns(), int getRows() Gibt die Anzahl der Spalten und Zeilen an.

• void setColumns( int columns ), void setRows( int rows ) Setzt die Anzahl der Spalten und Zeilen neu.

• int getLineCount() Liefert die Anzahl der Zeilen.

Praktisch sind die int-gebenden Methoden getLineEndOffset(int line), getLineStartOffset(int line) und getLineOfOffset(int offset), die Zeichen-Position mit Zeilennummern zusammenbringen.

Modifikationen des Textes sind ebenfalls möglich und gehen über die Methoden der Oberklasse JTextComponent hinaus.

• void append( String str ) Hängt den String an den vorhandenen Text an. Diese Funktion steht in der Oberklasse JTextComponent nicht zur Verfügung.

• void insert( String str, int pos ) Fügt den String an die Position pos ein.

• void replaceRange( String str, int start, int end ) Ersetzt Text von start bis end durch den neuen Text str.

Scrolling

Wie üblich besitzt die JTextArea keine Rollbalken und muss zwecks Scrolling in eine JScrollPane eingebaut werden. Es ist praktisch zu wissen, dass sich einzelne Rollbalken einer JScrollPane mit get[Vertical|Horizontal]ScrollBar erfragen lassen. Denn wenn zum Beispiel am Ende etwas angehängt wird, scrollt die JTextArea nicht automatisch mit nach unten. Nach dem Einfügen können wir jedoch den vertikalen Rollbalken erfragen und von Hand den Wert auf das Maximum setzen:

JScrollBar bar = scrollPane.getVerticalScrollBar(); 
bar.setValue( bar.getMaximum() );

15.17.6 Editor-Klasse (JEditorPane)

Die Klasse JEditorPane ist eine sehr leistungsfähige Textkomponente für verschiedene Textformate. Die Swing-Implementierung unterstützt HTML und Rich Text Format (RTF), eigene Implementierungen lassen sich ohne große Probleme ergänzen. Diese werden Editor-Kits genannt. Der Editor stellt Text dar, der ihm mit setContentType() übergeben wird. Das Editor-Kit wird dann mit setEditorKit() zugewiesen. Ohne eigene Erweiterungen sind »text/html« (Standard), »text/plain« und »text/rtf« erlaubt. Soll nur Text ohne Formatierungen und ohne Attribute dargestellt werden, lässt sich auch gleich JTextField verwenden.

Meistens wird ein JEditorPane über einen Konstruktor erzeugt, dem eine URL oder ein String mit einer URL übergeben wird. Für Programme mit Dateien auf dem lokalen Dateisystem wird dann die URL mit file:// beginnen. Wird mit dem Standard-Konstruktor gearbeitet, kann später mit setPage() ein URL-Objekt oder ein String eine Seite neu belegen. Auch setText() erlaubt ein Setzen des Inhalts. Zu guter Letzt lässt sich der Editor auch mit einem InputStream über read() mit Inhalt füllen.

Mit diesem Wissen lässt sich ein kleiner Webbrowser implementieren.

Listing 15.48 com/tutego/insel/ui/text/JBrowser.java

package com.tutego.insel.ui.text; 
 
import javax.swing.*; 
import javax.swing.event.*; 
import java.io.*; 
import java.net.*; 
 
public class JBrowser extends JEditorPane implements HyperlinkListener 
{ 
  JBrowser( String url ) 
  { 
    setEditable( false ); 
    addHyperlinkListener( this ); 
 
    try 
    { 
      setPage( new URL(url) ); 
    } 
    catch ( IOException e ) { e.printStackTrace(); } 
  } 
 
  public void hyperlinkUpdate( HyperlinkEvent event ) 
  { 
    HyperlinkEvent.EventType typ = event.getEventType(); 
 
    if ( typ == HyperlinkEvent.EventType.ACTIVATED ) 
    { 
      try 
      { 
        setPage( event.getURL() ); 
      } 
      catch( IOException e ) { 
        JOptionPane.showMessageDialog( this, 
                                      "Can't follow link to " 
                                        + event.getURL().toExternalForm(), 
                                      "Error", 
                                      JOptionPane.ERROR_MESSAGE); 
      } 
 
    } 
  } 
 
  public static void main( String[] args ) 
  { 
    JFrame f = new JFrame(); 
    f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE ); 
    f.setSize( 600, 500 ); 
    f.add( new JScrollPane(new JBrowser("http://www.heise.de/index.html")) ); 
    f.setVisible( true ); 
  } 
}

class javax.swing.JEditorPane 
extends JTextComponent

• JEditorPane() Erzeugt einen neuen Editor.

• JEditorPane( String url ), JEditorPane( URL url ) Erzeugt einen neuen Editor mit dem Inhalt, auf den die URL zeigt.

• void setPage( String url ), void setPage( URL page ) Zeigt eine neue Seite an.

• void addHyperlinkListener( HyperlinkListener l ) Reagiert auf das Aktivieren von Hyperlinks.

• void removeHyperlinkListener( HyperlinkListener l ) Entfernt den Horcher.

Ihr Kommentar