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.framework.app;
35  
36  import info.magnolia.ui.framework.location.Location;
37  import info.magnolia.ui.framework.view.ViewPort;
38  
39  /**
40   * AppController manages life cycles of {@link App}s. It takes care of starting, stopping and switching to already running apps.
41   * Manages apps running for a single user.
42   */
43  public interface AppController {
44  
45      App startIfNotAlreadyRunning(String name, Location location);
46  
47      App startIfNotAlreadyRunningThenFocus(String name, Location location);
48  
49      void stopApp(String name);
50  
51      void stopCurrentApp();
52  
53      boolean isAppStarted(String name);
54  
55      void setViewPort(ViewPort viewport);
56  
57      void focusCurrentApp();
58  
59      Location getCurrentLocation(String name);
60  
61      AppContext getCurrentApp();
62  
63      App getAppWithoutStarting(String appId);
64  }