svn commit: r16995 - trunk/src/argouml-app/src/org/argouml/uml/ui/UMLComboBox2.java

Author: tfmorris
Date: 2009-03-29 12:24:24-0700
New Revision: 16995

Modified:
   trunk/src/argouml-app/src/org/argouml/uml/ui/UMLComboBox2.java

Log:
Issue 2885: Patch from Christian Heinrich (shurakai). Support keyboard selection of UML elements in combo boxes 
http://argouml.tigris.org/issues/show_bug.cgi?id=2885

Modified: trunk/src/argouml-app/src/org/argouml/uml/ui/UMLComboBox2.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/uml/ui/UMLComboBox2.java?view=diff&pathrev=16995&r1=16994&r2=16995
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/uml/ui/UMLComboBox2.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/uml/ui/UMLComboBox2.java	2009-03-29 12:24:24-0700
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 1996-2006 The Regents of the University of California. All
+// Copyright (c) 1996-2009 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
@@ -25,11 +25,13 @@
 package org.argouml.uml.ui;
 
 import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
 
 import javax.swing.Action;
+import javax.swing.ComboBoxModel;
 import javax.swing.JComboBox;
+import javax.swing.ListCellRenderer;
 
-import org.apache.log4j.Logger;
 import org.argouml.ui.LookAndFeelMgr;
 import org.argouml.ui.targetmanager.TargetEvent;
 import org.argouml.ui.targetmanager.TargetListener;
@@ -46,8 +48,13 @@
  */
 public class UMLComboBox2
     extends JComboBox
-    implements TargettableModelView, TargetListener {
-   
+    implements TargettableModelView, TargetListener, 
+        JComboBox.KeySelectionManager {
+
+    private static final int KEY_TIME_THRESHOLD_MILLIS = 1500;
+    private String searchString = "";
+    private long lastKeyEventTime;
+
     /**
      * Constructor for UMLComboBox2.
      * @deprecated As of ArgoUml version unknown (before 0.13.5),
@@ -73,8 +80,10 @@
 			boolean showIcon) {
         super(model);
         setFont(LookAndFeelMgr.getInstance().getStandardFont());
+        lastKeyEventTime = 0;
         addActionListener(action);
         // setDoubleBuffered(true);
+        setKeySelectionManager(this);
         setRenderer(new UMLListCellRenderer2(showIcon));
         addPopupMenuListener(model);
     }
@@ -98,6 +107,61 @@
             doIt(arg0);
         }
     }
+    
+    /**
+     * Implementation of the JComboBox.KeySelectionManager interface. Helps with
+     * navigating through the ComboBox when using the keyboard.
+     * 
+     * @param key The key which has been pressed
+     * @param model Current ComboBoxModel
+     * @return int The index of the item that is to be selected
+     * @see javax.swing.JComboBox.KeySelectionManager#selectionForKey(char, javax.swing.ComboBoxModel)
+     */
+    public int selectionForKey(char key, ComboBoxModel model)
+    {        
+        long now = System.currentTimeMillis();
+        int index = -1;
+        int startAtIndex = 0;
+
+        // Implements backspace functionality
+        if (searchString != null && key == KeyEvent.VK_BACK_SPACE
+                && searchString.length() > 0) {
+            searchString = searchString.substring(0, searchString.length() - 1);
+        }
+        else {
+            if (lastKeyEventTime + KEY_TIME_THRESHOLD_MILLIS < now) {
+                searchString = Character.toString(key);
+            }
+            else {
+                searchString = searchString + key;
+                startAtIndex = getSelectedIndex();
+                if (startAtIndex < 0) {
+                    startAtIndex = 0;
+                }
+            }
+        }
+        
+        String umlElemName = "";
+        String searchStringLowerCase = searchString.toLowerCase();
+        ListCellRenderer cellRenderer = getRenderer();
+        
+        for (int i = startAtIndex, length = model.getSize(); i < length; i++) {
+            Object value = model.getElementAt(i);
+            if (cellRenderer instanceof UMLListCellRenderer2) {
+                umlElemName = 
+                    ((UMLListCellRenderer2) cellRenderer).makeText(value);
+            } else {
+                umlElemName = value.toString();
+            }
+            if (umlElemName.toLowerCase().startsWith(searchStringLowerCase)) {
+                index = i;
+                break;
+            }
+        }
+        lastKeyEventTime = now;
+
+        return index;
+    }
 
     /**
      * The 'body' of the actionPerformed method. Is only called if there is

------------------------------------------------------
http://argouml.tigris.org/ds/viewMessage.do?dsForumId=5905&dsMessageId=1473358

To unsubscribe from this discussion, e-mail: [[email protected]].