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  
39  import java.io.InputStream;
40  
41  /**
42   * Fired when work with media editor is finished. This event delivers the
43   * resulting media stream and the type of confirmation made after finishing
44   * media editor (submitted, canceled).
45   */
46  public class MediaEditorCompletedEvent implements Event<MediaEditorCompletedEvent.Handler>{
47  
48      /**
49       * CompletionType.
50       */
51      public enum CompletionType {
52          SUBMIT,
53          CANCEL;
54      };
55  
56      private CompletionType type;
57  
58      private InputStream stream;
59  
60      public MediaEditorCompletedEvent(CompletionType type, InputStream stream) {
61          this.stream = stream;
62          this.type = type;
63      }
64  
65      public InputStream getStream() {
66          return stream;
67      }
68  
69      public CompletionType getType() {
70          return type;
71      }
72  
73      /**
74       * Handler.
75       */
76      public interface Handler extends EventHandler {
77  
78          void onSubmit(MediaEditorCompletedEvent event);
79  
80          void onCancel(MediaEditorCompletedEvent event);
81  
82      }
83  
84      @Override
85      public void dispatch(Handler handler) {
86          switch (type) {
87          case SUBMIT:
88              handler.onSubmit(this);
89              break;
90          case CANCEL:
91              handler.onCancel(this);
92              break;
93          }
94      }
95  }