/*
- * jSite-remote - I18nContainer.java Copyright © 2007 David Roden
- *
+ * jSite - I18nContainer.java - Copyright © 2007–2012 David Roden
+ *
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation; either version 2 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 General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
* Place - Suite 330, Boston, MA 02111-1307, USA.
import java.util.List;
/**
- * @author David Roden <droden@gmail.com>
- * @version $Id$
+ * Container that collects {@link Runnable}s that change the texts of GUI
+ * components when the current locale has changed.
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
*/
public class I18nContainer implements Iterable<Runnable> {
+ /** The container singleton. */
private static final I18nContainer singleton = new I18nContainer();
+
+ /** The list of runnables that change texts. */
private final List<Runnable> i18nRunnables = Collections.synchronizedList(new ArrayList<Runnable>());
+
+ /**
+ * The list of runnables that change texts and run after
+ * {@link #i18nRunnables}.
+ */
private final List<Runnable> i18nPostRunnables = Collections.synchronizedList(new ArrayList<Runnable>());
+ /**
+ * Returns the singleton instance.
+ *
+ * @return The singleton instance
+ */
public static I18nContainer getInstance() {
return singleton;
}
+ /**
+ * Registers an i18n runnable that is run when the current locale has
+ * changed.
+ *
+ * @param i18nRunnable
+ * The runnable to register
+ */
public void registerRunnable(Runnable i18nRunnable) {
i18nRunnables.add(i18nRunnable);
}
+ /**
+ * Registers a {@link Runnable} that changes texts when the current locale
+ * has changed and runs after {@link #i18nRunnables} have run.
+ *
+ * @param i18nPostRunnable
+ * The runnable to register
+ */
public void registerPostRunnable(Runnable i18nPostRunnable) {
i18nPostRunnables.add(i18nPostRunnable);
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * Returns a combined list of {@link #i18nRunnables} and
+ * {@link #i18nPostRunnables}, in that order.
+ */
public Iterator<Runnable> iterator() {
List<Runnable> allRunnables = new ArrayList<Runnable>();
allRunnables.addAll(i18nRunnables);