1 /**
2 * This file Copyright (c) 2013-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.mediaeditor.data;
35
36 import info.magnolia.ui.api.action.ActionExecutionException;
37
38 import com.vaadin.v7.data.Property;
39
40 /**
41 * Property interface that is capable of tracking data modification and
42 * undo/redo the steps. The original value is buffered and the state can
43 * always be rolled back to it.
44 */
45 public interface EditHistoryTrackingProperty extends Property<byte[]> {
46
47 /**
48 * Listener interface that receives important information
49 * about the property workflow.
50 */
51 interface Listener {
52
53 void errorOccurred(String message, Throwable e);
54 }
55
56 public void setListener(Listener listener);
57
58 /**
59 * Gets the last done action name.
60 * @return last action name.
61 */
62 String getLastDoneActionName();
63
64 /**
65 * Gets the last undone action name.
66 * @return last undone action name.
67 */
68 String getLastUnDoneActionName();
69
70 /**
71 * Clears modification history which erases all the tracked steps.
72 * After this method call it will be impossible to undo/redo operations.
73 */
74 void purgeHistory();
75
76 /**
77 * Sets the amount of steps that can be tracked. When the limit is reached,
78 * the eldest recorded steps are erased.
79 * @param capacity amount of steps to be available for undo/redo.
80 */
81 void setCapacity(int capacity);
82
83 /**
84 * Starts an action which will cause a new record to appear in history.
85 * @param actionName the name of an action.
86 */
87 void startAction(String actionName);
88
89 /**
90 * Undo last step.
91 */
92 void undo() throws ActionExecutionException;
93
94 /**
95 * Redo last step.
96 */
97 void redo() throws ActionExecutionException;
98
99 /**
100 * Propagate changes to the original value.
101 */
102 void commit();
103
104 /**
105 * Roll back to original value.
106 */
107 void revert();
108 }