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.EventBus;
37 import info.magnolia.ui.api.event.AdmincentralEventBus;
38 import info.magnolia.ui.api.ioc.AdmincentralScoped;
39 import info.magnolia.ui.api.shell.ConfirmationHandler;
40 import info.magnolia.ui.api.shell.Shell;
41
42 import javax.inject.Inject;
43 import javax.inject.Named;
44
45 /**
46 * Manages the user's location in the application and controls location changes.
47 */
48 @AdmincentralScoped
49 public class LocationController {
50
51 private final EventBus eventBus;
52
53 private Shell shell;
54
55 private Location where = Location.NOWHERE;
56
57 @Inject
58 public LocationController(@Named(AdmincentralEventBus.NAME) final EventBus eventBus, Shell shell) {
59 this.eventBus = eventBus;
60 this.shell = shell;
61 }
62
63 /**
64 * Returns the current location.
65 */
66 public Location getWhere() {
67 return where;
68 }
69
70 /**
71 * Request a change to a new location.
72 */
73 public void goTo(final Location newLocation) {
74
75 if (newLocation == null || getWhere().equals(newLocation)) {
76 return;
77 }
78
79 LocationChangeRequestedEventedEvent.html#LocationChangeRequestedEvent">LocationChangeRequestedEvent willChange = new LocationChangeRequestedEvent(newLocation);
80 eventBus.fireEvent(willChange);
81
82 // Listeners to this event will set warning if they want the users to confirm the location change
83
84 if (willChange.getWarning() != null) {
85 shell.askForConfirmation(willChange.getWarning(), new ConfirmationHandler() {
86
87 @Override
88 public void onConfirm() {
89 goToWithoutChecks(newLocation);
90 }
91
92 @Override
93 public void onCancel() {
94 }
95 });
96 } else {
97 goToWithoutChecks(newLocation);
98 }
99 }
100
101 protected void goToWithoutChecks(Location newLocation) {
102 this.where = newLocation;
103 eventBus.fireEvent(new LocationChangedEvent(newLocation));
104 }
105 }