Changeset 11613

Timestamp:

2006-04-06T17:15:07+12:00 (18 years ago)

Author:

mdewsnip

Message:

Made a customised RightClickMenu for the WorkspaceTree and put it in the WorkspaceTree class.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• file/WorkspaceTree.java (modified) (5 diffs)
• gui/GatherPane.java (modified) (4 diffs)

trunk/gli/src/org/greenstone/gatherer/file/WorkspaceTree.java

@@ -27 +27 @@
 package org.greenstone.gatherer.file;
 
+import java.awt.event.*;
 import java.io.File;
 import java.util.Enumeration;
+import javax.swing.*;
 import javax.swing.tree.TreePath;
 import org.greenstone.gatherer.Configuration;
 import org.greenstone.gatherer.DebugStream;
+import org.greenstone.gatherer.Dictionary;
 import org.greenstone.gatherer.Gatherer;
+import org.greenstone.gatherer.gui.CreateShortcutPrompt;
+import org.greenstone.gatherer.gui.GLIButton;
 import org.greenstone.gatherer.gui.tree.DragTree;
 
@@ -38 +43 @@
 public class WorkspaceTree
     extends DragTree
+    implements MouseListener
 {
     static public final int LIBRARY_CONTENTS_CHANGED = 10;
@@ -47 +53 @@
     {
     super(name, WorkspaceTreeModel.getWorkspaceTreeModel(), true);
+    addMouseListener(this);
     }
 
@@ -58 +65 @@
     refresh(FOLDER_SHORTCUTS_CHANGED);
     }
+
+
+    public void mouseClicked(MouseEvent event)
+    {
+    if (SwingUtilities.isRightMouseButton(event)) {
+        new WorkspaceTreeRightClickMenu(this, event);
+    }
+    }
+
+    public void mouseEntered(MouseEvent event) { }
+
+    public void mouseExited(MouseEvent event) { }
+
+    public void mousePressed(MouseEvent event) { }
+
+    public void mouseReleased(MouseEvent event) { }
 
 
@@ -141 +164 @@
     refresh(FOLDER_SHORTCUTS_CHANGED);
     }
+
+
+    /** 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 WorkspaceTreeRightClickMenu
+    extends JPopupMenu
+    implements ActionListener
+    {
+    /** The tree over which the right click action occurred. */
+    private WorkspaceTree workspace_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 WorkspaceTreeNode node = null;
+
+    private JMenuItem create_shortcut = null;
+    private JMenuItem delete_shortcut = 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 WorkspaceTreeRightClickMenu(WorkspaceTree workspace_tree, MouseEvent event)
+    {
+        super();
+        this.workspace_tree = workspace_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 = workspace_tree.getPathForLocation(event.getX(), event.getY());
+        if (right_click_path == null) {
+        // user has clicked outside of the tree, clear the selection
+        selection_paths = null;
+        workspace_tree.setImmediate(true);
+        workspace_tree.clearSelection();
+        workspace_tree.setImmediate(false);
+        }
+        else {
+        // Get the paths currently selected in the tree
+        selection_paths = workspace_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;
+            workspace_tree.setImmediate(true);
+            workspace_tree.setSelectionPath(right_click_path);
+            workspace_tree.setImmediate(false);
+        }
+        else if (selection_paths.length == 1 && ! selection_paths[0].equals( right_click_path)) {
+            workspace_tree.setImmediate(true);
+            workspace_tree.clearSelection();
+            workspace_tree.setSelectionPath(right_click_path);
+            workspace_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
+            workspace_tree.setImmediate(true);
+            workspace_tree.clearSelection();
+            workspace_tree.setSelectionPath(right_click_path);
+            workspace_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(workspace_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);
+
+        // Only meta-audit and delete are available if multiple items are selected...
+        if (selection_paths.length > 1) {
+        return;
+        }
+
+        TreePath path = selection_paths[0];
+        node = (WorkspaceTreeNode) 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 (workspace_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);
+        }
+
+        // Create/remove shortcut option, for workspace tree only
+        if (workspace_tree == workspace_tree) {
+        // The "built-in" folders can't be modified
+        String node_name = node.toString();
+        if (node_name.equals(Dictionary.get("Tree.World")) || node_name.equals(Dictionary.get("Tree.Root")) || node_name.equals(Dictionary.get("Tree.DownloadedFiles"))) {
+            return;
+        }
+
+        // You can unmap 1st level nodes
+        WorkspaceTreeNode root = (WorkspaceTreeNode) workspace_tree.getModel().getRoot();
+        if (root.getIndex(node) != -1) {
+            delete_shortcut = new JMenuItem(Dictionary.get("MappingPrompt.Unmap"), KeyEvent.VK_R);
+            delete_shortcut.addActionListener(this);
+            add(delete_shortcut);
+        }
+        // Or map any other level directories
+        else {
+            create_shortcut = new JMenuItem(Dictionary.get("MappingPrompt.Map"), KeyEvent.VK_S);
+            create_shortcut.addActionListener(this);
+            add(create_shortcut);
+        }
+        }
+    }
+
+
+    /** 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();
+
+        // Create shortcut
+        if (source == create_shortcut) {
+        CreateShortcutPrompt mp = new CreateShortcutPrompt(workspace_tree, node.getFile());
+        mp.destroy();
+        }
+
+        // Delete shortcut
+        else if (source == delete_shortcut) {
+        workspace_tree.removeDirectoryMapping(node);
+        }
+
+        // Collapse folder
+        else if (source == collapse_folder) {
+        workspace_tree.collapsePath(selection_paths[0]);
+        }
+
+        // Expand folder
+        else if (source == expand_folder) {
+        workspace_tree.expandPath(selection_paths[0]);
+        }
+
+        // Open in external program
+        else if (source == open_externally) {
+        Gatherer.f_man.openFileInExternalApplication(node.getFile());
+        }
+    }
+    }
 }

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

@@ -107 +107 @@
     /** A split pane seperating the two trees, allowing for the screen real-estate for each to be changed. */
     private JSplitPane tree_pane          =  null;
-    /** Text fragment arguments used to fill in phrases returned from the dictionary. */
-    private String args[]                =  null;
     /** Ensures that expansion and selection events between collection trees based on the same model are synchronized. */
     private TreeSynchronizer collection_tree_sync = null;
@@ -207 +205 @@
 
     /** Generates the pane on controls used to 'collect' files into the collection. Resposible for creating, connecting and laying out these controls. */
-    public void display() {
-    // Create Components.
-    MouseListenerImpl mouse_listener = new MouseListenerImpl();
-
+    public void display()
+    {
     // Workspace Tree
     workspace_pane = new JPanel();
@@ -225 +221 @@
     workspace_tree = new WorkspaceTree(Utility.WORKSPACE_TREE);
     group.add(workspace_tree);
-    workspace_tree.addMouseListener(mouse_listener);
     workspace_tree.addMouseListener(Gatherer.g_man.foa_listener);
     workspace_tree.addTreeExpansionListener(Gatherer.g_man.foa_listener);
@@ -426 +421 @@
     workspace_tree.refresh(refresh_reason);
     }
-    
-
-    /** 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 RightClickMenu
-    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 FileNode node = null;
-
-    private JMenuItem create_shortcut = null;
-    private JMenuItem delete_shortcut = 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 RightClickMenu(DragTree tree, MouseEvent event)
-    {
-        super();
-        this.tree = 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, only the new folder/dummy doc options are available...
-        if (selection_paths == null) {
-        // ... but only in the collection tree!
-        if (tree == collection_tree) {
-            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) tree.getModel().getRoot();
-        }
-
-        return;
-        }
-
-        DebugStream.println("Number of files/folders selected: " + selection_paths.length);
-
-        // Collection tree: display meta-audit option and delete options
-        if (tree == collection_tree) {
-        String[] args = new String[1];
-        args[0] = collection_tree.getSelectionDetails();
-        metaaudit = new JMenuItem(Dictionary.get("Menu.Metadata_View", args), 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;
-        }
-
-        // collection tree gets rename option
-        // but not for remote gli (until we make it work properly)
-        if (tree == collection_tree) {
-        if (!Gatherer.isGsdlRemote) {
-            rename = new JMenuItem(Dictionary.get("CollectionPopupMenu.Rename"), KeyEvent.VK_R);
-            rename.addActionListener(this);
-            add(rename);
-        }
-        }
-
-        TreePath path = selection_paths[0];
-        node = (FileNode) path.getLastPathComponent();
-
-        // ---- Options for file nodes ----
-        if (node.isLeaf()) {
-        if (tree == collection_tree) {
-            // Explode metadata databases, for explodable files only
-            if (((CollectionTreeNode) 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
-            // but not for remote gli (until we make it work properly)
-            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 (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, for collection tree only
-        if (tree == collection_tree && !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);
-        }
-
-        // Create/remove shortcut option, for workspace tree only
-        if (tree == workspace_tree) {
-        // The "built-in" folders can't be modified
-        String node_name = node.toString();
-        if (node_name.equals(Dictionary.get("Tree.World")) || node_name.equals(Dictionary.get("Tree.Root")) || node_name.equals(Dictionary.get("Tree.DownloadedFiles"))) {
-            return;
-        }
-
-        // You can unmap 1st level nodes
-        WorkspaceTreeNode root = (WorkspaceTreeNode) tree.getModel().getRoot();
-        if (root.getIndex(node) != -1) {
-            delete_shortcut = new JMenuItem(Dictionary.get("MappingPrompt.Unmap"), KeyEvent.VK_R);
-            delete_shortcut.addActionListener(this);
-            add(delete_shortcut);
-        }
-        // Or map any other level directories
-        else {
-            create_shortcut = new JMenuItem(Dictionary.get("MappingPrompt.Map"), KeyEvent.VK_S);
-            create_shortcut.addActionListener(this);
-            add(create_shortcut);
-        }
-        }
-    }
-
-
-    /** 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();
-
-        // Create shortcut
-        if (source == create_shortcut) {
-        CreateShortcutPrompt csp = new CreateShortcutPrompt(workspace_tree, node.getFile());
-        csp.destroy();
-        }
-
-        // Delete shortcut
-        else if (source == delete_shortcut) {
-        workspace_tree.removeDirectoryMapping((WorkspaceTreeNode) node);
-        }
-
-        // Collapse folder
-        else if (source == collapse_folder) {
-        tree.collapsePath(selection_paths[0]);
-        }
-
-        // Expand folder
-        else if (source == expand_folder) {
-        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) {
-        FileNode[] source_nodes = new FileNode[selection_paths.length];
-        for (int i = 0; i < selection_paths.length; i++) {
-            source_nodes[i] = (FileNode) selection_paths[i].getLastPathComponent();
-        }
-
-        // Fire a delete action
-        Gatherer.f_man.action(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(tree, (CollectionTreeNode) node);
-        }
-
-        // New dummy doc
-        else if (source == new_dummy_doc) {
-        Gatherer.f_man.newDummyDoc(tree, (CollectionTreeNode) 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, (CollectionTreeNode) node);
-        }
-
-        // Replace
-        else if (source == replace) {
-        Gatherer.f_man.replaceCollectionFile(collection_tree, (CollectionTreeNode) node);
-        }
-    }
-    }
-
-
-    /** This class listens for mouse clicks and responds right mouse button clicks (popup menu). */
-    private class MouseListenerImpl
-    extends MouseAdapter {
-    /** 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. */
-    public void mouseClicked(MouseEvent event) {
-        if (SwingUtilities.isRightMouseButton(event)) {
-        new RightClickMenu((DragTree) event.getSource(), event);
-        }
-    }
-    }
 }