1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
/* * @(#)CompoundEdit.java 1.26 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.undo; import java.util.*; /** * A concrete subclass of AbstractUndoableEdit, used to assemble little * UndoableEdits into great big ones. * * @version 1.26 11/17/05 * @author Ray Ryan */ public class CompoundEdit extends AbstractUndoableEdit { /** * True if this edit has never received <code>end</code>. */ boolean inProgress; /** * The collection of <code>UndoableEdit</code>s * undone/redone en masse by this <code>CompoundEdit</code>. */ protected Vector<UndoableEdit> edits; public CompoundEdit() { super(); inProgress = true; edits = new Vector<UndoableEdit>(); } /** * Sends <code>undo</code> to all contained * <code>UndoableEdits</code> in the reverse of * the order in which they were added. */ public void undo() throws CannotUndoException { super.undo(); int i = edits.size(); while (i-- > 0) { UndoableEdit e = (UndoableEdit)edits.elementAt(i); e.undo(); } } /** * Sends <code>redo</code> to all contained * <code>UndoableEdit</code>s in the order in * which they were added. */ public void redo() throws CannotRedoException { super.redo(); Enumeration cursor = edits.elements(); while (cursor.hasMoreElements()) { ((UndoableEdit)cursor.nextElement()).redo(); } } /** * Returns the last <code>UndoableEdit</code> in * <code>edits</code>, or <code>null</code> * if <code>edits</code> is empty. */ protected UndoableEdit lastEdit() { int count = edits.size(); if (count > 0) return (UndoableEdit)edits.elementAt(count-1); else return null; } /** * Sends <code>die</code> to each subedit, * in the reverse of the order that they were added. */ public void die() { int size = edits.size(); for (int i = size-1; i >= 0; i--) { UndoableEdit e = (UndoableEdit)edits.elementAt(i); // System.out.println("CompoundEdit(" + i + "): Discarding " + // e.getUndoPresentationName()); e.die(); } super.die(); } /** * If this edit is <code>inProgress</code>, * accepts <code>anEdit</code> and returns true. * * <p>The last edit added to this <code>CompoundEdit</code> * is given a chance to <code>addEdit(anEdit)</code>. * If it refuses (returns false), <code>anEdit</code> is * given a chance to <code>replaceEdit</code> the last edit. * If <code>anEdit</code> returns false here, * it is added to <code>edits</code>. * * @param anEdit the edit to be added * @return true if the edit is <code>inProgress</code>; * otherwise returns false */ public boolean addEdit(UndoableEdit anEdit) { if (!inProgress) { return false; } else { UndoableEdit last = lastEdit(); // If this is the first subedit received, just add it. // Otherwise, give the last one a chance to absorb the new // one. If it won't, give the new one a chance to absorb // the last one. if (last == null) { edits.addElement(anEdit); } else if (!last.addEdit(anEdit)) { if (anEdit.replaceEdit(last)) { edits.removeElementAt(edits.size()-1); } edits.addElement(anEdit); } return true; } } /** * Sets <code>inProgress</code> to false. * * @see #canUndo * @see #canRedo */ public void end() { inProgress = false; } /** * Returns false if <code>isInProgress</code> or if super * returns false. * * @see #isInProgress */ public boolean canUndo() { return !isInProgress() && super.canUndo(); } /** * Returns false if <code>isInProgress</code> or if super * returns false. * * @see #isInProgress */ public boolean canRedo() { return !isInProgress() && super.canRedo(); } /** * Returns true if this edit is in progress--that is, it has not * received end. This generally means that edits are still being * added to it. * * @see #end */ public boolean isInProgress() { return inProgress; } /** * Returns true if any of the <code>UndoableEdit</code>s * in <code>edits</code> do. * Returns false if they all return false. */ public boolean isSignificant() { Enumeration cursor = edits.elements(); while (cursor.hasMoreElements()) { if (((UndoableEdit)cursor.nextElement()).isSignificant()) { return true; } } return false; } /** * Returns <code>getPresentationName</code> from the * last <code>UndoableEdit</code> added to * <code>edits</code>. If <code>edits</code> is empty, * calls super. */ public String getPresentationName() { UndoableEdit last = lastEdit(); if (last != null) { return last.getPresentationName(); } else { return super.getPresentationName(); } } /** * Returns <code>getUndoPresentationName</code> * from the last <code>UndoableEdit</code> * added to <code>edits</code>. * If <code>edits</code> is empty, calls super. */ public String getUndoPresentationName() { UndoableEdit last = lastEdit(); if (last != null) { return last.getUndoPresentationName(); } else { return super.getUndoPresentationName(); } } /** * Returns <code>getRedoPresentationName</code> * from the last <code>UndoableEdit</code> * added to <code>edits</code>. * If <code>edits</code> is empty, calls super. */ public String getRedoPresentationName() { UndoableEdit last = lastEdit(); if (last != null) { return last.getRedoPresentationName(); } else { return super.getRedoPresentationName(); } } /** * Returns a string that displays and identifies this * object's properties. * * @return a String representation of this object */ public String toString() { return super.toString() + " inProgress: " + inProgress + " edits: " + edits; } }