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.actionbar;
35  
36  import info.magnolia.ui.api.view.View;
37  import info.magnolia.ui.vaadin.gwt.client.actionbar.shared.ActionbarItem;
38  
39  import com.vaadin.server.Resource;
40  
41  /**
42   * Base interface for an action bar view.
43   *
44   * @deprecated since 6.0. Use new framework and {@link info.magnolia.ui.contentapp.browser.actionbar.ActionbarView}.
45   */
46  @Deprecated
47  public interface ActionbarView extends View {
48  
49      void setListener(Listener listener);
50  
51      void addSection(String sectionName, String label);
52  
53      void removeSection(String sectionName);
54  
55      void setPreview(final Resource previewResource);
56  
57      void addAction(ActionbarItem action, String sectionName);
58  
59      void removeAction(String actionName);
60  
61  
62      // ENABLE / DISABLE
63      void setActionEnabled(String actionName, boolean isEnabled);
64  
65      void setActionEnabled(String actionName, String sectionName, boolean isEnabled);
66  
67      void setGroupEnabled(String groupName, boolean isEnabled);
68  
69      void setGroupEnabled(String groupName, String sectionName, boolean isEnabled);
70  
71      // SHOW / HIDE SECTIONS
72      void setSectionVisible(String sectionName, boolean isVisible);
73  
74      boolean isSectionVisible(String sectionName);
75  
76      void setOpen(boolean isOpen);
77  
78      /**
79       * Base interface for an action bar listener.
80       */
81      interface Listener {
82  
83          /**
84           * Event handler invoked on clicking an item in the action bar.
85           *
86           * @param actionToken the action token
87           */
88          void onActionbarItemClicked(String actionToken);
89      }
90  }