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 java.util.Locale;

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.geotools.styling.StylingUtil;
import schmitzm.lang.LangUtil;
import schmitzm.lang.ResourceProvider;
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) {
                this(owner, new JComponent[] {});
        }

        /**
         * 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;

                // 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();
                        }
                }

                init();
        }

        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();
        }

        protected void cancel() {
                firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
                restore();
                setVisible(false);
                dispose();
        }

        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.");

                                }

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

                                        if (!checkValidInputs())
                                                return;

                                        setVisible(false);
                                        dispose();
                                }

                        });

                }
                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();
                                }
                        });
                }
                jPanel.add(cancelButton);

                return jPanel;
        }

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