Changeset 11608

Timestamp:

2006-04-06T16:39:37+12:00 (18 years ago)

Author:

mdewsnip

Message:

Created a CollectionTreeRightClickMenu class inside CollectionTree so this code doesn't have to be duplicated between Gather and Enrich panes (and will always be consistent).

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• collection/CollectionTree.java (modified) (3 diffs)
• gui/EnrichPane.java (modified) (2 diffs)
• gui/GatherPane.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/collection/CollectionTree.java

@@ -28 +28 @@
 
 import java.awt.*;
+import java.awt.event.*;
 import javax.swing.*;
+import javax.swing.tree.*;
+import org.greenstone.gatherer.gui.ExplodeMetadataPrompt;
 import org.greenstone.gatherer.gui.tree.DragTree;
 import org.greenstone.gatherer.gui.tree.DragTreeCellRenderer;
+import org.greenstone.gatherer.Dictionary;
+import org.greenstone.gatherer.Gatherer;
 
 
 public class CollectionTree
     extends DragTree
+    implements MouseListener
 {
     public CollectionTree(String name, CollectionTreeModel collection_tree_model, boolean mixed_selection)
@@ -40 +46 @@
     super(name, collection_tree_model, mixed_selection);
     setCellRenderer(new CollectionTreeCellRenderer());
+    addMouseListener(this);
     }
+
+
+    public void mouseClicked(MouseEvent event)
+    {
+    if (SwingUtilities.isRightMouseButton(event)) {
+        new CollectionTreeRightClickMenu(this, event);
+    }
+    }
+
+    public void mouseEntered(MouseEvent event) { }
+
+    public void mouseExited(MouseEvent event) { }
+
+    public void mousePressed(MouseEvent event) { }
+
+    public void mouseReleased(MouseEvent event) { }
 
 
@@ -58 +81 @@
     }
     }
+
+
+    /** 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.
+     */
+    private class CollectionTreeRightClickMenu
+    extends JPopupMenu
+    implements ActionListener
+    {
+    /** The tree over which the right click action occurred. */
+    private CollectionTree collection_tree = null;
+    /** The tree nodes selected when the right click action occurred. */
+    private TreePath[] selection_paths = null;
+    /** The file record over which the right click action occurred. */
+    private CollectionTreeNode node = null;
+
+    private JMenuItem collapse_folder = null;
+    private JMenuItem expand_folder = null;
+    private JMenuItem explode_metadata_database = null;
+    private JMenuItem delete = null;
+    private JMenuItem metaaudit = null;
+    private JMenuItem new_folder = null;
+    private JMenuItem new_dummy_doc = null;
+    private JMenuItem open_externally = null;
+    private JMenuItem rename = null;
+    private JMenuItem replace = null;
+
+
+    private CollectionTreeRightClickMenu(CollectionTree collection_tree, MouseEvent event)
+    {
+        super();
+        this.collection_tree = collection_tree;
+
+        // Note we have to use setImmediate() with the set selction paths
+        // otherwise the selection doesn't get updated until after the 
+        // popup comes up.
+
+        // the right click position
+        TreePath right_click_path = collection_tree.getPathForLocation(event.getX(), event.getY());
+        if (right_click_path == null) {
+        // user has clicked outside of the tree, clear the selection
+        selection_paths = null;
+        collection_tree.setImmediate(true);
+        collection_tree.clearSelection();
+        collection_tree.setImmediate(false);
+        }
+        else {
+        // Get the paths currently selected in the tree
+        selection_paths = collection_tree.getSelectionPaths();
+        if (selection_paths == null) {
+            // nothing currently selected - we shift the selection to 
+            // the node that was right clicked on
+            selection_paths = new TreePath[1];
+            selection_paths[0] = right_click_path;
+            collection_tree.setImmediate(true);
+            collection_tree.setSelectionPath(right_click_path);
+            collection_tree.setImmediate(false);
+        }
+        else if (selection_paths.length == 1 && ! selection_paths[0].equals( right_click_path)) {
+            collection_tree.setImmediate(true);
+            collection_tree.clearSelection();
+            collection_tree.setSelectionPath(right_click_path);
+            collection_tree.setImmediate(false);
+            selection_paths[0] = right_click_path;
+        }
+        else {
+            // we had multiply selected paths in the tree.
+            // if we clicked on one of those paths, then use all the 
+            // current selection, otherwise clear the selection and 
+            // select the one we right clicked on
+            boolean clicked_in_selection = false;
+            for (int i = 0; i < selection_paths.length; i++) {
+            if (selection_paths[i].equals(right_click_path)) {
+                clicked_in_selection = true;
+                break;
+            }
+            }
+            if (!clicked_in_selection) {
+            // want the tree to update right away
+            collection_tree.setImmediate(true);
+            collection_tree.clearSelection();
+            collection_tree.setSelectionPath(right_click_path);
+            collection_tree.setImmediate(false);
+            selection_paths = new TreePath[1];
+            selection_paths[0] = right_click_path;
+            }
+        }
+        }
+        
+        // Create an appropriate context menu, based on what is selected
+        buildContextMenu(selection_paths);
+
+        // Show the popup menu on screen
+        show(collection_tree, event.getX(), event.getY());
+    }
+
+
+    private void buildContextMenu(TreePath[] selection_paths)
+    {
+        // If nothing is selected, only the new folder/dummy doc options are available...
+        if (selection_paths == null) {
+        new_folder = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Folder"), KeyEvent.VK_N);
+        new_folder.addActionListener(this);
+        add(new_folder);
+
+        new_dummy_doc = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Dummy_Doc"));
+        new_dummy_doc.addActionListener(this);
+        add(new_dummy_doc);
+
+        node = (CollectionTreeNode) collection_tree.getModel().getRoot();
+        return;
+        }
+
+        // Meta-audit and delete options
+        metaaudit = new JMenuItem(Dictionary.get("Menu.Metadata_View", collection_tree.getSelectionDetails()), KeyEvent.VK_A);
+        metaaudit.addActionListener(this);
+        add(metaaudit);
+
+        delete = new JMenuItem(Dictionary.get("CollectionPopupMenu.Delete"), KeyEvent.VK_D);
+        delete.addActionListener(this);
+        add(delete);
+
+        // Only meta-audit and delete are available if multiple items are selected...
+        if (selection_paths.length > 1) {
+        return;
+        }
+
+        // Rename option
+        // !! TO DO: Remote building
+        if (!Gatherer.isGsdlRemote) {
+        rename = new JMenuItem(Dictionary.get("CollectionPopupMenu.Rename"), KeyEvent.VK_R);
+        rename.addActionListener(this);
+        add(rename);
+        }
+
+        TreePath path = selection_paths[0];
+        node = (CollectionTreeNode) path.getLastPathComponent();
+
+        // ---- Options for file nodes ----
+        if (node.isLeaf()) {
+        // Explode metadata databases, for explodable files only
+        if (node.isExplodable()) {
+            explode_metadata_database = new JMenuItem(Dictionary.get("Menu.Explode_Metadata_Database"), KeyEvent.VK_E);
+            explode_metadata_database.addActionListener(this);
+            explode_metadata_database.setEnabled(!Gatherer.isGsdlRemote);
+            add(explode_metadata_database);
+        }
+        // Replace file
+        // !! TO DO: Remote building
+        if (!Gatherer.isGsdlRemote) {
+            replace = new JMenuItem(Dictionary.get("CollectionPopupMenu.Replace"), KeyEvent.VK_P);
+            replace.addActionListener(this);
+            add(replace);
+        }
+        
+        // Open the file in an external program
+        open_externally = new JMenuItem(Dictionary.get("Menu.Open_Externally"), KeyEvent.VK_O);
+        open_externally.addActionListener(this);
+        add(open_externally);
+
+        return;
+        }
+
+        // ---- Options for folder nodes ----
+        // Collapse or expand, depending on current status
+        if (collection_tree.isExpanded(path)) {
+        collapse_folder = new JMenuItem(Dictionary.get("Menu.Collapse"), KeyEvent.VK_C);
+        collapse_folder.addActionListener(this);
+        add(collapse_folder);
+        }
+        else {
+        expand_folder = new JMenuItem(Dictionary.get("Menu.Expand"), KeyEvent.VK_O);
+        expand_folder.addActionListener(this);
+        add(expand_folder);
+        }
+
+        // New folder/dummy doc options
+        if (!node.isReadOnly()) {
+        new_folder = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Folder"), KeyEvent.VK_N);
+        new_folder.addActionListener(this);
+        add(new_folder);
+
+        new_dummy_doc = new JMenuItem(Dictionary.get("CollectionPopupMenu.New_Dummy_Doc"));
+        new_dummy_doc.addActionListener(this);
+        add(new_dummy_doc);
+        }
+    }
+
+
+    /** Called whenever one of the menu items is clicked, this method then causes the appropriate effect. */
+    public void actionPerformed(ActionEvent event)
+    {
+        Object source = event.getSource();
+
+        // Collapse folder
+        if (source == collapse_folder) {
+        collection_tree.collapsePath(selection_paths[0]);
+        }
+
+        // Expand folder
+        else if (source == expand_folder) {
+        collection_tree.expandPath(selection_paths[0]);
+        }
+
+        // Explode metadata database
+        else if (source == explode_metadata_database) {
+        ExplodeMetadataPrompt emp = new ExplodeMetadataPrompt(node.getFile());
+        //emp.destroy();
+        }
+
+        // Delete
+        else if (source == delete) {
+        CollectionTreeNode[] source_nodes = new CollectionTreeNode[selection_paths.length];
+        for (int i = 0; i < selection_paths.length; i++) {
+            source_nodes[i] = (CollectionTreeNode) selection_paths[i].getLastPathComponent();
+        }
+
+        // Fire a delete action
+        Gatherer.f_man.action(collection_tree, source_nodes, Gatherer.recycle_bin, null);
+        }
+
+        // Meta-audit
+        else if (source == metaaudit) {
+        Gatherer.g_man.showMetaAuditBox();
+        }
+
+        // New folder
+        else if (source == new_folder) {
+        Gatherer.f_man.newFolder(collection_tree, node);
+        }
+
+        // New dummy doc
+        else if (source == new_dummy_doc) {
+        Gatherer.f_man.newDummyDoc(collection_tree, node);
+        }
+
+        // Open in external program
+        else if (source == open_externally) {
+        Gatherer.f_man.openFileInExternalApplication(node.getFile());
+        }
+
+        // Rename
+        else if (source == rename) {
+        Gatherer.f_man.renameCollectionFile(collection_tree, node);
+        }
+
+        // Replace
+        else if (source == replace) {
+        Gatherer.f_man.replaceCollectionFile(collection_tree, node);
+        }
+    }
+    }
 }

trunk/gli/src/org/greenstone/gatherer/gui/EnrichPane.java

@@ -132 +132 @@
     collection_tree.putClientProperty("JTree.lineStyle", "Angled");
     collection_tree.addMouseListener(Gatherer.g_man.foa_listener);
-    collection_tree.addMouseListener(new RightButtonListener());
     collection_tree.addTreeSelectionListener(this);
     collection_tree.addTreeExpansionListener(Gatherer.g_man.foa_listener);
@@ -389 +388 @@
     }
     }
-
-
-    /** A listener for right mouse button clicks over the collection tree. */
-    private class RightButtonListener
-    extends MouseAdapter {
-    /** Called whenever a mouse click occurs (right or left) over a target component.
-     * @param event A <strong>MouseEvent</strong> containing further information about the mouse click action.
-     * @see org.greenstone.gatherer.gui.EnrichPane.RightButtonMenu
-     */
-    public void mouseClicked(MouseEvent event) {
-        if (SwingUtilities.isRightMouseButton(event)) {
-        new RightButtonMenu(event);
-        }
-    }
-    }
-
-
-    /** When a user right-clicks within the collection tree they are presented with a small popup menu of context based options. This class provides such functionality.
-     */
-    private class RightButtonMenu
-    extends JPopupMenu
-    implements ActionListener {
-
-    /** The tree over which the right click action occurred. */
-    private DragTree tree = null;
-    /** The tree nodes selected when the right click action occurred. */
-    private TreePath[] selection_paths = null;
-    /** The file record over which the right click action occurred. */
-    private CollectionTreeNode node = null;
-
-    private JMenuItem collapse_folder = null;
-    private JMenuItem expand_folder = null;
-    private JMenuItem metaaudit = null;
-    private JMenuItem open_externally = null;
-
-
-    private RightButtonMenu(MouseEvent event)
-    {
-        super();
-        this.tree = collection_tree;
-
-        // Note we have to use setImmediate() with the set selction paths
-        // otherwise the selection doesn't get updated until after the 
-        // popup comes up.
-
-        // the right click position
-        TreePath right_click_path = tree.getPathForLocation(event.getX(), event.getY());
-        if (right_click_path == null) {
-        // user has clicked outside of the tree, clear the selection
-        selection_paths = null;
-        tree.setImmediate(true);
-        tree.clearSelection();
-        tree.setImmediate(false);
-        } else {
-        // Get the paths currently selected in the tree
-        selection_paths = tree.getSelectionPaths();
-        if (selection_paths == null) {
-            // nothing currently selected - we shift the selection to 
-            // the node that was right clicked on
-            selection_paths = new TreePath[1];
-            selection_paths[0] = right_click_path;
-            tree.setImmediate(true);
-            tree.setSelectionPath(right_click_path);
-            tree.setImmediate(false);
-        } else if (selection_paths.length == 1 && ! selection_paths[0].equals( right_click_path)) {
-            tree.setImmediate(true);
-            tree.clearSelection();
-            tree.setSelectionPath(right_click_path);
-            tree.setImmediate(false);
-            selection_paths[0] = right_click_path;
-        } else {
-            // we had multiply selected paths in the tree.
-            // if we clicked on one of those paths, then use all the 
-            // current selection, otherwise clear the selection and 
-            // select the one we right clicked on
-            boolean clicked_in_selection = false;
-            for (int i=0; i<selection_paths.length; i++) {
-            if (selection_paths[i].equals(right_click_path)) {
-                clicked_in_selection = true;
-                break;
-            }
-            }
-            if (!clicked_in_selection) {
-            // want the tree to update right away
-            tree.setImmediate(true);
-            tree.clearSelection();
-            tree.setSelectionPath(right_click_path);
-            tree.setImmediate(false);
-            selection_paths = new TreePath[1];
-            selection_paths[0] = right_click_path;
-            }
-        }
-        }
-        // finally we have the correct selection paths!
-
-        // Create an appropriate context menu, based on what is selected
-        buildContextMenu(selection_paths);
-
-        // Show the popup menu on screen
-        show(tree, event.getX(), event.getY());
-    }
-
-
-    private void buildContextMenu(TreePath[] selection_paths)
-    {
-        // If nothing is selected, no options are available
-        if (selection_paths == null) {
-        return;
-        }
-
-        DebugStream.println("Number of files/folders selected: " + selection_paths.length);
-
-        // Always have meta-audit option
-        metaaudit = new JMenuItem(Dictionary.get("Menu.Metadata_View", collection_tree.getSelectionDetails()), KeyEvent.VK_A);
-        metaaudit.addActionListener(this);
-        add(metaaudit);
-
-        // Only meta-audit is available if multiple items are selected...
-        if (selection_paths.length > 1) {
-        return;
-        }
-
-        TreePath path = selection_paths[0];
-        node = (CollectionTreeNode) path.getLastPathComponent();
-
-        // ---- Options for file nodes ----
-        if (node.isLeaf()) {
-        // Open the file in an external program
-        open_externally = new JMenuItem(Dictionary.get("Menu.Open_Externally"), KeyEvent.VK_O);
-        open_externally.addActionListener(this);
-        add(open_externally);
-        return;
-        }
-
-        // ---- Options for folder nodes ----
-        // Collapse or expand, depending on current status
-        if (tree.isExpanded(path)) {
-        collapse_folder = new JMenuItem(Dictionary.get("Menu.Collapse"), KeyEvent.VK_C);
-        collapse_folder.addActionListener(this);
-        add(collapse_folder);
-        }
-        else {
-        expand_folder = new JMenuItem(Dictionary.get("Menu.Expand"), KeyEvent.VK_O);
-        expand_folder.addActionListener(this);
-        add(expand_folder);
-        }
-    }
-
-
-    /** Called whenever one of the menu items is clicked, this method then causes the appropriate effect. */
-    public void actionPerformed(ActionEvent event)
-    {
-        Object source = event.getSource();
-
-        // Collapse folder
-        if (source == collapse_folder) {
-        tree.collapsePath(selection_paths[0]);
-        }
-
-        // Expand folder
-        else if (source == expand_folder) {
-        tree.expandPath(selection_paths[0]);
-        }
-
-        // Meta-audit
-        else if (source == metaaudit) {
-        Gatherer.g_man.showMetaAuditBox();
-        }
-
-        // Open in external program
-        else if (source == open_externally) {
-        Gatherer.f_man.openFileInExternalApplication(node.getFile());
-        }
-    }
-    }
 }

trunk/gli/src/org/greenstone/gatherer/gui/GatherPane.java

@@ -257 +257 @@
     collection_tree.setEnabled(Gatherer.c_man.getCollectionTreeModel() != null);
     group.add(collection_tree);
-    collection_tree.addMouseListener(mouse_listener);
     collection_tree.addMouseListener(Gatherer.g_man.foa_listener);
     collection_tree.addTreeExpansionListener(Gatherer.g_man.foa_listener);