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: package org.netbeans.modules.vmd.api.model.common;
042:
043: import org.netbeans.modules.vmd.api.model.*;
044: import org.openide.util.WeakSet;
045:
046: import java.util.Collection;
047: import java.util.Collections;
048:
049: /**
050: * This class allows to register a listener on active document and components in whole environment.
051: * Usually used by active-document-aware components like inspector, palette, ...
052: *
053: * @author David Kaspar
054: */
055: public final class ActiveDocumentSupport {
056:
057: private static final DesignEventFilter FILTER_SELECTION = new DesignEventFilter()
058: .setSelection(true);
059:
060: private static final ActiveDocumentSupport support = new ActiveDocumentSupport();
061:
062: private final WeakSet<Listener> listeners = new WeakSet<Listener>();
063:
064: private DesignDocument activeDocument = null;
065: private DesignListener selectionListener = null;
066: private Collection<DesignComponent> activeComponents = Collections
067: .emptySet(); // WARNING - possible memory leak
068:
069: private ActiveDocumentSupport() {
070: }
071:
072: /**
073: * Returns a default instance of the ActiveViewSupport.
074: * @return the default ActiveViewSupport
075: */
076: public static ActiveDocumentSupport getDefault() {
077: return support;
078: }
079:
080: /**
081: * Registers an active-document listener.
082: * @param listener the listener
083: */
084: public void addActiveDocumentListener(Listener listener) {
085: synchronized (listeners) {
086: listeners.add(listener);
087: }
088: }
089:
090: /**
091: * Unregisters an active-document listener.
092: * @param listener the listener
093: */
094: public void removeActiveDocumentListener(Listener listener) {
095: synchronized (listeners) {
096: listeners.remove(listener);
097: }
098: }
099:
100: /**
101: * Returns an active document in whole environment.
102: * @return the active document
103: */
104: public DesignDocument getActiveDocument() {
105: return activeDocument;
106: }
107:
108: /**
109: * returns active components in whole environment.
110: * @return the active components
111: */
112: public Collection<DesignComponent> getActiveComponents() {
113: return activeComponents;
114: }
115:
116: private void fireActiveDocumentChanged(
117: DesignDocument deactivatedDocument,
118: final DesignDocument activatedDocument) {
119: Listener[] Listeners;
120: synchronized (listeners) {
121: Listeners = listeners
122: .toArray(new Listener[listeners.size()]);
123: }
124: for (Listener listener : Listeners) {
125: if (listener != null)
126: listener.activeDocumentChanged(deactivatedDocument,
127: activatedDocument);
128: }
129:
130: if (deactivatedDocument != activatedDocument) {
131: if (deactivatedDocument != null) {
132: if (selectionListener == null)
133: Debug
134: .warning("SelectionListener does not exist but it should"); // NOI18N
135: else
136: deactivatedDocument.getListenerManager()
137: .removeDesignListener(selectionListener);
138: }
139: if (activatedDocument != null) {
140: activatedDocument.getTransactionManager().readAccess(
141: new Runnable() {
142: public void run() {
143: activatedDocument
144: .getListenerManager()
145: .addDesignListener(
146: selectionListener = new SelectionDesignListener(
147: activatedDocument),
148: FILTER_SELECTION);
149: fireActiveComponentsChanged(activatedDocument
150: .getSelectedComponents());
151: }
152: });
153: } else {
154: fireActiveComponentsChanged(Collections
155: .<DesignComponent> emptyList());
156: }
157: }
158: }
159:
160: private void fireActiveComponentsChanged(
161: Collection<DesignComponent> activeComponents) {
162: this .activeComponents = activeComponents;
163:
164: Listener[] Listeners;
165: synchronized (listeners) {
166: Listeners = listeners
167: .toArray(new Listener[listeners.size()]);
168: }
169: for (Listener listener : Listeners) {
170: if (listener != null)
171: listener.activeComponentsChanged(activeComponents);
172: }
173: }
174:
175: /**
176: * Sets an active document for whole environment. This method is used from ActiveViewSupport.
177: * Do not call it unless you know what it really does.
178: * @param designDocument the newly active document
179: */
180: public void setActiveDocument(DesignDocument designDocument) {
181: if (activeDocument == designDocument)
182: return;
183: DesignDocument lastDocument = activeDocument;
184: activeDocument = designDocument;
185: fireActiveDocumentChanged(lastDocument, activeDocument);
186: }
187:
188: private class SelectionDesignListener implements DesignListener {
189:
190: private DesignDocument document;
191:
192: public SelectionDesignListener(DesignDocument document) {
193: this .document = document;
194: }
195:
196: public void designChanged(DesignEvent event) {
197: fireActiveComponentsChanged(document
198: .getSelectedComponents());
199: }
200: }
201:
202: /**
203: * Used for notification of an active document in the whole environment.
204: * Usually used by active-document-aware components like inspector, palette, ...
205: * The listener could be registered using ActiveDocumentSupport class.
206: */
207: public interface Listener {
208:
209: /**
210: * Called when a reference to an active document is changed.
211: * Called before activeComponentsChanged method.
212: * @param deactivatedDocument the deactivated document; null if there was no active document before.
213: * @param activatedDocument the activated document; null if there is no active document now.
214: */
215: void activeDocumentChanged(DesignDocument deactivatedDocument,
216: DesignDocument activatedDocument);
217:
218: /**
219: * Called when a collection of active components is changed.
220: * Called after activeDocumentChanged methods.
221: * @param activeComponents the collection of active components
222: */
223: void activeComponentsChanged(
224: Collection<DesignComponent> activeComponents);
225:
226: }
227:
228: }
|