skrueger/swing/TranslationEditJPanel.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.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.HashSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
import java.util.WeakHashMap;

import javax.swing.BorderFactory;
import javax.swing.JLabel;
import javax.swing.JTextField;
import javax.swing.SpringLayout;
import javax.swing.SwingConstants;

import org.apache.log4j.Logger;

import schmitzm.swing.JPanel;
import schmitzm.swing.SpringUtilities;
import schmitzm.swing.SwingUtil;
import skrueger.i8n.Translation;

/**
 * A {@link JPanel} that asks the user for the translations of a String in
 * several languages. Use {@link TranslationAskJDialog} to display.<br/>
 * The class does not implement any backup/clong strategies. The
 * {@link Translation} object is manipulated directly.<br/>
 * {@link TranslationEditJPanel}s. {@link TranslationAskJDialog} implements a
 * transparent Apply/Cancel logic.
 * 
 * @author Stefan Alfons Krüger
 */
public class TranslationEditJPanel extends JPanel {
        static final protected Logger LOGGER = Logger
                        .getLogger(TranslationEditJPanel.class);

        private final List<String> languages;
        private JPanel translationGrid;
        private Translation trans;

        /**
         * Remembers all {@link JTextField} that have been created.
         */
         private Set<TranslationJTextField> langTextFields = new HashSet<TranslationJTextField>();
        private WeakHashMap<ActionListener, ActionListener> actionListeners = new WeakHashMap<ActionListener, ActionListener>();

        /**
         * Creates a {@link JPanel} that asks the user for the translation of a
         * String in several languages
         */
        public TranslationEditJPanel(Translation trans, List<String> languages_) {
                this(null, trans, languages_);
        }

        /**
         * Creates a {@link JPanel} that asks the user for the translation of a
         * String in several languages and additionally puts a {@link JLabel} with a
         * question at the {@link JPanel}'s first row.
         */
        public TranslationEditJPanel(String question, Translation trans,
                        List<String> languages_) {
                super(new BorderLayout());
                
                SwingUtil.setMinimumWidth(this, 400);

                if (trans == null)
                        trans = new Translation();

                this.trans = trans;
                this.languages = languages_;

                add(getTranslationGrid(), BorderLayout.CENTER);

                if (question != null) {
                        JLabel questionLable = new JLabel(question);
                        questionLable
                                        .setBorder(BorderFactory.createEmptyBorder(6, 6, 6, 6));
                        add(questionLable, BorderLayout.NORTH);
                }

                /**
                 * Add listeners
                 */
        }

        /**
         * Creates a {@link JPanel} that asks the user for the translation of a
         * String in several languages and additionally puts a {@link JLabel} with a
         * question at the {@link JPanel}'s first row.
         * 
         * <br/>
         * This constructor also sets a TitledBorder with the given title.
         */
        public TranslationEditJPanel(Translation title, List<String> languages2,
                        String borderTitle) {
                this(title, languages2);

                setBorder(BorderFactory.createTitledBorder(borderTitle));
        }

        private JPanel getTranslationGrid() {
                if (translationGrid == null) {
                        translationGrid = new JPanel(new SpringLayout());

                        for (String langId : languages) {

                                // language code : entry field for translation
                                JLabel langDesc = new JLabel(langId.toUpperCase() + " :"); // i8n
                                langDesc.setHorizontalAlignment(SwingConstants.RIGHT);
                                langDesc.setVerticalAlignment(SwingConstants.NORTH);

                                TranslationJTextField langTextField = new TranslationJTextField(
                                                trans, langId);
                                // Setting a size
                                langTextField.setPreferredSize(new Dimension(360, 22));
                                langDesc.setLabelFor(langTextField);
                                translationGrid.add(langDesc);
                                translationGrid.add(langTextField);

                                 langTextFields.add(langTextField);
                        }

                        // Lay out the panel.
                        SpringUtilities.makeCompactGrid(translationGrid, languages.size(), // rows,
                                        2, // cols
                                        6, 6, // initX, initY
                                        6, 6); // xPad, yPad

                }
                return translationGrid;
        }

        /**
         * @return The {@link Translation} that this {@link TranslationEditJPanel}
         *         deals with.
         */
        public Translation getTranslation() {
                return trans;
        }

        /**
         * TODO Is never called?!
         */
        public void dispose() {
                for (TranslationJTextField f: langTextFields) {
                        f.dispose();
                }
        }

        public void addTranslationChangeListener(final ActionListener al) {
                final ActionListener actionListener = new ActionListener() {

                        @Override
                        public void actionPerformed(ActionEvent e) {
                                al.actionPerformed(new ActionEvent(TranslationEditJPanel.this,
                                                new Random().nextInt(), ""));
                        }

                };
                actionListeners.put(al, actionListener);
                getTranslation().addTranslationChangeListener(actionListener);
        }

        public void removeTranslationChangeListener(ActionListener al) {
                if (actionListeners.get(al) != null) {
                        ActionListener actionListener = actionListeners.get(al);
                        getTranslation().removeTranslationChangeListener(actionListener);
                        actionListeners.remove(actionListener);
                }
        }

}
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			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
30			package skrueger.swing;
31
32			import java.awt.BorderLayout;
33			import java.awt.Dimension;
34			import java.awt.event.ActionEvent;
35			import java.awt.event.ActionListener;
36			import java.util.HashSet;
37			import java.util.List;
38	alfonx	292	import java.util.Random;
39	alfonx	244	import java.util.Set;
40	alfonx	292	import java.util.WeakHashMap;
41	alfonx	244
42			import javax.swing.BorderFactory;
43			import javax.swing.JLabel;
44			import javax.swing.JTextField;
45			import javax.swing.SpringLayout;
46			import javax.swing.SwingConstants;
47
48			import org.apache.log4j.Logger;
49
50	mojays	289	import schmitzm.swing.JPanel;
51	alfonx	244	import schmitzm.swing.SpringUtilities;
52	alfonx	490	import schmitzm.swing.SwingUtil;
53	alfonx	244	import skrueger.i8n.Translation;
54
55			/**
56			* A {@link JPanel} that asks the user for the translations of a String in
57			* several languages. Use {@link TranslationAskJDialog} to display.<br/>
58			* The class does not implement any backup/clong strategies. The
59			* {@link Translation} object is manipulated directly.<br/>
60			* {@link TranslationEditJPanel}s. {@link TranslationAskJDialog} implements a
61			* transparent Apply/Cancel logic.
62			*
63			* @author Stefan Alfons Krüger
64			*/
65	alfonx	292	public class TranslationEditJPanel extends JPanel {
66	alfonx	244	static final protected Logger LOGGER = Logger
67			.getLogger(TranslationEditJPanel.class);
68
69			private final List<String> languages;
70			private JPanel translationGrid;
71			private Translation trans;
72
73			/**
74			* Remembers all {@link JTextField} that have been created.
75			*/
76	alfonx	298	private Set<TranslationJTextField> langTextFields = new HashSet<TranslationJTextField>();
77	alfonx	292	private WeakHashMap<ActionListener, ActionListener> actionListeners = new WeakHashMap<ActionListener, ActionListener>();
78
79	alfonx	244	/**
80			* Creates a {@link JPanel} that asks the user for the translation of a
81			* String in several languages
82			*/
83			public TranslationEditJPanel(Translation trans, List<String> languages_) {
84			this(null, trans, languages_);
85			}
86
87			/**
88			* Creates a {@link JPanel} that asks the user for the translation of a
89			* String in several languages and additionally puts a {@link JLabel} with a
90			* question at the {@link JPanel}'s first row.
91			*/
92			public TranslationEditJPanel(String question, Translation trans,
93			List<String> languages_) {
94			super(new BorderLayout());
95	alfonx	490
96			SwingUtil.setMinimumWidth(this, 400);
97	alfonx	244
98			if (trans == null)
99			trans = new Translation();
100
101			this.trans = trans;
102			this.languages = languages_;
103
104			add(getTranslationGrid(), BorderLayout.CENTER);
105
106			if (question != null) {
107			JLabel questionLable = new JLabel(question);
108			questionLable
109			.setBorder(BorderFactory.createEmptyBorder(6, 6, 6, 6));
110			add(questionLable, BorderLayout.NORTH);
111			}
112	alfonx	298
113			/**
114			* Add listeners
115			*/
116	alfonx	244	}
117
118	alfonx	298	/**
119			* Creates a {@link JPanel} that asks the user for the translation of a
120			* String in several languages and additionally puts a {@link JLabel} with a
121			* question at the {@link JPanel}'s first row.
122			*
123			* <br/>
124			* This constructor also sets a TitledBorder with the given title.
125			*/
126			public TranslationEditJPanel(Translation title, List<String> languages2,
127			String borderTitle) {
128			this(title, languages2);
129
130			setBorder(BorderFactory.createTitledBorder(borderTitle));
131			}
132
133	alfonx	244	private JPanel getTranslationGrid() {
134			if (translationGrid == null) {
135			translationGrid = new JPanel(new SpringLayout());
136
137			for (String langId : languages) {
138
139			// language code : entry field for translation
140			JLabel langDesc = new JLabel(langId.toUpperCase() + " :"); // i8n
141			langDesc.setHorizontalAlignment(SwingConstants.RIGHT);
142			langDesc.setVerticalAlignment(SwingConstants.NORTH);
143
144			TranslationJTextField langTextField = new TranslationJTextField(
145			trans, langId);
146			// Setting a size
147			langTextField.setPreferredSize(new Dimension(360, 22));
148			langDesc.setLabelFor(langTextField);
149			translationGrid.add(langDesc);
150			translationGrid.add(langTextField);
151	alfonx	292
152	alfonx	298	langTextFields.add(langTextField);
153	alfonx	244	}
154
155			// Lay out the panel.
156			SpringUtilities.makeCompactGrid(translationGrid, languages.size(), // rows,
157			2, // cols
158			6, 6, // initX, initY
159			6, 6); // xPad, yPad
160
161			}
162			return translationGrid;
163			}
164
165			/**
166			* @return The {@link Translation} that this {@link TranslationEditJPanel}
167			* deals with.
168			*/
169			public Translation getTranslation() {
170			return trans;
171			}
172
173	alfonx	298	/**
174			* TODO Is never called?!
175			*/
176			public void dispose() {
177			for (TranslationJTextField f: langTextFields) {
178			f.dispose();
179			}
180			}
181
182	alfonx	292	public void addTranslationChangeListener(final ActionListener al) {
183			final ActionListener actionListener = new ActionListener() {
184	alfonx	244
185	alfonx	292	@Override
186			public void actionPerformed(ActionEvent e) {
187			al.actionPerformed(new ActionEvent(TranslationEditJPanel.this,
188			new Random().nextInt(), ""));
189			}
190	alfonx	244
191	alfonx	292	};
192			actionListeners.put(al, actionListener);
193			getTranslation().addTranslationChangeListener(actionListener);
194	alfonx	244	}
195
196	alfonx	292	public void removeTranslationChangeListener(ActionListener al) {
197			if (actionListeners.get(al) != null) {
198			ActionListener actionListener = actionListeners.get(al);
199			getTranslation().removeTranslationChangeListener(actionListener);
200			actionListeners.remove(actionListener);
201	alfonx	244	}
202			}
203
204			}