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

Last change on this file since 22684 was 22684, checked in by sjm84, 14 years ago

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