001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.debugger;
043:
044: import java.util.HashSet;
045: import java.util.Vector;
046:
047: /**
048: * Support for {@link ActionsProvider} implementation. You should implement
049: * {@link #doAction} and {@link #getActions} only, and call {@link #setEnabled}
050: * when the action state is changed.
051: *
052: * @author Jan Jancura
053: */
054: public abstract class ActionsProviderSupport extends ActionsProvider {
055:
056: private HashSet enabled = new HashSet();
057: private Vector listeners = new Vector();
058:
059: /**
060: * Called when the action is called (action button is pressed).
061: *
062: * @param action an action which has been called
063: */
064: public abstract void doAction(Object action);
065:
066: /**
067: * Returns a state of given action defined by {@link #setEnabled}
068: * method call.
069: *
070: * Do not override. Should be final - the enabled state is cached,
071: * therefore this method is not consulted unless the state change
072: * is fired.
073: *
074: * @param action action
075: */
076: public boolean isEnabled(Object action) {
077: return enabled.contains(action);
078: }
079:
080: /**
081: * Sets state of enabled property.
082: *
083: * @param action action whose state should be changed
084: * @param enabled the new state
085: */
086: protected final void setEnabled(Object action, boolean enabled) {
087: boolean fire = false;
088: if (enabled)
089: fire = this .enabled.add(action);
090: else
091: fire = this .enabled.remove(action);
092: if (fire)
093: fireActionStateChanged(action, enabled);
094: }
095:
096: /**
097: * Fires a change of action state.
098: *
099: * @param action action whose state has been changed
100: * @param enabled the new state
101: */
102: protected void fireActionStateChanged(Object action, boolean enabled) {
103: Vector v = (Vector) listeners.clone();
104: int i, k = v.size();
105: for (i = 0; i < k; i++)
106: ((ActionsProviderListener) v.elementAt(i))
107: .actionStateChange(action, enabled);
108: }
109:
110: /**
111: * Adds property change listener.
112: *
113: * @param l new listener.
114: */
115: public final void addActionsProviderListener(
116: ActionsProviderListener l) {
117: listeners.addElement(l);
118: }
119:
120: /**
121: * Removes property change listener.
122: *
123: * @param l removed listener.
124: */
125: public final void removeActionsProviderListener(
126: ActionsProviderListener l) {
127: listeners.removeElement(l);
128: }
129: }
|