/[schmitzm]/trunk/src/skrueger/swing/TranslationAskJDialog.java
ViewVC logotype

Diff of /trunk/src/skrueger/swing/TranslationAskJDialog.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 34 by alfonx, Sat Mar 28 18:08:42 2009 UTC revision 261 by mojays, Fri Jul 31 17:05:18 2009 UTC
# Line 1  Line 1 
1  package skrueger.swing;  /*******************************************************************************
2     * Copyright (c) 2009 Martin O. J. Schmitz.
3  import java.awt.BorderLayout;   *
4  import java.awt.Dialog;   * This file is part of the SCHMITZM library - a collection of utility
5  import java.awt.FlowLayout;   * classes based on Java 1.6, focusing (not only) on Java Swing
6  import java.awt.Window;   * and the Geotools library.
7  import java.awt.event.ActionEvent;   *
8  import java.awt.event.ActionListener;   * The SCHMITZM project is hosted at:
9  import java.awt.event.KeyEvent;   * http://wald.intevation.org/projects/schmitzm/
10  import java.awt.event.WindowAdapter;   *
11  import java.awt.event.WindowEvent;   * This program is free software; you can redistribute it and/or
12  import java.util.ArrayList;   * modify it under the terms of the GNU Lesser General Public License
13  import java.util.Locale;   * as published by the Free Software Foundation; either version 3
14     * of the License, or (at your option) any later version.
15  import javax.swing.AbstractAction;   *
16  import javax.swing.Action;   * This program is distributed in the hope that it will be useful,
17  import javax.swing.Box;   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  import javax.swing.JComponent;   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  import javax.swing.JDialog;   * GNU General Public License for more details.
20  import javax.swing.JPanel;   *
21  import javax.swing.JRootPane;   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22  import javax.swing.KeyStroke;   * along with this program; if not, write to the Free Software
23     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24  import schmitzm.lang.LangUtil;   * or try this link: http://www.gnu.org/licenses/lgpl.html
25  import schmitzm.lang.ResourceProvider;   *
26  import schmitzm.swing.SwingUtil;   * Contributors:
27  import skrueger.i8n.Translation;   *     Martin O. J. Schmitz - initial API and implementation
28     *     Stefan A. Krüger - additional utility classes
29  public class TranslationAskJDialog extends JDialog {   ******************************************************************************/
30    package skrueger.swing;
31          /**  
32           * {@link ResourceProvider}, der die Lokalisation fuer GUI-Komponenten des  import java.awt.BorderLayout;
33           * Package {@code skrueger.swing} zur Verfuegung stellt. Diese sind in  import java.awt.Component;
34           * properties-Datein unter {@code skrueger.swing.resource.locales}  import java.awt.FlowLayout;
35           * hinterlegt.  import java.awt.Window;
36           */  import java.awt.event.ActionEvent;
37          public static ResourceProvider RESOURCE = new ResourceProvider(LangUtil  import java.awt.event.ActionListener;
38                          .extendPackagePath(TranslationAskJDialog.class,  import java.awt.event.KeyEvent;
39                                          "resource.locales.SwingResourceBundle"), Locale.ENGLISH);  import java.awt.event.WindowAdapter;
40    import java.awt.event.WindowEvent;
41          private String[] backup = new String[50]; // Maximum 50 languages ;-)  
42          private OkButton okButton;  import javax.swing.AbstractAction;
43          private CancelButton cancelButton;  import javax.swing.Action;
44    import javax.swing.BorderFactory;
45          public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";  import javax.swing.Box;
46          public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";  import javax.swing.JButton;
47    import javax.swing.JComponent;
48          private final JComponent[] translationEditJPanelsOrJustComponents;  import javax.swing.JDialog;
49    import javax.swing.JOptionPane;
50          private boolean hasBeenCanceled;  import javax.swing.JPanel;
51    import javax.swing.JRootPane;
52          /**  import javax.swing.KeyStroke;
53           * Since the registerKeyboardAction() method is part of the JComponent class  
54           * definition, you must define the Escape keystroke and register the  import schmitzm.swing.SwingUtil;
55           * keyboard action with a JComponent, not with a JDialog. The JRootPane for  import skrueger.i8n.Translation;
56           * the JDialog serves as an excellent choice to associate the registration,  
57           * as this will always be visible. If you override the protected  public class TranslationAskJDialog extends JDialog {
58           * createRootPane() method of JDialog, you can return your custom JRootPane  
59           * with the keystroke enabled:          private String[] backup = new String[50]; // Maximum 50 languages ;-)
60           */          private OkButton okButton;
61          @Override          private CancelButton cancelButton;
62          protected JRootPane createRootPane() {  
63                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);          public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
64                  JRootPane rootPane = new JRootPane();          public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
65                  rootPane.registerKeyboardAction(new ActionListener() {  
66            private JComponent[] translationEditJPanelsOrJustComponents;
67                          public void actionPerformed(ActionEvent e) {  
68                                  cancel();          private boolean hasBeenCanceled;
69                          }  
70            private JButton[] optionalButtons;
71                  }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);  
72            /**
73                  return rootPane;           * Since the registerKeyboardAction() method is part of the JComponent class
74          }           * definition, you must define the Escape keystroke and register the
75             * keyboard action with a JComponent, not with a JDialog. The JRootPane for
76          /**           * the JDialog serves as an excellent choice to associate the registration,
77           * This class handles the cancel button itself. You may still want to listen           * as this will always be visible. If you override the protected
78           * to PROPERTY_APPLY_AND_CLOSE events.           * createRootPane() method of JDialog, you can return your custom JRootPane
79           *           * with the keystroke enabled:
80           * This dialog is modal. The dialog has to be set visible afterwards.           */
81           */          @Override
82          public TranslationAskJDialog(Dialog owner,          protected JRootPane createRootPane() {
83                          final JComponent... translationEditJPanels) {                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
84                  super(owner);                  JRootPane rootPane = new JRootPane();
85                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;                  rootPane.registerKeyboardAction(new ActionListener() {
86                  init();  
87          }                          public void actionPerformed(ActionEvent e) {
88                                    cancel();
89          /**                          }
90           * This class handles the cancel button itself. You may still want to listen  
91           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has                  }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
92           * to be set visible afterwards.  
93           */                  return rootPane;
94          public TranslationAskJDialog(Window owner,          }
95                          final JComponent... translationEditJPanels) {  
96                  super(owner);          /**
97                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;           * The {@link TranslationAskJDialog} fills its content pane with an
98                  init();           * arbitrary number of components. If these {@link Component}s are
99             * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
100                  // Rememebr backups for all the jtextpanels           * values and restore them if the dialog is canceled. Other
101                  int count = 0;           * {@link JComponent}s are just displayed.<br/>
102                  for (JComponent component : translationEditJPanelsOrJustComponents) {           * This class handles the cancel button itself. You may still want to listen
103                          if (component instanceof TranslationEditJPanel) {           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
104                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;           * to be set visible afterwards.<br/>
105                                  Translation orig = tep.getTranslation();           *
106                                             * @param owner
107                                  // We don't want to overwrite the Translation object on           *            A component of the GUI that this dialog is related to. If no
108                                  // restore(). We just want to change its value.           *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is
109             *            called.
110                                  backup[count++] = orig.toOneLine();           */
111                          }          public TranslationAskJDialog(Component owner,
112                  }                          final JComponent... translationEditJPanels) {
113          }                  super(SwingUtil.getParentWindow(owner));
114                    setComponents(translationEditJPanels);
115          private void init() {          }
116                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);  
117                  addWindowListener(new WindowAdapter() {          /**
118             * The {@link TranslationAskJDialog} fills its content pane with an
119                          public void windowClosing(WindowEvent e) {           * arbitrary number of components. If these {@link Component}s are
120                                  cancel();           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
121                          }           * values and restore them if the dialog is canceled. Other
122             * {@link JComponent}s are just displayed.<br/>
123                  });           * This class handles the cancel button itself. You may still want to listen
124                  SwingUtil.centerFrameOnScreen(this);           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
125                  Box box = Box.createVerticalBox();           * to be set visible afterwards.<br/>
126                  for (JComponent panel : translationEditJPanelsOrJustComponents) {           * Using this constructor, you have to call setComponents afterwards.
127                          box.add(panel);           */
128                  }          public TranslationAskJDialog(Component owner) {
129                  JPanel cp = new JPanel(new BorderLayout());                  this(owner, new JComponent[] {});
130                  cp.add(box, BorderLayout.CENTER);          }
131                  cp.add(getButtons(), BorderLayout.SOUTH);  
132                  setContentPane(cp);          /**
133             * The {@link TranslationAskJDialog} fills its content pane with an
134                  // dialog.getRootPane().setDefaultButton(okButton);           * arbitrary number of components. If these {@link Component}s are
135             * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
136                  setTitle(RESOURCE.getString("translation_dialog_title")); // i8n           * values and restore them if the dialog is canceled. Other
137                  setModal(true);           * {@link JComponent}s are just displayed.
138                  pack();           *
139          }           * @param translationEditJPanels
140             *            Arbitrary list of {@link JComponent}s and
141          protected void cancel() {           *            {@link TranslationEditJPanel}s.
142                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);           */
143                  restore();          public void setComponents(final JComponent... translationEditJPanels) {
144                  setVisible(false);                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;
145                  dispose();  
146          }                  // Remember backups for all the TranslationEditJPanel
147                    int count = 0;
148          private void restore() {                  for (JComponent component : translationEditJPanelsOrJustComponents) {
149                  int count = 0;                          if (component instanceof TranslationEditJPanel) {
150                  for (JComponent component : translationEditJPanelsOrJustComponents) {                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;
151                          if (component instanceof TranslationEditJPanel) {                                  Translation orig = tep.getTranslation();
152                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;  
153                                  tep.getTranslation().fromOneLine(backup[count++]);                                  // We don't want to overwrite the Translation object on
154                          }                                  // restore(). We just want to change its value.
155                  }                                  backup[count++] = orig.toOneLine();
156          }                          }
157                    }
158          private JComponent getButtons() {  
159                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));                  init();
160                  if (okButton == null) {          }
161                          okButton = new OkButton(new AbstractAction() {  
162                                  {          private void init() {
163                                          // Set a mnemonic character. In most look and feels, this                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
164                                          // causes the                  addWindowListener(new WindowAdapter() {
165                                          // specified character to be underlined This indicates that  
166                                          // if the component                          public void windowClosing(WindowEvent e) {
167                                          // using this action has the focus and In some look and                                  cancel();
168                                          // feels, this causes                          }
169                                          // the specified character in the label to be underlined and  
170                                          putValue(Action.MNEMONIC_KEY, new Integer(                  });
171                                                          java.awt.event.KeyEvent.VK_E));                  SwingUtil.centerFrameOnScreen(this);
172                    Box box = Box.createVerticalBox();
173                                          // Set tool tip text                  for (JComponent panel : translationEditJPanelsOrJustComponents) {
174                                          putValue(Action.SHORT_DESCRIPTION,                          panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
175                                                          "Accept the changes made to the translation.");                          panel.setBorder( BorderFactory.createEmptyBorder(5, 6, 5, 6));
176                            box.add(panel);
177                                  }                          
178                    }
179                                  public void actionPerformed(ActionEvent evt) {                  JPanel cp = new JPanel(new BorderLayout());
180                                          TranslationAskJDialog.this.firePropertyChange(                  cp.add(box, BorderLayout.WEST);
181                                                          PROPERTY_APPLY_AND_CLOSE, null, null);                  cp.add(getButtons(), BorderLayout.SOUTH);
182                                          setVisible(false);                  setContentPane(cp);
183                                          dispose();                  
184                                          System.out.println("OK button action performed");                  setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
185                                  }                  setModal(true);
186                    pack();
187                          });          }
188                          // okButton.addKeyListener( new KeyListener() {  
189                          //          public void setButtons(JButton... optionalButtons) {
190                          // public void keyTyped(KeyEvent e) {                  this.optionalButtons = optionalButtons;
191                          // if ()                  init();
192                          // okButton.action(new KEyPreEvent(), what)          }
193                          // }  
194                          //                                        protected void cancel() {
195                          // });                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
196                  }                  restore();
197                  jPanel.add(okButton);                  setVisible(false);
198                    dispose();
199                  if (cancelButton == null) {          }
200                          cancelButton = new CancelButton(new AbstractAction("") {  
201                                  public void actionPerformed(ActionEvent evt) {          protected void restore() {
202                                          // restore();                  int count = 0;
203                                          TranslationAskJDialog.this.firePropertyChange(                  for (JComponent component : translationEditJPanelsOrJustComponents) {
204                                                          PROPERTY_CANCEL_AND_CLOSE, null, null);                          if (component instanceof TranslationEditJPanel) {
205                                          setVisible(false);                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;
206                                          setHasBeenCanceled(true);                                  tep.getTranslation().fromOneLine(backup[count++]);
207                                          dispose();                          }
208                                  }                  }
209                          });          }
210                  }  
211                  jPanel.add(cancelButton);          private JComponent getButtons() {
212                    JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
213                  return jPanel;  
214          }                  if (optionalButtons != null)
215                            for (JButton b : optionalButtons) {
216          public static void main(String[] args) {                                  jPanel.add(b);
217                  ArrayList<String> lang = new ArrayList<String>();                          }
218                  lang.add("de");  
219                  lang.add("en");                  if (okButton == null) {
220                  lang.add("fr");                          okButton = new OkButton(new AbstractAction() {
221                                    {
222                  Translation transe = new Translation();                                          // Set a mnemonic character. In most look and feels, this
223                  transe.put("de", "Terciopelo-Lanzenotter");                                          // causes the
224                  TranslationEditJPanel p1 = new TranslationEditJPanel(                                          // specified character to be underlined This indicates that
225                                  "Name von New Group", transe, lang);                                          // if the component
226                                            // using this action has the focus and In some look and
227                  Translation transe2 = new Translation();                                          // feels, this causes
228                  transe2                                          // the specified character in the label to be underlined and
229                                  .put(                                          putValue(Action.MNEMONIC_KEY, new Integer(
230                                                  "de",                                                          java.awt.event.KeyEvent.VK_E));
231                                                  "Terciopelo-Lanzenotter (Bothrops asper) ist eine in Mittelamerika und im Nordwesten Südamerikas weit verbreitete Schlangenart.");  
232                  TranslationEditJPanel p2 = new TranslationEditJPanel(                                          // Set tool tip text
233                                  "Description of Animal:", transe2, lang);                                          putValue(Action.SHORT_DESCRIPTION,
234                                                            "Accept the changes made to the translation.");
235                  // JFrame frame = new JFrame();  
236                  // frame.setContentPane(p1);                                  }
237                  // frame.pack();  
238                  // frame.setVisible(true);                                  public void actionPerformed(ActionEvent evt) {
239                                            TranslationAskJDialog.this.firePropertyChange(
240                  TranslationAskJDialog dialog = new TranslationAskJDialog(null, p1, p2);                                                          PROPERTY_APPLY_AND_CLOSE, null, null);
241                  dialog.setVisible(true);  
242          }                                          if (!checkValidInputs())
243                                                    return;
244          private void setHasBeenCanceled(boolean hasBeenCanceled) {  
245                  this.hasBeenCanceled = hasBeenCanceled;                                          setVisible(false);
246          }                                          dispose();
247                                    }
248          /**  
249           * After the modal dialog has been closed, this allows to find out, whether                          });
250           * the dialog has been canceled.  
251           *                  }
252           * @return <code>true</code> if the {@link JDialog} has been canceled.                  jPanel.add(okButton);
253           */  
254          public boolean isHasBeenCanceled() {                  if (cancelButton == null) {
255                  return hasBeenCanceled;                          cancelButton = new CancelButton(new AbstractAction("") {
256          }                                  public void actionPerformed(ActionEvent evt) {
257                                            restore();
258  }                                          TranslationAskJDialog.this.firePropertyChange(
259                                                            PROPERTY_CANCEL_AND_CLOSE, null, null);
260                                            setVisible(false);
261                                            setCancelled(true);
262                                            dispose();
263                                    }
264                            });
265                    }
266                    jPanel.add(cancelButton);
267    
268                    return jPanel;
269            }
270    
271            /**
272             * @return <code>true</code> if none of the translations contains illegal
273             *         characters.
274             */
275            protected boolean checkValidInputs() {
276    
277                    for (JComponent component : translationEditJPanelsOrJustComponents) {
278                            if (component instanceof TranslationEditJPanel) {
279                                    TranslationEditJPanel tep = (TranslationEditJPanel) component;
280    
281                                    for (String l : tep.getTranslation().values()) {
282                                            if (l.contains("{") || l.contains("}")) {
283                                                    JOptionPane
284                                                                    .showMessageDialog(
285                                                                                    this,
286                                                                                    SwingUtil.R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));
287                                                    return false;
288                                            }
289                                    }
290    
291                            }
292                    }
293    
294                    return true;
295            }
296    
297            private void setCancelled(boolean hasBeenCanceled) {
298                    this.hasBeenCanceled = hasBeenCanceled;
299            }
300    
301            /**
302             * After the modal dialog has been closed, this allows to find out, whether
303             * the dialog has been canceled.
304             *
305             * @return <code>true</code> if the {@link JDialog} has been canceled.
306             */
307            public boolean isCancelled() {
308                    return hasBeenCanceled;
309            }
310    
311    }
Legend:
Removed from v.34  
changed lines
  Added in v.261
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26