Changeset 5180

Timestamp:

2003-08-19T11:19:38+12:00 (21 years ago)

Author:

mdewsnip

Message:

The value tree now features tab-completion and enter to append.

File:

• trunk/gli/src/org/greenstone/gatherer/gui/MetaEditPane.java (modified) (17 diffs)

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

@@ -107 +107 @@
     /** The currently selected metadata determined by listening to every second list selection event from the metadata table. */
     private Metadata selected_metadata;
-    /** A temporary storage array from Strings passed to the dictionary to be inserted in the phrase returned. */
-    private String args[];
     /** Provide synchronization between the collection trees in this view and the collection pane view. */
     private TreeSynchronizer tree_sync = null;
@@ -161 +159 @@
     expand.setPreferredSize(new Dimension(25, 25));
 
-    tree = new GValueTree(this, CONTROL_SIZE.width, CONTROL_SIZE.height);
+    tree = new GValueTree(CONTROL_SIZE.width, CONTROL_SIZE.height);
     }
 
@@ -289 +287 @@
     if(ready) {
         TreeModel collection_model = Gatherer.c_man.getRecordSet();
-        args = new String[1];
+        String[] args = new String[1];
         args[0] = Gatherer.c_man.getCollection().getName();
         collection_label.setText(get("Collection.Collection", args));
@@ -342 +340 @@
 
     ///atherer.println("\tCreating collection_label");
-    args = new String[1];
-    args[0] = get("Collection.No_Collection");
     collection_label = new JLabel(get("Collection.Collection"));
     collection_label.setOpaque(true);
@@ -394 +390 @@
     main_split_pane.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
     main_split_pane.setDividerSize(8);
-
-    // Thumbnail - Currently disabled.
-    // At least until I figure out how to render thumbnails off screen,
-    // which possibly may happen with the discovery of CalpaHTML.
-    /*
-      thumbnail_pane = new JPanel(new BorderLayout());
-
-      Gatherer.println("\tCreating thumbnail_label");
-      thumbnail_label = new JLabel(get("Thumbnail"));
-      thumbnail_label.setHorizontalAlignment(JLabel.CENTER);
-
-      Gatherer.println("\tCreating thumbnail_view_pane");
-      thumbnail_view_pane = new JPanel(new FlowLayout(FlowLayout.CENTER));
-      thumbnail_scroll = new JScrollPane(thumbnail_view_pane);
-
-      thumbnail_pane.add(thumbnail_label, BorderLayout.NORTH);
-      thumbnail_pane.add(thumbnail_scroll, BorderLayout.CENTER);
-    */
 
     // Metadata Table. In order to achieve what Ian envisions I'm going
@@ -519 +497 @@
     table_title_pane.setBorder(BorderFactory.createEmptyBorder(0,0,5,0));
     table_title_pane.setLayout(new BorderLayout());
-    //table_title_pane.setLayout(new GridLayout(1,2,5,0));
     table_title_pane.add(table_label, BorderLayout.CENTER);
 
@@ -645 +622 @@
         }
         else {
-        // Can append or replace
-        add.setEnabled(true);
-        update.setEnabled(true);
+        // Can append or replace, if something has been entered
+        add.setEnabled((tree.getSelectedValue().length() > 0));
+        update.setEnabled((tree.getSelectedValue().length() > 0));
         }
 
@@ -976 +953 @@
 
     /**
-     * @author John Thompson, Greenstone Digital Library, University of Waikato
-     * @version 2.2
+     * This class is a little bit complex, a little bit subtle, and a little bit odd.
+     * The strange interaction model is due to the fact that it is very tightly
+     * coupled to the MetaEditPane.
+     *
+     * The interaction is complex because there are three separate controls that the
+     * user may interact with, each of which can affect the other two. The three
+     * controls are:
+     *   - The "assigned metadata" table, at the top right of the meta edit pane.
+     *   - The "metadata value" text field, where users can type in new values.
+     *   - The "metadata value tree", which shows other values that have been
+     *     assigned to the selected metadata element.
+     *
+     * The interactions are:
+     *   - The "assigned metadata" table
+     *     Users may select one (and only one) row in this table. Selecting a row
+     *     chooses one metadata element. The text field will be set to the current
+     *     value of the metadata element. This value will also be selected in the
+     *     metadata value tree.
+     *
+     *   - The "metadata value" text field
+     *     If the value the user has typed in this is a prefix of an entry in the
+     *     value tree, this value will be selected in the value tree. In this case,
+     *     pressing "Enter" will complete the value (ie. make the value in the text
+     *     field the same as the value in the tree). This is to allow users to
+     *     quickly and easily assign existing metadata values to new documents.
+     *
+     *   - The "metadata value tree"
+     *     Selecting a value in the tree will set the text field to this value.
      */
     private class GValueTree
@@ -992 +995 @@
     private JTextField value;
     private JTree tree;
-    private MetaEditPane metaedit;
-    private String args[] = new String[1];
     /** Stock standard size for labels. */
     final private Dimension VALUE_LABEL_SIZE = new Dimension(66, 26);
@@ -1001 +1002 @@
 
 
-    /**
-     * This class is a little bit complex, a little bit subtle, and a little bit odd.
-     * The strange interaction model is due to the fact that it is very tightly
-     * coupled to the MetaEditPane.
-     *
-     * The interaction is complex because there are three separate controls that the
-     * user may interact with, each of which can affect the other two. The three
-     * controls are:
-     *   - The "assigned metadata" table, at the top right of the meta edit pane.
-     *   - The "metadata value" text field, where users can type in new values.
-     *   - The "metadata value tree", which shows other values that have been
-     *     assigned to the selected metadata element.
-     *
-     * The interactions are:
-     *   - The "assigned metadata" table
-     *     Users may select one (and only one) row in this table. Selecting a row
-     *     chooses one metadata element. The text field will be set to the current
-     *     value of the metadata element. This value will also be selected in the
-     *     metadata value tree.
-     *
-     *   - The "metadata value" text field
-     *     If the value the user has typed in this is a prefix of an entry in the
-     *     value tree, this value will be selected in the value tree. In this case,
-     *     pressing "Enter" will complete the value (ie. make the value in the text
-     *     field the same as the value in the tree). This is to allow users to
-     *     quickly and easily assign existing metadata values to new documents.
-     *
-     *   - The "metadata value tree"
-     *     Selecting a value in the tree will set the text field to this value.
-     */
-    public GValueTree(MetaEditPane metaedit, int width, int height) {
+    public GValueTree(int width, int height) {
         super();
-
-        this.metaedit = metaedit;
 
         setFont(Gatherer.config.getFont("general.font", false));
@@ -1051 +1020 @@
         value.setPreferredSize(new Dimension(413, 24));
         value.getDocument().addDocumentListener(new DocumentListenerImpl());
-        value.addActionListener(new MetadataFieldListener());
+        value.addKeyListener(new MetadataFieldListener());
+        value.setFocusTraversalKeysEnabled(false);
 
         JPanel button_pane = new JPanel();
@@ -1158 +1128 @@
 
         // Special case the extracted metadata set
-        if (selected_metadata_element.getNamespace().equals("")) {
+        if (selected_metadata_element.getNamespace().equals(Utility.EXTRACTED_METADATA_NAMESPACE)) {
         // Display the panel showing the "you cannot edit this metadata" message
+        String[] args = new String[1];
         args[0] = selected_metadata_element.toString();
         extracted_message.setText(get("AutoMessage", args));
@@ -1207 +1178 @@
         key = "MetaEdit." + key;
         }
-        return Gatherer.dictionary.get(key,args);
+        return Gatherer.dictionary.get(key, args);
     }
 
@@ -1272 +1243 @@
 
     private class MetadataFieldListener
-        implements ActionListener {
-        /** Gives notification of the Enter key being pressed on the text field */
-        public void actionPerformed(ActionEvent e) {
-        if (tree.getSelectionCount() != 0 && !value.getText().equals("")) {
-            TreePath path = tree.getSelectionPath();
-            GValueNode node = (GValueNode) path.getLastPathComponent();
-            value.setText(Utility.stripNL(node.getFullPath()));
+        implements KeyListener {
+
+        /** Gives notification of key events on the text field */
+        public void keyPressed(KeyEvent e) {
+        if (e.getKeyCode() == KeyEvent.VK_TAB) {
+            // Tab: Auto-complete
+            if (tree.getSelectionCount() != 0 && !value.getText().equals("")) {
+            TreePath path = tree.getSelectionPath();
+            GValueNode node = (GValueNode) path.getLastPathComponent();
+            value.setText(Utility.stripNL(node.getFullPath()));
+            }
         }
-        }
+        if (e.getKeyCode() == KeyEvent.VK_ENTER) {
+            // Enter: Append the metadata value, if we're allowed to
+            if (add.isEnabled()) {
+            add.doClick();
+            }
+        }           
+        }
+
+        public void keyReleased(KeyEvent e) { }
+
+        public void keyTyped(KeyEvent e) { }
     }
 
@@ -1286 +1271 @@
     private class DocumentListenerImpl
         implements DocumentListener {
-        /** Gives notification that an attribute or set of attributes changed. */
+        /** Gives notification that an attribute or set of attributes changed */
         public void changedUpdate(DocumentEvent e) {
         validate();
         }
 
-        /** Gives notification that there was an insert into the document. */
+        /** Gives notification that there was an insert into the document */
         public void insertUpdate(DocumentEvent e) {
         validate();
         }
 
-        /** Gives notification that a portion of the document has been removed. */
+        /** Gives notification that a portion of the document has been removed */
         public void removeUpdate(DocumentEvent e) {
         validate();
@@ -1302 +1287 @@
 
 
-        /** Ensures that the value text field and value tree are synchronized. */
+        /** Ensures that the value text field and value tree are synchronized */
         private void validate()
         {
@@ -1329 +1314 @@
 
             // Update the status of the buttons
-            metaedit.validateControls();
+            validateControls();
         }
         }