source: main/trunk/gli/src/org/greenstone/gatherer/gui/GUIManager.java@ 23015

Last change on this file since 23015 was 23015, checked in by ak19, 14 years ago

Again for ticket 152 (moveable collectdir). If the default GS collectdir is the one active in GLI (but all collections are closed) when exiting GLI, this default GS collectdir is not stored in config.xml (in the User Data location). Instead of the last opened collection or last open collectdir, an empty value is written out in the case of the default GS collectdir. This will allow other GS installations to open in their own collectdir. The benefits do not extend to if a collection in another GS' default collectdir was left open. In that case, the collection path is written out to the config.xml file, and the collectdir that a different GLI loads will be the old GLI's collect dir.
  • Property svn:keywords set to Author Date Id Revision
File size: 34.2 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 * <BR><BR>
9 *
10 * Author: John Thompson, Greenstone Digital Library, University of Waikato
11 *
12 * <BR><BR>
13 *
14 * Copyright (C) 1999 New Zealand Digital Library Project
15 *
16 * <BR><BR>
17 *
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
22 *
23 * <BR><BR>
24 *
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
29 *
30 * <BR><BR>
31 *
32 * You should have received a copy of the GNU General Public License
33 * along with this program; if not, write to the Free Software
34 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
35 *########################################################################
36 */
37package org.greenstone.gatherer.gui;
38
39import java.awt.*;
40import java.awt.datatransfer.*;
41import java.awt.event.*;
42import java.io.File;
43import java.lang.*;
44import java.net.*;
45import java.util.*;
46import javax.swing.*;
47import javax.swing.event.*;
48import javax.swing.filechooser.*;
49import javax.swing.plaf.*;
50import javax.swing.text.*;
51import org.greenstone.gatherer.Configuration;
52import org.greenstone.gatherer.DebugStream;
53import org.greenstone.gatherer.Dictionary;
54import org.greenstone.gatherer.Gatherer;
55import org.greenstone.gatherer.collection.Collection;
56import org.greenstone.gatherer.collection.CollectionManager;
57import org.greenstone.gatherer.file.FileOpenActionListener;
58import org.greenstone.gatherer.file.WorkspaceTree;
59import org.greenstone.gatherer.gui.metaaudit.MetaAuditFrame;
60import org.greenstone.gatherer.gui.tree.DragTree;
61import org.greenstone.gatherer.metadata.MetadataSet;
62import org.greenstone.gatherer.metadata.MetadataXMLFileManager;
63import org.greenstone.gatherer.remote.RemoteGreenstoneServer;
64import org.greenstone.gatherer.util.JarTools;
65import org.greenstone.gatherer.util.StaticStrings;
66import org.greenstone.gatherer.util.Utility;
67
68/** The GUIManager is in charge of creating the Gatherer window frame then filling it with the goodness of the view panes. GUIManager not only creates these panes, but allows some messaging between them. Furthermore GUIManager includes functionality from menu driven choices, simply as it was easier to put it here once and have it accessible from all pane children. */
69public class GUIManager
70 extends JFrame
71 implements ActionListener, ChangeListener, WindowFocusListener{
72 /** The download pane contains controls for downloading internet sites. */
73 public DownloadPane download_pane = null;
74 /** The gather pane is more like a file manager where you drag files from one tree to another. */
75 public GatherPane gather_pane = null;
76 /** The enrich pane is used to assign, edit and remove metadata from files within the collection. */
77 public EnrichPane enrich_pane = null;
78 /** The design pane allows you to edit the design of the library in terms of the collection configuration file. - the stuff that requires rebuilding */
79 public DesignPane design_pane = null;
80 /** The create pane contains scripting options for importing and building collections into libraries. */
81 public CreatePane create_pane = null;
82 /** The format pane allows you to edit the design of the library in terms of the collection configuration file. - the stuff that doesn't require rebuilding */
83 public FormatPane format_pane = null;
84
85 public FileOpenActionListener foa_listener = new FileOpenActionListener();
86
87
88 /** A reference to the currently instantiated help window, if any. */
89 private HelpFrame help = null;
90 /** The menu bar. */
91 public MenuBar menu_bar = null;
92 public MetaAuditFrame meta_audit;
93 /** Are certain panes currently locked? */
94 private boolean locked = false;
95 /** The size of the Gatherer window. */
96 private Dimension size = null;
97 /** The panel within the window that other components are placed on. */
98 private JPanel content_pane = null;
99 /** The last view pane selected. */
100 private JPanel previous_pane;
101 /** The main tab pane containing the different views, available here to trap view change events. */
102 private JTabbedPane tab_pane = null;
103 /** A threaded tab changer to try and avoid NPE on exit. */
104 private TabUpdater tab_updater = null;
105
106
107
108
109
110 final static String newline = "\n";
111 final static String space = " ";
112
113
114 /**Constructor. Enable window events and arranges all other components.
115 * @param size The intial <strong>Dimension</strong> of the screen.
116 */
117 public GUIManager(Dimension size) {
118 super();
119 this.setComponentOrientation(Dictionary.getOrientation());
120 // Initialization
121 this.help = new HelpFrame();
122 this.size = size;
123
124 this.setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
125
126 // Add a focus listener to ourselves. Thus if we gain focus when a Modal Dialog should instead have it, we can try to bring the modal dialog to the fore.
127 this.addFocusListener(new GLIGUIFocusListener());
128
129 this.addWindowFocusListener(this);
130
131 // Make the Tool tip hang around for a rediculous amount of time.
132 ToolTipManager.sharedInstance().setDismissDelay(10000);
133
134 // Set up some other UI stuff. (fonts handled in Gatherer.main())
135 UIManager.put("FileChooser.lookInLabelText", Dictionary.get("SaveCollectionBox.Look_In"));
136 UIManager.put("FileChooser.filesOfTypeLabelText", Dictionary.get("SaveCollectionBox.Files_Of_Type"));
137 UIManager.put("FileChooser.fileNameLabelText", Dictionary.get("SaveCollectionBox.File_Name"));
138 }
139
140
141 public void windowGainedFocus(WindowEvent e)
142 {
143 }
144
145
146 public void windowLostFocus(WindowEvent e)
147 {
148 // Save the loaded collection
149 if (Gatherer.c_man != null && Gatherer.c_man.ready() && Gatherer.c_man.getCollection().cdm != null) {
150 Gatherer.c_man.saveCollection();
151 }
152 }
153
154
155 private class GLIGUIFocusListener
156 extends FocusAdapter {
157 public void focusGained(FocusEvent e) {
158 if (ModalDialog.current_modal != null) {
159 ModalDialog.current_modal.makeVisible();
160 ModalDialog.current_modal.toFront();
161 }
162 }
163 }
164
165 /** Any implementation of <i>ActionListener</i> must include this method so that we can be informed when an action has occured. In this case we are listening to actions from the menu-bar, and should react appropriately.
166 * @param event An <strong>ActionEvent</strong> containing information about the action that has occured.
167 */
168 public void actionPerformed(ActionEvent event) {
169 Object esrc = event.getSource();
170 // *************
171 // File Options.
172 // *************
173 if (esrc == menu_bar.file_associations) {
174 Gatherer.assoc_man.edit();
175 }
176 else if (esrc == menu_bar.file_close) {
177 saveThenCloseCurrentCollection();
178 }
179 else if (esrc == menu_bar.file_delete) {
180 new DeleteCollectionTask().start();
181 }
182 else if (esrc == menu_bar.file_cdimage) {
183 WriteCDImagePrompt wcdip = new WriteCDImagePrompt();
184 wcdip.display();
185 wcdip.destroy();
186 wcdip = null;
187 }
188 else if (esrc == menu_bar.file_exportas) {
189 ExportAsPrompt eap = new ExportAsPrompt();
190 eap.display();
191 eap.destroy();
192 eap = null;
193 }
194 else if (esrc == menu_bar.file_exit) {
195 exit();
196 }
197 else if (esrc == menu_bar.file_new) {
198 new NewCollectionTask().start();
199 }
200 else if (esrc == menu_bar.file_open) {
201 new OpenCollectionTask().start();
202 }
203 else if (esrc == menu_bar.file_options) {
204 new Preferences();
205 }
206 else if (esrc == menu_bar.file_save) {
207 // Very important: make sure metadata values are saved too
208 enrich_pane.stopEditingAndRebuild();
209 // Make sure all the metadata has been saved to file
210 MetadataXMLFileManager.saveMetadataXMLFiles();
211
212 Gatherer.c_man.saveCollection();
213 }
214
215 // *************
216 // Edit Options.
217 // *************
218 else if(esrc == menu_bar.edit_copy) {
219 try {
220 KeyboardFocusManager kfm = KeyboardFocusManager.getCurrentKeyboardFocusManager();
221 // Get the component with selected text as a JTextComponent
222 JTextComponent text = (JTextComponent) kfm.getPermanentFocusOwner();//getFocusOwner();
223 text.copy();
224 }
225 catch (Exception cce) {
226 // If the component is not a text component ignore the copy command
227 DebugStream.println(cce.toString());
228 }
229 }
230 else if(esrc == menu_bar.edit_cut) {
231 try {
232 KeyboardFocusManager kfm = KeyboardFocusManager.getCurrentKeyboardFocusManager();
233 // Get the component with selected text as a JTextComponent
234 JTextComponent text = (JTextComponent) kfm.getPermanentFocusOwner();
235 // Cut the text to the clipboard
236 text.cut();
237 }
238 catch (ClassCastException cce) {
239 // If the component is not a text component ignore the cut command
240 DebugStream.println(cce.toString());
241 }
242 }
243 else if(esrc == menu_bar.edit_paste) {
244 try {
245 KeyboardFocusManager kfm = KeyboardFocusManager.getCurrentKeyboardFocusManager();
246 // Get the component with selected text as a JTextComponent
247 JTextComponent text = (JTextComponent) kfm.getPermanentFocusOwner();
248 // Cut the text to the clipboard
249 text.paste();
250 }
251 catch (ClassCastException cce) {
252 // If the component is not a text component ignore the paste command
253 DebugStream.println(cce.toString());
254 }
255 }
256
257 // *************
258 // Help Options.
259 // *************
260 else if (esrc == menu_bar.help_general) {
261 HelpFrame.setView("introduction");
262 }
263 else if (esrc == menu_bar.help_download) {
264 HelpFrame.setView("themirrorview");
265 }
266 else if (esrc == menu_bar.help_gather) {
267 HelpFrame.setView("collectingfiles");
268 }
269 else if (esrc == menu_bar.help_enrich) {
270 HelpFrame.setView("enrichingacollection");
271 }
272 else if (esrc == menu_bar.help_design) {
273 HelpFrame.setView("designingacollection");
274 }
275 else if (esrc == menu_bar.help_create) {
276 HelpFrame.setView("producingthecollection");
277 }
278 else if (esrc == menu_bar.help_format) {
279 HelpFrame.setView("formattingacollection");
280 }
281 else if (esrc == menu_bar.help_about) {
282 new AboutDialog(this);
283 }
284 }
285
286
287 /** Any actions that should happen after the display of the Gatherer window can be called here. Currently only updates the browser pane if it is active to work around bug in Mozilla renderer implementation.
288 */
289 public void afterDisplay() {
290 if (download_pane != null) {
291 download_pane.afterDisplay();
292 }
293 enrich_pane.afterDisplay();
294 }
295
296
297 public void closeCurrentCollection()
298 {
299 tab_pane.setSelectedComponent(gather_pane);
300 Gatherer.c_man.closeCollection();
301 }
302
303
304 public void saveThenCloseCurrentCollection()
305 {
306 Gatherer.c_man.saveCollection();
307 closeCurrentCollection();
308 }
309
310
311 /** This is called when we're absolutely finished with the GLI. It is *not* called when the applet is suspended.
312 */
313 public void destroy()
314 {
315 // Destroying create pane ensures the latest log has been closed
316 if (create_pane != null) {
317 create_pane.destroy();
318 }
319
320 // Deal to help
321 if (help != null) {
322 help.destroy();
323 help = null;
324 }
325 }
326
327
328 /** Enabled events on the window to be trapped, creates all the visual components, then builds the tab and other layouts.
329 */
330 public void display() {
331 content_pane = (JPanel) this.getContentPane();
332 content_pane.setComponentOrientation(Dictionary.getOrientation());
333
334 // Enable window-type events to be fired.
335 enableEvents(AWTEvent.WINDOW_EVENT_MASK);
336 // Initialise and layout sub-components, plus other window dressing.
337 try {
338 this.setSize(size);
339
340 // Set the title
341 String collection_title = null;
342 String collection_name = null;
343 if (Gatherer.c_man.ready()) {
344 Collection collection = Gatherer.c_man.getCollection();
345 collection_title = collection.getTitle();
346 collection_name = collection.getGroupQualifiedName(true);
347 collection = null;
348 }
349 setTitle(collection_title, collection_name);
350 collection_title = null;
351 collection_name = null;
352
353 // Pretty corner icon
354 String gsmall_image = "gatherer.png";
355 if (Configuration.fedora_info.isActive()) {
356 gsmall_image = "fli-" + gsmall_image;
357 }
358 if(Gatherer.isGsdlRemote) {
359 gsmall_image = "client-" + gsmall_image;
360 }
361 this.setIconImage(JarTools.getImage(gsmall_image).getImage());
362 // BorderLayout for the main screen. I'll try my best to avoid these in subcomponents as they're space greedy.
363 content_pane.setLayout(new BorderLayout());
364 // Create the menu-bar and stick it up the top.
365 menu_bar = new MenuBar(new MenuListenerImpl());
366 menu_bar.setComponentOrientation(Dictionary.getOrientation());
367
368 //feedback changes
369 //content_pane.add(menu_bar, BorderLayout.NORTH);
370 this.setJMenuBar(menu_bar);
371 // end feedback changes
372
373 // Create the tabbed pane and plop it in the center where it will
374 // expand to consume all available space like any good gas would.
375 tab_pane = new JTabbedPane();
376 tab_pane.setComponentOrientation(Dictionary.getOrientation());
377 tab_pane.addChangeListener(this);
378 tab_pane.setFont(Configuration.getFont("general.font", false));
379
380 if (Configuration.get("workflow.download", true) && Gatherer.isDownloadEnabled) {
381 download_pane = new DownloadPane();
382 // "GUI.Download_Tooltip" is used automatically
383 tab_pane.addTab(Dictionary.get("GUI.Download"), JarTools.getImage("download.gif"), download_pane, Dictionary.get("GUI.Download_Tooltip"));
384 tab_pane.setEnabledAt(tab_pane.indexOfComponent(download_pane), Configuration.get("workflow.download", false));
385 }
386
387 gather_pane = new GatherPane();
388 gather_pane.display();
389 if (Configuration.get("workflow.gather", true)) {
390 // "GUI.Gather_Tooltip" is used automatically
391 tab_pane.addTab(Dictionary.get("GUI.Gather"), JarTools.getImage("gather.gif"), gather_pane, Dictionary.get("GUI.Gather_Tooltip"));
392 tab_pane.setEnabledAt(tab_pane.indexOfComponent(gather_pane), Configuration.get("workflow.gather", false));
393 }
394
395 enrich_pane = new EnrichPane();
396 enrich_pane.display();
397 if (Configuration.get("workflow.enrich", true)) {
398 // "GUI.Enrich_Tooltip" is used automatically
399 tab_pane.addTab(Dictionary.get("GUI.Enrich"), JarTools.getImage("enrich.gif"), enrich_pane, Dictionary.get("GUI.Enrich_Tooltip"));
400 tab_pane.setEnabledAt(tab_pane.indexOfComponent(enrich_pane), false);
401 }
402
403 design_pane = new DesignPane();
404 design_pane.display();
405 if (Configuration.get("workflow.design", true)) {
406 // "GUI.Design_Tooltip" is used automatically
407 if (Configuration.fedora_info.isActive()) {
408 tab_pane.addTab("Plugins", JarTools.getImage("design.gif"), design_pane, Dictionary.get("GUI.Design_Tooltip"));
409 }
410 else {
411 tab_pane.addTab(Dictionary.get("GUI.Design"), JarTools.getImage("design.gif"), design_pane, Dictionary.get("GUI.Design_Tooltip"));
412 }
413
414 tab_pane.setEnabledAt(tab_pane.indexOfComponent(design_pane), false);
415 }
416
417 create_pane = new CreatePane();
418 create_pane.setComponentOrientation(Dictionary.getOrientation());
419 create_pane.display();
420 if (Configuration.get("workflow.create", true)) {
421 // "GUI.Create_Tooltip" is used automatically
422 tab_pane.addTab(Dictionary.get("GUI.Create"), JarTools.getImage("create.gif"), create_pane, Dictionary.get("GUI.Create_Tooltip"));
423 tab_pane.setEnabledAt(tab_pane.indexOfComponent(create_pane), false);
424 }
425
426 format_pane = new FormatPane();
427 format_pane.setComponentOrientation(Dictionary.getOrientation());
428 format_pane.display();
429 if (Configuration.get("workflow.format", true)) {
430 tab_pane.addTab(Dictionary.get("GUI.Format"), JarTools.getImage("format.gif"), format_pane, Dictionary.get("GUI.Format_Tooltip"));
431 tab_pane.setEnabledAt(tab_pane.indexOfComponent(format_pane), false);
432 }
433
434 // The MetaAuditFrame must be created after the gather/enrich panes but before they get focus
435 meta_audit = new MetaAuditFrame();
436 meta_audit.setComponentOrientation(Dictionary.getOrientation());
437 // Select the collect pane if it is available
438 if (tab_pane.indexOfComponent(gather_pane) != -1) {
439 tab_pane.setSelectedComponent(gather_pane);
440 }
441 // Otherwise find the first tab that is enabled and select that.
442 else {
443 for (int i = 0; i < tab_pane.getTabCount(); i++) {
444 if (tab_pane.isEnabledAt(i)) {
445 tab_pane.setSelectedIndex(i);
446 break;
447 }
448 }
449 }
450
451 content_pane.add(tab_pane, BorderLayout.CENTER);
452
453 // Add an extra progress bar at the bottom of every screen when using a remote Greenstone server
454 if (Gatherer.isGsdlRemote) {
455 JPanel remote_greenstone_server_progress_panel = new JPanel();
456 //remote_greenstone_server_progress_panel.setComponentOrientation(Dictionary.getOrientation());
457 JLabel remote_greenstone_server_progress_label = new JLabel(Dictionary.get("RemoteGreenstoneServer.Progress"));
458 //remote_greenstone_server_progress_label.setComponentOrientation(Dictionary.getOrientation());
459 remote_greenstone_server_progress_panel.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
460 remote_greenstone_server_progress_panel.setLayout(new BorderLayout());
461 remote_greenstone_server_progress_panel.add(remote_greenstone_server_progress_label, BorderLayout.LINE_START);
462 remote_greenstone_server_progress_panel.add(Gatherer.remoteGreenstoneServer.getProgressBar(), BorderLayout.CENTER);
463 content_pane.add(remote_greenstone_server_progress_panel, BorderLayout.SOUTH);
464 }
465
466 // Call refresh to update all controls to reflect current collection status.
467 refresh(-1, Gatherer.c_man.ready());
468 }
469 catch (Exception e) {
470 DebugStream.printStackTrace(e);
471 // The GUI failing to build is an app killer
472 e.printStackTrace();
473 System.exit(1);
474 }
475 }
476
477 public void exit()
478 {
479 exit(0);
480 }
481
482 // some cases we have already saved the collection, but don't want to
483 // override the general.open_collection value here
484 public void exitNoCollectionSave(int exit_status) {
485 // Store the current position and size of the GLI for next time
486 Configuration.setBounds("general.bounds", true, getBounds());
487
488 // Save configuration
489 Configuration.save();
490
491 // Hide the main window
492 setVisible(false);
493
494 // If we're running as an applet we don't quit here (we quit when the browser calls GathererApplet.destroy())
495 if (!Gatherer.isApplet) {
496 Gatherer.exit(exit_status);
497 }
498
499 }
500 /** This method ensures that all the things needing saving are saved before Gatherer.exit() is called.
501 */
502 public void exit(int exit_status)
503 {
504 // If we have a collection open remember it for next time, then save it and close it
505 if (Gatherer.c_man.ready()) {
506 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
507 true, CollectionManager.getLoadedCollectionColFilePath());
508 saveThenCloseCurrentCollection();
509 }
510 else {
511 // if there was no open collection, then write out the collect dir path for next time
512 // IF this is not the default collect directory
513 if(Gatherer.getCollectDirectoryPath().equals(
514 Gatherer.getDefaultGSCollectDirectoryPath(true))) {
515 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
516 true, "");
517 } else {
518 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
519 true, Gatherer.getCollectDirectoryPath());
520 }
521 }
522
523 // Store the current position and size of the GLI for next time
524 Configuration.setBounds("general.bounds", true, getBounds());
525
526 // Save configuration
527 Configuration.save();
528
529 // Hide the main window
530 setVisible(false);
531
532 // If we're running as an applet we don't quit here (we quit when the browser calls GathererApplet.destroy())
533 if (!Gatherer.isApplet) {
534 Gatherer.exit(exit_status);
535 }
536 }
537
538
539 /** This method is called when the collection is being built, and is used to disable all controls in all pane which could change the state of the collection.
540 */
541 public void lockCollection(boolean import_stage, boolean lock)
542 {
543 locked = lock;
544
545 if (import_stage) {
546 int gather_pos = tab_pane.indexOfComponent(gather_pane);
547 if (gather_pos != -1) {
548 tab_pane.setEnabledAt(gather_pos, !lock);
549 }
550 int enrich_pos = tab_pane.indexOfComponent(enrich_pane);
551 if (enrich_pos != -1) {
552 tab_pane.setEnabledAt(enrich_pos, !lock);
553 }
554 }
555
556 int design_pos = tab_pane.indexOfComponent(design_pane);
557 if (design_pos != -1) {
558 tab_pane.setEnabledAt(design_pos, !lock);
559 }
560 }
561
562
563 public void modeChanged(int mode) {
564 // Set the title
565 String collection_title = null;
566 String collection_name = null;
567 if (Gatherer.c_man.ready()) {
568 Collection collection = Gatherer.c_man.getCollection();
569 collection_title = collection.getTitle();
570 collection_name = collection.getGroupQualifiedName(true);
571 collection = null;
572 }
573 setTitle(collection_title, collection_name);
574 collection_title = null;
575 collection_name = null;
576 // Now pass on the message to anyone who cares
577 if (download_pane != null) {
578 download_pane.modeChanged(mode);
579 }
580 if (gather_pane != null) {
581 gather_pane.modeChanged(mode);
582 }
583 if (enrich_pane != null) {
584 enrich_pane.modeChanged(mode);
585 }
586 if (design_pane != null) {
587 design_pane.modeChanged(mode);
588 }
589 if (create_pane != null) {
590 create_pane.modeChanged(mode);
591 }
592 if (format_pane != null) {
593 format_pane.modeChanged(mode);
594 }
595 }
596
597
598 public void refresh(int refresh_reason, boolean collection_loaded)
599 {
600 // Set the collection information in the title bar
601 if (collection_loaded) {
602 Collection collection = Gatherer.c_man.getCollection();
603 setTitle(collection.getTitle(), collection.getGroupQualifiedName(true));
604 }
605 else {
606 setTitle(null, null);
607 }
608
609 // Update the menu bar
610 menu_bar.refresh(refresh_reason, collection_loaded);
611
612 // Update the loaded panes
613 if (download_pane != null) {
614 download_pane.refresh(refresh_reason, collection_loaded);
615 }
616 if (gather_pane != null) {
617 gather_pane.refresh(refresh_reason, collection_loaded);
618 }
619 if (enrich_pane != null) {
620 enrich_pane.refresh(refresh_reason, collection_loaded);
621 }
622 if (design_pane != null) {
623 design_pane.refresh(refresh_reason, collection_loaded);
624 }
625 if (create_pane != null) {
626 create_pane.refresh(refresh_reason, collection_loaded);
627 }
628 if (format_pane != null) {
629 format_pane.refresh(refresh_reason, collection_loaded);
630 }
631
632 // Now enable tabs as necessary. Do this on event queue to prevent crazy NPEs
633 if (!locked) {
634 if (tab_updater == null) {
635 tab_updater = new TabUpdater(tab_pane, collection_loaded);
636 }
637 else {
638 tab_updater.setReady(collection_loaded);
639 }
640 SwingUtilities.invokeLater(tab_updater);
641 }
642 }
643
644
645 public void refreshCollectionTree(int refresh_reason)
646 {
647 if (gather_pane != null) {
648 gather_pane.refreshCollectionTree(refresh_reason);
649 }
650 }
651
652
653 public void refreshWorkspaceTree(int refresh_reason)
654 {
655 if (gather_pane != null) {
656 gather_pane.refreshWorkspaceTree(refresh_reason);
657 }
658 }
659
660 public void refreshWorkspaceTreeGreenstoneCollections()
661 {
662 refreshWorkspaceTree(WorkspaceTree.LIBRARY_CONTENTS_CHANGED);
663 }
664
665 /** Specifies whether a certain tab is enabled or not. */
666 private void setTabEnabled(String rawname, boolean state) {
667 // Retrieve the dictionary based name.
668 String name = Dictionary.get("GUI." + rawname);
669 int index = tab_pane.indexOfTab(name);
670 // Of course we may not have this tab available.
671 if(index != -1) {
672 // Some tabs are also dependant on if a collection is ready
673 Component component = tab_pane.getComponentAt(index);
674 if(component == enrich_pane || component == design_pane || component == create_pane || component == format_pane) {
675 tab_pane.setEnabledAt(index, state && Gatherer.c_man != null && Gatherer.c_man.ready());
676 }
677 else {
678 tab_pane.setEnabledAt(index, state);
679 }
680 // If this was the currently selected tab and it is now disabled, change the view to the first enabled tab.
681 if(tab_pane.getSelectedIndex() == index && !state) {
682 boolean found = false;
683 for(int i = 0; !found && i < tab_pane.getTabCount(); i++) {
684 if(tab_pane.isEnabledAt(i)) {
685 tab_pane.setSelectedIndex(i);
686 found = true;
687 }
688 }
689 // If there are no tabs enabled, which should be impossible, then select the first tab
690 if(!found) {
691 tab_pane.setSelectedIndex(0);
692 }
693 }
694 }
695 }
696
697 /** Change the string shown in the title bar of the main gui frame. If either value is null, the 'No Collection' string is shown instead.
698 * @param title
699 * @param name
700 */
701 public void setTitle(String title, String name) {
702
703 // Finally display the collection name in the title bar.
704 StringBuffer title_buffer = new StringBuffer(Configuration.getApplicationTitle());
705 title_buffer.append(StaticStrings.SPACE_CHARACTER);
706 title_buffer.append(Gatherer.PROGRAM_VERSION);
707 title_buffer.append(StaticStrings.SPACE_CHARACTER);
708 title_buffer.append(StaticStrings.SPACE_CHARACTER);
709 // Server version information
710 title_buffer.append(Gatherer.getServerVersionAsString());
711 title_buffer.append(StaticStrings.SPACE_CHARACTER);
712 title_buffer.append(StaticStrings.SPACE_CHARACTER);
713 // Describe the current user mode
714 title_buffer.append(StaticStrings.MODE_STR);
715 title_buffer.append(Configuration.getModeAsString());
716 title_buffer.append(StaticStrings.SPACE_CHARACTER);
717 title_buffer.append(StaticStrings.SPACE_CHARACTER);
718 // Now for the current collection
719 title_buffer.append(StaticStrings.COLLECTION_STR);
720 if (title != null && name != null) {
721 title_buffer.append(title);
722 title_buffer.append(StaticStrings.SPACE_CHARACTER);
723 title_buffer.append(StaticStrings.OPEN_PARENTHESIS_CHARACTER);
724 title_buffer.append(name);
725 title_buffer.append(StaticStrings.CLOSE_PARENTHESIS_CHARACTER);
726 }
727 else {
728 title_buffer.append(Dictionary.get("Collection.No_Collection"));
729 }
730 this.setTitle(title_buffer.toString());
731 title_buffer = null;
732 }
733
734
735 private class OpenCollectionTask
736 extends Thread
737 {
738 public void run()
739 {
740 String collection_file_path = showOpenCollectionDialog();
741
742 // User has selected a collection to open
743 if (collection_file_path != null) {
744 // If there is already a collection open, save and close it
745 if (Gatherer.c_man.ready()) {
746 saveThenCloseCurrentCollection();
747 }
748
749 // Open the selected collection
750 Gatherer.c_man.loadCollection(collection_file_path);
751 }
752 }
753 }
754
755
756 /** When the load collection option is chosen this method is called to produce the modal file load prompt.
757 */
758 private String showOpenCollectionDialog()
759 {
760 OpenCollectionDialog dialog = new OpenCollectionDialog();
761 dialog.setComponentOrientation(Dictionary.getOrientation());
762 if (dialog.display() == OpenCollectionDialog.OK_OPTION) {
763 return dialog.getFileName();
764 }
765
766 // User must have cancelled the action
767 return null;
768 }
769
770
771 /** When called this method causes the MetadataAuditTable to display a nice dialog box which contains all the metadata assigned in the collection.
772 */
773 public void showMetaAuditBox() {
774 wait(true);
775 meta_audit.display();
776 wait(false);
777 }
778
779
780 private class NewCollectionTask
781 extends Thread
782 {
783 public void run()
784 {
785 // Create the collection details prompt from new collection prompt
786 NewCollectionDetailsPrompt ncd_prompt = new NewCollectionDetailsPrompt();
787
788 // Create the new collection (if not cancelled) in a new thread.
789 if (!ncd_prompt.isCancelled()) {
790 // If there is already a collection open, save and close it.
791 if (Gatherer.c_man.ready()) {
792 saveThenCloseCurrentCollection();
793 }
794
795 // Create new collection.
796 Gatherer.c_man.createCollection(ncd_prompt.getDescription(), Configuration.getEmail(), ncd_prompt.getName(), ncd_prompt.getTitle(), ncd_prompt.getBase(), new ArrayList());
797 ncd_prompt.dispose();
798 }
799
800 // Done
801 ncd_prompt = null;
802 }
803 }
804
805
806 private class DeleteCollectionTask
807 extends Thread
808 {
809 public void run()
810 {
811 // The rest is handled by the DeleteCollectionPrompt
812 DeleteCollectionPrompt dc_prompt = new DeleteCollectionPrompt();
813 if (dc_prompt.display()) {
814 //closeCurrentCollection();
815 }
816 dc_prompt.destroy();
817 dc_prompt = null;
818 }
819 }
820
821
822 /** Any implementation of ChangeListener must include this method so we can be informed when the state of one of the registered objects changes. In this case we are listening to view changes within the tabbed pane.
823 * @param event A ChangeEvent containing information about the event that fired this call.
824 */
825 public void stateChanged(ChangeEvent event)
826 {
827 if (previous_pane != null) {
828 if (previous_pane == gather_pane) {
829 gather_pane.loseFocus();
830 }
831 else if (previous_pane == enrich_pane) {
832 enrich_pane.loseFocus();
833 }
834 else if (previous_pane == design_pane) {
835 design_pane.loseFocus();
836 }
837 else if (previous_pane == create_pane) {
838 create_pane.loseFocus();
839 }
840 else if (previous_pane == format_pane) {
841 format_pane.loseFocus();
842 }
843 }
844
845 menu_bar.tabSelected(tab_pane.getSelectedIndex());
846 int selected_index = tab_pane.getSelectedIndex();
847 if (selected_index == tab_pane.indexOfComponent(download_pane)) {
848 download_pane.gainFocus();
849 }
850 else if (selected_index == tab_pane.indexOfComponent(gather_pane)) {
851 gather_pane.gainFocus();
852 }
853 else if (selected_index == tab_pane.indexOfComponent(enrich_pane)) {
854 enrich_pane.gainFocus();
855 }
856 else if (selected_index == tab_pane.indexOfComponent(design_pane)) {
857 design_pane.gainFocus();
858 }
859 else if (selected_index == tab_pane.indexOfComponent(create_pane)) {
860 create_pane.gainFocus();
861 }
862 else if (selected_index == tab_pane.indexOfComponent(format_pane)) {
863 format_pane.gainFocus();
864 }
865
866 previous_pane = (JPanel) tab_pane.getSelectedComponent();
867
868 }
869
870
871 private MouseListener mouse_blocker_listener = new MouseAdapter() {};
872
873 public void updateUI()
874 {
875 JPanel pane = (JPanel) getContentPane();
876 pane.updateUI();
877 // Also update all of the tabs according to workflow.
878 workflowUpdate("Download", Configuration.get("workflow.download", false));
879 workflowUpdate("Gather", Configuration.get("workflow.gather", false));
880 workflowUpdate("Enrich", Configuration.get("workflow.enrich", false));
881 workflowUpdate("Design", Configuration.get("workflow.design", false));
882 workflowUpdate("Create", Configuration.get("workflow.create", false));
883 workflowUpdate("Format", Configuration.get("workflow.format", false));
884 }
885
886 public void wait(boolean waiting) {
887 Component glass_pane = getGlassPane();
888 if(waiting) {
889 // Show wait cursor.
890 glass_pane.addMouseListener(mouse_blocker_listener);
891 glass_pane.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
892 glass_pane.setVisible(true);
893 }
894 else {
895 // Hide wait cursor.
896 glass_pane.setVisible(false);
897 glass_pane.setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
898 glass_pane.removeMouseListener(mouse_blocker_listener);
899 }
900 glass_pane = null;
901 }
902
903 public void workflowUpdate(String raw, boolean state) {
904 WorkflowUpdater task = new WorkflowUpdater(raw, state);
905 SwingUtilities.invokeLater(task);
906 task = null;
907 }
908
909
910 /**Overridden from JFrame so we can exit safely when window is closed (or destroyed).
911 * @param event A <strong>WindowEvent</strong> containing information about the event that fired this call.
912 */
913 protected void processWindowEvent(WindowEvent event) {
914 if(event.getID() == WindowEvent.WINDOW_CLOSING) {
915 exit();
916 }
917 }
918
919
920 /** Listens to actions upon the menu bar, and if it detects a click over the help menu brings the help window to the front if it has become hidden.
921 */
922 private class MenuListenerImpl
923 implements MenuListener {
924 /** Called whenever a popup menu is hidden, but we don't care.
925 * @param e Some <strong>MenuEvent</strong> that we could care less about.
926 */
927 public void menuCanceled(MenuEvent e) {
928 }
929 /** Called whenever a menu header (ie button) becomes unselected, but we don't care.
930 * @param e Some <strong>MenuEvent</strong> that we could care less about.
931 */
932 public void menuDeselected(MenuEvent e) {
933 }
934 /** This method, when a menu is first opened, is the only one we respond to by bringing the help window to the front if possible, but only if there is a help window and the help menu is the one opening.
935 * @param e The <strong>MenuEvent</strong> whose source is checked.
936 */
937 public void menuSelected(MenuEvent e) {
938 if(e.getSource() == menu_bar.help) {
939 if(menu_bar.help.isSelected()) {
940 menu_bar.help.doClick(10);
941 }
942 }
943 }
944 }
945
946 private class TabUpdater
947 implements Runnable {
948 private boolean ready = false;
949 private int download_pos = -1;
950 private int enrich_pos = -1;
951 private int design_pos = -1;
952 private int create_pos = -1;
953 private int format_pos = -1;
954 private int export_pos = -1;
955 private JTabbedPane tab_pane = null;
956
957 public TabUpdater(JTabbedPane tab_pane, boolean ready) {
958 this.ready = ready;
959 this.tab_pane = tab_pane;
960 download_pos = tab_pane.indexOfComponent(download_pane);
961 enrich_pos = tab_pane.indexOfComponent(enrich_pane);
962 design_pos = tab_pane.indexOfComponent(design_pane);
963 create_pos = tab_pane.indexOfComponent(create_pane);
964 format_pos = tab_pane.indexOfComponent(format_pane);
965 }
966
967 public void run()
968 {
969 if (download_pos != -1) {
970 if (ready) {
971 tab_pane.setEnabledAt(download_pos, Configuration.get("workflow.download", false));
972 }
973 else {
974 tab_pane.setEnabledAt(download_pos, Configuration.get("workflow.download", true));
975 }
976 }
977 if (enrich_pos != -1) {
978 tab_pane.setEnabledAt(enrich_pos, ready && Configuration.get("workflow.enrich", false));
979 }
980 if (design_pos != -1) {
981 tab_pane.setEnabledAt(design_pos, ready && Configuration.get("workflow.design", false) && Configuration.getMode() > Configuration.ASSISTANT_MODE);
982 }
983 if (create_pos != -1) {
984 tab_pane.setEnabledAt(create_pos, ready && Configuration.get("workflow.create", false));
985 }
986 if (format_pos != -1) {
987 tab_pane.setEnabledAt(format_pos, ready && Configuration.get("workflow.format", false) && Configuration.getMode() > Configuration.ASSISTANT_MODE);
988 }
989 }
990
991 public void setReady(boolean ready) {
992 this.ready = ready;
993 }
994 }
995
996 private class WorkflowUpdater
997 implements Runnable {
998 private boolean state;
999 private String raw;
1000 public WorkflowUpdater(String raw, boolean state) {
1001 this.raw = raw;
1002 this.state = state;
1003 }
1004 public void run() {
1005 setTabEnabled(raw, state);
1006 }
1007 }
1008}
Note: See TracBrowser for help on using the repository browser.