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

Last change on this file since 7157 was 7157, checked in by kjdon, 20 years ago

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