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