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-2007 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.modules.xml.xam.ui.highlight;
043:
044: import java.util.ArrayList;
045: import java.util.HashMap;
046: import java.util.Iterator;
047: import java.util.LinkedList;
048: import java.util.List;
049: import java.util.Map;
050: import java.util.Set;
051: import java.util.WeakHashMap;
052: import org.netbeans.modules.xml.xam.Component;
053: import org.openide.util.WeakListeners;
054:
055: /**
056: * Manages the active set of HighlightGroup instances, as well as the
057: * Highlighted implementations that interpret the active highlights.
058: *
059: * @author Nathan Fiedler
060: */
061: public abstract class HighlightManager {
062: /** Default global highlight manager instance. */
063: private static final HighlightManager defaultInstance;
064: /** Registered (weak) highlight listeners. */
065: private List<Highlighted> listeners;
066: /** Registered highlight groups. */
067: private List<HighlightGroup> groups;
068: /** Map of components to the listeners interested in them. */
069: private Map<Component, List<Highlighted>> componentListenerMap;
070:
071: static {
072: defaultInstance = new DefaultHighlightManager();
073: }
074:
075: /**
076: * Creates a new instance of HighlightManager.
077: */
078: public HighlightManager() {
079: listeners = new ArrayList<Highlighted>();
080: groups = new ArrayList<HighlightGroup>();
081: componentListenerMap = new WeakHashMap<Component, List<Highlighted>>();
082: }
083:
084: /**
085: * Adds the given HighlightGroup to this manager.
086: *
087: * @param group HighlightGroup to be added.
088: */
089: public void addHighlightGroup(HighlightGroup group) {
090: synchronized (groups) {
091: groups.add(group);
092: }
093: showHighlights(group);
094: }
095:
096: /**
097: * Adds the given Highlighted to this manager. The listener will
098: * be weakly referenced to allow it to be garbage collected.
099: *
100: * @param l Highlighted to be added.
101: */
102: public void addHighlighted(Highlighted l) {
103: Highlighted wl = (Highlighted) WeakListeners.create(
104: Highlighted.class, l, this );
105: synchronized (listeners) {
106: listeners.add(wl);
107: }
108: synchronized (componentListenerMap) {
109: Set<Component> comps = wl.getComponents();
110: if (comps != null) {
111: for (Component comp : comps) {
112: List<Highlighted> list = componentListenerMap
113: .get(comp);
114: if (list == null) {
115: list = new LinkedList<Highlighted>();
116: componentListenerMap.put(comp, list);
117: }
118: list.add(wl);
119: }
120: }
121: }
122: highlight(l);
123: }
124:
125: /**
126: * Locate the highlight listeners that are affected by the given group
127: * of highlights.
128: *
129: * @param group highlight group.
130: * @return highlight listeners and the highlights they care about.
131: */
132: protected Map<Highlighted, List<Highlight>> findListeners(
133: HighlightGroup group) {
134: Map<Highlighted, List<Highlight>> map = new HashMap<Highlighted, List<Highlight>>();
135: synchronized (componentListenerMap) {
136: Iterator<Highlight> iter = group.highlights().iterator();
137: while (iter.hasNext()) {
138: Highlight h = iter.next();
139: Component comp = h.getComponent();
140: List<Highlighted> list = componentListenerMap.get(comp);
141: if (list != null) {
142: for (Highlighted l : list) {
143: List<Highlight> lights = map.get(l);
144: if (lights == null) {
145: lights = new ArrayList<Highlight>();
146: map.put(l, lights);
147: }
148: lights.add(h);
149: }
150: }
151: }
152: }
153: return map;
154: }
155:
156: /**
157: * Returns the global instance of a HighlightManager.
158: *
159: * @return global highlight manager instance.
160: */
161: public static HighlightManager getDefault() {
162: return defaultInstance;
163: }
164:
165: /**
166: * Retrieves the highlight groups of the given type, if any.
167: *
168: * @return highlight groups matching type (empty if none).
169: */
170: public List<HighlightGroup> getHighlightGroups(String type) {
171: List<HighlightGroup> list = new ArrayList<HighlightGroup>();
172: synchronized (groups) {
173: if (groups.size() > 0) {
174: for (HighlightGroup group : groups) {
175: if (group.getType().equals(type)) {
176: list.add(group);
177: }
178: }
179: }
180: }
181: return list;
182: }
183:
184: /**
185: * Deactivate all of the Highlight instances in the group.
186: *
187: * @param group HighlightGroup to be hidden.
188: */
189: protected abstract void hideHighlights(HighlightGroup group);
190:
191: /**
192: * Determines if any of the existing highlight groups affect the given
193: * listener or not, and if so, show the highlight for that listener.
194: *
195: * @param listener listener which needs highlighting.
196: */
197: protected void highlight(Highlighted listener) {
198: Set<Component> comps = listener.getComponents();
199: if (comps != null && !comps.isEmpty()) {
200: synchronized (groups) {
201: for (HighlightGroup group : groups) {
202: if (group.isShowing()) {
203: Iterator<Highlight> iter = group.highlights()
204: .iterator();
205: while (iter.hasNext()) {
206: Highlight h = iter.next();
207: Component comp = h.getComponent();
208: if (comps.contains(comp)) {
209: listener.highlightAdded(h);
210: }
211: }
212: }
213: }
214: }
215: }
216: }
217:
218: /**
219: * Removes the given HighlightGroup from this manager.
220: *
221: * @param group HighlightGroup to be removed.
222: */
223: public void removeHighlightGroup(HighlightGroup group) {
224: hideHighlights(group);
225: synchronized (groups) {
226: groups.remove(group);
227: }
228: }
229:
230: /**
231: * Removes the given Highlighted from this manager. This should only
232: * be called by the NetBeans WeakListeners class, which is used to
233: * wrap the original listener in <code>addHighlighted()</code>.
234: * That is, the listener will be automatically removed when it is no
235: * longer needed.
236: *
237: * @param l Highlighted to be removed.
238: */
239: public void removeHighlighted(Highlighted l) {
240: // Counting on weak listener to delegate equals() to actual listener.
241: synchronized (listeners) {
242: listeners.remove(l);
243: }
244: synchronized (componentListenerMap) {
245: Set<Component> comps = l.getComponents();
246: if (comps != null) {
247: for (Component comp : comps) {
248: List<Highlighted> list = componentListenerMap
249: .get(comp);
250: if (list != null) {
251: list.remove(l);
252: }
253: }
254: }
255: }
256: }
257:
258: /**
259: * Activate all of the Highlight instances in the group.
260: *
261: * @param group HighlightGroup to be shown.
262: */
263: protected abstract void showHighlights(HighlightGroup group);
264: }
|