View Javadoc

1   /**
2    * This file Copyright (c) 2012 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.event;
35  
36  import info.magnolia.ui.framework.event.Event;
37  import info.magnolia.ui.framework.event.EventHandler;
38  
39  import java.io.Serializable;
40  
41  import com.vaadin.data.Item;
42  
43  /**
44   * Event fired when the inplace editing field value was edited.
45   */
46  public class ItemEditedEvent implements Event<ItemEditedEvent.Handler> {
47  
48      /**
49       * Event listener that should react to item edited events.
50       */
51      public interface Handler extends EventHandler {
52  
53          void onItemEdited(ItemEditedEvent event);
54      }
55  
56      /**
57       * Event notifier that should register item edited events.
58       */
59      public interface Notifier extends Serializable {
60  
61          void addListener(ItemEditedEvent.Handler listener);
62  
63          void removeListener(ItemEditedEvent.Handler listener);
64      }
65  
66      private final Item item;
67  
68      /**
69       * Instantiates a new item edited event.
70       *
71       * @param item the item that has been edited.
72       */
73      public ItemEditedEvent(Item item) {
74          this.item = item;
75      }
76  
77      public Item getItem() {
78          return item;
79      }
80  
81      @Override
82      public void dispatch(Handler handler) {
83          handler.onItemEdited(this);
84      }
85  }