1 /**
2 * This file Copyright (c) 2015-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.api.app;
35
36 import info.magnolia.event.Event;
37
38 /**
39 * SubAppLifecycleEvent is fired on initiation, termination and activation/de-activation of a sub-app (the exact list of
40 * supported lifecycle phases is provided by {@link Type}).
41 * <p>
42 * Such events are fired in the sub-app scope, hence, handlers in some sub-app are notified of only those lifecycle events
43 * that happen in that particular sub-app.
44 * <p>
45 * Subscription to the SubAppLifecycleEvent allows the developer for managing the sub-app resources in a more fine-grained fashion,
46 * e.g. warming-up some caches once sub-app is starting/activating and cleaning them up on termination/de-activation.
47 * <p>
48 * Please note that this event normally <strong>should not</strong> be fired in a custom app code - the app framework is
49 * responsible for that.
50 *
51 * @see SubAppEventBus
52 * @see Type
53 */
54 public class SubAppLifecycleEvent implements Event<SubAppLifecycleEventHandler> {
55
56 /**
57 * List of supported sub-app lifecycle phases.
58 */
59 public enum Type {
60 STARTED, STOPPED, FOCUSED, BLURRED
61 }
62
63 private final SubAppDescriptor subAppDescriptor;
64 private final Type eventType;
65
66 public SubAppLifecycleEvent(SubAppDescriptor app, Type eventType) {
67 this.subAppDescriptor = app;
68 this.eventType = eventType;
69 }
70
71 public SubAppDescriptor getSubAppDescriptor() {
72 return subAppDescriptor;
73 }
74
75 @Override
76 public void dispatch(SubAppLifecycleEventHandler handler) {
77 if (eventType == null) {
78 return;
79 }
80
81 switch (eventType) {
82 case STARTED:
83 handler.onSubAppStarted(this);
84 break;
85 case FOCUSED:
86 handler.onSubAppFocused(this);
87 break;
88 case STOPPED:
89 handler.onSubAppStopped(this);
90 break;
91 case BLURRED:
92 handler.onSubAppBlurred(this);
93 break;
94 }
95 }
96 }