libjava/classpath/examples/gnu/classpath/examples/swing/DocumentFilterDemo.java

   1 /* DpocumentFilterDemo.java -- An example for the DocumentFilter class.
   2    Copyright (C) 2006  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath examples.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20 */
  21
  22
  23 package gnu.classpath.examples.swing;
  24
  25 import java.awt.BorderLayout;
  26 import java.awt.Color;
  27 import java.awt.GridLayout;
  28 import java.awt.Toolkit;
  29 import java.awt.datatransfer.Clipboard;
  30 import java.awt.datatransfer.StringSelection;
  31 import java.awt.event.ActionEvent;
  32 import java.awt.event.ActionListener;
  33
  34 import javax.swing.JButton;
  35 import javax.swing.JComboBox;
  36 import javax.swing.JComponent;
  37 import javax.swing.JFrame;
  38 import javax.swing.JLabel;
  39 import javax.swing.JOptionPane;
  40 import javax.swing.JPanel;
  41 import javax.swing.JTextField;
  42 import javax.swing.SwingUtilities;
  43 import javax.swing.text.AbstractDocument;
  44 import javax.swing.text.AttributeSet;
  45 import javax.swing.text.BadLocationException;
  46 import javax.swing.text.DocumentFilter;
  47 import javax.swing.text.TextAction;
  48
  49 /**
  50  * A demonstration of the <code>javax.swing.text.DocumentFilter</code> class.
  51  *
  52  * <p>Similar to a dialog in a popular programming IDE the user can insert
  53  * a CVS URL into a textfield and the filter will split the components apart
  54  * and will put them into the right textfields saving the user a lot of
  55  * typing time.</p>
  56  *
  57  * @author Robert Schuster
  58  */
  59 public class DocumentFilterDemo
  60   extends JPanel
  61   implements ActionListener
  62 {
  63   JTextField target;
  64
  65   JTextField host;
  66   JTextField repositoryPath;
  67   JTextField user;
  68   JTextField password;
  69   JComboBox connectionType;
  70
  71   /**
  72    * Creates a new demo instance.
  73    */
  74   public DocumentFilterDemo()
  75   {
  76     createContent();
  77     // initFrameContent() is only called (from main) when running this app
  78     // standalone
  79   }
  80
  81   /**
  82    * When the demo is run independently, the frame is displayed, so we should
  83    * initialise the content panel (including the demo content and a close
  84    * button).  But when the demo is run as part of the Swing activity board,
  85    * only the demo content panel is used, the frame itself is never displayed,
  86    * so we can avoid this step.
  87    */
  88   void initFrameContent()
  89   {
  90     JPanel closePanel = new JPanel();
  91     JButton closeButton = new JButton("Close");
  92     closeButton.setActionCommand("CLOSE");
  93     closeButton.addActionListener(this);
  94     closePanel.add(closeButton);
  95     add(closePanel, BorderLayout.SOUTH);
  96   }
  97
  98   private void createContent()
  99   {
 100     setLayout(new BorderLayout());
 101
 102     JPanel panel = new JPanel(new GridLayout(7, 2));
 103     panel.add(new JLabel("CVS URL:"));
 104     panel.add(target = new JTextField(20));
 105     target.setBackground(Color.RED);
 106
 107     panel.add(new JLabel("Host:"));
 108     panel.add(host = new JTextField(20));
 109
 110     panel.add(new JLabel("Repository Path:"));
 111     panel.add(repositoryPath = new JTextField(20));
 112
 113     panel.add(new JLabel("Username:"));
 114     panel.add(user = new JTextField(20));
 115
 116     panel.add(new JLabel("Password:"));
 117     panel.add(password = new JTextField(20));
 118
 119     panel.add(new JLabel("Connection Type:"));
 120     panel.add(connectionType = new JComboBox());
 121
 122     JButton helpButton = new JButton("Help");
 123     panel.add(helpButton);
 124
 125     helpButton.addActionListener(new ActionListener()
 126       {
 127         public void actionPerformed(ActionEvent ae)
 128         {
 129           JOptionPane.showMessageDialog(DocumentFilterDemo.this,
 130                                         "Paste a CVS URL into the red " +
 131                                         "textfield.\nIf you do not want to " +
 132                                         "look up a CVS URL yourself click " +
 133                                         "on the 'provide me an example' " +
 134                                         "button.\nThis will paste a proper " +
 135                                         "string into your clipboard.");
 136         }
 137       });
 138
 139     JButton exampleButton = new JButton("Provide me an example!");
 140     panel.add(exampleButton);
 141     exampleButton.addActionListener(new ActionListener()
 142       {
 143         public void actionPerformed(ActionEvent ae)
 144         {
 145          try
 146            {
 147              Toolkit tk = Toolkit.getDefaultToolkit();
 148              Clipboard cb = tk.getSystemSelection();
 149              StringSelection selection
 150                = new StringSelection(":extssh:gnu@cvs.savannah.gnu.org:" +
 151                         "/cvs/example/project");
 152
 153              cb.setContents(selection, selection);
 154
 155              // Confirm success with a beep.
 156              tk.beep();
 157            }
 158          catch (IllegalStateException ise)
 159            {
 160              JOptionPane.showMessageDialog(DocumentFilterDemo.this,
 161                                            "Clipboard is currently" +
 162                                            " unavailable.",
 163                                            "Error",
 164                                            JOptionPane.ERROR_MESSAGE);
 165            }
 166         }
 167       });
 168
 169     connectionType.addItem("pserver");
 170     connectionType.addItem("ext");
 171     connectionType.addItem("extssh");
 172
 173     add(panel);
 174
 175     AbstractDocument doc = (AbstractDocument) target.getDocument();
 176     doc.setDocumentFilter(new CVSFilter());
 177   }
 178
 179   public void actionPerformed(ActionEvent e)
 180   {
 181     if (e.getActionCommand().equals("CLOSE"))
 182       System.exit(0);
 183
 184   }
 185
 186   public static void main(String[] args)
 187   {
 188     SwingUtilities.invokeLater
 189     (new Runnable()
 190      {
 191        public void run()
 192        {
 193          DocumentFilterDemo app = new DocumentFilterDemo();
 194          app.initFrameContent();
 195          JFrame frame = new JFrame("DocumentFilterDemo");
 196          frame.getContentPane().add(app);
 197          frame.pack();
 198          frame.setVisible(true);
 199          frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
 200        }
 201      });
 202   }
 203
 204   /**
 205    * Returns a DemoFactory that creates a DocumentFilterDemo.
 206    *
 207    * @return a DemoFactory that creates a DocumentFilterDemo
 208    */
 209   public static DemoFactory createDemoFactory()
 210   {
 211     return new DemoFactory()
 212     {
 213       public JComponent createDemo()
 214       {
 215         return new DocumentFilterDemo();
 216       }
 217     };
 218   }
 219
 220   class CVSFilter extends DocumentFilter
 221   {
 222     // example: pserver:anonymous@cvs.sourceforge.net:/cvsroot/fmj
 223     String cvsPattern = ":?(pserver|ext|extssh):(\\w)+(:(\\w)+)?@(\\w|\\.)+:/(\\w|/)*";
 224
 225     public void insertString(DocumentFilter.FilterBypass fb,
 226                              int offset, String string,
 227                              AttributeSet attr)
 228     throws BadLocationException
 229     {
 230       filterString(fb, offset, 0, string, attr, true);
 231     }
 232
 233     public void replace(DocumentFilter.FilterBypass fb,
 234                               int offset, int length,
 235                               String string,
 236                               AttributeSet attr)
 237     throws BadLocationException
 238     {
 239       filterString(fb, offset, length, string, attr, false);
 240     }
 241
 242     public void filterString(DocumentFilter.FilterBypass fb,
 243                              int offset, int length, String string,
 244                              AttributeSet attr, boolean insertion)
 245     throws BadLocationException
 246     {
 247       if(string.matches(cvsPattern))
 248         {
 249           // Split off the connection type part.
 250           String[] result = string.split(":", 2);
 251
 252           // If the string contained a leading colon, result[0]
 253           // will be empty at that point. We simply repeat the split
 254           // operation on the remaining string and continue.
 255           if(result[0].equals(""))
 256             result = result[1].split(":", 2);
 257
 258           connectionType.setSelectedItem(result[0]);
 259
 260           // Split off the username and password part
 261           result = result[1].split("@", 2);
 262
 263           // Break username and password in half
 264           String[] userCredentials = result[0].split(":");
 265           user.setText(userCredentials[0]);
 266
 267           // If the result has two entries the second one will
 268           // be the password.
 269           if (userCredentials.length == 2)
 270             password.setText(userCredentials[1]);
 271
 272           // Now break the host part apart.
 273           result = result[1].split(":");
 274
 275           host.setText(result[0]);
 276
 277           repositoryPath.setText(result[1]);
 278         }
 279
 280       // The unmodified string is put into the document.
 281       if (insertion)
 282         fb.insertString(offset, string, attr);
 283       else
 284         fb.replace(offset, length, string, attr);
 285     }
 286
 287   }
 288
 289 }