aboutsummaryrefslogtreecommitdiff
path: root/libjava/javax/swing/undo/CompoundEdit.java
blob: 37a7c4ca4eb3b1ccd99e44c4e898726ad3215afc (plain)
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/* AbstractTableModel.java --
   Copyright (C) 2002 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.swing.undo;

// Imports
import java.util.Vector;

/**
 * CompoundEdit
 * @author Andrew Selkirk
 */
public class CompoundEdit extends AbstractUndoableEdit {

	//-------------------------------------------------------------
	// Variables --------------------------------------------------
	//-------------------------------------------------------------

	/**
	 * The collection of UndoableEdits undone/redone en
	 * masse by this CompoundEdit
	 */
	protected	Vector	edits		= new Vector();

	/**
	 * TODO
	 */
	private		boolean	inProgress	= false;


	//-------------------------------------------------------------
	// Initialization ---------------------------------------------
	//-------------------------------------------------------------

	/**
	 * Create new Compound Edit
	 */
	public CompoundEdit() {
	} // CompoundEdit()


	//-------------------------------------------------------------
	// Interface: UndoableEdit ------------------------------------
	//-------------------------------------------------------------

	/**
	 * addEdit
	 * @param anEdit TODO
	 * @returns TODO
	 */
	public boolean addEdit(UndoableEdit anEdit) {

		// Variables
		UndoableEdit	lastEdit;

		if (inProgress == true) {

			// Get Last Edit
			lastEdit = lastEdit();

			// Check for null
			if (lastEdit != null) {

				if (lastEdit.addEdit(anEdit) == false) {
					if (lastEdit.replaceEdit(anEdit) == false) {
						edits.add(anEdit);
					}
				}

			} // if: lastEdit

			return true;

		} else {
			return false;
		}
	} // addEdit()

	/**
	 * canRedo
	 * @returns TODO
	 */
	public boolean canRedo() {
		if (isInProgress() == true || super.canRedo() == false) {
			return false;
		}
		return true;
	} // canRedo()

	/**
	 * canUndo
	 * @returns TODO
	 */
	public boolean canUndo() {
		if (isInProgress() == true || super.canUndo() == false) {
			return false;
		}
		return true;
	} // canUndo()

	/**
	 * die
	 */
	public void die() {

		// Variables
		int				index;
		UndoableEdit	current;

		// Loop through all contained UndoableEdits
		for (index = edits.size() - 1; index >= 0; index--) {
			current = (UndoableEdit) edits.elementAt(index);
			current.die();
		} // for: index

	} // die()

	/**
	 * end
	 */
	public void end() {
		inProgress = false;
	} // end()

	/**
	 * getPresentationName
	 * @returns TODO
	 */
	public String getPresentationName() {
		if (edits.size() == 0) {
			return super.getPresentationName();
		} else {
			return lastEdit().getPresentationName();
		}
	} // getPresentationName()

	/**
	 * getRedoPresentationName
	 * @returns TODO
	 */
	public String getRedoPresentationName()	{
		if (edits.size() == 0) {
			return super.getRedoPresentationName();
		} else {
			return lastEdit().getRedoPresentationName();
		}
	} // getRedoPresentationName()

	/**
	 * getUndoPresentationName
	 * @returns TODO
	 */
	public String getUndoPresentationName()	{
		if (edits.size() == 0) {
			return super.getUndoPresentationName();
		} else {
			return lastEdit().getUndoPresentationName();
		}
	} // getUndoPresentationName()

	/**
	 * isInProgress
	 * @returns TODO
	 */
	public boolean isInProgress() {
		return inProgress;
	} // isInProgress()


	/**
	 * isSignigicant
	 * @returns TODO
	 */
	public boolean isSignificant() {

		// Variables
		int				index;
		UndoableEdit	current;

		// Check each edit
		for (index = 0; index < edits.size(); index++) {
			current = (UndoableEdit) edits.elementAt(index);
			if (current.isSignificant() == true) {
				return true;
			}
		} // for: index

		return false;

	} // isSignificant()

	/**
	 * lastEdit
	 * @returns TODO
	 */
	protected UndoableEdit lastEdit() {
		if (edits.size() == 0) {
			return null;
		}
		return (UndoableEdit) edits.elementAt(edits.size() - 1);
	} // lastEdit()

	/**
	 * redo
	 * @throws CannotRedoException TODO
	 */
	public void redo() throws CannotRedoException {

		// Variables
		int				index;
		UndoableEdit	current;

		// Loop through all contained UndoableEdits
		for (index = 0; index < edits.size(); index++) {
			current = (UndoableEdit) edits.elementAt(index);
			current.redo();
		} // for: index

	} // redo()

	/**
	 * String representation
	 * @returns String representation
	 */
	public String toString() {
		return null; // TODO
	} // toString()

	/**
	 * undo
	 * @throws CannotUndoException TODO
	 */
	public void undo() throws CannotUndoException {

		// Variables
		int				index;
		UndoableEdit	current;

		// Loop through all contained UndoableEdits
		for (index = edits.size() - 1; index >= 0; index--) {
			current = (UndoableEdit) edits.elementAt(index);
			current.undo();
		} // for: index

	} // undo()


} // CompoundEdit