001/* ComponentInputMap.java -- 002 Copyright (C) 2002, 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.swing; 039 040 041/** 042 * An {@link InputMap} that is associated with a particular {@link JComponent}. 043 * The component is notified when its <code>ComponentInputMap</code> changes. 044 * 045 * @author Andrew Selkirk 046 * @author Michael Koch 047 */ 048public class ComponentInputMap extends InputMap 049{ 050 /** 051 * The component to notify. 052 */ 053 private JComponent component; 054 055 /** 056 * Creates <code>ComponentInputMap</code> object that notifies the given 057 * component about changes to it. 058 * 059 * @param comp the component to notify 060 * 061 * @exception IllegalArgumentException if comp is null 062 */ 063 public ComponentInputMap(JComponent comp) 064 { 065 if (comp == null) 066 throw new IllegalArgumentException(); 067 068 this.component = comp; 069 } 070 071 /** 072 * Puts a new entry into the <code>InputMap</code>. 073 * If actionMapKey is null an existing entry will be removed. 074 * 075 * @param keystroke the keystroke for the entry 076 * @param value the action. 077 */ 078 public void put(KeyStroke keystroke, Object value) 079 { 080 super.put(keystroke, value); 081 if (component != null) 082 component.updateComponentInputMap(this); 083 } 084 085 /** 086 * Clears the <code>InputMap</code>. 087 */ 088 public void clear() 089 { 090 super.clear(); 091 if (component != null) 092 component.updateComponentInputMap(this); 093 } 094 095 /** 096 * Remove an entry from the <code>InputMap</code>. 097 * 098 * @param keystroke the key of the entry to remove 099 */ 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}