View Javadoc

1   /**
2    * This file Copyright (c) 2013-2014 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.vaadin.gwt.client.magnoliashell.event;
35  
36  import info.magnolia.ui.vaadin.gwt.client.shared.magnoliashell.ShellAppType;
37  
38  import com.google.gwt.event.shared.EventHandler;
39  import com.google.web.bindery.event.shared.Event;
40  
41  /**
42   * Fired when a shell-app UI is loaded (transition is finished).
43   * Emitter:
44   * @see info.magnolia.ui.vaadin.gwt.client.magnoliashell.viewport.connector.ShellAppsViewportConnector
45   * Receiver:
46   * @see info.magnolia.ui.vaadin.gwt.client.magnoliashell.shell.MagnoliaShellConnector
47   */
48  public class ShellAppStartedEvent extends Event<ShellAppStartedEvent.Handler> {
49  
50      public ShellAppType getType() {
51          return type;
52      }
53  
54      /**
55       * Handler interface for ShellAppStartedEvent.
56       */
57      public interface Handler extends EventHandler {
58          void onShellAppStarted(ShellAppStartedEvent event);
59      }
60  
61      public static final Type<Handler> TYPE = new Type<Handler>();
62  
63      private ShellAppType type;
64  
65      public ShellAppStartedEvent(ShellAppType type) {
66          this.type = type;
67      }
68  
69      @Override
70      protected void dispatch(Handler handler) {
71          handler.onShellAppStarted(this);
72      }
73  
74      @Override
75      public Type<Handler> getAssociatedType() {
76          return TYPE;
77      }
78  
79  
80  }