Source for javax.swing.ComponentInputMap

   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:  * @author Andrew Selkirk
  43:  * @author Michael Koch
  44:  */
  45: public class ComponentInputMap extends InputMap
  46: {
  47:   /**
  48:    * The component to notify.
  49:    */
  50:   private JComponent component;
  51: 
  52:   /**
  53:    * Creates <code>ComponentInputMap</code> object that notifies the given
  54:    * component about changes to it.
  55:    *
  56:    * @param comp the component to notify
  57:    *
  58:    * @exception IllegalArgumentException if comp is null
  59:    */
  60:   public ComponentInputMap(JComponent comp)
  61:   {
  62:     if (comp == null)
  63:       throw new IllegalArgumentException();
  64:     
  65:     this.component = comp;
  66:   }
  67: 
  68:   /**
  69:    * Puts a new entry into the <code>InputMap</code>.
  70:    * If actionMapKey is null an existing entry will be removed.
  71:    *
  72:    * @param keystroke the keystroke for the entry
  73:    * @param actionMapKey the action.
  74:    */
  75:   public void put(KeyStroke keystroke, Object value)
  76:   {
  77:     super.put(keystroke, value);
  78:     // FIXME: Notify component.
  79:   }
  80: 
  81:   /**
  82:    * Clears the <code>InputMap</code>.
  83:    */
  84:   public void clear()
  85:   {
  86:     super.clear();
  87:     // FIXME: Notify component.
  88:   }
  89: 
  90:   /**
  91:    * Remove an entry from the <code>InputMap</code>.
  92:    *
  93:    * @param key the key of the entry to remove
  94:    */
  95:   public void remove(KeyStroke keystroke)
  96:   {
  97:     super.remove(keystroke);
  98:     // FIXME: Notify component.
  99:   }
 100: 
 101:   /**
 102:    * Sets a parent for this <code>ComponentInputMap</code>.
 103:    *
 104:    * @param parentMap the new parent
 105:    *
 106:    * @exception IllegalArgument if parentMap is not a
 107:    * <code>ComponentInputMap</code> or not associated with the same component
 108:    */
 109:   public void setParent(InputMap parentMap)
 110:   {
 111:     if (! (parentMap instanceof ComponentInputMap))
 112:       throw new IllegalArgumentException();
 113: 
 114:     if (((ComponentInputMap) parentMap).getComponent() != component)
 115:       throw new IllegalArgumentException();
 116:    
 117:     super.setParent(parentMap);
 118:     // FIXME: Notify component.
 119:   }
 120: 
 121:   /**
 122:    * Returns the component to notify about changes.
 123:    *
 124:    * @return a <code>JComponent</code> object
 125:    */
 126:   public JComponent getComponent()
 127:   {
 128:     return component;
 129:   }
 130: }