View Javadoc
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.contentapp.browser;
35  
36  import info.magnolia.ui.actionbar.ActionbarView;
37  import info.magnolia.ui.api.view.View;
38  import info.magnolia.ui.vaadin.actionbar.ActionPopup;
39  import info.magnolia.ui.workbench.WorkbenchView;
40  
41  import com.vaadin.ui.MenuBar.MenuItem;
42  import com.vaadin.server.Resource;
43  import com.vaadin.ui.ComponentContainer;
44  
45  /**
46   * Implementations of this interface are responsible for building a workbench and handling the UI
47   * actions associated with it.
48   */
49  public interface BrowserView extends ComponentContainer, View {
50  
51      /**
52       * Use this method to add an action bar to this sub app view.
53       */
54      void setActionbarView(ActionbarView actionbar);
55  
56      void setWorkbenchView(WorkbenchView workbenchView);
57  
58      void setListener(BrowserView.Listener listener);
59  
60      ActionPopup getActionPopup();
61  
62      /**
63       * @deprecated configure popup items via {@link #getActionPopup()}, this method is anyway useless without a command passed.
64       */
65      @Deprecated
66      MenuItem addPopupItem(String label, Resource iconFontResource);
67  
68      /**
69       * Listener for the BrowserView.
70       * @deprecated not used anymore.
71       */
72      @Deprecated
73      interface Listener {
74  
75          void onActionBarSelection(String actionName);
76  
77      }
78  }