/[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

trunk/src/skrueger/swing/TranslationAskJDialog.java revision 206 by alfonx, Thu Jul 9 16:45:26 2009 UTC branches/1.0-gt2-2.6/src/skrueger/swing/TranslationAskJDialog.java revision 315 by mojays, Wed Aug 26 11:03:27 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.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;  
42    import javax.swing.AbstractAction;
43          private boolean hasBeenCanceled;  import javax.swing.Action;
44    import javax.swing.BorderFactory;
45          private JButton[] optionalButtons;  import javax.swing.Box;
46    import javax.swing.JButton;
47          /**  import javax.swing.JComponent;
48           * Since the registerKeyboardAction() method is part of the JComponent class  import javax.swing.JDialog;
49           * definition, you must define the Escape keystroke and register the  import javax.swing.JOptionPane;
50           * keyboard action with a JComponent, not with a JDialog. The JRootPane for  import javax.swing.JPanel;
51           * the JDialog serves as an excellent choice to associate the registration,  import javax.swing.JRootPane;
52           * as this will always be visible. If you override the protected  import javax.swing.KeyStroke;
53           * createRootPane() method of JDialog, you can return your custom JRootPane  
54           * with the keystroke enabled:  import schmitzm.swing.SwingUtil;
55           */  import skrueger.i8n.Translation;
56          @Override  
57          protected JRootPane createRootPane() {  public class TranslationAskJDialog extends JDialog {
58                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);  
59                  JRootPane rootPane = new JRootPane();          private String[] backup = new String[50]; // Maximum 50 languages ;-)
60                  rootPane.registerKeyboardAction(new ActionListener() {          private OkButton okButton;
61            private CancelButton cancelButton;
62                          public void actionPerformed(ActionEvent e) {  
63                                  cancel();          public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
64                          }          public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
65    
66                  }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);          private JComponent[] translationEditJPanelsOrJustComponents;
67    
68                  return rootPane;          private boolean hasBeenCanceled;
69          }  
70            private JButton[] optionalButtons;
71          /**  
72           * The {@link TranslationAskJDialog} fills its content pane with an          /**
73           * arbitrary number of components. If these {@link Component}s are           * Since the registerKeyboardAction() method is part of the JComponent class
74           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the           * definition, you must define the Escape keystroke and register the
75           * values and restore them if the dialog is canceled. Other           * keyboard action with a JComponent, not with a JDialog. The JRootPane for
76           * {@link JComponent}s are just displayed.<br/>           * 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. This dialog is modal. The dialog has           * createRootPane() method of JDialog, you can return your custom JRootPane
79           * to be set visible afterwards.<br/>           * with the keystroke enabled:
80           *           */
81           * @param owner          @Override
82           *            A component of the GUI that this dialog is related to. If no          protected JRootPane createRootPane() {
83           *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
84           *            called.                  JRootPane rootPane = new JRootPane();
85           */                  rootPane.registerKeyboardAction(new ActionListener() {
86          public TranslationAskJDialog(Component owner,  
87                          final JComponent... translationEditJPanels) {                          public void actionPerformed(ActionEvent e) {
88                  super(SwingUtil.getParentWindow(owner));                                  cancel();
89                  setComponents(translationEditJPanels);                          }
90          }  
91                    }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
92          /**  
93           * The {@link TranslationAskJDialog} fills its content pane with an                  return rootPane;
94           * arbitrary number of components. If these {@link Component}s are          }
95           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the  
96           * values and restore them if the dialog is canceled. Other          /**
97           * {@link JComponent}s are just displayed.<br/>           * The {@link TranslationAskJDialog} fills its content pane with an
98           * This class handles the cancel button itself. You may still want to listen           * arbitrary number of components. If these {@link Component}s are
99           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
100           * to be set visible afterwards.<br/>           * values and restore them if the dialog is canceled. Other
101           * Using this constructor, you have to call setComponents afterwards.           * {@link JComponent}s are just displayed.<br/>
102           */           * This class handles the cancel button itself. You may still want to listen
103          public TranslationAskJDialog(Component owner) {           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
104                  this(owner, new JComponent[] {});           * to be set visible afterwards.<br/>
105          }           *
106             * @param owner
107          /**           *            A component of the GUI that this dialog is related to. If no
108           * The {@link TranslationAskJDialog} fills its content pane with an           *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is
109           * arbitrary number of components. If these {@link Component}s are           *            called.
110           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the           */
111           * values and restore them if the dialog is canceled. Other          public TranslationAskJDialog(Component owner,
112           * {@link JComponent}s are just displayed.                          final JComponent... translationEditJPanels) {
113           *                  super(SwingUtil.getParentWindow(owner));
114           * @param translationEditJPanels                  setComponents(translationEditJPanels);
115           *            Arbitrary list of {@link JComponent}s and          }
116           *            {@link TranslationEditJPanel}s.  
117           */          /**
118          public void setComponents(final JComponent... translationEditJPanels) {           * The {@link TranslationAskJDialog} fills its content pane with an
119                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;           * arbitrary number of components. If these {@link Component}s are
120             * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
121                  // Remember backups for all the TranslationEditJPanel           * values and restore them if the dialog is canceled. Other
122                  int count = 0;           * {@link JComponent}s are just displayed.<br/>
123                  for (JComponent component : translationEditJPanelsOrJustComponents) {           * This class handles the cancel button itself. You may still want to listen
124                          if (component instanceof TranslationEditJPanel) {           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
125                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;           * to be set visible afterwards.<br/>
126                                  Translation orig = tep.getTranslation();           * Using this constructor, you have to call setComponents afterwards.
127             */
128                                  // We don't want to overwrite the Translation object on          public TranslationAskJDialog(Component owner) {
129                                  // restore(). We just want to change its value.                  super(SwingUtil.getParentWindow(owner));
130                                  backup[count++] = orig.toOneLine();          }
131                          }  
132                  }          /**
133             * The {@link TranslationAskJDialog} fills its content pane with an
134                  init();           * arbitrary number of components. If these {@link Component}s are
135          }           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
136             * values and restore them if the dialog is canceled. Other
137          private void init() {           * {@link JComponent}s are just displayed.
138                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);           *
139                  addWindowListener(new WindowAdapter() {           * @param translationEditJPanels
140             *            Arbitrary list of {@link JComponent}s and
141                          public void windowClosing(WindowEvent e) {           *            {@link TranslationEditJPanel}s.
142                                  cancel();           */
143                          }          public void setComponents(final JComponent... translationEditJPanels) {
144                    this.translationEditJPanelsOrJustComponents = translationEditJPanels;
145                  });  
146                  SwingUtil.centerFrameOnScreen(this);                  backup();
147                  Box box = Box.createVerticalBox();  
148                  for (JComponent panel : translationEditJPanelsOrJustComponents) {                  init();
149                          panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);          }
150                          panel.setBorder( BorderFactory.createEmptyBorder(5, 6, 5, 6));  
151                          box.add(panel);          /**
152                                     * Stores the original values of all {@link TranslationEditJPanel}s so
153                  }           * cancel works.
154                  JPanel cp = new JPanel(new BorderLayout());           */
155                  cp.add(box, BorderLayout.WEST);          protected void backup() {
156                  cp.add(getButtons(), BorderLayout.SOUTH);                  // Remember backups for all the TranslationEditJPanel
157                  setContentPane(cp);                  int count = 0;
158                                    for (JComponent component : translationEditJPanelsOrJustComponents) {
159                  setTitle(SwingUtil.R("TranslationAskJDialog.Title"));                          if (component instanceof TranslationEditJPanel) {
160                  setModal(true);                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;
161                  pack();                                  Translation orig = tep.getTranslation();
162          }  
163                                    // We don't want to overwrite the Translation object on
164          public void setButtons(JButton... optionalButtons) {                                  // restore(). We just want to change its value.
165                  this.optionalButtons = optionalButtons;                                  backup[count++] = orig.toOneLine();
166                  init();                          }
167          }                  }
168            }
169          protected void cancel() {  
170                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);          private void init() {
171                  restore();                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
172                  setVisible(false);                  addWindowListener(new WindowAdapter() {
173                  dispose();  
174          }                          public void windowClosing(WindowEvent e) {
175                                    cancel();
176          protected void restore() {                          }
177                  int count = 0;  
178                  for (JComponent component : translationEditJPanelsOrJustComponents) {                  });
179                          if (component instanceof TranslationEditJPanel) {                  SwingUtil.centerFrameOnScreen(this);
180                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;                  Box box = Box.createVerticalBox();
181                                  tep.getTranslation().fromOneLine(backup[count++]);                  for (JComponent panel : translationEditJPanelsOrJustComponents) {
182                          }                          panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
183                  }                          panel.setBorder(BorderFactory.createEmptyBorder(5, 6, 5, 6));
184          }                          box.add(panel);
185    
186          private JComponent getButtons() {                  }
187                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));                  JPanel cp = new JPanel(new BorderLayout());
188                    cp.add(box, BorderLayout.WEST);
189                  if (optionalButtons != null)                  cp.add(getButtons(), BorderLayout.SOUTH);
190                          for (JButton b : optionalButtons) {                  setContentPane(cp);
191                                  jPanel.add(b);  
192                          }                  setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
193                    setModal(true);
194                  if (okButton == null) {                  pack();
195                          okButton = new OkButton(new AbstractAction() {          }
196                                  {  
197                                          // Set a mnemonic character. In most look and feels, this          public void setButtons(JButton... optionalButtons) {
198                                          // causes the                  this.optionalButtons = optionalButtons;
199                                          // specified character to be underlined This indicates that                  init();
200                                          // if the component          }
201                                          // using this action has the focus and In some look and  
202                                          // feels, this causes          /**
203                                          // the specified character in the label to be underlined and           * Called when the dilaog is closed using the cancel button.
204                                          putValue(Action.MNEMONIC_KEY, new Integer(           */
205                                                          java.awt.event.KeyEvent.VK_E));          protected void cancel() {
206                    restore();
207                                          // Set tool tip text                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
208                                          putValue(Action.SHORT_DESCRIPTION,                  setCancelled(true);
209                                                          "Accept the changes made to the translation.");                  setVisible(false);
210                    dispose();
211                                  }          }
212    
213                                  public void actionPerformed(ActionEvent evt) {          /**
214                                          TranslationAskJDialog.this.firePropertyChange(           * Used to restore all the values when cancel has been pressed.
215                                                          PROPERTY_APPLY_AND_CLOSE, null, null);           */
216            protected void restore() {
217                                          if (!checkValidInputs())                  int count = 0;
218                                                  return;                  for (JComponent component : translationEditJPanelsOrJustComponents) {
219                            if (component instanceof TranslationEditJPanel) {
220                                          setVisible(false);                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;
221                                          dispose();                                  tep.getTranslation().fromOneLine(backup[count++]);
222                                  }                          }
223                    }
224                          });          }
225    
226                  }          private JComponent getButtons() {
227                  jPanel.add(okButton);                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
228    
229                  if (cancelButton == null) {                  if (optionalButtons != null)
230                          cancelButton = new CancelButton(new AbstractAction("") {                          for (JButton b : optionalButtons) {
231                                  public void actionPerformed(ActionEvent evt) {                                  jPanel.add(b);
232                                          restore();                          }
233                                          TranslationAskJDialog.this.firePropertyChange(  
234                                                          PROPERTY_CANCEL_AND_CLOSE, null, null);                  if (okButton == null) {
235                                          setVisible(false);                          okButton = new OkButton(new AbstractAction() {
236                                          setCancelled(true);                                  {
237                                          dispose();                                          // Set a mnemonic character. In most look and feels, this
238                                  }                                          // causes the
239                          });                                          // specified character to be underlined This indicates that
240                  }                                          // if the component
241                  jPanel.add(cancelButton);                                          // using this action has the focus and In some look and
242                                            // feels, this causes
243                  return jPanel;                                          // the specified character in the label to be underlined and
244          }                                          putValue(Action.MNEMONIC_KEY, new Integer(
245                                                            java.awt.event.KeyEvent.VK_E));
246          /**  
247           * @return <code>true</code> if none of the translations contains illegal                                          // // Set tool tip text
248           *         characters.                                          // putValue(Action.SHORT_DESCRIPTION,
249           */                                          // "Accept the changes made to the translation."); //i8n
250          protected boolean checkValidInputs() {  
251                                    }
252                  for (JComponent component : translationEditJPanelsOrJustComponents) {  
253                          if (component instanceof TranslationEditJPanel) {                                  public void actionPerformed(ActionEvent evt) {
254                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;                                          TranslationAskJDialog.this.firePropertyChange(
255                                                            PROPERTY_APPLY_AND_CLOSE, null, null);
256                                  for (String l : tep.getTranslation().values()) {  
257                                          if (l.contains("{") || l.contains("}")) {                                          if (!checkValidInputs())
258                                                  JOptionPane                                                  return;
259                                                                  .showMessageDialog(  
260                                                                                  this,                                          okClose();
261                                                                                  SwingUtil.R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));  
262                                                  return false;                                  }
263                                          }  
264                                  }                          });
265    
266                          }                  }
267                  }                  jPanel.add(okButton);
268    
269                  return true;                  if (cancelButton == null) {
270          }                          cancelButton = new CancelButton(new AbstractAction("") {
271                                    public void actionPerformed(ActionEvent evt) {
272          private void setCancelled(boolean hasBeenCanceled) {  //                                      restore();
273                  this.hasBeenCanceled = hasBeenCanceled;  //                                      TranslationAskJDialog.this.firePropertyChange(
274          }  //                                                      PROPERTY_CANCEL_AND_CLOSE, null, null);
275    //                                      setVisible(false);
276          /**  //                                      setCancelled(true);
277           * After the modal dialog has been closed, this allows to find out, whether  //                                      dispose();
278           * the dialog has been canceled.                                          cancel();
279           *                                  }
280           * @return <code>true</code> if the {@link JDialog} has been canceled.                          });
281           */                  }
282          public boolean isCancelled() {                  jPanel.add(cancelButton);
283                  return hasBeenCanceled;  
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.206  
changed lines
  Added in v.315

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26