View Javadoc

1   /**
2    * This file Copyright (c) 2010-2014 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.field;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.ui.imageprovider.definition.ImageProviderDefinition;
38  import info.magnolia.ui.workbench.WorkbenchPresenter;
39  import info.magnolia.ui.workbench.WorkbenchView;
40  import info.magnolia.ui.workbench.definition.WorkbenchDefinition;
41  import info.magnolia.ui.workbench.event.SearchEvent;
42  import info.magnolia.ui.workbench.event.SelectionChangedEvent;
43  import info.magnolia.ui.workbench.tree.TreePresenterDefinition;
44  
45  import org.slf4j.Logger;
46  import org.slf4j.LoggerFactory;
47  
48  import com.vaadin.data.Item;
49  import com.vaadin.ui.Component;
50  import com.vaadin.ui.CustomField;
51  
52  /**
53   * Wraps a workbench instance into a field. While it is quite useful in dialogs the users are discouraged
54   * from using it in a form.
55   */
56  public class WorkbenchField extends CustomField<Object> {
57  
58      private static final String DEFAULT_HEIGHT = "400px";
59  
60      private Logger log = LoggerFactory.getLogger(getClass());
61  
62      private ImageProviderDefinition imageProvider;
63  
64      private WorkbenchDefinition workbenchDefinition;
65  
66      private WorkbenchPresenter presenter;
67  
68      private EventBus workbenchEventbus;
69  
70      private WorkbenchView view;
71  
72      public WorkbenchField(WorkbenchDefinition definition, ImageProviderDefinition imageProvider, WorkbenchPresenter presenter, EventBus eventBus) {
73          this.workbenchDefinition = definition;
74          this.imageProvider = imageProvider;
75          this.presenter = presenter;
76          this.workbenchEventbus = eventBus;
77      }
78  
79      @Override
80      protected Component initContent() {
81          this.view = presenter.start(workbenchDefinition, imageProvider, workbenchEventbus);
82          this.view.setViewType(TreePresenterDefinition.VIEW_TYPE);
83          this.view.asVaadinComponent().setHeight(DEFAULT_HEIGHT);
84          presenter.select(getValue());
85  
86          workbenchEventbus.addHandler(SelectionChangedEvent.class, new SelectionChangedEvent.Handler() {
87              @Override
88              public void onSelectionChanged(SelectionChangedEvent event) {
89                  setValue(event.getFirstItemId(), false);
90              }
91          });
92  
93          workbenchEventbus.addHandler(SearchEvent.class, new SearchEvent.Handler() {
94              @Override
95              public void onSearch(SearchEvent event) {
96                  presenter.doSearch(event.getSearchExpression());
97              }
98          });
99  
100         return this.view.asVaadinComponent();
101     }
102 
103     @Override
104     public void setPropertyDataSource(com.vaadin.data.Property newDataSource) {
105         super.setPropertyDataSource(null);
106     }
107 
108     @Override
109     public Class<? extends Item> getType() {
110         return Item.class;
111     }
112 
113     public WorkbenchPresenter getPresenter() {
114         return presenter;
115     }
116 }