/[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 33 by alfonx, Sat Mar 28 17:06:27 2009 UTC revision 1137 by alfonx, Fri Oct 15 15:21:36 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.Dialog;   * 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.ArrayList;   * modify it under the terms of the GNU Lesser General Public License
13  import java.util.Locale;   * as published by the Free Software Foundation; either version 3
14     * of the License, or (at your option) any later version.
15  import javax.swing.AbstractAction;   *
16  import javax.swing.Action;   * 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.JComponent;   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  import javax.swing.JDialog;   * GNU General Public License for more details.
20  import javax.swing.JPanel;   *
21  import javax.swing.JRootPane;   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22  import javax.swing.KeyStroke;   * along with this program; if not, write to the Free Software
23     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24  import schmitzm.lang.LangUtil;   * or try this link: http://www.gnu.org/licenses/lgpl.html
25  import schmitzm.lang.ResourceProvider;   *
26  import schmitzm.swing.SwingUtil;   * Contributors:
27  import skrueger.i8n.Translation;   *     Martin O. J. Schmitz - initial API and implementation
28     *     Stefan A. Tzeggai - additional utility classes
29  public class TranslationAskJDialog extends JDialog {   ******************************************************************************/
30    package skrueger.swing;
31          /**  
32           * {@link ResourceProvider}, der die Lokalisation fuer GUI-Komponenten des  import java.awt.BorderLayout;
33           * Package {@code skrueger.swing} zur Verfuegung stellt. Diese sind in  import java.awt.Component;
34           * properties-Datein unter {@code skrueger.swing.resource.locales}  import java.awt.FlowLayout;
35           * hinterlegt.  import java.awt.event.ActionEvent;
36           */  import java.awt.event.ActionListener;
37          public static ResourceProvider RESOURCE = new ResourceProvider(LangUtil  import java.awt.event.KeyEvent;
38                          .extendPackagePath(TranslationAskJDialog.class,  import java.awt.event.WindowAdapter;
39                                          "resource.locales.SwingResourceBundle"), Locale.ENGLISH);  import java.awt.event.WindowEvent;
40    
41          private String[] backup = new String[50]; // Maximum 50 languages ;-)  import javax.swing.AbstractAction;
42          private OkButton okButton;  import javax.swing.Action;
43          private CancelButton cancelButton;  import javax.swing.JButton;
44    import javax.swing.JComponent;
45          public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";  import javax.swing.JDialog;
46          public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";  import javax.swing.JPanel;
47    import javax.swing.JRootPane;
48          private final JComponent[] translationEditJPanelsOrJustComponents;  import javax.swing.KeyStroke;
49    
50          private boolean hasBeenCanceled;  import schmitzm.swing.SwingUtil;
51    
52          /**  public class TranslationAskJDialog extends CancellableDialogAdapter{
53           * Since the registerKeyboardAction() method is part of the JComponent class  
54           * definition, you must define the Escape keystroke and register the          private OkButton okButton;
55           * keyboard action with a JComponent, not with a JDialog. The JRootPane for          private CancelButton cancelButton;
56           * the JDialog serves as an excellent choice to associate the registration,  
57           * as this will always be visible. If you override the protected          public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
58           * createRootPane() method of JDialog, you can return your custom JRootPane          public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
59           * with the keystroke enabled:  
60           */          private JComponent[] translationEditJPanelsOrJustComponents;
61          @Override  
62          protected JRootPane createRootPane() {          private boolean hasBeenCanceled;
63                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);  
64                  JRootPane rootPane = new JRootPane();          private JButton[] optionalButtons;
65                  rootPane.registerKeyboardAction(new ActionListener() {          private TranslationsAskJPanel translationsAskPane;
66    
67                          public void actionPerformed(ActionEvent e) {          /**
68                                  cancel();           * Since the registerKeyboardAction() method is part of the JComponent class
69                          }           * definition, you must define the Escape keystroke and register the
70             * keyboard action with a JComponent, not with a JDialog. The JRootPane for
71                  }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);           * the JDialog serves as an excellent choice to associate the registration,
72             * as this will always be visible. If you override the protected
73                  return rootPane;           * createRootPane() method of JDialog, you can return your custom JRootPane
74          }           * with the keystroke enabled:
75             */
76          /**          @Override
77           * This class handles the cancel button itself. You may still want to listen          protected JRootPane createRootPane() {
78           * to PROPERTY_APPLY_AND_CLOSE events.                  KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
79           *                  JRootPane rootPane = new JRootPane();
80           * This dialog is modal. The dialog has to be set visible afterwards.                  rootPane.registerKeyboardAction(new ActionListener() {
81           */  
82          public TranslationAskJDialog(Dialog owner,                          public void actionPerformed(ActionEvent e) {
83                          final JComponent... translationEditJPanels) {                                  cancel();
84                  super(owner);                          }
85                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;  
86                  init();                  }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
87          }  
88                    return rootPane;
89          /**          }
90           * This class handles the cancel button itself. You may still want to listen  
91           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has          /**
92           * to be set visible afterwards.           * The {@link TranslationAskJDialog} fills its content pane with an
93           */           * arbitrary number of components. If these {@link Component}s are
94          public TranslationAskJDialog(Window owner,           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
95                          final JComponent... translationEditJPanels) {           * values and restore them if the dialog is canceled. Other
96                  super(owner);           * {@link JComponent}s are just displayed.<br/>
97                  this.translationEditJPanelsOrJustComponents = translationEditJPanels;           * This class handles the cancel button itself. You may still want to listen
98                  init();           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
99             * to be set visible afterwards.<br/>
100                  // Rememebr backups for all the jtextpanels           */
101                  int count = 0;          public TranslationAskJDialog(Component owner,
102                  for (JComponent component : translationEditJPanelsOrJustComponents) {                          final JComponent... translationEditJPanels) {
103                          if (component instanceof TranslationEditJPanel) {                  super(owner);
104                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;                  setComponents(translationEditJPanels);
105                                  Translation orig = tep.getTranslation();          }
106                                  // We dont' want to overwrite the Translation object on  
107                                  // restore(). We just want to change its values.          /**
108             * The {@link TranslationAskJDialog} fills its content pane with an
109                                  backup[count++] = orig.toOneLine();           * arbitrary number of components. If these {@link Component}s are
110                          }           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
111                  }           * values and restore them if the dialog is canceled. Other
112          }           * {@link JComponent}s are just displayed.<br/>
113             * This class handles the cancel button itself. You may still want to listen
114          private void init() {           * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
115                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);           * to be set visible afterwards.<br/>
116                  addWindowListener(new WindowAdapter() {           * Using this constructor, you have to call setComponents afterwards.
117             */
118                          public void windowClosing(WindowEvent e) {          public TranslationAskJDialog(Component owner) {
119                                  cancel();                  super(owner);
120                          }          }
121    
122                  });          /**
123                  SwingUtil.centerFrameOnScreen(this);           * The {@link TranslationAskJDialog} fills its content pane with an
124                  Box box = Box.createVerticalBox();           * arbitrary number of components. If these {@link Component}s are
125                  for (JComponent panel : translationEditJPanelsOrJustComponents) {           * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
126                          box.add(panel);           * values and restore them if the dialog is canceled. Other
127                  }           * {@link JComponent}s are just displayed.
128                  JPanel cp = new JPanel(new BorderLayout());           *
129                  cp.add(box, BorderLayout.CENTER);           * @param translationEditJPanels
130                  cp.add(getButtons(), BorderLayout.SOUTH);           *            Arbitrary list of {@link JComponent}s and
131                  setContentPane(cp);           *            {@link TranslationEditJPanel}s.
132             */
133                  // dialog.getRootPane().setDefaultButton(okButton);          public void setComponents(final JComponent... translationEditJPanels) {
134                    this.translationEditJPanelsOrJustComponents = translationEditJPanels;
135                  setTitle(RESOURCE.getString("translation_dialog_title")); // i8n  
136                  setModal(true);                  init();
137                  pack();          }
138          }  
139    
140          protected void cancel() {          private void init() {
141                  firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);                  setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
142                  restore();                  addWindowListener(new WindowAdapter() {
143                  setVisible(false);  
144                  dispose();                          public void windowClosing(WindowEvent e) {
145          }                                  cancel();
146                            }
147          private void restore() {  
148                  int count = 0;                  });
149                  for (JComponent component : translationEditJPanelsOrJustComponents) {                  
150                          if (component instanceof TranslationEditJPanel) {                  translationsAskPane = new TranslationsAskJPanel(translationEditJPanelsOrJustComponents);
151                                  TranslationEditJPanel tep = (TranslationEditJPanel) component;                  JPanel cp = new JPanel(new BorderLayout());
152                                  tep.getTranslation().fromOneLine(backup[count++]);                  cp.add(translationsAskPane, BorderLayout.WEST);
153                          }                  cp.add(getButtons(), BorderLayout.SOUTH);
154                  }                  setContentPane(cp);
155          }  
156                    setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
157          private JComponent getButtons() {                  setModal(true);
158                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));                  pack();
159                  if (okButton == null) {                  SwingUtil.setRelativeFramePosition(this, getParent(), .5, .5);
160                          okButton = new OkButton(new AbstractAction() {          }
161                                  {  
162                                          // Set a mnemonic character. In most look and feels, this          public void setOptionalButtons(JButton... optionalButtons) {
163                                          // causes the                  this.optionalButtons = optionalButtons;
164                                          // specified character to be underlined This indicates that                  init();
165                                          // if the component          }
166                                          // using this action has the focus and In some look and  
167                                          // feels, this causes          /**
168                                          // the specified character in the label to be underlined and           * Called when the dilaog is closed using the cancel button. When
169                                          putValue(Action.MNEMONIC_KEY, new Integer(           * overwriting this method, call super.cancel() after restoring your
170                                                          java.awt.event.KeyEvent.VK_E));           * properties.
171             */
172                                          // Set tool tip text          @Override
173                                          putValue(Action.SHORT_DESCRIPTION,          public void cancel() {
174                                                          "Accept the changes made to the translation.");                  translationsAskPane.cancel();
175                    firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
176                                  }                  hasBeenCanceled = true;
177                    setVisible(false);
178                                  public void actionPerformed(ActionEvent evt) {                  dispose();
179                                          TranslationAskJDialog.this.firePropertyChange(          }
180                                                          PROPERTY_APPLY_AND_CLOSE, null, null);  
181                                          setVisible(false);  
182                                          dispose();          private JComponent getButtons() {
183                                          System.out.println("OK button action performed");                  JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
184                                  }  
185                    if (optionalButtons != null)
186                          });                          for (JButton b : optionalButtons) {
187                          // okButton.addKeyListener( new KeyListener() {                                  jPanel.add(b);
188                          //                          }
189                          // public void keyTyped(KeyEvent e) {  
190                          // if ()                  if (okButton == null) {
191                          // okButton.action(new KEyPreEvent(), what)                          okButton = new OkButton(new AbstractAction() {
192                          // }                                  {
193                          //                                                                        // Set a mnemonic character. In most look and feels, this
194                          // });                                          // causes the
195                  }                                          // specified character to be underlined This indicates that
196                  jPanel.add(okButton);                                          // if the component
197                                            // using this action has the focus and In some look and
198                  if (cancelButton == null) {                                          // feels, this causes
199                          cancelButton = new CancelButton(new AbstractAction("") {                                          // the specified character in the label to be underlined and
200                                  public void actionPerformed(ActionEvent evt) {                                          putValue(Action.MNEMONIC_KEY, new Integer(
201                                          // restore();                                                          java.awt.event.KeyEvent.VK_E));
202                                          TranslationAskJDialog.this.firePropertyChange(  
203                                                          PROPERTY_CANCEL_AND_CLOSE, null, null);                                          // // Set tool tip text
204                                          setVisible(false);                                          // putValue(Action.SHORT_DESCRIPTION,
205                                          setHasBeenCanceled(true);                                          // "Accept the changes made to the translation."); //i8n
206                                          dispose();  
207                                  }                                  }
208                          });  
209                  }                                  public void actionPerformed(ActionEvent evt) {
210                  jPanel.add(cancelButton);  
211                                            okClose();
212                  return jPanel;  
213          }                                  }
214    
215          public static void main(String[] args) {                          });
216                  ArrayList<String> lang = new ArrayList<String>();  
217                  lang.add("de");                  }
218                  lang.add("en");                  jPanel.add(okButton);
219                  lang.add("fr");  
220                    if (cancelButton == null) {
221                  Translation transe = new Translation();                          cancelButton = new CancelButton(new AbstractAction("") {
222                  transe.put("de", "Terciopelo-Lanzenotter");                                  public void actionPerformed(ActionEvent evt) {
223                  TranslationEditJPanel p1 = new TranslationEditJPanel(                                          cancel();
224                                  "Name von New Group", transe, lang);                                  }
225                            });
226                  Translation transe2 = new Translation();                  }
227                  transe2                  jPanel.add(cancelButton);
228                                  .put(  
229                                                  "de",                  return jPanel;
230                                                  "Terciopelo-Lanzenotter (Bothrops asper) ist eine in Mittelamerika und im Nordwesten Südamerikas weit verbreitete Schlangenart.");          }
231                  TranslationEditJPanel p2 = new TranslationEditJPanel(  
232                                  "Description of Animal:", transe2, lang);          /**
233             * This method is only called when the dialog is closed and not canceled.
234                  // JFrame frame = new JFrame();           * Can be overwritten to do anything when the dialog has been accepted.
235                  // frame.setContentPane(p1);           */
236                  // frame.pack();          public boolean okClose() {
237                  // frame.setVisible(true);  
238                    if (!translationsAskPane.checkValidInputs())
239                  TranslationAskJDialog dialog = new TranslationAskJDialog(null, p1, p2);                          return false;
240                  dialog.setVisible(true);                  
241          }                  
242                    dispose();
243          private void setHasBeenCanceled(boolean hasBeenCanceled) {                  
244                  this.hasBeenCanceled = hasBeenCanceled;                  TranslationAskJDialog.this.firePropertyChange(
245          }                                  PROPERTY_APPLY_AND_CLOSE, null, null);
246                    return true;
247          /**          }
248           * After the modal dialog has been closed, this allows to find out, wether  
249           * the dialog has been canceled.  
250           *  
251           * @return          /**
252           */           * After the modal dialog has been closed, this allows to find out, whether
253          public boolean isHasBeenCanceled() {           * the {@link Component} has been canceled.
254                  return hasBeenCanceled;           *
255          }           * @return <code>true</code> if the {@link JDialog} has been canceled.
256             */
257  }          public boolean isCancelled() {
258                    return hasBeenCanceled;
259            }
260    
261    }
Legend:
Removed from v.33  
changed lines
  Added in v.1137
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26