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.admincentral.shellapp.favorites;
35  
36  import java.io.Serializable;
37  import java.lang.reflect.Method;
38  
39  import com.vaadin.ui.Component;
40  import com.vaadin.ui.Component.Event;
41  
42  /**
43   * An event sent when editing a favorite entry.
44   */
45  @SuppressWarnings("serial")
46  public final class EditingEvent extends Event implements Serializable {
47  
48      private boolean editing;
49  
50      public EditingEvent(Component source, boolean editing) {
51          super(source);
52          this.editing = editing;
53      }
54  
55      public boolean isEditing() {
56          return editing;
57      }
58  
59      public static final Method EDITING_METHOD;
60  
61      static {
62          try {
63              EDITING_METHOD = EditingListener.class.getDeclaredMethod(
64                      "onEdit", new Class[] { EditingEvent.class });
65          } catch (final java.lang.NoSuchMethodException e) {
66              // This should never happen
67              throw new java.lang.RuntimeException();
68          }
69      }
70  
71      /**
72       * EditableListener.
73       */
74      public interface EditingListener extends Serializable {
75          void onEdit(EditingEvent event);
76      }
77  
78      /**
79       * EditingListener.
80       */
81      public interface EditingNotifier extends Serializable {
82          /**
83           * Register a listener to handle {@link EditingEvent}s.
84           */
85          void addEditingListener(EditingListener listener);
86  
87          /**
88           * Removes an EditingListener.
89           */
90          void removeEditingListener(EditingListener listener);
91      }
92  
93  }