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) {
                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
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	this(owner, new JComponent[] {});
130	}
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	// Remember backups for all the TranslationEditJPanel
147	int count = 0;
148	for (JComponent component : translationEditJPanelsOrJustComponents) {
149	if (component instanceof TranslationEditJPanel) {
150	TranslationEditJPanel tep = (TranslationEditJPanel) component;
151	Translation orig = tep.getTranslation();
152
153	// We don't want to overwrite the Translation object on
154	// restore(). We just want to change its value.
155	backup[count++] = orig.toOneLine();
156	}
157	}
158
159	init();
160	}
161
162	private void init() {
163	setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
164	addWindowListener(new WindowAdapter() {
165
166	public void windowClosing(WindowEvent e) {
167	cancel();
168	}
169
170	});
171	SwingUtil.centerFrameOnScreen(this);
172	Box box = Box.createVerticalBox();
173	for (JComponent panel : translationEditJPanelsOrJustComponents) {
174	panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
175	panel.setBorder( BorderFactory.createEmptyBorder(5, 6, 5, 6));
176	box.add(panel);
177
178	}
179	JPanel cp = new JPanel(new BorderLayout());
180	cp.add(box, BorderLayout.WEST);
181	cp.add(getButtons(), BorderLayout.SOUTH);
182	setContentPane(cp);
183
184	setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
185	setModal(true);
186	pack();
187	}
188
189	public void setButtons(JButton... optionalButtons) {
190	this.optionalButtons = optionalButtons;
191	init();
192	}
193
194	protected void cancel() {
195	firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
196	restore();
197	setVisible(false);
198	dispose();
199	}
200
201	protected void restore() {
202	int count = 0;
203	for (JComponent component : translationEditJPanelsOrJustComponents) {
204	if (component instanceof TranslationEditJPanel) {
205	TranslationEditJPanel tep = (TranslationEditJPanel) component;
206	tep.getTranslation().fromOneLine(backup[count++]);
207	}
208	}
209	}
210
211	private JComponent getButtons() {
212	JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
213
214	if (optionalButtons != null)
215	for (JButton b : optionalButtons) {
216	jPanel.add(b);
217	}
218
219	if (okButton == null) {
220	okButton = new OkButton(new AbstractAction() {
221	{
222	// Set a mnemonic character. In most look and feels, this
223	// causes the
224	// specified character to be underlined This indicates that
225	// if the component
226	// using this action has the focus and In some look and
227	// feels, this causes
228	// the specified character in the label to be underlined and
229	putValue(Action.MNEMONIC_KEY, new Integer(
230	java.awt.event.KeyEvent.VK_E));
231
232	// Set tool tip text
233	putValue(Action.SHORT_DESCRIPTION,
234	"Accept the changes made to the translation.");
235
236	}
237
238	public void actionPerformed(ActionEvent evt) {
239	TranslationAskJDialog.this.firePropertyChange(
240	PROPERTY_APPLY_AND_CLOSE, null, null);
241
242	if (!checkValidInputs())
243	return;
244
245	setVisible(false);
246	dispose();
247	}
248
249	});
250
251	}
252	jPanel.add(okButton);
253
254	if (cancelButton == null) {
255	cancelButton = new CancelButton(new AbstractAction("") {
256	public void actionPerformed(ActionEvent evt) {
257	restore();
258	TranslationAskJDialog.this.firePropertyChange(
259	PROPERTY_CANCEL_AND_CLOSE, null, null);
260	setVisible(false);
261	setCancelled(true);
262	dispose();
263	}
264	});
265	}
266	jPanel.add(cancelButton);
267
268	return jPanel;
269	}
270
271	/**
272	* @return <code>true</code> if none of the translations contains illegal
273	* characters.
274	*/
275	protected boolean checkValidInputs() {
276
277	for (JComponent component : translationEditJPanelsOrJustComponents) {
278	if (component instanceof TranslationEditJPanel) {
279	TranslationEditJPanel tep = (TranslationEditJPanel) component;
280
281	for (String l : tep.getTranslation().values()) {
282	if (l.contains("{") \|\| l.contains("}")) {
283	JOptionPane
284	.showMessageDialog(
285	this,
286	SwingUtil.R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));
287	return false;
288	}
289	}
290
291	}
292	}
293
294	return true;
295	}
296
297	private void setCancelled(boolean hasBeenCanceled) {
298	this.hasBeenCanceled = hasBeenCanceled;
299	}
300
301	/**
302	* After the modal dialog has been closed, this allows to find out, whether
303	* the dialog has been canceled.
304	*
305	* @return <code>true</code> if the {@link JDialog} has been canceled.
306	*/
307	public boolean isCancelled() {
308	return hasBeenCanceled;
309	}
310
311	}