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