skrueger/i8n/SwitchLanguageDialog.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. Tzeggai - additional utility classes
 ******************************************************************************/
package skrueger.i8n;

import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseWheelListener;
import java.util.List;
import java.util.Locale;

import javax.swing.DefaultComboBoxModel;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JPanel;

import org.apache.log4j.Logger;

import schmitzm.swing.SwingUtil;
import skrueger.swing.AtlasDialog;
import skrueger.swing.OkButton;
import skrueger.swing.TranslationEditJPanel;

/**
 * This dialog ask the user to select one of list of given languages. The dialog
 * is modal and not visible after construction.
 * 
 * @author Stefan A. Tzeggai
 */
public class SwitchLanguageDialog extends AtlasDialog {
        protected Logger LOGGER = Logger.getLogger(SwitchLanguageDialog.class);

        private JPanel jContentPane = null;

        private JLabel jLabelFlagimage = null;

        private JPanel jPanel = null;

        private JButton jButton = null;

        private JPanel jPanel1 = null;

        private JLabel jLabel = null;

        private JComboBox jComboBox = null;

        private final List<String> languages;

        /**
         * if <code>true</code>, the default locale will also be changed during a
         * language selection
         **/
        protected boolean setLocale;

        /**
         * A dialog to select one of the available languages. If only one language
         * is available, select it directly. Creating this object automatically
         * makes it visible, unless there is only one language to choose from.. it
         * that case it disposes itself automatically.
         * 
         * @param setLocale
         *            if <code>true</code>, the default locale will also be changed
         *            during a language selection
         */
        public SwitchLanguageDialog(final Component owner,
                        final List<String> languages, boolean setLocale) {
                super(owner);
                this.languages = languages;
                this.setLocale = setLocale;

                if (languages == null || languages.size() == 0) {
                        // No language is available.
                        return;
                }

                Translation.setActiveLang(languages.get(0), setLocale);
                if (languages.size() == 1) {
                        // Only language one language is available. It has been selected
                        // automatically.
                        return;
                }

                initialize();
        }

        @Override
        /**
         * This modal dialog will not appear if there is <= one language to select from.
         */
        public void setVisible(boolean b) {
                if (b == true && (languages == null || languages.size() <= 1)) {
                        return;
                }
                super.setVisible(b);
        }

        /**
         * This method initializes this
         * 
         * @return void
         */
        private void initialize() {
                this.setContentPane(getJContentPane());

                pack();

                SwingUtil.centerFrameOnScreenRandom(this);
                setModal(true);
        }

        public boolean close() {
                // Only close by ESC and window-close if a valid selection is made
                if (jComboBox.getSelectedIndex() == languages.size())
                        return false;
                else
                        return super.close();
        }

        /**
         * This method initializes jContentPane
         * 
         * @return javax.swing.JPanel
         */
        private JPanel getJContentPane() {
                if (jContentPane == null) {
                        final GridBagConstraints gridBagConstraints11 = new GridBagConstraints();
                        gridBagConstraints11.gridx = 1;
                        gridBagConstraints11.fill = GridBagConstraints.HORIZONTAL;
                        gridBagConstraints11.gridy = 1;
                        final GridBagConstraints gridBagConstraints3 = new GridBagConstraints();
                        gridBagConstraints3.gridx = 1;
                        gridBagConstraints3.fill = GridBagConstraints.HORIZONTAL;
                        gridBagConstraints3.gridy = 2;
                        final GridBagConstraints gridBagConstraints1 = new GridBagConstraints();
                        gridBagConstraints1.gridx = 0;
                        gridBagConstraints1.fill = GridBagConstraints.BOTH;
                        gridBagConstraints1.gridwidth = 2;
                        gridBagConstraints1.anchor = GridBagConstraints.NORTH;
                        gridBagConstraints1.gridy = 0;
                        jLabelFlagimage = new JLabel(new ImageIcon(
                                        TranslationEditJPanel.class
                                                        .getResource("resource/flags.jpg")));
                        jContentPane = new JPanel();
                        jContentPane.setLayout(new GridBagLayout());
                        jContentPane.add(jLabelFlagimage, gridBagConstraints1);
                        jContentPane.add(getJPanel(), gridBagConstraints3);
                        jContentPane.add(getJPanel1(), gridBagConstraints11);
                }
                return jContentPane;
        }

        /**
         * This method initializes jPanel
         * 
         * @return javax.swing.JPanel
         */
        private JPanel getJPanel() {
                if (jPanel == null) {
                        final GridBagConstraints gridBagConstraints4 = new GridBagConstraints();
                        gridBagConstraints4.gridx = 0;
                        gridBagConstraints4.anchor = GridBagConstraints.EAST;
                        gridBagConstraints4.weightx = 1.0;
                        gridBagConstraints4.insets = new Insets(5, 5, 5, 5);
                        gridBagConstraints4.gridy = 0;
                        jPanel = new JPanel();
                        jPanel.setLayout(new GridBagLayout());
                        jPanel.add(getJButton(), gridBagConstraints4);
                }
                return jPanel;
        }

        /**
         * This method initializes jButton
         * 
         * @return javax.swing.JButton
         */
        private JButton getJButton() {
                if (jButton == null) {
                        jButton = new OkButton();
                        jButton.setEnabled(false);

                        jButton.addActionListener(new ActionListener() {

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

                        });
                }
                return jButton;
        }

        /**
         * This method initializes jPanel1
         * 
         * @return javax.swing.JPanel
         */
        private JPanel getJPanel1() {
                if (jPanel1 == null) {
                        final GridBagConstraints gridBagConstraints2 = new GridBagConstraints();
                        gridBagConstraints2.fill = GridBagConstraints.VERTICAL;
                        gridBagConstraints2.gridy = 0;
                        gridBagConstraints2.weightx = 1.0;
                        gridBagConstraints2.insets = new Insets(5, 5, 5, 5);
                        gridBagConstraints2.anchor = GridBagConstraints.WEST;
                        gridBagConstraints2.gridx = 1;
                        final GridBagConstraints gridBagConstraints = new GridBagConstraints();
                        gridBagConstraints.gridx = 0;
                        gridBagConstraints.insets = new Insets(0, 5, 0, 0);
                        gridBagConstraints.gridy = 0;
                        jLabel = new JLabel();
                        jLabel.setText("Select language: "); // i8n!?! Maybe replace with an
                        // icon of an index finger
                        jPanel1 = new JPanel();
                        jPanel1.setLayout(new GridBagLayout());
                        jPanel1.add(jLabel, gridBagConstraints);
                        jPanel1.add(getJComboBox(), gridBagConstraints2);
                }
                return jPanel1;
        }

        /**
         * This method initializes jComboBox
         * 
         * @return javax.swing.JComboBox
         */
        private JComboBox getJComboBox() {
                if (jComboBox == null) {
                        jComboBox = new JComboBox();

                        jComboBox.addMouseWheelListener(new MouseWheelListener() {
                                public void mouseWheelMoved(java.awt.event.MouseWheelEvent e) {

                                        if ((e.getWheelRotation() < 0)) {
                                                if (jComboBox.getSelectedIndex() < jComboBox
                                                                .getItemCount() - 1)
                                                        jComboBox.setSelectedIndex(jComboBox
                                                                        .getSelectedIndex() + 1);
                                        } else {
                                                if (jComboBox.getSelectedIndex() > 0)
                                                        jComboBox.setSelectedIndex(jComboBox
                                                                        .getSelectedIndex() - 1);
                                        }
                                }
                        });

                        String[] langNames = new String[languages.size() + 1];
                        for (int i = 0; i < languages.size(); i++) {

                                Locale locale = I8NUtil.getFirstLocaleForLang(languages.get(i));

                                langNames[i] = locale.getDisplayLanguage(locale) + " / "
                                                + locale.getDisplayLanguage() + " / "
                                                + languages.get(i);
                        }
                        langNames[languages.size()] = "?";

                        jComboBox.setModel(new DefaultComboBoxModel(langNames));
                        jComboBox.setSelectedItem(langNames[languages.size()]);

                        jComboBox.addActionListener(new ActionListener() {

                                public void actionPerformed(final ActionEvent e) {
                                        if (jComboBox.getSelectedIndex() == languages.size()) {
                                                getJButton().setEnabled(false);
                                                return;
                                        }

                                        String l = languages.get(jComboBox.getSelectedIndex());
                                        try {
                                                Translation.setActiveLang(l, setLocale);

                                                getJButton().setEnabled(true);
                                        } catch (java.lang.IllegalArgumentException ee) {
                                                LOGGER.warn("The language " + l + " is not valid", ee);
                                                getJButton().setEnabled(false);
                                        }

                                }

                        });
                }
                return jComboBox;
        }

}
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. Tzeggai - additional utility classes
29	******************************************************************************/
30	package skrueger.i8n;
31
32	import java.awt.Component;
33	import java.awt.GridBagConstraints;
34	import java.awt.GridBagLayout;
35	import java.awt.Insets;
36	import java.awt.event.ActionEvent;
37	import java.awt.event.ActionListener;
38	import java.awt.event.MouseWheelListener;
39	import java.util.List;
40	import java.util.Locale;
41
42	import javax.swing.DefaultComboBoxModel;
43	import javax.swing.ImageIcon;
44	import javax.swing.JButton;
45	import javax.swing.JComboBox;
46	import javax.swing.JLabel;
47	import javax.swing.JPanel;
48
49	import org.apache.log4j.Logger;
50
51	import schmitzm.swing.SwingUtil;
52	import skrueger.swing.AtlasDialog;
53	import skrueger.swing.OkButton;
54	import skrueger.swing.TranslationEditJPanel;
55
56	/**
57	* This dialog ask the user to select one of list of given languages. The dialog
58	* is modal and not visible after construction.
59	*
60	* @author Stefan A. Tzeggai
61	*/
62	public class SwitchLanguageDialog extends AtlasDialog {
63	protected Logger LOGGER = Logger.getLogger(SwitchLanguageDialog.class);
64
65	private JPanel jContentPane = null;
66
67	private JLabel jLabelFlagimage = null;
68
69	private JPanel jPanel = null;
70
71	private JButton jButton = null;
72
73	private JPanel jPanel1 = null;
74
75	private JLabel jLabel = null;
76
77	private JComboBox jComboBox = null;
78
79	private final List<String> languages;
80
81	/**
82	* if <code>true</code>, the default locale will also be changed during a
83	* language selection
84	**/
85	protected boolean setLocale;
86
87	/**
88	* A dialog to select one of the available languages. If only one language
89	* is available, select it directly. Creating this object automatically
90	* makes it visible, unless there is only one language to choose from.. it
91	* that case it disposes itself automatically.
92	*
93	* @param setLocale
94	* if <code>true</code>, the default locale will also be changed
95	* during a language selection
96	*/
97	public SwitchLanguageDialog(final Component owner,
98	final List<String> languages, boolean setLocale) {
99	super(owner);
100	this.languages = languages;
101	this.setLocale = setLocale;
102
103	if (languages == null \|\| languages.size() == 0) {
104	// No language is available.
105	return;
106	}
107
108	Translation.setActiveLang(languages.get(0), setLocale);
109	if (languages.size() == 1) {
110	// Only language one language is available. It has been selected
111	// automatically.
112	return;
113	}
114
115	initialize();
116	}
117
118	@Override
119	/**
120	* This modal dialog will not appear if there is <= one language to select from.
121	*/
122	public void setVisible(boolean b) {
123	if (b == true && (languages == null \|\| languages.size() <= 1)) {
124	return;
125	}
126	super.setVisible(b);
127	}
128
129	/**
130	* This method initializes this
131	*
132	* @return void
133	*/
134	private void initialize() {
135	this.setContentPane(getJContentPane());
136
137	pack();
138
139	SwingUtil.centerFrameOnScreenRandom(this);
140	setModal(true);
141	}
142
143	public boolean close() {
144	// Only close by ESC and window-close if a valid selection is made
145	if (jComboBox.getSelectedIndex() == languages.size())
146	return false;
147	else
148	return super.close();
149	}
150
151	/**
152	* This method initializes jContentPane
153	*
154	* @return javax.swing.JPanel
155	*/
156	private JPanel getJContentPane() {
157	if (jContentPane == null) {
158	final GridBagConstraints gridBagConstraints11 = new GridBagConstraints();
159	gridBagConstraints11.gridx = 1;
160	gridBagConstraints11.fill = GridBagConstraints.HORIZONTAL;
161	gridBagConstraints11.gridy = 1;
162	final GridBagConstraints gridBagConstraints3 = new GridBagConstraints();
163	gridBagConstraints3.gridx = 1;
164	gridBagConstraints3.fill = GridBagConstraints.HORIZONTAL;
165	gridBagConstraints3.gridy = 2;
166	final GridBagConstraints gridBagConstraints1 = new GridBagConstraints();
167	gridBagConstraints1.gridx = 0;
168	gridBagConstraints1.fill = GridBagConstraints.BOTH;
169	gridBagConstraints1.gridwidth = 2;
170	gridBagConstraints1.anchor = GridBagConstraints.NORTH;
171	gridBagConstraints1.gridy = 0;
172	jLabelFlagimage = new JLabel(new ImageIcon(
173	TranslationEditJPanel.class
174	.getResource("resource/flags.jpg")));
175	jContentPane = new JPanel();
176	jContentPane.setLayout(new GridBagLayout());
177	jContentPane.add(jLabelFlagimage, gridBagConstraints1);
178	jContentPane.add(getJPanel(), gridBagConstraints3);
179	jContentPane.add(getJPanel1(), gridBagConstraints11);
180	}
181	return jContentPane;
182	}
183
184	/**
185	* This method initializes jPanel
186	*
187	* @return javax.swing.JPanel
188	*/
189	private JPanel getJPanel() {
190	if (jPanel == null) {
191	final GridBagConstraints gridBagConstraints4 = new GridBagConstraints();
192	gridBagConstraints4.gridx = 0;
193	gridBagConstraints4.anchor = GridBagConstraints.EAST;
194	gridBagConstraints4.weightx = 1.0;
195	gridBagConstraints4.insets = new Insets(5, 5, 5, 5);
196	gridBagConstraints4.gridy = 0;
197	jPanel = new JPanel();
198	jPanel.setLayout(new GridBagLayout());
199	jPanel.add(getJButton(), gridBagConstraints4);
200	}
201	return jPanel;
202	}
203
204	/**
205	* This method initializes jButton
206	*
207	* @return javax.swing.JButton
208	*/
209	private JButton getJButton() {
210	if (jButton == null) {
211	jButton = new OkButton();
212	jButton.setEnabled(false);
213
214	jButton.addActionListener(new ActionListener() {
215
216	public void actionPerformed(ActionEvent e) {
217	dispose();
218	}
219
220	});
221	}
222	return jButton;
223	}
224
225	/**
226	* This method initializes jPanel1
227	*
228	* @return javax.swing.JPanel
229	*/
230	private JPanel getJPanel1() {
231	if (jPanel1 == null) {
232	final GridBagConstraints gridBagConstraints2 = new GridBagConstraints();
233	gridBagConstraints2.fill = GridBagConstraints.VERTICAL;
234	gridBagConstraints2.gridy = 0;
235	gridBagConstraints2.weightx = 1.0;
236	gridBagConstraints2.insets = new Insets(5, 5, 5, 5);
237	gridBagConstraints2.anchor = GridBagConstraints.WEST;
238	gridBagConstraints2.gridx = 1;
239	final GridBagConstraints gridBagConstraints = new GridBagConstraints();
240	gridBagConstraints.gridx = 0;
241	gridBagConstraints.insets = new Insets(0, 5, 0, 0);
242	gridBagConstraints.gridy = 0;
243	jLabel = new JLabel();
244	jLabel.setText("Select language: "); // i8n!?! Maybe replace with an
245	// icon of an index finger
246	jPanel1 = new JPanel();
247	jPanel1.setLayout(new GridBagLayout());
248	jPanel1.add(jLabel, gridBagConstraints);
249	jPanel1.add(getJComboBox(), gridBagConstraints2);
250	}
251	return jPanel1;
252	}
253
254	/**
255	* This method initializes jComboBox
256	*
257	* @return javax.swing.JComboBox
258	*/
259	private JComboBox getJComboBox() {
260	if (jComboBox == null) {
261	jComboBox = new JComboBox();
262
263	jComboBox.addMouseWheelListener(new MouseWheelListener() {
264	public void mouseWheelMoved(java.awt.event.MouseWheelEvent e) {
265
266	if ((e.getWheelRotation() < 0)) {
267	if (jComboBox.getSelectedIndex() < jComboBox
268	.getItemCount() - 1)
269	jComboBox.setSelectedIndex(jComboBox
270	.getSelectedIndex() + 1);
271	} else {
272	if (jComboBox.getSelectedIndex() > 0)
273	jComboBox.setSelectedIndex(jComboBox
274	.getSelectedIndex() - 1);
275	}
276	}
277	});
278
279	String[] langNames = new String[languages.size() + 1];
280	for (int i = 0; i < languages.size(); i++) {
281
282	Locale locale = I8NUtil.getFirstLocaleForLang(languages.get(i));
283
284	langNames[i] = locale.getDisplayLanguage(locale) + " / "
285	+ locale.getDisplayLanguage() + " / "
286	+ languages.get(i);
287	}
288	langNames[languages.size()] = "?";
289
290	jComboBox.setModel(new DefaultComboBoxModel(langNames));
291	jComboBox.setSelectedItem(langNames[languages.size()]);
292
293	jComboBox.addActionListener(new ActionListener() {
294
295	public void actionPerformed(final ActionEvent e) {
296	if (jComboBox.getSelectedIndex() == languages.size()) {
297	getJButton().setEnabled(false);
298	return;
299	}
300
301	String l = languages.get(jComboBox.getSelectedIndex());
302	try {
303	Translation.setActiveLang(l, setLocale);
304
305	getJButton().setEnabled(true);
306	} catch (java.lang.IllegalArgumentException ee) {
307	LOGGER.warn("The language " + l + " is not valid", ee);
308	getJButton().setEnabled(false);
309	}
310
311	}
312
313	});
314	}
315	return jComboBox;
316	}
317
318	}