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