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.api.editor.fold;
043:
044: /**
045: * Event describing the changes done in the hierarchy.
046: * <br>
047: * The structural changes are described by the lists of added and removed folds.
048: * <br>
049: * State changes are described by a list of {@link FoldStateChange}s.
050: * <br>
051: * In addition there is a description of the offset range that was
052: * affected by the change. This is useful for the editor
053: * to recreate the affected views and repaint the affected area.
054: * <p>
055: * Added folds can have either collapsed or expanded initial state.
056: *
057: * @author Miloslav Metelka
058: * @version 1.00
059: */
060:
061: public final class FoldHierarchyEvent extends java.util.EventObject {
062:
063: private Fold[] removedFolds;
064:
065: private Fold[] addedFolds;
066:
067: private FoldStateChange[] foldStateChanges;
068:
069: private int affectedStartOffset;
070:
071: private int affectedEndOffset;
072:
073: /**
074: * Create new FoldHierarchyEvent.
075: * <br>
076: * It's guaranteed that no passed arrays contents will be modified.
077: *
078: * @param source FoldHierarchy for which this event gets created.
079: * @param removedFolds non-null array of removed folds.
080: * @param addedFolds non-null array of added folds.
081: * @param foldStateChanges changes describing changes in the state
082: * of particular folds.
083: * @param affectedStartOffset first offset in the document affected by this change.
084: * @param affectedEndOffset end of the offset area affected by this change.
085: */
086: FoldHierarchyEvent(FoldHierarchy source, Fold[] removedFolds,
087: Fold[] addedFolds, FoldStateChange[] foldStateChanges,
088: int affectedStartOffset, int affectedEndOffset) {
089:
090: super (source);
091:
092: this .removedFolds = removedFolds;
093: this .addedFolds = addedFolds;
094: this .foldStateChanges = foldStateChanges;
095: this .affectedStartOffset = affectedStartOffset;
096: this .affectedEndOffset = affectedEndOffset;
097: }
098:
099: /**
100: * Get the number of folds removed from the hierarchy.
101: *
102: * @return >=0 number of removed folds.
103: */
104: public int getRemovedFoldCount() {
105: return removedFolds.length;
106: }
107:
108: /**
109: * Get the fold with the given index removed
110: * from the fold hierarchy.
111: *
112: * @param removedFoldIndex >=0 and <{@link #getRemovedFoldCount()}
113: * index of the removed fold.
114: */
115: public Fold getRemovedFold(int removedFoldIndex) {
116: return removedFolds[removedFoldIndex];
117: }
118:
119: /**
120: * Get the number of folds that were added to the hierarchy.
121: *
122: * @return >=0 number of added folds.
123: */
124: public int getAddedFoldCount() {
125: return addedFolds.length;
126: }
127:
128: /**
129: * Get the fold with the given index added
130: * to the hierarchy.
131: *
132: * @param addedFoldIndex >=0 and <{@link #getAddedFoldCount()}
133: * index of the added fold.
134: */
135: public Fold getAddedFold(int addedFoldIndex) {
136: return addedFolds[addedFoldIndex];
137: }
138:
139: /**
140: * Get the number of the fold state changes contained in this event.
141: *
142: * @return >=0 number of fold state changes.
143: */
144: public int getFoldStateChangeCount() {
145: return foldStateChanges.length;
146: }
147:
148: /**
149: * Get the fold state change at the given index.
150: *
151: * @param index >=0 and <{@link #getFoldStateChangeCount()}
152: * index of the fold state change.
153: */
154: public FoldStateChange getFoldStateChange(int index) {
155: return foldStateChanges[index];
156: }
157:
158: /**
159: * Get the first offset in the underlying document affected
160: * by this change.
161: *
162: * @return >=0 first offset affected by the change.
163: */
164: public int getAffectedStartOffset() {
165: return affectedStartOffset;
166: }
167:
168: /**
169: * Get the ending offset in the offset area affected
170: * by this change.
171: *
172: * @return >={@link #getAffectedStartOffset()}
173: * end of the offset area affected by the change.
174: */
175: public int getAffectedEndOffset() {
176: return affectedEndOffset;
177: }
178:
179: public String toString() {
180: return org.netbeans.modules.editor.fold.FoldUtilitiesImpl
181: .foldHierarchyEventToString(this);
182: }
183:
184: }
|