old-autovect-branch/libjava/classpath/javax/swing/ComponentInputMap.java

   1 /* ComponentInputMap.java --
   2    Copyright (C) 2002, 2004  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.swing;
  39
  40
  41 /**
  42  * An {@link InputMap} that is associated with a particular {@link JComponent}.
  43  * The component is notified when its <code>ComponentInputMap</code> changes.
  44  *
  45  * @author Andrew Selkirk
  46  * @author Michael Koch
  47  */
  48 public class ComponentInputMap extends InputMap
  49 {
  50   /**
  51    * The component to notify.
  52    */
  53   private JComponent component;
  54
  55   /**
  56    * Creates <code>ComponentInputMap</code> object that notifies the given
  57    * component about changes to it.
  58    *
  59    * @param comp the component to notify
  60    *
  61    * @exception IllegalArgumentException if comp is null
  62    */
  63   public ComponentInputMap(JComponent comp)
  64   {
  65     if (comp == null)
  66       throw new IllegalArgumentException();
  67
  68     this.component = comp;
  69   }
  70
  71   /**
  72    * Puts a new entry into the <code>InputMap</code>.
  73    * If actionMapKey is null an existing entry will be removed.
  74    *
  75    * @param keystroke the keystroke for the entry
  76    * @param value the action.
  77    */
  78   public void put(KeyStroke keystroke, Object value)
  79   {
  80     super.put(keystroke, value);
  81     if (component != null)
  82       component.updateComponentInputMap(this);
  83   }
  84
  85   /**
  86    * Clears the <code>InputMap</code>.
  87    */
  88   public void clear()
  89   {
  90     super.clear();
  91     if (component != null)
  92       component.updateComponentInputMap(this);
  93   }
  94
  95   /**
  96    * Remove an entry from the <code>InputMap</code>.
  97    *
  98    * @param keystroke the key of the entry to remove
  99    */
 100   public void remove(KeyStroke keystroke)
 101   {
 102     super.remove(keystroke);
 103     if (component != null)
 104       component.updateComponentInputMap(this);
 105   }
 106
 107   /**
 108    * Sets a parent for this <code>ComponentInputMap</code>.
 109    *
 110    * @param parentMap the new parent
 111    *
 112    * @exception IllegalArgumentException if parentMap is not a
 113    * <code>ComponentInputMap</code> or not associated with the same component
 114    */
 115   public void setParent(InputMap parentMap)
 116   {
 117     if (parentMap != null && !(parentMap instanceof ComponentInputMap))
 118       throw new IllegalArgumentException("ComponentInputMaps can only have " +
 119                                          "ComponentInputMaps for parents");
 120
 121     if (parentMap != null &&
 122         ((ComponentInputMap) parentMap).getComponent() != component)
 123       throw new
 124         IllegalArgumentException("ComponentInputMaps' parents must " +
 125                                  "be associated with the same JComponents");
 126
 127     super.setParent(parentMap);
 128     if (component != null)
 129       component.updateComponentInputMap(this);
 130   }
 131
 132   /**
 133    * Returns the component to notify about changes.
 134    *
 135    * @return a <code>JComponent</code> object
 136    */
 137   public JComponent getComponent()
 138   {
 139     return component;
 140   }
 141 }