1 /**
2 * This file Copyright (c) 2012-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.location;
35
36 import info.magnolia.event.Event;
37 import info.magnolia.event.EventHandler;
38
39 /**
40 * Event fired when a location change is about to happen usually in response to user interaction. Handlers can call
41 * {@link #setWarning(String)} to request that the user be prompted to confirm the change.
42 */
43 public class LocationChangeRequestedEvent implements Event<LocationChangeRequestedEvent.Handler> {
44
45 /**
46 * Handler interface for {@link LocationChangeRequestedEvent}.
47 */
48 public interface Handler extends EventHandler {
49
50 void onLocationChangeRequested(LocationChangeRequestedEvent event);
51 }
52
53 private String warning;
54
55 private final Location newLocation;
56
57 public LocationChangeRequestedEvent(Location newLocation) {
58 this.newLocation = newLocation;
59 }
60
61 /**
62 * Returns the location we may navigate to, or null on window close.
63 */
64 public Location getNewLocation() {
65 return newLocation;
66 }
67
68 /**
69 * Returns the warning message to show the user before allowing the location change, or null if
70 * none has been set.
71 */
72 public String getWarning() {
73 return warning;
74 }
75
76 /**
77 * Set a message to warn the user that it might be unwise to navigate away from the current
78 * location, i.e. due to unsaved changes. If the user clicks okay to that message, navigation will
79 * proceed to the requested location.
80 * <p>
81 * Calling with a null warning is the same as not calling the method at all -- the user will not be prompted.
82 * <p>
83 * Only the first non-null call to setWarning has any effect. That is, once the warning message has been set it cannot be cleared.
84 */
85 public void setWarning(String warning) {
86 if (this.warning == null) {
87 this.warning = warning;
88 }
89 }
90
91 @Override
92 public void dispatch(Handler handler) {
93 handler.onLocationChangeRequested(this);
94 }
95
96 }