skrueger/i8n/Translation.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.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Random;
import java.util.Set;
import java.util.WeakHashMap;

import javax.swing.JComponent;

import org.apache.log4j.Logger;
import org.geotools.util.WeakHashSet;
import org.opengis.util.InternationalString;

import schmitzm.lang.ResourceProvider;
import schmitzm.lang.SortableVector;
import skrueger.geotools.Copyable;

/**
 * Represents a {@link HashMap} of translations. toString() returns the
 * appropriate translation
 * 
 * @author @author <a href="mailto:[email protected]">Stefan Alfons
 *         Tzeggai</a>
 */

public class Translation extends HashMap<String, String> implements
                Copyable<Translation>, Serializable {

        private static final long serialVersionUID = -347702744122305245L;

        public static final String LOCALECHANGE_PROPERTY = "localechange";
        public static final String NO_TRANSLATION = "NO TRANSLATION";
        public static final String DEFAULT_KEY = "default";
        static final Logger LOGGER = Logger.getLogger(Translation.class);
        static String activeLang = Locale.getDefault().getLanguage();

        static protected WeakHashSet<PropertyChangeListener> listeners = new WeakHashSet<PropertyChangeListener>(
                        PropertyChangeListener.class);

        static {

                // TODO default aus Locale auslesen und mit möglichen vergleichen...
                // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht

                // Get default locale
                Locale locale = Locale.getDefault();
                setActiveLang(locale.getLanguage());
        }

        private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
                        ActionListener.class);

        @Override
        /*
         * @comment To make a copy of a translation see methods toOneLine() and
         * fromOneLine()
         */
        public Translation clone() {
                throw new RuntimeException("use copy()");
                // return (Translation) super.clone();
        }

        /**
         * Get the two-letter language sting that is active
         */
        public static String getActiveLang() {
                return activeLang;
        }

        /**
         * Set up the {@link Translation}-system to use language. If a change is
         * performed, events are fired to listeners. Nothing is done if the new
         * language equals the old language. The system's default {@link Locale} is changed.
         * 
         * @param newLang
         *            The ISO Code of the new active language
         */
        public static void setActiveLang(String newLang) {
                setActiveLang(newLang, true);
        }

        /**
         * Set up the {@link Translation}-system to use language. If a change is
         * performed, events are fired to listeners. Nothing is done if the new
         * language equals the old language.
         * 
         * @param newLang
         *            The ISO Code of the new active language
         * 
         * @param setDefaultLocale
         *            Shall the system's default locale be changed?
         */
        public static void setActiveLang(String newLang, boolean setDefaultLocale) {
                if (getActiveLang().equals(newLang)) {
                        return;
                }

                if (!I8NUtil.isValidISOLangCode(newLang)) {
                        throw new IllegalArgumentException("'" + newLang
                                        + "' is not a valid ISO language code.");
                }

                Locale newLocale = new Locale(newLang);
                if (setDefaultLocale)
                        Locale.setDefault(newLocale);

                /**
                 * Setting default locale for Swing JComponents to work around bug
                 * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
                 */
                JComponent.setDefaultLocale(newLocale);

                Translation.activeLang = newLang;

                fireLocaleChangeEvents();

                LOGGER.info("skrueger.i8n.Translation switched ActiveLang to "
                                + newLang);
        }

        /**
         * Initializes a new {@link Translation} with a default translation if a
         * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
         * Other translations may be added later - this is a HashMap<br/>
         * 
         * @param defaultTranslation
         * 
         * @see public Translation(List<String> languages, String
         *      defaultTranslation) {
         * 
         */
        public Translation(String defaultTranslation) {

                fromOneLine(defaultTranslation);

        }

        /**
         * Initializes a new {@link Translation}, an uses the given String to
         * initialize the {@link Translation} for all languages codes passed.
         * 
         * The translations can be changed later
         */
        public Translation(List<String> languages, String defaultTranslation) {
                // put(DEFAULT_KEY, defaultTranslation);
                if (languages == null) {
                        put(DEFAULT_KEY, defaultTranslation);
                } else
                        for (String code : languages) {
                                // if (code.equals(getActiveLang())) {
                                put(code, defaultTranslation);
                                // }
                        }
        }

        /**
         * Sometimes Translations are optional, like for keywords.
         */
        public Translation() {
        }

        /**
         * Fills the {@link Translation} with the values coded into the String
         * Format of {@link String} is: "de{Baum}en{tree}"
         * <p>
         * <ul>
         * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
         * <li>If format can't be recognized, the {@link String} is interpreted as
         * the translation in the <code>{@value #DEFAULT_KEY}</code> language
         * 
         * @author Stefan Alfons Tzeggai
         */
        public void fromOneLine(final String oneLineCoded) {

                clear();

                try {

                        if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
                                put(DEFAULT_KEY, "");
                                return;
                        }

                        if (oneLineCoded.indexOf("}") == -1) {
                                // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
                                put(DEFAULT_KEY, oneLineCoded);
                        }

                        String eatUp = oneLineCoded;
                        while (eatUp.indexOf("}") != -1) {
                                String substring = eatUp.substring(0, eatUp.indexOf("}"));

                                // log.debug("substring = "+substring);
                                String key = substring.substring(0, substring.indexOf("{"));
                                String value = substring.substring(substring.indexOf("{") + 1,
                                                substring.length());
                                // log.debug("key="+key);
                                // log.debug("value="+value);
                                put(key, value);
                                eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
                        }
                } catch (Exception e) {
                        LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
                                        + "'", e);
                        LOGGER.warn("Translation will be empty!");
                }
        }

        /**
         * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
         * 
         * @author Stefan Alfons Tzeggai
         */
        public String toOneLine() {
                return I8NUtil.toOneLine(this);
        }

        /**
         * Returns the right translation by using the {@link #activeLang} field. If
         * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
         * returned. This might be changed for the final release. If the correct
         * language was not found, any entry in the {@link Translation}
         * {@link HashMap} will be returned, that contains more than an empty
         * string.
         */
        @Override
        public String toString() {
                if (get(activeLang) != null) {
                        return get(activeLang);
                }
                // ****************************************************************************
                // MS: The ISDSS needs the concept of the default lang!! So I took the
                // following in again!!
                // ****************************************************************************
                // else return "";
                // //****************************************************************************
                // // The following is commented out.. the concept of the default lang
                // seems to be bad....
                // //****************************************************************************
                // MS:
                else {
                        if (get(DEFAULT_KEY) != null) {
                                return get(DEFAULT_KEY);
                        }

                        // log.debug("return first best <> '' ");
                        if (size() > 0)
                                for (String s : values()) {
                                        if ((s != null) && (s.trim().length() > 0))
                                                return s;
                                }
                }
                // log.warn("No translation found!");
                return NO_TRANSLATION;
        }

        /**
         * {@link PropertyChangeListener} can be registered to be informed when the
         * {@link Locale} changed.<br>
         * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
         * reference to the listener or it will be removed!
         * 
         * @param propertyChangeListener
         *            A {@link PropertyChangeListener} that will be called when
         *            {@link #setActiveLang(String)} changes the language.
         */
        public static void addLocaleChangeListener(
                        PropertyChangeListener propertyChangeListener) {
                listeners.add(propertyChangeListener);
        }

        /**
         * {@link PropertyChangeListener} can be registered to be informed when the
         * {@link Locale} changed.<br>
         * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
         * reference to the listener or it will be removed!
         * 
         * @param propertyChangeListener
         *            A {@link PropertyChangeListener} that will be called when
         *            {@link #setActiveLang(String)} changes the language.
         */
        public static boolean removeLocaleChangeListener(
                        PropertyChangeListener propertyChangeListener) {
                return listeners.remove(propertyChangeListener);
        }

        /**
         * Informs all registered {@link PropertyChangeListener}s about a change of
         * the the {@link Locale}.
         */
        public static void fireLocaleChangeEvents() {
                PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
                                new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
                                null, getActiveLang());
                for (PropertyChangeListener pcl : listeners) {
                        if (pcl != null)
                                pcl.propertyChange(pce);
                }
        }

        /**
         * The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a
         * reference as long as you need the listener.
         */
        public void addTranslationChangeListener(ActionListener actionListener) {
                if (actionListeners.add(actionListener)) {
                        // LOGGER
                        // .debug("registering a new translationChangeActionListener in the WeakHashSet");
                }
        }

        /**
         * The listeneras are stored in a {@link WeakHashSet}! You don't have to
         * remove the listener, as long as you throw away the reference to the
         * listener.
         */
        public boolean removeTranslationChangeListener(ActionListener actionListener) {
                return actionListeners.remove(actionListener);
        }

        public void fireTranslationChangedEvents(String lang) {
                ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);

                final Iterator<ActionListener> iterator = actionListeners.iterator();
                while (iterator.hasNext()) {
                        ActionListener al = iterator.next();
                        al.actionPerformed(ae);
                }
        }

        @Override
        public String put(String lang, String value) {
                String result = super.put(lang, value);
                fireTranslationChangedEvents(lang);
                return result;
        }

        public void fromOneLine(InternationalString iString) {
                if (iString != null)
                        fromOneLine(iString.toString());
                else
                        fromOneLine((String) null);
        }

        /**
         * Copy this {@link Translation} to another {@link Translation} e.g. for
         * editing
         * 
         * @return the destination {@link Translation}
         */
        @Override
        public Translation copyTo(Translation translation2) {

                if (translation2 == null)
                        // throw new IllegalArgumentException(
                        // "Target translation may not be null.");
                        return copy();
                for (String s : keySet()) {
                        translation2.put(s, get(s));
                }

                return translation2;
        }

        @Override
        public Translation copy() {
                return copyTo(new Translation());
        }

        /**
         * Checks if the {@link String}s stored in the {@link Translation} are all
         * valid.
         * 
         * @return <code>true</code> if all good
         */
        public static boolean checkValid(Translation translationToCheck) {

                for (String l : translationToCheck.values()) {

                        if (l.contains("{") || l.contains("}")) {

                                return false;
                        }
                }
                return true;
        }

        /**
         * Goes through the available languages of the FIRST registered {@link ResourceProvider} and set the active locale to the fist match. 
         * 
         * @param fireChangeEvent if <code>true</code>, a Translation.fireLocaleChangeEvents() is issued.

         * @return
         */
        public static boolean setFirstmatchingLanguage(List<String> languages,
                        boolean fireChangeEvent) {

                SortableVector<ResourceProvider> registeredResourceProvider = ResourceProvider
                                .getRegisteredResourceProvider();
                Set<Locale> available = ResourceProvider.getAvailableLocales(
                                registeredResourceProvider.get(0), true);

                for (String l : languages) {
                        for (Locale loc : available) {
                                if (loc.getLanguage().equals(l)) {
                                        Translation.setActiveLang(l);
                                        if (fireChangeEvent)
                                                Translation.fireLocaleChangeEvents();
                                        return true;
                                }
                        }
                }

                return false;

        }
}
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	alfonx	862	* Stefan A. Tzeggai - additional utility classes
29	alfonx	244	******************************************************************************/
30			package skrueger.i8n;
31
32	alfonx	292	import java.awt.event.ActionEvent;
33			import java.awt.event.ActionListener;
34	alfonx	244	import java.beans.PropertyChangeEvent;
35			import java.beans.PropertyChangeListener;
36	alfonx	772	import java.io.Serializable;
37	alfonx	244	import java.util.ArrayList;
38			import java.util.HashMap;
39	alfonx	482	import java.util.Iterator;
40	alfonx	244	import java.util.List;
41			import java.util.Locale;
42	alfonx	292	import java.util.Random;
43	alfonx	905	import java.util.Set;
44	alfonx	607	import java.util.WeakHashMap;
45	alfonx	244
46			import javax.swing.JComponent;
47
48			import org.apache.log4j.Logger;
49	alfonx	482	import org.geotools.util.WeakHashSet;
50	alfonx	409	import org.opengis.util.InternationalString;
51	alfonx	244
52	alfonx	905	import schmitzm.lang.ResourceProvider;
53			import schmitzm.lang.SortableVector;
54	alfonx	420	import skrueger.geotools.Copyable;
55
56	alfonx	244	/**
57			* Represents a {@link HashMap} of translations. toString() returns the
58			* appropriate translation
59			*
60			* @author @author <a href="mailto:[email protected]">Stefan Alfons
61	alfonx	888	* Tzeggai</a>
62	alfonx	244	*/
63
64	alfonx	482	public class Translation extends HashMap<String, String> implements
65	alfonx	772	Copyable<Translation>, Serializable {
66	alfonx	905
67	alfonx	772	private static final long serialVersionUID = -347702744122305245L;
68	alfonx	905
69	alfonx	244	public static final String LOCALECHANGE_PROPERTY = "localechange";
70			public static final String NO_TRANSLATION = "NO TRANSLATION";
71			public static final String DEFAULT_KEY = "default";
72	alfonx	486	static final Logger LOGGER = Logger.getLogger(Translation.class);
73	alfonx	268	static String activeLang = Locale.getDefault().getLanguage();
74	alfonx	244
75	alfonx	607	static protected WeakHashSet<PropertyChangeListener> listeners = new WeakHashSet<PropertyChangeListener>(
76			PropertyChangeListener.class);
77	alfonx	244
78			static {
79
80			// TODO default aus Locale auslesen und mit möglichen vergleichen...
81			// mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
82
83			// Get default locale
84			Locale locale = Locale.getDefault();
85			setActiveLang(locale.getLanguage());
86			}
87
88	alfonx	482	private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
89			ActionListener.class);
90	alfonx	292
91	alfonx	244	@Override
92			/*
93			* @comment To make a copy of a translation see methods toOneLine() and
94			* fromOneLine()
95			*/
96			public Translation clone() {
97	alfonx	420	throw new RuntimeException("use copy()");
98	alfonx	482	// return (Translation) super.clone();
99	alfonx	244	}
100
101			/**
102			* Get the two-letter language sting that is active
103			*/
104			public static String getActiveLang() {
105			return activeLang;
106			}
107
108			/**
109			* Set up the {@link Translation}-system to use language. If a change is
110			* performed, events are fired to listeners. Nothing is done if the new
111	alfonx	905	* language equals the old language. The system's default {@link Locale} is changed.
112	alfonx	244	*
113			* @param newLang
114			* The ISO Code of the new active language
115			*/
116			public static void setActiveLang(String newLang) {
117			setActiveLang(newLang, true);
118			}
119
120			/**
121			* Set up the {@link Translation}-system to use language. If a change is
122			* performed, events are fired to listeners. Nothing is done if the new
123			* language equals the old language.
124			*
125			* @param newLang
126			* The ISO Code of the new active language
127			*
128			* @param setDefaultLocale
129			* Shall the system's default locale be changed?
130			*/
131			public static void setActiveLang(String newLang, boolean setDefaultLocale) {
132			if (getActiveLang().equals(newLang)) {
133			return;
134			}
135
136			if (!I8NUtil.isValidISOLangCode(newLang)) {
137			throw new IllegalArgumentException("'" + newLang
138			+ "' is not a valid ISO language code.");
139			}
140
141			Locale newLocale = new Locale(newLang);
142			if (setDefaultLocale)
143			Locale.setDefault(newLocale);
144
145			/**
146			* Setting default locale for Swing JComponents to work around bug
147			* http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
148			*/
149			JComponent.setDefaultLocale(newLocale);
150
151			Translation.activeLang = newLang;
152
153			fireLocaleChangeEvents();
154
155	alfonx	607	LOGGER.info("skrueger.i8n.Translation switched ActiveLang to "
156			+ newLang);
157	alfonx	244	}
158
159			/**
160			* Initializes a new {@link Translation} with a default translation if a
161			* simple text is passed. If a "oneLine" text is parsed, it is interpreted.
162			* Other translations may be added later - this is a HashMap<br/>
163			*
164			* @param defaultTranslation
165			*
166			* @see public Translation(List<String> languages, String
167			* defaultTranslation) {
168			*
169			*/
170			public Translation(String defaultTranslation) {
171
172			fromOneLine(defaultTranslation);
173
174			}
175
176			/**
177			* Initializes a new {@link Translation}, an uses the given String to
178			* initialize the {@link Translation} for all languages codes passed.
179			*
180			* The translations can be changed later
181			*/
182			public Translation(List<String> languages, String defaultTranslation) {
183			// put(DEFAULT_KEY, defaultTranslation);
184			if (languages == null) {
185			put(DEFAULT_KEY, defaultTranslation);
186			} else
187			for (String code : languages) {
188	alfonx	905	// if (code.equals(getActiveLang())) {
189			put(code, defaultTranslation);
190			// }
191	alfonx	244	}
192			}
193
194			/**
195			* Sometimes Translations are optional, like for keywords.
196			*/
197			public Translation() {
198			}
199
200			/**
201			* Fills the {@link Translation} with the values coded into the String
202			* Format of {@link String} is: "de{Baum}en{tree}"
203			* <p>
204			* <ul>
205			* <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
206			* <li>If format can't be recognized, the {@link String} is interpreted as
207			* the translation in the <code>{@value #DEFAULT_KEY}</code> language
208			*
209	alfonx	862	* @author Stefan Alfons Tzeggai
210	alfonx	244	*/
211			public void fromOneLine(final String oneLineCoded) {
212	alfonx	420
213	alfonx	244	clear();
214	alfonx	482
215	alfonx	420	try {
216	alfonx	244
217	alfonx	482	if ((oneLineCoded == null) \|\| (oneLineCoded.equals(""))) {
218			put(DEFAULT_KEY, "");
219			return;
220			}
221	alfonx	244
222	alfonx	482	if (oneLineCoded.indexOf("}") == -1) {
223			// log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
224			put(DEFAULT_KEY, oneLineCoded);
225			}
226	alfonx	244
227	alfonx	482	String eatUp = oneLineCoded;
228			while (eatUp.indexOf("}") != -1) {
229			String substring = eatUp.substring(0, eatUp.indexOf("}"));
230
231			// log.debug("substring = "+substring);
232			String key = substring.substring(0, substring.indexOf("{"));
233			String value = substring.substring(substring.indexOf("{") + 1,
234			substring.length());
235			// log.debug("key="+key);
236			// log.debug("value="+value);
237			put(key, value);
238			eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
239			}
240	alfonx	420	} catch (Exception e) {
241	alfonx	486	LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
242	alfonx	482	+ "'", e);
243	alfonx	486	LOGGER.warn("Translation will be empty!");
244	alfonx	420	}
245	alfonx	244	}
246
247			/**
248			* Exports the Translations to a String of the Format: "de{Baum}en{tree}"
249			*
250	alfonx	862	* @author Stefan Alfons Tzeggai
251	alfonx	244	*/
252			public String toOneLine() {
253			return I8NUtil.toOneLine(this);
254			}
255
256			/**
257			* Returns the right translation by using the {@link #activeLang} field. If
258			* no translation is set, an ugly String {@link #NO_TRANSLATION} will re
259			* returned. This might be changed for the final release. If the correct
260			* language was not found, any entry in the {@link Translation}
261			* {@link HashMap} will be returned, that contains more than an empty
262			* string.
263			*/
264			@Override
265			public String toString() {
266			if (get(activeLang) != null) {
267			return get(activeLang);
268			}
269			// ****************************************************************************
270			// MS: The ISDSS needs the concept of the default lang!! So I took the
271			// following in again!!
272			// ****************************************************************************
273			// else return "";
274			// //****************************************************************************
275			// // The following is commented out.. the concept of the default lang
276			// seems to be bad....
277			// //****************************************************************************
278			// MS:
279			else {
280			if (get(DEFAULT_KEY) != null) {
281			return get(DEFAULT_KEY);
282			}
283
284			// log.debug("return first best <> '' ");
285			if (size() > 0)
286			for (String s : values()) {
287			if ((s != null) && (s.trim().length() > 0))
288			return s;
289			}
290			}
291	alfonx	482	// log.warn("No translation found!");
292	alfonx	244	return NO_TRANSLATION;
293			}
294
295			/**
296			* {@link PropertyChangeListener} can be registered to be informed when the
297	alfonx	607	* {@link Locale} changed.<br>
298			* The listeners are kept in a {@link WeakHashMap}, so you have to keep a
299			* reference to the listener or it will be removed!
300	alfonx	244	*
301			* @param propertyChangeListener
302	alfonx	607	* A {@link PropertyChangeListener} that will be called when
303			* {@link #setActiveLang(String)} changes the language.
304	alfonx	244	*/
305			public static void addLocaleChangeListener(
306			PropertyChangeListener propertyChangeListener) {
307			listeners.add(propertyChangeListener);
308			}
309
310			/**
311	alfonx	607	* {@link PropertyChangeListener} can be registered to be informed when the
312			* {@link Locale} changed.<br>
313			* The listeners are kept in a {@link WeakHashMap}, so you have to keep a
314			* reference to the listener or it will be removed!
315			*
316			* @param propertyChangeListener
317			* A {@link PropertyChangeListener} that will be called when
318			* {@link #setActiveLang(String)} changes the language.
319			*/
320			public static boolean removeLocaleChangeListener(
321			PropertyChangeListener propertyChangeListener) {
322			return listeners.remove(propertyChangeListener);
323			}
324
325			/**
326	alfonx	244	* Informs all registered {@link PropertyChangeListener}s about a change of
327			* the the {@link Locale}.
328			*/
329			public static void fireLocaleChangeEvents() {
330			PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
331			new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
332			null, getActiveLang());
333			for (PropertyChangeListener pcl : listeners) {
334			if (pcl != null)
335			pcl.propertyChange(pce);
336			}
337			}
338
339	alfonx	482	/**
340			* The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a
341			* reference as long as you need the listener.
342			*/
343	alfonx	292	public void addTranslationChangeListener(ActionListener actionListener) {
344	alfonx	486	if (actionListeners.add(actionListener)) {
345	alfonx	905	// LOGGER
346			// .debug("registering a new translationChangeActionListener in the WeakHashSet");
347	alfonx	486	}
348	alfonx	292	}
349	alfonx	482
350			/**
351			* The listeneras are stored in a {@link WeakHashSet}! You don't have to
352			* remove the listener, as long as you throw away the reference to the
353			* listener.
354			*/
355	alfonx	292	public boolean removeTranslationChangeListener(ActionListener actionListener) {
356			return actionListeners.remove(actionListener);
357			}
358
359	alfonx	300	public void fireTranslationChangedEvents(String lang) {
360			ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
361	alfonx	482
362			final Iterator<ActionListener> iterator = actionListeners.iterator();
363			while (iterator.hasNext()) {
364			ActionListener al = iterator.next();
365			al.actionPerformed(ae);
366	alfonx	292	}
367			}
368	alfonx	482
369	alfonx	292	@Override
370	alfonx	300	public String put(String lang, String value) {
371			String result = super.put(lang, value);
372			fireTranslationChangedEvents(lang);
373	alfonx	292	return result;
374			}
375	alfonx	409
376			public void fromOneLine(InternationalString iString) {
377			if (iString != null)
378			fromOneLine(iString.toString());
379	alfonx	482	else
380			fromOneLine((String) null);
381	alfonx	409	}
382	alfonx	482
383	alfonx	420	/**
384			* Copy this {@link Translation} to another {@link Translation} e.g. for
385			* editing
386			*
387			* @return the destination {@link Translation}
388			*/
389			@Override
390			public Translation copyTo(Translation translation2) {
391	alfonx	482
392	alfonx	420	if (translation2 == null)
393	alfonx	482	// throw new IllegalArgumentException(
394			// "Target translation may not be null.");
395			return copy();
396	alfonx	420	for (String s : keySet()) {
397			translation2.put(s, get(s));
398			}
399	alfonx	482
400	alfonx	420	return translation2;
401			}
402
403			@Override
404			public Translation copy() {
405			return copyTo(new Translation());
406			}
407
408			/**
409	alfonx	482	* Checks if the {@link String}s stored in the {@link Translation} are all
410			* valid.
411			*
412	alfonx	420	* @return <code>true</code> if all good
413			*/
414			public static boolean checkValid(Translation translationToCheck) {
415	alfonx	482
416	alfonx	420	for (String l : translationToCheck.values()) {
417	alfonx	482
418	alfonx	420	if (l.contains("{") \|\| l.contains("}")) {
419	alfonx	482
420	alfonx	420	return false;
421			}
422			}
423			return true;
424			}
425	alfonx	482
426	alfonx	905	/**
427			* Goes through the available languages of the FIRST registered {@link ResourceProvider} and set the active locale to the fist match.
428			*
429			* @param fireChangeEvent if <code>true</code>, a Translation.fireLocaleChangeEvents() is issued.
430
431			* @return
432			*/
433			public static boolean setFirstmatchingLanguage(List<String> languages,
434			boolean fireChangeEvent) {
435
436			SortableVector<ResourceProvider> registeredResourceProvider = ResourceProvider
437			.getRegisteredResourceProvider();
438			Set<Locale> available = ResourceProvider.getAvailableLocales(
439			registeredResourceProvider.get(0), true);
440
441			for (String l : languages) {
442			for (Locale loc : available) {
443			if (loc.getLanguage().equals(l)) {
444			Translation.setActiveLang(l);
445			if (fireChangeEvent)
446			Translation.fireLocaleChangeEvents();
447			return true;
448			}
449			}
450			}
451
452			return false;
453
454			}
455	alfonx	244	}