/[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 116 by alfonx, Wed May 13 17:37:11 2009 UTC revision 302 by alfonx, Mon Aug 17 12:45:48 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.Component;   * 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.Locale;   * modify it under the terms of the GNU Lesser General Public License
13     * as published by the Free Software Foundation; either version 3
14  import javax.swing.AbstractAction;   * of the License, or (at your option) any later version.
15  import javax.swing.Action;   *
16  import javax.swing.Box;   * This program is distributed in the hope that it will be useful,
17  import javax.swing.JComponent;   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  import javax.swing.JDialog;   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  import javax.swing.JOptionPane;   * 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 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           * The {@link TranslationAskJDialog} fills its content pane with an           * as this will always be visible. If you override the protected
78           * arbitrary number of components. If these {@link Component}s are           * createRootPane() method of JDialog, you can return your custom JRootPane
79           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the           * with the keystroke enabled:
80           * values and restore them if the dialog is canceled. Other           */
81           * {@link JComponent}s are just displayed.<br/>          @Override
82           * This class handles the cancel button itself. You may still want to listen          protected JRootPane createRootPane() {
83           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
84           * to be set visible afterwards.<br/>                  JRootPane rootPane = new JRootPane();
85           *                  rootPane.registerKeyboardAction(new ActionListener() {
86           * @param owner  
87           *            A component of the GUI that this dialog is related to. If no                          public void actionPerformed(ActionEvent e) {
88           *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is                                  cancel();
89           *            called.                          }
90           */  
91          public TranslationAskJDialog(Component owner,                  }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
92                          final JComponent... translationEditJPanels) {  
93                  super(owner instanceof Window ? (Window) owner : SwingUtil                  return rootPane;
94                                  .getParentWindow(owner));          }
95                  setComponents(translationEditJPanels);  
96          }          /**
97             * The {@link TranslationAskJDialog} fills its content pane with an
98          /**           * arbitrary number of components. If these {@link Component}s are
99           * The {@link TranslationAskJDialog} fills its content pane with an           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
100           * arbitrary number of components. If these {@link Component}s are           * values and restore them if the dialog is canceled. Other
101           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the           * {@link JComponent}s are just displayed.<br/>
102           * values and restore them if the dialog is canceled. Other           * This class handles the cancel button itself. You may still want to listen
103           * {@link JComponent}s are just displayed.<br/>           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
104           * This class handles the cancel button itself. You may still want to listen           * to be set visible afterwards.<br/>
105           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has           *
106           * to be set visible afterwards.<br/>           * @param owner
107           * Using this constructor, you have to call setComponents afterwards.           *            A component of the GUI that this dialog is related to. If no
108           */           *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is
109          public TranslationAskJDialog(Window owner) {           *            called.
110                  this(owner, new JComponent[] {});           */
111          }          public TranslationAskJDialog(Component owner,
112                            final JComponent... translationEditJPanels) {
113          /**                  super(SwingUtil.getParentWindow(owner));
114           * The {@link TranslationAskJDialog} fills its content pane with an                  setComponents(translationEditJPanels);
115           * arbitrary number of components. If these {@link Component}s are          }
116           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the  
117           * values and restore them if the dialog is canceled. Other          /**
118           * {@link JComponent}s are just displayed.           * The {@link TranslationAskJDialog} fills its content pane with an
119           *           * arbitrary number of components. If these {@link Component}s are
120           * @param translationEditJPanels           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
121           *            Arbitrary list of {@link JComponent}s and           * values and restore them if the dialog is canceled. Other
122           *            {@link TranslationEditJPanel}s.           * {@link JComponent}s are just displayed.<br/>
123           */           * This class handles the cancel button itself. You may still want to listen
124          public void setComponents(final JComponent... translationEditJPanels) {           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
125                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;           * to be set visible afterwards.<br/>
126             * Using this constructor, you have to call setComponents afterwards.
127                  // Remember backups for all the TranslationEditJPanel           */
128                  int count = 0;          public TranslationAskJDialog(Component owner) {
129                  for (JComponent component : translationEditJPanelsOrJustComponents) {                  super(SwingUtil.getParentWindow(owner));
130                          if (component instanceof TranslationEditJPanel) {          }
131                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;  
132                                  Translation orig = tep.getTranslation();          /**
133             * The {@link TranslationAskJDialog} fills its content pane with an
134                                  // We don't want to overwrite the Translation object on           * arbitrary number of components. If these {@link Component}s are
135                                  // restore(). We just want to change its value.           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
136                                  backup[count++] = orig.toOneLine();           * values and restore them if the dialog is canceled. Other
137                          }           * {@link JComponent}s are just displayed.
138                  }           *
139             * @param translationEditJPanels
140                  init();           *            Arbitrary list of {@link JComponent}s and
141          }           *            {@link TranslationEditJPanel}s.
142             */
143          private void init() {          public void setComponents(final JComponent... translationEditJPanels) {
144                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;
145                  addWindowListener(new WindowAdapter() {  
146                    backup();
147                          public void windowClosing(WindowEvent e) {  
148                                  cancel();                  init();
149                          }          }
150    
151                  });          /**
152                  SwingUtil.centerFrameOnScreen(this);           * Stores the original values of all {@link TranslationEditJPanel}s so
153                  Box box = Box.createVerticalBox();           * cancel works.
154                  for (JComponent panel : translationEditJPanelsOrJustComponents) {           */
155                          box.add(panel);          protected void backup() {
156                  }                  // Remember backups for all the TranslationEditJPanel
157                  JPanel cp = new JPanel(new BorderLayout());                  int count = 0;
158                  cp.add(box, BorderLayout.CENTER);                  for (JComponent component : translationEditJPanelsOrJustComponents) {
159                  cp.add(getButtons(), BorderLayout.SOUTH);                          if (component instanceof TranslationEditJPanel) {
160                  setContentPane(cp);                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;
161                                    Translation orig = tep.getTranslation();
162                  setTitle(RESOURCE.getString("translation_dialog_title")); // i8n  
163                  setModal(true);                                  // We don't want to overwrite the Translation object on
164                  pack();                                  // restore(). We just want to change its value.
165          }                                  backup[count++] = orig.toOneLine();
166                            }
167          protected void cancel() {                  }
168                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);          }
169                  restore();  
170                  setVisible(false);          private void init() {
171                  dispose();                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
172          }                  addWindowListener(new WindowAdapter() {
173    
174          protected void restore() {                          public void windowClosing(WindowEvent e) {
175                  int count = 0;                                  cancel();
176                  for (JComponent component : translationEditJPanelsOrJustComponents) {                          }
177                          if (component instanceof TranslationEditJPanel) {  
178                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;                  });
179                                  tep.getTranslation().fromOneLine(backup[count++]);                  SwingUtil.centerFrameOnScreen(this);
180                          }                  Box box = Box.createVerticalBox();
181                  }                  for (JComponent panel : translationEditJPanelsOrJustComponents) {
182          }                          panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
183                            panel.setBorder(BorderFactory.createEmptyBorder(5, 6, 5, 6));
184          private JComponent getButtons() {                          box.add(panel);
185                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));  
186                  if (okButton == null) {                  }
187                          okButton = new OkButton(new AbstractAction() {                  JPanel cp = new JPanel(new BorderLayout());
188                                  {                  cp.add(box, BorderLayout.WEST);
189                                          // Set a mnemonic character. In most look and feels, this                  cp.add(getButtons(), BorderLayout.SOUTH);
190                                          // causes the                  setContentPane(cp);
191                                          // specified character to be underlined This indicates that  
192                                          // if the component                  setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
193                                          // using this action has the focus and In some look and                  setModal(true);
194                                          // feels, this causes                  pack();
195                                          // the specified character in the label to be underlined and          }
196                                          putValue(Action.MNEMONIC_KEY, new Integer(  
197                                                          java.awt.event.KeyEvent.VK_E));          public void setButtons(JButton... optionalButtons) {
198                    this.optionalButtons = optionalButtons;
199                                          // Set tool tip text                  init();
200                                          putValue(Action.SHORT_DESCRIPTION,          }
201                                                          "Accept the changes made to the translation.");  
202            /**
203                                  }           * Called when the dilaog is closed using the cancel button.
204             */
205                                  public void actionPerformed(ActionEvent evt) {          protected void cancel() {
206                                          TranslationAskJDialog.this.firePropertyChange(                  restore();
207                                                          PROPERTY_APPLY_AND_CLOSE, null, null);                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
208                    setCancelled(true);
209                                          if (!checkValidInputs())                  setVisible(false);
210                                                  return;                  dispose();
211            }
212                                          setVisible(false);  
213                                          dispose();          /**
214                                  }           * Used to restore all the values when cancel has been pressed.
215             */
216                          });          protected void restore() {
217                    int count = 0;
218                  }                  for (JComponent component : translationEditJPanelsOrJustComponents) {
219                  jPanel.add(okButton);                          if (component instanceof TranslationEditJPanel) {
220                                    TranslationEditJPanel tep = (TranslationEditJPanel) component;
221                  if (cancelButton == null) {                                  tep.getTranslation().fromOneLine(backup[count++]);
222                          cancelButton = new CancelButton(new AbstractAction("") {                          }
223                                  public void actionPerformed(ActionEvent evt) {                  }
224                                          restore();          }
225                                          TranslationAskJDialog.this.firePropertyChange(  
226                                                          PROPERTY_CANCEL_AND_CLOSE, null, null);          private JComponent getButtons() {
227                                          setVisible(false);                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
228                                          setCancelled(true);  
229                                          dispose();                  if (optionalButtons != null)
230                                  }                          for (JButton b : optionalButtons) {
231                          });                                  jPanel.add(b);
232                  }                          }
233                  jPanel.add(cancelButton);  
234                    if (okButton == null) {
235                  return jPanel;                          okButton = new OkButton(new AbstractAction() {
236          }                                  {
237                                            // Set a mnemonic character. In most look and feels, this
238          /**                                          // causes the
239           * @return <code>true</code> if none of the translations contains illegal                                          // specified character to be underlined This indicates that
240           *         characters.                                          // if the component
241           */                                          // using this action has the focus and In some look and
242          protected boolean checkValidInputs() {                                          // feels, this causes
243                                            // the specified character in the label to be underlined and
244                  for (JComponent component : translationEditJPanelsOrJustComponents) {                                          putValue(Action.MNEMONIC_KEY, new Integer(
245                          if (component instanceof TranslationEditJPanel) {                                                          java.awt.event.KeyEvent.VK_E));
246                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;  
247                                            // // Set tool tip text
248                                  for (String l : tep.getTranslation().values()) {                                          // putValue(Action.SHORT_DESCRIPTION,
249                                          if (l.contains("{") || l.contains("}")) {                                          // "Accept the changes made to the translation."); //i8n
250                                                  JOptionPane  
251                                                                  .showMessageDialog(                                  }
252                                                                                  this,  
253                                                                                  RESOURCE                                  public void actionPerformed(ActionEvent evt) {
254                                                                                                  .getString("ErrorMsg.InvalidCharacterInTranslation"));                                          TranslationAskJDialog.this.firePropertyChange(
255                                                  return false;                                                          PROPERTY_APPLY_AND_CLOSE, null, null);
256                                          }  
257                                  }                                          if (!checkValidInputs())
258                                                    return;
259                          }  
260                  }                                          okClose();
261    
262                  return true;                                  }
263          }  
264                            });
265          private void setCancelled(boolean hasBeenCanceled) {  
266                  this.hasBeenCanceled = hasBeenCanceled;                  }
267          }                  jPanel.add(okButton);
268    
269          /**                  if (cancelButton == null) {
270           * After the modal dialog has been closed, this allows to find out, whether                          cancelButton = new CancelButton(new AbstractAction("") {
271           * the dialog has been canceled.                                  public void actionPerformed(ActionEvent evt) {
272           *  //                                      restore();
273           * @return <code>true</code> if the {@link JDialog} has been canceled.  //                                      TranslationAskJDialog.this.firePropertyChange(
274           */  //                                                      PROPERTY_CANCEL_AND_CLOSE, null, null);
275          public boolean isCancelled() {  //                                      setVisible(false);
276                  return hasBeenCanceled;  //                                      setCancelled(true);
277          }  //                                      dispose();
278                                            cancel();
279  }                                  }
280                            });
281                    }
282                    jPanel.add(cancelButton);
283    
284                    return jPanel;
285            }
286    
287            /**
288             * This method is only called when the dialog is closed and not cancelled.
289             * Can be overwritten to do anything when the dialog has been accepted.
290             */
291            protected void okClose() {
292                    setVisible(false);
293                    dispose();
294            }
295    
296            /**
297             * @return <code>true</code> if none of the translations contains illegal
298             *         characters.
299             */
300            protected boolean checkValidInputs() {
301    
302                    for (JComponent component : translationEditJPanelsOrJustComponents) {
303                            if (component instanceof TranslationEditJPanel) {
304                                    TranslationEditJPanel tep = (TranslationEditJPanel) component;
305    
306                                    for (String l : tep.getTranslation().values()) {
307                                            if (l.contains("{") || l.contains("}")) {
308                                                    JOptionPane
309                                                                    .showMessageDialog(
310                                                                                    this,
311                                                                                    SwingUtil
312                                                                                                    .R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));
313                                                    return false;
314                                            }
315                                    }
316    
317                            }
318                    }
319    
320                    return true;
321            }
322    
323            private void setCancelled(boolean hasBeenCanceled) {
324                    this.hasBeenCanceled = hasBeenCanceled;
325            }
326    
327            /**
328             * After the modal dialog has been closed, this allows to find out, whether
329             * the dialog has been canceled.
330             *
331             * @return <code>true</code> if the {@link JDialog} has been canceled.
332             */
333            public boolean isCancelled() {
334                    return hasBeenCanceled;
335            }
336    
337    }
Legend:
Removed from v.116  
changed lines
  Added in v.302
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26