View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.form.field.component;
35  
36  import info.magnolia.context.MgnlContext;
37  import info.magnolia.ui.imageprovider.ImageProvider;
38  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
39  import info.magnolia.ui.vaadin.integration.jcr.JcrNodeAdapter;
40  
41  import java.util.List;
42  
43  import javax.jcr.Node;
44  import javax.jcr.RepositoryException;
45  
46  import org.apache.commons.lang3.StringUtils;
47  import org.slf4j.Logger;
48  import org.slf4j.LoggerFactory;
49  
50  import com.vaadin.server.ExternalResource;
51  import com.vaadin.ui.Component;
52  import com.vaadin.ui.FormLayout;
53  import com.vaadin.ui.Image;
54  import com.vaadin.v7.data.Item;
55  import com.vaadin.v7.ui.HorizontalLayout;
56  
57  /**
58   * {@link Item} implementation of {@link AbstractContentPreviewComponent}.
59   */
60  public abstract class AbstractBaseItemContentPreviewComponent extends AbstractContentPreviewComponent<Item> {
61  
62      private static final Logger log = LoggerFactory.getLogger(AbstractBaseItemContentPreviewComponent.class);
63      protected ImageProvider imageProvider;
64  
65      public AbstractBaseItemContentPreviewComponent(String workspace) {
66          super(workspace);
67          // Always set the root layout as CompositionRoot.
68          this.rootLayout = new HorizontalLayout();
69          setCompositionRoot(rootLayout);
70      }
71  
72      public abstract void setImageProvider();
73  
74      /**
75       * Returned components (Label) will be displayed in the order of creation (first display is the first put into the list).
76       *
77       * @param fileItem
78       * @return list of detail components (Generally a Label)
79       * @throws RepositoryException
80       */
81      public abstract List<Component> createFieldDetail(Item fileItem) throws RepositoryException;
82  
83      @Override
84      public Component refreshContentDetail(Item item) {
85          FormLayout fileInfo = new FormLayout();
86          fileInfo.setSizeUndefined();
87          fileInfo.addStyleName("file-details");
88          try {
89              List<Component> res = createFieldDetail(item);
90              fileInfo.addComponents(res.toArray(new Component[res.size()]));
91          } catch (RepositoryException e) {
92              log.warn("Could not get the related File node", e);
93          }
94          return fileInfo;
95      }
96  
97      @Override
98      public Component refreshContentPreview(Item item) {
99          Image thumbnail = new Image();
100         String path = imageProvider.getPortraitPath(((JcrItemAdapter)item).getItemId());
101         if (StringUtils.isNotBlank(path)) {
102             thumbnail = new Image("", new ExternalResource(path));
103             thumbnail.addStyleName("file-preview-area");
104         }
105         return thumbnail;
106     }
107 
108     /**
109      * Retrieve an {@link Item} based on the itemPath.<br>
110      * This {@link Item} is then used by sub classes to display Item detail and preview.
111      */
112     @Override
113     protected Item refreshItem(String itemPath) {
114         Item currentItem = null;
115         try {
116             Node fileNode = MgnlContext.getJCRSession(workspace).getNode(itemPath);
117             if (fileNode != null) {
118                 currentItem = new JcrNodeAdapter(fileNode);
119             }
120         } catch (RepositoryException e) {
121             log.warn("Not able to refresh the Preview Component view for the following path: {}", itemPath, e);
122         }
123         return currentItem;
124     }
125 
126 }