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

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

For Remote GLI and applets, we no longer remember any opened collections as this causes problems in applets when other users on a machine want to use an applet and GLI wants to load a collection left open from a previous session and *requires* the old user to authenticate.
  • Property svn:keywords set to Author Date Id Revision
File size: 34.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 * <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 // but we no longer remember open collections for remote GLI, as this causes problems
507 // in applets when other users on a machine want to use an applet and GLI wants to load
508 // a collection left open from a previous session and *requires* the old user to authenticate
509 if(!Gatherer.isGsdlRemote) {
510 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
511 true, CollectionManager.getLoadedCollectionColFilePath());
512 }
513 saveThenCloseCurrentCollection();
514 }
515 else {
516 // if there was no open collection, then write out the collect dir path for next time
517 // IF this is not the default collect directory
518 if(Gatherer.getCollectDirectoryPath().equals(
519 Gatherer.getDefaultGSCollectDirectoryPath(true))) {
520 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
521 true, "");
522 } else {
523 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
524 true, Gatherer.getCollectDirectoryPath());
525 }
526 }
527
528 // Store the current position and size of the GLI for next time
529 Configuration.setBounds("general.bounds", true, getBounds());
530
531 // Save configuration
532 Configuration.save();
533
534 // Hide the main window
535 setVisible(false);
536
537 // If we're running as an applet we don't quit here (we quit when the browser calls GathererApplet.destroy())
538 if (!Gatherer.isApplet) {
539 Gatherer.exit(exit_status);
540 }
541 }
542
543
544 /** 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.
545 */
546 public void lockCollection(boolean import_stage, boolean lock)
547 {
548 locked = lock;
549
550 if (import_stage) {
551 int gather_pos = tab_pane.indexOfComponent(gather_pane);
552 if (gather_pos != -1) {
553 tab_pane.setEnabledAt(gather_pos, !lock);
554 }
555 int enrich_pos = tab_pane.indexOfComponent(enrich_pane);
556 if (enrich_pos != -1) {
557 tab_pane.setEnabledAt(enrich_pos, !lock);
558 }
559 }
560
561 int design_pos = tab_pane.indexOfComponent(design_pane);
562 if (design_pos != -1) {
563 tab_pane.setEnabledAt(design_pos, !lock);
564 }
565 }
566
567
568 public void modeChanged(int mode) {
569 // Set the title
570 String collection_title = null;
571 String collection_name = null;
572 if (Gatherer.c_man.ready()) {
573 Collection collection = Gatherer.c_man.getCollection();
574 collection_title = collection.getTitle();
575 collection_name = collection.getGroupQualifiedName(true);
576 collection = null;
577 }
578 setTitle(collection_title, collection_name);
579 collection_title = null;
580 collection_name = null;
581 // Now pass on the message to anyone who cares
582 if (download_pane != null) {
583 download_pane.modeChanged(mode);
584 }
585 if (gather_pane != null) {
586 gather_pane.modeChanged(mode);
587 }
588 if (enrich_pane != null) {
589 enrich_pane.modeChanged(mode);
590 }
591 if (design_pane != null) {
592 design_pane.modeChanged(mode);
593 }
594 if (create_pane != null) {
595 create_pane.modeChanged(mode);
596 }
597 if (format_pane != null) {
598 format_pane.modeChanged(mode);
599 }
600 }
601
602
603 public void refresh(int refresh_reason, boolean collection_loaded)
604 {
605 // Set the collection information in the title bar
606 if (collection_loaded) {
607 Collection collection = Gatherer.c_man.getCollection();
608 setTitle(collection.getTitle(), collection.getGroupQualifiedName(true));
609 }
610 else {
611 setTitle(null, null);
612 }
613
614 // Update the menu bar
615 menu_bar.refresh(refresh_reason, collection_loaded);
616
617 // Update the loaded panes
618 if (download_pane != null) {
619 download_pane.refresh(refresh_reason, collection_loaded);
620 }
621 if (gather_pane != null) {
622 gather_pane.refresh(refresh_reason, collection_loaded);
623 }
624 if (enrich_pane != null) {
625 enrich_pane.refresh(refresh_reason, collection_loaded);
626 }
627 if (design_pane != null) {
628 design_pane.refresh(refresh_reason, collection_loaded);
629 }
630 if (create_pane != null) {
631 create_pane.refresh(refresh_reason, collection_loaded);
632 }
633 if (format_pane != null) {
634 format_pane.refresh(refresh_reason, collection_loaded);
635 }
636
637 // Now enable tabs as necessary. Do this on event queue to prevent crazy NPEs
638 if (!locked) {
639 if (tab_updater == null) {
640 tab_updater = new TabUpdater(tab_pane, collection_loaded);
641 }
642 else {
643 tab_updater.setReady(collection_loaded);
644 }
645 SwingUtilities.invokeLater(tab_updater);
646 }
647 }
648
649
650 public void refreshCollectionTree(int refresh_reason)
651 {
652 if (gather_pane != null) {
653 gather_pane.refreshCollectionTree(refresh_reason);
654 }
655 }
656
657
658 public void refreshWorkspaceTree(int refresh_reason)
659 {
660 if (gather_pane != null) {
661 gather_pane.refreshWorkspaceTree(refresh_reason);
662 }
663 }
664
665 public void refreshWorkspaceTreeGreenstoneCollections()
666 {
667 refreshWorkspaceTree(WorkspaceTree.LIBRARY_CONTENTS_CHANGED);
668 }
669
670 /** Specifies whether a certain tab is enabled or not. */
671 private void setTabEnabled(String rawname, boolean state) {
672 // Retrieve the dictionary based name.
673 String name = Dictionary.get("GUI." + rawname);
674 int index = tab_pane.indexOfTab(name);
675 // Of course we may not have this tab available.
676 if(index != -1) {
677 // Some tabs are also dependant on if a collection is ready
678 Component component = tab_pane.getComponentAt(index);
679 if(component == enrich_pane || component == design_pane || component == create_pane || component == format_pane) {
680 tab_pane.setEnabledAt(index, state && Gatherer.c_man != null && Gatherer.c_man.ready());
681 }
682 else {
683 tab_pane.setEnabledAt(index, state);
684 }
685 // If this was the currently selected tab and it is now disabled, change the view to the first enabled tab.
686 if(tab_pane.getSelectedIndex() == index && !state) {
687 boolean found = false;
688 for(int i = 0; !found && i < tab_pane.getTabCount(); i++) {
689 if(tab_pane.isEnabledAt(i)) {
690 tab_pane.setSelectedIndex(i);
691 found = true;
692 }
693 }
694 // If there are no tabs enabled, which should be impossible, then select the first tab
695 if(!found) {
696 tab_pane.setSelectedIndex(0);
697 }
698 }
699 }
700 }
701
702 /** 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.
703 * @param title
704 * @param name
705 */
706 public void setTitle(String title, String name) {
707
708 // Finally display the collection name in the title bar.
709 StringBuffer title_buffer = new StringBuffer(Configuration.getApplicationTitle());
710 title_buffer.append(StaticStrings.SPACE_CHARACTER);
711 title_buffer.append(Gatherer.PROGRAM_VERSION);
712 title_buffer.append(StaticStrings.SPACE_CHARACTER);
713 title_buffer.append(StaticStrings.SPACE_CHARACTER);
714 // Server version information
715 title_buffer.append(Gatherer.getServerVersionAsString());
716 title_buffer.append(StaticStrings.SPACE_CHARACTER);
717 title_buffer.append(StaticStrings.SPACE_CHARACTER);
718 // Describe the current user mode
719 title_buffer.append(StaticStrings.MODE_STR);
720 title_buffer.append(Configuration.getModeAsString());
721 title_buffer.append(StaticStrings.SPACE_CHARACTER);
722 title_buffer.append(StaticStrings.SPACE_CHARACTER);
723 // Now for the current collection
724 title_buffer.append(StaticStrings.COLLECTION_STR);
725 if (title != null && name != null) {
726 title_buffer.append(title);
727 title_buffer.append(StaticStrings.SPACE_CHARACTER);
728 title_buffer.append(StaticStrings.OPEN_PARENTHESIS_CHARACTER);
729 title_buffer.append(name);
730 title_buffer.append(StaticStrings.CLOSE_PARENTHESIS_CHARACTER);
731 }
732 else {
733 title_buffer.append(Dictionary.get("Collection.No_Collection"));
734 }
735 this.setTitle(title_buffer.toString());
736 title_buffer = null;
737 }
738
739
740 private class OpenCollectionTask
741 extends Thread
742 {
743 public void run()
744 {
745 String collection_file_path = showOpenCollectionDialog();
746
747 // User has selected a collection to open
748 if (collection_file_path != null) {
749 // If there is already a collection open, save and close it
750 if (Gatherer.c_man.ready()) {
751 saveThenCloseCurrentCollection();
752 }
753
754 // Open the selected collection
755 Gatherer.c_man.loadCollection(collection_file_path);
756 }
757 }
758 }
759
760
761 /** When the load collection option is chosen this method is called to produce the modal file load prompt.
762 */
763 private String showOpenCollectionDialog()
764 {
765 OpenCollectionDialog dialog = new OpenCollectionDialog();
766 dialog.setComponentOrientation(Dictionary.getOrientation());
767 if (dialog.display() == OpenCollectionDialog.OK_OPTION) {
768 return dialog.getFileName();
769 }
770
771 // User must have cancelled the action
772 return null;
773 }
774
775
776 /** When called this method causes the MetadataAuditTable to display a nice dialog box which contains all the metadata assigned in the collection.
777 */
778 public void showMetaAuditBox() {
779 wait(true);
780 meta_audit.display();
781 wait(false);
782 }
783
784
785 private class NewCollectionTask
786 extends Thread
787 {
788 public void run()
789 {
790 // Create the collection details prompt from new collection prompt
791 NewCollectionDetailsPrompt ncd_prompt = new NewCollectionDetailsPrompt();
792
793 // Create the new collection (if not cancelled) in a new thread.
794 if (!ncd_prompt.isCancelled()) {
795 // If there is already a collection open, save and close it.
796 if (Gatherer.c_man.ready()) {
797 saveThenCloseCurrentCollection();
798 }
799
800 // Create new collection.
801 Gatherer.c_man.createCollection(ncd_prompt.getDescription(), Configuration.getEmail(), ncd_prompt.getName(), ncd_prompt.getTitle(), ncd_prompt.getBase(), new ArrayList());
802 ncd_prompt.dispose();
803 }
804
805 // Done
806 ncd_prompt = null;
807 }
808 }
809
810
811 private class DeleteCollectionTask
812 extends Thread
813 {
814 public void run()
815 {
816 // The rest is handled by the DeleteCollectionPrompt
817 DeleteCollectionPrompt dc_prompt = new DeleteCollectionPrompt();
818 if (dc_prompt.display()) {
819 //closeCurrentCollection();
820 }
821 dc_prompt.destroy();
822 dc_prompt = null;
823 }
824 }
825
826
827 /** 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.
828 * @param event A ChangeEvent containing information about the event that fired this call.
829 */
830 public void stateChanged(ChangeEvent event)
831 {
832 if (previous_pane != null) {
833 if (previous_pane == gather_pane) {
834 gather_pane.loseFocus();
835 }
836 else if (previous_pane == enrich_pane) {
837 enrich_pane.loseFocus();
838 }
839 else if (previous_pane == design_pane) {
840 design_pane.loseFocus();
841 }
842 else if (previous_pane == create_pane) {
843 create_pane.loseFocus();
844 }
845 else if (previous_pane == format_pane) {
846 format_pane.loseFocus();
847 }
848 }
849
850 menu_bar.tabSelected(tab_pane.getSelectedIndex());
851 int selected_index = tab_pane.getSelectedIndex();
852 if (selected_index == tab_pane.indexOfComponent(download_pane)) {
853 download_pane.gainFocus();
854 }
855 else if (selected_index == tab_pane.indexOfComponent(gather_pane)) {
856 gather_pane.gainFocus();
857 }
858 else if (selected_index == tab_pane.indexOfComponent(enrich_pane)) {
859 enrich_pane.gainFocus();
860 }
861 else if (selected_index == tab_pane.indexOfComponent(design_pane)) {
862 design_pane.gainFocus();
863 }
864 else if (selected_index == tab_pane.indexOfComponent(create_pane)) {
865 create_pane.gainFocus();
866 }
867 else if (selected_index == tab_pane.indexOfComponent(format_pane)) {
868 format_pane.gainFocus();
869 }
870
871 previous_pane = (JPanel) tab_pane.getSelectedComponent();
872
873 }
874
875
876 private MouseListener mouse_blocker_listener = new MouseAdapter() {};
877
878 public void updateUI()
879 {
880 JPanel pane = (JPanel) getContentPane();
881 pane.updateUI();
882 // Also update all of the tabs according to workflow.
883 workflowUpdate("Download", Configuration.get("workflow.download", false));
884 workflowUpdate("Gather", Configuration.get("workflow.gather", false));
885 workflowUpdate("Enrich", Configuration.get("workflow.enrich", false));
886 workflowUpdate("Design", Configuration.get("workflow.design", false));
887 workflowUpdate("Create", Configuration.get("workflow.create", false));
888 workflowUpdate("Format", Configuration.get("workflow.format", false));
889 }
890
891 public void wait(boolean waiting) {
892 Component glass_pane = getGlassPane();
893 if(waiting) {
894 // Show wait cursor.
895 glass_pane.addMouseListener(mouse_blocker_listener);
896 glass_pane.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
897 glass_pane.setVisible(true);
898 }
899 else {
900 // Hide wait cursor.
901 glass_pane.setVisible(false);
902 glass_pane.setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
903 glass_pane.removeMouseListener(mouse_blocker_listener);
904 }
905 glass_pane = null;
906 }
907
908 public void workflowUpdate(String raw, boolean state) {
909 WorkflowUpdater task = new WorkflowUpdater(raw, state);
910 SwingUtilities.invokeLater(task);
911 task = null;
912 }
913
914
915 /**Overridden from JFrame so we can exit safely when window is closed (or destroyed).
916 * @param event A <strong>WindowEvent</strong> containing information about the event that fired this call.
917 */
918 protected void processWindowEvent(WindowEvent event) {
919 if(event.getID() == WindowEvent.WINDOW_CLOSING) {
920 exit();
921 }
922 }
923
924
925 /** 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.
926 */
927 private class MenuListenerImpl
928 implements MenuListener {
929 /** Called whenever a popup menu is hidden, but we don't care.
930 * @param e Some <strong>MenuEvent</strong> that we could care less about.
931 */
932 public void menuCanceled(MenuEvent e) {
933 }
934 /** Called whenever a menu header (ie button) becomes unselected, but we don't care.
935 * @param e Some <strong>MenuEvent</strong> that we could care less about.
936 */
937 public void menuDeselected(MenuEvent e) {
938 }
939 /** 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.
940 * @param e The <strong>MenuEvent</strong> whose source is checked.
941 */
942 public void menuSelected(MenuEvent e) {
943 if(e.getSource() == menu_bar.help) {
944 if(menu_bar.help.isSelected()) {
945 menu_bar.help.doClick(10);
946 }
947 }
948 }
949 }
950
951 private class TabUpdater
952 implements Runnable {
953 private boolean ready = false;
954 private int download_pos = -1;
955 private int enrich_pos = -1;
956 private int design_pos = -1;
957 private int create_pos = -1;
958 private int format_pos = -1;
959 private int export_pos = -1;
960 private JTabbedPane tab_pane = null;
961
962 public TabUpdater(JTabbedPane tab_pane, boolean ready) {
963 this.ready = ready;
964 this.tab_pane = tab_pane;
965 download_pos = tab_pane.indexOfComponent(download_pane);
966 enrich_pos = tab_pane.indexOfComponent(enrich_pane);
967 design_pos = tab_pane.indexOfComponent(design_pane);
968 create_pos = tab_pane.indexOfComponent(create_pane);
969 format_pos = tab_pane.indexOfComponent(format_pane);
970 }
971
972 public void run()
973 {
974 if (download_pos != -1) {
975 if (ready) {
976 tab_pane.setEnabledAt(download_pos, Configuration.get("workflow.download", false));
977 }
978 else {
979 tab_pane.setEnabledAt(download_pos, Configuration.get("workflow.download", true));
980 }
981 }
982 if (enrich_pos != -1) {
983 tab_pane.setEnabledAt(enrich_pos, ready && Configuration.get("workflow.enrich", false));
984 }
985 if (design_pos != -1) {
986 tab_pane.setEnabledAt(design_pos, ready && Configuration.get("workflow.design", false) && Configuration.getMode() > Configuration.ASSISTANT_MODE);
987 }
988 if (create_pos != -1) {
989 tab_pane.setEnabledAt(create_pos, ready && Configuration.get("workflow.create", false));
990 }
991 if (format_pos != -1) {
992 tab_pane.setEnabledAt(format_pos, ready && Configuration.get("workflow.format", false) && Configuration.getMode() > Configuration.ASSISTANT_MODE);
993 }
994 }
995
996 public void setReady(boolean ready) {
997 this.ready = ready;
998 }
999 }
1000
1001 private class WorkflowUpdater
1002 implements Runnable {
1003 private boolean state;
1004 private String raw;
1005 public WorkflowUpdater(String raw, boolean state) {
1006 this.raw = raw;
1007 this.state = state;
1008 }
1009 public void run() {
1010 setTabEnabled(raw, state);
1011 }
1012 }
1013}
Note: See TracBrowser for help on using the repository browser.