View Javadoc
1   /**
2    * This file Copyright (c) 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.contentapp.configuration.ContentViewDefinition;
37  import info.magnolia.ui.contentapp.configuration.ContentViewsDefinition;
38  import info.magnolia.ui.contentapp.configuration.WorkbenchDefinition;
39  import info.magnolia.ui.framework.ContextProperty;
40  import info.magnolia.ui.UIComponent;
41  import info.magnolia.ui.framework.UiComponentContext;
42  
43  import java.util.function.Consumer;
44  
45  import javax.inject.Inject;
46  
47  import com.vaadin.ui.HorizontalLayout;
48  import com.vaadin.ui.VerticalLayout;
49  
50  /**
51   * Workbench view.
52   * @param <T> item type.
53   */
54  public class Workbench<T> extends VerticalLayout implements UIComponent {
55  
56      private final WorkbenchContext workbenchContext;
57      private final ContentViews<T> contentViews;
58  
59      @Inject
60      public Workbench(WorkbenchDefinition<T> definition, WorkbenchContext workbenchContext) {
61          this.workbenchContext = workbenchContext;
62  
63          final String defaultDisplayedContentView = definition.getContentViews()
64                  .stream()
65                  .map(ContentViewDefinition::getName)
66                  .findFirst()
67                  .orElseThrow(() -> new RuntimeException("No content views defined."));
68  
69          this.workbenchContext
70                  .displayedContentViewId()
71                  .set(defaultDisplayedContentView);
72  
73          this.contentViews = getContentViews(definition);
74  
75          HorizontalLayout contentViewLayout = new HorizontalLayout();
76          contentViewLayout.setSizeFull();
77          contentViewLayout.addComponent(contentViews);
78          contentViewLayout.setExpandRatio(contentViews, 0f);
79  
80          setSizeFull();
81          addStyleName("workbench");
82          setMargin(false);
83          addComponent(contentViews);
84      }
85  
86      protected ContentViews<T> getContentViews(WorkbenchDefinition<T> definition) {
87          return create(ContentViewsDefinition.of(definition.getContentViews()), definition.getExtensionViews());
88      }
89  
90      public void setTitle(String title) {
91          this.contentViews.setTitle(title);
92      }
93  
94      public void setTitle(String title, boolean isHtml) {
95          this.contentViews.setTitle(title, isHtml);
96      }
97  
98      public void onContentViewTypeChange(Consumer<String> handler) {
99          workbenchContext
100                 .displayedContentViewId()
101                 .observeNullable(handler::accept);
102     }
103 
104     /**
105      * {@link UiComponentContext} specific to a workbench.
106      */
107     public interface WorkbenchContext extends UiComponentContext {
108         ContextProperty<String> displayedContentViewId();
109     }
110 }