View Javadoc
1   /**
2    * This file Copyright (c) 2013-2015 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.workbench.tree;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.objectfactory.ComponentProvider;
38  import info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector;
39  import info.magnolia.ui.vaadin.integration.contentconnector.JcrContentConnector;
40  import info.magnolia.ui.workbench.column.definition.ColumnDefinition;
41  import info.magnolia.ui.workbench.definition.WorkbenchDefinition;
42  import info.magnolia.ui.workbench.event.ActionEvent;
43  import info.magnolia.ui.workbench.list.ListPresenter;
44  import info.magnolia.ui.workbench.tree.drop.DropConstraint;
45  
46  import java.util.ArrayList;
47  import java.util.Iterator;
48  import java.util.List;
49  
50  import javax.inject.Inject;
51  
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  import com.vaadin.data.Container;
56  import com.vaadin.data.Property;
57  
58  /**
59   * The TreePresenter is responsible for creating, configuring and updating a tree of items according to the workbench definition.
60   */
61  public class TreePresenter extends ListPresenter implements TreeView.Listener {
62  
63      private static final String SAVE_ACTION_NAME = "saveItemProperty";
64      private static final Logger log = LoggerFactory.getLogger(TreePresenter.class);
65  
66      @Inject
67      public TreePresenter(TreeView view, ComponentProvider componentProvider) {
68          super(view, componentProvider);
69      }
70  
71      @Override
72      public TreeView start(WorkbenchDefinition workbenchDefinition, EventBus eventBus, String viewTypeName, ContentConnector contentConnector) {
73          TreeView view = (TreeView) super.start(workbenchDefinition, eventBus, viewTypeName, contentConnector);
74  
75          // inplace-editing
76          if (workbenchDefinition.isEditable()) {
77  
78              List<Object> editableColumns = new ArrayList<Object>();
79  
80              Iterator<ColumnDefinition> it = getColumnsIterator();
81              while (it.hasNext()) {
82                  ColumnDefinition column = it.next();
83  
84                  String propertyId = column.getPropertyName();
85                  if (column.isEditable()) {
86                      editableColumns.add(propertyId);
87                  }
88              }
89              view.setEditableColumns(editableColumns.toArray());
90              view.setEditable(true);
91          }
92  
93          // Drag and Drop
94          Class<? extends DropConstraint> dropConstraintClass = workbenchDefinition.getDropConstraintClass();
95          if (dropConstraintClass != null) {
96              final DropConstraint constraint = getComponentProvider().newInstance(dropConstraintClass);
97              final MoveHandler moveHandler = getComponentProvider().newInstance(MoveHandler.class, view.asVaadinComponent(), constraint);
98              view.setDragAndDropHandler(moveHandler.asDropHandler());
99              log.debug("Set following drop container {} to the treeTable", dropConstraintClass.getName());
100         }
101 
102         return view;
103     }
104 
105 
106     public void disableDragAndDrop() {
107         ((TreeView) view).setDragAndDropHandler(null);
108     }
109 
110     // TREE VIEW LISTENER IMPL
111 
112     @Override
113     public void onItemEdited(Object itemId, Object propertyId, Property<?> propertyDataSource) {
114         if (itemId != null && propertyId != null) {
115             eventBus.fireEvent(new ActionEvent(SAVE_ACTION_NAME, itemId, propertyId, propertyDataSource));
116         }
117 
118         // Clear preOrder cache of itemIds in case node was renamed
119         refresh();
120     }
121 
122     @Override
123     public void expand(Object itemId) {
124         view.expand(itemId);
125     }
126 
127     @Override
128     protected Container.Hierarchical createContainer() {
129         return new HierarchicalJcrContainer(((JcrContentConnector)contentConnector).getContentConnectorDefinition());
130     }
131 }