source: trunk/gli/src/org/greenstone/gatherer/cdm/LanguageManager.java@ 5655

Last change on this file since 5655 was 5590, checked in by mdewsnip, 21 years ago

Could it be I've finished adding tooltips?? Why yes, very nearly... and a big "hallelulah" for that.

  • Property svn:keywords set to Author Date Id Revision
File size: 17.9 KB
Line 
1/**
2 *#########################################################################
3 *
4 * A component of the Gatherer application, part of the Greenstone digital
5 * library suite from the New Zealand Digital Library Project at the
6 * University of Waikato, New Zealand.
7 *
8 * Author: John Thompson, Greenstone Digital Library, University of Waikato
9 *
10 * Copyright (C) 1999 New Zealand Digital Library Project
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 *########################################################################
26 */
27package org.greenstone.gatherer.cdm;
28
29/**************************************************************************************
30 * Written: 08/05/02
31 * Revised: 17/11/02 - Commented
32 * 07/07/03 - DOM support
33 **************************************************************************************/
34import java.awt.*;
35import java.awt.event.*;
36import java.io.*;
37import java.util.*;
38import javax.swing.*;
39import javax.swing.event.*;
40import org.greenstone.gatherer.Dictionary;
41import org.greenstone.gatherer.Gatherer;
42import org.greenstone.gatherer.cdm.CollectionConfiguration;
43import org.greenstone.gatherer.cdm.CollectionDesignManager;
44import org.greenstone.gatherer.cdm.Control;
45import org.greenstone.gatherer.cdm.DOMProxyListModel;
46import org.greenstone.gatherer.cdm.Language;
47import org.greenstone.gatherer.cdm.LanguageListCellRenderer;
48import org.w3c.dom.*;
49
50/** This class manages the language commands, remembering both a list of languages to build indexes in, plus the default language.
51 * @author John Thompson, Greenstone Digital Library, University of Waikato
52 * @version 2.3
53 */
54public class LanguageManager
55 extends DOMProxyListModel {
56
57 static final private Dimension LABEL_SIZE = new Dimension(125,25);
58
59 /** The visual controls for this manager. */
60 private Control controls = null;
61 /** A reference to this class as a model, for the inner controls class. */
62 private DOMProxyListModel model = null;
63 /** A hashtable of code->name mappings of known languages. */
64 private LinkedHashMap known_languages = null;
65 /** The default language object. */
66 private Language default_language = null;
67
68 /** Constructor. */
69 public LanguageManager(Element languages_element) {
70 super(languages_element, CollectionConfiguration.LANGUAGE_ELEMENT, new Language());
71
72 Gatherer.println("LanguageManager: " + getSize() + " languages parsed.");
73
74 this.model = this;
75 // Retrieve the default language
76 NodeList default_language_elements = CollectionDesignManager.collect_config.getDocumentElement().getElementsByTagName(CollectionConfiguration.LANGUAGE_DEFAULT_ELEMENT);
77 if(default_language_elements.getLength() > 0) {
78 default_language = new Language((Element)default_language_elements.item(0));
79 }
80 // Load a series of code->language mappings into known_languages, by reading from the 'languages.dat' file, which is essentially a subset of the ISO 639 Standard.
81 known_languages = new LinkedHashMap();
82 try {
83 File in_file = new File("languages.dat");
84 FileReader in_reader = new FileReader(in_file);
85 BufferedReader in = new BufferedReader(in_reader);
86 String entry = null;
87 while((entry = in.readLine()) != null) {
88 if(!entry.startsWith("#")) {
89 StringTokenizer tokenizer = new StringTokenizer(entry);
90 if(tokenizer.countTokens() >= 2) {
91 String name = tokenizer.nextToken();
92 String code = tokenizer.nextToken().toLowerCase();
93 known_languages.put(code, name);
94 }
95 }
96 }
97 in.close();
98 in_reader.close();
99 in = null;
100 in_reader = null;
101 in_file = null;
102 }
103 catch (Exception error) {
104 error.printStackTrace();
105 }
106 }
107
108 /** Method to add a new language.
109 * @param language The <strong>Language</strong> to add.
110 * @see org.greenstone.gatherer.Gatherer
111 * @see org.greenstone.gatherer.collection.CollectionManager
112 */
113 public void addLanguage(Language language) {
114 if(!contains(language)) {
115 Element element = language.getElement();
116 // Locate where we should insert this new subcollection.
117 Node target_node = CollectionConfiguration.findInsertionPoint(element);
118 // Failing that we insert immediately after a language string
119 add(root, language, target_node);
120 Gatherer.c_man.configurationChanged();
121 }
122 }
123
124 public void destroy() {
125 if(controls != null) {
126 controls.destroy();
127 controls = null;
128 }
129 known_languages.clear();
130 known_languages = null;
131 }
132
133 /** Method to retrieve the control for this manager.
134 * @return the Control for editing the language partitions
135 */
136 public Control getControls() {
137 if(controls == null) {
138 // Build controls
139 controls = new LanguageControl();
140 }
141 return controls;
142 }
143
144 /** Method to retrieve the default language code.
145 * @return A <strong>Language</strong> containing a two letter code.
146 */
147 public Language getDefaultLanguage() {
148 // If no default is set...
149 if(default_language != null && default_language.isAssigned()) {
150 return default_language;
151 }
152 return null;
153 }
154
155 /** Method to retrieve a certain language object by its code.
156 * @param code The two letter code of a language, as a <strong>String</strong>.
157 * @param assigned_only If <i>true</i> only those languages currently having indexes built for them are checked, otherwise the known languages buffer is checked.
158 * @return The <strong>Language</strong> that matches the given code, or <i>null</i> if no such language exists.
159 */
160 public Language getLanguage(String code) {
161 int size = getSize();
162 for(int i = 0; i < size; i++) {
163 Language language = (Language) getElementAt(i);
164 if(language.getCode().equals(code)) {
165 return language;
166 }
167 }
168 return null;
169 }
170
171 public ArrayList getLanguages() {
172 return children();
173 }
174
175 /** Method to return a list of the known language codes.
176 * @return an ArrayList containing the series of known language codes as per the languages.dat file
177 */
178 public ArrayList getLanguageCodes() {
179 return new ArrayList(known_languages.keySet());
180 }
181
182 public String getLanguageName(String code) {
183 return (String) known_languages.get(code);
184 }
185
186 /** Method to remove a certain language.
187 * @param language The <strong>Language</strong> to remove.
188 * @see org.greenstone.gatherer.Gatherer
189 * @see org.greenstone.gatherer.collection.CollectionManager
190 */
191 public void removeLanguage(Language language) {
192 remove(language);
193 if(default_language != null && default_language.equals(language)) {
194 default_language = null;
195 }
196 Gatherer.c_man.configurationChanged();
197 }
198
199 /** Method to set the default language.
200 * @param language The <strong>Language</strong> to use as a default, or <i>null</i> for no default.
201 * @see org.greenstone.gatherer.Gatherer
202 * @see org.greenstone.gatherer.collection.CollectionManager
203 */
204 public void setDefault(Language language) {
205 if(language != null) {
206 if(default_language == null) {
207 // Create the default index element, and place immediately after indexes element.
208 Element default_language_element = root.getOwnerDocument().createElement(CollectionConfiguration.LANGUAGE_DEFAULT_ELEMENT);
209 default_language = new Language(default_language_element);
210 Node target_node = CollectionConfiguration.findInsertionPoint(default_language_element);
211 if(target_node != null) {
212 root.getOwnerDocument().getDocumentElement().insertBefore(default_language_element, target_node);
213 }
214 else {
215 root.getOwnerDocument().getDocumentElement().appendChild(default_language_element);
216 }
217 }
218 default_language.setAssigned(true);
219 default_language.setCode(language.getCode());
220 }
221 else {
222 if(default_language != null) {
223 default_language.setAssigned(false);
224 }
225 }
226 Gatherer.c_man.configurationChanged();
227 }
228
229
230 /** This class represents the visual component of the Language Manager. */
231 private class LanguageControl
232 extends JPanel
233 implements Control {
234 /** The button to add a new language support. */
235 private JButton add_button = null;
236 /** The button to clear the current default language. */
237 private JButton clear_button = null;
238 /** The button to remove a supported language. */
239 private JButton remove_button = null;
240 /** The button to set the current language as the default one. */
241 private JButton set_button = null;
242 /** A combobox listing the available supported languages. */
243 private JComboBox selector_combobox = null;
244 /** A list of currently supported languages. */
245 private JList language_list = null;
246 /** A description of the language currently selected. */
247 private JTextArea description_textarea = null;
248 /** The text field showing the currently name of the default language. Non-editable. */
249 private JTextField default_language_field = null;
250 /** Constructor.
251 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.AddListener
252 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.ClearDefaultListener
253 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.ListListener
254 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.RemoveListener
255 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.SelectorListener
256 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.SetDefaultListener
257 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.TranslateListener
258 */
259 public LanguageControl() {
260 super();
261 // Creation.
262 JPanel center_panel = new JPanel();
263
264 JLabel language_list_label = new JLabel();
265 Dictionary.registerText(language_list_label, "CDM.LanguageManager.Assigned_Languages");
266 language_list = new JList(model);
267
268 JPanel details_panel = new JPanel();
269
270 JPanel default_panel = new JPanel();
271
272 JLabel default_label = new JLabel();
273 default_label.setBorder(BorderFactory.createEmptyBorder(0,0,0,5));
274 default_label.setPreferredSize(LABEL_SIZE);
275 Dictionary.registerText(default_label, "CDM.LanguageManager.Default_Language");
276
277 if(default_language == null) {
278 default_language_field = new JTextField();
279 }
280 else {
281 default_language_field = new JTextField(default_language.toString());
282 }
283 default_language_field.setBackground(Gatherer.config.getColor("coloring.collection_tree_background", false));
284 default_language_field.setEditable(false);
285 JPanel control_panel = new JPanel();
286
287 JLabel selector_label = new JLabel();
288 selector_label.setPreferredSize(LABEL_SIZE);
289 Dictionary.registerText(selector_label, "CDM.LanguageManager.Selector");
290
291 selector_combobox = new JComboBox(getLanguageCodes().toArray());
292 selector_combobox.setBackground(Gatherer.config.getColor("coloring.collection_tree_background", false));
293 selector_combobox.setRenderer(new LanguageListCellRenderer());
294 Dictionary.registerTooltip(selector_combobox, "CDM.LanguageManager.Selector_Tooltip");
295
296 JPanel button_panel = new JPanel();
297
298 add_button = new JButton();
299 add_button.setMnemonic(KeyEvent.VK_A);
300 Dictionary.registerBoth(add_button, "CDM.LanguageManager.Add", "CDM.LanguageManager.Add_Tooltip");
301
302 remove_button = new JButton();
303 remove_button.setMnemonic(KeyEvent.VK_R);
304 remove_button.setEnabled(false);
305 Dictionary.registerBoth(remove_button, "CDM.LanguageManager.Remove", "CDM.LanguageManager.Remove_Tooltip");
306
307 clear_button = new JButton();
308 clear_button.setMnemonic(KeyEvent.VK_C);
309 clear_button.setEnabled(false);
310 Dictionary.registerBoth(clear_button, "CDM.LanguageManager.Clear_Default", "CDM.LanguageManager.Clear_Default_Tooltip");
311
312 set_button = new JButton();
313 set_button.setMnemonic(KeyEvent.VK_S);
314 set_button.setEnabled(false);
315 Dictionary.registerBoth(set_button, "CDM.LanguageManager.Set_Default", "CDM.LanguageManager.Set_Default_Tooltip");
316
317 // Set up and connect listeners.
318 add_button.addActionListener(new AddListener());
319 clear_button.addActionListener(new ClearDefaultListener());
320 remove_button.addActionListener(new RemoveListener());
321 selector_combobox.addActionListener(new SelectorListener());
322 set_button.addActionListener(new SetDefaultListener());
323 language_list.addListSelectionListener(new ListListener());
324
325 // Layout components
326 default_panel.setBorder(BorderFactory.createCompoundBorder(BorderFactory.createRaisedBevelBorder(), BorderFactory.createEmptyBorder(2,0,2,2)));
327 default_panel.setLayout(new BorderLayout());
328 default_panel.add(default_label, BorderLayout.WEST);
329 default_panel.add(default_language_field, BorderLayout.CENTER);
330
331 control_panel.setBorder(BorderFactory.createEmptyBorder(5,0,0,0));
332 control_panel.setLayout(new BorderLayout());
333 control_panel.add(selector_label, BorderLayout.WEST);
334 control_panel.add(selector_combobox, BorderLayout.CENTER);
335
336 details_panel.setBorder(BorderFactory.createEmptyBorder(5,0,5,0));
337 details_panel.setLayout(new BorderLayout());
338 details_panel.add(default_panel, BorderLayout.CENTER);
339 details_panel.add(control_panel, BorderLayout.SOUTH);
340
341 center_panel.setLayout(new BorderLayout());
342 center_panel.add(language_list_label, BorderLayout.NORTH);
343 center_panel.add(new JScrollPane(language_list), BorderLayout.CENTER);
344 center_panel.add(details_panel, BorderLayout.SOUTH);
345
346 button_panel.setLayout(new GridLayout(2,2));
347 button_panel.add(add_button);
348 button_panel.add(remove_button);
349 button_panel.add(set_button);
350 button_panel.add(clear_button);
351
352 setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
353 setLayout(new BorderLayout());
354 add(center_panel, BorderLayout.CENTER);
355 add(button_panel, BorderLayout.SOUTH);
356 }
357
358 /** Destructor. */
359 public void destroy() {
360 }
361
362 public void gainFocus() {
363 }
364
365 public void loseFocus() {
366 }
367
368 /** Listens for actions apon the 'add' button in the LanguageManager controls, and if detected calls the add method of the manager with a newly created language. */
369 private class AddListener
370 implements ActionListener {
371 /** Add a new language support.
372 * @param event an ActionEvent
373 * @see org.greenstone.gatherer.cdm.Language
374 */
375 public void actionPerformed(ActionEvent event) {
376 String language_code = (String) selector_combobox.getSelectedItem();
377 if(language_code != null) {
378 addLanguage(new Language(language_code));
379 }
380 add_button.setEnabled(false);
381 }
382 }
383
384 /** Listens for actions apon the 'clear default' button in the LanguageManager controls, and if detected calls the setDefault method of the manager with <i>null</i>. */
385 private class ClearDefaultListener
386 implements ActionListener {
387 /** Clear the default index.
388 * @param event An <strong>ActionEvent</strong>.
389 */
390 public void actionPerformed(ActionEvent event) {
391 setDefault(null);
392 clear_button.setEnabled(false);
393 default_language_field.setText("");
394 }
395 }
396
397 /** Listens for actions apon the 'remove' button in the LanguageManager controls, and if detected calls the remove method of the manager with the language selected for removal. */
398 private class RemoveListener
399 implements ActionListener {
400 /** Remove the currently selected language, if any.
401 * @param event An <strong>ActionEvent</strong>.
402 * @see org.greenstone.gatherer.cdm.Language
403 */
404 public void actionPerformed(ActionEvent event) {
405 Language delete_me = (Language)language_list.getSelectedValue();
406 if(delete_me != null) {
407 removeLanguage(delete_me);
408 if(default_language != null && default_language.equals(delete_me)) {
409 setDefault(null);
410 clear_button.setEnabled(false);
411 default_language_field.setText("");
412 }
413 }
414 remove_button.setEnabled(false);
415 }
416 }
417
418 /** Listens for selections within the combobox on the LanguageManager controls, and if a change is detected enables, or disables, controls appropriately. */
419 private class SelectorListener
420 implements ActionListener {
421 /** Enable or disable controls depeding on selection.
422 * @param event An <strong>ActionEvent</strong>.
423 */
424 public void actionPerformed(ActionEvent event) {
425 if(selector_combobox.getSelectedItem() != null) {
426 add_button.setEnabled(true);
427 }
428 else {
429 add_button.setEnabled(false);
430 }
431 }
432 }
433
434 /** Listens for actions apon the 'set default' button in the LanguageManager controls, and if detected calls the <i>setDefault()</i> method of the manager with the language selected for default. */
435 private class SetDefaultListener
436 implements ActionListener {
437 /** Set the default index to the one currently selected, if any.
438 * @param event An <strong>ActionEvent</strong>.
439 * @see org.greenstone.gatherer.cdm.Language
440 */
441 public void actionPerformed(ActionEvent event) {
442 if(!language_list.isSelectionEmpty()) {
443 setDefault((Language)language_list.getSelectedValue());
444 clear_button.setEnabled(true);
445 default_language_field.setText(default_language.toString());
446 }
447 }
448 }
449
450 /** Listens for selections within the list on the LanguageManager controls, and if a change is detected enables, or disables, controls appropriately. */
451 private class ListListener
452 implements ListSelectionListener {
453 /** Enable or disable controls depending on the current list selection.
454 * @param event A <strong>ListSelectionEvent</strong>.
455 */
456 public void valueChanged(ListSelectionEvent event) {
457 if(language_list.isSelectionEmpty()) {
458 remove_button.setEnabled(false);
459 set_button.setEnabled(false);
460 }
461 else {
462 remove_button.setEnabled(true);
463 set_button.setEnabled(true);
464 }
465 }
466 }
467 }
468}
Note: See TracBrowser for help on using the repository browser.