summaryrefslogtreecommitdiffstats
path: root/logo/src/xlogo/gui/components/X4SGui.java
blob: bef236e097ea8c41f71f9ad9455914d0e2b6610e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/* XLogo4Schools - A Logo Interpreter specialized for use in schools, based on XLogo by Loic Le Coq
 * Copyright (C) 2013 Marko Zivkovic
 * 
 * Contact Information: marko88zivkovic at gmail dot com
 * 
 * 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., 51 Franklin Street, Fifth Floor, Boston, 
 * MA 02110-1301, USA.
 * 
 * 
 * This Java source code belongs to XLogo4Schools, written by Marko Zivkovic
 * during his Bachelor thesis at the computer science department of ETH Zurich,
 * in the year 2013 and/or during future work.
 * 
 * It is a reengineered version of XLogo written by Loic Le Coq, published
 * under the GPL License at http://xlogo.tuxfamily.org/
 * 
 * Contents of this file were entirely written by Marko Zivkovic
 */

package xlogo.gui.components;

import xlogo.AppSettings;
import xlogo.AppSettings.AppProperty;
import xlogo.interfaces.Observable.PropertyChangeListener;

/**
 * Automatically calls all convenience features in the following order:
 * <li> initComponent() </li>
 * <li> layoutComponent() </li>
 * <li> setText() </li>
 * <li> initEventListeners() </li>
 * <li> startListernForLanguageChangeEvents() </li>
 * <p> Additionally, setText is called when language is changed by the user.
 * If you do not need to update the language, just {@link X4SGui#stopListenForLanguageChangeEvents()}
 * @since June 10th 2014
 * @author Marko
 */
public abstract class X4SGui {

	public X4SGui() {
		initComponent();
		layoutComponent();
		setText();
		initEventListeners();
		startListenForLanguageChangeEvents();
	}
	/**
	 * Subclassses should make sure the component is completely initialized and ready to be used.
	 * Called before setText() and layotComponent()
	 */
	protected abstract void initComponent();
	
	protected abstract void layoutComponent();
	
	protected abstract void initEventListeners();
	
	public void stopEventListeners()
	{
		stopListenForLanguageChangeEvents();
	}
	
	private PropertyChangeListener languageChangeListener = new PropertyChangeListener(){
		@Override
		public void propertyChanged() {
			setText();
		}
	};
	
	/**
	 * Note: registers only once, even if called more than once.
	 */
	public void startListenForLanguageChangeEvents()
	{
		AppSettings.getInstance().addPropertyChangeListener(AppProperty.LANGUAGE, languageChangeListener);
	}
	
	public void stopListenForLanguageChangeEvents()
	{
		if (languageChangeListener == null)
			return;
		AppSettings.getInstance().removePropertyChangeListener(AppProperty.LANGUAGE, languageChangeListener);
		languageChangeListener = null;
	}
	
	/**
	 * Called whenever language is changed or the component is initialized.
	 */
	protected void setText() { }
	
	/**
	 * Shortcut to LanguageManager.getInstance().translate(key)
	 * @param key
	 * @return
	 */
	protected String translate(String key)
	{
		return AppSettings.getInstance().translate(key);
	}

}