skrueger/swing/TranslationAskJDialog.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Krüger - additional utility classes
 ******************************************************************************/
package skrueger.swing;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JRootPane;
import javax.swing.KeyStroke;

import schmitzm.swing.SwingUtil;
import skrueger.i8n.Translation;

public class TranslationAskJDialog extends JDialog {

        private String[] backup = new String[50]; // Maximum 50 languages ;-)
        private OkButton okButton;
        private CancelButton cancelButton;

        public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
        public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";

        private JComponent[] translationEditJPanelsOrJustComponents;

        private boolean hasBeenCanceled;

        private JButton[] optionalButtons;

        /**
         * Since the registerKeyboardAction() method is part of the JComponent class
         * definition, you must define the Escape keystroke and register the
         * keyboard action with a JComponent, not with a JDialog. The JRootPane for
         * the JDialog serves as an excellent choice to associate the registration,
         * as this will always be visible. If you override the protected
         * createRootPane() method of JDialog, you can return your custom JRootPane
         * with the keystroke enabled:
         */
        @Override
        protected JRootPane createRootPane() {
                KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
                JRootPane rootPane = new JRootPane();
                rootPane.registerKeyboardAction(new ActionListener() {

                        public void actionPerformed(ActionEvent e) {
                                cancel();
                        }

                }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);

                return rootPane;
        }

        /**
         * The {@link TranslationAskJDialog} fills its content pane with an
         * arbitrary number of components. If these {@link Component}s are
         * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
         * values and restore them if the dialog is canceled. Other
         * {@link JComponent}s are just displayed.<br/>
         * 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
         * to be set visible afterwards.<br/>
         * 
         * @param owner
         *            A component of the GUI that this dialog is related to. If no
         *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is
         *            called.
         */
        public TranslationAskJDialog(Component owner,
                        final JComponent... translationEditJPanels) {
                super(SwingUtil.getParentWindow(owner));
                setComponents(translationEditJPanels);
        }

        /**
         * The {@link TranslationAskJDialog} fills its content pane with an
         * arbitrary number of components. If these {@link Component}s are
         * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
         * values and restore them if the dialog is canceled. Other
         * {@link JComponent}s are just displayed.<br/>
         * 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
         * to be set visible afterwards.<br/>
         * Using this constructor, you have to call setComponents afterwards.
         */
        public TranslationAskJDialog(Component owner) {
                super(SwingUtil.getParentWindow(owner));
        }

        /**
         * The {@link TranslationAskJDialog} fills its content pane with an
         * arbitrary number of components. If these {@link Component}s are
         * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
         * values and restore them if the dialog is canceled. Other
         * {@link JComponent}s are just displayed.
         * 
         * @param translationEditJPanels
         *            Arbitrary list of {@link JComponent}s and
         *            {@link TranslationEditJPanel}s.
         */
        public void setComponents(final JComponent... translationEditJPanels) {
                this.translationEditJPanelsOrJustComponents = translationEditJPanels;

                backup();

                init();
        }

        /**
         * Stores the original values of all {@link TranslationEditJPanel}s so
         * cancel works.
         */
        protected void backup() {
                // Remember backups for all the TranslationEditJPanel
                int count = 0;
                for (JComponent component : translationEditJPanelsOrJustComponents) {
                        if (component instanceof TranslationEditJPanel) {
                                TranslationEditJPanel tep = (TranslationEditJPanel) component;
                                Translation orig = tep.getTranslation();

                                // We don't want to overwrite the Translation object on
                                // restore(). We just want to change its value.
                                backup[count++] = orig.toOneLine();
                        }
                }
        }

        private void init() {
                setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
                addWindowListener(new WindowAdapter() {

                        public void windowClosing(WindowEvent e) {
                                cancel();
                        }

                });
                SwingUtil.centerFrameOnScreen(this);
                Box box = Box.createVerticalBox();
                for (JComponent panel : translationEditJPanelsOrJustComponents) {
                        panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
                        panel.setBorder(BorderFactory.createEmptyBorder(5, 6, 5, 6));
                        box.add(panel);

                }
                JPanel cp = new JPanel(new BorderLayout());
                cp.add(box, BorderLayout.WEST);
                cp.add(getButtons(), BorderLayout.SOUTH);
                setContentPane(cp);

                setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
                setModal(true);
                pack();
        }

        public void setButtons(JButton... optionalButtons) {
                this.optionalButtons = optionalButtons;
                init();
        }

        /**
         * Called when the dilaog is closed using the cancel button.
         */
        protected void cancel() {
                restore();
                firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
                setCancelled(true);
                setVisible(false);
                dispose();
        }

        /**
         * Used to restore all the values when cancel has been pressed.
         */
        protected void restore() {
                int count = 0;
                for (JComponent component : translationEditJPanelsOrJustComponents) {
                        if (component instanceof TranslationEditJPanel) {
                                TranslationEditJPanel tep = (TranslationEditJPanel) component;
                                tep.getTranslation().fromOneLine(backup[count++]);
                        }
                }
        }

        private JComponent getButtons() {
                JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));

                if (optionalButtons != null)
                        for (JButton b : optionalButtons) {
                                jPanel.add(b);
                        }

                if (okButton == null) {
                        okButton = new OkButton(new AbstractAction() {
                                {
                                        // Set a mnemonic character. In most look and feels, this
                                        // causes the
                                        // specified character to be underlined This indicates that
                                        // if the component
                                        // using this action has the focus and In some look and
                                        // feels, this causes
                                        // the specified character in the label to be underlined and
                                        putValue(Action.MNEMONIC_KEY, new Integer(
                                                        java.awt.event.KeyEvent.VK_E));

                                        // // Set tool tip text
                                        // putValue(Action.SHORT_DESCRIPTION,
                                        // "Accept the changes made to the translation."); //i8n

                                }

                                public void actionPerformed(ActionEvent evt) {
                                        TranslationAskJDialog.this.firePropertyChange(
                                                        PROPERTY_APPLY_AND_CLOSE, null, null);

                                        if (!checkValidInputs())
                                                return;

                                        okClose();

                                }

                        });

                }
                jPanel.add(okButton);

                if (cancelButton == null) {
                        cancelButton = new CancelButton(new AbstractAction("") {
                                public void actionPerformed(ActionEvent evt) {
//                                      restore();
//                                      TranslationAskJDialog.this.firePropertyChange(
//                                                      PROPERTY_CANCEL_AND_CLOSE, null, null);
//                                      setVisible(false);
//                                      setCancelled(true);
//                                      dispose();
                                        cancel();
                                }
                        });
                }
                jPanel.add(cancelButton);

                return jPanel;
        }

        /**
         * This method is only called when the dialog is closed and not cancelled.
         * Can be overwritten to do anything when the dialog has been accepted.
         */
        protected void okClose() {
                setVisible(false);
                dispose();
        }

        /**
         * @return <code>true</code> if none of the translations contains illegal
         *         characters.
         */
        protected boolean checkValidInputs() {

                for (JComponent component : translationEditJPanelsOrJustComponents) {
                        if (component instanceof TranslationEditJPanel) {
                                TranslationEditJPanel tep = (TranslationEditJPanel) component;

                                for (String l : tep.getTranslation().values()) {
                                        if (l.contains("{") || l.contains("}")) {
                                                JOptionPane
                                                                .showMessageDialog(
                                                                                this,
                                                                                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;
        }

}
1	alfonx	244	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5	alfonx	256	* classes based on Java 1.6, focusing (not only) on Java Swing
6	alfonx	244	* and the Geotools library.
7			*
8			* The SCHMITZM project is hosted at:
9			* http://wald.intevation.org/projects/schmitzm/
10			*
11			* This program is free software; you can redistribute it and/or
12			* modify it under the terms of the GNU Lesser General Public License
13			* as published by the Free Software Foundation; either version 3
14			* of the License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU Lesser General Public License (license.txt)
22			* 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			* or try this link: http://www.gnu.org/licenses/lgpl.html
25			*
26			* Contributors:
27			* Martin O. J. Schmitz - initial API and implementation
28			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
30			package skrueger.swing;
31
32			import java.awt.BorderLayout;
33			import java.awt.Component;
34			import java.awt.FlowLayout;
35			import java.awt.Window;
36			import java.awt.event.ActionEvent;
37			import java.awt.event.ActionListener;
38			import java.awt.event.KeyEvent;
39			import java.awt.event.WindowAdapter;
40			import java.awt.event.WindowEvent;
41
42			import javax.swing.AbstractAction;
43			import javax.swing.Action;
44			import javax.swing.BorderFactory;
45			import javax.swing.Box;
46			import javax.swing.JButton;
47			import javax.swing.JComponent;
48			import javax.swing.JDialog;
49			import javax.swing.JOptionPane;
50			import javax.swing.JPanel;
51			import javax.swing.JRootPane;
52			import javax.swing.KeyStroke;
53
54			import schmitzm.swing.SwingUtil;
55			import skrueger.i8n.Translation;
56
57			public class TranslationAskJDialog extends JDialog {
58
59			private String[] backup = new String[50]; // Maximum 50 languages ;-)
60			private OkButton okButton;
61			private CancelButton cancelButton;
62
63			public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
64			public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
65
66			private JComponent[] translationEditJPanelsOrJustComponents;
67
68			private boolean hasBeenCanceled;
69
70			private JButton[] optionalButtons;
71
72			/**
73			* Since the registerKeyboardAction() method is part of the JComponent class
74			* definition, you must define the Escape keystroke and register the
75			* 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			* 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			@Override
82			protected JRootPane createRootPane() {
83			KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
84			JRootPane rootPane = new JRootPane();
85			rootPane.registerKeyboardAction(new ActionListener() {
86
87			public void actionPerformed(ActionEvent e) {
88			cancel();
89			}
90
91			}, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
92
93			return rootPane;
94			}
95
96			/**
97			* The {@link TranslationAskJDialog} fills its content pane with an
98			* arbitrary number of components. If these {@link Component}s are
99			* {@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			* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
104			* 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			* {@link Window} is passed, SwingUtil.getParentWindow(owner) is
109			* called.
110			*/
111			public TranslationAskJDialog(Component owner,
112			final JComponent... translationEditJPanels) {
113			super(SwingUtil.getParentWindow(owner));
114			setComponents(translationEditJPanels);
115			}
116
117			/**
118			* The {@link TranslationAskJDialog} fills its content pane with an
119			* arbitrary number of components. If these {@link Component}s are
120			* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
121			* values and restore them if the dialog is canceled. Other
122			* {@link JComponent}s are just displayed.<br/>
123			* This class handles the cancel button itself. You may still want to listen
124			* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
125			* to be set visible afterwards.<br/>
126			* Using this constructor, you have to call setComponents afterwards.
127			*/
128			public TranslationAskJDialog(Component owner) {
129	alfonx	302	super(SwingUtil.getParentWindow(owner));
130	alfonx	244	}
131
132			/**
133			* The {@link TranslationAskJDialog} fills its content pane with an
134			* 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			* {@link JComponent}s are just displayed.
138			*
139			* @param translationEditJPanels
140			* Arbitrary list of {@link JComponent}s and
141			* {@link TranslationEditJPanel}s.
142			*/
143			public void setComponents(final JComponent... translationEditJPanels) {
144			this.translationEditJPanelsOrJustComponents = translationEditJPanels;
145
146	alfonx	302	backup();
147
148			init();
149			}
150
151			/**
152			* Stores the original values of all {@link TranslationEditJPanel}s so
153			* cancel works.
154			*/
155			protected void backup() {
156	alfonx	244	// Remember backups for all the TranslationEditJPanel
157			int count = 0;
158			for (JComponent component : translationEditJPanelsOrJustComponents) {
159			if (component instanceof TranslationEditJPanel) {
160			TranslationEditJPanel tep = (TranslationEditJPanel) component;
161			Translation orig = tep.getTranslation();
162
163			// We don't want to overwrite the Translation object on
164			// restore(). We just want to change its value.
165			backup[count++] = orig.toOneLine();
166			}
167			}
168			}
169
170			private void init() {
171			setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
172			addWindowListener(new WindowAdapter() {
173
174			public void windowClosing(WindowEvent e) {
175			cancel();
176			}
177
178			});
179			SwingUtil.centerFrameOnScreen(this);
180			Box box = Box.createVerticalBox();
181			for (JComponent panel : translationEditJPanelsOrJustComponents) {
182			panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
183	alfonx	302	panel.setBorder(BorderFactory.createEmptyBorder(5, 6, 5, 6));
184	alfonx	244	box.add(panel);
185	alfonx	302
186	alfonx	244	}
187			JPanel cp = new JPanel(new BorderLayout());
188			cp.add(box, BorderLayout.WEST);
189			cp.add(getButtons(), BorderLayout.SOUTH);
190			setContentPane(cp);
191	alfonx	302
192			setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
193	alfonx	244	setModal(true);
194			pack();
195			}
196
197			public void setButtons(JButton... optionalButtons) {
198			this.optionalButtons = optionalButtons;
199			init();
200			}
201
202	alfonx	302	/**
203			* Called when the dilaog is closed using the cancel button.
204			*/
205	alfonx	244	protected void cancel() {
206	alfonx	302	restore();
207	alfonx	244	firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
208	alfonx	302	setCancelled(true);
209	alfonx	244	setVisible(false);
210			dispose();
211			}
212
213	alfonx	302	/**
214			* Used to restore all the values when cancel has been pressed.
215			*/
216	alfonx	244	protected void restore() {
217			int count = 0;
218			for (JComponent component : translationEditJPanelsOrJustComponents) {
219			if (component instanceof TranslationEditJPanel) {
220			TranslationEditJPanel tep = (TranslationEditJPanel) component;
221			tep.getTranslation().fromOneLine(backup[count++]);
222			}
223			}
224			}
225
226			private JComponent getButtons() {
227			JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
228
229			if (optionalButtons != null)
230			for (JButton b : optionalButtons) {
231			jPanel.add(b);
232			}
233
234			if (okButton == null) {
235			okButton = new OkButton(new AbstractAction() {
236			{
237			// 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			// using this action has the focus and In some look and
242			// feels, this causes
243			// 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	alfonx	302	// // Set tool tip text
248			// putValue(Action.SHORT_DESCRIPTION,
249			// "Accept the changes made to the translation."); //i8n
250	alfonx	244
251			}
252
253			public void actionPerformed(ActionEvent evt) {
254			TranslationAskJDialog.this.firePropertyChange(
255			PROPERTY_APPLY_AND_CLOSE, null, null);
256
257			if (!checkValidInputs())
258			return;
259
260	alfonx	302	okClose();
261
262	alfonx	244	}
263
264			});
265
266			}
267			jPanel.add(okButton);
268
269			if (cancelButton == null) {
270			cancelButton = new CancelButton(new AbstractAction("") {
271			public void actionPerformed(ActionEvent evt) {
272	alfonx	302	// restore();
273			// TranslationAskJDialog.this.firePropertyChange(
274			// PROPERTY_CANCEL_AND_CLOSE, null, null);
275			// setVisible(false);
276			// setCancelled(true);
277			// dispose();
278			cancel();
279	alfonx	244	}
280			});
281			}
282			jPanel.add(cancelButton);
283
284			return jPanel;
285			}
286
287			/**
288	alfonx	302	* 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	alfonx	244	* @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	alfonx	302	SwingUtil
312			.R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));
313	alfonx	244	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			}