View Javadoc
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.event;
35  
36  import info.magnolia.event.Event;
37  import info.magnolia.event.EventHandler;
38  import info.magnolia.ui.mediaeditor.MediaEditorPresenter;
39  
40  /**
41   * Fired by the UI-fields, instructs the {@link MediaEditorPresenter}
42   * to manage transaction (rollback, commitState, etc).
43   */
44  public class MediaEditorInternalEvent implements Event<MediaEditorInternalEvent.Handler> {
45  
46      /**
47       * Type of possible action to be performed in a handler of event.
48       */
49      public static enum EventType {
50        APPLY,
51        SUBMIT,
52        CANCEL_LAST,
53        CANCEL_ALL;
54      };
55      
56      /**
57       * Handler.
58       */
59      public interface Handler extends EventHandler {
60          
61          void onSubmit(MediaEditorInternalEvent e);
62          
63          void onLastActionCancelled(MediaEditorInternalEvent e);
64          
65          void onLastActionApplied(MediaEditorInternalEvent e);
66          
67          void onCancelAll(MediaEditorInternalEvent e);
68      }
69  
70      private EventType type;
71      
72      public MediaEditorInternalEvent(EventType type) {
73          this.type = type;
74      }
75      
76      public EventType getType() {
77          return type;
78      }
79      
80      @Override
81      public void dispatch(Handler handler) {
82          switch (type) {
83          case SUBMIT:
84              handler.onSubmit(this);
85              break;
86          case CANCEL_LAST:
87              handler.onLastActionCancelled(this);
88              break;
89          case APPLY:
90              handler.onLastActionApplied(this);
91              break;
92          case CANCEL_ALL:
93              handler.onCancelAll(this);
94              break;
95          default:
96              break;
97          }
98      }
99  }