001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.util.swing;
038:
039: import javax.swing.*;
040: import java.awt.event.*;
041: import java.beans.*;
042: import java.util.HashMap;
043: import java.util.ListIterator;
044: import java.util.LinkedList;
045:
046: public class DelegatingAction implements Action {
047: /**
048: * These keys will be copied from the delegatee. All other keys are held in this action itself.
049: */
050: private static final String[] KEYS_TO_DELEGATE = {
051: //DEFAULT,
052: NAME,
053: //SHORT_DESCRIPTION,
054: //LONG_DESCRIPTION,
055: //SMALL_ICON,
056: //ACTION_COMMAND_KEY,
057: //ACCELERATOR_KEY,
058: //MNEMONIC_KEY,
059: };
060:
061: /** Can't use a more specific type parameter because of Action interface. */
062: private HashMap<String, Object> _localProperties = new HashMap<String, Object>();
063:
064: /** The action to delegate to. If it's null, this action is disabled and all method calls will result in
065: * IllegalStateExceptions.
066: */
067: private Action _delegatee;
068: private final LinkedList<PropertyChangeListener> _listenerList = new LinkedList<PropertyChangeListener>();
069:
070: /**
071: * Returns value of the key, from delegatee is it's in {@link #KEYS_TO_DELEGATE}
072: * or from this if not.
073: */
074: public Object getValue(String key) {
075: _checkState();
076:
077: if (_isDelegatedKey(key)) {
078: return _delegatee.getValue(key);
079: } else {
080: return _localProperties.get(key);
081: }
082: }
083:
084: private boolean _isDelegatedKey(String key) {
085: for (int i = 0; i < KEYS_TO_DELEGATE.length; i++) {
086: if (KEYS_TO_DELEGATE[i].equals(key))
087: return true;
088: }
089: return false;
090: }
091:
092: public void putValue(String key, Object value) {
093: _checkState();
094:
095: if (_isDelegatedKey(key)) {
096: _delegatee.putValue(key, value);
097: } else {
098: Object old = _localProperties.get(key);
099: _localProperties.put(key, value);
100: ListIterator itor = _listenerList.listIterator();
101:
102: PropertyChangeEvent event = new PropertyChangeEvent(this ,
103: key, old, value);
104:
105: while (itor.hasNext()) {
106: PropertyChangeListener listener = (PropertyChangeListener) itor
107: .next();
108: listener.propertyChange(event);
109: }
110: }
111: }
112:
113: public void setEnabled(boolean b) {
114: _checkState();
115: _delegatee.setEnabled(b);
116: }
117:
118: public boolean isEnabled() {
119: _checkState();
120: return _delegatee.isEnabled();
121: }
122:
123: public void addPropertyChangeListener(
124: PropertyChangeListener listener) {
125: _checkState();
126: _delegatee.addPropertyChangeListener(listener);
127: _listenerList.add(listener);
128: }
129:
130: public void removePropertyChangeListener(
131: PropertyChangeListener listener) {
132: _checkState();
133: _delegatee.removePropertyChangeListener(listener);
134: _listenerList.remove(listener);
135: }
136:
137: public void actionPerformed(ActionEvent ae) {
138: _checkState();
139: _delegatee.actionPerformed(ae);
140: }
141:
142: public void setDelegatee(final Action newDelegatee) {
143: if (newDelegatee == null) {
144: throw new IllegalArgumentException(
145: "setDelegatee(null) is not allowed!");
146: }
147:
148: // create property change notifications
149: Boolean isEnabled = newDelegatee.isEnabled() ? Boolean.TRUE
150: : Boolean.FALSE;
151:
152: PropertyChangeEvent enabledEvent = new PropertyChangeEvent(
153: newDelegatee, "enabled", Boolean.FALSE, isEnabled);
154:
155: PropertyChangeEvent[] events = null;
156:
157: if (_delegatee != null) {
158: events = new PropertyChangeEvent[KEYS_TO_DELEGATE.length];
159:
160: for (int i = 0; i < KEYS_TO_DELEGATE.length; i++) {
161: Object oldValue = _delegatee
162: .getValue(KEYS_TO_DELEGATE[i]);
163: Object newValue = newDelegatee
164: .getValue(KEYS_TO_DELEGATE[i]);
165:
166: events[i] = new PropertyChangeEvent(newDelegatee,
167: KEYS_TO_DELEGATE[i], oldValue, newValue);
168: }
169: }
170:
171: // remove listeners from old and add to new
172: ListIterator itor = _listenerList.listIterator();
173: while (itor.hasNext()) {
174: PropertyChangeListener listener = (PropertyChangeListener) itor
175: .next();
176:
177: if (_delegatee != null) {
178: _delegatee.removePropertyChangeListener(listener);
179: }
180:
181: newDelegatee.addPropertyChangeListener(listener);
182:
183: // fire property change events for all properties
184:
185: if (events != null) {
186: for (int i = 0; i < events.length; i++) {
187: listener.propertyChange(events[i]);
188: }
189: }
190:
191: listener.propertyChange(enabledEvent);
192: }
193:
194: _delegatee = newDelegatee;
195: }
196:
197: private void _checkState() {
198: if (_delegatee == null) {
199: throw new IllegalStateException("delegatee is null!");
200: }
201: }
202: }
|