skrueger/swing/TranslationJTextField.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.Color;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

import org.apache.log4j.Logger;

import skrueger.i8n.Translation;

/**
 * A {@link JTextArea} that signals red when it is not filled by a value. A
 * listener is automatically registered with the {@link Translation} to update
 * on {@link Translation} changes.
 * 
 * @author Stefan Alfons Krüger
 * 
 */
public class TranslationJTextField extends JTextField {
        static final protected Logger LOGGER = Logger
                        .getLogger(TranslationJTextField.class);
        int wasValid = 99; // 0 = false, 1 = true, 99 = undefined
        private String langCode;
        private Translation trans;
        /**
         * Listens to changes in the {@link Translation} and update the
         * {@link JTextField}
         */
        private final ActionListener translationChangeActionListener;

        /**
         * This RED indicates a missing translation
         * 
         * TODO to properties ;-)
         */
        final static public Color emptyColor = new Color(240, 190, 190);

        /**
         * Creates a new {@link TranslationJTextField}
         * 
         * @param trans
         * @param langCode
         */
        public TranslationJTextField(final Translation trans, final String langCode) {
                super(trans.get(langCode));
                this.trans = trans;
                this.langCode = langCode;

                /**
                 * SK: Change 26.Mai Use the default for an empty field
                 **/
                if (trans.get(langCode) == null) {
                        String defaultTrans = trans.get(Translation.DEFAULT_KEY);
                        trans.put(langCode, defaultTrans);
                        setText(defaultTrans);
                }

                checkValid();

                // This Listener colors the JTextfiel red if it is empty
                getDocument().addDocumentListener(new DocumentListener() {

                        // This method is called after an insert into the document
                        public void insertUpdate(DocumentEvent evt) {
                                checkValid();
                        }

                        // This method is called after a removal from the document
                        public void removeUpdate(DocumentEvent evt) {
                                checkValid();
                        }

                        // This method is called after one or more attributes have changed.
                        // This method is not called when characters are inserted with
                        // attributes.
                        public void changedUpdate(DocumentEvent evt) {
                                checkValid();
                        }
                });

                /**
                 * Add a Listener to the Translation, so the JTextField can update on
                 * Translation changes.
                 */
                translationChangeActionListener = new ActionListener() {

                        @Override
                        public void actionPerformed(ActionEvent e) {
                                // LOGGER.debug("ActionListener called ");

                                // if (e.getSource() == trans)
                                // // && langCode.equals(e.getActionCommand()))
                                // {
                                // // LOGGER.debug(" and omittet!\n");
                                // return;
                                // }
                                // LOGGER.debug(" and performed!\n");
                                String newString = trans.get(langCode);
                                if (newString == null)
                                        newString = "";
                                if ((newString != null && !newString.equals(getText()))) {
                                        // LOGGER.debug("Setting text to " + newString
                                        // + " becuse oldString was " + getText());

                                        try {
                                                setText(newString);
                                        } catch (java.lang.IllegalStateException ee) {
                                                /*
                                                 * 
                                                 * ERROR AtlasCreator uncaughtException An uncaught
                                                 * exception happened on Thread
                                                 * Thread[AWT-EventQueue-0,6,main]
                                                 * java.lang.IllegalStateException: Attempt to mutate in
                                                 * notification at
                                                 * javax.swing.text.AbstractDocument.writeLock
                                                 * (AbstractDocument.java:1323) at
                                                 * javax.swing.text.AbstractDocument
                                                 * .replace(AbstractDocument.java:644) at
                                                 * javax.swing.text
                                                 * .JTextComponent.setText(JTextComponent.java:1693) at
                                                 * skrueger
                                                 * .swing.TranslationJTextField$2.actionPerformed
                                                 * (TranslationJTextField.java:138) at
                                                 * skrueger.i8n.Translation
                                                 * .fireTranslationChangedEvents(Translation.java:358)
                                                 * at skrueger.i8n.Translation.put(Translation.java:365)
                                                 * atskrueger.swing.TranslationJTextField.checkValid(
                                                 * TranslationJTextField.java:184) at
                                                 * skrueger.swing.TranslationJTextField$1
                                                 * .removeUpdate(TranslationJTextField.java:104) at
                                                 * javax.swing.text.AbstractDocument.fireRemoveUpdate(
                                                 * AbstractDocument.java:243) _
                                                 */
                                                LOGGER.warn(ee);
                                        }
                                }
                        }

                };

                trans.addTranslationChangeListener(translationChangeActionListener);
        }

        /**
         * TODO Is never called. Should be called!
         */
        public void dispose() {
                boolean b = trans
                                .removeTranslationChangeListener(translationChangeActionListener);
                LOGGER.debug("removing translationChangeActionListener = " + b);
        }

        /**
         * If the getText().equals("") sets background color to red. The method also
         * stored the changed string into the {@link Translation} object.
         */
        protected void checkValid() {

                String trimmedText = getText().trim();

                if (trimmedText.equals("")) {
                        // Not valid
                        if (wasValid != 0) {
                                setBackground(emptyColor);
                                repaint();
                                wasValid = 0;
                        }

                } else {
                        // valid
                        if (wasValid != 1) {
                                setBackground(Color.white);
                                repaint();
                                wasValid = 1;
                        }
                        // Directly store the change in the Translation Object
                }

                // LOGGER.debug("putting '"+trimmedText+"' into the translation");
                if (!trimmedText.equals(trans.get(langCode)))
                        trans.put(langCode, trimmedText);
        }
        //
        // ActionListener listenToChangesOfTheTranslationAndUpdateTheGUI = new
        // ActionListener() {
        //
        // @Override
        // public void actionPerformed(ActionEvent e) {
        // if (!hasFocus())
        // translationChangedExternally();
        // }
        // };
        //
        // /**
        // * Call it when the translation object has changed to update the
        // JTextFields
        // */
        // public void translationChangedExternally() {
        // setText(trans.get(langCode));
        // }

}
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	mojays	2	package skrueger.swing;
31
32			import java.awt.Color;
33	alfonx	298	import java.awt.event.ActionEvent;
34			import java.awt.event.ActionListener;
35	mojays	2
36			import javax.swing.JTextArea;
37			import javax.swing.JTextField;
38			import javax.swing.event.DocumentEvent;
39			import javax.swing.event.DocumentListener;
40
41			import org.apache.log4j.Logger;
42
43			import skrueger.i8n.Translation;
44
45			/**
46	alfonx	298	* A {@link JTextArea} that signals red when it is not filled by a value. A
47			* listener is automatically registered with the {@link Translation} to update
48			* on {@link Translation} changes.
49	mojays	2	*
50			* @author Stefan Alfons Krüger
51			*
52			*/
53			public class TranslationJTextField extends JTextField {
54	alfonx	292	static final protected Logger LOGGER = Logger
55			.getLogger(TranslationJTextField.class);
56			int wasValid = 99; // 0 = false, 1 = true, 99 = undefined
57	mojays	2	private String langCode;
58			private Translation trans;
59	alfonx	298	/**
60			* Listens to changes in the {@link Translation} and update the
61			* {@link JTextField}
62			*/
63			private final ActionListener translationChangeActionListener;
64	alfonx	292
65	mojays	2	/**
66	alfonx	292	* This RED indicates a missing translation
67	mojays	2	*
68			* TODO to properties ;-)
69			*/
70	alfonx	292	final static public Color emptyColor = new Color(240, 190, 190);
71	mojays	2
72			/**
73			* Creates a new {@link TranslationJTextField}
74	alfonx	292	*
75			* @param trans
76	mojays	2	* @param langCode
77			*/
78	alfonx	298	public TranslationJTextField(final Translation trans, final String langCode) {
79	mojays	2	super(trans.get(langCode));
80			this.trans = trans;
81			this.langCode = langCode;
82	alfonx	292
83			/**
84			* SK: Change 26.Mai Use the default for an empty field
85			**/
86	mojays	2	if (trans.get(langCode) == null) {
87	alfonx	292	String defaultTrans = trans.get(Translation.DEFAULT_KEY);
88	mojays	2	trans.put(langCode, defaultTrans);
89	alfonx	292	setText(defaultTrans);
90	mojays	2	}
91	alfonx	292
92	mojays	2	checkValid();
93
94			// This Listener colors the JTextfiel red if it is empty
95			getDocument().addDocumentListener(new DocumentListener() {
96
97			// This method is called after an insert into the document
98			public void insertUpdate(DocumentEvent evt) {
99			checkValid();
100			}
101
102			// This method is called after a removal from the document
103			public void removeUpdate(DocumentEvent evt) {
104			checkValid();
105			}
106
107			// This method is called after one or more attributes have changed.
108			// This method is not called when characters are inserted with
109			// attributes.
110			public void changedUpdate(DocumentEvent evt) {
111			checkValid();
112			}
113			});
114	alfonx	298
115			/**
116			* Add a Listener to the Translation, so the JTextField can update on
117			* Translation changes.
118			*/
119			translationChangeActionListener = new ActionListener() {
120
121			@Override
122			public void actionPerformed(ActionEvent e) {
123	alfonx	711	// LOGGER.debug("ActionListener called ");
124	alfonx	300
125	alfonx	712	// if (e.getSource() == trans)
126			// // && langCode.equals(e.getActionCommand()))
127			// {
128			// // LOGGER.debug(" and omittet!\n");
129			// return;
130			// }
131			// LOGGER.debug(" and performed!\n");
132	alfonx	298	String newString = trans.get(langCode);
133			if (newString == null)
134			newString = "";
135			if ((newString != null && !newString.equals(getText()))) {
136	alfonx	712	// LOGGER.debug("Setting text to " + newString
137			// + " becuse oldString was " + getText());
138
139			try {
140			setText(newString);
141			} catch (java.lang.IllegalStateException ee) {
142			/*
143			*
144			* ERROR AtlasCreator uncaughtException An uncaught
145			* exception happened on Thread
146			* Thread[AWT-EventQueue-0,6,main]
147			* java.lang.IllegalStateException: Attempt to mutate in
148			* notification at
149			* javax.swing.text.AbstractDocument.writeLock
150			* (AbstractDocument.java:1323) at
151			* javax.swing.text.AbstractDocument
152			* .replace(AbstractDocument.java:644) at
153			* javax.swing.text
154			* .JTextComponent.setText(JTextComponent.java:1693) at
155			* skrueger
156			* .swing.TranslationJTextField$2.actionPerformed
157			* (TranslationJTextField.java:138) at
158			* skrueger.i8n.Translation
159			* .fireTranslationChangedEvents(Translation.java:358)
160			* at skrueger.i8n.Translation.put(Translation.java:365)
161			* atskrueger.swing.TranslationJTextField.checkValid(
162			* TranslationJTextField.java:184) at
163			* skrueger.swing.TranslationJTextField$1
164			* .removeUpdate(TranslationJTextField.java:104) at
165			* javax.swing.text.AbstractDocument.fireRemoveUpdate(
166			* AbstractDocument.java:243) _
167			*/
168			LOGGER.warn(ee);
169			}
170	alfonx	298	}
171			}
172
173			};
174
175			trans.addTranslationChangeListener(translationChangeActionListener);
176	mojays	2	}
177
178			/**
179	alfonx	298	* TODO Is never called. Should be called!
180			*/
181			public void dispose() {
182			boolean b = trans
183			.removeTranslationChangeListener(translationChangeActionListener);
184			LOGGER.debug("removing translationChangeActionListener = " + b);
185			}
186
187			/**
188	alfonx	292	* If the getText().equals("") sets background color to red. The method also
189			* stored the changed string into the {@link Translation} object.
190	mojays	2	*/
191			protected void checkValid() {
192	alfonx	292
193	mojays	2	String trimmedText = getText().trim();
194	alfonx	292
195	mojays	2	if (trimmedText.equals("")) {
196			// Not valid
197	alfonx	292	if (wasValid != 0) {
198			setBackground(emptyColor);
199	mojays	2	repaint();
200			wasValid = 0;
201			}
202	alfonx	292
203	mojays	2	} else {
204			// valid
205			if (wasValid != 1) {
206			setBackground(Color.white);
207			repaint();
208			wasValid = 1;
209			}
210			// Directly store the change in the Translation Object
211			}
212	alfonx	292
213	alfonx	298	// LOGGER.debug("putting '"+trimmedText+"' into the translation");
214	alfonx	711	if (!trimmedText.equals(trans.get(langCode)))
215			trans.put(langCode, trimmedText);
216	mojays	2	}
217	alfonx	712	//
218			// ActionListener listenToChangesOfTheTranslationAndUpdateTheGUI = new
219			// ActionListener() {
220			//
221			// @Override
222			// public void actionPerformed(ActionEvent e) {
223			// if (!hasFocus())
224			// translationChangedExternally();
225			// }
226			// };
227			//
228			// /**
229			// * Call it when the translation object has changed to update the
230			// JTextFields
231			// */
232			// public void translationChangedExternally() {
233			// setText(trans.get(langCode));
234			// }
235	alfonx	711
236	mojays	2	}