source: trunk/gli/src/org/greenstone/gatherer/gui/GatherPane.java@ 10396

Last change on this file since 10396 was 10325, checked in by mdewsnip, 19 years ago

Opening files in an external program is now done through FileManager.openFileInExternalApplication().
  • Property svn:keywords set to Author Date Id Revision
File size: 37.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.event.*;
41import java.io.*;
42import java.util.*;
43import javax.swing.*;
44import javax.swing.event.*;
45import javax.swing.tree.*;
46import org.greenstone.gatherer.Configuration;
47import org.greenstone.gatherer.DebugStream;
48import org.greenstone.gatherer.Dictionary;
49import org.greenstone.gatherer.Gatherer;
50import org.greenstone.gatherer.collection.CollectionTree;
51import org.greenstone.gatherer.collection.CollectionTreeNode;
52import org.greenstone.gatherer.file.FileNode;
53import org.greenstone.gatherer.file.FileOpenActionListener;
54import org.greenstone.gatherer.file.FileQueue;
55import org.greenstone.gatherer.file.FileSystemModel;
56import org.greenstone.gatherer.file.RecycleBin;
57import org.greenstone.gatherer.file.WorkspaceTree;
58import org.greenstone.gatherer.file.WorkspaceTreeNode;
59import org.greenstone.gatherer.gui.tree.DragTree;
60import org.greenstone.gatherer.gui.ExplodeMetadataPrompt;
61import org.greenstone.gatherer.util.DragComponent;
62import org.greenstone.gatherer.util.DragGroup;
63import org.greenstone.gatherer.util.JarTools;
64import org.greenstone.gatherer.util.TreeSynchronizer;
65import org.greenstone.gatherer.util.Utility;
66
67/** The collection pane is analogous with a file manager. It is there that the user chooses which files to include in their collection and what structure the file hierarchy should take. The later aspect is not important for the Greenstone Suite, but is usefull for grouping files for ease of metadata markup. The view essentially consists of two file trees, one denoting the entire source workspace and the other the files within your collection. The trees themselves have a title bar at the top, a filter control at the bottom, and are coloured to indicate activity (grey for disabled). The remainder of the screen is taken by a status area, to indicate current file job progress during copying etc, and three buttons for controlling features of the view.
68 * @author John Thompson, Greenstone Digital Library, University of Waikato
69 * @version 2.3
70 */
71public class GatherPane
72 extends JPanel
73 implements ActionListener, FocusListener {
74 /** The group encompassing all of the components available as drop targets for drag and drop actions. Required so that only one component renders the ghost and higlights itself as a target, which the other members are restored to their original, pristine, condition. */
75 private DragGroup group = null;
76 /** The tree showing the files within the collection. */
77 private CollectionTree collection_tree = null;
78 /** The threaded queue that handles the actually movement of files, so that the gui remains responsive. */
79 private FileQueue file_queue = null;
80 /** The filter currently applied to the collection tree. */
81 private Filter collection_filter = null;
82 /** The filter currently applied to the workspace tree. */
83 private Filter workspace_filter = null;
84 /** The button used to cancel all pending file queue jobs. */
85 private JButton stop_action = null;
86 /** The button used to create a new folder in the collection tree. */
87 private JButton new_folder = null;
88 /** The label shown at the top of the collection tree. */
89 private JLabel collection_label = null;
90 /** The label shown in the status area explaining the file apon which action is taking place. */
91 private JLabel filename_label = null;
92 /** The label shown explaining the current state of the file queue thread. */
93 private JLabel status_label = null;
94 /** The label at the top of the workspace tree. */
95 private JLabel workspace_label = null;
96 /** The panel that contains the collection tree. */
97 private JPanel collection_pane = null;
98 /** The panel that contains the various controls including the status area. */
99 private JPanel control_pane = null;
100 /** The panel that contains the workspace tree. */
101 private JPanel workspace_pane = null;
102 /** The scrollable area into which the collection tree is placed. */
103 private JScrollPane collection_scroll = null;
104 /** The scrollable area into which the workspace tree is placed. */
105 private JScrollPane workspace_scroll = null;
106 /** A split pane seperating the two trees, allowing for the screen real-estate for each to be changed. */
107 private JSplitPane tree_pane = null;
108 /** Text fragment arguments used to fill in phrases returned from the dictionary. */
109 private String args[] = null;
110 /** Ensures that expansion and selection events between collection trees based on the same model are synchronized. */
111 private TreeSynchronizer collection_tree_sync = null;
112 /** The button used to delete files, which also doubles as a drop target for files from the Trees. */
113 private RecycleBin bin_button = null;
114 /** The default size of a special mapping dialog. */
115 static final Dimension DIALOG_SIZE = new Dimension(400, 120);
116 /** The minimum size a gui component can become. */
117 static private Dimension MIN_SIZE = new Dimension( 90, 90);
118 /** The default size of the status area. */
119 static private Dimension STATUS_SIZE = new Dimension(450, 120);
120 /** The initial size of the trees. */
121 static private Dimension TREE_SIZE = new Dimension(400, 430);
122
123 /** The tree showing the available source workspace. */
124 private WorkspaceTree workspace_tree = null;
125
126
127 /* Constructor.
128 * @param tree_sync Ensures that expansion events between like trees are synchronized.
129 * @see org.greenstone.gatherer.file.FileManager
130 * @see org.greenstone.gatherer.file.FileQueue
131 */
132 public GatherPane(TreeSynchronizer collection_tree_sync) {
133 this.group = new DragGroup();
134 this.file_queue = Gatherer.f_man.getQueue();
135 this.collection_tree_sync = collection_tree_sync;
136
137 // Create components.
138 stop_action = new GLIButton();
139 stop_action.addActionListener(this);
140 stop_action.setEnabled(false);
141 stop_action.setMnemonic(KeyEvent.VK_S);
142 file_queue.registerStopButton(stop_action);
143 Dictionary.registerBoth(stop_action, "Collection.Stop", "Collection.Stop_Tooltip");
144
145 new_folder = new GLIButton(JarTools.getImage("folder.gif"));
146 new_folder.addActionListener(this);
147 new_folder.setEnabled(false);
148 new_folder.setMinimumSize(MIN_SIZE);
149 new_folder.setMnemonic(KeyEvent.VK_N);
150 new_folder.setPreferredSize(MIN_SIZE);
151 Dictionary.registerTooltip(new_folder, "Collection.New_Folder_Tooltip");
152 }
153
154 /** Any implementation of ActionListener requires this method so that when an action is performed the appropriate effect can occur. In this case there are three valid possibilities. If the action occured on the recycle bin, then delete the current selection from the collection tree. If the action instead occured on the new folder button, then create a new folder under the current (single) selection in the collection tree. And finally if the cancel button was pressed, cancel the current, and remaining, jobs on the file queue. */
155 public void actionPerformed(ActionEvent event) {
156 // If a user has clicked on the bin button directly remove whatever
157 // files are selected in the active tree.
158 if(event.getSource() == bin_button) {
159 if(!bin_button.ignore()) {
160 // Find the active tree (you've made selections in).
161 DragTree tree = (DragTree) group.getActive();
162 // Fudge things a bit
163 group.setSource(tree);
164 // Determine the selection.
165 TreePath paths[] = tree.getSelectionPaths();
166 if(paths != null) {
167 FileNode[] source_nodes = new FileNode[paths.length];
168 for(int i = 0; i < paths.length; i++) {
169 source_nodes[i] = (FileNode)(paths[i].getLastPathComponent());
170 }
171 Gatherer.f_man.action(tree, source_nodes, bin_button, null);
172 }
173 }
174 }
175 // If a user has clicked on new_folder create a new folder under
176 // whatever node is selected.
177 else if(event.getSource() == new_folder && collection_tree != null) {
178 int count = collection_tree.getSelectionCount();
179 boolean error = false;
180 if(count == 1) {
181 TreePath path = collection_tree.getSelectionPath();
182 CollectionTreeNode node = (CollectionTreeNode) path.getLastPathComponent();
183 if (node.getAllowsChildren()) {
184 Gatherer.f_man.newFolder(collection_tree, node);
185 }
186 else {
187 // try the parent
188 CollectionTreeNode parent = (CollectionTreeNode) node.getParent();
189 if (parent!=null && parent.getAllowsChildren()) {
190 Gatherer.f_man.newFolder(collection_tree, parent);
191 } else {
192 error = true;
193 }
194 }
195 }
196 else {
197 error = true;
198 }
199 if(error) {
200 // instead of an error, we now create a new folder at the root
201 CollectionTreeNode node = (CollectionTreeNode) collection_tree.getModel().getRoot();
202 Gatherer.f_man.newFolder(collection_tree, node);
203 }
204 }
205 else if(event.getSource() == stop_action) {
206 file_queue.cancelAction();
207 }
208 }
209
210
211 /** Generates the pane on controls used to 'collect' files into the collection. Resposible for creating, connecting and laying out these controls. */
212 public void display() {
213 // Create Components.
214 KeyListenerImpl key_listener = new KeyListenerImpl();
215 MouseListenerImpl mouse_listener = new MouseListenerImpl();
216 this.addKeyListener(key_listener);
217
218 // Workspace Tree
219 workspace_pane = new JPanel();
220 workspace_pane.setMinimumSize(MIN_SIZE);
221 workspace_pane.setPreferredSize(TREE_SIZE);
222 workspace_pane.setSize(TREE_SIZE);
223
224 workspace_label = new JLabel();
225 workspace_label.setOpaque(true);
226 workspace_label.setBackground(Configuration.getColor("coloring.workspace_heading_background", false));
227 workspace_label.setForeground(Configuration.getColor("coloring.workspace_heading_foreground", false));
228 Dictionary.registerText(workspace_label, "Collection.Workspace");
229
230 workspace_tree = new WorkspaceTree(Utility.WORKSPACE_TREE);
231 group.add(workspace_tree);
232 workspace_tree.addFocusListener(this);
233 workspace_tree.addKeyListener(key_listener);
234 workspace_tree.addMouseListener(mouse_listener);
235 workspace_tree.addMouseListener(Gatherer.g_man.foa_listener);
236 workspace_tree.addTreeExpansionListener(Gatherer.g_man.foa_listener);
237 workspace_tree.putClientProperty("JTree.lineStyle", "Angled");
238 workspace_tree.setBackgroundNonSelectionColor(Configuration.getColor("coloring.workspace_tree_background", false));
239 workspace_tree.setTextNonSelectionColor(Configuration.getColor("coloring.workspace_tree_foreground", false));
240 workspace_tree.setBackgroundSelectionColor(Configuration.getColor("coloring.workspace_selection_background", false));
241 workspace_tree.setTextSelectionColor(Configuration.getColor("coloring.workspace_selection_foreground", false));
242 workspace_tree.setRootVisible(false);
243
244 workspace_scroll = new JScrollPane(workspace_tree);
245
246 workspace_filter = Gatherer.g_man.getFilter(workspace_tree);
247 workspace_filter.setBackground(Configuration.getColor("coloring.workspace_heading_background", false));
248 workspace_filter.setEditable(Configuration.getMode() > Configuration.LIBRARIAN_MODE);
249 Dictionary.registerTooltip(workspace_filter.getComboBox(), "Collection.Filter_Tooltip");
250
251 // Collection Tree
252 collection_pane = new JPanel();
253 collection_pane.setMinimumSize(MIN_SIZE);
254 collection_pane.setPreferredSize(TREE_SIZE);
255 collection_pane.setSize(TREE_SIZE);
256
257 collection_label = new JLabel();
258 collection_label.setOpaque(true);
259 Dictionary.registerText(collection_label, "Collection.No_Collection");
260
261 collection_tree = new CollectionTree(Utility.COLLECTION_TREE, Gatherer.c_man.getCollectionTreeModel(), true);
262 collection_tree.setEnabled(Gatherer.c_man.getCollectionTreeModel() != null);
263 group.add(collection_tree);
264 collection_tree.addFocusListener(this);
265 collection_tree.addKeyListener(key_listener);
266 collection_tree.addMouseListener(mouse_listener);
267 collection_tree.addMouseListener(Gatherer.g_man.foa_listener);
268 collection_tree.addTreeExpansionListener(Gatherer.g_man.foa_listener);
269 collection_tree.putClientProperty("JTree.lineStyle", "Angled");
270 collection_tree.setBackgroundNonSelectionColor(Configuration.getColor("coloring.collection_tree_background", false));
271 collection_tree.setTextNonSelectionColor(Configuration.getColor("coloring.collection_tree_foreground", false));
272 collection_tree.setBackgroundSelectionColor(Configuration.getColor("coloring.collection_selection_background", false));
273 collection_tree.setTextSelectionColor(Configuration.getColor("coloring.collection_selection_foreground", false));
274 collection_tree.setRootVisible(false);
275
276 collection_scroll = new JScrollPane(collection_tree);
277
278 collection_filter = Gatherer.g_man.getFilter(collection_tree);
279 collection_filter.setBackground(Configuration.getColor("coloring.collection_heading_background", false));
280 collection_filter.setEditable(Configuration.getMode() > Configuration.LIBRARIAN_MODE);
281 Dictionary.registerTooltip(collection_filter.getComboBox(), "Collection.Filter_Tooltip");
282
283 tree_pane = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT);
284
285 // Status pane
286 control_pane = new JPanel();
287
288 JPanel inner_pane = new JPanel();
289 inner_pane.setSize(STATUS_SIZE);
290
291 JPanel file_pane = new JPanel();
292 JPanel progress_pane = new JPanel();
293 JLabel file_status = file_queue.getFileStatus();
294
295 JProgressBar progress_bar = file_queue.getProgressBar();
296
297 JPanel button_pane = new JPanel();
298
299 bin_button = new RecycleBin();
300 bin_button.addActionListener(this);
301 bin_button.setEnabled(false);
302 bin_button.setMinimumSize(MIN_SIZE);
303 bin_button.setPreferredSize(MIN_SIZE);
304 Dictionary.registerTooltip(bin_button, "Collection.Delete_Tooltip");
305 group.add(bin_button);
306
307 // Layout Components.
308 workspace_pane.setLayout(new BorderLayout());
309 workspace_pane.add(workspace_label, BorderLayout.NORTH);
310 workspace_pane.add(workspace_scroll, BorderLayout.CENTER);
311 workspace_pane.add(workspace_filter, BorderLayout.SOUTH);
312
313 collection_pane.setLayout(new BorderLayout());
314 collection_pane.add(collection_label, BorderLayout.NORTH);
315 collection_pane.add(collection_scroll, BorderLayout.CENTER);
316 collection_pane.add(collection_filter, BorderLayout.SOUTH);
317
318 tree_pane.add(workspace_pane, JSplitPane.LEFT);
319 tree_pane.add(collection_pane, JSplitPane.RIGHT);
320 tree_pane.setDividerLocation(TREE_SIZE.width - 10);
321
322 file_pane.setBorder(BorderFactory.createEmptyBorder(2,2,2,2));
323 file_pane.setLayout(new BorderLayout());
324 file_pane.add(file_status, BorderLayout.CENTER);
325 file_pane.add(stop_action, BorderLayout.EAST);
326
327 progress_pane.setBorder(BorderFactory.createEmptyBorder(2,2,2,2));
328 progress_pane.setLayout(new BorderLayout());
329 progress_pane.add(progress_bar, BorderLayout.CENTER);
330
331 inner_pane.setBorder(BorderFactory.createCompoundBorder(BorderFactory.createEmptyBorder(10,10,10,10), BorderFactory.createLoweredBevelBorder()));
332 inner_pane.setLayout(new GridLayout(2,1));
333 inner_pane.add(file_pane);
334 inner_pane.add(progress_pane);
335
336 button_pane.add(new_folder);
337 button_pane.add(bin_button);
338
339 control_pane.setLayout(new BorderLayout());
340 control_pane.add(inner_pane, BorderLayout.CENTER);
341 control_pane.add(button_pane, BorderLayout.EAST);
342
343 this.setLayout(new BorderLayout());
344 this.add(tree_pane, BorderLayout.CENTER);
345 this.add(control_pane, BorderLayout.SOUTH);
346 }
347 /** This method ensures that a certain tree path is visible and selected within the collection tree, expanding nodes if necessary. If the method is successful the bounds of the new selection are returned. */
348 public Rectangle expandPath(TreePath path) {
349 collection_tree.setImmediate(true);
350 collection_tree.scrollPathToVisible(path);
351 collection_tree.setSelectionPath(path);
352 collection_tree.setImmediate(false);
353 return collection_tree.getRowBounds(collection_tree.getRowForPath(path));
354 }
355 /** Called whenever this pane gains focus, this method ensures that the various tree renderers are correctly colouring the tree (as these settings sometimes get lost).
356 * @param event A <strong>FocusEvent</strong> containing details about the focus action performed.
357 */
358 public void focusGained(FocusEvent event) {
359 DefaultTreeCellRenderer def = new DefaultTreeCellRenderer();
360 DefaultTreeCellRenderer w = (DefaultTreeCellRenderer)workspace_tree.getCellRenderer();
361 DefaultTreeCellRenderer c = (DefaultTreeCellRenderer)collection_tree.getCellRenderer();
362 if(event.getSource() == workspace_tree) {
363 w.setBackgroundSelectionColor(def.getBackgroundSelectionColor());
364 c.setBackgroundSelectionColor(Color.lightGray);
365 }
366 else if(event.getSource() == collection_tree) {
367 c.setBackgroundSelectionColor(def.getBackgroundSelectionColor());
368 w.setBackgroundSelectionColor(Color.lightGray);
369 }
370 repaint();
371 }
372 /** Implementation side-effect, not used in any way.
373 * @param event A <strong>FocusEvent</strong> containing details about the focus action performed.
374 */
375 public void focusLost(FocusEvent event) {
376 }
377
378 /** Called to inform this control panel that it has just gained focus as an effect of the user clicking on its tab.
379 */
380 public void gainFocus() {
381 // Update the meta-audit view to show the current selection, if any.
382 Gatherer.g_man.meta_audit.setRecords(getCollectionTreeSelection());
383 }
384
385 /** Retrieve a list of the currently selected file records in the collection tree. */
386 private CollectionTreeNode[] getCollectionTreeSelection()
387 {
388 TreePath paths[] = collection_tree.getSelectionPaths();
389 CollectionTreeNode records[] = null;
390 if (paths != null) {
391 records = new CollectionTreeNode[paths.length];
392 for (int i = 0; i < records.length; i++) {
393 records[i] = (CollectionTreeNode) paths[i].getLastPathComponent();
394 }
395 }
396 return records;
397 }
398
399
400 /** Called whenever the detail mode changes to ensure the filters are at an appropriate level (ie only editable by those that understand regular expression matching)
401 * @param mode the mode level as an int
402 */
403 public void modeChanged(int mode) {
404 collection_filter.setEditable(mode > Configuration.LIBRARIAN_MODE);
405 workspace_filter.setEditable(mode > Configuration.LIBRARIAN_MODE);
406 }
407
408
409 /** Refresh this pane, depending on what has just happened (refresh_reason). */
410 public void refresh(int refresh_reason, boolean collection_loaded)
411 {
412 if (collection_loaded) {
413 // Update collection label
414 Dictionary.registerText(collection_label, "Collection.Collection");
415 collection_label.setBackground(Configuration.getColor("coloring.collection_heading_background", false));
416 collection_label.setForeground(Configuration.getColor("coloring.collection_heading_foreground", false));
417
418 // Update collection tree
419 if (refresh_reason == Gatherer.COLLECTION_OPENED) {
420 collection_tree.setModel(Gatherer.c_man.getCollectionTreeModel());
421 }
422
423 // Update collection filter
424 collection_filter.setBackground(Configuration.getColor("coloring.collection_heading_background", false));
425 }
426 else {
427 // Update collection label
428 String[] args = new String[1];
429 args[0] = Dictionary.get("Collection.No_Collection");
430 Dictionary.registerText(collection_label, "Collection.Collection", args);
431 collection_label.setBackground(Color.lightGray);
432 collection_label.setForeground(Color.black);
433
434 // Update collection tree
435 collection_tree.setModel(new DefaultTreeModel(new DefaultMutableTreeNode("Error")));
436
437 // Update collection filter
438 collection_filter.setBackground(Color.lightGray);
439 }
440
441 // Enable or disable the controls
442 workspace_tree.setEnabled(true);
443 collection_tree.setEnabled(collection_loaded);
444 collection_filter.setEnabled(collection_loaded);
445 bin_button.setEnabled(collection_loaded);
446 new_folder.setEnabled(collection_loaded);
447
448 // Ensure that this collection tree view is synchronized with all others
449 collection_tree_sync.add(collection_tree);
450 }
451
452
453 public void refreshCollectionTree(int refresh_reason) {
454 collection_tree.refresh(null);
455 }
456
457
458 public void refreshWorkspaceTree(int refresh_reason) {
459 workspace_tree.refresh(refresh_reason);
460 }
461
462
463 /** When a user right-clicks within the workspace and collection trees they are presented with a small popup menu of context based options. This class provides such functionality.
464 */
465 private class RightClickMenu
466 extends JPopupMenu
467 implements ActionListener {
468
469 /** The tree over which the right click action occurred. */
470 private DragTree tree = null;
471 /** The tree nodes selected when the right click action occurred. */
472 private TreePath[] selection_paths = null;
473 /** The file record over which the right click action occurred. */
474 private FileNode node = null;
475
476 private JMenuItem create_shortcut = null;
477 private JMenuItem delete_shortcut = null;
478 private JMenuItem collapse_folder = null;
479 private JMenuItem expand_folder = null;
480 private JMenuItem explode_metadata_database = null;
481 private JMenuItem delete = null;
482 private JMenuItem metaaudit = null;
483 private JMenuItem new_folder = null;
484 private JMenuItem new_dummy_doc = null;
485 private JMenuItem open_externally = null;
486
487
488 private RightClickMenu(DragTree tree, MouseEvent event)
489 {
490 super();
491 this.tree = tree;
492
493 // Note we have to use setImmediate() with the set selction paths
494 // otherwise the selection doesn't get updated until after the
495 // popup comes up.
496
497 // the right click position
498 TreePath right_click_path = tree.getPathForLocation(event.getX(), event.getY());
499 if (right_click_path == null) {
500 // user has clicked outside of the tree, clear the selection
501 selection_paths = null;
502 tree.setImmediate(true);
503 tree.clearSelection();
504 tree.setImmediate(false);
505 } else {
506 // Get the paths currently selected in the tree
507 selection_paths = tree.getSelectionPaths();
508 if (selection_paths == null) {
509 // nothing currently selected - we shift the selection to
510 // the node that was right clicked on
511 selection_paths = new TreePath[1];
512 selection_paths[0] = right_click_path;
513 tree.setImmediate(true);
514 tree.setSelectionPath(right_click_path);
515 tree.setImmediate(false);
516 } else if (selection_paths.length == 1 && ! selection_paths[0].equals( right_click_path)) {
517 tree.setImmediate(true);
518 tree.clearSelection();
519 tree.setSelectionPath(right_click_path);
520 tree.setImmediate(false);
521 selection_paths[0] = right_click_path;
522 } else {
523 // we had multiply selected paths in the tree.
524 // if we clicked on one of those paths, then use all the
525 // current selection, otherwise clear the selection and
526 // select the one we right clicked on
527 boolean clicked_in_selection = false;
528 for (int i=0; i<selection_paths.length; i++) {
529 if (selection_paths[i].equals(right_click_path)) {
530 clicked_in_selection = true;
531 break;
532 }
533 }
534 if (!clicked_in_selection) {
535 // want the tree to update right away
536 tree.setImmediate(true);
537 tree.clearSelection();
538 tree.setSelectionPath(right_click_path);
539 tree.setImmediate(false);
540 selection_paths = new TreePath[1];
541 selection_paths[0] = right_click_path;
542 }
543 }
544 }
545 // finally we have the correct selection paths!
546
547 // Create an appropriate context menu, based on what is selected
548 buildContextMenu(selection_paths);
549
550 // Show the popup menu on screen
551 show(tree, event.getX(), event.getY());
552 }
553
554
555 private void buildContextMenu(TreePath[] selection_paths)
556 {
557 // If nothing is selected, only the new folder/dummy doc options are available...
558 if (selection_paths == null) {
559 // ... but only in the collection tree!
560 if (tree == collection_tree) {
561 new_folder = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Folder"), KeyEvent.VK_N);
562 new_folder.addActionListener(this);
563 add(new_folder);
564
565 new_dummy_doc = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Dummy_Doc"));
566 new_dummy_doc.addActionListener(this);
567 add(new_dummy_doc);
568
569 node = (CollectionTreeNode) tree.getModel().getRoot();
570 }
571
572 return;
573 }
574
575 DebugStream.println("Number of files/folders selected: " + selection_paths.length);
576
577 // Collection tree: display meta-audit option and delete options
578 if (tree == collection_tree) {
579 String[] args = new String[1];
580 args[0] = collection_tree.getSelectionDetails();
581 metaaudit = new JMenuItem(Dictionary.get("Menu.Metadata_View", args), KeyEvent.VK_A);
582 metaaudit.addActionListener(this);
583 add(metaaudit);
584
585 delete = new JMenuItem(Dictionary.get("CollectionPopupMenu.Delete"), KeyEvent.VK_D);
586 delete.addActionListener(this);
587 add(delete);
588 }
589
590 // Only meta-audit and delete are available if multiple items are selected...
591 if (selection_paths.length > 1) {
592 return;
593 }
594
595 TreePath path = selection_paths[0];
596 node = (FileNode) path.getLastPathComponent();
597
598 // ---- Options for file nodes ----
599 if (node.isLeaf()) {
600 // Explode metadata databases, for collection tree only, and for explodable files only
601 if (tree == collection_tree && ((CollectionTreeNode) node).isExplodable()) {
602 explode_metadata_database = new JMenuItem(Dictionary.get("Menu.Explode_Metadata_Database"), KeyEvent.VK_E);
603 explode_metadata_database.addActionListener(this);
604 add(explode_metadata_database);
605 }
606
607 // Open the file in an external program
608 open_externally = new JMenuItem(Dictionary.get("Menu.Open_Externally"), KeyEvent.VK_O);
609 open_externally.addActionListener(this);
610 add(open_externally);
611
612 return;
613 }
614
615 // ---- Options for folder nodes ----
616 // Collapse or expand, depending on current status
617 if (tree.isExpanded(path)) {
618 collapse_folder = new JMenuItem(Dictionary.get("Menu.Collapse"), KeyEvent.VK_C);
619 collapse_folder.addActionListener(this);
620 add(collapse_folder);
621 }
622 else {
623 expand_folder = new JMenuItem(Dictionary.get("Menu.Expand"), KeyEvent.VK_O);
624 expand_folder.addActionListener(this);
625 add(expand_folder);
626 }
627
628 // New folder/dummy doc options, for collection tree only
629 if (tree == collection_tree && !node.isReadOnly()) {
630 new_folder = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Folder"), KeyEvent.VK_N);
631 new_folder.addActionListener(this);
632 add(new_folder);
633 new_dummy_doc = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Dummy_Doc"));
634 new_dummy_doc.addActionListener(this);
635 add(new_dummy_doc);
636 }
637
638 // Create/remove shortcut option, for workspace tree only
639 if (tree == workspace_tree) {
640 // The "built-in" folders can't be modified
641 String node_name = node.toString();
642 if (node_name.equals(Dictionary.get("Tree.World")) || node_name.equals(Dictionary.get("Tree.Root")) || node_name.equals(Dictionary.get("Tree.DownloadedFiles"))) {
643 return;
644 }
645
646 // You can unmap 1st level nodes
647 WorkspaceTreeNode root = (WorkspaceTreeNode) tree.getModel().getRoot();
648 if (root.getIndex(node) != -1) {
649 delete_shortcut = new JMenuItem(Dictionary.get("MappingPrompt.Unmap"), KeyEvent.VK_R);
650 delete_shortcut.addActionListener(this);
651 add(delete_shortcut);
652 }
653 // Or map any other level directories
654 else {
655 create_shortcut = new JMenuItem(Dictionary.get("MappingPrompt.Map"), KeyEvent.VK_S);
656 create_shortcut.addActionListener(this);
657 add(create_shortcut);
658 }
659 }
660 }
661
662
663 /** Called whenever one of the menu items is clicked, this method then causes the appropriate effect. */
664 public void actionPerformed(ActionEvent event)
665 {
666 Object source = event.getSource();
667
668 // Create shortcut
669 if (source == create_shortcut) {
670 MappingPrompt mp = new MappingPrompt(node.getFile());
671 mp.destroy();
672 }
673
674 // Delete shortcut
675 else if (source == delete_shortcut) {
676 workspace_tree.removeDirectoryMapping((WorkspaceTreeNode) node);
677 }
678
679 // Collapse folder
680 else if (source == collapse_folder) {
681 tree.collapsePath(selection_paths[0]);
682 }
683
684 // Expand folder
685 else if (source == expand_folder) {
686 tree.expandPath(selection_paths[0]);
687 }
688
689 // Explode metadata database
690 else if (source == explode_metadata_database) {
691 ExplodeMetadataPrompt emp = new ExplodeMetadataPrompt(node.getFile());
692 //emp.destroy();
693 }
694
695 // Delete
696 else if (source == delete) {
697 FileNode[] source_nodes = new FileNode[selection_paths.length];
698 for (int i = 0; i < selection_paths.length; i++) {
699 source_nodes[i] = (FileNode) selection_paths[i].getLastPathComponent();
700 }
701
702 // Fire a delete action
703 Gatherer.f_man.action(tree, source_nodes, bin_button, null);
704 }
705
706 // Meta-audit
707 else if (source == metaaudit) {
708 Gatherer.g_man.showMetaAuditBox();
709 }
710
711 // New folder
712 else if (source == new_folder) {
713 Gatherer.f_man.newFolder(tree, (CollectionTreeNode) node);
714 }
715 // New dummy doc
716 else if (source == new_dummy_doc) {
717 Gatherer.f_man.newDummyDoc(tree, (CollectionTreeNode) node);
718 }
719 // Open in external program
720 else if (source == open_externally) {
721 Gatherer.f_man.openFileInExternalApplication(node.getFile());
722 }
723 }
724 }
725
726
727 /** This class listens for certain key presses, such as [Enter] or [Delete], and responds appropriately. */
728 private class KeyListenerImpl
729 extends KeyAdapter {
730 private boolean vk_left_pressed = false;
731 /** Called whenever a key that was pressed is released, it is this action that will cause the desired effects (this allows for the key event itself to be processed prior to this listener dealing with it). */
732 public void keyReleased(KeyEvent event) {
733 ///ystem.err.println("Key Release detected. " + event.getKeyCode());
734 if(event.getKeyCode() == KeyEvent.VK_DELETE) {
735 // Get the selected files from the tree and removal them using the default dnd removal method.
736 // Find the active tree (you've made selections in).
737 DragTree tree = (DragTree) group.getActive();
738 // Fudge things a bit
739 group.setSource(tree);
740 // Determine the selection.
741 TreePath paths[] = tree.getSelectionPaths();
742 if(paths != null) {
743 FileNode[] source_nodes = new FileNode[paths.length];
744 for(int i = 0; i < source_nodes.length; i++) {
745 source_nodes[i] = (FileNode) paths[i].getLastPathComponent();
746 }
747 Gatherer.f_man.action(tree, source_nodes, bin_button, null);
748 source_nodes = null;
749 }
750 }
751 else if(event.getKeyCode() == KeyEvent.VK_ENTER) {
752 // Get the first selected file.
753 DragTree tree = (DragTree)event.getSource();
754 TreePath path = tree.getSelectionPath();
755 if(path != null) {
756 File file = ((FileNode)path.getLastPathComponent()).getFile();
757 if (file != null && file.isFile()) {
758 Gatherer.f_man.openFileInExternalApplication(file);
759 }
760 else {
761 if(!tree.isExpanded(path)) {
762 tree.expandPath(path);
763 }
764 else {
765 tree.collapsePath(path);
766 }
767 }
768 }
769 } else if (event.getKeyCode() == KeyEvent.VK_UP || event.getKeyCode() == KeyEvent.VK_DOWN) {
770 DragTree tree = (DragTree)event.getSource();
771 // we need to manually do the up and down selections
772 boolean up = (event.getKeyCode() == KeyEvent.VK_UP);
773 int current_row = tree.getLeadSelectionRow();
774 tree.setImmediate(true);
775 if (up) {
776 if (current_row > 0) {
777 tree.clearSelection();
778 tree.setSelectionRow(current_row-1);
779 }
780 } else {
781 if (current_row < tree.getRowCount()-1){
782 tree.clearSelection();
783 tree.setSelectionRow(current_row+1);
784 }
785 }
786 tree.setImmediate(false);
787 } else if (event.getKeyCode() == KeyEvent.VK_LEFT) {
788 // left key on a file shifts the selection to the parent folder
789 DragTree tree = (DragTree)event.getSource();
790 TreePath path = tree.getLeadSelectionPath();
791 if(path != null) {
792 File file = ((FileNode)path.getLastPathComponent()).getFile();
793 if(file != null) {
794 if (file.isFile() || vk_left_pressed) {
795 vk_left_pressed = false;
796 TreePath parent_path = path.getParentPath();
797 if (parent_path != null && parent_path.getParentPath() != null) {
798 // if this file is in the top level folder, don't move the focus
799 tree.setImmediate(true);
800 tree.clearSelection();
801 tree.setSelectionPath(parent_path);
802 tree.setImmediate(false);
803 }
804 }
805 }
806 }
807 }
808 }
809
810 // we need to watch for left clicks on an unopened folder - should shift the focus to teh parent folder. But because there is some other mysterious key listener that does opening and closing folders on right and left clicks, we must detect the situation before the other handler has done its job, and process it after.
811 public void keyPressed(KeyEvent event) {
812 if (event.getKeyCode() == KeyEvent.VK_LEFT) {
813 // left key on closed directory shifts the selection to the parent folder
814 DragTree tree = (DragTree)event.getSource();
815 TreePath path = tree.getLeadSelectionPath();
816 if(path == null) return;
817 File file = ((FileNode)path.getLastPathComponent()).getFile();
818 if(file == null) return;
819
820 if (file.isDirectory() && tree.isCollapsed(path)) {
821 vk_left_pressed = true;
822 }
823 }
824 }
825 }
826
827 /** This provides a small prompt for gathering addition details about a special directory mapping such as its symbolic name.
828 * Used when creating a new shortcut to a folder */
829 private class MappingPrompt
830 extends JDialog
831 implements ActionListener, KeyListener {
832 private boolean cancelled = false;
833 private JButton cancel_button = null;
834 private JButton ok_button = null;
835 private JTextField name_field = null;
836 public MappingPrompt(File file) {
837 super(Gatherer.g_man);
838 setModal(true);
839 setSize(DIALOG_SIZE);
840 Dictionary.setText(this, "MappingPrompt.Title");
841
842 // Creation
843 JPanel content_pane = (JPanel) getContentPane();
844 JPanel center_pane = new JPanel();
845 JPanel labels_pane = new JPanel();
846 JPanel fields_pane = new JPanel();
847
848 JLabel file_label = new JLabel();
849 Dictionary.setText(file_label, "MappingPrompt.File");
850 JLabel file_field = new JLabel(file.getAbsolutePath());
851
852 JLabel name_label = new JLabel();
853 Dictionary.setText(name_label, "MappingPrompt.Name");
854 name_field = new JTextField(file.getName());
855
856 JPanel button_pane = new JPanel();
857 ok_button = new GLIButton();
858 ok_button.setEnabled(name_field.getText().length() > 0);
859 ok_button.setMnemonic(KeyEvent.VK_O);
860 Dictionary.setBoth(ok_button, "General.OK", "General.OK_Tooltip");
861 cancel_button = new GLIButton();
862 cancel_button.setMnemonic(KeyEvent.VK_C);
863 Dictionary.setBoth(cancel_button, "General.Cancel", "General.Cancel_Tooltip");
864
865 // Connection
866 cancel_button.addActionListener(this);
867 ok_button.addActionListener(this);
868 name_field.addKeyListener(this);
869
870 // Layout
871 labels_pane.setLayout(new GridLayout(2,1,5,0));
872 labels_pane.add(file_label);
873 labels_pane.add(name_label);
874
875 fields_pane.setLayout(new GridLayout(2,1,5,0));
876 fields_pane.add(file_field);
877 fields_pane.add(name_field);
878
879 center_pane.setBorder(BorderFactory.createEmptyBorder(0,0,5,0));
880 center_pane.setLayout(new BorderLayout(5,0));
881 center_pane.add(labels_pane, BorderLayout.WEST);
882 center_pane.add(fields_pane, BorderLayout.CENTER);
883
884 button_pane.setLayout(new GridLayout(1,2,5,5));
885 button_pane.add(ok_button);
886 button_pane.add(cancel_button);
887
888 content_pane.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
889 content_pane.setLayout(new BorderLayout());
890 content_pane.add(center_pane, BorderLayout.CENTER);
891 content_pane.add(button_pane, BorderLayout.SOUTH);
892 // Display
893 Dimension screen_size = Configuration.screen_size;
894 setLocation((screen_size.width - DIALOG_SIZE.width) / 2, (screen_size.height - DIALOG_SIZE.height) / 2);
895 setVisible(true);
896 // If not cancelled create mapping.
897 if (!cancelled) {
898 workspace_tree.addDirectoryMapping(name_field.getText(), file);
899 }
900 }
901 public void actionPerformed(ActionEvent event) {
902 if(event.getSource() == cancel_button) {
903 cancelled = true;
904 }
905 dispose();
906 }
907 public void destroy() {
908 cancel_button = null;
909 ok_button = null;
910 name_field = null;
911 }
912 public void keyPressed(KeyEvent event) {
913 }
914 public void keyReleased(KeyEvent event) {
915 ok_button.setEnabled(name_field.getText().length() > 0);
916
917 }
918 public void keyTyped(KeyEvent event) {
919 }
920 }
921
922 /** This class listens for mouse clicks and responds right mouse button clicks (popup menu). */
923 private class MouseListenerImpl
924 extends MouseAdapter {
925 /** Any subclass of MouseAdapter can override this method to respond to mouse click events. In this case we want to open a pop-up menu if we detect a right mouse click over one of our registered components, and start an external application if someone double clicks on a certain file record. */
926 public void mouseClicked(MouseEvent event) {
927 if (SwingUtilities.isRightMouseButton(event)) {
928 new RightClickMenu((DragTree) event.getSource(), event);
929 }
930 }
931 }
932}
Note: See TracBrowser for help on using the repository browser.