Coverage Report

Coverage Report - org.argouml.kernel.UndoManager

Classes in this File

 /* $Id: UndoManager.java 17822 2010-01-12 18:47:46Z linus $
  *****************************************************************************
  * Copyright (c) 2009 Contributors - see below
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *    tfmorris
  *****************************************************************************
  *
  * Some portions of this file was previously release using the BSD License:
  */
 
 // Copyright (c) 2007 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
 // and this paragraph appear in all copies. This software program and
 // documentation are copyrighted by The Regents of the University of
 // California. The software program and documentation are supplied "AS
 // IS", without any accompanying services from The Regents. The Regents
 // does not warrant that the operation of the program will be
 // uninterrupted or error-free. The end-user understands that the program
 // was developed for research purposes and is advised not to rely
 // exclusively on the program for any reason. IN NO EVENT SHALL THE
 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 package org.argouml.kernel;
 
 import java.beans.PropertyChangeListener;
 
 /**
  * Stores Commands that have been executed and allows them to be undone
  * and redone. Commands represent single operations on the ArgoUML model.
  * A single user interaction may generate several Commands. Undo/redo
  * works an a user interaction and so can undo/redo several commands in one
  * call.
  * 
  * @author Bob Tarling
  */
 public interface UndoManager {
 
     /**
      * Adds a new command to the undo stack.
      * @param command the command.
      */
     public abstract void addCommand(Command command);
 
     /**
      * Execute a command and add it to the undo stack.
      * 
      * @param command the command.
      * @return any resulting object the command creates
      */
     public abstract Object execute(Command command);
 
     /**
      * Set the maximum number of interactions the stack can hold.
      * @param max the maximum chain count
      */
     public abstract void setUndoMax(int max);
 
     /**
      * Undo the top user interaction on the undo stack and move
      * it to the redo stack.
      */
     public abstract void undo();
 
     /**
      * Redo the top user interaction on the redo stack and move
      * it to the undo stack.
      */
     public abstract void redo();
 
     /**
      * Instructs the UndoManager that a new user interaction is about to take
      * place. All commands received until the next call to startInteraction will
      * form a single undoable unit.
      * 
      * @param label the label for this interaction to build the undo/redo label
      */
     public abstract void startInteraction(String label);
     
     /**
      * Add a new PropertyChangeListener for undo/redo events. Allow a listener
      * to detect when the undo or redo stack changes availability. No guarantees
      * are made about which thread the event will be delivered on, so any
      * specific thread requirements (e.g. Swing/AWT thread requirements) must be
      * dealt with by the
      * {@link PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)}
      * method.
      * 
      * @param listener a PropertyChangeListener
      */
     public abstract void addPropertyChangeListener(
             PropertyChangeListener listener);
     
     /**
      * Remove the given listener.
      * @param listener a PropertyChangeListener
      */
     public abstract void removePropertyChangeListener(
             PropertyChangeListener listener);
 }

1		/* $Id: UndoManager.java 17822 2010-01-12 18:47:46Z linus $
2		*****************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* tfmorris
11		*****************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 2007 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.kernel;
40
41		import java.beans.PropertyChangeListener;
42
43		/**
44		* Stores Commands that have been executed and allows them to be undone
45		* and redone. Commands represent single operations on the ArgoUML model.
46		* A single user interaction may generate several Commands. Undo/redo
47		* works an a user interaction and so can undo/redo several commands in one
48		* call.
49		*
50		* @author Bob Tarling
51		*/
52		public interface UndoManager {
53
54		/**
55		* Adds a new command to the undo stack.
56		* @param command the command.
57		*/
58		public abstract void addCommand(Command command);
59
60		/**
61		* Execute a command and add it to the undo stack.
62		*
63		* @param command the command.
64		* @return any resulting object the command creates
65		*/
66		public abstract Object execute(Command command);
67
68		/**
69		* Set the maximum number of interactions the stack can hold.
70		* @param max the maximum chain count
71		*/
72		public abstract void setUndoMax(int max);
73
74		/**
75		* Undo the top user interaction on the undo stack and move
76		* it to the redo stack.
77		*/
78		public abstract void undo();
79
80		/**
81		* Redo the top user interaction on the redo stack and move
82		* it to the undo stack.
83		*/
84		public abstract void redo();
85
86		/**
87		* Instructs the UndoManager that a new user interaction is about to take
88		* place. All commands received until the next call to startInteraction will
89		* form a single undoable unit.
90		*
91		* @param label the label for this interaction to build the undo/redo label
92		*/
93		public abstract void startInteraction(String label);
94
95		/**
96		* Add a new PropertyChangeListener for undo/redo events. Allow a listener
97		* to detect when the undo or redo stack changes availability. No guarantees
98		* are made about which thread the event will be delivered on, so any
99		* specific thread requirements (e.g. Swing/AWT thread requirements) must be
100		* dealt with by the
101		* {@link PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)}
102		* method.
103		*
104		* @param listener a PropertyChangeListener
105		*/
106		public abstract void addPropertyChangeListener(
107		PropertyChangeListener listener);
108
109		/**
110		* Remove the given listener.
111		* @param listener a PropertyChangeListener
112		*/
113		public abstract void removePropertyChangeListener(
114		PropertyChangeListener listener);
115		}