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.editor.highlighting.support;
043:
044: import java.util.List;
045: import org.netbeans.lib.editor.util.ListenerList;
046: import org.netbeans.spi.editor.highlighting.HighlightsChangeEvent;
047: import org.netbeans.spi.editor.highlighting.HighlightsChangeListener;
048: import org.netbeans.spi.editor.highlighting.HighlightsContainer;
049: import org.netbeans.spi.editor.highlighting.HighlightsSequence;
050:
051: /**
052: * The default implementation of the <code>HighlightsContainer</code> interface.
053: * It provides standard implementation of the methods for adding and removing
054: * <code>HighlightsChangeListener</code>s and allows subclasses to notify listeners
055: * by calling the <code>fireHighlightsChange</code> method.
056: *
057: * @author Vita Stejskal
058: */
059: public abstract class AbstractHighlightsContainer implements
060: HighlightsContainer {
061:
062: private ListenerList<HighlightsChangeListener> listeners = new ListenerList<HighlightsChangeListener>();
063:
064: /** Creates a new instance of AbstractHighlightsContainer */
065: protected AbstractHighlightsContainer() {
066: }
067:
068: public abstract HighlightsSequence getHighlights(int startOffset,
069: int endOffset);
070:
071: /**
072: * Adds <code>HighlightsChangeListener</code> to this container.
073: *
074: * @param listener The listener to add.
075: */
076: public final void addHighlightsChangeListener(
077: HighlightsChangeListener listener) {
078: synchronized (listeners) {
079: listeners.add(listener);
080: }
081: }
082:
083: /**
084: * Removes <code>HighlightsChangeListener</code> to this container.
085: *
086: * @param listener The listener to remove.
087: */
088: public final void removeHighlightsChangeListener(
089: HighlightsChangeListener listener) {
090: synchronized (listeners) {
091: listeners.remove(listener);
092: }
093: }
094:
095: /**
096: * Notifies all registered listeners about a change in this container. The
097: * area of a document where highlights changed is specified by the
098: * <code>changeStartOffset</code> and <code>changeEndOffset</code> parameters.
099: *
100: * @param changeStartOffset The starting offset of the changed area.
101: * @param changeEndOffset The ending offset of the changed area.
102: */
103: protected final void fireHighlightsChange(int changeStartOffset,
104: int changeEndOffset) {
105: List<HighlightsChangeListener> targets;
106:
107: synchronized (listeners) {
108: targets = listeners.getListeners();
109: }
110:
111: if (targets.size() > 0) {
112: HighlightsChangeEvent evt = new HighlightsChangeEvent(this ,
113: changeStartOffset, changeEndOffset);
114:
115: for (HighlightsChangeListener l : targets) {
116: l.highlightChanged(evt);
117: }
118: }
119: }
120: }
|